Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (1=Produção, 2=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). situacao vem sempre em 3 valores: aderente, nao_aderente ou desconhecido (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. desconhecido nunca é fabricado como não aderente.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"EngineAPI","description":"Documentação pública da engineAPI: emissão de NF-e, NFC-e, NFS-e e mais, direto na SEFAZ.","colors":{"primary":"#1E56B1","light":"#2D7AF6","dark":"#0F2A5E"},"logo":{"light":"https://mintcdn.com/3xtec/upxot-gn5enp24zf/logo/light.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=63aef46d17335e80239cdc40c74322e9","dark":"https://mintcdn.com/3xtec/upxot-gn5enp24zf/logo/dark.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=32d8c9d72ff50350091826485812d053"},"favicon":"https://mintcdn.com/3xtec/upxot-gn5enp24zf/favicon.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=2710eead1ba540400726bc73e0244b91","api":{"openapi":"openapi.json"},"appearance":{"default":"light","strict":false},"navbar":{"links":[{"href":"https://app.engineapi.com.br","label":"App"}],"primary":{"type":"button","label":"Começar grátis","href":"https://app.engineapi.com.br/auth/register"}},"footer":{"links":[{"header":"Produto","items":[{"label":"App","href":"https://app.engineapi.com.br"},{"label":"Começar grátis","href":"https://app.engineapi.com.br/auth/register"}]},{"header":"Suporte","items":[{"label":"suporte@engineapi.com.br","href":"mailto:suporte@engineapi.com.br"}]}]},"search":{"prompt":"Buscar..."},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"3xtec","hasAudioNarration":false,"actualSubdomain":"3xtec","customDomains":["docs.engineapi.com.br"],"gitSource":{"type":"github","owner":"3x-git","repo":"engine-api","deployBranch":"develop","contentDirectory":"apps/docs-mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acae18b30925e44ebb51012","collectionId":"5de367f7-8235-49df-a3ef-858641d0e29c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acae18b30925e44ebb51012"},"entitlements":{},"buildId":"6acb736d4f34638a06955649","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":119},{"language":"default","tag":"Endpoints","count":111},{"language":"default","tag":"Documentação","count":47},{"language":"default","tag":"NFe","count":22},{"language":"default","tag":"Autenticação","count":20},{"language":"default","tag":"Cérebro Fiscal","count":16},{"language":"default","tag":"NFSe","count":11},{"language":"default","tag":"Emissão","count":10},{"language":"default","tag":"Erros e operação","count":10},{"language":"default","tag":"Empresas","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/nfse/cobertura-da-nfs-e-por-município","slug":"/api-reference/nfse/cobertura-da-nfs-e-por-município","pageMetadata":{"title":"Cobertura da NFS-e por município","description":"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (`1`=Produção, `2`=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). `situacao` vem sempre em 3 valores: `aderente`, `nao_aderente` ou `desconhecido` (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. `desconhecido` nunca é fabricado como `não aderente`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/cobertura/{ibge}","href":"/api-reference/nfse/cobertura-da-nfs-e-por-município","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (\", _jsx(_components.code, {\n children: \"1\"\n }), \"=Produção, \", _jsx(_components.code, {\n children: \"2\"\n }), \"=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). \", _jsx(_components.code, {\n children: \"situacao\"\n }), \" vem sempre em 3 valores: \", _jsx(_components.code, {\n children: \"aderente\"\n }), \", \", _jsx(_components.code, {\n children: \"nao_aderente\"\n }), \" ou \", _jsx(_components.code, {\n children: \"desconhecido\"\n }), \" (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. \", _jsx(_components.code, {\n children: \"desconhecido\"\n }), \" nunca é fabricado como \", _jsx(_components.code, {\n children: \"não aderente\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cobertura da NFS-e por município","description":"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (`1`=Produção, `2`=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). `situacao` vem sempre em 3 valores: `aderente`, `nao_aderente` ou `desconhecido` (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. `desconhecido` nunca é fabricado como `não aderente`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/cobertura/{ibge}","href":"/api-reference/nfse/cobertura-da-nfs-e-por-município","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (`1`=Produção, `2`=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). `situacao` vem sempre em 3 valores: `aderente`, `nao_aderente` ou `desconhecido` (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. `desconhecido` nunca é fabricado como `não aderente`.","operationId":"consultarCobertura","parameters":["7290fac3-6fa7-4bd7-bc6a-465737671d69","626239d4-7542-4faf-85c9-8a645a6a4bdf","cc945de7-3ef7-4b19-a99a-87a1269a84a0"],"responses":{"200":"5428ca28-e1be-4920-86f2-1a67b2344792","400":"3bb0cb0d-d161-4507-a26e-ff055b3e8232"},"security":["575ca09c-f849-46d3-b39b-9692ac6ea018"],"summary":"Cobertura da NFS-e por município","tags":["NFSe"],"method":"get","type":"path","servers":["554c3c59-78aa-445d-a37b-eb89b25d62bd"],"path":"/v1/nfse/cobertura/{ibge}","baseUrlOptions":["https://api.engineapi.com.br"],"title":"Cobertura da NFS-e por município","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7290fac3-6fa7-4bd7-bc6a-465737671d69":{"name":"ibge","required":true,"in":"path","description":"Código IBGE do município (7 dígitos)","schema":{"pattern":"^[0-9]{7}$","type":"string","isRequired":true,"description":"Código IBGE do município (7 dígitos)","uniqueKey":"","typeLabel":"string"}},"626239d4-7542-4faf-85c9-8a645a6a4bdf":{"name":"ambiente","required":false,"in":"query","description":"1=Produção, 2=Produção Restrita. Default: ambiente fiscal do primeiro emissor do parceiro autenticado, ou 1 sem emissor cadastrado.","schema":{"oneOf":[{"type":"string","const":"1","description":"1=Produção, 2=Produção Restrita. Default: ambiente fiscal do primeiro emissor do parceiro autenticado, ou 1 sem emissor cadastrado.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"string","const":"2","description":"1=Produção, 2=Produção Restrita. Default: ambiente fiscal do primeiro emissor do parceiro autenticado, ou 1 sem emissor cadastrado.","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"string"}},"cc945de7-3ef7-4b19-a99a-87a1269a84a0":{"name":"atualizar","required":false,"in":"query","description":"true força reconsulta ao ADN (ignora o TTL do espelho) usando um certificado do parceiro autenticado, quando disponível.","schema":{"type":"string","enum":["true","false"],"isRequired":false,"description":"true força reconsulta ao ADN (ignora o TTL do espelho) usando um certificado do parceiro autenticado, quando disponível.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"5428ca28-e1be-4920-86f2-1a67b2344792":{"description":"{ ibge, ambiente, situacao, aderente, desde, fonte, detalhes, motivo? }","content":{"application/json":{"schema":{"type":"object","properties":{"ibge":{"type":"string","isRequired":true,"uniqueKey":"ibge","typeLabel":"string"},"ambiente":{"oneOf":[{"type":"number","const":1,"isRequired":true,"uniqueKey":"ambiente.oneOf.0","typeLabel":"number"},{"type":"number","const":2,"isRequired":true,"uniqueKey":"ambiente.oneOf.1","typeLabel":"number"}],"isRequired":true,"uniqueKey":"ambiente","typeLabel":"number"},"situacao":{"type":"string","enum":["aderente","nao_aderente","desconhecido"],"isRequired":true,"uniqueKey":"situacao","typeLabel":"enum\u003cstring>"},"aderente":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"aderente.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"aderente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"aderente","typeLabel":"boolean | null"},"desde":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","isRequired":true,"uniqueKey":"desde.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"desde.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"desde","typeLabel":"string\u003cdate-time> | null"},"fonte":{"type":"string","isRequired":true,"uniqueKey":"fonte","typeLabel":"string"},"detalhes":{"type":"object","properties":{"aderenteEmissorNacional":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"detalhes.aderenteEmissorNacional.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"detalhes.aderenteEmissorNacional.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"detalhes.aderenteEmissorNacional","typeLabel":"boolean | null"},"situacaoEmissaoPadraoContribuintesRFB":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"detalhes.situacaoEmissaoPadraoContribuintesRFB.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"detalhes.situacaoEmissaoPadraoContribuintesRFB.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"detalhes.situacaoEmissaoPadraoContribuintesRFB","typeLabel":"number | null"},"mensagem":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detalhes.mensagem.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"detalhes.mensagem.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"detalhes.mensagem","typeLabel":"string | null"}},"required":["aderenteEmissorNacional","situacaoEmissaoPadraoContribuintesRFB","mensagem"],"isRequired":true,"uniqueKey":"detalhes","typeLabel":"object"},"motivo":{"type":"string","uniqueKey":"motivo","typeLabel":"string"}},"required":["ibge","ambiente","situacao","aderente","desde","fonte","detalhes"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ibge":"\u003cstring>","ambiente":1,"situacao":"aderente","aderente":true,"desde":"2023-11-07T05:31:56Z","fonte":"\u003cstring>","detalhes":{"aderenteEmissorNacional":true,"situacaoEmissaoPadraoContribuintesRFB":123,"mensagem":"\u003cstring>"},"motivo":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3bb0cb0d-d161-4507-a26e-ff055b3e8232":{"description":"Código IBGE inválido (não tem 7 dígitos)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"575ca09c-f849-46d3-b39b-9692ac6ea018":{"JWT-auth":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Token JWT obtido via /v1/auth/login","scopes":[],"schemeName":"JWT-auth"}}},"servers":{"554c3c59-78aa-445d-a37b-eb89b25d62bd":{"url":"https://api.engineapi.com.br","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Token JWT obtido via /v1/auth/login","scopes":[],"schemeName":"JWT-auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token JWT obtido via /v1/auth/login","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"JWT-auth","name":"Authorization"}],"title":"JWT-auth"}]},"originalFileLocation":"openapi.json"},"subdomain":"3xtec","siteName":"EngineAPI","title":"Cobertura da NFS-e por município - EngineAPI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-10T12:04:58.103Z","originalFileLocation":"api-reference/nfse/cobertura-da-nfs-e-por-município.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (1=Produção, 2=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). situacao vem sempre em 3 valores: aderente, nao_aderente ou desconhecido (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. desconhecido nunca é fabricado como não aderente.\">\u003cmeta data-mint-head name=\"application-name\" content=\"EngineAPI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cobertura da NFS-e por município - EngineAPI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (1=Produção, 2=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). situacao vem sempre em 3 valores: aderente, nao_aderente ou desconhecido (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. desconhecido nunca é fabricado como não aderente.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"EngineAPI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-município\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://3xtec.mintlify.app/_mintlify/api/og/v2?division=NFSe\u0026amp;title=Cobertura+da+NFS-e+por+munic%C3%ADpio\u0026amp;description=Consulta+o+espelho+local+do+conv%C3%AAnio+do+Sistema+Nacional+da+NFS-e+%28ADN%29+para+um+c%C3%B3digo+IBGE+%E2%80%94+se+o+munic%C3%ADpio+%C3%A9+aderente+ao+Padr%C3%A3o+Nacional+NESTE+ambiente+%28%601%60%3DP\u0026amp;theme=f7c46973c22350b6fc03fc3c\u0026amp;signature=a65170f7642f578796aa10301e02f374f81d810b9065a3fa8eafa4507042fcdc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Cobertura da NFS-e por município - EngineAPI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (1=Produção, 2=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). situacao vem sempre em 3 valores: aderente, nao_aderente ou desconhecido (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. desconhecido nunca é fabricado como não aderente.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://3xtec.mintlify.app/_mintlify/api/og/v2?division=NFSe\u0026amp;title=Cobertura+da+NFS-e+por+munic%C3%ADpio\u0026amp;description=Consulta+o+espelho+local+do+conv%C3%AAnio+do+Sistema+Nacional+da+NFS-e+%28ADN%29+para+um+c%C3%B3digo+IBGE+%E2%80%94+se+o+munic%C3%ADpio+%C3%A9+aderente+ao+Padr%C3%A3o+Nacional+NESTE+ambiente+%28%601%60%3DP\u0026amp;theme=f7c46973c22350b6fc03fc3c\u0026amp;signature=a65170f7642f578796aa10301e02f374f81d810b9065a3fa8eafa4507042fcdc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/3xtec/e0fLCDQyVL4lj2rl/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"EngineAPI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1E56B1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-município\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.engineapi.com.br/#organization\",\"name\":\"EngineAPI\",\"url\":\"https://docs.engineapi.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/3xtec/upxot-gn5enp24zf/logo/light.svg?fit=max\u0026auto=format\u0026n=upxot-gn5enp24zf\u0026q=85\u0026s=63aef46d17335e80239cdc40c74322e9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.engineapi.com.br#website\",\"name\":\"EngineAPI\",\"url\":\"https://docs.engineapi.com.br\",\"publisher\":{\"@id\":\"https://docs.engineapi.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio#webpage\",\"url\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio\",\"name\":\"Cobertura da NFS-e por município\",\"description\":\"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (1=Produção, 2=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). situacao vem sempre em 3 valores: aderente, nao_aderente ou desconhecido (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. desconhecido nunca é fabricado como não aderente.\",\"dateModified\":\"2026-10-10T12:04:58.103Z\",\"isPartOf\":{\"@id\":\"https://docs.engineapi.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.engineapi.com.br/api-reference/sa%C3%BAde/raiz-da-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cobertura da NFS-e por município\",\"item\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio#apireference\",\"headline\":\"Cobertura da NFS-e por município\",\"name\":\"Cobertura da NFS-e por município\",\"description\":\"Consulta o espelho local do convênio do Sistema Nacional da NFS-e (ADN) para um código IBGE — se o município é aderente ao Padrão Nacional NESTE ambiente (1=Produção, 2=Produção Restrita; a cobertura é POR AMBIENTE, um município pode ser aderente num e não no outro). situacao vem sempre em 3 valores: aderente, nao_aderente ou desconhecido (sem certificado disponível para consultar, erro de rede/timeout, ou espelho velho demais sem reconsulta bem-sucedida) — nunca 404 por veredito, o 404 fica reservado a erro de rota. desconhecido nunca é fabricado como não aderente.\",\"url\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio\",\"mainEntityOfPage\":{\"@id\":\"https://docs.engineapi.com.br/api-reference/nfse/cobertura-da-nfs-e-por-munic%C3%ADpio#webpage\"},\"dateModified\":\"2026-10-10T12:04:58.103Z\",\"publisher\":{\"@id\":\"https://docs.engineapi.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.engineapi.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"EngineAPI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"EngineAPI","nav":{"global":null,"tabs":[{"tab":"Documentação","icon":"book-open","pages":[{"title":"Documentação","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Referência","icon":"list","pages":[{"title":"Referência da API","href":"/api-reference/overview"}]},{"group":"Endpoints","icon":"plug","pages":[{"group":"Saúde","pages":[{"title":"Raiz da API","deprecated":null,"version":null,"openapi":"/openapi.json get /v1","href":"/api-reference/saúde/raiz-da-api"},{"title":"Verificar liveness do processo","deprecated":null,"version":null,"openapi":"/openapi.json get /health/live","href":"/api-reference/saúde/verificar-liveness-do-processo"},{"title":"Sanidade de auth (API key / JWT): read-only","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health/auth","href":"/api-reference/saúde/sanidade-de-auth-api-key-jwt:-read-only"},{"title":"Verificar readiness da aplicação","deprecated":null,"version":null,"openapi":"/openapi.json get /health","href":"/api-reference/saúde/verificar-readiness-da-aplicação"},{"title":"Consultar versão em execução","deprecated":null,"version":null,"openapi":"/openapi.json get /version","href":"/api-reference/saúde/consultar-versão-em-execução"}]},{"group":"Autenticação","pages":[{"title":"Autenticar usuário","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/login","href":"/api-reference/autenticação/autenticar-usuário"},{"title":"Concluir login com o segundo fator","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/verify","href":"/api-reference/autenticação/concluir-login-com-o-segundo-fator"},{"title":"Iniciar enrolamento do 2FA","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/setup","href":"/api-reference/autenticação/iniciar-enrolamento-do-2fa"},{"title":"Confirmar e ativar o 2FA","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/enable","href":"/api-reference/autenticação/confirmar-e-ativar-o-2fa"},{"title":"Desativar o 2FA","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/2fa/disable","href":"/api-reference/autenticação/desativar-o-2fa"},{"title":"Estado do 2FA da conta autenticada","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/2fa/status","href":"/api-reference/autenticação/estado-do-2fa-da-conta-autenticada"},{"title":"Renovar a sessão","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/refresh","href":"/api-reference/autenticação/renovar-a-sessão"},{"title":"Encerrar a sessão","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/logout","href":"/api-reference/autenticação/encerrar-a-sessão"},{"title":"Login via Google OAuth","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/google","href":"/api-reference/autenticação/login-via-google-oauth"},{"title":"Alterar senha","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/change-password","href":"/api-reference/autenticação/alterar-senha"},{"title":"Registrar novo parceiro (SUPERADMIN)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/register-partner","href":"/api-reference/autenticação/registrar-novo-parceiro-superadmin"},{"title":"Pedir acesso antecipado (JOT-150)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/register","href":"/api-reference/autenticação/pedir-acesso-antecipado-jot-150"},{"title":"Solicitar recuperação de senha","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/forgot-password","href":"/api-reference/autenticação/solicitar-recuperação-de-senha"},{"title":"Redefinir senha com token","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/reset-password","href":"/api-reference/autenticação/redefinir-senha-com-token"},{"title":"Verificar e-mail com token","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/verify-email","href":"/api-reference/autenticação/verificar-e-mail-com-token"},{"title":"Reenviar e-mail de verificação","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/resend-verification","href":"/api-reference/autenticação/reenviar-e-mail-de-verificação"},{"title":"Status de verificação de e-mail","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/verification-status","href":"/api-reference/autenticação/status-de-verificação-de-e-mail"},{"title":"Gerar/regenerar API Key de PRODUÇÃO (ek_live_)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/api-keys/regenerate","href":"/api-reference/autenticação/gerarregenerar-api-key-de-produção-ek_live_"},{"title":"Gerar/regenerar API Key de TESTE (ek_test_)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/api-keys/test/regenerate","href":"/api-reference/autenticação/gerarregenerar-api-key-de-teste-ek_test_"},{"title":"Informações da API Key","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/api-keys/info","href":"/api-reference/autenticação/informações-da-api-key"}]},{"group":"Empresas","pages":[{"title":"Listar empresas emissoras","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies","href":"/api-reference/empresas/listar-empresas-emissoras"},{"title":"Cadastrar empresa emissora","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies","href":"/api-reference/empresas/cadastrar-empresa-emissora"},{"title":"Consultar CNPJ antes de cadastrar","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/consult/{cnpj}","href":"/api-reference/empresas/consultar-cnpj-antes-de-cadastrar"},{"title":"Solicitar transferência de emissor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/transfer-request","href":"/api-reference/empresas/solicitar-transferência-de-emissor"},{"title":"Cancelar solicitação de transferência","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/transfer-request/{id}/cancel","href":"/api-reference/empresas/cancelar-solicitação-de-transferência"},{"title":"Buscar empresa por ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}","href":"/api-reference/empresas/buscar-empresa-por-id"},{"title":"Excluir empresa emissora","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/companies/{id}","href":"/api-reference/empresas/excluir-empresa-emissora"},{"title":"Atualizar empresa emissora","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/companies/{id}","href":"/api-reference/empresas/atualizar-empresa-emissora"},{"title":"Enviar certificado digital do emissor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/certificate","href":"/api-reference/empresas/enviar-certificado-digital-do-emissor"},{"title":"Trocar ambiente fiscal do emissor (Produção/Homologação)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/companies/{id}/ambiente","href":"/api-reference/empresas/trocar-ambiente-fiscal-do-emissor-produçãohomologação"}]},{"group":"Consultas","pages":[{"title":"Consultar CNPJ","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/queries/cnpj/{cnpj}","href":"/api-reference/consultas/consultar-cnpj"},{"title":"Invalidar cache de CNPJ","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/queries/cnpj/{cnpj}/cache","href":"/api-reference/consultas/invalidar-cache-de-cnpj"},{"title":"Consultar CPF (LGPD)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/queries/cpf/{cpf}","href":"/api-reference/consultas/consultar-cpf-lgpd"},{"title":"Excluir dados de CPF (LGPD)","description":"Remove dados cacheados do CPF e anonimiza registros de auditoria. Art. 18 LGPD: direito à eliminação dos dados pessoais.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/queries/cpf/{cpf}","href":"/api-reference/consultas/excluir-dados-de-cpf-lgpd"}]},{"group":"NFSe","pages":[{"title":"Cobertura da NFS-e por município","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/cobertura/{ibge}","href":"/api-reference/nfse/cobertura-da-nfs-e-por-município"},{"title":"Listar NFS-e","description":"Lista as NFS-e do partner autenticado, paginada e filtrável por `companyId` (emissor). Cobre tanto o Padrão Nacional (SEFIN/ADN) quanto prefeituras ABRASF, conforme o provider configurado em cada emissor — não há distinção de shape entre os dois no retorno.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse","href":"/api-reference/nfse/listar-nfs-e"},{"title":"Emitir NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfse","href":"/api-reference/nfse/emitir-nfs-e"},{"title":"Exportar NFSe em CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/export","href":"/api-reference/nfse/exportar-nfse-em-csv"},{"title":"Comprovante do cancelamento da NFS-e (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/cancelamento/{id}/pdf","href":"/api-reference/nfse/comprovante-do-cancelamento-da-nfs-e-pdf"},{"title":"Detalhes da NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/{id}","href":"/api-reference/nfse/detalhes-da-nfs-e"},{"title":"Cancelar NFS-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfse/{id}/cancelar","href":"/api-reference/nfse/cancelar-nfs-e"},{"title":"Consultar NFS-e na SEFIN","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/{id}/consultar","href":"/api-reference/nfse/consultar-nfs-e-na-sefin"},{"title":"Download PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/pdf/{id}","href":"/api-reference/nfse/download-pdf"},{"title":"Download DANFSe (alias)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/{id}/danfse","href":"/api-reference/nfse/download-danfse-alias"},{"title":"Download XML","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfse/xml/{id}","href":"/api-reference/nfse/download-xml"}]},{"group":"NFe","pages":[{"title":"Verificar status do serviço de emissão NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/status","href":"/api-reference/nfe/verificar-status-do-serviço-de-emissão-nf-e"},{"title":"Status SEFAZ por UF","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/sefaz-status/{uf}","href":"/api-reference/nfe/status-sefaz-por-uf"},{"title":"Status SEFAZ de todas as UFs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/sefaz-status","href":"/api-reference/nfe/status-sefaz-de-todas-as-ufs"},{"title":"Listar NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe","href":"/api-reference/nfe/listar-nf-e"},{"title":"Criar NF-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe","href":"/api-reference/nfe/criar-nf-e"},{"title":"Exportar NF-e em CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/export","href":"/api-reference/nfe/exportar-nf-e-em-csv"},{"title":"Listar fila de emissão em lote","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/queue","href":"/api-reference/nfe/listar-fila-de-emissão-em-lote"},{"title":"Buscar NF-e por ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/{id}","href":"/api-reference/nfe/buscar-nf-e-por-id"},{"title":"Excluir registro de NF-e","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/nfe/{id}","href":"/api-reference/nfe/excluir-registro-de-nf-e"},{"title":"Atualizar registro de NF-e","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/nfe/{id}","href":"/api-reference/nfe/atualizar-registro-de-nf-e"},{"title":"Inutilizar faixa de numeração de NF-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/inutilizar","href":"/api-reference/nfe/inutilizar-faixa-de-numeração-de-nf-e"},{"title":"Cancelar NF-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{idOuChave}/cancelar","href":"/api-reference/nfe/cancelar-nf-e"},{"title":"Enfileirar notas para emissão em lote","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/batch","href":"/api-reference/nfe/enfileirar-notas-para-emissão-em-lote"},{"title":"Download do DANFE (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/pdf/{accessKey}","href":"/api-reference/nfe/download-do-danfe-pdf"},{"title":"Download do XML da NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/xml/{chaveOuId}","href":"/api-reference/nfe/download-do-xml-da-nf-e"},{"title":"Download do XML da Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/cce/{accessKey}/xml","href":"/api-reference/nfe/download-do-xml-da-carta-de-correção"},{"title":"Download do documento auxiliar da Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/cce/{accessKey}/pdf","href":"/api-reference/nfe/download-do-documento-auxiliar-da-carta-de-correção"},{"title":"Comprovante do cancelamento da NF-e (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/cancelamento/{accessKey}/pdf","href":"/api-reference/nfe/comprovante-do-cancelamento-da-nf-e-pdf"},{"title":"Carta de Correção (CC-e) por chave de acesso (JWT ou x-api-key)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{accessKey}/carta-correcao","href":"/api-reference/nfe/carta-de-correção-cc-e-por-chave-de-acesso-jwt-ou-x-api-key"},{"title":"Cancelar NF-e pelo dashboard","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{id}/cancelar-dashboard","href":"/api-reference/nfe/cancelar-nf-e-pelo-dashboard"},{"title":"Enviar Carta de Correção (CC-e) via dashboard","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfe/{id}/cce","href":"/api-reference/nfe/enviar-carta-de-correção-cc-e-via-dashboard"},{"title":"Listar eventos fiscais da NF-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfe/{id}/eventos","href":"/api-reference/nfe/listar-eventos-fiscais-da-nf-e"}]},{"group":"Webhooks","pages":[{"title":"Obter configuração de webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/config","href":"/api-reference/webhooks/obter-configuração-de-webhooks"},{"title":"Atualizar configuração de webhooks","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/webhooks/config","href":"/api-reference/webhooks/atualizar-configuração-de-webhooks"},{"title":"Enviar webhook de teste","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/test","href":"/api-reference/webhooks/enviar-webhook-de-teste"},{"title":"Histórico de entregas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/logs","href":"/api-reference/webhooks/histórico-de-entregas"},{"title":"Regenerar webhook secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/secret/regenerate","href":"/api-reference/webhooks/regenerar-webhook-secret"},{"title":"Listar Dead Letter Queue","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/dlq","href":"/api-reference/webhooks/listar-dead-letter-queue"},{"title":"Limpar DLQ","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhooks/dlq","href":"/api-reference/webhooks/limpar-dlq"},{"title":"Reenviar webhook da DLQ","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/dlq/{deliveryId}/retry","href":"/api-reference/webhooks/reenviar-webhook-da-dlq"},{"title":"Reenviar TODOS da DLQ","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/dlq/retry-all","href":"/api-reference/webhooks/reenviar-todos-da-dlq"}]},{"group":"Cérebro Fiscal","pages":[{"title":"Resolver classificação + tributação de um produto (assistido)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve","href":"/api-reference/cérebro-fiscal/resolver-classificação-+-tributação-de-um-produto-assistido"},{"title":"Resolver classificação + tributação de um serviço (NFS-e, assistido)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve-servico","href":"/api-reference/cérebro-fiscal/resolver-classificação-+-tributação-de-um-serviço-nfs-e-assistido"},{"title":"Sugerir atividade de serviço padrão (LC116/cTribNac) a partir do CNAE (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve-servico-padrao","href":"/api-reference/cérebro-fiscal/sugerir-atividade-de-serviço-padrão-lc116ctribnac-a-partir-do-cnae-consultivo"},{"title":"Sugerir NCM a partir da descrição do produto (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/resolve-ncm","href":"/api-reference/cérebro-fiscal/sugerir-ncm-a-partir-da-descrição-do-produto-consultivo"},{"title":"Confirmar a classificação de um produto (loop de validação)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/confirm","href":"/api-reference/cérebro-fiscal/confirmar-a-classificação-de-um-produto-loop-de-validação"},{"title":"Corrigir a classificação de um produto (loop de validação)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/correct","href":"/api-reference/cérebro-fiscal/corrigir-a-classificação-de-um-produto-loop-de-validação"},{"title":"Comerciante confirma o NCM ou o código de serviço incerto (degrau 3 da cascata)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/confirm-merchant","href":"/api-reference/cérebro-fiscal/comerciante-confirma-o-ncm-ou-o-código-de-serviço-incerto-degrau-3-da-cascata"},{"title":"Corrigir a classificação lembrada de um produto SEM código de barras","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/description-memory/correct","href":"/api-reference/cérebro-fiscal/corrigir-a-classificação-lembrada-de-um-produto-sem-código-de-barras"},{"title":"Revogar a classificação lembrada de um produto SEM código de barras","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/description-memory/revoke","href":"/api-reference/cérebro-fiscal/revogar-a-classificação-lembrada-de-um-produto-sem-código-de-barras"},{"title":"Comerciante responde a pergunta de fato da classe IBS/CBS","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/classe/confirm-merchant","href":"/api-reference/cérebro-fiscal/comerciante-responde-a-pergunta-de-fato-da-classe-ibscbs"},{"title":"Confirmar a classe IBS/CBS de um produto neste emissor","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classification/classe","href":"/api-reference/cérebro-fiscal/confirmar-a-classe-ibscbs-de-um-produto-neste-emissor"},{"title":"Listar as classes IBS/CBS vigentes de um NCM (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classes-por-ncm","href":"/api-reference/cérebro-fiscal/listar-as-classes-ibscbs-vigentes-de-um-ncm-consultivo"},{"title":"Itens com classe IBS/CBS pendente neste emissor","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fiscal/classification/pendentes","href":"/api-reference/cérebro-fiscal/itens-com-classe-ibscbs-pendente-neste-emissor"},{"title":"Listar ciclos de mudança de regra fiscal","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fiscal/changelog","href":"/api-reference/cérebro-fiscal/listar-ciclos-de-mudança-de-regra-fiscal"},{"title":"Prontidão fiscal do motor (emissão assistida)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fiscal/prontidao","href":"/api-reference/cérebro-fiscal/prontidão-fiscal-do-motor-emissão-assistida"},{"title":"Classificar a empresa em produto, serviço ou ambíguo pelos CNAEs (consultivo)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fiscal/classificar-cnae","href":"/api-reference/cérebro-fiscal/classificar-a-empresa-em-produto-serviço-ou-ambíguo-pelos-cnaes-consultivo"}]},{"group":"NFCe","pages":[{"title":"Verificar status do serviço NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/status","href":"/api-reference/nfce/verificar-status-do-serviço-nfc-e"},{"title":"Listar NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce","href":"/api-reference/nfce/listar-nfc-e"},{"title":"Emitir NFC-e (Modelo 65)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfce","href":"/api-reference/nfce/emitir-nfc-e-modelo-65"},{"title":"Download do DANFCE (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/pdf/{accessKey}","href":"/api-reference/nfce/download-do-danfce-pdf"},{"title":"Comprovante do cancelamento da NFC-e (PDF)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/cancelamento/{accessKey}/pdf","href":"/api-reference/nfce/comprovante-do-cancelamento-da-nfc-e-pdf"},{"title":"Download do XML da NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/xml/{accessKey}","href":"/api-reference/nfce/download-do-xml-da-nfc-e"},{"title":"Inutilizar faixa de numeração de NFC-e","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfce/inutilizar","href":"/api-reference/nfce/inutilizar-faixa-de-numeração-de-nfc-e"},{"title":"Cancelar NFC-e autorizada","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/nfce/{idOuChave}/cancelar","href":"/api-reference/nfce/cancelar-nfc-e-autorizada"},{"title":"Exportar NFC-e em CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/export","href":"/api-reference/nfce/exportar-nfc-e-em-csv"},{"title":"Buscar NFC-e por ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/nfce/{id}","href":"/api-reference/nfce/buscar-nfc-e-por-id"}]},{"group":"Cadastros","pages":[{"title":"Consultar créditos de cadastro","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cadastros/creditos","href":"/api-reference/cadastros/consultar-créditos-de-cadastro"},{"title":"Consultar cadastro por CNPJ","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cadastros/{cnpj}","href":"/api-reference/cadastros/consultar-cadastro-por-cnpj"}]},{"group":"Status","pages":[{"title":"Consultar status público por serviço","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/status","href":"/api-reference/status/consultar-status-público-por-serviço"},{"title":"Verificar saúde do servidor MCP","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/mcp/health","href":"/api-reference/status/verificar-saúde-do-servidor-mcp"}]}]},{"group":"Catálogo de campos","icon":"table-list","pages":[{"title":"Referência de campos: NFe","href":"/api-reference/campos-nfe"},{"title":"Referência de campos: NFCe","href":"/api-reference/campos-nfce"},{"title":"Referência de campos: NFSe","href":"/api-reference/campos-nfse"},{"title":"Referência de campos: Cérebro Fiscal (resolve-ncm)","href":"/api-reference/campos-fiscal-resolve-ncm"},{"title":"Referência de campos: Cérebro Fiscal (resolve-servico-padrao)","href":"/api-reference/campos-fiscal-resolve-servico-padrao"},{"title":"Referência de campos: Cérebro Fiscal (resolve, produto)","href":"/api-reference/campos-fiscal-resolve"},{"title":"Referência de campos: Cérebro Fiscal (resolve-servico)","href":"/api-reference/campos-fiscal-resolve-servico"}]}]},{"tab":"SDKs","icon":"cube","pages":[{"title":"SDKs","href":"/sdks/typescript"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Cobertura da NFS-e por município - EngineAPI","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}