Rent Payments

Record a rent payment

Record a rent payment for a lease period.

The payment status is auto-computed based on amounts and dates:

  • PAID if paid_amount >= expected_amount
  • PARTIALLY_PAID if paid_amount > 0 but less than expected
  • LATE if no payment and period_end has passed
  • PENDING if no payment but period not yet ended

Permissions required: leases:write

post/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

Lease ID

Request body

period_startstring date required

Start of the rent period

period_endstring date required

End of the rent period

expected_amountnumber required

Expected rent amount (rent + charges)

paid_amountnumber required

Amount actually paid

payment_datestring date nullable

Date of payment

payment_method'VIREMENT_BANCAIRE' | 'PRELEVEMENT_AUTOMATIQUE' | 'CHEQUE' | 'ESPECES' | 'CARTE_BANCAIRE' | 'MANDAT_CASH' | 'AUTRE' nullable

Payment method

referencestring nullable

Payment reference (transfer number, check number)

notesstring nullable

Optional notes

Example request

{
  "period_start": "2025-01-01",
  "period_end": "2025-01-31",
  "expected_amount": 900,
  "paid_amount": 900,
  "payment_date": "2025-01-05"
}

Response

Payment recorded successfully

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.