Através do serviço de download de eventos é possível obter os dados de um evento de Cancelamento, Inclusão de Condutor ou Encerramento vinculado a um MDF-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://mdfe.ns.eti.br/mdfe/get/event
Dados de entrada
| Campo | Descrição | Tupo | Ocorrência | |
|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | A | 1-1 | |
| chMDFe | Chave de acesso do MDF-e | N | 1-1 | |
| tpDown | Tipo do download: X - XML J - JSON P - PDF XP - XML e PDF JP - JSON e PDF | A | 1-1 | |
| tpAmb | Tipo do ambiente de autorização do MDF-e: 1 - Produção 2 - Homologação | N | 0-1 | 1 - Produção 2 - Homologação Valor padrão: 1 |
| tpEvento | Tipo do evento: ENC CANC INCCOND INCDFE PAGOPER | A | 1-1 | ENC: Encerramento CANC: Cancelamento INCCOND: Inclusão de condutor INCDFE: Inclusão de DF-e PAGOPER: Pagamento da Operação |
| nSeqEvento | Número sequencial do evento | N | 0-1 | Apenas para download de Inclusão de condutor e Inclusão de DF-e. Para cancelamento e encerramento 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",
"chMDFe": "43170507364617000135580000000003481000033457",
"tpDown": "x",
"tpEvento": "enc"
}'\
https://mdfe.ns.eti.br/mdfe/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 | |
| retEvento.cStat | Código de situação do evento na Sefaz | 1-1 | N | retEvento | |
| retEvento.xMotivo | Descrição literal da situação do evento na Sefaz | 1-1 | A | retEvento | |
| retEvento.chMDFe | Chave de acesso da MDF-e | 1-1 | N | retEvento | |
| 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 |
| retEvento.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 ou XP Somente em status = 200 | |
| json | JSON do XML do evento | 0-1 | O | Somente em quando tpDown = J ou JP Somente em status = 200 | |
| Representação gráfica do evento em PDF | 0-1 | A | 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 download do evento não possa ser realizado com sucesso | 0-1 | O | Somente em status diferente de 200 | |
| erro.cStat | Código de status do erro | 1-1 | N | ||
| erro.xMotivo | Descrição literal do erro | 1-1 | A |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Evento localizado com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado ao MDF-e",
"chMDFe": "43170507364617000135580000000003481000033452",
"dhRegEvento": "2017-05-26T19:02:15-03:00",
"nProt": "943170000040769"
},
"xml": "<?xml version=\"1.0\"?><procEventoMDFe versao=\"3.00\" xmlns=\"http://www.portalfiscal.inf.br/mdfe\">...</procEventoMDFe>"
}
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 |