Creates a new leasing contract for an asset, setting up rental terms, dates, and financial parameters.
A leasing contract must be associated with an existing asset.
You can associate multiple tenants and guarantors with the contract by providing arrays of profile IDs.
Profile Association Options:
- Use
tenant_idsto associate multiple tenants with the contract - Use
guarantor_idsto associate multiple guarantors with the contract
Provide these arrays of profile public IDs in the JSON body, either at the root
or inside the leasing_contract object.
Quarter Revision Index:
Use quarter_revision_index_attributes with quarter, nature, and year to lookup the index from the database.
This provides a convenient way to reference the correct revision index without needing to know the internal ID.
When omitted, Rivage uses the last index published at the lease start date, whatever its quarter.
Valeur initiale du bail (signing revision index):
Use signing_quarter_revision_index_id with a revision index public ID to set the base value used for
rent indexation. When omitted, it defaults to the same value as quarter_revision_index.
The contract will go through various lifecycle stages from creation to closing,
with financial transactions tracked at each stage.
Tacit Renewal:
Set the tacit renewal duration using tacit_renewal_duration_years:
- nil or omit: No tacit renewal
- 1, 3, 6, or 9: Specific duration in years
- -1: Unlimited renewal
Guarantee Coverage:
Use guaranteed_renewals_count to define how many renewals the guarantee covers after the initial lease term:
- 0: Initial lease term only
- 1, 2, or 3: Initial lease term plus the selected number of renewals
You can set a custom unpaid_threshold_amount_in_cents to override the customer's default value
for unpaid rent alerts for this specific contract.
VAT (TVA):
- Provide
vat_rateswith bothrentandchargesrates (allowed decimals, e.g., 5.5, 10, 20) - When
vat_ratesis present, it takes precedence andvat_applicableis derived from its values vat_applicable,vat_rateandvat_on_rent_onlyremain accepted whenvat_ratesis omitted, but are deprecated
Rent Indexation:
The indexation_enabled field controls whether IRL (Indice de Référence des Loyers) rent indexation
is activated for this contract. When set to true (default), the contract will be eligible
for automatic annual rent indexation based on the IRL index. The indexation also requires
a valid quarter_revision_index to be set.
Revision Frequency:
Use revision_frequency_in_years to set 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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
