FairePlace Property Management API

Schemas

Contact

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

Error

object

CreateContact

type_contact

string · required

email

string · email · required

mobile

string · required

category

string · required

address_line1

string · required

address_city

string · required

address_postal_code

string · required

address_country

string · required

first_name

string | null

last_name

string | null

legal_name

string | null

registration_number

string | null

telephone

string | null

website

string | null · uri

color

string | null

address_line2

string | null

address_region

string | null

bank_name

string | null

bank_address

string | null

bank_city

string | null

bank_postal_code

string | null

bank_country

string | null

iban

string | null

swift_bic

string | null

bank_account_holder

string | null

professional_activity

string | null

professional_card_number

string | null

professional_card_issuing_location

string | null

professional_card_issuing_date

string | null · date

professional_card_expiry_date

string | null · date

professional_registration_number

string | null

professional_guarantor_id

string | null · uuid

professional_insurance_company

string | null

professional_insurance_policy

string | null

professional_status

string | null

UpdateContact

type_contact

string

first_name

string | null

last_name

string | null

legal_name

string | null

registration_number

string | null

email

string · email

mobile

string

telephone

string | null

website

string | null · uri

color

string | null

category

string

address_line1

string

address_line2

string | null

address_city

string

address_postal_code

string

address_region

string | null

address_country

string

bank_name

string | null

bank_address

string | null

bank_city

string | null

bank_postal_code

string | null

bank_country

string | null

iban

string | null

swift_bic

string | null

bank_account_holder

string | null

professional_activity

string | null

professional_card_number

string | null

professional_card_issuing_location

string | null

professional_card_issuing_date

string | null · date

professional_card_expiry_date

string | null · date

professional_registration_number

string | null

professional_guarantor_id

string | null · uuid

professional_insurance_company

string | null

professional_insurance_policy

string | null

professional_status

string | null

PlaceCategory

string · enum

Enum values:

Individual

Collective

Place category (individual or collective)

Example: Collective

PlaceLegalRegime

string · enum

Enum values:

MonoPropriete

Copropriete

Legal regime of the place

Example: Copropriete

Place

id

string | null · uuid

name

string | null

country

string | null

address_complement

string | null

street_number

string | null

street_name

string | null

locality

string | null

postal_code

string | null

city

string | null

postal_box

string | null

latitude

number | null

longitude

number | null

description

string | null

type_id

string | null · uuid

legislative_zone_id

string | null · uuid

digicode

string | null

number_of_floor

integer | null

owner_id

string | null · uuid

previous_owner_id

string | null · uuid

construction_date

string | null · date-time

renovation_date

string | null · date-time

place_category

string · enum

Place category (individual or collective)

Enum values:

Individual

Collective

Example: Collective

legal_regime

string · enum

Legal regime of the place

Enum values:

MonoPropriete

Copropriete

Example: Copropriete

created_at

string | null · date-time

updated_at

string | null · date-time

CreatePlace

name

string · required

type_id

string · uuid · required

legislative_zone_id

string · uuid · required

owner_id

string · uuid · required

country

string · required

street_name

string · required

postal_code

string · required

city

string · required

place_category

string · required

legal_regime

string · required

address_complement

string | null

street_number

string | null

locality

string | null

postal_box

string | null

latitude

number | null

longitude

number | null

description

string | null

digicode

string | null

number_of_floor

integer | null

construction_date

string | null · date-time

renovation_date

string | null · date-time

UpdatePlace

Data for updating an existing place. **Update behavior for optional fields**: - **Field absent**: the existing value is preserved (no modification) - **Field present with `null`**: the value is removed (set to NULL in the database) - **Field present with a value**: the value is updated **Fields affected by this behavior**: - `address_complement`: can be set to `null` to remove the value - `street_number`: can be set to `null` to remove the value - `locality`: can be set to `null` to remove the value - `postal_box`: can be set to `null` to remove the value - `latitude`: can be set to `null` to remove the value - `longitude`: can be set to `null` to remove the value **Fields assigned directly (can already be set to null)**: - `description`, `digicode`, `number_of_floor`, `renovation_date`

name

string | null

country

string | null

address_complement

string | null

Address complement.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

street_number

string | null

Street number.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

street_name

string | null

locality

string | null

Locality.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

postal_code

string | null

city

string | null

postal_box

string | null

Postal box.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

latitude

number | null

GPS latitude.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
Number: the value is updated

longitude

number | null

GPS longitude.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
Number: the value is updated

description

string | null

type_id

string | null · uuid

legislative_zone_id

string | null · uuid

digicode

string | null

number_of_floor

integer | null

place_category

string · enum

Place category (individual or collective)

Enum values:

Individual

Collective

Example: Collective

legal_regime

string · enum

Legal regime of the place

Enum values:

MonoPropriete

Copropriete

Example: Copropriete

renovation_date

string | null · date-time

EstateRentalStatus

string · enum

Enum values:

VACANT

RENTED

NOTICE

Rental status of a property.

VACANT: Vacant property, no active lease
RENTED: Rented property, at least one active lease
NOTICE: Property under notice period, at least one lease under notice (without an active lease)

This status is automatically synchronized with the status of associated leases when statuses change (ACTIVE, NOTICE, TERMINATED).

Example: RENTED

Estate

id

string | null · uuid

name

string | null

Property name

Example: 3-bedroom apartment - Rue de la Paix

place_id

string | null · uuid

estate_type_id

string | null · uuid

area

number | null

number_of_room

integer | null

orientation

string | null

building

string | null

floor

integer | null

owner_id

string | null · uuid

previous_owner_id

string | null · uuid

lot_number

string | null

fiscal_identifier

string | null

Property tax identifier (required)

Example: 1234567890123

housing_tax

number | null

property_tax

number | null

acquisition_price

number | null

rent_amount

number | null · decimal

Reference rent amount for the property (in euros). Automatically synchronized with active leases.

Example: 1200

rental_status

string · enum

Rental status of the property, automatically synchronized with the status of associated leases.

VACANT: Vacant property (no active lease)
RENTED: Rented property (active lease)
NOTICE: Property under notice period (lease under notice)

This status is automatically updated when lease statuses change (ACTIVE, NOTICE, TERMINATED).

Enum values:

VACANT

RENTED

NOTICE

Example: RENTED

construction_date

string | null · date-time

renovation_date

string | null · date-time

address

string | null

other_detail

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

UpdateEstate

Data for updating an existing property. **Update behavior for optional fields**: - **Field absent**: the existing value is preserved (no modification) - **Field present with `null`**: the value is removed (set to NULL in database) - **Field present with value**: the value is updated **Fields affected by this behavior**: - `number_of_room`: can be set to `null` to remove the value **Fields assigned directly (can already be set to null)**: - `orientation`, `building`, `floor`, `lot_number`, `housing_tax`, `property_tax`, `acquisition_price`, `construction_date`, `renovation_date`, `address`, `other_detail` **Changing place**: - `place_id`: can be modified to move a property to another place - **Important**: Changing `place_id` is only possible via flat routes `/estates/{id}` (PUT) - Nested routes `/places/{place_id}/estates/{estate_id}` do not allow changing the `place_id` - The new `place_id` must exist and belong to the same tenant, otherwise a 404 error will be returned

name

string | null · minLength: 1 · maxLength: 255

Property name

Example: 3-bedroom apartment - Rue de la Paix

place_id

string | null · uuid

Identifier of the place to which the property is associated.

Changing place:

This field can be modified to move a property to another place
Use the flat route PUT /estates/{id} to change this field
The new place_id must exist and belong to the same tenant
If the new place does not exist or belongs to another tenant, a 404 error will be returned
If this field is absent from the request, the existing value is preserved

Example: 550e8400-e29b-41d4-a716-446655440000

estate_type_id

string | null · uuid

area

number | null

number_of_room

integer | null

Number of rooms.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
Integer: the value is updated

orientation

string | null

building

string | null

floor

integer | null

lot_number

string | null

fiscal_identifier

string | null · minLength: 1 · maxLength: 50

Property tax identifier

Example: 1234567890123

housing_tax

number | null

property_tax

number | null

acquisition_price

number | null

rent_amount

number | null · decimal · min: 0

Reference rent amount for the property (in euros).

Update behavior:

Field absent: the existing value is preserved
Field present with null: the value is removed (set to NULL)
Field present with value: the value is updated

Note: Directly modifying this field does not affect existing leases. Active leases retain their rent. This field serves as the default value for future leases.

Example: 1200

construction_date

string | null · date-time

renovation_date

string | null · date-time

address

string | null

other_detail

string | null

rental_status

string · enum

Rental status of the property.

Update behavior:

Field absent: the existing value is preserved
Field present with null: the value is removed (set to NULL)
Field present with value: the value is updated

Note: This field is generally automatically synchronized with the lease status. A manual modification may be overwritten during the next lease status change.

VACANT: Vacant property (no active lease)
RENTED: Rented property (active lease)
NOTICE: Property under notice period (lease under notice)

Enum values:

VACANT

RENTED

NOTICE

Example: RENTED

CreateEstate

name

string · minLength: 1 · maxLength: 255 · required

Property name

Example: 3-bedroom apartment - Rue de la Paix

estate_type_id

string · uuid · required

area

number · required

fiscal_identifier

string · minLength: 1 · maxLength: 50 · required

Property tax identifier (required)

Example: 1234567890123

number_of_room

integer | null

orientation

string | null

building

string | null

floor

integer | null

lot_number

string | null

housing_tax

number | null

property_tax

number | null

acquisition_price

number | null

rent_amount

number | null · decimal · min: 0

Reference rent amount for the property (in euros). Used as default value when creating leases.

Example: 1200

rental_status

string · enum

Rental status of the property. By default, a new property is created with VACANT status.

VACANT: Vacant property (no active lease)
RENTED: Rented property (active lease)
NOTICE: Property under notice period (lease under notice)

Enum values:

VACANT

RENTED

NOTICE

Example: VACANT

construction_date

string | null · date-time

renovation_date

string | null · date-time

address

string | null

other_detail

string | null

Room

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

CreateRoom

type_room_id

string · uuid · required

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

UpdateRoom

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

ServiceSpaceType

string · enum

Enum values:

INDOOR_COMMON

OUTDOOR_COMMON

PRIVATE

TECHNICAL

GARDEN

PARKING

TELECOM_SERVICES

Space type for place services

Example: INDOOR_COMMON

PlaceService

id

string | null · uuid

place_id

string | null · uuid

service_id

string | null · uuid

name

string | null

description

string | null

is_chargeable

boolean | null

category_id

string | null · uuid

space_type

string · enum

Space type for place services

Enum values:

INDOOR_COMMON

OUTDOOR_COMMON

PRIVATE

TECHNICAL

GARDEN

PARKING

TELECOM_SERVICES

Example: INDOOR_COMMON

default_distribution_key_id

string | null · uuid

created_at

string | null · date-time

EnergyLabel

string · enum

Enum values:

DPE energy label (A to G)

Example: B

GesLabel

string · enum

Enum values:

DPE GHG (Greenhouse Gas) label (A to G)

Example: B

EnergyDiagnosis

Complete Energy Performance Diagnosis (DPE)

id

string | null · uuid · required

Unique identifier of the DPE

Example: 550e8400-e29b-41d4-a716-446655440000

reference_number

string | null · maxLength: 100 · required

DPE reference number

Example: DPE-2024-002

diagnosis_date

string | null · date · required

Diagnosis date

Example: 2024-02-10

valid_until

string | null · date · required

Diagnosis validity date (10 years maximum)

Example: 2034-02-10

energy_label

string · enum · required

DPE energy label (A to G)

Enum values:

Example: B

ges_label

string · enum · required

DPE GHG (Greenhouse Gas) label (A to G)

Enum values:

Example: B

construction_year

integer | null · min: 1800 · max: 2024 · required

Construction year of the property

Example: 2010

created_at

string | null · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string | null · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

estate_id

string | null · uuid

Property (if DPE for a specific property) ID

Example: 550e8400-e29b-41d4-a716-446655440001

place_id

string | null · uuid

Place (if DPE for a specific place) ID

Example: 550e8400-e29b-41d4-a716-446655440002

energy_consumption

number | null · double · min: 0

Energy consumption in kWh/m²/year

Example: 125.8

ges_emission

number | null · double · min: 0

GHG emission in kg CO2/m²/year

Example: 28.7

heated_area

number | null · double

Heated area in m²

Example: 65

diagnostician_contact_id

string | null · uuid

Diagnostician contact ID

Example: 550e8400-e29b-41d4-a716-446655440003

notes

string | null · maxLength: 1000

Internal notes about the diagnosis

Example: Apartment with reinforced insulation

media_id

string | null · uuid

Media ID of the uploaded DPE PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

PaginationMeta

current_page

integer

per_page

integer

total

integer

total_pages

integer

has_next

boolean

has_prev

boolean

CreateEnergyDiagnosis

Data for creating a new DPE

reference_number

string · minLength: 1 · maxLength: 100 · required

DPE reference number

Example: DPE-2024-002

diagnosis_date

string · date · required

Diagnosis date

Example: 2024-02-10

valid_until

string · date · required

Diagnosis validity date (10 years maximum)

Example: 2034-02-10

energy_label

string · enum · required

DPE energy label (A to G)

Enum values:

Example: B

ges_label

string · enum · required

DPE GHG (Greenhouse Gas) label (A to G)

Enum values:

Example: B

construction_year

integer · min: 1800 · max: 2024 · required

Construction year of the property

Example: 2010

estate_id

string | null · uuid

Property (required if place_id is not provided) ID

Example: 550e8400-e29b-41d4-a716-446655440001

place_id

string | null · uuid

Place (required if estate_id is not provided) ID

Example: 550e8400-e29b-41d4-a716-446655440002

energy_consumption

number | null · double · min: 0

Energy consumption in kWh/m²/year

Example: 125.8

ges_emission

number | null · double · min: 0

GHG emission in kg CO2/m²/year

Example: 28.7

heated_area

number | null · double

Heated area in m²

Example: 65

diagnostician_contact_id

string | null · uuid

Diagnostician contact ID

Example: 550e8400-e29b-41d4-a716-446655440003

notes

string | null · maxLength: 1000

Internal notes about the diagnosis

Example: Apartment with reinforced insulation

media_id

string | null · uuid

Media ID of the uploaded DPE PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

UpdateEnergyDiagnosis

Data for updating an existing DPE. **Update behavior for optional fields**: - **Field absent**: the existing value is preserved (no modification) - **Field present with `null`**: the value is removed (set to NULL in database) - **Field present with value**: the value is updated **Fields subject to this behavior**: - `energy_consumption`: can be set to `null` to remove the value - `ges_emission`: can be set to `null` to remove the value - `heated_area`: can be set to `null` to remove the value - `diagnostician_contact_id`: can be set to `null` to remove the value - `notes`: can be set to `null` to remove the value

reference_number

string | null · minLength: 1 · maxLength: 100

DPE reference number

Example: DPE-2024-002

diagnosis_date

string | null · date

Diagnosis date

Example: 2024-02-10

valid_until

string | null · date

Diagnosis validity date (10 years maximum)

Example: 2034-02-10

energy_label

string · enum

DPE energy label (A to G)

Enum values:

Example: B

energy_consumption

number | null · double · min: 0

Energy consumption in kWh/m²/year.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
Numeric value: the value is updated

Example: 125.8

ges_label

string · enum

DPE GHG (Greenhouse Gas) label (A to G)

Enum values:

Example: B

ges_emission

number | null · double · min: 0

GHG emission in kg CO2/m²/year.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
Numeric value: the value is updated

Example: 28.7

heated_area

number | null · double

Heated area in m².

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
Numeric value: the value is updated

Example: 65

construction_year

integer | null · min: 1800 · max: 2024

Construction year of the property

Example: 2010

diagnostician_contact_id

string | null · uuid

Diagnostician contact ID.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
Valid UUID: the value is updated

Example: 550e8400-e29b-41d4-a716-446655440003

notes

string | null · maxLength: 1000

Additional notes about the diagnosis.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
String value: the value is updated

Example: Apartment with reinforced insulation

media_id

string | null · uuid

Media ID of the uploaded DPE PDF document.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in database)
Valid UUID: the value is updated

Example: 550e8400-e29b-41d4-a716-446655440010

DiagnosticType

string · enum

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Type of estate diagnostic

Example: DIAGNOSTIC_PLOMB

EstateDiagnostic

Estate diagnostic document (lead, asbestos, electrical, gas, risk assessment, co-ownership rules)

id

string · uuid · required

Unique identifier of the diagnostic

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

is_active

boolean · required

Whether this diagnostic is currently active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

CreateEstateDiagnostic

Data for creating a new estate diagnostic

estate_id

string · uuid · required

Property (estate) ID this diagnostic belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

diagnostic_type

string · enum · required

Type of estate diagnostic

Enum values:

DIAGNOSTIC_PLOMB

DIAGNOSTIC_AMIANTE

DIAGNOSTIC_ELECTRICITE

DIAGNOSTIC_GAZ

ETAT_RISQUES

REGLEMENT_COPROPRIETE

CUSTOM

Example: DIAGNOSTIC_PLOMB

media_id

string · uuid · required

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string · minLength: 1 · maxLength: 255 · required

Name/title of the diagnostic

Example: CREP - Lead Diagnosis

description

string | null · maxLength: 1000

Optional description or notes

Example: Lead diagnosis for apartment 3B

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

UpdateEstateDiagnostic

Data for updating an existing estate diagnostic. All fields are optional. Only provided fields will be updated.

media_id

string | null · uuid

Media ID of the uploaded diagnostic PDF document

Example: 550e8400-e29b-41d4-a716-446655440010

name

string | null · minLength: 1 · maxLength: 255

Name/title of the diagnostic

Example: CREP - Lead Diagnosis (updated)

description

string | null · maxLength: 1000

Optional description or notes

Example: Updated lead diagnosis

performed_at

string | null · date

Date when the diagnostic was performed

Example: 2024-06-15

expires_at

string | null · date

Expiry date of the diagnostic

Example: 2030-06-15

is_active

boolean | null

Whether this diagnostic is currently active

Example: true

Equipment

id

string | null · uuid

name

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

CreateEquipment

equipment_type_id

string · uuid · required

entity_id

string · uuid · required

entity_type

string · enum · required

Enum values:

place

estate

room

description

string | null

quantity

integer | null

UpdateEquipment

equipment_type_id

string · uuid

entity_id

string · uuid

entity_type

string · enum

Enum values:

place

estate

room

description

string | null

quantity

integer | null

EquipmentJunctionWithDetails

equipment_id

string | null · uuid

entity_id

string | null · uuid

entity_type

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

description

string | null

quantity

integer | null

equipment_name

string | null

equipment_type_id

string | null · uuid

LinkEquipmentDto

equipment_id

string · uuid · required

description

string | null

quantity

integer | null

Owner

id

string | null · uuid

title

string | null · maxLength: 10

last_name

string | null

first_name

string | null · maxLength: 255

owner_category

string | null · enum

Enum values:

individual

company

sc/sci

legal_name

string | null · maxLength: 255

registration_number

string | null · maxLength: 50

country

string | null · maxLength: 50

address_complement

string | null · maxLength: 255

street_number

string | null · maxLength: 50

street_name

string | null · maxLength: 255

locality

string | null · maxLength: 255

postal_code

string | null · maxLength: 20

city

string | null · maxLength: 255

postal_box

string | null · maxLength: 20

mobile_phone

string | null · maxLength: 20

landline_phone

string | null · maxLength: 20

email

string | null · email

auth_user_id

string | null

created_at

string | null · date-time

updated_at

string | null · date-time

CreateOwner

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	No specific criteria
	requires: legal_name, registration_number

Properties for Individual owner:

UpdateOwner

All fields are optional. If `owner_category` is `company` or `sc/sci`, then `legal_name` and `registration_number` must be provided.

title

string · maxLength: 10

last_name

string · maxLength: 255

first_name

string | null · maxLength: 255

owner_category

string · enum

Enum values:

individual

company

sc/sci

legal_name

string | null · maxLength: 255

registration_number

string | null · maxLength: 50

country

string · maxLength: 50

address_complement

string | null · maxLength: 255

street_number

string | null · maxLength: 50

street_name

string · maxLength: 255

locality

string | null · maxLength: 255

postal_code

string · maxLength: 20

city

string · maxLength: 255

postal_box

string | null · maxLength: 20

mobile_phone

string · maxLength: 20

landline_phone

string | null · maxLength: 20

email

string · email

auth_user_id

string | null

LegislativeZoneDto

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

CreateLegislativeZone

zone_type

string · required

country_code

string · required

code

string · required

name

string · required

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

LegislativeZoneFilter

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

is_active

boolean | null

effective_date

string | null · date

parent_zone_id

string | null · uuid

UpdateLegislativeZone

name

string

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

RentRegulationCheckRequest

postal_code

string · required

RegulationTypeResponse

type_name

string

description

string

rules

string[]

RegulationDetail

name

string

description

string

is_applicable

boolean

GeographicalZoneResponse

zone_type

string

irl_cap_percentage

number · float

description

string

postal_code_pattern

string

IrlInfoResponse

current_quarter

string

current_value

number · float

previous_year_value

number · float

publication_date

string | null

data_source

string

last_update

string

annual_increase_cap

number · float

RentRegulationCheckResponse

postal_code

string

city_name

string

is_rent_regulated

boolean

insee_code

string

object

object[]

object

ConstructionPeriod

string · enum

Enum values:

before_1946

19461970

19711990

19912005

after_2005

after_1990

RentControlRequest

address

string · required

postal_code

string · required

room_count

integer · required

surface_area

number · float · required

construction_period

string · enum · required

Enum values:

before_1946

19461970

19711990

19912005

after_2005

after_1990

is_furnished

boolean · required

proposed_rent

number · float · required

Coordinates

longitude

number · float

latitude

number · float

ReferenceRentData

reference_rent

number · float

reference_rent_increased

number · float

reference_rent_decreased

number · float

year

string

RegulationRule

name

