Project Site Forecasted Sale

Project Site Forecasted Sale - Get Site Forecasted Sale

HTTP Request

GET /api/site-forecasted-sales/{id}

Interactive Demo

📋 Description: Retrieves forecasted sales data for a specific asset within the Nakisa Portfolio Management Suite, enabling users to analyze projected financial performance in the context of portfolio and real estate property management.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ProjectSiteForecastedSaleDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "salesYearEstAmount": 0.1,
  "salesYearIncYear": 0.1,
  "anticipatedSaleEstAmount": 0.1,
  "anticipatedSalesIncYear": 0.1,
  "salesLostEstAmount": 0.1,
  "salesLostIncYear": 0.1,
  "incrementalSalesEstAmount": 0.1,
  "incrementalSalesIncYear": 0.1,
  "typeId": 0,
  "unitId": 0,
  "projectSiteRelationId": 0,
  "site": "string",
  "siteExternalId": "string",
  "siteId": 0,
  "isDraft": true,
  "siteCurrency": "string",
  "siteMeasureUnit": "string",
  "areaInfo": [
    [
      {}
    ]
  ]
}

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

Project Site Forecasted Sale - Update Site Forecasted Sale

HTTP Request

PUT /api/site-forecasted-sales/{id}

Interactive Demo

📋 Description: Updates the forecasted sales data for a specified asset within the Nakisa Portfolio Management Suite, enabling enhanced analytics and informed decision-making in real estate property management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ProjectSiteForecastedSaleDto	true	Request body containing the updated forecasted sales data for a specific asset, including metrics and analytics relevant to portfolio 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,
  "salesYearEstAmount": 0.1,
  "salesYearIncYear": 0.1,
  "anticipatedSaleEstAmount": 0.1,
  "anticipatedSalesIncYear": 0.1,
  "salesLostEstAmount": 0.1,
  "salesLostIncYear": 0.1,
  "incrementalSalesEstAmount": 0.1,
  "incrementalSalesIncYear": 0.1,
  "typeId": 0,
  "unitId": 0,
  "projectSiteRelationId": 0,
  "site": "string",
  "siteExternalId": "string",
  "siteId": 0,
  "isDraft": true,
  "siteCurrency": "string",
  "siteMeasureUnit": "string",
  "areaInfo": [
    [
      {}
    ]
  ]
}

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

Project Site Forecasted Sale - Delete Site Forecasted Sale

HTTP Request

DELETE /api/site-forecasted-sales/{id}

Interactive Demo

📋 Description: Deletes a specified forecasted sales record from the Nakisa Portfolio Management Suite, enabling users to manage and refine their portfolio analytics related to real estate properties.

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

Project Site Forecasted Sale - Create Site Forecasted Sale

HTTP Request

POST /api/site-forecasted-sales

Interactive Demo

📋 Description: Submits forecasted sales data for specified real estate properties within the portfolio, enabling enhanced analytics and strategic decision-making in asset management.

Parameters

Name	In	Type	Required	Description
body	body	ProjectSiteForecastedSaleDto	true	Request body containing forecasted sales data for real estate properties, including portfolio identifiers, asset details, and relevant analytics metrics.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "salesYearEstAmount": 0.1,
  "salesYearIncYear": 0.1,
  "anticipatedSaleEstAmount": 0.1,
  "anticipatedSalesIncYear": 0.1,
  "salesLostEstAmount": 0.1,
  "salesLostIncYear": 0.1,
  "incrementalSalesEstAmount": 0.1,
  "incrementalSalesIncYear": 0.1,
  "typeId": 0,
  "unitId": 0,
  "projectSiteRelationId": 0,
  "site": "string",
  "siteExternalId": "string",
  "siteId": 0,
  "isDraft": true,
  "siteCurrency": "string",
  "siteMeasureUnit": "string",
  "areaInfo": [
    [
      {}
    ]
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses

0

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

Project Site Forecasted Sale - Get Site Forecasted Sale By Project ID

HTTP Request

GET /api/site-forecasted-sales/projects/{projectId}

Interactive Demo

📋 Description: Retrieves forecasted sales data for a specified project within the Nakisa Portfolio Management Suite, enabling users to analyze projected financial performance related to their portfolio and real estate assets.

Parameters

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

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,
    "salesYearEstAmount": 0.1,
    "salesYearIncYear": 0.1,
    "anticipatedSaleEstAmount": 0.1,
    "anticipatedSalesIncYear": 0.1,
    "salesLostEstAmount": 0.1,
    "salesLostIncYear": 0.1,
    "incrementalSalesEstAmount": 0.1,
    "incrementalSalesIncYear": 0.1,
    "typeId": 0,
    "unitId": 0,
    "projectSiteRelationId": 0,
    "site": "string",
    "siteExternalId": "string",
    "siteId": 0,
    "isDraft": true,
    "siteCurrency": "string",
    "siteMeasureUnit": "string",
    "areaInfo": [
      [
        {}
      ]
    ]
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ProjectSiteForecastedSaleDto]	false	none	[Data transfer object representing the projected sales for a specific real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio 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
» salesYearEstAmount	number(double)	false	none	Amount of sales year est
» salesYearIncYear	number(double)	false	none	Value for salesYearIncYear field
» anticipatedSaleEstAmount	number(double)	false	none	Amount of anticipated sale est
» anticipatedSalesIncYear	number(double)	false	none	Value for anticipatedSalesIncYear field
» salesLostEstAmount	number(double)	false	none	Amount of sales lost est
» salesLostIncYear	number(double)	false	none	Value for salesLostIncYear field
» incrementalSalesEstAmount	number(double)	false	none	Amount of incremental sales est
» incrementalSalesIncYear	number(double)	false	none	Value for incrementalSalesIncYear field
» typeId	integer(int64)	false	none	Unique identifier for the type
» unitId	integer(int64)	false	none	Unique identifier for the unit
» projectSiteRelationId	integer(int64)	false	none	Unique identifier for the project site relation
» site	string	false	none	Represents the specific site associated with the forecasted sale within the portfolio, facilitating asset and real estate property analytics.
» siteExternalId	string	false	none	Unique identifier for the site external
» siteId	integer(int64)	false	none	Unique identifier for the site
» isDraft	boolean	false	none	Whether the resource is draft
» siteCurrency	string	false	none	Represents the currency used for financial transactions within the project site, facilitating accurate portfolio and asset analytics in the Nakisa Portfolio Management Suite.
» siteMeasureUnit	string	false	none	Specifies the measurement unit used for forecasting sales at the project site, facilitating accurate analytics within the real estate portfolio management context.
» areaInfo	[array]	false	none	List of areaInfo items

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

Project Site Forecasted Sale - Delete Forecasted Sale By Relation ID

HTTP Request

DELETE /api/site-forecasted-sales/relations/{relationId}

Interactive Demo

📋 Description: Deletes a specified relation from the forecasted sales data within the Nakisa Portfolio Management Suite, enabling users to maintain accurate and relevant portfolio analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
relationId	path	integer(int64)	true	Unique identifier for the relation

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

---