Charges

Update installment

Update a regularization installment (status, payment date, notes).

put/leases/{lease_id}/charges/installments/{installment_id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/charges/installments/{installment_id}
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
installment_idstring uuid required

Request body

status'PENDING' | 'PAID' | 'OVERDUE' | 'CANCELLED'

Status of a regularization installment:

  • PENDING: Payment due
  • PAID: Payment received
  • OVERDUE: Payment overdue
  • CANCELLED: Installment cancelled
payment_datestring date nullable

Actual payment date

notesstring nullable

Response

Installment updated

idstring uuid
lease_idstring uuid
charge_review_idstring uuid nullable

Associated charge review (bilan de régularisation)

total_amountnumber double

Total regularization amount to spread

installment_numberinteger

Installment number (1-12)

total_installmentsinteger

Total number of installments (max 12)

installment_amountnumber double

Amount for this installment

due_datestring date

Payment due date

payment_datestring date nullable

Actual payment date (when paid)

status'PENDING' | 'PAID' | 'OVERDUE' | 'CANCELLED'

Status of a regularization installment:

  • PENDING: Payment due
  • PAID: Payment received
  • OVERDUE: Payment overdue
  • CANCELLED: Installment cancelled
notesstring nullable
created_atstring date-time
updated_atstring date-time

Changes

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