> ## 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.
# Get real estate objects of a commercial rent contracts
> Get all non-removed real estate objects used in the requested commercial rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the commercial rent contract.
## OpenAPI
````json GET /api/v1/contracts/commercialrent/realestateobjects
{
"openapi": "3.0.4",
"info": {
"title": "Concept SalesContracts V1",
"description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "CommercialRentContracts"
},
{
"name": "Concept CommercialRent"
},
{
"name": "Concept PrivateRent"
},
{
"name": "GeneralSalesContracts"
},
{
"name": "Metadata"
},
{
"name": "PrivateRentContracts"
},
{
"name": "SupplierContracts"
}
],
"paths": {
"/api/v1/contracts/commercialrent/realestateobjects": {
"get": {
"tags": [
"CommercialRentContracts"
],
"summary": "Get real estate objects of a commercial rent contracts",
"description": "Get all non-removed real estate objects used in the requested commercial rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the commercial rent contract.",
"operationId": "GetCommercialRentContractRealEstateObjects",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SalesContractRealEstateObject"
}
}
}
}
}
},
"x-d360-narrative-url": "Get real estate objects of a commercial rent contracts
This endpoint retrieves the real estate objects currently linked to a finalised commercial lease contract, excluding any objects that have since been removed from the contract.
A developer calls this endpoint to find out which stores, offices or other commercial spaces are covered by a specific finalised 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 are used to find the 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 |
|---|
salesContractReference | string | No | The reference of the contract as generated by Bloxs. Maximum length 100 characters. |
salesContractExternalIdentifier | string | No | The identifier of the contract within the system of the requesting party. Maximum length 100 characters. |
realEstateObjectReference | string | No | The reference of the real estate object linked to the contract, as generated by Bloxs. Maximum length 100 characters. |
startDate | string (date-time) | Yes | The date from which the real estate object is linked to the contract. ISO 8601 format. |
endDate | string (date-time) | No | The date on which the real estate object is unlinked from the contract, or the date the contract automatically renews on. May be left empty if there is no fixed end date. ISO 8601 format. |