Get all contract lines used in the requested private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the contract lines of the private rent contract.
Get contract lines of a private rent contracts
Retrieves all contract lines used in a finalized residential lease contract.
A contract line represents a cost item on the contract, such as base rent, additional costs, or a discount (a discount has a negative amount).
A developer calls this endpoint to review the charges that currently make up a finalized contract, for example when reconciling invoiced amounts.
Either the contract's reference or its external identifier must be supplied to identify the contract.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | No | The reference of the residential lease contract, as generated by Bloxs. |
externalIdentifier | string | No | The external identifier of the residential lease contract, assigned by the requesting party. This identifier is not generated by Bloxs. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
salesContractReference | string | No | The reference of the residential lease contract that this line belongs to, as generated by Bloxs. Maximum length 100 characters. |
salesContractExternalIdentifier | string | No | The external identifier of the residential lease contract that this line belongs to, assigned by the requesting party. Maximum length 100 characters. |
contractLineItemName | string | No | The name of the contract line item type, for example base rent or a discount. Maximum length 256 characters. |
realEstateObjectReference | string | No | The reference of the real estate object that the contract line applies to. Maximum length 100 characters. |
startDate | string (date) | Yes | The date from which this contract line applies. ISO 8601 date format. |
endDate | string (date) | No | The date until which this contract line applies. Empty when no end date applies. ISO 8601 date format. |
isStarted | boolean | Yes | Whether the contract line's start date has already passed. |
isEnded | boolean | Yes | Whether the contract line's end date has already passed. |
description | string | No | Free text describing the contract line. Maximum length 512 characters. |
invoiceInterval | integer (int32) | Yes | The invoicing frequency that applied to this contract line for its period. Stored per line because the contract-level invoicing frequency can change over time, allowing the historical frequency for each period to be retrieved. Allowed values are 1 (month), 3 (quarter), 6 (half year), and 12 (year). |
taxRateCode | string | No | The code of the tax rate applied to the contract line. Maximum length 100 characters. |
amountExcl | number (double) | Yes | The amount of the contract line, excluding VAT. Decimals are separated with a period. |
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. |
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