Update an initial cost for concept private rent contract.
Update an initial cost for concept private rent contract
Updates an existing initial cost on a concept residential lease contract.
Use this endpoint to correct or change the amount of an initial cost that was already registered, for example when the tenant's initial charges need to be revised before the contract is finalized.
The existing initial cost is identified by the combination of the contract's external identifier, the object reference, and the initial cost item name. The amount supplied replaces the amount currently registered for that item.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The external identifier of the concept residential lease contract that the initial cost belongs 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 to update, for example a key deposit or nameplates. Maximum length 256 characters. |
amountExcl | number (double) | Yes | The updated 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 updated 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. |
An initial cost for concept private rent contract was updated
The initial cost data for concept private rent contract data has validation issues