FairePlace Property Management API

Meters

Endpointhttps://api.faireplace.com/api

Meter (compteur) management for tracking consumption in properties.

Key features

Meter CRUD — Create and manage physical meters (electricity, gas, water, heating, cooling)
Sub-meter hierarchy — Organize meters in parent/child relationships
Readings — Record manual, automatic, photo, or estimated readings
Auto-consumption — Automatic consumption calculation with rollover support
Anomaly detection — Flags consumption deviating >50% from average
Billing integration — Link meters to leases and charges for billing

Meter types

ELECTRICITY, GAS, WATER_HOT, WATER_COLD, HEATING, COOLING

Billing types

INDIVIDUAL, COLLECTIVE, SHARED, INCLUDED

List meters

GET

https://api.faireplace.com/api

/meters

List meters with optional filters

List meters › query Parameters

place_id

string · uuid

Filter by place ID

estate_id

string · uuid

Filter by estate ID

service_place_id

string · uuid

Filter by service place ID

meter_type

string

Filter by meter type

status

string

Filter by status

billing_type

string

Filter by billing type

is_main_meter

boolean

Filter by main meter flag

page

integer

Page number

Default: 1

limit

integer · max: 500

Number of items per page

Default: 50

List meters › Responses

Meters retrieved successfully

object[]

A physical meter installed in a property to measure consumption (electricity, gas, water, heating, cooling). Meters can be organized hierarchically (parent/sub-meters) and linked to leases and charges for billing.

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

GET/meters

curl --request GET \
  --url https://api.faireplace.com/api/meters

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "place_id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "service_place_id": "00000000-0000-0000-0000-000000000000",
    "meter_type": "ELECTRICITY",
    "billing_type": "INDIVIDUAL",
    "serial_number": "EDF-2024-001234",
    "manufacturer": "Itron",
    "model_reference": "Linky G3",
    "installation_date": "2024-08-25",
    "last_inspection_date": "2024-08-25",
    "next_inspection_date": "2024-08-25",
    "unit": "KWH",
    "multiplier": 0,
    "status": "ACTIVE",
    "is_main_meter": true,
    "parent_meter_id": "00000000-0000-0000-0000-000000000000",
    "max_value": {},
    "precision_digits": 0,
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create a meter

POST

https://api.faireplace.com/api

/meters

Create a new meter

Create a meter › Request Body

Create a new meter. **Validation rules:** - `serial_number` cannot be empty and must be unique per tenant - `installation_date` cannot be in the future - `last_inspection_date` must be >= `installation_date` (if provided) - `last_inspection_date` must be < `next_inspection_date` (if both provided) - `multiplier` must be > 0 - `max_value` must be > 0 (if provided) - At least one of `place_id` or `estate_id` is required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · minLength: 1 · required

installation_date

string · date · required

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

place_id

string | null · uuid

estate_id

string | null · uuid

service_place_id

string | null · uuid

manufacturer

string | null

model_reference

string | null

last_inspection_date

string | null · date

next_inspection_date

string | null · date

multiplier

number · decimal

Default: 1

status

string · enum

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean

Default: false

parent_meter_id

string | null · uuid

max_value

number | null · decimal

precision_digits

integer

Default: 2

notes

string | null

Create a meter › Responses

Meter created successfully

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

POST/meters

curl --request POST \
  --url https://api.faireplace.com/api/meters \
  --header 'Content-Type: application/json' \
  --data '
{
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": "serial_number",
  "manufacturer": {},
  "model_reference": {},
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": 0,
  "status": "ACTIVE",
  "is_main_meter": true,
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": 0,
  "notes": {}
}
'

shell

Example Request Body

