Quote Reference Endpoints: GetEventTypes

GetEventTypes

This method is used to return a list of valid event types.

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/?/Events/getEventTypes(https://api.test.catch-e.com/docs/?urls.primaryName=Main#/Events/getEventTypes|).

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

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

Event Types

• sl.receipts.batch.posted — Used internally as part of the Pay Run Receipts Setup
• gb.exports.batch.created — This feature is currently under construction. When complete, clients can arrange to have a webhook subscription created. This will send a message each time an accounting export batch is created in their system.

HTTP Method

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

URL Example

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

Response Details

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

| Shows list of available Event Types |
| 401 - Unauthorized | | |

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

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "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. |

GetPayCycles

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

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Pay%20Cycles/getPayCycles(https://https://api.catch-e.com/docs/#/Pay%20Cycles/getPayCycles)

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

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/pay-cycles

Parameters (Query Params)

GetOriginators

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

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Originators/getOriginators(https://api.catch-e.com/docs/#/Originators/getOriginators)

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

Parameters - Query

Response Details

{ "_links": { "self": { "href": "https://api.test.catch-e.com/gb/originators/?page=1&page_size=1&supplier_id=100533&include_inactive_flag=no" }, "first": { "href": "https://api.test.catch-e.com/gb/originators/?page_size=1&supplier_id=100533&include_inactive_flag=no" }, "last": { "href": "https://api.test.catch-e.com/gb/originators/?page=2&page_size=1&supplier_id=100533&include_inactive_flag=no" }, "next": { "href": "https://api.test.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.test.catch-e.com/gb/originators/100000" } } } ] }, "page_count": 2, "page_size": 1, "total_items": 2, "page": 1}

| A successful response returns all fields in the table record. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |

GetOpportunityStages

Enables you to get details of records stored in the table.

These are used by the Salesforce CRM system. Go to the Salesforce page for full details.

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

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

Parameters - Query

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

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

| A successful response returns all fields in the table record. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |

GetPostingMaps

Enables you to get a list of the available Contract Types.

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/#/Posting%20Maps/getPostingMaps(https://api.test.catch-e.com/docs/#/Posting%20Maps/getPostingMaps)

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

Parameters - Query

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

{ "_links": { "self": { "href": "https://api.test.catch-e.com/gl/posting-maps/?posting_map_code=NOFB&posting_map_group=novated&name=%25bud%25&include_inactive_flag=yes&fields%5B0%5D=posting_map_code&fields%5B1%5D=status_flag&fields%5B2%5D=posting_map_group&fields%5B3%5D=name&page=1&page_size=25" }, "first": { "href": "https://api.test.catch-e.com/gl/posting-maps/?posting_map_code=NOFB&posting_map_group=novated&name=%25bud%25&include_inactive_flag=yes&fields%5B0%5D=posting_map_code&fields%5B1%5D=status_flag&fields%5B2%5D=posting_map_group&fields%5B3%5D=name&page_size=25" }, "last": { "href": "https://api.test.catch-e.com/gl/posting-maps/?posting_map_code=NOFB&posting_map_group=novated&name=%25bud%25&include_inactive_flag=yes&fields%5B0%5D=posting_map_code&fields%5B1%5D=status_flag&fields%5B2%5D=posting_map_group&fields%5B3%5D=name&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.test.catch-e.com/gl/posting-maps/100023" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1}

| A successful response returns all fields in the table record. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |

GetLocations

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

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

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

Parameters (Query Params)

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.