For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Recalculates repayment amounts for a specific rate bracket result.
Used when the user adjusts parameters on an individual result card
(e.g., changing balloon amount or rate).
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
pvdoubleRequired2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
compounding_freq_valueintegerRequired
base_mindoubleRequired2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
base_maxdoubleRequired2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
basedoubleRequired2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
base_ratedoubleRequired2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
noi_maxintegerRequired
noi_minintegerRequired
balloondoubleRequired2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
billing_typeenumRequired
Allowed values:
rate_changedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
uplift_min_termintegerOptional
uplift_max_termintegerOptional
rate_bracket_idintegerOptional
product_idintegerOptional
r_maxdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
r_mindoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
compounding_freqstringOptional
repayment_mindoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
repayment_maxdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Response
Recalculated result
pvdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Present value (financed amount)
costdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
brokeragedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
doc_feedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
uplift_min_termintegerOptional
uplift_max_termintegerOptional
rate_bracket_idintegerOptional
rate_bracket_namestringOptional
product_idintegerOptional
product_namestringOptional
product_min_rangeintegerOptional
product_max_rangeintegerOptional
organisation_idintegerOptional
organisation_namestringOptional
r_maxdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Maximum effective rate (%)
r_mindoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Minimum effective rate (%)
compounding_freqstringOptional
compounding_freq_valueintegerOptional
base_mindoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
base_maxdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
basedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Base rate
base_ratedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
noi_maxintegerOptional
Maximum number of installments
noi_minintegerOptional
Minimum number of installments
e_mindoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Minimum effective rate
e_maxdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Maximum effective rate
repayment_mindoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Minimum repayment amount per period
repayment_maxdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
Maximum repayment amount per period
balloondoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
