Através do serviço de download de eventos é possível obter os dados de um evento de vinculado a uma NF3-e. Os dados do evento podem ser recebidos em XML ou JSON.
URL
Produção: POST https://nf3e.ns.eti.br/v1/nf3e/get/event
Dados de entrada
| Campo | Descrição | Tipo | Ocorrência | |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | A | 1-1 | |
| chNF3e | Chave de acesso do NF3-e | N | 1-1 | |
| tpDown | Tipo do download: X - XML J - JSON | A | 1-1 | |
| tpAmb | Tipo do ambiente de autorização do NF3-e 1 - Produção 2 - Homologação | N | 1-1 | 1 - Produção 2 - Homologação |
| tpEvento | Tipo do evento CANC | A | 1-1 | CANC: Cancelamento |
Exemplo de requisição
Requisição de download de evento
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN": "SEU_TOKEN", "chNF3e": "43170507364617000135580000000003481000033457","tpAmb":"2", "tpDown": "x", "tpEvento": "canc"}'\
https://nf3e.ns.eti.br/v1/nf3e/get/event
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 | ||
| retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | 0-1 | O | Somente em status = 200 | |
| cStat | Código de situação do evento na Sefaz | 1-1 | N | retEvento | |
| xMotivo | Descrição literal da situação do evento na Sefaz | 1-1 | A | retEvento | |
| chNF3e | Chave de acesso da NF3-e | 1-1 | N | retEvento | |
| dhRegEvento | Data e hora de registro do evento na Sefaz | 1-1 | D | retEvento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-03:00 |
| nProt | Número do protocolo de autorização do evento pela Sefaz | 1-1 | N | retEvento | |
| xml | XML do evento | 0-1 | A | Somente em quando tpDown = X Somente em status = 200 | |
| json | JSON do XML do evento | 0-1 | O | Somente em quando tpDown = J Somente em status = 200 | |
| erro | Objeto contendo as informações de erro caso o download do evento não possa ser realizado com sucesso | 0-1 | O | Somente em status diferente de 200 | |
| cStat | Código de status do erro | 1-1 | N | erro | |
| xMotivo | Descrição literal do erro | 1-1 | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Evento localizado com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a NF3-e",
"chNF3e": "11111111111111111111111111111111111111111111",
"dhRegEvento": "2021-02-22T10:26:48-03:00",
"nProt": "111111111111111"
},
"xml": "<?xml version=\"1.0\"?><procEventoNF3e versao=\"3.00\" xmlns=\"http://www.portalfiscal.inf.br/mdfe\">...</procEventoNF3e>"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Download do evento realizado 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 |