Leases

Transition review status

Transition the status of a charge review.

Valid statuses: DRAFT, IN_PROGRESS, PENDING_VALIDATION, VALIDATED, SENT, DISPUTED, CLOSED.

post/leases/{lease_id}/charges/reviews/{review_id}/transition

Request

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

Path parameters

lease_idstring uuid required

Lease ID

review_idstring uuid required

Review ID

Request body

Target status for the review

Response

Review status transitioned successfully

idstring uuid required

estate_idstring uuid required

Estate being reviewed

yearinteger required

Year under review

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.