InstallmentPlan é a entidade responsável por agrupar as parcelas criadas para um produto, guardar as configurações de criação do conjunto de parcelas (período de recorrência, regra de data, número de parcelas etc) e responder perguntas sobre o conjunto de parcelas, como quantidade de parcelas vencidas, início do próximo ciclo de cobrança, etc.
Premissas
- As Installments serão agregadas por um InstallmentPlan, que será 1:1 com o contrato (empréstimo, acordo de renegociação, etc.).
- Valores calculados:
- NumberOfOverdueInstallments: contagem de parcelas com IsOverdue = true
- OverdueAmount: saldo presente das parcelas vencidas
🏛 Estrutura da entidade
{
"id": "xpto",
"account_plan_id": "xpto",
"security":{
"id": "ja1239sakfapsodasd9",
"type": "XPTO",
},
"number_of_installments": "ja1239sakfapsodasd9",
"first_start_date": "2022-12-24",
"billing": {
"period": "",
"period_unit": "",
"order": ""
},
"rates": {
"interest": 0.019,
"default_interest": 0.005,
"late_payment_fee": 0.02,
"tax": 0.01
},
"lender": "34590184000109",
"initial_amount": 10000.00,
"installments": [],
"antecipated_maturity": false,
"is_active": true,
"total_paid": 1000.00,
"total_balance": 1000.00,
"total_amount_due": 1000.00,
"number_of_overdue_installments": 4,
"overdue_amount": 100.00,
"disbursement_date": "2022-03-03",
"total_interest_economy": 0.0000,
"creation_date": "2022-05-01",
"last_update_date": "2022-05-01",
}
📚 Dicionário de dados
| Campos | Tipo | Descrição |
|---|---|---|
| id | string | Identificador único do plano de parcelamento |
| account_plan_id | string | Identificador único do plano de contas |
| security | object | Objeto que carrega as informações referentes a origem do plano de parcelamento |
| number_of_installments | inteiro | Quantidade de parcelas contidas no plano de parcelamento |
| first_start_date | date | Data de início de coleta da primeira parcela. Para o loan, será igual à maximum_disbursement_date |
| billing | object | Contém as regras de amortização da parcela, como periodicidade de vencimento e ordem de amortização |
| rates | object | Contém todas as taxas que podem ser cobradas ao longo da vida da security |
| lender | string | Documento do credor da security |
| initial_amount | decimal | Saldo inicial do plano de parcelamento (valor desembolsado+encargos) |
| installments | object | Lista que contém as informações das parcelas contidas no plano. |
| antecipated_maturity | boolean | Informa se o plano foi vencido antecipadamente. |
| is_active | boolean | Informa se o plano está ativo |
| total_paid | decimal | Valor total pago em todas as parcelas |
| total_balance | decimal | Soma de todos os lançamentos de todas as parcelas |
| total_amount_due | decimal | Soma dos valores de todas as parcelas a valor presente |
| number_of_overdue_installments | inteiro | Quantidade de parcelas vencidas |
| overdue_amount | decimal | Saldo presente das parcelas vencidas |
| disbursement_date | date | Data do desembolso relacionado a security |
| total_interest_economy | decimal | Economia total de juros |
| creation_date | dateTime | Data em que o plano foi criado |
| last_update_date | dateTime | Data da última atualização do plano |