Rent Payments

List rent payments

List all rent payments for a lease, with optional filters by status and period.

Permissions required: leases:read

get/leases/{lease_id}/rent-payments

Request

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

Path parameters

lease_idstring uuid required

Query parameters

status'PENDING' | 'PAID' | 'PARTIALLY_PAID' | 'LATE' | 'UNPAID' | 'IN_DISPUTE'
period_startstring date

Filter payments with period_start >= this date

period_endstring date

Filter payments with period_end <= this date

Response

List of rent payments

idstring uuid
lease_idstring uuid
period_startstring date
period_endstring date
expected_amountnumber
paid_amountnumber
payment_datestring date nullable
payment_methodstring nullable
referencestring nullable
status'PENDING' | 'PAID' | 'PARTIALLY_PAID' | 'LATE' | 'UNPAID' | 'IN_DISPUTE'
receipt_idstring uuid nullable
notesstring nullable
created_atstring date-time
updated_atstring date-time

Changes

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