Skip to main content
GET
/
schedule-management
/
v1
/
mabis
/
clearing-periods
/
{uid}
/
settlements
List Settlements
curl --request GET \
  --url https://api.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}/settlements \
  --header 'Authorization: <api-key>'
[
  {
    "clearing_period_uid": "<string>",
    "created_ts": "<string>",
    "date": "<string>",
    "last_modified_ts": "<string>",
    "uid": "<string>",
    "values": {}
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
uid
string<uuid>
required

Clearing period unique identifier.

Response

Successful Response

​
clearing_period_uid
string
required

Parent Clearing Period identifier.

​
created_ts
string
required

ISO 8601 datetime when this record was created.

Example:

"2026-02-20T08:00:00+00:00"

​
date
string
required

Settlement date in ISO 8601 format.

Example:

"2026-01-15"

​
last_modified_ts
string
required

ISO 8601 datetime of the most recent update.

Example:

"2026-02-20T08:00:00+00:00"

​
uid
string
required

Unique identifier for this settlement record.

Example:

"d6e7f8a9-b0c1-4d2e-8f3a-4b5c6d7e8f9a"

​
values
Values · object
required

Raw interval values from the MSCONS message. Structure varies by message type.