Através do serviço de download de evento é possível obter os dados de um evento de Cancelamento ou Carta de Correção Eletrônica vinculado a uma NF-e. Os dados do evento podem ser recebidos em XML ou JSON. Além disso, é possível também receber uma representação gráfica do evento em formato PDF.
URL
Produção: POST https://nfe.ns.eti.br/nfe/get/event
Dados de entrada
| Campo | Descrição | Observação |
|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | |
| chNFe | Chave de acesso da NF-e | |
| tpAmb | Tipo do ambiente de autorização da NF-e 1 - Produção 2 - Homologação | |
| tpDown | Tipo do download: X - XML J - JSON P - PDF XP - XML e PDF JP - JSON e PDF | |
| tpEvento | Tipo do evento CCE CANC | CCE: Carta de Correção Eletrônica CANC: Cancelamento |
| nSeqEvento | Número sequencial do evento | Apenas para download de CC-e. Para CANC será sempre 1. |
Exemplo de requisição
Requisição de download de evento
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"chNFe": "43161107364617000135550000000099341000094932",
"tpDown": "xp",
"tpEvento": "cce",
"nSeqEvento": 1,
"tpAmb": 1
}'\
https://nfe.ns.eti.br/nfe/get/event
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| retEvento | rotocolo de recebimento da NF-e | Somente em status = 200 |
| retEvento.cStat | Código de situação do evento na Sefaz | |
| retEvento.xMotivo | Descrição literal da situação do evento na Sefaz | |
| retEvento.chNFe | Chave de acesso da NF-e | |
| retEvento.dhRegEvento | Data e hora de registro do evento na Sefaz | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-03:00 |
| retEvento.nProt | Número do protocolo de autorização do evento pela Sefaz | |
| xml | XML do evento | Somente em quando tpDown = X ou XP Somente em status = 200 |
| json | JSON do XML do evento | Somente em quando tpDown = J ou JP Somente em status = 200 |
| Representação gráfica do evento em PDF | PDF em Base64 Somente em quando tpDown = P, JP ou XP Somente em status = 200 |
|
| erro | Objeto contendo as informações de erro caso o cancelamento não possa ser realizado com sucesso | Somente em status diferente de 200 |
| erro.cStat | Código de status do erro | |
| erro.xMotivo | Descrição literal do erro |
Exemplo de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a NF-e",
"chNFe": "43161107364617000135550000000099341000094832",
"dhRegEvento": "2016-11-29T19:15:42-02:00",
"nProt": "143160001512983"
},
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoNFe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</procEventoNFe>",
"pdf": "JVBERi0xLjQKJe..."
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | NF-e cancelada com sucesso |
| -2 | Chave de acesso inválida |
| -3 | Tipo de evento inválido |
| -4 | Tipo de download inválido |
| -5 | Não foi possível carregar o evento Verifique o objeto erro para maiores informações |