{
"erro": {
"codigo": "requisicao_invalida",
"mensagem": "corpo.cnpj: String should match pattern '^\\d{14}$'"
}
}
{
"erro": {
"codigo": "limite_de_requisicoes",
"mensagem": "Muitas requisições; tente de novo em instantes."
}
}
Notas
Consultar Nota
A Nota e o resultado da emissão. Consulte até o status sair de pendente/processando
(normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"NotasX","description":"API de emissão de NFS-e pelo Padrão Nacional (Sefin Nacional + ADN), para integradores que emitem para vários Prestadores.","colors":{"primary":"#0F766E","light":"#14B8A6","dark":"#0F766E"},"api":{"playground":{"display":"interactive"}},"footer":{"socials":{}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"notasx","hasAudioNarration":false,"actualSubdomain":"notasx","customDomains":[],"gitSource":{"type":"github","owner":"adrianomirandaa","repo":"notasx-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6af4e6aea4129e637572ef0c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4eafd28c9c9173ff75a06","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Getting Started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/notas/consultar-nota","slug":"/api-reference/notas/consultar-nota","pageMetadata":{"title":"Consultar Nota","description":"A Nota e o resultado da emissão. Consulte até o `status` sair de `pendente`/`processando`\n(normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notas/{nota_id}","href":"/api-reference/notas/consultar-nota","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: [\"A Nota e o resultado da emissão. Consulte até o \", _jsx(_components.code, {\n children: \"status\"\n }), \" sair de \", _jsx(_components.code, {\n children: \"pendente\"\n }), \"/\", _jsx(_components.code, {\n children: \"processando\"\n }), \"\\n(normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).\"]\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":"Consultar Nota","description":"A Nota e o resultado da emissão. Consulte até o `status` sair de `pendente`/`processando`\n(normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notas/{nota_id}","href":"/api-reference/notas/consultar-nota","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Notas"],"summary":"Consultar Nota","description":"A Nota e o resultado da emissão. Consulte até o `status` sair de `pendente`/`processando`\n(normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).","operationId":"obter_v1_notas__nota_id__get","security":["d03c5c28-ebb9-4b32-9cd1-9e8299c1137c"],"parameters":["ea47ec1a-434f-42a9-913b-1ef89bd406d0"],"responses":{"200":"c211f9fc-79e5-4026-bbf6-9b4a04bf34aa","401":"c47030eb-bb34-462c-b31a-10811783133d","404":"789a1474-c182-45cc-8d73-8bb3b44c9fed","422":"fde696d0-06a8-4849-8cec-9d1237ebcf66","429":"5246cc66-aa0f-4985-84f7-a851e5773e39"},"method":"get","type":"path","servers":["ff0d736f-200f-4959-a789-6e402f83f1bf"],"path":"/v1/notas/{nota_id}","baseUrlOptions":["https://notasx-api.fly.dev"],"title":"Consultar Nota","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ea47ec1a-434f-42a9-913b-1ef89bd406d0":{"name":"nota_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Id da Nota, devolvido na criação.","title":"Nota Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Id da Nota, devolvido na criação."}},"responses":{"c211f9fc-79e5-4026-bbf6-9b4a04bf34aa":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Id da Nota no NotasX.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"prestador_id":{"type":"string","format":"uuid","title":"Prestador Id","description":"Prestador que emite.","isRequired":true,"uniqueKey":"prestador_id","typeLabel":"string\u003cuuid>"},"ambiente":{"type":"string","enum":["homologacao","producao"],"title":"Ambiente","description":"Ambiente do Prestador quando a Nota foi criada. Não muda.","isRequired":true,"uniqueKey":"ambiente","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pendente","processando","emitida","rejeitada","falhou","cancelada","substituida"],"title":"Status","description":"`pendente` → `processando` → `emitida`, `rejeitada` ou `falhou` (finais). `cancelada` e `substituida` são reservados para eventos futuros.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"chave_idempotencia":{"type":"string","title":"Chave Idempotencia","description":"O `Idempotency-Key` do pedido que criou a Nota.","isRequired":true,"uniqueKey":"chave_idempotencia","typeLabel":"string"},"competencia":{"type":"string","format":"date","title":"Competencia","description":"Data de Competência informada na criação.","isRequired":true,"uniqueKey":"competencia","typeLabel":"string\u003cdate>"},"dados":{"properties":{"ctrib_nac":{"type":"string","pattern":"^\\d{6}$","title":"Ctrib Nac","description":"Código de Tributação Nacional (`cTribNac`): item, subitem e desdobro da lista de serviços da LC 116/2003. Ex.: `010101` = análise e desenvolvimento de sistemas.","examples":["010101"],"isRequired":true,"uniqueKey":"dados.ctrib_nac","typeLabel":"string"},"descricao":{"type":"string","maxLength":2000,"minLength":1,"title":"Descricao","description":"Discriminação do serviço, como sairá na NFS-e.","examples":["Desenvolvimento de software sob encomenda - novembro/2026"],"isRequired":true,"uniqueKey":"dados.descricao","typeLabel":"string"},"valor_servico":{"type":"string","title":"Valor Servico","description":"Valor do serviço em reais, com até 2 casas. Devolvido como texto (`\"1500.00\"`).","examples":["1500.00"],"isRequired":true,"uniqueKey":"dados.valor_servico","typeLabel":"string"},"codigo_nbs":{"oneOf":[{"type":"string","title":"Codigo Nbs","description":"Código NBS (Nomenclatura Brasileira de Serviços), opcional.","pattern":"^\\d{9}$","example":"115013000","uniqueKey":"dados.codigo_nbs.oneOf.0","typeLabel":"string"},{"type":"null","title":"Codigo Nbs","description":"Código NBS (Nomenclatura Brasileira de Serviços), opcional.","example":"115013000","uniqueKey":"dados.codigo_nbs.oneOf.1","typeLabel":"null"}],"uniqueKey":"dados.codigo_nbs","typeLabel":"string | null"},"iss_retido":{"type":"boolean","title":"Iss Retido","description":"`true` se o ISS for retido pelo Tomador.","default":false,"uniqueKey":"dados.iss_retido","typeLabel":"boolean"},"aliquota_iss":{"oneOf":[{"type":"string","title":"Aliquota Iss","description":"Alíquota do ISS como fração (`0.05` = 5%). Hoje é ignorada: nos municípios conveniados a alíquota vem da parametrização municipal.","example":"0.05","uniqueKey":"dados.aliquota_iss.oneOf.0","typeLabel":"string"},{"type":"null","title":"Aliquota Iss","description":"Alíquota do ISS como fração (`0.05` = 5%). Hoje é ignorada: nos municípios conveniados a alíquota vem da parametrização municipal.","example":"0.05","uniqueKey":"dados.aliquota_iss.oneOf.1","typeLabel":"null"}],"uniqueKey":"dados.aliquota_iss","typeLabel":"string | null"}},"type":"object","required":["ctrib_nac","descricao","valor_servico"],"title":"Servico","description":"O serviço prestado e o valor.","isRequired":true,"uniqueKey":"dados","typeLabel":"Servico · object"},"tomador":{"oneOf":[{"type":"object","title":"Tomador","description":"Quem contratou o serviço. Opcional: a Sefin aceita DPS sem Tomador.","required":["documento"],"properties":{"documento":{"type":"string","pattern":"^(\\d{11}|\\d{14})$","title":"Documento","description":"CPF (11) ou CNPJ (14 dígitos), só dígitos.","examples":["11222333000181"],"isRequired":true,"uniqueKey":"tomador.oneOf.0.documento","typeLabel":"string"},"nome":{"oneOf":[{"type":"string","title":"Nome","description":"Nome ou razão social.","maxLength":300,"example":"Cliente Exemplo LTDA","uniqueKey":"tomador.oneOf.0.nome.oneOf.0","typeLabel":"string"},{"type":"null","title":"Nome","description":"Nome ou razão social.","example":"Cliente Exemplo LTDA","uniqueKey":"tomador.oneOf.0.nome.oneOf.1","typeLabel":"null"}],"uniqueKey":"tomador.oneOf.0.nome","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"E-mail do Tomador, registrado na NFS-e.","maxLength":80,"example":"financeiro@cliente.com.br","uniqueKey":"tomador.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","description":"E-mail do Tomador, registrado na NFS-e.","example":"financeiro@cliente.com.br","uniqueKey":"tomador.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"tomador.oneOf.0.email","typeLabel":"string | null"},"fone":{"oneOf":[{"type":"string","title":"Fone","description":"Telefone, só dígitos.","pattern":"^\\d{6,20}$","example":"84999990000","uniqueKey":"tomador.oneOf.0.fone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Fone","description":"Telefone, só dígitos.","example":"84999990000","uniqueKey":"tomador.oneOf.0.fone.oneOf.1","typeLabel":"null"}],"uniqueKey":"tomador.oneOf.0.fone","typeLabel":"string | null"},"endereco":{"oneOf":[{"type":"object","title":"Endereco","description":"Endereço nacional do Tomador. Vai para a DPS só se vier completo.","required":["codigo_municipio","logradouro","numero","bairro"],"properties":{"codigo_municipio":{"type":"string","pattern":"^\\d{7}$","title":"Codigo Municipio","description":"Código IBGE do município.","examples":["2408102"],"isRequired":true,"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.codigo_municipio","typeLabel":"string"},"logradouro":{"type":"string","maxLength":255,"minLength":1,"title":"Logradouro","description":"Rua, avenida etc.","examples":["Av. Exemplo"],"isRequired":true,"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.logradouro","typeLabel":"string"},"numero":{"type":"string","maxLength":60,"minLength":1,"title":"Numero","description":"Número; use `S/N` se não houver.","examples":["100"],"isRequired":true,"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.numero","typeLabel":"string"},"bairro":{"type":"string","maxLength":60,"minLength":1,"title":"Bairro","description":"Bairro.","examples":["Centro"],"isRequired":true,"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.bairro","typeLabel":"string"},"cep":{"oneOf":[{"type":"string","title":"Cep","description":"CEP, só dígitos.","pattern":"^\\d{8}$","example":"59000000","uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.cep.oneOf.0","typeLabel":"string"},{"type":"null","title":"Cep","description":"CEP, só dígitos.","example":"59000000","uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.cep.oneOf.1","typeLabel":"null"}],"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.cep","typeLabel":"string | null"},"complemento":{"oneOf":[{"type":"string","title":"Complemento","description":"Complemento, opcional.","maxLength":156,"example":"Sala 2","uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.complemento.oneOf.0","typeLabel":"string"},{"type":"null","title":"Complemento","description":"Complemento, opcional.","example":"Sala 2","uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.complemento.oneOf.1","typeLabel":"null"}],"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0.complemento","typeLabel":"string | null"}},"uniqueKey":"tomador.oneOf.0.endereco.oneOf.0","typeLabel":"Endereco · object"},{"type":"null","uniqueKey":"tomador.oneOf.0.endereco.oneOf.1","typeLabel":"null"}],"uniqueKey":"tomador.oneOf.0.endereco","typeLabel":"Endereco · object | null"}},"isRequired":true,"uniqueKey":"tomador.oneOf.0","typeLabel":"Tomador · object"},{"type":"null","isRequired":true,"uniqueKey":"tomador.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tomador","typeLabel":"Tomador · object | null"},"numero_dps":{"oneOf":[{"type":"integer","title":"Numero Dps","description":"Número da DPS, reservado no primeiro envio e reaproveitado nas novas tentativas.","isRequired":true,"uniqueKey":"numero_dps.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Numero Dps","description":"Número da DPS, reservado no primeiro envio e reaproveitado nas novas tentativas.","isRequired":true,"uniqueKey":"numero_dps.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"numero_dps","typeLabel":"integer | null"},"chave_acesso":{"oneOf":[{"type":"string","title":"Chave Acesso","description":"Chave de acesso da NFS-e (50 dígitos). Só existe com `emitida`.","isRequired":true,"uniqueKey":"chave_acesso.oneOf.0","typeLabel":"string"},{"type":"null","title":"Chave Acesso","description":"Chave de acesso da NFS-e (50 dígitos). Só existe com `emitida`.","isRequired":true,"uniqueKey":"chave_acesso.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"chave_acesso","typeLabel":"string | null"},"numero_nfse":{"oneOf":[{"type":"string","title":"Numero Nfse","description":"Número da NFS-e atribuído pela Sefin.","isRequired":true,"uniqueKey":"numero_nfse.oneOf.0","typeLabel":"string"},{"type":"null","title":"Numero Nfse","description":"Número da NFS-e atribuído pela Sefin.","isRequired":true,"uniqueKey":"numero_nfse.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"numero_nfse","typeLabel":"string | null"},"resultado_codigo":{"oneOf":[{"type":"string","title":"Resultado Codigo","description":"Em `rejeitada`, os códigos da Sefin (ex.: `E0123`); em `falhou`, `impedimento` ou `sem_resposta`.","isRequired":true,"uniqueKey":"resultado_codigo.oneOf.0","typeLabel":"string"},{"type":"null","title":"Resultado Codigo","description":"Em `rejeitada`, os códigos da Sefin (ex.: `E0123`); em `falhou`, `impedimento` ou `sem_resposta`.","isRequired":true,"uniqueKey":"resultado_codigo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resultado_codigo","typeLabel":"string | null"},"resultado_mensagem":{"oneOf":[{"type":"string","title":"Resultado Mensagem","description":"Explicação do resultado, quando houver.","isRequired":true,"uniqueKey":"resultado_mensagem.oneOf.0","typeLabel":"string"},{"type":"null","title":"Resultado Mensagem","description":"Explicação do resultado, quando houver.","isRequired":true,"uniqueKey":"resultado_mensagem.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resultado_mensagem","typeLabel":"string | null"},"criada_em":{"type":"string","format":"date-time","title":"Criada Em","description":"Quando a Nota foi criada.","isRequired":true,"uniqueKey":"criada_em","typeLabel":"string\u003cdate-time>"},"atualizada_em":{"type":"string","format":"date-time","title":"Atualizada Em","description":"Última mudança (de status ou de resultado).","isRequired":true,"uniqueKey":"atualizada_em","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["id","prestador_id","ambiente","status","chave_idempotencia","competencia","dados","tomador","numero_dps","chave_acesso","numero_nfse","resultado_codigo","resultado_mensagem","criada_em","atualizada_em"],"title":"Nota","examples":[{"ambiente":"homologacao","atualizada_em":"2026-11-11T21:40:06Z","chave_acesso":"24081022242404473000102000000000002426114744866240","chave_idempotencia":"pedido-2026-000123","competencia":"2026-11-11","criada_em":"2026-11-11T21:40:00Z","dados":{"ctrib_nac":"010101","descricao":"Desenvolvimento de software sob encomenda - novembro/2026","valor_servico":"1500.00"},"id":"ec73f621-e696-41bb-af2e-a6facb8e2be1","numero_dps":2,"numero_nfse":"24","prestador_id":"3891f091-65d6-4a88-ac60-72dbe3e98319","status":"emitida","tomador":{"documento":"11222333000181","email":"financeiro@cliente.com.br","endereco":{"bairro":"Centro","cep":"59000000","codigo_municipio":"2408102","logradouro":"Av. Exemplo","numero":"100"},"nome":"Cliente Exemplo LTDA"}}],"uniqueKey":"","typeLabel":"Nota · object"},"examples":{"Example":{"title":"Example","value":{"ambiente":"homologacao","atualizada_em":"2026-11-11T21:40:06Z","chave_acesso":"24081022242404473000102000000000002426114744866240","chave_idempotencia":"pedido-2026-000123","competencia":"2026-11-11","criada_em":"2026-11-11T21:40:00Z","dados":{"ctrib_nac":"010101","descricao":"Desenvolvimento de software sob encomenda - novembro/2026","valor_servico":"1500.00"},"id":"ec73f621-e696-41bb-af2e-a6facb8e2be1","numero_dps":2,"numero_nfse":"24","prestador_id":"3891f091-65d6-4a88-ac60-72dbe3e98319","status":"emitida","tomador":{"documento":"11222333000181","email":"financeiro@cliente.com.br","endereco":{"bairro":"Centro","cep":"59000000","codigo_municipio":"2408102","logradouro":"Av. Exemplo","numero":"100"},"nome":"Cliente Exemplo LTDA"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c47030eb-bb34-462c-b31a-10811783133d":{"description":"Sem credencial, ou Chave de API inválida/revogada, ou JWT de sessão expirado.","headers":{"WWW-Authenticate":{"description":"Sempre `Bearer`.","schema":{"type":"string"}}},"content":{"application/json":{"examples":{"nao_autenticado":{"title":"nao_autenticado","value":{"erro":{"codigo":"nao_autenticado","mensagem":"Credencial ausente, inválida ou revogada."}}}},"schema":{"properties":{"erro":{"properties":{"codigo":{"type":"string","title":"Codigo","description":"Código estável, em snake_case, para tratar o erro no seu código.","examples":["nao_encontrado"],"isRequired":true,"uniqueKey":"erro.codigo","typeLabel":"string"},"mensagem":{"type":"string","title":"Mensagem","description":"Explicação em português para humanos. Pode mudar; não compare com ela.","examples":["Nota não encontrada."],"isRequired":true,"uniqueKey":"erro.mensagem","typeLabel":"string"}},"type":"object","required":["codigo","mensagem"],"title":"Erro","isRequired":true,"uniqueKey":"erro","typeLabel":"Erro · object"}},"type":"object","required":["erro"],"title":"ErroResposta","description":"Corpo de toda resposta de erro (4xx e 5xx).","examples":[{"erro":{"codigo":"nao_encontrado","mensagem":"Nota não encontrada."}}],"uniqueKey":"","typeLabel":"ErroResposta · object"},"exampleType":"examples"}},"exampleType":"examples"},"789a1474-c182-45cc-8d73-8bb3b44c9fed":{"description":"Recurso inexistente ou de um Prestador sem vínculo com a sua Conta (a resposta é a mesma, de propósito).","content":{"application/json":{"examples":{"nao_encontrado":{"title":"nao_encontrado","value":{"erro":{"codigo":"nao_encontrado","mensagem":"Nota não encontrada."}}}},"schema":{"properties":{"erro":{"properties":{"codigo":{"type":"string","title":"Codigo","description":"Código estável, em snake_case, para tratar o erro no seu código.","examples":["nao_encontrado"],"isRequired":true,"uniqueKey":"erro.codigo","typeLabel":"string"},"mensagem":{"type":"string","title":"Mensagem","description":"Explicação em português para humanos. Pode mudar; não compare com ela.","examples":["Nota não encontrada."],"isRequired":true,"uniqueKey":"erro.mensagem","typeLabel":"string"}},"type":"object","required":["codigo","mensagem"],"title":"Erro","isRequired":true,"uniqueKey":"erro","typeLabel":"Erro · object"}},"type":"object","required":["erro"],"title":"ErroResposta","description":"Corpo de toda resposta de erro (4xx e 5xx).","examples":[{"erro":{"codigo":"nao_encontrado","mensagem":"Nota não encontrada."}}],"uniqueKey":"","typeLabel":"ErroResposta · object"},"exampleType":"examples"}},"exampleType":"examples"},"fde696d0-06a8-4849-8cec-9d1237ebcf66":{"description":"Corpo, parâmetro ou regra de negócio inválidos. `requisicao_invalida` lista os campos com problema.","content":{"application/json":{"examples":{"requisicao_invalida":{"title":"requisicao_invalida","value":{"erro":{"codigo":"requisicao_invalida","mensagem":"corpo.cnpj: String should match pattern '^\\d{14}$'"}}}},"schema":{"properties":{"erro":{"properties":{"codigo":{"type":"string","title":"Codigo","description":"Código estável, em snake_case, para tratar o erro no seu código.","examples":["nao_encontrado"],"isRequired":true,"uniqueKey":"erro.codigo","typeLabel":"string"},"mensagem":{"type":"string","title":"Mensagem","description":"Explicação em português para humanos. Pode mudar; não compare com ela.","examples":["Nota não encontrada."],"isRequired":true,"uniqueKey":"erro.mensagem","typeLabel":"string"}},"type":"object","required":["codigo","mensagem"],"title":"Erro","isRequired":true,"uniqueKey":"erro","typeLabel":"Erro · object"}},"type":"object","required":["erro"],"title":"ErroResposta","description":"Corpo de toda resposta de erro (4xx e 5xx).","examples":[{"erro":{"codigo":"nao_encontrado","mensagem":"Nota não encontrada."}}],"uniqueKey":"","typeLabel":"ErroResposta · object"},"exampleType":"examples"}},"exampleType":"examples"},"5246cc66-aa0f-4985-84f7-a851e5773e39":{"description":"Limite de requisições por minuto ou Cota mensal esgotada. Respeite o header `Retry-After`.","headers":{"Retry-After":{"description":"Segundos até poder tentar de novo.","schema":{"type":"integer"}}},"content":{"application/json":{"examples":{"limite_de_requisicoes":{"title":"limite_de_requisicoes","value":{"erro":{"codigo":"limite_de_requisicoes","mensagem":"Muitas requisições; tente de novo em instantes."}}}},"schema":{"properties":{"erro":{"properties":{"codigo":{"type":"string","title":"Codigo","description":"Código estável, em snake_case, para tratar o erro no seu código.","examples":["nao_encontrado"],"isRequired":true,"uniqueKey":"erro.codigo","typeLabel":"string"},"mensagem":{"type":"string","title":"Mensagem","description":"Explicação em português para humanos. Pode mudar; não compare com ela.","examples":["Nota não encontrada."],"isRequired":true,"uniqueKey":"erro.mensagem","typeLabel":"string"}},"type":"object","required":["codigo","mensagem"],"title":"Erro","isRequired":true,"uniqueKey":"erro","typeLabel":"Erro · object"}},"type":"object","required":["erro"],"title":"ErroResposta","description":"Corpo de toda resposta de erro (4xx e 5xx).","examples":[{"erro":{"codigo":"nao_encontrado","mensagem":"Nota não encontrada."}}],"uniqueKey":"","typeLabel":"ErroResposta · object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d03c5c28-ebb9-4b32-9cd1-9e8299c1137c":{"Chave de API":{"type":"http","description":"`Authorization: Bearer nx_...` com uma Chave de API, ou o JWT de sessão do painel (Supabase Auth). As duas credenciais representam a mesma Conta.","scheme":"bearer","scopes":[],"schemeName":"Chave de API"}}},"servers":{"ff0d736f-200f-4959-a789-6e402f83f1bf":{"url":"https://notasx-api.fly.dev","description":"Produção da API (Prestadores em homologação ou produção)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"`Authorization: Bearer nx_...` com uma Chave de API, ou o JWT de sessão do painel (Supabase Auth). As duas credenciais representam a mesma Conta.","scheme":"bearer","scopes":[],"schemeName":"Chave de API"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"`Authorization: Bearer nx_...` com uma Chave de API, ou o JWT de sessão do painel (Supabase Auth). As duas credenciais representam a mesma Conta.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Chave de API","name":"Authorization"}],"title":"Chave de API"}]},"originalFileLocation":"openapi.json"},"subdomain":"notasx","siteName":"NotasX","title":"Consultar Nota - NotasX","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T22:24:01.066Z","originalFileLocation":"api-reference/notas/consultar-nota.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=\"system\"}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=\"A Nota e o resultado da emissão. Consulte até o status sair de pendente/processando (normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).\">\u003cmeta data-mint-head name=\"application-name\" content=\"NotasX\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/notasx/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/notasx/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/notasx/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/notasx/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar Nota - NotasX\">\u003cmeta data-mint-head property=\"og:description\" content=\"A Nota e o resultado da emissão. Consulte até o status sair de pendente/processando (normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NotasX\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://notasx.mintlify.app/api-reference/notas/consultar-nota\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://notasx.mintlify.site/_mintlify/api/og/v2?division=Notas\u0026amp;title=Consultar+Nota\u0026amp;description=A+Nota+e+o+resultado+da+emiss%C3%A3o.+Consulte+at%C3%A9+o+%60status%60+sair+de+%60pendente%60%2F%60processando%60%0A%28normalmente+alguns+segundos%3B+com+a+Sefin+inst%C3%A1vel%2C+as+novas+tentativa\u0026amp;theme=d1461b4e243aa5910cf425cc\u0026amp;signature=4d182b310f754142c2a094192f4e9f88d52bc2daf8e3aea7cf78a2a93fecc7d7\">\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=\"Consultar Nota - NotasX\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A Nota e o resultado da emissão. Consulte até o status sair de pendente/processando (normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://notasx.mintlify.site/_mintlify/api/og/v2?division=Notas\u0026amp;title=Consultar+Nota\u0026amp;description=A+Nota+e+o+resultado+da+emiss%C3%A3o.+Consulte+at%C3%A9+o+%60status%60+sair+de+%60pendente%60%2F%60processando%60%0A%28normalmente+alguns+segundos%3B+com+a+Sefin+inst%C3%A1vel%2C+as+novas+tentativa\u0026amp;theme=d1461b4e243aa5910cf425cc\u0026amp;signature=4d182b310f754142c2a094192f4e9f88d52bc2daf8e3aea7cf78a2a93fecc7d7\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/notasx/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NotasX\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://notasx.mintlify.app/api-reference/notas/consultar-nota\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/notas/consultar-nota.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://notasx.mintlify.app/#organization\",\"name\":\"NotasX\",\"url\":\"https://notasx.mintlify.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://notasx.mintlify.app#website\",\"name\":\"NotasX\",\"url\":\"https://notasx.mintlify.app\",\"publisher\":{\"@id\":\"https://notasx.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota#webpage\",\"url\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota\",\"name\":\"Consultar Nota\",\"description\":\"A Nota e o resultado da emissão. Consulte até o status sair de pendente/processando (normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).\",\"dateModified\":\"2026-11-11T22:24:01.066Z\",\"isPartOf\":{\"@id\":\"https://notasx.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Notas\",\"item\":\"https://notasx.mintlify.app/api-reference/notas/listar-notas\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consultar Nota\",\"item\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota#apireference\",\"headline\":\"Consultar Nota\",\"name\":\"Consultar Nota\",\"description\":\"A Nota e o resultado da emissão. Consulte até o status sair de pendente/processando (normalmente alguns segundos; com a Sefin instável, as novas tentativas podem levar minutos).\",\"url\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota\",\"mainEntityOfPage\":{\"@id\":\"https://notasx.mintlify.app/api-reference/notas/consultar-nota#webpage\"},\"dateModified\":\"2026-11-11T22:24:01.066Z\",\"publisher\":{\"@id\":\"https://notasx.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://notasx.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NotasX\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"NotasX\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/notas/consultar-nota.md","siteName":"NotasX","nav":{"global":null,"tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":""}]},{"tab":"Referência da API","groups":[{"group":"Notas","pages":[{"title":"Listar Notas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notas","href":"/api-reference/notas/listar-notas"},{"title":"Criar Nota","description":"Cria a Nota `pendente` e a coloca na fila de emissão; responde `202` na hora, sem esperar a Sefin.\nAcompanhe o resultado em `GET /v1/notas/{id}`.\n\n**Idempotência:** repetir o pedido com o mesmo `Idempotency-Key` devolve a mesma Nota, sem criar outra emissão\n(o corpo do pedido repetido é ignorado). Em caso de timeout ou erro de rede, repita com a mesma chave.\n\n**Cota:** se o Prestador está em produção e `usadas + pendentes` já alcançou o limite do mês, responde\n`429 cota_esgotada`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/notas","href":"/api-reference/notas/criar-nota"},{"title":"Consultar Nota","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notas/{nota_id}","href":"/api-reference/notas/consultar-nota"},{"title":"Baixar o XML da NFS-e","description":"Devolve um link temporário (5 minutos) para o XML oficial da NFS-e. Disponível pouco depois de\n`emitida`; antes disso, `404 xml_indisponivel`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notas/{nota_id}/xml","href":"/api-reference/notas/baixar-o-xml-da-nfs-e"}]},{"group":"Conta","pages":[{"title":"Consultar a Cota","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cota","href":"/api-reference/conta/consultar-a-cota"},{"title":"Consultar o Webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook","href":"/api-reference/conta/consultar-o-webhook"},{"title":"Configurar o Webhook","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/webhook","href":"/api-reference/conta/configurar-o-webhook"},{"title":"Remover o Webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhook","href":"/api-reference/conta/remover-o-webhook"}]},{"group":"Prestadores","pages":[{"title":"Listar Prestadores","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/prestadores","href":"/api-reference/prestadores/listar-prestadores"},{"title":"Cadastrar Prestador","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prestadores","href":"/api-reference/prestadores/cadastrar-prestador"},{"title":"Consultar Prestador","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/prestadores/{prestador_id}","href":"/api-reference/prestadores/consultar-prestador"},{"title":"Ativar produção","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prestadores/{prestador_id}/ativar-producao","href":"/api-reference/prestadores/ativar-produção"},{"title":"Enviar Certificado A1","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prestadores/{prestador_id}/certificado","href":"/api-reference/prestadores/enviar-certificado-a1"}]},{"group":"Chaves de API","pages":[{"title":"Listar Chaves de API","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/chaves-api","href":"/api-reference/chaves-de-api/listar-chaves-de-api"},{"title":"Criar Chave de API","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/chaves-api","href":"/api-reference/chaves-de-api/criar-chave-de-api"},{"title":"Revogar Chave de API","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/chaves-api/{chave_id}","href":"/api-reference/chaves-de-api/revogar-chave-de-api"}]}]}]},"basePath":"","title":"Consultar Nota - NotasX","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}