Rent Revisions

Lease rent revision (IRL indexation): simulate, record, list, and apply annual rent revisions on a lease.

Simulate a rent revision

POST

https://api.faireplace.com/api

/leases/{lease_id}/rent-revisions/simulate

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

Code
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:


Code
{
  "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
}

Simulate a rent revision › path Parameters

lease_id

string · uuid · required

Lease ID

Simulate a rent revision › Request Body

Request to simulate a rent revision (IRL indexation) without persisting anything. The simulation computes the new rent that would result from applying the provided IRL reference quarter, based on the lease's current rent and its baseline IRL value.

SimulateRevisionRequest

new_irl_quarter

string · 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.

Example: T3-2024

effective_date

string · date · required

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

Example: 2025-07-01

Simulate a rent revision › Responses

Revision simulated successfully

Result of a rent revision simulation. Amounts are expressed in euros (decimal). The simulation does not modify the lease.

RevisionSimulationResponse

previous_rent

number · double · required

Current rent before revision (in euros).

Example: 1200

new_rent

number · double · required

Computed rent after revision (in euros).

Example: 1236

old_irl_quarter

string · required

Baseline IRL reference quarter currently applied to the lease.

Example: T3-2023

old_irl_value

number · double · required

Official IRL value for the baseline quarter.

Example: 140.59

new_irl_quarter

string · required

IRL reference quarter applied in the simulation.

Example: T3-2024

new_irl_value

number · double · required

Official IRL value for the new quarter.

Example: 144.81

variation_percentage

number · double · required

Percentage variation between the old and new rent.

Example: 3

effective_date

string · date · required

Effective date of the simulated revision (ISO 8601).

Example: 2025-07-01

monthly_increase

number · double · required

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

Example: 36

List rent revisions

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-revisions

Retrieves the full history of recorded rent revisions for a lease, ordered chronologically.

Usage Example

Code
curl -X GET https://api.faireplace.com/api/leases/660e8400-e29b-41d4-a716-446655440001/rent-revisions \
  -H "Authorization: Bearer YOUR_API_KEY"

List rent revisions › path Parameters

lease_id

string · uuid · required

Lease ID

List rent revisions › Responses

Revision history retrieved successfully

RentRevisionRecord[]

A persisted rent revision record. Captures the indexation applied to a lease, including the previous and new rent, the IRL index value used, and any applicable increase cap or special period.

RentRevisionRecord

id

string · uuid · required

Unique identifier of the revision record.

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant (organization) identifier owning this revision.

Example: tenant_123

lease_id

string · uuid · required

Lease to which the revision applies.

Example: 660e8400-e29b-41d4-a716-446655440001

index_value_id

string · uuid · required

Identifier of the IRL index value used for the revision.

Example: 770e8400-e29b-41d4-a716-446655440002

revision_date

string · date · required

Effective date of the revision (ISO 8601).

Example: 2025-07-01

previous_amount

number · double · required

Rent amount before the revision (in euros).

Example: 1200

new_amount

number · double · required

Rent amount after the revision (in euros).

Example: 1236

percentage_change

number · double · required

Percentage change between previous and new rent.

Example: 3

capped_increase

boolean · required

Whether the increase was capped by a legislative increase cap.

Example: false

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

increase_cap_id

string | null · uuid

Identifier of the increase cap applied, if any.

Example: 880e8400-e29b-41d4-a716-446655440003

special_period_id

string | null · uuid

Identifier of the special (legislative) period applied, if any.

Example: 990e8400-e29b-41d4-a716-446655440004

object | null

Free-form JSON details about the revision computation.

GET/leases/{lease_id}/rent-revisions

curl https://api.faireplace.com/api/leases/:lease_id/rent-revisions \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tenant_id": "tenant_123",
    "lease_id": "660e8400-e29b-41d4-a716-446655440001",
    "index_value_id": "770e8400-e29b-41d4-a716-446655440002",
    "increase_cap_id": "880e8400-e29b-41d4-a716-446655440003",
    "special_period_id": "990e8400-e29b-41d4-a716-446655440004",
    "revision_date": "2025-07-01",
    "previous_amount": 1200,
    "new_amount": 1236,
    "percentage_change": 3,
    "capped_increase": false,
    "revision_details": {},
    "created_at": "2025-06-15T10:30:00Z",
    "updated_at": "2025-06-15T10:30:00Z"
  }
]

json

application/json

Record a rent revision

POST

https://api.faireplace.com/api

/leases/{lease_id}/rent-revisions

Records (persists) an IRL-based rent revision for a lease.

The revision is computed from the provided IRL reference quarter and stored as a historical record. Recording does not change the active rent — call PUT /leases/{lease_id}/rent-revisions/{revision_id}/apply to apply it.

Usage Example

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

Record a rent revision › path Parameters

lease_id

string · uuid · required

Lease ID

Record a rent revision › Request Body

Request to record (persist) a rent revision for a lease. The revision is computed from the provided IRL reference quarter and stored as a historical record. Use `PUT .../apply` afterwards to apply it to the active rent.

RecordRevisionRequest

new_irl_quarter

string · required

IRL reference quarter to apply, in the format T{quarter}-{year}. Must not be empty.

Example: T3-2024

effective_date

string · date · required

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

Example: 2025-07-01

Record a rent revision › Responses

Revision recorded successfully

A persisted rent revision record. Captures the indexation applied to a lease, including the previous and new rent, the IRL index value used, and any applicable increase cap or special period.

RentRevisionRecord

id

string · uuid · required

Unique identifier of the revision record.

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant (organization) identifier owning this revision.

Example: tenant_123

lease_id

