Leases
Create a lease
Create a new lease for a property.
Automatic rent synchronization with Estate:
┌─────────────────────────────────────────────────────────────┐
│ Lease creation (POST /leases) │
└─────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────┐
│ rent_amount provided │
│ in the DTO? │
└─────────────────────┘
│ │
YES │ │ NO
▼ ▼
┌──────────────────┐ ┌──────────────────┐
│ Use the DTO │ │ Retrieve the │
│ value │ │ rent_amount from │
│ │ │ the Estate │
│ Synchronize │ │ │
│ with Estate │ │ If Estate has a │
│ (update) │ │ rent_amount: │
│ │ │ • Use this value │
│ │ │ │
│ │ │ If Estate has no │
│ │ │ rent_amount: │
│ │ │ • Use 0.00 │
│ │ │ (default value) │
└──────────────────┘ └──────────────────┘
│ │
└──────┬───────┘
▼
┌─────────────────┐
│ Create the lease │
│ with rent_amount │
└─────────────────┘
Rules:
- If rent_amount is provided in the DTO → used for the lease AND synchronized with the Estate
- If rent_amount is not provided → uses Estate.rent_amount (or 0.00 if absent)
- This synchronization ensures consistency between the lease rent and the property's reference rent
Usage examples:
- Create a lease with a specific rent: provide rent_amount: 1200.00 → the lease will be created with this amount and the Estate will be updated
- Create a lease using the Estate's reference rent: omit rent_amount or provide null → the system will use estate.rent_amount (or 0.00 if absent)
post/leases
Request
- Base URL: https://api.faireplace.com/api
- URL: https://api.faireplace.com/api/leases
- Auth: HTTP bearer
Request body
Example request
{
"rent_amount": 1200,
"rent_frequency": "MONTHLY",
"revision_index_type": "IRL",
"usage_type": "RESIDENTIAL_ONLY",
"charge_settlement_mode": "PROVISION",
"payment_terms": "TERME_A_ECHOIR",
"payment_method": "VIREMENT_BANCAIRE",
"student_school_name": "Université Paris-Saclay",
"student_enrollment_year": "2024-2025",
"student_level": "Master 1",
"mobility_reason": "mission_temporaire",
"initial_duration_months": 6,
"extended_duration_months": 9,
"seasonal_rental_purpose": "vacances",
"seasonal_guest_count": 4,
"seasonal_cleaning_fee": 80,
"seasonal_tourist_tax_amount": 2.5,
"seasonal_services_included": "WiFi, household linen, private parking",
"seasonal_energy_mode": "inclus_forfait",
"seasonal_declaration_number": "75001-2025-00123",
"commercial_business_name": "TECH RETAIL SARL",
"commercial_legal_form": "SARL",
"commercial_siret": "12345678901234",
"commercial_rcs": "RCS Paris 987 654 321",
"commercial_activity": "IT retail and office equipment",
"commercial_activity_code_ape": "47.11F",
"commercial_triennial_exit_year_3": "2027-07-01",
"commercial_triennial_exit_year_6": "2030-07-01",
"commercial_triennial_exit_year_9": "2033-07-01",
"commercial_notice_period_months": 6,
"commercial_ilc_base_value": 130.52,
"commercial_ilc_base_date": "2024-10-01",
"commercial_next_revision_date": "2027-01-01",
"commercial_despecialization_partial": [
{
"date": "2025-06-01",
"activity": "Sale of IT accessories",
"approved_by": "Jean Dupont"
}
],
"commercial_despecialization_full": {
"date": "2026-03-15",
"old_activity": "IT retail",
"new_activity": "Restaurant",
"approved": true,
"indemnity_amount": 15000
},
"commercial_guarantors": [
{
"name": "Holding Company XYZ",
"siret": "98765432109876",
"address": "10 Avenue des Champs-Élysées, 75008 Paris",
"guaranteed_amount": 50000,
"signature_date": "2025-01-01"
}
],
"commercial_insurance_policy": "POL-RC-2025-789456"
}Response
Lease created successfully
Example response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"estate_id": "550e8400-e29b-41d4-a716-446655440001",
"lease_type_id": "550e8400-e29b-41d4-a716-446655440002",
"reference_number": "BAIL-2024-001",
"status": "ACTIVE",
"version": 1,
"start_date": "2024-01-01",
"end_date": "2025-01-01",
"rent_amount": 1200,
"rent_frequency": "MONTHLY",
"deposit_amount": 1200,
"revision_index_type": "IRL",
"usage_type": "RESIDENTIAL_ONLY",
"reference_rent_per_m2": 20.5,
"reference_rent_increased_per_m2": 22.55,
"base_rent_amount": 1000,
"rent_complement_amount": 200,
"previous_tenant_last_rent": 1150,
"irl_reference_quarter": "T1 2024",
"irl_reference_value": 142.35,
"charge_settlement_mode": "PROVISION",
"payment_day": 5,
"payment_terms": "TERME_A_ECHOIR",
"payment_method": "VIREMENT_BANCAIRE",
"student_school_name": "Université Paris-Saclay",
"student_enrollment_year": "2024-2025",
"student_level": "Master 1",
"mobility_reason": "mission_temporaire",
"initial_duration_months": 6,
"extended_duration_months": 9,
"seasonal_rental_purpose": "vacances",
"seasonal_guest_count": 4,
"seasonal_cleaning_fee": 80,
"seasonal_tourist_tax_amount": 2.5,
"seasonal_services_included": "WiFi, household linen, private parking",
"seasonal_energy_mode": "inclus_forfait",
"seasonal_declaration_number": "75001-2025-00123",
"commercial_business_name": "TECH RETAIL SARL",
"commercial_legal_form": "SARL",
"commercial_siret": "12345678901234",
"commercial_rcs": "RCS Paris 987 654 321",
"commercial_activity": "IT retail and office equipment",
"commercial_activity_code_ape": "47.11F",
"commercial_triennial_exit_year_3": "2027-07-01",
"commercial_triennial_exit_year_6": "2030-07-01",
"commercial_triennial_exit_year_9": "2033-07-01",
"commercial_notice_period_months": 6,
"commercial_ilc_base_value": 130.52,
"commercial_ilc_base_date": "2024-10-01",
"commercial_next_revision_date": "2027-01-01",
"commercial_despecialization_partial": [
{
"date": "2025-06-01",
"activity": "Sale of IT accessories",
"approved_by": "Jean Dupont"
}
],
"commercial_despecialization_full": {
"date": "2026-03-15",
"old_activity": "IT retail",
"new_activity": "Restaurant",
"approved": true,
"indemnity_amount": 15000
},
"commercial_guarantors": [
{
"name": "Holding Company XYZ",
"siret": "98765432109876",
"address": "10 Avenue des Champs-Élysées, 75008 Paris",
"guaranteed_amount": 50000,
"signature_date": "2025-01-01"
}
],
"commercial_insurance_policy": "POL-RC-2025-789456",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}Changes
No recorded changes to this operation across all 1 revision of this API.