Get all non-removed real estate objects used in the requested general sales contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the general sales contract.
Get real estate objects of a general sales contracts
This endpoint retrieves all non-removed real estate objects linked to a specific general sales contract.
Integrators call this endpoint to see which objects a given "other contract" applies to, for example when a contract covers several properties.
The contract is identified by its internal reference, its external identifier, or both.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the contract, generated by Bloxs. Either reference or externalIdentifier must be provided. If both are given, the contract must match both values. |
externalIdentifier | string | Conditional | External identifier of the contract, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the contract must match both values. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
salesContractReference | string | No | Internal identifier of the contract, generated by Bloxs. Maximum length 100 characters. |
salesContractExternalIdentifier | string | No | External identifier of the contract, as set by the integrating system. Maximum length 100 characters. |
realEstateObjectReference | string | No | Reference of the real estate object subject to the contract. Must be a reference assigned by Bloxs. Maximum length 100 characters. |
startDate | string (date-time) | Yes | Start date of the contract for this object. |
endDate | string (date-time) | No | End date of the contract for this object. Can be left empty. Also used as the date the contract is automatically renewed, when applicable. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK