Manual da API · Leitura e consulta

Baixa o XML assinado do evento 110180 com o protocolo

GET/v1/saida/eventos-cte/{id}/xml

Grupo integracao-tms. Evento 110180 assinado, com o protocolo da SEFAZ. O Veltra não transmite o 110190.

Para que serve: baixa o XML assinado do evento 110180 (Comprovante de Entrega do CT-e), com o protocolo da SEFAZ.

Quando chamar: quando o estado do evento do CT-e chegou a REGISTRADO (evento evento_cte.estado_alterado) e o TMS quer guardar o XML. Só a chave do TMS usa.

Parâmetros

Cabeçalhos (header)

X-Veltra-Api-Keytextoobrigatório
Chave de API do TMS. Emitida na tela Chaves de API do portal; o valor completo aparece uma única vez.

Caminho (path)

idtexto (uuid)obrigatório

Respostas

200application/xml

XML do evento 110180

403application/problem+json

CHAVE_SUSPENSA (no campo codigo): a chave de consulta está suspensa porque o add-on foi desligado. A chave não foi revogada e volta a funcionar quando o add-on for contratado de novo.

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Erroapplication/problem+json

Erro no formato RFC 9457 (application/problem+json)

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Guia explicado

Importante

o Veltra não transmite o evento 110190 (insucesso). Esse evento deve ser emitido pelo TMS por conta própria.

O que fazer: erros

Status	Quando	O que fazer
`401`	Chave inválida	Conferir a chave
`403`	Chave que não é de TMS	Usar a chave de TMS
`404`	Não existe neste ambiente, ou o perfil da transportadora não gerou o evento 110180 para esse documento	Confirmar o perfil com a transportadora
`429`	Limite de chamadas	Esperar o `Retry-After`

Observações

o XML só existe para documentos cujo perfil da transportadora gera esse evento. O download é registrado para medição e pode ser repetido.

Texto completo, com mais exemplos, em API por rota.