getListChannelQuoteDefaults

Overview

This method returns the quote defaults for a specified channel.

This method requires the ChannelQuoteDefaults:Get permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ChannelQuoteDefaults:Get'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/qt/channel/defaults https://api.{{environment}}.catch-e.com/qt/channel/defaults https://api.test.catch-e.com/qt/channel/defaults

Query Parameters

Key	Format	Notes	Mandatory
channel_id	string	The channel to return quote defaults for. A positive whole number, up to 10 digits, with no leading zeros.	Yes
page	integer	Page number. Default `1`.	No
page_size	integer	Number of records per page. Default `25`. Use `-1` to return all records.	No

Response Details

Success

200 - OK

Field	Format	Notes
channel_default_id	string	Channel default id.
channel_id	string	Channel id.
novated_management_fee	number (double)	Novated management fees.
operating_management_fee	number (double)	Operating management fees.
supplier_id_financier	string	Financier.
novated_commission_rate	number (double)	Novated commission rate.
contract_pay_cycle_from_quote_flag	string	Values: `yes`, `no`.
finance_budget_term_deferred_flag	string	Values: `yes`, `no`.
periods_deferred	integer (int32)	From 0 to 99.
report_finance_payments_flag	string	Values: `yes`, `no`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/qt/channel/defaults/1234" }, "channel": { "href": "https://api.catch-e.loc/fm/channels/56" } }, "channel_default_id": "1234", "channel_id": "56", "novated_management_fee": 150.0, "operating_management_fee": 120.0, "supplier_id_financier": "78", "novated_commission_rate": 1.25, "contract_pay_cycle_from_quote_flag": "no", "finance_budget_term_deferred_flag": "no", "periods_deferred": 0, "report_finance_payments_flag": "no" }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

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

Validation Message	Comments
403 - 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.

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

Validation Message	Comments
404 - Not Found	No quote defaults were found for the channel.

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

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

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

Validation Message	Comments
409 - Conflict	The request conflicts with the current state of the data.

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

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

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

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

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