Pular para o conteúdo principal
Version: 2.4

DFeDistribution - Inbound API

API de Consulta de NF-e, CT-e e NFS-e (Distribuição) da plataforma nfe.io. Permite habilitar/desabilitar a busca automatica de documentos fiscais, consultar metadados, XMLs, PDFs, eventos e listar documentos via OData.

Subsistemas cobertos:

  • NF-e Recebidas (Product Invoices) — captura via SEFAZ Distribuição DFe.
  • CT-e Recebidas (Transportation Invoices) — captura via SEFAZ Distribuição DFe.
  • NFS-e Recebidas — captura via ADN (Ambiente de Dados Nacional).

Complementos:

  • Documentação técnica detalhada para devs cliente: 02-doc-tecnica-clientes-nfe-cte-dev-pt.md (NFe + CTe), 02-doc-tecnica-clientes-dev-nfse-inbound-api.md (NFSe API), 02-doc-tecnica-clientes-dev-nfse-inbound-webhook.md (NFSe webhook).
  • Postman collection completa (55 endpoints, inclui o NFe Inbound exporter-friendly e a folder Bulk Export que dispara jobs no shared-usage-api), em duas linguagens: PT · EN.

Novidades v2.4 (2026-08-31):

  • Data de corte da captura (startFromDate) — aceita no cadastro da empresa e alteravel apenas por PUT .../maintenance/start-from-date (papel Management). Documentos anteriores ao corte continuam capturados, mas ficam fora da listagem, nascem com webhookStatus: Skipped e sao bilhetados como historico.
  • Historico retido e sua liberacao — novos GET .../inbound/nfse/backfill (resumo: startFromDate, released, hiddenDocumentsCount) e POST .../maintenance/backfill/release (libera/revoga a entrega, com varredura assincrona retomavel).
  • Captura sob demanda pela chave — novo POST .../inbound/nfse/fetch-by-access-key, sincrono e idempotente por chave, com registro de uso proprio (acao GetDocByKey) e 403 por sigilo fiscal quando a empresa nao e Prestador/Tomador/Intermediario.
  • outboundEnabled documentado no cadastro, no update e no resource da empresa (entrega tambem das notas emitidas pela propria empresa).
  • Enums do documento corrigidos — status passou a listar Received e Reprocessed (nao Pending); webhookStatus passou a listar Retrying e Skipped (nao Failed); nsu agora e nullable.
  • rateLimitedUntil documentado com suas duas causas: rate limit do ADN e certificado indisponivel/inutilizavel. Certificado ausente ou vencido nao desativa mais a empresa — apenas espaca a captura.
  • Familia /inbound/nfe (NF-e exporter-friendly) documentada de fato - os 4 endpoints e os schemas NFeMetadataListResource / ListInboundNfeResponse, prometidos nas notas v2.2/v2.3 mas ausentes do arquivo, agora constam aqui.

Novidades v2.3 (2026-05-07):

  • Schemas de resposta enriquecidos — todos os schemas em components.schemas ganharam um example próprio renderizavel pelo Swagger UI; respostas 4xx/5xx (BadRequest, Unauthorized, Forbidden, NotFound, Conflict, UnprocessableEntity, InternalError) passaram a expor exemplo de payload de erro.
  • Novos schemas: AsyncAcceptedResource (corpo padrao de respostas 202 com documentId/companyId para correlacao), NFeMetadataListResource, ListInboundNfeResponse, CTeBatchConsolidationRequest, AutomaticManifestingResource, NFeEventMetadataResource.
  • EnableInboundProductInvoiceResource agora documenta os campos webhookEvents, webhookVersion e o sub-objeto automaticManifesting.minutesToOperationConfirmation/minutesToUnknownOperation.
  • ProductInvoiceInboundResource e TransportationInvoiceInboundResource passaram a refletir os campos reais de retorno (companyId, status, createdOn, modifiedOn).

Novidades v2.2 (2026-05-06):

  • Adicionados 4 endpoints sob /v2/companies/{companyId}/inbound/nfe/... (NFe Inbound exporter-friendly), incluindo o novo GET /{accessKey} consumido pelo exporter analitico CSV.
  • Documentado suporte a bulk export CSV via shared-usage-api: novos resources company-nfse-inbound-analytical-csv e company-nfe-inbound-analytical-csv que produzem uma planilha achatando cada nota + evento relacionado primario na mesma linha. Veja 04-guia-uso-console.md e 05-guia-onboarding.md para uso pelo console e 02-doc-tecnica-clientes-nfe-cte-dev-pt.md para integracao via API.

Authentication​

API Key da conta nfe.io enviada no header Authorization (sem prefixo Bearer). A mesma chave usada nas demais APIs da plataforma. As roles relevantes são NFeDist, CTeDist e NFSeDist — somente endpoints cujas policies o token cobre são acessíveis.

Security Scheme Type:

apiKey

Header parameter name:

Authorization

Contact

nfe.io:

URL: https://nfe.io

NFE.io

A NFE.io é uma empresa de tecnologia que fornece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas. Com suas ferramentas, as empresas podem economizar tempo e reduzir erros, aumentando a eficiência e precisão do processo de emissão de notas fiscais.

Um dos principais cases de sucesso da NFE.io é a implementação da solução na empresa de transporte Rodonaves. Com a automatização da emissão e gestão de notas fiscais eletrônicas, a Rodonaves conseguiu reduzir em até 80% o tempo gasto nesse processo, o que se traduziu em uma significativa melhoria na eficiência operacional. Além disso, a empresa também conseguiu eliminar erros e atrasos na emissão de notas fiscais, o que melhorou a relação com seus clientes e aumentou a confiança dos órgãos fiscais.

Outro exemplo é a implementação da NFE.io na empresa de comércio eletrônico, a Loja Integrada. Com a automatização da emissão de notas fiscais, a Loja Integrada conseguiu aumentar a velocidade de emissão de notas em até 10 vezes, o que permitiu que a empresa atendesse a uma maior quantidade de clientes e, consequentemente, aumentar as suas vendas.

Além desses exemplos, a NFE.io também tem outros cases de sucesso com empresas de setores como indústria, construção, varejo e serviços, mostrando a versatilidade e eficácia da sua solução.

Em resumo, a NFE.io é uma empresa de tecnologia que oferece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas, ajudando as empresas a economizar tempo e reduzir erros, melhorando a eficiência e precisão do processo. Com cases de sucesso em diferentes setores, a NFE.io tem se destacado como uma empresa líder em automação fiscal.