Preview jurisdiction tax amounts

Computes disbursement IOF tax amounts using the active compiled jurisdiction profile without persisting data.

POST /api/v1/br/tax/preview

Preview jurisdiction tax amounts

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/tax/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "disbursementDate": "2026-06-14T12:00:00Z",
  "finalDueDate": "2026-06-14T12:00:00Z",
  "grossAmount": "100000.00",
  "jurisdictionCode": "BR",
  "taxRegime": "<string>",
  "borrowerKind": "pessoaFisica",
  "firstDueDate": "2026-03-10",
  "loanProductVersionId": "018f4e4e-7a3f-7c2e-9a1b-2c3d4e5f6071",
  "netDeliveredAmount": "99949.66",
  "requestedInstallments": 12,
  "requestedInterestRate": "0.02"
}
'

200

{
  "data": {
    "cofins": "0.00",
    "grossAmount": "100000.00",
    "iofAdditional": "38.00",
    "iofDaily": "12.34",
    "jurisdictionCode": "BR",
    "netDeliveredAmount": "99949.66",
    "pis": "0.00",
    "profileVersion": "1.0.0",
    "rateTableSnapshotId": "550e8400-e29b-41d4-a716-446655440002",
    "taxRegime": "<string>",
    "totalIof": "50.34",
    "totalTax": "50.34"
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Body

application/json

disbursementDate · string<date-time> · required

Disbursement date (RFC3339).

Example:

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

finalDueDate · string<date-time> · required

Final due date (RFC3339).

Example:

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

grossAmount · string · required

Gross disbursement amount in major currency units (e.g. "100000.00").

Example:

"100000.00"

jurisdictionCode · string · required

ISO 3166-1 alpha-2 jurisdiction code (e.g. "BR").

Required string length: 2

Example:

"BR"

taxRegime · string · required

Tax regime selector understood by the jurisdiction tax engine.

borrowerKind · string

Kind of taxpayer the credit is granted to. Brazil sets a different daily IOF aliquota per kind (Decreto 6.306/2007, art. 7, I, "b"), so the preview quotes the rate priced for the kind named here. The deployment ships pricing pessoaFisica, which is also what an omitted value previews; pessoaJuridica and any further kind (Simples Nacional, MEI) are priced by seeding a rate-table row, with no schema change, which is why this is not a closed list. A kind the deployment does not price is refused 422 LENDER-0900 rather than previewed at another kind's rate.

Example:

"pessoaFisica"

firstDueDate · string

Day the first instalment falls due (RFC3339 or YYYY-MM-DD). Omit it and the ladder falls on the day the schedule generator strikes by itself, one month after the disbursement date clamped to the month's last day. Supply it and it becomes the ladder's anchor: the first period runs from the disbursement date to this day, longer or shorter than a month and charged by its real days, so the IOF quoted here moves with it. Ignored without requestedInstallments and requestedInterestRate, because there is no ladder to anchor.

Example:

"2026-03-10"

loanProductVersionId · string<uuid>

Loan product version whose admitted first-due-date window this quote should be bounded by. Optional: omit it and the quote prices whatever the arithmetic allows, which is what a quote made before a product is picked needs. Supply it together with firstDueDate, requestedInstallments and requestedInterestRate and the quote answers the same refusal booking will, rather than quoting a tax on a ladder the door will not take. The window is read only on a quote that strikes a ladder: without both ladder inputs there is no first due date to bound, so this version is not consulted and no window refusal can come back.

Example:

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

netDeliveredAmount · string

Optional net delivered amount in major currency units.

Example:

"99949.66"

requestedInstallments · integer<int64>

Number of monthly instalments the contract amortises over. Supply it together with requestedInterestRate and the quote is computed on the instalment ladder the schedule generator strikes, which is the ladder the disbursement door withholds against. Omit either and the quote values the operation as a single window from the disbursement date to the final due date, which is what a bullet operation is.

Required range: 0 <= x <= 600

Example:

12

requestedInterestRate · string

Monthly interest rate as a decimal FRACTION, not a percentage: "0.02" is 2% a month. Required together with requestedInstallments to quote on the instalment ladder.

Example:

"0.02"

Response

200

application/json

OK

data · object · required

The computed tax-preview result (IOF, PIS, COFINS, and net delivered amount) for the requested disbursement.

Show child attributes