API Reference

Para que possa realizar a consulta de cobrança por ID pode fazer o seguinte GET:
https://sandbox.sistematize.me:8443/api/v1/cobranca/ID_COBRANCA

Retorno da busca:

{
  "id" : "a7af5372-b543-460f-8348-50aa92794f03",
  "numero" : 882,
  "status" : "QUITADO",
  "data_criacao" : "2024-10-03T13:27:41",
  "data_atualizacao" : "2024-10-03T13:27:49",
  "data_limite_pagamento" : "2024-10-03T00:00:00",
  "valor_total" : 60.00,
  "valor_total_liquido" : 60.00,
  "forma_pagamento" : "BOLETO",
  "data_vencimento_boleto" : "2024-10-03T00:00:00",
  "multa_atraso_boleto" : 0.00,
  "juros_atraso_boleto" : 0.00,
  "parcelas" : 1,
  "max_parcelas_boleto" : 1,
  "max_parcelas_cartao" : 1,
  "empresa" : {
    "id" : "b51ae983-184f-4d31-9f28-92db414557f9",
    "status" : "ATIVA",
    "cnpj" : "74910037000193",
    "razao_social" : "Pedro PCS",
    "nome_fantasia" : "PEDRO PCS LTDA",
    "inscricao_municipal" : "104178",
    "inscricao_estadual" : "",
    "telefone" : "1142219170",
    "email" : "[email protected]",
    "cep" : "09531-190",
    "endereco" : "Alameda Terracota",
    "complemento" : "",
    "numero" : "545",
    "bairro" : "Cerâmica",
    "cidade" : "São Caetano do Sul",
    "uf" : "SP",
    "codigo_ibge" : "3548807",
    "emite_nfse" : true,
    "requer_cliente_nfse" : true,
    "emite_nfce" : false,
    "csc_nfce" : "1234567891234568789",
    "fatura_venda_avista" : true,
    "id_token_nfce" : "0001",
    "regime_tributario" : "SIMPLES_NACIONAL",
    "regime_especial_tributacao" : "MEI",
    "tributacao_rps" : "T",
    "serie_rps" : "1",
    "optante_simples_nacional" : true,
    "incentivador_cultural" : false,
    "natureza_juridica" : "LTDA",
    "data_abertura" : "1990-01-11T00:00:00",
    "cnae" : "4520005",
    "faturamento_medio" : 2000.00,
    "ticket_medio" : 15000.00,
    "marketplace" : {
      "id" : "156184f0-95b1-4e7a-a539-af88fa7b345d"
    },
    "validade_certificado" : "2025-03-20T11:55:20",
    "erp_integra_cr" : false,
    "data_atualizacao" : "2024-10-02T17:45:37",
    "enderecoCompleto" : "Alameda Terracota, 545 Cerâmica, São Caetano do Sul - SP, 09531-190"
  },
  "cliente" : {
    "id" : "9c90ea2d-97c1-4794-a33c-ff619407bfe6",
    "tipo" : "PESSOA_FISICA",
    "razao_social" : "JOAO DA COSTA ANTUNES",
    "nome" : "JOAO DA COSTA ANTUNES",
    "cpf" : "88398158808",
    "email" : "[email protected]",
    "telefone_fixo" : "1144556677",
    "telefone_celular" : "11987876767",
    "cep" : "09720-470",
    "endereco" : "Rua Comendador Carlo Mário Gardano",
    "numero" : "103",
    "bairro" : "Centro",
    "cidade" : "São Bernardo do Campo",
    "uf" : "SP",
    "codigo_ibge" : "3548708",
    "data_criacao" : "2022-09-26T23:59:14",
    "data_atualizacao" : "2022-11-01T19:05:45",
    "status" : "ATIVO",
    "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
    "pep" : false,
    "primeiroNome" : "JOAO",
    "ultimoNome" : " DA COSTA ANTUNES",
    "documento" : "88398158808"
  },
  "opcoes_pagamento" : [ "BOLETO" ],
  "transacoes" : [ {
    "id" : 1033118,
    "data_criacao" : "2024-10-03T13:27:44",
    "status" : "PAGO",
    "tipo" : "BOLETO",
    "arranjo" : "SISTEMATIZE",
    "valor" : 60.00,
    "valor_liquido" : 56.50,
    "valor_taxa_administracao" : 3.50,
    "valor_taxa_antecipacao" : 0.00,
    "vencimento_boleto" : "2024-10-03T00:00:00",
    "url_boleto" : "https://sandbox.sistematize.me/boleto/cc99ad03a9ac7918f449124eab37f85b88dcb979734bd7c1b9de88e4ef882107",
    "barcode_boleto" : "00196985800000060000000003128557000103311817",
    "qrcode" : "00020101021226920014br.gov.bcb.pix2570qrcodepix-h.bb.com.br/pix/v2/cobv/8ee1df39-93b1-488c-a8d3-020ec6575143520400005303986540560.005802BR5925MERCEARIA MANASSES PEREIR6008BRASILIA62070503***6304359A",
    "url_qrcode" : "qrcodepix-h.bb.com.br/pix/v2/cobv/8ee1df39-93b1-488c-a8d3-020ec6575143",
    "emitir_nfse" : false,
    "emitir_nfce" : false,
    "nota_fiscal" : {
      "id" : 2055,
      "transacoes" : [ {
        "id" : 1033118,
        "emitir_nfse" : false,
        "emitir_nfce" : false,
        "valorTotalItensBruto" : 0,
        "valorTotalItensLiquido" : 0
      } ],
      "destinatarios" : [ "[email protected]" ],
      "status" : "ERRO_AUTORIZACAO",
      "tipo" : "NFSE",
      "data_emissao" : "2024-10-03T13:27:44",
      "empresa" : {
        "id" : "b51ae983-184f-4d31-9f28-92db414557f9",
        "status" : "ATIVA",
        "cnpj" : "74910037000193",
        "razao_social" : "Pedro PCS",
        "nome_fantasia" : "PEDRO PCS LTDA",
        "inscricao_municipal" : "104178",
        "inscricao_estadual" : "",
        "telefone" : "1142219170",
        "email" : "[email protected]",
        "cep" : "09531-190",
        "endereco" : "Alameda Terracota",
        "complemento" : "",
        "numero" : "545",
        "bairro" : "Cerâmica",
        "cidade" : "São Caetano do Sul",
        "uf" : "SP",
        "codigo_ibge" : "3548807",
        "emite_nfse" : true,
        "requer_cliente_nfse" : true,
        "emite_nfce" : false,
        "csc_nfce" : "1234567891234568789",
        "fatura_venda_avista" : true,
        "id_token_nfce" : "0001",
        "regime_tributario" : "SIMPLES_NACIONAL",
        "regime_especial_tributacao" : "MEI",
        "tributacao_rps" : "T",
        "serie_rps" : "1",
        "optante_simples_nacional" : true,
        "incentivador_cultural" : false,
        "natureza_juridica" : "LTDA",
        "data_abertura" : "1990-01-11T00:00:00",
        "cnae" : "4520005",
        "faturamento_medio" : 2000.00,
        "ticket_medio" : 15000.00,
        "marketplace" : {
          "id" : "156184f0-95b1-4e7a-a539-af88fa7b345d"
        },
        "validade_certificado" : "2025-03-20T11:55:20",
        "erp_integra_cr" : false,
        "data_atualizacao" : "2024-10-02T17:45:37",
        "enderecoCompleto" : "Alameda Terracota, 545 Cerâmica, São Caetano do Sul - SP, 09531-190"
      },
      "tomador" : {
        "id" : "9c90ea2d-97c1-4794-a33c-ff619407bfe6",
        "tipo" : "PESSOA_FISICA",
        "razao_social" : "JOAO DA COSTA ANTUNES",
        "nome" : "JOAO DA COSTA ANTUNES",
        "cpf" : "88398158808",
        "email" : "[email protected]",
        "telefone_fixo" : "1144556677",
        "telefone_celular" : "11987876767",
        "cep" : "09720-470",
        "endereco" : "Rua Comendador Carlo Mário Gardano",
        "numero" : "103",
        "bairro" : "Centro",
        "cidade" : "São Bernardo do Campo",
        "uf" : "SP",
        "codigo_ibge" : "3548708",
        "data_criacao" : "2022-09-26T23:59:14",
        "data_atualizacao" : "2022-11-01T19:05:45",
        "status" : "ATIVO",
        "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
        "pep" : false,
        "primeiroNome" : "JOAO",
        "ultimoNome" : " DA COSTA ANTUNES",
        "documento" : "88398158808"
      },
      "numero_rps" : 1501,
      "serie_rps" : "1",
      "itens" : [ {
        "quantidade" : 1,
        "servico" : {
          "id" : "f91c133c-dc2a-42a9-8867-91f949cfdb05",
          "sku" : "BALTHV3",
          "status" : "ATIVO",
          "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
          "nome" : "BARBA LENHADOR TESTE HV3 / ROD-MARIA",
          "descricao" : "BARBA LENHADOR TESTE HV3 / ROD-MARIA SPLITANDO PARA OUTRO",
          "valor" : 60.00,
          "cnae" : "9602502",
          "item_lista_servico" : "060201",
          "codigo_tributario_municipio" : "060201",
          "iss_retido" : false,
          "perc_base_calculo_iss" : 0.00,
          "aliquota_iss" : 0.00,
          "inss_retido" : false,
          "aliquota_inss" : 0.00,
          "perc_base_calculo_inss" : 0.00,
          "pis_retido" : false,
          "aliquota_pis" : 0.00,
          "cofins_retido" : false,
          "aliquota_cofins" : 0.00,
          "ir_retido" : false,
          "aliquota_ir" : 0.00,
          "csll_retido" : false,
          "aliquota_csll" : 0.00,
          "categoria" : {
            "id" : "1ecea5c0-a1a1-49c5-ae9c-64cc510f6869",
            "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
            "nome" : "Temperos",
            "foto_url" : "https://sandbox.sistematize.me:8443/api/v1/public/categoria/1ecea5c0-a1a1-49c5-ae9c-64cc510f6869/imagem/cd64c80b-b795-448a-b9ac-e5b219215595.jpg",
            "destaque" : false,
            "prioridade" : 12
          },
          "setor" : {
            "id" : "4185e55d-ad80-4af4-b2e5-2706cb0aa033",
            "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
            "nome" : "Bravus 2.0",
            "imprimir" : false,
            "impressora_ip" : "127.0.0.2",
            "impressora_porta" : 3000,
            "vias" : 4
          },
          "splits" : [ {
            "recebedor" : {
              "id" : "966f65ec-fb91-465c-9804-2f2c0572a53f",
              "cnpj" : "80764338000159",
              "razao_social" : "Jose Parede Solida LTDA",
              "nome_fantasia" : "Jose  JD Parede"
            },
            "metodo" : "PERCENTUAL",
            "valor" : 70.00,
            "paga_taxa_transacao" : true,
            "paga_resto_divisao_taxa" : true
          }, {
            "recebedor" : {
              "id" : "b31736f3-f0fa-4b46-a68b-a5923b22ead4",
              "cnpj" : "78475124000110",
              "razao_social" : "Pizzaria LTDA",
              "nome_fantasia" : "BOA PIZZA"
            },
            "metodo" : "PERCENTUAL",
            "valor" : 30.00,
            "paga_taxa_transacao" : true,
            "paga_resto_divisao_taxa" : false
          } ],
          "data_atualizacao" : "2024-09-19T13:37:11"
        },
        "desconto" : 0.00,
        "valor" : 60.00,
        "executado" : false,
        "total" : 60.00,
        "valorLiquido" : 60.00
      } ],
      "msg_erro" : "CNPJ do emitente não autorizado.",
      "valorTotalBruto" : 60.00,
      "valorTotalLiquido" : 60.00
    },
    "valorTotalItensBruto" : 0,
    "valorTotalItensLiquido" : 0
  } ],
  "itens" : [ {
    "quantidade" : 1,
    "servico" : {
      "id" : "f91c133c-dc2a-42a9-8867-91f949cfdb05",
      "sku" : "BALTHV3",
      "status" : "ATIVO",
      "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
      "nome" : "BARBA LENHADOR TESTE HV3 / ROD-MARIA",
      "descricao" : "BARBA LENHADOR TESTE HV3 / ROD-MARIA SPLITANDO PARA OUTRO",
      "valor" : 60.00,
      "cnae" : "9602502",
      "item_lista_servico" : "060201",
      "codigo_tributario_municipio" : "060201",
      "iss_retido" : false,
      "perc_base_calculo_iss" : 0.00,
      "aliquota_iss" : 0.00,
      "inss_retido" : false,
      "aliquota_inss" : 0.00,
      "perc_base_calculo_inss" : 0.00,
      "pis_retido" : false,
      "aliquota_pis" : 0.00,
      "cofins_retido" : false,
      "aliquota_cofins" : 0.00,
      "ir_retido" : false,
      "aliquota_ir" : 0.00,
      "csll_retido" : false,
      "aliquota_csll" : 0.00,
      "categoria" : {
        "id" : "1ecea5c0-a1a1-49c5-ae9c-64cc510f6869",
        "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
        "nome" : "Temperos",
        "foto_url" : "https://sandbox.sistematize.me:8443/api/v1/public/categoria/1ecea5c0-a1a1-49c5-ae9c-64cc510f6869/imagem/cd64c80b-b795-448a-b9ac-e5b219215595.jpg",
        "destaque" : false,
        "prioridade" : 12
      },
      "setor" : {
        "id" : "4185e55d-ad80-4af4-b2e5-2706cb0aa033",
        "empresa_id" : "b51ae983-184f-4d31-9f28-92db414557f9",
        "nome" : "Bravus 2.0",
        "imprimir" : false,
        "impressora_ip" : "127.0.0.2",
        "impressora_porta" : 3000,
        "vias" : 4
      },
      "splits" : [ {
        "recebedor" : {
          "id" : "966f65ec-fb91-465c-9804-2f2c0572a53f",
          "cnpj" : "80764338000159",
          "razao_social" : "Jose Parede Solida LTDA",
          "nome_fantasia" : "Jose  JD Parede"
        },
        "metodo" : "PERCENTUAL",
        "valor" : 70.00,
        "paga_taxa_transacao" : true,
        "paga_resto_divisao_taxa" : true
      }, {
        "recebedor" : {
          "id" : "b31736f3-f0fa-4b46-a68b-a5923b22ead4",
          "cnpj" : "78475124000110",
          "razao_social" : "Pizzaria LTDA",
          "nome_fantasia" : "BOA PIZZA"
        },
        "metodo" : "PERCENTUAL",
        "valor" : 30.00,
        "paga_taxa_transacao" : true,
        "paga_resto_divisao_taxa" : false
      } ],
      "data_atualizacao" : "2024-09-19T13:37:11"
    },
    "desconto" : 0.00,
    "valor" : 60.00,
    "executado" : false,
    "total" : 60.00,
    "valorLiquido" : 60.00
  } ],
  "splits" : [ ],
  "notasfiscais" : [ ],
  "emitir_nfse" : true,
  "observacoes" : "",
  "qtd_parcelas_pago" : 1,
  "qtd_parcelas_pendente" : 0,
  "qtd_parcelas_atrasado" : 0,
  "total_pago" : 60.00,
  "total_atrasado" : 0
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!