getContractEvents

getContractEvents

Overview

This method returns a list of contract events, optionally filtered by contract, posting class or linked table.

This method requires the ContractEvents:Get permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractEvents:Get'.

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

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/fm/contract/events?contract_id=5678 https://api.{{environment}}.catch-e.com/fm/contract/events?contract_id=5678 https://api.test.catch-e.com/fm/contract/events?contract_id=5678

Query Parameters

Key

Format

Notes

Mandatory

contract_id

string

Filter by contract. A positive whole number, up to 10 digits, with no leading zeros.

No

posting_class_id

string

Filter by posting class. A positive whole number, up to 10 digits, with no leading zeros.

No

table_name

string

Filter by the table of the linked record. Allowed values: fm_drivers, fm_client_cost_centres, fm_client_divisions.

No

page

integer

Page number. Default 1.

No

page_size

integer

Number of records per page. Default 25. Use -1 to return all records.

No

Response Details

Success

200 - OK

Each record in _embedded.fm_contract_events contains:

Field

Format

Notes

contract_event_id

string

Contract Event Id.

contract_id

string

Contract Id.

posting_class_id

string

Posting Class Id.

attachment_id

string

Attachment Id, if an attachment is linked to the event.

event_date

string (date)

Event date.

table_name

string

The table of the linked record.

record_id

string

The id of the linked record in that table.

event_value

string

description

string

contract_event_value_id

string

See getContractEventValues.

contract_event_description_id

string

See getContractEventDescriptions.

contract_event_action_id

string

See getContractEventActions.

due_date

string (date)

Due date.

completed_flag

string

Values: yes, no.

event_amount

string

message_type

string

Values: email, pdf, sms, csv.

user_id

string

User Id.

last_edit

integer

status_flag

string

Values: active, deleted.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/contract/events?contract_id=5678&page=1" } }, "_embedded": { "fm_contract_events": [ { "contract_event_id": "9012", "contract_id": "5678", "posting_class_id": "3", "attachment_id": "", "event_date": "2026-03-02", "table_name": "fm_drivers", "record_id": "4321", "event_value": "string", "description": "string", "contract_event_value_id": "11", "contract_event_description_id": "22", "contract_event_action_id": "33", "due_date": "2026-03-16", "completed_flag": "no", "event_amount": "0.00", "message_type": "email", "user_id": "67", "last_edit": 1, "status_flag": "active" } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

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

404 - Not Found

No contract events were found.

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

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

409 - Conflict

The request conflicts with the current state of the data.

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

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