Contract / Events

Get contract events

Get contract events.

GET

/fm/contract/events

Get contract events

curl --request GET \
  --url 'https://api.catch-e.com/fm/contract/events?contract_id=%3Cstring%3E&posting_class_id=%3Cstring%3E&table_name=fm_drivers&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "fm_contract_events": [
      {
        "attachment_id": "100000",
        "completed_flag": "yes",
        "contract_event_action_id": "100000",
        "contract_event_description_id": "100000",
        "contract_event_id": "100000",
        "contract_event_value_id": "100000",
        "contract_id": "100000",
        "description": "<string>",
        "due_date": "2022-03-07",
        "event_amount": "<string>",
        "event_date": "2022-03-07",
        "event_value": "<string>",
        "last_edit": 123,
        "message_type": "email",
        "posting_class_id": "100000",
        "record_id": "100000",
        "status_flag": "active",
        "table_name": "fm_drivers",
        "user_id": "100000"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/contract/events"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

contract_idstringquery

Optional Contract Id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

posting_class_idstringquery

Optional Posting Class Id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

table_nameenum<string>query

Optional Table Name

Available options: fm_drivers, fm_client_cost_centres, fm_client_divisions

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team