FairePlace Property Management API

Lease Termination

Endpointhttps://api.faireplace.com/api

Get termination status

GET

https://api.faireplace.com/api

/leases/{lease_id}/termination

Returns the current state of the termination process including the checklist progress.

Permissions required: LeasesRead

Get termination status › path Parameters

lease_id

string · uuid · required

Get termination status › Responses

Termination details

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

GET/leases/{lease_id}/termination

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/termination

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Initiate lease termination from notice

POST

https://api.faireplace.com/api

/leases/{lease_id}/termination

Initiates the termination process for a lease after a notice (congé) has been received. Creates a LeaseTermination orchestrator with a checklist adapted to the lease type. Transitions the lease from ACTIVE to NOTICE.

Idempotent: If a termination already exists for this lease, returns the existing one.

Permissions required: LeasesWrite

Initiate lease termination from notice › path Parameters

lease_id

string · uuid · required

Initiate lease termination from notice › Request Body

notice_id

string · uuid · required

ID of the lease notice (must be in RECEIVED or EFFECTIVE status)

Initiate lease termination from notice › Responses

Termination process initiated (or existing returned)

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

POST/leases/{lease_id}/termination

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/termination \
  --header 'Content-Type: application/json' \
  --data '
{
  "notice_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "notice_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Initiate termination from natural expiration

POST

https://api.faireplace.com/api

/leases/{lease_id}/termination/from-expiration

Initiates the termination process for a lease that has reached its end_date without a formal notice (congé). Used for fixed-term leases (mobility, seasonal, CDD). Transitions the lease directly from ACTIVE to FINALISATION (skips NOTICE).

Idempotent. Typically called by the scheduler, but can be triggered manually.

Permissions required: LeasesWrite

Initiate termination from natural expiration › path Parameters

lease_id

string · uuid · required

Initiate termination from natural expiration › Responses

200

Termination process initiated

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

POST/leases/{lease_id}/termination/from-expiration

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/from-expiration

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Transition to finalisation phase

PUT

https://api.faireplace.com/api

/leases/{lease_id}/termination/start-finalisation

Transitions the lease from NOTICE to FINALISATION when the notice effective date is reached. Sets the termination status to EXIT_PENDING.

Idempotent: If already past INITIATED status, returns current state.

Permissions required: LeasesWrite

Transition to finalisation phase › path Parameters

lease_id

string · uuid · required

Transition to finalisation phase › Responses

Finalisation phase started

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/termination/start-finalisation

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/start-finalisation

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Register exit condition report

PUT

https://api.faireplace.com/api

/leases/{lease_id}/termination/exit-report

Links an exit condition report (EDL de sortie) to the termination process. Automatically:

Checks exit_condition_report_done in the checklist
Checks keys_returned if keys_returned: true
Calculates the deposit restitution deadline (Art. 22): 1 month if conformity, 2 months otherwise
Updates security_deposit.restitution_due_date
Transitions termination to SETTLEMENT_PENDING

Permissions required: LeasesWrite

Register exit condition report › path Parameters

lease_id

string · uuid · required

Register exit condition report › Request Body

condition_report_id

string · uuid · required

ID of the exit condition report (must be type EXIT)

actual_exit_date

string · date · required

Date the tenant actually vacated

keys_returned

boolean · required

Whether keys were returned

Register exit condition report › Responses

200

Exit report registered

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/termination/exit-report

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/exit-report \
  --header 'Content-Type: application/json' \
  --data '
{
  "condition_report_id": "00000000-0000-0000-0000-000000000000",
  "actual_exit_date": "2024-08-25",
  "keys_returned": true
}
'

shell

Example Request Body

{
  "condition_report_id": "00000000-0000-0000-0000-000000000000",
  "actual_exit_date": "2024-08-25",
  "keys_returned": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Check a checklist item

PUT

https://api.faireplace.com/api

/leases/{lease_id}/termination/checklist/{key}

Marks a checklist item as completed. Idempotent — if already checked, no-op.

Permissions required: LeasesWrite

Check a checklist item › path Parameters

lease_id

string · uuid · required

key

string · required

Checklist item key (e.g., keys_returned, meters_read)

Check a checklist item › Responses

Item checked

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/termination/checklist/{key}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/checklist/:key

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Uncheck a checklist item

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/termination/checklist/{key}

Unchecks a checklist item (correction). Resets completed, completed_at, completed_by.

Permissions required: LeasesWrite

Uncheck a checklist item › path Parameters

lease_id

string · uuid · required

key

string · required

Uncheck a checklist item › Responses

200

Item unchecked

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

DELETE/leases/{lease_id}/termination/checklist/{key}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/checklist/:key

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Calculate deposit settlement

PUT

https://api.faireplace.com/api

/leases/{lease_id}/termination/settlement

Applies retentions on the security deposit and calculates the amount to return. Uses existing SecurityDepositService::validate_return() which enforces:

Max 20% of deposit for co-ownership charges (Art. 22)
Late penalty: 10% monthly rent per month of delay

Checks deposit_settled in the checklist.

Permissions required: LeasesWrite

Calculate deposit settlement › path Parameters

lease_id

string · uuid · required

Calculate deposit settlement › Request Body

retained_for_charges

number | null · decimal

Co-ownership charge retention (max 20% of deposit, Art. 22)

retained_for_damages

number | null · decimal

Retention for damages (justified by exit inspection)

retained_for_unpaid_rent

number | null · decimal

Retention for unpaid rent

copro_accounts_approval_date

string | null · date

Syndic account approval date

notes

string | null

Calculate deposit settlement › Responses

200

Settlement calculated

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/termination/settlement

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/settlement \
  --header 'Content-Type: application/json' \
  --data '
{
  "retained_for_charges": {},
  "retained_for_damages": {},
  "retained_for_unpaid_rent": {},
  "copro_accounts_approval_date": "2024-08-25",
  "notes": {}
}
'

shell

Example Request Body

{
  "retained_for_charges": {},
  "retained_for_damages": {},
  "retained_for_unpaid_rent": {},
  "copro_accounts_approval_date": "2024-08-25",
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Complete the termination process

PUT

https://api.faireplace.com/api

/leases/{lease_id}/termination/complete

Finalises the termination: transitions the lease from FINALISATION to TERMINATED. Requires all required checklist items to be completed (can_complete = true).

Idempotent: If already COMPLETED, returns current state.

Updates estate rental status to VACANT (if no other active lease).

Permissions required: LeasesWrite

Complete the termination process › path Parameters

lease_id

string · uuid · required

Complete the termination process › Responses

Termination completed

id

string · uuid

lease_id

string · uuid

notice_id

string | null · uuid

status

string · enum

Enum values:

INITIATED

EXIT_PENDING

SETTLEMENT_PENDING

COMPLETED

effective_date

string · date

actual_exit_date

string | null · date

exit_condition_report_id

string | null · uuid

charge_review_id

string | null · uuid

object[]

completion_percentage

integer · min: 0 · max: 100

can_complete

boolean

True if all required checklist items are completed

created_at

string · date-time

updated_at

string · date-time

PUT/leases/{lease_id}/termination/complete

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/termination/complete

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notice_id": "00000000-0000-0000-0000-000000000000",
  "status": "INITIATED",
  "effective_date": "2024-08-25",
  "actual_exit_date": "2024-08-25",
  "exit_condition_report_id": "00000000-0000-0000-0000-000000000000",
  "charge_review_id": "00000000-0000-0000-0000-000000000000",
  "checklist": [
    {
      "key": "key",
      "label": "label",
      "required_for_completion": true,
      "completed": true,
      "completed_at": "2024-08-25T15:00:00Z",
      "completed_by": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "completion_percentage": 0,
  "can_complete": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Force terminate a lease

PUT

https://api.faireplace.com/api

/leases/{lease_id}/force-terminate

Terminates the lease immediately, bypassing the standard termination process. No LeaseTermination orchestrator is created. Requires a mandatory reason (10-1000 characters).

Use cases:

Termination handled outside the application (paper mail, bailiff)
Court-ordered termination
Amicable agreement managed directly
Migration from legacy system

Permissions required: LeasesWrite

Force terminate a lease › path Parameters

lease_id

string · uuid · required

Force terminate a lease › Request Body

reason

string · minLength: 10 · maxLength: 1000 · required

Mandatory reason for force termination

termination_date

string | null · date

Effective end date (defaults to today)

Force terminate a lease › Responses

Lease force-terminated

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

PUT/leases/{lease_id}/force-terminate

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/force-terminate \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "reason",
  "termination_date": "2024-08-25"
}
'

shell

Example Request Body

{
  "reason": "reason",
  "termination_date": "2024-08-25"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440002",
  "template_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "reference_number": "BAIL-2024-001",
  "status": "ACTIVE",
  "version": 1,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "rent_amount": 1200,
  "rent_frequency": "MONTHLY",
  "deposit_amount": 1200,
  "revision_index_type": "IRL",
  "last_revision_date": "2024-08-25",
  "next_revision_date": "2024-08-25",
  "usage_type": "RESIDENTIAL_ONLY",
  "furniture_list_id": "00000000-0000-0000-0000-000000000000",
  "notes": {},
  "is_subject_to_rent_evolution_decree": true,
  "is_subject_to_reference_rent_cap": true,
  "reference_rent_per_m2": 20.5,
  "reference_rent_increased_per_m2": 22.55,
  "base_rent_amount": 1000,
  "rent_complement_amount": 200,
  "rent_complement_justification": {},
  "previous_tenant_last_rent": 1150,
  "previous_tenant_last_payment_date": "2024-08-25",
  "previous_tenant_last_revision_date": "2024-08-25",
  "rent_revision_date": "2024-08-25",
  "irl_reference_quarter": "T1 2024",
  "irl_reference_value": 142.35,
  "rent_regulation_applied_at": "2024-08-25T15:00:00Z",
  "rent_regulation_zone_type": {},
  "rent_regulation_compliance_status": {},
  "rent_regulation_last_check": "2024-08-25T15:00:00Z",
  "charge_settlement_mode": "PROVISION",
  "payment_day": 5,
  "payment_terms": "TERME_A_ECHOIR",
  "payment_method": "VIREMENT_BANCAIRE",
  "rent_increase_for_work": {},
  "rent_increase_work_description": {},
  "rent_increase_work_cost": {},
  "rent_increase_work_completion_date": "2024-08-25",
  "rent_increase_legal_basis": {},
  "rent_increase_calculation_method": {},
  "rent_increase_supporting_documents": {},
  "rent_increase_start_date": "2024-08-25",
  "rent_increase_end_date": "2024-08-25",
  "rent_increase_duration_months": {},
  "rent_decrease_for_tenant_work": {},
  "rent_decrease_work_description": {},
  "rent_decrease_work_estimated_cost": {},
  "rent_decrease_work_deadline": "2024-08-25",
  "rent_decrease_work_specifications": {},
  "rent_decrease_work_authorization_required": {},
  "rent_decrease_restitution_clause": {},
  "rent_decrease_supporting_documents": {},
  "rent_decrease_start_date": "2024-08-25",
  "rent_decrease_end_date": "2024-08-25",
  "rent_decrease_duration_months": {},
  "solidarity_clause": {},
  "termination_clause": {},
  "visit_clause": {},
  "furniture_provision_clause": {},
  "pet_clause": {},
  "insurance_clause": {},
  "maintenance_clause": {},
  "damage_clause": {},
  "regularization_waiver_clause": {},
  "rent_free_clause": {},
  "custom_clause": {},
  "rent_free_start_date": "2024-08-25",
  "rent_free_end_date": "2024-08-25",
  "rent_free_amount": {},
  "tenant_fees_cap_visit_dossier_lease_per_m2": {},
  "tenant_fees_cap_inventory_per_m2": {},
  "landlord_fees_visit_dossier_lease": {},
  "landlord_fees_visit_dossier_lease_description": {},
  "landlord_fees_inventory_entry": {},
  "landlord_fees_inventory_entry_description": {},
  "landlord_fees_other": {},
  "landlord_fees_other_description": {},
  "tenant_fees_visit_dossier_lease": {},
  "tenant_fees_visit_dossier_lease_description": {},
  "tenant_fees_inventory_entry": {},
  "tenant_fees_inventory_entry_description": {},
  "tenant_fees_other": {},
  "tenant_fees_other_description": {},
  "fees_calculation_date": "2024-08-25T15:00:00Z",
  "fees_regulation_compliance": {},
  "fees_agency_name": {},
  "fees_agency_registration_number": {},
  "student_school_name": "Université Paris-Saclay",
  "student_enrollment_year": "2024-2025",
  "student_certificate_provided": {},
  "student_level": "Master 1",
  "mobility_reason": "mission_temporaire",
  "mobility_reason_other": {},
  "initial_duration_months": 6,
  "extended_duration_months": 9,
  "lease_extension_info": {},
  "seasonal_rental_purpose": "vacances",
  "seasonal_purpose_details": {},
  "seasonal_guest_count": 4,
  "seasonal_cleaning_included": {},
  "seasonal_cleaning_fee": 80,
  "seasonal_tourist_tax_included": {},
  "seasonal_tourist_tax_amount": 2.5,
  "seasonal_services_included": "WiFi, household linen, private parking",
  "seasonal_energy_mode": "inclus_forfait",
  "seasonal_cancellation_policy": {},
  "seasonal_declaration_number": "75001-2025-00123",
  "commercial_business_name": "TECH RETAIL SARL",
  "commercial_legal_form": "SARL",
  "commercial_siret": "12345678901234",
  "commercial_rcs": "RCS Paris 987 654 321",
  "commercial_activity": "IT retail and office equipment",
  "commercial_activity_code_ape": "47.11F",
  "commercial_triennial_exit_year_3": "2027-07-01",
  "commercial_triennial_exit_year_6": "2030-07-01",
  "commercial_triennial_exit_year_9": "2033-07-01",
  "commercial_notice_period_months": 6,
  "commercial_ilc_base_value": 130.52,
  "commercial_ilc_base_date": "2024-10-01",
  "commercial_next_revision_date": "2027-01-01",
  "commercial_rent_ceiling_enabled": {},
  "commercial_despecialization_partial": [
    {
      "date": "2025-06-01",
      "activity": "Sale of IT accessories",
      "approved_by": "Jean Dupont"
    }
  ],
  "commercial_despecialization_full": {
    "date": "2026-03-15",
    "old_activity": "IT retail",
    "new_activity": "Restaurant",
    "approved": true,
    "indemnity_amount": 15000
  },
  "commercial_guarantors": [
    {
      "name": "Holding Company XYZ",
      "siret": "98765432109876",
      "address": "10 Avenue des Champs-Élysées, 75008 Paris",
      "guaranteed_amount": 50000,
      "signature_date": "2025-01-01"
    }
  ],
  "commercial_insurance_policy": "POL-RC-2025-789456",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Archive a lease

PUT

https://api.faireplace.com/api

/leases/{lease_id}/archive

Sets archived_at on the lease. Archived leases are excluded from default listings. Only TERMINATED or EXPIRED leases can be archived. Cannot archive if security_deposit is in DISPUTED status.

Idempotent: If already archived, no-op.

Permissions required: LeasesWrite

Archive a lease › path Parameters

lease_id

string · uuid · required

Archive a lease › Responses

Lease archived

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

PUT/leases/{lease_id}/archive

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/archive

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440002",
  "template_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "reference_number": "BAIL-2024-001",
  "status": "ACTIVE",
  "version": 1,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "rent_amount": 1200,
  "rent_frequency": "MONTHLY",
  "deposit_amount": 1200,
  "revision_index_type": "IRL",
  "last_revision_date": "2024-08-25",
  "next_revision_date": "2024-08-25",
  "usage_type": "RESIDENTIAL_ONLY",
  "furniture_list_id": "00000000-0000-0000-0000-000000000000",
  "notes": {},
  "is_subject_to_rent_evolution_decree": true,
  "is_subject_to_reference_rent_cap": true,
  "reference_rent_per_m2": 20.5,
  "reference_rent_increased_per_m2": 22.55,
  "base_rent_amount": 1000,
  "rent_complement_amount": 200,
  "rent_complement_justification": {},
  "previous_tenant_last_rent": 1150,
  "previous_tenant_last_payment_date": "2024-08-25",
  "previous_tenant_last_revision_date": "2024-08-25",
  "rent_revision_date": "2024-08-25",
  "irl_reference_quarter": "T1 2024",
  "irl_reference_value": 142.35,
  "rent_regulation_applied_at": "2024-08-25T15:00:00Z",
  "rent_regulation_zone_type": {},
  "rent_regulation_compliance_status": {},
  "rent_regulation_last_check": "2024-08-25T15:00:00Z",
  "charge_settlement_mode": "PROVISION",
  "payment_day": 5,
  "payment_terms": "TERME_A_ECHOIR",
  "payment_method": "VIREMENT_BANCAIRE",
  "rent_increase_for_work": {},
  "rent_increase_work_description": {},
  "rent_increase_work_cost": {},
  "rent_increase_work_completion_date": "2024-08-25",
  "rent_increase_legal_basis": {},
  "rent_increase_calculation_method": {},
  "rent_increase_supporting_documents": {},
  "rent_increase_start_date": "2024-08-25",
  "rent_increase_end_date": "2024-08-25",
  "rent_increase_duration_months": {},
  "rent_decrease_for_tenant_work": {},
  "rent_decrease_work_description": {},
  "rent_decrease_work_estimated_cost": {},
  "rent_decrease_work_deadline": "2024-08-25",
  "rent_decrease_work_specifications": {},
  "rent_decrease_work_authorization_required": {},
  "rent_decrease_restitution_clause": {},
  "rent_decrease_supporting_documents": {},
  "rent_decrease_start_date": "2024-08-25",
  "rent_decrease_end_date": "2024-08-25",
  "rent_decrease_duration_months": {},
  "solidarity_clause": {},
  "termination_clause": {},
  "visit_clause": {},
  "furniture_provision_clause": {},
  "pet_clause": {},
  "insurance_clause": {},
  "maintenance_clause": {},
  "damage_clause": {},
  "regularization_waiver_clause": {},
  "rent_free_clause": {},
  "custom_clause": {},
  "rent_free_start_date": "2024-08-25",
  "rent_free_end_date": "2024-08-25",
  "rent_free_amount": {},
  "tenant_fees_cap_visit_dossier_lease_per_m2": {},
  "tenant_fees_cap_inventory_per_m2": {},
  "landlord_fees_visit_dossier_lease": {},
  "landlord_fees_visit_dossier_lease_description": {},
  "landlord_fees_inventory_entry": {},
  "landlord_fees_inventory_entry_description": {},
  "landlord_fees_other": {},
  "landlord_fees_other_description": {},
  "tenant_fees_visit_dossier_lease": {},
  "tenant_fees_visit_dossier_lease_description": {},
  "tenant_fees_inventory_entry": {},
  "tenant_fees_inventory_entry_description": {},
  "tenant_fees_other": {},
  "tenant_fees_other_description": {},
  "fees_calculation_date": "2024-08-25T15:00:00Z",
  "fees_regulation_compliance": {},
  "fees_agency_name": {},
  "fees_agency_registration_number": {},
  "student_school_name": "Université Paris-Saclay",
  "student_enrollment_year": "2024-2025",
  "student_certificate_provided": {},
  "student_level": "Master 1",
  "mobility_reason": "mission_temporaire",
  "mobility_reason_other": {},
  "initial_duration_months": 6,
  "extended_duration_months": 9,
  "lease_extension_info": {},
  "seasonal_rental_purpose": "vacances",
  "seasonal_purpose_details": {},
  "seasonal_guest_count": 4,
  "seasonal_cleaning_included": {},
  "seasonal_cleaning_fee": 80,
  "seasonal_tourist_tax_included": {},
  "seasonal_tourist_tax_amount": 2.5,
  "seasonal_services_included": "WiFi, household linen, private parking",
  "seasonal_energy_mode": "inclus_forfait",
  "seasonal_cancellation_policy": {},
  "seasonal_declaration_number": "75001-2025-00123",
  "commercial_business_name": "TECH RETAIL SARL",
  "commercial_legal_form": "SARL",
  "commercial_siret": "12345678901234",
  "commercial_rcs": "RCS Paris 987 654 321",
  "commercial_activity": "IT retail and office equipment",
  "commercial_activity_code_ape": "47.11F",
  "commercial_triennial_exit_year_3": "2027-07-01",
  "commercial_triennial_exit_year_6": "2030-07-01",
  "commercial_triennial_exit_year_9": "2033-07-01",
  "commercial_notice_period_months": 6,
  "commercial_ilc_base_value": 130.52,
  "commercial_ilc_base_date": "2024-10-01",
  "commercial_next_revision_date": "2027-01-01",
  "commercial_rent_ceiling_enabled": {},
  "commercial_despecialization_partial": [
    {
      "date": "2025-06-01",
      "activity": "Sale of IT accessories",
      "approved_by": "Jean Dupont"
    }
  ],
  "commercial_despecialization_full": {
    "date": "2026-03-15",
    "old_activity": "IT retail",
    "new_activity": "Restaurant",
    "approved": true,
    "indemnity_amount": 15000
  },
  "commercial_guarantors": [
    {
      "name": "Holding Company XYZ",
      "siret": "98765432109876",
      "address": "10 Avenue des Champs-Élysées, 75008 Paris",
      "guaranteed_amount": 50000,
      "signature_date": "2025-01-01"
    }
  ],
  "commercial_insurance_policy": "POL-RC-2025-789456",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

List archived leases

GET

https://api.faireplace.com/api

/leases/archived

Returns all archived leases (archived_at IS NOT NULL).

Permissions required: LeasesRead

List archived leases › Responses

200

List of archived leases

object[]

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

GET/leases/archived

curl --request GET \
  --url https://api.faireplace.com/api/leases/archived

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "estate_id": "550e8400-e29b-41d4-a716-446655440001",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440002",
    "template_id": "00000000-0000-0000-0000-000000000000",
    "agent_id": "00000000-0000-0000-0000-000000000000",
    "reference_number": "BAIL-2024-001",
    "status": "ACTIVE",
    "version": 1,
    "start_date": "2024-01-01",
    "end_date": "2025-01-01",
    "rent_amount": 1200,
    "rent_frequency": "MONTHLY",
    "deposit_amount": 1200,
    "revision_index_type": "IRL",
    "last_revision_date": "2024-08-25",
    "next_revision_date": "2024-08-25",
    "usage_type": "RESIDENTIAL_ONLY",
    "furniture_list_id": "00000000-0000-0000-0000-000000000000",
    "notes": {},
    "is_subject_to_rent_evolution_decree": true,
    "is_subject_to_reference_rent_cap": true,
    "reference_rent_per_m2": 20.5,
    "reference_rent_increased_per_m2": 22.55,
    "base_rent_amount": 1000,
    "rent_complement_amount": 200,
    "rent_complement_justification": {},
    "previous_tenant_last_rent": 1150,
    "previous_tenant_last_payment_date": "2024-08-25",
    "previous_tenant_last_revision_date": "2024-08-25",
    "rent_revision_date": "2024-08-25",
    "irl_reference_quarter": "T1 2024",
    "irl_reference_value": 142.35,
    "rent_regulation_applied_at": "2024-08-25T15:00:00Z",
    "rent_regulation_zone_type": {},
    "rent_regulation_compliance_status": {},
    "rent_regulation_last_check": "2024-08-25T15:00:00Z",
    "charge_settlement_mode": "PROVISION",
    "payment_day": 5,
    "payment_terms": "TERME_A_ECHOIR",
    "payment_method": "VIREMENT_BANCAIRE",
    "rent_increase_for_work": {},
    "rent_increase_work_description": {},
    "rent_increase_work_cost": {},
    "rent_increase_work_completion_date": "2024-08-25",
    "rent_increase_legal_basis": {},
    "rent_increase_calculation_method": {},
    "rent_increase_supporting_documents": {},
    "rent_increase_start_date": "2024-08-25",
    "rent_increase_end_date": "2024-08-25",
    "rent_increase_duration_months": {},
    "rent_decrease_for_tenant_work": {},
    "rent_decrease_work_description": {},
    "rent_decrease_work_estimated_cost": {},
    "rent_decrease_work_deadline": "2024-08-25",
    "rent_decrease_work_specifications": {},
    "rent_decrease_work_authorization_required": {},
    "rent_decrease_restitution_clause": {},
    "rent_decrease_supporting_documents": {},
    "rent_decrease_start_date": "2024-08-25",
    "rent_decrease_end_date": "2024-08-25",
    "rent_decrease_duration_months": {},
    "solidarity_clause": {},
    "termination_clause": {},
    "visit_clause": {},
    "furniture_provision_clause": {},
    "pet_clause": {},
    "insurance_clause": {},
    "maintenance_clause": {},
    "damage_clause": {},
    "regularization_waiver_clause": {},
    "rent_free_clause": {},
    "custom_clause": {},
    "rent_free_start_date": "2024-08-25",
    "rent_free_end_date": "2024-08-25",
    "rent_free_amount": {},
    "tenant_fees_cap_visit_dossier_lease_per_m2": {},
    "tenant_fees_cap_inventory_per_m2": {},
    "landlord_fees_visit_dossier_lease": {},
    "landlord_fees_visit_dossier_lease_description": {},
    "landlord_fees_inventory_entry": {},
    "landlord_fees_inventory_entry_description": {},
    "landlord_fees_other": {},
    "landlord_fees_other_description": {},
    "tenant_fees_visit_dossier_lease": {},
    "tenant_fees_visit_dossier_lease_description": {},
    "tenant_fees_inventory_entry": {},
    "tenant_fees_inventory_entry_description": {},
    "tenant_fees_other": {},
    "tenant_fees_other_description": {},
    "fees_calculation_date": "2024-08-25T15:00:00Z",
    "fees_regulation_compliance": {},
    "fees_agency_name": {},
    "fees_agency_registration_number": {},
    "student_school_name": "Université Paris-Saclay",
    "student_enrollment_year": "2024-2025",
    "student_certificate_provided": {},
    "student_level": "Master 1",
    "mobility_reason": "mission_temporaire",
    "mobility_reason_other": {},
    "initial_duration_months": 6,
    "extended_duration_months": 9,
    "lease_extension_info": {},
    "seasonal_rental_purpose": "vacances",
    "seasonal_purpose_details": {},
    "seasonal_guest_count": 4,
    "seasonal_cleaning_included": {},
    "seasonal_cleaning_fee": 80,
    "seasonal_tourist_tax_included": {},
    "seasonal_tourist_tax_amount": 2.5,
    "seasonal_services_included": "WiFi, household linen, private parking",
    "seasonal_energy_mode": "inclus_forfait",
    "seasonal_cancellation_policy": {},
    "seasonal_declaration_number": "75001-2025-00123",
    "commercial_business_name": "TECH RETAIL SARL",
    "commercial_legal_form": "SARL",
    "commercial_siret": "12345678901234",
    "commercial_rcs": "RCS Paris 987 654 321",
    "commercial_activity": "IT retail and office equipment",
    "commercial_activity_code_ape": "47.11F",
    "commercial_triennial_exit_year_3": "2027-07-01",
    "commercial_triennial_exit_year_6": "2030-07-01",
    "commercial_triennial_exit_year_9": "2033-07-01",
    "commercial_notice_period_months": 6,
    "commercial_ilc_base_value": 130.52,
    "commercial_ilc_base_date": "2024-10-01",
    "commercial_next_revision_date": "2027-01-01",
    "commercial_rent_ceiling_enabled": {},
    "commercial_despecialization_partial": [
      {
        "date": "2025-06-01",
        "activity": "Sale of IT accessories",
        "approved_by": "Jean Dupont"
      }
    ],
    "commercial_despecialization_full": {
      "date": "2026-03-15",
      "old_activity": "IT retail",
      "new_activity": "Restaurant",
      "approved": true,
      "indemnity_amount": 15000
    },
    "commercial_guarantors": [
      {
        "name": "Holding Company XYZ",
        "siret": "98765432109876",
        "address": "10 Avenue des Champs-Élysées, 75008 Paris",
        "guaranteed_amount": 50000,
        "signature_date": "2025-01-01"
      }
    ],
    "commercial_insurance_policy": "POL-RC-2025-789456",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Lease Notices Rent Reminders