Meters

Create a meter reading

Create a new reading. The system automatically populates previous_value from the latest reading and calculates consumption using the meter's multiplier. Handles meter rollover when max_value is configured.

post/meters/{meter_id}/readings

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/meters/{meter_id}/readings
  • Auth: HTTP bearer

Path parameters

meter_idstring uuid required

Meter ID

Request body

lease_idstring uuid nullable
reading_datestring date-time required
reading_type'MANUAL' | 'AUTOMATIC' | 'PHOTO' | 'ESTIMATED' required

How the reading was captured.

  • MANUAL: Manual entry by a person
  • AUTOMATIC: Automatic reading from connected meter
  • PHOTO: Reading from a photo (OCR)
  • ESTIMATED: Estimated value (not actual reading)
valuenumber required
is_estimatedboolean
is_billing_readingboolean
photo_urlstring nullable
reader_namestring nullable
notesstring nullable

Example request

{
  "reading_type": "MANUAL"
}

Response

Meter reading created successfully

idstring uuid required
meter_idstring uuid required
lease_idstring uuid nullable

Optional lease association

reading_datestring date-time required

Date and time of the reading

reading_type'MANUAL' | 'AUTOMATIC' | 'PHOTO' | 'ESTIMATED' required

How the reading was captured.

  • MANUAL: Manual entry by a person
  • AUTOMATIC: Automatic reading from connected meter
  • PHOTO: Reading from a photo (OCR)
  • ESTIMATED: Estimated value (not actual reading)
valuenumber required

The meter reading value

previous_valuenumber nullable

Previous reading value (auto-populated)

consumptionnumber nullable

Calculated consumption since last reading (auto-populated). Formula: (value - previous_value) * multiplier With rollover: (max_value - previous_value + value) * multiplier

is_estimatedboolean required

Whether the reading is an estimate

is_billing_readingboolean required

Whether this reading is used for billing

photo_urlstring nullable

URL to photo of the meter reading

reader_namestring nullable

Name of the person who took the reading

notesstring nullable
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "reading_type": "MANUAL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.