string

description

string

reference_url

string | null

RentControlResponse

territory

string

address

string

administrative_quarter

string

quarter_id

integer | null

object

proposed_rent_per_sqm

number · float

is_compliant

boolean

compliance_status

string

object[]

data_source

string

last_update

string

AdministrativeQuarter

id

integer

name

string

object

SupportedTerritories

territories

string[]

PlaceType

Place type (e.g., Apartment building, Detached house, Commercial premises)

id

string | null · uuid · required

Unique identifier of the place type

Example: 550e8400-e29b-41d4-a716-446655440000

name

string | null · maxLength: 255 · required

Place type name

Example: Residential building

created_at

string | null · date-time · required

Creation date and time

Example: 2024-01-15T10:30:00Z

updated_at

string | null · date-time · required

Last modification date and time

Example: 2024-01-15T10:30:00Z

CreatePlaceType

Data for creating a new place type

name

string · minLength: 1 · maxLength: 255 · required

Name of the place type to create

Example: Commercial building

EstateType

Property type (e.g., Apartment, Studio, 1-bedroom, 2-bedroom, 3-bedroom, etc.)

id

string | null · uuid · required

Unique identifier of the property type

Example: 550e8400-e29b-41d4-a716-446655440001

name

string | null · maxLength: 255 · required

Property type name

Example: 3-bedroom apartment

created_at

string | null · date-time · required

Creation date and time

Example: 2024-01-15T10:30:00Z

updated_at

string | null · date-time · required

Last modification date and time

Example: 2024-01-15T10:30:00Z

CreateEstateType

Data for creating a new property type

name

string · minLength: 1 · maxLength: 255 · required

Name of the property type to create

Example: Furnished studio

RoomType

Room type in a property (e.g., Living room, Bedroom, Kitchen, Bathroom, etc.)

id

string | null · uuid · required

Unique identifier of the room type

Example: 550e8400-e29b-41d4-a716-446655440002

name

string | null · maxLength: 255 · required

Room type name

Example: Living room

counts_towards_habitable

boolean | null · required

Indicates whether this room counts toward the habitable area (Carrez law)

Example: true

Default: true

created_at

string | null · date-time · required

Creation date and time

Example: 2024-01-15T10:30:00Z

updated_at

string | null · date-time · required

Last modification date and time

Example: 2024-01-15T10:30:00Z

CreateRoomType

Data for creating a new room type

name

string · minLength: 1 · maxLength: 255 · required

Name of the room type to create

Example: Office

counts_towards_habitable

boolean · required

Indicates whether this room counts toward the habitable area (Carrez law)

Example: true

Default: true

EquipmentType

Equipment type available in a property (e.g., Heating, Air conditioning, Elevator, etc.)

id

string | null · uuid · required

Unique identifier of the equipment type

Example: 550e8400-e29b-41d4-a716-446655440003

name

string | null · maxLength: 255 · required

Equipment type name

Example: Central heating

created_at

string | null · date-time · required

Creation date and time

Example: 2024-01-15T10:30:00Z

updated_at

string | null · date-time · required

Last modification date and time

Example: 2024-01-15T10:30:00Z

CreateEquipmentType

Data for creating a new equipment type

name

string · minLength: 1 · maxLength: 255 · required

Name of the equipment type to create

Example: Reversible air conditioning

EntityType

string · enum

Enum values:

PLACE

ESTATE

ROOM

EQUIPMENT

LEASE

OWNER

CONTACT

LESSEE

Business entity type supported for media

MediaSecurityLevel

string · enum

Enum values:

STANDARD

SENSITIVE

CRITICAL

Security/encryption level. CRITICAL and SENSITIVE may trigger SSE-C encrypted storage; STANDARD is unencrypted.

MediaRole

string · enum

Enum values:

AVATAR

ID_DOCUMENT

PRIMARY_PHOTO

LEASE_ORIGINAL

LEASE_SIGNED

Media

id

string | null · uuid

url

string | null

media_type

string | null

MIME type (e.g. application/pdf, image/jpeg)

file_size

integer | null · int64

security_level

string · enum

Security/encryption level. CRITICAL and SENSITIVE may trigger SSE-C encrypted storage; STANDARD is unencrypted.

Enum values:

STANDARD

SENSITIVE

CRITICAL

encryption_key_id

string | null

SSE-C key identifier if the media is encrypted (secure mode)

checksum

string | null

SHA-256 of the source content for integrity verification

tags

array | null

Tags normalized to lowercase; max 32 tags; each tag <= 64 chars, [a-z0-9_-]

roles

array | null

Roles associated with this media for different entities

Enum values:

AVATAR

ID_DOCUMENT

PRIMARY_PHOTO

LEASE_ORIGINAL

LEASE_SIGNED

created_at

string | null · date-time

updated_at

string | null · date-time

UpdateMediaTagsRequest

tags

string[] · required

AssignRoleRequest

role

string · enum · required

Media role (enum MediaRole) - accepts values AVATAR, ID_DOCUMENT, PRIMARY_PHOTO, LEASE_ORIGINAL, LEASE_SIGNED

Enum values:

AVATAR

ID_DOCUMENT

PRIMARY_PHOTO

LEASE_ORIGINAL

LEASE_SIGNED

Example: AVATAR

WorkerMediaResponse

pdf_base64

string | null

document_name

string | null

content_type

string | null

file_size

integer | null · int64

security_level

string · enum

Security/encryption level. CRITICAL and SENSITIVE may trigger SSE-C encrypted storage; STANDARD is unencrypted.

Enum values:

STANDARD

SENSITIVE

CRITICAL

WorkerUploadSignedPdfResponse

success

boolean | null

message

string | null

data

object | null

ChargeCategoryType

string · enum

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Type of charge category

Example: MAINTENANCE

MaintenanceDetails

Maintenance details for a charge category

maintenance_type

string · minLength: 1 · required

Maintenance type (e.g., Preventive, Corrective, Curative)

Example: Preventive

description

string · minLength: 1 · required

Detailed description of the maintenance

Example: Annual preventive maintenance of the boiler

frequency

string · minLength: 1 · required

Maintenance frequency (e.g., Monthly, Quarterly, Annual)

Example: Annual

estimated_cost

number · decimal · min: 0 · required

Estimated maintenance cost (in euros)

Example: 250

last_maintenance_date

string | null · date

Date of the last maintenance performed

Example: 2024-01-15

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2025-01-15

object | null

Additional information in JSON format

Example: {"provider":"Maintenance Pro","contract_number":"MAINT-2024-001"}

NotificationFrequency

