Update leasing contract

Updates an existing leasing contract, allowing modification of terms, dates, or status.

This endpoint can be used to progress the contract through lifecycle stages,
modify financial parameters, or update contract terms. Only the fields that
need to be updated should be included in the request.

You can set or update the unpaid_threshold_amount_in_cents to override the customer's default
threshold for unpaid rent alerts for this specific contract.

Quarter Revision Index Update:
To update the revision index, use quarter_revision_index_attributes with quarter, nature, and year
to lookup the index from the database.

Valeur initiale du bail (signing revision index) correction:
To correct the informative "valeur initiale du bail", use signing_quarter_revision_index_id with the revision index public ID. This does not affect quarter_revision_index, the reference index used for the next revision.

Note that the asset_id cannot be changed through this endpoint as it
represents the fundamental property being rented. Creating a new leasing contract
would be the correct approach for changing the asset.

VAT (TVA):

  • You can update vat_applicable and vat_rate to change VAT behavior on the contract
  • When vat_applicable is true, vat_rate must be provided (0..100, decimals allowed)

Rent Indexation:
You can update indexation_enabled to enable or disable IRL rent indexation for this contract.
When enabled (true), the contract will be eligible for automatic annual rent indexation based
on the IRL index, provided a valid quarter_revision_index is set.

Revision Frequency:
You can update revision_frequency_in_years to change the rent revision frequency:

  • 1: Annual revision (default)
  • 3: Triennial revision (for commercial leases)

First Call Only:
Set first_call_only to true when only managing the move-in (mise en location).
Only the first rent call will be generated, with no recurring billing lines.
Mutually exclusive with rental_transfer.

Tenants and Guarantors:
Use tenant_ids / guarantor_ids (arrays of profile public IDs) to replace the tenants
or guarantors of the contract. Provide them in the JSON body, either at the root or inside
the leasing_contract object. Pass an empty array to remove all current associations.
The tenants and guarantors objects returned by GET are read-only and ignored on update.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Leasing contract unique identifier

Body Params
integer

Unique identifier

string

Contract reference code

integer
required

Agency fees charged to the tenant

integer | null

Landlord rental fees in cents. If set, overrides the calculated value from management contract

integer
required

Security deposit amount

integer

Monthly base rent charged to tenant in cents

integer

Monthly charges amount in cents

date

Contract start date

date

Contract end date

date | null

Date the lease was signed

string
enum
required

Current contract lifecycle state

Allowed:
string
enum
required

Type of lease

string

Public ID of the property this contract applies to

tenant_ids
array of strings

Profile public IDs to set as the tenants of the contract. Replaces the current tenants; pass an empty array to remove them all

tenant_ids
guarantor_ids
array of strings

Profile public IDs to set as the guarantors of the contract. Replaces the current guarantors; pass an empty array to remove them all

guarantor_ids
integer
required

Contract duration in months

integer

Day of the month when rent is due

boolean

Whether the contract automatically renews

integer | null

Tacit renewal duration in years (nil=none, 1/3/6/9=specific duration, -1=unlimited)

string
enum

Entity holding the security deposit

Allowed:
string
enum
required

How rental charges are calculated

Allowed:
integer

Threshold amount for unpaid rent alerts, overrides customer configuration when set

boolean

Whether rental transfer is enabled for this contract

boolean
Defaults to false

When true, only the first rent call is generated (for move-in only management). Mutually exclusive with rental_transfer

string

Public ID of the GLI provider

string
enum
required
Defaults to monthly

Rent call frequency (monthly, quarterly, semiannual, annual)

Allowed:
integer
Defaults to 1

First month of the billing cycle (1-12). Controls which months rent is called for non-monthly frequencies. Normalized to 1..frequency_in_months range.

boolean

Whether VAT is applicable for this contract

float

VAT rate as a percentage (0..100). Decimals allowed: e.g., 5.5, 10, 20

boolean
Defaults to true

Whether IRL (Indice de Référence des Loyers) rent indexation is enabled for this contract

integer
enum
Defaults to 1

Rent revision frequency in years (1 = annual, 3 = triennial)

Allowed:
quarter_revision_index_attributes
object
required

Quarter revision index attributes - provide quarter, nature, and year to lookup the index from database

string

Public ID of the revision index used at lease signing

string
enum
Defaults to asset

Scope of the lease - A leasing_contract can be scoped to a single asset or an asset group

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json