Add an initial cost with the amount for concept commercial rent contracts

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

Add an initial cost with the amount for concept commercial rent contracts.

Add an initial cost with the amount for concept commercial rent contracts

This endpoint adds an initial cost to a concept commercial lease contract, such as a key deposit or nameplates charged once at the start of the lease.

A developer calls this endpoint after the draft contract exists, to record a one-off cost component alongside the recurring contract lines.


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. 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, for example a key deposit or nameplates. Maximum length 256 characters.

amountExcl

number (double)

Yes

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

OK

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