Operating Cost Period Expense

Operating Cost Period Expense - Get Operating Cost Period Expense

HTTP Request

GET /api/operating-cost-period-expenses/{id}

📋 Description: Retrieves detailed operating cost period expenses for a specified asset within the Nakisa Portfolio Management Suite, enabling users to analyze financial performance in the context of portfolio management and real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperatingCostPeriodExpenseDto

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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Operating Cost Period Expense - Update Operating Cost Period Expense

HTTP Request

PUT /api/operating-cost-period-expenses/{id}

📋 Description: Updates the operating cost period expenses for a specified asset within the Nakisa Portfolio Management Suite, enabling enhanced financial analytics and portfolio management for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

OperatingCostPeriodExpenseDto

true

Request body containing the updated operating cost period expenses data, including financial metrics and relevant asset identifiers for effective portfolio management and 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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperatingCostPeriodExpenseDto

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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Operating Cost Period Expense - Delete Operating Cost Period Expense

HTTP Request

DELETE /api/operating-cost-period-expenses/{id}

📋 Description: Deletes a specified operating cost period expense from the Nakisa Portfolio Management Suite, enabling users to maintain accurate financial records related to portfolio and asset management in 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

Operating Cost Period Expense - Archive Operating Cost Period Expense

HTTP Request

POST /api/operating-cost-period-expenses/{id}/archive

📋 Description: Archives the specified operating cost period expenses for a portfolio asset, facilitating streamlined analytics and management 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

200

OK

OK

OperatingCostPeriodExpenseDto

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  "operatingCostExpenseTypeId": 0,
10  "amount": 0,
11  "revisedAmount": 0,
12  "considerRevisedAmount": true,
13  "operatingCostExpenseType": {
14    "createdBy": "string",
15    "lastModifiedBy": "string",
16    "createdDate": "2019-08-24T14:15:22Z",
17    "lastModifiedDate": "2019-08-24T14:15:22Z",
18    "archived": true,
19    "externalId": "string",
20    "id": 0,
21    "priority": 0,
22    "internalId": 0,
23    "pickListCode": "string",
24    "pickListLabel": "string",
25    "label": "string",
26    "cultureId": 0,
27    "labelDtos": [
28      {
29        "createdBy": "string",
30        "lastModifiedBy": "string",
31        "createdDate": "2019-08-24T14:15:22Z",
32        "lastModifiedDate": "2019-08-24T14:15:22Z",
33        "archived": true,
34        "externalId": "string",
35        "id": 0,
36        "cultureId": 0,
37        "value": "string"
38      }
39    ]
40  },
41  "expenseGroup": {
42    "createdBy": "string",
43    "lastModifiedBy": "string",
44    "createdDate": "2019-08-24T14:15:22Z",
45    "lastModifiedDate": "2019-08-24T14:15:22Z",
46    "archived": true,
47    "externalId": "string",
48    "id": 0,
49    "priority": 0,
50    "internalId": 0,
51    "pickListCode": "string",
52    "pickListLabel": "string",
53    "label": "string",
54    "cultureId": 0,
55    "labelDtos": [
56      {
57        "createdBy": "string",
58        "lastModifiedBy": "string",
59        "createdDate": "2019-08-24T14:15:22Z",
60        "lastModifiedDate": "2019-08-24T14:15:22Z",
61        "archived": true,
62        "externalId": "string",
63        "id": 0,
64        "cultureId": 0,
65        "value": "string"
66      }
67    ]
68  }
69}

Operating Cost Period Expense - Get Operating Cost Period Expenses

HTTP Request

GET /api/operating-cost-period-expenses

📋 Description: Retrieves operating cost period expenses associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to analyze financial performance and optimize asset management.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results for operating cost period expenses should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics in real estate property management.

operating-cost-period-id

query

string

false

Unique identifier for the operating cost period, used to retrieve associated expense data within the Nakisa Portfolio Management Suite for effective portfolio and asset analytics.

expense-type-id

query

string

false

Unique identifier for the type of expense associated with operating costs in the Nakisa Portfolio Management Suite, facilitating detailed analytics for portfolio and asset management in real estate properties.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelOperatingCostPeriodExpenseDto

Example Responses

 1{
 2  "_embedded": {
 3    "operatingCostPeriodExpenses": [
 4      {
 5        "createdBy": "string",
 6        "lastModifiedBy": "string",
 7        "createdDate": "2019-08-24T14:15:22Z",
 8        "lastModifiedDate": "2019-08-24T14:15:22Z",
 9        "archived": true,
10        "externalId": "string",
11        "id": 0,
12        "operatingCostExpenseTypeId": 0,
13        "amount": 0,
14        "revisedAmount": 0,
15        "considerRevisedAmount": true,
16        "operatingCostExpenseType": {
17          "createdBy": "string",
18          "lastModifiedBy": "string",
19          "createdDate": "2019-08-24T14:15:22Z",
20          "lastModifiedDate": "2019-08-24T14:15:22Z",
21          "archived": true,
22          "externalId": "string",
23          "id": 0,
24          "priority": 0,
25          "internalId": 0,
26          "pickListCode": "string",
27          "pickListLabel": "string",
28          "label": "string",
29          "cultureId": 0,
30          "labelDtos": [
31            {
32              "createdBy": "string",
33              "lastModifiedBy": "string",
34              "createdDate": "2019-08-24T14:15:22Z",
35              "lastModifiedDate": "2019-08-24T14:15:22Z",
36              "archived": true,
37              "externalId": "string",
38              "id": 0,
39              "cultureId": 0,
40              "value": "string"
41            }
42          ]
43        },
44        "expenseGroup": {
45          "createdBy": "string",
46          "lastModifiedBy": "string",
47          "createdDate": "2019-08-24T14:15:22Z",
48          "lastModifiedDate": "2019-08-24T14:15:22Z",
49          "archived": true,
50          "externalId": "string",
51          "id": 0,
52          "priority": 0,
53          "internalId": 0,
54          "pickListCode": "string",
55          "pickListLabel": "string",
56          "label": "string",
57          "cultureId": 0,
58          "labelDtos": [
59            {
60              "createdBy": "string",
61              "lastModifiedBy": "string",
62              "createdDate": "2019-08-24T14:15:22Z",
63              "lastModifiedDate": "2019-08-24T14:15:22Z",
64              "archived": true,
65              "externalId": "string",
66              "id": 0,
67              "cultureId": 0,
68              "value": "string"
69            }
70          ]
71        }
72      }
73    ]
74  },
75  "page": {
76    "size": 0,
77    "totalElements": 0,
78    "totalPages": 0,
79    "number": 0
80  }
81}