Rent Payments

Generate payment schedule

Generates expected payment entries for a date range based on the lease parameters (rent amount, frequency). Skips periods where a payment already exists.

Permissions required: leases:write

post/leases/{lease_id}/rent-payments/generate-schedule

Request

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

Path parameters

lease_idstring uuid required

Request body

range_startstring date required
range_endstring date required

Example request

{
  "range_start": "2025-01-01",
  "range_end": "2025-12-31"
}

Response

Payment schedule entries created

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.