Get all non-removed real estate objects used in the requested supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the supplier contract.
Get real estate objects of a supplier contracts
This endpoint retrieves the real estate objects currently linked to a finalised supplier contract, excluding any objects that have since been removed from the contract.
A developer calls this endpoint to find out which real estate objects are covered by a specific finalised supplier contract, for example to check which properties a security or maintenance agreement applies to.
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. When reference is given, relationReference must also be given. Passed as a query parameter. |
relationReference | string | No | The reference of the supplier the contract belongs to. Required when reference is given. Maximum length 100 characters. 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 |
|---|---|---|---|
purchaseContractReference | string | No | The reference of the contract as generated by Bloxs. Maximum length 100 characters. |
purchaseContractExternalIdentifier | 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. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model). When given 'relationReference' should also be given
The internal identifier of the contract's relation. Required when 'reference' is given.
The external API identifier of the model.
OK