Referência interativa disponível

Para spec OpenAPI completa, schemas e "Try it" inline, use a API Reference — Consulta NF-e Distribuição. Esta página documenta o uso prático; a referência tem o contrato completo.

Endpoints /inbound/nfe (analítico/exportação)

Esta página cobre a API de NF-e sob /inbound/productinvoices. Há também a família mais recente GET /v2/companies/{companyId}/inbound/nfe[/{accessKey}][/xml|/pdf] — orientada a exportação analítica (CSV) e listagem — disponível na API Reference — NFS-e Inbound (Captura Fiscal). Os dois caminhos consultam o mesmo acervo de NF-e recebidas.

Endpoints de NF-e

Referência dos endpoints HTTP do serviço NFe Inbound para operações com NF-e (modelo 55).

Sumário

• Buscar Metadados de uma NF-e
• Baixar XML de uma NF-e
• Baixar PDF (DANFE) de uma NF-e
• Buscar Dados de um Evento de NF-e
• Registrar Manifestação
• Reprocessar Webhook de uma NF-e

Buscar Metadados de uma NF-e

Retorna os dados estruturados de uma NF-e pela sua chave de acesso.

GET /v2/companies/{company_id}/inbound/productinvoices/{access_key}
Authorization: ApiKey {api_key}

Parâmetros de URL:

• company_id: ID da sua empresa na nfe.io
• access_key: Chave de acesso de 44 dígitos da NF-e

Resposta de sucesso (200):

{
  "accessKey": "35240112345678000195550010000012341234567890",
  "createdOn": "2024-03-15T14:22:10Z",
  "nsu": "21825",
  "nsuParent": null,
  "nfeNumber": "1234",
  "nfeSerialNumber": "1",
  "issuedOn": "2024-03-15T10:00:00Z",
  "type": "productInvoice",
  "description": "Autorizado o uso da NF-e",
  "totalInvoiceAmount": "1500.00",
  "operationType": "Incoming",
  "issuer": {
    "federalTaxNumber": "12345678000195",
    "name": "Fornecedor LTDA"
  },
  "buyer": {
    "federalTaxNumber": "98765432000100",
    "name": "Minha Empresa S.A."
  },
  "company": {
    "id": "comp_123",
    "federalTaxNumber": "98765432000100"
  },
  "links": {
    "xml": "https://storage.nfe.io/temp/xml/...",
    "pdf": "https://storage.nfe.io/temp/pdf/..."
  }
}

Descrição dos campos:

Campo	Tipo	Descrição
accessKey	string	Chave de acesso 44 dígitos
createdOn	DateTime	Quando o documento entrou no sistema
nsu	string	Número Sequencial Único na SEFAZ
nfeNumber	string	Número da NF-e
nfeSerialNumber	string	Série da NF-e
issuedOn	DateTime	Data de emissão
type	string	productInvoice, productInvoiceEvent, productInvoiceSummary
description	string	Status da NF-e (ex: "Autorizado o uso da NF-e")
totalInvoiceAmount	string	Valor total em reais
operationType	string	Incoming (destinatário) ou Outgoing (emitente)
issuer	object	Dados do emitente (quem emitiu a NF-e)
buyer	object	Dados do destinatário (comprador)
links.xml	string	URL temporária para download do XML (expira em 1 hora)
links.pdf	string	URL temporária para download do PDF/DANFE

Baixar XML de uma NF-e

GET /v2/companies/{company_id}/inbound/{access_key}/xml
Authorization: ApiKey {api_key}

# Retorna 200 JSON: {"publicTemporaryUri": "https://...xml"}
# — não é o arquivo XML direto. Baixe o XML a partir dessa URL.

Alternativamente, use a URL temporária retornada em links.xml para download direto do storage (sem precisar passar pela API). Esse link expira em 1 hora.

Baixar PDF (DANFE) de uma NF-e

GET /v2/companies/{company_id}/inbound/{access_key}/pdf
Authorization: ApiKey {api_key}

# Retorna 200 JSON: {"publicTemporaryUri": "https://...pdf"}
# — não é o arquivo PDF direto. Baixe o PDF a partir dessa URL.

Buscar Dados de um Evento de NF-e

Eventos são ações sobre a NF-e: cancelamento, ciência, confirmação de operação, etc.

GET /v2/companies/{company_id}/inbound/productinvoices/{access_key}/events/{event_key}
Authorization: ApiKey {api_key}

O event_key tem 55 dígitos (chave de acesso da NF-e + código do evento + sequência).

Registrar Manifestação

A manifestação é o processo pelo qual o destinatário comunica à SEFAZ que tem conhecimento da NF-e. É obrigatória para NF-es de entrada.

POST /v2/companies/{company_id}/inbound/{access_key}/manifest?tpEvent=210210
Authorization: ApiKey {api_key}

Tipos de manifestação (tpEvent):

Código	Tipo	Descrição
210210	Ciência da Operação	"Estou ciente desta NF-e" (não confirma recebimento físico)
210200	Confirmação da Operação	"Recebi a mercadoria conforme NF-e"
210220	Desconhecimento da Operação	"Não reconheço esta operação"
210240	Operação não Realizada	"A operação não foi concluída"

Resposta (200):

"Manifestação registrada com sucesso"

Manifestação Automática: Se você configurou AutomaticManifesting.MinutesToWaitAwarenessOperation, o sistema registrará "Ciência da Operação" automaticamente após esse intervalo. Você não precisa chamar este endpoint para ciência se tiver auto-manifestação ativa.

Reprocessar Webhook de uma NF-e

Use quando o webhook não foi entregue ou precisa ser reenviado.

POST /v2/companies/{company_id}/inbound/productinvoices/{access_key}/processwebhook
Authorization: ApiKey {api_key}

# Ou por NSU:
POST /v2/companies/{company_id}/inbound/productinvoices/{nsu}/processwebhook

Veja também

• Endpoints de CT-e
• Webhook events + HMAC
• Tipos e enums
• Códigos HTTP e tratamento de erros
• Manifestar NF-e
• Ativar via API