Get a list of line items for concept private rent contracts.
Get a list of line items for concept private rent contracts
This endpoint retrieves the list of predefined contract line items available for concept residential lease contracts in Bloxs, such as rent, furniture or a rent discount.
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 a contract line to a concept residential lease contract, since lineItemName is one of the fields required when adding a contract line.
Request Fields
This endpoint takes no request fields.
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
lineItemName | string | Yes | The name of the line item. Maximum length 256 characters. |
sortingIndex | integer (int32) | No | The order in which the line item is displayed in the Bloxs interface or on the invoice. |
defaultDescription | string | No | The default description populated on new contract lines using this item. This can be overridden at the individual contract line level. Maximum length 512 characters. |
ledgerAccountCode | string | No | The general ledger account code the line item posts to. Maximum length 12 characters. |
taxRatePercentage | number (double) | No | The VAT percentage applicable to the line item. If left empty, no VAT applies. |
OK