Get a list of initial cost items for concept commercial rent contracts

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

Get a list of initial cost items for concept commercial rent contracts.

Get a list of initial cost items for concept commercial rent contracts

This endpoint retrieves the list of predefined initial cost items available for concept commercial lease contracts in Bloxs, such as a key deposit or nameplates.

This is a generic list that can be edited within the Bloxs application.

A developer calls this endpoint to look up the valid values before adding an initial cost to a concept commercial lease contract, since initialCostsItemName is one of the fields required when adding an initial cost.


Request Fields

This endpoint takes no request fields.


Response Fields

Field

Type

Required

Description

initialCostsItemName

string

Yes

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

defaultDescription

string

Yes

The default description populated on new initial costs using this item. This can be overridden at the individual initial cost level. Maximum length 512 characters.

sortingIndex

integer (int32)

Yes

The order in which the initial cost item is displayed in the Bloxs interface or on the invoice.

taxRatePercentage

number (double)

Yes

The VAT percentage applicable to the initial cost item. If left empty, no VAT applies.

Security
Responses
200

OK

Array of object
object
initialCostsItemName
string
Min length0
Max length256
defaultDescription
string | null
Min length0
Max length512
sortingIndex
integer (int32)
taxRatePercentage
number (double) | null