{ "info": { "name": "ZP — APIs de terceiro", "_postman_id": "zp-zp-apis-de-terceiro", "description": "Coleção gerada da documentação oficial (https://wiki.txfuel.com.br/pt-br/zp/api). Preencha as variáveis da coleção: base_url, tipo_identificador (APP, REDE, CNPJ ou CPF), valor_identificador, identificador e app_id. A senha do dia é calculada automaticamente.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Autenticação das APIs de terceiro do ZP: acrescenta APP|REDE|CNPJ|CPF, SENHA (do dia) e A em todo pedido.", "// SENHA = md5(identificador + AAAA-MM-DD + valor enviado em APP/REDE/CNPJ/CPF), data de Brasília.", "const tipo = pm.variables.get('tipo_identificador') || 'APP';", "const valor = pm.variables.get('valor_identificador') || '';", "const identificador = pm.variables.get('identificador') || '';", "const hoje = new Date(Date.now() - 3 * 3600 * 1000).toISOString().slice(0, 10);", "const chave = (tipo === 'CNPJ' || tipo === 'CPF') ? valor.replace(/\\D/g, '') : valor;", "const senha = CryptoJS.MD5(identificador + hoje + chave).toString();", "['APP', 'REDE', 'CNPJ', 'CPF', 'SENHA', 'A'].forEach(k => pm.request.url.query.remove(k));", "pm.request.url.query.add({ key: tipo, value: chave });", "pm.request.url.query.add({ key: 'SENHA', value: senha });", "pm.request.url.query.add({ key: 'A', value: pm.variables.get('app_id') });" ] } } ], "variable": [ { "key": "base_url", "value": "https://zp1.txfuel.com.br/api" }, { "key": "tipo_identificador", "value": "APP" }, { "key": "valor_identificador", "value": "NOME DO APP" }, { "key": "identificador", "value": "" }, { "key": "app_id", "value": "0" } ], "item": [ { "name": "Cobranças", "description": "Emissão, consulta e cancelamento de cobranças por boleto, PIX e cartão de crédito (uma ou várias por chamada, em lote), acompanhamento dos lotes e cofre de cartões usados nas cobranças por cartão.", "item": [ { "name": "GET cobranca — Consulta uma cobrança ou lista as de um convênio por vencimento", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cobranca?id_convenio=10", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cobranca" ], "query": [ { "key": "id_convenio", "value": "10", "description": "Convênio (id_cob_convenio).", "disabled": false }, { "key": "acao", "value": "", "description": "get (uma cobrança, padrão) ou list (por período de vencimento).", "disabled": true }, { "key": "id_cobranca", "value": "", "description": "acao=get: obrigatório. acao=list: não enviar.", "disabled": true }, { "key": "data_inicial", "value": "", "description": "acao=list: obrigatório; vencimento inicial (AAAA-MM-DD). acao=get: não enviar.", "disabled": true }, { "key": "data_final", "value": "", "description": "acao=list: obrigatório; vencimento final, maior ou igual à inicial.", "disabled": true }, { "key": "id_tx_estabelecimento", "value": "", "description": "Cedente; fixo no perfil Filial.", "disabled": true } ] }, "description": "Rota principal do ZP Cobrança. A cobrança é emitida num convênio (conta bancária + integrador + tipo) do cedente do acesso. Uma cobrança só por chamada: o ZP grava e já registra no banco/integrador na mesma chamada. Várias cobranças: o ZP cria um lote, grava todas na situação NW e o registro no banco é feito depois, pela rotina do ZP (acompanhe por /lote e GET cobranca). Se qualquer cobrança do pedido for recusada na validação, nenhuma é gravada. PUT existe na permissão, mas não está implementado (405). Escopo: o perfil Filial usa os convênios do próprio cedente; os outros perfis informam id_tx_estabelecimento (= id do cedente).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "POST cobranca — Emite uma ou várias cobranças", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cobranca?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cobranca" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Cedente (id do cedente = id da filial). Fixo no perfil Filial; nos outros perfis, informe.", "disabled": true } ] }, "description": "Corpo JSON. Datas no formato AAAA-MM-DD. documento_hora_vencimento é aceito mas hoje não é gravado. Regras de CARTAO/PIX: sem multa, juros, descontos, prazos de baixa/protesto e sem avalista. Resposta: com uma cobrança, já registrada (linha digitável, PIX copia e cola, ou pagamento do cartão); com várias, situação NW e idLote preenchido.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"id_convenio\": 10,\n \"tipo\": \"BOLETO\",\n \"cobrancas\": [\n {\n \"codigo_cobranca\": \"PED-1001\",\n \"documento_numero\": 1001,\n \"documento_data\": \"2026-11-12\",\n \"documento_valor\": 150.0,\n \"documento_vencimento\": \"2026-12-10\",\n \"documento_especie\": \"DM\",\n \"instrucoes\": \"NÃO RECEBER APÓS 30 DIAS DO VENCIMENTO\",\n \"perc_multa\": 2.0,\n \"perc_juros_dia\": 0.033,\n \"incluir_pix_boleto\": true,\n \"sacado\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome_razao_social\": \"CLIENTE EXEMPLO DA SILVA\",\n \"cep\": \"80000000\",\n \"logradouro\": \"RUA EXEMPLO\",\n \"numero\": 100,\n \"complemento\": \"\",\n \"bairro\": \"CENTRO\",\n \"localidade\": \"CURITIBA\",\n \"estado\": \"PR\",\n \"telefone\": \"\",\n \"celular\": \"41999990000\",\n \"email\": \"cliente@exemplo.com.br\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE cobranca — Cancela uma cobrança", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cobranca?id_cobranca=5001", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cobranca" ], "query": [ { "key": "id_cobranca", "value": "5001", "description": "Cobrança (id_cob_cobranca).", "disabled": false }, { "key": "id_tx_estabelecimento", "value": "", "description": "Cedente; fixo no perfil Filial.", "disabled": true } ] }, "description": "Não cancela no banco na mesma chamada: cobrança nova (NW) vira CS; registrada ou paga vira FC e a rotina do ZP faz o cancelamento. Acompanhe pelo GET.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET lote — Um lote ou lista de lotes de um convênio", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/lote?id_cob_convenio=10", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "lote" ], "query": [ { "key": "id_cob_convenio", "value": "10", "description": "Convênio dos lotes.", "disabled": false }, { "key": "acao", "value": "", "description": "get (um lote, padrão) ou list.", "disabled": true }, { "key": "id_cob_lote", "value": "", "description": "acao=get: obrigatório.", "disabled": true }, { "key": "data_inicial", "value": "", "description": "acao=list: data de criação inicial (padrão 1980-01-01). Aceita também data_inicio e data_ini.", "disabled": true }, { "key": "data_final", "value": "", "description": "acao=list: data de criação final (padrão 2099-12-31). Aceita também data_fim.", "disabled": true }, { "key": "size", "value": "", "description": "acao=list: tamanho da página, de 1 a 50.", "disabled": true }, { "key": "page", "value": "", "description": "acao=list: página.", "disabled": true } ] }, "description": "Mostra quantas cobranças de cada lote (criado pelo POST cobranca com mais de uma cobrança) já foram processadas pela rotina do ZP. Só GET. Atenção: a rota não confere se o convênio é do acesso (ver dúvidas no relatório).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET cartao — Lista os cartões do cedente ou consulta um", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cartao?id_cob_cedente=25", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cartao" ], "query": [ { "key": "id_cob_cedente", "value": "25", "description": "Cedente.", "disabled": false }, { "key": "acao", "value": "", "description": "list (padrão) ou get.", "disabled": true }, { "key": "id_cob_cartao", "value": "", "description": "acao=get: id do cartão (ou use card_token).", "disabled": true }, { "key": "card_token", "value": "", "description": "acao=get: token do cartão (ou use id_cob_cartao).", "disabled": true } ] }, "description": "acao=get devolve os campos do cartão na raiz (sem a lista cartoes).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "POST cartao — Cadastra um cartão", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cartao", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cartao" ], "query": [] }, "description": "Corpo JSON.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"id_cob_cedente\": 25,\n \"pag_nome_razao_social\": \"CLIENTE EXEMPLO DA SILVA\",\n \"pag_cpf_cnpj\": \"12345678909\",\n \"pag_cep\": \"80000000\",\n \"pag_logradouro\": \"RUA EXEMPLO\",\n \"pag_numero\": 100,\n \"pag_bairro\": \"CENTRO\",\n \"pag_localidade\": \"CURITIBA\",\n \"pag_estado\": \"PR\",\n \"pag_celular\": \"41999990000\",\n \"pag_email\": \"cliente@exemplo.com.br\",\n \"card_numero\": \"4111111111111111\",\n \"card_cvv\": \"123\",\n \"card_mes_vencimento\": \"12\",\n \"card_ano_vencimento\": \"2030\",\n \"card_nome_titular\": \"CLIENTE EXEMPLO\",\n \"card_cpf_cnpj_titular\": \"12345678909\",\n \"card_apelido\": \"CARTAO EMPRESA\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT cartao — Altera titular e apelido de um cartão", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cartao?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cartao" ], "query": [ { "key": "id_cob_cartao", "value": "300", "description": "Cartão (ou use card_token).", "disabled": true }, { "key": "card_token", "value": "", "description": "Token do cartão (ou use id_cob_cartao).", "disabled": true } ] }, "description": "Só titular, CPF/CNPJ do titular e apelido mudam; os campos não enviados ficam vazios. O ZP desativa o registro antigo e cria outro com o mesmo card_token: o id_cob_cartao muda (use o da resposta).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"card_nome_titular\": \"CLIENTE EXEMPLO\",\n \"card_cpf_cnpj_titular\": \"12345678909\",\n \"card_apelido\": \"CARTAO NOVO\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE cartao — Desativa um cartão", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cartao?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cartao" ], "query": [ { "key": "id_cob_cartao", "value": "300", "description": "Cartão (ou use card_token).", "disabled": true }, { "key": "card_token", "value": "", "description": "Token do cartão (ou use id_cob_cartao).", "disabled": true } ] }, "description": "Desativa (ativo = N); o cartão deixa de aparecer e o token deixa de valer para novas cobranças.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } } ] }, { "name": "Cedentes e software houses", "description": "Para software houses que revendem o ZP Cobrança aos seus clientes: cadastro da software house e cadastro/alteração dos cedentes (com conta bancária e convênio) da sua rede.", "item": [ { "name": "GET cedente — Consulta um cedente com contas e convênios", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cedente?id_cob_cedente=25", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cedente" ], "query": [ { "key": "id_cob_cedente", "value": "25", "description": "Cedente da rede da software house.", "disabled": false } ] }, "description": "Para software houses (rede no ZP) que cadastram os próprios clientes como cedentes. Só os perfis Rede (a rede da software house) e Filial (a filial da própria software house) usam; os demais recebem 403. O POST cria, numa transação, o cedente (com a pessoa, a filial e o acesso de terceiro do cedente), uma conta bancária e um convênio, e devolve os ids e o identificador do acesso do cedente. Não há DELETE. Os ids de banco, integrador e tipo de cobrança são fornecidos pela TX Fuel.\n\nPerfis: App, Rede, Estabelecimento." } }, { "name": "POST cedente — Cria cedente, conta e convênio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cedente", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cedente" ], "query": [] }, "description": "Corpo JSON. Os ids (id_cob_cedente, id_cob_conta, id_cob_convenio, id_tx_pessoa) enviados no corpo são ignorados: sempre cria registros novos.\n\nPerfis: App, Rede, Estabelecimento.", "body": { "mode": "raw", "raw": "{\n \"cedente\": {\n \"cpf_cnpj\": \"11222333000181\",\n \"nome_razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"cep\": \"80000000\",\n \"logradouro\": \"AVENIDA EXEMPLO\",\n \"numero\": 1000,\n \"complemento\": \"SALA 1\",\n \"bairro\": \"CENTRO\",\n \"localidade\": \"CURITIBA\",\n \"estado\": \"PR\",\n \"celular\": \"41988880000\",\n \"email\": \"financeiro@exemplo.com.br\"\n },\n \"conta\": {\n \"id_cob_banco\": 1,\n \"descricao\": \"CONTA PRINCIPAL\",\n \"agencia\": \"1234\",\n \"agencia_dv\": \"0\",\n \"numero\": \"56789\",\n \"numero_dv\": \"0\"\n },\n \"convenio\": {\n \"id_cob_integrador\": 3,\n \"id_cob_tipo\": 1,\n \"descricao\": \"BOLETO CONTA PRINCIPAL\",\n \"homologacao\": \"S\",\n \"webhook_url\": \"https://sistema.exemplo.com.br/webhook/zp\",\n \"parametros\": {\n \"val1\": \"\",\n \"val2\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT cedente — Altera cedente, contas e convênios (parcial)", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cedente?id_cob_cedente=25", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cedente" ], "query": [ { "key": "id_cob_cedente", "value": "25", "description": "Cedente (só na URL).", "disabled": false } ] }, "description": "Corpo JSON; só os blocos e campos enviados mudam. Tudo numa transação: se um bloco falhar, nada é gravado.\n\nPerfis: App, Rede, Estabelecimento.", "body": { "mode": "raw", "raw": "{\n \"convenio\": {\n \"id_cob_convenio\": 10,\n \"homologacao\": \"N\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST softwareHouse — Cadastra a software house e o usuário responsável", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/softwareHouse?cnpj_software_house=11222333000181&id_plano=1&cpf=12345678909&nome=RESPONSAVEL EXEMPLO&celular=41999990000&email=responsavel@exemplo.com.br&senha_usuario=", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "softwareHouse" ], "query": [ { "key": "cnpj_software_house", "value": "11222333000181", "description": "CNPJ da software house, só números.", "disabled": false }, { "key": "id_plano", "value": "1", "description": "Plano contratado — id fornecido pela TX Fuel.", "disabled": false }, { "key": "cpf", "value": "12345678909", "description": "CPF do responsável (vira o login), só números.", "disabled": false }, { "key": "nome", "value": "RESPONSAVEL EXEMPLO", "description": "Nome do responsável.", "disabled": false }, { "key": "celular", "value": "41999990000", "description": "Celular do responsável com DDD.", "disabled": false }, { "key": "email", "value": "responsavel@exemplo.com.br", "description": "E-mail do responsável (recebe as boas-vindas).", "disabled": false }, { "key": "senha_usuario", "value": "", "description": "Senha inicial do responsável.", "disabled": false } ] }, "description": "Em qualquer erro nada é gravado. A resposta de sucesso não traz ids nem credenciais: elas vão por e-mail.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } } ] }, { "name": "Documentos fiscais", "description": "Consulta das NF-e e CT-e emitidas e recebidas pelo CNPJ da filial (chaves, situação e manifesto), resumo por situação/modal e andamento da captura das NF-e recebidas.", "item": [ { "name": "GET nfeChave — Lista de NF-e", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/nfeChave?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "nfeChave" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Filial cujo CNPJ (parâmetro CNPJ_NFE) é consultado. Fixo no perfil Filial; nos outros perfis, informe.", "disabled": true }, { "key": "data_inicial", "value": "", "description": "Data inicial: vale a data de emissão OU a data de cadastro no ZP (AAAA-MM-DD; aceita também data_inicio e data_ini).", "disabled": true }, { "key": "data_final", "value": "", "description": "Data final (AAAA-MM-DD; aceita também data_fim).", "disabled": true }, { "key": "chave", "value": "", "description": "Chave de acesso (44 dígitos); * ou ausente = todas.", "disabled": true }, { "key": "situacao", "value": "", "description": "AUTORIZADA, CANCELADA…; * = todas.", "disabled": true }, { "key": "manifesto", "value": "", "description": "CONFIRMADA, CIÊNCIA, DESCONHECIDA, NÃO REALIZADA; * = todos.", "disabled": true }, { "key": "modal", "value": "", "description": "RODOVIÁRIO, FERROVIÁRIO, AEROVIÁRIO, DUTOVIÁRIO, HIDROVIÁRIO; * = todos.", "disabled": true }, { "key": "xml", "value": "", "description": "S = só as que já têm XML; N = sem XML; * = todas.", "disabled": true } ] }, "description": "Lista as NF-e capturadas para o CNPJ da filial (como emitente ou destinatário), com situação, manifesto e modal. Só GET. A lista não é paginada.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET nfeResumo — Totais do período", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/nfeResumo?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "nfeResumo" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Filial cujo CNPJ (parâmetro CNPJ_NFE) é consultado. Fixo no perfil Filial; nos outros perfis, informe.", "disabled": true }, { "key": "data_inicial", "value": "", "description": "Emissão inicial (AAAA-MM-DD).", "disabled": true }, { "key": "data_final", "value": "", "description": "Emissão final (AAAA-MM-DD).", "disabled": true } ] }, "description": "Contagens das NF-e de saída (emitidas pelo CNPJ da filial) e de entrada (recebidas) no período de emissão. Só GET.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET nfeRecebidaStatus — Totais e percentuais", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/nfeRecebidaStatus?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "nfeRecebidaStatus" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Filial cujo CNPJ (parâmetro CNPJ_NFE) é consultado. Fixo no perfil Filial; nos outros perfis, informe.", "disabled": true } ] }, "description": "Percentual das NF-e recebidas pelo CNPJ da filial que já têm XML, JSON, PDF e manifesto confirmado no ZP. Sem filtro de data. Só GET.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET cteChave — Lista de CT-e", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/cteChave?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "cteChave" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Filial cujo CNPJ (parâmetro CNPJ_NFE) é consultado. Fixo no perfil Filial; nos outros perfis, informe.", "disabled": true }, { "key": "data_inicial", "value": "", "description": "Emissão inicial (AAAA-MM-DD; aceita também data_inicio e data_ini).", "disabled": true }, { "key": "data_final", "value": "", "description": "Emissão final (AAAA-MM-DD; aceita também data_fim).", "disabled": true }, { "key": "chave", "value": "", "description": "Chave de acesso; * ou ausente = todas.", "disabled": true }, { "key": "situacao", "value": "", "description": "Situação; * = todas.", "disabled": true }, { "key": "manifesto", "value": "", "description": "Manifesto; * = todos.", "disabled": true }, { "key": "xml", "value": "", "description": "S = com XML; N = sem; * = todos.", "disabled": true } ] }, "description": "Lista os CT-e capturados para o CNPJ da filial (como interessado ou emitente), por data de emissão. Só GET. A lista não é paginada.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } } ] }, { "name": "Utilitários", "description": "Teste da credencial, consulta de CEP e de localidade, validação cadastral de CPF/CNPJ e observações livres ligadas a registros.", "item": [ { "name": "GET status — Responde ok se a credencial é válida", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/status", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "status" ], "query": [] }, "description": "Não consulta nada: só confirma que a autenticação (APP/REDE/CNPJ/CPF + SENHA + A) e a permissão do terceiro estão corretas. Útil para testar a conexão da integração. Vale para todos os perfis.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET consultarCep — Endereço do CEP", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/consultarCep?cep=80000000", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "consultarCep" ], "query": [ { "key": "cep", "value": "80000000", "description": "CEP, 8 dígitos (pontuação é ignorada).", "disabled": false } ] }, "description": "Consulta o CEP na base do ZP (atualizada por serviço externo quando preciso). Só GET.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET localizarLocalidade — Cidades", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/localizarLocalidade?q=curitiba", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "localizarLocalidade" ], "query": [ { "key": "q", "value": "curitiba", "description": "Parte do nome da cidade.", "disabled": false } ] }, "description": "Até 10 cidades cujo nome contém o texto (sem acentos). Só GET.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET validarPessoaFisica — Semelhança dos dados com o bureau", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/validarPessoaFisica?documento=12345678909", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "validarPessoaFisica" ], "query": [ { "key": "documento", "value": "12345678909", "description": "CPF.", "disabled": false }, { "key": "nome", "value": "", "description": "Nome completo.", "disabled": true }, { "key": "data_nascimento", "value": "", "description": "AAAA-MM-DD.", "disabled": true }, { "key": "nome_mae", "value": "", "description": "Nome da mãe.", "disabled": true }, { "key": "cep", "value": "", "description": "CEP informado pelo cliente.", "disabled": true }, { "key": "logradouro", "value": "", "description": "", "disabled": true }, { "key": "numero", "value": "", "description": "", "disabled": true }, { "key": "complemento", "value": "", "description": "", "disabled": true }, { "key": "bairro", "value": "", "description": "", "disabled": true }, { "key": "localidade", "value": "", "description": "Cidade.", "disabled": true }, { "key": "estado", "value": "", "description": "UF.", "disabled": true }, { "key": "telefone", "value": "", "description": "Com DDD.", "disabled": true }, { "key": "celular", "value": "", "description": "Com DDD.", "disabled": true }, { "key": "email", "value": "", "description": "", "disabled": true } ] }, "description": "Compara os dados informados com a base do bureau e devolve o grau de semelhança de cada bloco, a situação do CPF e se há indicação de óbito. Cada chamada consulta o bureau (serviço pago) e fica registrada. Só GET. Os parâmetros vão na query (ou no corpo como application/x-www-form-urlencoded); corpo JSON não é lido.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET validarPessoaJuridica — Semelhança dos dados com o bureau", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/validarPessoaJuridica?documento=11222333000181", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "validarPessoaJuridica" ], "query": [ { "key": "documento", "value": "11222333000181", "description": "CNPJ.", "disabled": false }, { "key": "razao_social", "value": "", "description": "", "disabled": true }, { "key": "nome_fantasia", "value": "", "description": "", "disabled": true }, { "key": "data_fundacao", "value": "", "description": "AAAA-MM-DD.", "disabled": true }, { "key": "cep", "value": "", "description": "CEP informado pelo cliente.", "disabled": true }, { "key": "logradouro", "value": "", "description": "", "disabled": true }, { "key": "numero", "value": "", "description": "", "disabled": true }, { "key": "complemento", "value": "", "description": "", "disabled": true }, { "key": "bairro", "value": "", "description": "", "disabled": true }, { "key": "localidade", "value": "", "description": "Cidade.", "disabled": true }, { "key": "estado", "value": "", "description": "UF.", "disabled": true }, { "key": "telefone", "value": "", "description": "Com DDD.", "disabled": true }, { "key": "celular", "value": "", "description": "Com DDD.", "disabled": true }, { "key": "email", "value": "", "description": "", "disabled": true } ] }, "description": "Como validarPessoaFisica, para CNPJ: semelhança dos dados informados com o bureau, situação do CNPJ e se está inativo. Cada chamada consulta o bureau (serviço pago) e fica registrada. Só GET. Os parâmetros vão na query (ou no corpo como application/x-www-form-urlencoded); corpo JSON não é lido.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "GET txObservacao — Consulta uma observação ou as de um registro", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [ { "key": "id_tx_observacao", "value": "", "description": "Id da observação (tem prioridade).", "disabled": true }, { "key": "tabela", "value": "", "description": "Tabela (usar junto com id quando não houver id_tx_observacao).", "disabled": true }, { "key": "id", "value": "", "description": "Id do registro na tabela.", "disabled": true } ] }, "description": "Por id_tx_observacao a resposta é um objeto plano (sem data[] e, no ZP, sem data_hora): {status, id_tx_observacao, tabela, id, observacao, ativo}.\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } }, { "name": "POST txObservacao — Cria uma observação", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [] }, "description": "Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"tabela\": \"cob_cobranca\",\n \"id\": 5001,\n \"observacao\": \"Cliente pediu segunda via\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT txObservacao — Altera uma observação (parcial)", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao?id_tx_observacao=", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [ { "key": "id_tx_observacao", "value": "", "description": "Id da observação", "disabled": false } ] }, "description": "Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"observacao\": \"Texto corrigido\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE txObservacao — Desativa uma observação", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao?id_tx_observacao=", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [ { "key": "id_tx_observacao", "value": "", "description": "Id da observação", "disabled": false } ] }, "description": "Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).\n\nPerfis: App, Rede, Estabelecimento, Cliente, Pessoa." } } ] } ] }