> ## 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.
# Add an initial cost with the amount for concept commercial rent contracts
> Add an initial cost with the amount for concept commercial rent contracts.
## OpenAPI
````json POST /api/v1/contracts/conceptcommercialrent/initialcosts
{
"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/initialcosts": {
"post": {
"tags": [
"Concept CommercialRent"
],
"summary": "Add an initial cost with the amount for concept commercial rent contracts",
"description": "Add an initial cost with the amount for concept commercial rent contracts.",
"operationId": "PostInitialCostForConceptCommercialRentContracts",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractInitialCostUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractInitialCostModel"
}
}
}
}
},
"x-d360-narrative-url": "Add an initial cost with the amount for concept commercial rent contracts
This endpoint adds an initial cost to a concept commercial lease contract, such as a key deposit or nameplates charged once at the start of the lease.
A developer calls this endpoint after the draft contract exists, to record a one-off cost component alongside the recurring contract lines.
Request Fields
Field | Type | Required | Description |
|---|
contractExternalIdentifier | string | Yes | The identifier assigned to the contract by the calling system. This identifier is not generated by Bloxs. Minimum length 1. |
objectReference | string | Yes | The reference of the real estate object linked to the initial cost. Must match a reference already registered as a real estate object on this contract. Minimum length 1. |
initialCostsItemName | string | Yes | The name of the initial cost item, for example a key deposit or nameplates. Maximum length 256 characters. |
amountExcl | number (double) | Yes | Amount of the initial cost, excluding VAT. Decimals use a period as separator. |
Response Fields
Field | Type | Required | Description |
|---|
contractExternalIdentifier | string | Yes | The identifier assigned to the contract by the calling system. Minimum length 1. |
objectReference | string | No | The reference of the real estate object linked to the initial cost. |
initialCostsItemName | string | Yes | The name of the initial cost item. Maximum length 256 characters. |
amountExcl | number (double) | No | Amount of the initial cost, excluding VAT. Decimals use a period as separator. |
amountVAT | number (double) | No | VAT amount of the initial cost. Decimals use a period as separator. |
amountIncl | number (double) | No | Amount of the initial cost, including VAT. Decimals use a period as separator. |