Como fazer download do DADFe ou do DANFe?
Se o documento foi autorizado ou emitido em contingência, você pode fazer o download do Documento Fiscal Auxiliar (DADFe) em formato .pdf
.
DADFe é um termo genérico para se referir aos Documentos Auxiliares Fiscais de qualquer tipo de DFe. O DANFe, documento auxiliar mais conhecido, é um DADFe de uma Nota Fiscal Eletrônica (NFe) 😉
Há duas formas de solicitar o documento auxiliar:
Durante a integração do seu sistema com a API REST Oobj a equipe de desenvolvimento pode escolher um dos dois métodos, ou ambos.
Download do DADFe com ano, série e número
- Faça uma requisição GET ao endpoint download de DADFe por ano, série e número;
[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}.pdf
Preencha as seguintes informações (
path parameters
):{empresa}
*: CNPJ da Empresa;{ambiente}
*: hom ou prod;{codModelo}
*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe) ou 99 (NFSe);{ano}
*: ano de emissão no formato AAAA;{serie}
*: série do documento;{numero}
*: número do documento;
O CNPJ/CPF sempre será considerado na busca como emitente/prestador do documento.
- Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
A requisição contém dados fictícios, somente para demonstração.
curl -L -X GET 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/hom/55/2023/503/741566.pdf' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'
Exemplo de retorno
Exemplo de retorno via Postman
Download do DADFe com chave de acesso
Neste caso, o documento do envolvido é filtrado conforme a tabela a seguir:
Modelo DFe | Conta com módulo de emissão/importação | Conta com módulo de recebimento |
---|---|---|
NFe | emitente | destinatário, transportador, autorizados |
NFCe | emitente | destinatário, transportador, autorizados |
NFSe | emitente/prestador | destinatário/tomador, autorizados |
MDFe | emitente | autorizados |
CTe | emitente | destinatário, tomador, expedidor, autorizados |
CFe | emitente | destinatário, autorizados |
- Para começar, faça uma requisição GET ao endpoint download de DADFe por chave de acesso;
[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{chaveAcesso}.pdf
Preencha as seguintes informações (
path parameters
):{empresa}
*: CNPJ da Empresa;{ambiente}
*: hom ou prod;{codModelo}
*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe) ou 99 (NFSe);{chaveAcesso}
*: número da chave de acesso do documento;
Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
A requisição contém dados fictícios, somente para demonstração.
curl -L -X GET 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/prod/55/43180307385111000102555020001860671000000000.pdf' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'
Exemplo de retorno
Exemplo de retorno via Postman
Pronto, você acaba de finalizar o processo de fazer o download do Documento Fiscal Auxiliar (DADFe)! Siga para o artigo Como fazer download do XML?