Add a contract line with the amount for concept private rent contracts.
Add a contract line with the amount for concept private rent contracts
Adds a contract line to a concept residential lease contract.
A contract line represents a cost item charged to the tenant, such as base rent, furniture, or a rent discount (discount is recorded as a negative amount).
A developer calls this endpoint while building up a draft contract, before it is signed and the first invoice is generated.
The line is always attached to one specific real estate object within the contract, so both the contract's external identifier and the object reference must be supplied together.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The external identifier of the concept residential lease contract to add the line to. Minimum length 1 character. Assigned by the requesting party, not generated by Bloxs. |
objectReference | string | Yes | The reference of the real estate object that the contract line applies to. Must be one of the real estate objects already linked to the contract. Minimum length 1 character. |
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. |
amountExcl | number (double) | Yes | The amount of the contract line, excluding VAT. Decimals are separated with a period, for example 750.00. |
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. Leave empty when the line has no defined end date. |
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. |
lineItemName | string | Yes | The name of the contract line item type, for example base rent or a discount. 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, calculated from the line item's tax rate. 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, calculated from amountExcl and amountVAT. 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. |
OK