[PREVIEW] 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.
Description
Retrieve the information currently known in the Bloxs database about a certain finalised commercial rent contract. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.
Commercial rent contracts concern the finalised contracts, which is essentially different from the 'ConceptCommercialRent' endpoints which relate to the concept contracts. Commercial rent contracts pertains to contracts concerning stores, offices, and commercial spaces (commercial real estate).
Please note that it is currently not possible to finalise a contract through the Bloxs api's. If a concept rent contract is created using the POST operation, it will first need to be finalised in the Bloxs application before it can be retrieved through this GET operation.
Use Case
Upon finalising the contract in the Bloxs application, the user wants to retrieve the most important details of the contract in a third party application.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | The reference of the contract as generated by Bloxs. |
| externalIdentifier | The unique identifier of the contract within the system of the requesting party. This identifier is not generated by the Bloxs system. |
Response fields
The 200 response contains the fields in the table below. For the GET operation it gives an up-to-date insight in the data that is currently registered in Bloxs.
| Field | Description |
|---|---|
| reference | The reference of the contract as generated by Bloxs. |
| externalIdentifier | The unique identifier of the contract within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| ownerReference | This pertains to the reference of the owner of the object which is subject of the contract. Please note, a reference assigned by Bloxs must be included here. |
| relationReference | This pertains to the primary tenant who is financially responsible. Please note, a reference assigned by Bloxs must be included here. |
| extraRelationReferences | This pertains to co-tenants. Please note, a reference assigned by Bloxs 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 field indicates whether the contract is subject to automatic renewal. The default value is "false." |
| noticeDate | The latest date by which the contract can be cancelled, before an automatic extension is activated. This is true only if 'automaticExtends' = true. This date is automatically calculated by Bloxs based on the 'noticePeriod' & 'endDate' of the contract. If 'endDate' is left empty, noticeDate will not be calculated and therefore be left empty. |
| noticePeriod | Notice period of the contract specified in months. This is relevant if automatic extension applies to this contract (automaticExtends = true). |
| lastModified | Timestamp of the last modification in Bloxs. |
Please enter a valid token
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.