Create leasing contract

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_ids to associate multiple tenants with the contract
  • Use guarantor_ids to 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.

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

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

  • Use vat_applicable to enable VAT on the contract
  • Provide vat_rate when VAT is applicable (allowed decimals, e.g., 5.5, 10, 20)

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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