Update Quote Endpoints: PatchQuoteEventList

API endpoints for patching and updating quotes

PatchQuoteEventList

This API permits you to edit multiple Quote Events.

Permissions

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

If you are not actively using the API, leave the permission off for better security.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'PATCH' for consuming this web service.

URL Examples

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

Body (JSON)

Key	Format	Notes	Mandatory
quoteeventid	string	Quote Event ID	Yes
quote_id	string	Quote ID	Yes
quoteeventcode_id	string	Event Code ID	Yes
event_date	string	Event Date	Yes
event_amount	string	Event Amount	No
attachment_id	string	Link a Quote Event to an Attachment ID.	No
quoteeventaction_id	string	Event Action ID	Yes
due_date	string	Due Date	No
completed_flag	string	Completed Flag ('yes','no')	No
useridedit	string	Last Edit By (User ID)	No
last_edit	string	Last Edit timestamp	No
status_flag	string	Event Status ('active','deleted')	No

JSON Sample

[ { "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": "0", "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", //"attachment_id": "0", "status_flag": "active" }]

Response Details

Validation Messages	Comments
200 OK

{ "_links": { "self": { "href": "https://api.test.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.test.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.test.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}

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

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

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

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 422 - Unprocessable Content | | |

{ "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

This API permits you to edit a Quote Event.

Permissions

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

If you are not actively using the API, leave the permission off for better security.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'PATCH' for consuming this web service.

URL Examples

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

Body (JSON)

Key	Format	Notes	Mandatory
quote_id	string	Quote ID	Yes
quoteeventcode_id	string	Event Code ID	Yes
event_date	string	Event Date	Yes
event_amount	string	Event Amount	No
attachment_id	string	Link a Quote Event to an Attachment ID.	No
quoteeventaction_id	string	Event Action ID	Yes
due_date	string	Due Date	No
completed_flag	string	Completed Flag ('yes','no')	No
useridedit	string	Last Edit By (User ID)	No
last_edit	string	Last Edit timestamp	No
status_flag	string	Event Status ('active','deleted')	No

JSON Sample

 { "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 Details

Validation Messages	Comments
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.test.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" } }}

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

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

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

{ "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

The fields listed on this page are all found primarily on the Quotes / Contract 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
Contract
date	date	Updates the Effective Date.	No
quote_date	date	Quote Date	No
duration	number	Valid for {duration} days	No
quotestatusid	listbox	Updates the Quote Status	No
competitor_id	number	Competitor	No
competitormarginid	number	Lost by	No
dealtypeid	listbox	Updates the Deal Type	No
postingmapid	number	Update the Quotes / Contract “Type Code” field. This field will not automatically update when changing clientid. To update the postingmap_id you must include it in your payload.	No
term	number	Updates the Term (Months)	No
contractkms or annualkms	string	Updates the Contract KMs or Annual KMs respectively. The Global Control (qt) 'contractkmasannualflag determines if the "Contract KMs" is displayed as "Annual KMs" (and subsequently recalculated and stored as . You would not typically include both contractkms & annualkms in your patchQuote payload request. If you do, 'annual_kms' will be ignored.	No
state	string	Delivery State	No
location_name	string	Updates the Location	No
locationregistrationid	number	Location Rego	No
vehicleusagetype_id	number	Usage Type	No
vehicletrackingsystem_flag	checkbox	Updates the Vehicle Tracking System flag	No
parentquoteid	number	Updates the Parent Quote ID	No
opportunity_id	string	Updates the Opportunity ID	No
opportunity_number	string	Updates the Opportunity No	No
opportunitystageid	string	Updates the Opportunity Stage (hidden field)	No
lockquoteflag	string	Updates the Lock Quote checkbox	No
Client Details
client_id	number	Client Code. This field will not automatically update the postingmapid when changing clientid. To update the postingmap_id you must include it in your payload.	No
clientgroupflag	string	Group	No
client_name	string	Updates the Client Name (on the Quote. This does not update the Client Name).	No
clientcontactname	string	Updates the Contact Name (on the Quote. This does not update the Contact Name).	No
client_email	string	Updates the Email (on the Quote. This does not update the Client Email).	No
client_phone	string	Updates the Phone (on the Quote. This does not update the Client Phone).	No
client_fax	string	Updates the Fax (on the Quote. This does not update the Client Fax).	No
useridclient_manager	listbox	Updates the A/C Manager (on the Quote. This does not update the Client A/C Manager).	No
Inclusions
excesskmflag	string	Excess KM Charge	No
redundancyinsuranceflag	string	Updates the Redundancy Insurance checkbox	No
gapinsuranceflag	string	Gap Insurance. To leave the Gap Insurance profile as is, do not include this JSON content at all. Set to 'yes' when you want to include "Gap Insurance" in your Quote. Visit the Gap Insurance page to review the rules that are applied. Set to 'no' to turn the "Gap Insurance" flag off.	No
afterhoursassistance_flag	string	After Hours Assistance	No
reliefvehicleflag	string	Updates the Relief Vehicle checkbox	No
comments	string	Updates the Quote Comments	No
comments_internal	string	Populate Internal Comments field from Quote Internal Note	No
Driver Details
driver_id	number	Driver ID	No
driver_surname	string	Updates the Surname (on the Quote. This does not update the Driver Surname).	No
drivergivenname	string	Updates the Given Name (on the Quote. This does not update the Driver Given Name).	No
driver_email	string	Updates the Email (on the Quote. This does not update the Driver Email).	No
driver_phone	string	Updates the Phone (on the Quote. This does not update the Driver Phone).	No
paycycleid	string	Updates the Pay Cycle. To find paycycleid use getPayCycles.	No
annual_salary	number	Updates the Salary	No
allowances	number	Allowances	No
superannuation	number	Superannuation	No
reducedsuperflag	string	Reduced Super	No
atoloanflag	string	HELP Debt	No
pretaxexisting	number	Pre Tax	No
posttaxexisting	number	Post Tax	No
packagingadvicefee	number	Advice Fee	No
packagingadminfee	number	Packaging Admin Fee	No
driver_fax	string	Updates the Fax (on the Quote. This does not update the Driver Fax).	No
employerfbttype	string	Updates the (Quote) Employer FBT Type. Please see Employer FBT Type for validation rules for this field.	No
fbtbenefittype	string	Updates the FBT Type. See FBT Type for validation rules.	No
fbtbusinessuse	number	Updates the Bus. Use%	No
ecm_flag	string	Updates the Use ECM? flag	No
previousleasestart	date	Updates the Previous Lease Start	No
previousfbtvalue	number	Updates the Previous FBT Value	No
useridassigned	listbox	Updates the Assigned user	No

Validations and Alerts

Alert
Term must be greater than Months Deferred
The input is not between '1' and '120' inclusively

PatchQuote - Events tab

The fields listed on this page are all found primarily on the Quotes:Events 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
Column 1
No fields are currently supported on this screen.

PatchQuote - Finance tab

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)
financetypeid	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.	No
deposit_net	number	Updates the Deposit Net (shown as a calculated Deposit Gross in UI)	No
deposit_gst	number	Updates the Deposit GST	No
tradeinreg_no	string	Updates the Trade in Registration	No
tradeinamount_net	number	Updates the Trade in Gross (shown as a calculated Trade in Gross in UI)	No
tradeinamount_gst	number	Updates the Trade in GST	No
claimable_gst	number	Updates the GST Claimable	No
Broker (Column Two)
commission_rate	number	Updates the Commission Rate	No
commission	number	Updates the Commission Fee	No
establishment_fee	number	Updates the Establishment / Admin Fee	No
originator_fee	number	Updates the Originator Fee	No
Residual (Column Three)
residual_net	number	Updates the Residual Exc GST. Residual GST and Residual Inc GST will be auto calculated.	No
Finance Application
originator_id	string	Updates the Originator (if configured)	No
application_reference	string	Updates the Application Reference	No
application_date	timestamp	Updates the Application Date	No
applicationstatusflag	listbox	Updates the Status	No