Get an existing concept commercial rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the concept commercial rent contract.
Get a concept commercial rent contract
Retrieves an existing concept commercial lease contract by its externalIdentifier.
A developer calls this endpoint to check the current values stored in Bloxs before updating a concept contract, for example to see which properties still need to be corrected.
This endpoint can only be used to retrieve a concept contract before it is finalized in the Bloxs application.
Concept contracts are identified only by externalIdentifier. Unlike finalized contracts, there is no Bloxs-generated reference field until the contract is finalized in the Bloxs application.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | Yes | Unique identifier of the concept commercial lease contract in the requesting system, passed as a query parameter. Bloxs does not generate this value. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | No | Unique identifier of the concept commercial lease contract in the requesting system. |
name | string | No | Free-text name of the contract. |
ownerReference | string | No | Reference of the owner, meaning the administration, associated with the real estate object in this contract. |
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 lease. ISO 8601 date format. |
endDate | string (date) | No | End date of the lease. ISO 8601 date format. |
automaticExtends | boolean | No | Indicates whether the contract renews automatically at the end of its term. |
notifyOnExpiration | boolean | No | Indicates whether the property manager receives a notification task when the lease is due to expire. |
notifyOnExpirationMonths | integer | No | Number of months before expiration at which the notification task is created. |
paymentMethod | integer | No | Payment method for the contract. Allowed values: 1 (Direct debit), 2 (Bank transfer). |
copyAddressToTenant | boolean | No | Indicates whether the property address is copied to the tenant's contact record. |
ownerBankAccount | string | No | Bank account of the owner used for this contract. |
paymentTermInDays | integer | No | Payment term in days, calculated from the start of the rental period. |
invoiceInterval | integer | No | Frequency at which invoices are sent to the tenant. Allowed values: 1 (Month), 3 (Quarter), 6 (Half year), 12 (Year). |
automaticInvoicingFrom | string (date) | No | Date from which automated invoicing starts. ISO 8601 date format. |
indexationInfo | object | No | Indexation settings applied to the contract. |
indexationInfo.indexationMethodName | string | No | Name of the indexation method applied to the contract. |
indexationInfo.nextIndexDate | string (date) | No | Date from which the indexation method is first applied. ISO 8601 date format. |
indexationInfo.indexationUseOverrules | boolean | No | Indicates whether the overrule fields below are applied. |
indexationInfo.indexationOverrule_MinimumIndexRate | number | No | Minimum indexation rate applied instead of the outcome of the indexation method. Decimal fraction where 1 equals 100 percent. |
indexationInfo.indexationOverrule_MaximumIndexRate | number | No | Maximum indexation rate applied instead of the outcome of the indexation method. Decimal fraction where 1 equals 100 percent. |
indexationInfo.indexationOverrule_IncrementRate | number | No | Fixed increment applied on top of the rate produced by the indexation method. Decimal fraction. |
indexationInfo.useGraduatedScaleIndexation | boolean | No | Indicates whether graduated scales are used to calculate the indexation rate instead of a single rate. |
indexationInfo.graduatedScaleIndexationLines | array of object | No | Graduated scale lines used to calculate the indexation rate. |
indexationInfo.graduatedScaleIndexationLines.fromPercentage | number | No | Inflation percentage from which the appliedPercentage in this line takes effect. Decimal fraction between 0 and 1. |
indexationInfo.graduatedScaleIndexationLines.appliedPercentage | number | No | Share of the inflation within this scale that is included in the indexation. Decimal fraction between 0 and 1. |
sendInvoices | boolean | No | Indicates whether invoices are sent to the tenant. |
extraInvoiceText | string | No | Additional text included on the invoice. |
remarks | string | No | Free-text remarks for internal use. |
noticePeriod | integer | No | Notice period of the contract, in months. |
depositTypeName | string | No | Name of the deposit type that applies to this contract. |
depositAmount | number | No | Amount of the deposit for this contract. |
contractRealEstateObjects | array of string | No | References of the real estate object or objects covered by the contract. |
extensionPeriods | array of object | No | Renewal periods applied when automaticExtends is true. |
extensionPeriods.numberOfMonths | integer | No | Number of months by which the contract renews each time. |
breakOption | string (date) | No | Date on which either party can terminate the contract early. ISO 8601 date format. |
The external API identifier of the model.
OK
DirectDebit = 1 BankTransfer = 2
Month = 1 Quarter = 3 HalfYear = 6 Year = 12
The requested concept commercial rent contract was not found.