string · pattern: ^\d+\s+(day|week|mon…

Notification frequency in 'X unit' format (e.g., '30 days', '1 month')

Example: 30 days

ServiceChargeCategory

Charge category for services (Article 23 of decree no. 87-713)

id

string · uuid · required

Unique identifier of the category

name

string · minLength: 1 · maxLength: 255 · required

Category name (e.g., Building employee, Collective heating)

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

recovery_rate

number · decimal · min: 0 · max: 100 · required

Recovery rate from the tenant (as a percentage, 0-100)

Example: 100

Default: 100

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

description

string | null · maxLength: 1000

Detailed description of the category

legal_reference

string | null

Legal reference (e.g., Article 23-1 of decree no. 87-713)

object

Maintenance details if applicable

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

Alert notification frequency

Example: 30 days

CreateServiceChargeCategory

Data for creating a charge category (Article 23 of decree no. 87-713)

name

string · minLength: 1 · maxLength: 255 · required

Category name (e.g., Building employee, Collective heating)

Example: Collective heating

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

description

string | null · maxLength: 1000

Detailed description of the category

Example: Charges related to the building's collective heating

legal_reference

string | null

Legal reference (e.g., Article 23-1 of decree no. 87-713)

Example: Article 23-1 paragraph 3 of decree no. 87-713

object

Maintenance details if applicable

recovery_rate

number | null · decimal · min: 0 · max: 100

Recovery rate from the tenant (as a percentage, 0-100). Default value: 100

Example: 100

Default: 100

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

Alert notification frequency

Example: 30 days

UpdateServiceChargeCategory

Data for updating a charge category

name

string · minLength: 1 · maxLength: 255 · required

Category name (e.g., Building employee, Collective heating)

Example: Collective heating

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

description

string | null · maxLength: 1000

Detailed description of the category

Example: Charges related to the building's collective heating

legal_reference

string | null

Legal reference (e.g., Article 23-1 of decree no. 87-713)

Example: Article 23-1 paragraph 3 of decree no. 87-713

object

Maintenance details if applicable

recovery_rate

number | null · decimal · min: 0 · max: 100

Recovery rate from the tenant (as a percentage, 0-100)

Example: 100

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

Alert notification frequency

Example: 30 days

TypeRepartitionCharge

string · enum

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Type of charge distribution among tenants (distribution technique).

Compatibility rules with the billing mode:

CONSOMMATION_MESUREE requires RELEVE_DIRECT or PROVISION (not FORFAIT)
Other types can be used with PROVISION or FORFAIT

Example: SURFACE

DistributionParameters

Charge distribution parameters based on the chosen calculation type

surface_m2

number | null · decimal

Surface area in m² for SURFACE calculation

Example: 75.5

occupant_count

integer | null · min: 0

Number of occupants for OCCUPANT calculation

Example: 3

meter_id

string | null · uuid

Meter ID for CONSOMMATION_MESUREE calculation

equipment_count

integer | null · min: 0

Number of equipment items for NOMBRE_EQUIPEMENTS calculation

Example: 2

millieme_value

number | null · decimal · min: 0

Value in thousandths for MILLIEME calculation

Example: 125.5

object | null

Custom parameters for FORMULE_PERSONNALISEE calculation (JSON format)

ValidationRules

Validation rules for distribution calculations

min_value

number | null · decimal

Minimum allowed value

Example: 0

max_value

number | null · decimal

Maximum allowed value

Example: 10000

required_parameters

string[]

Required parameters for validation

Example: ["surface_m2"]

object | null

Custom validation rule (JSON format)

ChargeDistributionKey

Charge distribution key. **When used in a rental charge:** - The `calculation_type` must be compatible with the charge's `calculation_method` - `CONSOMMATION_MESUREE` requires `RELEVE_DIRECT` or `PROVISION` as billing mode - Other types can be used with `PROVISION` or `FORFAIT`

id

string · uuid · required

Unique identifier of the distribution key

name

string · required

Name of the distribution key

calculation_type

string · enum · required

Distribution type. Must be compatible with the billing mode when used in a charge. See TypeRepartitionCharge for compatibility rules.

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

description

string | null

Description of the distribution key

formula

string | null

Custom calculation formula (required if calculation_type = FORMULE_PERSONNALISEE)

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

created_at

string · date-time

Creation date

updated_at

string · date-time

Last modification date

CreateChargeDistributionKey

Data for creating a new charge distribution key

name

string · minLength: 1 · required

Name of the distribution key

calculation_type

string · enum · required

Type of charge distribution among tenants (distribution technique).

Compatibility rules with the billing mode:

CONSOMMATION_MESUREE requires RELEVE_DIRECT or PROVISION (not FORFAIT)
Other types can be used with PROVISION or FORFAIT

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

description

string | null

Description of the distribution key

formula

string | null

Custom calculation formula

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

UpdateChargeDistributionKey

Data for updating a charge distribution key

name

string · minLength: 1

Name of the distribution key

description

string | null

Description of the distribution key

calculation_type

string · enum

Type of charge distribution among tenants (distribution technique).

Compatibility rules with the billing mode:

CONSOMMATION_MESUREE requires RELEVE_DIRECT or PROVISION (not FORFAIT)
Other types can be used with PROVISION or FORFAIT

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

formula

string | null

Custom calculation formula

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

DistributionCalculationRequest

Charge distribution calculation request

place_id

string · uuid · required

ID of the place for which to calculate the distribution

total_amount

number · float · required

Total amount to distribute

calculation_date

string · date

Calculation date

object

Additional parameters for the calculation

Distribution

Charge distribution for a specific unit

unit_id

string · uuid · required

ID of the unit (dwelling, premises, etc.)

unit_name

string · required

Name of the unit

amount

number · float · required

Amount allocated to this unit

percentage

number · float · required

Percentage of the total allocated to this unit

object

Calculation details for this unit

DistributionCalculationResponse

Result of the charge distribution calculation

distribution_key_id

string · uuid · required

ID of the distribution key used

total_amount

number · float · required

Total amount distributed

object[] · required

List of calculated distributions

calculation_date

string · date-time · required

Date and time of the calculation

object

Calculation metadata

InventoryConditionStatus

string · enum

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Condition state of an inventory item

Example: GOOD

Inventory

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

CreateInventory

Data for creating a new inventory item

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

quantity

integer · min: 1

Quantity of items

Example: 1

unit

string · maxLength: 20

Unit of measurement

Example: piece

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

UpdateInventory

Data for updating an inventory item

inventory_type_id

string | null · uuid

Inventory type ID

name

string | null · maxLength: 255

Specific name of the item

description

string | null

Detailed description of the item

brand

string | null · maxLength: 100

Brand of the item

model

string | null · maxLength: 100

Model of the item

serial_number

string | null · maxLength: 100

Serial number

quantity

integer | null · min: 1

Quantity of items

unit

string | null · maxLength: 20

Unit of measurement

condition_status

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes

string | null

Notes on the condition of the item

last_condition_check

string | null · date

Date of the last condition check

next_condition_check

string | null · date

Date of the next scheduled condition check

purchase_date

string | null · date

Purchase date

purchase_price

number | null · decimal

Purchase price

current_value

number | null · decimal

Estimated current value

insured_value

number | null · decimal

Insured value

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

last_maintenance_date

string | null · date

Date of the last maintenance

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

maintenance_frequency_days

integer | null

Maintenance frequency in days

maintenance_notes

string | null

Maintenance notes

tags

array | null

Tags for search/filtering

object | null

Custom fields per tenant

notes

string | null

General notes

InventoryCategory

Inventory category

id

string · uuid · required

Unique identifier of the category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Category description

Example: Doors and woodwork

CreateInventoryCategory

Data for creating a new inventory category

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

description

string | null

Category description

Example: Doors and woodwork

UpdateInventoryCategory

Data for updating an inventory category

name

string | null · maxLength: 255

Category name

description

string | null

Category description

InventoryType

Inventory type

id

string · uuid · required

Unique identifier of the type

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Type name

Example: Main door

is_active

boolean · required

Indicates whether the type is active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

CreateInventoryType

Data for creating a new inventory type

name

string · maxLength: 255 · required

Type name

Example: Main door

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

is_active

boolean | null

Indicates whether the type is active

Example: true

UpdateInventoryType

Data for updating an inventory type

name

string | null · maxLength: 255

Type name

description

string | null

Type description

category_id

string | null · uuid

Category ID

is_active

boolean | null

Indicates whether the type is active

RoomInventory

Junction between a room and an inventory item

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition of the item in this room

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

LinkInventoryToRoom

Data for linking an existing inventory item to a room

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer | null

Quantity of the item in this room

Example: 1

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition of the item in this room

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

placed_date

string | null · date

Date placed in the room

Example: 2024-01-15

removed_date

string | null · date

Date removed from the room

is_active

boolean | null

Indicates whether the item is currently in this room

Example: true

notes

string | null

Notes specific to this room

Example: Near the window

CreateInventoryWithRoom

Data for creating a new inventory item and linking it to a room in one operation

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

quantity

integer · min: 1

Quantity of items

Example: 1

unit

string · maxLength: 20

Unit of measurement

Example: piece

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

quantity_in_room

integer | null

Quantity of the item in this room

Example: 1

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition of the item in this room

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

placed_date

string | null · date

Date placed in the room

Example: 2024-01-15

removed_date

string | null · date

Date removed from the room

is_active

boolean | null

Indicates whether the item is currently in this room

Example: true

room_notes

string | null

Notes specific to this room

Example: Near the window

RoomInventoryWithDetails

Room-inventory junction with full inventory item details

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition of the item in this room

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

object

Full details of the inventory item

UpdateRoomInventory

Data for updating a room-inventory junction. **Update behavior for optional fields**: - **Field absent**: the existing value is preserved (no modification) - **Field present with `null`**: the value is removed (set to NULL in the database) - **Field present with a value**: the value is updated **Fields affected by this behavior**: - `location_description`: can be set to `null` to remove the value - `removed_date`: can be set to `null` to remove the value - `condition_notes_in_room`: can be set to `null` to remove the value - `notes`: can be set to `null` to remove the value

room_id

string | null · uuid

New room ID (to move the inventory item)

Example: 550e8400-e29b-41d4-a716-446655440001

quantity_in_room

integer | null

Quantity of the item in this room

location_description

string | null · maxLength: 500

Description of the location within the room.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

position_x

number | null · decimal

X position in the room (in meters)

position_y

number | null · decimal

Y position in the room (in meters)

is_active

boolean | null

Indicates whether the inventory item is currently in this room

placed_date

string | null · date

Date the item was placed in this room

removed_date

string | null · date

Date the item was removed from this room.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
Date: the value is updated

condition_in_room

string · enum

Condition of the item in this specific room

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null · maxLength: 500

Notes on the condition of the item in this room.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

notes

string | null · maxLength: 1000

General notes about this room-inventory association.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

EstateKeyType

string · enum

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Key or access badge type

Example: CLEF

EstateKeyStatus

string · enum

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Key status

Example: ACTIVE

EstateKeySecurityLevel

string · enum

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Key security level

Example: STANDARD

EstateKey

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

ListEstateKeysResponse

Paginated response for key list

object[] · required

Key list

total

integer · required

Total number of keys

Example: 10

page

integer · required

Current page number

Example: 1

limit

integer · required

Number of items per page

Example: 50

CreateEstateKey

Data for creating a new key

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

description

string · minLength: 1 · maxLength: 500 · required

Key description

Example: Main key for the apartment

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

UpdateEstateKey

Data for updating a key

key_type

string · enum

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

description

string | null · maxLength: 500

Key description

brand

string | null · maxLength: 100

Key or badge brand

key_number

string | null · maxLength: 100

Key or badge number

quantity

integer | null · min: 1

Key quantity

protected_code

string | null · maxLength: 100

Key protection code

security_level

string · enum

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

access_restrictions

string | null · maxLength: 1000

Access restrictions

emergency_contact

string | null · maxLength: 255

Emergency contact

notes

string | null · maxLength: 1000

Internal notes about the key

RenderEstateKeyDto

Data for handing over a key

rendered_to

string · maxLength: 255 · required

Person to whom the key is handed over

Example: Jean Dupont

rendered_by

string · maxLength: 255 · required

Person who hands over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time of handover (default: now)

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handover

Example: Apartment visit

notes

string | null · maxLength: 1000

Internal notes

Example: Key handed over for visit with potential tenant

ReturnEstateKeyDto

Data for returning a key

returned_by

string · maxLength: 255 · required

Person who returns the key

Example: Jean Dupont

notes

string | null · maxLength: 1000

Notes about the return

Example: Key returned in good condition

MarkEstateKeyLostDto

Data for marking a key as lost

changed_by

string · maxLength: 255 · required

Person who marks the key as lost

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the loss

Example: Key misplaced during the visit - Search in progress

MarkEstateKeyFoundDto

Data for marking a key as found

found_by

string · maxLength: 255 · required

Person who found the key

Example: Jean Dupont

notes

string | null · maxLength: 1000

Notes about the discovery

Example: Key found in the office

MarkEstateKeyDamagedDto

Data for marking a key as damaged

changed_by

string · maxLength: 255 · required

Person who marks the key as damaged

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the damage

Example: Key broken during use

ArchiveEstateKeyDto

Data for archiving a key

archived_by

string · maxLength: 255 · required

Person who archives the key

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the archival

Example: Key replaced by a new one

LesseeCategory

string · enum

Enum values:

individual

company/other

guarantor

Lessee category

Example: individual

Lessee

Complete lessee

id

string · uuid · required

Unique identifier of the lessee

Example: 550e8400-e29b-41d4-a716-446655440000

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

first_name

string · maxLength: 255

First name

Example: Jean

last_name

string · maxLength: 255

Last name

Example: Dupont

legal_name

string · maxLength: 255

Legal name (for companies)

Example: SARL Dupont & Associés

birth_date

string | null · date

Date of birth

Example: 1985-03-15

birth_place

string · maxLength: 255

Place of birth

Example: Paris

email

string · email

Email address

Example: [email protected]

mobile_phone

string · maxLength: 20

Mobile phone number

Example: +33 6 12 34 56 78

landline_phone

string · maxLength: 20

Landline phone number

Example: +33 1 23 45 67 89

address_country

string · maxLength: 50

Country

Example: France

address_complement

string · maxLength: 255

Address complement

Example: Appartement 12

address_street_number

string · maxLength: 50

Street number

Example: 123

address_street_name

string · maxLength: 255

Street name

Example: rue de la Paix

address_locality

string · maxLength: 255

Locality, district, or borough

Example: 1er arrondissement

address_postal_code

string · maxLength: 20

Postal code

Example: 75001

address_city

string · maxLength: 100

City

Example: Paris

address_postal_box

string · maxLength: 20

PO Box

Example: 123

profession

string · maxLength: 255

Profession

Example: Ingénieur

employer_name

string · maxLength: 255

Employer name

Example: TechCorp SAS

employer_phone

string · maxLength: 20

Employer phone

Example: +33 1 98 76 54 32

monthly_income

number | null · decimal · min: 0

Monthly income

Example: 3500

other_income

number | null · decimal · min: 0

Other income

Example: 500

bank_name

string · maxLength: 255

Bank name

Example: Crédit Agricole

iban

string · maxLength: 34

IBAN code

Example: FR76 1234 5678 9012 3456 7890 123

bic

string · maxLength: 11

BIC/SWIFT code

Example: AGRIFRPP

object | null

Additional addresses (JSON)

Example: {"work":"456 avenue des Champs-Élysées, 75008 Paris"}

object | null

Identity documents (JSON)

Example: {"passport":"12AB34567","id_card":"123456789"}

object | null

Additional contacts (JSON)

Example: {"emergency":"+33 6 98 76 54 32","family":"+33 1 11 22 33 44"}

object | null

Custom fields (JSON)

Example: {"preferred_language":"fr","special_needs":"wheelchair access"}

auth_user_id

string | null

Better Auth user ID

Example: user_123456789

LesseeListResponse

Paginated response for the lessee list

object[] · required

Lessees list

total

integer · required

Total number of lessees

Example: 10

page

integer · required

Current page number

Example: 1

limit

integer · required

Number of items per page

Example: 20

CreateLessee

Data for creating a new lessee

category

string · enum · required

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

first_name

string · maxLength: 255

First name (required for individuals)

last_name

string · maxLength: 255

Last name

legal_name

string · maxLength: 255

Legal name (required for companies)

birth_date

string | null · date

Date of birth

birth_place

string · maxLength: 255

Place of birth

email

string · email

Email address

mobile_phone

string · maxLength: 20

Mobile phone number

landline_phone

string · maxLength: 20

Landline phone number

address_country

string · maxLength: 50

Country

address_complement

string · maxLength: 255

Address complement

address_street_number

string · maxLength: 50

Street number

address_street_name

string · maxLength: 255

Street name

address_locality

string · maxLength: 255

Locality, district, or borough

address_postal_code

string · maxLength: 20

Postal code

address_city

string · maxLength: 100

City

address_postal_box

string · maxLength: 20

PO Box

profession

string · maxLength: 255

Profession

employer_name

string · maxLength: 255

Employer name

employer_phone

string · maxLength: 20

Employer phone

monthly_income

number · decimal · min: 0

Monthly income

other_income

number · decimal · min: 0

Other income

bank_name

string · maxLength: 255

Bank name

iban

string · maxLength: 34

IBAN code

bic

string · maxLength: 11

BIC/SWIFT code

object

Additional addresses (JSON)

object

Identity documents (JSON)

object

Additional contacts (JSON)

object

Custom fields (JSON)

auth_user_id

string

Better Auth user ID

UpdateLessee

Data for updating a lessee

category

string · enum

Lessee category

Enum values:

individual

company/other

guarantor

Example: individual

title

string · maxLength: 10

Title (Mr., Mrs., etc.)

first_name

string · maxLength: 255

First name

last_name

string · maxLength: 255

Last name

legal_name

string · maxLength: 255

Legal name (for companies)

birth_date

string · date

Date of birth

birth_place

string · maxLength: 255

Place of birth

email

string · email

Email address

mobile_phone

string · maxLength: 20

Mobile phone number

landline_phone

string · maxLength: 20

Landline phone number

address_country

string · maxLength: 50

Country

address_complement

string · maxLength: 255

Address complement

address_street_number

string · maxLength: 50

Street number

address_street_name

string · maxLength: 255

Street name

address_locality

string · maxLength: 255

Locality, district, or borough

address_postal_code

string · maxLength: 20

Postal code

address_city

string · maxLength: 100

City

address_postal_box

string · maxLength: 20

PO Box

profession

string · maxLength: 255

Profession

employer_name

string · maxLength: 255

Employer name

employer_phone

string · maxLength: 20

Employer phone

monthly_income

number · decimal · min: 0

Monthly income

other_income

number · decimal · min: 0

Other income

bank_name

string · maxLength: 255

Bank name

iban

string · maxLength: 34

IBAN code

bic

string · maxLength: 11

BIC/SWIFT code

object

Additional addresses (JSON)

object

Identity documents (JSON)

object

Additional contacts (JSON)

object

Custom fields (JSON)

auth_user_id

string

Better Auth user ID

LesseeType

string · enum

Enum values:

PRIMARY

GUARANTOR

CO_TENANT

Lessee type

Example: PRIMARY

CreateLesseesBulk

Bulk creation of lessees

object[] · minItems: 1 · maxItems: 100 · required

List of lessees to create

DeleteLesseesBulk

Bulk deletion of lessees

lessee_ids

string[] · minItems: 1 · maxItems: 100 · required

List of lessee IDs to delete

LeaseStatus

string · enum

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Lease status

Example: ACTIVE

LeaseRentFrequency

string · enum

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Rent payment frequency

Example: MONTHLY

LeaseRevisionIndexType

string · enum

Enum values:

ILC

ILAT

IRL

ICC

NONE

Rent revision index type

Example: IRL

LeaseUsageType

string · enum

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Premises usage type

Example: RESIDENTIAL_ONLY

ChargeSettlementMode

string · enum

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Charge settlement mode

Example: PROVISION

LeasePaymentTerms

string · enum

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Payment terms

Example: TERME_A_ECHOIR

LeasePaymentMethod

string · enum

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Payment method

Example: VIREMENT_BANCAIRE

Lease

Complete lease

id

string · uuid · required

Unique lease identifier

Example: 550e8400-e29b-41d4-a716-446655440000

estate_id

string · uuid · required

Rented property unit ID

Example: 550e8400-e29b-41d4-a716-446655440001

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440002

status

string · enum · required

Lease status

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Example: ACTIVE

version

integer · required

Lease version (incremented with each amendment)

Example: 1

start_date

string · date · required

Lease start date

Example: 2024-01-01

rent_amount

number · decimal · required

Lease rent amount (in EUR). Automatically synchronized with the associated Estate's rent_amount.

Example: 1200

rent_frequency

string · enum · required

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

is_subject_to_rent_evolution_decree

boolean · required

Subject to rent evolution decree at re-letting

Default: false

is_subject_to_reference_rent_cap

boolean · required

Subject to increased reference rent by prefectural decree

Default: false

payment_day

integer · min: 1 · max: 31 · required

Monthly payment day (1-31)

Example: 5

payment_terms

string · enum · required

Payment terms

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Example: TERME_A_ECHOIR

payment_method

string · enum · required

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Example: VIREMENT_BANCAIRE

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

template_id

string | null · uuid

Template ID used to generate the lease

agent_id

string | null · uuid

Agent ID (real estate agent)

reference_number

string | null · maxLength: 500

Lease reference number

Example: BAIL-2024-001

end_date

string | null · date

Lease end date

Example: 2025-01-01

deposit_amount

number | null · decimal

Security deposit amount

Example: 1200

revision_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

last_revision_date

string | null · date

Date of the last rent revision

next_revision_date

string | null · date

Date of the next rent revision

usage_type

string · enum

Premises usage type

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Example: RESIDENTIAL_ONLY

furniture_list_id

string | null · uuid

Furniture list ID (for furnished leases)

notes

string | null · maxLength: 5000

Internal notes

reference_rent_per_m2

number | null · decimal

Reference rent in EUR/m²

Example: 20.5

reference_rent_increased_per_m2

number | null · decimal

Increased reference rent in EUR/m²

Example: 22.55

base_rent_amount

number | null · decimal

Base rent (equal to increased reference rent if supplement)

Example: 1000

rent_complement_amount

number | null · decimal

Rent supplement

Example: 200

rent_complement_justification

string | null · maxLength: 5000

Rent supplement justification

previous_tenant_last_rent

number | null · decimal

Previous tenant's last rent

Example: 1150

previous_tenant_last_payment_date

string | null · date

Previous tenant's last payment date

previous_tenant_last_revision_date

string | null · date

Previous tenant's last revision date

rent_revision_date

string | null · date

Rent revision date

irl_reference_quarter

string | null · maxLength: 50

IRL reference quarter (e.g., Q1 2024)

Example: T1 2024

irl_reference_value

number | null · decimal

IRL reference index value

Example: 142.35

rent_regulation_applied_at

string | null · date-time

Regulation application date

rent_regulation_zone_type

string | null · maxLength: 50

Regulation zone type

rent_regulation_compliance_status

string | null · maxLength: 20

Regulation compliance status

rent_regulation_last_check

string | null · date-time

Date of last compliance check

charge_settlement_mode

string · enum

Charge settlement mode

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Example: PROVISION

rent_increase_for_work

number | null · decimal

Rent increase amount due to landlord's work

rent_increase_work_description

string | null

Description of work done by the landlord

rent_increase_work_cost

number | null · decimal

Total cost of work done by the landlord

rent_increase_work_completion_date

string | null · date

Work completion date

rent_increase_legal_basis

string | null

Legal basis (e.g., art. 17-2 law 1989)

rent_increase_calculation_method

string | null

Calculation method used

object | null

Supporting documents (invoices, quotes) - JSON format

rent_increase_start_date

string | null · date

Start date of the rent increase application

rent_increase_end_date

string | null · date

End date of the rent increase application

rent_increase_duration_months

integer | null

Application duration in months

rent_decrease_for_tenant_work

number | null · decimal

Rent decrease amount due to tenant's required work

rent_decrease_work_description

string | null

Description of work to be done by the tenant

rent_decrease_work_estimated_cost

number | null · decimal

Estimated cost of work to be borne by the tenant

rent_decrease_work_deadline

string | null · date

Deadline to complete the work

rent_decrease_work_specifications

string | null

Technical specifications of the work

rent_decrease_work_authorization_required

boolean | null

Prior authorization required

rent_decrease_restitution_clause

string | null

Restitution clause at end of lease

object | null

Documents (quotes, specifications) - JSON format

rent_decrease_start_date

string | null · date

Start date of the rent decrease application

rent_decrease_end_date

string | null · date

End date of the rent decrease application

rent_decrease_duration_months

integer | null

Application duration in months

solidarity_clause

string | null

Solidarity clause between co-tenants

termination_clause

string | null

Termination clause (termination conditions)

visit_clause

string | null

Clause for visits to re-let or sell

furniture_provision_clause

string | null

Clause regarding provided furniture

pet_clause

string | null

Pet clause

insurance_clause

string | null

Tenant home insurance clause

maintenance_clause

string | null

Annual appliance maintenance clause

damage_clause

string | null

Tenant damage clause

regularization_waiver_clause

string | null

Charge regularization waiver clause

rent_free_clause

string | null

Rent-free clause

custom_clause

string | null

Custom clause (free-form)

rent_free_start_date

string | null · date

Rent-free period start date

rent_free_end_date

string | null · date

Rent-free period end date

rent_free_amount

number | null · decimal

Rent-free amount (0 = fully free, >0 = reduced rent)

tenant_fees_cap_visit_dossier_lease_per_m2

number | null · decimal

Fee cap for visits/file processing/lease drafting (EUR/m²)

tenant_fees_cap_inventory_per_m2

number | null · decimal

Fee cap for move-in inspection (EUR/m²)

landlord_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

landlord_fees_visit_dossier_lease_description

string | null

Details of services performed

landlord_fees_inventory_entry

number | null · decimal

Move-in inspection fees

landlord_fees_inventory_entry_description

string | null

Move-in inspection service details

landlord_fees_other

number | null · decimal

Other services

landlord_fees_other_description

string | null

Details of other services and conditions

tenant_fees_visit_dossier_lease

number | null · decimal

Fees for visits/file processing/lease drafting

tenant_fees_visit_dossier_lease_description

string | null

Details of services performed

tenant_fees_inventory_entry

number | null · decimal

Move-in inspection fees

tenant_fees_inventory_entry_description

string | null

Move-in inspection service details

tenant_fees_other

number | null · decimal

Other fees

tenant_fees_other_description

string | null

Details of other services

fees_calculation_date

string | null · date-time

Fee calculation date

fees_regulation_compliance

boolean | null

Regulatory compliance

fees_agency_name

string | null

Agency/professional name

fees_agency_registration_number

string | null

Professional registration number

student_school_name

string | null · maxLength: 200

Educational institution name (student lease only)

Example: Université Paris-Saclay

student_enrollment_year

string | null · maxLength: 10

Academic year (student lease only)

Example: 2024-2025

student_certificate_provided

boolean | null

Enrollment certificate provided (student lease only)

student_level

string | null · maxLength: 50

Education level (student lease only)

Example: Master 1

mobility_reason

string | null · enum

Mobility reason (mobility lease only)

Enum values:

formation_professionnelle

etudes_superieures

contrat_apprentissage

stage

service_civique

mutation_professionnelle

mission_temporaire

autre

Example: mission_temporaire

mobility_reason_other

string | null · maxLength: 500

Reason details if 'autre' (mobility lease only)

initial_duration_months

integer | null · min: 1 · max: 10

Initial duration in months (mobility lease only, between 1 and 10 months)

Example: 6

extended_duration_months

integer | null · min: 1 · max: 10

Duration after extension in months (mobility lease only, maximum 10 months total)

Example: 9

lease_extension_info

object | null

Extension amendment information (mobility lease only)

seasonal_rental_purpose

string | null · maxLength: 100

Seasonal stay reason (seasonal lease only, max duration 90 days). Common values: vacation, business trip, spa treatment, tourism, other.

Example: vacances

seasonal_purpose_details

string | null · maxLength: 2000

Additional reason details if 'other' selected (seasonal lease only)

seasonal_guest_count

integer | null · min: 1

Number of guests accommodated in the property (seasonal lease only, minimum 1 person)

Example: 4

seasonal_cleaning_included

boolean | null

Indicates whether end-of-stay cleaning is included in the rent (seasonal lease only)

Default: false

seasonal_cleaning_fee

number | null · decimal · min: 0

End-of-stay cleaning fee if not included in the rent (seasonal lease only, in EUR)

Example: 80

seasonal_tourist_tax_included

boolean | null

Indicates whether the tourist tax is included in the rent (seasonal lease only)

Default: false

seasonal_tourist_tax_amount

number | null · decimal · min: 0

Tourist tax amount per person per night (seasonal lease only, in EUR)

Example: 2.5

seasonal_services_included

string | null · maxLength: 1000

Services included in the seasonal rental (wifi, household linen, parking, etc.)

Example: WiFi, household linen, private parking

seasonal_energy_mode

string | null · enum

Energy billing mode for the seasonal rental

Enum values:

inclus_forfait

compteur_releve

non_inclus

Example: inclus_forfait

seasonal_cancellation_policy

string | null · maxLength: 2000

Specific cancellation policy defined by the landlord (conditions, deadlines, potential penalties)

seasonal_declaration_number

string | null · maxLength: 50

City hall declaration number (Cerfa n°14004) - Legally required unless the property is the landlord's primary residence (Tourism Code L.324-1-1)

Example: 75001-2025-00123

commercial_business_name

string | null · maxLength: 255

Tenant company business name (commercial lease only, required per Article L145-1)

Example: TECH RETAIL SARL

commercial_legal_form

string | null · maxLength: 100

Company legal form (SARL, SAS, EURL, etc.)

Example: SARL

commercial_siret

string | null · maxLength: 14 · pattern: ^\d{14}$

14-digit SIRET number (required for commercial lease)

Example: 12345678901234

commercial_rcs

string | null · maxLength: 100

RCS registration (e.g., RCS Paris 123 456 789)

Example: RCS Paris 987 654 321

commercial_activity

string | null · maxLength: 2000

Description of the authorized commercial activity (premises purpose, Article L145-1). Determines despecialization rights.

Example: IT retail and office equipment

commercial_activity_code_ape

string | null · maxLength: 10

APE/NAF activity code (e.g., 47.11F)

Example: 47.11F

commercial_triennial_exit_year_3

string | null · date

Notification deadline for triennial termination at year 3 (3-6-9 rule, Article L145-5). The tenant must notify 6 months before this date.

Example: 2027-07-01

commercial_triennial_exit_year_6

string | null · date

Notification deadline for triennial termination at year 6 (3-6-9 rule, Article L145-5)

Example: 2030-07-01

commercial_triennial_exit_year_9

string | null · date

Notification deadline for triennial termination at year 9 (3-6-9 rule, Article L145-5)

Example: 2033-07-01

commercial_notice_period_months

integer | null · min: 1

Termination notice period in months (minimum 6 months per Article L145-12)

Example: 6

commercial_ilc_base_value

number | null · decimal · min: 0

Commercial Rent Index (ILC) reference value at lease start (for triennial revision per Articles L145-33 to L145-38)

Example: 130.52

commercial_ilc_base_date

string | null · date

ILC reference date (quarter) (e.g., 2024-10-01 for Q4 2024)

Example: 2024-10-01

commercial_next_revision_date

string | null · date

Next triennial rent revision date based on ILC

Example: 2027-01-01

commercial_rent_ceiling_enabled

boolean | null

Rent variation capping at +/-10% per 3-year period (Article L145-38)

Default: false

array | null

History of granted partial despecializations (related or complementary activities, Article L145-47)

Example: [{"date":"2025-06-01","activity":"Sale of IT accessories","approved_by":"Jean Dupont"}]

commercial_despecialization_full

object | null

Full despecialization (complete change of activity, Articles L145-48 and L145-49, requires judicial procedure)

Example: {"date":"2026-03-15","old_activity":"IT retail","new_activity":"Restaurant","approved":true,"indemnity_amount":15000}

array | null

Joint and several guarantors for the commercial lease (Article 2298 of the Civil Code)

Example: [{"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

string | null · maxLength: 200

Insurance policy number for rental risks and professional liability (required per Article L145-7)

Example: POL-RC-2025-789456

SignerType

string · enum

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Signer type

Example: PROPRIETAIRE

SignatureStatus

string · enum

Enum values:

PENDING

OTP_SENT

SIGNED

FAILED

EXPIRED

Status of an individual signature

Example: PENDING

SignatureRequestSummary

Summary of a signature request

id

string · uuid · required

Signature request ID

Example: 550e8400-e29b-41d4-a716-446655440000

signer_type

string · enum · required

Signer type

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

signer_email

string · email · required

Signer email

Example: [email protected]

status

string · enum · required

Status of an individual signature

Enum values:

PENDING

OTP_SENT

SIGNED

FAILED

EXPIRED

Example: PENDING

expires_at

string · date-time · required

Request expiration date

Example: 2024-01-20T10:00:00Z

LeaseRoleType

string · enum

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Role of the lessee in the lease

Example: PRIMARY

LeaseLessee

Association of a lessee with a lease

id

string · uuid · required

Unique identifier of the association

Example: 550e8400-e29b-41d4-a716-446655440005

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

lessee_id

string · uuid · required

Associated lessee ID

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

rent_share

number | null · decimal

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

CreateLeaseLessee

Data for associating a lessee with a lease

lessee_id

string · uuid · required

Lessee ID to associate

Example: 550e8400-e29b-41d4-a716-446655440001

role_type

string · enum · required

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

start_date

string · date · required

Start date of the association

Example: 2024-01-01

lease_id

string | null · uuid

Associated lease ID (can be omitted if in the path)

Example: 550e8400-e29b-41d4-a716-446655440000

rent_share

number | null · decimal · min: 0 · max: 1

Rent share for this lessee (if co-tenancy)

Example: 0.5

end_date

string | null · date

End date of the association

Example: 2025-01-01

created_by_amendment_id

string | null · uuid

Amendment ID that created this association

Example: 550e8400-e29b-41d4-a716-446655440002

guarantor_max_amount

number | null · decimal · min: 0

Maximum guaranteed amount (if role = GUARANTOR)

Example: 10000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

UpdateLeaseLessee

Data for updating a lessee-lease association

role_type

string · enum

Role of the lessee in the lease

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

rent_share

number | null · decimal · min: 0 · max: 1

Rent share for this lessee (if co-tenancy)

Example: 0.6

end_date

string | null · date

End date of the association

Example: 2025-06-30

ended_by_amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440004

guarantor_max_amount

number | null · decimal · min: 0

Maximum guaranteed amount (if role = GUARANTOR)

Example: 12000

guarantor_conditions

string | null · maxLength: 1000

Specific guarantee conditions

guarantees_lessee_id

string | null · uuid

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

Example: 550e8400-e29b-41d4-a716-446655440003

EndLesseeTermDto

Data for ending a lessee's association with a lease

end_date

string · date · required

End date of the association

Example: 2025-01-01

amendment_id

string | null · uuid

Amendment ID that ended this association

Example: 550e8400-e29b-41d4-a716-446655440000

LeaseType

Complete lease type

id

string · uuid · required

Unique identifier of the lease type

Example: 550e8400-e29b-41d4-a716-446655440000

legislative_zone_id

string · uuid · required

Legislative zone ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

CreateLeaseType

Data for creating a new lease type

legislative_zone_id

string · uuid · required

Legislative zone ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · minLength: 1 · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

UpdateLeaseType

Data for updating a lease type

name

string · minLength: 1 · maxLength: 255

Lease type name

Example: Furnished lease 3 years

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

is_furnished

boolean

Indicates whether the lease is furnished

Example: true

LeaseChargeMode

string · enum

Enum values:

PROVISION

FORFAIT

Charge management mode

Example: PROVISION

LeaseTypeConfiguration

Lease type configuration

id

string · uuid · required

Unique identifier of the configuration

Example: 550e8400-e29b-41d4-a716-446655440000

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

CreateLeaseTypeConfiguration

Data for creating a new lease type configuration

name

string · minLength: 1 · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

UpdateLeaseTypeConfiguration

Data for updating a lease type configuration

name

string · minLength: 1 · maxLength: 255

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1

Minimum duration in months

Example: 12

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

is_renewable

boolean

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0

Number of deposit months

Example: 1

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

charge_mode

string · enum

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean

Indicates whether a guarantor is required

Example: true

LeaseTypeTemplate

Lease type template

id

string · uuid · required

Unique identifier of the template

Example: 550e8400-e29b-41d4-a716-446655440000

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

CreateLeaseTypeTemplate

Data for creating a new lease type template

name

string · minLength: 1 · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · minLength: 1 · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · minLength: 1 · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

UpdateLeaseTypeTemplate

Data for updating a lease type template

name

string · minLength: 1 · maxLength: 255

Template name

Example: Standard furnished lease template

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

content

string · minLength: 1

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · minLength: 1 · maxLength: 50

Template version

Example: 1.0.0

is_active

boolean

Indicates whether the template is active

Example: true

is_default

boolean

Indicates whether the template is the default

Example: false

LeaseResponsibleParty

string · enum

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Party responsible for charges

Example: TENANT

DefaultCharge

Default charge

name

string · maxLength: 255 · required

Charge name

Example: Heating

amount

number · decimal · min: 0 · required

Charge amount

Example: 50

is_mandatory

boolean · required

Indicates whether the charge is mandatory

Example: true

calculation_method

string · enum · required

Calculation method

Enum values:

FIXED

PERCENTAGE

CONSUMPTION

Example: FIXED

DistributionRule

Charge distribution rule

charge_name

string · maxLength: 255 · required

Charge name

Example: Heating

distribution_method

string · enum · required

Distribution method

Enum values:

SURFACE

OCCUPANT

CONSUMPTION

EQUAL

Example: SURFACE

object | null

Distribution parameters

LeaseTypeChargeConfig

Charge configuration for a lease type

id

string · uuid · required

Unique identifier of the configuration

Example: 550e8400-e29b-41d4-a716-446655440000

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440001

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

string · enum · required

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

object[]

Default charges

object[]

Charge distribution rules

UpdateLeaseTypeChargeConfig

Data for updating a charge configuration

charge_mode

string · enum

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

string · enum

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

object[]

Default charges

object[]

Charge distribution rules

CreateLeaseTypeChargeConfig

Data for creating a new charge configuration

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

string · enum · required

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

object[]

Default charges

object[]

Charge distribution rules

LeaseListItem

Lease list item (simplified version)

id

string · uuid · required

estate_id

string · uuid · required

status

string · enum · required

Lease status

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Example: ACTIVE

start_date

string · date · required

rent_amount

number · decimal · required

rent_frequency

string · enum · required

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

reference_number

string | null

end_date

string | null · date

lessee_name

string | null

Formatted name of the primary tenant (PRIMARY role). Format: 'FirstName LastName' for individuals, 'Business Name' for companies. NULL if no tenant.

estate_name

string | null

Name of the associated property. NULL if property deleted.

place_name

string | null

Name or address of the place where the property is located. NULL if not defined.

deposit_amount

number | null · decimal

Security deposit amount

CreateLease

Data for creating a new lease

estate_id

string · uuid · required

Rented property unit ID

lease_type_id

string · uuid · required

Lease type ID

start_date

string · date · required

Lease start date

rent_frequency

string · enum · required

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

payment_day

integer · min: 1 · max: 31 · required

Monthly payment day (1-31)

Default: 1

payment_terms

string · enum · required

Payment terms

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Example: TERME_A_ECHOIR

Default: TERME_A_ECHOIR

payment_method

string · enum · required

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Example: VIREMENT_BANCAIRE

Default: VIREMENT_BANCAIRE

template_id

string | null · uuid

Template used ID

agent_id

string | null · uuid

Agent ID

reference_number

string | null · maxLength: 500

Lease reference number

end_date

string | null · date

Lease end date

rent_amount

number | null · decimal · min: 0

Rent amount.

Synchronization rules with Estate:

1. When creating a lease (POST /leases):

Code
 
┌─────────────────────────────────────────────────────────────┐
│  Lease creation                                             │
└─────────────────────────────────────────────────────────────┘
                      │
                      ▼
            ┌─────────────────────┐
            │ rent_amount provided │
            │ in the DTO?         │
            └─────────────────────┘
             │              │
    YES      │              │      NO
             ▼              ▼
┌──────────────────┐  ┌──────────────────┐
│ Use the DTO      │  │ Retrieve the     │
│ value            │  │ rent_amount from  │
│                  │  │ the Estate        │
│                  │  │                  │
│ Synchronize      │  │ If Estate has a  │
│ with Estate      │  │ rent_amount:     │
│ (update)         │  │ • Use this       │
│                  │  │   value          │
│                  │  │                  │
│                  │  │ If Estate has   │
│                  │  │ no              │
│                  │  │ rent_amount:    │
│                  │  │ • Use 0.00      │
│                  │  │   (default      │
│                  │  │   value)        │
└──────────────────┘  └──────────────────┘
             │              │
             └──────┬───────┘
                    ▼
           ┌─────────────────┐
           │ Create the lease │
           │ with rent_amount │
           └─────────────────┘

2. When updating a lease (PUT /leases/{id}):

Code
 
┌─────────────────────────────────────────────────────────────┐
│  Lease update                                               │
└─────────────────────────────────────────────────────────────┘
                      │
                      ▼
            ┌─────────────────────┐
            │ rent_amount provided │
            │ in the DTO?         │
            └─────────────────────┘
             │              │
    YES      │              │      NO
             ▼              ▼
┌──────────────────┐  ┌──────────────────┐
│ Update the lease │  │ No               │
│ with the new     │  │ synchronization  │
│ value            │  │ (rent_amount     │
│                  │  │ unchanged)       │
│                  │  │                  │
│ Synchronize      │  │                  │
│ with Estate      │  │                  │
│ (update)         │  │                  │
└──────────────────┘  └──────────────────┘

3. When updating rent (PUT /leases/{id}/rent):

Code
 
┌─────────────────────────────────────────────────────────────┐
│  Rent update                                                │
└─────────────────────────────────────────────────────────────┘
                      │
                      ▼
           ┌─────────────────────┐
           │ Update the lease    │
           │ rent_amount with    │
           │ new_rent_amount     │
           └─────────────────────┘
                      │
                      ▼
           ┌─────────────────────┐
           │ Automatically       │
           │ synchronize with    │
           │ Estate.rent_amount  │
           └─────────────────────┘

Rules summary:

Operation	rent_amount provided?	Estate.rent_amount exists?	Behavior
Creation	Yes	-	Use the DTO value + synchronize with Estate
Creation	No	Yes	Use `Estate.rent_amount`
Creation	No	No	Use `0.00` (default value)
Update	Yes	-	Update the lease + synchronize with Estate
Update	No	-	No rent modification
Rent update	Yes (required)	-	Update the lease + synchronize with Estate

Automatic synchronization:

Synchronization is performed atomically during each operation
It maintains consistency between the lease rent and the property's reference rent
Synchronization is unidirectional: Lease -> Estate (the lease updates the Estate)

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)

Example: 1200

deposit_amount

number | null · decimal · min: 0

Security deposit amount

revision_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

next_revision_date

string | null · date

Next revision date

usage_type

string · enum

Premises usage type

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Example: RESIDENTIAL_ONLY

notes

string | null · maxLength: 5000

Internal notes

is_subject_to_rent_evolution_decree

boolean | null

Subject to rent evolution decree

Default: false

is_subject_to_reference_rent_cap

boolean | null

Subject to increased reference rent cap

Default: false

reference_rent_per_m2

number | null · decimal

Reference rent in EUR/m²

reference_rent_increased_per_m2

number | null · decimal

Increased reference rent in EUR/m²

base_rent_amount

number | null · decimal

Base rent

rent_complement_amount

number | null · decimal

Rent supplement

rent_complement_justification

string | null · maxLength: 5000

Supplement justification

previous_tenant_last_rent

number | null · decimal

Previous tenant's last rent

previous_tenant_last_payment_date

string | null · date

Previous tenant's last payment date

previous_tenant_last_revision_date

string | null · date

Previous tenant's last revision date

rent_revision_date

string | null · date

Rent revision date

irl_reference_quarter

string | null · maxLength: 50

IRL reference quarter

irl_reference_value

number | null · decimal

IRL reference value

rent_regulation_applied_at

string | null · date-time

Regulation application date

rent_regulation_zone_type

string | null · maxLength: 50

Regulation zone type

rent_regulation_compliance_status

string | null · maxLength: 20

Compliance status

rent_regulation_last_check

string | null · date-time

Last check date

charge_settlement_mode

string · enum

Charge settlement mode

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Example: PROVISION

rent_increase_for_work

number | null · decimal · min: 0

Rent increase amount due to landlord's work

rent_increase_work_description

string | null · maxLength: 2000

Description of work done by the landlord

rent_increase_work_cost

number | null · decimal · min: 0

Total cost of work done by the landlord

rent_increase_work_completion_date

string | null · date

Work completion date

rent_increase_legal_basis

string | null · maxLength: 500

Legal basis (e.g., art. 17-2 law 1989)

rent_increase_calculation_method

string | null · maxLength: 500

Calculation method used

object | null

Supporting documents (invoices, quotes) - JSON format

rent_increase_start_date

string | null · date

Start date of the rent increase application

rent_increase_end_date

string | null · date

End date of the rent increase application

rent_increase_duration_months

integer | null · min: 1

Application duration in months

rent_decrease_for_tenant_work

number | null · decimal · min: 0

Rent decrease amount due to tenant's required work

rent_decrease_work_description

string | null · maxLength: 2000

Description of work to be done by the tenant

rent_decrease_work_estimated_cost

number | null · decimal · min: 0

Estimated cost of work to be borne by the tenant

rent_decrease_work_deadline

string | null · date

Deadline to complete the work

rent_decrease_work_specifications

string | null · maxLength: 2000

Technical specifications of the work

rent_decrease_work_authorization_required

boolean | null

Prior authorization required

rent_decrease_restitution_clause

string | null · maxLength: 2000

Restitution clause at end of lease

object | null

Documents (quotes, specifications) - JSON format

rent_decrease_start_date

string | null · date

Start date of the rent decrease application

rent_decrease_end_date

string | null · date

End date of the rent decrease application

rent_decrease_duration_months

integer | null · min: 1

Application duration in months

solidarity_clause

string | null · maxLength: 5000

Solidarity clause between co-tenants

termination_clause

string | null · maxLength: 5000

Termination clause (termination conditions)

visit_clause

string | null · maxLength: 2000

Clause for visits to re-let or sell

furniture_provision_clause

string | null · maxLength: 2000

Clause regarding provided furniture

pet_clause

string | null · maxLength: 2000

Pet clause

insurance_clause

string | null · maxLength: 2000

Tenant home insurance clause

maintenance_clause

string | null · maxLength: 2000

Annual appliance maintenance clause

damage_clause

string | null · maxLength: 2000

Tenant damage clause

regularization_waiver_clause

string | null · maxLength: 3000

Charge regularization waiver clause

rent_free_clause

string | null · maxLength: 5000

Rent-free clause

custom_clause

string | null · maxLength: 5000

Custom clause (free-form)

rent_free_start_date

string | null · date

Rent-free period start date

rent_free_end_date

string | null · date

Rent-free period end date

rent_free_amount

number | null · decimal · min: 0

Rent-free amount (0 = fully free, >0 = reduced rent)

tenant_fees_cap_visit_dossier_lease_per_m2

number | null · decimal · min: 0

Fee cap for visits/file processing/lease drafting (EUR/m²)

tenant_fees_cap_inventory_per_m2

number | null · decimal · min: 0

Fee cap for move-in inspection (EUR/m²)

landlord_fees_visit_dossier_lease

number | null · decimal · min: 0

Fees for visits/file processing/lease drafting

landlord_fees_visit_dossier_lease_description

string | null · maxLength: 5000

Details of services performed

landlord_fees_inventory_entry

number | null · decimal · min: 0

Move-in inspection fees

landlord_fees_inventory_entry_description

string | null · maxLength: 5000

Move-in inspection service details

landlord_fees_other

number | null · decimal · min: 0

Other services

landlord_fees_other_description

string | null · maxLength: 5000

Details of other services and conditions

tenant_fees_visit_dossier_lease

number | null · decimal · min: 0

Fees for visits/file processing/lease drafting

tenant_fees_visit_dossier_lease_description

string | null · maxLength: 5000

Details of services performed

tenant_fees_inventory_entry

number | null · decimal · min: 0

Move-in inspection fees

tenant_fees_inventory_entry_description

string | null · maxLength: 5000

Move-in inspection service details

tenant_fees_other

number | null · decimal · min: 0

Other fees

tenant_fees_other_description

string | null · maxLength: 5000

Details of other services

fees_calculation_date

string | null · date-time

Fee calculation date

fees_regulation_compliance

boolean | null

Regulatory compliance

fees_agency_name

string | null · maxLength: 255

Agency/professional name

fees_agency_registration_number

string | null · maxLength: 500

Professional registration number

student_school_name

string | null · maxLength: 200

Educational institution name (student lease only)

Example: Université Paris-Saclay

student_enrollment_year

string | null · maxLength: 10

Academic year (student lease only)

Example: 2024-2025

student_certificate_provided

boolean | null

Enrollment certificate provided (student lease only)

student_level

string | null · maxLength: 50

Education level (student lease only)

Example: Master 1

mobility_reason

string | null · enum

Mobility reason (mobility lease only)

Enum values:

formation_professionnelle

etudes_superieures

contrat_apprentissage

stage

service_civique

mutation_professionnelle

mission_temporaire

autre

Example: mission_temporaire

mobility_reason_other

string | null · maxLength: 500

Reason details if 'autre' (mobility lease only)

initial_duration_months

integer | null · min: 1 · max: 10

Initial duration in months (mobility lease only, between 1 and 10 months)

Example: 6

extended_duration_months

integer | null · min: 1 · max: 10

Duration after extension in months (mobility lease only, maximum 10 months total)

Example: 9

lease_extension_info

object | null

Extension amendment information (mobility lease only)

seasonal_rental_purpose

string | null · maxLength: 100

Seasonal stay reason (seasonal lease only, max duration 90 days). Common values: vacation, business trip, spa treatment, tourism, other.

Example: vacances

seasonal_purpose_details

string | null · maxLength: 2000

Additional reason details if 'other' selected (seasonal lease only)

seasonal_guest_count

integer | null · min: 1

Number of guests accommodated in the property (seasonal lease only, minimum 1 person)

Example: 4

seasonal_cleaning_included

boolean | null

Indicates whether end-of-stay cleaning is included in the rent (seasonal lease only)

Default: false

seasonal_cleaning_fee

number | null · decimal · min: 0

End-of-stay cleaning fee if not included in the rent (seasonal lease only, in EUR)

Example: 80

seasonal_tourist_tax_included

boolean | null

Indicates whether the tourist tax is included in the rent (seasonal lease only)

Default: false

seasonal_tourist_tax_amount

number | null · decimal · min: 0

Tourist tax amount per person per night (seasonal lease only, in EUR)

Example: 2.5

seasonal_services_included

string | null · maxLength: 1000

Services included in the seasonal rental (wifi, household linen, parking, etc.)

Example: WiFi, household linen, private parking

seasonal_energy_mode

string | null · enum

Energy billing mode for the seasonal rental

Enum values:

inclus_forfait

compteur_releve

non_inclus

Example: inclus_forfait

seasonal_cancellation_policy

string | null · maxLength: 2000

Specific cancellation policy defined by the landlord (conditions, deadlines, potential penalties)

seasonal_declaration_number

string | null · maxLength: 50

City hall declaration number (Cerfa n°14004) - Legally required unless the property is the landlord's primary residence (Tourism Code L.324-1-1)

Example: 75001-2025-00123

commercial_business_name

string | null · maxLength: 255

Tenant company business name (commercial lease only, required per Article L145-1)

Example: TECH RETAIL SARL

commercial_legal_form

string | null · maxLength: 100

Company legal form (SARL, SAS, EURL, etc.)

Example: SARL

commercial_siret

string | null · maxLength: 14 · pattern: ^\d{14}$

14-digit SIRET number (required for commercial lease, validated by CHECK constraint in database)

Example: 12345678901234

commercial_rcs

string | null · maxLength: 100

RCS registration (e.g., RCS Paris 123 456 789)

Example: RCS Paris 987 654 321

commercial_activity

string | null · maxLength: 2000

Description of the authorized commercial activity (premises purpose, Article L145-1). Determines despecialization rights.

Example: IT retail and office equipment

commercial_activity_code_ape

string | null · maxLength: 10

APE/NAF activity code (e.g., 47.11F)

Example: 47.11F

commercial_triennial_exit_year_3

string | null · date

Notification deadline for triennial termination at year 3 (3-6-9 rule, Article L145-5). The tenant must notify 6 months before this date.

Example: 2027-07-01

commercial_triennial_exit_year_6

string | null · date

Notification deadline for triennial termination at year 6 (3-6-9 rule, Article L145-5)

Example: 2030-07-01

commercial_triennial_exit_year_9

string | null · date

Notification deadline for triennial termination at year 9 (3-6-9 rule, Article L145-5)

Example: 2033-07-01

commercial_notice_period_months

integer | null · min: 1

Termination notice period in months (minimum 6 months per Article L145-12)

Example: 6

commercial_ilc_base_value

number | null · decimal · min: 0

Commercial Rent Index (ILC) reference value at lease start (for triennial revision)

Example: 130.52

commercial_ilc_base_date

string | null · date

ILC reference date (quarter) (e.g., 2024-10-01 for Q4 2024)

Example: 2024-10-01

commercial_next_revision_date

string | null · date

Next triennial rent revision date based on ILC

Example: 2027-01-01

commercial_rent_ceiling_enabled

boolean | null

Rent variation capping at +/-10% per 3-year period (Article L145-38)

Default: false

array | null

History of granted partial despecializations (related or complementary activities, Article L145-47)

Example: [{"date":"2025-06-01","activity":"Sale of IT accessories","approved_by":"Jean Dupont"}]

commercial_despecialization_full

object | null

Full despecialization (complete change of activity, Articles L145-48 and L145-49, requires judicial procedure)

Example: {"date":"2026-03-15","old_activity":"IT retail","new_activity":"Restaurant","approved":true,"indemnity_amount":15000}

array | null

Joint and several guarantors for the commercial lease (Article 2298 of the Civil Code)

Example: [{"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

string | null · maxLength: 200

Insurance policy number for rental risks and professional liability (required per Article L145-7)

Example: POL-RC-2025-789456

UpdateLease

Data for updating a lease (all fields are optional)

reference_number

string | null · maxLength: 500

end_date

string | null · date

rent_amount

number | null · decimal · min: 0

Rent amount.

Synchronization with Estate:

Code
 
┌─────────────────────────────────────────────────────────────┐
│  Lease rent_amount update                                   │
└─────────────────────────────────────────────────────────────┘
                      │
                      ▼
            ┌─────────────────────┐
            │ rent_amount provided │
            │ in the DTO?         │
            └─────────────────────┘
             │              │
    YES      │              │      NO
             ▼              ▼
┌──────────────────┐  ┌──────────────────┐
│ Update the lease │  │ No               │
│ with the new     │  │ modification     │
│ value            │  │ (rent_amount     │
│                  │  │ unchanged)       │
│                  │  │                  │
│ Synchronize      │  │                  │
│ with Estate      │  │                  │
│ (update)         │  │                  │
└──────────────────┘  └──────────────────┘

If this field is provided during the update, it automatically updates the rent_amount of the associated Estate
This synchronization maintains consistency between the lease rent and the property's reference rent
Synchronization is performed atomically during the lease update

Example: 1200

deposit_amount

number | null · decimal · min: 0

revision_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

next_revision_date

string | null · date

usage_type

string · enum

Premises usage type

Enum values:

RESIDENTIAL_ONLY

MIXED_PROFESSIONAL

Example: RESIDENTIAL_ONLY

furniture_list_id

string | null · uuid

notes

string | null · maxLength: 5000

is_subject_to_rent_evolution_decree

boolean | null

is_subject_to_reference_rent_cap

boolean | null

reference_rent_per_m2

number | null · decimal

reference_rent_increased_per_m2

number | null · decimal

base_rent_amount

number | null · decimal

rent_complement_amount

number | null · decimal

rent_complement_justification

string | null · maxLength: 5000

previous_tenant_last_rent

number | null · decimal

previous_tenant_last_payment_date

string | null · date

previous_tenant_last_revision_date

string | null · date

rent_revision_date

string | null · date

irl_reference_quarter

string | null · maxLength: 50

irl_reference_value

number | null · decimal

rent_regulation_zone_type

string | null · maxLength: 50

rent_regulation_compliance_status

string | null · maxLength: 20

charge_settlement_mode

string · enum

Charge settlement mode

Enum values:

PROVISION

PERIODIC

FLAT_RATE

Example: PROVISION

payment_day

integer | null · min: 1 · max: 31

payment_terms

string · enum

Payment terms

Enum values:

TERME_ECHU

TERME_A_ECHOIR

Example: TERME_A_ECHOIR

payment_method

string · enum

Payment method

Enum values:

VIREMENT_BANCAIRE

PRELEVEMENT_AUTOMATIQUE

CHEQUE

ESPECES

CARTE_BANCAIRE

MANDAT_CASH

AUTRE

Example: VIREMENT_BANCAIRE

landlord_fees_excluding_tax

number | null · decimal

landlord_fees_including_tax

number | null · decimal

tenant_fees_excluding_tax

number | null · decimal

tenant_fees_including_tax

number | null · decimal

tenant_fees_state_of_play

number | null · decimal

tenant_fees_inventory

number | null · decimal

tenant_fees_visit

number | null · decimal

tenant_fees_file_processing

number | null · decimal

tenant_fees_other

number | null · decimal

tenant_fees_other_description

string | null · maxLength: 5000

fees_agency_name

string | null · maxLength: 200

fees_agency_registration_number

string | null · maxLength: 500

student_school_name

string | null · maxLength: 200

Educational institution name (student lease only)

Example: Université Paris-Saclay

student_enrollment_year

string | null · maxLength: 10

Academic year (student lease only)

Example: 2024-2025

student_certificate_provided

boolean | null

Enrollment certificate provided (student lease only)

student_level

string | null · maxLength: 50

Education level (student lease only)

Example: Master 1

mobility_reason

string | null · enum

Mobility reason (mobility lease only)

Enum values:

formation_professionnelle

etudes_superieures

contrat_apprentissage

stage

service_civique

mutation_professionnelle

mission_temporaire

autre

Example: mission_temporaire

mobility_reason_other

string | null · maxLength: 500

Reason details if 'autre' (mobility lease only)

initial_duration_months

integer | null · min: 1 · max: 10

Initial duration in months (mobility lease only, between 1 and 10 months)

Example: 6

extended_duration_months

integer | null · min: 1 · max: 10

Duration after extension in months (mobility lease only, maximum 10 months total)

Example: 9

lease_extension_info

object | null

Extension amendment information (mobility lease only)

seasonal_rental_purpose

string | null · maxLength: 100

Seasonal stay reason (seasonal lease only, max duration 90 days). Common values: vacation, business trip, spa treatment, tourism, other.

Example: vacances

seasonal_purpose_details

string | null · maxLength: 2000

Additional reason details if 'other' selected (seasonal lease only)

seasonal_guest_count

integer | null · min: 1

Number of guests accommodated in the property (seasonal lease only, minimum 1 person)

Example: 4

seasonal_cleaning_included

boolean | null

Indicates whether end-of-stay cleaning is included in the rent (seasonal lease only)

seasonal_cleaning_fee

number | null · decimal · min: 0

End-of-stay cleaning fee if not included in the rent (seasonal lease only, in EUR)

Example: 80

seasonal_tourist_tax_included

boolean | null

Indicates whether the tourist tax is included in the rent (seasonal lease only)

seasonal_tourist_tax_amount

number | null · decimal · min: 0

Tourist tax amount per person per night (seasonal lease only, in EUR)

Example: 2.5

seasonal_services_included

string | null · maxLength: 1000

Services included in the seasonal rental (wifi, household linen, parking, etc.)

Example: WiFi, household linen, private parking

seasonal_energy_mode

string | null · enum

Energy billing mode for the seasonal rental

Enum values:

inclus_forfait

compteur_releve

non_inclus

Example: inclus_forfait

seasonal_cancellation_policy

string | null · maxLength: 2000

Specific cancellation policy defined by the landlord (conditions, deadlines, potential penalties)

seasonal_declaration_number

string | null · maxLength: 50

City hall declaration number (Cerfa n°14004) - Legally required unless the property is the landlord's primary residence (Tourism Code L.324-1-1)

Example: 75001-2025-00123

commercial_business_name

string | null · maxLength: 255

Tenant company business name (commercial lease only, required per Article L145-1)

Example: TECH RETAIL SARL

commercial_legal_form

string | null · maxLength: 100

Company legal form (SARL, SAS, EURL, etc.)

Example: SARL

commercial_siret

string | null · maxLength: 14 · pattern: ^\d{14}$

14-digit SIRET number (required for commercial lease, validated by CHECK constraint in database)

Example: 12345678901234

commercial_rcs

string | null · maxLength: 100

RCS registration (e.g., RCS Paris 123 456 789)

Example: RCS Paris 987 654 321

commercial_activity

string | null · maxLength: 2000

Description of the authorized commercial activity (premises purpose, Article L145-1). Determines despecialization rights.

Example: IT retail and office equipment

commercial_activity_code_ape

string | null · maxLength: 10

APE/NAF activity code (e.g., 47.11F)

Example: 47.11F

commercial_triennial_exit_year_3

string | null · date

Notification deadline for triennial termination at year 3 (3-6-9 rule, Article L145-5)

Example: 2027-07-01

commercial_triennial_exit_year_6

string | null · date

Notification deadline for triennial termination at year 6 (3-6-9 rule, Article L145-5)

Example: 2030-07-01

commercial_triennial_exit_year_9

string | null · date

Notification deadline for triennial termination at year 9 (3-6-9 rule, Article L145-5)

Example: 2033-07-01

commercial_notice_period_months

integer | null · min: 1

Termination notice period in months (minimum 6 months per Article L145-12)

Example: 6

commercial_ilc_base_value

number | null · decimal · min: 0

Commercial Rent Index (ILC) reference value at lease start (for triennial revision)

Example: 130.52

commercial_ilc_base_date

string | null · date

ILC reference date (quarter) (e.g., 2024-10-01 for Q4 2024)

Example: 2024-10-01

commercial_next_revision_date

string | null · date

Next triennial rent revision date based on ILC

Example: 2027-01-01

commercial_rent_ceiling_enabled

boolean | null

Rent variation capping at +/-10% per 3-year period (Article L145-38)

array | null

History of granted partial despecializations (related or complementary activities, Article L145-47)

commercial_despecialization_full

object | null

Full despecialization (complete change of activity, Articles L145-48 and L145-49)

array | null

Joint and several guarantors for the commercial lease (Article 2298 of the Civil Code)

commercial_insurance_policy

string | null · maxLength: 200

Insurance policy number for rental risks and professional liability (required per Article L145-7)

Example: POL-RC-2025-789456

ChangeLeaseStatusDto

Data for changing a lease status

status

string · enum · required

Lease status

Enum values:

DRAFT

PENDING_SIGNATURE

ACTIVE

NOTICE

FINALISATION

TERMINATED

EXPIRED

Example: ACTIVE

reason

string | null · maxLength: 500

Reason for the status change

RentUpdateDto

Data for updating a lease's rent. **Automatic synchronization with Estate**: ``` ┌─────────────────────────────────────────────────────────────┐ │ Synchronization flow Lease -> Estate │ └─────────────────────────────────────────────────────────────┘ PUT /leases/{id}/rent │ ▼ ┌──────────────────────┐ │ new_rent_amount │ │ (in the DTO) │ └──────────────────────┘ │ ▼ ┌──────────────────────┐ ┌──────────────────────┐ │ Lease rent_amount │────────▶│ Automatic │ │ update │ │ synchronization with │ └──────────────────────┘ │ Estate.rent_amount │ └──────────────────────┘ ``` - The new rent amount (`new_rent_amount`) is automatically synchronized to the `rent_amount` field of the associated Estate - This synchronization maintains consistency between the lease rent and the property's reference rent - Synchronization is performed atomically during the rent update

new_rent_amount

number · decimal · min: 0 · required

New rent amount.

Automatic synchronization:

Code
 
┌─────────────────────────────────────────────────────────────┐
│  Rent update (PUT /leases/{id}/rent)                        │
└─────────────────────────────────────────────────────────────┘
                      │
                      ▼
           ┌─────────────────────┐
           │ Update the lease    │
           │ rent_amount with    │
           │ new_rent_amount     │
           └─────────────────────┘
                      │
                      ▼
           ┌─────────────────────┐
           │ Automatically       │
           │ synchronize with    │
           │ Estate.rent_amount  │
           └─────────────────────┘

This amount is automatically synchronized to the rent_amount field of the Estate associated with the lease
Synchronization is performed atomically during the update

revision_date

string | null · date

Revision date

irl_reference_quarter

string | null · maxLength: 50

IRL reference quarter

irl_reference_value

number | null · decimal

IRL reference value

ComplianceCheckType

string · enum

Enum values:

RentControl

RentRegulation

ZoneRegulation

Type of compliance check performed.

RentControl: Rent control verification (Alur law)
RentRegulation: Rent regulation verification (high-demand zones)
ZoneRegulation: Verification of regulations specific to the geographical area

Example: RentControl

ComplianceStatus

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = object · requires: Error

Properties for Variant 1:

string · enum

Enum values:

Compliant

NonCompliant

Warning

NotApplicable

Simple compliance status

Example: Compliant

ComplianceCheck

Individual compliance check

check_type

string · enum · required

Type of compliance check performed.

RentControl: Rent control verification (Alur law)
RentRegulation: Rent regulation verification (high-demand zones)
ZoneRegulation: Verification of regulations specific to the geographical area

Enum values:

RentControl

RentRegulation

ZoneRegulation

Example: RentControl

required

Compliance status of a check.

Possible values:

"Compliant": The lease complies with regulations
"NonCompliant": The lease does not comply (action required)
"Warning": Warning (compliant but attention required)
"NotApplicable": The check is not applicable to this lease
{"Error": {"message": "..."}}: Error during verification (with detailed message)

Examples:


Code
 
"Compliant"


Code
 
{
  "Error": {
    "message": "Verification error: Unable to retrieve regulation data"
  }
}

details

string · required

Check details

recommendations

string[] · required

Recommendations

LeaseComplianceCheckResponse

Lease compliance check result

lease_id

string · uuid · required

Lease ID

country_code

string · required

Country code

Example: FR

legislative_zone_name

string · required

Legislative zone name

postal_code

string · required

Postal code

object[] · required

Checks list

required

Compliance status of a check.

Possible values:

"Compliant": The lease complies with regulations
"NonCompliant": The lease does not comply (action required)
"Warning": Warning (compliant but attention required)
"NotApplicable": The check is not applicable to this lease
{"Error": {"message": "..."}}: Error during verification (with detailed message)

Examples:


Code
 
"Compliant"


Code
 
{
  "Error": {
    "message": "Verification error: Unable to retrieve regulation data"
  }
}

rent_revision_date

string | null · date

Rent revision date

irl_reference_quarter

string | null

IRL reference quarter

irl_reference_value

number | null · decimal

IRL reference value

LeaseDocument

Lease document

id

string · uuid · required

Unique identifier of the document

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

document_type

string · maxLength: 100 · required

Document type

Example: CONTRACT

file_path

string · required

File path

Example: /documents/leases/2024/lease-001.pdf

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Document description

Example: Lease contract signed by both parties

UploadLeaseDocumentDto

Data for uploading a lease document

document_type

string · minLength: 1 · maxLength: 100 · required

Document type

description

string | null · maxLength: 500

Document description

file

string

File to upload

UpdateLeaseDocument

Data for updating a lease document

document_type

string | null · minLength: 1 · maxLength: 100

Document type

file_path

string | null · minLength: 1

File path

description

string | null · maxLength: 500

Document description

LeaseAmendmentType

string · enum

Enum values:

RENT_INCREASE

DURATION_EXTENSION

TERMS_MODIFICATION

PARTY_CHANGE

PROPERTY_CHANGE

OTHER

Amendment type

Example: RENT_INCREASE

LeaseAmendmentStatus

string · enum

Enum values:

DRAFT

PENDING_APPROVAL

APPROVED

REJECTED

ACTIVE

EXPIRED

Amendment status

Example: DRAFT

LeaseAmendment

Lease amendment

id

string · uuid · required

Unique identifier of the amendment

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

amendment_number

string · maxLength: 100 · required

Amendment number

Example: AVE-001

amendment_type

string · enum · required

Amendment type

Enum values:

RENT_INCREASE

DURATION_EXTENSION

TERMS_MODIFICATION

PARTY_CHANGE

PROPERTY_CHANGE

OTHER

Example: RENT_INCREASE

status

string · enum · required

Amendment status

Enum values:

DRAFT

PENDING_APPROVAL

APPROVED

REJECTED

ACTIVE

EXPIRED

Example: DRAFT

effective_date

string · date · required

Effective date of the amendment

Example: 2024-06-01

description

string · required

Description of the amendment

Example: Rent increase following IRL revision

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

created_by

string · uuid · required

ID of the creator user

updated_by

string · uuid · required

ID of the last modifier user

signature_date

string | null · date

Amendment signature date

Example: 2024-05-15

validation_status

string | null · maxLength: 100

Validation status (VARCHAR in DB)

validation_date

string | null · date-time

Validation date

validated_by

string | null · uuid

ID of the user who validated

legal_reference

string | null · maxLength: 200

Legal reference

special_conditions

string | null · maxLength: 2000

Special conditions of the amendment

notes

string | null · maxLength: 1000

Internal notes

CreateLeaseAmendment

Data for creating a new lease amendment

amendment_number

string · minLength: 1 · maxLength: 100 · required

Amendment number

amendment_type

string · enum · required

Amendment type

Enum values:

RENT_INCREASE

DURATION_EXTENSION

TERMS_MODIFICATION

PARTY_CHANGE

PROPERTY_CHANGE

OTHER

Example: RENT_INCREASE

effective_date

string · date · required

Effective date of the amendment

description

string · required

Description of the amendment

created_by

string · uuid · required

ID of the creator user (required)

signature_date

string | null · date

Signature date

legal_reference

string | null · maxLength: 200

Legal reference

special_conditions

string | null · maxLength: 2000

Special conditions

notes

string | null · maxLength: 1000

Internal notes

UpdateLeaseAmendment

Data for updating a lease amendment

amendment_type

string · enum

Amendment type

Enum values:

RENT_INCREASE

DURATION_EXTENSION

TERMS_MODIFICATION

PARTY_CHANGE

PROPERTY_CHANGE

OTHER

Example: RENT_INCREASE

status

string · enum

Amendment status

Enum values:

DRAFT

PENDING_APPROVAL

APPROVED

REJECTED

ACTIVE

EXPIRED

Example: DRAFT

effective_date

string | null · date

Effective date

signature_date

string | null · date

Signature date

validation_status

string | null · maxLength: 100

Validation status (VARCHAR)

validation_date

string | null · date-time

Validation date

validated_by

string | null · uuid

Validator ID

legal_reference

string | null · maxLength: 200

Legal reference

description

string | null

Description

special_conditions

string | null · maxLength: 2000

Special conditions

notes

string | null · maxLength: 1000

Internal notes

updated_by

string | null · uuid

Modifier ID

ChangeAmendmentStatusDto

Data for changing the status of an amendment

status

string · enum · required

Amendment status

Enum values:

DRAFT

PENDING_APPROVAL

APPROVED

REJECTED

ACTIVE

EXPIRED

Example: DRAFT

reason

string | null · maxLength: 500

Reason for the status change

ModeFacturationCharge

string · enum

Enum values:

FORFAIT

PROVISION

DEPENSE_REELLE

RELEVE_DIRECT

Charge billing mode to the tenant (provision/fixed/actual expense).

Compatibility rules:

CONSOMMATION_MESUREE (distribution) requires RELEVE_DIRECT or PROVISION
FORFAIT requires FORFAIT as calculation basis
DEPENSE_REELLE requires DEPENSE_REELLE or a staff basis as calculation basis
PROVISION can be used with all calculation bases
The mode must be allowed for the lease type (allow_provisional, allow_fixed)

Example: PROVISION

BaseCalculCharge

string · enum

Enum values:

DEPENSE_REELLE

FORFAIT

PERSONNEL_75_POURCENT

PERSONNEL_40_POURCENT

PERSONNEL_100_POURCENT

Charge calculation basis (specific business rules only).

Compatibility rules:

FORFAIT requires FORFAIT as billing mode
DEPENSE_REELLE requires DEPENSE_REELLE as billing mode or can be used with PROVISION
PERSONNEL_75_POURCENT, PERSONNEL_40_POURCENT, PERSONNEL_100_POURCENT:
- Require the EMPLOYEE category
- Can be used with DEPENSE_REELLE or PROVISION as billing mode

Example: FORFAIT

EnergyEfficiencyContribution

Contribution for sharing energy savings (Energy Transition Act)

id

string · uuid · required

Unique identifier

lease_charge_id

string · uuid · required

Associated charge ID

baseline_consumption

number · decimal · min: 0 · required

Consumption before works

target_savings_percentage

number · decimal · min: 0 · max: 100 · required

Targeted savings percentage

monthly_contribution_amount

number · decimal · min: 0 · required

Monthly contribution amount

remaining_months

integer · min: 0 · required

Remaining duration in months

work_description

string · required

Description of the completed works

start_date

string · date · required

Contribution start date

end_date

string · date · required

Contribution end date

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

work_cost

number | null · decimal · min: 0

Cost of works

energy_audit_reference

string | null · maxLength: 100

Energy audit reference

notes

string | null · maxLength: 1000

Notes

ColocatationInsurance

Insurance taken out by the landlord on behalf of co-tenants

id

string · uuid · required

Unique identifier

lease_charge_id

string · uuid · required

Associated charge ID

contract_number

string · maxLength: 100 · required

Insurance contract number

insurance_company

string · maxLength: 200 · required

Insurance company

annual_premium

number · decimal · min: 0 · required

Annual premium

recoverable_amount

number · decimal · min: 0 · required

Amount recoverable from tenants

coverage_details

string · required

Coverage details

policy_start_date

string · date · required

Policy start date

policy_end_date

string · date · required

Policy end date

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

deductible_amount

number | null · decimal · min: 0

Deductible amount

object | null

Coverage limits (JSON)

exclusions

string | null · maxLength: 1000

Coverage exclusions

notes

string | null · maxLength: 1000

Notes

LeaseCharge

Rental charge

id

string · uuid · required

Unique identifier of the charge

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

calculation_method

string · enum · required

Charge billing mode to the tenant (provision/fixed/actual expense).

Compatibility rules:

CONSOMMATION_MESUREE (distribution) requires RELEVE_DIRECT or PROVISION
FORFAIT requires FORFAIT as calculation basis
DEPENSE_REELLE requires DEPENSE_REELLE or a staff basis as calculation basis
PROVISION can be used with all calculation bases
The mode must be allowed for the lease type (allow_provisional, allow_fixed)

Enum values:

FORFAIT

PROVISION

DEPENSE_REELLE

RELEVE_DIRECT

Example: PROVISION

calculation_basis

string · enum · required

Charge calculation basis (specific business rules only).

Compatibility rules:

FORFAIT requires FORFAIT as billing mode
DEPENSE_REELLE requires DEPENSE_REELLE as billing mode or can be used with PROVISION
PERSONNEL_75_POURCENT, PERSONNEL_40_POURCENT, PERSONNEL_100_POURCENT:
- Require the EMPLOYEE category
- Can be used with DEPENSE_REELLE or PROVISION as billing mode

Enum values:

DEPENSE_REELLE

FORFAIT

PERSONNEL_75_POURCENT

PERSONNEL_40_POURCENT

PERSONNEL_100_POURCENT

Example: FORFAIT

amount

number · decimal · min: 0 · required

Charge amount

Example: 150

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

service_place_id

string | null · uuid

Place service ID

category_id

string | null · uuid

Charge category ID

billing_period_start

string | null · date

Billing period start date

billing_period_end

string | null · date

Billing period end date

last_regularization_date

string | null · date

Last regularization date

distribution_key_id

string | null · uuid

Distribution key ID

notes

string | null · maxLength: 1000

Notes about the charge

object

Associated energy efficiency contribution (if applicable)

object

Associated co-tenancy insurance (if applicable)

CreateEnergyEfficiencyForCharge

Data for creating a new energy efficiency contribution when creating a charge

baseline_consumption

number · decimal · min: 0 · required

Consumption before works

Example: 15000

target_savings_percentage

number · decimal · min: 0 · max: 100 · required

Targeted savings percentage (0-100)

Example: 25

monthly_contribution_amount

number · decimal · min: 0 · required

Monthly contribution amount

Example: 50

duration_months

integer · min: 1 · required

Contribution duration in months

Example: 36

work_description

string · minLength: 1 · maxLength: 1000 · required

Description of the completed works

Example: Attic thermal insulation and boiler replacement

start_date

string · date · required

Contribution start date

Example: 2024-01-01

work_cost

number | null · decimal · min: 0

Cost of works

Example: 18000

energy_audit_reference

string | null · maxLength: 100

Energy audit reference

Example: DPE-2024-001234

notes

string | null · maxLength: 1000

Notes

CreateColocatationInsuranceForCharge

Data for creating a new co-tenancy insurance when creating a charge

contract_number

string · minLength: 1 · maxLength: 100 · required

Insurance contract number

Example: ASS-COL-2024-001

insurance_company

string · minLength: 1 · maxLength: 200 · required

Insurance company

Example: AXA Assurances

annual_premium

number · decimal · min: 0 · required

Annual premium

Example: 1200

recoverable_amount

number · decimal · min: 0 · required

Amount recoverable from tenants (less than or equal to annual premium)

Example: 1200

coverage_details

string · minLength: 1 · maxLength: 2000 · required

Coverage details

Example: Civil liability, water damage, fire

policy_start_date

string · date · required

Policy start date

Example: 2024-01-01

policy_end_date

string · date · required

Policy end date (must be after start date)

Example: 2024-12-31

deductible_amount

number | null · decimal · min: 0

Deductible amount

Example: 150

object | null

Coverage limits (JSON)

Example: {"civil_liability":2000000,"water_damage":50000}

exclusions

string | null · maxLength: 1000

Coverage exclusions

Example: Intentional damage, undeclared natural disasters

notes

string | null · maxLength: 1000

Notes

CreateLeaseCharge

Data for creating a rental charge. **Validation rules:** - If `service_place_id` is provided, the service must be attached to the same place as the lease's estate and must be chargeable - If `distribution_key_id` is not provided, it will be automatically resolved from `service_place.default_distribution_key_id` (required if `service_place_id` is provided) - The distribution key allocation must be compatible with `calculation_method` (e.g.: `CONSOMMATION_MESUREE` requires `RELEVE_DIRECT` or `PROVISION`) - `calculation_method` and `calculation_basis` must be compatible (e.g.: `FORFAIT` requires `FORFAIT` as basis) - The category (via `category_id` or `service_place.category_id`) must be allowed for the lease type - If `calculation_method` is `PROVISION`, the period duration must not exceed `max_provisional_months` of the lease type - Billing periods must be within the lease boundaries (between `lease.start_date` and `lease.end_date`) - If `category_id` corresponds to `EMPLOYEE`, `calculation_basis` must be `PERSONNEL_75_POURCENT`, `PERSONNEL_40_POURCENT` or `PERSONNEL_100_POURCENT`

calculation_method

string · enum · required

Billing mode. Must be compatible with:

The distribution key allocation
The lease type (checks allow_provisional and allow_fixed)

Enum values:

FORFAIT

PROVISION

DEPENSE_REELLE

RELEVE_DIRECT

Example: PROVISION

calculation_basis

string · enum · required

Calculation basis. Must be compatible with:

The billing mode (FORFAIT requires FORFAIT, DEPENSE_REELLE requires DEPENSE_REELLE or employee basis)
The category (if EMPLOYEE, must use an employee basis)

Enum values:

DEPENSE_REELLE

FORFAIT

PERSONNEL_75_POURCENT

PERSONNEL_40_POURCENT

PERSONNEL_100_POURCENT

Example: FORFAIT

amount

number · decimal · min: 0 · required

Charge amount

service_place_id

string | null · uuid

Place service ID. If provided:

The service must be attached to the same place as the lease's estate
The service must be chargeable (is_chargeable = true)
The service must have a default_distribution_key_id if distribution_key_id is not provided

category_id

string | null · uuid

Category ID. If not provided, it will be resolved from service_place.category_id if service_place_id is provided. The category must be allowed for the lease type.

billing_period_start

string | null · date

Billing period start date. Must be:

= lease.start_date
<= billing_period_end if provided
<= lease.end_date if the lease has an end date

billing_period_end

string | null · date

Billing period end date. Must be:

= billing_period_start
<= lease.end_date if the lease has an end date
If calculation_method is PROVISION, the duration must not exceed max_provisional_months of the lease type

distribution_key_id

string | null · uuid

Distribution key ID. If not provided:

Will be resolved from service_place.default_distribution_key_id if service_place_id is provided
Otherwise, an error will be returned

notes

string | null · maxLength: 1000

Notes

object

Energy efficiency contribution (optional)

object

Co-tenancy insurance (optional)

UpdateEnergyEfficiency

Data for updating an energy efficiency contribution

baseline_consumption

number | null · decimal · min: 0

Consumption before works

target_savings_percentage

number | null · decimal · min: 0 · max: 100

Targeted savings percentage (0-100)

monthly_contribution_amount

number | null · decimal · min: 0

Monthly contribution amount

remaining_months

integer | null · min: 0

Remaining duration in months

work_description

string | null · minLength: 1 · maxLength: 1000

Description of the completed works

work_cost

number | null · decimal · min: 0

Cost of works

energy_audit_reference

string | null · maxLength: 100

Energy audit reference

start_date

string | null · date

Contribution start date

end_date

string | null · date

Contribution end date

notes

string | null · maxLength: 1000

Notes

UpdateColocatationInsurance

Data for updating a co-tenancy insurance

contract_number

string | null · minLength: 1 · maxLength: 100

Insurance contract number

insurance_company

string | null · minLength: 1 · maxLength: 200

Insurance company

annual_premium

number | null · decimal · min: 0

Annual premium

recoverable_amount

number | null · decimal · min: 0

Amount recoverable from tenants

coverage_details

string | null · minLength: 1 · maxLength: 2000

Coverage details

policy_start_date

string | null · date

Policy start date

policy_end_date

string | null · date

Policy end date

deductible_amount

number | null · decimal · min: 0

Deductible amount

object | null

Coverage limits (JSON)

exclusions

string | null · maxLength: 1000

Coverage exclusions

notes

string | null · maxLength: 1000

Notes

UpdateLeaseCharge

Data for updating a rental charge. **Validation rules:** - The same validations as for creation apply to modified fields - Values not provided retain their existing values - If `service_place_id` is modified, service_place / lease compatibility validations apply - If `calculation_method` or `calculation_basis` are modified, consistency validations apply

service_place_id

string | null · uuid

Service ID. If modified, the service must be attached to the same place as the lease's estate and must be chargeable

category_id

string | null · uuid

Category ID. If modified, the category must be allowed for the lease type

calculation_method

string · enum

Billing mode. If modified, must be compatible with the allocation and the lease type

Enum values:

FORFAIT

PROVISION

DEPENSE_REELLE

RELEVE_DIRECT

Example: PROVISION

calculation_basis

string · enum

Calculation basis. If modified, must be compatible with the billing mode and the category

Enum values:

DEPENSE_REELLE

FORFAIT

PERSONNEL_75_POURCENT

PERSONNEL_40_POURCENT

PERSONNEL_100_POURCENT

Example: FORFAIT

amount

number | null · decimal · min: 0

billing_period_start

string | null · date

Billing period start date. If modified, must respect the lease boundaries

billing_period_end

string | null · date

Billing period end date. If modified, must respect the lease boundaries and max_provisional_months if applicable

last_regularization_date

string | null · date

Last regularization date

distribution_key_id

string | null · uuid

Distribution key ID. If modified, must be compatible with calculation_method

notes

string | null · maxLength: 1000

object

Update energy efficiency contribution (optional)

object

Update co-tenancy insurance (optional)

PdfMargins

PDF document margins in millimeters

top

number · float · min: 0

Top margin

Example: 25

Default: 25

right

number · float · min: 0

Right margin

Example: 25

Default: 25

bottom

number · float · min: 0

Bottom margin

Example: 25

Default: 25

left

number · float · min: 0

Left margin

Example: 25

Default: 25

PdfFormFieldPosition

Position of a form field in the PDF

page

integer · min: 1 · required

Page number (starts at 1)

Example: 1

x

number · float · min: 0 · required

X position in millimeters

Example: 50.5

y

number · float · min: 0 · required

Y position in millimeters

Example: 100

width

number | null · float · min: 0

Field width in millimeters

Example: 80

height

number | null · float · min: 0

Field height in millimeters

Example: 20

PdfFormField

Custom PDF form field

field_name

string · maxLength: 100 · required

Form field name

Example: tenant_signature

field_type

string · enum · required

Form field type

Enum values:

text

signature

checkbox

radio

dropdown

date

number

Example: signature

object · required

Position of a form field in the PDF

label

string | null · maxLength: 255

Field label

Example: Tenant signature

placeholder

string | null · maxLength: 255

Help text

Example: Sign here

required

boolean

Required field

Example: true

Default: false

object | null

Validation rules

Example: {"min_length":3,"max_length":50,"pattern":"^[A-Za-z\\s]+$"}

default_value

string | null

Default value

Example:

options

array | null

Options for dropdown/radio field types

Example: ["Option 1","Option 2","Option 3"]

PdfFormatOptions

PDF formatting options

paper_size

string | null

Paper size (A4, Letter, Legal, etc.)

Example: A4

Default: A4

object

PDF document margins in millimeters

font_size

number | null · double · min: 6 · max: 72

Font size in points

Example: 12

Default: 12

add_metadata

boolean | null

Add metadata to the PDF

Example: true

Default: true

object | null

Custom variables for the template

pdf_standard

string | null

PDF standard to comply with (PDF/A-1b, PDF/A-2b, etc.)

Example: PDF/A-1b

page_ranges

array | null

Page ranges to include (e.g., ['1-5', '10'])

Example: ["1-5","10"]

compress

boolean | null

Compress the PDF

Example: false

Default: false

add_form_fields

boolean | null

Add interactive form fields

Example: false

Default: false

array | null

Custom form fields

GeneratePdfRequest

Request to generate a lease PDF

template_id

string · uuid · required

Document template ID to use

Example: 550e8400-e29b-41d4-a716-446655440000

template_type

string · enum · required

Template type (LeaseContract, Amendment, InventoryReport, etc.)

Enum values:

LeaseContract

Amendment

InventoryReport

RentReceipt

NoticeToVacate

OtherDocument

Example: LeaseContract

object · required

Data to insert into the template (JSON format)

Example: {"tenant_name":"Jean Dupont","property_address":"123 Rue de la Paix, 75001 Paris","rent_amount":850}

object

PDF formatting options

GeneratedPdf

Generated PDF metadata

id

string · uuid · required

Unique identifier of the generated PDF

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

template_id

string · uuid · required

Template ID used

Example: 550e8400-e29b-41d4-a716-446655440002

template_type

string · enum · required

Template type used

Enum values:

LeaseContract

Amendment

InventoryReport

RentReceipt

NoticeToVacate

OtherDocument

Example: LeaseContract

file_path

string · required

Path or URL of the generated PDF file

Example: https://storage.example.com/pdfs/lease_contract_123.pdf

file_size

integer · int64 · min: 0 · required

File size in bytes

Example: 524288

creation_timestamp

string · date-time · required

PDF creation date and time

Example: 2024-01-15T10:30:00Z

object | null

Custom variables used during generation

DocumentSignatureStatus

string · enum

Enum values:

READY

SIGNING

COMPLETED

FAILED

ARCHIVED

Status of the document signature process

Example: READY

InitiateSignatureResponse

Response after initiating a signature

document_signature_id

string · uuid · required

Unique ID of the signature process

Example: 550e8400-e29b-41d4-a716-446655440000

event_id

string · required

Unique event ID for traceability

Example: signature_550e8400-e29b-41d4-a716-446655440001_1704985200

pdf_url

string · uri · required

Absolute URL of the PDF document to sign

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440002

media_id

string · uuid · required

Reference to the media table (PDF document)

Example: 550e8400-e29b-41d4-a716-446655440002

object[] · minItems: 1 · required

List of created signature requests

status

string · enum · required

Status of the signature process

Enum values:

READY

SIGNING

COMPLETED

FAILED

ARCHIVED

Example: SIGNING

SignatureStatusResponse

Status of a signature process (returned by get_signature_status with DO Global)

lease_id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

document_signature_id

string · uuid · required

Signature process ID

Example: 550e8400-e29b-41d4-a716-446655440000

object · required

Signature state from DO Global (dynamic structure)

Example: {"status":"SIGNING","signers":[{"signer_type":"PROPRIETAIRE","status":"COMPLETED"},{"signer_type":"LOCATAIRE","status":"PENDING"}]}

DocumentSignatureStatusResponse

Detailed status of a signature document (returned by get_document_signature_status)

document_signature_id

string · uuid · required

Signature process ID

Example: 550e8400-e29b-41d4-a716-446655440000

event_id

string · required

Unique ID for traceability

Example: signature_550e8400-e29b-41d4-a716-446655440001_1704985200

pdf_url

string · uri · required

PDF document URL

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440002

media_id

string · uuid · required

Reference to the media table

Example: 550e8400-e29b-41d4-a716-446655440002

object[] · required

List of signature requests

status

string · enum · required

Status of the document signature process

Enum values:

READY

SIGNING

COMPLETED

FAILED

ARCHIVED

Example: READY

PendingSignerDto

Information about a signer in a pending contract. Includes contact details, signature status, and personal information.

signer_type

string · enum · required

Signer type (owner or tenant)

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

signer_email

string · email · required

Signer email address

Example: [email protected]

signer_phone

string · pattern: ^\+[1-9]\d{1,14}$ · required

Phone number for OTP delivery

Example: +33612345678

status

string · enum · required

Current signature status for this signer

Enum values:

PENDING

OTP_SENT

SIGNED

FAILED

EXPIRED

Example: PENDING

expires_at

string · date-time · required

Signature request expiration date

Example: 2024-01-20T10:00:00Z

person_id

string | null · uuid

Database person ID (owner_id or lessee_id)

Example: 550e8400-e29b-41d4-a716-446655440000

first_name

string | null · maxLength: 100

Signer first name

Example: Jean

last_name

string | null · maxLength: 100

Signer last name

Example: Dupont

legal_name

string | null · maxLength: 255

Legal name (for legal entities)

Example: SARL Dupont Immobilier

title

string | null · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

resend_count

integer · min: 0

Number of times the request has been resent for this signer

Example: 0

PendingSignatureContract

Represents a lease contract pending electronic signature. This schema is returned by the `/leases/signatures/pending` endpoint and contains all the information needed to display and manage a signature process: - Document and associated lease identification - Overall signature process status - List of all signers with their individual statuses - URLs to access the PDF document (original and signed)

document_signature_id

string · uuid · required

Unique identifier of the signature process

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Associated lease identifier

Example: 550e8400-e29b-41d4-a716-446655440001

status

string · enum · required

Overall status of the signature process:

READY: Ready to start, no signatures received
SIGNING: At least one signer has started or signed
COMPLETED: All signers have signed
FAILED: Process failed
ARCHIVED: Contract archived

Enum values:

READY

SIGNING

COMPLETED

FAILED

ARCHIVED

Example: READY

initiator_type

string · enum · required

Type of the user who initiated the signature (usually PROPRIETAIRE)

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

created_at

string · date-time · required

Date and time the signature process was created

Example: 2024-01-15T10:00:00Z

object[] · minItems: 1 · required

List of all contract signers with their individual statuses

Example: [{"signer_type":"PROPRIETAIRE","signer_email":"[email protected]","signer_phone":"+33612345678","status":"PENDING","expires_at":"2024-01-22T10:00:00Z","first_name":"Jean","last_name":"Dupont"},{"signer_type":"LOCATAIRE","signer_email":"[email protected]","signer_phone":"+33612345679","status":"COMPLETED","expires_at":"2024-01-22T10:00:00Z","first_name":"Marie","last_name":"Martin"}]

expires_at

string | null · date-time

Overall process expiration date (usually 7 days after creation)

Example: 2024-01-22T10:00:00Z

document_url

string | null · uri

URL of the original PDF document to sign (accessible via media API)

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440002

signed_pdf_url

string | null · uri

URL of the signed PDF document (available once all signatures are collected)

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440003

PendingSignaturesResponse

Paginated response containing the list of contracts pending signature for the tenant. Used by the `GET /leases/signatures/pending` endpoint. ## Pagination Use the `limit` and `offset` fields in the request to navigate through results. The `total_count` field indicates the total number of contracts matching the criteria, allowing you to calculate the number of pages. ## Page calculation example ``` total_pages = ceil(total_count / limit) current_page = floor(offset / limit) + 1 ```

object[] · required

List of contracts pending signature (for the current page)

total_count

integer · int64 · min: 0 · required

Total number of pending contracts (all combined, before pagination)

Example: 25

limit

integer · min: 1 · max: 100 · required

Maximum number of results per page (value used for the request)

Example: 50

Default: 50

offset

integer · min: 0 · required

Number of skipped results (pagination offset used)

Example: 0

Default: 0

SignerDetailsDto

Full details of a signer

signer_type

string · enum · required

Signer type

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

signer_email

string · email · required

signer_phone

string · required

status

string · enum · required

Status of an individual signature

Enum values:

PENDING

OTP_SENT

SIGNED

FAILED

EXPIRED

Example: PENDING

expires_at

string · date-time · required

signed_at

string | null · date-time

Date and time of signature

Example: 2024-01-16T15:30:00Z

first_name

string | null

last_name

string | null

legal_name

string | null

title

string | null

SignatureContractDetails

Full details of a signature contract

document_signature_id

string · uuid · required

lease_id

string · uuid · required

media_id

string · uuid · required

Reference to the media table

Example: 550e8400-e29b-41d4-a716-446655440002

status

string · enum · required

Status of the document signature process

Enum values:

READY

SIGNING

COMPLETED

FAILED

ARCHIVED

Example: READY

initiator_type

string · enum · required

Signer type

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

initiator_id

string · uuid · required

Initiator ID

Example: 550e8400-e29b-41d4-a716-446655440003

event_id

string · required

Unique ID for traceability

Example: signature_550e8400-e29b-41d4-a716-446655440001_1704985200

created_at

string · date-time · required

object[] · minItems: 1 · required

expires_at

string | null · date-time

document_url

string | null · uri

signed_pdf_url

string | null · uri

archive_url

string | null · uri

URL of the archived PDF with electronic timestamping

Example: https://storage.example.com/leases/archived-doc.pdf

RequestSignatureDto

Request to initiate a user's signature. This object is sent to the `/leases/{lease_id}/signature/request` endpoint to: 1. Submit the signature image captured by the user 2. Trigger sending an OTP code via SMS The user is automatically identified via their JWT - no need to specify their identity in the request.

document_signature_id

string · uuid · required

Unique identifier of the signature process. Obtained during initiation via /signature/initiate.

Example: 550e8400-e29b-41d4-a716-446655440000

object · required

Handwritten signature data

BaseEvent

Base event for Scaleway Topics

event_id

string · required

Unique event ID

Example: evt_550e8400-e29b-41d4-a716-446655440000

event_type

string · enum · required

Event type

Enum values:

SignatureRequested

OtpSent

OtpValidated

SignatureCompleted

DocumentFinalized

NotificationSent

ErrorOccurred

Example: SignatureRequested

timestamp

string · date-time · required

Date and time of the event

Example: 2024-01-15T10:00:00Z

tenant_id

string · required

Tenant ID

Example: tenant_123

correlation_id

string | null

Correlation ID for tracking

Example: corr_550e8400-e29b-41d4-a716-446655440000

object

Additional metadata

SignerInfo

Signer information

signer_type

string · enum · required

Signer type

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

phone

string · pattern: ^\+[1-9]\d{1,14}$ · required

Mobile phone number for OTP

Example: +33612345678

email

string · email · required

Signer email

Example: [email protected]

person_id

string | null · uuid

Database person ID

Example: 550e8400-e29b-41d4-a716-446655440000

first_name

string | null · maxLength: 100

First name

Example: Jean

last_name

string | null · maxLength: 100

Last name

Example: Dupont

legal_name

string | null · maxLength: 255

Legal name (for companies)

Example: SARL Dupont Immobilier

title

string | null · maxLength: 10

Title (Mr., Mrs., etc.)

Example: M.

SignatureRequestedEvent

Signature request event (format aligned with the notifier function)

object · required

Base event for Scaleway Topics

document_signature_id

string · uuid · required

Signature process ID

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

object · required

Signer information

document_url

string · uri · required

URL of the PDF document to sign

Example: https://storage.example.com/leases/unsigned-doc.pdf

signature_url

string · uri · required

URL to access the signature

Example: https://api.faireplace.com/api/signature/550e8400-e29b-41d4-a716-446655440000

expires_at

string · date-time · required

Signature request expiration date

Example: 2024-01-22T10:00:00Z

ValidateOtpDto

Request to validate the OTP code and finalize the signature. This object is sent to the `/leases/{lease_id}/signature/validate-otp` endpoint after the user has received their code via SMS. The OTP code expires after **5 minutes**. If expired, the user must request a new code via `/signature/request`.

document_signature_id

string · uuid · required

Unique identifier of the signature process. Must match the one used during the signature request.

Example: 550e8400-e29b-41d4-a716-446655440000

otp

string · minLength: 6 · maxLength: 6 · pattern: ^\d{6}$ · required

6-digit OTP code received via SMS.

Format: Exactly 6 digits (0-9) Validity: 5 minutes after sending Attempts: Maximum 3 attempts before temporary lockout

Example: 123456

CancelSignatureResponse

Response after cancelling a signature request. Cancellation marks the document as CANCELLED in the DO Global and sets the lease back to DRAFT status, while preserving the history of signature attempts.

success

boolean · required

Indicates whether the cancellation succeeded

Example: true

message

string · required

Confirmation message

Example: Signature cancelled for lease 550e8400-e29b-41d4-a716-446655440001

document_signature_id

string · uuid · required

Cancelled signature document ID

Example: 550e8400-e29b-41d4-a716-446655440000

ResetSignatureResponse

Response after a complete signature reset. The complete reset deletes all signature data (documents and requests) and sets the lease back to DRAFT status, allowing a new signature initiation.

success

boolean · required

Indicates whether the reset succeeded

Example: true

message

string · required

Confirmation message

Example: Signature fully reset for lease 550e8400-e29b-41d4-a716-446655440001

ResendSignatureResponse

Response after resending a signature request for a specific signer. Resending resets the signer's status to PENDING and resends the notifications (SMS/Email) to allow a new signature attempt.

success

boolean · required

Indicates whether the resend succeeded

Example: true

message

string · required

Confirmation message

Example: Signature request resent for signer proprietaire

signer_type

string · enum · required

Type of the signer for whom the request was resent

Enum values:

PROPRIETAIRE

LOCATAIRE

AGENT_IMMOBILIER

Example: PROPRIETAIRE

resend_count

integer · min: 0 · required

Total number of resends performed for this signer (including this request)

Example: 1

remaining_resends

integer · min: 0 · required

Number of remaining allowed resends (maximum 5 total)

Example: 4

LeaseAnnexType

string · enum

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Type d'annexe au bail. Chaque type correspond a un document reglementaire ou complementaire qui doit etre joint au contrat de location conformement a la legislation francaise.

Documents reglementaires obligatoires :

NOTICE_INFORMATION - Notice d'information (Loi ALUR art. 3-3)
CHARGES_RECUPERABLES - Liste des charges recuperables (Decret 87-713)
REPARATIONS_LOCATIVES - Reparations a la charge du locataire (Decret 87-712)
GRILLE_VETUSTE - Grille de vetuste indicative (Decret 2016-382)
INVENTAIRE_MOBILIER - Inventaire du mobilier (baux meubles, Decret 2015-981)
ETAT_DES_LIEUX - Etat des lieux d'entree/sortie (Decret 2016-382)

Diagnostics techniques :

DPE - Diagnostic de Performance Energetique
DIAGNOSTIC_PLOMB - Constat de Risque d'Exposition au Plomb (CREP)
DIAGNOSTIC_AMIANTE - Etat d'amiante (parties privatives)
DIAGNOSTIC_ELECTRICITE - Etat de l'installation interieure d'electricite
DIAGNOSTIC_GAZ - Etat de l'installation interieure de gaz
ETAT_RISQUES - Etat des Risques et Pollutions (ERP)

Documents complementaires :

REGLEMENT_COPROPRIETE - Extraits du reglement de copropriete
ASSURANCE_HABITATION - Attestation d'assurance habitation
CAUTIONNEMENT - Acte de cautionnement
CUSTOM - Document personnalise

Example: NOTICE_INFORMATION

AnnexSource

string · enum

Enum values:

STATIC_FILE

GENERATED

USER_UPLOAD

Methode de resolution du contenu de l'annexe.

STATIC_FILE - Fichier PDF statique embarque dans l'application (ex: textes reglementaires officiels).
GENERATED - Document PDF genere dynamiquement a partir des donnees du bail (ex: inventaire mobilier).
USER_UPLOAD - Document uploade manuellement par l'utilisateur via le systeme de medias.

Example: STATIC_FILE

SystemLeaseAnnex

Annexe systeme du catalogue global. Ces annexes sont predefinies par la plateforme et servent de modeles pour les annexes attachees aux baux individuels. Elles ne sont pas liees a un tenant specifique et sont partagees par tous les utilisateurs.

id

string · uuid · required

Unique identifier of the system annex

Example: a0000001-89ab-cdef-0123-456789abcdef

annex_type

string · enum · required

Type d'annexe au bail. Chaque type correspond a un document reglementaire ou complementaire qui doit etre joint au contrat de location conformement a la legislation francaise.

Documents reglementaires obligatoires :

NOTICE_INFORMATION - Notice d'information (Loi ALUR art. 3-3)
CHARGES_RECUPERABLES - Liste des charges recuperables (Decret 87-713)
REPARATIONS_LOCATIVES - Reparations a la charge du locataire (Decret 87-712)
GRILLE_VETUSTE - Grille de vetuste indicative (Decret 2016-382)
INVENTAIRE_MOBILIER - Inventaire du mobilier (baux meubles, Decret 2015-981)
ETAT_DES_LIEUX - Etat des lieux d'entree/sortie (Decret 2016-382)

Diagnostics techniques :

DPE - Diagnostic de Performance Energetique
DIAGNOSTIC_PLOMB - Constat de Risque d'Exposition au Plomb (CREP)
DIAGNOSTIC_AMIANTE - Etat d'amiante (parties privatives)
DIAGNOSTIC_ELECTRICITE - Etat de l'installation interieure d'electricite
DIAGNOSTIC_GAZ - Etat de l'installation interieure de gaz
ETAT_RISQUES - Etat des Risques et Pollutions (ERP)

Documents complementaires :

REGLEMENT_COPROPRIETE - Extraits du reglement de copropriete
ASSURANCE_HABITATION - Attestation d'assurance habitation
CAUTIONNEMENT - Acte de cautionnement
CUSTOM - Document personnalise

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

source

string · enum · required

Methode de resolution du contenu de l'annexe.

STATIC_FILE - Fichier PDF statique embarque dans l'application (ex: textes reglementaires officiels).
GENERATED - Document PDF genere dynamiquement a partir des donnees du bail (ex: inventaire mobilier).
USER_UPLOAD - Document uploade manuellement par l'utilisateur via le systeme de medias.

Enum values:

STATIC_FILE

GENERATED

USER_UPLOAD

Example: STATIC_FILE

name

string · required

Nom complet de l'annexe tel qu'il apparaitra dans le bail.

Example: Notice d'information relative aux droits et obligations des locataires et des bailleurs

version

string · required

Version du document (permet le suivi des mises a jour reglementaires).

Example: 2023.03

file_name

string · required

Nom du fichier a utiliser lors du telechargement.

Example: notice_information_mars_2023.pdf

mime_type

string · required

Type MIME du document.

Example: application/pdf

is_active

boolean · required

Indique si l'annexe est active et disponible pour etre attachee aux baux.

Example: true

is_mandatory

boolean · required

Indique si l'annexe est obligatoire pour les types de bail concernes. Les annexes obligatoires sont automatiquement attachees lors de l'appel a attach-mandatory.

Example: true

created_at

string · date-time · required

Date de creation de l'annexe systeme.

description

string | null

Description detaillee du contenu et de l'objet de l'annexe.

Example: Notice d'information conforme a l'arrete du 29 mai 2015, mise a jour mars 2023

legal_reference

string | null

Reference legale associee (loi, decret, arrete).

Example: Loi n89-462 art. 3-3, Arrete du 29 mai 2015

file_path

string | null

Chemin relatif du fichier statique dans le repertoire d'assets. Renseigne uniquement pour les annexes de source STATIC_FILE.

Example: lease-annexes/notice_information_mars_2023.pdf

template_name

string | null

Identifiant interne du template utilise pour la generation dynamique du PDF. Renseigne uniquement pour les annexes de source GENERATED.

Example: inventaire_mobilier

applicable_lease_type_ids

array | null

Liste des identifiants de types de bail pour lesquels cette annexe est applicable. Si null, l'annexe est applicable a tous les types de bail.

Example: ["e0000002-89ab-cdef-0123-456789abcdef","e0000003-89ab-cdef-0123-456789abcdef"]

LeaseAnnex

Annexe attachee a un bail specifique. Chaque annexe est isolee par tenant et liee a un bail unique. Une annexe peut etre : - Derivee d'une annexe systeme (via `system_annex_id`) pour les documents reglementaires - Creee manuellement avec un media uploade (via `media_id`) pour les documents personnalises - Generee dynamiquement (ex: inventaire mobilier) avec un PDF stocke sur le serveur

id

string · uuid · required

Unique identifier of the annex

tenant_id

string · required

Identifiant du tenant proprietaire de cette ressource.

lease_id

string · uuid · required

Identifiant du bail auquel cette annexe est rattachee.

annex_type

string · enum · required

Type d'annexe au bail. Chaque type correspond a un document reglementaire ou complementaire qui doit etre joint au contrat de location conformement a la legislation francaise.

Documents reglementaires obligatoires :

NOTICE_INFORMATION - Notice d'information (Loi ALUR art. 3-3)
CHARGES_RECUPERABLES - Liste des charges recuperables (Decret 87-713)
REPARATIONS_LOCATIVES - Reparations a la charge du locataire (Decret 87-712)
GRILLE_VETUSTE - Grille de vetuste indicative (Decret 2016-382)
INVENTAIRE_MOBILIER - Inventaire du mobilier (baux meubles, Decret 2015-981)
ETAT_DES_LIEUX - Etat des lieux d'entree/sortie (Decret 2016-382)

Diagnostics techniques :

DPE - Diagnostic de Performance Energetique
DIAGNOSTIC_PLOMB - Constat de Risque d'Exposition au Plomb (CREP)
DIAGNOSTIC_AMIANTE - Etat d'amiante (parties privatives)
DIAGNOSTIC_ELECTRICITE - Etat de l'installation interieure d'electricite
DIAGNOSTIC_GAZ - Etat de l'installation interieure de gaz
ETAT_RISQUES - Etat des Risques et Pollutions (ERP)

Documents complementaires :

REGLEMENT_COPROPRIETE - Extraits du reglement de copropriete
ASSURANCE_HABITATION - Attestation d'assurance habitation
CAUTIONNEMENT - Acte de cautionnement
CUSTOM - Document personnalise

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

Nom de l'annexe tel qu'il apparait dans le dossier du bail.

Example: Notice d'information relative aux droits et obligations

position

integer · required

Position d'affichage de l'annexe dans la liste (0 = premiere position).

Example: 0

is_included

boolean · required

Indique si l'annexe est incluse dans le dossier du bail. Permet d'exclure temporairement une annexe sans la supprimer.

Example: true

created_at

string · date-time · required

Date de creation.

updated_at

string · date-time · required

Date de derniere mise a jour.

system_annex_id

string | null · uuid

Reference vers l'annexe systeme dont cette annexe est derivee. null pour les annexes creees manuellement.

description

string | null

Description complementaire de l'annexe.

media_id

string | null · uuid

Identifiant du media associe (document uploade par l'utilisateur). Utilise pour les annexes de source USER_UPLOAD.

generated_pdf_path

string | null

Chemin du fichier PDF genere dynamiquement sur le serveur. Renseigne apres la premiere generation d'une annexe GENERATED (ex: inventaire mobilier). Sert de cache pour eviter les regenerations inutiles.

CreateLeaseAnnexDto

Donnees necessaires pour attacher une nouvelle annexe a un bail. **Deux cas d'usage :** 1. **Annexe systeme** : Renseigner `system_annex_id` pour lier a une annexe du catalogue global. Le type et le nom seront herites de l'annexe systeme. 2. **Annexe personnalisee** : Renseigner `media_id` pour associer un document uploade.

annex_type

string · enum · required

Type d'annexe au bail. Chaque type correspond a un document reglementaire ou complementaire qui doit etre joint au contrat de location conformement a la legislation francaise.

Documents reglementaires obligatoires :

NOTICE_INFORMATION - Notice d'information (Loi ALUR art. 3-3)
CHARGES_RECUPERABLES - Liste des charges recuperables (Decret 87-713)
REPARATIONS_LOCATIVES - Reparations a la charge du locataire (Decret 87-712)
GRILLE_VETUSTE - Grille de vetuste indicative (Decret 2016-382)
INVENTAIRE_MOBILIER - Inventaire du mobilier (baux meubles, Decret 2015-981)
ETAT_DES_LIEUX - Etat des lieux d'entree/sortie (Decret 2016-382)

Diagnostics techniques :

DPE - Diagnostic de Performance Energetique
DIAGNOSTIC_PLOMB - Constat de Risque d'Exposition au Plomb (CREP)
DIAGNOSTIC_AMIANTE - Etat d'amiante (parties privatives)
DIAGNOSTIC_ELECTRICITE - Etat de l'installation interieure d'electricite
DIAGNOSTIC_GAZ - Etat de l'installation interieure de gaz
ETAT_RISQUES - Etat des Risques et Pollutions (ERP)

Documents complementaires :

REGLEMENT_COPROPRIETE - Extraits du reglement de copropriete
ASSURANCE_HABITATION - Attestation d'assurance habitation
CAUTIONNEMENT - Acte de cautionnement
CUSTOM - Document personnalise

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

Nom de l'annexe.

Example: Notice d'information

system_annex_id

string | null · uuid

Identifiant de l'annexe systeme a lier. Fournir cet identifiant pour attacher une annexe reglementaire du catalogue.

description

string | null

Description complementaire.

media_id

string | null · uuid

Identifiant du media uploade a associer a cette annexe.

position

integer | null

Position souhaitee dans la liste des annexes. Par defaut, ajoutee en derniere position.

Example: 0

ReorderAnnexesDto

Liste ordonnee des identifiants d'annexes pour reorganiser leur ordre d'affichage. Tous les identifiants d'annexes du bail doivent etre presents dans la liste.

annex_ids

string[] · required

Liste ordonnee des identifiants d'annexes. La position de chaque annexe sera mise a jour selon son index dans cette liste.

Example: ["11111111-1111-1111-1111-111111111111","22222222-2222-2222-2222-222222222222","33333333-3333-3333-3333-333333333333"]

AttachMandatoryResult

Resultat de l'operation d'attachement automatique des annexes obligatoires. Fournit un bilan detaille des annexes traitees.

object[] · required

Liste des annexes qui ont ete nouvellement attachees au bail.

already_attached

string[] · required

Identifiants des annexes systeme qui etaient deja attachees (pas de doublons crees).

not_applicable

string[] · required

Descriptions des annexes obligatoires qui n'ont pas pu etre attachees (ex: type de bail non compatible, source non resolue).

Example: ["Inventaire mobilier : applicable uniquement aux baux meubles"]

AnnexComplianceItem

Detail de conformite pour un type d'annexe specifique.

annex_type

string · enum · required

Type d'annexe au bail. Chaque type correspond a un document reglementaire ou complementaire qui doit etre joint au contrat de location conformement a la legislation francaise.

Documents reglementaires obligatoires :

NOTICE_INFORMATION - Notice d'information (Loi ALUR art. 3-3)
CHARGES_RECUPERABLES - Liste des charges recuperables (Decret 87-713)
REPARATIONS_LOCATIVES - Reparations a la charge du locataire (Decret 87-712)
GRILLE_VETUSTE - Grille de vetuste indicative (Decret 2016-382)
INVENTAIRE_MOBILIER - Inventaire du mobilier (baux meubles, Decret 2015-981)
ETAT_DES_LIEUX - Etat des lieux d'entree/sortie (Decret 2016-382)

Diagnostics techniques :

DPE - Diagnostic de Performance Energetique
DIAGNOSTIC_PLOMB - Constat de Risque d'Exposition au Plomb (CREP)
DIAGNOSTIC_AMIANTE - Etat d'amiante (parties privatives)
DIAGNOSTIC_ELECTRICITE - Etat de l'installation interieure d'electricite
DIAGNOSTIC_GAZ - Etat de l'installation interieure de gaz
ETAT_RISQUES - Etat des Risques et Pollutions (ERP)

Documents complementaires :

REGLEMENT_COPROPRIETE - Extraits du reglement de copropriete
ASSURANCE_HABITATION - Attestation d'assurance habitation
CAUTIONNEMENT - Acte de cautionnement
CUSTOM - Document personnalise

Enum values:

NOTICE_INFORMATION

CHARGES_RECUPERABLES

REPARATIONS_LOCATIVES

GRILLE_VETUSTE

INVENTAIRE_MOBILIER

ETAT_DES_LIEUX

DPE

DIAGNOSTIC_PLOMB

Example: NOTICE_INFORMATION

name

string · required

Nom de l'annexe attendue.

Example: Notice d'information

status

string · enum · required

Statut de presence de l'annexe :

present - L'annexe est attachee et incluse
excluded - L'annexe est attachee mais exclue du dossier
missing - L'annexe n'est pas attachee au bail

Enum values:

present

excluded

missing

Example: missing

annex_id

string | null · uuid

Identifiant de l'annexe si elle est attachee, null si manquante.

AnnexComplianceResult

Resultat de la verification de conformite des annexes d'un bail. Compare les annexes presentes avec les exigences reglementaires du type de bail.

lease_id

string · uuid · required

Identifiant du bail verifie.

is_compliant

boolean · required

true si toutes les annexes obligatoires sont presentes et incluses. false si au moins une annexe obligatoire est manquante.

Example: false

total_annexes

integer · required

Nombre total d'annexes attachees au bail.

Example: 3

included_annexes

integer · required

Nombre d'annexes incluses (non exclues) dans le dossier.

Example: 3

object[] · required

Liste des annexes obligatoires avec leur statut de presence.

object[] · required

Liste des annexes recommandees (non obligatoires) avec leur statut.

UpdateLeaseAnnexDto

Donnees de mise a jour partielle d'une annexe de bail. Seuls les champs fournis sont mis a jour.

name

string | null

Nouveau nom de l'annexe.

description

string | null

Nouvelle description.

media_id

string | null · uuid

Nouveau media a associer. Passer null pour dissocier le media actuel.

position

integer | null

Nouvelle position dans la liste.

is_included

boolean | null

Inclure ou exclure l'annexe du dossier de bail.

PaymentMethod

string · enum

Enum values:

stripe

credit

Payment method for a lease.

stripe: card payment via Stripe (PaymentIntent)
credit: debit from the user's credit balance

Example: stripe

CreatePaymentIntentRequest

Request to create a payment intent for a lease. The `lease_id` is provided in the route path, not in the body.

amount

integer · int64 · min: 1 · required

Amount in cents (e.g. 2990 = 29.90 EUR).

Example: 2990

currency

string · minLength: 1 · maxLength: 10 · required

Currency code (e.g. "eur", "EUR").

Example: eur

payment_method

string · enum · required

Payment method for a lease.

stripe: card payment via Stripe (PaymentIntent)
credit: debit from the user's credit balance

Enum values:

stripe

credit

Example: stripe

object | null

Optional metadata propagated to the payment port. The backend automatically adds lease_id and reason (e.g. "lease_payment").

PaymentStatus

string · enum

Enum values:

pending

succeeded

failed

canceled

Payment status.

Example: succeeded

CreatePaymentIntentResponse

Response after creating a payment intent. - For Stripe: contains `client_secret` for Stripe Elements. - For credits: may contain `balance_after` (balance after debit).

payment_intent_id

string · required

Stripe PaymentIntent ID (e.g. "pi_xxx") or credit transaction ID.

Example: pi_3ABC123xyz

status

string · enum · required

Payment status.

Enum values:

pending

succeeded

failed

canceled

Example: succeeded

amount

integer · int64 · required

Amount in cents.

Example: 2990

currency

string · required

payment_method

string · enum · required

Payment method for a lease.

stripe: card payment via Stripe (PaymentIntent)
credit: debit from the user's credit balance

Enum values:

stripe

credit

Example: stripe

client_secret

string | null

Client secret for Stripe Elements (web). Absent for credit payments.

Example: pi_3ABC123xyz_secret_xxx

balance_after

integer | null · int64

Credit balance after consumption (only if payment_method = credit).

Example: 4710

PurchaseCreditsRequest

Request to initiate a credit purchase. This request creates a Stripe Checkout Session and returns the payment URL. Payment is processed by Stripe, and credits are automatically credited via webhook when payment is confirmed.

package_id

string · uuid · required

Identifier of the credit package to purchase.

The package must be active and have a configured stripe_price_id.

Example: 550e8400-e29b-41d4-a716-446655440000

success_url

string · uri · required

Redirect URL after successful payment.

The user will be redirected to this URL after completing the payment on the Stripe Checkout page.

Recommendations:

Include a success parameter to identify the transaction
Example: https://app.fairplace.com/credits/success?session_id={CHECKOUT_SESSION_ID}

Example: https://app.fairplace.com/credits/success?session_id={CHECKOUT_SESSION_ID}

cancel_url

string · uri · required

Redirect URL if the user cancels the payment.

The user will be redirected to this URL if they close the Stripe Checkout page without completing the payment.

Example: https://app.fairplace.com/credits/cancel

PurchaseCreditsResponse

Response after creating a credit purchase session. Contains the Stripe Checkout page URL where the user must be redirected to complete the payment.

checkout_url

string · uri · required

Stripe Checkout page URL.

Required action: Redirect the user to this URL to complete the payment.

This URL is valid for a limited time (typically 24 hours). If the user does not complete the payment within this period, the session expires.

Example: https://checkout.stripe.com/c/pay/cs_test_a1b2c3d4e5f6...

package_id

string · uuid · required

Identifier of the selected package.

Example: 550e8400-e29b-41d4-a716-446655440000

package_name

string · required

Name of the selected package.

Example: Pack Starter

credits_amount

integer · int64 · required

Number of credits that will be credited after successful payment (in cents).

Example: 1000

price_cents

integer · int64 · required

Package price in euro cents.

Example: 2990

CreditBalance

Credit balance for a user. The balance is expressed in euro cents (1 credit = 1 cent). A user without an existing balance will return a zero balance rather than an error.

balance

integer · int64 · min: 0 · required

Credit balance in euro cents.

Examples:

5000 = 50.00 EUR in credits
2990 = 29.90 EUR in credits
0 = No credits available

Example: 5000

currency

string · enum · required

Balance currency (always "EUR" for now).

Enum values:

EUR

Example: EUR

last_updated

string | null · date-time

Date and time of the last balance update (ISO 8601).

Format: YYYY-MM-DDTHH:mm:ssZ

Example: 2026-01-28T10:30:00Z

CreditTransactionType

string · enum

Enum values:

purchase

consumption

expiration

refund

adjustment

Credit transaction type.

The different types allow tracking the origin and nature of each credit movement.

Example: purchase

CreditTransaction

Individual credit transaction. Each credit movement (purchase, consumption, etc.) generates a transaction to ensure full traceability.

id

string · uuid · required

Unique transaction identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

amount

integer · int64 · required

Transaction amount in cents.

Convention:

Positive amount for purchases and additions
Negative amount for consumptions

Example: 1000

transaction_type

string · enum · required

Credit transaction type.

The different types allow tracking the origin and nature of each credit movement.

Enum values:

purchase

consumption

expiration

refund

adjustment

Example: purchase

balance_before

integer · int64 · required

Balance before the transaction (in cents).

Example: 2000

balance_after

integer · int64 · required

Balance after the transaction (in cents).

Example: 3000

created_at

string · date-time · required

Date and time of the transaction creation (ISO 8601).

Example: 2026-01-28T10:30:00Z

reason

string | null

Reason or description of the transaction.

Examples:

"Credit purchase via Stripe Checkout Session cs_test_123 (event: evt_test_456)"
"Consumption for lease signing lease_789"
"Manual adjustment by administrator"

Example: Credit purchase via Stripe Checkout Session cs_test_123

CreditTransactionsResponse

Response containing the list of credit transactions with pagination.

object[] · required

List of transactions, sorted by creation date descending (most recent first).

total

integer · int32 · required

Total number of transactions returned in this response.

Note: This is not the total number of user transactions, but only the count returned in this page.

Example: 10

limit

integer · int64 · required

Maximum number of requested transactions.

Default value: 50 Maximum: 100

Example: 50

offset

integer · int64 · required

Offset for pagination (number of transactions to skip).

Default value: 0

Example: 0

CreditPackage

Credit package available for purchase. Packages are configurable per tenant and can be enabled/disabled. Each package is linked to a Stripe Price for payment.

id

string · uuid · required

Unique package identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Package name (e.g., "Pack Starter", "Pack Pro", "Pack Business").

Example: Pack Starter

credits_amount

integer · int64 · min: 1 · required

Number of credits included in the package (in cents).

Examples:

1000 = 10.00 EUR in credits
5000 = 50.00 EUR in credits
20000 = 200.00 EUR in credits

Example: 1000

price_cents

integer · int64 · min: 1 · required

Package price in euro cents.

Examples:

2990 = 29.90 EUR
12990 = 129.90 EUR
49990 = 499.90 EUR

Example: 2990

active

boolean · required

Indicates whether the package is currently available for purchase.

Inactive packages are not returned by default in the list (unless active_only=false is specified).

Example: true

display_order

integer · min: 0 · required

Display order of the package in the list.

Packages are sorted by display_order ascending, then by creation date. Default value: 0

Example: 1

description

string | null

Detailed package description.

Example: Starter pack ideal for small landlords

CreditPackagesResponse

Response containing the list of available credit packages.

object[] · required

List of packages, sorted by display_order ascending, then by creation date.

LinkServiceToPlace

Data for adding a service to a place. **Validation rules:** - If `is_chargeable = true`, `default_distribution_key_id` is **required** - Validation is performed before persistence - If validation fails, an HTTP 400 error is returned with an explicit message

service_id

string | null · uuid

Service ID (optional, automatically generated if not provided)

name

string | null

Service name (e.g., Heating, Elevator)

is_chargeable

boolean | null

Indicates whether the service can be billed as charges. If true, default_distribution_key_id becomes required.

space_type

string · enum

Type of space concerned by the service

Enum values:

INDOOR_COMMON

OUTDOOR_COMMON

PRIVATE

TECHNICAL

GARDEN

PARKING

TELECOM_SERVICES

Example: INDOOR_COMMON

description

string | null

Detailed service description

default_distribution_key_id

string | null · uuid

Default distribution key for billing. Required if is_chargeable = true. Automatically used when creating a charge if distribution_key_id is not provided.

category_id

string | null · uuid

Charge category ID if the service is billable

RentControl

is_active

boolean

reference_rent_per_m2

number

increased_rent_per_m2

number

calculation_method

string · enum

Enum values:

SurfaceWeighted

LocationBased

MarketIndexed

last_updated

string | null · date-time

applicable_from

string | null · date-time

LegislativeZone

id

string | null · uuid

name

string | null

country_code

string | null

zone_type

string | null · enum

Enum values:

TenseZone

RegulatedZone

ControlledZone

description

string | null

postal_codes

array | null

object

created_at

string | null · date-time

updated_at

string | null · date-time

EquipmentJunction

equipment_id

string | null · uuid

entity_id

string | null · uuid

entity_type

string | null · enum

Enum values:

place

estate

room

created_at

string | null · date-time

updated_at

string | null · date-time

description

string | null

quantity

integer | null

ServicePlace

Service available in a specific place. **When used in a rental charge:** - The service must be attached to the same place as the lease's estate - The service must be chargeable (`is_chargeable = true`) - The service must have a `default_distribution_key_id` if used to create a charge without an explicit `distribution_key_id` - The service category (if present) must be allowed for the lease type

id

string | null · uuid

place_id

string | null · uuid

ID of the place to which the service is attached

name

string | null

Service name (e.g., Heating, Elevator)

description

string | null

Detailed description of the service

is_chargeable

boolean | null

Indicates whether the service can be billed as a charge. If true, default_distribution_key_id is required.

category_id

string | null · uuid

ID of the charge category if the service is chargeable. The category must be allowed for the lease type when creating a charge.

space_type

string · enum

Type of space concerned by the service

Enum values:

INDOOR_COMMON

OUTDOOR_COMMON

PRIVATE

TECHNICAL

GARDEN

PARKING

TELECOM_SERVICES

Example: INDOOR_COMMON

default_distribution_key_id

string | null · uuid

Default distribution key for billing. Required if is_chargeable = true. Automatically used when creating a charge if distribution_key_id is not provided.

created_at

string | null · date-time

updated_at

string | null · date-time

CreateServicePlace

Data for creating a place service. **Validation rules:** - If `is_chargeable = true`, `default_distribution_key_id` is required

name

string · required

Service name (e.g., Heating, Elevator)

description

string | null

Detailed description of the service

is_chargeable

boolean | null

Indicates whether the service can be billed as a charge. If true, default_distribution_key_id becomes required.

category_id

string | null · uuid

ID of the charge category if the service is chargeable

space_type

string · enum

Type of space concerned by the service

Enum values:

INDOOR_COMMON

OUTDOOR_COMMON

PRIVATE

TECHNICAL

GARDEN

PARKING

TELECOM_SERVICES

Example: INDOOR_COMMON

default_distribution_key_id

string | null · uuid

Default distribution key for billing. Required if is_chargeable = true. Automatically used when creating a charge if distribution_key_id is not provided.

UpdateServicePlace

Data for updating a place service. **Validation rules:** - If `is_chargeable` is changed to `true`, `default_distribution_key_id` must be present

name

string | null

Service name (e.g., Heating, Elevator)

description

string | null

Detailed description of the service

is_chargeable

boolean | null

Indicates whether the service can be billed as a charge. If changed to true, default_distribution_key_id becomes required.

category_id

string | null · uuid

ID of the charge category if the service is chargeable

space_type

string · enum

Type of space concerned by the service

Enum values:

INDOOR_COMMON

OUTDOOR_COMMON

PRIVATE

TECHNICAL

GARDEN

PARKING

TELECOM_SERVICES

Example: INDOOR_COMMON

default_distribution_key_id

string | null · uuid

Default distribution key for billing. Required if is_chargeable = true. Automatically used when creating a charge if distribution_key_id is not provided.

ChargeCalculationType

string · enum · deprecated

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Calculation type for charge distribution (deprecated, use TypeRepartitionCharge)

Example: SURFACE

ChargeDistributionMode

string · enum

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Charge distribution mode (alias of TypeRepartitionCharge)

Example: SURFACE

ChargeCalculationMethod

string · enum · deprecated

Enum values:

FORFAIT

PROVISION

DEPENSE_REELLE

RELEVE_DIRECT

Charge calculation method (deprecated, use ModeFacturationCharge)

Example: PROVISION

ChargeCalculationBasis

string · enum · deprecated

Enum values:

DEPENSE_REELLE

FORFAIT

PERSONNEL_75_POURCENT

PERSONNEL_40_POURCENT

PERSONNEL_100_POURCENT

Charge calculation basis (deprecated, use BaseCalculCharge)

Example: FORFAIT

StaffChargeRule

string · enum

Enum values:

Standard

ConciergeDual

ConciergeSingle

Staff charge calculation rule

ChargeReadingType

string · enum

Enum values:

MeterReading

Consumption

OccupantCount

EquipmentCount

Charge reading type

ChargeReadingSubtype

string · enum

Enum values:

CommonAreas

Individual

Maintenance

LeakFix

Charge reading subtype

CreateRoomInventory

Data for creating a new room-inventory junction

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer | null

Quantity of the item in this room

Example: 1

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition of the item in this room

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

placed_date

string | null · date

Date placed in the room

Example: 2024-01-15

removed_date

string | null · date

Date removed from the room

is_active

boolean | null

Indicates whether the item is currently in this room

Example: true

notes

string | null

Notes specific to this room

Example: Near the window

InventorySearchQuery

Search parameters for inventory

q

string | null

General search term

Example: refrigerator

inventory_type_id

string | null · uuid

Filter by inventory type

condition_status

string · enum

Filter by condition

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

tags

array | null

Filter by tags

Example: ["kitchen","appliance"]

page

integer | null · min: 1

Page number

Example: 1

limit

integer | null · min: 1 · max: 100

Number of items per page

Example: 20

EstateKeyFilterDto

Filters for key search

key_type

string · enum

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean | null

Filter by returned/not returned keys

brand

string | null

Filter by brand

page

integer | null · min: 1

Page number

Default: 1

limit

integer | null · min: 1 · max: 100

Number of items per page

Default: 50

MarkEstateKeyStolenDto

Data for marking a key as stolen

changed_by

string · maxLength: 255 · required

Person who marks the key as stolen

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the theft

Example: Key stolen during the burglary - Police notified

MarkEstateKeyReplacedDto

Data for marking a key as replaced

changed_by

string · maxLength: 255 · required

Person who marks the key as replaced

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the replacement

Example: Key replaced by a new one following the loss

ChangeEstateKeyStatusDto

Data for changing the status of a key

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

changed_by

string · maxLength: 255 · required

Person who performs the status change

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the status change

Example: Key marked as stolen following a burglary

LesseeSearchQuery

Search parameters for lessees

q

string

General search term

Example: Jean Dupont

category

string · enum

Filter by category

Enum values:

individual

company/other

guarantor

Example: individual

email

string · email

Filter by email

phone

string

Filter by phone number

city

string

Filter by city

has_income

boolean

Filter by income presence

min_income

number · decimal · min: 0

Minimum income

max_income

number · decimal · min: 0

Maximum income

page

integer · min: 1

Page number

Example: 1

limit

integer · min: 1 · max: 100

Number of items per page

Example: 20

LeaseLesseeWithDetails

Lessee-lease association with lessee details

object · required

Association of a lessee with a lease

object · required

Complete lessee

LeaseLesseeListResponse

Paginated list of lessee-lease associations

object[] · required

total_count

integer · int64 · required

limit

integer · required

offset

integer · required

ActiveLesseesResponse

Active lessees list

object[] · required

LeaseLesseeSearchQuery

Search criteria for lessee-lease associations

lease_id

string | null · uuid

Filter by lease

lessee_id

string | null · uuid

Filter by lessee

role_type

string · enum

Filter by role

Enum values:

PRIMARY

CO_TENANT

GUARANTOR

Example: PRIMARY

active_only

boolean

Return only active associations

Default: false

limit

integer · min: 1 · max: 100

Default: 20

offset

integer · min: 0

Default: 0

LeaseGuaranteeType

string · enum

Enum values:

PERSONAL_GUARANTEE

BANK_GUARANTEE

INSURANCE_GLI

PROFESSIONAL_INSURANCE

HOME_INSURANCE

Guarantee type

Example: PERSONAL_GUARANTEE

LeaseWearTearType

string · enum

Enum values:

LEGAL

NEGOTIABLE

NONE

Normal wear and tear type

Example: LEGAL

LeaseMaintenanceType

string · enum

Enum values:

CLEANING

REPAIRS

PAINTING

PLUMBING

ELECTRICAL

HVAC

APPLIANCES

STRUCTURAL

Maintenance type

Example: CLEANING

LeasePartyType

string · enum

Enum values:

LANDLORD

TENANT

Lease party type

Example: TENANT

LeaseTypeName

string · enum

Enum values:

COMMERCIAL

RESIDENTIAL_EMPTY

RESIDENTIAL_FURNISHED

MOBILITY

STUDENT

SEASONAL

Lease type name

Example: RESIDENTIAL_FURNISHED

LeaseRenewalType

string · enum

Enum values:

AUTOMATIC

MANUAL

NONE

Renewal type

Example: AUTOMATIC

LeaseConditionType

string · enum

Enum values:

SUSPENSIVE

RESOLUTORY

MIXED

Condition type

Example: SUSPENSIVE

LeaseConditionStatus

string · enum

Enum values:

PENDING

FULFILLED

NOT_FULFILLED

WAIVED

Condition status

Example: PENDING

LeaseOptionType

string · enum

Enum values:

PURCHASE

RENEWAL

TERMINATION

MODIFICATION

Option type

Example: RENEWAL

LeaseOptionStatus

string · enum

Enum values:

AVAILABLE

EXERCISED

EXPIRED

WAIVED

Option status

Example: AVAILABLE

LeaseNotificationType

string · enum

Enum values:

RENT_INCREASE

TERMINATION

RENEWAL

MAINTENANCE

INSPECTION

OTHER

Notification type

Example: RENT_INCREASE

LeaseNotificationStatus

string · enum

Enum values:

SENT

DELIVERED

READ

ACKNOWLEDGED

FAILED

Notification status

Example: SENT

LeaseWithDetails

Lease with all associated details

object · required

Complete lease

object[] · required

CreateLeaseDocument

Data for creating a new lease document

lease_id

string · uuid · required

Lease ID

document_type

string · minLength: 1 · maxLength: 100 · required

Document type

file_path

string · minLength: 1 · required

File path

description

string | null · maxLength: 500

Document description

RegularizationData

Charge regularization data

actual_amount

number · decimal · min: 0 · required

Actual amount after regularization

regularization_date

string · date · required

Regularization date

notes

string | null · maxLength: 1000

Notes about the regularization

NoticePeriodPartyType

string · enum

Enum values:

LANDLORD

TENANT

Type of party giving notice

Example: TENANT

NoticePeriodSituationType

string · enum

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Type of situation justifying the notice period duration

Example: STANDARD

NoticePeriodConfigurationSource

string · enum

Enum values:

SPECIFIC_SITUATION

STANDARD_CONFIGURATION

DEFAULT_CONFIGURATION

LEGAL_MINIMUM

Notice period configuration source

Example: STANDARD_CONFIGURATION

NoticePeriodConfiguration

Notice period configuration

id

string · uuid · required

Unique identifier of the configuration

Example: 550e8400-e29b-41d4-a716-446655440000

lease_type_id

string · uuid · required

Lease type ID

party_type

string · enum · required

Type of party giving notice

Enum values:

LANDLORD

TENANT

Example: TENANT

situation_type

string · enum · required

Type of situation justifying the notice period duration

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Example: STANDARD

notice_months

integer · min: 0 · required

Number of notice months

Example: 3

requires_justification

boolean · required

Justification required

Example: true

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Modification date

notice_days

integer | null · min: 0

Number of additional days

Example: 0

object | null

Required documents (JSON)

legal_reference

string | null · maxLength: 500

Legal reference

Example: Article 15 of law no. 89-462 of July 6, 1989

notes

string | null · maxLength: 1000

Notes

CreateNoticePeriodConfiguration

Data for creating a new notice period configuration

lease_type_id

string · uuid · required

Lease type ID

party_type

string · enum · required

Type of party giving notice

Enum values:

LANDLORD

TENANT

Example: TENANT

situation_type

string · enum · required

Type of situation justifying the notice period duration

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Example: STANDARD

notice_months

integer · min: 0 · required

Number of notice months

requires_justification

boolean · required

Justification required

notice_days

integer | null · min: 0

Number of additional days

object | null

Required documents (JSON)

legal_reference

string | null · maxLength: 500

Legal reference

notes

string | null · maxLength: 1000

Notes

UpdateNoticePeriodConfiguration

Data for updating a notice period configuration

notice_months

integer | null · min: 0

notice_days

integer | null · min: 0

requires_justification

boolean | null

object | null

legal_reference

string | null · maxLength: 500

notes

string | null · maxLength: 1000

CalculateNoticePeriodRequest

Request to calculate a notice period

party_type

string · enum · required

Type of party giving notice

Enum values:

LANDLORD

TENANT

Example: TENANT

situation_type

string · enum · required

Type of situation justifying the notice period duration

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Example: STANDARD

NoticePeriodCalculationResponse

Notice period calculation result

lease_id

string · uuid · required

Lease ID

party_type

string · enum · required

Type of party giving notice

Enum values:

LANDLORD

TENANT

Example: TENANT

situation_type

string · enum · required

Type of situation justifying the notice period duration

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Example: STANDARD

total_days

integer · required

Total number of notice days

Example: 90

requires_justification

boolean · required

Justification required

configuration_source

string · enum · required

Notice period configuration source

Enum values:

SPECIFIC_SITUATION

STANDARD_CONFIGURATION

DEFAULT_CONFIGURATION

LEGAL_MINIMUM

Example: STANDARD_CONFIGURATION

notice_months

integer | null

Number of notice months

Example: 3

notice_days

integer | null

Number of additional days

Example: 0

legal_reference

string | null

Legal reference

object | null

Required documents (JSON)

CheckNoticeDeadlineRequest

Request to check the notice deadline

party_type

string · enum · required

Type of party giving notice

Enum values:

LANDLORD

TENANT

Example: TENANT

situation_type

string · enum · required

Type of situation justifying the notice period duration

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Example: STANDARD

target_departure_date

string · date · required

Desired departure date

Example: 2024-12-31

NoticeDeadlineResponse

Notice deadline verification result

lease_id

string · uuid · required

Lease ID

party_type

string · enum · required

Type of party giving notice

Enum values:

LANDLORD

TENANT

Example: TENANT

situation_type

string · enum · required

Type of situation justifying the notice period duration

Enum values:

STANDARD

RETIREMENT

JOB_LOSS

FIRST_JOB

HEALTH_ISSUES

SOCIAL_HOUSING

PROFESSIONAL_TRANSFER

INCOME_DECREASE

Example: STANDARD

target_departure_date

string · date · required

Desired departure date

notice_deadline

string · date · required

Deadline to give notice

can_give_notice

boolean · required

Can give notice now

next_possible_departure

string · date · required

Next possible departure date

object · required

Notice period calculation result

days_remaining

integer | null

Days remaining before the deadline

SystemAnnexQuery

Parametres optionnels pour filtrer les annexes systeme.

lease_type_id

string | null · uuid

Filtrer les annexes applicables a un type de bail specifique. Retourne uniquement les annexes dont applicable_lease_type_ids contient cet identifiant.

DownloadAnnexQuery

Parametres optionnels pour le telechargement d'une annexe.

force

boolean | null

Forcer la regeneration du PDF pour les annexes dynamiques (ex: inventaire mobilier, etat des lieux). Par defaut false : le systeme utilise la version en cache si disponible. Passer true pour obtenir une version regeneree avec les donnees a jour.

Example: false

edl_type

string | null · enum

Type d'etat des lieux a generer. Applicable uniquement aux annexes de type ETAT_DES_LIEUX.

entree - Etat des lieux d'entree (par defaut)
sortie - Etat des lieux de sortie

Enum values:

entree

sortie

Example: entree

SignaturePosition

Position of the signature on the PDF document

page

integer · min: 1 · required

Page number (starts at 1)

Example: 1

x

number · float · required

X position (in points, origin at bottom left)

Example: 100

y

number · float · required

Y position (in points, origin at bottom left)

Example: 200

width

number · float · min: 0 · required

Width of the signature area

Example: 150

height

number · float · min: 0 · required

Height of the signature area

Example: 50

OtpValidationResponse

Response returned after successful OTP validation. Indicates whether the signature was applied and provides information about the overall signature process state.

success

boolean · required

Indicates whether the validation and signature succeeded

Example: true

message

string · required

Descriptive result message

Example: Signature completed successfully

document_signature_id

string · uuid · required

Signature process ID

Example: 550e8400-e29b-41d4-a716-446655440000

signer_status

string · enum

New signer status after validation

Enum values:

COMPLETED

FAILED

Example: COMPLETED

document_status

string · enum

Overall document status after this signature:

SIGNING: Waiting for other signatures
COMPLETED: All signers have signed

Enum values:

SIGNING

COMPLETED

Example: SIGNING

remaining_signers

integer · min: 0

Number of remaining signers (0 if all have signed)

Example: 1

signed_pdf_url

string | null · uri

URL of the final signed PDF.

Available only when all signers have validated their signature (document_status = COMPLETED).

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440003

CompleteSignatureRequestRequest

Request to complete an individual signature. This endpoint is called by the signature-orchestrator when an individual signer has finished their signature. It updates the status of the corresponding signature_request in the database.

signature_hash

string | null

Signature hash for traceability (optional)

Example: abc123def456...

CompleteSignatureRequestResponse

Response after completing an individual signature. This response confirms that the signature_request has been updated with COMPLETED status in the database.

success

boolean · required

Indicates whether the completion succeeded

Example: true

message

string · required

Confirmation message

Example: Signature request completed successfully

document_signature_id

string · uuid · required

Signature document ID

Example: 550e8400-e29b-41d4-a716-446655440000

signer_type

string · enum · required

Type of the signer who completed their signature

Enum values:

proprietaire

locataire

agent_immobilier

Example: proprietaire

signature_request_id

string · uuid · required

Updated signature_request ID

Example: 550e8400-e29b-41d4-a716-446655440001

FinalizeDocumentSignatureRequest

Request to finalize a signature document. This endpoint is called by the signature-orchestrator when all signers have finished their signatures. It verifies that all signatures are complete and activates the lease if so.

signed_pdf_url

string · uri · required

URL of the final signed PDF (containing all signatures)

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440003

archive_url

string | null · uri

URL of the archived PDF with timestamping (optional)

Example: https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440004

FinalizeDocumentSignatureResponse

Response after finalizing a signature document. This response confirms that the document has been finalized and that the lease has been activated if all signatures were complete.

success

boolean · required

Indicates whether the finalization succeeded

Example: true

message

string · required

Confirmation message

Example: Document signature finalized successfully

document_signature_id

string · uuid · required

Finalized signature document ID

Example: 550e8400-e29b-41d4-a716-446655440000

TemplateDataMetadata

Metadata about the template data generation

generated_at

string · date-time · required

Date and time of data generation

Example: 2024-01-15T10:30:00Z

generation_time_ms

integer · int64 · min: 0 · required

Generation time in milliseconds

Example: 45

has_custom_variables

boolean · required

Indicates whether custom variables have been included

Example: true

data_schema_version

string · pattern: ^[0-9]+\.[0-9]+$ · required

Version of the data schema used

Example: 1.0

data_source

string · enum · required

Data source (database, cache, mock, etc.)

Enum values:

database

cache

mock

external

Example: database

data_size_bytes

integer · int64 · min: 0 · required

Approximate size of the JSON data in bytes

Example: 15420

LeaseTemplateDataResponse

Response containing Typst template data exposed in JSON format. This response is generated by the `/leases/{lease_id}/template-data` endpoint and contains all the data needed to generate a Typst document for a given lease. The data includes: - Lease information (amount, dates, status, etc.) - Property details (address, area, etc.) - Owner information - List of lessees and their details - Charges associated with the lease - Custom variables (if provided via query parameters) - Generation metadata **Data structure:** - `lease_id`: Lease identifier - `template_data`: JSON object containing all structured data - `metadata`: Generation metadata (time, size, etc.)

lease_id

string · uuid · required

Unique identifier of the lease

Example: 550e8400-e29b-41d4-a716-446655440000

object · required

Complete template data in JSON format.

This structure contains all the information needed to generate a Typst document, organized hierarchically:

Typical structure:


Code
 
{
  "lease": {
    "id": "uuid",
    "rent_amount": 1200.00,
    "status": "ACTIVE",
    "start_date": "2024-01-01",
    "end_date": "2024-12-31"
  },
  "estate": {
    "name": "Appartement T3",
    "area": 75.5,
    "address": "123 Rue de la Paix"
  },
  "owner": {
    "name": "Jean Dupont",
    "email": "[email protected]"
  },
  "lessees": [
    {
      "name": "Marie Martin",
      "email": "[email protected]"
    }
  ],
  "charges": [
    {
      "name": "Common charges",
      "amount": 150.00
    }
  ],
  "custom_variables": {
    "custom_field": "value",
    "amount": 123.45
  }
}

Note: The exact structure may vary depending on the lease type and available data. Custom variables are added at the root level of template_data.

Example: {"lease":{"id":"550e8400-e29b-41d4-a716-446655440000","rent_amount":1200,"status":"ACTIVE","start_date":"2024-01-01","end_date":"2024-12-31"},"estate":{"name":"Appartement T3 - Rue de la Paix","area":75.5,"address":"123 Rue de la Paix, 75001 Paris"},"owner":{"name":"Jean Dupont","email":"[email protected]","phone":"+33 1 23 45 67 89"},"lessees":[{"name":"Marie Martin","email":"[email protected]","phone":"+33 1 98 76 54 32","role":"PRIMARY"}],"charges":[{"name":"Common charges","amount":150,"calculation_method":"PROVISION"},{"name":"Heating","amount":80,"calculation_method":"RELEVE_DIRECT"}],"custom_field":"custom_value","amount":123.45,"is_active":true}

object · required

Metadata about the template data generation