> ## 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 initial cost items for concept private rent contracts
> Get a list of initial cost items for concept private rent contracts.
## OpenAPI
````json GET /api/v1/contracts/conceptprivaterent/initialcostitems
{
"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/conceptprivaterent/initialcostitems": {
"get": {
"tags": [
"Admin"
],
"summary": "Get a list of initial cost items for concept private rent contracts",
"description": "Get a list of initial cost items for concept private rent contracts.",
"operationId": "GetInitialCostItemsForConceptPrivateRentContracts",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SalesContractInitialCostsItemAPIModel"
}
}
}
}
}
},
"x-d360-narrative-url": "Get a list of initial cost items for concept private rent contracts
This endpoint retrieves the list of predefined initial cost items available for concept residential lease contracts in Bloxs, such as a key deposit or nameplates.
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 an initial cost to a concept residential lease contract, since initialCostsItemName is one of the fields required when adding an initial cost.
Request Fields
This endpoint takes no request fields.
Response Fields
Field | Type | Required | Description |
|---|
initialCostsItemName | string | Yes | The name of the initial cost item. Maximum length 256 characters. |
defaultDescription | string | Yes | The default description populated on new initial costs using this item. This can be overridden at the individual initial cost level. Maximum length 512 characters. |
sortingIndex | integer (int32) | Yes | The order in which the initial cost item is displayed in the Bloxs interface or on the invoice. |
taxRatePercentage | number (double) | Yes | The VAT percentage applicable to the initial cost item. If left empty, no VAT applies. |