{ "info": { "name": "IXC E-Docs — Sandbox (NFS-e, NFCom, NF-e)", "description": "Coleção com os exemplos publicados no manual de integração do e-docs sandbox. Os payloads de emissão são validados automaticamente contra os schemas públicos. Troque `base_url` por https://sandbox.edocs.ixcsoft.com.br/api para usar o sandbox remoto.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://sandbox.edocs.ixcsoft.com.br/api" }, { "key": "api_key", "value": "COLE_AQUI_SUA_CHAVE_DE_API" }, { "key": "issuer_tax_id", "value": "00000000000000" }, { "key": "nfse_external_id", "value": "nfse-001" }, { "key": "nfcom_external_id", "value": "nfcom-001" }, { "key": "nfe_external_id", "value": "nfe-001" } ], "item": [ { "name": "Onboarding", "item": [ { "name": "Criar acesso no sandbox", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "url": "{{base_url}}/auth/signup", "body": { "mode": "raw", "raw": "{\n \"name\": \"Seu nome\",\n \"cpf\": \"000.000.000-00\",\n \"email\": \"voce@exemplo.com\",\n \"phone\": \"5511999998888\",\n \"workspace\": { \"name\": \"Meu workspace\" }\n}" } } } ] }, { "name": "NFS-e", "item": [ { "name": "Configurar NFS-e da empresa (Nacional)", "request": { "method": "PUT", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfse/config/companies/{{issuer_tax_id}}", "body": { "mode": "raw", "raw": "{\n \"integration\": \"national\",\n \"environment\": \"production\",\n \"numbering\": { \"dps\": [\"1\"] }\n}" } } }, { "name": "Enviar NFS-e", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfse", "body": { "mode": "raw", "raw": "[\n {\n \"external_id\": \"nfse-001\",\n \"competence_date\": \"2026-08-19T00:00:00-03:00\",\n \"issuer\": { \"tax_id\": \"{{issuer_tax_id}}\" },\n \"customer\": {\n \"tax_id\": \"05823474911\",\n \"legal_name\": \"Cliente Exemplo\",\n \"email\": \"cliente@exemplo.com\",\n \"phone\": \"5549988079672\",\n \"address\": {\n \"street\": \"Rua Tamoios - E\",\n \"number\": \"1012\",\n \"neighborhood\": \"Esplanada\",\n \"city\": \"Chapecó\",\n \"state\": \"SC\",\n \"postal_code\": \"89812437\",\n \"municipality_code\": \"4204202\",\n \"country\": \"BR\"\n }\n },\n \"send_email\": true,\n \"service\": {\n \"description\": \"Consultoria de integração de sistemas\",\n \"cnae_code\": \"6201501\", \"lc116_code\": \"1.07\",\n \"national_tax_code\": \"010701\",\n \"municipal_tax_code\": \"802\"\n },\n \"taxes\": { \"iss_taxation\": 1, \"iss_retention_type\": 1, \"pis_cofins_cst\": \"01\" },\n \"values\": {\n \"total_amount\": 1500,\n \"base_amount\": 1500,\n \"pis_cofins_base_amount\": 1500,\n \"pis_rate\": 0.65,\n \"pis_amount\": 9.75,\n \"cofins_rate\": 3,\n \"cofins_amount\": 45\n }\n }\n]" } } }, { "name": "Enviar NFS-e (exemplo 2)", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfse", "body": { "mode": "raw", "raw": "[\n {\n \"external_id\": \"nfse-002\",\n \"competence_date\": \"2026-08-19T00:00:00-03:00\",\n \"issuer\": { \"tax_id\": \"{{issuer_tax_id}}\" },\n \"customer\": {\n \"tax_id\": \"05823474911\",\n \"legal_name\": \"Cliente Exemplo\",\n \"email\": \"cliente@exemplo.com\",\n \"phone\": \"5549988079672\",\n \"address\": {\n \"street\": \"Rua Tamoios - E\",\n \"number\": \"1012\",\n \"neighborhood\": \"Esplanada\",\n \"city\": \"Chapecó\",\n \"state\": \"SC\",\n \"postal_code\": \"89812437\",\n \"municipality_code\": \"4204202\",\n \"country\": \"BR\"\n }\n },\n \"send_email\": false,\n \"service\": {\n \"description\": \"Consultoria de integração de sistemas\",\n \"cnae_code\": \"6201501\", \"lc116_code\": \"1.07\",\n \"national_tax_code\": \"010701\",\n \"municipal_tax_code\": \"802\"\n },\n \"taxes\": { \"iss_taxation\": 1, \"iss_retention_type\": 1, \"pis_cofins_cst\": \"01\" },\n \"values\": {\n \"total_amount\": 500,\n \"base_amount\": 500,\n \"pis_cofins_base_amount\": 500,\n \"pis_rate\": 0.65,\n \"pis_amount\": 3.25,\n \"cofins_rate\": 3,\n \"cofins_amount\": 15\n }\n }\n]" } } }, { "name": "Consultar NFS-e pelo emitente e ID externo", "request": { "method": "GET", "header": [{ "key": "x-api-key", "value": "{{api_key}}" }], "url": "{{base_url}}/nfse/{{issuer_tax_id}}/{{nfse_external_id}}" } }, { "name": "Perfil de município (verifica provider municipal)", "request": { "method": "GET", "header": [{ "key": "x-api-key", "value": "{{api_key}}" }], "url": "{{base_url}}/nfse/4204202/profile" } } ] }, { "name": "NFCom", "item": [ { "name": "Configurar NFCom da empresa", "request": { "method": "PUT", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfcom/config/companies/{{issuer_tax_id}}", "body": { "mode": "raw", "raw": "{ \"environment\": \"production\", \"series\": \"1\" }" } } }, { "name": "Enviar NFCom", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfcom", "body": { "mode": "raw", "raw": "[\n {\n \"external_id\": \"nfcom-001\",\n \"issuer\": {\n \"tax_id\": \"{{issuer_tax_id}}\",\n \"address\": {\n \"street\": \"Rua Tamoios - E\", \"number\": \"1012\", \"neighborhood\": \"Esplanada\",\n \"city\": \"Chapecó\", \"state\": \"SC\", \"postal_code\": \"89812437\",\n \"municipality_code\": \"4204202\"\n }\n },\n \"customer\": {\n \"tax_id\": \"05823474911\", \"legal_name\": \"Cliente Exemplo\", \"ie_indicator\": 9,\n \"address\": {\n \"street\": \"Rua do Cliente\", \"number\": \"10\", \"neighborhood\": \"Bairro Alto\",\n \"city\": \"Chapecó\", \"state\": \"SC\", \"postal_code\": \"89801001\",\n \"municipality_code\": \"4204202\"\n }\n },\n \"subscriber\": { \"code\": \"ASSIN-100\", \"type\": 3, \"service_type\": 4 },\n \"service\": {\n \"items\": [{\n \"product_code\": \"PLANO-100\", \"description\": \"Plano de internet 100 MB\",\n \"classification_code\": \"0100401\", \"unit\": 4, \"quantity\": 1, \"unit_value\": 99.9,\n \"icms\": { \"cst\": \"00\", \"base\": 99.9, \"rate\": 17, \"amount\": 16.98 }\n }]\n }\n }\n]" } } }, { "name": "Consultar NFCom pelo emitente e ID externo", "request": { "method": "GET", "header": [{ "key": "x-api-key", "value": "{{api_key}}" }], "url": "{{base_url}}/nfcom/{{issuer_tax_id}}/{{nfcom_external_id}}" } } ] }, { "name": "NF-e", "item": [ { "name": "Configurar NF-e da empresa", "request": { "method": "PUT", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfe/config/companies/{{issuer_tax_id}}", "body": { "mode": "raw", "raw": "{ \"environment\": \"production\", \"numbering\": [{ \"series\": \"1\", \"number\": 1 }] }" } } }, { "name": "Enviar NF-e", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/nfe", "body": { "mode": "raw", "raw": "[\n {\n \"external_id\": \"nfe-001\",\n \"identification\": {\n \"operation_nature\": \"VENDA DE MERCADORIA\", \"type\": 1, \"destination\": 1, \"purpose\": 1,\n \"final_consumer\": true, \"presence_indicator\": 1, \"taxable_event_municipality_code\": \"4204202\"\n },\n \"issuer\": { \"tax_id\": \"{{issuer_tax_id}}\" },\n \"items\": [{\n \"product\": {\n \"code\": \"P001\", \"description\": \"PRODUTO TESTE\", \"ncm\": \"85044010\", \"cfop\": \"5102\",\n \"commercial_unit\": \"UN\", \"commercial_quantity\": 1, \"commercial_unit_value\": 100,\n \"total_value\": 100, \"taxable_unit\": \"UN\", \"taxable_quantity\": 1, \"taxable_unit_value\": 100,\n \"composes_total\": true\n },\n \"taxes\": { \"icms\": { \"csosn\": \"102\", \"origin\": 0 } }\n }],\n \"totals\": { \"icms\": {\n \"base\": 0, \"amount\": 0, \"desonerated_amount\": 0, \"fcp_amount\": 0, \"st_base\": 0,\n \"st_amount\": 0, \"st_fcp_amount\": 0, \"st_withheld_fcp_amount\": 0, \"products_amount\": 100,\n \"freight_amount\": 0, \"insurance_amount\": 0, \"discount_amount\": 0, \"import_tax_amount\": 0,\n \"ipi_amount\": 0, \"ipi_returned_amount\": 0, \"pis_amount\": 0, \"cofins_amount\": 0,\n \"other_amount\": 0, \"nfe_amount\": 100\n } },\n \"transport\": { \"freight_mode\": 9 },\n \"payments\": [{ \"indicator\": 0, \"type\": \"01\", \"amount\": 100 }]\n }\n]" } } }, { "name": "Consultar NF-e pelo emitente e ID externo", "request": { "method": "GET", "header": [{ "key": "x-api-key", "value": "{{api_key}}" }], "url": "{{base_url}}/nfe/{{issuer_tax_id}}/{{nfe_external_id}}" } } ] }, { "name": "Integrações e Webhooks", "item": [ { "name": "Criar chave de API (workspace)", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "url": "{{base_url}}/workspaces/:workspace_id/integrations", "body": { "mode": "raw", "raw": "{ \"name\": \"Minha integração\", \"active\": true, \"allowed_ips\": [\"0.0.0.0/0\"] }" }, "variable": [{ "key": "workspace_id", "value": "" }] } }, { "name": "Criar webhook", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{base_url}}/webhooks", "body": { "mode": "raw", "raw": "{\n \"name\": \"Webhook ERP\",\n \"url\": \"https://erp.cliente.com.br/webhooks/nfse\",\n \"events\": [\"nfse_authorized\", \"nfse_rejected\"],\n \"active\": true\n}" } } } ] } ] }