string · uuid · required

Lease to which the revision applies.

Example: 660e8400-e29b-41d4-a716-446655440001

index_value_id

string · uuid · required

Identifier of the IRL index value used for the revision.

Example: 770e8400-e29b-41d4-a716-446655440002

revision_date

string · date · required

Effective date of the revision (ISO 8601).

Example: 2025-07-01

previous_amount

number · double · required

Rent amount before the revision (in euros).

Example: 1200

new_amount

number · double · required

Rent amount after the revision (in euros).

Example: 1236

percentage_change

number · double · required

Percentage change between previous and new rent.

Example: 3

capped_increase

boolean · required

Whether the increase was capped by a legislative increase cap.

Example: false

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

increase_cap_id

string | null · uuid

Identifier of the increase cap applied, if any.

Example: 880e8400-e29b-41d4-a716-446655440003

special_period_id

string | null · uuid

Identifier of the special (legislative) period applied, if any.

Example: 990e8400-e29b-41d4-a716-446655440004

object | null

Free-form JSON details about the revision computation.

POST/leases/{lease_id}/rent-revisions

curl https://api.faireplace.com/api/leases/:lease_id/rent-revisions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "new_irl_quarter": "T3-2024",
  "effective_date": "2025-07-01"
}'

Example Request Body

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

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "tenant_123",
  "lease_id": "660e8400-e29b-41d4-a716-446655440001",
  "index_value_id": "770e8400-e29b-41d4-a716-446655440002",
  "increase_cap_id": "880e8400-e29b-41d4-a716-446655440003",
  "special_period_id": "990e8400-e29b-41d4-a716-446655440004",
  "revision_date": "2025-07-01",
  "previous_amount": 1200,
  "new_amount": 1236,
  "percentage_change": 3,
  "capped_increase": false,
  "revision_details": {},
  "created_at": "2025-06-15T10:30:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

json

application/json

Get a rent revision

GET

https://api.faireplace.com/api

/leases/{lease_id}/rent-revisions/{revision_id}

Retrieves a single recorded rent revision by its identifier.

Usage Example

Code
curl -X GET https://api.faireplace.com/api/leases/660e8400-e29b-41d4-a716-446655440001/rent-revisions/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

Get a rent revision › path Parameters

lease_id

string · uuid · required

Lease ID

revision_id

string · uuid · required

Rent revision ID

Get a rent revision › Responses

Revision retrieved successfully

A persisted rent revision record. Captures the indexation applied to a lease, including the previous and new rent, the IRL index value used, and any applicable increase cap or special period.

RentRevisionRecord

id

string · uuid · required

Unique identifier of the revision record.

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant (organization) identifier owning this revision.

Example: tenant_123

lease_id

string · uuid · required

Lease to which the revision applies.

Example: 660e8400-e29b-41d4-a716-446655440001

index_value_id

string · uuid · required

Identifier of the IRL index value used for the revision.

Example: 770e8400-e29b-41d4-a716-446655440002

revision_date

string · date · required

Effective date of the revision (ISO 8601).

Example: 2025-07-01

previous_amount

number · double · required

Rent amount before the revision (in euros).

Example: 1200

new_amount

number · double · required

Rent amount after the revision (in euros).

Example: 1236

percentage_change

number · double · required

Percentage change between previous and new rent.

Example: 3

capped_increase

boolean · required

Whether the increase was capped by a legislative increase cap.

Example: false

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

increase_cap_id

string | null · uuid

Identifier of the increase cap applied, if any.

Example: 880e8400-e29b-41d4-a716-446655440003

special_period_id

string | null · uuid

Identifier of the special (legislative) period applied, if any.

Example: 990e8400-e29b-41d4-a716-446655440004

object | null

Free-form JSON details about the revision computation.

GET/leases/{lease_id}/rent-revisions/{revision_id}

curl https://api.faireplace.com/api/leases/:lease_id/rent-revisions/:revision_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "tenant_123",
  "lease_id": "660e8400-e29b-41d4-a716-446655440001",
  "index_value_id": "770e8400-e29b-41d4-a716-446655440002",
  "increase_cap_id": "880e8400-e29b-41d4-a716-446655440003",
  "special_period_id": "990e8400-e29b-41d4-a716-446655440004",
  "revision_date": "2025-07-01",
  "previous_amount": 1200,
  "new_amount": 1236,
  "percentage_change": 3,
  "capped_increase": false,
  "revision_details": {},
  "created_at": "2025-06-15T10:30:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

json

application/json

Apply a rent revision

PUT

https://api.faireplace.com/api

/leases/{lease_id}/rent-revisions/{revision_id}/apply

Applies a previously recorded rent revision to the lease, updating its active rent to the revision's new_amount.

Usage Example

Code
curl -X PUT https://api.faireplace.com/api/leases/660e8400-e29b-41d4-a716-446655440001/rent-revisions/550e8400-e29b-41d4-a716-446655440000/apply \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:


Code
{
  "message": "Révision appliquée avec succès",
  "revision_id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "660e8400-e29b-41d4-a716-446655440001"
}

Apply a rent revision › path Parameters

lease_id

string · uuid · required

Lease ID

revision_id

string · uuid · required

Rent revision ID to apply

Apply a rent revision › Responses

Revision applied successfully

Confirmation returned after applying a recorded rent revision to the lease.

ApplyRevisionResponse

message

string · required

Human-readable confirmation message.

Example: Révision appliquée avec succès

revision_id

string · uuid · required

Identifier of the revision that was applied.

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Identifier of the lease whose rent was updated.

Example: 660e8400-e29b-41d4-a716-446655440001

Usage Public Tools