Insert a complex

externalIdentifier

string

No

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

name

string

No

Name of the complex. Maximum length 256 characters.

categoryName

string

Yes

Category assigned to the complex. 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 whether the complex must be divided into sections. Maximum length 256 characters.

extraRelations

array of object

No

Additional relations to link to the complex. 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 complex.

underManagementSince

string (date)

No

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

address.street

string

Yes

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

address.houseNumber

string

No

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

address.postalCode

string

Yes

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

address.city

string

Yes

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

address.countryISOCode

string

Yes

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

ownerReference

string

Yes

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

estateAgentReference

string

No

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

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 complex was constructed.

energyIndex

number (double)

No

Energy index of the complex.

technicalManagement

boolean

No

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

financialManagement

boolean

No

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

reference

string

No

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

externalIdentifier

string

No

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

name

string

No

Name of the complex.

displayName

string

No

Display name of the complex, as shown in Bloxs.

ownerReference

string

No

Reference of the owner the complex belongs to.

categoryName

string

No

Category assigned to the complex.

extraRelations

array of object

No

Additional relations linked to the complex. 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 complex.

underManagementSince

string (date-time)

No

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

salesDate

string (date-time)

No

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

lastModified

string (date-time)

Yes

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

address.street

string

Yes

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

address.houseNumber

string

No

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

address.postalCode

string

Yes

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

address.city

string

Yes

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

address.countryISOCode

string

Yes

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

estateAgentReference

string

No

Reference of the estate agent associated with the complex.

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 complex was constructed.

totalRawFloorArea

number (double)

No

Total raw floor area of all rentable units in the complex, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

totalRentableFloorArea

number (double)

No

Total rentable floor area of all rentable units in the complex, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

totalUsableFloorArea

number (double)

No

Total usable floor area of all rentable units in the complex, in square meters.

energyIndex

number (double)

No

Energy index of the complex.

technicalManagement

boolean

Yes

Indicates whether the complex is under technical management.

financialManagement

boolean

Yes

Indicates whether the complex is under financial management.