{
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": "serial_number",
  "manufacturer": {},
  "model_reference": {},
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": 0,
  "status": "ACTIVE",
  "is_main_meter": true,
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": 0,
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": "EDF-2024-001234",
  "manufacturer": "Itron",
  "model_reference": "Linky G3",
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": 0,
  "status": "ACTIVE",
  "is_main_meter": true,
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": 0,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get a meter

GET

https://api.faireplace.com/api

/meters/{id}

Retrieve a specific meter by its ID

Get a meter › path Parameters

id

string · uuid · required

Meter ID

Get a meter › Responses

Meter retrieved successfully

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

GET/meters/{id}

curl --request GET \
  --url https://api.faireplace.com/api/meters/:id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": "EDF-2024-001234",
  "manufacturer": "Itron",
  "model_reference": "Linky G3",
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": 0,
  "status": "ACTIVE",
  "is_main_meter": true,
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": 0,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update a meter

PUT

https://api.faireplace.com/api

/meters/{id}

Update an existing meter

Update a meter › path Parameters

id

string · uuid · required

Meter ID

Update a meter › Request Body

Partial update of a meter. Only provided fields are updated.

place_id

string | null · uuid

estate_id

string | null · uuid

service_place_id

string | null · uuid

meter_type

string · enum

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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum

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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string | null

manufacturer

string | null

model_reference

string | null

installation_date

string | null · date

last_inspection_date

string | null · date

next_inspection_date

string | null · date

unit

string · enum

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number | null · decimal

status

string · enum

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean | null

parent_meter_id

string | null · uuid

max_value

number | null · decimal

precision_digits

integer | null

notes

string | null

Update a meter › Responses

Meter updated successfully

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

PUT/meters/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/meters/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": {},
  "manufacturer": {},
  "model_reference": {},
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": {},
  "status": "ACTIVE",
  "is_main_meter": {},
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": {},
  "manufacturer": {},
  "model_reference": {},
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": {},
  "status": "ACTIVE",
  "is_main_meter": {},
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "place_id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "service_place_id": "00000000-0000-0000-0000-000000000000",
  "meter_type": "ELECTRICITY",
  "billing_type": "INDIVIDUAL",
  "serial_number": "EDF-2024-001234",
  "manufacturer": "Itron",
  "model_reference": "Linky G3",
  "installation_date": "2024-08-25",
  "last_inspection_date": "2024-08-25",
  "next_inspection_date": "2024-08-25",
  "unit": "KWH",
  "multiplier": 0,
  "status": "ACTIVE",
  "is_main_meter": true,
  "parent_meter_id": "00000000-0000-0000-0000-000000000000",
  "max_value": {},
  "precision_digits": 0,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a meter

DELETE

https://api.faireplace.com/api

/meters/{id}

Delete a meter

Delete a meter › path Parameters

id

string · uuid · required

Meter ID

Delete a meter › Responses

Meter deleted successfully

No data returned

DELETE/meters/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/meters/:id

shell

Example Responses

No example specified for this content type

List sub-meters

GET

https://api.faireplace.com/api

/meters/{id}/sub-meters

List all sub-meters attached to a parent meter. Used for meter hierarchy (e.g., main electricity meter → individual apartment meters).

List sub-meters › path Parameters

id

string · uuid · required

Parent meter ID

List sub-meters › Responses

Sub-meters retrieved successfully

object[]

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

GET/meters/{id}/sub-meters

curl --request GET \
  --url https://api.faireplace.com/api/meters/:id/sub-meters

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "place_id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "service_place_id": "00000000-0000-0000-0000-000000000000",
    "meter_type": "ELECTRICITY",
    "billing_type": "INDIVIDUAL",
    "serial_number": "EDF-2024-001234",
    "manufacturer": "Itron",
    "model_reference": "Linky G3",
    "installation_date": "2024-08-25",
    "last_inspection_date": "2024-08-25",
    "next_inspection_date": "2024-08-25",
    "unit": "KWH",
    "multiplier": 0,
    "status": "ACTIVE",
    "is_main_meter": true,
    "parent_meter_id": "00000000-0000-0000-0000-000000000000",
    "max_value": {},
    "precision_digits": 0,
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

List meter readings

GET

https://api.faireplace.com/api

/meters/{meter_id}/readings

Retrieve the list of readings for a meter

List meter readings › path Parameters

meter_id

string · uuid · required

Meter ID

List meter readings › query Parameters

reading_type

string

Filter by reading type

is_billing_reading

boolean

Filter by billing reading flag

start_date

string · date-time

Filter readings from this date

end_date

string · date-time

Filter readings until this date

page

integer

Page number

limit

integer

Number of items per page

List meter readings › Responses

Meter readings retrieved successfully

object[]

total

integer

GET/meters/{meter_id}/readings

curl --request GET \
  --url https://api.faireplace.com/api/meters/:meter_id/readings

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "meter_id": "00000000-0000-0000-0000-000000000000",
      "lease_id": "00000000-0000-0000-0000-000000000000",
      "reading_date": "2024-08-25T15:00:00Z",
      "reading_type": "MANUAL",
      "value": 0,
      "previous_value": {},
      "consumption": {},
      "is_estimated": true,
      "is_billing_reading": true,
      "photo_url": {},
      "reader_name": {},
      "notes": {},
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "total": 0
}

