Site Financial Analysis

Update Financial Analysis For Site

HTTP Request

PUT /api/financial-analyses/{financialAnalysisId}/sites/{siteId}

📋 Description: Updates the specified site information within a financial analysis in the Nakisa Portfolio Management Suite, enabling users to manage and optimize real estate asset portfolios effectively.

Parameters

Name	In	Type	Required	Description
financialAnalysisId	path	integer(int64)	true	Unique identifier for the financial analysis
siteId	path	integer(int64)	true	Unique identifier for the site
body	body	SiteFinancialAnalysisDto	true	Request body containing the updated site information and financial analysis parameters for the specified real estate property within the portfolio.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "discountRate": 0.1,
  "netPresentValue": 0.1,
  "returnOnInvestment": 0.1,
  "breakEvenPoint": 0.1,
  "name": "string",
  "site": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "name": "string",
    "storeNumber": "string",
    "fileNumber": "string",
    "businessUnitId": 0,
    "propertyTypeId": 0,
    "buildingTypeId": 0,
    "siteQualityId": 0,
    "areaTypeId": 0,
    "unitId": 0,
    "area": 0,
    "defaultCurrencyId": 0,
    "typeId": 0,
    "legalEntityIds": [
      0
    ],
    "siteManagerId": 0,
    "siteStatusId": 0,
    "referenceLocationId": 0,
    "draft": true
  },
  "siteId": 0,
  "siteFinancialViabilityDtos": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "year": 0,
      "salesGrowth": 0.1,
      "salesRevenue": 0.1,
      "otherIncome": 0.1,
      "totalIncome": 0.1,
      "siteAcquisitionCost": 0.1,
      "renovationCost": 0.1,
      "marketingExpense": 0.1,
      "initialInventory": 0.1,
      "operatingCost": 0.1,
      "maintenanceCost": 0.1,
      "landlordIncentive": 0.1,
      "totalInvestment": 0.1,
      "netCashFlow": 0.1,
      "openingBalance": 0.1,
      "closingBalance": 0.1,
      "siteFinancialAnalysisId": 0
    }
  ],
  "mainScenario": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Site Financial Analysis By Site Id

HTTP Request

GET /api/financial-analyses/sites/{siteId}

📋 Description: Retrieves financial analyses for a specified site within the Nakisa Portfolio Management Suite, enabling users to assess portfolio performance and asset metrics related to real estate properties.

Parameters

Name	In	Type	Required	Description
siteId	path	integer(int64)	true	Unique identifier for the site

Responses

Status	Meaning	Description	Schema
200	OK	OK	SiteFinancialAnalysisDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "discountRate": 0.1,
  "netPresentValue": 0.1,
  "returnOnInvestment": 0.1,
  "breakEvenPoint": 0.1,
  "name": "string",
  "site": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "name": "string",
    "storeNumber": "string",
    "fileNumber": "string",
    "businessUnitId": 0,
    "propertyTypeId": 0,
    "buildingTypeId": 0,
    "siteQualityId": 0,
    "areaTypeId": 0,
    "unitId": 0,
    "area": 0,
    "defaultCurrencyId": 0,
    "typeId": 0,
    "legalEntityIds": [
      0
    ],
    "siteManagerId": 0,
    "siteStatusId": 0,
    "referenceLocationId": 0,
    "draft": true
  },
  "siteId": 0,
  "siteFinancialViabilityDtos": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "year": 0,
      "salesGrowth": 0.1,
      "salesRevenue": 0.1,
      "otherIncome": 0.1,
      "totalIncome": 0.1,
      "siteAcquisitionCost": 0.1,
      "renovationCost": 0.1,
      "marketingExpense": 0.1,
      "initialInventory": 0.1,
      "operatingCost": 0.1,
      "maintenanceCost": 0.1,
      "landlordIncentive": 0.1,
      "totalInvestment": 0.1,
      "netCashFlow": 0.1,
      "openingBalance": 0.1,
      "closingBalance": 0.1,
      "siteFinancialAnalysisId": 0
    }
  ],
  "mainScenario": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Financial Analysis For Site

HTTP Request

