Pular para o conteúdo
Veltra Ajuda
Manual da APIPlaybookEntrar

Manual da API · Leitura e consulta

Baixa o PDF legível do evento 110180 (Comprovante de Entrega do CT-e)

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

Grupo integracao-tms. PDF gerado do XML assinado do evento que o Veltra guarda, com o retorno da SEFAZ (cStat, xMotivo, protocolo e data do registro), a chave do CT-e, o nSeqEvento, o recebedor, a posição da entrega, o hash da entrega e, quando existe, o comprovante do Veltra ligado ao evento (código público, hash do manifesto e QR de verificação). O PDF é só uma vista: o registro oficial continua sendo o XML (/v1/saida/eventos-cte/{id}/xml), que não é alterado. Se a transportadora escolheu mascarar o recebedor nos PDFs, o nome e o documento saem parcialmente ocultos. O {id} é o eventoId do payload de evento_cte.estado_alterado. Evento de outro ambiente ou de outra transportadora responde 404. Só a chave do TMS.

Para que serve: baixa o PDF legível do evento 110180 (Comprovante de Entrega do CT-e), gerado do XML assinado que o Veltra guarda. Serve para uma pessoa conferir ou guardar uma cópia; o registro oficial continua sendo o XML (rota acima), que o PDF nunca altera.

Quando chamar: depois que o estado do evento do CT-e chegou a REGISTRADO ou REGISTRADO_COM_ALERTA (evento evento_cte.estado_alterado). Um evento depois CANCELADO ainda tem PDF, com a faixa de cancelamento. 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/pdf

PDF 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.

404application/problem+json

Evento inexistente neste ambiente (EVENTO_NAO_ENCONTRADO, no campo codigo).

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.

409application/problem+json

Evento ainda não registrado na SEFAZ (EVENTO_AINDA_NAO_REGISTRADO) ou sem XML assinado guardado (EVENTO_SEM_XML_ASSINADO), no campo codigo.

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

StatusQuandoO que fazer
401Chave inválidaConferir a chave
403Chave que não é de TMS, ou chave suspensaUsar a chave de TMS
404EVENTO_NAO_ENCONTRADO: não existe neste ambiente ou é de outra transportadoraConferir o eventoId e o ambiente da chave
409EVENTO_AINDA_NAO_REGISTRADO: a SEFAZ ainda não registrou o eventoEsperar o estado REGISTRADO
409EVENTO_SEM_XML_ASSINADO: o registro foi só conciliado e o Veltra não guarda o XML assinadoPedir o XML ao emitente
429Limite de chamadasEsperar o Retry-After

Observações

o PDF é gerado na hora, do XML guardado, e o download é registrado para medição, como os outros PDFs.

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