Leases

Create a charge review

Create a new charge review for a lease.

This implements the annual charge review as defined by Art. 23 of Loi n° 89-462 du 6 juillet 1989. The review compares provisional charges paid by the tenant against actual expenses incurred, and calculates the difference to be settled.

post/leases/{lease_id}/charges/reviews

Request

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

Path parameters

lease_idstring uuid required

Lease ID

Request body

estate_idstring uuid required
yearinteger required
start_datestring date-time required
end_datestring date-time required
total_provisional_amountnumber required
total_actual_amountnumber nullable
notesstring nullable
distribution_modestring nullable

Response

Review created successfully

idstring uuid required
estate_idstring uuid required

Estate being reviewed

yearinteger required

Year under review

status'DRAFT' | 'IN_PROGRESS' | 'PENDING_VALIDATION' | 'VALIDATED' | 'SENT' | 'DISPUTED' | 'CLOSED' required

Status of an annual charge review (Art. 23 Loi 89-462).

start_datestring date-time required

Review period start

end_datestring date-time required

Review period end

total_provisional_amountnumber required

Total provisions collected during the period

total_actual_amountnumber nullable

Total actual expenses

total_difference_amountnumber nullable

Difference (positive = tenant owes, negative = credit)

notification_datestring date-time nullable

Date the regularization notice was sent to tenant

validation_datestring date-time nullable

Date the review was validated

notesstring nullable
linesobject nullable

Breakdown by nature (JSON)

distribution_modestring nullable

Distribution mode used

documents_available_untilstring date-time nullable

Date until supporting documents are available (6 months per Art. 23 al. 4)

settlement_directionstring nullable

OVERPAYMENT or UNDERPAYMENT

settlement_amountnumber nullable

Amount to settle

settlement_statusstring nullable

Settlement status

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "year": 2024,
  "status": "DRAFT"
}

Changes

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