Introduction

Contracts v1

Important

Although the API folder is named “Concept SalesContracts V1”, this name is misleading. The underlying endpoints are not limited to draft (concept) sales contracts. They cover all supported contract types and states, as reflected in the menu structure.

This API provides comprehensive support for managing contracts within Bloxs. It enables external systems to create, retrieve, update and delete draft contracts, as well as retrieve active (non-draft) contracts. Contracts can be linked to one or more real estate objects and can contain contract lines, initial costs and supporting documents.

The API distinguishes between contract types (general, residential lease, commercial lease and supplier contracts) and between draft and non-draft states. Available operations depend on both the contract type and its status.

General contracts

General contracts are used for agreements where periodic sales invoices must be generated based on the agreements defined in the contract. These agreements can be of a general nature and are not considered lease contracts. Linking real estate objects to these contracts is optional.

Non-draft general contracts

For non-draft general contracts, the API supports:

• Retrieve a specific contract;

• Retrieve contracts (filtered and paged);

• Retrieve real estate objects linked to a contract.

Note: There is no API that support operations for draft general contracts.

Residential lease contracts

Residential lease contracts are used for rental agreements related to residential real estate objects, such as buildings or units intended for housing.

Draft residential lease contracts

For residential lease contracts in draft status, the API supports full lifecycle management, including:

• Core contract management

  • Retrieve a specific contract;

  • Create a new contract;

  • Update an existing contract;

  • Delete a contract;

  • Retrieve contracts (filtered and paged).

• Contract lines

  • Retrieve contract lines for a contract;

  • Add contract lines to a contract;

  • Delete contract lines for a contract.

• Initial costs

  • Retrieve initial costs for a contract;

  • Add initial costs to a contract;

  • Update initial costs for a contract;

  • Delete initial costs for a contract.

• Files

  • Add a file to a contract.

This enables external systems to fully prepare and structure a residential lease contract before it becomes active.

Non-draft residential lease contracts

For residential lease contracts that are no longer in draft status, the API supports read-only operations:

• Retrieve a specific contract;

• Retrieve contracts (filtered and paged);

• Retrieve real estate objects linked to a contract.

Once a contract is no longer in draft, structural modifications (such as updating contract lines or initial costs) are not supported via this API.

Commercial lease contracts

Commercial lease contracts are used for rental agreements related to commercial real estate objects, such as offices, retail spaces or other business premises.

Draft commercial lease contracts

For commercial lease contracts in draft status, the API supports full lifecycle management, including:

• Core contract management

  • Retrieve a specific contract;

  • Create a new contract;

  • Update an existing contract;

  • Delete a contract;

  • Retrieve contracts (filtered and paged).

• Contract lines

  • Retrieve contract lines for a contract;

  • Add contract lines to a contract;

  • Delete contract lines for a contract.

• Initial costs

  • Retrieve initial costs for a contract;

  • Add initial costs to a contract;

  • Update initial costs for a contract;

  • Delete initial costs for a contract.

• Files

  • Add a file to a contract.

This allows external systems to assemble and configure commercial lease agreements before activation.

Non-draft commercial lease contracts

For commercial lease contracts that are no longer in draft status, the API supports read-only operations:

• Retrieve a specific contract;

• Retrieve contracts (filtered and paged);

• Retrieve real estate objects linked to a contract.

Once a contract is no longer in draft, structural modifications (such as updating contract lines or initial costs) are not supported via this API.

Supplier contracts

Supplier contracts are used for agreements with suppliers, such as service providers or maintenance vendors. These contracts are typically used for managing supplier-related contracts and cost structures.

Non-draft supplier contracts

For non-draft supplier contracts, the API supports:

• Retrieve a specific contract;

• Retrieve contracts (filtered and paged).

Note: Draft supplier contracts do not exist in Bloxs. Therefore, operations for draft supplier contracts are not supported by this API.

Admin settings

The API provides supporting admin endpoints that allow external systems to retrieve available configuration values used when creating or maintaining contracts. These endpoints ensure that external systems can align with Bloxs contract configuration rules.

The admin settings API supports:

• Retrieve a list of initial cost items for concept commercial rent contracts;

• Retrieve a list of line items for concept commercial rent contracts;

• Retrieve a list of commercial rent indexation methods;

• Retrieve a list of commercial rent deposit types;

• Retrieve a list of initial cost items for concept private rent contracts;

• Retrieve a list of line items for concept private rent contracts;

• Retrieve a list of private rent indexation methods;

• Retrieve a list of private rent deposit types;

• Retrieve a list of line items for supplier contracts.

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.