---
title: "Insert a concept private rent contract"
slug: "preview-insert-a-concept-private-rent-contract"
updated: 2025-11-07T20:01:42Z
published: 2026-02-10T12:51:19Z
---
> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Insert a concept private rent contract
Post/api/v1/contracts/conceptprivaterent
Insert a new concept private rent contract.
**Description**
Insert (add) an concept private rent contract to your existing concept private rent contracts.
Private rent contracts pertains to contracts concerning real estate objects in the private sector. It is generated for each prospect, with the remaining details to be filled in in the Bloxs application. 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.
**Use Case**
The user wants to add a concept of a private rent contract to the Bloxs application. Subsequently the concept contract can be finalised in the Bloxs application.
**Request****fields**
The request contains the following fields:
| Field | Description |
| --- | --- |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| name | The free name field of the contract. Intended as clarification for search purposes. |
| ownerReference | This pertains to the reference of the owner of the object. Please note, a reference must be included here. |
| relationReference | This pertains to the primary tenant who is financially responsible. Please note, a reference must be included here. |
| extraRelations | This pertains to co-tenants. Please note, a reference must be included here |
| startDate | Start date of the contract. |
| endDate | End date of the contract. This may be left blank; otherwise, please fill in the contract end date. This can also be the date on which the contract is automatically renewed. |
| automaticExtends | This indicator indicates whether the contract is subject to automatic renewal. The default value is "false." |
| notifyOnExpiration | With this indicator, the user (not the tenant) can indicate whether they wish to receive a notification when the rental period expires. The default value is "false". |
| notifyOnExpirationMonths | This allows you to specify how many months in advance you wish to receive the notification. The notification refers to a task in the application. The notification will not be sent if the contract has already been renewed. |
| paymentMethod | The payment method. There is no default value. |
| paymentTermInDays | This is the payment term in days, calculated from the start of the rental period. For example, if a tenant begins renting on November 1, the payment term will expire on November 8. The due date is calculated based on this payment term. This field can be left empty in the API, but it must be filled in within Bloxs itself; otherwise, the contract cannot be finalized. |
| invoiceInterval | This field indicates how often an invoice is sent. The invoice will be sent to the tenant's email address. The invoicing process can also be turned off in the application. There is no default value in the API. |
| automaticInvoicingFrom | This field indicates the date from which the Bloxs system will begin the automated invoicing process. It is strongly recommended to set this date to the first day of the month. If the contract starts mid-month, the first invoice will need to be generated manually. Regardless of the selected start date, the invoicing period will be monthly or quarterly. For example, if the user sets October 5 as the start date for automated invoicing, the invoicing period will run from October 5 to November 4, and so forth. The start date must be on or after the contract start date. |
| indexationInfo | Details regarding the indexation that should be applied to this contract can be entered here. |
| indexationMethodName | The method of indexation that should be applied to this specific contract. The available methods consist of a predefined list by Bloxs, which can be customized by the user in the Bloxs application. In order to retrieve the available methods, the following endpoint can be used: [Get a list of private rent indexation methods](/v1-api/apidocs/preview-get-a-list-of-private-rent-indexation-methods)[](https://www.bloxs.io/apidocs/preview-get-a-list-of-private-rent-indexation-methods). Examples of indexation methods are a fixed yearly amount (eg. 2%) or a percentage linked to the inflation numbers. The inflation numbers are automatically processed by Bloxs, the user does not need to upload these numbers manually. |
| nextIndexDate | The next date from which the indexation method will be applied. Further indexations will be applied on an annual basis, starting from the 'nextIndexDate'. For example the nextIndexDate is 2025-01-01. This means subsequent dates for indexation are 2026-01-01, 2027-01-01 etc. |
| indexationUseOverrules | This field indicates if certain overrules should be applied to the chosen indexation method. The following 3 overrules are available: MinimumIndexRate, MaximumIndexRate & IncrementRate. The overrule information entered in one (or multiple) of these 3 fields will only be applied of 'IndexationUseOverrules' has the value 'true'. The default value is false. |
| indexationOverrule_MinimumIndexRate | This overrule will apply a minimum indexation percentage. This will overrule the chosen indexation method. For example, the user wants to use the inflation method for indexation. However, the user does not want the indexation to be less than 2%. In this case this field can be used to enter a minimum indexation percentage. For this scenario the value '0.02' should be entered. The number 1 means 100%. This field should always be used in combination with 'IndexationUseOverrules' value 'true'. |
| indexationOverrule_MaximumIndexRate | This overrule will apply a maximum indexation percentage. This will overrule the chosen indexation method. For example, the user wants to use the inflation method for indexation. However, the user does not want the indexation to be more than 8%. In this case this field can be used to enter a maximum indexation percentage. For this scenario the value '0.08' should be entered. The number 1 means 100%. This field should always be used in combination with 'IndexationUseOverrules' value 'true'. |
| indexationOverrule_IncrementRate | This overrule wil apply a fixed increment rate to the chosen indexation method. The increment rate applies a percentage (+ or -) to the base number. In this example the indexation derived from the indexation method is 5%. If the user wants to always apply an extra 2% on top op de number derived from the indexation method, this can be entered here with the value 0.02. In this case the total indexation would be 7%. The outcome (7%) can still be overruled by the MinimumIndexRate or the MaximumIndexRate in case the value is not within the min/max range. This field should always be used in combination with 'IndexationUseOverrules' value 'true'. |
| sendInvoices | Boolean indicating whether invoices should be send. Default value is false. |
| extraInvoiceText | Extra text that can be added on the invoice. For example the number of the contract, relation number or other client/contract specific details. |
| remarks | General remarks field for the user. The content of this field is not included on the actual invoice. |
| noticePeriod | Notice period of the contract specified in months. This is relevant if automatic extension applies to this contract (automaticExtends = true). |
| depositTypeName | This field indicates the type of deposit that applies to this contract. Bloxs provides a standard list with deposit types. The user can edit this list in the Bloxs application, through the API this is not possible. In order to retrieve the full list of available deposit types, the following endpoint can be used: [Get a list of private rent deposit types](/v1-api/apidocs/preview-get-a-list-of-private-rent-deposit-types).[](https://www.bloxs.io/apidocs/preview-get-a-list-of-private-rent-deposit-types) |
| depositAmount | The amount of the deposit. Decimals are point separated. |
| contractRealEstateObjects | The reference of the real estate object(s) which is (are) the subject of this contract. Please note, a reference must be included here. If the contract contains multiple real estate objects, an array of reference can be entered here. |
| extensionPeriods.numberOfMonths | Number of months by which the contract is automatically renewed. If a contract is renewed every six months, set `"automaticExtends"` to `"true"` and `"extensionPeriods.numberOfMonths"` to `6`. |
| doNotTakeOverTheoreticalRent | A user can input in Bloxs the theoretical rental income expected for the property. This boolean allows the user to deviate from that amount. The default value is "false," in which case the theoretical rent is applied. Reasons for deviation might include cases where the property is part of an apartment complex with certain units that differ due to ground-floor location and a garden. |
| doNotTakeOverInitialCosts | A user can input in Bloxs the theoretical initial costs expected to be charged for the property. This boolean allows the user to deviate from that amount. The default value is "false," in which case the theoretical initial costs are applied. Reasons for deviation might include cases where the property is part of an apartment complex with certain units that differ due to ground-floor location and a garden. These units may, for example, require extra keys for the garden door. |
SecurityHTTPType Bearer
Please enter a valid token
Body parametersExpand Allobject externalIdentifierstring RequiredMin length0Max length100
namestring | null Min length0Max length256
ownerReferencestring RequiredMin length1
relationReferencestring | null
extraRelations Array of string | null string
startDatestring (date)
endDatestring (date) | null
automaticExtendsboolean
notifyOnExpirationboolean
notifyOnExpirationMonthsinteger (int32) | null Minimum1Maximum9999
paymentMethodinteger (int32) | null Valid values[
1,
2
]
paymentTermInDaysinteger (int32) | null
invoiceIntervalinteger (int32) | null Valid values[
1,
3,
6,
12
]
automaticInvoicingFromstring (date) | null
indexationInfoobject (SalesContractIndexationInfoAPIModel) indexationMethodNamestring RequiredMin length1
nextIndexDatestring (date) Required
indexationUseOverrulesboolean Required
indexationOverrule_MinimumIndexRatenumber (double) | null RequiredMinimum-1Maximum1
indexationOverrule_MaximumIndexRatenumber (double) | null RequiredMinimum-1Maximum1
indexationOverrule_IncrementRatenumber (double) | null RequiredMinimum-1Maximum1
sendInvoicesboolean
extraInvoiceTextstring | null
remarksstring | null
noticePeriodinteger (int32) | null
depositTypeNamestring | null
depositAmountnumber (double) | null
contractRealEstateObjects Array of string Requiredstring
extensionPeriods Array of object (ConceptContractExtensionPeriod) | null object numberOfMonthsinteger (int32) | null Minimum1Maximum9999
doNotTakeOverTheoreticalRentboolean
doNotTakeOverInitialCostsboolean
Responses200
A concept private rent contract was created
Expand Allobject externalIdentifierstring | null
namestring | null
ownerReferencestring | null
relationReferencestring | null
extraRelations Array of string | null string
startDatestring (date) | null
endDatestring (date) | null
automaticExtendsboolean
notifyOnExpirationboolean
notifyOnExpirationMonthsinteger (int32) | null Minimum1Maximum9999
paymentMethodinteger (int32) | null Valid values[
1,
2
]
ownerBankAccountstring | null
paymentTermInDaysinteger (int32) | null
invoiceIntervalinteger (int32) | null Valid values[
1,
3,
6,
12
]
automaticInvoicingFromstring (date) | null
indexationInfoobject (SalesContractIndexationInfoAPIModel) indexationMethodNamestring Min length1
nextIndexDatestring (date)
indexationUseOverrulesboolean
indexationOverrule_MinimumIndexRatenumber (double) | null Minimum-1Maximum1
indexationOverrule_MaximumIndexRatenumber (double) | null Minimum-1Maximum1
indexationOverrule_IncrementRatenumber (double) | null Minimum-1Maximum1
sendInvoicesboolean
extraInvoiceTextstring | null
remarksstring | null
noticePeriodinteger (int32) | null
depositTypeNamestring | null
depositAmountnumber (double) | null
contractRealEstateObjects Array of string | null string
extensionPeriods Array of object (ConceptContractExtensionPeriod) | null object numberOfMonthsinteger (int32) | null Minimum1Maximum9999
400
The concept private rent contract data has validation issues
Expand Allobject typestring | null
titlestring | null
traceIdstring | null
statusinteger (int32)
errorsobject | null property* Array of string | null additionalPropertiesstring