Skip to main content

POST /annual-consumption/v1/{mpid}

Creates an annual consumption change process for one MPAN.

Request​

Method and path:

  • POST /annual-consumption/v1/{mpid}

Headers:

  • X-API-KEY (required): string, UUID format.
  • X-IDEMPOTENCY-KEY (required): string.
  • X-TEST-MODE (optional): string ("true" to suppress production comms).

Path parameters:

  • mpid (required): string supplier MPID.

Body schema:

  • AnnualConsumptionChangeRequestSchema
{
  "mpan_core": 1234567890123,
  "notification_efd": "2026-03-28T00:00:00+00:00",
  "notification_expiry": "2026-06-30T00:00:00+00:00",
  "annual_consumption": "3500.000",
  "additional_information": "Customer submitted updated annual usage after meter review."
}

Response​

Success:

  • 202 Accepted
  • Body type: SupplierProcessResponseSchema
{
  "request_id": "bc80bd6e-ef22-42f6-b3a7-cb4d49e1af7b",
  "request_type": "annual-consumption-change",
  "request_status": "Pending",
  "description": "Annual Consumption Change Process",
  "created_at": "2026-03-24T10:20:00+00:00",
  "last_updated_at": "2026-03-24T10:20:00+00:00",
  "mpan_core": 1234567890123
}

Other documented responses:

  • 401 Unauthorized.
  • 409 Conflict.
  • 422 Validation error.
  • 428 Missing X-IDEMPOTENCY-KEY.

Field-level constraints: