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.
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
Authentication
AuthorizationBearer
JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token
Headers
X-Finput-ClientenumOptional
Which client is asking, so every message in the response is worded for it. ios and android get sentences that state a fact and nothing more: no plan, no price, no link. Absent means web, which keeps its existing wording. An unrecognised value is treated like ios and android.
Allowed values:
Request
This endpoint expects an object.
costintegerRequired>=0
Total asset cost ($)
termintegerRequired>=0
Loan term (months)
depositfloatRequired
Deposit amount ($ or %)
brokeragefloatRequired
Brokerage amount ($ or %)
origination_feefloatRequired
Origination fee ($)
advance_arrearsenumRequired
Allowed values:
repayment_frequencyenumRequired
none prices monthly.
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
balloonfloatOptionalDefaults to 0
Balloon/residual payment ($ or %)
balloon_gstbooleanOptionalDefaults to false
balloon_percentagebooleanOptionalDefaults to false
If true, balloon is a percentage
private_salenullable boolean or enumOptional
A yes/no calculator input. true, 1, "1", "true" and "yes" mean yes; false, 0, "0", "false" and "no" mean no; null, "" and "not_sure" mean unanswered, which filters nothing. Strings are case-insensitive. Any other value is rejected with a 400 naming the field.
sale_hire_backnullable boolean or enumOptional
A yes/no calculator input. true, 1, "1", "true" and "yes" mean yes; false, 0, "0", "false" and "no" mean no; null, "" and "not_sure" mean unanswered, which filters nothing. Strings are case-insensitive. Any other value is rejected with a 400 naming the field.
doc_fee_financednullable boolean or enum or enumOptional
Whether the documentation fee is financed. Takes every YesNoFlagInput spelling, plus the rate-card value "both", which narrows to cards set to both rather than meaning unanswered.
asset_ownernullable boolean or enumOptional
Whether the borrower is a home owner
asset_stateenumOptional
Allowed values:
asset_ageinteger or nullOptional>=0
Asset age (months)
asset_age_plus_terminteger or nullOptional>=0
asset_valueinteger or nullOptional
abn_ageinteger or nullOptional>=0
ABN age (months)
abn_years_ageinteger or nullOptional>=0
Whole years the ABN has been registered, with abn_months_age. Not priced (abn_age is); kept with the recent scenario, which reopens from it.
abn_months_ageinteger or nullOptional>=0
gst_ageinteger or nullOptional>=0
GST registration age (months)
gst_years_ageinteger or nullOptional>=0
Whole years registered for GST, with gst_months_age. Not priced (gst_age is); kept with the recent scenario, which reopens from it.
gst_months_ageinteger or nullOptional>=0
credit_scoreinteger or nullOptional>=0
preferred_financierlist of integersOptional
List of preferred organisation (financier) IDs
typeenumOptionalDefaults to commercial
Which calculator to run. Absent means commercial, so payloads written before the consumer calculator keep their behaviour.
Allowed values:
employment_statusenumOptional
Consumer borrower's employment status. Null means not stated.
citizenship_statusenumOptional
Consumer borrower's residency status. Null means not stated.
Allowed values:
lvrfloat or nullOptional
Loan-to-value ratio being asked for, as a percentage of the asset's value. A rate card whose max_lvr sits below this drops out. Omit it to filter on LVR at all — the consumer form pre-fills 100, so a broker who ignores the field still sends 100 explicitly. Deliberately not capped at 100: a consumer deal routinely finances more than the asset is worth once fees are capitalised, and lenders publish cards for exactly that.
bid_overrideboolean or nullOptional
Overrides the broker organisation's BID (broker-introduced deal) status for this run. Tri-state — omit to use the organisation's own setting.
Response
Calculator results
rate_bracket_idintegerOptional
rate_bracket_namestring or nullOptional
product_idintegerOptional
product_namestring or nullOptional
organisation_idintegerOptional
organisation_namestringOptional
maskedbooleanOptional
Present only when the plan sees the cheapest rows in full: false on those, true on the rest.
repayment_minstring or nullOptional
Dollars per repayment, 2 decimal places, e.g. "830.33". Null on a masked row, never 0.
repayment_maxstring or nullOptional
Dollars per repayment, 2 decimal places. Null on a masked row, never 0.
base_minstring or nullOptional
Annual rate as a percentage, 2 decimal places, e.g. "7.95". Null on a masked row, never 0.
base_maxstring or nullOptional
Annual rate as a percentage, 2 decimal places. Null on a masked row, never 0.
basedouble or nullOptional
Annual rate as a fraction, e.g. 0.0795. Null on a masked row, never 0.
e_minstring or nullOptional
Effective annual rate as a percentage, 2 decimal places. Null on a masked row, never 0.
e_maxstring or nullOptional
Effective annual rate as a percentage, 2 decimal places. Null on a masked row, never 0.
r_mindouble or nullOptional
Rate per compounding period, as a fraction. Null on a masked row, never 0.
r_maxdouble or nullOptional
Rate per compounding period, as a fraction. Null on a masked row, never 0.
balloondouble or nullOptional
Dollars; 0 for no balloon. Null on a masked row, never 0.
commissiondouble or nullOptional
Dollars. Null on a masked row, never 0.
pvdouble or nullOptional
Amount financed, dollars. Null on a masked row.
costdoubleOptional
Cost including GST, dollars
depositdoubleOptional
brokeragedoubleOptional
As entered, normalised; a fraction when a percentage, else dollars excluding GST
loaded_brokeragedouble or nullOptional
Brokerage as the product loads it. Null on a masked row.
origination_feedoubleOptional
loaded_origination_feedouble or nullOptional
Origination fee as the product loads it. Null on a masked row.
upfront_feesdouble or nullOptional
Dollars. Null on a masked row.
max_upfront_feesdouble or nullOptional
Set only when whether fees are financed was not answered. Null on a masked row.
monthly_feedouble or nullOptional
Dollars. Null on a masked row.
documentation_feedouble or nullOptional
Dollars. Null on a masked row.
balloon_basisstring or nullOptional
Null on a masked row.
brokerage_basisstring or nullOptional
Null on a masked row.
uplift_min_terminteger or nullOptional
Months. Null on a masked row.
uplift_max_terminteger or nullOptional
Months. Null on a masked row.
product_min_rangeintegerOptional
product_max_rangeintegerOptional
compounding_freqstring or nullOptional
Null on a masked row.
compounding_freq_valueinteger or nullOptional
Compounding periods a year. Null on a masked row.
unresolved_rate_fieldslist of stringsOptional
Request fields a rate depends on that were not answered. Empty on a masked row, which shows no rate.
noi_mindouble or nullOptional
Number of repayments. Null on a masked row.
noi_maxdouble or nullOptional
Number of repayments. Null on a masked row.
billing_typestring or nullOptional
advance_arrears, as sent
repayment_frequencystringOptional
consumer_commissiondouble or nullOptional
Consumer only. Dollars. Null on a masked row, never 0.
flex_stepslist of objects or nullOptional
Consumer only: the rate, repayment and commission at each notch below the quoted rate. Null on a masked row, never 0.
