Get a list of line items for supplier contracts

Prev Next
Get
/api/v1/contracts/supplier/contractlineitems

Get a list of line items for supplier 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 invoiced by the supplier, such as planned maintenance costs, security services or cleaning services. It is a generic list, however the user can edit the list in the Bloxs application.

A supplier contract pertains to contracts with a supplier for, for instance,  the regular servicing of heating and ventilation systemes in rental properties.

Use Case

The user wants to add line items to a supplier contract through 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.

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.
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