{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/devnota.com.br" } ], "info": { "name": "API NFSe", "_postman_id": "b0623300-cd63-4f09-8142-b3bad70aeac7", "description": "API for issuing and canceling service invoices, providing efficient and secure integration.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Company management", "description": "\nAPIs for managing companies", "item": [ { "name": "GET api\/companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies", "query": [], "raw": "{{baseUrl}}\/api\/companies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\": 1, \"name\": \"Company A\", \"cnpj\": \"12345678000100\", \"im\": \"12345\"}, {\"id\": 2, \"name\": \"Company B\", \"cnpj\": \"98765432000100\", \"im\": \"67890\"}, {\"id\": 3, \"name\": \"Company C\", \"cnpj\": \"11223344000100\", \"im\": \"54321\"}]", "name": "" } ] }, { "name": "POST api\/companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies", "query": [], "raw": "{{baseUrl}}\/api\/companies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme Corporation\",\"ibge_code\":\"2611606\",\"state_id\":\"quia\",\"fantasy_name\":\"Acme\",\"cnpj\":\"12345678000195\",\"im\":1428873}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"id\": 1, \"name\": \"Company A\", \"cnpj\": \"12345678000100\", \"im\": \"12345\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The name field is required. (and 1 more error)\",\"errors\":{\"name\":[\"The name field is required.\"],\"cert_file\":[\"The cert file field is required.\"]}}", "name": "" } ] }, { "name": "PUT api\/companies\/{cnpj}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:cnpj", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:cnpj", "variable": [ { "id": "cnpj", "key": "cnpj", "value": "sed", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme Corporation\",\"ibge_code\":\"2611606\",\"state_id\":\"repellendus\",\"fantasy_name\":\"Acme\",\"cnpj\":\"12345678000195\",\"im\":1428873}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"id\": 1, \"name\": \"Company A\", \"cnpj\": \"12345678000100\", \"im\": \"12345\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The name field is required. (and 1 more error)\",\"errors\":{\"name\":[\"The name field is required.\"],\"cert_file\":[\"The cert file field is required.\"]}}", "name": "" } ] }, { "name": "POST api\/companies\/{cnpj}\/certificate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:cnpj\/certificate", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:cnpj\/certificate", "variable": [ { "id": "cnpj", "key": "cnpj", "value": "nostrum", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cert_file\":\"MIIC... (base64 encoded certificate)\",\"cert_pass\":\"password123\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"id\": 1, \"cert_file\": \"Company A\", \"cnpj\": \"12345678000100\", \"im\": \"12345\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"The cert file field is required.\", \"errors\": {\"cert_file\": [\"The cert file field is required.\"]}}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/consultar\/protocolo\/{protocolo}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/consultar\/protocolo\/:protocolo", "query": [], "raw": "{{baseUrl}}\/api\/consultar\/protocolo\/:protocolo", "variable": [ { "id": "protocolo", "key": "protocolo", "value": "eos", "description": "The protocolo." } ] }, "method": "GET", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"protocolo\": 2948,\"status\": \"processado\",\"response\": [{\"rps\": \"20\",\"link\": \"https:\/\/nfse.recife.pe.gov.br\/nfse.aspx?ccm=4305116&nf=5661&cod=CJJYPZEV\",\"numero\": \"5661\",\"data_emissao\": \"2025-04-14T17:47:08\",\"codigo_verificacao\": \"CJJY-PZEV\"}],\"xml\": \"https:\/\/nfse.civis.com.br\/xml\/2948\"}", "name": "" } ] } ] }, { "name": "NFCe management", "description": "\nAPIs for managing product invoices (NFCe)", "item": [ { "name": "Generate NFe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfc\/gerar", "query": [], "raw": "{{baseUrl}}\/api\/nfc\/gerar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"http:\\\/\\\/hahn.com\\\/veniam-esse-sed-nemo-impedit-sunt-aut\",\"ambiente\":\"developer\",\"ide\":{\"cUF\":7,\"cNF\":\"laudantium\",\"natOp\":\"vba\",\"serie\":19,\"nNF\":18,\"dhEmi\":\"2026-03-12T23:18:22+00:00\",\"dhSaiEnt\":\"2026-03-12T23:18:22+00:00\",\"tpNF\":0,\"idDest\":1,\"cMunFG\":17,\"tpImp\":4,\"tpEmis\":4,\"cDV\":5,\"finNFe\":1,\"indFinal\":0,\"indPres\":9,\"procEmi\":1,\"verProc\":\"vgxhzssgdvn\",\"dhCont\":\"2026-03-12T23:18:22+00:00\",\"xJust\":\"iwnnmugs\",\"NFref\":{\"refNFe\":\"donuoztbcsmiqmjqfvufdrplqaqljaromczusbwsaclu\"}},\"emit\":{\"CNPJ\":\"ahruiugznbevbu\",\"CPF\":\"qwlsyaizwod\",\"xNome\":\"fazsxhwxkrzbjkr\",\"xFant\":\"kyg\",\"IE\":\"tw\",\"IEST\":\"mukhujvkidpfoz\",\"IM\":\"gw\",\"CNAE\":\"tstuvln\",\"CRT\":1},\"enderEmit\":{\"xLgr\":\"carygesptdmfl\",\"nro\":\"ghvcfzxafznmopv\",\"xCpl\":\"pcvkhtttwhqufyw\",\"xBairro\":\"epwquibamjsjvdboxkpuiqf\",\"cMun\":6,\"xMun\":\"dgeanyhbdcu\",\"UF\":\"xa\",\"CEP\":\"xaixhwbv\",\"cPais\":3,\"xPais\":\"se\",\"fone\":\"jdliminnoydomq\"},\"dest\":{\"CNPJ\":\"bucnlnfjytfzre\",\"CPF\":\"vavruvrpicd\",\"idEstrangeiro\":\"ivtvs\",\"xNome\":\"eenmgqgabwpvueht\",\"indIEDest\":9,\"IE\":\"pqlqwdjyumu\",\"ISUF\":\"bqhaxyakx\",\"IM\":\"djmk\",\"email\":\"breichel@example.com\"},\"enderDest\":{\"xLgr\":\"uhe\",\"nro\":\"ngejkqnji\",\"xCpl\":\"xkrshvfkdmnbzcabajaiu\",\"xBairro\":\"drtg\",\"cMun\":20,\"xMun\":\"ukjfrubqxhkrwdbzwkaawytpq\",\"UF\":\"nx\",\"CEP\":\"kncraxhy\",\"cPais\":10,\"xPais\":\"ancefcicntvlejzziheurdvgc\",\"fone\":\"outww\"},\"retirada\":{\"CNPJ\":\"tehxanzjgzsows\",\"CPF\":\"voenxeggqcn\",\"xNome\":\"ablwhgdcw\",\"xLgr\":\"ghvwdojofixjegx\",\"nro\":\"rzfzi\",\"xCpl\":\"vgmypjpbaudtnixr\",\"xBairro\":\"f\",\"cMun\":20,\"xMun\":\"plwalkmanmzymxxbe\",\"UF\":\"kz\",\"CEP\":\"qfnqnxta\",\"cPais\":5,\"xPais\":\"eeruqku\",\"fone\":\"ffmk\"},\"entrega\":{\"CNPJ\":\"gisxuyjfbjwyfu\",\"CPF\":\"pbhgswtkdxf\",\"xNome\":\"vglmjspwsdheydoxowubs\",\"xLgr\":\"gbkbxlgxiddnvpexbtoixlj\",\"nro\":\"qwtmrqxlgj\",\"xCpl\":\"rrzyckfuunlxcfpam\",\"xBairro\":\"fwaujdp\",\"cMun\":19,\"xMun\":\"aupslahht\",\"UF\":\"ol\",\"CEP\":\"vcyvxlxp\",\"cPais\":19,\"xPais\":\"lbmyjorugpxhshybauyk\",\"fone\":\"frhjjfbdo\"},\"det\":[{\"nItem\":72,\"prod\":{\"cProd\":\"emxpulrbppir\",\"cEAN\":\"kjylygrxkm\",\"xProd\":\"s\",\"NCM\":\"fhvjutcp\",\"CEST\":\"dqjfeoq\",\"CFOP\":\"ekbg\",\"uCom\":\"h\",\"qCom\":72914015.466367,\"vUnCom\":3859.8195304,\"vProd\":319292.9,\"cEANTrib\":\"poekb\",\"uTrib\":\"uvsm\",\"qTrib\":95128580,\"vUnTrib\":3.26,\"indTot\":1},\"imposto\":{\"vTotTrib\":30921798.078547,\"ICMS\":[{\"orig\":2,\"CST\":20,\"CSOSN\":300,\"modBC\":2,\"vBC\":19319868.66820404,\"pICMS\":195069.57896557,\"vICMS\":0.8490213}],\"PIS\":[{\"CST\":65,\"vBC\":3391.116112,\"pPIS\":38554312,\"vPIS\":4667358.7}],\"COFINS\":[{\"CST\":98,\"vBC\":61604.62449,\"pCOFINS\":27488.1,\"vCOFINS\":4.309}]}}],\"total\":{\"ICMSTot\":{\"vBC\":37.2249,\"vICMS\":40652.19361042,\"vICMSDeson\":368196.9,\"vFCP\":5753950.687,\"vBCST\":1,\"vST\":714604700.147621,\"vFCPST\":4.2,\"vFCPSTRet\":5975008.78562211,\"vProd\":1412.54,\"vFrete\":1472.2,\"vSeg\":0.01573469,\"vDesc\":26656842.023658566,\"vII\":17.671111732,\"vIPI\":9339.77684,\"vIPIDevol\":4105.2,\"vPIS\":25811416,\"vCOFINS\":51211721.602850415,\"vOutro\":630.673,\"vNF\":713.472942,\"vTotTrib\":6159}},\"transp\":{\"modFrete\":4},\"pag\":{\"vTroco\":4319774.258168883,\"detPag\":[{\"indPag\":0,\"tPag\":\"vm\",\"vPag\":833.48,\"tpIntegra\":2,\"CNPJ\":\"huspvvqlcvvsep\",\"tBand\":6,\"cAut\":\"ms\"}]},\"infAdic\":{\"infAdFisco\":\"lfghqg\",\"infCpl\":\"xonyvli\"},\"infRespTec\":{\"CNPJ\":\"qquiekrefcsuzf\",\"xContato\":\"xgi\",\"email\":\"nkulas@example.org\",\"fone\":\"ihpivqvcnh\"}}" }, "description": "Create a new electronic invoice (NFe)" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 3050,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The notaFiscal field is required.\",\"errors\":{\"notaFiscal\":[\"The notaFiscal field is required.\"]}}", "name": "" } ] }, { "name": "Cancel NFe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfc\/cancelar", "query": [], "raw": "{{baseUrl}}\/api\/nfc\/cancelar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ambiente\":\"developer\",\"chave\":\"kvwvhmgcwktwbllcgbgreshljebbulydqlrnzplzqeha\",\"protocolo\":\"molestias\",\"justificativa\":\"gnclvm\"}" }, "description": "Cancel an existing electronic invoice (NFe)" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 3051,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The chave field is required.\",\"errors\":{\"chave\":[\"The chave field is required.\"]}}", "name": "" } ] }, { "name": "Correction Letter NFCe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfc\/cce", "query": [], "raw": "{{baseUrl}}\/api\/nfc\/cce" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"https:\\\/\\\/example.com\\\/callback\",\"ambiente\":\"production or developer\",\"chave\":\"43190512345678000123550010000000011000000011\",\"correcao\":\"Correction of the invoice data as per agreement.\",\"sequencial\":1}" }, "description": "Correct an existing electronic invoice (NFCe)" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 3051,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The chave field is required.\",\"errors\":{\"chave\":[\"The chave field is required.\"]}}", "name": "" } ] } ] }, { "name": "NFSe management", "description": "\nAPIs for managing services invoices (NFSe)", "item": [ { "name": "POST api\/nfse\/gerar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfse\/gerar", "query": [], "raw": "{{baseUrl}}\/api\/nfse\/gerar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"https:\\\/\\\/example.com\\\/callback\",\"ambiente\":\"production or developer\",\"rps\":{\"identificacao\":{\"numero\":123456,\"serie\":1,\"tipo\":1},\"data_emissao\":\"2023-10-01T12:00:00\",\"data_competencia\":\"2026-03-12\",\"natureza_operacao\":1,\"optante_simples_nacional\":1,\"regime_especial_tributacao_sn\":1,\"incentivador_cultural\":1,\"status\":1,\"servico\":{\"valores\":{\"valor_servicos\":100,\"iss_retido\":1,\"aliquota\":5,\"aliquota_fed\":3,\"aliquota_est\":0.0906476,\"aliquota_mun\":3585.88,\"valor_deducoes\":10,\"valor_total_recebido\":90,\"valor_pis\":1,\"valor_cofins\":1,\"valor_inss\":1,\"valor_ir\":1,\"valor_csll\":1,\"valor_iss\":1,\"valor_iss_retido\":1,\"outras_retencoes\":1,\"base_calculo\":100,\"valor_liquido_nfse\":90,\"desconto_incondicionado\":0,\"desconto_condicionado\":0,\"cst\":\"01\",\"pis_cofins_retido\":1},\"item_lista_servico\":123456,\"codigo_cnae\":12345678,\"nbs\":12345678,\"codigo_tributacao_municipio\":123456,\"discriminacao\":\"Service description\",\"codigo_municipio\":123456,\"regime_especial_tributacao\":1,\"exigibilidade_iss\":1,\"municipio_incidencia\":123456,\"informacoes_complementares\":\"voluptatem\"},\"tomador\":{\"nome\":\"John Doe\",\"cpf\":\"12345678901\",\"cnpj\":\"12345678901234\",\"endereco\":\"123 Main St\",\"numero\":\"123\",\"complemento\":\"Apt 1\",\"bairro\":\"Downtown\",\"codigo_municipio\":123456,\"uf\":\"SP\",\"cep\":\"12345678\",\"telefone\":\"38665465\",\"email\":\"claudia.orn@example.net\"},\"obra\":{\"cep\":\"12345678\",\"endereco\":\"456 Elm St\",\"numero\":\"456\",\"bairro\":\"Uptown\",\"codigo_obra\":123456,\"art\":\"123456789\"}}}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 2950,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The rps.identificacao.numero field is required.\",\"errors\":{\"rps.identificacao.numero\":[\"The rps.identificacao.numero field is required.\"]}}", "name": "" } ] }, { "name": "POST api\/nfse\/gerar\/lote", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfse\/gerar\/lote", "query": [], "raw": "{{baseUrl}}\/api\/nfse\/gerar\/lote" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"https:\\\/\\\/example.com\\\/callback\",\"ambiente\":\"production or developer\",\"lote\":123456,\"rps\":[{\"identificacao\":{\"numero\":123456,\"serie\":1,\"tipo\":1},\"data_emissao\":\"2023-10-01T12:00:00\",\"natureza_operacao\":1,\"optante_simples_nacional\":1,\"incentivador_cultural\":1,\"status\":1,\"servico\":{\"valores\":{\"valor_servicos\":100,\"iss_retido\":1,\"aliquota\":5,\"valor_deducoes\":10,\"valor_total_recebido\":90,\"valor_pis\":1,\"valor_cofins\":1,\"valor_inss\":1,\"valor_ir\":1,\"valor_csll\":1,\"valor_iss_retido\":1,\"outras_retencoes\":1,\"base_calculo\":100,\"valor_liquido_nfse\":90,\"desconto_incondicionado\":0,\"desconto_condicionado\":0,\"cst\":\"01\",\"pis_cofins_retido\":1},\"item_lista_servico\":123456,\"codigo_cnae\":12345678,\"codigo_tributacao_municipio\":123456,\"discriminacao\":\"Service description\",\"codigo_municipio\":123456,\"regime_especial_tributacao\":1,\"exigibilidade_iss\":1,\"municipio_incidencia\":123456},\"tomador\":{\"nome\":\"John Doe\",\"cpf\":\"12345678901\",\"cnpj\":\"12345678901234\",\"endereco\":\"123 Main St\",\"numero\":\"123\",\"complemento\":\"Apt 1\",\"bairro\":\"Downtown\",\"codigo_municipio\":123456,\"uf\":\"SP\",\"cep\":\"12345678\"},\"obra\":{\"cep\":\"12345678\",\"endereco\":\"456 Elm St\",\"numero\":\"456\",\"bairro\":\"Uptown\",\"codigo_obra\":123456,\"art\":\"123456789\"}}]}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 2950,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The rps.0.identificacao.numero field is required.\",\"errors\":{\"rps.identificacao.0.numero\":[\"The rps.0.identificacao.numero field is required.\"]}}", "name": "" } ] }, { "name": "POST api\/nfse\/cancelar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfse\/cancelar", "query": [], "raw": "{{baseUrl}}\/api\/nfse\/cancelar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"https:\\\/\\\/example.com\\\/callback\",\"ambiente\":\"production or developer\",\"numero\":123456,\"codigo_cancelamento\":1,\"motivo\":\"sapiente\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 2950,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The numero field is required.\",\"errors\":{\"numero\":[\"The numero field is required.\"]}}", "name": "" } ] } ] }, { "name": "NFSe v2 management", "description": "\nAPIs for managing services invoices (NFSe)", "item": [ { "name": "POST api\/v2\/nfse\/gerar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/nfse\/gerar", "query": [], "raw": "{{baseUrl}}\/api\/v2\/nfse\/gerar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 2950,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The rps.identificacao.numero field is required.\",\"errors\":{\"rps.identificacao.numero\":[\"The rps.identificacao.numero field is required.\"]}}", "name": "" } ] }, { "name": "POST api\/v2\/nfse\/gerar\/lote", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/nfse\/gerar\/lote", "query": [], "raw": "{{baseUrl}}\/api\/v2\/nfse\/gerar\/lote" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 2950,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The rps.0.identificacao.numero field is required.\",\"errors\":{\"rps.identificacao.0.numero\":[\"The rps.0.identificacao.numero field is required.\"]}}", "name": "" } ] }, { "name": "POST api\/v2\/nfse\/cancelar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/nfse\/cancelar", "query": [], "raw": "{{baseUrl}}\/api\/v2\/nfse\/cancelar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 2950,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The numero field is required.\",\"errors\":{\"numero\":[\"The numero field is required.\"]}}", "name": "" } ] } ] }, { "name": "NFe management", "description": "\nAPIs for managing product invoices (NFe)", "item": [ { "name": "Generate NFe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfe\/gerar", "query": [], "raw": "{{baseUrl}}\/api\/nfe\/gerar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"https:\\\/\\\/exemplo.com\\\/webhook\",\"ambiente\":\"production\",\"ide\":{\"cUF\":26,\"cNF\":\"83319433\",\"natOp\":\"VENDA FORA DO ESTADO\",\"serie\":1,\"nNF\":15233,\"dhEmi\":\"2025-06-02T08:38:53-03:00\",\"dhSaiEnt\":\"2025-06-02T08:38:53-03:00\",\"tpNF\":1,\"idDest\":2,\"cMunFG\":2611101,\"tpImp\":1,\"tpEmis\":1,\"cDV\":0,\"finNFe\":1,\"indFinal\":1,\"indPres\":0,\"procEmi\":0,\"verProc\":\"2.1.4 - 1.046.4\",\"dhCont\":\"2025-06-02T08:38:53-03:00\",\"xJust\":\"Justificativa para entrada em conting\u00eancia\",\"NFref\":{\"refNFe\":\"35220608339483000120550010001523341000123345\"}},\"emit\":{\"CNPJ\":\"00000000000000\",\"CPF\":\"12345678901\",\"xNome\":\"DEVNOTA LTDA\",\"xFant\":\"DEVNOTA LTDA\",\"IE\":\"027840417\",\"IEST\":\"123456789\",\"IM\":\"123456789012345\",\"CNAE\":\"4530703\",\"CRT\":1},\"enderEmit\":{\"xLgr\":\"AV SETE DE SETEMBRO\",\"nro\":\"690\",\"xCpl\":\"SALA 01\",\"xBairro\":\"OURO PRETO\",\"cMun\":2611101,\"xMun\":\"PETROLINA\",\"UF\":\"PE\",\"CEP\":\"56306610\",\"cPais\":1058,\"xPais\":\"BRASIL\",\"fone\":\"8738636050\"},\"dest\":{\"CNPJ\":\"00000000000000\",\"CPF\":\"00000000000\",\"idEstrangeiro\":\"ID123456789\",\"xNome\":\"JOAO SILVA\",\"indIEDest\":1,\"IE\":\"081054726\",\"ISUF\":\"123456789\",\"IM\":\"123456789012345\",\"email\":\"cliente@exemplo.com\"},\"enderDest\":{\"xLgr\":\"AVENIDA TRANSNORDESTINA\",\"nro\":\"71\",\"xCpl\":\"APTO 101\",\"xBairro\":\"JARDIM AMAZONAS\",\"cMun\":2611101,\"xMun\":\"PETROLINA\",\"UF\":\"PE\",\"CEP\":\"56318750\",\"cPais\":1058,\"xPais\":\"BRASIL\",\"fone\":\"8738636050\"},\"retirada\":{\"CNPJ\":\"00000000000000\",\"CPF\":\"00000000000\",\"xNome\":\"JOAO SILVA\",\"xLgr\":\"AVENIDA TRANSNORDESTINA\",\"nro\":\"71\",\"xCpl\":\"APTO 101\",\"xBairro\":\"JARDIM AMAZONAS\",\"cMun\":2611101,\"xMun\":\"PETROLINA\",\"UF\":\"PE\",\"CEP\":\"56318750\",\"cPais\":1058,\"xPais\":\"BRASIL\",\"fone\":\"8738636050\"},\"entrega\":{\"CNPJ\":\"00000000000000\",\"CPF\":\"00000000000\",\"xNome\":\"JOAO SILVA\",\"xLgr\":\"AVENIDA TRANSNORDESTINA\",\"nro\":\"71\",\"xCpl\":\"APTO 101\",\"xBairro\":\"JARDIM AMAZONAS\",\"cMun\":2611101,\"xMun\":\"PETROLINA\",\"UF\":\"PE\",\"CEP\":\"56318750\",\"cPais\":1058,\"xPais\":\"BRASIL\",\"fone\":\"8738636050\"},\"det\":[{\"nItem\":1,\"prod\":{\"cProd\":\"BR50320C\",\"cEAN\":\"SEM GTIN\",\"xProd\":\"REGULADOR FREIO S-10 12\\\/.. TRAS\\\/ESQ\",\"NCM\":\"87083019\",\"NVE\":\"AB0001\",\"CEST\":\"0100100\",\"indEscala\":\"N\",\"CNPJFab\":\"00000000000000\",\"cBenef\":\"PE123456\",\"EXTIPI\":\"001\",\"CFOP\":\"5405\",\"uCom\":\"PC\",\"qCom\":1,\"vUnCom\":130,\"vProd\":130,\"cEANTrib\":\"SEM GTIN\",\"uTrib\":\"PC\",\"qTrib\":1,\"vUnTrib\":130,\"vFrete\":0,\"vSeg\":0,\"vDesc\":0,\"vOutro\":0,\"indTot\":1,\"xPed\":\"43728\",\"nItemPed\":1,\"nFCI\":\"12345678-1234-1234-1234-123456789012\",\"comb\":{\"cProdANP\":\"210203001\",\"descANP\":\"GLP ENVASADO\",\"pGLP\":0.5,\"pGNn\":0.3,\"pGNi\":0.2,\"vPart\":100.25,\"CODIF\":\"ABC123456789\",\"qTemp\":12.1234,\"UFCons\":\"PE\",\"qBCProd\":10,\"vAliqProd\":1.25,\"vCIDE\":12.5,\"encerrante\":{\"nBico\":1,\"nBomba\":2,\"nTanque\":3,\"vEncIni\":100.123,\"vEncFin\":110.123}}},\"imposto\":{\"vTotTrib\":42.63,\"ICMS\":[{\"orig\":0,\"CST\":\"00\",\"CSOSN\":\"500\",\"modBC\":3,\"vBC\":130,\"pICMS\":18,\"vICMS\":23.4,\"vBCSTRet\":0,\"pST\":17,\"vICMSSubstituto\":0,\"vICMSSTRet\":0}],\"PIS\":[{\"CST\":\"04\",\"vBC\":130,\"pPIS\":1.65,\"vPIS\":2.15}],\"COFINS\":[{\"CST\":\"04\",\"vBC\":130,\"pCOFINS\":7.6,\"vCOFINS\":9.88}],\"IBSCBS\":[{\"vBC\":6257.8,\"CST\":2332486.85,\"cClassTrib\":1}],\"IPI\":{\"clEnq\":\"12345\",\"CNPJProd\":\"00000000000000\",\"cSelo\":\"SELO123456\",\"qSelo\":1,\"cEnq\":\"999\",\"CST\":\"50\",\"vBC\":130,\"pIPI\":10,\"qUnid\":1,\"vUnid\":13,\"vIPI\":13},\"II\":{\"vBC\":130,\"vDespAdu\":5,\"vII\":15,\"vIOF\":2}}}],\"total\":{\"ICMSTot\":{\"vBC\":0,\"vICMS\":0,\"vICMSDeson\":0,\"vFCP\":0,\"vBCST\":0,\"vST\":0,\"vFCPST\":0,\"vFCPSTRet\":0,\"vProd\":130,\"vFrete\":0,\"vSeg\":0,\"vDesc\":0,\"vII\":0,\"vIPI\":0,\"vIPIDevol\":0,\"vPIS\":0,\"vCOFINS\":0,\"vOutro\":0,\"vNF\":130,\"vTotTrib\":42.63}},\"transp\":{\"modFrete\":0,\"transporta\":{\"CNPJ\":\"00000000000000\",\"CPF\":\"12345678901\",\"xNome\":\"Transportadora Exemplo Ltda\",\"IE\":\"123456789\",\"xEnder\":\"Rua das Flores, 123, Centro\",\"xMun\":\"S\u00e3o Paulo\",\"UF\":\"SP\"},\"retTransp\":{\"vServ\":150,\"vBCRet\":150,\"pICMSRet\":12,\"vICMSRet\":18,\"CFOP\":\"5353\",\"cMunFG\":3550308},\"veicTransp\":{\"placa\":\"ABC1234\",\"UF\":\"SP\",\"RNTC\":\"12345678\"},\"vol\":{\"qVol\":19,\"esp\":\"snwjtfpgzvnvttrd\",\"marca\":\"wivgkaaquvnkm\",\"nVol\":\"brwfgiyxehclnuzhluwikrxn\",\"pesoL\":261980.38,\"pesoB\":3035926},\"reboque\":[{\"placa\":\"DEF5678\",\"UF\":\"SP\",\"RNTC\":\"87654321\"}]},\"pag\":{\"detPag\":[{\"indPag\":0,\"tPag\":\"01\",\"vPag\":130,\"tpIntegra\":1,\"CNPJ\":\"xjutnspslnhvnw\",\"tBand\":13,\"cAut\":\"rkduoebpwteqibvpatomllymk\"}],\"vTroco\":5},\"infAdic\":{\"infAdFisco\":\"Informa\u00e7\u00f5es adicionais do fisco\",\"infCpl\":\"MD-5: .ICMS PAGO ANTERIORMENTE POR SUBST. TRIBUTARIA CONF. DECRETO N: 35.679\\\/2010 E 33.205 DE 27\\\/03\\\/2009\"},\"infRespTec\":{\"CNPJ\":\"00000000000000\",\"xContato\":\"Programador\",\"email\":\"contato@devnota.com.br\",\"fone\":\"1937553000\"}}" }, "description": "Create a new electronic invoice (NFe)" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 3050,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The notaFiscal field is required.\",\"errors\":{\"notaFiscal\":[\"The notaFiscal field is required.\"]}}", "name": "" } ] }, { "name": "Cancel NFe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfe\/cancelar", "query": [], "raw": "{{baseUrl}}\/api\/nfe\/cancelar" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ambiente\":\"production\",\"chave\":\"tvtgyeayclovvzirzciyudoouibgefrlqmlukxczdkjy\",\"protocolo\":\"rerum\",\"justificativa\":\"oqyburzadbyxks\"}" }, "description": "Cancel an existing electronic invoice (NFe)" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 3051,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The chave field is required.\",\"errors\":{\"chave\":[\"The chave field is required.\"]}}", "name": "" } ] }, { "name": "Correction Letter NFe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfe\/cce", "query": [], "raw": "{{baseUrl}}\/api\/nfe\/cce" }, "method": "POST", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"callback\":\"https:\\\/\\\/example.com\\\/callback\",\"ambiente\":\"production or developer\",\"chave\":\"43190512345678000123550010000000011000000011\",\"correcao\":\"Correction of the invoice data as per agreement.\",\"sequencial\":1}" }, "description": "Correct an existing electronic invoice (NFe)" }, "response": [ { "header": [], "code": 201, "body": "{\"protocolo\": 3051,\"status\": \"processando\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The chave field is required.\",\"errors\":{\"chave\":[\"The chave field is required.\"]}}", "name": "" } ] }, { "name": "Distribution NFe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/nfe\/dist", "query": [], "raw": "{{baseUrl}}\/api\/nfe\/dist" }, "method": "GET", "header": [ { "key": "Company", "value": "{YOUR_COMPANY_CNPJ}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve distributed electronic invoices (NFe)" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 500, "body": "{\"success\":false,\"message\":\"Unauthenticated.\",\"error\":\"AuthenticationException\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }