Real estate unit (lot) management
List estates for place
path Parameters
idList estates for place › Responses
OK
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atUpdate estate
path Parameters
idestate_idUpdate estate › Request Body
nameProperty name
place_idIdentifier 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_idmust 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
estate_type_idareanumber_of_roomNumber 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
orientationbuildingfloorlot_numberfiscal_identifierProperty tax identifier
housing_taxproperty_taxacquisition_pricerent_amountReference 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.
construction_daterenovation_dateaddressother_detailrental_statusRental 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).
Update estate › Responses
OK
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atCreate estate for place
path Parameters
idCreate estate for place › Request Body
nameProperty name
estate_type_idareafiscal_identifierProperty tax identifier (required)
number_of_roomorientationbuildingfloorlot_numberhousing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Used as default value when creating leases.
rental_statusRental 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_daterenovation_dateaddressother_detailCreate estate for place › Responses
Created
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atGet estate by ID
path Parameters
idestate_idGet estate by ID › Responses
OK
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atUpdate estate
path Parameters
idestate_idUpdate estate › Request Body
nameProperty name
place_idIdentifier 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_idmust 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
estate_type_idareanumber_of_roomNumber 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
orientationbuildingfloorlot_numberfiscal_identifierProperty tax identifier
housing_taxproperty_taxacquisition_pricerent_amountReference 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.
construction_daterenovation_dateaddressother_detailrental_statusRental 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).
Update estate › Responses
OK
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atList all estates
Retrieve all estates for the authenticated tenant.
This endpoint returns all estates regardless of their associated place, providing a flat view of all estates in the system.
Note: This is a flat route that complements the nested route /places/{id}/estates.
Use this endpoint when you need to access estates without knowing their parent place,
or when you need to change an estate's place association.
List all estates › Responses
OK
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atGet estate by ID
Retrieve a specific estate by its ID.
This endpoint allows direct access to an estate without needing to know its parent place. The estate must belong to the authenticated tenant.
path Parameters
idThe UUID of the estate to retrieve
Get estate by ID › Responses
OK
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atUpdate estate
Update an estate's properties, including the ability to change its place association.
Key Features:
- Allows changing the
place_idto move an estate to a different place - Validates that the new
place_idexists and belongs to the same tenant - Returns a 404 error if the new place doesn't exist or belongs to another tenant
Update Behavior:
- Field absent: Existing value is preserved (no modification)
- Field present with
null: Value is removed (set to NULL in database) - Field present with value: Value is updated
Special Fields:
place_id: Can be updated to change the estate's place association. The new place must exist and belong to the same tenant.number_of_room: Can be set tonullto remove the value
Example: To move an estate to a different place, include place_id in the request body:
Code
path Parameters
idThe UUID of the estate to update
Update estate › Request Body
nameProperty name
place_idIdentifier 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_idmust 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
estate_type_idareanumber_of_roomNumber 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
orientationbuildingfloorlot_numberfiscal_identifierProperty tax identifier
housing_taxproperty_taxacquisition_pricerent_amountReference 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.
construction_daterenovation_dateaddressother_detailrental_statusRental 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).
Update estate › Responses
OK - Estate updated successfully
idnameProperty name
place_idestate_type_idareanumber_of_roomorientationbuildingfloorowner_idprevious_owner_idlot_numberfiscal_identifierProperty tax identifier (required)
housing_taxproperty_taxacquisition_pricerent_amountReference rent amount for the property (in euros). Automatically synchronized with active leases.
rental_statusRental 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_daterenovation_dateaddressother_detailcreated_atupdated_atDelete estate
Delete an estate by its ID.
This endpoint allows direct deletion of an estate without needing to know its parent place. The estate must belong to the authenticated tenant.
Warning: This operation is irreversible. Ensure all related data (rooms, equipment, leases, etc.) is handled appropriately before deleting an estate.
path Parameters
idThe UUID of the estate to delete
Delete estate › Responses
No Content - Estate deleted successfully