O método de download do NF3-e é responsável por retornar o JSON, XML e o DANF3E (Documento Auxiliar da Nota Fiscal de Energia Elétrica Eletrônica) a partir do fornecimento da chave de acesso de uma NF3-e autorizada.
URL
Produção: POST https://nf3e.ns.eti.br/v1/nf3e/get
Dados de entrada
| Campo | Ocorrência | Descrição |
|---|---|---|
| X-AUTH-TOKEN | 1-1 | Token de acesso do usuário |
| chNF3e | 1-1 | Chave de acesso do NF3-e |
| tpAmb | 1-1 | Tipo de Ambiente :1 - Produção 2 - Homologação |
| tpDown | 1-1 | Tipo do download: X - XML J - JSON P - PDF XP - XML e PDF JP - JSON e PDF |
Exemplo de requisição
Requisição de download de NF3-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN":"SEU_TOKEN","chNF3e":"44444444444444444444444444444444444444444444","tpAmb":"2","tpDown":"XP"}' \
https://nf3e.ns.eti.br/v1/nf3e/get
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | 1-1 | N | ||
| motivo | Descrição literal do status de processamento | 1-1 | A | ||
| chNF3e | Chave da NF3-e | 0-1 | N | Somente em quando tipo = X ou XP Apenas com status = 200 | |
| xml | XML de distribuição da NF-e autorizada | 0-1 | A | Somente em quando tipo = X ou XP Apenas com status = 200 | |
| PDF da DANF3E | 0-1 | A | Base64 do PDF do DANF3E Somente em quando tipo = P, JP ou XP Apenas com status = 200 | ||
| erro | Objeto contendo informações de erro ao carregar a NF3-e | 0-1 | Apenas com status diferente de 200 | ||
| cStat | Código do status de erro | N | |||
| xMotivo | Descrição literal do erro | A |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chNF3e": "43191207364617000135660000000000101834241950",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><nf3eProc versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nf3e\"><NF3e><infNF3e versao=\"1.00\" Id=\"NF3e43191207364617000135660000000000101834241950\">...</nf3eProc>"
}
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 | NF3-e não encontrada com a chave de acesso informada |