Add an initial cost with the amount for concept private rent contracts.
Add an initial cost for concept private rent contracts
Adds an initial cost to a concept residential lease contract.
Initial costs are one-time charges billed to the tenant at the start of the lease, such as a key deposit or nameplates, as distinct from the recurring contract lines.
A developer calls this endpoint while assembling a draft contract's initial charges, before the contract is finalized.
The cost 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 cost 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 initial cost applies to. Must be one of the real estate objects already linked to the contract. Minimum length 1 character. |
initialCostsItemName | string | Yes | The name of the initial cost item type, for example a key deposit or nameplates. A separate lookup endpoint returns the full list of available initial cost item names for concept residential lease contracts. Maximum length 256 characters. |
amountExcl | number (double) | Yes | The amount of the initial cost, excluding VAT. Decimals are separated with a period, for example 45.00. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The external identifier of the concept residential lease contract that this initial cost belongs to. |
objectReference | string | No | The reference of the real estate object linked to this initial cost. |
initialCostsItemName | string | Yes | The name of the initial cost item type, for example a key deposit or nameplates. Maximum length 256 characters. |
amountExcl | number (double) | Yes | The amount of the initial cost, excluding VAT. Decimals are separated with a period, for example 45.00. |
amountVAT | number (double) | Yes | The VAT amount of the initial cost, calculated from the 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 initial cost, including VAT, calculated from amountExcl and amountVAT. Decimals are separated with a period. |
OK