> ## 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 costs for buildings
> Get a list of initial costs for buildings
## OpenAPI
````json GET /api/v1/realestateobjects/buildings/initialcosts
{
"openapi": "3.0.4",
"info": {
"title": "RealEstateObjects V1",
"description": "Welcome to BETA version of the new RealEstateObjects 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": "Admin"
},
{
"name": "Buildings"
},
{
"name": "Complexes"
},
{
"name": "Generic"
},
{
"name": "Metadata"
},
{
"name": "PublishObjects"
},
{
"name": "ScoringPointTotals"
},
{
"name": "Sections"
},
{
"name": "Units"
}
],
"paths": {
"/api/v1/realestateobjects/buildings/initialcosts": {
"get": {
"tags": [
"Buildings"
],
"summary": "Get a list of initial costs for buildings",
"description": "Get a list of initial costs for buildings",
"operationId": "GetBuildingInitialCosts",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InitialCostAPIModel"
}
}
}
}
}
},
"x-d360-narrative-url": "Get a list of initial costs for buildings
This endpoint retrieves the initial cost components currently recorded in Bloxs for a building.
Initial costs are one-time charges related to setting up a rental, for example key deposits or nameplates, as distinct from recurring rent.
Integrators call this endpoint to review the initial costs configured for a building, for example to determine which ones apply or to identify entries that need to be added or corrected.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Conditional | Internal identifier of the building. Either reference or externalIdentifier must be provided. If both are given, the building must match both values. |
externalIdentifier | string | Conditional | External identifier of the building, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the building must match both values. |
Response Fields
Field | Type | Required | Description |
|---|
name | string | No | Name of the initial cost component, for example key deposit or nameplates. |
amountExcl | number (double) | Yes | Default amount of the initial cost, excluding VAT (net amount). Decimals are separated with a period. |
orderNo | integer | Yes | Display order of the initial cost component. Determines the order in which entries appear on screen in Bloxs, and can be used to arrange entries consistently in a connected application. |