Meters

Create meter read

Create a new meter read.

post/v1/meters/{meterId}/reads

Path parameters

meterIdstring required

UUID of the meter

Request body

readValuenumber required

Meter reading value

readDatestring date-time required

Date of the reading (ISO 8601)

readType'ACTUAL' | 'ESTIMATED' | 'CUSTOMER' required

Type of reading

registerCode'TOTAL' | 'DAY' | 'NIGHT' | 'PEAK' | 'OFF_PEAK' required

Register code

source'MANUAL' | 'INVOICE' | 'SMART_METER' | 'SUPPLIER_API' required

Source of the reading

notesstring

Additional notes

Response

Meter read created successfully

idstring

Meter read identifier

meterIdstring

Associated meter identifier

readValuenumber

Meter reading value

readDatestring date-time

Date of the reading

readType'ACTUAL' | 'ESTIMATED' | 'CUSTOMER'

Type of reading

registerCode'TOTAL' | 'DAY' | 'NIGHT' | 'PEAK' | 'OFF_PEAK'

Register code

source'MANUAL' | 'INVOICE' | 'SMART_METER' | 'SUPPLIER_API'

Source of the reading

notesstring

Additional notes

createdAtstring date-time

Creation timestamp

Changes

Changed in 3 of the 13 revisions of this API.61

    • the response property id became optional for the status 200

      response-property-became-optional

    • the response property meterId became optional for the status 200

      response-property-became-optional

    • the response property readDate became optional for the status 200

      response-property-became-optional

    • the response property readType became optional for the status 200

      response-property-became-optional

    • the response property readValue became optional for the status 200

      response-property-became-optional

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog