Calculate repayments | Finput Docs

The core calculator endpoint. Takes loan parameters and returns matching financier/product/rate bracket combinations with calculated repayment amounts.

Performs:

Filters products by eligibility criteria (term, amount, ABN age, asset age, etc.)
Matches rate brackets within eligible products
Applies uplift rate adjustments
Calculates min/max repayments for each match

The core calculator endpoint. Takes loan parameters and returns matching financier/product/rate bracket combinations with calculated repayment amounts. Performs: 1. Filters products by eligibility criteria (term, amount, ABN age, asset age, etc.) 2. Matches rate brackets within eligible products 3. Applies uplift rate adjustments 4. Calculates min/max repayments for each match

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

costintegerRequired

Total asset cost ($)

termintegerRequired

Loan term (months)

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

Deposit amount ($ or %)

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

Brokerage amount ($ or %)

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

Origination fee ($)

advance_arrearsenumRequired

Allowed values:

repayment_frequencyenumRequired

Allowed values:

cost_gstbooleanOptionalDefaults to false

Whether cost includes GST

deposit_gstbooleanOptionalDefaults to false

deposit_percentagebooleanOptionalDefaults to false

If true, deposit is a percentage of cost

brokerage_gstbooleanOptionalDefaults to false

brokerage_percentagebooleanOptionalDefaults to false

If true, brokerage is a percentage

origination_fee_gstbooleanOptionalDefaults to false

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

Balloon/residual payment ($ or %)

balloon_gstbooleanOptionalDefaults to false

balloon_percentagebooleanOptionalDefaults to false

If true, balloon is a percentage

private_salebooleanOptionalDefaults to false

sale_hire_backbooleanOptionalDefaults to false

doc_fee_financedenumOptional

Allowed values:

asset_ownerbooleanOptionalDefaults to false

Whether the borrower is a home owner

asset_stateenumOptional

Allowed values:

asset_ageintegerOptional

Asset age (months)

asset_age_plus_termintegerOptional

asset_valueintegerOptional

abn_ageintegerOptional

ABN age (months)

gst_ageintegerOptional

GST registration age (months)

credit_scoreintegerOptional

preferred_financierlist of integersOptional

List of preferred organisation (financier) IDs

Response

Calculator results

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:

Errors

400

Calculate Request Bad Request Error

500

Calculate Request Internal Server Error

1	import requests
2
3	url = "https://api.finput.com.au/api/v1/calculator"
4
5	payload = {
6	"cost": 50000,
7	"term": 60,
8	"deposit": 5000,
9	"brokerage": 2.5,
10	"origination_fee": 990,
11	"advance_arrears": "arrears",
12	"repayment_frequency": "monthly",
13	"cost_gst": False,
14	"deposit_gst": False,
15	"deposit_percentage": False,
16	"brokerage_gst": False,
17	"brokerage_percentage": True,
18	"origination_fee_gst": False,
19	"balloon": 0,
20	"asset_state": "used",
21	"asset_age": 24,
22	"abn_age": 36,
23	"gst_age": 36,
24	"credit_score": 650,
25	"preferred_financier": [1]
26	}
27	headers = {
28	"Authorization": "Bearer <token>",
29	"Content-Type": "application/json"
30	}
31
32	response = requests.post(url, json=payload, headers=headers)
33
34	print(response.json())

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