[PREVIEW] Get a list of initial cost items for concept private rent contracts
  • 30 Dec 2024
  • 1 Minute to read
  • Dark
    Light

[PREVIEW] Get a list of initial cost items for concept private rent contracts

  • Dark
    Light

Article summary

Get
/api/v1/contracts/conceptprivaterent/initialcostitems

[PREVIEW] Get a list of initial cost items for concept private rent contracts.

Description

Retrieve a list with all known 'initial cost items' within Bloxs. Examples of initial costs are nameplates for an apartment complex or keys. Initial cost items are the options which are available as initial costs (e.g., key deposit, nameplates). This is a generic list, however the list can be edited in the Bloxs application.

Private rent contracts pertains to contracts concerning real estate objects in the private sector. It is generated for each prospect, with the remaining details to be filled in in the Bloxs application. No API endpoint will be made available to finalise the contract. The draft contract can (optionally) be signed digitally. Once signed, the first invoice can be issued immediately. Please note that the concept contract is not a template; it is a draft with only one mandatory field.

Use Case

The user wants to add initial costs to a concept of a private rent contract through the initial costs post operation initial costs post operation. One of the obligatory fields in the request of this operation is 'InitialCostItemName'. However, the user does not know the options which are available to choose from. The user can utilize this operation to retrieve a list, so a choice can be made regarding which 'InitialCostItemName' to choose.

Response fields

The response contains the fields in the table below. For the get operation it gives a up-to-date insight in the data that is currently registered in Bloxs.

FieldDescription
initialCostsItemNameThe name of the item.
defaultDescriptionDefault description populated for new contract line items (this can be overridden at the individual contract line level).
sortingIndexOrder indication for how it should be displayed (in our own interface) or appear on the invoice.
taxRatePercentageThe VAT percentage applicable to this contract item. If this field is empty, no VAT is applicable.
Security
HTTP
Type Bearer

Please enter a valid token

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