Recalculate repayments

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

pvdouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Present value (financed amount)

costdouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

brokeragedouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

doc_feedouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

uplift_min_terminteger

uplift_max_terminteger

rate_bracket_idinteger

rate_bracket_namestring

product_idinteger

product_namestring

product_min_rangeinteger

product_max_rangeinteger

organisation_idinteger

organisation_namestring

r_maxdouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Maximum effective rate (%)

r_mindouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Minimum effective rate (%)

compounding_freqstring

compounding_freq_valueinteger

base_mindouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

base_maxdouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

basedouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Base rate

base_ratedouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

noi_maxinteger

Maximum number of installments

noi_mininteger

Minimum number of installments

e_mindouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Minimum effective rate

e_maxdouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Maximum effective rate

repayment_mindouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Minimum repayment amount per period

repayment_maxdouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

Maximum repayment amount per period

balloondouble2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0

billing_typeenum

Allowed values:

1	import requests
2
3	url = "https://api.finput.com.au/api/v1/calculator/recalculate"
4
5	payload = {
6	"pv": 1.1,
7	"compounding_freq_value": 1,
8	"base_min": 1.1,
9	"base_max": 1.1,
10	"base": 1.1,
11	"base_rate": 1.1,
12	"noi_max": 1,
13	"noi_min": 1,
14	"balloon": 1.1,
15	"billing_type": "advance"
16	}
17	headers = {
18	"Authorization": "Bearer <token>",
19	"Content-Type": "application/json"
20	}
21
22	response = requests.post(url, json=payload, headers=headers)
23
24	print(response.json())

1	{
2	"pv": 1.1,
3	"cost": 1.1,
4	"brokerage": 1.1,
5	"doc_fee": 1.1,
6	"uplift_min_term": 1,
7	"uplift_max_term": 1,
8	"rate_bracket_id": 1,
9	"rate_bracket_name": "rate_bracket_name",
10	"product_id": 1,
11	"product_name": "product_name",
12	"product_min_range": 1,
13	"product_max_range": 1,
14	"organisation_id": 1,
15	"organisation_name": "organisation_name",
16	"r_max": 1.1,
17	"r_min": 1.1,
18	"compounding_freq": "compounding_freq",
19	"compounding_freq_value": 1,
20	"base_min": 1.1,
21	"base_max": 1.1,
22	"base": 1.1,
23	"base_rate": 1.1,
24	"noi_max": 1,
25	"noi_min": 1,
26	"e_min": 1.1,
27	"e_max": 1.1,
28	"repayment_min": 1.1,
29	"repayment_max": 1.1,
30	"balloon": 1.1,
31	"billing_type": "none"
32	}