POST /api/financial-analyses/sites/{siteId}

📋 Description: Creates a financial analysis for a specified site within the Nakisa Portfolio Management Suite, enabling users to evaluate portfolio performance and asset analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
siteId	path	integer(int64)	true	Unique identifier for the site
body	body	SiteFinancialAnalysisDto	true	Request body containing financial analysis data for the specified site, including portfolio metrics and asset performance indicators relevant to real estate property analytics.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "discountRate": 0.1,
  "netPresentValue": 0.1,
  "returnOnInvestment": 0.1,
  "breakEvenPoint": 0.1,
  "name": "string",
  "site": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "name": "string",
    "storeNumber": "string",
    "fileNumber": "string",
    "businessUnitId": 0,
    "propertyTypeId": 0,
    "buildingTypeId": 0,
    "siteQualityId": 0,
    "areaTypeId": 0,
    "unitId": 0,
    "area": 0,
    "defaultCurrencyId": 0,
    "typeId": 0,
    "legalEntityIds": [
      0
    ],
    "siteManagerId": 0,
    "siteStatusId": 0,
    "referenceLocationId": 0,
    "draft": true
  },
  "siteId": 0,
  "siteFinancialViabilityDtos": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "year": 0,
      "salesGrowth": 0.1,
      "salesRevenue": 0.1,
      "otherIncome": 0.1,
      "totalIncome": 0.1,
      "siteAcquisitionCost": 0.1,
      "renovationCost": 0.1,
      "marketingExpense": 0.1,
      "initialInventory": 0.1,
      "operatingCost": 0.1,
      "maintenanceCost": 0.1,
      "landlordIncentive": 0.1,
      "totalInvestment": 0.1,
      "netCashFlow": 0.1,
      "openingBalance": 0.1,
      "closingBalance": 0.1,
      "siteFinancialAnalysisId": 0
    }
  ],
  "mainScenario": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	integer

Example Responses

0

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Financial Analysis By Project Id And Site Id

HTTP Request

GET /api/financial-analyses/projects/{projectId}/sites/{siteId}

📋 Description: Fetches detailed financial analysis data for a specific site within a project in the Nakisa Portfolio Management Suite, enabling users to assess portfolio performance and asset management insights in the context of real estate properties.

Parameters

Name	In	Type	Required	Description
projectId	path	integer(int64)	true	Unique identifier for the project
siteId	path	integer(int64)	true	Unique identifier for the site

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "discountRate": 0.1,
    "netPresentValue": 0.1,
    "returnOnInvestment": 0.1,
    "breakEvenPoint": 0.1,
    "name": "string",
    "site": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "name": "string",
      "storeNumber": "string",
      "fileNumber": "string",
      "businessUnitId": 0,
      "propertyTypeId": 0,
      "buildingTypeId": 0,
      "siteQualityId": 0,
      "areaTypeId": 0,
      "unitId": 0,
      "area": 0,
      "defaultCurrencyId": 0,
      "typeId": 0,
      "legalEntityIds": [
        0
      ],
      "siteManagerId": 0,
      "siteStatusId": 0,
      "referenceLocationId": 0,
      "draft": true
    },
    "siteId": 0,
    "siteFinancialViabilityDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "year": 0,
        "salesGrowth": 0.1,
        "salesRevenue": 0.1,
        "otherIncome": 0.1,
        "totalIncome": 0.1,
        "siteAcquisitionCost": 0.1,
        "renovationCost": 0.1,
        "marketingExpense": 0.1,
        "initialInventory": 0.1,
        "operatingCost": 0.1,
        "maintenanceCost": 0.1,
        "landlordIncentive": 0.1,
        "totalInvestment": 0.1,
        "netCashFlow": 0.1,
        "openingBalance": 0.1,
        "closingBalance": 0.1,
        "siteFinancialAnalysisId": 0
      }
    ],
    "mainScenario": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SiteFinancialAnalysisDto]	false	none	[Data transfer object representing the financial analysis of real estate properties within a portfolio, providing insights and analytics to support informed decision-making in asset management.]
