Project Site Capital Investment¶
Project Site Capital Investment - Get Site Capital Investment¶
HTTP Request
GET /api/site-capital-investments/{id}
📋 Description: Retrieves detailed information about a specific capital investment within the Nakisa Portfolio Management Suite, enabling users to analyze asset performance and portfolio impact in the context of 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 |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "landPurchaseTotalCost": 0.1,
10 "landPurchaseAmortizationAmt": 0.1,
11 "buildingTotalCost": 0.1,
12 "buildingAmortizationAmt": 0.1,
13 "leaseholdImprTotalCost": 0.1,
14 "leaseholdImprAmortizationAmt": 0.1,
15 "landlordIncTotalCost": 0.1,
16 "landlordIncAmortizationAmt": 0.1,
17 "amortizationTotalCost": 0.1,
18 "typeId": 0,
19 "unitId": 0,
20 "projectSiteRelationId": 0,
21 "site": "string",
22 "siteId": 0,
23 "siteExternalId": "string",
24 "isDraft": true,
25 "siteCurrency": "string",
26 "siteMeasureUnit": "string",
27 "areaInfo": [
28 [
29 {}
30 ]
31 ]
32}
Project Site Capital Investment - Update Site Capital Investment¶
HTTP Request
PUT /api/site-capital-investments/{id}
📋 Description: Updates the details of a specific capital investment within the Nakisa Portfolio Management Suite, allowing users to manage and optimize their portfolio of real estate assets effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated capital investment details, including asset allocation and performance metrics, relevant to portfolio management and real estate analytics. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "landPurchaseTotalCost": 0.1,
10 "landPurchaseAmortizationAmt": 0.1,
11 "buildingTotalCost": 0.1,
12 "buildingAmortizationAmt": 0.1,
13 "leaseholdImprTotalCost": 0.1,
14 "leaseholdImprAmortizationAmt": 0.1,
15 "landlordIncTotalCost": 0.1,
16 "landlordIncAmortizationAmt": 0.1,
17 "amortizationTotalCost": 0.1,
18 "typeId": 0,
19 "unitId": 0,
20 "projectSiteRelationId": 0,
21 "site": "string",
22 "siteId": 0,
23 "siteExternalId": "string",
24 "isDraft": true,
25 "siteCurrency": "string",
26 "siteMeasureUnit": "string",
27 "areaInfo": [
28 [
29 {}
30 ]
31 ]
32}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Project Site Capital Investment - Delete Site Capital Investment¶
HTTP Request
DELETE /api/site-capital-investments/{id}
📋 Description: Deletes a specified capital investment from the portfolio, enabling users to effectively manage and optimize their asset allocations within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Project Site Capital Investment - Create Site Capital Investment¶
HTTP Request
POST /api/site-capital-investments
📋 Description: Creates a new capital investment entry within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze portfolio assets related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the capital investment details for real estate properties, including portfolio identifiers, asset valuations, and relevant analytics. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "landPurchaseTotalCost": 0.1,
10 "landPurchaseAmortizationAmt": 0.1,
11 "buildingTotalCost": 0.1,
12 "buildingAmortizationAmt": 0.1,
13 "leaseholdImprTotalCost": 0.1,
14 "leaseholdImprAmortizationAmt": 0.1,
15 "landlordIncTotalCost": 0.1,
16 "landlordIncAmortizationAmt": 0.1,
17 "amortizationTotalCost": 0.1,
18 "typeId": 0,
19 "unitId": 0,
20 "projectSiteRelationId": 0,
21 "site": "string",
22 "siteId": 0,
23 "siteExternalId": "string",
24 "isDraft": true,
25 "siteCurrency": "string",
26 "siteMeasureUnit": "string",
27 "areaInfo": [
28 [
29 {}
30 ]
31 ]
32}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Project Site Capital Investment - Get Site Capital Investment By Project ID¶
HTTP Request
GET /api/site-capital-investments/projects/{projectId}
📋 Description: Retrieves detailed information about a specific capital investment project within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset allocation in the context of real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "landPurchaseTotalCost": 0.1,
11 "landPurchaseAmortizationAmt": 0.1,
12 "buildingTotalCost": 0.1,
13 "buildingAmortizationAmt": 0.1,
14 "leaseholdImprTotalCost": 0.1,
15 "leaseholdImprAmortizationAmt": 0.1,
16 "landlordIncTotalCost": 0.1,
17 "landlordIncAmortizationAmt": 0.1,
18 "amortizationTotalCost": 0.1,
19 "typeId": 0,
20 "unitId": 0,
21 "projectSiteRelationId": 0,
22 "site": "string",
23 "siteId": 0,
24 "siteExternalId": "string",
25 "isDraft": true,
26 "siteCurrency": "string",
27 "siteMeasureUnit": "string",
28 "areaInfo": [
29 [
30 {}
31 ]
32 ]
33 }
34]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the capital investment details associated with a project site within the Nakisa Portfolio Management Suite, facilitating informed decision-making in portfolio and asset management for real estate properties.] |
|
» 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 |
» landPurchaseTotalCost |
number(double) |
false |
none |
Value for landPurchaseTotalCost field |
» landPurchaseAmortizationAmt |
number(double) |
false |
none |
Value for landPurchaseAmortizationAmt field |
» buildingTotalCost |
number(double) |
false |
none |
Value for buildingTotalCost field |
» buildingAmortizationAmt |
number(double) |
false |
none |
Value for buildingAmortizationAmt field |
» leaseholdImprTotalCost |
number(double) |
false |
none |
Value for leaseholdImprTotalCost field |
» leaseholdImprAmortizationAmt |
number(double) |
false |
none |
Value for leaseholdImprAmortizationAmt field |
» landlordIncTotalCost |
number(double) |
false |
none |
Value for landlordIncTotalCost field |
» landlordIncAmortizationAmt |
number(double) |
false |
none |
Value for landlordIncAmortizationAmt field |
» amortizationTotalCost |
number(double) |
false |
none |
Value for amortizationTotalCost 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 a project within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics. |
» siteId |
integer(int64) |
false |
none |
Unique identifier for the site |
» siteExternalId |
string |
false |
none |
Unique identifier for the site external |
» isDraft |
boolean |
false |
none |
Whether the resource is draft |
» siteCurrency |
string |
false |
none |
Specifies the currency used for financial transactions and reporting within the project site, facilitating accurate portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
» siteMeasureUnit |
string |
false |
none |
Specifies the unit of measurement for site-related capital investments within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in the real estate sector. |
» areaInfo |
[array] |
false |
none |
List of areaInfo items |
Project Site Capital Investment - Delete Capital Investment By Relation ID¶
HTTP Request
DELETE /api/site-capital-investments/relations/{relationId}
📋 Description: Deletes a specified relationship between capital investments within the Nakisa Portfolio Management Suite, enabling users to maintain accurate portfolio and asset 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 |
None |