Get a list of initial costs for concept commercial rent contracts

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

Get a list of initial costs for concept commercial rent contracts.

Get a list of initial costs for concept commercial rent contracts

This endpoint retrieves the initial costs registered for a concept commercial lease contract, such as key deposits or nameplates charged once at the start of the lease.

A developer calls this endpoint to review the one-off costs already recorded for a draft contract before adding, changing or removing them through the related endpoints.


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. Passed as a query parameter.

objectReference

string

No

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. Passed as a query parameter.


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, for example a key deposit or nameplates. 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
Query parameters
ContractExternalIdentifier
stringRequired

The external API identifier of the contract.

ObjectReference
string

The reference id of the real estate object.

Responses
200

OK

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