{ "info": { "name": "API Fiscal - API Fiscal (NF-e, NFC-e, NFS-e, CT-e, MDF-e)", "description": "Collection oficial da API Fiscal.\n\n1. Crie sua API Key em Painel > API Keys.\n2. Em Variables desta collection, preencha `api_key` (fiscal_test_... para sandbox/homologacao ou fiscal_live_... para producao).\n3. Ajuste `empresa` (codigo da empresa) e `id` (devolvido na emissao) quando necessario.\n\nAutenticacao: Authorization: Bearer {{api_key}} (alternativa: X-API-Key).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://fiscal.versianecode.com.br/api/v1", "type": "string" }, { "key": "api_key", "value": "", "type": "secret" }, { "key": "empresa", "value": "EMPRESA_001", "type": "string" }, { "key": "empresa_id", "value": "1", "type": "string" }, { "key": "id", "value": "1", "type": "string" }, { "key": "nfe_id", "value": "1", "type": "string" }, { "key": "nfse_id", "value": "1", "type": "string" }, { "key": "cte_id", "value": "1", "type": "string" }, { "key": "cteos_id", "value": "1", "type": "string" }, { "key": "mdfe_id", "value": "1", "type": "string" }, { "key": "webhook_id", "value": "1", "type": "string" }, { "key": "dfe_id", "value": "1", "type": "string" }, { "key": "solicitacao_id", "value": "sol_00000000000000000000", "type": "string" } ], "item": [ { "name": "NF-e", "item": [ { "name": "POST /nfe - Emitir NF-e (modelo 55)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/nfe", "host": [ "{{base_url}}" ], "path": [ "nfe" ] }, "description": "Recebe o JSON minimo (pedido, cliente, itens e pagamento). A API obtem emitente, certificado, natureza, serie e numeracao da configuracao da empresa; o Motor Tributario resolve CFOP, CST/CSOSN, ICMS, PIS, COFINS e IBS/CBS; valida, assina e transmite a SEFAZ. Sem regra suficiente NAO emite: responde 422 FISCAL_CONFIGURATION_REQUIRED dizendo o que configurar.\n\nPermissao da chave: `emitir`.\n\nObrigatorios: pedido, cliente, itens[].codigo, itens[].quantidade, pagamento.\nOpcionais: empresa (obrigatorio so se sua conta tem mais de uma), itens[].valor (padrao: preco do produto), itens[].desconto, natureza, observacoes, presenca (presencial|internet|telefone|entrega|outros), intermediador {cnpj,id} (presenca diferente de presencial; padrao: sem intermediador), consumidor_final, frete.modalidade.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"PED-12345\",\n \"cliente\": \"CLI001\",\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"quantidade\": 2\n }\n ],\n \"pagamento\": \"pix\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/nfe", "host": [ "{{base_url}}" ], "path": [ "nfe" ] }, "description": "Recebe o JSON minimo (pedido, cliente, itens e pagamento). A API obtem emitente, certificado, natureza, serie e numeracao da configuracao da empresa; o Motor Tributario resolve CFOP, CST/CSOSN, ICMS, PIS, COFINS e IBS/CBS; valida, assina e transmite a SEFAZ. Sem regra suficiente NAO emite: responde 422 FISCAL_CONFIGURATION_REQUIRED dizendo o que configurar.\n\nPermissao da chave: `emitir`.\n\nObrigatorios: pedido, cliente, itens[].codigo, itens[].quantidade, pagamento.\nOpcionais: empresa (obrigatorio so se sua conta tem mais de uma), itens[].valor (padrao: preco do produto), itens[].desconto, natureza, observacoes, presenca (presencial|internet|telefone|entrega|outros), intermediador {cnpj,id} (presenca diferente de presencial; padrao: sem intermediador), consumidor_final, frete.modalidade.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"PED-12345\",\n \"cliente\": \"CLI001\",\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"quantidade\": 2\n }\n ],\n \"pagamento\": \"pix\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"AUTORIZADA\",\n \"id\": \"43\",\n \"numero\": 1,\n \"serie\": 1,\n \"chave\": \"3524...\",\n \"protocolo\": \"135240000000001\",\n \"xml\": \"/api/v1/nfe/43/xml\",\n \"danfe\": \"/api/v1/nfe/43/danfe\",\n \"request_id\": \"req_a1b2c3d4e5f6a7b8c9d0\"\n}" } ] } ] }, { "name": "NFC-e", "item": [ { "name": "POST /nfce - Emitir NFC-e (modelo 65)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfce", "host": [ "{{base_url}}" ], "path": [ "nfce" ] }, "description": "Mesmo JSON da NF-e; o cliente e opcional e nao exige endereco.\n\nPermissao da chave: `emitir`.\n\nObrigatorios: pedido, itens[].codigo, itens[].quantidade, pagamento.\nOpcionais: empresa, cliente, itens[].valor, natureza, observacoes.", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"PED-9\",\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"quantidade\": 1\n }\n ],\n \"pagamento\": \"dinheiro\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfce", "host": [ "{{base_url}}" ], "path": [ "nfce" ] }, "description": "Mesmo JSON da NF-e; o cliente e opcional e nao exige endereco.\n\nPermissao da chave: `emitir`.\n\nObrigatorios: pedido, itens[].codigo, itens[].quantidade, pagamento.\nOpcionais: empresa, cliente, itens[].valor, natureza, observacoes.", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"PED-9\",\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"quantidade\": 1\n }\n ],\n \"pagamento\": \"dinheiro\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"AUTORIZADA\",\n \"id\": \"44\",\n \"numero\": 1,\n \"serie\": 1,\n \"danfe\": \"/api/v1/nfce/44/danfce\",\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Fiscal", "item": [ { "name": "POST /fiscal/preview - Pre-visualizar calculo (nao emite)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/preview", "host": [ "{{base_url}}" ], "path": [ "fiscal", "preview" ] }, "description": "Enriquece, aplica regras, valida e calcula tributos sem transmitir nada.\n\nPermissao da chave: `preview`.\n\nObrigatorios: itens[], pagamento.\nOpcionais: modelo (55|65, padrao 55), demais campos da emissao.", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"PED-12345\",\n \"cliente\": \"CLI001\",\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"quantidade\": 2\n }\n ],\n \"pagamento\": \"pix\",\n \"modelo\": 55\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/preview", "host": [ "{{base_url}}" ], "path": [ "fiscal", "preview" ] }, "description": "Enriquece, aplica regras, valida e calcula tributos sem transmitir nada.\n\nPermissao da chave: `preview`.\n\nObrigatorios: itens[], pagamento.\nOpcionais: modelo (55|65, padrao 55), demais campos da emissao.", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"PED-12345\",\n \"cliente\": \"CLI001\",\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"quantidade\": 2\n }\n ],\n \"pagamento\": \"pix\",\n \"modelo\": 55\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"ready_to_issue\": true,\n \"document\": {\n \"modelo\": 55,\n \"itens\": [\n {\n \"codigo\": \"PROD001\",\n \"cfop\": \"5102\",\n \"regra_tributaria_id\": 12,\n \"regra_iva_id\": null,\n \"decisao_tributaria\": {\n \"data_operacao\": \"2026-09-29\",\n \"regra_tributaria\": {\n \"regra_id\": 12,\n \"tipo_regra\": \"tributaria\",\n \"prioridade\": 100,\n \"criterios_correspondentes\": [\n \"crt\",\n \"operacao\",\n \"ncm\"\n ]\n }\n }\n }\n ],\n \"totais\": {\n \"vProd\": 200,\n \"vNF\": 200\n }\n },\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Consulta", "item": [ { "name": "GET /nfe/{id} - Consultar NF-e / NFC-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}" ] }, "description": "Status, numero, serie, chave, protocolo e eventos. Documentos PENDENTE sao reconciliados com a SEFAZ. Use /nfce/{id} para NFC-e.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}" ] }, "description": "Status, numero, serie, chave, protocolo e eventos. Documentos PENDENTE sao reconciliados com a SEFAZ. Use /nfce/{id} para NFC-e.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"43\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"3524...\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /nfe/{id}/eventos - Historico de eventos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/eventos", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "eventos" ] }, "description": "Cancelamentos e cartas de correcao do documento (tambem /nfce/{id}/eventos).\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/eventos", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "eventos" ] }, "description": "Cancelamentos e cartas de correcao do documento (tambem /nfce/{id}/eventos).\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"eventos\": [\n {\n \"tipo\": \"CANCELAMENTO\",\n \"status\": \"REGISTRADO\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /nfe/{id}/xml - Baixar XML", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/xml", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "xml" ] }, "description": "XML autorizado (application/xml). Tambem /nfce/{id}/xml.\n\nPermissao da chave: `download`." }, "response": [] }, { "name": "GET /nfe/{id}/danfe - Baixar DANFE / DANFCE (PDF)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/danfe", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "danfe" ] }, "description": "PDF do DANFE (NF-e) em /nfe/{id}/danfe ou do DANFCE (NFC-e) em /nfce/{id}/danfce.\n\nPermissao da chave: `download`." }, "response": [] } ] }, { "name": "Eventos", "item": [ { "name": "POST /nfe/{id}/cancelamento - Cancelar documento", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/cancelamento", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "cancelamento" ] }, "description": "Cancela NF-e ou NFC-e (/nfce/{id}/cancelamento).\n\nPermissao da chave: `cancelar`.\n\nObrigatorios: justificativa (15 a 255 caracteres).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Erro na digitacao do pedido\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/cancelamento", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "cancelamento" ] }, "description": "Cancela NF-e ou NFC-e (/nfce/{id}/cancelamento).\n\nPermissao da chave: `cancelar`.\n\nObrigatorios: justificativa (15 a 255 caracteres).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Erro na digitacao do pedido\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"CANCELADA\",\n \"protocolo\": \"135...\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /nfe/{id}/cce - Carta de correcao (CC-e)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/cce", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "cce" ] }, "description": "A sequencia (1..20) e controlada pela API.\n\nPermissao da chave: `cce`.\n\nObrigatorios: correcao (15 a 1000 caracteres).", "body": { "mode": "raw", "raw": "{\n \"correcao\": \"Corrigir endereco de entrega para Rua B, 20\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfe/{{nfe_id}}/cce", "host": [ "{{base_url}}" ], "path": [ "nfe", "{{nfe_id}}", "cce" ] }, "description": "A sequencia (1..20) e controlada pela API.\n\nPermissao da chave: `cce`.\n\nObrigatorios: correcao (15 a 1000 caracteres).", "body": { "mode": "raw", "raw": "{\n \"correcao\": \"Corrigir endereco de entrega para Rua B, 20\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"sequencia\": 1,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /inutilizacao - Inutilizar numeracao", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/inutilizacao", "host": [ "{{base_url}}" ], "path": [ "inutilizacao" ] }, "description": "Inutiliza uma faixa de numeros nao utilizados.\n\nPermissao da chave: `inutilizar`.\n\nObrigatorios: modelo (55|65), numero_inicial, justificativa.\nOpcionais: empresa, serie, numero_final.", "body": { "mode": "raw", "raw": "{\n \"empresa\": \"EMPRESA_001\",\n \"modelo\": 55,\n \"numero_inicial\": 10,\n \"justificativa\": \"Numeracao pulada por falha de sistema\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/inutilizacao", "host": [ "{{base_url}}" ], "path": [ "inutilizacao" ] }, "description": "Inutiliza uma faixa de numeros nao utilizados.\n\nPermissao da chave: `inutilizar`.\n\nObrigatorios: modelo (55|65), numero_inicial, justificativa.\nOpcionais: empresa, serie, numero_final.", "body": { "mode": "raw", "raw": "{\n \"empresa\": \"EMPRESA_001\",\n \"modelo\": 55,\n \"numero_inicial\": 10,\n \"justificativa\": \"Numeracao pulada por falha de sistema\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"HOMOLOGADA\",\n \"protocolo\": \"135...\",\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Configuracao Fiscal", "item": [ { "name": "GET /configuracao-fiscal - Visao geral da configuracao fiscal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal" ] }, "description": "Status das 5 etapas (Emitente, Certificado, Natureza, Tributacao, IBS/CBS), percentual, pendencias, emitente e certificado (sem segredos). Query opcional: ?empresa=CODIGO (so entre as empresas da sua conta). Sem empresa cadastrada devolve 0% com a pendencia de emitente. Status por etapa: nao_configurado, incompleto, configurado, requer_atencao.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal" ] }, "description": "Status das 5 etapas (Emitente, Certificado, Natureza, Tributacao, IBS/CBS), percentual, pendencias, emitente e certificado (sem segredos). Query opcional: ?empresa=CODIGO (so entre as empresas da sua conta). Sem empresa cadastrada devolve 0% com a pendencia de emitente. Status por etapa: nao_configurado, incompleto, configurado, requer_atencao.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa\": \"EMPRESA_001\",\n \"configuracao_fiscal_percentual\": 75,\n \"pronta_para_emitir\": false,\n \"etapas\": {\n \"emitente\": {\n \"ordem\": 1,\n \"rotulo\": \"Emitente\",\n \"status\": \"configurado\",\n \"obrigatoria\": true\n },\n \"certificado\": {\n \"ordem\": 2,\n \"status\": \"nao_configurado\"\n },\n \"natureza\": {\n \"ordem\": 3,\n \"status\": \"configurado\"\n },\n \"tributacao\": {\n \"ordem\": 4,\n \"status\": \"configurado\"\n },\n \"iva\": {\n \"ordem\": 5,\n \"status\": \"nao_configurado\",\n \"obrigatoria\": false\n }\n },\n \"pendencias\": [\n \"Certificado: certificado digital A1 da empresa nao cadastrado.\"\n ],\n \"emitente\": {\n \"cnpj\": \"12345678000195\",\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"crt\": 3\n },\n \"certificado\": {\n \"status\": \"ausente\",\n \"valido\": false\n },\n \"totais\": {\n \"naturezas\": 1,\n \"regras_tributacao\": 3,\n \"regras_iva\": 0\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/validar - Validar se a empresa esta pronta para emitir", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/validar", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "validar" ] }, "description": "Executa o validador fiscal da configuracao. 200 quando pronta; 422 CONFIG_FISCAL_INCOMPLETA com a lista de pendencias em error.details.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/validar", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "validar" ] }, "description": "Executa o validador fiscal da configuracao. 200 quando pronta; 422 CONFIG_FISCAL_INCOMPLETA com a lista de pendencias em error.details.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"CONFIG_FISCAL_INCOMPLETA\",\n \"message\": \"A configuracao fiscal esta incompleta.\",\n \"details\": [\n \"Certificado: certificado digital A1 da empresa nao cadastrado.\"\n ]\n },\n \"configuracao_fiscal_percentual\": 75,\n \"pronta_para_emitir\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/cnpj/consultar - Consultar dados do CNPJ", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/cnpj/consultar", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "cnpj", "consultar" ] }, "description": "Busca razao social, fantasia, situacao cadastral, data de abertura, CNAE principal/secundarios, endereco, IBGE, UF (e cUF), telefone e e-mail (BrasilAPI e publica.cnpj.ws). NAO grava nada: o usuario revisa e confirma em POST/PUT /configuracao-fiscal/emitente. Cada campo vem com sua origem (AUTOMATICO, CALCULADO, SUGERIDO, CONFIRMACAO_OBRIGATORIA); o CRT e apenas sugestao e exige confirmacao. CFOP, CST, ICMS, PIS, COFINS, IBS, CBS e cClassTrib nunca sao inferidos do CNPJ.\n\nPermissao da chave: `consultar`.\n\nObrigatorios: cnpj (14 digitos, com ou sem mascara).", "body": { "mode": "raw", "raw": "{\n \"cnpj\": \"12345678000195\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/cnpj/consultar", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "cnpj", "consultar" ] }, "description": "Busca razao social, fantasia, situacao cadastral, data de abertura, CNAE principal/secundarios, endereco, IBGE, UF (e cUF), telefone e e-mail (BrasilAPI e publica.cnpj.ws). NAO grava nada: o usuario revisa e confirma em POST/PUT /configuracao-fiscal/emitente. Cada campo vem com sua origem (AUTOMATICO, CALCULADO, SUGERIDO, CONFIRMACAO_OBRIGATORIA); o CRT e apenas sugestao e exige confirmacao. CFOP, CST, ICMS, PIS, COFINS, IBS, CBS e cClassTrib nunca sao inferidos do CNPJ.\n\nPermissao da chave: `consultar`.\n\nObrigatorios: cnpj (14 digitos, com ou sem mascara).", "body": { "mode": "raw", "raw": "{\n \"cnpj\": \"12345678000195\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"dados\": {\n \"cnpj\": \"12345678000195\",\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"nome_fantasia\": \"EXEMPLO\",\n \"situacao_cadastral\": \"ATIVA\",\n \"data_abertura\": \"2015-03-10\",\n \"cnae\": \"4751201\",\n \"cnaes_secundarios\": [\n \"4753900\"\n ],\n \"cep\": \"38700000\",\n \"logradouro\": \"RUA DAS FLORES\",\n \"numero\": \"100\",\n \"bairro\": \"CENTRO\",\n \"municipio\": \"PATOS DE MINAS\",\n \"cod_municipio\": \"3148004\",\n \"uf\": \"MG\",\n \"cod_uf\": 31,\n \"telefone\": \"3433334444\",\n \"email\": \"contato@exemplo.com.br\",\n \"crt\": 1\n },\n \"origem\": {\n \"razao_social\": \"AUTOMATICO\",\n \"cod_uf\": \"CALCULADO\",\n \"crt\": \"CONFIRMACAO_OBRIGATORIA\"\n },\n \"fonte\": \"BrasilAPI / publica.cnpj.ws\",\n \"avisos\": [\n \"Inscricao estadual nao encontrada: informe-a manualmente (obrigatoria para emitir NF-e).\"\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/automatica - Gerar configuracao fiscal automatica", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/automatica", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "automatica" ] }, "description": "A partir do CNPJ/UF e do CRT do emitente gera naturezas (VENDA, VENDA_CONSUMIDOR), regras de tributacao (CFOP, CSOSN/CST ICMS, PIS/COFINS, ICMS interno/interestadual) e a regra IBS/CBS de 2026. Sao sugestoes marcadas com [Auto] e prioridade 50: regras suas sempre prevalecem; nada e apagado nem duplicado. Tambem roda sozinha ao salvar o emitente (desligue com \"config_automatica\": false).\n\nPermissao da chave: `configurar`.\nOpcionais: empresa (query), apuracao (presumido|real: so CRT 3, define PIS/COFINS 0,65/3,00 ou 1,65/7,60)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/automatica", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "automatica" ] }, "description": "A partir do CNPJ/UF e do CRT do emitente gera naturezas (VENDA, VENDA_CONSUMIDOR), regras de tributacao (CFOP, CSOSN/CST ICMS, PIS/COFINS, ICMS interno/interestadual) e a regra IBS/CBS de 2026. Sao sugestoes marcadas com [Auto] e prioridade 50: regras suas sempre prevalecem; nada e apagado nem duplicado. Tambem roda sozinha ao salvar o emitente (desligue com \"config_automatica\": false).\n\nPermissao da chave: `configurar`.\nOpcionais: empresa (query), apuracao (presumido|real: so CRT 3, define PIS/COFINS 0,65/3,00 ou 1,65/7,60)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"crt\": 1,\n \"regime\": \"Simples Nacional\",\n \"criados\": {\n \"naturezas\": 2,\n \"tributacao\": 3,\n \"iva\": 1\n },\n \"regras_automaticas_desativadas\": 0,\n \"avisos\": [\n \"IBS/CBS: gerada a regra de 2026 (ano de teste). Para 2027 em diante revise as aliquotas.\"\n ],\n \"configuracao_fiscal_percentual\": 80,\n \"pronta_para_emitir\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/emitente - Consultar o emitente", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/emitente", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "emitente" ] }, "description": "Dados do emitente da empresa (sem CSC, tokens ou senha do certificado).\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/emitente", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "emitente" ] }, "description": "Dados do emitente da empresa (sem CSC, tokens ou senha do certificado).\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"emitente\": {\n \"codigo\": \"EMPRESA_001\",\n \"cnpj\": \"12345678000195\",\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"crt\": 3,\n \"regime_tributario\": \"Regime Normal (Lucro Presumido/Real)\",\n \"uf\": \"MG\",\n \"cod_uf\": 31,\n \"origem_dados\": {\n \"razao_social\": \"AUTOMATICO\"\n },\n \"confirmado_em\": \"2026-09-29 16:06:00\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/emitente - Criar o emitente (empresa da conta)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/emitente", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "emitente" ] }, "description": "Cria a empresa vinculada ao usuario da API Key (NUNCA a um usuario_id enviado no corpo). A empresa nasce em HOMOLOGACAO. O envio equivale a confirmar os dados; se o CRT veio da consulta de CNPJ (origem CONFIRMACAO_OBRIGATORIA), envie \"confirmar\": true. Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: cnpj, razao_social, uf.\nOpcionais: nome_fantasia, ie, iest, im, crt (1|2|3|4), cnae, cnaes_secundarios[], cep, logradouro, numero, complemento, bairro, municipio, cod_municipio, telefone, email, serie_nfe, serie_nfce, csc_id, csc, exige_ibs_cbs, origem {campo: ORIGEM}, confirmar.", "body": { "mode": "raw", "raw": "{\n \"cnpj\": \"12345678000195\",\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"uf\": \"MG\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/emitente", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "emitente" ] }, "description": "Cria a empresa vinculada ao usuario da API Key (NUNCA a um usuario_id enviado no corpo). A empresa nasce em HOMOLOGACAO. O envio equivale a confirmar os dados; se o CRT veio da consulta de CNPJ (origem CONFIRMACAO_OBRIGATORIA), envie \"confirmar\": true. Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: cnpj, razao_social, uf.\nOpcionais: nome_fantasia, ie, iest, im, crt (1|2|3|4), cnae, cnaes_secundarios[], cep, logradouro, numero, complemento, bairro, municipio, cod_municipio, telefone, email, serie_nfe, serie_nfce, csc_id, csc, exige_ibs_cbs, origem {campo: ORIGEM}, confirmar.", "body": { "mode": "raw", "raw": "{\n \"cnpj\": \"12345678000195\",\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"uf\": \"MG\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa\": \"EMPRESA_002\",\n \"emitente\": {\n \"cnpj\": \"12345678000195\",\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /configuracao-fiscal/emitente - Atualizar / confirmar o emitente", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/emitente", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "emitente" ] }, "description": "Atualizacao parcial: so os campos enviados mudam. Registra valor anterior e novo na auditoria. O campo opcional \"empresa\" escolhe entre as empresas da sua conta.\n\nPermissao da chave: `configurar`.\nOpcionais: mesmos campos de POST /configuracao-fiscal/emitente, empresa.", "body": { "mode": "raw", "raw": "{\n \"ie\": \"0011223340000\",\n \"crt\": 3\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/emitente", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "emitente" ] }, "description": "Atualizacao parcial: so os campos enviados mudam. Registra valor anterior e novo na auditoria. O campo opcional \"empresa\" escolhe entre as empresas da sua conta.\n\nPermissao da chave: `configurar`.\nOpcionais: mesmos campos de POST /configuracao-fiscal/emitente, empresa.", "body": { "mode": "raw", "raw": "{\n \"ie\": \"0011223340000\",\n \"crt\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"emitente\": {\n \"razao_social\": \"EMPRESA EXEMPLO LTDA\",\n \"ie\": \"0011223340000\"\n },\n \"status\": {\n \"status\": \"configurado\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/certificado - Situacao do certificado digital", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/certificado", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "certificado" ] }, "description": "Status (ausente, ok, vence_em_breve <= 30 dias, vencido, invalido), titular, emissor, numero de serie, CNPJ, validade e dias restantes. Nunca devolve a senha.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/certificado", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "certificado" ] }, "description": "Status (ausente, ok, vence_em_breve <= 30 dias, vencido, invalido), titular, emissor, numero de serie, CNPJ, validade e dias restantes. Nunca devolve a senha.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa (query)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"certificado\": {\n \"status\": \"ok\",\n \"valido\": true,\n \"titular\": \"EMPRESA EXEMPLO LTDA:12345678000195\",\n \"emissor\": \"AC Certisign RFB G5\",\n \"numero_serie\": \"1274...\",\n \"cnpj\": \"12345678000195\",\n \"cnpj_confere_com_emitente\": true,\n \"validade\": \"2027-03-01\",\n \"dias_restantes\": 153,\n \"problemas\": [],\n \"codigos\": []\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/certificado - Enviar certificado digital A1 (.pfx/.p12)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/certificado", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "certificado" ] }, "description": "JSON com o arquivo em base64 e a senha (ou multipart: campo \"arquivo\" e \"senha\"). Valida senha, validade e CNPJ (raiz do CNPJ do certificado = raiz do emitente). A senha e criptografada (AES-256-GCM) e nunca e devolvida nem registrada em log.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: arquivo_base64, senha.\nOpcionais: empresa.", "body": { "mode": "raw", "raw": "{\n \"arquivo_base64\": \"MIIK...(.pfx em base64)\",\n \"senha\": \"SENHA_DO_CERTIFICADO\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/certificado", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "certificado" ] }, "description": "JSON com o arquivo em base64 e a senha (ou multipart: campo \"arquivo\" e \"senha\"). Valida senha, validade e CNPJ (raiz do CNPJ do certificado = raiz do emitente). A senha e criptografada (AES-256-GCM) e nunca e devolvida nem registrada em log.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: arquivo_base64, senha.\nOpcionais: empresa.", "body": { "mode": "raw", "raw": "{\n \"arquivo_base64\": \"MIIK...(.pfx em base64)\",\n \"senha\": \"SENHA_DO_CERTIFICADO\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"certificado\": {\n \"status\": \"ok\",\n \"valido\": true,\n \"validade\": \"2027-03-01\"\n },\n \"aviso\": null,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/logs - Historico de alteracoes da configuracao", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/logs", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "logs" ] }, "description": "Auditoria de emitente, certificado, natureza, tributacao e iva: usuario, acao, registro, valor anterior/novo, IP e data. Query: entidade, page, limit (max 100).\n\nPermissao da chave: `consultar`.\nOpcionais: entidade, page, limit, empresa." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/logs", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "logs" ] }, "description": "Auditoria de emitente, certificado, natureza, tributacao e iva: usuario, acao, registro, valor anterior/novo, IP e data. Query: entidade, page, limit (max 100).\n\nPermissao da chave: `consultar`.\nOpcionais: entidade, page, limit, empresa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"items\": [\n {\n \"id\": 10,\n \"acao\": \"atualizado\",\n \"entidade\": \"natureza\",\n \"registro_id\": \"3\",\n \"valor_anterior\": {\n \"descricao\": \"VENDA\"\n },\n \"valor_novo\": {\n \"descricao\": \"VENDA DE MERCADORIA\"\n },\n \"ip\": \"203.0.113.10\",\n \"criado_em\": \"2026-09-29 16:07:00\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Naturezas de Operacao", "item": [ { "name": "GET /configuracao-fiscal/naturezas - Listar naturezas de operacao", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/naturezas", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "naturezas" ] }, "description": "Naturezas da sua empresa. Query: ativo=1|0, empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: ativo, empresa." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/naturezas", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "naturezas" ] }, "description": "Naturezas da sua empresa. Query: ativo=1|0, empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: ativo, empresa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"items\": [\n {\n \"id\": 3,\n \"codigo\": \"VENDA\",\n \"descricao\": \"VENDA DE MERCADORIA\",\n \"tipo_operacao\": 1,\n \"finalidade\": 1,\n \"padrao_nfe\": 1,\n \"ativo\": 1\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/naturezas - Criar natureza de operacao", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/naturezas", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "naturezas" ] }, "description": "Varias naturezas por empresa (venda, devolucao, remessa, bonificacao, transferencia...). Apenas uma natureza e a padrao por modelo (padrao_nfe / padrao_nfce). O CFOP da natureza e informativo: quem decide o CFOP e a regra tributaria. Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: codigo, descricao (natOp, ate 60).\nOpcionais: tipo_operacao (1 saida | 0 entrada), finalidade (1..4), operacao_interna, operacao_interestadual, consumidor_final, contribuinte, cfop, observacoes, padrao_nfe, padrao_nfce, ativo.", "body": { "mode": "raw", "raw": "{\n \"codigo\": \"VENDA\",\n \"descricao\": \"VENDA DE MERCADORIA\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/naturezas", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "naturezas" ] }, "description": "Varias naturezas por empresa (venda, devolucao, remessa, bonificacao, transferencia...). Apenas uma natureza e a padrao por modelo (padrao_nfe / padrao_nfce). O CFOP da natureza e informativo: quem decide o CFOP e a regra tributaria. Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: codigo, descricao (natOp, ate 60).\nOpcionais: tipo_operacao (1 saida | 0 entrada), finalidade (1..4), operacao_interna, operacao_interestadual, consumidor_final, contribuinte, cfop, observacoes, padrao_nfe, padrao_nfce, ativo.", "body": { "mode": "raw", "raw": "{\n \"codigo\": \"VENDA\",\n \"descricao\": \"VENDA DE MERCADORIA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": 3,\n \"codigo\": \"VENDA\",\n \"descricao\": \"VENDA DE MERCADORIA\"\n },\n \"avisos\": [],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/naturezas/{id} - Consultar natureza (PUT atualiza, DELETE desativa)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/naturezas/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "naturezas", "{{id}}" ] }, "description": "GET consulta; PUT /configuracao-fiscal/naturezas/{id} atualiza parcialmente (mesmos campos do POST, permissao configurar); DELETE apenas desativa (dados e historico preservados). Registro de outra empresa responde 404.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/naturezas/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "naturezas", "{{id}}" ] }, "description": "GET consulta; PUT /configuracao-fiscal/naturezas/{id} atualiza parcialmente (mesmos campos do POST, permissao configurar); DELETE apenas desativa (dados e historico preservados). Registro de outra empresa responde 404.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": 3,\n \"codigo\": \"VENDA\"\n },\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Regras de Tributacao", "item": [ { "name": "GET /configuracao-fiscal/tributacao - Listar regras de tributacao", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/tributacao", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "tributacao" ] }, "description": "Regras da empresa, da mais prioritaria para a menos. Query: ativo, empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: ativo, empresa." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/tributacao", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "tributacao" ] }, "description": "Regras da empresa, da mais prioritaria para a menos. Query: ativo, empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: ativo, empresa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"items\": [\n {\n \"id\": 12,\n \"descricao\": \"Interna geral\",\n \"crt\": 3,\n \"operacao\": \"interna\",\n \"cfop\": \"5102\",\n \"cst_icms\": \"00\",\n \"aliq_icms\": \"18.0000\",\n \"prioridade\": 100,\n \"vigencia_inicio\": null,\n \"vigencia_fim\": null\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/tributacao - Criar regra de tributacao", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/tributacao", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "tributacao" ] }, "description": "Define CFOP e a tributacao (CSOSN ou CST de ICMS, aliquota, reducao de BC, PIS, COFINS) para os criterios informados; criterio em branco = qualquer. O Motor Tributario escolhe a regra vigente MAIS ESPECIFICA (mais criterios que casam), desempata por prioridade e devolve conflito se duas empatarem. A resposta traz avisos quando a regra conflita com outra ativa. Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: cfop.\nOpcionais: descricao, prioridade, vigencia_inicio, vigencia_fim, modelo (55|65), crt (1..4), natureza_id, produto_id, ncm (prefixo), cest, categoria, origem (0..8), uf_origem, uf_destino, operacao (interna|interestadual|exterior), tipo_destinatario (PF|PJ), consumidor_final, contribuinte, csosn, cst_icms, aliq_icms, red_bc, aliq_cred_sn, cst_pis, aliq_pis, cst_cofins, aliq_cofins, inf_cpl, ativo.", "body": { "mode": "raw", "raw": "{\n \"cfop\": \"5102\",\n \"crt\": 3,\n \"operacao\": \"interna\",\n \"cst_icms\": \"00\",\n \"aliq_icms\": 18,\n \"cst_pis\": \"01\",\n \"aliq_pis\": 1.65,\n \"cst_cofins\": \"01\",\n \"aliq_cofins\": 7.6\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/tributacao", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "tributacao" ] }, "description": "Define CFOP e a tributacao (CSOSN ou CST de ICMS, aliquota, reducao de BC, PIS, COFINS) para os criterios informados; criterio em branco = qualquer. O Motor Tributario escolhe a regra vigente MAIS ESPECIFICA (mais criterios que casam), desempata por prioridade e devolve conflito se duas empatarem. A resposta traz avisos quando a regra conflita com outra ativa. Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: cfop.\nOpcionais: descricao, prioridade, vigencia_inicio, vigencia_fim, modelo (55|65), crt (1..4), natureza_id, produto_id, ncm (prefixo), cest, categoria, origem (0..8), uf_origem, uf_destino, operacao (interna|interestadual|exterior), tipo_destinatario (PF|PJ), consumidor_final, contribuinte, csosn, cst_icms, aliq_icms, red_bc, aliq_cred_sn, cst_pis, aliq_pis, cst_cofins, aliq_cofins, inf_cpl, ativo.", "body": { "mode": "raw", "raw": "{\n \"cfop\": \"5102\",\n \"crt\": 3,\n \"operacao\": \"interna\",\n \"cst_icms\": \"00\",\n \"aliq_icms\": 18,\n \"cst_pis\": \"01\",\n \"aliq_pis\": 1.65,\n \"cst_cofins\": \"01\",\n \"aliq_cofins\": 7.6\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": 12,\n \"cfop\": \"5102\"\n },\n \"avisos\": [],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/tributacao/{id} - Consultar regra (PUT atualiza, DELETE desativa)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/tributacao/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "tributacao", "{{id}}" ] }, "description": "GET consulta; PUT atualiza parcialmente; DELETE desativa (nunca apaga: documentos emitidos guardam a regra usada). Para mudar aliquotas ao longo do tempo, encerre a vigencia da regra antiga e crie outra.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/tributacao/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "tributacao", "{{id}}" ] }, "description": "GET consulta; PUT atualiza parcialmente; DELETE desativa (nunca apaga: documentos emitidos guardam a regra usada). Para mudar aliquotas ao longo do tempo, encerre a vigencia da regra antiga e crie outra.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": 12\n },\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Regras IVA (IBS/CBS)", "item": [ { "name": "GET /configuracao-fiscal/iva - Listar regras IVA (IBS/CBS)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/iva", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "iva" ] }, "description": "Regras de IBS/CBS/cClassTrib da empresa. Query: ativo, empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: ativo, empresa." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/iva", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "iva" ] }, "description": "Regras de IBS/CBS/cClassTrib da empresa. Query: ativo, empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: ativo, empresa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"items\": [\n {\n \"id\": 5,\n \"ncm\": \"4444\",\n \"cst\": \"000\",\n \"cclasstrib\": \"000001\",\n \"ibs_p_uf\": \"0.1000\",\n \"ibs_p_mun\": \"0.0000\",\n \"cbs_p\": \"0.9000\",\n \"ativo\": 1\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/iva - Criar regra IVA (IBS/CBS)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/iva", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "iva" ] }, "description": "Define CST (3 digitos), cClassTrib (6 digitos) e aliquotas de IBS (UF e municipio) e CBS, com reducao de aliquota (gRed), diferimento (gDif), vigencia e criterios (produto, NCM, NBS, natureza, destinatario, UF, municipio, operacao). Integrada ao Motor Tributario: e resolvida junto com a tributacao tradicional pela data da operacao. Credito presumido e informativo (nao e emitido no XML). Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: cst, cclasstrib.\nOpcionais: descricao, prioridade, vigencia_inicio, vigencia_fim, modelo, natureza_id, produto_id, ncm, nbs, categoria, uf_destino, cod_municipio_destino, operacao, consumidor_final, contribuinte, tipo_destinatario, classificacao, regime (regular|regime_especifico|tratamento_diferenciado), ibs_p_uf, ibs_p_mun, cbs_p, red_aliq_ibs_uf, red_aliq_ibs_mun, red_aliq_cbs, dif_p_ibs_uf, dif_p_ibs_mun, dif_p_cbs, cred_presumido_p, inf_cpl, ativo.", "body": { "mode": "raw", "raw": "{\n \"cst\": \"000\",\n \"cclasstrib\": \"000001\",\n \"ibs_p_uf\": 0.1,\n \"ibs_p_mun\": 0,\n \"cbs_p\": 0.9\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/iva", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "iva" ] }, "description": "Define CST (3 digitos), cClassTrib (6 digitos) e aliquotas de IBS (UF e municipio) e CBS, com reducao de aliquota (gRed), diferimento (gDif), vigencia e criterios (produto, NCM, NBS, natureza, destinatario, UF, municipio, operacao). Integrada ao Motor Tributario: e resolvida junto com a tributacao tradicional pela data da operacao. Credito presumido e informativo (nao e emitido no XML). Resposta 201.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: cst, cclasstrib.\nOpcionais: descricao, prioridade, vigencia_inicio, vigencia_fim, modelo, natureza_id, produto_id, ncm, nbs, categoria, uf_destino, cod_municipio_destino, operacao, consumidor_final, contribuinte, tipo_destinatario, classificacao, regime (regular|regime_especifico|tratamento_diferenciado), ibs_p_uf, ibs_p_mun, cbs_p, red_aliq_ibs_uf, red_aliq_ibs_mun, red_aliq_cbs, dif_p_ibs_uf, dif_p_ibs_mun, dif_p_cbs, cred_presumido_p, inf_cpl, ativo.", "body": { "mode": "raw", "raw": "{\n \"cst\": \"000\",\n \"cclasstrib\": \"000001\",\n \"ibs_p_uf\": 0.1,\n \"ibs_p_mun\": 0,\n \"cbs_p\": 0.9\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": 5,\n \"cst\": \"000\",\n \"cclasstrib\": \"000001\"\n },\n \"avisos\": [],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/iva/{id} - Consultar regra IVA (PUT atualiza, DELETE desativa)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/iva/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "iva", "{{id}}" ] }, "description": "GET consulta; PUT atualiza parcialmente; DELETE desativa. Documentos ja emitidos mantem a regra IVA usada (snapshot).\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/iva/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "iva", "{{id}}" ] }, "description": "GET consulta; PUT atualiza parcialmente; DELETE desativa. Documentos ja emitidos mantem a regra IVA usada (snapshot).\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": 5\n },\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Financeiro (creditos)", "item": [ { "name": "GET /financeiro/status - Situacao financeira", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/financeiro/status", "host": [ "{{base_url}}" ], "path": [ "financeiro", "status" ] }, "description": "Saldo, precos por emissao e se ha creditos ilimitados ativos (concessao do administrador). Sempre da carteira do proprio usuario da chave.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/financeiro/status", "host": [ "{{base_url}}" ], "path": [ "financeiro", "status" ] }, "description": "Saldo, precos por emissao e se ha creditos ilimitados ativos (concessao do administrador). Sempre da carteira do proprio usuario da chave.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"credito_ilimitado\": false,\n \"saldo\": \"37.50\",\n \"saldo_baixo\": false,\n \"alerta_saldo\": \"10.00\",\n \"precos\": {\n \"NFE\": \"1.50\",\n \"NFCE\": \"0.75\"\n },\n \"moeda\": \"BRL\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /financeiro/saldo - Saldo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/financeiro/saldo", "host": [ "{{base_url}}" ], "path": [ "financeiro", "saldo" ] }, "description": "Saldo atual da carteira (valores em BRL, string decimal). Com creditos ilimitados o saldo e preservado, mas nao e consumido.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/financeiro/saldo", "host": [ "{{base_url}}" ], "path": [ "financeiro", "saldo" ] }, "description": "Saldo atual da carteira (valores em BRL, string decimal). Com creditos ilimitados o saldo e preservado, mas nao e consumido.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"saldo\": \"37.50\",\n \"credito_ilimitado\": false,\n \"moeda\": \"BRL\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /financeiro/extrato - Extrato", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/financeiro/extrato", "host": [ "{{base_url}}" ], "path": [ "financeiro", "extrato" ] }, "description": "Movimentacoes da carteira (ledger), da mais recente para a mais antiga. Query: pagina, por_pagina (ate 100), de/ate (AAAA-MM-DD), tipo (CREDITO_COMPRA, CREDITO_ADMIN, DEBITO_EMISSAO, ESTORNO, AJUSTE_ADMIN, REEMBOLSO). valor negativo = saida.\n\nPermissao da chave: `consultar`.\nOpcionais: pagina, por_pagina, de, ate, tipo." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/financeiro/extrato", "host": [ "{{base_url}}" ], "path": [ "financeiro", "extrato" ] }, "description": "Movimentacoes da carteira (ledger), da mais recente para a mais antiga. Query: pagina, por_pagina (ate 100), de/ate (AAAA-MM-DD), tipo (CREDITO_COMPRA, CREDITO_ADMIN, DEBITO_EMISSAO, ESTORNO, AJUSTE_ADMIN, REEMBOLSO). valor negativo = saida.\n\nPermissao da chave: `consultar`.\nOpcionais: pagina, por_pagina, de, ate, tipo." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"saldo\": \"37.50\",\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"total\": 1,\n \"movimentacoes\": [\n {\n \"id\": 10,\n \"tipo\": \"DEBITO_EMISSAO\",\n \"valor\": \"-1.50\",\n \"saldo_anterior\": \"39.00\",\n \"saldo_posterior\": \"37.50\",\n \"tipo_documento\": \"NFE\",\n \"documento_id\": 43,\n \"pagamento_id\": null,\n \"referencia\": \"emissao:...\",\n \"descricao\": \"Emissao NFE - pedido PED-1\",\n \"data\": \"2026-01-01 10:00:00\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Fiscal Engine", "item": [ { "name": "POST /fiscal/calcular - Calcular (Motor Tributario, sem emitir)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/calcular", "host": [ "{{base_url}}" ], "path": [ "fiscal", "calcular" ] }, "description": "Executa o Motor Tributario Central para qualquer documento (NFE, NFCE, NFSE, CTE, MDFE) e contexto, SEM emitir, cobrar ou falar com SEFAZ/Sistema Nacional. \"operacao\" e o mesmo JSON minimo da emissao (NF-e/NFC-e dispensam o pagamento). Devolve taxes, classifications, rules_used (fonte/versao/vigencia), warnings, confidence_score e requires_review. A legislacao e escolhida pela data da operacao (data_operacao, apenas para simulacao). Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `preview`.\n\nObrigatorios: documento (NFE|NFCE|NFSE|CTE|CTEOS|MDFE), operacao {}.\nOpcionais: empresa_id | empresa, contexto (PRODUTOR_RURAL), operacao.data_operacao (simulacao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"documento\": \"NFSE\",\n \"operacao\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/calcular", "host": [ "{{base_url}}" ], "path": [ "fiscal", "calcular" ] }, "description": "Executa o Motor Tributario Central para qualquer documento (NFE, NFCE, NFSE, CTE, MDFE) e contexto, SEM emitir, cobrar ou falar com SEFAZ/Sistema Nacional. \"operacao\" e o mesmo JSON minimo da emissao (NF-e/NFC-e dispensam o pagamento). Devolve taxes, classifications, rules_used (fonte/versao/vigencia), warnings, confidence_score e requires_review. A legislacao e escolhida pela data da operacao (data_operacao, apenas para simulacao). Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `preview`.\n\nObrigatorios: documento (NFE|NFCE|NFSE|CTE|CTEOS|MDFE), operacao {}.\nOpcionais: empresa_id | empresa, contexto (PRODUTOR_RURAL), operacao.data_operacao (simulacao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"documento\": \"NFSE\",\n \"operacao\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"document\": \"NFSE\",\n \"taxes\": {\n \"iss\": {\n \"tipo\": \"tributavel\",\n \"base\": 1500,\n \"rate\": 2.5,\n \"valor\": 37.5\n }\n },\n \"classifications\": {\n \"cTribNac\": \"010701\",\n \"municipio_incidencia\": \"3148004\",\n \"tpRetISSQN\": 1\n },\n \"rules_used\": [\n {\n \"rule_id\": 81,\n \"tipo\": \"ISS\",\n \"versao\": \"2026.1\",\n \"fonte\": \"Lei Complementar Municipal ...\",\n \"vigencia_inicio\": \"2026-01-01\"\n }\n ],\n \"warnings\": [],\n \"confidence_score\": 0.95,\n \"requires_review\": false,\n \"request_id\": \"req_...\"\n}" }, { "name": "Requer revisao (sem regra de ISS vigente)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/calcular", "host": [ "{{base_url}}" ], "path": [ "fiscal", "calcular" ] }, "description": "Executa o Motor Tributario Central para qualquer documento (NFE, NFCE, NFSE, CTE, MDFE) e contexto, SEM emitir, cobrar ou falar com SEFAZ/Sistema Nacional. \"operacao\" e o mesmo JSON minimo da emissao (NF-e/NFC-e dispensam o pagamento). Devolve taxes, classifications, rules_used (fonte/versao/vigencia), warnings, confidence_score e requires_review. A legislacao e escolhida pela data da operacao (data_operacao, apenas para simulacao). Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `preview`.\n\nObrigatorios: documento (NFE|NFCE|NFSE|CTE|CTEOS|MDFE), operacao {}.\nOpcionais: empresa_id | empresa, contexto (PRODUTOR_RURAL), operacao.data_operacao (simulacao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"documento\": \"NFSE\",\n \"operacao\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Exemplo", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"requires_review\": true,\n \"confidence_score\": 0.3,\n \"errors\": [\n {\n \"code\": \"ISS_SEM_REGRA\",\n \"message\": \"nao ha aliquota de ISS configurada nem regra vigente na data 2026-03-10.\"\n }\n ],\n \"warnings\": [\n \"aliquota de ISS nao determinada ...\"\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /fiscal/validate - Validar (dry-run)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/validate", "host": [ "{{base_url}}" ], "path": [ "fiscal", "validate" ] }, "description": "Dry-run completo: o mesmo calculo de /fiscal/calcular + validacao do documento (DPS/XML no leiaute oficial) + consistencia. Sem SEFAZ/Sistema Nacional, sem cobranca, sem emissao. Retorna valid e ready_to_issue (false quando requires_review ou o leiaute reprova).\n\nPermissao da chave: `preview`.\n\nObrigatorios: documento, operacao {}.\nOpcionais: empresa_id | empresa, contexto.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"documento\": \"CTE\",\n \"operacao\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"FRETE-0001\",\n \"tomador\": \"destinatario\",\n \"remetente\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Remetente Industria Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"destinatario\": {\n \"cpf_cnpj\": \"00000000000191\",\n \"nome\": \"Destinatario Comercio SA\",\n \"ie\": \"110042490114\",\n \"endereco\": {\n \"logradouro\": \"Av. B\",\n \"numero\": \"200\",\n \"bairro\": \"Se\",\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\",\n \"cep\": \"01001000\"\n }\n },\n \"valor_prestacao\": 1000,\n \"carga\": {\n \"valor\": 50000,\n \"produto\": \"Tubos plasticos\",\n \"peso_kg\": 18145\n },\n \"documentos\": [\n \"31260960701190000104550010000001231123456789\"\n ],\n \"fiscal\": {\n \"tipo_estabelecimento_tomador\": \"comercial\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/validate", "host": [ "{{base_url}}" ], "path": [ "fiscal", "validate" ] }, "description": "Dry-run completo: o mesmo calculo de /fiscal/calcular + validacao do documento (DPS/XML no leiaute oficial) + consistencia. Sem SEFAZ/Sistema Nacional, sem cobranca, sem emissao. Retorna valid e ready_to_issue (false quando requires_review ou o leiaute reprova).\n\nPermissao da chave: `preview`.\n\nObrigatorios: documento, operacao {}.\nOpcionais: empresa_id | empresa, contexto.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"documento\": \"CTE\",\n \"operacao\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"FRETE-0001\",\n \"tomador\": \"destinatario\",\n \"remetente\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Remetente Industria Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"destinatario\": {\n \"cpf_cnpj\": \"00000000000191\",\n \"nome\": \"Destinatario Comercio SA\",\n \"ie\": \"110042490114\",\n \"endereco\": {\n \"logradouro\": \"Av. B\",\n \"numero\": \"200\",\n \"bairro\": \"Se\",\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\",\n \"cep\": \"01001000\"\n }\n },\n \"valor_prestacao\": 1000,\n \"carga\": {\n \"valor\": 50000,\n \"produto\": \"Tubos plasticos\",\n \"peso_kg\": 18145\n },\n \"documentos\": [\n \"31260960701190000104550010000001231123456789\"\n ],\n \"fiscal\": {\n \"tipo_estabelecimento_tomador\": \"comercial\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"document\": \"CTE\",\n \"valid\": true,\n \"ready_to_issue\": true,\n \"xml_validado\": true,\n \"leiaute\": \"PL_CTe_400\",\n \"taxes\": {\n \"icms\": {\n \"cst\": \"00\",\n \"rate\": 12,\n \"valor\": 120\n }\n },\n \"confidence_score\": 0.9,\n \"requires_review\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/regras-base - Listar regras da base tributaria versionada", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base" ] }, "description": "Regras da empresa e globais da plataforma (somente leitura). Query: tipo (ISS, ISS_RETENCAO, RETENCAO_FEDERAL, MUNICIPIO_INCIDENCIA, ICMS_TRANSPORTE, RURAL_ICMS, RURAL_BENEFICIO, CFOP_OPERACAO, IBS_CBS), empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: tipo, empresa (query)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base" ] }, "description": "Regras da empresa e globais da plataforma (somente leitura). Query: tipo (ISS, ISS_RETENCAO, RETENCAO_FEDERAL, MUNICIPIO_INCIDENCIA, ICMS_TRANSPORTE, RURAL_ICMS, RURAL_BENEFICIO, CFOP_OPERACAO, IBS_CBS), empresa.\n\nPermissao da chave: `consultar`.\nOpcionais: tipo, empresa (query)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"itens\": [\n {\n \"id\": 81,\n \"config_id\": 25,\n \"tipo\": \"ISS\",\n \"criterios\": {\n \"municipio_ibge\": \"3148004\"\n },\n \"resultado\": {\n \"aliquota\": 2.5\n },\n \"vigencia_inicio\": \"2026-01-01\",\n \"vigencia_fim\": null,\n \"versao\": \"2026.1\",\n \"fonte\": \"Lei Complementar Municipal ...\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /configuracao-fiscal/regras-base - Cadastrar regra da base tributaria", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base" ] }, "description": "Toda regra exige tipo, criterios (casamento: igualdade, *_prefixo, *_in), resultado, vigencia_inicio, versao e FONTE (norma/fundamento). Beneficios (RURAL_ICMS diferente de NORMAL, RURAL_BENEFICIO) exigem resultado.fundamento. A aliquota/beneficio nunca e presumido pela plataforma. Alteracoes sao auditadas.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: tipo, criterios {}, resultado {}, vigencia_inicio, versao, fonte.\nOpcionais: vigencia_fim, descricao, referencia, prioridade, confianca (0..1), empresa_id.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"tipo\": \"ISS\",\n \"criterios\": {\n \"municipio_ibge\": \"3148004\",\n \"lc116_prefixo\": \"01\"\n },\n \"resultado\": {\n \"aliquota\": 2.5\n },\n \"vigencia_inicio\": \"2026-01-01\",\n \"versao\": \"2026.1\",\n \"fonte\": \"Lei Complementar Municipal ...\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base" ] }, "description": "Toda regra exige tipo, criterios (casamento: igualdade, *_prefixo, *_in), resultado, vigencia_inicio, versao e FONTE (norma/fundamento). Beneficios (RURAL_ICMS diferente de NORMAL, RURAL_BENEFICIO) exigem resultado.fundamento. A aliquota/beneficio nunca e presumido pela plataforma. Alteracoes sao auditadas.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: tipo, criterios {}, resultado {}, vigencia_inicio, versao, fonte.\nOpcionais: vigencia_fim, descricao, referencia, prioridade, confianca (0..1), empresa_id.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"tipo\": \"ISS\",\n \"criterios\": {\n \"municipio_ibge\": \"3148004\",\n \"lc116_prefixo\": \"01\"\n },\n \"resultado\": {\n \"aliquota\": 2.5\n },\n \"vigencia_inicio\": \"2026-01-01\",\n \"versao\": \"2026.1\",\n \"fonte\": \"Lei Complementar Municipal ...\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 81,\n \"tipo\": \"ISS\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /configuracao-fiscal/regras-base/{id} - Consultar regra", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base", "{{id}}" ] }, "description": "Regra da empresa ou global.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base", "{{id}}" ] }, "description": "Regra da empresa ou global.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 81,\n \"tipo\": \"ISS\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /configuracao-fiscal/regras-base/{id} - Alterar regra da empresa", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base", "{{id}}" ] }, "description": "Somente regras da propria empresa (as globais sao da plataforma). Emissoes ja feitas NAO mudam (snapshot imutavel).\n\nPermissao da chave: `configurar`.\nOpcionais: campos da criacao.", "body": { "mode": "raw", "raw": "{\n \"resultado\": {\n \"aliquota\": 3\n },\n \"fonte\": \"Lei Complementar Municipal ...\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base", "{{id}}" ] }, "description": "Somente regras da propria empresa (as globais sao da plataforma). Emissoes ja feitas NAO mudam (snapshot imutavel).\n\nPermissao da chave: `configurar`.\nOpcionais: campos da criacao.", "body": { "mode": "raw", "raw": "{\n \"resultado\": {\n \"aliquota\": 3\n },\n \"fonte\": \"Lei Complementar Municipal ...\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 81,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /configuracao-fiscal/regras-base/{id} - Desativar regra da empresa", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `configurar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuracao-fiscal/regras-base/{{id}}", "host": [ "{{base_url}}" ], "path": [ "configuracao-fiscal", "regras-base", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `configurar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 81,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "NFS-e", "item": [ { "name": "POST /nfse - Emitir NFS-e Nacional", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/nfse", "host": [ "{{base_url}}" ], "path": [ "nfse" ] }, "description": "JSON minimo: pedido, tomador e servico (cadastrado em /servicos ou inline com descricao, c_trib_nac e valor). A API monta a DPS, o Motor Tributario determina ISS (aliquota pela base versionada da data da operacao), retencoes, municipio de incidencia e classificacao, assina e envia ao Sistema Nacional da NFS-e (mTLS com o certificado A1 da empresa). Sem aliquota/regra vigente NAO emite (422). Idempotente (pedido e Idempotency-Key). Dependencias externas: certificado ICP-Brasil valido, convenio do municipio com o Sistema Nacional e XSD oficial (opcional) em storage/schemas/nfse.\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: pedido, servico.codigo OU (servico.descricao + servico.c_trib_nac + servico.valor).\nOpcionais: empresa_id | empresa, tomador {cpf_cnpj, nome, email, endereco}, competencia, desconto, observacoes, servico.valor/lc116/nbs/cnae/local_prestacao, servico.aliquota_iss e servico.iss_retido (OVERRIDE: exigem permissao override + override_motivo), aceitar_revisao (requer override).\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/nfse", "host": [ "{{base_url}}" ], "path": [ "nfse" ] }, "description": "JSON minimo: pedido, tomador e servico (cadastrado em /servicos ou inline com descricao, c_trib_nac e valor). A API monta a DPS, o Motor Tributario determina ISS (aliquota pela base versionada da data da operacao), retencoes, municipio de incidencia e classificacao, assina e envia ao Sistema Nacional da NFS-e (mTLS com o certificado A1 da empresa). Sem aliquota/regra vigente NAO emite (422). Idempotente (pedido e Idempotency-Key). Dependencias externas: certificado ICP-Brasil valido, convenio do municipio com o Sistema Nacional e XSD oficial (opcional) em storage/schemas/nfse.\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: pedido, servico.codigo OU (servico.descricao + servico.c_trib_nac + servico.valor).\nOpcionais: empresa_id | empresa, tomador {cpf_cnpj, nome, email, endereco}, competencia, desconto, observacoes, servico.valor/lc116/nbs/cnae/local_prestacao, servico.aliquota_iss e servico.iss_retido (OVERRIDE: exigem permissao override + override_motivo), aceitar_revisao (requer override).\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"12\",\n \"status\": \"AUTORIZADA\",\n \"chave_acesso\": \"3148004221...(50 posicoes)\",\n \"numero_nfse\": \"1\",\n \"valor_servicos\": 1500,\n \"valor_iss\": 37.5,\n \"links\": {\n \"xml\": \"/api/v1/nfse/12/xml\",\n \"danfse\": \"/api/v1/nfse/12/danfse\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /nfse/preview - Preview da NFS-e (nao emite, nao cobra)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/preview", "host": [ "{{base_url}}" ], "path": [ "nfse", "preview" ] }, "description": "Mesmo JSON da emissao. Calcula, classifica, valida a DPS e explica. Nao transmite, nao cobra, nao gera documento. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: pedido (opcional no preview), servico, tomador.\nOpcionais: data_operacao (simulacao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/preview", "host": [ "{{base_url}}" ], "path": [ "nfse", "preview" ] }, "description": "Mesmo JSON da emissao. Calcula, classifica, valida a DPS e explica. Nao transmite, nao cobra, nao gera documento. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: pedido (opcional no preview), servico, tomador.\nOpcionais: data_operacao (simulacao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"ready_to_issue\": true,\n \"document\": \"NFSE\",\n \"taxes\": {\n \"iss\": {\n \"valor\": 37.5,\n \"rate\": 2.5\n }\n },\n \"classifications\": {\n \"cTribNac\": \"010701\"\n },\n \"confidence_score\": 0.95,\n \"requires_review\": false,\n \"dps_validacao\": [],\n \"request_id\": \"req_...\"\n}" }, { "name": "Requer revisao", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/preview", "host": [ "{{base_url}}" ], "path": [ "nfse", "preview" ] }, "description": "Mesmo JSON da emissao. Calcula, classifica, valida a DPS e explica. Nao transmite, nao cobra, nao gera documento. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: pedido (opcional no preview), servico, tomador.\nOpcionais: data_operacao (simulacao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"email\": \"joao@exemplo.com\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Exemplo", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"requires_review\": true,\n \"confidence_score\": 0.3,\n \"errors\": [\n {\n \"code\": \"ISS_SEM_REGRA\",\n \"message\": \"nao ha aliquota de ISS configurada nem regra vigente na data 2026-03-10.\"\n }\n ],\n \"warnings\": [\n \"aliquota de ISS nao determinada ...\"\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /nfse - Listar NFS-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse", "host": [ "{{base_url}}" ], "path": [ "nfse" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina (ate 100). Somente documentos das empresas da credencial.\n\nPermissao da chave: `nfse:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse", "host": [ "{{base_url}}" ], "path": [ "nfse" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina (ate 100). Somente documentos das empresas da credencial.\n\nPermissao da chave: `nfse:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"itens\": [\n {\n \"id\": \"12\",\n \"status\": \"AUTORIZADA\",\n \"chave_acesso\": \"...\",\n \"valor_servicos\": 1500\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /nfse/{id} - Consultar NFS-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/{{nfse_id}}", "host": [ "{{base_url}}" ], "path": [ "nfse", "{{nfse_id}}" ] }, "description": "Status, chave de acesso, valores, eventos e links. NFS-e PROCESSANDO (resposta incerta) e reconciliada consultando a DPS no Sistema Nacional.\n\nPermissao da chave: `nfse:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/{{nfse_id}}", "host": [ "{{base_url}}" ], "path": [ "nfse", "{{nfse_id}}" ] }, "description": "Status, chave de acesso, valores, eventos e links. NFS-e PROCESSANDO (resposta incerta) e reconciliada consultando a DPS no Sistema Nacional.\n\nPermissao da chave: `nfse:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"12\",\n \"status\": \"AUTORIZADA\",\n \"chave_acesso\": \"3148004221...(50 posicoes)\",\n \"numero_nfse\": \"1\",\n \"valor_servicos\": 1500,\n \"valor_iss\": 37.5,\n \"links\": {\n \"xml\": \"/api/v1/nfse/12/xml\",\n \"danfse\": \"/api/v1/nfse/12/danfse\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /nfse/{id}/cancelar - Cancelar NFS-e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/{{nfse_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "nfse", "{{nfse_id}}", "cancelar" ] }, "description": "Registra o evento de cancelamento (e101101) no Sistema Nacional. Prazos e regras sao do municipio/Sistema Nacional.\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: justificativa (15 a 255 caracteres).\nOpcionais: codigo_motivo (1 erro na emissao, 2 servico nao prestado, 9 outros; padrao 9).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento por erro na emissao do servico\",\n \"codigo_motivo\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/{{nfse_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "nfse", "{{nfse_id}}", "cancelar" ] }, "description": "Registra o evento de cancelamento (e101101) no Sistema Nacional. Prazos e regras sao do municipio/Sistema Nacional.\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: justificativa (15 a 255 caracteres).\nOpcionais: codigo_motivo (1 erro na emissao, 2 servico nao prestado, 9 outros; padrao 9).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento por erro na emissao do servico\",\n \"codigo_motivo\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"12\",\n \"status\": \"CANCELADA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /nfse/{id}/xml - Baixar XML da NFS-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/{{nfse_id}}/xml", "host": [ "{{base_url}}" ], "path": [ "nfse", "{{nfse_id}}", "xml" ] }, "description": "XML da NFS-e autorizada devolvido pelo Sistema Nacional (referencia principal, armazenado como recebido).\n\nPermissao da chave: `nfse:read`." }, "response": [] }, { "name": "GET /nfse/{id}/danfse - Baixar DANFSe (PDF)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nfse/{{nfse_id}}/danfse", "host": [ "{{base_url}}" ], "path": [ "nfse", "{{nfse_id}}", "danfse" ] }, "description": "DANFSe nacional gerado localmente a partir do XML autorizado armazenado (sped-da, NT 008). O PDF nao substitui o documento eletronico.\n\nPermissao da chave: `nfse:read`." }, "response": [] }, { "name": "GET /servicos - Listar servicos cadastrados", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos", "host": [ "{{base_url}}" ], "path": [ "servicos" ] }, "description": "Servicos fiscais da empresa (LC 116, cTribNac, NBS, CNAE, preco e, opcionalmente, aliquota/retencao de ISS).\n\nPermissao da chave: `nfse:read`.\nOpcionais: empresa_id." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos", "host": [ "{{base_url}}" ], "path": [ "servicos" ] }, "description": "Servicos fiscais da empresa (LC 116, cTribNac, NBS, CNAE, preco e, opcionalmente, aliquota/retencao de ISS).\n\nPermissao da chave: `nfse:read`.\nOpcionais: empresa_id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"itens\": [\n {\n \"id\": 1,\n \"codigo\": \"CONS01\",\n \"c_trib_nac\": \"010701\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /servicos - Cadastrar servico", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos", "host": [ "{{base_url}}" ], "path": [ "servicos" ] }, "description": "c_trib_nac (6 digitos) identifica o servico no padrao nacional. aliquota_iss/iss_retido sao CONFIGURACAO (cadastro); sem eles o Motor usa a base versionada.\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: codigo, descricao.\nOpcionais: empresa_id, lc116 (NN.NN), c_trib_nac, c_trib_mun, nbs, cnae, preco, aliquota_iss, iss_retido, municipio_incidencia.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"codigo\": \"CONS01\",\n \"descricao\": \"Consultoria em tecnologia da informacao\",\n \"lc116\": \"01.07\",\n \"c_trib_nac\": \"010701\",\n \"nbs\": \"115090000\",\n \"preco\": 1500\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos", "host": [ "{{base_url}}" ], "path": [ "servicos" ] }, "description": "c_trib_nac (6 digitos) identifica o servico no padrao nacional. aliquota_iss/iss_retido sao CONFIGURACAO (cadastro); sem eles o Motor usa a base versionada.\n\nPermissao da chave: `nfse:write`.\n\nObrigatorios: codigo, descricao.\nOpcionais: empresa_id, lc116 (NN.NN), c_trib_nac, c_trib_mun, nbs, cnae, preco, aliquota_iss, iss_retido, municipio_incidencia.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"codigo\": \"CONS01\",\n \"descricao\": \"Consultoria em tecnologia da informacao\",\n \"lc116\": \"01.07\",\n \"c_trib_nac\": \"010701\",\n \"nbs\": \"115090000\",\n \"preco\": 1500\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"codigo\": \"CONS01\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /servicos/{id} - Consultar servico", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "servicos", "{{id}}" ] }, "description": "Servico da empresa.\n\nPermissao da chave: `nfse:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "servicos", "{{id}}" ] }, "description": "Servico da empresa.\n\nPermissao da chave: `nfse:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"codigo\": \"CONS01\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /servicos/{id} - Alterar servico", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "servicos", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `nfse:write`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"preco\": 1600\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "servicos", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `nfse:write`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"preco\": 1600\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /servicos/{id} - Desativar servico", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "servicos", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `nfse:write`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/servicos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "servicos", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `nfse:write`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "CT-e", "item": [ { "name": "POST /cte - Emitir CT-e (modelo 57, rodoviario)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/cte", "host": [ "{{base_url}}" ], "path": [ "cte" ] }, "description": "JSON simplificado: tomador (papel ou terceiro), remetente, destinatario (codigo de cliente cadastrado ou dados), valor da prestacao, carga e chaves das NF-e transportadas. O Motor Tributario determina o ICMS do transporte (base ICMS_TRANSPORTE da data da operacao; Simples Nacional usa ICMSSN), o CFOP e, se ha regra vigente, o IBS/CBS (leiaute 4.00 com IBS/CBS). O CFOP sai da base pelo tipo de estabelecimento do tomador (fiscal.tipo_estabelecimento_tomador) ou e declarado em fiscal.cfop. XML gerado com sped-cte, validado no XSD 4.00, enviado a SEFAZ; o XML autorizado (cteProc) e a referencia. Pre-requisitos: RNTRC e IE do emitente, certificado A1, credenciamento do emitente como transportador na SEFAZ da UF.\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: pedido, tomador (remetente|expedidor|recebedor|destinatario ou objeto), remetente, destinatario, valor_prestacao, carga {valor, produto, peso_kg|quantidades}, documentos [chaves NF-e].\nOpcionais: empresa_id | empresa, expedidor, recebedor, origem/destino {cod_municipio, municipio, uf} (padrao: enderecos de remetente/destinatario), componentes [{nome, valor}], fiscal {tipo_estabelecimento_tomador: mesma_natureza|industrial|comercial|comunicacao|energia|produtor_rural, cfop}, natureza_operacao, observacoes, data_operacao.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"FRETE-0001\",\n \"tomador\": \"destinatario\",\n \"remetente\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Remetente Industria Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"destinatario\": {\n \"cpf_cnpj\": \"00000000000191\",\n \"nome\": \"Destinatario Comercio SA\",\n \"ie\": \"110042490114\",\n \"endereco\": {\n \"logradouro\": \"Av. B\",\n \"numero\": \"200\",\n \"bairro\": \"Se\",\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\",\n \"cep\": \"01001000\"\n }\n },\n \"valor_prestacao\": 1000,\n \"carga\": {\n \"valor\": 50000,\n \"produto\": \"Tubos plasticos\",\n \"peso_kg\": 18145\n },\n \"documentos\": [\n \"31260960701190000104550010000001231123456789\"\n ],\n \"fiscal\": {\n \"tipo_estabelecimento_tomador\": \"comercial\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/cte", "host": [ "{{base_url}}" ], "path": [ "cte" ] }, "description": "JSON simplificado: tomador (papel ou terceiro), remetente, destinatario (codigo de cliente cadastrado ou dados), valor da prestacao, carga e chaves das NF-e transportadas. O Motor Tributario determina o ICMS do transporte (base ICMS_TRANSPORTE da data da operacao; Simples Nacional usa ICMSSN), o CFOP e, se ha regra vigente, o IBS/CBS (leiaute 4.00 com IBS/CBS). O CFOP sai da base pelo tipo de estabelecimento do tomador (fiscal.tipo_estabelecimento_tomador) ou e declarado em fiscal.cfop. XML gerado com sped-cte, validado no XSD 4.00, enviado a SEFAZ; o XML autorizado (cteProc) e a referencia. Pre-requisitos: RNTRC e IE do emitente, certificado A1, credenciamento do emitente como transportador na SEFAZ da UF.\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: pedido, tomador (remetente|expedidor|recebedor|destinatario ou objeto), remetente, destinatario, valor_prestacao, carga {valor, produto, peso_kg|quantidades}, documentos [chaves NF-e].\nOpcionais: empresa_id | empresa, expedidor, recebedor, origem/destino {cod_municipio, municipio, uf} (padrao: enderecos de remetente/destinatario), componentes [{nome, valor}], fiscal {tipo_estabelecimento_tomador: mesma_natureza|industrial|comercial|comunicacao|energia|produtor_rural, cfop}, natureza_operacao, observacoes, data_operacao.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"FRETE-0001\",\n \"tomador\": \"destinatario\",\n \"remetente\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Remetente Industria Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"destinatario\": {\n \"cpf_cnpj\": \"00000000000191\",\n \"nome\": \"Destinatario Comercio SA\",\n \"ie\": \"110042490114\",\n \"endereco\": {\n \"logradouro\": \"Av. B\",\n \"numero\": \"200\",\n \"bairro\": \"Se\",\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\",\n \"cep\": \"01001000\"\n }\n },\n \"valor_prestacao\": 1000,\n \"carga\": {\n \"valor\": 50000,\n \"produto\": \"Tubos plasticos\",\n \"peso_kg\": 18145\n },\n \"documentos\": [\n \"31260960701190000104550010000001231123456789\"\n ],\n \"fiscal\": {\n \"tipo_estabelecimento_tomador\": \"comercial\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"7\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"31260...57...(44)\",\n \"protocolo\": \"131000000000001\",\n \"cfop\": \"6353\",\n \"valor_prestacao\": 1000,\n \"links\": {\n \"xml\": \"/api/v1/cte/7/xml\",\n \"dacte\": \"/api/v1/cte/7/dacte\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cte/preview - Preview do CT-e (nao emite, nao cobra)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/preview", "host": [ "{{base_url}}" ], "path": [ "cte", "preview" ] }, "description": "Calcula ICMS/CFOP/IBS-CBS, valida o XML no leiaute oficial e explica. Nao transmite nem cobra. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: (mesmos da emissao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"FRETE-0001\",\n \"tomador\": \"destinatario\",\n \"remetente\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Remetente Industria Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"destinatario\": {\n \"cpf_cnpj\": \"00000000000191\",\n \"nome\": \"Destinatario Comercio SA\",\n \"ie\": \"110042490114\",\n \"endereco\": {\n \"logradouro\": \"Av. B\",\n \"numero\": \"200\",\n \"bairro\": \"Se\",\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\",\n \"cep\": \"01001000\"\n }\n },\n \"valor_prestacao\": 1000,\n \"carga\": {\n \"valor\": 50000,\n \"produto\": \"Tubos plasticos\",\n \"peso_kg\": 18145\n },\n \"documentos\": [\n \"31260960701190000104550010000001231123456789\"\n ],\n \"fiscal\": {\n \"tipo_estabelecimento_tomador\": \"comercial\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/preview", "host": [ "{{base_url}}" ], "path": [ "cte", "preview" ] }, "description": "Calcula ICMS/CFOP/IBS-CBS, valida o XML no leiaute oficial e explica. Nao transmite nem cobra. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: (mesmos da emissao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"FRETE-0001\",\n \"tomador\": \"destinatario\",\n \"remetente\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Remetente Industria Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"destinatario\": {\n \"cpf_cnpj\": \"00000000000191\",\n \"nome\": \"Destinatario Comercio SA\",\n \"ie\": \"110042490114\",\n \"endereco\": {\n \"logradouro\": \"Av. B\",\n \"numero\": \"200\",\n \"bairro\": \"Se\",\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\",\n \"cep\": \"01001000\"\n }\n },\n \"valor_prestacao\": 1000,\n \"carga\": {\n \"valor\": 50000,\n \"produto\": \"Tubos plasticos\",\n \"peso_kg\": 18145\n },\n \"documentos\": [\n \"31260960701190000104550010000001231123456789\"\n ],\n \"fiscal\": {\n \"tipo_estabelecimento_tomador\": \"comercial\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"ready_to_issue\": true,\n \"document\": \"CTE\",\n \"taxes\": {\n \"icms\": {\n \"cst\": \"00\",\n \"valor\": 120\n }\n },\n \"classifications\": {\n \"cfop\": \"6353\",\n \"cst\": \"00\"\n },\n \"xml_validado\": true,\n \"leiaute\": \"PL_CTe_400\",\n \"confidence_score\": 0.9,\n \"requires_review\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /cte - Listar CT-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte", "host": [ "{{base_url}}" ], "path": [ "cte" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina.\n\nPermissao da chave: `cte:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte", "host": [ "{{base_url}}" ], "path": [ "cte" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina.\n\nPermissao da chave: `cte:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"itens\": [\n {\n \"id\": \"7\",\n \"status\": \"AUTORIZADA\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /cte/{id} - Consultar CT-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}" ] }, "description": "Status, chave, protocolo, eventos e links. CT-e PENDENTE e reconciliado por consulta da chave na SEFAZ.\n\nPermissao da chave: `cte:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}" ] }, "description": "Status, chave, protocolo, eventos e links. CT-e PENDENTE e reconciliado por consulta da chave na SEFAZ.\n\nPermissao da chave: `cte:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"7\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"31260...57...(44)\",\n \"protocolo\": \"131000000000001\",\n \"cfop\": \"6353\",\n \"valor_prestacao\": 1000,\n \"links\": {\n \"xml\": \"/api/v1/cte/7/xml\",\n \"dacte\": \"/api/v1/cte/7/dacte\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cte/{id}/cancelar - Cancelar CT-e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "cancelar" ] }, "description": "Evento de cancelamento (110111).\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: justificativa (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento por erro de digitacao no valor\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "cancelar" ] }, "description": "Evento de cancelamento (110111).\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: justificativa (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento por erro de digitacao no valor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"CANCELADA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cte/{id}/cce - Carta de Correcao (CC-e)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/cce", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "cce" ] }, "description": "Evento 110110 com correcoes [{grupo, campo, valor}]. Nao pode alterar valores, tomador, CFOP etc. (regra da SEFAZ). Sequencia controlada pela API.\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: correcoes [{grupo, campo, valor, numero_item?}].", "body": { "mode": "raw", "raw": "{\n \"correcoes\": [\n {\n \"grupo\": \"compl\",\n \"campo\": \"xObs\",\n \"valor\": \"Observacao corrigida\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/cce", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "cce" ] }, "description": "Evento 110110 com correcoes [{grupo, campo, valor}]. Nao pode alterar valores, tomador, CFOP etc. (regra da SEFAZ). Sequencia controlada pela API.\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: correcoes [{grupo, campo, valor, numero_item?}].", "body": { "mode": "raw", "raw": "{\n \"correcoes\": [\n {\n \"grupo\": \"compl\",\n \"campo\": \"xObs\",\n \"valor\": \"Observacao corrigida\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"eventos\": [\n {\n \"tipo\": \"CCE\",\n \"sequencia\": 1,\n \"status\": \"REGISTRADO\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cte/{id}/desacordo - Prestacao de servico em desacordo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/desacordo", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "desacordo" ] }, "description": "Evento 610110 (desacordo do tomador).\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: observacao (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"observacao\": \"Prestacao do servico em desacordo com o contratado\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/desacordo", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "desacordo" ] }, "description": "Evento 610110 (desacordo do tomador).\n\nPermissao da chave: `cte:write`.\n\nObrigatorios: observacao (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"observacao\": \"Prestacao do servico em desacordo com o contratado\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"eventos\": [\n {\n \"tipo\": \"DESACORDO\",\n \"status\": \"REGISTRADO\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /cte/{id}/xml - Baixar XML do CT-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/xml", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "xml" ] }, "description": "cteProc (XML autorizado + protocolo + eventos de cancelamento), referencia principal.\n\nPermissao da chave: `cte:read`." }, "response": [] }, { "name": "GET /cte/{id}/dacte - Baixar DACTE (PDF)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cte/{{cte_id}}/dacte", "host": [ "{{base_url}}" ], "path": [ "cte", "{{cte_id}}", "dacte" ] }, "description": "DACTE gerado a partir do XML autorizado armazenado (sped-da).\n\nPermissao da chave: `cte:read`." }, "response": [] } ] }, { "name": "CT-e OS", "item": [ { "name": "POST /cteos - Emitir CT-e OS (modelo 67, transporte de pessoas, valores e excesso de bagagem)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/cteos", "host": [ "{{base_url}}" ], "path": [ "cteos" ] }, "description": "JSON simplificado: tomador (codigo de cliente cadastrado ou dados), servico {tipo: transporte_pessoas | transporte_valores | excesso_bagagem, descricao, quantidade}, origem e destino {cod_municipio, municipio, uf}, valor da prestacao e, opcionalmente, percurso (UFs), veiculo, fretamento e documentos referenciados. O Motor Tributario determina o ICMS do transporte (base ICMS_TRANSPORTE da data da operacao; criterio documento = CTEOS restringe a regra ao CT-e OS; Simples Nacional usa ICMSSN) e, se ha regra vigente, o IBS/CBS (leiaute 4.00 com IBS/CBS). O CFOP NAO e adivinhado: vem de regra CFOP_OPERACAO cadastrada para o documento CTEOS ou e declarado em fiscal.cfop. XML gerado com sped-cte (CTeOS), validado no XSD cteOS 4.00, enviado a SEFAZ SEMPRE de forma unitaria; o XML autorizado (cteOSProc) e a referencia. Modal rodoviario OS: TAF (12 digitos) ou numero do Registro Estadual (25 digitos) do transportador, configurado na empresa (taf_cteos | reg_estadual_cteos) ou informado em transporte. Pre-requisitos: IE e endereco do emitente, certificado A1, modulo cteos habilitado e autorizacao do emitente para transporte de passageiros/valores.\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: pedido, tomador (codigo de cliente ou {cpf_cnpj, nome, endereco}), servico {tipo, descricao (ate 30 caracteres), quantidade?}, origem {cod_municipio, municipio, uf}, destino {cod_municipio, municipio, uf}, valor_prestacao.\nOpcionais: empresa_id | empresa, percurso [UFs] (ate 25), veiculo (placa ou {placa, renavam, uf, proprietario {cpf_cnpj, nome, tipo 0|1|2, taf|nro_reg_estadual, ie, uf}}), fretamento {tipo: eventual|continuo, data_viagem}, transporte {taf | nro_reg_estadual} (substitui o padrao da empresa), documentos_referenciados [{numero, serie, subserie, data, valor} | {chave_bpe}], componentes [{nome, valor}], fiscal {cfop, tipo_estabelecimento_tomador}, natureza_operacao, observacoes, data_operacao.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios. Prefer: respond-async: processa pela fila fiscal.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"OS-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Empresa de Turismo Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"tipo\": \"transporte_pessoas\",\n \"descricao\": \"Fretamento para evento\",\n \"quantidade\": 40\n },\n \"origem\": {\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\"\n },\n \"destino\": {\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\"\n },\n \"valor_prestacao\": 1500,\n \"fiscal\": {\n \"cfop\": \"6357\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/cteos", "host": [ "{{base_url}}" ], "path": [ "cteos" ] }, "description": "JSON simplificado: tomador (codigo de cliente cadastrado ou dados), servico {tipo: transporte_pessoas | transporte_valores | excesso_bagagem, descricao, quantidade}, origem e destino {cod_municipio, municipio, uf}, valor da prestacao e, opcionalmente, percurso (UFs), veiculo, fretamento e documentos referenciados. O Motor Tributario determina o ICMS do transporte (base ICMS_TRANSPORTE da data da operacao; criterio documento = CTEOS restringe a regra ao CT-e OS; Simples Nacional usa ICMSSN) e, se ha regra vigente, o IBS/CBS (leiaute 4.00 com IBS/CBS). O CFOP NAO e adivinhado: vem de regra CFOP_OPERACAO cadastrada para o documento CTEOS ou e declarado em fiscal.cfop. XML gerado com sped-cte (CTeOS), validado no XSD cteOS 4.00, enviado a SEFAZ SEMPRE de forma unitaria; o XML autorizado (cteOSProc) e a referencia. Modal rodoviario OS: TAF (12 digitos) ou numero do Registro Estadual (25 digitos) do transportador, configurado na empresa (taf_cteos | reg_estadual_cteos) ou informado em transporte. Pre-requisitos: IE e endereco do emitente, certificado A1, modulo cteos habilitado e autorizacao do emitente para transporte de passageiros/valores.\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: pedido, tomador (codigo de cliente ou {cpf_cnpj, nome, endereco}), servico {tipo, descricao (ate 30 caracteres), quantidade?}, origem {cod_municipio, municipio, uf}, destino {cod_municipio, municipio, uf}, valor_prestacao.\nOpcionais: empresa_id | empresa, percurso [UFs] (ate 25), veiculo (placa ou {placa, renavam, uf, proprietario {cpf_cnpj, nome, tipo 0|1|2, taf|nro_reg_estadual, ie, uf}}), fretamento {tipo: eventual|continuo, data_viagem}, transporte {taf | nro_reg_estadual} (substitui o padrao da empresa), documentos_referenciados [{numero, serie, subserie, data, valor} | {chave_bpe}], componentes [{nome, valor}], fiscal {cfop, tipo_estabelecimento_tomador}, natureza_operacao, observacoes, data_operacao.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios. Prefer: respond-async: processa pela fila fiscal.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"OS-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Empresa de Turismo Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"tipo\": \"transporte_pessoas\",\n \"descricao\": \"Fretamento para evento\",\n \"quantidade\": 40\n },\n \"origem\": {\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\"\n },\n \"destino\": {\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\"\n },\n \"valor_prestacao\": 1500,\n \"fiscal\": {\n \"cfop\": \"6357\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"5\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"31261...67...(44)\",\n \"protocolo\": \"131000000000003\",\n \"cfop\": \"6357\",\n \"tipo_servico\": \"transporte_pessoas\",\n \"valor_prestacao\": 1500,\n \"links\": {\n \"xml\": \"/api/v1/cteos/5/xml\",\n \"dacte\": \"/api/v1/cteos/5/dacte\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cteos/preview - Preview do CT-e OS (nao emite, nao cobra)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/preview", "host": [ "{{base_url}}" ], "path": [ "cteos", "preview" ] }, "description": "Calcula ICMS/CFOP/IBS-CBS, valida o XML no leiaute oficial e explica. Nao transmite nem cobra. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: (mesmos da emissao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"OS-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Empresa de Turismo Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"tipo\": \"transporte_pessoas\",\n \"descricao\": \"Fretamento para evento\",\n \"quantidade\": 40\n },\n \"origem\": {\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\"\n },\n \"destino\": {\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\"\n },\n \"valor_prestacao\": 1500,\n \"fiscal\": {\n \"cfop\": \"6357\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/preview", "host": [ "{{base_url}}" ], "path": [ "cteos", "preview" ] }, "description": "Calcula ICMS/CFOP/IBS-CBS, valida o XML no leiaute oficial e explica. Nao transmite nem cobra. Query ?explain=true devolve o passo a passo de cada decisao (tributo, base, aliquota, valor, regra, fonte, versao, motivo).\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: (mesmos da emissao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"OS-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"33000167000101\",\n \"nome\": \"Empresa de Turismo Ltda\",\n \"ie\": \"9057800426\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"1\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"tipo\": \"transporte_pessoas\",\n \"descricao\": \"Fretamento para evento\",\n \"quantidade\": 40\n },\n \"origem\": {\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\"\n },\n \"destino\": {\n \"cod_municipio\": \"3550308\",\n \"municipio\": \"Sao Paulo\",\n \"uf\": \"SP\"\n },\n \"valor_prestacao\": 1500,\n \"fiscal\": {\n \"cfop\": \"6357\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"ready_to_issue\": true,\n \"document\": \"CTEOS\",\n \"taxes\": {\n \"icms\": {\n \"cst\": \"00\",\n \"valor\": 180\n }\n },\n \"classifications\": {\n \"cfop\": \"6357\",\n \"cst\": \"00\"\n },\n \"xml_validado\": true,\n \"leiaute\": \"PL_CTe_400\",\n \"confidence_score\": 0.9,\n \"requires_review\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /cteos - Listar CT-e OS", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos", "host": [ "{{base_url}}" ], "path": [ "cteos" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina.\n\nPermissao da chave: `cteos:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos", "host": [ "{{base_url}}" ], "path": [ "cteos" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina.\n\nPermissao da chave: `cteos:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"itens\": [\n {\n \"id\": \"5\",\n \"status\": \"AUTORIZADA\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /cteos/{id} - Consultar CT-e OS", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}" ] }, "description": "Status, chave, protocolo, eventos e links. CT-e OS PENDENTE e reconciliado por consulta da chave na SEFAZ.\n\nPermissao da chave: `cteos:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}" ] }, "description": "Status, chave, protocolo, eventos e links. CT-e OS PENDENTE e reconciliado por consulta da chave na SEFAZ.\n\nPermissao da chave: `cteos:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"5\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"31261...67...(44)\",\n \"protocolo\": \"131000000000003\",\n \"cfop\": \"6357\",\n \"tipo_servico\": \"transporte_pessoas\",\n \"valor_prestacao\": 1500,\n \"links\": {\n \"xml\": \"/api/v1/cteos/5/xml\",\n \"dacte\": \"/api/v1/cteos/5/dacte\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cteos/{id}/cancelar - Cancelar CT-e OS", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}", "cancelar" ] }, "description": "Evento de cancelamento (110111).\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: justificativa (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento por erro de digitacao no valor\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}", "cancelar" ] }, "description": "Evento de cancelamento (110111).\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: justificativa (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento por erro de digitacao no valor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"CANCELADA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /cteos/{id}/cce - Carta de Correcao (CC-e)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}/cce", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}", "cce" ] }, "description": "Evento 110110 com correcoes [{grupo, campo, valor}]. Nao pode alterar valores, tomador, CFOP etc. (regra da SEFAZ). Sequencia controlada pela API.\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: correcoes [{grupo, campo, valor, numero_item?}].", "body": { "mode": "raw", "raw": "{\n \"correcoes\": [\n {\n \"grupo\": \"compl\",\n \"campo\": \"xObs\",\n \"valor\": \"Observacao corrigida\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}/cce", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}", "cce" ] }, "description": "Evento 110110 com correcoes [{grupo, campo, valor}]. Nao pode alterar valores, tomador, CFOP etc. (regra da SEFAZ). Sequencia controlada pela API.\n\nPermissao da chave: `cteos:write`.\n\nObrigatorios: correcoes [{grupo, campo, valor, numero_item?}].", "body": { "mode": "raw", "raw": "{\n \"correcoes\": [\n {\n \"grupo\": \"compl\",\n \"campo\": \"xObs\",\n \"valor\": \"Observacao corrigida\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"eventos\": [\n {\n \"tipo\": \"CCE\",\n \"sequencia\": 1,\n \"status\": \"REGISTRADO\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /cteos/{id}/xml - Baixar XML do CT-e OS", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}/xml", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}", "xml" ] }, "description": "cteOSProc (XML autorizado + protocolo + eventos de cancelamento), referencia principal.\n\nPermissao da chave: `cteos:read`." }, "response": [] }, { "name": "GET /cteos/{id}/dacte - Baixar DACTE OS (PDF)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cteos/{{cteos_id}}/dacte", "host": [ "{{base_url}}" ], "path": [ "cteos", "{{cteos_id}}", "dacte" ] }, "description": "DACTE OS gerado a partir do XML autorizado armazenado (sped-da).\n\nPermissao da chave: `cteos:read`." }, "response": [] } ] }, { "name": "MDF-e", "item": [ { "name": "POST /mdfe - Emitir MDF-e (modelo 58, rodoviario)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/mdfe", "host": [ "{{base_url}}" ], "path": [ "mdfe" ] }, "description": "Dados simplificados: veiculo (placa cadastrada em /veiculos), condutores (CPF cadastrado em /condutores), percurso e documentos vinculados: CT-es ja emitidos por cte_id (sem redigitar chave/municipio/valor) ou chaves de CT-e/NF-e. O MDF-e nao tem tributacao (o Motor registra o contexto no snapshot). Validado no XSD 3.00 (sped-mdfe). Regras de leiaute aplicadas: um unico documento exige CEP de carga/descarga (infLotacao); tipo_emitente 1/3 exige produto predominante.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: pedido, veiculo, condutores [CPF ou {nome,cpf}], documentos [{cte_id | chave_cte | chave_nfe (+municipio_descarga)}], carga.peso_kg.\nOpcionais: empresa_id | empresa, reboques [placas], percurso {uf_inicio, uf_fim, ufs_percurso, carregamento{cod_municipio, municipio, cep}, inicio_viagem}, carga {valor, tipo 01-11, produto, ncm}, tipo_emitente (1 prestador, 2 carga propria, 3 CT-e globalizado), tipo_transportador (1 ETC, 2 TAC, 3 CTC), seguro, observacoes.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"MANIF-0001\",\n \"veiculo\": \"ABC1D23\",\n \"condutores\": [\n \"11144477735\"\n ],\n \"percurso\": {\n \"uf_inicio\": \"MG\",\n \"uf_fim\": \"SP\"\n },\n \"documentos\": [\n {\n \"cte_id\": 7\n },\n {\n \"cte_id\": 8\n }\n ],\n \"carga\": {\n \"peso_kg\": 36290\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/mdfe", "host": [ "{{base_url}}" ], "path": [ "mdfe" ] }, "description": "Dados simplificados: veiculo (placa cadastrada em /veiculos), condutores (CPF cadastrado em /condutores), percurso e documentos vinculados: CT-es ja emitidos por cte_id (sem redigitar chave/municipio/valor) ou chaves de CT-e/NF-e. O MDF-e nao tem tributacao (o Motor registra o contexto no snapshot). Validado no XSD 3.00 (sped-mdfe). Regras de leiaute aplicadas: um unico documento exige CEP de carga/descarga (infLotacao); tipo_emitente 1/3 exige produto predominante.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: pedido, veiculo, condutores [CPF ou {nome,cpf}], documentos [{cte_id | chave_cte | chave_nfe (+municipio_descarga)}], carga.peso_kg.\nOpcionais: empresa_id | empresa, reboques [placas], percurso {uf_inicio, uf_fim, ufs_percurso, carregamento{cod_municipio, municipio, cep}, inicio_viagem}, carga {valor, tipo 01-11, produto, ncm}, tipo_emitente (1 prestador, 2 carga propria, 3 CT-e globalizado), tipo_transportador (1 ETC, 2 TAC, 3 CTC), seguro, observacoes.\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"MANIF-0001\",\n \"veiculo\": \"ABC1D23\",\n \"condutores\": [\n \"11144477735\"\n ],\n \"percurso\": {\n \"uf_inicio\": \"MG\",\n \"uf_fim\": \"SP\"\n },\n \"documentos\": [\n {\n \"cte_id\": 7\n },\n {\n \"cte_id\": 8\n }\n ],\n \"carga\": {\n \"peso_kg\": 36290\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"3\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"31260...58...(44)\",\n \"protocolo\": \"131000000000002\",\n \"qtd_documentos\": 2,\n \"links\": {\n \"xml\": \"/api/v1/mdfe/3/xml\",\n \"damdfe\": \"/api/v1/mdfe/3/damdfe\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /mdfe/preview - Preview do MDF-e (nao emite, nao cobra)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/preview", "host": [ "{{base_url}}" ], "path": [ "mdfe", "preview" ] }, "description": "Valida veiculo, condutores, CT-es e o XML no leiaute oficial. Nao transmite nem cobra.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: (mesmos da emissao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"MANIF-0001\",\n \"veiculo\": \"ABC1D23\",\n \"condutores\": [\n \"11144477735\"\n ],\n \"percurso\": {\n \"uf_inicio\": \"MG\",\n \"uf_fim\": \"SP\"\n },\n \"documentos\": [\n {\n \"cte_id\": 7\n },\n {\n \"cte_id\": 8\n }\n ],\n \"carga\": {\n \"peso_kg\": 36290\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/preview", "host": [ "{{base_url}}" ], "path": [ "mdfe", "preview" ] }, "description": "Valida veiculo, condutores, CT-es e o XML no leiaute oficial. Nao transmite nem cobra.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: (mesmos da emissao).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"MANIF-0001\",\n \"veiculo\": \"ABC1D23\",\n \"condutores\": [\n \"11144477735\"\n ],\n \"percurso\": {\n \"uf_inicio\": \"MG\",\n \"uf_fim\": \"SP\"\n },\n \"documentos\": [\n {\n \"cte_id\": 7\n },\n {\n \"cte_id\": 8\n }\n ],\n \"carga\": {\n \"peso_kg\": 36290\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"ready_to_issue\": true,\n \"document\": \"MDFE\",\n \"qtd_documentos\": 2,\n \"xml_validado\": true,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /mdfe - Listar MDF-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe", "host": [ "{{base_url}}" ], "path": [ "mdfe" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina.\n\nPermissao da chave: `mdfe:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe", "host": [ "{{base_url}}" ], "path": [ "mdfe" ] }, "description": "Query: status, pedido, empresa_id, pagina, por_pagina.\n\nPermissao da chave: `mdfe:read`.\nOpcionais: status, pedido, empresa_id, pagina, por_pagina." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"itens\": [\n {\n \"id\": \"3\",\n \"status\": \"AUTORIZADA\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /mdfe/{id} - Consultar MDF-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}" ] }, "description": "Status, chave, protocolo, documentos, condutores, eventos e links.\n\nPermissao da chave: `mdfe:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}" ] }, "description": "Status, chave, protocolo, documentos, condutores, eventos e links.\n\nPermissao da chave: `mdfe:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": \"3\",\n \"status\": \"AUTORIZADA\",\n \"chave\": \"31260...58...(44)\",\n \"protocolo\": \"131000000000002\",\n \"qtd_documentos\": 2,\n \"links\": {\n \"xml\": \"/api/v1/mdfe/3/xml\",\n \"damdfe\": \"/api/v1/mdfe/3/damdfe\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /mdfe/{id}/encerrar - Encerrar MDF-e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/encerrar", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "encerrar" ] }, "description": "Evento de encerramento (110112) com o municipio de encerramento (IBGE, 7 digitos).\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: cod_municipio.\nOpcionais: data (AAAA-MM-DD).", "body": { "mode": "raw", "raw": "{\n \"cod_municipio\": \"3550308\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/encerrar", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "encerrar" ] }, "description": "Evento de encerramento (110112) com o municipio de encerramento (IBGE, 7 digitos).\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: cod_municipio.\nOpcionais: data (AAAA-MM-DD).", "body": { "mode": "raw", "raw": "{\n \"cod_municipio\": \"3550308\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"ENCERRADA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /mdfe/{id}/cancelar - Cancelar MDF-e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "cancelar" ] }, "description": "Evento de cancelamento (110111).\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: justificativa (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento do manifesto por engano do emissor\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/cancelar", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "cancelar" ] }, "description": "Evento de cancelamento (110111).\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: justificativa (15 a 255).", "body": { "mode": "raw", "raw": "{\n \"justificativa\": \"Cancelamento do manifesto por engano do emissor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"CANCELADA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /mdfe/{id}/condutor - Incluir condutor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/condutor", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "condutor" ] }, "description": "Evento de inclusao de condutor (110114). O condutor nao pode repetir.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: cpf.\nOpcionais: nome (quando o CPF nao esta cadastrado).", "body": { "mode": "raw", "raw": "{\n \"cpf\": \"52998224725\",\n \"nome\": \"Maria Souza\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/condutor", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "condutor" ] }, "description": "Evento de inclusao de condutor (110114). O condutor nao pode repetir.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: cpf.\nOpcionais: nome (quando o CPF nao esta cadastrado).", "body": { "mode": "raw", "raw": "{\n \"cpf\": \"52998224725\",\n \"nome\": \"Maria Souza\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"condutores\": [\n {\n \"nome\": \"Joao da Silva\"\n },\n {\n \"nome\": \"Maria Souza\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /mdfe/{id}/xml - Baixar XML do MDF-e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/xml", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "xml" ] }, "description": "mdfeProc (XML autorizado + protocolo + eventos), referencia principal.\n\nPermissao da chave: `mdfe:read`." }, "response": [] }, { "name": "GET /mdfe/{id}/damdfe - Baixar DAMDFE (PDF)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mdfe/{{mdfe_id}}/damdfe", "host": [ "{{base_url}}" ], "path": [ "mdfe", "{{mdfe_id}}", "damdfe" ] }, "description": "DAMDFE gerado a partir do XML autorizado armazenado (sped-da).\n\nPermissao da chave: `mdfe:read`." }, "response": [] }, { "name": "GET /veiculos - Listar veiculos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos", "host": [ "{{base_url}}" ], "path": [ "veiculos" ] }, "description": "Veiculos de tracao e reboques cadastrados.\n\nPermissao da chave: `mdfe:read`.\nOpcionais: empresa_id." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos", "host": [ "{{base_url}}" ], "path": [ "veiculos" ] }, "description": "Veiculos de tracao e reboques cadastrados.\n\nPermissao da chave: `mdfe:read`.\nOpcionais: empresa_id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"itens\": [\n {\n \"id\": 1,\n \"placa\": \"ABC1D23\",\n \"tipo\": \"TRACAO\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /veiculos - Cadastrar veiculo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos", "host": [ "{{base_url}}" ], "path": [ "veiculos" ] }, "description": "Placa (AAA0A00/AAA0000), tara e UF de licenciamento. Proprietario de terceiros: proprietario_*.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: placa, tara (kg), uf_licenciamento.\nOpcionais: empresa_id, renavam, cap_kg, cap_m3, tp_rod, tp_car, tipo (TRACAO|REBOQUE), proprietario_doc, proprietario_nome, proprietario_rntrc, proprietario_ie, proprietario_uf, proprietario_tp_prop.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"placa\": \"ABC1D23\",\n \"tara\": 8350,\n \"uf_licenciamento\": \"MG\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos", "host": [ "{{base_url}}" ], "path": [ "veiculos" ] }, "description": "Placa (AAA0A00/AAA0000), tara e UF de licenciamento. Proprietario de terceiros: proprietario_*.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: placa, tara (kg), uf_licenciamento.\nOpcionais: empresa_id, renavam, cap_kg, cap_m3, tp_rod, tp_car, tipo (TRACAO|REBOQUE), proprietario_doc, proprietario_nome, proprietario_rntrc, proprietario_ie, proprietario_uf, proprietario_tp_prop.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"placa\": \"ABC1D23\",\n \"tara\": 8350,\n \"uf_licenciamento\": \"MG\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"placa\": \"ABC1D23\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /veiculos/{id} - Consultar veiculo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "veiculos", "{{id}}" ] }, "description": "Veiculo da empresa.\n\nPermissao da chave: `mdfe:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "veiculos", "{{id}}" ] }, "description": "Veiculo da empresa.\n\nPermissao da chave: `mdfe:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"placa\": \"ABC1D23\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /veiculos/{id} - Alterar veiculo", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "veiculos", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `mdfe:write`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"cap_kg\": 16000\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "veiculos", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `mdfe:write`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"cap_kg\": 16000\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /veiculos/{id} - Desativar veiculo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "veiculos", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `mdfe:write`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/veiculos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "veiculos", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `mdfe:write`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /condutores - Listar condutores", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores", "host": [ "{{base_url}}" ], "path": [ "condutores" ] }, "description": "Condutores cadastrados.\n\nPermissao da chave: `mdfe:read`.\nOpcionais: empresa_id." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores", "host": [ "{{base_url}}" ], "path": [ "condutores" ] }, "description": "Condutores cadastrados.\n\nPermissao da chave: `mdfe:read`.\nOpcionais: empresa_id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"itens\": [\n {\n \"id\": 1,\n \"nome\": \"JOAO DA SILVA\",\n \"cpf\": \"11144477735\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /condutores - Cadastrar condutor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores", "host": [ "{{base_url}}" ], "path": [ "condutores" ] }, "description": "Nome (ate 60) e CPF valido.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: nome, cpf.\nOpcionais: empresa_id.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"nome\": \"JOAO DA SILVA\",\n \"cpf\": \"111.444.777-35\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores", "host": [ "{{base_url}}" ], "path": [ "condutores" ] }, "description": "Nome (ate 60) e CPF valido.\n\nPermissao da chave: `mdfe:write`.\n\nObrigatorios: nome, cpf.\nOpcionais: empresa_id.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"nome\": \"JOAO DA SILVA\",\n \"cpf\": \"111.444.777-35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"cpf\": \"11144477735\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /condutores/{id} - Consultar condutor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores/{{id}}", "host": [ "{{base_url}}" ], "path": [ "condutores", "{{id}}" ] }, "description": "Condutor da empresa.\n\nPermissao da chave: `mdfe:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores/{{id}}", "host": [ "{{base_url}}" ], "path": [ "condutores", "{{id}}" ] }, "description": "Condutor da empresa.\n\nPermissao da chave: `mdfe:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"nome\": \"JOAO DA SILVA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /condutores/{id} - Alterar condutor", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores/{{id}}", "host": [ "{{base_url}}" ], "path": [ "condutores", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `mdfe:write`.\nOpcionais: nome, cpf.", "body": { "mode": "raw", "raw": "{\n \"nome\": \"JOAO P. DA SILVA\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores/{{id}}", "host": [ "{{base_url}}" ], "path": [ "condutores", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `mdfe:write`.\nOpcionais: nome, cpf.", "body": { "mode": "raw", "raw": "{\n \"nome\": \"JOAO P. DA SILVA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /condutores/{id} - Desativar condutor", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores/{{id}}", "host": [ "{{base_url}}" ], "path": [ "condutores", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `mdfe:write`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/condutores/{{id}}", "host": [ "{{base_url}}" ], "path": [ "condutores", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `mdfe:write`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Produtor Rural", "item": [ { "name": "GET /rural/produtor - Consultar produtor rural", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/produtor", "host": [ "{{base_url}}" ], "path": [ "rural", "produtor" ] }, "description": "Dados do produtor (PF por CPF ou PJ por CNPJ), contexto fiscal, propriedades e situacao do certificado.\n\nPermissao da chave: `rural:read`.\nOpcionais: empresa_id (query)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/produtor", "host": [ "{{base_url}}" ], "path": [ "rural", "produtor" ] }, "description": "Dados do produtor (PF por CPF ou PJ por CNPJ), contexto fiscal, propriedades e situacao do certificado.\n\nPermissao da chave: `rural:read`.\nOpcionais: empresa_id (query)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"tipo\": \"PF\",\n \"documento\": \"11144477735\",\n \"contexto_fiscal\": \"PRODUTOR_RURAL\",\n \"propriedades\": 1,\n \"certificado\": {\n \"status\": \"ok\",\n \"validade\": \"2027-01-01\"\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /rural/produtor - Cadastrar produtor rural PF", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/produtor", "host": [ "{{base_url}}" ], "path": [ "rural", "produtor" ] }, "description": "Cria a empresa emitente do produtor pessoa fisica (CPF + IE, sem CNPJ), com o contexto PRODUTOR_RURAL. Exige API Key de usuario. O CRT e informado por voce (o motor nao presume o enquadramento). O certificado e-CPF do produtor e enviado em /configuracao-fiscal/certificado. Produtor PJ: cadastre a empresa normalmente e ative o contexto com PUT.\n\nPermissao da chave: `rural:write`.\n\nObrigatorios: cpf, nome, uf, ie, crt, logradouro, numero, bairro, cod_municipio, municipio, cep, fone.\nOpcionais: nome_fantasia, cnae.", "body": { "mode": "raw", "raw": "{\n \"cpf\": \"111.444.777-35\",\n \"nome\": \"Jose Produtor Rural\",\n \"uf\": \"MG\",\n \"ie\": \"PR0123456780123\",\n \"crt\": 3,\n \"logradouro\": \"Fazenda Boa Vista\",\n \"numero\": \"S/N\",\n \"bairro\": \"Zona Rural\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"cep\": \"38700000\",\n \"fone\": \"34999998888\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/produtor", "host": [ "{{base_url}}" ], "path": [ "rural", "produtor" ] }, "description": "Cria a empresa emitente do produtor pessoa fisica (CPF + IE, sem CNPJ), com o contexto PRODUTOR_RURAL. Exige API Key de usuario. O CRT e informado por voce (o motor nao presume o enquadramento). O certificado e-CPF do produtor e enviado em /configuracao-fiscal/certificado. Produtor PJ: cadastre a empresa normalmente e ative o contexto com PUT.\n\nPermissao da chave: `rural:write`.\n\nObrigatorios: cpf, nome, uf, ie, crt, logradouro, numero, bairro, cod_municipio, municipio, cep, fone.\nOpcionais: nome_fantasia, cnae.", "body": { "mode": "raw", "raw": "{\n \"cpf\": \"111.444.777-35\",\n \"nome\": \"Jose Produtor Rural\",\n \"uf\": \"MG\",\n \"ie\": \"PR0123456780123\",\n \"crt\": 3,\n \"logradouro\": \"Fazenda Boa Vista\",\n \"numero\": \"S/N\",\n \"bairro\": \"Zona Rural\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"cep\": \"38700000\",\n \"fone\": \"34999998888\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"tipo\": \"PF\",\n \"contexto_fiscal\": \"PRODUTOR_RURAL\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /rural/produtor - Ligar/desligar o contexto rural da empresa", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/produtor", "host": [ "{{base_url}}" ], "path": [ "rural", "produtor" ] }, "description": "Ativa (true) ou desativa (false) o contexto PRODUTOR_RURAL de uma empresa existente. Produtor PF nao pode desativar. Com o contexto ativo, a NF-e existente detecta o contexto pelo cadastro (sem enviar \"contexto\").\n\nPermissao da chave: `rural:write`.\n\nObrigatorios: ativo (boolean).\nOpcionais: empresa_id.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"ativo\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/produtor", "host": [ "{{base_url}}" ], "path": [ "rural", "produtor" ] }, "description": "Ativa (true) ou desativa (false) o contexto PRODUTOR_RURAL de uma empresa existente. Produtor PF nao pode desativar. Com o contexto ativo, a NF-e existente detecta o contexto pelo cadastro (sem enviar \"contexto\").\n\nPermissao da chave: `rural:write`.\n\nObrigatorios: ativo (boolean).\nOpcionais: empresa_id.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"ativo\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"tipo\": \"PJ\",\n \"contexto_fiscal\": \"PRODUTOR_RURAL\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /nfe - Emitir NF-e do produtor rural (endpoint NF-e existente)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/nfe", "host": [ "{{base_url}}" ], "path": [ "nfe" ] }, "description": "NAO ha endpoint paralelo: use POST /nfe com \"contexto\": \"PRODUTOR_RURAL\" (ou deixe a empresa com o contexto ativo) e \"operacao\" (venda, transferencia, remessa, retorno, devolucao, industrializacao, armazenagem...). O Motor aplica as regras rurais: CFOP da operacao (base versionada), situacao do ICMS (normal, diferimento, reducao, isencao, suspensao) SOMENTE por regra RURAL_ICMS vigente com fundamento, cBenef por RURAL_BENEFICIO, IBS/CBS por regra vigente. Tributacao incerta (requires_review) bloqueia a emissao. Identificacao do emitente por CPF (PF) ou CNPJ (PJ). A chave do webhook nfe.* traz \"context\".\n\nPermissao da chave: `emitir`.\n\nObrigatorios: pedido, contexto (PRODUTOR_RURAL) OU empresa com contexto ativo, operacao, cliente, itens, pagamento.\nOpcionais: propriedade (codigo cadastrado), itens[].origem_operacao (producao_propria|adquirida; padrao producao_propria com aviso).\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"RURAL-0001\",\n \"contexto\": \"PRODUTOR_RURAL\",\n \"operacao\": \"venda\",\n \"propriedade\": \"FAZ01\",\n \"cliente\": \"CLIMG\",\n \"itens\": [\n {\n \"codigo\": \"CAFE01\",\n \"quantidade\": 100\n }\n ],\n \"pagamento\": \"pix\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Opcional: evita emissao duplicada em reenvios.", "disabled": true } ], "url": { "raw": "{{base_url}}/nfe", "host": [ "{{base_url}}" ], "path": [ "nfe" ] }, "description": "NAO ha endpoint paralelo: use POST /nfe com \"contexto\": \"PRODUTOR_RURAL\" (ou deixe a empresa com o contexto ativo) e \"operacao\" (venda, transferencia, remessa, retorno, devolucao, industrializacao, armazenagem...). O Motor aplica as regras rurais: CFOP da operacao (base versionada), situacao do ICMS (normal, diferimento, reducao, isencao, suspensao) SOMENTE por regra RURAL_ICMS vigente com fundamento, cBenef por RURAL_BENEFICIO, IBS/CBS por regra vigente. Tributacao incerta (requires_review) bloqueia a emissao. Identificacao do emitente por CPF (PF) ou CNPJ (PJ). A chave do webhook nfe.* traz \"context\".\n\nPermissao da chave: `emitir`.\n\nObrigatorios: pedido, contexto (PRODUTOR_RURAL) OU empresa com contexto ativo, operacao, cliente, itens, pagamento.\nOpcionais: propriedade (codigo cadastrado), itens[].origem_operacao (producao_propria|adquirida; padrao producao_propria com aviso).\n\nIdempotency-Key (opcional): evita emissao duplicada em reenvios.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"RURAL-0001\",\n \"contexto\": \"PRODUTOR_RURAL\",\n \"operacao\": \"venda\",\n \"propriedade\": \"FAZ01\",\n \"cliente\": \"CLIMG\",\n \"itens\": [\n {\n \"codigo\": \"CAFE01\",\n \"quantidade\": 100\n }\n ],\n \"pagamento\": \"pix\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"AUTORIZADA\",\n \"id\": \"43\",\n \"chave\": \"3524...\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /rural/propriedades - Listar propriedades rurais", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades" ] }, "description": "Propriedades do produtor (multiplas).\n\nPermissao da chave: `rural:read`.\nOpcionais: empresa_id." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades" ] }, "description": "Propriedades do produtor (multiplas).\n\nPermissao da chave: `rural:read`.\nOpcionais: empresa_id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"itens\": [\n {\n \"id\": 1,\n \"codigo\": \"FAZ01\",\n \"nome\": \"Fazenda Boa Vista\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /rural/propriedades - Cadastrar propriedade rural", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades" ] }, "description": "Somente dados fiscais/operacionais necessarios.\n\nPermissao da chave: `rural:write`.\n\nObrigatorios: codigo, nome, uf, cod_municipio, municipio.\nOpcionais: empresa_id, ie, logradouro, numero, bairro, cep, atividade, cnae, car.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"codigo\": \"FAZ01\",\n \"nome\": \"Fazenda Boa Vista\",\n \"uf\": \"MG\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades" ] }, "description": "Somente dados fiscais/operacionais necessarios.\n\nPermissao da chave: `rural:write`.\n\nObrigatorios: codigo, nome, uf, cod_municipio, municipio.\nOpcionais: empresa_id, ie, logradouro, numero, bairro, cep, atividade, cnae, car.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"codigo\": \"FAZ01\",\n \"nome\": \"Fazenda Boa Vista\",\n \"uf\": \"MG\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"codigo\": \"FAZ01\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /rural/propriedades/{id} - Consultar propriedade", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades/{{id}}", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades", "{{id}}" ] }, "description": "Propriedade da empresa.\n\nPermissao da chave: `rural:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades/{{id}}", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades", "{{id}}" ] }, "description": "Propriedade da empresa.\n\nPermissao da chave: `rural:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"codigo\": \"FAZ01\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /rural/propriedades/{id} - Alterar propriedade", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades/{{id}}", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `rural:write`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"atividade\": \"Cafeicultura\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades/{{id}}", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `rural:write`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"atividade\": \"Cafeicultura\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /rural/propriedades/{id} - Desativar propriedade", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades/{{id}}", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `rural:write`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/rural/propriedades/{{id}}", "host": [ "{{base_url}}" ], "path": [ "rural", "propriedades", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `rural:write`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /produtos - Listar produtos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos", "host": [ "{{base_url}}" ], "path": [ "produtos" ] }, "description": "Produtos fiscais da empresa (qualquer produto agropecuario ou nao).\n\nPermissao da chave: `consultar`.\nOpcionais: empresa_id." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos", "host": [ "{{base_url}}" ], "path": [ "produtos" ] }, "description": "Produtos fiscais da empresa (qualquer produto agropecuario ou nao).\n\nPermissao da chave: `consultar`.\nOpcionais: empresa_id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"itens\": [\n {\n \"id\": 1,\n \"codigo\": \"CAFE01\",\n \"ncm\": \"09011110\",\n \"classificacao_rural\": \"cafe\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /produtos - Cadastrar produto", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos", "host": [ "{{base_url}}" ], "path": [ "produtos" ] }, "description": "NCM (8 digitos), origem, unidade e, para o contexto rural, classificacao_rural (livre: cafe, soja, milho, leite, gado, hortifruti...), usada nos criterios das regras. O motor NAO deduz NCM pela descricao.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: codigo, descricao, ncm, origem (0-8), unidade.\nOpcionais: empresa_id, cest, gtin, preco, categoria, classificacao_rural.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"codigo\": \"CAFE01\",\n \"descricao\": \"Cafe arabica em grao cru\",\n \"ncm\": \"09011110\",\n \"origem\": 0,\n \"unidade\": \"SC\",\n \"classificacao_rural\": \"cafe\",\n \"preco\": 1200\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos", "host": [ "{{base_url}}" ], "path": [ "produtos" ] }, "description": "NCM (8 digitos), origem, unidade e, para o contexto rural, classificacao_rural (livre: cafe, soja, milho, leite, gado, hortifruti...), usada nos criterios das regras. O motor NAO deduz NCM pela descricao.\n\nPermissao da chave: `configurar`.\n\nObrigatorios: codigo, descricao, ncm, origem (0-8), unidade.\nOpcionais: empresa_id, cest, gtin, preco, categoria, classificacao_rural.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"codigo\": \"CAFE01\",\n \"descricao\": \"Cafe arabica em grao cru\",\n \"ncm\": \"09011110\",\n \"origem\": 0,\n \"unidade\": \"SC\",\n \"classificacao_rural\": \"cafe\",\n \"preco\": 1200\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"codigo\": \"CAFE01\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /produtos/{id} - Consultar produto", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "produtos", "{{id}}" ] }, "description": "Produto da empresa.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "produtos", "{{id}}" ] }, "description": "Produto da empresa.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"codigo\": \"CAFE01\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /produtos/{id} - Alterar produto", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "produtos", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `configurar`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"preco\": 1300\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "produtos", "{{id}}" ] }, "description": "Atualiza campos informados (auditado).\n\nPermissao da chave: `configurar`.\nOpcionais: campos do cadastro.", "body": { "mode": "raw", "raw": "{\n \"preco\": 1300\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /produtos/{id} - Desativar produto", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "produtos", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `configurar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/produtos/{{id}}", "host": [ "{{base_url}}" ], "path": [ "produtos", "{{id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `configurar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 1,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Distribuicao DF-e", "item": [ { "name": "POST /dfe/sincronizar - Sincronizar documentos recebidos", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/sincronizar", "host": [ "{{base_url}}" ], "path": [ "dfe", "sincronizar" ] }, "description": "Busca na SEFAZ (Ambiente Nacional) os documentos emitidos CONTRA o CNPJ da empresa e grava o XML recebido. Incremental: usa o ultimo NSU de cada empresa/ambiente/tipo; chame de novo enquanto status = PARCIAL. Tipos: NFE (resumos, NF-e completas e eventos), CTE e MDFE (documentos em que a empresa e envolvida) ou TODOS. A SEFAZ exige aguardar 1 hora quando nao ha documentos novos (cStat 137) ou ao consumir indevidamente (656): a API respeita isso e responde AGUARDANDO com aguardar_ate. Sem cobranca de creditos. Para receber o XML COMPLETO de uma NF-e que veio como RESUMO, registre a manifestacao (POST /dfe/manifestacoes) e sincronize novamente. NFS-e: distribuicao do Sistema Nacional NAO implementada.\n\nPermissao da chave: `dfe:write`.\nOpcionais: empresa_id | empresa, tipo (NFE | CTE | MDFE | TODOS; padrao NFE), max_lotes (1 a 20; padrao 5; cada lote ate 50 documentos).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"tipo\": \"NFE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/sincronizar", "host": [ "{{base_url}}" ], "path": [ "dfe", "sincronizar" ] }, "description": "Busca na SEFAZ (Ambiente Nacional) os documentos emitidos CONTRA o CNPJ da empresa e grava o XML recebido. Incremental: usa o ultimo NSU de cada empresa/ambiente/tipo; chame de novo enquanto status = PARCIAL. Tipos: NFE (resumos, NF-e completas e eventos), CTE e MDFE (documentos em que a empresa e envolvida) ou TODOS. A SEFAZ exige aguardar 1 hora quando nao ha documentos novos (cStat 137) ou ao consumir indevidamente (656): a API respeita isso e responde AGUARDANDO com aguardar_ate. Sem cobranca de creditos. Para receber o XML COMPLETO de uma NF-e que veio como RESUMO, registre a manifestacao (POST /dfe/manifestacoes) e sincronize novamente. NFS-e: distribuicao do Sistema Nacional NAO implementada.\n\nPermissao da chave: `dfe:write`.\nOpcionais: empresa_id | empresa, tipo (NFE | CTE | MDFE | TODOS; padrao NFE), max_lotes (1 a 20; padrao 5; cada lote ate 50 documentos).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"tipo\": \"NFE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"ambiente\": \"homologacao\",\n \"resultados\": [\n {\n \"tipo\": \"NFE\",\n \"status\": \"CONCLUIDO\",\n \"lotes\": 2,\n \"novos\": 37,\n \"ult_nsu\": 1520,\n \"max_nsu\": 1520,\n \"cstat\": \"138\",\n \"motivo\": \"Documento(s) localizado(s)\",\n \"aguardar_ate\": null\n }\n ],\n \"request_id\": \"req_...\"\n}" }, { "name": "Aguardando a SEFAZ (sem documentos novos)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/sincronizar", "host": [ "{{base_url}}" ], "path": [ "dfe", "sincronizar" ] }, "description": "Busca na SEFAZ (Ambiente Nacional) os documentos emitidos CONTRA o CNPJ da empresa e grava o XML recebido. Incremental: usa o ultimo NSU de cada empresa/ambiente/tipo; chame de novo enquanto status = PARCIAL. Tipos: NFE (resumos, NF-e completas e eventos), CTE e MDFE (documentos em que a empresa e envolvida) ou TODOS. A SEFAZ exige aguardar 1 hora quando nao ha documentos novos (cStat 137) ou ao consumir indevidamente (656): a API respeita isso e responde AGUARDANDO com aguardar_ate. Sem cobranca de creditos. Para receber o XML COMPLETO de uma NF-e que veio como RESUMO, registre a manifestacao (POST /dfe/manifestacoes) e sincronize novamente. NFS-e: distribuicao do Sistema Nacional NAO implementada.\n\nPermissao da chave: `dfe:write`.\nOpcionais: empresa_id | empresa, tipo (NFE | CTE | MDFE | TODOS; padrao NFE), max_lotes (1 a 20; padrao 5; cada lote ate 50 documentos).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"tipo\": \"NFE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Exemplo", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"resultados\": [\n {\n \"tipo\": \"NFE\",\n \"status\": \"AGUARDANDO\",\n \"novos\": 0,\n \"cstat\": \"137\",\n \"motivo\": \"Nenhum documento localizado\",\n \"aguardar_ate\": \"2026-10-01 11:00:00\",\n \"aguardar_segundos\": 3410\n }\n ]\n}" } ] }, { "name": "POST /dfe/baixar-chave - Baixar NF-e pela chave", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/baixar-chave", "host": [ "{{base_url}}" ], "path": [ "dfe", "baixar-chave" ] }, "description": "Consulta de distribuicao por chave de acesso (somente NF-e em que a empresa e interessada). Grava o que a SEFAZ devolver (resumo ou XML completo) sem alterar o cursor de NSU.\n\nPermissao da chave: `dfe:write`.\n\nObrigatorios: chave (44 digitos).\nOpcionais: empresa_id | empresa.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"chave\": \"31260960701190000104550010000001231123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/baixar-chave", "host": [ "{{base_url}}" ], "path": [ "dfe", "baixar-chave" ] }, "description": "Consulta de distribuicao por chave de acesso (somente NF-e em que a empresa e interessada). Grava o que a SEFAZ devolver (resumo ou XML completo) sem alterar o cursor de NSU.\n\nPermissao da chave: `dfe:write`.\n\nObrigatorios: chave (44 digitos).\nOpcionais: empresa_id | empresa.", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"chave\": \"31260960701190000104550010000001231123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"chave\": \"31260960701190000104550010000001231123456789\",\n \"cstat\": \"138\",\n \"novos\": 1,\n \"documentos\": [\n {\n \"id\": 91,\n \"nsu\": 1498,\n \"natureza\": \"RESUMO\",\n \"schema_nome\": \"resNFe_v1.01\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /dfe/status - Situacao da sincronizacao", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/status", "host": [ "{{base_url}}" ], "path": [ "dfe", "status" ] }, "description": "Ultimo NSU, maximo NSU, ultima sincronizacao, ultimo cStat e bloqueio da SEFAZ por tipo, alem do total de documentos recebidos por tipo e natureza.\n\nPermissao da chave: `dfe:read`.\nOpcionais: empresa_id | empresa." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/status", "host": [ "{{base_url}}" ], "path": [ "dfe", "status" ] }, "description": "Ultimo NSU, maximo NSU, ultima sincronizacao, ultimo cStat e bloqueio da SEFAZ por tipo, alem do total de documentos recebidos por tipo e natureza.\n\nPermissao da chave: `dfe:read`.\nOpcionais: empresa_id | empresa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"ambiente\": \"homologacao\",\n \"sincronizacao_automatica\": false,\n \"cursores\": {\n \"NFE\": {\n \"ult_nsu\": 1520,\n \"max_nsu\": 1520,\n \"ultima_sync\": \"2026-10-01 10:00:00\",\n \"ultimo_cstat\": \"137\",\n \"aguardando_sefaz\": true,\n \"aguardar_ate\": \"2026-10-01 11:00:00\"\n }\n },\n \"totais\": {\n \"NFE\": {\n \"RESUMO\": 20,\n \"COMPLETO\": 15,\n \"EVENTO\": 2\n }\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /dfe/documentos - Listar documentos recebidos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/documentos", "host": [ "{{base_url}}" ], "path": [ "dfe", "documentos" ] }, "description": "Lista os documentos recebidos (metadados; o XML vem em /dfe/documentos/{id}/xml). Para importar incrementalmente no seu sistema, guarde o maior nsu recebido e use nsu_apos (ordem crescente de NSU). natureza: RESUMO (resNFe), COMPLETO (XML completo), EVENTO.\n\nPermissao da chave: `dfe:read`.\nOpcionais: empresa_id, tipo (NFE|CTE|MDFE), natureza (RESUMO|COMPLETO|EVENTO|OUTRO), chave, emitente (CNPJ/CPF), tp_evento, nsu_apos, de (YYYY-MM-DD), ate (YYYY-MM-DD), pagina, por_pagina (max 100)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/documentos", "host": [ "{{base_url}}" ], "path": [ "dfe", "documentos" ] }, "description": "Lista os documentos recebidos (metadados; o XML vem em /dfe/documentos/{id}/xml). Para importar incrementalmente no seu sistema, guarde o maior nsu recebido e use nsu_apos (ordem crescente de NSU). natureza: RESUMO (resNFe), COMPLETO (XML completo), EVENTO.\n\nPermissao da chave: `dfe:read`.\nOpcionais: empresa_id, tipo (NFE|CTE|MDFE), natureza (RESUMO|COMPLETO|EVENTO|OUTRO), chave, emitente (CNPJ/CPF), tp_evento, nsu_apos, de (YYYY-MM-DD), ate (YYYY-MM-DD), pagina, por_pagina (max 100)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 37,\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"itens\": [\n {\n \"id\": 91,\n \"tipo\": \"NFE\",\n \"nsu\": 1498,\n \"natureza\": \"COMPLETO\",\n \"chave\": \"3126...(44)\",\n \"emitente\": {\n \"documento\": \"60701190000104\",\n \"nome\": \"FORNECEDOR LTDA\",\n \"ie\": \"110042490114\"\n },\n \"valor\": 1520.5,\n \"data_emissao\": \"2026-09-28 10:15:00\",\n \"xml_completo\": true,\n \"xml\": \"/api/v1/dfe/documentos/91/xml\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /dfe/documentos/{id} - Consultar documento recebido", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/documentos/{{dfe_id}}", "host": [ "{{base_url}}" ], "path": [ "dfe", "documentos", "{{dfe_id}}" ] }, "description": "Metadados de um documento recebido.\n\nPermissao da chave: `dfe:read`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/documentos/{{dfe_id}}", "host": [ "{{base_url}}" ], "path": [ "dfe", "documentos", "{{dfe_id}}" ] }, "description": "Metadados de um documento recebido.\n\nPermissao da chave: `dfe:read`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 91,\n \"tipo\": \"NFE\",\n \"nsu\": 1498,\n \"natureza\": \"COMPLETO\",\n \"chave\": \"3126...(44)\",\n \"xml\": \"/api/v1/dfe/documentos/91/xml\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /dfe/documentos/{id}/xml - XML do documento recebido", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/documentos/{{dfe_id}}/xml", "host": [ "{{base_url}}" ], "path": [ "dfe", "documentos", "{{dfe_id}}", "xml" ] }, "description": "XML exatamente como recebido da SEFAZ (nfeProc, resNFe, evento...).\n\nPermissao da chave: `dfe:read`." }, "response": [] }, { "name": "POST /dfe/manifestacoes - Manifestacao do Destinatario (NF-e)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/manifestacoes", "host": [ "{{base_url}}" ], "path": [ "dfe", "manifestacoes" ] }, "description": "Registra na SEFAZ a manifestacao da empresa destinataria sobre uma NF-e ja recebida: ciencia (210210), confirmacao (210200), desconhecimento (210220) ou nao_realizada (210240, exige justificativa de 15 a 255 caracteres). A ciencia/confirmacao libera o XML completo na proxima sincronizacao. Idempotente por chave + evento.\n\nPermissao da chave: `dfe:write`.\n\nObrigatorios: chave, evento (ciencia | confirmacao | desconhecimento | nao_realizada).\nOpcionais: empresa_id | empresa, justificativa (obrigatoria em nao_realizada).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"chave\": \"31260960701190000104550010000001231123456789\",\n \"evento\": \"ciencia\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/manifestacoes", "host": [ "{{base_url}}" ], "path": [ "dfe", "manifestacoes" ] }, "description": "Registra na SEFAZ a manifestacao da empresa destinataria sobre uma NF-e ja recebida: ciencia (210210), confirmacao (210200), desconhecimento (210220) ou nao_realizada (210240, exige justificativa de 15 a 255 caracteres). A ciencia/confirmacao libera o XML completo na proxima sincronizacao. Idempotente por chave + evento.\n\nPermissao da chave: `dfe:write`.\n\nObrigatorios: chave, evento (ciencia | confirmacao | desconhecimento | nao_realizada).\nOpcionais: empresa_id | empresa, justificativa (obrigatoria em nao_realizada).", "body": { "mode": "raw", "raw": "{\n \"empresa_id\": {{empresa_id}},\n \"chave\": \"31260960701190000104550010000001231123456789\",\n \"evento\": \"ciencia\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 5,\n \"chave\": \"31260960701190000104550010000001231123456789\",\n \"evento\": \"ciencia\",\n \"tp_evento\": \"210210\",\n \"status\": \"REGISTRADO\",\n \"cstat\": \"135\",\n \"protocolo\": \"891260000000001\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /dfe/manifestacoes - Listar manifestacoes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/manifestacoes", "host": [ "{{base_url}}" ], "path": [ "dfe", "manifestacoes" ] }, "description": "Ultimas 100 manifestacoes registradas.\n\nPermissao da chave: `dfe:read`.\nOpcionais: empresa_id, chave." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/dfe/manifestacoes", "host": [ "{{base_url}}" ], "path": [ "dfe", "manifestacoes" ] }, "description": "Ultimas 100 manifestacoes registradas.\n\nPermissao da chave: `dfe:read`.\nOpcionais: empresa_id, chave." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"itens\": [\n {\n \"id\": 5,\n \"chave\": \"3126...(44)\",\n \"evento\": \"ciencia\",\n \"status\": \"REGISTRADO\",\n \"cstat\": \"135\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Status SEFAZ", "item": [ { "name": "GET /sefaz/status - Status dos servicos fiscais", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/sefaz/status", "host": [ "{{base_url}}" ], "path": [ "sefaz", "status" ] }, "description": "Status em tempo real de todos os documentos para a UF e o ambiente da empresa: NF-e (55), NFC-e (65), CT-e (57), CT-e OS (67) e MDF-e (58) pela consulta oficial de status de servico da SEFAZ (cStat 107 = em operacao) e NFS-e Nacional por sonda de conectividade (o Sistema Nacional nao publica status oficial). Cache de 20 s por servico. situacao: online, instavel, offline, erro, desabilitado (modulo nao habilitado na empresa).\n\nPermissao da chave: `consultar`.\nOpcionais: empresa_id | empresa." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/sefaz/status", "host": [ "{{base_url}}" ], "path": [ "sefaz", "status" ] }, "description": "Status em tempo real de todos os documentos para a UF e o ambiente da empresa: NF-e (55), NFC-e (65), CT-e (57), CT-e OS (67) e MDF-e (58) pela consulta oficial de status de servico da SEFAZ (cStat 107 = em operacao) e NFS-e Nacional por sonda de conectividade (o Sistema Nacional nao publica status oficial). Cache de 20 s por servico. situacao: online, instavel, offline, erro, desabilitado (modulo nao habilitado na empresa).\n\nPermissao da chave: `consultar`.\nOpcionais: empresa_id | empresa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"uf\": \"MG\",\n \"ambiente\": \"homologacao\",\n \"situacao_geral\": \"online\",\n \"consultado_em\": \"2026-10-01T10:00:00-03:00\",\n \"servicos\": {\n \"nfe\": {\n \"modelo\": \"55\",\n \"situacao\": \"online\",\n \"rotulo\": \"Em operação\",\n \"cstat\": \"107\",\n \"tempo_ms\": 310\n },\n \"nfce\": {\n \"modelo\": \"65\",\n \"situacao\": \"online\",\n \"rotulo\": \"Em operação\",\n \"cstat\": \"107\",\n \"tempo_ms\": 290\n },\n \"cte\": {\n \"modelo\": \"57\",\n \"situacao\": \"online\",\n \"rotulo\": \"Em operação\",\n \"cstat\": \"107\",\n \"tempo_ms\": 420\n },\n \"cteos\": {\n \"modelo\": \"67\",\n \"situacao\": \"online\",\n \"rotulo\": \"Em operação\",\n \"cstat\": \"107\",\n \"tempo_ms\": 410\n },\n \"mdfe\": {\n \"modelo\": \"58\",\n \"situacao\": \"instavel\",\n \"rotulo\": \"Paralisado momentaneamente\",\n \"cstat\": \"108\"\n },\n \"nfse\": {\n \"modelo\": \"nfse\",\n \"situacao\": \"online\",\n \"rotulo\": \"Sistema Nacional acessível\",\n \"tempo_ms\": 180\n }\n },\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Processamento assincrono", "item": [ { "name": "POST /fiscal/solicitacoes - Solicitar emissao assincrona", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes" ] }, "description": "Recebe a solicitacao de emissao (NF-e, NFC-e, NFS-e, CT-e, CT-e OS ou MDF-e), valida permissao do documento (emitir | nfse:write | cte:write | cteos:write | mdfe:write), empresa, modulo e SALDO de creditos, registra uma tarefa PERSISTENTE (MySQL) e devolve o solicitacao_id. Receber/enfileirar NAO significa transmitir nem autorizar: o worker transmite quando possivel e repete automaticamente em falhas temporarias (intervalo progressivo com variacao aleatoria), CONSULTA a situacao antes de qualquer reenvio (nunca retransmite as cegas), e so marca AUTORIZADA/REJEITADA com o resultado oficial. Idempotente por empresa + documento + pedido: reenviar o mesmo pedido devolve a mesma solicitacao (200 + Idempotent-Replay); conteudo diferente = 422 IDEMPOTENCY_KEY_REUSED. Equivalente: POST /nfe|/nfce|/nfse|/cte|/mdfe com o header Prefer: respond-async, ?async=true ou \"async\": true. Status: RECEBIDA, AGUARDANDO_TRANSMISSAO, TRANSMITINDO, AGUARDANDO_RETORNO, AUTORIZADA, REJEITADA, FALHA_TEMPORARIA, ACAO_NECESSARIA, CANCELADA (tarefa).\n\nPermissao da chave: `consultar`.\n\nObrigatorios: documento (NFE | NFCE | NFSE | CTE | CTEOS | MDFE), dados {} (o mesmo JSON da emissao, com pedido).\nOpcionais: empresa_id | empresa (tambem aceito dentro de dados), Idempotency-Key (header).", "body": { "mode": "raw", "raw": "{\n \"documento\": \"NFSE\",\n \"dados\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes" ] }, "description": "Recebe a solicitacao de emissao (NF-e, NFC-e, NFS-e, CT-e, CT-e OS ou MDF-e), valida permissao do documento (emitir | nfse:write | cte:write | cteos:write | mdfe:write), empresa, modulo e SALDO de creditos, registra uma tarefa PERSISTENTE (MySQL) e devolve o solicitacao_id. Receber/enfileirar NAO significa transmitir nem autorizar: o worker transmite quando possivel e repete automaticamente em falhas temporarias (intervalo progressivo com variacao aleatoria), CONSULTA a situacao antes de qualquer reenvio (nunca retransmite as cegas), e so marca AUTORIZADA/REJEITADA com o resultado oficial. Idempotente por empresa + documento + pedido: reenviar o mesmo pedido devolve a mesma solicitacao (200 + Idempotent-Replay); conteudo diferente = 422 IDEMPOTENCY_KEY_REUSED. Equivalente: POST /nfe|/nfce|/nfse|/cte|/mdfe com o header Prefer: respond-async, ?async=true ou \"async\": true. Status: RECEBIDA, AGUARDANDO_TRANSMISSAO, TRANSMITINDO, AGUARDANDO_RETORNO, AUTORIZADA, REJEITADA, FALHA_TEMPORARIA, ACAO_NECESSARIA, CANCELADA (tarefa).\n\nPermissao da chave: `consultar`.\n\nObrigatorios: documento (NFE | NFCE | NFSE | CTE | CTEOS | MDFE), dados {} (o mesmo JSON da emissao, com pedido).\nOpcionais: empresa_id | empresa (tambem aceito dentro de dados), Idempotency-Key (header).", "body": { "mode": "raw", "raw": "{\n \"documento\": \"NFSE\",\n \"dados\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"solicitacao_id\": \"sol_9f2c41aa07be13d5c8e1\",\n \"status\": \"AGUARDANDO_TRANSMISSAO\",\n \"mensagem\": \"Solicitacao recebida e aguardando processamento. Receber nao significa transmitir nem autorizar: acompanhe o resultado.\",\n \"consulta_url\": \"/api/v1/fiscal/solicitacoes/sol_9f2c41aa07be13d5c8e1\",\n \"request_id\": \"req_...\"\n}" }, { "name": "Replay (mesmo pedido e conteudo)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes" ] }, "description": "Recebe a solicitacao de emissao (NF-e, NFC-e, NFS-e, CT-e, CT-e OS ou MDF-e), valida permissao do documento (emitir | nfse:write | cte:write | cteos:write | mdfe:write), empresa, modulo e SALDO de creditos, registra uma tarefa PERSISTENTE (MySQL) e devolve o solicitacao_id. Receber/enfileirar NAO significa transmitir nem autorizar: o worker transmite quando possivel e repete automaticamente em falhas temporarias (intervalo progressivo com variacao aleatoria), CONSULTA a situacao antes de qualquer reenvio (nunca retransmite as cegas), e so marca AUTORIZADA/REJEITADA com o resultado oficial. Idempotente por empresa + documento + pedido: reenviar o mesmo pedido devolve a mesma solicitacao (200 + Idempotent-Replay); conteudo diferente = 422 IDEMPOTENCY_KEY_REUSED. Equivalente: POST /nfe|/nfce|/nfse|/cte|/mdfe com o header Prefer: respond-async, ?async=true ou \"async\": true. Status: RECEBIDA, AGUARDANDO_TRANSMISSAO, TRANSMITINDO, AGUARDANDO_RETORNO, AUTORIZADA, REJEITADA, FALHA_TEMPORARIA, ACAO_NECESSARIA, CANCELADA (tarefa).\n\nPermissao da chave: `consultar`.\n\nObrigatorios: documento (NFE | NFCE | NFSE | CTE | CTEOS | MDFE), dados {} (o mesmo JSON da emissao, com pedido).\nOpcionais: empresa_id | empresa (tambem aceito dentro de dados), Idempotency-Key (header).", "body": { "mode": "raw", "raw": "{\n \"documento\": \"NFSE\",\n \"dados\": {\n \"empresa_id\": {{empresa_id}},\n \"pedido\": \"SERV-0001\",\n \"tomador\": {\n \"cpf_cnpj\": \"12345678909\",\n \"nome\": \"Joao da Silva\",\n \"endereco\": {\n \"logradouro\": \"Rua A\",\n \"numero\": \"10\",\n \"bairro\": \"Centro\",\n \"cod_municipio\": \"3148004\",\n \"municipio\": \"Patos de Minas\",\n \"uf\": \"MG\",\n \"cep\": \"38700000\"\n }\n },\n \"servico\": {\n \"codigo\": \"CONS01\",\n \"valor\": 1500\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Exemplo", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"replay\": true,\n \"solicitacao_id\": \"sol_9f2c41aa07be13d5c8e1\",\n \"status\": \"AUTORIZADA\",\n \"resultado_oficial_confirmado\": true\n}" } ] }, { "name": "GET /fiscal/solicitacoes - Listar solicitacoes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes" ] }, "description": "Solicitacoes das empresas da credencial (isolamento multiempresa; chave de teste enxerga somente homologacao).\n\nPermissao da chave: `consultar`.\nOpcionais: status, documento (NFE|NFCE|NFSE|CTE|CTEOS|MDFE), empresa_id, pedido, ambiente (homologacao|producao), origem (API_ASSINCRONA|SINCRONA), de (YYYY-MM-DD), ate (YYYY-MM-DD), travadas=1, pagina, por_pagina (max 100)." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes" ] }, "description": "Solicitacoes das empresas da credencial (isolamento multiempresa; chave de teste enxerga somente homologacao).\n\nPermissao da chave: `consultar`.\nOpcionais: status, documento (NFE|NFCE|NFSE|CTE|CTEOS|MDFE), empresa_id, pedido, ambiente (homologacao|producao), origem (API_ASSINCRONA|SINCRONA), de (YYYY-MM-DD), ate (YYYY-MM-DD), travadas=1, pagina, por_pagina (max 100)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"total\": 1,\n \"pagina\": 1,\n \"por_pagina\": 20,\n \"itens\": [\n {\n \"solicitacao_id\": \"sol_9f2c41aa07be13d5c8e1\",\n \"documento\": \"NFSE\",\n \"pedido\": \"SERV-0001\",\n \"empresa_id\": 25,\n \"ambiente\": \"homologacao\",\n \"status\": \"AGUARDANDO_RETORNO\",\n \"tentativas\": 1,\n \"proxima_tentativa\": \"2026-10-01 11:03:00\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /fiscal/solicitacoes/{id} - Consultar solicitacao", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes/{{solicitacao_id}}", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes", "{{solicitacao_id}}" ] }, "description": "Situacao, historico de processamento (data, tentativa, mensagem e ator de cada transicao), proxima tentativa, resultado fiscal (documento_id, chave, protocolo, cStat) e links de XML/PDF quando autorizada. resultado_oficial_confirmado = true somente em AUTORIZADA ou REJEITADA. Solicitacao de outra empresa responde 404.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes/{{solicitacao_id}}", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes", "{{solicitacao_id}}" ] }, "description": "Situacao, historico de processamento (data, tentativa, mensagem e ator de cada transicao), proxima tentativa, resultado fiscal (documento_id, chave, protocolo, cStat) e links de XML/PDF quando autorizada. resultado_oficial_confirmado = true somente em AUTORIZADA ou REJEITADA. Solicitacao de outra empresa responde 404.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"solicitacao_id\": \"sol_9f2c41aa07be13d5c8e1\",\n \"documento\": \"NFSE\",\n \"pedido\": \"SERV-0001\",\n \"status\": \"AUTORIZADA\",\n \"descricao_status\": \"Documento autorizado (resultado oficial confirmado).\",\n \"resultado_oficial_confirmado\": true,\n \"tentativas\": 2,\n \"consultas\": 1,\n \"documento_id\": 12,\n \"chave\": \"3148004...\",\n \"protocolo\": \"131260000000001\",\n \"links\": {\n \"xml\": \"/api/v1/nfse/12/xml\",\n \"danfse\": \"/api/v1/nfse/12/danfse\"\n },\n \"historico\": [\n {\n \"de\": null,\n \"para\": \"RECEBIDA\",\n \"tentativa\": 0,\n \"mensagem\": \"Solicitacao recebida pela API.\",\n \"ator\": \"api\",\n \"em\": \"2026-10-01 10:00:00\"\n },\n {\n \"de\": \"AGUARDANDO_RETORNO\",\n \"para\": \"AUTORIZADA\",\n \"tentativa\": 2,\n \"mensagem\": \"Documento autorizado (protocolo 131260000000001).\",\n \"ator\": \"worker:srv1:4120\",\n \"em\": \"2026-10-01 10:04:11\"\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /fiscal/solicitacoes/{id} - Cancelar a TAREFA (antes da transmissao)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes/{{solicitacao_id}}", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes", "{{solicitacao_id}}" ] }, "description": "Remove somente uma tarefa AINDA NAO TRANSMITIDA (nao e cancelamento fiscal). Exige a permissao do documento. Se o documento ja foi transmitido ou esta autorizado, responde 409 e orienta o cancelamento fiscal oficial (POST /{documento}/{id}/cancelamento | cancelar).\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes/{{solicitacao_id}}", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes", "{{solicitacao_id}}" ] }, "description": "Remove somente uma tarefa AINDA NAO TRANSMITIDA (nao e cancelamento fiscal). Exige a permissao do documento. Se o documento ja foi transmitido ou esta autorizado, responde 409 e orienta o cancelamento fiscal oficial (POST /{documento}/{id}/cancelamento | cancelar).\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"aviso\": \"Foi cancelada a TAREFA ainda nao transmitida. Isto nao e o cancelamento fiscal de um documento.\",\n \"solicitacao_id\": \"sol_9f2c41aa07be13d5c8e1\",\n \"status\": \"CANCELADA\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /fiscal/solicitacoes/{id}/reprocessar - Reprocessar (acao necessaria / rejeitada)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes/{{solicitacao_id}}/reprocessar", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes", "{{solicitacao_id}}", "reprocessar" ] }, "description": "Devolve a solicitacao a fila quando estiver em ACAO_NECESSARIA (ex.: apos adicionar creditos ou corrigir a configuracao) ou REJEITADA (exige \"dados\" corrigidos). Com \"dados\", o pedido deve continuar o mesmo. NUNCA ignora a idempotencia nem as regras fiscais: passa pelo mesmo emitir() e pela consulta de situacao. Documento autorizado ou cancelado nao e reprocessavel. Auditado.\n\nPermissao da chave: `consultar`.\nOpcionais: dados {} (JSON da emissao corrigido; obrigatorio para REJEITADA).", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/solicitacoes/{{solicitacao_id}}/reprocessar", "host": [ "{{base_url}}" ], "path": [ "fiscal", "solicitacoes", "{{solicitacao_id}}", "reprocessar" ] }, "description": "Devolve a solicitacao a fila quando estiver em ACAO_NECESSARIA (ex.: apos adicionar creditos ou corrigir a configuracao) ou REJEITADA (exige \"dados\" corrigidos). Com \"dados\", o pedido deve continuar o mesmo. NUNCA ignora a idempotencia nem as regras fiscais: passa pelo mesmo emitir() e pela consulta de situacao. Documento autorizado ou cancelado nao e reprocessavel. Auditado.\n\nPermissao da chave: `consultar`.\nOpcionais: dados {} (JSON da emissao corrigido; obrigatorio para REJEITADA).", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"solicitacao_id\": \"sol_9f2c41aa07be13d5c8e1\",\n \"status\": \"AGUARDANDO_TRANSMISSAO\",\n \"tentativas\": 0,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /fiscal/notificacoes/preferencias - Preferencias de notificacao", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/notificacoes/preferencias", "host": [ "{{base_url}}" ], "path": [ "fiscal", "notificacoes", "preferencias" ] }, "description": "Preferencias de e-mail/painel do usuario dono da API Key (geral ou por empresa com ?empresa_id). Chaves sem usuario da plataforma respondem 403.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa_id." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/notificacoes/preferencias", "host": [ "{{base_url}}" ], "path": [ "fiscal", "notificacoes", "preferencias" ] }, "description": "Preferencias de e-mail/painel do usuario dono da API Key (geral ou por empresa com ?empresa_id). Chaves sem usuario da plataforma respondem 403.\n\nPermissao da chave: `consultar`.\nOpcionais: empresa_id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 0,\n \"preferencias\": {\n \"email_destino\": null,\n \"email_ativo\": 1,\n \"painel_ativo\": 1,\n \"ev_autorizada\": 1,\n \"ev_rejeitada\": 1,\n \"ev_acao\": 1,\n \"ev_falha\": 1,\n \"pendente_minutos\": null\n },\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "PUT /fiscal/notificacoes/preferencias - Salvar preferencias de notificacao", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/notificacoes/preferencias", "host": [ "{{base_url}}" ], "path": [ "fiscal", "notificacoes", "preferencias" ] }, "description": "Define o e-mail de destino, eventos que geram aviso (autorizada, rejeitada, acao necessaria, falha) e o aviso opcional de pendencia (pendente_minutos, 5 a 10080; envia UM e-mail). empresa_id restringe a uma empresa do usuario e prevalece sobre a preferencia geral.\n\nPermissao da chave: `configurar`.\nOpcionais: empresa_id, email_destino, email_ativo, painel_ativo, ev_autorizada, ev_rejeitada, ev_acao, ev_falha, pendente_minutos.", "body": { "mode": "raw", "raw": "{\n \"email_destino\": \"financeiro@empresa.com\",\n \"pendente_minutos\": 30\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal/notificacoes/preferencias", "host": [ "{{base_url}}" ], "path": [ "fiscal", "notificacoes", "preferencias" ] }, "description": "Define o e-mail de destino, eventos que geram aviso (autorizada, rejeitada, acao necessaria, falha) e o aviso opcional de pendencia (pendente_minutos, 5 a 10080; envia UM e-mail). empresa_id restringe a uma empresa do usuario e prevalece sobre a preferencia geral.\n\nPermissao da chave: `configurar`.\nOpcionais: empresa_id, email_destino, email_ativo, painel_ativo, ev_autorizada, ev_rejeitada, ev_acao, ev_falha, pendente_minutos.", "body": { "mode": "raw", "raw": "{\n \"email_destino\": \"financeiro@empresa.com\",\n \"pendente_minutos\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"empresa_id\": 25,\n \"preferencias\": {\n \"email_destino\": \"fiscal@empresa.com\",\n \"email_ativo\": 1,\n \"pendente_minutos\": 30\n },\n \"request_id\": \"req_...\"\n}" } ] } ] }, { "name": "Webhooks", "item": [ { "name": "POST /webhooks - Cadastrar webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "webhooks" ] }, "description": "Recebe eventos nfe.*, nfce.*, nfse.*, cte.*, mdfe.* (authorized, rejected, cancelled, processing, closed) dfe.documentos_recebidos (novos documentos da Distribuicao DF-e) e fiscal.document.queued | pending | authorized | rejected | action_required | cancelled (solicitacoes assincronas; payload com solicitacao_id, documento, status, empresa_id, pedido e dados do resultado; deduplicados e com historico de entregas). URL https obrigatoria (http so para localhost em desenvolvimento), sem enderecos privados. O segredo HMAC e exibido UMA vez. Cada entrega envia X-Webhook-Event, X-Webhook-Id, X-Webhook-Timestamp e X-Webhook-Signature = \"sha256=\" + HMAC-SHA256(segredo, timestamp + \".\" + corpo). Rejeite timestamps antigos (protecao contra replay) e trate eventos repetidos pelo id. Retentativas com backoff (1m, 5m, 15m, 1h, 6h).\n\nPermissao da chave: `configurar`.\n\nObrigatorios: url.\nOpcionais: eventos (lista ou [\"*\"]), empresa_id (restringe a uma empresa).", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://seu-sistema.com/webhooks/fiscal\",\n \"eventos\": [\n \"nfse.authorized\",\n \"cte.authorized\",\n \"cteos.authorized\",\n \"mdfe.closed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "webhooks" ] }, "description": "Recebe eventos nfe.*, nfce.*, nfse.*, cte.*, mdfe.* (authorized, rejected, cancelled, processing, closed) dfe.documentos_recebidos (novos documentos da Distribuicao DF-e) e fiscal.document.queued | pending | authorized | rejected | action_required | cancelled (solicitacoes assincronas; payload com solicitacao_id, documento, status, empresa_id, pedido e dados do resultado; deduplicados e com historico de entregas). URL https obrigatoria (http so para localhost em desenvolvimento), sem enderecos privados. O segredo HMAC e exibido UMA vez. Cada entrega envia X-Webhook-Event, X-Webhook-Id, X-Webhook-Timestamp e X-Webhook-Signature = \"sha256=\" + HMAC-SHA256(segredo, timestamp + \".\" + corpo). Rejeite timestamps antigos (protecao contra replay) e trate eventos repetidos pelo id. Retentativas com backoff (1m, 5m, 15m, 1h, 6h).\n\nPermissao da chave: `configurar`.\n\nObrigatorios: url.\nOpcionais: eventos (lista ou [\"*\"]), empresa_id (restringe a uma empresa).", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://seu-sistema.com/webhooks/fiscal\",\n \"eventos\": [\n \"nfse.authorized\",\n \"cte.authorized\",\n \"cteos.authorized\",\n \"mdfe.closed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 4,\n \"url\": \"https://seu-sistema.com/webhooks/fiscal\",\n \"eventos\": [\n \"nfse.authorized\"\n ],\n \"ativo\": true,\n \"segredo\": \"whsec_...(exibido uma vez)\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /webhooks - Listar webhooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "webhooks" ] }, "description": "Webhooks da sua credencial (sem o segredo).\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "webhooks" ] }, "description": "Webhooks da sua credencial (sem o segredo).\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"itens\": [\n {\n \"id\": 4,\n \"url\": \"https://...\",\n \"eventos\": [\n \"nfse.authorized\"\n ],\n \"ativo\": true,\n \"falhas_seguidas\": 0\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /webhooks/{id} - Consultar webhook", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}" ] }, "description": "Webhook da sua credencial.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}" ] }, "description": "Webhook da sua credencial.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 4,\n \"url\": \"https://...\",\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "DELETE /webhooks/{id} - Desativar webhook", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `configurar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}" ] }, "description": "Desativacao logica (auditada).\n\nPermissao da chave: `configurar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"id\": 4,\n \"ativo\": false,\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "GET /webhooks/{id}/entregas - Historico de entregas", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}/entregas", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}", "entregas" ] }, "description": "Ultimas 100 entregas: evento, status (PENDENTE, ENTREGUE, FALHA, ESGOTADO), tentativas, HTTP status e proxima tentativa.\n\nPermissao da chave: `consultar`." }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}/entregas", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}", "entregas" ] }, "description": "Ultimas 100 entregas: evento, status (PENDENTE, ENTREGUE, FALHA, ESGOTADO), tentativas, HTTP status e proxima tentativa.\n\nPermissao da chave: `consultar`." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"itens\": [\n {\n \"evento\": \"nfse.authorized\",\n \"status\": \"ENTREGUE\",\n \"tentativas\": 1,\n \"http_status\": 200\n }\n ],\n \"request_id\": \"req_...\"\n}" } ] }, { "name": "POST /webhooks/{id}/testar - Enviar evento de teste", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}/testar", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}", "testar" ] }, "description": "Envia o evento webhook.test assinado para a URL e devolve o resultado da entrega.\n\nPermissao da chave: `configurar`.", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Exemplo de sucesso", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/webhooks/{{webhook_id}}/testar", "host": [ "{{base_url}}" ], "path": [ "webhooks", "{{webhook_id}}", "testar" ] }, "description": "Envia o evento webhook.test assinado para a URL e devolve o resultado da entrega.\n\nPermissao da chave: `configurar`.", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"status\": \"ENTREGUE\",\n \"http_status\": 200,\n \"duracao_ms\": 120,\n \"request_id\": \"req_...\"\n}" } ] } ] } ] }