Get a list of initial costs for concept private rent contracts.
Get a list of initial costs for concept private rent contracts
Retrieves the initial costs currently registered for 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 to review which initial costs are already registered, for example before adding a new one or updating an existing amount.
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. 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 initial costs associated with that object. |
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. Empty when the cost applies to the contract as a whole rather than to one specific object. |
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. |
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. Decimals are separated with a period. |
The external API identifier of the contract.
The reference id of the real estate object.
OK