Estates

Archive an estate (nested route)

Archives an estate from within its parent place. Same effect as PUT /estates/{id}/archive: the estate is kept with its full history but released from the plan's active-property quota.

Use this variant when you are already navigating the place → estate hierarchy and want the place membership checked as part of the call.

put/places/{place_id}/estates/{estate_id}/archive

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/archive
  • Auth: HTTP bearer

Path parameters

place_idstring uuid required
estate_idstring uuid required

Response

Estate archived

idstring uuid nullable
namestring nullable

Property name

place_idstring uuid nullable
estate_type_idstring uuid nullable
areanumber nullable
number_of_roominteger nullable
orientationstring nullable
buildingstring nullable
floorinteger nullable
owner_idstring uuid nullable
previous_owner_idstring uuid nullable
lot_numberstring nullable
fiscal_identifierstring nullable

Property tax identifier (required)

housing_taxnumber nullable
property_taxnumber nullable
acquisition_pricenumber nullable
rent_amountnumber nullable

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

rental_status'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).

construction_datestring date-time nullable
renovation_datestring date-time nullable
addressstring nullable
other_detailstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Example response

{
  "name": "3-bedroom apartment - Rue de la Paix",
  "fiscal_identifier": "1234567890123",
  "rent_amount": 1200,
  "rental_status": "RENTED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.