Relations API (v1)
The Relations API provides CRUD access to the parties involved in Bloxs' real estate and financial workflows: Owners, Persons, Suppliers, Estate Agents, and Organisations. Integrators use it to create and maintain master data for these relations, including their contact details, addresses, and bank accounts, so that other Bloxs modules (leases, invoices, maintenance) can reference a consistent set of parties.
Each relation type supports the same core operations: retrieving a single record by reference or external identifier, searching a paged and filterable list, inserting a new record, fully overwriting an existing record, and archiving a record as of a given date. Archiving is used instead of deletion to preserve historical data while marking a relation as no longer active. Bank accounts are managed as a sub-resource under each relation type, with endpoints to list, add, update, and remove individual accounts. Organisations and Persons additionally support attaching files, such as identification documents or contracts.
Beyond the individual relation types, the API exposes a few cross-cutting endpoints. A common "get relation" endpoint retrieves any relation regardless of its type, useful when the caller only knows a reference or external identifier and not which relation type it belongs to. Separate lookup endpoints return the full list of relation types and supplier types configured in the system, which can be used to validate or populate values such as relationTypeName and supplierTypeNamebefore creating a record. Contact person endpoints allow retrieving all contacts linked to a relation, and conversely all relations linked to a given contact person. An admin endpoint returns the available communication forms (the allowed values for how a relation should be corresponded with, such as email or post).
Throughout the API, a relation can be looked up by either its internal reference or its externalIdentifier, allowing integrators to use their own external system's identifier as an alternative to the Bloxs-internal one.