Get all contract lines used in the requested supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the contract lines of the supplier contract.
Get contract lines of a supplier contracts
This endpoint retrieves all contract lines used in a finalised supplier contract.
A contract line represents an individual invoiced term of the agreement, for example a recurring service cost, linked to the real estate object it applies to.
A developer calls this endpoint to read the full cost build-up of a finalised supplier contract, for example to reconcile invoicing terms in 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 |
|---|---|---|---|
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. |
contractLineItemName | string | No | The name of the contract line item. Maximum length 256 characters. |
realEstateObjectReference | string | No | The reference of the real estate object linked to the contract line, as generated by Bloxs. Maximum length 100 characters. |
startDate | string (date) | Yes | Start date of the contract line. ISO 8601 date format. |
endDate | string (date) | No | End date of the contract line. May be left empty if there is no fixed end date. ISO 8601 date format. |
isStarted | boolean | Yes | Whether the contract line's start date has passed. |
isEnded | boolean | Yes | Whether the contract line's end date has passed. |
description | string | No | Free-text description of the contract line, printed on the invoice. Maximum length 512 characters. |
taxRateCode | string | No | The code of the VAT rate applied to the contract line. Maximum length 100 characters. |
amountExcl | number (double) | No | Amount of the contract line, excluding VAT. Decimals use a period as separator. |
amountVAT | number (double) | No | VAT amount of the contract line. Decimals use a period as separator. |
amountIncl | number (double) | No | Amount of the contract line, including VAT. Decimals use a period as separator. |
amountPercentage | number (double) | No | Percentage used to calculate the contract line's amount, where the line is based on a percentage rather than a fixed amount. |
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