Update an initial cost for concept commercial rent contract

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

Update an initial cost for concept commercial rent contract.

Update an initial cost for concept commercial rent contract

This endpoint updates an existing initial cost on a concept commercial lease contract.

The initial cost to update is identified by the combination of the contract, the linked real estate object and the item name, so a caller can adjust the amount of a one-off cost such as a key deposit or nameplates already registered on the draft contract.


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 update. 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 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 use a period as separator.


Response Fields

Field

Type

Required

Description

contractExternalIdentifier

string

Yes

The identifier assigned to the contract by the calling system. Minimum length 1.

objectReference

string

No

The reference of the real estate object linked to the initial cost.

initialCostsItemName

string

Yes

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

amountExcl

number (double)

No

Amount of the initial cost, excluding VAT. Decimals use a period as separator.

amountVAT

number (double)

No

VAT amount of the initial cost. Decimals use a period as separator.

amountIncl

number (double)

No

Amount of the initial cost, including VAT. Decimals use a period as separator.

Security
Body parameters
object
contractExternalIdentifier
string Required
Min length1
objectReference
string Required
Min length1
initialCostsItemName
string Required
Min length0
Max length256
amountExcl
number (double) Required
Responses
200

An initial cost for concept commercial rent contract was updated

object
contractExternalIdentifier
string
Min length1
objectReference
string | null
initialCostsItemName
string
Min length0
Max length256
amountExcl
number (double)
amountVAT
number (double)
amountIncl
number (double)
400

The initial cost data for concept commercial rent contract data 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