Skip to main content

GET /consumption/v1/{mpid}/defaulted

Returns defaulted settlement runs with nested ECS and settlement-date details.

Request​

Method and path:

  • GET /consumption/v1/{mpid}/defaulted?mpan_core=1234567890123&run_number=1&settlement_code=SF&from_date=2026-03-01

Headers:

  • X-API-KEY (required): string, API key used for tenant authorization.

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • mpan_core (optional): integer MPAN core.
  • run_number (optional): integer settlement run number.
  • settlement_code (optional): string settlement code.
  • from_date (optional): string date in YYYY-MM-DD.
  • updated_on (optional): string date in YYYY-MM-DD.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: array of DefaultedSettlementRunResponseSchema
[
  {
    "mpan_core": 1234567890123,
    "data_service_dip_id": "DIP-DC-001",
    "settlement_run_execution_date": "2026-03-20T02:15:00+00:00",
    "settlement_code": "RF",
    "run_number": 1,
    "connection_type": "H",
    "connection_type_efd": "2026-01-01T00:00:00+00:00",
    "updated_on": "2026-03-20T02:15:00+00:00",
    "defaulted_ecs_determination_data": [
      {
        "measurement_quantity_id": "AI",
        "market_segment_indicator": "A",
        "domestic_premise_indicator": true,
        "consumption_component_class_id": 1,
        "consumption_component_indicator": "IMP",
        "settlement_run_defaulted_settlement_dates": [
          {
            "utc_settlement_date": "2026-03-01",
            "settlement_period_duration": 30,
            "consumption_data": [
              {
                "utc_effective_to_datetime": "2026-03-01T00:30:00+00:00",
                "consumption_value": "0.401",
                "default_load_shape_flag": "Y"
              }
            ]
          }
        ]
      }
    ]
  }
]

No content case:

  • 204 No Content when no defaulted runs match the filters.

Notes:

  • This endpoint does not return a dedicated validation error for malformed from_date or updated_on; unparsable values are ignored and treated as no filter.

Full field definitions: