Relation API Documentation

Welcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations.

Authentication

To access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key.

CRUD Operations

The API supports CRUD operations for the following relationship types:

• Estate Agents: This includes a wide range of real estate brokerage services, including but not limited to real estate agents, brokers, and rental agents.
• Organisations: These are tenants who are not natural persons but rather entities such as commercial real estate or partnerships. For instance, a university providing rooms where the rent is collected directly from the tenant.
• Owners: This pertains to real estate owners. Each owner has their own financial administration. Adding a new owner automatically triggers the creation of a new financial administration.
• Persons: This is a standalone entity and pertains to an enhancement of organization. This could be a contact person within an organization. Several users utilize this to input their own employees into the system.
• Suppliers: This encompasses all entities from which you receive invoices. For example, the tax authorities or a cleaning company. Also, for instance, the company from which you purchase office supplies.

For each relationship type, the following operations are available:

• GET: Retrieve a list or apply filters.
• POST: Add a new entry, archive an existing relation or apply filters.
• PUT: Update existing details.

Moreover, in the nearby future the following operations will become available:

• PATCH: Apply partial updates.
• DELETE: Remove an entry.

Thank you for choosing our Relation API.