Ir para o conteúdo

7.5. Boleto e Carnê

Especificação — em construção

Os serviços descritos nesta área ainda não estão disponíveis.

🔗 Endpoints

Método URL Retorno
GET /credito/contratos/{idContrato}/parcelas/{idParcela}/boleto JSON
GET /credito/contratos/{idContrato}/parcelas/{idParcela}/boleto/documento PDF
GET /credito/contratos/{idContrato}/cobrancas/documento PDF

Dados do boleto da parcela

Devolve os dados para pagamento, em JSON — útil quando você renderiza o boleto na sua própria interface ou envia a linha digitável por mensagem.

🧪 Exemplo de cURL

curl -X GET "https://api.vehub.com.br/credito/contratos/5001/parcelas/8801/boleto" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "sucesso": true,
  "mensagem": null,
  "dados": {
    "valor": 850.00,
    "dataVencimento": "2026-10-13",
    "linhaDigitavel": "34191.79001 01043.510047 91020.150008 1 99860000085000",
    "numCodBarras": "34191998600000850001790001010435100479102015000",
    "pixCopiaECola": null
  }
}
Campo Tipo Descrição
valor number Valor da cobrança
dataVencimento string Vencimento da cobrança
linhaDigitavel string / null Linha digitável
numCodBarras string / null Código de barras
pixCopiaECola string / null Código PIX, quando emitido

❌ 404 Not Found

Quando a parcela não tem cobrança emitida.

PDF do boleto da parcela

Devolve o boleto pronto para impressão ou envio ao cliente, com Content-Type: application/pdf.

🧪 Exemplo de cURL

curl -X GET "https://api.vehub.com.br/credito/contratos/5001/parcelas/8801/boleto/documento" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  --output boleto-parcela-1.pdf

Carnê do contrato

Devolve, em um único PDF, as cobranças do contrato — o carnê completo, ou apenas uma parcela.

🔹 Query Parameters

Parâmetro Tipo Descrição
formato string Formato do documento. pdf
nroParcela integer Quando informado, gera apenas a parcela indicada. Omitido ⇒ carnê completo

🧪 Exemplo de cURL

Carnê completo:

curl -X GET "https://api.vehub.com.br/credito/contratos/5001/cobrancas/documento?formato=pdf" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  --output carne-5001.pdf

Apenas a terceira parcela:

curl -X GET "https://api.vehub.com.br/credito/contratos/5001/cobrancas/documento?formato=pdf&nroParcela=3" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  --output boleto-parcela-3.pdf

🧭 Qual usar

Preciso de... Endpoint
A linha digitável para enviar por mensagem ou exibir na tela .../parcelas/{idParcela}/boleto
O boleto em PDF de uma parcela .../parcelas/{idParcela}/boleto/documento
O carnê com todas as parcelas .../cobrancas/documento

⚠️ Observações

  • Estes serviços leem cobranças já emitidas. Para emitir, ver 7.4. Cobrança — e lembre que a emissão depende de cobrancaExterna.
  • Em esteiras com cobrança externa, não há cobrança emitida pela plataforma: os endpoints responderão 404. Nesse cenário o boleto é seu, e a plataforma só precisa saber da liquidação.
  • O PDF é gerado no momento da chamada. Para envios em volume, prefira gerar sob demanda em vez de pré-baixar todos os boletos do contrato.