Assign an uplift to a rate bracket

{
  "id": 1,
  "uplift_name": "string",
  "product_id": 1,
  "rate_bracket_id": 1,
  "fields_name": [
    "string"
  ],
  "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"
}

Idempotent — assigning a bracket that is already assigned succeeds and changes nothing.

An uplift may only be assigned to a bracket whose product belongs to the same organisation. The assignment is classed as an edit, so it captures a rate-card restore point.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Request

This endpoint expects an object.

rate_bracket_idintegerRequired

Response

The uplift, with the assignment applied.

idintegerOptionalRead-only

uplift_namestringOptional<=99 characters

product_idinteger or nullOptional

rate_bracket_idinteger or nullOptional

fields_namelist of strings or nullOptional

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

rate_changefloat or nullOptional

Rate adjustment (positive = increase, negative = decrease)

property_ownership_statusboolean or nullOptional

asset_stateenumOptional

Allowed values:

min_asset_costdouble or nullOptional

max_asset_costdouble or nullOptional

min_asset_ageinteger or nullOptional

max_asset_ageinteger or nullOptional

min_abn_ageinteger or nullOptional

max_abn_ageinteger or nullOptional

min_gst_ageinteger or nullOptional

max_gst_ageinteger or nullOptional

min_terminteger or nullOptional

max_terminteger or nullOptional

min_credit_scoreinteger or nullOptional

max_credit_scoreinteger or nullOptional

min_asset_age_plus_terminteger or nullOptional

max_asset_age_plus_terminteger or nullOptional

private_saleboolean or nullOptional

sale_hire_backboolean or nullOptional

brokerage_loading_treatmentfloat or nullOptional

created_atdatetimeOptionalRead-only

updated_atdatetimeOptionalRead-only

Errors

400

Bad Request Error

404

Not Found Error