O método de download da NF-e é responsável por retornar o JSON, XML e o DANFE (Documento Auxiliar de Nota Fiscal Eletrônica) a partir do fornecimento da chave de acesso de uma NF-e autorizada.
URL
Produção: POST https://nfe.ns.eti.br/nfe/get
Dados de entrada
Campo | Ocorrência | Tipo | Descrição |
---|---|---|---|
X-AUTH-TOKEN | 1-1 | A | Token de acesso do usuário |
chNFe | 1-1 | N | Chave de acesso da NF-e |
printCEAN | 0-1 | Boolean | Imprimir código EAN Valor padrão: False |
tpAmb | 0-1 | N | Tipo de ambiente de autorização da NF-e 1 - Produção 2 - Homologação Valor padrão: 2 |
tpDown | 1-1 | N | Tipo do download: X - XML J - JSON P - PDF XP - XML e PDF JP - JSON e PDF |
obsCanhoto | 0-1 | Boolean | Imprime conteúdo do campo infCpl no canhoto, ao invés de "Recebemos de ...." |
printDesconto | 0-1 | True - Imprimir os itens com desconto; False - Valor Padrão. |
|
tpImp | 0-1 | 1=DANFE normal, Retrato; 2=DANFE normal, Paisagem; 3=DANFE Simplificado. |
Exemplo de requisição
Requisição de download de NF-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN":"SEU_TOKEN",
"chNFe":"44444444444444444444444444444444444444444444",
"tpDown":"XP"
}' \
https://nfe.ns.eti.br/nfe/get
Dados retornados
Campo | Descrição | Observação |
---|---|---|
status | Código de status do processamento | |
motivo | Descrição literal do status de processamento | |
chNFe | Chave da NF-e | |
xml | XML de distribuição da NF-e autorizada | Somente em quando tipo = X ou XP Apenas com status = 200 |
nfeProc | Objeto JSON com os dados de distribuição da NF-e autorizada | Somente em quando tipo = J ou JP Apenas com status = 200 |
PDF da DANFE | Base64 do PDF do DANTE Somente em quando tipo = P, JP ou XP Apenas com status = 200 |
|
erro | Objeto contendo informações de erro ao carregar a NFe | Apenas com status diferente de 200 |
erro.cStat | Código do status de erro | |
erro.xMotivo | Descrição literal do erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chNFe": "44444444444444444444444444444444444444444444",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><nfeProc versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><NFe>...</NFe><protNFe versao=\"3.10\">...</protNFe></nfeProc>",
"pdf": "JVBERi0xLjQKJeLjz..."
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Download realizado com sucesso |
-2 | Tipo de download inválido Obs.: Quando o tipo for diferente X, P, XP ou PX (case-insensitive). |
-3 | Chave de acesso inválida |
-4 | NF-e não encontrada com a chave de acesso informada |
Imprimir xTexto no canhoto
No canhoto da NF-e pode constar a mensagem “Recebemos de …” ou o infCpl quando solicitado no método de download.
Além desses conteúdos, é possível imprimir no canhoto informações de desejo do emitente.
Para isso, é necessário informar durante a emissão,o grupo obsCont(Z04) contendo um xCampo com valor “xObsCanhoto”, então será impresso no canhoto o conteúdo do respectivo xTexto.