json

application/json

Create a meter reading

POST

https://api.faireplace.com/api

/meters/{meter_id}/readings

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.

Create a meter reading › path Parameters

meter_id

string · uuid · required

Meter ID

Create a meter reading › Request Body

Create a new meter reading. **Auto-populated fields:** - `previous_value` — automatically set from the latest reading - `consumption` — automatically calculated: `(value - previous_value) * multiplier` **Validation rules:** - `value` must be >= 0 - `reading_date` cannot be in the future

reading_date

string · date-time · required

reading_type

string · enum · 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)

Enum values:

MANUAL

AUTOMATIC

PHOTO

ESTIMATED

Example: MANUAL

value

number · decimal · min: 0 · required

lease_id

string | null · uuid

is_estimated

boolean

Default: false

is_billing_reading

boolean

Default: false

photo_url

string | null

reader_name

string | null

notes

string | null

Create a meter reading › Responses

Meter reading created successfully

A reading captured from a meter at a specific point in time. Consumption is automatically calculated from the difference between current and previous readings, accounting for the meter's multiplier and potential rollover.

id

string · uuid · required

meter_id

string · uuid · required

reading_date

string · date-time · required

Date and time of the reading

reading_type

string · enum · 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)

Enum values:

MANUAL

AUTOMATIC

PHOTO

ESTIMATED

Example: MANUAL

value

number · decimal · min: 0 · required

The meter reading value

is_estimated

boolean · required

Whether the reading is an estimate

Default: false

is_billing_reading

boolean · required

Whether this reading is used for billing

Default: false

created_at

string · date-time · required

updated_at

string · date-time · required

lease_id

string | null · uuid

Optional lease association

previous_value

number | null · decimal

Previous reading value (auto-populated)

consumption

number | null · decimal

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

photo_url

string | null

URL to photo of the meter reading

reader_name

string | null

Name of the person who took the reading

notes

string | null

POST/meters/{meter_id}/readings

curl --request POST \
  --url https://api.faireplace.com/api/meters/:meter_id/readings \
  --header 'Content-Type: application/json' \
  --data '
{
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": 0,
  "is_estimated": true,
  "is_billing_reading": true,
  "photo_url": {},
  "reader_name": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": 0,
  "is_estimated": true,
  "is_billing_reading": true,
  "photo_url": {},
  "reader_name": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "meter_id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": 0,
  "previous_value": {},
  "consumption": {},
  "is_estimated": true,
  "is_billing_reading": true,
  "photo_url": {},
  "reader_name": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get latest meter reading

GET

https://api.faireplace.com/api

/meters/{meter_id}/readings/latest

Get the most recent reading for this meter.

Get latest meter reading › path Parameters

meter_id

string · uuid · required

Meter ID

Get latest meter reading › Responses

Latest meter reading retrieved successfully

id

string · uuid · required

meter_id

string · uuid · required

reading_date

string · date-time · required

Date and time of the reading

reading_type

string · enum · 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)

Enum values:

MANUAL

AUTOMATIC

PHOTO

ESTIMATED

Example: MANUAL

value

number · decimal · min: 0 · required

The meter reading value

is_estimated

boolean · required

Whether the reading is an estimate

Default: false

is_billing_reading

boolean · required

Whether this reading is used for billing

Default: false

created_at

string · date-time · required

updated_at

string · date-time · required

lease_id

string | null · uuid

Optional lease association

previous_value

number | null · decimal

Previous reading value (auto-populated)

consumption

number | null · decimal

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

photo_url

string | null

URL to photo of the meter reading

reader_name

string | null

Name of the person who took the reading

notes

string | null

GET/meters/{meter_id}/readings/latest

curl --request GET \
  --url https://api.faireplace.com/api/meters/:meter_id/readings/latest

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "meter_id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": 0,
  "previous_value": {},
  "consumption": {},
  "is_estimated": true,
  "is_billing_reading": true,
  "photo_url": {},
  "reader_name": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get a meter reading

GET

https://api.faireplace.com/api

/meters/{meter_id}/readings/{reading_id}

Retrieve a specific meter reading

Get a meter reading › path Parameters

meter_id

string · uuid · required

Meter ID

reading_id

