FairePlace Property Management API

Amendment Rent Details

Endpointhttps://api.faireplace.com/api

Get rent modification details

GET

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/rent-detail

Retrieve the rent detail for a specific amendment.

Get rent modification details › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

Get rent modification details › Responses

Rent detail

Rent modification details for a RENT_MODIFICATION amendment (1:1 relationship)

id

string · uuid · required

amendment_id

string · uuid · required

previous_amount

number · decimal · required

Previous monthly rent amount (EUR)

Example: 850

new_amount

number · decimal · required

New monthly rent amount (EUR). In zone tendue, must not exceed reference_rent_increased_per_m2 x surface (Art. 17-2 Loi 89-462)

Example: 875.5

calculation_method

string · enum · required

Method used to calculate the new rent

Enum values:

INDEX_BASED

NEGOTIATED

LEGAL_INCREASE

CAPPED

Example: INDEX_BASED

increase_percentage

number | null · decimal

Percentage increase

Example: 3

index_value_id

string | null · uuid

Reference to the rent index value used for calculation

increase_cap_id

string | null · uuid

Reference to the rent increase cap applied

calculation_details

object | null

JSON details of the calculation methodology

GET/leases/{lease_id}/amendments/{amendment_id}/rent-detail

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/rent-detail

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "previous_amount": 850,
  "new_amount": 875.5,
  "increase_percentage": 3,
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}

json

application/json

Update rent modification details

PUT

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/rent-detail

Update the rent detail for an amendment. Since rent detail is a 1:1 relationship, no detail ID is needed — the system identifies the detail by amendment ID.

Update rent modification details › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

Update rent modification details › Request Body

Data for updating rent modification details

previous_amount

number | null · decimal

new_amount

number | null · decimal

increase_percentage

number | null · decimal

index_value_id

string | null · uuid

increase_cap_id

string | null · uuid

calculation_method

string | null · enum

Enum values:

INDEX_BASED

NEGOTIATED

LEGAL_INCREASE

CAPPED

calculation_details

object | null

Update rent modification details › Responses

Rent detail updated

Rent modification details for a RENT_MODIFICATION amendment (1:1 relationship)

id

string · uuid · required

amendment_id

string · uuid · required

previous_amount

number · decimal · required

Previous monthly rent amount (EUR)

Example: 850

new_amount

number · decimal · required

New monthly rent amount (EUR). In zone tendue, must not exceed reference_rent_increased_per_m2 x surface (Art. 17-2 Loi 89-462)

Example: 875.5

calculation_method

string · enum · required

Method used to calculate the new rent

Enum values:

INDEX_BASED

NEGOTIATED

LEGAL_INCREASE

CAPPED

Example: INDEX_BASED

increase_percentage

number | null · decimal

Percentage increase

Example: 3

index_value_id

string | null · uuid

Reference to the rent index value used for calculation

increase_cap_id

string | null · uuid

Reference to the rent increase cap applied

calculation_details

object | null

JSON details of the calculation methodology

PUT/leases/{lease_id}/amendments/{amendment_id}/rent-detail

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/rent-detail \
  --header 'Content-Type: application/json' \
  --data '
{
  "previous_amount": {},
  "new_amount": {},
  "increase_percentage": {},
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}
'

shell

Example Request Body

{
  "previous_amount": {},
  "new_amount": {},
  "increase_percentage": {},
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "previous_amount": 850,
  "new_amount": 875.5,
  "increase_percentage": 3,
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}

json

application/json

Create rent modification details

POST

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/rent-detail

Create the rent detail for a RENT_MODIFICATION amendment. Only one rent detail can exist per amendment (1:1 relationship).

Validation rules:

previous_amount and new_amount must be >= 0
In zone tendue, the new amount is validated against reference_rent_increased_per_m2 x surface at activation (Art. 17-2 Loi 89-462 / ALUR)

Create rent modification details › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

Create rent modification details › Request Body

Data for creating rent modification details

previous_amount

number · decimal · required

Previous monthly rent (must be >= 0)

Example: 850

new_amount

number · decimal · required

New monthly rent (must be >= 0)

Example: 875.5

calculation_method

string · enum · required

Enum values:

INDEX_BASED

NEGOTIATED

LEGAL_INCREASE

CAPPED

increase_percentage

number | null · decimal

index_value_id

string | null · uuid

increase_cap_id

string | null · uuid

calculation_details

object | null

Create rent modification details › Responses

Rent detail created

Rent modification details for a RENT_MODIFICATION amendment (1:1 relationship)

id

string · uuid · required

amendment_id

string · uuid · required

previous_amount

number · decimal · required

Previous monthly rent amount (EUR)

Example: 850

new_amount

number · decimal · required

New monthly rent amount (EUR). In zone tendue, must not exceed reference_rent_increased_per_m2 x surface (Art. 17-2 Loi 89-462)

Example: 875.5

calculation_method

string · enum · required

Method used to calculate the new rent

Enum values:

INDEX_BASED

NEGOTIATED

LEGAL_INCREASE

CAPPED

Example: INDEX_BASED

increase_percentage

number | null · decimal

Percentage increase

Example: 3

index_value_id

string | null · uuid

Reference to the rent index value used for calculation

increase_cap_id

string | null · uuid

Reference to the rent increase cap applied

calculation_details

object | null

JSON details of the calculation methodology

POST/leases/{lease_id}/amendments/{amendment_id}/rent-detail

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/rent-detail \
  --header 'Content-Type: application/json' \
  --data '
{
  "previous_amount": 850,
  "new_amount": 875.5,
  "increase_percentage": {},
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}
'

shell

Example Request Body

{
  "previous_amount": 850,
  "new_amount": 875.5,
  "increase_percentage": {},
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "previous_amount": 850,
  "new_amount": 875.5,
  "increase_percentage": 3,
  "index_value_id": "00000000-0000-0000-0000-000000000000",
  "increase_cap_id": "00000000-0000-0000-0000-000000000000",
  "calculation_method": "INDEX_BASED",
  "calculation_details": {}
}

json

application/json

Delete rent modification details

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/rent-detail

Delete the rent detail for an amendment. Since rent detail is a 1:1 relationship, no detail ID is needed.

Delete rent modification details › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

Delete rent modification details › Responses

Rent detail deleted

No data returned

DELETE/leases/{lease_id}/amendments/{amendment_id}/rent-detail

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/rent-detail

shell

Example Responses

No example specified for this content type

Amendment Validations Amendment Duration Details