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 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "readValue": 123,
  "readDate": "2023-11-07T05:31:56Z",
  "notes": "<string>"
}
'
{
  "id": "<string>",
  "meterId": "<string>",
  "readValue": 123,
  "readDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

VoltView API key

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

Meter read identifier

​
meterId
string

Associated meter identifier

​
readValue
number

Meter reading value

​
readDate
string<date-time>

Date of the reading

​
readType
enum<string>

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