Get an existing supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the supplier contract.
Get a supplier contract
This endpoint retrieves an existing, finalised supplier contract from Bloxs, for example a contract for the regular servicing of heating and ventilation systems in rental properties.
A developer calls this endpoint to read the key terms of a specific finalised supplier contract into a third party system.
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 |
|---|---|---|---|
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 supplier the contract belongs to. This is the same relation reference used across persons, organisations, suppliers, estate agents, financiers and owners in 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. |
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
The requested supplier contract was not found.