Meters

Create a meter

Create a new meter

post/meters

Request

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

Request body

place_idstring uuid nullable
estate_idstring uuid nullable
service_place_idstring uuid nullable
meter_type'ELECTRICITY' | 'GAS' | 'WATER_HOT' | 'WATER_COLD' | 'HEATING' | 'COOLING' required

Type of meter.

  • ELECTRICITY: Electrical consumption meter
  • GAS: Gas consumption meter
  • WATER_HOT: Hot water meter
  • WATER_COLD: Cold water meter
  • HEATING: Heating meter (calories)
  • COOLING: Cooling/AC meter
billing_type'INDIVIDUAL' | 'COLLECTIVE' | 'SHARED' | 'INCLUDED' required

How the meter is used for billing.

  • INDIVIDUAL: Meter for a single tenant
  • COLLECTIVE: Shared meter for the building
  • SHARED: Shared among specific tenants with ratios
  • INCLUDED: Consumption included in rent (informational only)
serial_numberstring required
manufacturerstring nullable
model_referencestring nullable
installation_datestring date required
last_inspection_datestring date nullable
next_inspection_datestring date nullable
unit'KWH' | 'M3' | 'L' | 'KCAL' | 'BTU' required

Unit of measurement for the meter.

multipliernumber
status'ACTIVE' | 'INACTIVE' | 'MAINTENANCE' | 'REPLACED' | 'REMOVED'

Current operational status of the meter.

is_main_meterboolean
parent_meter_idstring uuid nullable
max_valuenumber nullable
precision_digitsinteger
notesstring nullable

Example request

{
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "unit": "KWH",
  "status": "ACTIVE"
}

Response

Meter created successfully

idstring uuid required
place_idstring uuid nullable

Place where the meter is installed

estate_idstring uuid nullable

Estate (lot) where the meter is installed

service_place_idstring uuid nullable

Associated service (e.g., electricity service for the building)

meter_type'ELECTRICITY' | 'GAS' | 'WATER_HOT' | 'WATER_COLD' | 'HEATING' | 'COOLING' required

Type of meter.

  • ELECTRICITY: Electrical consumption meter
  • GAS: Gas consumption meter
  • WATER_HOT: Hot water meter
  • WATER_COLD: Cold water meter
  • HEATING: Heating meter (calories)
  • COOLING: Cooling/AC meter
billing_type'INDIVIDUAL' | 'COLLECTIVE' | 'SHARED' | 'INCLUDED' required

How the meter is used for billing.

  • INDIVIDUAL: Meter for a single tenant
  • COLLECTIVE: Shared meter for the building
  • SHARED: Shared among specific tenants with ratios
  • INCLUDED: Consumption included in rent (informational only)
serial_numberstring required

Unique serial number (unique per tenant)

manufacturerstring nullable

Meter manufacturer

model_referencestring nullable

Model reference

installation_datestring date required

Date the meter was installed (cannot be in the future)

last_inspection_datestring date nullable

Date of last inspection (must be >= installation_date)

next_inspection_datestring date nullable

Date of next planned inspection

unit'KWH' | 'M3' | 'L' | 'KCAL' | 'BTU' required

Unit of measurement for the meter.

multipliernumber required

Reading multiplier (default 1.0, must be > 0)

status'ACTIVE' | 'INACTIVE' | 'MAINTENANCE' | 'REPLACED' | 'REMOVED' required

Current operational status of the meter.

is_main_meterboolean required

Whether this is the main meter (vs. sub-meter)

parent_meter_idstring uuid nullable

Parent meter ID (for sub-meter hierarchy)

max_valuenumber nullable

Maximum value before rollover (for rollover detection)

precision_digitsinteger required

Number of decimal digits for readings

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

Example response

{
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": "EDF-2024-001234",
  "manufacturer": "Itron",
  "model_reference": "Linky G3",
  "unit": "KWH",
  "status": "ACTIVE"
}

Changes

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