Get a list of contract lines for concept commercial rent contracts.
Get a list of contract lines for concept commercial rent contracts
This endpoint retrieves the contract lines belonging to a concept commercial lease contract.
A contract line represents an individual term of the agreement, such as rent, furniture or a rent discount, and forms the theoretical rent build-up for the draft contract.
A developer calls this endpoint to review the terms already registered for a draft contract before adding, changing or removing lines through the related endpoints.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The identifier assigned to the contract by the calling system. This identifier is not generated by Bloxs. Passed as a query parameter. |
objectReference | string | No | The reference of the real estate object linked to the contract line. Must match a reference already registered on this contract. Passed as a query parameter. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The identifier assigned to the contract by the calling system. Minimum length 1. |
objectReference | string | No | The reference of the real estate object linked to the contract line. |
lineItemName | string | Yes | The name of the contract line item, for example rent, furniture or a discount. Maximum length 256 characters. |
description | string | No | Free-text description of the contract line, printed on the invoice. Maximum length 512 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. |
startDate | string (date) | No | Start date of the contract line. ISO 8601 date format. |
endDate | string (date) | No | End date of the contract line. ISO 8601 date format. |
The external API identifier of the contract.
The reference id of the real estate object.
OK