Skip to main content
POST
Pré-visualizar cronograma de amortização

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
annualInterestRate
string
obrigatório

Annual interest rate as a decimal string (e.g. "0.12000000").

Exemplo:

"0.12000000"

dayCountConvention
string
obrigatório

Day count convention identifier.

Exemplo:

"ACT/365"

jurisdictionCode
string
obrigatório

ISO-2 jurisdiction code.

Required string length: 2
Exemplo:

"BR"

principalAmount
string
obrigatório

Principal amount as a decimal string (e.g. "50000.00").

Exemplo:

"50000.00"

startDate
string
obrigatório

Schedule start date (RFC3339 or YYYY-MM-DD).

Exemplo:

"2026-06-14T00:00:00Z"

termMonths
integer<int64>
obrigatório

Number of months.

Intervalo obrigatório: 1 <= x <= 600
Exemplo:

24

gracePeriodDays
integer<int64>

Grace period in days.

Intervalo obrigatório: 0 <= x <= 365
Exemplo:

30

Resposta

OK

calendarReference
string
obrigatório

Identifier of the business calendar used to resolve due dates.

dayCountConvention
string
obrigatório

Day count convention applied to interest accrual.

Exemplo:

"ACT/365"

installments
object[] | null
obrigatório

Ordered amortisation schedule, one entry per installment.

jurisdictionCode
string
obrigatório

ISO-2 jurisdiction code resolved for this preview.

Exemplo:

"BR"

profileVersion
string
obrigatório

Jurisdiction profile version used to compute the schedule.

Exemplo:

"1.0.0"

totalInterest
string
obrigatório

Sum of interest across all installments as a decimal string, minor-unit precision scale 2 (e.g. "4321.00").

Exemplo:

"4321.00"

totalPrincipal
string
obrigatório

Sum of principal across all installments as a decimal string, minor-unit precision scale 2 (e.g. "50000.00").

Exemplo:

"50000.00"

effectiveCostPreview
object

Effective-cost breakdown; present only when the jurisdiction profile computes one.

jurisdictionExtensions
object

Per-jurisdiction overlay payload; present only when the profile emits one.