Skip to main content
POST
/
v1
/
meters
/
{meterId}
/
reads
Create meter read
curl --request POST \
  --url https://api.voltview.co.uk/v1/meters/{meterId}/reads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "readValue": 123,
  "readDate": "2023-11-07T05:31:56Z",
  "readType": "ACTUAL",
  "registerCode": "TOTAL",
  "source": "MANUAL",
  "notes": "<string>"
}
'
{
  "id": "<string>",
  "meterId": "<string>",
  "readValue": 123,
  "readDate": "2023-11-07T05:31:56Z",
  "readType": "ACTUAL",
  "registerCode": "TOTAL",
  "source": "MANUAL",
  "notes": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Path Parameters

meterId
string
required

UUID of the meter

Body

application/json
readValue
number
required

Meter reading value

readDate
string<date-time>
required

Date of the reading (ISO 8601)

readType
enum<string>
required

Type of reading

Available options:
ACTUAL,
ESTIMATED,
CUSTOMER
registerCode
enum<string>
required

Register code

Available options:
TOTAL,
DAY,
NIGHT,
PEAK,
OFF_PEAK
source
enum<string>
required

Source of the reading

Available options:
MANUAL,
INVOICE,
SMART_METER,
SUPPLIER_API
notes
string

Additional notes

Response

Meter read created successfully

id
string
required

Meter read identifier

meterId
string
required

Associated meter identifier

readValue
number
required

Meter reading value

readDate
string<date-time>
required

Date of the reading

readType
enum<string>
required

Type of reading

Available options:
ACTUAL,
ESTIMATED,
CUSTOMER
registerCode
enum<string>

Register code

Available options:
TOTAL,
DAY,
NIGHT,
PEAK,
OFF_PEAK
source
enum<string>

Source of the reading

Available options:
MANUAL,
INVOICE,
SMART_METER,
SUPPLIER_API
notes
string

Additional notes

createdAt
string<date-time>

Creation timestamp