Update leasing contract

patch

https://rivage.immo/api/v1/leasing_contracts/{id}

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_rates to change VAT behavior independently for rent and charges
When vat_rates is present, it takes precedence and vat_applicable is derived from its values
vat_applicable, vat_rate and vat_on_rent_only remain accepted when vat_rates is omitted, but are deprecated

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Leasing contract unique identifier

Body Params

string

Public leasing contract identifier (for example lc_abc123)

reference

string

Contract reference code

tenant_fees_in_cents

integer

required

≥ 0

Total agency fees charged to the tenant. Writing it alone on a broken-down contract clears tenant_fees_breakdown

tenant_fees_breakdown

object | null

Split of the tenant fees between letting and move-in inventory services. Null when the contract carries a single global amount. When written, tenant_fees_in_cents is derived from the sum; supplying both must be consistent

landlord_rental_fees_in_cents

integer | null

One-off letting fees charged to the landlord, in cents. This is not the recurring management fee. If set, it overrides the amount calculated from the management contract

deposit_in_cents

integer

required

Security deposit amount

rent_in_cents

integer

Monthly rent excluding charges in cents. Includes the optional rent supplement.

rent_supplement_in_cents

integer | null

Informational breakdown of the rent supplement already included in rent_in_cents

rent_supplement_justification

string | null

Reason justifying the rent supplement. Required when rent_supplement_in_cents is positive

charges_in_cents

integer

Monthly charges amount in cents

start_date

date

Contract start date

end_date

date

Contract end date

signed_at

date | null

Date the lease was signed

status

string

enum

required

Current contract lifecycle state

Allowed:

nature

string

enum

required

Type of lease

asset_id

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

duration_in_months

integer

required

Contract duration in months

rent_due_day

integer

Day of the month when rent is due

tacit_renewal

boolean

Whether the contract automatically renews

tacit_renewal_duration_years

integer | null

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

guaranteed_renewals_count

integer

enum

Defaults to 0

Number of lease renewals covered by the guarantee, in addition to the initial lease term

Allowed:

deposit_retained_by

string

enum

Entity holding the security deposit

Allowed:

charges_nature

string

enum

required

How rental charges are calculated

Allowed:

unpaid_threshold_amount_in_cents

integer

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

rental_transfer

boolean

Whether rental transfer is enabled for this contract

first_call_only

boolean

Defaults to false

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

gli_provider_id

string

Public ID of the GLI provider

frequency_in_months

integer

enum

required

Defaults to 1

Rent call frequency in months: 1 (monthly), 3 (quarterly), 6 (semiannual), or 12 (annual)

Allowed:

period_start_month

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.

vat_applicable

boolean

deprecated

Deprecated: use vat_rates instead. Whether VAT is applicable, derived from the component rates.

vat_rates

object

VAT rates as percentages for each lease component. When provided, this object takes precedence over the deprecated VAT fields. Both rates must be between 0 and 100.

vat_rate

float

deprecated

Deprecated: use vat_rates.rent instead. VAT rate as a percentage (0..100).

vat_on_rent_only

boolean

deprecated

Deprecated: use vat_rates.rent and vat_rates.charges instead.

indexation_enabled

boolean

Defaults to true

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

revision_frequency_in_years

integer

enum

Defaults to 1

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

Allowed:

quarter_revision_index_attributes

object

Quarter revision index attributes - provide quarter, nature, and year to lookup the index from database. When omitted on creation, defaults to the last index published at the lease start date, whatever its quarter

signing_quarter_revision_index_id

string

Public ID of the revision index used at lease signing

lease_scope

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

200leasing contract updated

422invalid request