PatchQuoteEventList

PatchQuoteEventList

Permits you to edit multiple Quote Events.

Permissions

To run this API, the nominated 'web-services' role needs permission.

If not actively using, leave off for better security.

Go to Roles / APIs and check on QuoteEvents:Update.

Authentication

Authenticate with the API before running this API.

HTTP Method

PATCH

URL

https://api.catch-e.com/qt/quote-events/

Body (JSON)

Array of quote event objects. Each object contains:

Field

Format

Notes

Mandatory

quote_event_id

string

Quote Event ID

Yes

quote_id

string

Quote ID

Yes

quote_event_code_id

string

Event Code ID

Yes

event_date

string

Event Date

Yes

event_amount

string

Event Amount

No

attachment_id

string

Link Quote Event to Attachment ID

No

quote_event_action_id

string

Event Action ID

Yes

due_date

string

Due Date

No

completed_flag

string

Completed Flag (values: yes, no)

No

user_id_edit

string

Last Edit By (User ID)

No

last_edit

string

Last Edit timestamp

No

status_flag

string

Event Status (values: active, deleted)

No

description

string

Event description

No

Input Example

[ { "quote_event_id": "100096", "quote_id": "132580", "quote_event_code_id": "100001", "event_date": "2022-11-09", "description": "Re-Test#2: Event Code: Notes (API)", "event_amount": "1.02", "quote_event_action_id": "100001", "due_date": "2022-11-11", "completed_flag": "yes", "status_flag": "active" }, { "quote_event_id": "100097", "quote_id": "132580", "quote_event_code_id": "100000", "event_date": "2022-11-08", "description": "Re-Test#3: Event Code: Dealer Pricing (API)", "event_amount": "1.01", "quote_event_action_id": "100000", "due_date": "2022-11-10", "completed_flag": "no", "status_flag": "active" } ]

Response - 200 OK

