Rent Payments

Get a rent payment

Retrieve a specific rent payment by ID.

Permissions required: leases:read

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

Request

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

Path parameters

lease_idstring uuid required
payment_idstring uuid required

Response

Payment details

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.