Dataset: Utility Meter Reading

Dataset name: ds_utility_meter_readings


Utility meter readings

Fields in this dataset

Name Field Name Description Field Type Field Example
Meter Reading ID id The primary identifier for this record. number 5
Utility Meter Reading Instance instance The instance this transaction relates to. number 8
Utility Meter Reading Source source The source of the data - user or connection. text
Utility Transactions Meter Reading utility_reading The value of the meter reading number
Utility Transactions Meter Read Date utility_reading_date The date on which the meter was read date
Utility Transactions Estimated utility_reading_estimated Boolean indicating whether the meter reading is estimated. varchar Y/N
Utility Transactions Read By utility_reading_read_by How the meter was read varchar Auto
Meter Reading Type utility_reading_type The type of meter reading (helps to distinguish on mixed bills). varchar
Utility Transactions Metering Unit utility_reading_unit The units read by the meter text kWh

Making an API request for this Dataset

Example Request to the Sandbox Server

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

  "5": {
    "id": "5",
    "ds_id": "5",
    "utility_reading": null,
    "utility_reading_date": null,
    "utility_reading_estimated": "Y/N",
    "utility_reading_read_by": "Auto",
    "utility_reading_type": null,
    "utility_reading_unit": "kWh"