> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a list of line items for concept commercial rent contracts
> Get a list of line items for concept commercial rent contracts.
## OpenAPI
````json GET /api/v1/contracts/conceptcommercialrent/contractlineitems
{
"openapi": "3.0.4",
"info": {
"title": "Concept SalesContracts V1",
"description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "CommercialRentContracts"
},
{
"name": "Concept CommercialRent"
},
{
"name": "Concept PrivateRent"
},
{
"name": "GeneralSalesContracts"
},
{
"name": "Metadata"
},
{
"name": "PrivateRentContracts"
},
{
"name": "SupplierContracts"
}
],
"paths": {
"/api/v1/contracts/conceptcommercialrent/contractlineitems": {
"get": {
"tags": [
"Admin"
],
"summary": "Get a list of line items for concept commercial rent contracts",
"description": "Get a list of line items for concept commercial rent contracts.",
"operationId": "GetLineItemsForConceptCommercialRentContracts",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConceptRentContractLineItemAPIModel"
}
}
}
}
}
},
"x-d360-narrative-url": "Get a list of line items for concept commercial rent contracts
This endpoint retrieves the list of predefined contract line items available for concept commercial 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 commercial 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. |