Get an existing commercial rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the commercial rent contract.
Get a commercial rent contract
This endpoint retrieves an existing, finalised commercial lease contract from Bloxs.
A developer calls this endpoint once a contract has been finalised in the Bloxs application, to read back its key terms into a third party system.
This endpoint applies only to finalised contracts, not to concept commercial lease contracts, and Bloxs currently offers no API operation to finalise a contract.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | No | The reference of the contract as generated by Bloxs. Either reference or externalIdentifier must be given. If both are given, both must match the same contract. Passed as a query parameter. |
externalIdentifier | string | No | The identifier of the contract within the system of the requesting party. This identifier is not generated by Bloxs. Either reference or externalIdentifier must be given. Passed as a query parameter. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | No | The reference of the contract as generated by Bloxs. Maximum length 100 characters. |
externalIdentifier | string | No | The identifier of the contract within the system of the requesting party. Maximum length 100 characters. |
ownerReference | string | No | The reference of the owner of the real estate object covered by the contract, as generated by Bloxs. Maximum length 100 characters. |
relationReference | string | No | The reference of the primary tenant who is financially responsible for the contract, as generated by Bloxs. Maximum length 100 characters. |
extraRelationReferences | string | No | The references of co-tenants on the contract, as generated by Bloxs. Maximum length 100 characters. |
startDate | string (date-time) | Yes | Start date of the contract. ISO 8601 format. |
endDate | string (date-time) | No | End date of the contract, or the date the contract automatically renews on. May be left empty if the contract has no fixed end date. ISO 8601 format. |
automaticExtends | boolean | Yes | Whether the contract automatically renews at its end date. Default value false. |
noticeDate | string (date-time) | No | The latest date on which the contract can be cancelled before automatic renewal takes effect. Only relevant when automaticExtends is true. Calculated by Bloxs from noticePeriod and endDate, and left empty if endDate is empty. ISO 8601 format. |
noticePeriod | integer (int32) | No | Notice period of the contract in months. Relevant when automaticExtends is true. |
lastModified | string (date-time) | Yes | Timestamp of the last modification of the contract in Bloxs. ISO 8601 format. |
depositTypeName | string | No | The name of the deposit type applied to the contract. Maximum length 256 characters. |
depositAmount | number (double) | No | The deposit amount held for the contract. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested commercial rent contract was not found.