» createdBy	string	false	none	Username of who created this resource
» lastModifiedBy	string	false	none	Username of who last modified this resource
» createdDate	string(date-time)	false	none	Date of the created
» lastModifiedDate	string(date-time)	false	none	Date of the last modified
» archived	boolean	false	none	Boolean flag indicating archived status
» externalId	string	false	none	Unique identifier for the external
» id	integer(int64)	false	none	Unique identifier for the resource
» discountRate	number(double)	false	none	Rate of discount
» netPresentValue	number(double)	false	none	Value for netPresentValue field
» returnOnInvestment	number(double)	false	none	Value for returnOnInvestment field
» breakEvenPoint	number(double)	false	none	Value for breakEvenPoint field
» name	string	false	none	Name of the resource
» site	Site	false	none	Data transfer object representing a site within the Nakisa Portfolio Management Suite, encompassing essential details related to real estate properties, portfolio management, and asset analytics.
»» createdBy	string	false	none	Username of who created this resource
»» lastModifiedBy	string	false	none	Username of who last modified this resource
»» createdDate	string(date-time)	false	none	Date of the created
»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»» archived	boolean	false	none	Boolean flag indicating archived status
»» externalId	string	false	none	Unique identifier for the external
»» id	integer(int64)	false	none	Unique identifier for the resource
»» name	string	true	none	Name of the resource
»» storeNumber	string	true	none	Text value for storeNumber in Site
»» fileNumber	string	false	none	Text value for fileNumber in Site
»» businessUnitId	integer(int64)	false	none	Unique identifier for the business unit
»» propertyTypeId	integer(int64)	false	none	Unique identifier for the property type
»» buildingTypeId	integer(int64)	false	none	Unique identifier for the building type
»» siteQualityId	integer(int64)	false	none	Unique identifier for the site quality
»» areaTypeId	integer(int64)	false	none	Unique identifier for the area type
»» unitId	integer(int64)	false	none	Unique identifier for the unit
»» area	number	false	none	Value for area field
»» defaultCurrencyId	integer(int64)	false	none	Unique identifier for the default currency
»» typeId	integer(int64)	false	none	Unique identifier for the type
»» legalEntityIds	[integer]	false	none	List of legalEntityIds items
»» siteManagerId	integer(int64)	false	none	Unique identifier for the site manager
»» siteStatusId	integer(int64)	false	none	Unique identifier for the site status
»» referenceLocationId	integer(int64)	false	none	Unique identifier for the reference location
»» draft	boolean	false	none	Boolean flag indicating draft status
» siteId	integer(int64)	false	none	Unique identifier for the site
» siteFinancialViabilityDtos	[SiteFinancialViabilityDto]	false	none	List of siteFinancialViabilityDtos items
»» createdBy	string	false	none	Username of who created this resource
»» lastModifiedBy	string	false	none	Username of who last modified this resource
»» createdDate	string(date-time)	false	none	Date of the created
»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»» archived	boolean	false	none	Boolean flag indicating archived status
»» externalId	string	false	none	Unique identifier for the external
»» id	integer(int64)	false	none	Unique identifier for the resource
»» year	integer(int32)	false	none	Numeric value representing year
»» salesGrowth	number(double)	false	none	Value for salesGrowth field
»» salesRevenue	number(double)	false	none	Value for salesRevenue field
»» otherIncome	number(double)	false	none	Value for otherIncome field
»» totalIncome	number(double)	false	none	Value for totalIncome field
»» siteAcquisitionCost	number(double)	false	none	Value for siteAcquisitionCost field
»» renovationCost	number(double)	false	none	Value for renovationCost field
»» marketingExpense	number(double)	false	none	Value for marketingExpense field
»» initialInventory	number(double)	false	none	Value for initialInventory field
»» operatingCost	number(double)	false	none	Value for operatingCost field
»» maintenanceCost	number(double)	false	none	Value for maintenanceCost field
»» landlordIncentive	number(double)	false	none	Value for landlordIncentive field
»» totalInvestment	number(double)	false	none	Value for totalInvestment field
»» netCashFlow	number(double)	false	none	Value for netCashFlow field
»» openingBalance	number(double)	false	none	Value for openingBalance field
»» closingBalance	number(double)	false	none	Value for closingBalance field
»» siteFinancialAnalysisId	integer(int64)	false	none	Unique identifier for the site financial analysis
» mainScenario	boolean	false	none	Boolean flag indicating mainScenario status

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update And Create Financial Analysis By Project Id And Site Id

