Insert a building

externalIdentifier

string

No

External identifier of the building, as set by the integrating system. Maximum length 100 characters.

name

string

No

Name of the building. Maximum length 256 characters.

categoryName

string

Yes

Category assigned to the building. The category describes the type of object and indicates its purpose, for example house, office, or shop. Category values are configurable in the Bloxs admin module and determine the divisibility rules of the building. Maximum length 256 characters.

extraRelations

array of object

No

Additional relations to link to the building. Only existing relations can be linked.

extraRelations.extraRelationTypeName

string

No

Relation type to assign to the linked party for this object, for example cleaner or maintenance. Configurable in the Bloxs admin module.

extraRelations.relationReference

string

No

Reference of the relation to link. Must correspond to an existing relation already registered in Bloxs.

remarks

string

No

Free text remarks to store on the building.

underManagementSince

string (date)

No

Date the building comes under management. ISO 8601 format, for example 2026-01-01.

ownerReference

string

Yes

Reference of the owner the building belongs to. A building can have only one owner.

address.street

string

Yes

Street name of the building's address. Maximum length 200 characters.

address.houseNumber

string

No

House number of the building's address, including any suffix, for example "12A". Maximum length 40 characters.

address.postalCode

string

Yes

Postal code of the building's address. Maximum length 20 characters.

address.city

string

Yes

City of the building's address. Maximum length 200 characters.

address.countryISOCode

string

Yes

ISO 3166-1 alpha-2 country code of the building's address, for example "NL". Maximum length 2 characters.

regionName

string

No

Region to assign the building to. Maximum length 256 characters.

rawFloorArea

number (double)

No

Raw floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period. Minimum 0.01.

rentableFloorArea

number (double)

No

Rentable floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period. Minimum 0.01.

usableFloorArea

number (double)

No

Usable floor area of the building, in square meters. Minimum 0.01.

energyIndex

number (double)

No

Energy index of the building.

estateAgentReference

string

No

Reference of the estate agent associated with the building. Must be an existing relation. A building can have only one estate agent.

technicalManagement

boolean

No

Indicates whether the building is under technical management. Default value is false when omitted.

financialManagement

boolean

No

Indicates whether the building is under financial management. Default value is false when omitted.

mandateAmount

number (double)

No

Mandate amount related to technical management. It indicates the limit up to which the manager may approve repairs and maintenance costs before requiring the owner's approval.

constructionYear

integer

No

Year the building was constructed.

divisibleInfo.divisibleType

integer

Yes (within divisibleInfo)

Divisibility type of the building. Valid values are 1 (SingleUnit), 2 (DivisibleByUnits), or 3 (DivisibleByFloorArea).

divisibleInfo.divisibleFloorAreaType

integer

No

Floor area type used when divisibleType is DivisibleByFloorArea. Valid values are 0 (NA), 1 (RawFloorArea), 2 (RentableFloorArea), or 3 (UsableFloorArea).

divisibleInfo.divisibleValue

number (double)

No

Threshold value used together with divisibleFloorAreaType to determine divisibility.

reference

string

No

Internal identifier generated by Bloxs for the newly created building. This value must be stored by the integrating system and used to identify the building in all subsequent operations.

externalIdentifier

string

No

External identifier of the building, as set by the integrating system.

name

string

No

Name of the building.

displayName

string

No

Display name of the building, as shown in Bloxs.

ownerReference

string

No

Reference of the owner the building belongs to.

categoryName

string

No

Category assigned to the building.

extraRelations

array of object

No

Additional relations linked to the building. Empty or omitted when no extra relations are set.

extraRelations.extraRelationTypeName

string

No

Relation type assigned to the linked party for this object.

extraRelations.relationReference

string

No

Reference of the linked relation.

remarks

string

No

Free text remarks stored on the building.

underManagementSince

string (date-time)

No

Date the building came under management. ISO 8601 format, for example 2026-01-01T00:00:00.

salesDate

string (date-time)

No

Date the building was sold, if applicable. ISO 8601 format.

lastModified

string (date-time)

Yes

Date and time the building was last modified. ISO 8601 format, UTC.

address.street

string

Yes

Street name of the building's address. Maximum length 200 characters.

address.houseNumber

string

No

House number of the building's address, including any suffix. Maximum length 40 characters.

address.postalCode

string

Yes

Postal code of the building's address. Maximum length 20 characters.

address.city

string

Yes

City of the building's address. Maximum length 200 characters.

address.countryISOCode

string

Yes

ISO 3166-1 alpha-2 country code of the building's address. Maximum length 2 characters.

regionName

string

No

Region the building is assigned to.

rawFloorArea

number (double)

No

Raw floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

rentableFloorArea

number (double)

No

Rentable floor area of the building, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

usableFloorArea

number (double)

No

Usable floor area of the building, in square meters.

energyIndex

number (double)

No

Energy index of the building.

estateAgentReference

string

No

Reference of the estate agent associated with the building.

technicalManagement

boolean

Yes

Indicates whether the building is under technical management.

financialManagement

boolean

Yes

Indicates whether the building is under financial management.

mandateAmount

number (double)

No

Mandate amount related to technical management, indicating the limit up to which the manager may approve repairs and maintenance costs before requiring the owner's approval.

constructionYear

integer

No

Year the building was constructed.

isDivisible

boolean

Yes

Indicates whether the building can be divided into rentable units. Derived from the assigned category.

divisibleInfo.divisibleType

integer

Yes

Divisibility type of the building. Valid values are 1 (SingleUnit), 2 (DivisibleByUnits), or 3 (DivisibleByFloorArea).

divisibleInfo.divisibleFloorAreaType

integer

No

Floor area type used when divisibleType is DivisibleByFloorArea. Valid values are 0 (NA), 1 (RawFloorArea), 2 (RentableFloorArea), or 3 (UsableFloorArea).

divisibleInfo.divisibleValue

number (double)

No

Threshold value used together with divisibleFloorAreaType to determine divisibility.