Skip to navigation
EndpointsApprovals

Create an approval

Financier admins and members author their own organisation’s approvals.

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Request

This endpoint expects an object.
namestringRequired<=99 characters
doc_levelenumRequired

Documentation burden. Results sort least-onerous first.

Allowed values:
organisation_idintegerOptional
Owning financier. Set from the caller.
priorityfloatOptionalDefaults to 0

Ordering within a financier's group — higher sorts first, so a financier decides which of their approvals is the headline row.

min_deposit_percentagestring or nullOptional
min_deposit_amountstring or nullOptional
max_terminteger or nullOptional

Longest term (months) this approval will write. Does two jobs: it is shown on the Matrix result row, and it is the upper bound a supplied term is tested against.

min_terminteger or nullOptional

Shortest term (months) this approval will write. Criterion only — unlike max_term it is not shown on the result row.

min_abn_ageinteger or nullOptional
Months.
max_abn_ageinteger or nullOptional
min_gst_ageinteger or nullOptional
Months.
max_gst_ageinteger or nullOptional
min_asset_ageinteger or nullOptional
Months.
max_asset_ageinteger or nullOptional
min_asset_coststring or nullOptional

GST-inclusive dollars.

max_asset_coststring or nullOptional
min_borrower_ageinteger or nullOptional

Years — brokers state borrower age in years, not months.

max_borrower_ageinteger or nullOptional
min_file_ageinteger or nullOptional

Credit-file age in months.

max_file_ageinteger or nullOptional
min_credit_scoreinteger or nullOptional

Credit score floor. Distinct from credit-file age.

max_credit_scoreinteger or nullOptional
home_ownerboolean or nullOptional

Tri-state — null is "not checked", true/false must match.

private_saleboolean or nullOptional
sale_hire_backboolean or nullOptional
asset_stateenumOptional
Allowed values:
transaction_typeslist of enumsOptional
Empty means every transaction type.
Allowed values:
industrieslist of stringsOptional
ANZSIC divisions. Empty means every industry.
asset_idslist of integersOptional
Assets this approval covers. Empty means all. A member matches itself and everything beneath it in the asset tree, so financiers author against categories while brokers submit leaves.
rate_bracket_idslist of integersOptional

Response

Created
namestring<=99 characters
doc_levelenum

Documentation burden. Results sort least-onerous first.

Allowed values:
idintegerOptionalRead-only
organisation_idintegerOptional
Owning financier. Set from the caller.
priorityfloatOptionalDefaults to 0

Ordering within a financier's group — higher sorts first, so a financier decides which of their approvals is the headline row.

min_deposit_percentagestring or nullOptional
min_deposit_amountstring or nullOptional
max_terminteger or nullOptional

Longest term (months) this approval will write. Does two jobs: it is shown on the Matrix result row, and it is the upper bound a supplied term is tested against.

min_terminteger or nullOptional

Shortest term (months) this approval will write. Criterion only — unlike max_term it is not shown on the result row.

min_abn_ageinteger or nullOptional
Months.
max_abn_ageinteger or nullOptional
min_gst_ageinteger or nullOptional
Months.
max_gst_ageinteger or nullOptional
min_asset_ageinteger or nullOptional
Months.
max_asset_ageinteger or nullOptional
min_asset_coststring or nullOptional

GST-inclusive dollars.

max_asset_coststring or nullOptional
min_borrower_ageinteger or nullOptional

Years — brokers state borrower age in years, not months.

max_borrower_ageinteger or nullOptional
min_file_ageinteger or nullOptional

Credit-file age in months.

max_file_ageinteger or nullOptional
min_credit_scoreinteger or nullOptional

Credit score floor. Distinct from credit-file age.

max_credit_scoreinteger or nullOptional
home_ownerboolean or nullOptional

Tri-state — null is "not checked", true/false must match.

private_saleboolean or nullOptional
sale_hire_backboolean or nullOptional
asset_stateenumOptional
Allowed values:
transaction_typeslist of enumsOptional
Empty means every transaction type.
Allowed values:
industrieslist of stringsOptional
ANZSIC divisions. Empty means every industry.
assetslist of integersOptionalRead-only

Errors

400
Bad Request Error
403
Forbidden Error