Através do serviço de download de evento é possível obter os dados de um evento de Cancelamento vinculado a uma GTV-e. Os dados do evento podem ser recebidos em XML ou JSON.
URL
Versão 3.00
Produção: POST https://gtve.ns.eti.br/v1/gtve/get/event
Dados de entrada
| Campo | Descrição | Observação |
|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | |
| chGTVe | Chave de acesso da GTV-e | |
| tpDown | Tipo do download: X - XMLJ - JSON | |
| tpEvento | Tipo do evento CANC | CANC: Cancelamento |
| tpAmb | Tipo do ambiente do evento 1 - Produção 2 - Homologação | |
| nSeqEvento | Número sequencial do evento | 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",
"chCTe": "43210107364617000135640000000000101000010500",
"tpAmb": "2",
"tpDown": "X",
"tpEvento": "CANC",
"nSeqEvento": 1
}'\
https://gtve.ns.eti.br/v1/event/get/
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do 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 GTV-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 Somente em status = 200 |
| json | JSON do XML do evento | Somente em quando tpDown = J 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 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Evento localizado com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a CT-e",
"chCTe": "43210107364617000135640000000000101000010500",
"dhRegEvento": "2021-01-20T10:00:25-03:00",
"nProt": "143210000026536"
},
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><procEventoCTe versao=\"3.00\" xmlns=\"http://www.portalfiscal.inf.br/cte\">...</procEventoCTe>"
}
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 |