Rent Payments

Get tenant balance

Returns the aggregated balance for a lease: total expected, total paid, arrears, overpayment, and count of unpaid periods.

Permissions required: leases:read

get/leases/{lease_id}/rent-payments/balance

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/rent-payments/balance
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Response

Lease balance

lease_idstring uuid
total_expectednumber

Total expected rent across all periods

total_paidnumber

Total amount paid

arrearsnumber

Amount owed (total_expected - total_paid, min 0)

overpaymentnumber

Overpayment amount (total_paid - total_expected, min 0)

unpaid_periodsinteger

Count of periods with LATE or UNPAID status

Changes

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