Delete an initial cost from concept commercial rent contract

Prev Next
Delete
/api/v1/contracts/conceptcommercialrent/initialcosts

Delete an initial cost from concept commercial rent contract.

Delete an initial cost from concept commercial rent contract

This endpoint removes an initial cost from a concept commercial lease contract.

It is used to correct or clean up a draft contract's one-off costs before the contract is finalised, for example when a cost such as a key deposit is no longer applicable.

This endpoint only applies to contracts that have not yet been finalised in the Bloxs application.


Request Fields

Field

Type

Required

Description

contractExternalIdentifier

string

Yes

The identifier assigned to the contract by the calling system. This identifier is not generated by Bloxs. Minimum length 1.

objectReference

string

Yes

The reference of the real estate object linked to the initial cost to delete. Must match a reference already registered as a real estate object on this contract. Minimum length 1.

initialCostsItemName

string

Yes

The name of the initial cost item to delete. Maximum length 256 characters.


Response Fields

This endpoint returns no response fields. A successful call confirms the initial cost was deleted.

Security
Body parameters
object
contractExternalIdentifier
string Required
Min length1
objectReference
string Required
Min length1
initialCostsItemName
string Required
Min length0
Max length256
Responses
200

An initial cost for concept commercial rent contract was deleted

400

The initial cost data for concept commercial rent contract has validation issues

Expand All
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string | null additionalProperties
string