---
title: 7.6. Relatórios
url: https://docs.vehub.com.br/Emiss%C3%A3o%20de%20Ativos/API/Cr%C3%A9dito/7.%20Contratos%20e%20Parcelas/7.6.%20Relat%C3%B3rios/
---
# 7.6. Relatórios

!!! warning "Especificação — em construção"
    Os serviços descritos nesta área ainda não estão disponíveis.

## 🔗 Endpoints

| Método | URL |
|--------|-----|
| ![GET](https://img.shields.io/badge/GET-green) | `/credito/relatorios/contratos-ativos` |
| ![GET](https://img.shields.io/badge/GET-green) | `/credito/relatorios/parcelas` |

---

## 🧾 Descrição

Visões consolidadas da carteira, para conferência e fechamento. Ambos aceitam consulta paginada em
JSON ou **download** em CSV/XLSX.

Para integração transacional — conciliar pagamentos, buscar vencimentos do dia — use
[7.2. Parcelas e Saldo](7.2.%20Parcelas%20e%20Saldo.md). Os relatórios servem ao trabalho de
back-office.

---

## Contratos ativos

### 🔹 Query Parameters

| Parâmetro | Tipo | Descrição |
|-----------|------|-----------|
| pagina | integer | Página, começando em `1` |
| quantidade | integer | Registros por página. Máximo `100` |
| produto | string | `ep` ou `cdc` |
| dataContrato | date | Data mínima de contratação |
| dataContratoFim | date | Data máxima de contratação |
| formato | string | `csv` ou `xlsx`. Quando informado, devolve arquivo em vez de JSON |

### 🧪 Exemplo de cURL — consulta

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

### 🧪 Exemplo de cURL — download

```bash
curl -X GET "https://api.vehub.com.br/credito/relatorios/contratos-ativos?produto=ep&formato=xlsx" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  --output contratos-ativos.xlsx
```

### 📥 Response — `200 OK`

```json
{
  "registros": [
    {
      "idContrato": 5001,
      "numeroCcb": "PROP-2026-004821",
      "produto": "ep",
      "tomadorNome": "João da Silva",
      "tomadorDocumento": "12345678900",
      "dataContrato": "2026-08-20",
      "valorLiquido": 18000.00,
      "valorBruto": 20400.00,
      "quantidadeParcelas": 24,
      "parcelasPagas": 3,
      "parcelasEmAberto": 21,
      "saldoDevedor": 15980.42,
      "taxa": 1.99,
      "dataProximaParcela": "2027-01-13"
    }
  ],
  "paginacao": { "pagina": 1, "quantidade": 100, "total": 412 },
  "mensagem": null
}
```

| Campo | Tipo | Descrição |
|-------|------|-----------|
| parcelasPagas / parcelasEmAberto | integer | Contagem por situação |
| saldoDevedor | number | Saldo devedor atual do contrato |
| dataProximaParcela | string | Vencimento da próxima parcela em aberto |

---

## Parcelas

Mesma visão em nível de parcela, útil para fechamento de período.

### 🔹 Query Parameters

| Parâmetro | Tipo | Descrição |
|-----------|------|-----------|
| pagina | integer | Página, começando em `1` |
| quantidade | integer | Registros por página. Máximo `100` |
| produto | string | `ep` ou `cdc` |
| status | integer | Status da parcela |
| dataVencimento | date | Vencimento mínimo |
| dataVencimentoFim | date | Vencimento máximo |
| formato | string | `csv` ou `xlsx` |

### 🧪 Exemplo de cURL

```bash
curl -X GET "https://api.vehub.com.br/credito/relatorios/parcelas?dataVencimento=2026-10-01&dataVencimentoFim=2026-10-31&formato=csv" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  --output parcelas-outubro.csv
```

### 📥 Response — `200 OK`

```json
{
  "registros": [
    {
      "idContrato": 5001,
      "numeroCcb": "PROP-2026-004821",
      "produto": "ep",
      "tomadorNome": "João da Silva",
      "tomadorDocumento": "12345678900",
      "numero": 1,
      "dataVencimento": "2026-10-13",
      "valor": 850.00,
      "amortizacao": 495.28,
      "juros": 354.72,
      "saldoDevedor": 17325.17,
      "status": 2,
      "dataPagamento": "2026-10-13",
      "valorPagamento": 850.00
    }
  ],
  "paginacao": { "pagina": 1, "quantidade": 100, "total": 3184 },
  "mensagem": null
}
```

---

## ⚠️ Observações

- O download em CSV/XLSX é **síncrono** e limitado ao volume do filtro. Para períodos longos, quebre
  em recortes menores em vez de pedir a carteira inteira.
- Os relatórios respeitam o **grupo econômico** da credencial e devolvem apenas contratos de crédito
  (EP e CDC).
- Os valores refletem o estado no momento da consulta. Para o valor a cobrar numa data específica,
  use `POST /credito/contratos/{idContrato}/parcelas/valores` em
  [7.2](7.2.%20Parcelas%20e%20Saldo.md).