string · uuid · required

Reading ID

Get a meter reading › Responses

Meter reading retrieved successfully

id

string · uuid · required

meter_id

string · uuid · required

reading_date

string · date-time · required

Date and time of the reading

reading_type

string · enum · 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)

Enum values:

MANUAL

AUTOMATIC

PHOTO

ESTIMATED

Example: MANUAL

value

number · decimal · min: 0 · required

The meter reading value

is_estimated

boolean · required

Whether the reading is an estimate

Default: false

is_billing_reading

boolean · required

Whether this reading is used for billing

Default: false

created_at

string · date-time · required

updated_at

string · date-time · required

lease_id

string | null · uuid

Optional lease association

previous_value

number | null · decimal

Previous reading value (auto-populated)

consumption

number | null · decimal

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

photo_url

string | null

URL to photo of the meter reading

reader_name

string | null

Name of the person who took the reading

notes

string | null

GET/meters/{meter_id}/readings/{reading_id}

curl --request GET \
  --url https://api.faireplace.com/api/meters/:meter_id/readings/:reading_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "meter_id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": 0,
  "previous_value": {},
  "consumption": {},
  "is_estimated": true,
  "is_billing_reading": true,
  "photo_url": {},
  "reader_name": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update a meter reading

PUT

https://api.faireplace.com/api

/meters/{meter_id}/readings/{reading_id}

Update an existing meter reading

Update a meter reading › path Parameters

meter_id

string · uuid · required

Meter ID

reading_id

string · uuid · required

Reading ID

Update a meter reading › Request Body

Partial update of a meter reading.

reading_date

string | null · date-time

reading_type

string · enum

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)

Enum values:

MANUAL

AUTOMATIC

PHOTO

ESTIMATED

Example: MANUAL

value

number | null · decimal · min: 0

is_estimated

boolean | null

is_billing_reading

boolean | null

photo_url

string | null

reader_name

string | null

notes

string | null

Update a meter reading › Responses

Meter reading updated successfully

id

string · uuid · required

meter_id

string · uuid · required

reading_date

string · date-time · required

Date and time of the reading

reading_type

string · enum · 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)

Enum values:

MANUAL

AUTOMATIC

PHOTO

ESTIMATED

Example: MANUAL

value

number · decimal · min: 0 · required

The meter reading value

is_estimated

boolean · required

Whether the reading is an estimate

Default: false

is_billing_reading

boolean · required

Whether this reading is used for billing

Default: false

created_at

string · date-time · required

updated_at

string · date-time · required

lease_id

string | null · uuid

Optional lease association

previous_value

number | null · decimal

Previous reading value (auto-populated)

consumption

number | null · decimal

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

photo_url

string | null

URL to photo of the meter reading

reader_name

string | null

Name of the person who took the reading

notes

string | null

PUT/meters/{meter_id}/readings/{reading_id}

curl --request PUT \
  --url https://api.faireplace.com/api/meters/:meter_id/readings/:reading_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": {},
  "is_estimated": {},
  "is_billing_reading": {},
  "photo_url": {},
  "reader_name": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": {},
  "is_estimated": {},
  "is_billing_reading": {},
  "photo_url": {},
  "reader_name": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "meter_id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "reading_date": "2024-08-25T15:00:00Z",
  "reading_type": "MANUAL",
  "value": 0,
  "previous_value": {},
  "consumption": {},
  "is_estimated": true,
  "is_billing_reading": true,
  "photo_url": {},
  "reader_name": {},
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a meter reading

DELETE

https://api.faireplace.com/api

/meters/{meter_id}/readings/{reading_id}

Delete a meter reading

Delete a meter reading › path Parameters

meter_id

string · uuid · required

Meter ID

reading_id

string · uuid · required

Reading ID

Delete a meter reading › Responses

Meter reading deleted successfully

No data returned

