Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Indicative Imbalance Settlement

Settlement messages by settlement date and period (SMSG)

Returns settlement messages generated by the SAA for a given settlement period, relating to the data for a settlement run.

Only messages generated for the latest settlement run are returned.

Settlement date parameter must be provided in the exact format yyyy-MM-dd.

get/balancing/settlement/messages/{settlementDate}/{settlementPeriod}

Path parameters

settlementPeriodinteger required
Example:3

The settlement period to filter. This should be an integer from 1-50 inclusive.

settlementDatestring date required
Example:2024-02-01

The settlement date to filter. This must be in the format yyyy-MM-dd.

Query parameters

format'json' | 'xml' | 'csv'

Response data format. Use json/xml to include metadata.

Response

Data retrieved

Example response

{
  "data": [
    {
      "settlementDate": "2023-09-18",
      "settlementPeriod": 2,
      "startTime": "2023-09-18T00:30:00Z",
      "messageReceivedDateTime": "2023-09-17T15:31:12Z",
      "messageSeverity": "Error",
      "messageTypeCode": "ERR-BM-001",
      "messageType": "FPN",
      "messageText": "No FPN files have been received."
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}