Sign in
Supplier Integration

Submit meter reading to supplier

Submit a meter reading to the supplier (Octopus Energy, E.ON Next, British Gas Lite). The reading is saved to Firestore with status PENDING first, then sent to the supplier; the document is updated to SUCCESS or FAILED. Supports single-register (gas or single-rate electricity), day/night (2 registers), or multi-register (e.g. green/amber/red). Get registerIds from the supplier account's meter details (e.g. from account sites). On failure, the response includes readingId so you can retry within the typical 10-day submission window.

post/v1/suppliers/accounts/{id}/readings

Path parameters

idstring required

Supplier account ID

Request body

mpanMprnstring required

MPAN (electricity) or MPRN (gas) for the meter

readAtstring required

Date of the reading (ISO 8601 date e.g. 2026-03-15)

Response

Meter reading submitted successfully to supplier

successboolean
messagestring
readingIdstring

Unique id for this submission (for retries)

dataobject

Supplier API response

warningstring

Optional e.g. readAt older than 10 days

Example response

{
  "success": true
}

Changes

Changed in 2 of the 13 revisions of this API.11