Lease Reconciliation Period¶
Lease Reconciliation Period - Get Lease Reconciliation Period¶
HTTP Request
GET /api/lease-reconciliation-periods/{id}
📋 Description: Retrieves detailed information about a specific lease reconciliation period identified by the provided ID, facilitating effective 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 |
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 "statusId": 0,
12 "invoiceAmount": 0,
13 "receivedDate": "2019-08-24",
14 "acceptedAmount": 0,
15 "reviewedBy": "string",
16 "reviewedDate": "2019-08-24",
17 "fullReconciliation": true,
18 "status": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "operatingCostPeriodId": 0,
47 "reconciledExpenseCategoryDtos": [
48 {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "expenseGroupId": 0,
57 "totalCost": 0,
58 "accrualAmount": 0,
59 "balance": 0,
60 "expenseGroup": {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "priority": 0,
69 "internalId": 0,
70 "pickListCode": "string",
71 "pickListLabel": "string",
72 "label": "string",
73 "cultureId": 0,
74 "labelDtos": [
75 {
76 "createdBy": "string",
77 "lastModifiedBy": "string",
78 "createdDate": "2019-08-24T14:15:22Z",
79 "lastModifiedDate": "2019-08-24T14:15:22Z",
80 "archived": true,
81 "externalId": "string",
82 "id": 0,
83 "cultureId": 0,
84 "value": "string"
85 }
86 ]
87 },
88 "reconciledExpenseDtos": [
89 {
90 "createdBy": "string",
91 "lastModifiedBy": "string",
92 "createdDate": "2019-08-24T14:15:22Z",
93 "lastModifiedDate": "2019-08-24T14:15:22Z",
94 "archived": true,
95 "externalId": "string",
96 "id": 0,
97 "totalCost": 0,
98 "operatingCostExpenseTypeId": 0,
99 "operatingCostExpenseType": {
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 "priority": 0,
108 "internalId": 0,
109 "pickListCode": "string",
110 "pickListLabel": "string",
111 "label": "string",
112 "cultureId": 0,
113 "labelDtos": [
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 "cultureId": 0,
123 "value": "string"
124 }
125 ]
126 },
127 "reconciledExpenseSegmentDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "startDate": "2019-08-24",
137 "endDate": "2019-08-24",
138 "adjustedLocationCost": 0,
139 "proSharePercentage": 0,
140 "proShareCost": 0,
141 "cap": 0,
142 "subtotalCost": 0,
143 "adminFees": 0,
144 "totalCost": 0,
145 "conditionDto": {
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 "parentConditionId": 0,
154 "typeId": 0,
155 "startDate": "2019-08-24",
156 "endDate": "2019-08-24",
157 "replaceById": 0,
158 "managedById": 0,
159 "payById": 0,
160 "adminFee": 0,
161 "fixedIncreasePercentage": 0,
162 "note": "string",
163 "pageNumber": "string",
164 "section": "string",
165 "type": {
166 "createdBy": "string",
167 "lastModifiedBy": "string",
168 "createdDate": "2019-08-24T14:15:22Z",
169 "lastModifiedDate": "2019-08-24T14:15:22Z",
170 "archived": true,
171 "externalId": "string",
172 "id": 0,
173 "priority": 0,
174 "internalId": 0,
175 "pickListCode": "string",
176 "pickListLabel": "string",
177 "label": "string",
178 "cultureId": 0,
179 "labelDtos": [
180 {}
181 ]
182 },
183 "replaceBy": {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "priority": 0,
192 "internalId": 0,
193 "pickListCode": "string",
194 "pickListLabel": "string",
195 "label": "string",
196 "cultureId": 0,
197 "labelDtos": [
198 {}
199 ]
200 },
201 "managedBy": {
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 "priority": 0,
210 "internalId": 0,
211 "pickListCode": "string",
212 "pickListLabel": "string",
213 "label": "string",
214 "cultureId": 0,
215 "labelDtos": [
216 {}
217 ]
218 },
219 "payBy": {
220 "createdBy": "string",
221 "lastModifiedBy": "string",
222 "createdDate": "2019-08-24T14:15:22Z",
223 "lastModifiedDate": "2019-08-24T14:15:22Z",
224 "archived": true,
225 "externalId": "string",
226 "id": 0,
227 "priority": 0,
228 "internalId": 0,
229 "pickListCode": "string",
230 "pickListLabel": "string",
231 "label": "string",
232 "cultureId": 0,
233 "labelDtos": [
234 {}
235 ]
236 },
237 "proShareDto": {
238 "createdBy": "string",
239 "lastModifiedBy": "string",
240 "createdDate": "2019-08-24T14:15:22Z",
241 "lastModifiedDate": "2019-08-24T14:15:22Z",
242 "archived": true,
243 "externalId": "string",
244 "id": 0,
245 "type": "string"
246 },
247 "capDto": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "type": "string"
256 }
257 }
258 }
259 ]
260 }
261 ],
262 "hasWarning": true
263 }
264 ]
265}
Lease Reconciliation Period - Update Lease Reconciliation Period¶
HTTP Request
PUT /api/lease-reconciliation-periods/{id}
📋 Description: Updates the details of a specified lease reconciliation period within the Nakisa Portfolio Management Suite, enabling accurate asset management and enhanced 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 updated lease reconciliation period details, including financial metrics and associated asset information, for effective portfolio and asset management. |
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 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "statusId": 0,
12 "invoiceAmount": 0,
13 "receivedDate": "2019-08-24",
14 "acceptedAmount": 0,
15 "reviewedBy": "string",
16 "reviewedDate": "2019-08-24",
17 "fullReconciliation": true,
18 "status": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "operatingCostPeriodId": 0,
47 "reconciledExpenseCategoryDtos": [
48 {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "expenseGroupId": 0,
57 "totalCost": 0,
58 "accrualAmount": 0,
59 "balance": 0,
60 "expenseGroup": {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "priority": 0,
69 "internalId": 0,
70 "pickListCode": "string",
71 "pickListLabel": "string",
72 "label": "string",
73 "cultureId": 0,
74 "labelDtos": [
75 {
76 "createdBy": "string",
77 "lastModifiedBy": "string",
78 "createdDate": "2019-08-24T14:15:22Z",
79 "lastModifiedDate": "2019-08-24T14:15:22Z",
80 "archived": true,
81 "externalId": "string",
82 "id": 0,
83 "cultureId": 0,
84 "value": "string"
85 }
86 ]
87 },
88 "reconciledExpenseDtos": [
89 {
90 "createdBy": "string",
91 "lastModifiedBy": "string",
92 "createdDate": "2019-08-24T14:15:22Z",
93 "lastModifiedDate": "2019-08-24T14:15:22Z",
94 "archived": true,
95 "externalId": "string",
96 "id": 0,
97 "totalCost": 0,
98 "operatingCostExpenseTypeId": 0,
99 "operatingCostExpenseType": {
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 "priority": 0,
108 "internalId": 0,
109 "pickListCode": "string",
110 "pickListLabel": "string",
111 "label": "string",
112 "cultureId": 0,
113 "labelDtos": [
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 "cultureId": 0,
123 "value": "string"
124 }
125 ]
126 },
127 "reconciledExpenseSegmentDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "startDate": "2019-08-24",
137 "endDate": "2019-08-24",
138 "adjustedLocationCost": 0,
139 "proSharePercentage": 0,
140 "proShareCost": 0,
141 "cap": 0,
142 "subtotalCost": 0,
143 "adminFees": 0,
144 "totalCost": 0,
145 "conditionDto": {
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 "parentConditionId": 0,
154 "typeId": 0,
155 "startDate": "2019-08-24",
156 "endDate": "2019-08-24",
157 "replaceById": 0,
158 "managedById": 0,
159 "payById": 0,
160 "adminFee": 0,
161 "fixedIncreasePercentage": 0,
162 "note": "string",
163 "pageNumber": "string",
164 "section": "string",
165 "type": {
166 "createdBy": "string",
167 "lastModifiedBy": "string",
168 "createdDate": "2019-08-24T14:15:22Z",
169 "lastModifiedDate": "2019-08-24T14:15:22Z",
170 "archived": true,
171 "externalId": "string",
172 "id": 0,
173 "priority": 0,
174 "internalId": 0,
175 "pickListCode": "string",
176 "pickListLabel": "string",
177 "label": "string",
178 "cultureId": 0,
179 "labelDtos": [
180 {}
181 ]
182 },
183 "replaceBy": {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "priority": 0,
192 "internalId": 0,
193 "pickListCode": "string",
194 "pickListLabel": "string",
195 "label": "string",
196 "cultureId": 0,
197 "labelDtos": [
198 {}
199 ]
200 },
201 "managedBy": {
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 "priority": 0,
210 "internalId": 0,
211 "pickListCode": "string",
212 "pickListLabel": "string",
213 "label": "string",
214 "cultureId": 0,
215 "labelDtos": [
216 {}
217 ]
218 },
219 "payBy": {
220 "createdBy": "string",
221 "lastModifiedBy": "string",
222 "createdDate": "2019-08-24T14:15:22Z",
223 "lastModifiedDate": "2019-08-24T14:15:22Z",
224 "archived": true,
225 "externalId": "string",
226 "id": 0,
227 "priority": 0,
228 "internalId": 0,
229 "pickListCode": "string",
230 "pickListLabel": "string",
231 "label": "string",
232 "cultureId": 0,
233 "labelDtos": [
234 {}
235 ]
236 },
237 "proShareDto": {
238 "createdBy": "string",
239 "lastModifiedBy": "string",
240 "createdDate": "2019-08-24T14:15:22Z",
241 "lastModifiedDate": "2019-08-24T14:15:22Z",
242 "archived": true,
243 "externalId": "string",
244 "id": 0,
245 "type": "string"
246 },
247 "capDto": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "type": "string"
256 }
257 }
258 }
259 ]
260 }
261 ],
262 "hasWarning": true
263 }
264 ]
265}
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 "statusId": 0,
12 "invoiceAmount": 0,
13 "receivedDate": "2019-08-24",
14 "acceptedAmount": 0,
15 "reviewedBy": "string",
16 "reviewedDate": "2019-08-24",
17 "fullReconciliation": true,
18 "status": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "operatingCostPeriodId": 0,
47 "reconciledExpenseCategoryDtos": [
48 {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "expenseGroupId": 0,
57 "totalCost": 0,
58 "accrualAmount": 0,
59 "balance": 0,
60 "expenseGroup": {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "priority": 0,
69 "internalId": 0,
70 "pickListCode": "string",
71 "pickListLabel": "string",
72 "label": "string",
73 "cultureId": 0,
74 "labelDtos": [
75 {
76 "createdBy": "string",
77 "lastModifiedBy": "string",
78 "createdDate": "2019-08-24T14:15:22Z",
79 "lastModifiedDate": "2019-08-24T14:15:22Z",
80 "archived": true,
81 "externalId": "string",
82 "id": 0,
83 "cultureId": 0,
84 "value": "string"
85 }
86 ]
87 },
88 "reconciledExpenseDtos": [
89 {
90 "createdBy": "string",
91 "lastModifiedBy": "string",
92 "createdDate": "2019-08-24T14:15:22Z",
93 "lastModifiedDate": "2019-08-24T14:15:22Z",
94 "archived": true,
95 "externalId": "string",
96 "id": 0,
97 "totalCost": 0,
98 "operatingCostExpenseTypeId": 0,
99 "operatingCostExpenseType": {
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 "priority": 0,
108 "internalId": 0,
109 "pickListCode": "string",
110 "pickListLabel": "string",
111 "label": "string",
112 "cultureId": 0,
113 "labelDtos": [
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 "cultureId": 0,
123 "value": "string"
124 }
125 ]
126 },
127 "reconciledExpenseSegmentDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "startDate": "2019-08-24",
137 "endDate": "2019-08-24",
138 "adjustedLocationCost": 0,
139 "proSharePercentage": 0,
140 "proShareCost": 0,
141 "cap": 0,
142 "subtotalCost": 0,
143 "adminFees": 0,
144 "totalCost": 0,
145 "conditionDto": {
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 "parentConditionId": 0,
154 "typeId": 0,
155 "startDate": "2019-08-24",
156 "endDate": "2019-08-24",
157 "replaceById": 0,
158 "managedById": 0,
159 "payById": 0,
160 "adminFee": 0,
161 "fixedIncreasePercentage": 0,
162 "note": "string",
163 "pageNumber": "string",
164 "section": "string",
165 "type": {
166 "createdBy": "string",
167 "lastModifiedBy": "string",
168 "createdDate": "2019-08-24T14:15:22Z",
169 "lastModifiedDate": "2019-08-24T14:15:22Z",
170 "archived": true,
171 "externalId": "string",
172 "id": 0,
173 "priority": 0,
174 "internalId": 0,
175 "pickListCode": "string",
176 "pickListLabel": "string",
177 "label": "string",
178 "cultureId": 0,
179 "labelDtos": [
180 {}
181 ]
182 },
183 "replaceBy": {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "priority": 0,
192 "internalId": 0,
193 "pickListCode": "string",
194 "pickListLabel": "string",
195 "label": "string",
196 "cultureId": 0,
197 "labelDtos": [
198 {}
199 ]
200 },
201 "managedBy": {
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 "priority": 0,
210 "internalId": 0,
211 "pickListCode": "string",
212 "pickListLabel": "string",
213 "label": "string",
214 "cultureId": 0,
215 "labelDtos": [
216 {}
217 ]
218 },
219 "payBy": {
220 "createdBy": "string",
221 "lastModifiedBy": "string",
222 "createdDate": "2019-08-24T14:15:22Z",
223 "lastModifiedDate": "2019-08-24T14:15:22Z",
224 "archived": true,
225 "externalId": "string",
226 "id": 0,
227 "priority": 0,
228 "internalId": 0,
229 "pickListCode": "string",
230 "pickListLabel": "string",
231 "label": "string",
232 "cultureId": 0,
233 "labelDtos": [
234 {}
235 ]
236 },
237 "proShareDto": {
238 "createdBy": "string",
239 "lastModifiedBy": "string",
240 "createdDate": "2019-08-24T14:15:22Z",
241 "lastModifiedDate": "2019-08-24T14:15:22Z",
242 "archived": true,
243 "externalId": "string",
244 "id": 0,
245 "type": "string"
246 },
247 "capDto": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "type": "string"
256 }
257 }
258 }
259 ]
260 }
261 ],
262 "hasWarning": true
263 }
264 ]
265}
Lease Reconciliation Period - Get Documents For Lease Reconciliation Period¶
HTTP Request
GET /api/lease-reconciliation-periods/{leaseReconciliationPeriodId}/documents
📋 Description: Retrieves documents associated with a specific lease reconciliation period, enabling users to access critical information for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseReconciliationPeriodId |
path |
integer(int64) |
true |
Unique identifier for the lease reconciliation period |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter documents related to the specified lease reconciliation period 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 lease reconciliation period, used to filter documents related to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
signed-date |
query |
string |
false |
Specifies the date on which the document was signed, providing crucial context for lease reconciliation within the portfolio management framework. |
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 lease reconciliation period can be shared, facilitating collaboration and transparency in portfolio and asset management. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with the specified lease reconciliation period, facilitating effective management and analysis of real estate portfolio assets. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with the specified lease reconciliation period, facilitating targeted retrieval of relevant documents 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}
Lease Reconciliation Period - Upload Lease Reconciliation Period Document¶
HTTP Request
POST /api/lease-reconciliation-periods/{leaseReconciliationPeriodId}/documents
📋 Description: Uploads documents associated with a specific lease reconciliation period, facilitating enhanced portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseReconciliationPeriodId |
path |
integer(int64) |
true |
Unique identifier for the lease reconciliation period |
body |
body |
object |
false |
Request body containing the document data related to the specified lease reconciliation period, including relevant metadata for portfolio and asset analytics within the real estate property domain. |
» 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}
Lease Reconciliation Period - Create Ocexpense Type To Lease Conditions¶
HTTP Request
POST /api/lease-reconciliation-periods/{id}/oc-expense-type-to-lease-conditions
📋 Description: Creates a new operational expense type linked to specified lease conditions within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset 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 operational expense type data and associated lease conditions for the specified lease reconciliation period, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
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 "ocExpenseTypeId": 0,
11 "conditionTypeId": 0,
12 "ocExpenseType": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "priority": 0,
21 "internalId": 0,
22 "pickListCode": "string",
23 "pickListLabel": "string",
24 "label": "string",
25 "cultureId": 0,
26 "labelDtos": [
27 {
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 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 },
40 "conditionType": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
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 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 }
68 }
69]
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 "ocExpenseTypeId": 0,
11 "conditionTypeId": 0,
12 "ocExpenseType": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "priority": 0,
21 "internalId": 0,
22 "pickListCode": "string",
23 "pickListLabel": "string",
24 "label": "string",
25 "cultureId": 0,
26 "labelDtos": [
27 {
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 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 },
40 "conditionType": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
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 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 }
68 }
69]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the relationship between expense types and lease conditions within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and management of real estate property assets.] |
|
» 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 |
» ocExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the oc expense type |
» conditionTypeId |
integer(int64) |
false |
none |
Unique identifier for the condition type |
» ocExpenseType |
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. |
» conditionType |
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. |
Lease Reconciliation Period - Get Reconciliation Period Notes¶
HTTP Request
GET /api/lease-reconciliation-periods/{id}/notes
📋 Description: Fetches notes associated with a specific lease reconciliation period, enabling users to access relevant documentation 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 response should be paginated, allowing users to efficiently retrieve notes related to a specific lease reconciliation period within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter notes related to the specified lease reconciliation period within the Nakisa Portfolio Management Suite. |
message |
query |
string |
false |
Textual content of the note associated with the specified lease reconciliation 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}
Lease Reconciliation Period - Add Reconciliation Period Notes¶
HTTP Request
POST /api/lease-reconciliation-periods/{id}/notes
📋 Description: Adds a new note to the specified lease reconciliation period, enabling enhanced documentation and tracking of portfolio-related insights within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the lease reconciliation notes data, including relevant details and annotations for effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
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. |
Lease Reconciliation Period - Calculate Reconciliation Period Expenses¶
HTTP Request
POST /api/lease-reconciliation-periods/{id}/calculate
📋 Description: Calculates the lease reconciliation period for a specified asset within the Nakisa Portfolio Management Suite, enabling enhanced analytics and financial accuracy in 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 |
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 "expenseGroupId": 0,
11 "totalCost": 0,
12 "accrualAmount": 0,
13 "balance": 0,
14 "expenseGroup": {
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 "reconciledExpenseDtos": [
43 {
44 "createdBy": "string",
45 "lastModifiedBy": "string",
46 "createdDate": "2019-08-24T14:15:22Z",
47 "lastModifiedDate": "2019-08-24T14:15:22Z",
48 "archived": true,
49 "externalId": "string",
50 "id": 0,
51 "totalCost": 0,
52 "operatingCostExpenseTypeId": 0,
53 "operatingCostExpenseType": {
54 "createdBy": "string",
55 "lastModifiedBy": "string",
56 "createdDate": "2019-08-24T14:15:22Z",
57 "lastModifiedDate": "2019-08-24T14:15:22Z",
58 "archived": true,
59 "externalId": "string",
60 "id": 0,
61 "priority": 0,
62 "internalId": 0,
63 "pickListCode": "string",
64 "pickListLabel": "string",
65 "label": "string",
66 "cultureId": 0,
67 "labelDtos": [
68 {
69 "createdBy": "string",
70 "lastModifiedBy": "string",
71 "createdDate": "2019-08-24T14:15:22Z",
72 "lastModifiedDate": "2019-08-24T14:15:22Z",
73 "archived": true,
74 "externalId": "string",
75 "id": 0,
76 "cultureId": 0,
77 "value": "string"
78 }
79 ]
80 },
81 "reconciledExpenseSegmentDtos": [
82 {
83 "createdBy": "string",
84 "lastModifiedBy": "string",
85 "createdDate": "2019-08-24T14:15:22Z",
86 "lastModifiedDate": "2019-08-24T14:15:22Z",
87 "archived": true,
88 "externalId": "string",
89 "id": 0,
90 "startDate": "2019-08-24",
91 "endDate": "2019-08-24",
92 "adjustedLocationCost": 0,
93 "proSharePercentage": 0,
94 "proShareCost": 0,
95 "cap": 0,
96 "subtotalCost": 0,
97 "adminFees": 0,
98 "totalCost": 0,
99 "conditionDto": {
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 "parentConditionId": 0,
108 "typeId": 0,
109 "startDate": "2019-08-24",
110 "endDate": "2019-08-24",
111 "replaceById": 0,
112 "managedById": 0,
113 "payById": 0,
114 "adminFee": 0,
115 "fixedIncreasePercentage": 0,
116 "note": "string",
117 "pageNumber": "string",
118 "section": "string",
119 "type": {
120 "createdBy": "string",
121 "lastModifiedBy": "string",
122 "createdDate": "2019-08-24T14:15:22Z",
123 "lastModifiedDate": "2019-08-24T14:15:22Z",
124 "archived": true,
125 "externalId": "string",
126 "id": 0,
127 "priority": 0,
128 "internalId": 0,
129 "pickListCode": "string",
130 "pickListLabel": "string",
131 "label": "string",
132 "cultureId": 0,
133 "labelDtos": [
134 {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "cultureId": 0,
143 "value": "string"
144 }
145 ]
146 },
147 "replaceBy": {
148 "createdBy": "string",
149 "lastModifiedBy": "string",
150 "createdDate": "2019-08-24T14:15:22Z",
151 "lastModifiedDate": "2019-08-24T14:15:22Z",
152 "archived": true,
153 "externalId": "string",
154 "id": 0,
155 "priority": 0,
156 "internalId": 0,
157 "pickListCode": "string",
158 "pickListLabel": "string",
159 "label": "string",
160 "cultureId": 0,
161 "labelDtos": [
162 {
163 "createdBy": "string",
164 "lastModifiedBy": "string",
165 "createdDate": "2019-08-24T14:15:22Z",
166 "lastModifiedDate": "2019-08-24T14:15:22Z",
167 "archived": true,
168 "externalId": "string",
169 "id": 0,
170 "cultureId": 0,
171 "value": "string"
172 }
173 ]
174 },
175 "managedBy": {
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 "createdBy": "string",
192 "lastModifiedBy": "string",
193 "createdDate": "2019-08-24T14:15:22Z",
194 "lastModifiedDate": "2019-08-24T14:15:22Z",
195 "archived": true,
196 "externalId": "string",
197 "id": 0,
198 "cultureId": 0,
199 "value": "string"
200 }
201 ]
202 },
203 "payBy": {
204 "createdBy": "string",
205 "lastModifiedBy": "string",
206 "createdDate": "2019-08-24T14:15:22Z",
207 "lastModifiedDate": "2019-08-24T14:15:22Z",
208 "archived": true,
209 "externalId": "string",
210 "id": 0,
211 "priority": 0,
212 "internalId": 0,
213 "pickListCode": "string",
214 "pickListLabel": "string",
215 "label": "string",
216 "cultureId": 0,
217 "labelDtos": [
218 {
219 "createdBy": "string",
220 "lastModifiedBy": "string",
221 "createdDate": "2019-08-24T14:15:22Z",
222 "lastModifiedDate": "2019-08-24T14:15:22Z",
223 "archived": true,
224 "externalId": "string",
225 "id": 0,
226 "cultureId": 0,
227 "value": "string"
228 }
229 ]
230 },
231 "proShareDto": {
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 "type": "string"
240 },
241 "capDto": {
242 "createdBy": "string",
243 "lastModifiedBy": "string",
244 "createdDate": "2019-08-24T14:15:22Z",
245 "lastModifiedDate": "2019-08-24T14:15:22Z",
246 "archived": true,
247 "externalId": "string",
248 "id": 0,
249 "type": "string"
250 }
251 }
252 }
253 ]
254 }
255 ],
256 "hasWarning": true
257 }
258]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a reconciled expense category within the Nakisa Portfolio Management Suite, facilitating the analysis and management of expenses related to portfolios, assets, and real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» 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. |
|
»» 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. |
» 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 |
Lease Reconciliation Period - Archive Lease Reconciliation Period¶
HTTP Request
POST /api/lease-reconciliation-periods/{id}/archive
📋 Description: Archives the specified lease reconciliation period, facilitating effective portfolio management 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 |
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 "statusId": 0,
12 "invoiceAmount": 0,
13 "receivedDate": "2019-08-24",
14 "acceptedAmount": 0,
15 "reviewedBy": "string",
16 "reviewedDate": "2019-08-24",
17 "fullReconciliation": true,
18 "status": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "operatingCostPeriodId": 0,
47 "reconciledExpenseCategoryDtos": [
48 {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "expenseGroupId": 0,
57 "totalCost": 0,
58 "accrualAmount": 0,
59 "balance": 0,
60 "expenseGroup": {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "priority": 0,
69 "internalId": 0,
70 "pickListCode": "string",
71 "pickListLabel": "string",
72 "label": "string",
73 "cultureId": 0,
74 "labelDtos": [
75 {
76 "createdBy": "string",
77 "lastModifiedBy": "string",
78 "createdDate": "2019-08-24T14:15:22Z",
79 "lastModifiedDate": "2019-08-24T14:15:22Z",
80 "archived": true,
81 "externalId": "string",
82 "id": 0,
83 "cultureId": 0,
84 "value": "string"
85 }
86 ]
87 },
88 "reconciledExpenseDtos": [
89 {
90 "createdBy": "string",
91 "lastModifiedBy": "string",
92 "createdDate": "2019-08-24T14:15:22Z",
93 "lastModifiedDate": "2019-08-24T14:15:22Z",
94 "archived": true,
95 "externalId": "string",
96 "id": 0,
97 "totalCost": 0,
98 "operatingCostExpenseTypeId": 0,
99 "operatingCostExpenseType": {
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 "priority": 0,
108 "internalId": 0,
109 "pickListCode": "string",
110 "pickListLabel": "string",
111 "label": "string",
112 "cultureId": 0,
113 "labelDtos": [
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 "cultureId": 0,
123 "value": "string"
124 }
125 ]
126 },
127 "reconciledExpenseSegmentDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "startDate": "2019-08-24",
137 "endDate": "2019-08-24",
138 "adjustedLocationCost": 0,
139 "proSharePercentage": 0,
140 "proShareCost": 0,
141 "cap": 0,
142 "subtotalCost": 0,
143 "adminFees": 0,
144 "totalCost": 0,
145 "conditionDto": {
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 "parentConditionId": 0,
154 "typeId": 0,
155 "startDate": "2019-08-24",
156 "endDate": "2019-08-24",
157 "replaceById": 0,
158 "managedById": 0,
159 "payById": 0,
160 "adminFee": 0,
161 "fixedIncreasePercentage": 0,
162 "note": "string",
163 "pageNumber": "string",
164 "section": "string",
165 "type": {
166 "createdBy": "string",
167 "lastModifiedBy": "string",
168 "createdDate": "2019-08-24T14:15:22Z",
169 "lastModifiedDate": "2019-08-24T14:15:22Z",
170 "archived": true,
171 "externalId": "string",
172 "id": 0,
173 "priority": 0,
174 "internalId": 0,
175 "pickListCode": "string",
176 "pickListLabel": "string",
177 "label": "string",
178 "cultureId": 0,
179 "labelDtos": [
180 {}
181 ]
182 },
183 "replaceBy": {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "priority": 0,
192 "internalId": 0,
193 "pickListCode": "string",
194 "pickListLabel": "string",
195 "label": "string",
196 "cultureId": 0,
197 "labelDtos": [
198 {}
199 ]
200 },
201 "managedBy": {
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 "priority": 0,
210 "internalId": 0,
211 "pickListCode": "string",
212 "pickListLabel": "string",
213 "label": "string",
214 "cultureId": 0,
215 "labelDtos": [
216 {}
217 ]
218 },
219 "payBy": {
220 "createdBy": "string",
221 "lastModifiedBy": "string",
222 "createdDate": "2019-08-24T14:15:22Z",
223 "lastModifiedDate": "2019-08-24T14:15:22Z",
224 "archived": true,
225 "externalId": "string",
226 "id": 0,
227 "priority": 0,
228 "internalId": 0,
229 "pickListCode": "string",
230 "pickListLabel": "string",
231 "label": "string",
232 "cultureId": 0,
233 "labelDtos": [
234 {}
235 ]
236 },
237 "proShareDto": {
238 "createdBy": "string",
239 "lastModifiedBy": "string",
240 "createdDate": "2019-08-24T14:15:22Z",
241 "lastModifiedDate": "2019-08-24T14:15:22Z",
242 "archived": true,
243 "externalId": "string",
244 "id": 0,
245 "type": "string"
246 },
247 "capDto": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "type": "string"
256 }
257 }
258 }
259 ]
260 }
261 ],
262 "hasWarning": true
263 }
264 ]
265}
Lease Reconciliation Period - Create Reconciliation Adjustment Terms¶
HTTP Request
POST /api/lease-reconciliation-periods/{id}/adjustment-terms
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "date": "2019-08-24",
4 "amount": 0,
5 "expenseCategoryId": 0,
6 "operatingCostExpenseTypeId": 0,
7 "conditionId": 0,
8 "vendors": [
9 {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "partner": 0,
17 "ownership": 0.1,
18 "calculateTax": true,
19 "taxExemptionPercentage": 0,
20 "taxCodeDeterminationId": 0,
21 "partnerDto": {
22 "id": 0,
23 "status": "CREATED",
24 "displayId": "string",
25 "erpSystemId": 0,
26 "erpSystemDisplayId": "string",
27 "name": "string",
28 "fax": "string",
29 "phone": "string",
30 "parentId": 0,
31 "parentName": "string",
32 "parentDisplayId": "string",
33 "companyId": 0,
34 "partnerRoleId": 0,
35 "partnerContactId": 0
36 }
37 }
38 ]
39 }
40]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "draftVersionExternalId": "string",
3 "draftVersionFileNumber": "string",
4 "newTermCount": 0
5}
Lease Reconciliation Period - Get Lease Reconciliation Periods¶
HTTP Request
GET /api/lease-reconciliation-periods
📋 Description: Retrieves a list of lease reconciliation periods, enabling users to analyze and manage lease-related financial data within the Nakisa Portfolio Management Suite for effective portfolio and asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lease reconciliation periods query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
start-date |
query |
string |
false |
Specifies the starting date for the lease reconciliation period, enabling users to filter and analyze portfolio and asset data within the Nakisa Portfolio Management Suite. |
end-date |
query |
string |
false |
Specifies the end date for the lease reconciliation period, enabling users to retrieve relevant data for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of lease reconciliation periods, facilitating efficient tracking and analysis within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseReconciliationPeriods": [
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 "statusId": 0,
15 "invoiceAmount": 0,
16 "receivedDate": "2019-08-24",
17 "acceptedAmount": 0,
18 "reviewedBy": "string",
19 "reviewedDate": "2019-08-24",
20 "fullReconciliation": true,
21 "status": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "operatingCostPeriodId": 0,
50 "reconciledExpenseCategoryDtos": [
51 {
52 "createdBy": "string",
53 "lastModifiedBy": "string",
54 "createdDate": "2019-08-24T14:15:22Z",
55 "lastModifiedDate": "2019-08-24T14:15:22Z",
56 "archived": true,
57 "externalId": "string",
58 "id": 0,
59 "expenseGroupId": 0,
60 "totalCost": 0,
61 "accrualAmount": 0,
62 "balance": 0,
63 "expenseGroup": {
64 "createdBy": "string",
65 "lastModifiedBy": "string",
66 "createdDate": "2019-08-24T14:15:22Z",
67 "lastModifiedDate": "2019-08-24T14:15:22Z",
68 "archived": true,
69 "externalId": "string",
70 "id": 0,
71 "priority": 0,
72 "internalId": 0,
73 "pickListCode": "string",
74 "pickListLabel": "string",
75 "label": "string",
76 "cultureId": 0,
77 "labelDtos": [
78 {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "cultureId": 0,
87 "value": "string"
88 }
89 ]
90 },
91 "reconciledExpenseDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "totalCost": 0,
101 "operatingCostExpenseTypeId": 0,
102 "operatingCostExpenseType": {
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 "priority": 0,
111 "internalId": 0,
112 "pickListCode": "string",
113 "pickListLabel": "string",
114 "label": "string",
115 "cultureId": 0,
116 "labelDtos": [
117 {}
118 ]
119 },
120 "reconciledExpenseSegmentDtos": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "startDate": "2019-08-24",
130 "endDate": "2019-08-24",
131 "adjustedLocationCost": 0,
132 "proSharePercentage": 0,
133 "proShareCost": 0,
134 "cap": 0,
135 "subtotalCost": 0,
136 "adminFees": 0,
137 "totalCost": 0,
138 "conditionDto": {}
139 }
140 ]
141 }
142 ],
143 "hasWarning": true
144 }
145 ]
146 }
147 ]
148 },
149 "page": {
150 "size": 0,
151 "totalElements": 0,
152 "totalPages": 0,
153 "number": 0
154 }
155}
Lease Reconciliation Period - Get Reconciled Expenses¶
HTTP Request
GET /api/lease-reconciliation-periods/{reconciliationPeriodId}/reconciled-expense-categories
📋 Description: Fetches reconciled expense categories associated with a specified lease reconciliation period, enabling users to analyze financial data within the Nakisa Portfolio Management Suite for effective portfolio and asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results for reconciled expense categories should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
|
reconciliationPeriodId |
path |
string |
true |
Unique identifier for the reconciliation period |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "reconciledExpenseCategories": [
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 "expenseGroupId": 0,
13 "totalCost": 0,
14 "accrualAmount": 0,
15 "balance": 0,
16 "expenseGroup": {
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 "reconciledExpenseDtos": [
45 {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "totalCost": 0,
54 "operatingCostExpenseTypeId": 0,
55 "operatingCostExpenseType": {
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 "reconciledExpenseSegmentDtos": [
84 {
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 "startDate": "2019-08-24",
93 "endDate": "2019-08-24",
94 "adjustedLocationCost": 0,
95 "proSharePercentage": 0,
96 "proShareCost": 0,
97 "cap": 0,
98 "subtotalCost": 0,
99 "adminFees": 0,
100 "totalCost": 0,
101 "conditionDto": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "parentConditionId": 0,
110 "typeId": 0,
111 "startDate": "2019-08-24",
112 "endDate": "2019-08-24",
113 "replaceById": 0,
114 "managedById": 0,
115 "payById": 0,
116 "adminFee": 0,
117 "fixedIncreasePercentage": 0,
118 "note": "string",
119 "pageNumber": "string",
120 "section": "string",
121 "type": {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "priority": 0,
130 "internalId": 0,
131 "pickListCode": "string",
132 "pickListLabel": "string",
133 "label": "string",
134 "cultureId": 0,
135 "labelDtos": []
136 },
137 "replaceBy": {
138 "createdBy": "string",
139 "lastModifiedBy": "string",
140 "createdDate": "2019-08-24T14:15:22Z",
141 "lastModifiedDate": "2019-08-24T14:15:22Z",
142 "archived": true,
143 "externalId": "string",
144 "id": 0,
145 "priority": 0,
146 "internalId": 0,
147 "pickListCode": "string",
148 "pickListLabel": "string",
149 "label": "string",
150 "cultureId": 0,
151 "labelDtos": []
152 },
153 "managedBy": {
154 "createdBy": "string",
155 "lastModifiedBy": "string",
156 "createdDate": "2019-08-24T14:15:22Z",
157 "lastModifiedDate": "2019-08-24T14:15:22Z",
158 "archived": true,
159 "externalId": "string",
160 "id": 0,
161 "priority": 0,
162 "internalId": 0,
163 "pickListCode": "string",
164 "pickListLabel": "string",
165 "label": "string",
166 "cultureId": 0,
167 "labelDtos": []
168 },
169 "payBy": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "priority": 0,
178 "internalId": 0,
179 "pickListCode": "string",
180 "pickListLabel": "string",
181 "label": "string",
182 "cultureId": 0,
183 "labelDtos": []
184 },
185 "proShareDto": {
186 "createdBy": "string",
187 "lastModifiedBy": "string",
188 "createdDate": "2019-08-24T14:15:22Z",
189 "lastModifiedDate": "2019-08-24T14:15:22Z",
190 "archived": true,
191 "externalId": "string",
192 "id": 0,
193 "type": "string"
194 },
195 "capDto": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "type": "string"
204 }
205 }
206 }
207 ]
208 }
209 ],
210 "hasWarning": true
211 }
212 ]
213 },
214 "page": {
215 "size": 0,
216 "totalElements": 0,
217 "totalPages": 0,
218 "number": 0
219 }
220}
Lease Reconciliation Period - Get Ocexpense Type To Lease Conditions¶
HTTP Request
GET /api/lease-reconciliation-periods/{leaseReconciliationPeriodId}/oc-expense-type-to-lease-conditions
📋 Description: Fetches the operational expense types associated with a specified lease reconciliation period, facilitating enhanced portfolio and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
leaseReconciliationPeriodId |
path |
string |
true |
Unique identifier for the lease reconciliation period |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "oCExpenseTypeToLeaseConditions": [
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 "ocExpenseTypeId": 0,
13 "conditionTypeId": 0,
14 "ocExpenseType": {
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 "conditionType": {
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 ]
72 },
73 "page": {
74 "size": 0,
75 "totalElements": 0,
76 "totalPages": 0,
77 "number": 0
78 }
79}
Lease Reconciliation Period - Download Lease Reconciliation Period Document¶
HTTP Request
GET /api/lease-reconciliation-periods/{id}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a lease reconciliation period, enabling users to access critical documentation 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 |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Lease Reconciliation Period - Delete Lease Reconciliation Period Document¶
HTTP Request
DELETE /api/lease-reconciliation-periods/{leaseReconciliationPeriodId}/documents/{documentId}
📋 Description: Deletes a specific document associated with a lease reconciliation period, enabling effective management of portfolio and asset documentation within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseReconciliationPeriodId |
path |
integer(int64) |
true |
Unique identifier for the lease reconciliation period |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |