Delete a contract line from concept commercial rent contract

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

Delete a contract line from concept commercial rent contract.

Delete a contract line from concept commercial rent contract

This endpoint removes a contract line from a concept commercial lease contract.

It is used to correct or clean up a draft contract's theoretical rent build-up before the contract is finalised, for example when a rent component was added in error or was not agreed upon.

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 contract line to be deleted. Must match a reference already registered as a real estate object on this contract. Minimum length 1.

lineItemName

string

Yes

The name of the contract line item to be deleted. Maximum length 256 characters.


Response Fields

This endpoint returns no response fields. A successful call confirms the contract line was deleted.

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

Contract line for concept commercial rent contract was deleted

400

The contract line 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