Rent Payments

Update a rent payment

Update a rent payment. Status is auto-recalculated unless manually overridden.

Permissions required: leases:write

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

Request body

paid_amountnumber
payment_datestring date
payment_method'VIREMENT_BANCAIRE' | 'PRELEVEMENT_AUTOMATIQUE' | 'CHEQUE' | 'ESPECES' | 'CARTE_BANCAIRE' | 'MANDAT_CASH' | 'AUTRE'
referencestring
status'PENDING' | 'PAID' | 'PARTIALLY_PAID' | 'LATE' | 'UNPAID' | 'IN_DISPUTE'

Manually override status (otherwise auto-computed)

receipt_idstring uuid
notesstring

Response

Payment updated

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.