Relations v1
This API provides comprehensive support for managing relations within Bloxs. It enables external systems to create, retrieve, and update relations, including persons, organisations, suppliers, estate agents, and owners.
In addition to core CRUD functionality, the API supports creating, retrieving, updating, and deleting bank accounts linked to relations.
The API also provides generic endpoints, such as an endpoint to retrieve a relation when the relation type is unknown, as well as endpoints to retrieve all available relation types and communication forms.
Relation types
Persons
A person can be used in entities such as rental contracts or sales invoices, for example a tenant.
Organisations
An organisation can be used in entities such as rental contracts or sales invoices, for example a tenant that is a legal entity rather than a natural person.
Suppliers
A supplier can be used in entities such as supplier contracts or purchase invoices, for example a provider of goods or services.
Estate agents
An estate agent can be used to link real estate objects to an estate agent, enabling portfolio management per estate agent and supporting estate agent-specific functionality.
Owners
An owner represents the administration in which other entities are managed, such as objects, contracts, and invoices. Although an owner may correspond to a person or organisation in practice, it is created in Bloxs as a separate entity with only a name and no personal or organisational detail fields.
Authorization
To access the API, include your API key in the request headers. For details on how to obtain and use your API key, refer to the Authorization documentation.