Leases

Create a lease meter

Create a new meter for a lease

post/leases/{lease_id}/meters

Request

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

Path parameters

lease_idstring uuid required

Lease ID

Request body

lease_idstring uuid required
meter_idstring uuid required
start_datestring date required
end_datestring date nullable
initial_readingnumber nullable
final_readingnumber nullable
reading_frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'ANNUALLY'

Frequency at which meter readings are taken.

is_billing_meterboolean
billing_rationumber nullable

Example request

{
  "reading_frequency": "MONTHLY"
}

Response

Lease meter created successfully

idstring uuid required
lease_idstring uuid required
meter_idstring uuid required

Physical meter ID

start_datestring date required

Date the meter became active for this lease

end_datestring date nullable

Date the meter was deactivated (null = still active)

initial_readingnumber nullable

Meter reading at the start

final_readingnumber nullable

Meter reading at the end

reading_frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'ANNUALLY'

Frequency at which meter readings are taken.

is_billing_meterboolean required

Whether this meter is used for billing

billing_rationumber nullable

Billing ratio percentage (0 < x <= 100)

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "reading_frequency": "MONTHLY"
}

Changes

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