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.3 (2026-05-07):
- Schemas de resposta enriquecidos — todos os schemas em
components.schemasganharam umexamplepró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 comdocumentId/companyIdpara correlacao),NFeMetadataListResource,ListInboundNfeResponse,CTeBatchConsolidationRequest,AutomaticManifestingResource,NFeEventMetadataResource. EnableInboundProductInvoiceResourceagora documenta os camposwebhookEvents,webhookVersione o sub-objetoautomaticManifesting.minutesToOperationConfirmation/minutesToUnknownOperation.ProductInvoiceInboundResourceeTransportationInvoiceInboundResourcepassaram 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 novoGET /{accessKey}consumido pelo exporter analitico CSV. - Documentado suporte a bulk export CSV via shared-usage-api:
novos resources
company-nfse-inbound-analytical-csvecompany-nfe-inbound-analytical-csvque 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: ApiKey
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 |