GetQuoteStatuses

GetQuoteStatuses

Returns the Quotes / Contract "Quote Status" list. Use this selection in patchQuote.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/getQuoteStatuses

Permissions

Requires permission QuoteStatuses:Get. Not available in Roles / APIs by default, but can be enabled by Catch-e. Once enabled, turn on for your 'web_services' role via Edit API permissions process.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

description

string

Get Quote Status description. Supports wildcard % operator (See Wildcard % operator notes below)

No

active_flag

string

Get only Quote Statuses where active_flag = 'yes'. Values: yes, no

No

include_inactive_flag

string

Set to 'yes' for inactive Quote Sub Statuses in list. Values: yes, no. Default: no

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetQuoteSubStatuses

Returns the Quotes / Contract "Quote Sub Status" list. Use this selection in patchQuote.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/getQuoteSubStatuses

Permissions

Requires permission QuoteSubStatuses:Get. Not available in Roles / APIs by default, but can be enabled by Catch-e. Once enabled, turn on for your 'web_services' role via Edit API permissions process.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

sub_status

string

Get Quote Sub Status description. Supports wildcard % operator (See Wildcard % operator notes below)

No

parent_status_description

string

Get only Quote Sub Statuses linked to Quote Status. Supports wildcard % operator (See Wildcard % operator notes below)

No

include_inactive_flag

string

Set to 'yes' for inactive Quote Sub Statuses in list. Values: yes, no. Default: no

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetPowerPlantTypes

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

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

Permissions

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

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

power_plant_type_code

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetFuelTypes

Returns the Quotes / Lease "Fuel Profile" Fuel Type list. Use this selection in patchQuote.

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

Permissions

Requires permission FuelTypes:Get. Not available in Roles / APIs by default, but can be enabled by Catch-e. Once enabled, turn on for your 'web_services' role via Edit API permissions process.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

fuel_type_code

string

Get fuel_type_id for specific Fuel Type

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

GetFuelTypeTranslations

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

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

Permissions

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

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

fuel_type_external_code

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

fuel_type_code

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

data_source_id

string

Data source ID

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetVehicleTypes

Supporting API for patchQuote. Returns list of Vehicle Types.

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

Permissions

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

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

vehicle_type_code

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

vehicle_type_description

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

lct_exempt_flag

string

Values: yes, no

No

data_source_id

string

See Get a list of variant data sources

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetVehicleUsageTypes

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

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/#/Quote%20%2F%20Vehicle%20Usage%20Types/getVehicleUsageTypes

Permissions

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

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

name

string

Get vehicle_usage_type_id for Usage Type field. Supports wildcard % operator (See Wildcard % operator notes below)

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetDealTypes

Enables you to get list of available choices in Quotes / Contract "Deal Type" drop list.

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

Permissions

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

If not actively using, leave 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.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Default

Mandatory

deal_type_code

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

deal_type_description

string

Deal type description

No

page

number

Returns all pages by default. Limit with this value.

1

No

page_size

number

Results per page by default. Limit with this value.

25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

Response - 200 OK

{ "_links": { "self": { "href": "https://api.catch-e.com/qt/deal-types/?page=1&page_size=1" }, "first": { "href": "https://api.catch-e.com/qt/deal-types/?page_size=1" }, "last": { "href": "https://api.catch-e.com/qt/deal-types/?page=5&page_size=1" }, "next": { "href": "https://api.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.catch-e.com/qt/deal-types/100000" } } } ] }, "page_count": 5, "page_size": 1, "total_items": 5, "page": 1 }

Successful response returns all fields in table record.

Response - 403 Forbidden

{ "detail": "Forbidden" }

You do not have permissions for this request.

GetDiscountTypes

Returns Quotes / Vehicle "Discount Status" field list. Use this selection in patchQuote.

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

Permissions

Requires permission DiscountTypes:Get. Not available in Roles / APIs by default, but can be enabled by Catch-e. Once enabled, turn on for your 'web_services' role via Edit API permissions process.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

name

string

Get discount type using plan name. Supports wildcard % operator (See Wildcard % operator notes below)

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.