Charges

Create installment schedule

Generate a complete regularization installment schedule for a lease. Divides the total regularization amount into monthly payments (max 12 per Art. 23 al. 5).

Business rules:

  • num_installments must be between 1 and 12
  • total_amount cannot be zero
  • Each installment is rounded to 2 decimal places
  • Last installment adjusted to ensure total equals original amount
post/leases/{lease_id}/charges/installments

Request

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

Path parameters

lease_idstring uuid required

Request body

charge_review_idstring uuid nullable

Link to the charge review that triggered this schedule

total_amountnumber double required

Total regularization amount (cannot be zero)

start_datestring date required

Start date for the first installment

num_installmentsinteger

Number of monthly installments (1-12, per Art. 23 al. 5)

notesstring nullable

Response

Schedule created

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.