Skip to main content
The Property domain is the structural foundation of the API. Every other domain’s rows carry property_id, which resolves back to a record in properties. Use this domain to retrieve property objects, their internal structure (units, cost centres), assigned service providers, and technical/metered objects.

properties

GET /property/properties — one row per property object.
integer
required
Unique property identifier. The primary join key across all domains.
integer
Internal surrogate key. Not stable across data reloads — join on property_id, not this field.
string
Combined display label: property ID and name.
string
Property name.
string
Primary building entrance / street address component. Up to five entrance fields (entrance_1entrance_5) exist for properties with multiple entrances.
string
Combined address line.
string
Postal code.
string
City.
Example request

property_structure

GET /property/property_structure — the hierarchy tree that connects buildings, cost centres, and floor areas. This is the bridge table for the rest of the API: bookings and tenancy data join to a specific unit or cost centre through join_key, not directly through floor_area_id.
integer
required
Unique property identifier.
string
required
Bridge key. Equals account_id for cost-centre nodes, or floor_area_id for floor-area nodes. Accounting.booking_header and Accounting.booking_positions join to this table through join_key.
integer
Floor-area identifier, when this node represents a unit rather than a cost centre.
string
Display name of the structure node (cost centre or unit name).
string
Node type — distinguishes cost centres from floor areas.
property_structure has no natural single-column primary key of its own — join_key is unique per property, so treat (property_id, join_key) as the effective key when deduplicating or joining.

property_creditor_services

GET /property/property_creditor_services — which creditor provides which service for a property, and whether that assignment is exclusive.
integer
required
Unique property identifier.
integer
required
References Stakeholder.creditor.
integer
required
Identifies the service type.
string
Service name (e.g. cleaning, elevator maintenance).
string
Whether the creditor holds an exclusive assignment for this service at this property.

technical_objects

GET /property/technical_objects — technical/metered installations at a property (elevators, heating systems, meters, and similar equipment).
integer
required
Unique property identifier.
integer
Floor area the technical object is installed in, if applicable.
integer
Maintenance creditor responsible for the object. References Stakeholder.creditor.
integer
required
Technical object identifier.
string
Technical object number.
string
Object name.
string
Object type.
date
Installation/build date.
There is no separate meter-reading endpoint. A technical_objects row can represent a meter, but this endpoint only returns the object’s master data (type, location, responsible creditor) — not consumption readings.