createChannelQuoteDefaults

Overview

This method creates a new set of quote defaults for a channel.

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

Permissions

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

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

HTTP Method

Use the HTTP Method 'POST' 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

Input Fields (JSON)

Fields not supplied are set to their default values.

Key	Format	Notes	Mandatory
channel_id	string	Channel id. Default `0`.	Yes
novated_management_fee	number (double)	Novated management fees. Up to 2 decimal places. Default `0`.	No
operating_management_fee	number (double)	Operating management fees. Up to 2 decimal places. Default `0`.	No
supplier_id_financier	string	Financier. Default `0`.	No
novated_commission_rate	number (double)	Novated commission rate. Up to 4 decimal places. Default `0`.	No
contract_pay_cycle_from_quote_flag	string	Allowed values: `yes`, `no`. Default `no`.	No
finance_budget_term_deferred_flag	string	Allowed values: `yes`, `no`. Default `no`.	No
periods_deferred	integer (int32)	From 0 to 99. Default `0`.	No
report_finance_payments_flag	string	Allowed values: `yes`, `no`. Default `no`.	No

Example

{ "channel_id": "56", "novated_management_fee": 150.0, "operating_management_fee": 120.0, "supplier_id_financier": "78", "novated_commission_rate": 1.25 }

Response Details

Success

201 - Created

Returns the new channel quote defaults.

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
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
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

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

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

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