API Reference

Properties, Entrances, and Units

These entities help model the real-world layout of buildings and their components, enabling accurate mapping and management within our platform.

ER Diagram

ER Diagram


Properties

A Property is the central entity of facilioo and represents a building or a group of buildings that is owned, rented, or leased by an individual, a company, or an organization. This is the top-level physical structure and may consist of multiple entrances and, further below, units.

Entrances

An Entrance is a point of access to a property. It serves as the physical entryway used by residents, service providers, or guests. Each entrance belongs to exactly one property, but a property can have multiple entrances—such as front, rear, or side entrances to a building or complex.

📘

Relationship between Properties and Entrances

Due to historical reasons, properties and entrances are stored in the same table in facilioo. Therefore, the old system does not distinguish between properties and entrances, it does refer to them as objects. Units (formerly flats) could be attached to a object back then. The new API model does only support to connect units to entrances, whereas a property has a surrogate entrance in order to stay compatible with the old version. If a property is created, an implicit entrance for that property is created with the same values. Therefore, every property has an entrance with the same ID as the property.

Units

A Unit represents an individual, addressable part of a property—such as a flat, office, commercial space, or even a garage or parking space. Units are accessible through one or more entrances and are the primary entities associated with occupants or service requests. Each unit belongs to a single entrance.

Component Entities

These entities are directly associated with and dependent on Properties, Entrances, or Units. They represent detailed, specialized data components that extend the core information of their parent entities to support specific operational and management tasks.

  • Consumption Meters
    Manage consumption meters and track their usage data at two levels: Property Level and Unit Level. Each having distinctive mechanisms.
  • Attributes
    Customizable metadata organized in attribute groups and values, attached to properties, entrances, or units to capture tailored information for diverse operational needs.