{ "_links": { "self": { "href": "https://api.catch-e.com/qt/quote-events/" } }, "_embedded": { "qt_quote_events": [ { "quote_event_id": "100096", "quote_id": "132580", "quote_event_code_id": "100001", "event_date": "2022-11-09", "description": "Re-Test#2: Event Code: Notes (API)", "event_amount": 1.02, "quote_event_action_id": "100001", "due_date": "2022-11-11", "completed_flag": "yes", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-13 23:28:59", "status_flag": "active", "_links": { "self": { "href": "https://api.catch-e.com/qt/quote-events/100096" } }, "_embedded": { "quote_event_code": { "quote_event_code_id": "100001", "quote_event_code": "Notes", "name": "Notes", "description": "Quote Note", "template_id": "0", "status_flag": "active" }, "quote_event_action": { "quote_event_action_id": "100001", "name": "Request Docs" } } }, { "quote_event_id": "100097", "quote_id": "132580", "quote_event_code_id": "100000", "event_date": "2022-11-08", "description": "Re-Test#3: Event Code: Dealer Pricing (API)", "event_amount": 1.01, "quote_event_action_id": "100000", "due_date": "2022-11-10", "completed_flag": "no", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-13 23:28:59", "status_flag": "active", "_links": { "self": { "href": "https://api.catch-e.com/qt/quote-events/100097" } }, "_embedded": { "quote_event_code": { "quote_event_code_id": "100000", "quote_event_code": "Dealer", "name": "Dealer Pricing", "description": "Dealer Pricing Attached", "template_id": "0", "status_flag": "active" }, "quote_event_action": { "quote_event_action_id": "100000", "name": "Follow Up" } } } ] }, "total_items": 2 }

Successful request.

Response - 401 Unauthorized

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

You have not authenticated or your token_timeout has passed. Authenticate again.

Response - 403 Forbidden

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

Response - 422 Unprocessable Entity

{ "validation_messages": [ { "attachment_id": { "noRecordFound": "No record matching the input was found" } } ], "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Attachment ID not found/valid.

PatchQuoteEvents

Permits you to edit a single Quote Event.

Permissions

To run this API, the nominated 'web-services' role needs permission.

If not actively using, leave off for better security.

Go to Roles / APIs and check on QuoteEvents:Update.

Authentication

Authenticate with the API before running this API.

HTTP Method

PATCH

URL

https://api.catch-e.com/qt/quote-events/{quote_event_id}

Body (JSON)

Field

Format

Notes

Mandatory

quote_id

string

Quote ID

Yes

quote_event_code_id

string

Event Code ID

Yes

event_date

string

Event Date

Yes

event_amount

string

Event Amount

No

attachment_id

string

Link Quote Event to Attachment ID

No

quote_event_action_id

string

Event Action ID

Yes

due_date

string

Due Date

No

completed_flag

string

Completed Flag (values: yes, no)

No

user_id_edit

string

Last Edit By (User ID)

No

last_edit

string

Last Edit timestamp

No

status_flag

string

Event Status (values: active, deleted)

No

description

string

Event description

No

Input Example

{ "quote_id": "132580", "quote_event_code_id": "100000", "event_date": "2022-11-08", "description": "Event Code: Dealer Pricing (API)", "event_amount": "1.01", "quote_event_action_id": "100000", "due_date": "2022-11-10", "completed_flag": "no", "status_flag": "active" }

Response - 200 OK

{ "quote_event_id": "100095", "quote_id": "132580", "quote_event_code_id": "100000", "event_date": "2022-11-08", "description": "Re-Test#1: Event Code: Dealer Pricing (API) Edited via patchQuoteEvent", "event_amount": 1.03, "quote_event_action_id": "100000", "due_date": "2022-11-10", "completed_flag": "yes", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-14 01:10:43", "status_flag": "active", "_links": { "self": { "href": "https://api.catch-e.com/qt/quote-events/100095" } }, "_embedded": { "quote_event_code": { "quote_event_code_id": "100000", "quote_event_code": "Dealer", "name": "Dealer Pricing", "description": "Dealer Pricing Attached", "template_id": "0", "status_flag": "active" }, "quote_event_action": { "quote_event_action_id": "100000", "name": "Follow Up" } } }

Successful request.

Response - 401 Unauthorized

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

You have not authenticated or your token_timeout has passed. Authenticate again.

Response - 403 Forbidden

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

Response - 422 Unprocessable Entity

{ "validation_messages": [ { "attachment_id": { "noRecordFound": "No record matching the input was found" } } ], "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Attachment ID not found/valid.

PatchQuote - Contract Tab

Fields found primarily on Quotes / Contract tab. Not all fields supported yet. If field listed here, it is supported.

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

Contract Section

Field

Format

Notes

Mandatory

date

date

Updates Effective Date

No

quote_date

date

Quote Date

No

duration

number

Valid for duration days

No

quote_status_id

listbox

Updates Quote Status

No

competitor_id

number

Competitor

No

competitor_margin_id

number

Lost by

No

deal_type_id

listbox

Updates Deal Type

No

posting_map_id

number

Updates Type Code. Note: will not auto-update when changing client_id; must include in payload.

No

term

number

Updates Term (Months)

No

contract_kms / annual_kms

string

Updates Contract KMs or Annual KMs. Global Control (qt) contractkmasannualflag determines display. Do not include both; if both included, annual_kms ignored.

No

state

string

Delivery State

No

location_name

string

Updates Location

No

location_registration_id

number

Location Rego

No

vehicle_usage_type_id

number

Usage Type

No

vehicle_tracking_system_flag

checkbox

Updates Vehicle Tracking System flag

No

parent_quote_id

number

Updates Parent Quote ID

No

opportunity_id

string

Updates Opportunity ID

No

opportunity_number

string

Updates Opportunity No

No

opportunity_stage_id

string

Updates Opportunity Stage

No

lock_quote_flag

string

Updates Lock Quote checkbox

No

Client Details Section

Field

Format

Notes

Mandatory

client_id

number

Client Code. Note: will not auto-update posting_map_id; must include in payload.

No

client_group_flag

string

Group

No

client_name

string

Updates Client Name (on Quote only, not Client record)

No

client_contact_name

string

Updates Contact Name (on Quote only)

No

client_email

string

Updates Email (on Quote only)

No

client_phone

string

Updates Phone (on Quote only)

No

client_fax

string

Updates Fax (on Quote only)

No

user_id_client_manager

listbox

Updates A/C Manager (on Quote only)

No

Inclusions Section

Field

Format

Notes

Mandatory

excess_km_flag

string

Excess KM Charge

No

redundancy_insurance_flag

string

Updates Redundancy Insurance checkbox

No

gap_insurance_flag

string

Gap Insurance. Do not include to leave as-is. Set to 'yes' to include, 'no' to exclude. See Gap Insurance rules.

No

after_hours_assistance_flag

string

After Hours Assistance

No

relief_vehicle_flag

string

Updates Relief Vehicle checkbox

No

comments

string

Updates Quote Comments

No

comments_internal

string

Populate Internal Comments from Quote Internal Note

No

Driver Details Section

Field

Format

Notes

Mandatory

driver_id

number

Driver ID

No

driver_surname

string

Updates Surname (on Quote only)

No

driver_given_name

string

Updates Given Name (on Quote only)

No

driver_email

string

Updates Email (on Quote only)

No

driver_phone

string

Updates Phone (on Quote only)

No

driver_fax

string

Updates Fax (on Quote only)

No

pay_cycle_id

string

Updates Pay Cycle. Use getPayCycles to find pay_cycle_id.

No

annual_salary

number

Updates Salary

No

allowances

number

Allowances

No

superannuation

number

Superannuation

No

reduced_super_flag

string

Reduced Super

No

ato_loan_flag

string

HELP Debt

No

pre_tax_existing

number

Pre Tax

No

post_tax_existing

number

Post Tax

No

packaging_advice_fee

number

Advice Fee

No

packaging_admin_fee

number

Packaging Admin Fee

No

employer_fbt_type

string

Updates Employer FBT Type. See Employer FBT Type for validation.

No

fbt_benefit_type

string

Updates FBT Type. See FBT Type for validation.

No

fbt_business_use

number

Updates Bus. Use%

No

ecm_flag

string

Updates Use ECM? flag

No

previous_lease_start

date

Updates Previous Lease Start

No

previous_fbt_value

number

Updates Previous FBT Value

No

user_id_assigned

listbox

Updates Assigned user

No

Validations and Alerts

Alert

Notes

Term must be greater than Months Deferred

Input not between 1 and 120 inclusively

PatchQuote - Events Tab

Fields found primarily on Quotes / Events tab. Not all fields supported yet.

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

Note: No fields currently supported on Events tab.

PatchQuote - Finance Tab

Fields found on Quotes / Finance tab. Not all fields supported yet.

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

Financier (Column One)

Field

Format

Notes

Mandatory

finance_type_id

listbox

Updates Finance Type

No

base_rate

number

Updates Base Rate. Example: for 10.50%, use "0.1050"

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 Trade in Gross in UI)

No

trade_in_amount_gst

number

Updates Trade in GST

No

claimable_gst

number

Updates GST Claimable

No

Broker (Column Two)

Field

Format

Notes

Mandatory

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)

Field

Format

Notes

Mandatory

residual_net

number

Updates Residual Exc GST. Residual GST and Residual Inc GST auto-calculated.

No

Finance Application

Field

Format

Notes

Mandatory

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