VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/NF-e (nota fiscal)

Arquivos da NF-e (XML e DANFE)

Baixa o XML assinado e o DANFE em PDF de uma nota autorizada.

O XML é o documento fiscal oficial, que deve ser guardado por cinco anos; o DANFE é a versão para impressão. Os dois só existem depois que a nota fica autorizado.

Baixar o XML

GET/api/v1/admin/nfe/{id}/xmlAdmin

Baixa o XML da NF-e

Parâmetros de caminho

iduuidobrigatório
Id interno da nota.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/nfe/b7a76302-e926-4988-a015-789e8f225c60/xml" \
  -H "Authorization: Bearer $TOKEN" \
  -o nfe.xml

Resposta

200Arquivo XML

Corpo application/xml com Content-Disposition: attachment; filename=nfe_<id>.xml.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não tem manage_nfe nem manage_settings.{"error":"insufficient privileges","privilege_required_any":["manage_nfe","manage_settings"]}
403O módulo focusnfe está desligado na loja.{"error":"module_disabled","module":"focusnfe"}
404Nota inexistente.{"error":"NF-e not found"}
500Nota ainda sem XML (não autorizada) ou falha no provedor.{"error":"failed to download NF-e XML","detail":"nfe ... has no XML URL (status: processando)"}

Baixar o DANFE

GET/api/v1/admin/nfe/{id}/danfeAdmin

Baixa o DANFE da NF-e

Parâmetros de caminho

iduuidobrigatório
Id interno da nota.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/nfe/b7a76302-e926-4988-a015-789e8f225c60/danfe" \
  -H "Authorization: Bearer $TOKEN" \
  -o danfe.pdf

Resposta

200Arquivo PDF

Corpo application/pdf com Content-Disposition: attachment; filename=danfe_<id>.pdf.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não tem manage_nfe nem manage_settings.{"error":"insufficient privileges","privilege_required_any":["manage_nfe","manage_settings"]}
403O módulo focusnfe está desligado na loja.{"error":"module_disabled","module":"focusnfe"}
404Nota inexistente.{"error":"NF-e not found"}
500Nota ainda sem DANFE ou falha no provedor.{"error":"failed to download DANFE PDF","detail":"..."}
O cliente baixa pela própria conta

O cliente final acessa o XML e o DANFE do próprio pedido pela API da vitrine; estas rotas são para a equipe da loja.

Veja também

  • NF-e
Anterior
Consultar NF-e
Próxima
Cancelar, corrigir e inutilizar
Nesta página
  • Baixar o XML
  • Exemplo de requisição
  • Resposta
  • Erros
  • Baixar o DANFE
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também