HTTP Request

POST /api/financial-analyses/projects/{projectId}/sites/{siteId}

📋 Description: Creates a new financial analysis for a specified project and site within the Nakisa Portfolio Management Suite, enabling enhanced asset and portfolio analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
projectId	path	integer(int64)	true	Unique identifier for the project
siteId	path	integer(int64)	true	Unique identifier for the site
body	body	SiteFinancialAnalysisDto	true	Request body containing financial analysis data for the specified project and site, including key metrics and analytics relevant to portfolio and asset management.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "discountRate": 0.1,
    "netPresentValue": 0.1,
    "returnOnInvestment": 0.1,
    "breakEvenPoint": 0.1,
    "name": "string",
    "site": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "name": "string",
      "storeNumber": "string",
      "fileNumber": "string",
      "businessUnitId": 0,
      "propertyTypeId": 0,
      "buildingTypeId": 0,
      "siteQualityId": 0,
      "areaTypeId": 0,
      "unitId": 0,
      "area": 0,
      "defaultCurrencyId": 0,
      "typeId": 0,
      "legalEntityIds": [
        0
      ],
      "siteManagerId": 0,
      "siteStatusId": 0,
      "referenceLocationId": 0,
      "draft": true
    },
    "siteId": 0,
    "siteFinancialViabilityDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "year": 0,
        "salesGrowth": 0.1,
        "salesRevenue": 0.1,
        "otherIncome": 0.1,
        "totalIncome": 0.1,
        "siteAcquisitionCost": 0.1,
        "renovationCost": 0.1,
        "marketingExpense": 0.1,
        "initialInventory": 0.1,
        "operatingCost": 0.1,
        "maintenanceCost": 0.1,
        "landlordIncentive": 0.1,
        "totalInvestment": 0.1,
        "netCashFlow": 0.1,
        "openingBalance": 0.1,
        "closingBalance": 0.1,
        "siteFinancialAnalysisId": 0
      }
    ],
    "mainScenario": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	SiteFinancialAnalysisDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "discountRate": 0.1,
  "netPresentValue": 0.1,
  "returnOnInvestment": 0.1,
  "breakEvenPoint": 0.1,
  "name": "string",
  "site": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "name": "string",
    "storeNumber": "string",
    "fileNumber": "string",
    "businessUnitId": 0,
    "propertyTypeId": 0,
    "buildingTypeId": 0,
    "siteQualityId": 0,
    "areaTypeId": 0,
    "unitId": 0,
    "area": 0,
    "defaultCurrencyId": 0,
    "typeId": 0,
    "legalEntityIds": [
      0
    ],
    "siteManagerId": 0,
    "siteStatusId": 0,
    "referenceLocationId": 0,
    "draft": true
  },
  "siteId": 0,
  "siteFinancialViabilityDtos": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "year": 0,
      "salesGrowth": 0.1,
      "salesRevenue": 0.1,
      "otherIncome": 0.1,
      "totalIncome": 0.1,
      "siteAcquisitionCost": 0.1,
      "renovationCost": 0.1,
      "marketingExpense": 0.1,
      "initialInventory": 0.1,
      "operatingCost": 0.1,
      "maintenanceCost": 0.1,
      "landlordIncentive": 0.1,
      "totalInvestment": 0.1,
      "netCashFlow": 0.1,
      "openingBalance": 0.1,
      "closingBalance": 0.1,
      "siteFinancialAnalysisId": 0
    }
  ],
  "mainScenario": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Financial Analysis

HTTP Request

DELETE /api/financial-analyses/{id}

📋 Description: Deletes a specified financial analysis from the Nakisa Portfolio Management Suite, enabling users to maintain accurate and relevant analytics for their portfolio and real estate assets.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---