Charges

Create a global charge reading

Record a new reading for a charge (global scope). The system automatically populates previous_value from the latest reading and runs anomaly detection.

post/charges/readings

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/charges/readings
  • Auth: HTTP bearer

Request body

lease_charge_idstring uuid required
place_idstring uuid required
reading_datestring date-time required
reading_type'METER_READING' | 'CONSUMPTION' | 'OCCUPANT_COUNT' | 'EQUIPMENT_COUNT' required

Type of charge reading

reading_subtype'COMMON_AREAS' | 'INDIVIDUAL' | 'MAINTENANCE' | 'LEAK_FIX' required

Subtype of charge reading for more granular categorization

reading_valuenumber required

Reading value (must be >= 0)

anomaly_detectedboolean required
notesstring nullable

Response

Reading created

idstring uuid required
lease_charge_idstring uuid required

ID of the lease charge this reading belongs to

place_idstring uuid required

ID of the place where the reading was taken

reading_datestring date-time required

When the reading was taken

reading_valuenumber required

Reading value (BigDecimal)

reading_type'METER_READING' | 'CONSUMPTION' | 'OCCUPANT_COUNT' | 'EQUIPMENT_COUNT' required

Type of charge reading

reading_subtype'COMMON_AREAS' | 'INDIVIDUAL' | 'MAINTENANCE' | 'LEAK_FIX' required

Subtype of charge reading for more granular categorization

anomaly_detectedboolean required

Whether an anomaly was detected for this reading

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

Changes

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