Preview jurisdiction tax amounts (partner)
Answers as POST /api/v1/br/tax/preview to a partner credential bound to the loan product. A loanProductVersionId that is not a version of that product is answered 404, as an unknown product is.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
Loan product the quote is for. A loanProductVersionId in the body must be one of its versions.
Body
Disbursement date (RFC3339).
"2026-06-14T12:00:00Z"
Final due date (RFC3339).
"2026-06-14T12:00:00Z"
Gross disbursement amount in major currency units (e.g. "100000.00").
"100000.00"
Jurisdiction the quote is for. This route quotes Brazilian taxes only: "BR", in either letter case. Any other two-letter code is refused 422 LENDER-0925.
2"BR"
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; every kind is priced with PUT /api/v1/br/tax/iof-rates/{borrowerKind}, and the rate table's keys are not a closed list. Simples Nacional, MEI included, is a regime and not a kind: send taxRegime brazilSimplesNacional with pessoaJuridica. A kind, or a declared Simples Nacional, the deployment does not price is refused 422 LENDER-0900 rather than previewed at another kind's rate.
"pessoaFisica"
Day the first instalment falls due (RFC3339 or YYYY-MM-DD). Omit it and the first instalment falls one month after the disbursement date, clamped to the month's last day; a quote naming loanProductVersionId instead hangs every instalment on the schedule generator's first date for that day, rolled to a business day. To quote an application's release, send the application's firstDueDate. 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. Its interest is its whole months plus its extra days over 30 at the monthly rate; the IOF quoted here counts its real days, so it moves with it. Ignored without requestedInstallments and requestedInterestRate, because there is no ladder to anchor.
"2026-03-10"
Instalment the payroll deducts, in major currency units (e.g. "112.19"), as a consignado contract declares it. Supply it together with firstDueDate, requestedInstallments and requestedInterestRate and the quote strikes the ladder booking strikes for a payroll contract: every instalment but the last is exactly this amount, the first period's interest beyond what the instalment covers is carried, and the last instalment closes the balance. The IOF quoted is then the IOF booking withholds. Omit it and the ladder is the generator's own level instalment. Ignored without all three, because there is no payroll ladder to strike. Refused 422 when it is not a positive amount, when after the first period it does not cover a month's interest, or when it repays the loan before the last instalment: the same refusals booking gives.
"112.19"
Loan product version this quote is for. Supply it and the quote prices the tax regime this version declares, the one the disbursement withholds under, unless taxRegime names another regime the version admits; a version whose tax profile cannot be resolved is refused 422 LENDER-0207, as the disbursement refuses it. Omit it and taxRegime is required, and the quote prices whatever the arithmetic allows, which is what a quote made before a product is picked needs. The version also bounds the first due date: 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 no window refusal can come back.
"018f4e4e-7a3f-7c2e-9a1b-2c3d4e5f6071"
Optional net delivered amount in major currency units.
"99949.66"
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.
0 <= x <= 60012
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.
"0.02"
Tax regime selector understood by the jurisdiction tax engine. Required when loanProductVersionId is omitted, and then quoted as declared. With loanProductVersionId, a regime the version admits (GET /api/v1/br/loan-product-versions/{id}/tax-regimes) is quoted as declared, as the release of an application declaring it is; any other is ignored and the version's own regime is quoted. A brazilSimplesNacional regime in force, sent or the version's own, with pessoaJuridica quotes Decreto 6.306/2007, art. 7, VI while grossAmount is R$ 30.000,00 or less, and the pessoaJuridica rate above it. The release compares the operation's contracted principal, so a tranche is quoted here on its own amount.
Response
OK
The computed tax-preview result (IOF, PIS, COFINS, and net delivered amount) for the requested disbursement.