List uplifts | Finput Docs

[
  {
    "id": 1,
    "uplift_name": "uplift_name",
    "product_id": 1,
    "rate_bracket_id": 1,
    "fields_name": [
      "fields_name"
    ],
    "rate_change": 1.1,
    "property_ownership_status": true,
    "asset_state": "none",
    "min_asset_cost": 1.1,
    "max_asset_cost": 1.1,
    "min_asset_age": 1,
    "max_asset_age": 1,
    "min_abn_age": 1,
    "max_abn_age": 1,
    "min_gst_age": 1,
    "max_gst_age": 1,
    "min_term": 1,
    "max_term": 1,
    "min_credit_score": 1,
    "max_credit_score": 1,
    "min_asset_age_plus_term": 1,
    "max_asset_age_plus_term": 1,
    "private_sale": true,
    "sale_hire_back": true,
    "brokerage_loading_treatment": 1.1,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
]

Returns uplifts filtered by product and rate bracket.

Authentication

AuthorizationBearer

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

Query parameters

product_idintegerOptional

Filter by product ID

rate_bracket_idintegerOptional

Filter by rate bracket ID

Response

List of uplifts

idintegerOptional

uplift_namestringOptional

product_idintegerOptional

rate_bracket_idintegerOptional

fields_namelist of stringsOptional

List of field names this uplift applies to (max 15)

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

Rate adjustment (positive = increase, negative = decrease)

property_ownership_statusbooleanOptionalDefaults to false

asset_stateenumOptional

min_asset_costdoubleOptional

max_asset_costdoubleOptional

min_asset_ageintegerOptional

max_asset_ageintegerOptional

min_abn_ageintegerOptional

max_abn_ageintegerOptional

min_gst_ageintegerOptional

max_gst_ageintegerOptional

min_termintegerOptional

max_termintegerOptional

min_credit_scoreintegerOptional

max_credit_scoreintegerOptional

min_asset_age_plus_termintegerOptional

max_asset_age_plus_termintegerOptional

private_salebooleanOptionalDefaults to false

sale_hire_backbooleanOptionalDefaults to false

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

created_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

updated_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

$	curl https://api.finput.com.au/api/v1/uplifts \
>	-H "Authorization: Bearer <token>"