Annual Consumption Schema Reference
Headers and Parameters
| Field | Location | Required | Type | Format / Constraints |
|---|
X-API-KEY | Header | Yes | string | UUID format |
X-IDEMPOTENCY-KEY | Header | Yes | string | Non-empty string |
X-TEST-MODE | Header | No | string | Optional; "true" enables test mode |
mpid | Path | Yes | string | Supplier MPID |
Request Schema (AnnualConsumptionChangeRequestSchema)
| Field | Required | Type | Format / Constraints |
|---|
mpan_core | Yes | integer | Exactly 13 digits, numeric |
notification_efd | Yes | string(datetime) | ISO 8601 with timezone; cannot be in the past for API requests |
notification_expiry | No | string(datetime) or null | ISO 8601 with timezone; cannot be more than 12 months in the future |
annual_consumption | Yes | string | Pattern -?\d{1,9}\.\d{3} |
additional_information | No | string or null | Max 2000 chars |
allow_past_dates | No | boolean | Optional compatibility flag; not required for standard API submissions |
Additional validation notes:
- Unknown fields are explicitly rejected.
annual_consumption must include exactly 3 decimal places.
Response Schema (SupplierProcessResponseSchema)
| Field | Required | Type | Format / Constraints |
|---|
request_id | Yes | string | UUID |
request_type | Yes | string | Process type name |
request_status | Yes | string(enum) | Pending, Success, Failed |
description | No | string or null | Optional process description |
created_at | Yes | string(datetime) | ISO 8601 datetime |
last_updated_at | Yes | string(datetime) | ISO 8601 datetime |
mpan_core | Yes | integer | MPAN core |