Meters

Create meter

Create a new meter for a site. Requires admin permissions.

post/v1/meter/create

Request body

siteIdinteger required

ID of the site to add the meter to

mpxnstring required

MPAN (13 digits for electricity) or MPRN (6-10 digits for gas)

utilityType'ELECTRICITY' | 'GAS' | 'BMS' required

Type of utility

Meter created successfully

idstring

Meter identifier

siteIdstring

Associated site identifier

mpxnstring

MPAN (13 digits for electricity) or MPRN (6-10 digits for gas)

utilityType'ELECTRICITY' | 'GAS' | 'BMS'

Type of utility

meterSerialNumberstring

Meter serial number

supplierstring

Energy supplier name

status'ACTIVE' | 'INACTIVE'

Meter status

createdAtstring date-time

Creation timestamp