GetEventTypes

GetEventTypes

Returns list of valid event types.

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/?urls.primaryName=Main#/Events/getEventTypes

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 Events:GetTypes.

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

Event Types

  • ping

  • gb.api-event.subscriber.message.processed

  • gb.exports.batch.created (currently under construction; when complete, clients can arrange webhook subscription to send message each time accounting export batch is created)

  • sl.receipts.batch.posted (used internally as part of Pay Run Receipts Setup)

HTTP Method

GET

URL

https://api.catch-e.com/event/types

Response - 200 OK

[ "ping", "gb.api-event.subscriber.message.processed", "gb.exports.batch.created", "sl.receipts.batch.posted" ]

Shows list of available Event Types.

Response - 401 Unauthorized

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

You have not authenticated or your token_timeout has passed. Authenticate again.

Response - 403 Forbidden

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

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

GetPayCycles

Supporting API for patchQuote. Returns list of Pay Cycles details as seen in Pay Cycles.

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/#/Pay%20Cycles/getPayCycles

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/pay-cycles

Query Parameters

Key

Format

Notes

Mandatory

pay_cycle_code

string

Get pay_cycle_id for specific pay_cycle_code

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

GetOriginators

Enables you to get list of Originator records. See also the Originator Setup page.

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/#/Originators/getOriginators

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 Originators: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/gb/originators

Query Parameters

Key

Format

Notes

Default

Mandatory

supplier_id

string

Originators linked to Supplier/Financier

Yes

originator_code

string

Originator code

No

user_code

string

User code

No

description

string

Description

No

include_inactive_flag

string

Set to 'yes' for inactive Originators in list

no

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

Response - 200 OK

{ "_links": { "self": { "href": "https://api.catch-e.com/gb/originators/?page=1&page_size=1&supplier_id=100533&include_inactive_flag=no" }, "first": { "href": "https://api.catch-e.com/gb/originators/?page_size=1&supplier_id=100533&include_inactive_flag=no" }, "last": { "href": "https://api.catch-e.com/gb/originators/?page=2&page_size=1&supplier_id=100533&include_inactive_flag=no" }, "next": { "href": "https://api.catch-e.com/gb/originators/?page=2&page_size=1&supplier_id=100533&include_inactive_flag=no" } }, "_embedded": { "gb_originators": [ { "originator_id": 100000, "supplier_id": 100533, "originator_code": 10022882, "user_code": "UCMC1", "description": "Test Originator", "status_flag": "active", "_links": { "self": { "href": "https://api.catch-e.com/gb/originators/100000" } } } ] }, "page_count": 2, "page_size": 1, "total_items": 2, "page": 1 }

Successful response returns all fields in table record.

Response - 403 Forbidden

{ "detail": "Forbidden" }

You do not have permissions for this request.

GetOpportunityStages

Enables you to get details of Opportunity Stages records. Used by Salesforce CRM system.

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/#/Quote%20%2F%20Opportunity%20Stages/getOpportunityStages

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 OpportunityStages: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/opportunity-stages

Query Parameters

Key

Format

Notes

Default

Mandatory

opportunity_stage_code

string

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

No

opportunity_stage

string

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

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/opportunity-stages/?page=1&page_size=1" }, "first": { "href": "https://api.catch-e.com/qt/opportunity-stages/?page_size=1" }, "last": { "href": "https://api.catch-e.com/qt/opportunity-stages/?page=6&page_size=1" }, "next": { "href": "https://api.catch-e.com/qt/opportunity-stages/?page=2&page_size=1" } }, "_embedded": { "qt_opportunity_stages": [ { "opportunity_stage_id": 100000, "opportunity_stage_code": "NEW", "opportunity_stage": "New", "_links": { "self": { "href": "https://api.catch-e.com/qt/opportunity-stages/100000" } } } ] }, "page_count": 6, "page_size": 1, "total_items": 6, "page": 1 }

Successful response returns all fields in table record.

Response - 403 Forbidden

{ "detail": "Forbidden" }

You do not have permissions for this request.

GetPostingMaps

Enables you to get list of available Contract Types.

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/#/Posting%20Maps/getPostingMaps

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 PostingMaps: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/gl/posting-maps

Query Parameters

Key

Format

Notes

Default

Mandatory

posting_map_code

string

Enter Posting Map Code

No

posting_map_group

string

Enter Posting Map Group (one of: novated, lease, fleet-managed, insurance, non-billing, salary-packaged)

No

name

string

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

No

include_inactive_flag

string

Set to 'yes' to include inactive Contract Types. Default: no

no

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/gl/posting-maps/?posting_map_code=NOFB&posting_map_group=novated&name=%25bud%25&include_inactive_flag=yes&page=1&page_size=25" }, "first": { "href": "https://api.catch-e.com/gl/posting-maps/?posting_map_code=NOFB&posting_map_group=novated&name=%25bud%25&include_inactive_flag=yes&page_size=25" }, "last": { "href": "https://api.catch-e.com/gl/posting-maps/?posting_map_code=NOFB&posting_map_group=novated&name=%25bud%25&include_inactive_flag=yes&page=1&page_size=25" } }, "_embedded": { "gl_posting_maps": [ { "posting_map_id": "100023", "posting_map_code": "NOFB", "status_flag": "active", "posting_map_group": "novated", "name": "Novated Fully Budgeted", "_links": { "self": { "href": "https://api.catch-e.com/gl/posting-maps/100023" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

Successful response returns all fields in table record.

Response - 403 Forbidden

{ "detail": "Forbidden" }

You do not have permissions for this request.

GetLocations

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

Supplementary SWAGGER documentation: https://api.catch-e.com/docs/#/Quote%20%2F%20Locations/getLocations

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 Locations: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/locations

Query Parameters

Key

Format

Notes

Mandatory

location_name

string

Get location_id for Location Rego 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.