Cancelamento de GTV-e

Através do serviço de cancelamento de GTV-e é possível cancelar uma guia de transporte de valores eletrônica previamente autorizada através da NS API.

Obs.: O cancelamento de GTV-e possui regras e prazos definidos pela Secretaria da Fazendo que devem ser considerados e respeitados. Para maiores informações clique aqui e verifique a versão mais atualizada o Manual de Orientações do Contribuinte da Sefaz.

URL

Versão 3.00

Produção: POST https://gtve.ns.eti.br/v1/gtve/cancel

Dados de entrada

Campo	Descrição	Observação
X-AUTH-TOKEN	Token de acesso do usuário
chCTe	Chave de acesso da GTV-e
tpAmb	Tipo do ambiente de autorização da GTV-e 1 - Produção2 - Homologação
dhEvento	Data e hora da ocorrência do cancelamento	Padrão Sefaz (com UTC) AAAA-MM-DDTHH:MM:SS Ex.: 2021-01-20T15:04:10-03:00
nProt	Número do protocolo de autorização da GTV-e
xJust	Descrição literal do motivo de cancelamento da GTV-e	Mínimo 15 caracteres

Exemplo de requisição

Requisição de cancelamento de GTV-e

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{
          "X-AUTH-TOKEN":"...",
          "chCTe":"11111111111111111111111111111111111111111111", 
          "tpAmb":"2", 
          "dhEvento":"2021-01-12T15:57:49-03:00",           
          "nProt":"111111111111111", 
          "xJust":"CANCELAMENTO DE GTVE TESTE"
}'\
https://gtve.ns.eti.br/v1/gtve/cancel

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 GTV-e na Sefaz	Somente em status = 200
retEvento.cStat	Código de situação do processamento
retEvento.xMotivo	Descrição literal da situação do processamento na Sefaz
retEvento.chCTe	Chave de acesso do GTV-e
retEvento.dhRegEvento	Data e hora de registro do evento na Sefaz	Padrão Sefaz (com UTC)AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-03:00
retEvento.nProt	Número de recibo do documento pela Sefaz
xml	XML de distribuição do evento de cancelamento	Somente em status = 200
erros	Array contendo a lista de erros durante a validação das informações do cancelamento de acordo com o tipo de dados	Somente em status = -4
codigo	Codigo de erro ocorrido	Somente em status = -5
descricao	Descrição literal do erro ocorrido	Somente em status = -5

Exemplos de retorno

Retorno com sucesso

{
    "status": 200,
    "motivo": "GTVe cancelado com sucesso",
    "retEvento": {
        "cStat": "135",
        "xMotivo": "Evento registrado e vinculado a CT-e",
        "idEvento": "1101114321010736461700013564000000000010100001050001",
        "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	GTV-e cancelado com sucesso
-2	Campos obrigatórios não informados
-3	Chave de acesso inválida
-4	Erro de informações de acordo com o tipo de dados
-5	Erro ao enviar o cancelamento para Sefaz Verificar os campos codigo e descricao para mais informações

Download do Cancelamento de GTV-e

Você pode fazer o download das informações completas de distribuição do cancelamento em XML ou JSON. Para isso confira o método Download de Evento na NS GTV-e API.

NS GTVe

URL