Preview amortisation schedule

Computes a deterministic declining-balance schedule for the supplied loan parameters and records it as the offer, returning the identifier that names it. Re-running an identical preview returns the same identifier and records no second offer.

POST /api/v1/loan-applications/preview-schedule

Preview amortisation schedule

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annualInterestRate": "12.00000000",
  "jurisdictionCode": "BR",
  "startDate": "2026-06-14T00:00:00Z",
  "termMonths": 24,
  "amortizationSystem": "sac",
  "borrowerKind": "pessoaFisica",
  "firstDueDate": "2026-03-10",
  "gracePeriodDays": 30,
  "installmentAmount": "300.00",
  "loanProductVersionId": "018f4e4e-7a3f-7c2e-9a1b-2c3d4e5f6071",
  "netAmount": "10000.00",
  "paymentPeriodicity": "weekly",
  "paymentRules": [
    {
      "fromInstallment": 1,
      "kind": "interestOnly",
      "toInstallment": 6,
      "amount": "30000.00"
    }
  ],
  "principalAmount": "50000.00",
  "taxRegime": "brazilSimplesNacional"
}
'

200

{
  "calendarReference": "<string>",
  "installments": [
    {
      "dueDate": "2026-06-14",
      "interestAmount": "234.56",
      "number": 1,
      "principalAmount": "1000.00",
      "remainingBalance": "49000.00",
      "totalAmount": "1234.56"
    }
  ],
  "jurisdictionCode": "BR",
  "profileVersion": "1.0.0",
  "totalInterest": "4321.00",
  "totalPrincipal": "50000.00",
  "effectiveCostPreview": {
    "effectiveCostAnnualPct": "12.00000000",
    "effectiveCostMonthlyPct": "0.94888100",
    "memoryOfCalculation": {},
    "methodId": "<string>",
    "rateTableSnapshot": {}
  },
  "jurisdictionExtensions": {
    "body": {},
    "overlayKey": "<string>"
  },
  "netDeliveredAmount": "10000.01",
  "originationFeeAmount": "255.06",
  "scheduleOfferSnapshotId": "6f2b9a41-0c3d-5e7f-9a12-4b8c6d0e1f37",
  "withholdingAmount": "41.37"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

annualInterestRate · string · requerido

Annual interest rate as a decimal-string percentage (e.g. "12.00000000" is 12% a year): an application's monthly requestedInterestRate fraction times 1200.

Ejemplo:

"12.00000000"

jurisdictionCode · string · requerido

ISO-2 jurisdiction code. Ignored on a preview that names loanProductVersionId, which prices under the named version's own jurisdiction, as a proposal does.

Required string length: 2

Ejemplo:

"BR"

startDate · string · requerido

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

Ejemplo:

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

termMonths · integer<int64> · requerido

Number of instalments, on the periodicity of the contract (paymentPeriodicity).

Rango requerido: 1 <= x <= 600

Ejemplo:

24

amortizationSystem · enum<string>

Amortization system the ladder is struck under. OPTIONAL: omit it and the preview strikes price. A preview that names loanProductVersionId is refused when the version does not admit it (LENDER-0260).

Opciones disponibles: price, sac, american

Ejemplo:

"sac"

borrowerKind · enum<string>

Whose credit this is: it prices the IOF the release withholds, so the IOF rates disclosed, the gross a netAmount must cover and, with loanProductVersionId, the CET; a kind the deployment's rate table does not price is refused with LENDER-0233. Omitted, a preview prices a pessoaFisica.

Opciones disponibles: pessoaFisica, pessoaJuridica

Ejemplo:

"pessoaFisica"

firstDueDate · string

Day the first instalment falls due (RFC3339 or YYYY-MM-DD). Omit it and the first instalment falls one month after the start date, clamped to the month's last day; a request naming loanProductVersionId instead hangs every instalment on the schedule generator's first date for that day, rolled to a business day. To preview an application's release, send the application's firstDueDate. Supply it and it becomes the grid: every later instalment falls on that day of the month, clamped to each month's last day so a ladder anchored on the 31st falls on the 30th in April and never spills into May, and the first period runs from the start date to this day — longer or shorter than a month, and charged as its whole months plus each remaining day at a thirtieth of a month. Refused when, rolled onto a business day, it falls on or before the start date (LENDER-0229), or when gracePeriodDays is also set (LENDER-0232). First-period interest the first instalment does not cover is carried: it bears interest and is billed in the following instalments ahead of principal.

Ejemplo:

"2026-03-10"

gracePeriodDays · integer<int64>

Carência in calendar days: the first instalment falls this many days after the start date, on the business day the schedule generator moves that day to, and the preview is then exactly the one firstDueDate set to that business day answers: same ladder, CET and scheduleOfferSnapshotId. Mutually exclusive with firstDueDate (LENDER-0232). On a preview naming loanProductVersionId the day must be one the version's first due date window admits (LENDER-0235).

Rango requerido: 0 <= x <= 365

Ejemplo:

30

installmentAmount · string

Instalment to preview the principal of, as a decimal string, in place of principalAmount: a preview names exactly one of this, principalAmount and netAmount (LENDER-0255). Needs loanProductVersionId (LENDER-0255), on a version that admits the installment amount anchor (LENDER-0254). totalPrincipal is then the largest principal, in cents, whose every instalment is at most this amount: the principal a proposal records for the same instalment, version and dates. When none is, LENDER-0256.

Ejemplo:

"300.00"

loanProductVersionId · string<uuid>

Loan product version whose admitted first-due-date window this preview should be bounded by, and whose origination fee it prices into the CET. Optional: omit it and the preview prices whatever the arithmetic allows, with no fee, which is what a quote made before a product is picked needs. Supply it together with firstDueDate and the preview answers the same refusal booking will, rather than quoting a ladder the door will not take. Naming it also nets out of the CET the fee of the version's origination_fee template revision in force on the start date's civil day, the fee the release retains, and the IOF the release of the principal on the start date withholds for borrowerKind (a pessoaFisica when omitted) under taxRegime (the version's own when omitted), so the CET is the one that release discloses. A fee that leaves nothing of the principal less that IOF is refused with LENDER-0209, as the release refuses it, a taxRegime the version does not admit with LENDER-0930, brazilSimplesNacional for other than a pessoaJuridica with LENDER-0931, and a borrower kind the deployment prices no IOF for with LENDER-0233.

Ejemplo:

"018f4e4e-7a3f-7c2e-9a1b-2c3d4e5f6071"

netAmount · string

Net the borrower is to receive, as a decimal string, in place of principalAmount: a preview names exactly one of this, principalAmount and installmentAmount (LENDER-0255). Needs loanProductVersionId and borrowerKind (LENDER-0255), on a version that admits the net amount anchor (LENDER-0254). totalPrincipal is then the gross a proposal records for the same net, version, borrower kind and dates, and withholdingAmount, originationFeeAmount and netDeliveredAmount say what its release on the start date delivers. A borrower kind the version does not admit is refused with LENDER-0228, a fee that takes the net with LENDER-0209, and a borrower kind the deployment prices no tax for with LENDER-0233.

Ejemplo:

"10000.00"

paymentPeriodicity · enum<string>

How often an instalment falls due. OPTIONAL: omit it and the preview strikes monthly. A preview that names loanProductVersionId is refused when the version does not admit it (LENDER-0260).

Opciones disponibles: monthly, fortnightly, weekly

Ejemplo:

"weekly"

paymentRules · object[] | null

Rows paid by rule instead of the system's share, in order and without overlap; a row with no rule follows the system and is the calculated instalment. Price or sac, monthly, only with principalAmount (not installmentAmount or netAmount); a named loanProductVersionId must admit each kind (LENDER-0260); the last row cannot be interestOnly; every fixed total, the calculated instalment included, must exceed its period's interest, and a fixedAmount above the balance repays before the term (both LENDER-0212 at body.paymentRules). The last row closes the balance, so a fixedAmount there absorbs the rounding of the calculated instalment.

Maximum array length: 600

Show child attributes

principalAmount · string

Principal amount as a decimal string (e.g. "50000.00"). A preview names exactly one of this, installmentAmount and netAmount (LENDER-0255).

Ejemplo:

"50000.00"

taxRegime · string

Tax regime the borrower declared: the withholding is priced under it as a proposal's creation prices it, refused when the version does not admit it (LENDER-0930) and for Simples Nacional on other than a pessoaJuridica (LENDER-0931). Omitted, the version's own regime prices the release.

Ejemplo:

"brazilSimplesNacional"

Respuesta

200

application/json

OK

calendarReference · string · requerido

Identifier of the business calendar used to resolve due dates.

installments · object[] | null · requerido

Ordered amortisation schedule, one entry per installment.

Show child attributes

jurisdictionCode · string · requerido

ISO-2 jurisdiction code resolved for this preview.

Ejemplo:

"BR"

profileVersion · string · requerido

Jurisdiction profile version used to compute the schedule.

Ejemplo:

"1.0.0"

totalInterest · string · requerido

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

Ejemplo:

"4321.00"

totalPrincipal · string · requerido

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

Ejemplo:

"50000.00"

effectiveCostPreview · object

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

Show child attributes

jurisdictionExtensions · object

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

Show child attributes

netDeliveredAmount · string

Net that release delivers to the borrower: totalPrincipal minus withholdingAmount minus originationFeeAmount, the netAmount asked or 0.01 above it. Present only on a preview by netAmount.

Ejemplo:

"10000.01"

originationFeeAmount · string

Origination fee the version retains from that release, minor-unit precision scale 2. Present only on a preview by netAmount.

Ejemplo:

"255.06"

scheduleOfferSnapshotId · string

Identifier of the offer this preview recorded; derived from the frozen inputs, so an identical preview returns the same value. Absent whenever no offer was recorded — the request carries no tenant identity, the offer store was unavailable, or the service is misconfigured — and the schedule is returned in every one of those cases.

Ejemplo:

"6f2b9a41-0c3d-5e7f-9a12-4b8c6d0e1f37"

withholdingAmount · string

Jurisdiction withholding the release of totalPrincipal on the start date retains, minor-unit precision scale 2. Present only on a preview by netAmount.

Ejemplo:

"41.37"