Delete a contract line from concept private rent contract.
Delete a contract line from concept private rent contract
Removes a contract line from a concept residential lease contract.
Use this endpoint to remove a cost item, such as a rent, furniture, or discount line, that was added in error or is no longer agreed upon 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, contract lines can no longer be removed through this endpoint.
The line to delete is identified by the combination of the contract's external identifier, the object reference, and the line item name.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
contractExternalIdentifier | string | Yes | The external identifier of the concept residential lease contract that the line 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 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 to delete, for example base rent or a discount. Maximum length 256 characters. |
Response Fields
This endpoint takes no response fields. A successful call confirms that the contract line was deleted.
Contract line for concept private rent contract was deleted
The contract line data for concept private rent contract has validation issues