Charges

List distribution references for a lease

Retrieve distribution references scoped to a specific lease's charges

get/leases/{lease_id}/charges/distribution-references

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/charges/distribution-references
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Query parameters

estate_idstring uuid

Keep only references for this estate.

distribution_key_idstring uuid

Keep only references using this distribution key.

Response

Distribution references retrieved

idstring uuid required
distribution_key_idstring uuid required

Distribution key this reference belongs to

estate_idstring uuid required

Estate this reference applies to

reference_datestring date-time required

Date of the reference measurement

reference_valuenumber required

Reference value (e.g., surface area, number of occupants)

supporting_documentobject nullable

Reference to supporting document (JSON)

notesstring nullable

Additional notes

created_atstring date-time required
updated_atstring date-time required

Changes

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