> ## 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.
# Delete an initial cost from concept commercial rent contract
> Delete an initial cost from concept commercial rent contract.
## OpenAPI
````json DELETE /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": {
"delete": {
"tags": [
"Concept CommercialRent"
],
"summary": "Delete an initial cost from concept commercial rent contract",
"description": "Delete an initial cost from concept commercial rent contract.",
"operationId": "DeleteInitialCostForConceptCommercialRentContracts",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractInitialCostDeleteModel"
}
}
}
},
"responses": {
"200": {
"description": "An initial cost for concept commercial rent contract was deleted"
},
"400": {
"description": "The initial cost data for concept commercial rent contract has validation issues",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "Delete an initial cost from concept commercial rent contract
This endpoint removes an initial cost from a concept commercial lease contract.
It is used to correct or clean up a draft contract's one-off costs before the contract is finalised, for example when a cost such as a key deposit is no longer applicable.
This endpoint only applies to contracts that have not yet been finalised in the Bloxs application.
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 to delete. 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 to delete. Maximum length 256 characters. |
Response Fields
This endpoint returns no response fields. A successful call confirms the initial cost was deleted.
"
}
}
},
"components": {
"schemas": {
"ContractInitialCostDeleteModel": {
"required": [
"contractExternalIdentifier",
"initialCostsItemName",
"objectReference"
],
"type": "object",
"properties": {
"contractExternalIdentifier": {
"minLength": 1,
"type": "string"
},
"objectReference": {
"minLength": 1,
"type": "string"
},
"initialCostsItemName": {
"maxLength": 256,
"minLength": 0,
"type": "string"
}
},
"additionalProperties": false
},
"APIErrorMessageModel": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"traceId": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
````