Real estate objects v1
The Real estate objects API allows external systems to create, retrieve, and update the real estate objects managed in Bloxs. It covers the full object structure used for rent administration and reporting, buildings, complexes, sections, and units, together with related data such as energy labels, property valuations, initial costs, and BAG information.
Real estate object types
Buildings
A building is a standalone rentable object, such as a row house or a building that is not subdivided into multiple rentable parts. A building can be included in a lease contract. A property with multiple rentable units is modeled as a complex with units instead of a single building.
Complexes
A complex is a collection of one or more rentable units, typically located under one roof, though this is not required. A complex can optionally be divided into sections. Units within a complex, not the complex itself, are included in lease contracts.
Sections
A section is an optional subdivision within a complex, used to separate functional or physical parts of a property, such as floors, blocks, or usage types like commercial versus residential. Section configuration affects cost allocation, reporting, service cost settlements, and service tickets. Examples include a complex with a shop on the ground floor and apartments above, or an apartment complex where each floor forms a separate section.
Units
A unit is an individual rentable part of a larger property and can be included in a lease contract. A unit always belongs to a complex and may optionally belong to a section. Examples include a room in a student house or an apartment within a townhouse.
Generic and reference endpoints
Alongside the object endpoints, the API exposes lookup endpoints for values used elsewhere in the object data, such as regions, extra relation types, energy labels, property valuation types, and the categories available per object type. It also provides endpoints for publication data, used to mark objects as available, reserved, rented, or under option for listing purposes, property valuations per year, BAG information per object, and scoring point totals.