DELETE/meters/{meter_id}/readings/{reading_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/meters/:meter_id/readings/:reading_id

shell

Example Responses

No example specified for this content type

List meters for a place

GET

https://api.faireplace.com/api

/places/{place_id}/meters

Retrieve all meters installed in a specific place (building/residence).

List meters for a place › path Parameters

place_id

string · uuid · required

Place ID

List meters for a place › Responses

Meters retrieved

object[]

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

GET/places/{place_id}/meters

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/meters

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "place_id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "service_place_id": "00000000-0000-0000-0000-000000000000",
    "meter_type": "ELECTRICITY",
    "billing_type": "INDIVIDUAL",
    "serial_number": "EDF-2024-001234",
    "manufacturer": "Itron",
    "model_reference": "Linky G3",
    "installation_date": "2024-08-25",
    "last_inspection_date": "2024-08-25",
    "next_inspection_date": "2024-08-25",
    "unit": "KWH",
    "multiplier": 0,
    "status": "ACTIVE",
    "is_main_meter": true,
    "parent_meter_id": "00000000-0000-0000-0000-000000000000",
    "max_value": {},
    "precision_digits": 0,
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

List meters for an estate

GET

https://api.faireplace.com/api

/estates/{estate_id}/meters

Retrieve all meters installed in a specific estate (lot).

List meters for an estate › path Parameters

estate_id

string · uuid · required

Estate ID

List meters for an estate › Responses

Meters retrieved

object[]

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

GET/estates/{estate_id}/meters

curl --request GET \
  --url https://api.faireplace.com/api/estates/:estate_id/meters

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "place_id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "service_place_id": "00000000-0000-0000-0000-000000000000",
    "meter_type": "ELECTRICITY",
    "billing_type": "INDIVIDUAL",
    "serial_number": "EDF-2024-001234",
    "manufacturer": "Itron",
    "model_reference": "Linky G3",
    "installation_date": "2024-08-25",
    "last_inspection_date": "2024-08-25",
    "next_inspection_date": "2024-08-25",
    "unit": "KWH",
    "multiplier": 0,
    "status": "ACTIVE",
    "is_main_meter": true,
    "parent_meter_id": "00000000-0000-0000-0000-000000000000",
    "max_value": {},
    "precision_digits": 0,
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

List meters for a place-estate combination

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/meters

Retrieve all meters for a specific estate within a place.

List meters for a place-estate combination › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Estate ID

List meters for a place-estate combination › Responses

Meters retrieved

object[]

id

string · uuid · required

meter_type

string · enum · 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

Enum values:

ELECTRICITY

GAS

WATER_HOT

WATER_COLD

HEATING

COOLING

Example: ELECTRICITY

billing_type

string · enum · 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)

Enum values:

INDIVIDUAL

COLLECTIVE

SHARED

INCLUDED

Example: INDIVIDUAL

serial_number

string · required

Unique serial number (unique per tenant)

Example: EDF-2024-001234

installation_date

string · date · required

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

unit

string · enum · required

Unit of measurement for the meter.

Enum values:

KWH

KCAL

BTU

Example: KWH

multiplier

number · decimal · required

Reading multiplier (default 1.0, must be > 0)

Default: 1

status

string · enum · required

Current operational status of the meter.

Enum values:

ACTIVE

INACTIVE

MAINTENANCE

REPLACED

REMOVED

Example: ACTIVE

is_main_meter

boolean · required

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

Default: false

precision_digits

integer · required

Number of decimal digits for readings

Default: 2

created_at

string · date-time · required

updated_at

string · date-time · required

place_id

string | null · uuid

Place where the meter is installed

estate_id

string | null · uuid

Estate (lot) where the meter is installed

service_place_id

string | null · uuid

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

manufacturer

string | null

Meter manufacturer

Example: Itron

model_reference

string | null

Model reference

Example: Linky G3

last_inspection_date

string | null · date

Date of last inspection (must be >= installation_date)

next_inspection_date

string | null · date

Date of next planned inspection

parent_meter_id

string | null · uuid

Parent meter ID (for sub-meter hierarchy)

max_value

number | null · decimal

Maximum value before rollover (for rollover detection)

notes

string | null

GET/places/{place_id}/estates/{estate_id}/meters

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/meters

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "place_id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "service_place_id": "00000000-0000-0000-0000-000000000000",
    "meter_type": "ELECTRICITY",
    "billing_type": "INDIVIDUAL",
    "serial_number": "EDF-2024-001234",
    "manufacturer": "Itron",
    "model_reference": "Linky G3",
    "installation_date": "2024-08-25",
    "last_inspection_date": "2024-08-25",
    "next_inspection_date": "2024-08-25",
    "unit": "KWH",
    "multiplier": 0,
    "status": "ACTIVE",
    "is_main_meter": true,
    "parent_meter_id": "00000000-0000-0000-0000-000000000000",
    "max_value": {},
    "precision_digits": 0,
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Estate Diagnostics Charges