List leasing contracts

Returns a paginated list of all leasing contracts accessible to the current user, showing key contract details and status.

Leasing Contract Overview

A Leasing Contract represents a rental agreement for a specific Asset (property).
It defines the complete lifecycle of a rental period from creation to closure.

Business significance

Leasing Contracts track the complete rental lifecycle for an Asset, including
rent collection, deposit management, and tenant relationships. They govern the
financial and contractual aspects of renting a property to tenants.

Key data types

  • status: Contract lifecycle status (created, move_in, in_progress, move_out, closed)
  • nature: Type of lease (furnished, unfurnished, student, mobility, secondary_residence, parking, commercial, civil_code, other)
  • tenant_fees_in_cents: Fees charged to the tenant
  • landlord_rental_fees_in_cents: Optional landlord rental fees override in cents (if not set, calculated from management contract)
  • deposit_in_cents: Security deposit amount
  • rent_in_cents: Monthly base rent charged to tenant in cents
  • charges_in_cents: Monthly charges amount in cents
  • vat_applicable: Whether VAT is applicable for this contract
  • vat_rate: VAT rate percentage (0..100, decimals allowed like 5.5)
  • duration_in_months: Contract duration
  • rent_due_day: Day of the month when rent is due
  • tacit_renewal: Whether the contract automatically renews
  • tacit_renewal_duration_years: Duration of tacit renewal in years (nil=none, 1/3/6/9=specific, -1=unlimited)
  • deposit_retained_by: Who holds the deposit (landlord or agency)
  • charges_nature: How rental charges are calculated (provision or forfait)
  • unpaid_threshold_amount_in_cents: Threshold amount for unpaid rent alerts, overrides customer configuration when set
  • frequency_in_months: Rent call frequency (monthly, quarterly, semiannual, annual)
  • period_start_month: First month of the billing cycle (1-12, default: 1). Controls which months rent is called for non-monthly frequencies
  • quarter_revision_index_attributes: Quarter revision index attributes - provide quarter, nature, and year to lookup the index from database
  • quarter_revision_index: Reference revision index of the contract (read-only, returned with quarter, nature, year and value)
  • next_revision_date: Date of the next rent revision (read-only, computed)
  • signing_quarter_revision_index_id: Public ID of the revision index used at lease signing
  • signing_quarter_revision_index: Valeur initiale du bail (read-only): revision index used at lease signing. Null on legacy leases where it was never stored
  • indexation_enabled: Whether IRL (Indice de Référence des Loyers) rent indexation is enabled for this contract (default: true)
  • revision_frequency_in_years: Rent revision frequency in years (1 = annual, 3 = triennial)
  • first_call_only: When true, only the first rent call is generated (for move-in only management). Mutually exclusive with rental_transfer
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number for pagination (default: 1)

integer

Number of items per page (default: 10, max: 100)

Response

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