Visão Geral da Simulação

A simulação é meramente um cálculo que representará o esquema de pagamento e os custos da dívida dadas as condições fixas escolhidas dentro dos limites da oferta.

A partir da simulação, será possível exibir para o cliente uma prévia dos dados do empréstimo, gerada com base nos dados informados na geração da simulação.

Objeto

{
	"type": "LoanConcession",
	"requested_amount": 10546.87,
	"credit_amount": 10667.00,
	"installment_amount": 2101.59,
	"number_of_installments": 6,
	"installments_sum": 12609.51,
	"interest_rate": 0.05,
	"retention_rate": 0.1051,
	"due_date": "2023-06-10",
	"tax_amount": 120.13,
	"annual_total_effective_cost_rate": 0.8701,
	"annual_interest_rate": 0.7959
}
{
	"type": "Renegotiation",
	"securities": [
		{
			"type": "Credit",
			"external_reference": "jqshwb4c5az6f9y3smn2t92vy",
			"is_overdue": true,
			"installment_plan": {
				"amount": 390.7596220517,
				"count": 6,
				"total_sum": 2344.5577323102,
				"payment_reference_date": "2023-02-20"
			},
			"rate": {
				"tax_amount": 24.99,
				"annual_interest_rate": 0.1942,
				"annual_total_effective_cost_rate": 0.242,
				"retention_rate": 0.1954,
				"interest_rate": 0.0149,
				"iof_rate": 0.000041
			},
			"summary": {
				"total_paid": 10.0,
				"current_debt_amount": 2221.98086669,
				"number_of_open_installments": 6,
				"due_date": "2023-08-20",
				"days_overdue": 0
			},
			"last_update_date": "2023-03-16T00:00:00Z"
		}
	],
	"amount": 2221.98,
	"installment_amount": 380.77,
	"number_of_installments": 6,
	"installments_sum": 2284.61,
	"interest_rate": 0.008,
	"retention_rate": 0.02,
	"due_date": "2023-09-18",
	"tax_amount": 0.0,
	"annual_total_effective_cost_rate": 0.1003,
	"annual_interest_rate": 0.1003
}

Campos

CampoDescriçãoTipo
typeTipo da oferta que foi simuladaString
requested_amountValor de simulação do empréstimoDecimal
credit_amountValor da dívida. Sendo o somatório de requested_amount e tax_amountDecimal
installment_amountValor de cada parcelaDecimal
number_of_installmentsQuantidade de parceladas simuladasInteger
installments_sumValor total da soma de todas as parcelaDecimal
interest_rateTaxa de jurosDecimal
retention_rateTaxa de retençãoDecimal
due_dateData de vencimento do contratoDateTime
tax_amountValor das taxasDecimal
annual_total_effective_cost_rateTaxa do custo efetivo anualDecimal
annual_interest_rateTaxa de juros anualDecimal

Tipos de Oferta

TipoDescrição
LoanConcessionConcessão de crédito
RenegotiationRenegociação de um empréstimo (ainda não funcional)