This endpoint creates a new draft residential lease contract in Bloxs.
Integrators call it to register a prospect's contract details before the lease is finalized in the Bloxs application, since finalization itself is not possible through the API.
The contract is identified by an externalIdentifier assigned by the integrating system, since Bloxs does not generate its own reference until the contract is finalized.
Only externalIdentifier, ownerReference and contractRealEstateObjects are mandatory, every other field can be completed later directly in Bloxs.
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | Yes | Identifier of the concept contract within the integrating system's own system. Not generated by Bloxs. Maximum length 100 characters. |
name | string | No | Free-text name of the contract, intended to help with search. Maximum length 256 characters. |
ownerReference | string | Yes | Reference of the owner of the object subject to the contract. Must be a reference assigned by Bloxs. |
relationReference | string | No | Reference of the primary tenant who is financially responsible for the contract. |
extraRelations | array of string | No | References of co-tenants on the contract. |
startDate | string (date) | No | Start date of the contract. ISO 8601 format, for example 2026-09-01. |
endDate | string (date) | No | End date of the contract, if set. ISO 8601 format. Also used as the date the contract automatically renews, when applicable. |
automaticExtends | boolean | No | Indicates whether the contract renews automatically. Default value is false. |
notifyOnExpiration | boolean | No | Indicates whether the user, not the tenant, should be notified when the rental period expires. Default value is false. |
notifyOnExpirationMonths | integer | No | Number of months in advance the expiration notification is triggered, as a task in the Bloxs application. Minimum 1, maximum 9999. |
paymentMethod | integer | No | Payment method for the contract. Valid values are 1 (Direct Debit) or 2 (Bank Transfer). |
paymentTermInDays | integer | No | Payment term in days, calculated from the start of the rental period. Must be filled in within Bloxs before the contract can be finalized, even if left empty here. |
invoiceInterval | integer | No | Billing frequency. Valid values are 1 (monthly), 3 (quarterly), 6 (semi-annual) or 12 (annual). No other values are valid. |
automaticInvoicingFrom | string (date) | No | Date from which automated invoicing begins. ISO 8601 format. Recommended to set to the first of a month. If the contract starts mid-month, the first invoice must be generated manually. Must be on or after the contract start date. |
indexationInfo.indexationMethodName | string | Yes (within indexationInfo) | Indexation method applied to the contract, for example a fixed yearly percentage or a rate linked to inflation figures processed automatically by Bloxs. Values are configurable in the Bloxs application. |
indexationInfo.nextIndexDate | string (date) | Yes (within indexationInfo) | Next date the indexation method is applied. ISO 8601 format. Subsequent indexations follow annually from this date. |
indexationInfo.indexationUseOverrules | boolean | Yes (within indexationInfo) | Indicates whether the minimum, maximum or increment overrules below should be applied to the indexation method. Default value is false. |
indexationInfo.indexationOverrule_MinimumIndexRate | number (double) | Yes (within indexationInfo) | Minimum indexation rate applied regardless of the underlying method's outcome. 1 equals 100%. Must be included in the request body, though its value can be null. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1. |
indexationInfo.indexationOverrule_MaximumIndexRate | number (double) | Yes (within indexationInfo) | Maximum indexation rate applied regardless of the underlying method's outcome. 1 equals 100%. Must be included in the request body, though its value can be null. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1. |
indexationInfo.indexationOverrule_IncrementRate | number (double) | Yes (within indexationInfo) | Fixed additional rate applied on top of the method's outcome, for example 0.02 to add 2 percentage points. Can still be bounded by the minimum and maximum overrules. Must be included in the request body, though its value can be null. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1. |
sendInvoices | boolean | No | Indicates whether invoices should be sent. Default value is false. |
extraInvoiceText | string | No | Extra text to add to the invoice, for example the contract or relation number. |
remarks | string | No | Free text remarks for internal use. Not included on the invoice. |
noticePeriod | integer | No | Notice period of the contract, in months. Relevant when automaticExtends is true. |
depositTypeName | string | No | Type of deposit applying to the contract. Values are configurable in the Bloxs application and cannot be managed through the API. |
depositAmount | number (double) | No | Deposit amount. Decimals are separated with a period. |
contractRealEstateObjects | array of string | Yes | References of the real estate object or objects subject to the contract. |
extensionPeriods | array of object | No | Automatic renewal periods for the contract. |
extensionPeriods.numberOfMonths | integer | No | Number of months the contract is automatically renewed for, when automaticExtends is true, for example 6 for a contract that renews every six months. Minimum 1, maximum 9999. |
doNotTakeOverTheoreticalRent | boolean | No | Indicates whether to deviate from the real estate object's theoretical rent value, for example when a unit differs from others in the same complex, such as a ground floor unit with a garden. Default value is false, meaning the theoretical rent is applied. |
doNotTakeOverInitialCosts | boolean | No | Indicates whether to deviate from the real estate object's theoretical initial costs, for example when a unit requires extra keys not shared by others in the complex. Default value is false, meaning the theoretical initial costs are applied. |
copyAddressToTenant | boolean | No | Indicates whether the address of the real estate object is copied to the tenant as their contact address. Default value is false. |
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | No | Identifier of the concept contract within the integrating system's own system. Not generated by Bloxs. |
name | string | No | Free-text name of the contract, intended to help with search. |
ownerReference | string | No | Reference of the owner of the object subject to the contract. Must be a reference assigned by Bloxs. |
relationReference | string | No | Reference of the primary tenant who is financially responsible for the contract. |
extraRelations | array of string | No | References of co-tenants on the contract. |
startDate | string (date) | No | Start date of the contract. ISO 8601 format, for example 2026-09-01. |
endDate | string (date) | No | End date of the contract, if set. ISO 8601 format. Also used as the date the contract automatically renews, when applicable. |
automaticExtends | boolean | No | Indicates whether the contract renews automatically. Default value is false. |
notifyOnExpiration | boolean | No | Indicates whether the user, not the tenant, should be notified when the rental period expires. Default value is false. |
notifyOnExpirationMonths | integer | No | Number of months in advance the expiration notification is triggered, as a task in the Bloxs application. Not sent if the contract has already been renewed. Minimum 1, maximum 9999. |
copyAddressToTenant | boolean | No | Indicates whether the address of the real estate object is copied to the tenant as their contact address. Default value is false. |
paymentMethod | integer | No | Payment method for the contract. Valid values are 1 (Direct Debit) or 2 (Bank Transfer). |
ownerBankAccount | string | No | IBAN the rent amount should be transferred to. Not settable through this request, populated by Bloxs. |
paymentTermInDays | integer | No | Payment term in days, calculated from the start of the rental period. Must be filled in within Bloxs before the contract can be finalized, even if left empty here. |
invoiceInterval | integer | No | Billing frequency. Valid values are 1 (monthly), 3 (quarterly), 6 (semi-annual) or 12 (annual). No other values are valid. |
automaticInvoicingFrom | string (date) | No | Date from which automated invoicing begins. ISO 8601 format. Recommended to set to the first of a month. If the contract starts mid-month, the first invoice must be generated manually. Must be on or after the contract start date. |
indexationInfo.indexationMethodName | string | No | Indexation method applied to the contract, for example a fixed yearly percentage or a rate linked to inflation figures processed automatically by Bloxs. Values are configurable in the Bloxs application. |
indexationInfo.nextIndexDate | string (date) | No | Next date the indexation method is applied. ISO 8601 format. Subsequent indexations follow annually from this date. |
indexationInfo.indexationUseOverrules | boolean | No | Indicates whether the minimum, maximum or increment overrules below should be applied to the indexation method. Default value is false. |
indexationInfo.indexationOverrule_MinimumIndexRate | number (double) | No | Minimum indexation rate applied regardless of the underlying method's outcome. 1 equals 100%. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1. |
indexationInfo.indexationOverrule_MaximumIndexRate | number (double) | No | Maximum indexation rate applied regardless of the underlying method's outcome. 1 equals 100%. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1. |
indexationInfo.indexationOverrule_IncrementRate | number (double) | No | Fixed additional rate applied on top of the method's outcome, for example 0.02 to add 2 percentage points. Can still be bounded by the minimum and maximum overrules. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1. |
sendInvoices | boolean | No | Indicates whether invoices should be sent. Default value is false. |
extraInvoiceText | string | No | Extra text to add to the invoice, for example the contract or relation number. |
remarks | string | No | Free text remarks for internal use. Not included on the invoice. |
noticePeriod | integer | No | Notice period of the contract, in months. Relevant when automaticExtends is true. |
depositTypeName | string | No | Type of deposit applying to the contract. Values are configurable in the Bloxs application and cannot be managed through the API. |
depositAmount | number (double) | No | Deposit amount. Decimals are separated with a period. |
contractRealEstateObjects | array of string | No | References of the real estate object or objects subject to the contract. |
extensionPeriods | array of object | No | Automatic renewal periods for the contract. |
extensionPeriods.numberOfMonths | integer | No | Number of months the contract is automatically renewed for, when automaticExtends is true, for example 6 for a contract that renews every six months. Minimum 1, maximum 9999. |