Quote Reference Endpoints: GetQuoteStatuses

API endpoints for quote statuses, fuel types, and other reference data

GetQuoteStatuses

Returns the Quotes / Contract "Quote Status" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quotes/getQuoteStatuses

Permissions

This method requires the permission QuoteStatuses:Get.

This permission is not available in Roles / Apis by default, but it can be enabled for you by Catch-e.
If enabled, you can then turn on this permission for your 'web services' role. Visit the process page Edit API permissions for the steps to do this.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/quote-statuses

Parameters (Query Params)

Key	Format	Notes	Mandatory
description	string	Get a Quote Status description. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
active_flag	string	Get only Quote Statuses where the = 'yes'. Available values: yes, no.	No
includeinactiveflag	string	Set to yes if inactive Quote Sub Statuses are required in the list. Available values: yes, no. Default: no.	No
page	number	Optional page number. Default 1 page.	No
page_size	number	Optional page size. Default 25 records per page.	No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetQuoteSubStatuses

Returns the Quotes / Contract "Quote Status" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quotes/getQuoteSubStatuses

Permissions

This method requires the permission QuotesSubStatuses:Get.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/quote-sub-statuses

Parameters (Query Params)

Key	Format	Notes	Mandatory
sub_status	string	Get a Quote Sub Status description. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
parentstatusdescription	string	Get only Quote Sub Statuses linked to a Quote Status. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
includeinactiveflag	string	Set to yes if inactive Quote Sub Statuses are required in the list. Available values: yes, no. Default: no.	No
page	number	Optional page number. Default 1 page.	No
page_size	number	Optional page size. Default 25 records per page.	No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetPowerPlantTypes

Supporting API for patchQuote. Returns a list of Power Plant Types.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Power%20Plant%20Types

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 PowerPlantTypes:Get.

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/qt/power-plant-types

Parameters (Query Params)

Key	Format	Notes	Mandatory
powerplanttype_code	string	This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetFuelTypes

Returns the Quotes / Lease - Fuel Profile) "Fuel Type" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Fuel%20Types/getFuelTypes(https://https://api.catch-e.com/docs/#/Quote%20%2F%20Fuel%20Types/getFuelTypes)

Permissions

This method requires the permission FuelTypes:Get.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/fuel-types

Parameters (Query Params)

Key	Format	Notes	Mandatory
fueltypecode	string	Get fueltypeid for a specific Fuel Type.	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

GetFuelTypeTranslations

Supporting API for patchQuote. Returns a list of Fuel Type Translations.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Fuel%20Types/getFuelTypeTranslations

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 FuelTypeTranslations:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/qt/fuel-type-translations

Parameters (Query Params)

Key	Format	Notes	Mandatory
fueltypeexternal_code	string	This field supports the wildcard % operator (See Wildcard % operator notes below).	No
fueltypecode	string	This field supports the wildcard % operator (See Wildcard % operator notes below).	No
datasourceid	string		No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetVehicleTypes

Supporting API for patchQuote. Returns a list of Vehicle Types.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Vehicle%20Types

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 VehicleTypes:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/qt/vehicle-types

Parameters (Query Params)

Key	Format	Notes	Mandatory
vehicletypecode	string	This field supports the wildcard % operator (See Wildcard % operator notes below).	No
vehicletypedescription	string	This field supports the wildcard % operator (See Wildcard % operator notes below).	No
lctexemptflag	string	yes or no	No
datasourceid	string	See Get a list of variant data sources.	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetVehicleUsageTypes

Supporting API for patchQuote. Returns a list of Usage Type details as seen on the Quotes:Contract tab.

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/#/Quote%20%2F%20Vehicle%20Usage%20Types/getVehicleUsageTypes(https://api.test.catch-e.com/docs/#/Quote%20%2F%20Vehicle%20Usage%20Types/getVehicleUsageTypes)

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 VehicleUsageTypes:Get.

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/vehicle-usage-types

Parameters (Query Params)

Key	Format	Notes	Mandatory
name	string	Get vehicleusagetype_id for the "Usage Type" field. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetDealTypes

Enables you to get a list of the available choices in the Quotes / Contract "Deal Type" drop list.
Visit the Deal Types page for more details.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Deal%20Types/getDealTypes(https://api.catch-e.com/docs/#/Quote%20%2F%20Deal%20Types/getDealTypes)

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 DealTypes:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/qt/deal-types

Parameters - Query

Key	Format	Notes	Default Value	Mandatory
dealtypecode	string	This field supports the wildcard % operator (See Wildcard % operator notes below).		no
dealtypedescription	string	notes		no
page	number	Returns all pages by default. You can limit the results with this input value	1	no
page_size	number	25 results per page are returned by default. You can limit the results with this input value	25	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Response Details

Validation Messages	Comments
200 OK

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/deal-types/?page=1&page_size=1" }, "first": { "href": "https://api.test.catch-e.com/qt/deal-types/?page_size=1" }, "last": { "href": "https://api.test.catch-e.com/qt/deal-types/?page=5&page_size=1" }, "next": { "href": "https://api.test.catch-e.com/qt/deal-types/?page=2&page_size=1" } }, "_embedded": { "qt_deal_types": [ { "deal_type_id": "100000", "deal_type_code": "SALES", "deal_type_description": "Sales Team", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/deal-types/100000" } } } ] }, "page_count": 5, "page_size": 1, "total_items": 5, "page": 1}

|"detail": "Forbidden"

| You do not have permissions for this request. |

GetDiscountTypes

Returns the Quotes / Vehicle "Discount Status" field list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Discount%20Types/getDiscountTypes

Permissions

This method requires the permission DiscountTypes:Get..

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/discount-types

Parameters (Query Params)

Key	Format	Notes	Mandatory
name	string	Get walkawayplanid using the plan name. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.