Get all contract lines 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 contract lines of the commercial rent contract.
Get contract lines of a commercial rent contracts
This endpoint retrieves all contract lines used in a finalised commercial lease contract.
A contract line represents an individual invoiced term of the agreement, such as rent, with its own invoicing interval, VAT rate and amount.
A developer calls this endpoint to read the full rent build-up of a finalised 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. 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. |
contractLineItemName | string | No | The name of the contract line item, for example rent, furniture or a discount. 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. |
invoiceInterval | integer (int32) | Yes | The interval at which the contract line is invoiced. Allowed values: 1 (month), 3 (quarter), 6 (half year), 12 (year). |
taxRateCode | string | No | The code of the VAT rate applied to the contract line. Maximum length 100 characters. |
amountExcl | number (double) | Yes | Amount of the contract line, excluding VAT. Decimals use a period as separator. |
amountVAT | number (double) | Yes | VAT amount of the contract line. Decimals use a period as separator. |
amountIncl | number (double) | Yes | Amount of the contract line, including VAT. Decimals use a period as separator. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
Month = 1 Quarter = 3 HalfYear = 6 Year = 12