Download da NFC-e
O método de download é responsável por retornar o XML de distribuição da NFC-e a partir do fornecimento da chave de acesso de uma NFC-e autorizada pela API.
Este método retorna também o XML de cancelamento caso a NFC-e esteja cancelada e tenha sida cancelada pela API.
URL
Produção: POST https://nfce.ns.eti.br/v1/nfce/get
Dados de entrada
Campo | Descrição | Pai | Ocorrência | Tipo | Observação |
---|---|---|---|---|---|
chNFe | Chave de acesso da NF-e | 1-1 | N | ||
tpAmb | Ambiente de autorização da NFC-e | 1-1 | N | 1 - Produção 2 - Homologação |
|
impressao | Objeto de informações de geração do PDF | 0-1 | O | Antigamente denominado 'pdf' | |
tipo | Tipo de impressão | impressao | 1-1 | A | PDF ou ESCPOS |
ecologica | Se a impressão ecológica for habilitada (true) os produtos não serão impressos. | impressao | 0-1 | B | True ou False Valor padrão: False |
itemLinhas | Quantidade de linhas para cada produto | impressao | 0-1 | N | 1 ou 2 Valor padrão: 1 |
itemDesconto | Imprimir desconto do item abaixo do item | impressao | 0-1 | B | True ou False Valor padrão: True |
larguraPapel | Largura do papel | impressao | 0-1 | A | 58mm ou 80mm Valor padrão: 80mm |
modMiniImpressora | Modelo de impressora | impressao | 1-1 | A | Obrigatório para tipo = ESCPOS Possíveis valores: BEMATECH MP-4200 TH BEMATECH MP-2500 TH DARUMA EPSON T20 EPSON T70 ELGIN I9 |
Exemplo de requisição
Requisição de download de NFC-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN":"SEU_TOKEN",
"chNFe":"44444444444444444444444444444444444444444444",
"tpAmb": 2,
"impressao": {
"tipo": "pdf",
"itemDesconto": false
}
}' \
https://nfce.ns.eti.br/v1/nfce/get
Dados retornados
Campo | Descrição | Pai | Tipo | Ocorrência | Observação |
---|---|---|---|---|---|
status | Código de status do processamento | N | |||
motivo | Descrição literal do status de processamento | A | |||
nfeProc | Objeto com os dados da NFC-e | O | 0-1 | Somente em status = 100 | |
nProt | Número do protocolo de autorização da NFC-e | nfeProc | N | 1-1 | |
digVal | Digest Value | nfeProc | A | 1-1 | |
chNFe | Chave da NFC-e | nfeProc | N | 1-1 | |
serie | Série da NFC-e | nfeProc | N | 1-1 | |
numero | Número da NFC-e | nfeProc | N | 1-1 | |
dhRecbto | Data e hora de recebimento pela Sefaz | nfeProc | D | 1-1 | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
xml | XML de distribuição da NFC-e | nfeProc | A | 1-1 | |
retEvento | Objeto com dados do evento de cancelamento da NFC-e | O | 0-1 | Somente em status = 100 e NFC-e canceladaSomente em status = 100 e NFC-e cancelada | |
cStat | Status de processamento pela Sefaz | retEvento | N | 1-1 | |
xMotivo | Descrição literal do processamento pela Sefaz | retEvento | A | 1-1 | |
chNFeCanc | Chave do cancelamento da NFC-e | retEvento | N | 1-1 | |
dhRegEvento | Data e hora do registro do evento | retEvento | D | 1-1 | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
nProt | Número do protocolo do evento | retEvento | N | 1-1 | |
xml | XML de distribuição do evento | retEvento | A | 1-1 | |
Base64 do PDF do DANFE | A | 0-1 | Somente se o objeto impressao for enviado na solicitação e tipo = PDF |
||
pdfCancelamento | Base64 do PDF do cancelamento da NFC-e | A | 0-1 | Somente se o objeto impressao for enviado na solicitação e tipo = PDF Elemento retornado apenas se houver cancelamento vinculado |
|
escpos | Base64 do array de bytes do DANFE para serem impressos via ESC/POS | A | 0-1 | Somente se o objeto impressao for enviado na solicitação e tipo = ESCPOS |
Exemplos de retorno
Retorno com sucesso
{
"status": 100,
"motivo": "Download de NFC-e realizado com sucesso",
"nfeProc": {
"nProt": "143170001693116",
"digVal": "302B9r8c6820gvN2psd/TlXrtXI=",
"chNFe": "44444444444444444444444444444444444444444444",
"serie": "1",
"numero": "6497",
"dhRecbto": "2017-10-16T15:52:14-02:00",
"xml": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><nfeProc xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"3.10\"><NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</nfeProc>"
},
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a NF-e",
"chNFeCanc": "1101114444444444444444444444444444444444444444444401",
"dhRegEvento": "2017-10-16T15:53:51-02:00",
"nProt": "143170001693118",
"xml": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><procEventoNFe xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"1.00\"><evento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><infEvento Id=\"ID1101114317100736461700013565001000006497100002161001\">...</procEventoNFe>"
},
"pdf": "JVBERi0xLjQKJeLjz9M...AyCiUlRU9GCg==",
"pdfCancelamento": "JRLERiLjQKJeNLjz4M...AyCvUlRU3GCg=="
}
Códigos de retorno
Código | Descrição |
---|---|
100 | Download de NFC-e realizado com sucesso |
-100 | Nao foi possivel realizar o download da NFC-e Verifique os campos nfeProc.cstat e nfeProc.xMotivo para identificar o motivo |
-996 | Sem permissões para gerenciar documentos do CNPJ contribuinte |
-997 | Campos obrigatórios não informados O campo motivo terá maiores informações |
-999 | Erro interno ao processar a requisição O campo motivo terá maiores informações |