--- title: 7.2. Parcelas e Saldo url: https://docs.vehub.com.br/Emiss%C3%A3o%20de%20Ativos/API/Cr%C3%A9dito/7.%20Contratos%20e%20Parcelas/7.2.%20Parcelas%20e%20Saldo/ --- # 7.2. Parcelas e Saldo !!! 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/contratos/{idContrato}/parcelas` | | ![GET](https://img.shields.io/badge/GET-green) | `/credito/parcelas` | | ![POST](https://img.shields.io/badge/POST-blue) | `/credito/contratos/{idContrato}/parcelas/valores` | --- ## Parcelas de um contrato ### 🧪 Exemplo de cURL ```bash curl -X GET "https://api.vehub.com.br/credito/contratos/5001/parcelas" \ -H "Authorization: Bearer {seu_token}" \ -H "GrupoEconomico: {seu_grupo_economico}" ``` ### 📥 Response — `200 OK` ```json { "idContrato": 5001, "tomadorNome": "João da Silva", "tomadorDocumento": "12345678900", "parcelas": [ { "id": 8801, "numero": 1, "dataVencimento": "2026-10-13", "valor": 850.00, "valorPrestacaoTotal": 850.00, "amortizacao": 495.28, "juros": 354.72, "saldoDevedor": 17325.17, "status": 1, "dataPagamento": null, "valorPagamento": null, "valorBoleto": 850.00, "linhaDigitavel": "34191.79001 01043.510047 91020.150008 1 99860000085000", "numCodBarras": "34191998600000850001790001010435100479102015000", "dataVencimentoBoleto": "2026-10-13" } ] } ``` ### 🧾 Detalhamento dos Campos — `parcelas[]` | Campo | Tipo | Descrição | |-------|------|-----------| | id | integer | Identificador da parcela. Endereça liquidação, cobrança e boleto | | numero | integer | Número sequencial no fluxo | | dataVencimento | string | Vencimento contratado | | valor | number | Valor original da parcela | | valorPrestacaoTotal | number | Valor da prestação com encargos previstos | | amortizacao | number | Parcela de amortização do principal | | juros | number | Parcela de juros | | saldoDevedor | number | Saldo devedor após esta parcela | | status | integer | Ver `GET /enumeracoes/status-parcela` | | dataPagamento | string / null | Preenchido após a liquidação | | valorPagamento | number / null | Valor efetivamente pago | | valorBoleto | number / null | Valor da cobrança emitida | | linhaDigitavel | string / null | Linha digitável do boleto | | numCodBarras | string / null | Código de barras | | dataVencimentoBoleto | string / null | Vencimento da cobrança, que pode diferir do vencimento contratado | --- ## Listagem transversal de parcelas Para conciliação, varrer contrato por contrato é caro. Esta listagem devolve parcelas de **todos** os contratos da credencial, com filtros. ### 🔹 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` | | ccb | string | Filtro pelo número da CCB | | tomadorNome | string | Filtro por nome do tomador | | tomadorDocumento | string | Filtro por documento do tomador | | status | integer | Filtro por status da parcela | | valor | number | Valor mínimo | | valorFim | number | Valor máximo | | dataVencimento | date | Vencimento mínimo | | dataVencimentoFim | date | Vencimento máximo | ### 🧪 Exemplo de cURL Parcelas que vencem na próxima semana: ```bash curl -X GET "https://api.vehub.com.br/credito/parcelas?dataVencimento=2026-10-13&dataVencimentoFim=2026-10-20&quantidade=100" \ -H "Authorization: Bearer {seu_token}" \ -H "GrupoEconomico: {seu_grupo_economico}" ``` ### 📥 Response — `200 OK` ```json { "registros": [ { "id": 8801, "idContrato": 5001, "numeroCcb": "PROP-2026-004821", "produto": "ep", "tomadorNome": "João da Silva", "tomadorDocumento": "12345678900", "numero": 1, "dataVencimento": "2026-10-13", "valor": 850.00, "status": 1, "linhaDigitavel": "34191.79001 01043.510047 91020.150008 1 99860000085000" } ], "paginacao": { "pagina": 1, "quantidade": 100, "total": 3184 }, "mensagem": null } ``` --- ## Saldo atualizado numa data O valor da parcela muda com o tempo — encargos por atraso, ou desconto por antecipação. Este endpoint calcula o valor **numa data específica**. ### 📤 Requisição ```json { "idsParcelas": [8801, 8802], "dataCalculo": "2026-09-15", "permiteDescapitalizacao": true } ``` ### 🧾 Detalhamento dos Campos | Campo | Tipo | Obrigatório | Descrição | |-------|------|-------------|-----------| | idsParcelas | array | Não | Parcelas a calcular. Omitido ⇒ todas as parcelas em aberto | | dataCalculo | string | Sim | Data de referência do cálculo | | permiteDescapitalizacao | boolean | Não | `true` aplica desconto ao calcular parcela antes do vencimento | ### 🧪 Exemplo de cURL ```bash curl -X POST "https://api.vehub.com.br/credito/contratos/5001/parcelas/valores" \ -H "Authorization: Bearer {seu_token}" \ -H "GrupoEconomico: {seu_grupo_economico}" \ -H "Content-Type: application/json" \ -d '{ "idsParcelas": [8801, 8802], "dataCalculo": "2026-09-15", "permiteDescapitalizacao": true }' ``` ### 📥 Response — `200 OK` ```json { "sucesso": true, "mensagem": null, "dados": { "dataCalculo": "2026-09-15", "parcelas": [ { "id": 8801, "numero": 1, "dataVencimento": "2026-10-13", "valorOriginal": 850.00, "valorAtualizado": 826.40, "valorMulta": 0.00, "valorMora": 0.00, "valorDesconto": 23.60, "valorPresente": 826.40 } ], "totalAtualizado": 1652.80 } } ``` | Campo | Tipo | Descrição | |-------|------|-----------| | valorOriginal | number | Valor contratado da parcela | | valorAtualizado | number | Valor a cobrar na `dataCalculo` | | valorMulta / valorMora | number | Encargos por atraso, quando a data é posterior ao vencimento | | valorDesconto | number | Desconto por antecipação, quando `permiteDescapitalizacao = true` | | valorPresente | number | Valor presente da parcela na data | | totalAtualizado | number | Soma das parcelas calculadas | --- ## 🧭 Quando usar cada um | Preciso de... | Endpoint | |---|---| | O fluxo contratado de um contrato | `GET /credito/contratos/{id}/parcelas` | | Varrer vencimentos do período, para conciliação | `GET /credito/parcelas` | | O valor a cobrar hoje, com encargos ou desconto | `POST /credito/contratos/{id}/parcelas/valores` | --- ## ⚠️ Observações - O valor devolvido por `parcelas/valores` é um **cálculo para a data informada**, não uma cobrança. Para emitir, use [7.4. Cobrança](7.4.%20Cobrança.md); para registrar pagamento, use [7.3. Liquidar Parcela](7.3.%20Liquidar%20Parcela.md). - `linhaDigitavel` e `numCodBarras` só vêm preenchidos quando **existe cobrança emitida** para a parcela. - **Não há baixa automática por conciliação bancária.** O pagamento de uma parcela só é refletido quando você informa a liquidação ou quando a cobrança emitida pela plataforma é paga e retorna.