Settlement Schema Reference
Shared Request Parameters
| Field | Location | Required | Type | Format / Constraints | Notes |
|---|---|---|---|---|---|
X-API-KEY | Header | Yes | string | Not specified in schema | Required on all settlement endpoints. |
mpid | Path | Yes | string | Not specified | Supplier MPID used for tenant authorization. |
Consumption Query Parameters
| Field | Required | Type | Format / Constraints | Notes |
|---|---|---|---|---|
mpan_core | Conditional | integer | 13 digits | Required when updated_on is not supplied. |
from_date | Conditional | string | YYYY-MM-DD | Required when updated_on is not supplied. |
updated_on | No | string | YYYY-MM-DD | Enables changed-data retrieval mode. |
Consumption Response Schema (SettlementRunResponseSchema)
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
mpan_core | Yes | integer | 13 digits in practice |
data_service_dip_id | Yes | string | Not specified |
connection_type | Yes | string | Not specified |
measurement_quantity_id | Yes | string | Not specified |
utc_settlement_date | Yes | string(datetime) | ISO 8601 datetime |
settlement_period_duration | Yes | integer | Period length in minutes |
consumption_data | No | array of SettlementConsumptionDataResponseSchema | N/A |
SettlementConsumptionDataResponseSchema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
utc_effective_to_datetime | Yes | string(datetime) | ISO 8601 datetime |
consumption_value | Yes | string | Decimal serialized as string |
quality_indicator | Yes | string | Not specified |
estimation_reason_code | No | string or null | Not specified |
amendment_reason_code | No | string(enum) or null | Settlement amendment reason code |
Defaulted Response Schema (DefaultedSettlementRunResponseSchema)
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
mpan_core | Yes | integer | 13 digits in practice |
data_service_dip_id | Yes | string | Not specified |
settlement_run_execution_date | Yes | string(datetime) | ISO 8601 datetime |
settlement_code | Yes | string | Not specified |
run_number | Yes | integer | Not specified |
connection_type | Yes | string | Not specified |
connection_type_efd | Yes | string(datetime) | ISO 8601 datetime |
updated_on | Yes | string(datetime) | ISO 8601 datetime |
defaulted_ecs_determination_data | Yes | array of DefaultedECSTierResponseSchema | N/A |
DefaultedECSTierResponseSchema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
measurement_quantity_id | Yes | string | Not specified |
market_segment_indicator | Yes | string | Not specified |
domestic_premise_indicator | Yes | boolean | N/A |
consumption_component_class_id | Yes | integer | Not specified |
consumption_component_indicator | Yes | string | Not specified |
settlement_run_defaulted_settlement_dates | Yes | array of DefaultedSettlementDateResponseSchema | N/A |
DefaultedSettlementDateResponseSchema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
utc_settlement_date | Yes | string(date) | YYYY-MM-DD |
settlement_period_duration | Yes | integer | Period length in minutes |
consumption_data | Yes | array of DefaultedConsumptionPeriodResponseSchema | N/A |
DefaultedConsumptionPeriodResponseSchema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
utc_effective_to_datetime | Yes | string(datetime) | ISO 8601 datetime |
consumption_value | Yes | string | Decimal serialized as string |
default_load_shape_flag | Yes | string | Not specified |
Load Shape Period Response (SettlementLoadShapePeriodResponse)
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
received_on | Yes | string(datetime) | ISO 8601 datetime |
settlement_date | Yes | string(datetime) | ISO 8601 datetime |
period_duration | Yes | integer | Not specified |
gsp_group_id | No | string or null | Not specified |
connection_type | Yes | string | Not specified |
market_segment | Yes | string | Not specified |
domestic_indicator | No | string or null | Not specified |
mqid | Yes | string | Not specified |
lss_period_data | No | array of SettlementLoadShapePeriodDataResponse | N/A |
SettlementLoadShapePeriodDataResponse
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
effective_to | Yes | string(datetime) | ISO 8601 datetime |
ls_period_value | Yes | string | Decimal serialized as string |
default_flag | Yes | string | Not specified |
Load Shape Totals Response (SettlementLoadShapeTotalsResponse)
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
received_on | Yes | string(datetime) | ISO 8601 datetime |
settlement_date | Yes | string(datetime) | ISO 8601 datetime |
gsp_group_id | No | string or null | Not specified |
connection_type | Yes | string | Not specified |
market_segment | Yes | string | Not specified |
domestic_indicator | No | string or null | Not specified |
mqid | Yes | string | Not specified |
annual_load_shape_total | Yes | string | Decimal serialized as string |
lss_totals_data | No | array of SettlementLoadShapeTotalsDataResponse | N/A |
SettlementLoadShapeTotalsDataResponse
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
day_total | Yes | string | Decimal serialized as string |
day_peak_total | No | string or null | Decimal serialized as string |
day_off_peak_total | No | string or null | Decimal serialized as string |
seven_day_rolling_total | Yes | string | Decimal serialized as string |
seven_day_rolling_peak_total | No | string or null | Decimal serialized as string |
seven_day_rolling_off_peak_total | No | string or null | Decimal serialized as string |
Load Shape Update Response
GET /load-shapes/received-on-or-after returns an object with:
lss_periods: array ofSettlementLoadShapePeriodResponselss_totals: array ofSettlementLoadShapeTotalsResponse