patchQuote - Finance Tab

Overview

The fields listed on this page are all found on the Quotes / Finance tab.
Note: Not all fields are supported yet. If a field is listed below it is supported.
Refer to main page for full details of patchQuote functionality.

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quotes/patchQuote

Body - JSON

JSON Field

Format

Notes

Mandatory

Financier

(Column One)

finance_type_id

listbox

Updates the Finance Type

No

base_rate

number

Updates the Base Rate. Example: To update Base Rate to 10.50% use "0.1050" in payload. If lock_base_rate_flag = 'yes', the base_rate will not be recalculated and a 422 error "Base rate is locked" is returned.

No

client_margin

number

Calculates the Client Margin. If [gb_controls]client_margin_allow_negative_flag = 'no', negative values return 422 error "Client Margin must be 0 or a positive number."

No

lock_base_rate_flag

string

Set 'yes' to lock the Base Rate (default 'no'). Prevents recalculation and triggers alert. Note: Ignored in Catch-e UI until DEV-22363 is completed.

No

deposit_net

number

Updates Deposit Net (shown as calculated Deposit Gross in UI)

No

deposit_gst

number

Updates Deposit GST

No

trade_in_reg_no

string

Updates Trade-in Registration

No

trade_in_amount_net

number

Updates Trade-in Net (shown as calculated Gross in UI)

No

trade_in_amount_gst

number

Updates Trade-in GST

No

claimable_gst

number

Updates GST Claimable

No

Broker (Column Two)

commission_rate

number

Updates Commission Rate

No

commission

number

Updates Commission Fee

No

establishment_fee

number

Updates Establishment / Admin Fee

No

originator_fee

number

Updates Originator Fee

No

Residual

(Column Three)

residual_net

number

Updates Residual (Excl GST). Residual GST and Residual Incl GST are auto-calculated.

No

Finance Application

originator_id

string

Updates Originator (if configured)

No

application_reference

string

Updates Application Reference

No

application_date

timestamp

Updates Application Date

No

application_status_flag

listbox

Updates Status

No