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 um CT-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
Versão 3.00
Produção: POST https://cte.ns.eti.br/cte/get/event/300
Dados de entrada
| Campos | Descrição | Observação |
|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | |
| chCTe | Chave de acesso do CT-e | |
| tpDown | Tipo de download: "X" – XML, "J" – JSON, "P" – PDF, "XP" – XML e PDF, "JP" – JSON e PDF | PDF Disponível apenas para Carta de Correção e Cancelamento. |
| tpEvento | Tipo de Evento: CCE, CANC, COMPENTREGA ou CANCCOMPENTREGA | CCE: Carta de Correção Eletrônica CANC: Cancelamento do CT-e COMPENTREGA: Comprovante de entrega CANCCOMPENTREGA: Cancelamento do comprovante de entrega |
| tpAmb | Tipo do ambiente do evento: 1 – Produção, 2 – Homologação | Valor padrão: 1 |
| nSeqEvento | Número sequencial do evento | Para Cancelamento 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",
"chCTe": "43170112936129000195100000000013191000013027",
"tpDown": "xp",
"tpEvento": "cce",
"nSeqEvento": 1
}' \
https://cte.ns.eti.br/cte/get/event/300
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status de processamento | |
| motivo | Descrição literal do status de processamento | |
| retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | 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.chCte | Chave de acesso do CT-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 quando tpDown = "X" ( ou "XP" ) e status = 200 |
| json | json do XML do evento | Somente quando tpDown = "J" ( ou "JP" ) e status = 200 |
| Representação gráfica do evento em PDF | PDF em Base64 Somente quando tpDown = "P", "JP" ou "XP" em status = 200 | |
| erro | Objeto contendo as informações de erro caso o cancelamento não obteve sucesso | Somente em status diferentes de 200 |
| erro.cStat | Código do erro | |
| erro.xMotivo | Descrição literal do erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado ao CT-e",
"chCTe": "43161107364617000135550000000099341000094832",
"dhRegEvento": "2016-11-29T19:15:42-02:00",
"nProt": "143160001512983"},
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoCTe versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/Cte\">...</procEventoCTe>","pdf": "JVBERi0xLjQKJe..."
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada 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 |