List products | Finput Docs

[
  {
    "id": 1,
    "product_name": "string",
    "organisation_id": 1,
    "min_range": 1,
    "max_range": 1,
    "min_amount": 1.1,
    "max_amount": 1.1,
    "min_abn_age": 1,
    "max_abn_age": 1,
    "min_asset_age": 1,
    "max_asset_age": 1,
    "min_gst_age": 1,
    "max_gst_age": 1,
    "min_asset_age_plus_term": 1,
    "max_asset_age_plus_term": 1,
    "min_credit_score": 1,
    "max_credit_score": 1,
    "monthly_fee": 1.1,
    "documentation_fee": 1.1,
    "brokerage_cap": 1.1,
    "maximum_brokerage_limit": 1.1,
    "compounding_frequency": "w",
    "brokerage_loading_treatment": 1.1,
    "max_origination_fee_limit": 1.1,
    "doc_fee_financed": "yes",
    "private_sale": "yes",
    "sale_hire_back": "yes",
    "home_owner": "yes",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
]

Returns all products, optionally filtered by organisation.

Authentication

AuthorizationBearer

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

Query parameters

organisation_idintegerOptional

Filter products by organisation ID

Response

List of products

idintegerOptionalRead-only

product_namestringOptional<=99 characters

organisation_idinteger or nullOptional

ID of the owning organisation

min_rangeinteger or nullOptional

Minimum loan term (months)

max_rangeinteger or nullOptional

Maximum loan term (months)

min_amountfloat or nullOptional

Minimum loan amount ($)

max_amountfloat or nullOptional

Maximum loan amount ($)

min_abn_ageinteger or nullOptional

Minimum ABN age (months)

max_abn_ageinteger or nullOptional

min_asset_ageinteger or nullOptional

Minimum asset age (months)

max_asset_ageinteger or nullOptional

min_gst_ageinteger or nullOptional

Minimum GST registration age (months)

max_gst_ageinteger or nullOptional

min_asset_age_plus_terminteger or nullOptional

max_asset_age_plus_terminteger or nullOptional

min_credit_scoreinteger or nullOptional

max_credit_scoreinteger or nullOptional

monthly_feefloat or nullOptional

documentation_feefloat or nullOptional

brokerage_capfloat or nullOptional

Maximum brokerage percentage

maximum_brokerage_limitfloat or nullOptional

Maximum brokerage dollar amount

compounding_frequencyenumOptional

Compounding frequency:

w - Weekly
m - Monthly
q - Quarterly
y - Yearly

Allowed values:

brokerage_loading_treatmentfloat or nullOptional

max_origination_fee_limitfloat or nullOptional

doc_fee_financedenumOptional

Tri-state choice for product/rate bracket feature flags

Allowed values:

private_saleenumOptional

Tri-state choice for product/rate bracket feature flags

Allowed values:

sale_hire_backenumOptional

Tri-state choice for product/rate bracket feature flags

Allowed values:

home_ownerenumOptional

Tri-state choice for product/rate bracket feature flags

Allowed values:

created_atdatetimeOptionalRead-only

updated_atdatetimeOptionalRead-only