Operating Cost Period¶
Operating Cost Period - Get Operating Cost Periods¶
HTTP Request
GET /api/operating-cost-periods
📋 Description: Retrieves a list of operating cost periods associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio expenses effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the operating cost periods query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
|
year |
query |
string |
false |
Specifies the fiscal year for which operating cost periods are being retrieved, enabling analysis of portfolio and asset performance within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "operatingCostPeriods": [
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 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "year": 1950,
15 "statusId": 0,
16 "expenses": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "operatingCostExpenseTypeId": 0,
26 "amount": 0,
27 "revisedAmount": 0,
28 "considerRevisedAmount": true,
29 "operatingCostExpenseType": {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "priority": 0,
38 "internalId": 0,
39 "pickListCode": "string",
40 "pickListLabel": "string",
41 "label": "string",
42 "cultureId": 0,
43 "labelDtos": [
44 {
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 "cultureId": 0,
53 "value": "string"
54 }
55 ]
56 },
57 "expenseGroup": {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "priority": 0,
66 "internalId": 0,
67 "pickListCode": "string",
68 "pickListLabel": "string",
69 "label": "string",
70 "cultureId": 0,
71 "labelDtos": [
72 {
73 "createdBy": "string",
74 "lastModifiedBy": "string",
75 "createdDate": "2019-08-24T14:15:22Z",
76 "lastModifiedDate": "2019-08-24T14:15:22Z",
77 "archived": true,
78 "externalId": "string",
79 "id": 0,
80 "cultureId": 0,
81 "value": "string"
82 }
83 ]
84 }
85 }
86 ],
87 "status": {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "priority": 0,
96 "internalId": 0,
97 "pickListCode": "string",
98 "pickListLabel": "string",
99 "label": "string",
100 "cultureId": 0,
101 "labelDtos": [
102 {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "cultureId": 0,
111 "value": "string"
112 }
113 ]
114 },
115 "leaseReconciliationPeriods": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "startDate": "2019-08-24",
125 "endDate": "2019-08-24",
126 "statusId": 0,
127 "invoiceAmount": 0,
128 "receivedDate": "2019-08-24",
129 "acceptedAmount": 0,
130 "reviewedBy": "string",
131 "reviewedDate": "2019-08-24",
132 "fullReconciliation": true,
133 "status": {
134 "createdBy": "string",
135 "lastModifiedBy": "string",
136 "createdDate": "2019-08-24T14:15:22Z",
137 "lastModifiedDate": "2019-08-24T14:15:22Z",
138 "archived": true,
139 "externalId": "string",
140 "id": 0,
141 "priority": 0,
142 "internalId": 0,
143 "pickListCode": "string",
144 "pickListLabel": "string",
145 "label": "string",
146 "cultureId": 0,
147 "labelDtos": [
148 {
149 "createdBy": "string",
150 "lastModifiedBy": "string",
151 "createdDate": "2019-08-24T14:15:22Z",
152 "lastModifiedDate": "2019-08-24T14:15:22Z",
153 "archived": true,
154 "externalId": "string",
155 "id": 0,
156 "cultureId": 0,
157 "value": "string"
158 }
159 ]
160 },
161 "operatingCostPeriodId": 0,
162 "reconciledExpenseCategoryDtos": [
163 {
164 "createdBy": "string",
165 "lastModifiedBy": "string",
166 "createdDate": "2019-08-24T14:15:22Z",
167 "lastModifiedDate": "2019-08-24T14:15:22Z",
168 "archived": true,
169 "externalId": "string",
170 "id": 0,
171 "expenseGroupId": 0,
172 "totalCost": 0,
173 "accrualAmount": 0,
174 "balance": 0,
175 "expenseGroup": {
176 "createdBy": "string",
177 "lastModifiedBy": "string",
178 "createdDate": "2019-08-24T14:15:22Z",
179 "lastModifiedDate": "2019-08-24T14:15:22Z",
180 "archived": true,
181 "externalId": "string",
182 "id": 0,
183 "priority": 0,
184 "internalId": 0,
185 "pickListCode": "string",
186 "pickListLabel": "string",
187 "label": "string",
188 "cultureId": 0,
189 "labelDtos": [
190 {}
191 ]
192 },
193 "reconciledExpenseDtos": [
194 {
195 "createdBy": "string",
196 "lastModifiedBy": "string",
197 "createdDate": "2019-08-24T14:15:22Z",
198 "lastModifiedDate": "2019-08-24T14:15:22Z",
199 "archived": true,
200 "externalId": "string",
201 "id": 0,
202 "totalCost": 0,
203 "operatingCostExpenseTypeId": 0,
204 "operatingCostExpenseType": {},
205 "reconciledExpenseSegmentDtos": []
206 }
207 ],
208 "hasWarning": true
209 }
210 ]
211 }
212 ]
213 }
214 ]
215 },
216 "page": {
217 "size": 0,
218 "totalElements": 0,
219 "totalPages": 0,
220 "number": 0
221 }
222}
Operating Cost Period - Create Operating Cost Periods¶
HTTP Request
POST /api/operating-cost-periods
📋 Description: Creates a new operating cost period within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze financial data related to real estate assets and portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the operating cost period data, including relevant financial metrics and attributes essential for portfolio and asset analytics within the real estate property domain. |
Body Parameters
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 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "year": 1950,
13 "statusId": 0,
14 "expenses": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "operatingCostExpenseTypeId": 0,
24 "amount": 0,
25 "revisedAmount": 0,
26 "considerRevisedAmount": true,
27 "operatingCostExpenseType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "expenseGroup": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84 ],
85 "status": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "leaseReconciliationPeriods": [
114 {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "startDate": "2019-08-24",
123 "endDate": "2019-08-24",
124 "statusId": 0,
125 "invoiceAmount": 0,
126 "receivedDate": "2019-08-24",
127 "acceptedAmount": 0,
128 "reviewedBy": "string",
129 "reviewedDate": "2019-08-24",
130 "fullReconciliation": true,
131 "status": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "operatingCostPeriodId": 0,
160 "reconciledExpenseCategoryDtos": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "expenseGroupId": 0,
170 "totalCost": 0,
171 "accrualAmount": 0,
172 "balance": 0,
173 "expenseGroup": {
174 "createdBy": "string",
175 "lastModifiedBy": "string",
176 "createdDate": "2019-08-24T14:15:22Z",
177 "lastModifiedDate": "2019-08-24T14:15:22Z",
178 "archived": true,
179 "externalId": "string",
180 "id": 0,
181 "priority": 0,
182 "internalId": 0,
183 "pickListCode": "string",
184 "pickListLabel": "string",
185 "label": "string",
186 "cultureId": 0,
187 "labelDtos": [
188 {
189 "createdBy": "string",
190 "lastModifiedBy": "string",
191 "createdDate": "2019-08-24T14:15:22Z",
192 "lastModifiedDate": "2019-08-24T14:15:22Z",
193 "archived": true,
194 "externalId": "string",
195 "id": 0,
196 "cultureId": 0,
197 "value": "string"
198 }
199 ]
200 },
201 "reconciledExpenseDtos": [
202 {
203 "createdBy": "string",
204 "lastModifiedBy": "string",
205 "createdDate": "2019-08-24T14:15:22Z",
206 "lastModifiedDate": "2019-08-24T14:15:22Z",
207 "archived": true,
208 "externalId": "string",
209 "id": 0,
210 "totalCost": 0,
211 "operatingCostExpenseTypeId": 0,
212 "operatingCostExpenseType": {
213 "createdBy": "string",
214 "lastModifiedBy": "string",
215 "createdDate": "2019-08-24T14:15:22Z",
216 "lastModifiedDate": "2019-08-24T14:15:22Z",
217 "archived": true,
218 "externalId": "string",
219 "id": 0,
220 "priority": 0,
221 "internalId": 0,
222 "pickListCode": "string",
223 "pickListLabel": "string",
224 "label": "string",
225 "cultureId": 0,
226 "labelDtos": [
227 {}
228 ]
229 },
230 "reconciledExpenseSegmentDtos": [
231 {
232 "createdBy": "string",
233 "lastModifiedBy": "string",
234 "createdDate": "2019-08-24T14:15:22Z",
235 "lastModifiedDate": "2019-08-24T14:15:22Z",
236 "archived": true,
237 "externalId": "string",
238 "id": 0,
239 "startDate": "2019-08-24",
240 "endDate": "2019-08-24",
241 "adjustedLocationCost": 0,
242 "proSharePercentage": 0,
243 "proShareCost": 0,
244 "cap": 0,
245 "subtotalCost": 0,
246 "adminFees": 0,
247 "totalCost": 0,
248 "conditionDto": {}
249 }
250 ]
251 }
252 ],
253 "hasWarning": true
254 }
255 ]
256 }
257 ]
258 }
259]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "year": 1950,
13 "statusId": 0,
14 "expenses": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "operatingCostExpenseTypeId": 0,
24 "amount": 0,
25 "revisedAmount": 0,
26 "considerRevisedAmount": true,
27 "operatingCostExpenseType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "expenseGroup": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84 ],
85 "status": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "leaseReconciliationPeriods": [
114 {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "startDate": "2019-08-24",
123 "endDate": "2019-08-24",
124 "statusId": 0,
125 "invoiceAmount": 0,
126 "receivedDate": "2019-08-24",
127 "acceptedAmount": 0,
128 "reviewedBy": "string",
129 "reviewedDate": "2019-08-24",
130 "fullReconciliation": true,
131 "status": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "operatingCostPeriodId": 0,
160 "reconciledExpenseCategoryDtos": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "expenseGroupId": 0,
170 "totalCost": 0,
171 "accrualAmount": 0,
172 "balance": 0,
173 "expenseGroup": {
174 "createdBy": "string",
175 "lastModifiedBy": "string",
176 "createdDate": "2019-08-24T14:15:22Z",
177 "lastModifiedDate": "2019-08-24T14:15:22Z",
178 "archived": true,
179 "externalId": "string",
180 "id": 0,
181 "priority": 0,
182 "internalId": 0,
183 "pickListCode": "string",
184 "pickListLabel": "string",
185 "label": "string",
186 "cultureId": 0,
187 "labelDtos": [
188 {
189 "createdBy": "string",
190 "lastModifiedBy": "string",
191 "createdDate": "2019-08-24T14:15:22Z",
192 "lastModifiedDate": "2019-08-24T14:15:22Z",
193 "archived": true,
194 "externalId": "string",
195 "id": 0,
196 "cultureId": 0,
197 "value": "string"
198 }
199 ]
200 },
201 "reconciledExpenseDtos": [
202 {
203 "createdBy": "string",
204 "lastModifiedBy": "string",
205 "createdDate": "2019-08-24T14:15:22Z",
206 "lastModifiedDate": "2019-08-24T14:15:22Z",
207 "archived": true,
208 "externalId": "string",
209 "id": 0,
210 "totalCost": 0,
211 "operatingCostExpenseTypeId": 0,
212 "operatingCostExpenseType": {
213 "createdBy": "string",
214 "lastModifiedBy": "string",
215 "createdDate": "2019-08-24T14:15:22Z",
216 "lastModifiedDate": "2019-08-24T14:15:22Z",
217 "archived": true,
218 "externalId": "string",
219 "id": 0,
220 "priority": 0,
221 "internalId": 0,
222 "pickListCode": "string",
223 "pickListLabel": "string",
224 "label": "string",
225 "cultureId": 0,
226 "labelDtos": [
227 {}
228 ]
229 },
230 "reconciledExpenseSegmentDtos": [
231 {
232 "createdBy": "string",
233 "lastModifiedBy": "string",
234 "createdDate": "2019-08-24T14:15:22Z",
235 "lastModifiedDate": "2019-08-24T14:15:22Z",
236 "archived": true,
237 "externalId": "string",
238 "id": 0,
239 "startDate": "2019-08-24",
240 "endDate": "2019-08-24",
241 "adjustedLocationCost": 0,
242 "proSharePercentage": 0,
243 "proShareCost": 0,
244 "cap": 0,
245 "subtotalCost": 0,
246 "adminFees": 0,
247 "totalCost": 0,
248 "conditionDto": {}
249 }
250 ]
251 }
252 ],
253 "hasWarning": true
254 }
255 ]
256 }
257 ]
258 }
259]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the operating cost period for assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights related to portfolio and real estate property 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 |
» startDate |
string(date) |
false |
none |
none |
» endDate |
string(date) |
false |
none |
none |
» year |
integer(int32) |
false |
none |
Numeric value representing year |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» expenses |
false |
none |
List of expenses 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 |
»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»» amount |
number |
true |
none |
Amount value |
»» revisedAmount |
number |
false |
none |
Amount of revised |
»» considerRevisedAmount |
boolean |
false |
none |
Amount of consider revised |
»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property 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 |
»»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»»» pickListCode |
string |
false |
none |
Code for the pick list |
»»» pickListLabel |
string |
false |
none |
Label for the pick list |
»»» label |
string |
false |
none |
Label for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» labelDtos |
false |
none |
List of labelDtos 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 |
»»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»»» value |
string |
true |
none |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» leaseReconciliationPeriods |
false |
none |
List of leaseReconciliationPeriods 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 |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» invoiceAmount |
number |
false |
none |
Amount of invoice |
»» receivedDate |
string(date) |
false |
none |
Date of the received |
»» acceptedAmount |
number |
false |
none |
Amount of accepted |
»» reviewedBy |
string |
false |
none |
Identifier of the individual or entity that has reviewed the lease reconciliation period, facilitating accountability and transparency in portfolio and asset management within the Nakisa Portfolio Management Suite. |
»» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
»» fullReconciliation |
boolean |
false |
none |
Boolean flag indicating fullReconciliation status |
»» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» operatingCostPeriodId |
integer(int64) |
false |
none |
Unique identifier for the operating cost period |
»» reconciledExpenseCategoryDtos |
false |
none |
List of reconciledExpenseCategoryDtos 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 |
»»» expenseGroupId |
integer(int64) |
false |
none |
Unique identifier for the expense group |
»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»» accrualAmount |
number |
false |
none |
Amount of accrual |
»»» balance |
number |
false |
none |
Value for balance field |
»»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» reconciledExpenseDtos |
false |
none |
List of reconciledExpenseDtos 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 |
»»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»»»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»» reconciledExpenseSegmentDtos |
false |
none |
List of reconciledExpenseSegmentDtos 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 |
»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»» adjustedLocationCost |
number |
false |
none |
Value for adjustedLocationCost field |
»»»»» proSharePercentage |
number |
false |
none |
Percentage of pro share |
»»»»» proShareCost |
number |
false |
none |
Value for proShareCost field |
»»»»» cap |
number |
false |
none |
Value for cap field |
»»»»» subtotalCost |
number |
false |
none |
Value for subtotalCost field |
»»»»» adminFees |
number |
false |
none |
Value for adminFees field |
»»»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»»»» conditionDto |
false |
none |
Data transfer object representing the conditions associated with a lease within the Nakisa Portfolio Management Suite, facilitating insights and analytics for real estate property management and portfolio optimization. |
|
»»»»»» 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 |
»»»»»» parentConditionId |
integer(int64) |
false |
none |
none |
»»»»»» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
»»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»»» replaceById |
integer(int64) |
false |
none |
Unique identifier for the replace by |
»»»»»» managedById |
integer(int64) |
false |
none |
Unique identifier for the managed by |
»»»»»» payById |
integer(int64) |
false |
none |
Unique identifier for the pay by |
»»»»»» adminFee |
number |
false |
none |
Value for adminFee field |
»»»»»» fixedIncreasePercentage |
number |
false |
none |
Percentage of fixed increase |
»»»»»» note |
string |
false |
none |
Textual commentary or observations related to the lease condition, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»»»»»» pageNumber |
string |
false |
none |
Page number for pagination |
»»»»»» section |
string |
false |
none |
Identifies the specific section of the lease conditions relevant to the portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite. |
»»»»»» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» replaceBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» managedBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» payBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» proShareDto |
any |
false |
none |
Value for proShareDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
|
»»»»»»»» 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 |
»»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing area-based professional sharing insights within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making related to portfolio and asset management in real estate properties. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» dividendAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»»» divisorAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»»» dividendAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»»» divisorAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»»» dividendAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»»»»» divisorAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a fixed percentage profit-sharing arrangement within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate property assets in portfolio management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» fixedPercentage |
number |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» capDto |
any |
false |
none |
Value for capDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property 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 |
»»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing fixed capital assets within the Nakisa Portfolio Management Suite, encompassing key attributes for portfolio analysis, asset management, and real estate property evaluation. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» amount |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»»» cumulative |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing the annual capital allocation projections for real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and asset management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»»» cumulative |
boolean |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» hasWarning |
boolean |
false |
none |
Whether the resource has has warning |
Operating Cost Period - Create Operating Cost Period Expenses¶
HTTP Request
POST /api/operating-cost-periods/{id}/operating-cost-period-expenses
📋 Description: Creates a new operating cost expense associated with a specified operating cost period within the Nakisa Portfolio Management Suite, enabling enhanced financial analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the detailed expense data associated with the specified operating cost period, including relevant financial metrics for effective portfolio and asset management within the real estate sector. |
Body Parameters
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 "operatingCostExpenseTypeId": 0,
11 "amount": 0,
12 "revisedAmount": 0,
13 "considerRevisedAmount": true,
14 "operatingCostExpenseType": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "priority": 0,
23 "internalId": 0,
24 "pickListCode": "string",
25 "pickListLabel": "string",
26 "label": "string",
27 "cultureId": 0,
28 "labelDtos": [
29 {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 },
42 "expenseGroup": {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "priority": 0,
51 "internalId": 0,
52 "pickListCode": "string",
53 "pickListLabel": "string",
54 "label": "string",
55 "cultureId": 0,
56 "labelDtos": [
57 {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "cultureId": 0,
66 "value": "string"
67 }
68 ]
69 }
70 }
71]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "operatingCostExpenseTypeId": 0,
11 "amount": 0,
12 "revisedAmount": 0,
13 "considerRevisedAmount": true,
14 "operatingCostExpenseType": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "priority": 0,
23 "internalId": 0,
24 "pickListCode": "string",
25 "pickListLabel": "string",
26 "label": "string",
27 "cultureId": 0,
28 "labelDtos": [
29 {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 },
42 "expenseGroup": {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "priority": 0,
51 "internalId": 0,
52 "pickListCode": "string",
53 "pickListLabel": "string",
54 "label": "string",
55 "cultureId": 0,
56 "labelDtos": [
57 {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "cultureId": 0,
66 "value": "string"
67 }
68 ]
69 }
70 }
71]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the operating costs associated with a specific period for assets within the Nakisa Portfolio Management Suite, facilitating comprehensive analytics and informed decision-making in real estate property 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 |
» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
» amount |
number |
true |
none |
Amount value |
» revisedAmount |
number |
false |
none |
Amount of revised |
» considerRevisedAmount |
boolean |
false |
none |
Amount of consider revised |
» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property 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 |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos 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 |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
Operating Cost Period - Get Operating Cost Period Notes¶
HTTP Request
GET /api/operating-cost-periods/{id}/notes
📋 Description: Fetches notes associated with a specific operating cost period, providing insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results for notes associated with the specified operating cost period should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter notes related to the specified operating cost period, enhancing the ability to analyze portfolio and asset information within the Nakisa Portfolio Management Suite. |
message |
query |
string |
false |
Textual content of the note associated with the specified operating cost period, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
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 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Operating Cost Period - Create Operating Cost Period Notes¶
HTTP Request
POST /api/operating-cost-periods/{id}/notes
📋 Description: Creates a new note associated with a specific operating cost period in the Nakisa Portfolio Management Suite, enabling users to enhance asset and portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing detailed notes related to the specified operating cost period, including context for portfolio and asset analytics within the real estate property domain. |
Body Parameters
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.] |
|
» 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 |
» message |
string |
true |
none |
Textual content providing detailed information or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
URL to which users will be redirected after completing a specific action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio, asset, and real estate property management. |
Operating Cost Period - Get Documents For Operating Cost Period¶
HTTP Request
GET /api/operating-cost-periods/{id}/documents
📋 Description: Fetches documents associated with a specific operating cost period, enabling users to access relevant information for portfolio and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the document retrieval for the specified operating cost period should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter documents related to the specified operating cost period, enhancing portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
id |
query |
string |
false |
Unique identifier for the resource |
status-id |
query |
string |
false |
Unique identifier for the status of the operating cost period documents, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
signed-date |
query |
string |
false |
Specifies the date on which the document was signed, relevant for tracking the operational costs associated with portfolio and asset management in real estate properties. |
name |
query |
string |
false |
Name of the resource |
title |
query |
string |
false |
Title of the resource |
type |
query |
string |
false |
Type of the resource |
shareable |
query |
string |
false |
Indicates whether the documents associated with the specified operating cost period are shareable within the Nakisa Portfolio Management Suite, facilitating collaboration in portfolio and asset analytics for real estate properties. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with the specified operating cost period, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with the specified operating cost period, facilitating targeted retrieval of relevant portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "documents": [
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 "name": "string",
13 "title": "string",
14 "type": "string",
15 "description": "string",
16 "link": "string",
17 "signedDate": "2019-08-24",
18 "documentTypeId": 0,
19 "statusId": 0,
20 "shareable": true,
21 "size": 0,
22 "documentType": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "status": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 }
78 }
79 ]
80 },
81 "page": {
82 "size": 0,
83 "totalElements": 0,
84 "totalPages": 0,
85 "number": 0
86 }
87}
Operating Cost Period - Upload Operating Cost Period Document¶
HTTP Request
POST /api/operating-cost-periods/{id}/documents
📋 Description: Uploads documents associated with a specified operating cost period, enhancing portfolio and asset management within the Nakisa Portfolio Management Suite for real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
object |
false |
Request body containing the document details related to the specified operating cost period, including metadata and associated analytics for effective portfolio and asset management. |
» file |
body |
string(binary) |
false |
none |
» document |
body |
true |
Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties. |
|
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»» externalId |
body |
string |
false |
Unique identifier for the external |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» title |
body |
string |
false |
Title of the resource |
»» type |
body |
string |
false |
Type of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» link |
body |
string |
false |
URL link to access detailed information or resources related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»» signedDate |
body |
string(date) |
false |
Date of the signed |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» statusId |
body |
integer(int64) |
false |
Unique identifier for the status |
»» shareable |
body |
boolean |
false |
Boolean flag indicating shareable status |
»» size |
body |
integer(int64) |
false |
Number of items per page |
»» documentType |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» priority |
body |
integer(int64) |
false |
Priority of the resource |
»»» internalId |
body |
integer(int64) |
false |
Unique identifier for the internal |
»»» pickListCode |
body |
string |
false |
Code for the pick list |
»»» pickListLabel |
body |
string |
false |
Label for the pick list |
»»» label |
body |
string |
false |
Label for the resource |
»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»» labelDtos |
body |
false |
List of labelDtos items |
|
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»»» value |
body |
string |
true |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
»» status |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
Body Parameters
1{
2 "document": {
3 "archived": true,
4 "createdBy": "string",
5 "createdDate": "2019-08-24 14:15:22+00:00",
6 "description": "string",
7 "documentType": {
8 "archived": true,
9 "createdBy": "string",
10 "createdDate": "2019-08-24 14:15:22+00:00",
11 "cultureId": 0,
12 "externalId": "string",
13 "id": 0,
14 "internalId": 0,
15 "label": "string",
16 "labelDtos": [
17 {
18 "archived": true,
19 "createdBy": "string",
20 "createdDate": "2019-08-24 14:15:22+00:00",
21 "cultureId": 0,
22 "externalId": "string",
23 "id": 0,
24 "lastModifiedBy": "string",
25 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26 "value": "string"
27 }
28 ],
29 "lastModifiedBy": "string",
30 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "priority": 0
34 },
35 "documentTypeId": 0,
36 "externalId": "string",
37 "id": 0,
38 "lastModifiedBy": "string",
39 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40 "link": "string",
41 "name": "string",
42 "shareable": true,
43 "signedDate": "2019-08-24",
44 "size": 0,
45 "status": {
46 "archived": true,
47 "createdBy": "string",
48 "createdDate": "2019-08-24 14:15:22+00:00",
49 "cultureId": 0,
50 "externalId": "string",
51 "id": 0,
52 "internalId": 0,
53 "label": "string",
54 "labelDtos": [
55 {
56 "archived": true,
57 "createdBy": "string",
58 "createdDate": "2019-08-24 14:15:22+00:00",
59 "cultureId": 0,
60 "externalId": "string",
61 "id": 0,
62 "lastModifiedBy": "string",
63 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64 "value": "string"
65 }
66 ],
67 "lastModifiedBy": "string",
68 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69 "pickListCode": "string",
70 "pickListLabel": "string",
71 "priority": 0
72 },
73 "statusId": 0,
74 "title": "string",
75 "type": "string"
76 },
77 "file": "string"
78}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "name": "string",
10 "title": "string",
11 "type": "string",
12 "description": "string",
13 "link": "string",
14 "signedDate": "2019-08-24",
15 "documentTypeId": 0,
16 "statusId": 0,
17 "shareable": true,
18 "size": 0,
19 "documentType": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "priority": 0,
28 "internalId": 0,
29 "pickListCode": "string",
30 "pickListLabel": "string",
31 "label": "string",
32 "cultureId": 0,
33 "labelDtos": [
34 {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "cultureId": 0,
43 "value": "string"
44 }
45 ]
46 },
47 "status": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 }
75}
Operating Cost Period - Archive Operating Cost Period¶
HTTP Request
POST /api/operating-cost-periods/{id}/archive
📋 Description: Archives the specified operating cost period, facilitating effective management of portfolio and asset analytics within the Nakisa Portfolio Management Suite for 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 |
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 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "year": 1950,
12 "statusId": 0,
13 "expenses": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "operatingCostExpenseTypeId": 0,
23 "amount": 0,
24 "revisedAmount": 0,
25 "considerRevisedAmount": true,
26 "operatingCostExpenseType": {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "priority": 0,
35 "internalId": 0,
36 "pickListCode": "string",
37 "pickListLabel": "string",
38 "label": "string",
39 "cultureId": 0,
40 "labelDtos": [
41 {
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 "cultureId": 0,
50 "value": "string"
51 }
52 ]
53 },
54 "expenseGroup": {
55 "createdBy": "string",
56 "lastModifiedBy": "string",
57 "createdDate": "2019-08-24T14:15:22Z",
58 "lastModifiedDate": "2019-08-24T14:15:22Z",
59 "archived": true,
60 "externalId": "string",
61 "id": 0,
62 "priority": 0,
63 "internalId": 0,
64 "pickListCode": "string",
65 "pickListLabel": "string",
66 "label": "string",
67 "cultureId": 0,
68 "labelDtos": [
69 {
70 "createdBy": "string",
71 "lastModifiedBy": "string",
72 "createdDate": "2019-08-24T14:15:22Z",
73 "lastModifiedDate": "2019-08-24T14:15:22Z",
74 "archived": true,
75 "externalId": "string",
76 "id": 0,
77 "cultureId": 0,
78 "value": "string"
79 }
80 ]
81 }
82 }
83 ],
84 "status": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "leaseReconciliationPeriods": [
113 {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "startDate": "2019-08-24",
122 "endDate": "2019-08-24",
123 "statusId": 0,
124 "invoiceAmount": 0,
125 "receivedDate": "2019-08-24",
126 "acceptedAmount": 0,
127 "reviewedBy": "string",
128 "reviewedDate": "2019-08-24",
129 "fullReconciliation": true,
130 "status": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "priority": 0,
139 "internalId": 0,
140 "pickListCode": "string",
141 "pickListLabel": "string",
142 "label": "string",
143 "cultureId": 0,
144 "labelDtos": [
145 {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "cultureId": 0,
154 "value": "string"
155 }
156 ]
157 },
158 "operatingCostPeriodId": 0,
159 "reconciledExpenseCategoryDtos": [
160 {
161 "createdBy": "string",
162 "lastModifiedBy": "string",
163 "createdDate": "2019-08-24T14:15:22Z",
164 "lastModifiedDate": "2019-08-24T14:15:22Z",
165 "archived": true,
166 "externalId": "string",
167 "id": 0,
168 "expenseGroupId": 0,
169 "totalCost": 0,
170 "accrualAmount": 0,
171 "balance": 0,
172 "expenseGroup": {
173 "createdBy": "string",
174 "lastModifiedBy": "string",
175 "createdDate": "2019-08-24T14:15:22Z",
176 "lastModifiedDate": "2019-08-24T14:15:22Z",
177 "archived": true,
178 "externalId": "string",
179 "id": 0,
180 "priority": 0,
181 "internalId": 0,
182 "pickListCode": "string",
183 "pickListLabel": "string",
184 "label": "string",
185 "cultureId": 0,
186 "labelDtos": [
187 {
188 "createdBy": "string",
189 "lastModifiedBy": "string",
190 "createdDate": "2019-08-24T14:15:22Z",
191 "lastModifiedDate": "2019-08-24T14:15:22Z",
192 "archived": true,
193 "externalId": "string",
194 "id": 0,
195 "cultureId": 0,
196 "value": "string"
197 }
198 ]
199 },
200 "reconciledExpenseDtos": [
201 {
202 "createdBy": "string",
203 "lastModifiedBy": "string",
204 "createdDate": "2019-08-24T14:15:22Z",
205 "lastModifiedDate": "2019-08-24T14:15:22Z",
206 "archived": true,
207 "externalId": "string",
208 "id": 0,
209 "totalCost": 0,
210 "operatingCostExpenseTypeId": 0,
211 "operatingCostExpenseType": {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "priority": 0,
220 "internalId": 0,
221 "pickListCode": "string",
222 "pickListLabel": "string",
223 "label": "string",
224 "cultureId": 0,
225 "labelDtos": [
226 {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "cultureId": 0,
235 "value": "string"
236 }
237 ]
238 },
239 "reconciledExpenseSegmentDtos": [
240 {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "startDate": "2019-08-24",
249 "endDate": "2019-08-24",
250 "adjustedLocationCost": 0,
251 "proSharePercentage": 0,
252 "proShareCost": 0,
253 "cap": 0,
254 "subtotalCost": 0,
255 "adminFees": 0,
256 "totalCost": 0,
257 "conditionDto": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "parentConditionId": 0,
266 "typeId": 0,
267 "startDate": "2019-08-24",
268 "endDate": "2019-08-24",
269 "replaceById": 0,
270 "managedById": 0,
271 "payById": 0,
272 "adminFee": 0,
273 "fixedIncreasePercentage": 0,
274 "note": "string",
275 "pageNumber": "string",
276 "section": "string",
277 "type": {},
278 "replaceBy": {},
279 "managedBy": {},
280 "payBy": {},
281 "proShareDto": {},
282 "capDto": {}
283 }
284 }
285 ]
286 }
287 ],
288 "hasWarning": true
289 }
290 ]
291 }
292 ]
293}
Operating Cost Period - Get Operating Cost Period Expenses¶
HTTP Request
GET /api/operating-cost-periods/{operatingCostPeriodId}/operating-cost-period-expenses
📋 Description: Retrieves a list of operating cost expenses associated with a specific operating cost period, enabling users to analyze financial data related to portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the operating cost period expenses should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
operatingCostPeriodId |
path |
string |
true |
Unique identifier for the operating cost period |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
Operating Cost Period - Get Operating Cost Period¶
HTTP Request
GET /api/operating-cost-periods/{id}
📋 Description: Retrieves detailed information about a specific operating cost period for a given asset within the Nakisa Portfolio Management Suite, enabling enhanced analytics and decision-making for 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 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "year": 1950,
12 "statusId": 0,
13 "expenses": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "operatingCostExpenseTypeId": 0,
23 "amount": 0,
24 "revisedAmount": 0,
25 "considerRevisedAmount": true,
26 "operatingCostExpenseType": {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "priority": 0,
35 "internalId": 0,
36 "pickListCode": "string",
37 "pickListLabel": "string",
38 "label": "string",
39 "cultureId": 0,
40 "labelDtos": [
41 {
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 "cultureId": 0,
50 "value": "string"
51 }
52 ]
53 },
54 "expenseGroup": {
55 "createdBy": "string",
56 "lastModifiedBy": "string",
57 "createdDate": "2019-08-24T14:15:22Z",
58 "lastModifiedDate": "2019-08-24T14:15:22Z",
59 "archived": true,
60 "externalId": "string",
61 "id": 0,
62 "priority": 0,
63 "internalId": 0,
64 "pickListCode": "string",
65 "pickListLabel": "string",
66 "label": "string",
67 "cultureId": 0,
68 "labelDtos": [
69 {
70 "createdBy": "string",
71 "lastModifiedBy": "string",
72 "createdDate": "2019-08-24T14:15:22Z",
73 "lastModifiedDate": "2019-08-24T14:15:22Z",
74 "archived": true,
75 "externalId": "string",
76 "id": 0,
77 "cultureId": 0,
78 "value": "string"
79 }
80 ]
81 }
82 }
83 ],
84 "status": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "leaseReconciliationPeriods": [
113 {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "startDate": "2019-08-24",
122 "endDate": "2019-08-24",
123 "statusId": 0,
124 "invoiceAmount": 0,
125 "receivedDate": "2019-08-24",
126 "acceptedAmount": 0,
127 "reviewedBy": "string",
128 "reviewedDate": "2019-08-24",
129 "fullReconciliation": true,
130 "status": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "priority": 0,
139 "internalId": 0,
140 "pickListCode": "string",
141 "pickListLabel": "string",
142 "label": "string",
143 "cultureId": 0,
144 "labelDtos": [
145 {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "cultureId": 0,
154 "value": "string"
155 }
156 ]
157 },
158 "operatingCostPeriodId": 0,
159 "reconciledExpenseCategoryDtos": [
160 {
161 "createdBy": "string",
162 "lastModifiedBy": "string",
163 "createdDate": "2019-08-24T14:15:22Z",
164 "lastModifiedDate": "2019-08-24T14:15:22Z",
165 "archived": true,
166 "externalId": "string",
167 "id": 0,
168 "expenseGroupId": 0,
169 "totalCost": 0,
170 "accrualAmount": 0,
171 "balance": 0,
172 "expenseGroup": {
173 "createdBy": "string",
174 "lastModifiedBy": "string",
175 "createdDate": "2019-08-24T14:15:22Z",
176 "lastModifiedDate": "2019-08-24T14:15:22Z",
177 "archived": true,
178 "externalId": "string",
179 "id": 0,
180 "priority": 0,
181 "internalId": 0,
182 "pickListCode": "string",
183 "pickListLabel": "string",
184 "label": "string",
185 "cultureId": 0,
186 "labelDtos": [
187 {
188 "createdBy": "string",
189 "lastModifiedBy": "string",
190 "createdDate": "2019-08-24T14:15:22Z",
191 "lastModifiedDate": "2019-08-24T14:15:22Z",
192 "archived": true,
193 "externalId": "string",
194 "id": 0,
195 "cultureId": 0,
196 "value": "string"
197 }
198 ]
199 },
200 "reconciledExpenseDtos": [
201 {
202 "createdBy": "string",
203 "lastModifiedBy": "string",
204 "createdDate": "2019-08-24T14:15:22Z",
205 "lastModifiedDate": "2019-08-24T14:15:22Z",
206 "archived": true,
207 "externalId": "string",
208 "id": 0,
209 "totalCost": 0,
210 "operatingCostExpenseTypeId": 0,
211 "operatingCostExpenseType": {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "priority": 0,
220 "internalId": 0,
221 "pickListCode": "string",
222 "pickListLabel": "string",
223 "label": "string",
224 "cultureId": 0,
225 "labelDtos": [
226 {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "cultureId": 0,
235 "value": "string"
236 }
237 ]
238 },
239 "reconciledExpenseSegmentDtos": [
240 {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "startDate": "2019-08-24",
249 "endDate": "2019-08-24",
250 "adjustedLocationCost": 0,
251 "proSharePercentage": 0,
252 "proShareCost": 0,
253 "cap": 0,
254 "subtotalCost": 0,
255 "adminFees": 0,
256 "totalCost": 0,
257 "conditionDto": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "parentConditionId": 0,
266 "typeId": 0,
267 "startDate": "2019-08-24",
268 "endDate": "2019-08-24",
269 "replaceById": 0,
270 "managedById": 0,
271 "payById": 0,
272 "adminFee": 0,
273 "fixedIncreasePercentage": 0,
274 "note": "string",
275 "pageNumber": "string",
276 "section": "string",
277 "type": {},
278 "replaceBy": {},
279 "managedBy": {},
280 "payBy": {},
281 "proShareDto": {},
282 "capDto": {}
283 }
284 }
285 ]
286 }
287 ],
288 "hasWarning": true
289 }
290 ]
291 }
292 ]
293}
Operating Cost Period - Delete Operating Cost Period¶
HTTP Request
DELETE /api/operating-cost-periods/{id}
📋 Description: Deletes a specified operating cost period from the Nakisa Portfolio Management Suite, enabling users to maintain accurate financial records and streamline asset management within their real estate portfolio.
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 |
Operating Cost Period - Download Operating Cost Period Document¶
HTTP Request
GET /api/operating-cost-periods/{id}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a given operating cost period in the Nakisa Portfolio Management Suite, facilitating access to critical asset and portfolio analytics for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Operating Cost Period - Delete Operating Cost Period Document¶
HTTP Request
DELETE /api/operating-cost-periods/{id}/documents/{documentId}
📋 Description: Deletes a specified document associated with a given operating cost period in the Nakisa Portfolio Management Suite, facilitating streamlined management of portfolio-related documentation for enhanced asset analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |