Rent Revisions

Simulate a rent revision

Simulates an IRL-based rent revision for a lease without persisting anything.

Given a target IRL reference quarter and an effective date, the API computes the new rent that would result from indexation, based on the lease's current rent and its baseline IRL value. Use this to preview a revision before recording it.

Usage Example

curl -X POST https://api.faireplace.com/api/leases/660e8400-e29b-41d4-a716-446655440001/rent-revisions/simulate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "new_irl_quarter": "T3-2024",
    "effective_date": "2025-07-01"
  }'

Response:

{
  "previous_rent": 1200.00,
  "new_rent": 1236.00,
  "old_irl_quarter": "T3-2023",
  "old_irl_value": 140.59,
  "new_irl_quarter": "T3-2024",
  "new_irl_value": 144.81,
  "variation_percentage": 3.00,
  "effective_date": "2025-07-01",
  "monthly_increase": 36.00
}
post/leases/{lease_id}/rent-revisions/simulate

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/rent-revisions/simulate
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

Request body

new_irl_quarterstring required

Target IRL reference quarter to apply, in the format T{quarter}-{year}.

Must not be empty. The matching IRL index value must exist in the rent-indices catalog.

effective_datestring date required

Effective date of the simulated revision (ISO 8601 YYYY-MM-DD).

Example request

{
  "new_irl_quarter": "T3-2024",
  "effective_date": "2025-07-01"
}

Response

Revision simulated successfully

previous_rentnumber double required

Current rent before revision (in euros).

new_rentnumber double required

Computed rent after revision (in euros).

old_irl_quarterstring required

Baseline IRL reference quarter currently applied to the lease.

old_irl_valuenumber double required

Official IRL value for the baseline quarter.

new_irl_quarterstring required

IRL reference quarter applied in the simulation.

new_irl_valuenumber double required

Official IRL value for the new quarter.

variation_percentagenumber double required

Percentage variation between the old and new rent.

effective_datestring date required

Effective date of the simulated revision (ISO 8601).

monthly_increasenumber double required

Monthly rent increase resulting from the revision (in euros).

Example response

{
  "previous_rent": 1200,
  "new_rent": 1236,
  "old_irl_quarter": "T3-2023",
  "old_irl_value": 140.59,
  "new_irl_quarter": "T3-2024",
  "new_irl_value": 144.81,
  "variation_percentage": 3,
  "effective_date": "2025-07-01",
  "monthly_increase": 36
}

Changes

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