Create Quote Endpoints: CreateQuoteEvents

CreateQuoteEvents

This API permits you to create one or 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:Create.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

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

Body (JSON)

JSON Sample

Single Quote Event

[ { "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" }]

Multiple Quote Events

[ { "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" }, { "quote_id": "132580", "quote_event_code_id": "100001", "event_date": "2022-11-09", "description": "Event Code: Notes (API)", "event_amount": "1.02", "quote_event_action_id": "100001", "due_date": "2022-11-11", "completed_flag": "yes", "status_flag": "active" }]

Response Details

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-events/" } }, "_embedded": { "qt_quote_events": [ { "quote_event_id": "100098", "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", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-14 00:48:01", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-events/100098" } }, "_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": 1}

| The request was successful request. |
| 401 - Unauthorized | | |

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