Obter comprovante de CIOT

Fornecer o comprovante da operação CIOT (Código Identificador da Operação de Transporte) em formato PDF, convertido para Base64, para que o cliente possa visualizar, armazenar ou processar o documento conforme necessário.

Métodos e rotas

• Consulta (GET): /frete/obterComprovanteCIOT/{enterpriseID}/{cnpj}/{ciot}/{cod}
  • Parâmetros de Rota:
    • {cnpj}: CNPJ associado à operação (string).
    • {ciot}: número do CIOT (string ou numérico, conforme especificação interna).
    • {cod}: código identificador adicional da operação ou do comprovante (string).

Estrutura da Requisição

Cabeçalhos

• Deve ser enviado no header o token JWT:

  Authorization: Bearer {token}

Fluxo Operacional

1. O cliente envia uma requisição GET com os parâmetros de rota e o token JWT no header.
2. O servidor valida o token e os parâmetros informados.
3. Sendo a requisição válida, o comprovante CIOT é recuperado, convertido para Base64 e retornado no campo pdf.
4. Em caso de erro, é retornado um JSON no padrão de erro da API.

{
  "codigo": "999",
  "mensagem": "Descrição do erro"
}

Resposta do GET

Após a validação dos parâmetros e do token, o endpoint retornará um JSON contendo o comprovante do CIOT, convertido para Base64:

{
  "pdf": "base64 do pdf do comprovante"
}

pdf: (string) contém o conteúdo do comprovante em formato PDF convertido para uma string em Base64.

Códigos de Status HTTP

• 200 ou 201: o comprovante foi recuperado e retornado com sucesso.
• 400: erro de validação dos parâmetros da rota (ex.: formato incorreto, parâmetro ausente).
• 401: não autorizado (token JWT ausente ou inválido).
• 500: erro interno do servidor.

Consulte aqui para todas as mensagens e códigos de retorno

---

Próximos passos

Veja como pagar parcelas em lote

---