Delete an initial cost from concept private rent contract.
Delete an initial cost from concept private rent contract
Removes an initial cost from a concept residential lease contract.
Use this endpoint to remove a one-time charge, such as a key deposit or nameplates, that is no longer applicable before the contract is finalized.
This endpoint can only be used while the contract is still in draft. Once the contract is finalized in the Bloxs application, initial costs can no longer be removed through this endpoint.
The initial cost to delete is identified by the combination of the contract's external identifier, the object reference, and the initial cost item name.
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 delete, for example a key deposit or nameplates. Maximum length 256 characters. |
Response Fields
This endpoint takes no response fields. A successful call confirms that the initial cost was deleted.
An initial cost for concept private rent contract was deleted
The initial cost data for concept private rent contract has validation issues