Ir para o conteúdo

7.1. Consultar Contrato¶

Especificação — em construção

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

🔗 Endpoints¶

Método	URL
	`/credito/contratos/{idContrato}`
	`/credito/contratos`

🧾 Descrição¶

Consulta os contratos já formalizados — as operações que saíram do estado de proposta e passaram a gerar parcelas cobráveis.

O idContrato é devolvido na listagem de propostas e nos eventos de webhook de formalização.

Consultar contrato¶

🧪 Exemplo de cURL¶

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

📥 Response — `200 OK`¶

{
  "sucesso": true,
  "mensagem": null,
  "dados": {
    "idContrato": 5001,
    "idProposta": 1001,
    "idEsteira": 12,
    "produto": "ep",
    "numeroCcb": "PROP-2026-004821",
    "status": { "id": 6, "nome": "Finalizado" },
    "tomador": {
      "nome": "João da Silva",
      "documento": "12345678900"
    },
    "dataContrato": "2026-08-20",
    "dataPrimeiraParcela": "2026-10-13",
    "dataUltimaParcela": "2028-09-13",
    "quantidadeParcelas": 24,
    "valorBruto": 20400.00,
    "valorLiquido": 18000.00,
    "taxa": 1.99,
    "cet": { "valor": 2563.20, "percentualMensal": 2.10, "percentualAnual": 28.30 },
    "cobrancaExterna": false,
    "parceiroOriginador": null
  }
}

🧾 Detalhamento dos Campos¶

Campo	Tipo	Descrição
idContrato	integer	Identificador do contrato. Endereça os serviços de parcelas e cobrança
idProposta	integer	Proposta que originou o contrato
idEsteira	integer	Esteira da operação
produto	string	`ep` ou `cdc`
numeroCcb	string	Número da Cédula de Crédito Bancário
status	object	Ver 2.1. Enumerações
tomador	object	Nome e documento do tomador
dataContrato	string	Data da contratação
dataPrimeiraParcela / dataUltimaParcela	string	Vencimentos extremos do fluxo
quantidadeParcelas	integer	Número de parcelas
valorBruto	number	Total a pagar
valorLiquido	number	Valor desembolsado
taxa	number	Taxa mensal contratada
cet	object	Custo Efetivo Total
cobrancaExterna	boolean	`true` quando a cobrança é sua responsabilidade — ver 7.4
parceiroOriginador	object / null	Parceiro que recebeu o desembolso, em CDC

Listar contratos¶

🔹 Query Parameters¶

Parâmetro	Tipo	Descrição
pagina	integer	Página, começando em `1`
quantidade	integer	Registros por página. Máximo `100`
ordem	string	Campo de ordenação
direcaoOrdem	string	`asc` ou `desc`
produto	string	`ep` ou `cdc`
numeroCcb	string	Filtro pelo número da CCB
tomadorNome	string	Filtro por nome do tomador
cpfCnpj	string	Filtro por documento do tomador
idStatusContrato	integer	Filtro por status
valorEmprestado	number	Valor mínimo
valorEmprestadoFim	number	Valor máximo
dataProximaParcela	date	Vencimento mínimo da próxima parcela
dataProximaParcelaFim	date	Vencimento máximo da próxima parcela

🧪 Exemplo de cURL¶

curl -X GET "https://api.vehub.com.br/credito/contratos?produto=ep&pagina=1&quantidade=50" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — `200 OK`¶

{
  "registros": [
    {
      "idContrato": 5001,
      "idProposta": 1001,
      "produto": "ep",
      "numeroCcb": "PROP-2026-004821",
      "tomadorNome": "João da Silva",
      "tomadorDocumento": "12345678900",
      "status": 6,
      "dataContrato": "2026-08-20",
      "valorLiquido": 18000.00,
      "quantidadeParcelas": 24,
      "dataProximaParcela": "2026-10-13"
    }
  ],
  "paginacao": { "pagina": 1, "quantidade": 50, "total": 412 },
  "mensagem": null
}

⚠️ Observações¶

A listagem devolve apenas contratos de crédito (EP e CDC) do grupo econômico da credencial.
Para varrer parcelas de vários contratos de uma vez — o caso típico de conciliação — use 7.2. Parcelas e Saldo, que tem uma listagem transversal.
cobrancaExterna vem do parâmetro da esteira no momento da consulta. Ele determina se você pode gerar cobrança pela API.