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

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

  • Dark
    Light

Article summary

Get
/api/v1/contracts/conceptprivaterent/contractlineitems

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

Description

Retrieve a list with all known 'line items' within Bloxs. Contract line items pertains to the particular contract terms associated with the agreement. Line items include costs for the tenant, such as rent, furniture, and rent discounts (negative costs). It is a generic list, however the user can edit the list 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 line items to a concept of a private rent contract throughcthe contract line post operation the contract line post operation. One of the obligatory fields in the request of this operation is 'lineItemName'. 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 'lineItemName' 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
lineItemNameThe 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
lineItemName
string
Min length0
Max length256
sortingIndex
integer (int32)
defaultDescription
string | null
Min length0
Max length512
taxRatePercentage
number (double) | null