Concept Sales Contracts API Documentation

Welcome to the Concept Sales Contracts API documentation. This API allows you to perform CRUD operations on commercial- and private rent concept contracts. It is important to emphasise that this API only can be used for concept contracts. This is especially useful when the contracting is still in the commercial phase, and therefore no finalised contract is necessary yet. Moreover it is useful when not all properties of the contract are known yet. With a concept contract the majority of the properties are optional, whereas with a finalised contract they are compulsory. Another API will be made available shortly to finalise contracts as well.The draft contract can (optionally) be signed digitally. Once signed, the first invoice can be issued immediately. Please note that the concept contract is not a template; it is a draft with only one mandatory field.

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 concept contract types:

• Commercial rent: Commercial rent contracts pertains to contracts concerning stores, offices, and commercial spaces (commercial real estate).
• Private rent: Private rent contracts pertains to contracts concerning real estate objects in the private sector.

For each concept contract type, the following operations are available:

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

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

• PATCH: Apply partial updates.

Thank you for choosing our API.