Manual da API · Leitura e consulta

Obtém um documento fiscal da leitura de saída

GET/v1/saida/documentos/{id}

Grupos integracao-tms, consulta-embarcador e consulta-destinatario. Sem posição do veículo. PDF indicado só se D-11 autorizar.

Para que serve: mostra a situação de um documento fiscal (CT-e ou NF) pelo id do Veltra.

Quando chamar: quando um evento citou o documentoId e você quer saber o estado atual desse documento.

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/json

Documento

JSON

{
  "id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "numero": "texto",
  "status": "texto",
  "podeVerPdfECanhoto": true,
  "atualizadoEm": "2026-11-06T09:15:00-03:00"
}

Campos da resposta (5)

Campos

idtexto (uuid)obrigatório
numerotextoopcional
statustextoobrigatório
podeVerPdfECanhotoverdadeiro/falsoobrigatório
Verdadeiro só quando o terceiro é o tomador. O TMS da transportadora recebe verdadeiro.
atualizadoEmtexto (data e hora ISO 8601)opcional

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

O que fazer: erros

401, 403, 404 (não existe neste ambiente, ou, para chave de consulta, está fora das raízes de CNPJ da chave: é a mesma resposta de "não existe"), 400 (id inválido), 429.

Observações

não traz posição, placa ou trilha do veículo.

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