Get a list of contract lines for concept private rent contracts.
Get a list of contract lines for concept private rent contracts
Retrieves the contract lines registered for a concept residential lease contract.
A contract line represents an individual cost item in the draft agreement, such as base rent, an additional cost, or a discount (which are negative amounts), before the contract is finalized and invoicing starts.
A developer calls this endpoint to review the lines already registered on a concept contract, for example to check current amounts before adding a new line, updating one, or preparing the contract for signing. Results can be scoped to a single real estate object when the contract covers more than one object.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
ContractExternalIdentifier | string | Yes | The external identifier of the concept residential lease contract. This identifier is assigned by the requesting party, not generated by Bloxs. |
ObjectReference | string | No | The reference of a real estate object linked to the contract. When supplied, the response is limited to contract lines associated with that object. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The external identifier of the concept residential lease contract that this line belongs to. |
objectReference | string | No | The reference of the real estate object linked to this contract line. Empty when the line applies to the contract as a whole rather than to one specific object. |
lineItemName | string | Yes | The name of the contract line item type, for example base rent or a discount. A separate lookup endpoint returns the full list of available line item names for concept residential lease contracts. Maximum length 256 characters. |
description | string | No | Free text describing the contract line. Appears on the invoice generated from this line. Maximum length 512 characters. |
amountExcl | number (double) | Yes | The amount of the contract line, excluding VAT. Decimals are separated with a period, for example 750.00. |
amountVAT | number (double) | Yes | The VAT amount of the contract line. This is the VAT amount itself, not a VAT rate percentage. Decimals are separated with a period. |
amountIncl | number (double) | Yes | The amount of the contract line, including VAT. Decimals are separated with a period. |
startDate | string (date) | No | The date from which the contract line applies. ISO 8601 date format, for example 2026-01-01. |
endDate | string (date) | No | The date until which the contract line applies. ISO 8601 date format, for example 2026-12-31. Empty when the line has no defined end date. |
The external API identifier of the contract.
The reference id of the real estate object.
OK