Leases

Create a charge meter

Create a new meter association for a charge

post/leases/{lease_id}/charges/{charge_id}/meters

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/charges/{charge_id}/meters
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

charge_idstring uuid required

Charge ID

Request body

lease_charge_idstring uuid required
meter_idstring uuid required
calculation_method'DIRECT' | 'WEIGHTED' | 'SHARED' | 'FIXED_ALLOCATION'

Method used to calculate charge consumption from meter readings.

  • DIRECT: Direct consumption billing
  • WEIGHTED: Weighted by a coefficient
  • SHARED: Shared proportionally among tenants
  • FIXED_ALLOCATION: Fixed allocation regardless of consumption
allocation_rationumber nullable
calculation_formulaobject nullable
is_activeboolean
start_datestring date required
end_datestring date nullable

Example request

{
  "calculation_method": "DIRECT"
}

Response

Charge meter created successfully

idstring uuid required
lease_charge_idstring uuid required
meter_idstring uuid required
calculation_method'DIRECT' | 'WEIGHTED' | 'SHARED' | 'FIXED_ALLOCATION'

Method used to calculate charge consumption from meter readings.

  • DIRECT: Direct consumption billing
  • WEIGHTED: Weighted by a coefficient
  • SHARED: Shared proportionally among tenants
  • FIXED_ALLOCATION: Fixed allocation regardless of consumption
allocation_rationumber nullable

Allocation ratio percentage (0 < x <= 100)

calculation_formulaobject nullable

Custom calculation formula (JSON)

is_activeboolean required

Whether this meter-charge link is currently active

start_datestring date required
end_datestring date nullable
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "calculation_method": "DIRECT"
}

Changes

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