Consumption Amendment 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 test flag
mpid	Path	Yes	string	Supplier MPID

Request Schema

Field	Required	Type	Format / Constraints
mpan_core	Yes	integer	13 digits; range 1000000000000 to 9999999999999
supplier_reference	No	string or null	Max 50 chars
period_start_date	Yes	string(datetime)	ISO 8601 datetime
period_end_date	Yes	string(datetime)	ISO 8601 datetime; must be later than period_start_date
measurement_quantity_id	Yes	string	One of AI, AE, RI, RE
gross_revised_consumption	Yes	decimal	>= 0; max 14 digits total, max 3 decimal places, max 11 digits before decimal
reason_code	Yes	string(enum)	One of A, E, M, R, S, T, X

Response Schema

Used in GET /requests/v1/{mpid} when request_type=consumption-amendment.

Field	Required	Type	Format / Constraints
supplier_reference	No	string or null	Supplier reference
period_start_date	Yes	string(datetime)	ISO 8601 datetime
period_end_date	Yes	string(datetime)	ISO 8601 datetime
measurement_quantity_id	Yes	string	Quantity code
gross_revised_consumption	Yes	decimal	Serialized as string/decimal value
reason_code	Yes	string(enum)	Reason code

When show_messages=true on the requests search endpoint, the response wrapper may also include:

• outbound_if_027
• inbound_if_028

Process Response Schema

Used by POST /consumption-amendment/v1/{mpid}.

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	Process type description
created_at	Yes	string(datetime)	ISO 8601 datetime
last_updated_at	Yes	string(datetime)	ISO 8601 datetime
mpan_core	Yes	integer	MPAN core