Premise¶
Premise - Get Premise¶
HTTP Request
GET /api/premises/{id}
📋 Description: Retrieves detailed information about a specific real estate property within the Nakisa Portfolio Management Suite, identified by the provided premises ID, to support portfolio and asset analytics.
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 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}
Premise - Update Premise¶
HTTP Request
PUT /api/premises/{id}
📋 Description: Updates the details of a specific real estate property within the Nakisa Portfolio Management Suite, allowing users to modify asset information and enhance portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated information for the specified real estate property, including portfolio details, asset attributes, and relevant analytics. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}
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 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}
Premise - Delete Premise¶
HTTP Request
DELETE /api/premises/{id}
📋 Description: Deletes a specified real estate property from the portfolio, ensuring that asset management and analytics reflect the most current data within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Premise - Get Premise Occupancies¶
HTTP Request
GET /api/premises/{id}/occupancies
📋 Description: Retrieves occupancy data for a specified premise, providing insights into asset utilization within the Nakisa Portfolio Management Suite for effective portfolio and real estate property analytics.
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 "priority": 0,
11 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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. |
Premise - Create Or Update Premise Occupancies¶
HTTP Request
PUT /api/premises/{id}/occupancies
📋 Description: Updates the occupancy details for a specified premise within the Nakisa Portfolio Management Suite, enabling enhanced management of real estate assets and analytics related to portfolio performance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated occupancy data for the specified real estate property, including metrics for portfolio analysis and asset management. |
Body Parameters
1[
2 {
3 "id": 0
4 }
5]
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 "priority": 0,
11 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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. |
Premise - Get Premise Groups¶
HTTP Request
GET /api/premises/{id}/groups
📋 Description: Retrieves a list of groups associated with a specific premise, enabling users to analyze and manage portfolio and asset relationships 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 |
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 "priority": 0,
11 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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. |
Premise - Create Or Update Premise Groups¶
HTTP Request
PUT /api/premises/{id}/groups
📋 Description: Updates the group associations for a specified premise within the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset management through streamlined real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the group assignment data for the specified premises, including details on portfolio categorization and asset management relevant to real estate property analytics. |
Body Parameters
1[
2 {
3 "id": 0
4 }
5]
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 "priority": 0,
11 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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. |
Premise - Get Premises¶
HTTP Request
GET /api/premises
📋 Description: Retrieves a list of premises within the Nakisa Portfolio Management Suite, providing insights into real estate properties and their associated assets for enhanced portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the premises query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
listing |
query |
boolean |
false |
Indicates whether to include detailed listings of real estate properties in the portfolio analytics response. |
search |
query |
string |
false |
Search term used to filter and retrieve specific portfolio, asset, or real estate property data within the Nakisa Portfolio Management Suite. |
city-id |
query |
string |
false |
Unique identifier for the city associated with the premises, enabling targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
province-id |
query |
string |
false |
Unique identifier for the province associated with the premises, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
country-id |
query |
string |
false |
Unique identifier for the country associated with the premises, enabling targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
city-id-in |
query |
string |
false |
Unique identifier for the city associated with the premises, enabling targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
province-id-in |
query |
string |
false |
Unique identifier for the province, used to filter real estate property data within the Nakisa Portfolio Management Suite. |
country-id-in |
query |
string |
false |
Unique identifier for the country associated with the premises, used to filter portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
id-in |
query |
string |
false |
Unique identifier for the premises within the Nakisa Portfolio Management Suite, facilitating precise asset and portfolio analytics in real estate management. |
legal-entity-id-in |
query |
string |
false |
Unique identifier for the legal entity associated with the premises, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve detailed information about assets and analytics related to real estate properties. |
location-type-id |
query |
string |
false |
Identifier for the type of location associated with the premises, facilitating targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
location-id-in |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve detailed information about real estate assets and their associated analytics. |
location-number-like |
query |
string |
false |
Specifies a location number that matches the criteria for retrieving premises data within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate management. |
location-external-id |
query |
string |
false |
Unique identifier for the external location associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
external-id-like |
query |
string |
false |
Specifies a string pattern to filter premises by their external identifiers, facilitating targeted searches within the Nakisa Portfolio Management Suite for portfolio, asset, and real estate property analytics. |
number |
query |
string |
false |
Specifies the unique identifier for a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
number-like |
query |
string |
false |
Represents a numeric value or identifier related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and management of real estate properties. |
name |
query |
string |
false |
Name of the resource |
name-like |
query |
string |
false |
Filters the list of premises by matching names that are similar to the specified string, enhancing asset identification within the Nakisa Portfolio Management Suite. |
head-premise |
query |
string |
false |
Specifies the primary premise identifier for retrieving detailed information about real estate assets within the Nakisa Portfolio Management Suite. |
possession-date |
query |
string |
false |
Specifies the date of possession for the real estate property, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
opening-date |
query |
string |
false |
Specifies the opening date of the premises, enabling users to analyze portfolio performance and asset utilization within the real estate property context. |
closing-date |
query |
string |
false |
Specifies the closing date for the premises, allowing users to filter real estate property data within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
relocation-date |
query |
string |
false |
Specifies the date for the relocation of assets within the portfolio, enabling accurate analytics and management of real estate properties. |
vacating-date |
query |
string |
false |
Specifies the date on which a real estate property is scheduled to vacate, facilitating portfolio and asset management analytics within the Nakisa Portfolio Management Suite. |
expansion-date |
query |
string |
false |
Specifies the date for which the premises data is being requested, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of a premise within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
status-id-is-not |
query |
string |
false |
none |
status-id-in |
query |
string |
false |
Filters the premises returned by the API based on the specified status identifier, enabling targeted analytics within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
usage-id |
query |
string |
false |
Unique identifier for the specific usage instance within the Nakisa Portfolio Management Suite, facilitating precise asset and portfolio analytics related to real estate properties. |
parent-premise-id |
query |
string |
false |
Unique identifier for the parent premise, used to filter and retrieve specific asset and portfolio data within the Nakisa Portfolio Management Suite. |
contract-id-not-null |
query |
string |
false |
Unique identifier for the contract associated with a real estate property, ensuring that only valid contracts are retrieved in the portfolio analytics. |
master-agreement-id-in |
query |
string |
false |
Unique identifier for the master agreement associated with the premises, facilitating efficient portfolio and asset management within the Nakisa Portfolio Management Suite. |
business-unit-id-in |
query |
string |
false |
Unique identifier for the business unit, used to filter premises data within the Nakisa Portfolio Management Suite for portfolio, asset, analytics, and real estate property analysis. |
group-id-in |
query |
string |
false |
Unique identifier for the asset group within the Nakisa Portfolio Management Suite, used to filter and retrieve specific premises data related to portfolio and real estate analytics. |
contract-id-in |
query |
string |
false |
Unique identifier for the specific contract associated with a real estate property, used to retrieve relevant portfolio and asset analytics. |
head-premise-opt |
query |
string |
false |
Specifies the head premise option to filter the retrieved premises data, enhancing insights for portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "premises": [
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 "number": "string",
13 "name": "string",
14 "headPremise": true,
15 "possessionDate": "2019-08-24",
16 "openingDate": "2019-08-24",
17 "closingDate": "2019-08-24",
18 "relocationDate": "2019-08-24",
19 "vacatingDate": "2019-08-24",
20 "expansionDate": "2019-08-24",
21 "statusId": 0,
22 "usageId": 0,
23 "parentPremiseId": 0,
24 "costCenterId": 0,
25 "profitCenterId": 0,
26 "legalEntityId": 0,
27 "occupancyIds": [
28 0
29 ],
30 "locationId": 0,
31 "locationDto": {
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 "number": "string",
40 "name": "string",
41 "storeNumber": "string",
42 "defaultCurrencyId": 0,
43 "defaultMeasureId": 0,
44 "typeId": 0,
45 "qualityId": 0,
46 "propertyTypeId": 0,
47 "categoryId": 0,
48 "statusId": 0,
49 "businessUnitId": 0,
50 "groupIds": [
51 0
52 ],
53 "legalEntityIds": [
54 0
55 ],
56 "defaultCurrency": {
57 "id": 0,
58 "status": "CREATED",
59 "displayId": "string",
60 "erpSystemId": 0,
61 "erpSystemDisplayId": "string",
62 "name": "string",
63 "decimalPoints": 0,
64 "depreciationAreaId": 0
65 },
66 "defaultUnitValue": {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "unitId": 0,
75 "unitOfMeasureId": 0,
76 "erpSystemId": 0,
77 "unit": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
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 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitOfMeasure": {
106 "id": 0,
107 "status": "CREATED",
108 "displayId": "string",
109 "erpSystemId": 0,
110 "erpSystemDisplayId": "string",
111 "name": "string"
112 }
113 },
114 "type": {
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 "priority": 0,
123 "internalId": 0,
124 "pickListCode": "string",
125 "pickListLabel": "string",
126 "label": "string",
127 "cultureId": 0,
128 "labelDtos": [
129 {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "cultureId": 0,
138 "value": "string"
139 }
140 ]
141 },
142 "quality": {
143 "createdBy": "string",
144 "lastModifiedBy": "string",
145 "createdDate": "2019-08-24T14:15:22Z",
146 "lastModifiedDate": "2019-08-24T14:15:22Z",
147 "archived": true,
148 "externalId": "string",
149 "id": 0,
150 "priority": 0,
151 "internalId": 0,
152 "pickListCode": "string",
153 "pickListLabel": "string",
154 "label": "string",
155 "cultureId": 0,
156 "labelDtos": [
157 {
158 "createdBy": "string",
159 "lastModifiedBy": "string",
160 "createdDate": "2019-08-24T14:15:22Z",
161 "lastModifiedDate": "2019-08-24T14:15:22Z",
162 "archived": true,
163 "externalId": "string",
164 "id": 0,
165 "cultureId": 0,
166 "value": "string"
167 }
168 ]
169 },
170 "propertyType": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
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 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "category": {
199 "createdBy": "string",
200 "lastModifiedBy": "string",
201 "createdDate": "2019-08-24T14:15:22Z",
202 "lastModifiedDate": "2019-08-24T14:15:22Z",
203 "archived": true,
204 "externalId": "string",
205 "id": 0,
206 "priority": 0,
207 "internalId": 0,
208 "pickListCode": "string",
209 "pickListLabel": "string",
210 "label": "string",
211 "cultureId": 0,
212 "labelDtos": [
213 {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "cultureId": 0,
222 "value": "string"
223 }
224 ]
225 },
226 "status": {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "priority": 0,
235 "internalId": 0,
236 "pickListCode": "string",
237 "pickListLabel": "string",
238 "label": "string",
239 "cultureId": 0,
240 "labelDtos": [
241 {
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 "cultureId": 0,
250 "value": "string"
251 }
252 ]
253 },
254 "addressDto": {
255 "createdBy": "string",
256 "lastModifiedBy": "string",
257 "createdDate": "2019-08-24T14:15:22Z",
258 "lastModifiedDate": "2019-08-24T14:15:22Z",
259 "archived": true,
260 "externalId": "string",
261 "id": 0,
262 "street": "string",
263 "civicNumber": "string",
264 "suite": "string",
265 "postalCode": "string",
266 "lon": 0.1,
267 "lat": 0.1,
268 "city": {
269 "createdBy": "string",
270 "lastModifiedBy": "string",
271 "createdDate": "2019-08-24T14:15:22Z",
272 "lastModifiedDate": "2019-08-24T14:15:22Z",
273 "archived": true,
274 "externalId": "string",
275 "id": 0,
276 "name": "string",
277 "province": {
278 "createdBy": "string",
279 "lastModifiedBy": "string",
280 "createdDate": "2019-08-24T14:15:22Z",
281 "lastModifiedDate": "2019-08-24T14:15:22Z",
282 "archived": true,
283 "externalId": "string",
284 "id": 0,
285 "name": "string",
286 "code": "string",
287 "country": {
288 "createdBy": "string",
289 "lastModifiedBy": "string",
290 "createdDate": "2019-08-24T14:15:22Z",
291 "lastModifiedDate": "2019-08-24T14:15:22Z",
292 "archived": true,
293 "externalId": "string",
294 "id": 0,
295 "name": "string",
296 "code": "string"
297 },
298 "provinceCountryKey": "string"
299 },
300 "cityProvinceCountryKey": "string"
301 },
302 "district": {
303 "createdBy": "string",
304 "lastModifiedBy": "string",
305 "createdDate": "2019-08-24T14:15:22Z",
306 "lastModifiedDate": "2019-08-24T14:15:22Z",
307 "archived": true,
308 "externalId": "string",
309 "id": 0,
310 "name": "string",
311 "city": {
312 "createdBy": "string",
313 "lastModifiedBy": "string",
314 "createdDate": "2019-08-24T14:15:22Z",
315 "lastModifiedDate": "2019-08-24T14:15:22Z",
316 "archived": true,
317 "externalId": "string",
318 "id": 0,
319 "name": "string",
320 "province": {
321 "createdBy": "string",
322 "lastModifiedBy": "string",
323 "createdDate": "2019-08-24T14:15:22Z",
324 "lastModifiedDate": "2019-08-24T14:15:22Z",
325 "archived": true,
326 "externalId": "string",
327 "id": 0,
328 "name": "string",
329 "code": "string",
330 "country": {
331 "createdBy": "string",
332 "lastModifiedBy": "string",
333 "createdDate": "2019-08-24T14:15:22Z",
334 "lastModifiedDate": "2019-08-24T14:15:22Z",
335 "archived": true,
336 "externalId": "string",
337 "id": 0,
338 "name": "string",
339 "code": "string"
340 },
341 "provinceCountryKey": "string"
342 },
343 "cityProvinceCountryKey": "string"
344 }
345 },
346 "cityId": 0,
347 "districtId": 0
348 },
349 "secondAddressDto": {
350 "createdBy": "string",
351 "lastModifiedBy": "string",
352 "createdDate": "2019-08-24T14:15:22Z",
353 "lastModifiedDate": "2019-08-24T14:15:22Z",
354 "archived": true,
355 "externalId": "string",
356 "id": 0,
357 "street": "string",
358 "civicNumber": "string",
359 "suite": "string",
360 "postalCode": "string",
361 "lon": 0.1,
362 "lat": 0.1,
363 "city": {
364 "createdBy": "string",
365 "lastModifiedBy": "string",
366 "createdDate": "2019-08-24T14:15:22Z",
367 "lastModifiedDate": "2019-08-24T14:15:22Z",
368 "archived": true,
369 "externalId": "string",
370 "id": 0,
371 "name": "string",
372 "province": {
373 "createdBy": "string",
374 "lastModifiedBy": "string",
375 "createdDate": "2019-08-24T14:15:22Z",
376 "lastModifiedDate": "2019-08-24T14:15:22Z",
377 "archived": true,
378 "externalId": "string",
379 "id": 0,
380 "name": "string",
381 "code": "string",
382 "country": {
383 "createdBy": "string",
384 "lastModifiedBy": "string",
385 "createdDate": "2019-08-24T14:15:22Z",
386 "lastModifiedDate": "2019-08-24T14:15:22Z",
387 "archived": true,
388 "externalId": "string",
389 "id": 0,
390 "name": "string",
391 "code": "string"
392 },
393 "provinceCountryKey": "string"
394 },
395 "cityProvinceCountryKey": "string"
396 },
397 "district": {
398 "createdBy": "string",
399 "lastModifiedBy": "string",
400 "createdDate": "2019-08-24T14:15:22Z",
401 "lastModifiedDate": "2019-08-24T14:15:22Z",
402 "archived": true,
403 "externalId": "string",
404 "id": 0,
405 "name": "string",
406 "city": {
407 "createdBy": "string",
408 "lastModifiedBy": "string",
409 "createdDate": "2019-08-24T14:15:22Z",
410 "lastModifiedDate": "2019-08-24T14:15:22Z",
411 "archived": true,
412 "externalId": "string",
413 "id": 0,
414 "name": "string",
415 "province": {
416 "createdBy": "string",
417 "lastModifiedBy": "string",
418 "createdDate": "2019-08-24T14:15:22Z",
419 "lastModifiedDate": "2019-08-24T14:15:22Z",
420 "archived": true,
421 "externalId": "string",
422 "id": 0,
423 "name": "string",
424 "code": "string",
425 "country": {
426 "createdBy": "string",
427 "lastModifiedBy": "string",
428 "createdDate": "2019-08-24T14:15:22Z",
429 "lastModifiedDate": "2019-08-24T14:15:22Z",
430 "archived": true,
431 "externalId": "string",
432 "id": 0,
433 "name": "string",
434 "code": "string"
435 },
436 "provinceCountryKey": "string"
437 },
438 "cityProvinceCountryKey": "string"
439 }
440 },
441 "cityId": 0,
442 "districtId": 0
443 }
444 },
445 "status": {
446 "createdBy": "string",
447 "lastModifiedBy": "string",
448 "createdDate": "2019-08-24T14:15:22Z",
449 "lastModifiedDate": "2019-08-24T14:15:22Z",
450 "archived": true,
451 "externalId": "string",
452 "id": 0,
453 "priority": 0,
454 "internalId": 0,
455 "pickListCode": "string",
456 "pickListLabel": "string",
457 "label": "string",
458 "cultureId": 0,
459 "labelDtos": [
460 {
461 "createdBy": "string",
462 "lastModifiedBy": "string",
463 "createdDate": "2019-08-24T14:15:22Z",
464 "lastModifiedDate": "2019-08-24T14:15:22Z",
465 "archived": true,
466 "externalId": "string",
467 "id": 0,
468 "cultureId": 0,
469 "value": "string"
470 }
471 ]
472 },
473 "usage": {
474 "createdBy": "string",
475 "lastModifiedBy": "string",
476 "createdDate": "2019-08-24T14:15:22Z",
477 "lastModifiedDate": "2019-08-24T14:15:22Z",
478 "archived": true,
479 "externalId": "string",
480 "id": 0,
481 "priority": 0,
482 "internalId": 0,
483 "pickListCode": "string",
484 "pickListLabel": "string",
485 "label": "string",
486 "cultureId": 0,
487 "labelDtos": [
488 {
489 "createdBy": "string",
490 "lastModifiedBy": "string",
491 "createdDate": "2019-08-24T14:15:22Z",
492 "lastModifiedDate": "2019-08-24T14:15:22Z",
493 "archived": true,
494 "externalId": "string",
495 "id": 0,
496 "cultureId": 0,
497 "value": "string"
498 }
499 ]
500 },
501 "occupanciesDto": [
502 {
503 "createdBy": "string",
504 "lastModifiedBy": "string",
505 "createdDate": "2019-08-24T14:15:22Z",
506 "lastModifiedDate": "2019-08-24T14:15:22Z",
507 "archived": true,
508 "externalId": "string",
509 "id": 0,
510 "priority": 0,
511 "internalId": 0,
512 "pickListCode": "string",
513 "pickListLabel": "string",
514 "label": "string",
515 "cultureId": 0,
516 "labelDtos": [
517 {
518 "createdBy": "string",
519 "lastModifiedBy": "string",
520 "createdDate": "2019-08-24T14:15:22Z",
521 "lastModifiedDate": "2019-08-24T14:15:22Z",
522 "archived": true,
523 "externalId": "string",
524 "id": 0,
525 "cultureId": 0,
526 "value": "string"
527 }
528 ]
529 }
530 ]
531 }
532 ]
533 },
534 "page": {
535 "size": 0,
536 "totalElements": 0,
537 "totalPages": 0,
538 "number": 0
539 }
540}
Premise - Create Premises¶
HTTP Request
POST /api/premises
📋 Description: Creates a new premises entry within the Nakisa Portfolio Management Suite, enabling users to manage real estate properties and associated assets effectively for enhanced portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing detailed information about the premises, including portfolio identifiers, asset attributes, and relevant analytics for real estate property management. |
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 "number": "string",
11 "name": "string",
12 "headPremise": true,
13 "possessionDate": "2019-08-24",
14 "openingDate": "2019-08-24",
15 "closingDate": "2019-08-24",
16 "relocationDate": "2019-08-24",
17 "vacatingDate": "2019-08-24",
18 "expansionDate": "2019-08-24",
19 "statusId": 0,
20 "usageId": 0,
21 "parentPremiseId": 0,
22 "costCenterId": 0,
23 "profitCenterId": 0,
24 "legalEntityId": 0,
25 "occupancyIds": [
26 0
27 ],
28 "locationId": 0,
29 "locationDto": {
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 "number": "string",
38 "name": "string",
39 "storeNumber": "string",
40 "defaultCurrencyId": 0,
41 "defaultMeasureId": 0,
42 "typeId": 0,
43 "qualityId": 0,
44 "propertyTypeId": 0,
45 "categoryId": 0,
46 "statusId": 0,
47 "businessUnitId": 0,
48 "groupIds": [
49 0
50 ],
51 "legalEntityIds": [
52 0
53 ],
54 "defaultCurrency": {
55 "id": 0,
56 "status": "CREATED",
57 "displayId": "string",
58 "erpSystemId": 0,
59 "erpSystemDisplayId": "string",
60 "name": "string",
61 "decimalPoints": 0,
62 "depreciationAreaId": 0
63 },
64 "defaultUnitValue": {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "unitId": 0,
73 "unitOfMeasureId": 0,
74 "erpSystemId": 0,
75 "unit": {
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 "priority": 0,
84 "internalId": 0,
85 "pickListCode": "string",
86 "pickListLabel": "string",
87 "label": "string",
88 "cultureId": 0,
89 "labelDtos": [
90 {
91 "createdBy": "string",
92 "lastModifiedBy": "string",
93 "createdDate": "2019-08-24T14:15:22Z",
94 "lastModifiedDate": "2019-08-24T14:15:22Z",
95 "archived": true,
96 "externalId": "string",
97 "id": 0,
98 "cultureId": 0,
99 "value": "string"
100 }
101 ]
102 },
103 "unitOfMeasure": {
104 "id": 0,
105 "status": "CREATED",
106 "displayId": "string",
107 "erpSystemId": 0,
108 "erpSystemDisplayId": "string",
109 "name": "string"
110 }
111 },
112 "type": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "quality": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "propertyType": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
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 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "category": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "status": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "priority": 0,
233 "internalId": 0,
234 "pickListCode": "string",
235 "pickListLabel": "string",
236 "label": "string",
237 "cultureId": 0,
238 "labelDtos": [
239 {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "cultureId": 0,
248 "value": "string"
249 }
250 ]
251 },
252 "addressDto": {
253 "createdBy": "string",
254 "lastModifiedBy": "string",
255 "createdDate": "2019-08-24T14:15:22Z",
256 "lastModifiedDate": "2019-08-24T14:15:22Z",
257 "archived": true,
258 "externalId": "string",
259 "id": 0,
260 "street": "string",
261 "civicNumber": "string",
262 "suite": "string",
263 "postalCode": "string",
264 "lon": 0.1,
265 "lat": 0.1,
266 "city": {
267 "createdBy": "string",
268 "lastModifiedBy": "string",
269 "createdDate": "2019-08-24T14:15:22Z",
270 "lastModifiedDate": "2019-08-24T14:15:22Z",
271 "archived": true,
272 "externalId": "string",
273 "id": 0,
274 "name": "string",
275 "province": {
276 "createdBy": "string",
277 "lastModifiedBy": "string",
278 "createdDate": "2019-08-24T14:15:22Z",
279 "lastModifiedDate": "2019-08-24T14:15:22Z",
280 "archived": true,
281 "externalId": "string",
282 "id": 0,
283 "name": "string",
284 "code": "string",
285 "country": {
286 "createdBy": "string",
287 "lastModifiedBy": "string",
288 "createdDate": "2019-08-24T14:15:22Z",
289 "lastModifiedDate": "2019-08-24T14:15:22Z",
290 "archived": true,
291 "externalId": "string",
292 "id": 0,
293 "name": "string",
294 "code": "string"
295 },
296 "provinceCountryKey": "string"
297 },
298 "cityProvinceCountryKey": "string"
299 },
300 "district": {
301 "createdBy": "string",
302 "lastModifiedBy": "string",
303 "createdDate": "2019-08-24T14:15:22Z",
304 "lastModifiedDate": "2019-08-24T14:15:22Z",
305 "archived": true,
306 "externalId": "string",
307 "id": 0,
308 "name": "string",
309 "city": {
310 "createdBy": "string",
311 "lastModifiedBy": "string",
312 "createdDate": "2019-08-24T14:15:22Z",
313 "lastModifiedDate": "2019-08-24T14:15:22Z",
314 "archived": true,
315 "externalId": "string",
316 "id": 0,
317 "name": "string",
318 "province": {
319 "createdBy": "string",
320 "lastModifiedBy": "string",
321 "createdDate": "2019-08-24T14:15:22Z",
322 "lastModifiedDate": "2019-08-24T14:15:22Z",
323 "archived": true,
324 "externalId": "string",
325 "id": 0,
326 "name": "string",
327 "code": "string",
328 "country": {
329 "createdBy": "string",
330 "lastModifiedBy": "string",
331 "createdDate": "2019-08-24T14:15:22Z",
332 "lastModifiedDate": "2019-08-24T14:15:22Z",
333 "archived": true,
334 "externalId": "string",
335 "id": 0,
336 "name": "string",
337 "code": "string"
338 },
339 "provinceCountryKey": "string"
340 },
341 "cityProvinceCountryKey": "string"
342 }
343 },
344 "cityId": 0,
345 "districtId": 0
346 },
347 "secondAddressDto": {
348 "createdBy": "string",
349 "lastModifiedBy": "string",
350 "createdDate": "2019-08-24T14:15:22Z",
351 "lastModifiedDate": "2019-08-24T14:15:22Z",
352 "archived": true,
353 "externalId": "string",
354 "id": 0,
355 "street": "string",
356 "civicNumber": "string",
357 "suite": "string",
358 "postalCode": "string",
359 "lon": 0.1,
360 "lat": 0.1,
361 "city": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "province": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "code": "string",
380 "country": {
381 "createdBy": "string",
382 "lastModifiedBy": "string",
383 "createdDate": "2019-08-24T14:15:22Z",
384 "lastModifiedDate": "2019-08-24T14:15:22Z",
385 "archived": true,
386 "externalId": "string",
387 "id": 0,
388 "name": "string",
389 "code": "string"
390 },
391 "provinceCountryKey": "string"
392 },
393 "cityProvinceCountryKey": "string"
394 },
395 "district": {
396 "createdBy": "string",
397 "lastModifiedBy": "string",
398 "createdDate": "2019-08-24T14:15:22Z",
399 "lastModifiedDate": "2019-08-24T14:15:22Z",
400 "archived": true,
401 "externalId": "string",
402 "id": 0,
403 "name": "string",
404 "city": {
405 "createdBy": "string",
406 "lastModifiedBy": "string",
407 "createdDate": "2019-08-24T14:15:22Z",
408 "lastModifiedDate": "2019-08-24T14:15:22Z",
409 "archived": true,
410 "externalId": "string",
411 "id": 0,
412 "name": "string",
413 "province": {
414 "createdBy": "string",
415 "lastModifiedBy": "string",
416 "createdDate": "2019-08-24T14:15:22Z",
417 "lastModifiedDate": "2019-08-24T14:15:22Z",
418 "archived": true,
419 "externalId": "string",
420 "id": 0,
421 "name": "string",
422 "code": "string",
423 "country": {
424 "createdBy": "string",
425 "lastModifiedBy": "string",
426 "createdDate": "2019-08-24T14:15:22Z",
427 "lastModifiedDate": "2019-08-24T14:15:22Z",
428 "archived": true,
429 "externalId": "string",
430 "id": 0,
431 "name": "string",
432 "code": "string"
433 },
434 "provinceCountryKey": "string"
435 },
436 "cityProvinceCountryKey": "string"
437 }
438 },
439 "cityId": 0,
440 "districtId": 0
441 }
442 },
443 "status": {
444 "createdBy": "string",
445 "lastModifiedBy": "string",
446 "createdDate": "2019-08-24T14:15:22Z",
447 "lastModifiedDate": "2019-08-24T14:15:22Z",
448 "archived": true,
449 "externalId": "string",
450 "id": 0,
451 "priority": 0,
452 "internalId": 0,
453 "pickListCode": "string",
454 "pickListLabel": "string",
455 "label": "string",
456 "cultureId": 0,
457 "labelDtos": [
458 {
459 "createdBy": "string",
460 "lastModifiedBy": "string",
461 "createdDate": "2019-08-24T14:15:22Z",
462 "lastModifiedDate": "2019-08-24T14:15:22Z",
463 "archived": true,
464 "externalId": "string",
465 "id": 0,
466 "cultureId": 0,
467 "value": "string"
468 }
469 ]
470 },
471 "usage": {
472 "createdBy": "string",
473 "lastModifiedBy": "string",
474 "createdDate": "2019-08-24T14:15:22Z",
475 "lastModifiedDate": "2019-08-24T14:15:22Z",
476 "archived": true,
477 "externalId": "string",
478 "id": 0,
479 "priority": 0,
480 "internalId": 0,
481 "pickListCode": "string",
482 "pickListLabel": "string",
483 "label": "string",
484 "cultureId": 0,
485 "labelDtos": [
486 {
487 "createdBy": "string",
488 "lastModifiedBy": "string",
489 "createdDate": "2019-08-24T14:15:22Z",
490 "lastModifiedDate": "2019-08-24T14:15:22Z",
491 "archived": true,
492 "externalId": "string",
493 "id": 0,
494 "cultureId": 0,
495 "value": "string"
496 }
497 ]
498 },
499 "occupanciesDto": [
500 {
501 "createdBy": "string",
502 "lastModifiedBy": "string",
503 "createdDate": "2019-08-24T14:15:22Z",
504 "lastModifiedDate": "2019-08-24T14:15:22Z",
505 "archived": true,
506 "externalId": "string",
507 "id": 0,
508 "priority": 0,
509 "internalId": 0,
510 "pickListCode": "string",
511 "pickListLabel": "string",
512 "label": "string",
513 "cultureId": 0,
514 "labelDtos": [
515 {
516 "createdBy": "string",
517 "lastModifiedBy": "string",
518 "createdDate": "2019-08-24T14:15:22Z",
519 "lastModifiedDate": "2019-08-24T14:15:22Z",
520 "archived": true,
521 "externalId": "string",
522 "id": 0,
523 "cultureId": 0,
524 "value": "string"
525 }
526 ]
527 }
528 ]
529 }
530]
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 "number": "string",
11 "name": "string",
12 "headPremise": true,
13 "possessionDate": "2019-08-24",
14 "openingDate": "2019-08-24",
15 "closingDate": "2019-08-24",
16 "relocationDate": "2019-08-24",
17 "vacatingDate": "2019-08-24",
18 "expansionDate": "2019-08-24",
19 "statusId": 0,
20 "usageId": 0,
21 "parentPremiseId": 0,
22 "costCenterId": 0,
23 "profitCenterId": 0,
24 "legalEntityId": 0,
25 "occupancyIds": [
26 0
27 ],
28 "locationId": 0,
29 "locationDto": {
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 "number": "string",
38 "name": "string",
39 "storeNumber": "string",
40 "defaultCurrencyId": 0,
41 "defaultMeasureId": 0,
42 "typeId": 0,
43 "qualityId": 0,
44 "propertyTypeId": 0,
45 "categoryId": 0,
46 "statusId": 0,
47 "businessUnitId": 0,
48 "groupIds": [
49 0
50 ],
51 "legalEntityIds": [
52 0
53 ],
54 "defaultCurrency": {
55 "id": 0,
56 "status": "CREATED",
57 "displayId": "string",
58 "erpSystemId": 0,
59 "erpSystemDisplayId": "string",
60 "name": "string",
61 "decimalPoints": 0,
62 "depreciationAreaId": 0
63 },
64 "defaultUnitValue": {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "unitId": 0,
73 "unitOfMeasureId": 0,
74 "erpSystemId": 0,
75 "unit": {
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 "priority": 0,
84 "internalId": 0,
85 "pickListCode": "string",
86 "pickListLabel": "string",
87 "label": "string",
88 "cultureId": 0,
89 "labelDtos": [
90 {
91 "createdBy": "string",
92 "lastModifiedBy": "string",
93 "createdDate": "2019-08-24T14:15:22Z",
94 "lastModifiedDate": "2019-08-24T14:15:22Z",
95 "archived": true,
96 "externalId": "string",
97 "id": 0,
98 "cultureId": 0,
99 "value": "string"
100 }
101 ]
102 },
103 "unitOfMeasure": {
104 "id": 0,
105 "status": "CREATED",
106 "displayId": "string",
107 "erpSystemId": 0,
108 "erpSystemDisplayId": "string",
109 "name": "string"
110 }
111 },
112 "type": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "quality": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "propertyType": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
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 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "category": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "status": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "priority": 0,
233 "internalId": 0,
234 "pickListCode": "string",
235 "pickListLabel": "string",
236 "label": "string",
237 "cultureId": 0,
238 "labelDtos": [
239 {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "cultureId": 0,
248 "value": "string"
249 }
250 ]
251 },
252 "addressDto": {
253 "createdBy": "string",
254 "lastModifiedBy": "string",
255 "createdDate": "2019-08-24T14:15:22Z",
256 "lastModifiedDate": "2019-08-24T14:15:22Z",
257 "archived": true,
258 "externalId": "string",
259 "id": 0,
260 "street": "string",
261 "civicNumber": "string",
262 "suite": "string",
263 "postalCode": "string",
264 "lon": 0.1,
265 "lat": 0.1,
266 "city": {
267 "createdBy": "string",
268 "lastModifiedBy": "string",
269 "createdDate": "2019-08-24T14:15:22Z",
270 "lastModifiedDate": "2019-08-24T14:15:22Z",
271 "archived": true,
272 "externalId": "string",
273 "id": 0,
274 "name": "string",
275 "province": {
276 "createdBy": "string",
277 "lastModifiedBy": "string",
278 "createdDate": "2019-08-24T14:15:22Z",
279 "lastModifiedDate": "2019-08-24T14:15:22Z",
280 "archived": true,
281 "externalId": "string",
282 "id": 0,
283 "name": "string",
284 "code": "string",
285 "country": {
286 "createdBy": "string",
287 "lastModifiedBy": "string",
288 "createdDate": "2019-08-24T14:15:22Z",
289 "lastModifiedDate": "2019-08-24T14:15:22Z",
290 "archived": true,
291 "externalId": "string",
292 "id": 0,
293 "name": "string",
294 "code": "string"
295 },
296 "provinceCountryKey": "string"
297 },
298 "cityProvinceCountryKey": "string"
299 },
300 "district": {
301 "createdBy": "string",
302 "lastModifiedBy": "string",
303 "createdDate": "2019-08-24T14:15:22Z",
304 "lastModifiedDate": "2019-08-24T14:15:22Z",
305 "archived": true,
306 "externalId": "string",
307 "id": 0,
308 "name": "string",
309 "city": {
310 "createdBy": "string",
311 "lastModifiedBy": "string",
312 "createdDate": "2019-08-24T14:15:22Z",
313 "lastModifiedDate": "2019-08-24T14:15:22Z",
314 "archived": true,
315 "externalId": "string",
316 "id": 0,
317 "name": "string",
318 "province": {
319 "createdBy": "string",
320 "lastModifiedBy": "string",
321 "createdDate": "2019-08-24T14:15:22Z",
322 "lastModifiedDate": "2019-08-24T14:15:22Z",
323 "archived": true,
324 "externalId": "string",
325 "id": 0,
326 "name": "string",
327 "code": "string",
328 "country": {
329 "createdBy": "string",
330 "lastModifiedBy": "string",
331 "createdDate": "2019-08-24T14:15:22Z",
332 "lastModifiedDate": "2019-08-24T14:15:22Z",
333 "archived": true,
334 "externalId": "string",
335 "id": 0,
336 "name": "string",
337 "code": "string"
338 },
339 "provinceCountryKey": "string"
340 },
341 "cityProvinceCountryKey": "string"
342 }
343 },
344 "cityId": 0,
345 "districtId": 0
346 },
347 "secondAddressDto": {
348 "createdBy": "string",
349 "lastModifiedBy": "string",
350 "createdDate": "2019-08-24T14:15:22Z",
351 "lastModifiedDate": "2019-08-24T14:15:22Z",
352 "archived": true,
353 "externalId": "string",
354 "id": 0,
355 "street": "string",
356 "civicNumber": "string",
357 "suite": "string",
358 "postalCode": "string",
359 "lon": 0.1,
360 "lat": 0.1,
361 "city": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "province": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "code": "string",
380 "country": {
381 "createdBy": "string",
382 "lastModifiedBy": "string",
383 "createdDate": "2019-08-24T14:15:22Z",
384 "lastModifiedDate": "2019-08-24T14:15:22Z",
385 "archived": true,
386 "externalId": "string",
387 "id": 0,
388 "name": "string",
389 "code": "string"
390 },
391 "provinceCountryKey": "string"
392 },
393 "cityProvinceCountryKey": "string"
394 },
395 "district": {
396 "createdBy": "string",
397 "lastModifiedBy": "string",
398 "createdDate": "2019-08-24T14:15:22Z",
399 "lastModifiedDate": "2019-08-24T14:15:22Z",
400 "archived": true,
401 "externalId": "string",
402 "id": 0,
403 "name": "string",
404 "city": {
405 "createdBy": "string",
406 "lastModifiedBy": "string",
407 "createdDate": "2019-08-24T14:15:22Z",
408 "lastModifiedDate": "2019-08-24T14:15:22Z",
409 "archived": true,
410 "externalId": "string",
411 "id": 0,
412 "name": "string",
413 "province": {
414 "createdBy": "string",
415 "lastModifiedBy": "string",
416 "createdDate": "2019-08-24T14:15:22Z",
417 "lastModifiedDate": "2019-08-24T14:15:22Z",
418 "archived": true,
419 "externalId": "string",
420 "id": 0,
421 "name": "string",
422 "code": "string",
423 "country": {
424 "createdBy": "string",
425 "lastModifiedBy": "string",
426 "createdDate": "2019-08-24T14:15:22Z",
427 "lastModifiedDate": "2019-08-24T14:15:22Z",
428 "archived": true,
429 "externalId": "string",
430 "id": 0,
431 "name": "string",
432 "code": "string"
433 },
434 "provinceCountryKey": "string"
435 },
436 "cityProvinceCountryKey": "string"
437 }
438 },
439 "cityId": 0,
440 "districtId": 0
441 }
442 },
443 "status": {
444 "createdBy": "string",
445 "lastModifiedBy": "string",
446 "createdDate": "2019-08-24T14:15:22Z",
447 "lastModifiedDate": "2019-08-24T14:15:22Z",
448 "archived": true,
449 "externalId": "string",
450 "id": 0,
451 "priority": 0,
452 "internalId": 0,
453 "pickListCode": "string",
454 "pickListLabel": "string",
455 "label": "string",
456 "cultureId": 0,
457 "labelDtos": [
458 {
459 "createdBy": "string",
460 "lastModifiedBy": "string",
461 "createdDate": "2019-08-24T14:15:22Z",
462 "lastModifiedDate": "2019-08-24T14:15:22Z",
463 "archived": true,
464 "externalId": "string",
465 "id": 0,
466 "cultureId": 0,
467 "value": "string"
468 }
469 ]
470 },
471 "usage": {
472 "createdBy": "string",
473 "lastModifiedBy": "string",
474 "createdDate": "2019-08-24T14:15:22Z",
475 "lastModifiedDate": "2019-08-24T14:15:22Z",
476 "archived": true,
477 "externalId": "string",
478 "id": 0,
479 "priority": 0,
480 "internalId": 0,
481 "pickListCode": "string",
482 "pickListLabel": "string",
483 "label": "string",
484 "cultureId": 0,
485 "labelDtos": [
486 {
487 "createdBy": "string",
488 "lastModifiedBy": "string",
489 "createdDate": "2019-08-24T14:15:22Z",
490 "lastModifiedDate": "2019-08-24T14:15:22Z",
491 "archived": true,
492 "externalId": "string",
493 "id": 0,
494 "cultureId": 0,
495 "value": "string"
496 }
497 ]
498 },
499 "occupanciesDto": [
500 {
501 "createdBy": "string",
502 "lastModifiedBy": "string",
503 "createdDate": "2019-08-24T14:15:22Z",
504 "lastModifiedDate": "2019-08-24T14:15:22Z",
505 "archived": true,
506 "externalId": "string",
507 "id": 0,
508 "priority": 0,
509 "internalId": 0,
510 "pickListCode": "string",
511 "pickListLabel": "string",
512 "label": "string",
513 "cultureId": 0,
514 "labelDtos": [
515 {
516 "createdBy": "string",
517 "lastModifiedBy": "string",
518 "createdDate": "2019-08-24T14:15:22Z",
519 "lastModifiedDate": "2019-08-24T14:15:22Z",
520 "archived": true,
521 "externalId": "string",
522 "id": 0,
523 "cultureId": 0,
524 "value": "string"
525 }
526 ]
527 }
528 ]
529 }
530]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a premise within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets and analytics for real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» number |
string |
true |
none |
Represents the unique identification number assigned to a real estate property within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics. |
» name |
string |
true |
none |
Name of the resource |
» headPremise |
boolean |
false |
none |
Boolean flag indicating headPremise status |
» possessionDate |
string(date) |
false |
none |
Date of the possession |
» openingDate |
string(date) |
false |
none |
Date of the opening |
» closingDate |
string(date) |
false |
none |
Date of the closing |
» relocationDate |
string(date) |
false |
none |
Date of the relocation |
» vacatingDate |
string(date) |
false |
none |
Date of the vacating |
» expansionDate |
string(date) |
false |
none |
Date of the expansion |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» usageId |
integer(int64) |
false |
none |
Unique identifier for the usage |
» parentPremiseId |
integer(int64) |
false |
none |
Unique identifier for the parent premise |
» costCenterId |
integer(int64) |
true |
none |
Unique identifier for the cost center |
» profitCenterId |
integer(int64) |
false |
none |
Unique identifier for the profit center |
» legalEntityId |
integer(int64) |
true |
none |
Unique identifier for the legal entity |
» occupancyIds |
[integer] |
false |
none |
List of occupancyIds items |
» locationId |
integer(int64) |
true |
none |
Unique identifier for the location |
» locationDto |
false |
none |
Data transfer object representing a location within the Nakisa Portfolio Management Suite, encapsulating essential details related to real estate properties, assets, and portfolio analytics. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» number |
string |
false |
none |
Represents the numerical designation of a real estate property within the Nakisa Portfolio Management Suite, facilitating asset tracking and analytics within the portfolio. |
»» name |
string |
true |
none |
Name of the resource |
»» storeNumber |
string |
false |
none |
Unique identifier for the store within the Nakisa Portfolio Management Suite, facilitating asset tracking and analytics related to real estate properties. |
»» defaultCurrencyId |
integer(int64) |
true |
none |
Unique identifier for the default currency |
»» defaultMeasureId |
integer(int64) |
true |
none |
Unique identifier for the default measure |
»» typeId |
integer(int64) |
true |
none |
Unique identifier for the type |
»» qualityId |
integer(int64) |
false |
none |
Unique identifier for the quality |
»» propertyTypeId |
integer(int64) |
false |
none |
Unique identifier for the property type |
»» categoryId |
integer(int64) |
false |
none |
Unique identifier for the category |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» businessUnitId |
integer(int64) |
false |
none |
Unique identifier for the business unit |
»» groupIds |
[integer] |
false |
none |
List of groupIds items |
»» legalEntityIds |
[integer] |
false |
none |
List of legalEntityIds items |
»» defaultCurrency |
false |
none |
Data transfer object representing currency details utilized within the Nakisa Portfolio Management Suite, facilitating accurate financial analysis and reporting for portfolio, asset, and real estate property management. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» status |
string |
false |
none |
Status of the resource |
»»» displayId |
string |
true |
none |
Unique identifier for the display |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
true |
none |
Numeric value representing decimalPoints |
»»» depreciationAreaId |
integer(int64) |
false |
none |
Unique identifier for the depreciation area |
»» defaultUnitValue |
false |
none |
Data transfer object representing the default values for units within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics for real estate properties. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» unitId |
integer(int64) |
false |
none |
Unique identifier for the unit |
»»» unitOfMeasureId |
integer(int64) |
false |
none |
Unique identifier for the unit of measure |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» unit |
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. |
»»» unitOfMeasure |
false |
none |
Data transfer object representing the unit of measure utilized within the Nakisa Portfolio Management Suite, essential for accurately quantifying and analyzing assets in the context of portfolio management and real estate property analytics. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» status |
string |
false |
none |
Status of the resource |
»»»» displayId |
string |
true |
none |
Unique identifier for the display |
»»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»»» name |
string |
false |
none |
Name of the resource |
»» 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. |
|
»» quality |
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. |
|
»» propertyType |
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. |
|
»» category |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» addressDto |
true |
none |
Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» street |
string |
false |
none |
Represents the street address of a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
»»» civicNumber |
string |
false |
none |
The civicNumber field represents the official identification number assigned to a real estate property, facilitating accurate portfolio management and asset analytics within the Nakisa Portfolio Management Suite. |
»»» suite |
string |
false |
none |
Represents the name of the suite associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite, facilitating comprehensive analytics and management. |
»»» postalCode |
string |
false |
none |
Code for the postal |
»»» lon |
number(double) |
false |
none |
Value for lon field |
»»» lat |
number(double) |
false |
none |
Value for lat field |
»»» city |
false |
none |
Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset 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 |
»»»» name |
string |
true |
none |
Name of the resource |
»»»» province |
false |
none |
Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio analysis and asset management in the context of 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 |
»»»»» name |
string |
true |
none |
Name of the resource |
»»»»» code |
string |
false |
none |
Code identifier for the resource |
»»»»» country |
false |
none |
Data transfer object representing a country within the Nakisa Portfolio Management Suite, utilized for portfolio analysis and asset management in the context of real estate properties and analytics. |
|
»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»» name |
string |
true |
none |
Name of the resource |
»»»»»» code |
string |
false |
none |
Code identifier for the resource |
»»»»» provinceCountryKey |
string |
false |
none |
none |
»»»» cityProvinceCountryKey |
string |
false |
none |
none |
»»» district |
false |
none |
Data transfer object representing a district within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio management, asset allocation, and real estate property analytics. |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» name |
string |
true |
none |
Name of the resource |
»»»» city |
false |
none |
Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management. |
|
»»» cityId |
integer(int64) |
false |
none |
Unique identifier for the city |
»»» districtId |
integer(int64) |
false |
none |
Unique identifier for the district |
»» secondAddressDto |
false |
none |
Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
|
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» usage |
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. |
|
» occupanciesDto |
false |
none |
List of occupanciesDto items |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Premise - Get Pictures For Premise¶
HTTP Request
GET /api/premises/{premiseId}/pictures
📋 Description: Fetches a list of pictures associated with a specific premise, enabling users to enhance their portfolio and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently retrieve and analyze pictures associated with a specific premise within the Nakisa Portfolio Management Suite. |
|
premiseId |
path |
string |
true |
Unique identifier for the premise |
search |
query |
string |
false |
Search term used to filter and retrieve specific pictures associated with a real estate property within the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
type |
query |
string |
false |
Type of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "pictures": [
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 "documentDto": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "name": "string",
20 "title": "string",
21 "type": "string",
22 "description": "string",
23 "link": "string",
24 "signedDate": "2019-08-24",
25 "documentTypeId": 0,
26 "statusId": 0,
27 "shareable": true,
28 "size": 0,
29 "documentType": {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "priority": 0,
38 "internalId": 0,
39 "pickListCode": "string",
40 "pickListLabel": "string",
41 "label": "string",
42 "cultureId": 0,
43 "labelDtos": [
44 {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "cultureId": 0,
53 "value": "string"
54 }
55 ]
56 },
57 "status": {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "priority": 0,
66 "internalId": 0,
67 "pickListCode": "string",
68 "pickListLabel": "string",
69 "label": "string",
70 "cultureId": 0,
71 "labelDtos": [
72 {
73 "createdBy": "string",
74 "lastModifiedBy": "string",
75 "createdDate": "2019-08-24T14:15:22Z",
76 "lastModifiedDate": "2019-08-24T14:15:22Z",
77 "archived": true,
78 "externalId": "string",
79 "id": 0,
80 "cultureId": 0,
81 "value": "string"
82 }
83 ]
84 }
85 }
86 }
87 ]
88 },
89 "page": {
90 "size": 0,
91 "totalElements": 0,
92 "totalPages": 0,
93 "number": 0
94 }
95}
Premise - Upload Premise Picture¶
HTTP Request
POST /api/premises/{premiseId}/pictures
📋 Description: Uploads images associated with a specific premise in the Nakisa Portfolio Management Suite, enhancing asset documentation and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
body |
body |
object |
false |
Request body containing the image data and associated metadata for adding pictures to a specific premise within the Nakisa Portfolio Management Suite, enhancing asset visibility and analytics in real estate property management. |
» file |
body |
string(binary) |
true |
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 "documentDto": {
9 "createdBy": "string",
10 "lastModifiedBy": "string",
11 "createdDate": "2019-08-24T14:15:22Z",
12 "lastModifiedDate": "2019-08-24T14:15:22Z",
13 "archived": true,
14 "externalId": "string",
15 "id": 0,
16 "name": "string",
17 "title": "string",
18 "type": "string",
19 "description": "string",
20 "link": "string",
21 "signedDate": "2019-08-24",
22 "documentTypeId": 0,
23 "statusId": 0,
24 "shareable": true,
25 "size": 0,
26 "documentType": {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "priority": 0,
35 "internalId": 0,
36 "pickListCode": "string",
37 "pickListLabel": "string",
38 "label": "string",
39 "cultureId": 0,
40 "labelDtos": [
41 {
42 "createdBy": "string",
43 "lastModifiedBy": "string",
44 "createdDate": "2019-08-24T14:15:22Z",
45 "lastModifiedDate": "2019-08-24T14:15:22Z",
46 "archived": true,
47 "externalId": "string",
48 "id": 0,
49 "cultureId": 0,
50 "value": "string"
51 }
52 ]
53 },
54 "status": {
55 "createdBy": "string",
56 "lastModifiedBy": "string",
57 "createdDate": "2019-08-24T14:15:22Z",
58 "lastModifiedDate": "2019-08-24T14:15:22Z",
59 "archived": true,
60 "externalId": "string",
61 "id": 0,
62 "priority": 0,
63 "internalId": 0,
64 "pickListCode": "string",
65 "pickListLabel": "string",
66 "label": "string",
67 "cultureId": 0,
68 "labelDtos": [
69 {
70 "createdBy": "string",
71 "lastModifiedBy": "string",
72 "createdDate": "2019-08-24T14:15:22Z",
73 "lastModifiedDate": "2019-08-24T14:15:22Z",
74 "archived": true,
75 "externalId": "string",
76 "id": 0,
77 "cultureId": 0,
78 "value": "string"
79 }
80 ]
81 }
82 }
83}
Premise - Get Premise ESGs¶
HTTP Request
GET /api/premises/{premiseId}/esgs
📋 Description: Retrieves Environmental, Social, and Governance (ESG) data for a specified premise, enabling portfolio managers and analysts to assess sustainability metrics and performance within the real estate asset portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently retrieve ESG data for specific premises within the Nakisa Portfolio Management Suite. |
|
premiseId |
path |
string |
true |
Unique identifier for the premise |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "esgs": [
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 "esgTypeId": 0,
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "consumedQuantity": 0,
16 "esgType": {
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 "esgUnit": {
45 "id": 0,
46 "status": "CREATED",
47 "displayId": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string",
50 "name": "string"
51 },
52 "emissionQuantity": 0,
53 "emissionUnit": {
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 }
82 ]
83 },
84 "page": {
85 "size": 0,
86 "totalElements": 0,
87 "totalPages": 0,
88 "number": 0
89 }
90}
Premise - Create Premise ESGs¶
HTTP Request
POST /api/premises/{premiseId}/esgs
📋 Description: Creates a new Environmental, Social, and Governance (ESG) entry for a specified premise within the Nakisa Portfolio Management Suite, enabling enhanced analytics and reporting on real estate property performance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
body |
body |
true |
Request body containing the environmental, social, and governance (ESG) data related to the specified premise, essential for portfolio analytics and asset management within the real estate sector. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "esgTypeId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "consumedQuantity": 0,
14 "esgType": {
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 "esgUnit": {
43 "id": 0,
44 "status": "CREATED",
45 "displayId": "string",
46 "erpSystemId": 0,
47 "erpSystemDisplayId": "string",
48 "name": "string"
49 },
50 "emissionQuantity": 0,
51 "emissionUnit": {
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 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 }
79 }
80]
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 "esgTypeId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "consumedQuantity": 0,
14 "esgType": {
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 "esgUnit": {
43 "id": 0,
44 "status": "CREATED",
45 "displayId": "string",
46 "erpSystemId": 0,
47 "erpSystemDisplayId": "string",
48 "name": "string"
49 },
50 "emissionQuantity": 0,
51 "emissionUnit": {
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 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 }
79 }
80]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[EsgDto is a data transfer object that encapsulates environmental, social, and governance metrics for real estate properties within the Nakisa Portfolio Management Suite, facilitating comprehensive portfolio and asset analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» esgTypeId |
integer(int64) |
false |
none |
Unique identifier for the esg type |
» startDate |
string(date) |
true |
none |
Start date of the resource |
» endDate |
string(date) |
true |
none |
End date of the resource |
» consumedQuantity |
number |
true |
none |
Quantity of consumed quantity |
» esgType |
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. |
» esgUnit |
false |
none |
Data transfer object representing the unit of measure utilized within the Nakisa Portfolio Management Suite, essential for accurately quantifying and analyzing assets in the context of portfolio management and real estate property analytics. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» status |
string |
false |
none |
Status of the resource |
»» displayId |
string |
true |
none |
Unique identifier for the display |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»» name |
string |
false |
none |
Name of the resource |
» emissionQuantity |
number |
false |
none |
Quantity of emission quantity |
» emissionUnit |
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. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Premise - Get Premise Documents¶
HTTP Request
GET /api/premises/{premiseId}/documents
📋 Description: Fetches documents associated with a specific premise identified by the premiseId, enabling users to access critical information related to portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
pageable |
query |
true |
Indicates whether the results of the document retrieval for a specified premise should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific documents related to a premise 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 documents associated with a specific premise, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
signed-date |
query |
string |
false |
Specifies the date on which the document was signed, providing essential context for portfolio and asset management within the Nakisa Portfolio Management Suite. |
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 premise are shareable within the Nakisa Portfolio Management Suite, facilitating collaboration in portfolio and asset management. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with a specific premise, facilitating efficient retrieval and management of portfolio-related documents within the Nakisa Portfolio Management Suite. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with a specific premise, facilitating targeted retrieval of portfolio-related documentation 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}
Premise - Upload Premise Document¶
HTTP Request
POST /api/premises/{premiseId}/documents
📋 Description: Uploads documents associated with a specific premise in the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset management within the real estate property analytics framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
body |
body |
object |
false |
Request body containing the document details, including type, description, and associated metadata, for the specified real estate property within the portfolio management framework. |
» 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}
Premise - Get Sales For Premise¶
HTTP Request
GET /api/premises/{id}/sales
📋 Description: Fetches sales data associated with a specific real estate property identified by the provided ID, enabling portfolio and asset analysis within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the sales data for the specified premises should be returned in a paginated format, facilitating efficient data retrieval and analysis within the Nakisa Portfolio Management Suite. |
|
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "sales": [
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 "areaId": 0,
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "externalSaleSubCategoryId": 0,
16 "totalSales": 0,
17 "externalSaleSubCategory": {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "name": "string",
26 "saleSubCategoryId": 0,
27 "externalSaleCategory": {
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 "name": "string"
36 },
37 "externalSaleCategoryId": 0,
38 "saleSubCategory": {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "priority": 0,
47 "internalId": 0,
48 "pickListCode": "string",
49 "pickListLabel": "string",
50 "label": "string",
51 "cultureId": 0,
52 "labelDtos": [
53 {
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 "cultureId": 0,
62 "value": "string"
63 }
64 ]
65 },
66 "saleCategory": "string"
67 }
68 }
69 ]
70 },
71 "page": {
72 "size": 0,
73 "totalElements": 0,
74 "totalPages": 0,
75 "number": 0
76 }
77}
Premise - Create Premise Sales¶
HTTP Request
POST /api/premises/{id}/sales
📋 Description: Creates a new sales record for the specified premises within the Nakisa Portfolio Management Suite, enabling enhanced analytics and portfolio management for real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing sales transaction details, including asset identifiers and financial metrics, for the specified real estate property 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 "areaId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "externalSaleSubCategoryId": 0,
14 "totalSales": 0,
15 "externalSaleSubCategory": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "name": "string",
24 "saleSubCategoryId": 0,
25 "externalSaleCategory": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "name": "string"
34 },
35 "externalSaleCategoryId": 0,
36 "saleSubCategory": {
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 "priority": 0,
45 "internalId": 0,
46 "pickListCode": "string",
47 "pickListLabel": "string",
48 "label": "string",
49 "cultureId": 0,
50 "labelDtos": [
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 "cultureId": 0,
60 "value": "string"
61 }
62 ]
63 },
64 "saleCategory": "string"
65 }
66 }
67]
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 "areaId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "externalSaleSubCategoryId": 0,
14 "totalSales": 0,
15 "externalSaleSubCategory": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "name": "string",
24 "saleSubCategoryId": 0,
25 "externalSaleCategory": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "name": "string"
34 },
35 "externalSaleCategoryId": 0,
36 "saleSubCategory": {
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 "priority": 0,
45 "internalId": 0,
46 "pickListCode": "string",
47 "pickListLabel": "string",
48 "label": "string",
49 "cultureId": 0,
50 "labelDtos": [
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 "cultureId": 0,
60 "value": "string"
61 }
62 ]
63 },
64 "saleCategory": "string"
65 }
66 }
67]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a sale transaction within the Nakisa Portfolio Management Suite, encompassing critical details related to portfolio assets and real estate properties for enhanced analytics and 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 |
» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» externalSaleSubCategoryId |
integer(int64) |
false |
none |
Unique identifier for the external sale sub category |
» totalSales |
number |
false |
none |
Value for totalSales field |
» externalSaleSubCategory |
false |
none |
Data transfer object representing a subcategory of external sales within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of portfolio and asset data related to 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 |
»» name |
string |
true |
none |
Name of the resource |
»» saleSubCategoryId |
integer(int64) |
true |
none |
Unique identifier for the sale sub category |
»» externalSaleCategory |
false |
none |
Data structure representing the categorization of external sales within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» name |
string |
true |
none |
Name of the resource |
»» externalSaleCategoryId |
integer(int64) |
true |
none |
Unique identifier for the external sale category |
»» saleSubCategory |
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. |
»» saleCategory |
string |
false |
none |
Category of the sale |
Premise - Get Sale Leases For Premise¶
HTTP Request
GET /api/premises/{id}/sale-leases
📋 Description: Retrieves sale lease agreements associated with a specific real estate property, enabling users to analyze portfolio performance and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the sale leases associated with a specific premise should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis. |
|
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "saleLeases": [
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 "typeId": 0,
13 "statusId": 0,
14 "firm": "string",
15 "startDate": "2019-08-24",
16 "endDate": "2019-08-24",
17 "criticalDate": "2019-08-24",
18 "askingPrice": 0,
19 "targetPrice": 0,
20 "brokerageCost": 0,
21 "type": {
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 "status": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 }
77 }
78 ]
79 },
80 "page": {
81 "size": 0,
82 "totalElements": 0,
83 "totalPages": 0,
84 "number": 0
85 }
86}
Premise - Create Premise Sale Leases¶
HTTP Request
POST /api/premises/{id}/sale-leases
📋 Description: Creates a new sale lease record for a specified premise within the Nakisa Portfolio Management Suite, enabling effective management and analysis of real estate assets in your portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the sale lease details for the specified premises, including financial terms and lease duration, essential for 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 "typeId": 0,
11 "statusId": 0,
12 "firm": "string",
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "criticalDate": "2019-08-24",
16 "askingPrice": 0,
17 "targetPrice": 0,
18 "brokerageCost": 0,
19 "type": {
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 }
76]
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 "typeId": 0,
11 "statusId": 0,
12 "firm": "string",
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "criticalDate": "2019-08-24",
16 "askingPrice": 0,
17 "targetPrice": 0,
18 "brokerageCost": 0,
19 "type": {
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 }
76]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the details of a sale or lease transaction within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» firm |
string |
false |
none |
Represents the name of the firm associated with the real estate property, facilitating portfolio management and analytics within the Nakisa Portfolio Management Suite. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» criticalDate |
string(date) |
false |
none |
Date of the critical |
» askingPrice |
number |
false |
none |
Value for askingPrice field |
» targetPrice |
number |
false |
none |
Value for targetPrice field |
» brokerageCost |
number |
false |
none |
Value for brokerageCost field |
» 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. |
|
»» 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. |
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
Premise - Get Premise References¶
HTTP Request
GET /api/premises/{id}/references
📋 Description: Retrieves references associated with a specific premise identified by the provided ID, enabling users to access critical data for portfolio and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the reference retrieval for a specific premise should be paginated, enhancing the management of large datasets within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific references related to the designated premises within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
String representation of the reference number associated with the specified premises, used for retrieving relevant portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
department-id |
query |
string |
false |
Unique identifier for the department associated with the specified premises, facilitating targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "references": [
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 "number": "string",
13 "departmentId": 0,
14 "department": {
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 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Premise - Create Premise References¶
HTTP Request
POST /api/premises/{id}/references
📋 Description: Creates a new reference entry for a specified real estate property within the Nakisa Portfolio Management Suite, enhancing asset management and analytics capabilities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing reference data related to the specified premises, including asset identifiers and analytical insights for effective portfolio management. |
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 "number": "string",
11 "departmentId": 0,
12 "department": {
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 }
41]
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 "number": "string",
11 "departmentId": 0,
12 "department": {
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 }
41]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a reference entity within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio, asset, analytics, and real estate property management.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» number |
string |
true |
none |
Represents a unique identifier for assets within the Nakisa Portfolio Management Suite, facilitating effective tracking and analytics in portfolio and real estate property management. |
» departmentId |
integer(int64) |
false |
none |
Unique identifier for the department |
» department |
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. |
Premise - Perform Transition¶
HTTP Request
POST /api/premises/{id}/perform-transition
📋 Description: Initiates a transition process for a specified premise within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset changes effectively in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the transition details for the specified real estate property, including the target state and associated metadata for portfolio and asset management analytics. |
Body Parameters
1{
2 "name": "SEND_FOR_APPROVAL",
3 "from": {
4 "name": "DRAFT",
5 "end": true,
6 "readOnly": true
7 },
8 "to": {
9 "name": "DRAFT",
10 "end": true,
11 "readOnly": true
12 },
13 "permission": "string"
14}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "name": "SEND_FOR_APPROVAL",
4 "from": {
5 "name": "DRAFT",
6 "end": true,
7 "readOnly": true
8 },
9 "to": {
10 "name": "DRAFT",
11 "end": true,
12 "readOnly": true
13 },
14 "permission": "string"
15 }
16]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a transition within the Nakisa Portfolio Management Suite, capturing the movement of assets across portfolios to enhance analytics and optimize real estate property management.] |
|
» name |
string |
false |
none |
Name of the resource |
» from |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
»» name |
string |
false |
none |
Name of the resource |
»» end |
boolean |
false |
none |
Boolean flag indicating end status |
»» readOnly |
boolean |
false |
none |
Boolean flag indicating readOnly status |
» to |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
» permission |
string |
false |
none |
Specifies the access level granted to users for managing portfolio, asset, and analytics data within the Nakisa Portfolio Management Suite. |
Enumerated Values
Attribute |
Value |
|---|---|
name |
ACTIVATE, ACTIVE, APPROVE, APPROVED, AWAITING_ACTIVATION, DEACTIVATE, DRAFT, INACTIVE, OPEN_FOR_MODIFICATIONS, PENDING_APPROVAL, PENDING_TERMINATE, PENDING_TERMINATION, REJECT, SEND_FOR_APPROVAL, TERMINATE, TERMINATED |
Premise - Get Notes For Premise¶
HTTP Request
GET /api/premises/{id}/notes
📋 Description: Fetches notes associated with a specific premise identified by its ID, enabling users to access relevant insights and documentation for 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 |
pageable |
query |
true |
Indicates whether the results of the notes associated with a specific premise should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter notes related to a specific premise, enhancing the ability to analyze and manage real estate assets within the Nakisa Portfolio Management Suite. |
message |
query |
string |
false |
Textual content of the note associated with the specified premise, 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}
Premise - Create Premise Notes¶
HTTP Request
POST /api/premises/{id}/notes
📋 Description: Adds a new note to the specified premises within the Nakisa Portfolio Management Suite, enhancing asset documentation and supporting comprehensive portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the note details, including content and metadata, related to the specified real estate property 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. |
Premise - Get Premise Assessment Years¶
HTTP Request
GET /api/premises/{id}/assessment-years
📋 Description: Fetches the assessment years associated with a specific premise, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the assessment years for a specified premise should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "assessmentYears": [
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 "year": 1900,
13 "rollNumber": "string",
14 "referenceNumber": "string",
15 "name": "string",
16 "propertyTypeId": 0,
17 "matriculeNumber": "string",
18 "proShare": 0,
19 "payToId": 0,
20 "rollStartYear": 1900,
21 "rollDuration": "string",
22 "commencementFrom": "2019-08-24",
23 "commencementTo": "2019-08-24",
24 "description": "string",
25 "propertyType": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "priority": 0,
34 "internalId": 0,
35 "pickListCode": "string",
36 "pickListLabel": "string",
37 "label": "string",
38 "cultureId": 0,
39 "labelDtos": [
40 {
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 "cultureId": 0,
49 "value": "string"
50 }
51 ]
52 },
53 "payTo": {
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 }
82 ]
83 },
84 "page": {
85 "size": 0,
86 "totalElements": 0,
87 "totalPages": 0,
88 "number": 0
89 }
90}
Premise - Create Premise Assessment Years¶
HTTP Request
POST /api/premises/{id}/assessment-years
📋 Description: Creates a new assessment year for the specified premises, enabling enhanced analytics and portfolio management for real estate assets 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 assessment year data for the specified premises, including relevant metrics and analytics for portfolio and asset management within the real estate property domain. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "year": 1900,
11 "rollNumber": "string",
12 "referenceNumber": "string",
13 "name": "string",
14 "propertyTypeId": 0,
15 "matriculeNumber": "string",
16 "proShare": 0,
17 "payToId": 0,
18 "rollStartYear": 1900,
19 "rollDuration": "string",
20 "commencementFrom": "2019-08-24",
21 "commencementTo": "2019-08-24",
22 "description": "string",
23 "propertyType": {
24 "createdBy": "string",
25 "lastModifiedBy": "string",
26 "createdDate": "2019-08-24T14:15:22Z",
27 "lastModifiedDate": "2019-08-24T14:15:22Z",
28 "archived": true,
29 "externalId": "string",
30 "id": 0,
31 "priority": 0,
32 "internalId": 0,
33 "pickListCode": "string",
34 "pickListLabel": "string",
35 "label": "string",
36 "cultureId": 0,
37 "labelDtos": [
38 {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "cultureId": 0,
47 "value": "string"
48 }
49 ]
50 },
51 "payTo": {
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 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 }
79 }
80]
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 "year": 1900,
11 "rollNumber": "string",
12 "referenceNumber": "string",
13 "name": "string",
14 "propertyTypeId": 0,
15 "matriculeNumber": "string",
16 "proShare": 0,
17 "payToId": 0,
18 "rollStartYear": 1900,
19 "rollDuration": "string",
20 "commencementFrom": "2019-08-24",
21 "commencementTo": "2019-08-24",
22 "description": "string",
23 "propertyType": {
24 "createdBy": "string",
25 "lastModifiedBy": "string",
26 "createdDate": "2019-08-24T14:15:22Z",
27 "lastModifiedDate": "2019-08-24T14:15:22Z",
28 "archived": true,
29 "externalId": "string",
30 "id": 0,
31 "priority": 0,
32 "internalId": 0,
33 "pickListCode": "string",
34 "pickListLabel": "string",
35 "label": "string",
36 "cultureId": 0,
37 "labelDtos": [
38 {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "cultureId": 0,
47 "value": "string"
48 }
49 ]
50 },
51 "payTo": {
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 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 }
79 }
80]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the assessment year within the Nakisa Portfolio Management Suite, encompassing key metrics and analytics related to portfolio and asset performance in real estate property management.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» year |
integer(int32) |
true |
none |
Numeric value representing year |
» rollNumber |
string |
true |
none |
Unique identifier for the assessment year associated with a portfolio asset in the Nakisa Portfolio Management Suite. |
» referenceNumber |
string |
true |
none |
Unique identifier for the assessment year within the Nakisa Portfolio Management Suite, facilitating efficient tracking and analysis of portfolio and asset performance in real estate property management. |
» name |
string |
true |
none |
Name of the resource |
» propertyTypeId |
integer(int64) |
false |
none |
Unique identifier for the property type |
» matriculeNumber |
string |
false |
none |
Unique identifier for the real estate asset within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management. |
» proShare |
number |
false |
none |
Value for proShare field |
» payToId |
integer(int64) |
false |
none |
Unique identifier for the pay to |
» rollStartYear |
integer(int32) |
true |
none |
Numeric value representing rollStartYear |
» rollDuration |
string |
true |
none |
Specifies the duration of the roll period for assessments within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
» commencementFrom |
string(date) |
false |
none |
Specifies the start date for the assessment period of a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
» commencementTo |
string(date) |
false |
none |
Specifies the commencement date for the assessment year, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» description |
string |
false |
none |
Description of the resource |
» propertyType |
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. |
» payTo |
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. |
Premise - Get Premise Areas¶
HTTP Request
GET /api/premises/{id}/areas
📋 Description: Retrieves a list of areas associated with a specific premise, enabling users to analyze and manage real estate assets within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the area retrieval for a specified premise should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific areas within a real estate property portfolio in the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Identifier for the specific type of area associated with the real estate property, facilitating targeted analytics within the Nakisa Portfolio Management Suite. |
unit-id |
query |
string |
false |
Unique identifier for the specific unit within a real estate property, used to retrieve area details in the Nakisa Portfolio Management Suite. |
source-id |
query |
string |
false |
Unique identifier for the source of the premises data, facilitating accurate retrieval of area information within the Nakisa Portfolio Management Suite. |
pro-share-type-id |
query |
string |
false |
Unique identifier for the type of professional share associated with the specified premises area, facilitating portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
document-id |
query |
string |
false |
Unique identifier for the specific document associated with the premises, facilitating efficient retrieval of area-related data within the Nakisa Portfolio Management Suite. |
gross-up |
query |
string |
false |
Specifies the gross-up amount for calculating the total area of a real estate property within the portfolio analytics. |
lot |
query |
string |
false |
Identifier for the specific lot within the premises, used to retrieve detailed area information relevant to portfolio and asset management in the Nakisa Portfolio Management Suite. |
cadaster |
query |
string |
false |
Identifier for the cadaster associated with a specific premise, used to retrieve area details within the Nakisa Portfolio Management Suite for effective asset and portfolio analytics. |
verified |
query |
string |
false |
Indicates whether the areas associated with the specified premises have been verified, providing critical insights for portfolio and asset management within the Nakisa Portfolio Management Suite. |
to-be-measured |
query |
string |
false |
Specifies the area to be measured within the premises, facilitating precise analytics for portfolio and asset management in real estate properties. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "areas": [
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 "typeId": 0,
13 "unitId": 0,
14 "sourceId": 0,
15 "proShareTypeId": 0,
16 "documentId": 0,
17 "grossUp": 0,
18 "lot": "string",
19 "cadaster": "string",
20 "name": "string",
21 "verified": true,
22 "toBeMeasured": true,
23 "gla": true,
24 "type": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "source": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 },
80 "proShareType": {
81 "createdBy": "string",
82 "lastModifiedBy": "string",
83 "createdDate": "2019-08-24T14:15:22Z",
84 "lastModifiedDate": "2019-08-24T14:15:22Z",
85 "archived": true,
86 "externalId": "string",
87 "id": 0,
88 "priority": 0,
89 "internalId": 0,
90 "pickListCode": "string",
91 "pickListLabel": "string",
92 "label": "string",
93 "cultureId": 0,
94 "labelDtos": [
95 {
96 "createdBy": "string",
97 "lastModifiedBy": "string",
98 "createdDate": "2019-08-24T14:15:22Z",
99 "lastModifiedDate": "2019-08-24T14:15:22Z",
100 "archived": true,
101 "externalId": "string",
102 "id": 0,
103 "cultureId": 0,
104 "value": "string"
105 }
106 ]
107 },
108 "unitType": {
109 "createdBy": "string",
110 "lastModifiedBy": "string",
111 "createdDate": "2019-08-24T14:15:22Z",
112 "lastModifiedDate": "2019-08-24T14:15:22Z",
113 "archived": true,
114 "externalId": "string",
115 "id": 0,
116 "priority": 0,
117 "internalId": 0,
118 "pickListCode": "string",
119 "pickListLabel": "string",
120 "label": "string",
121 "cultureId": 0,
122 "labelDtos": [
123 {
124 "createdBy": "string",
125 "lastModifiedBy": "string",
126 "createdDate": "2019-08-24T14:15:22Z",
127 "lastModifiedDate": "2019-08-24T14:15:22Z",
128 "archived": true,
129 "externalId": "string",
130 "id": 0,
131 "cultureId": 0,
132 "value": "string"
133 }
134 ]
135 },
136 "historiesDto": [
137 {
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 "startDate": "2019-08-24",
146 "endDate": "2019-08-24",
147 "measure": 0,
148 "details": "string",
149 "floor": "string",
150 "suite": "string",
151 "areaId": 0,
152 "versionId": 0
153 }
154 ],
155 "archivedAssociation": true
156 }
157 ]
158 },
159 "page": {
160 "size": 0,
161 "totalElements": 0,
162 "totalPages": 0,
163 "number": 0
164 }
165}
Premise - Create Premise Areas¶
HTTP Request
POST /api/premises/{id}/areas
📋 Description: Creates a new area within a specified premise, enabling enhanced organization and management of real estate assets 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 area details, including name, type, and associated attributes, for the specified premises 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 "typeId": 0,
11 "unitId": 0,
12 "sourceId": 0,
13 "proShareTypeId": 0,
14 "documentId": 0,
15 "grossUp": 0,
16 "lot": "string",
17 "cadaster": "string",
18 "name": "string",
19 "verified": true,
20 "toBeMeasured": true,
21 "gla": true,
22 "type": {
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 "source": {
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 "proShareType": {
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 "priority": 0,
87 "internalId": 0,
88 "pickListCode": "string",
89 "pickListLabel": "string",
90 "label": "string",
91 "cultureId": 0,
92 "labelDtos": [
93 {
94 "createdBy": "string",
95 "lastModifiedBy": "string",
96 "createdDate": "2019-08-24T14:15:22Z",
97 "lastModifiedDate": "2019-08-24T14:15:22Z",
98 "archived": true,
99 "externalId": "string",
100 "id": 0,
101 "cultureId": 0,
102 "value": "string"
103 }
104 ]
105 },
106 "unitType": {
107 "createdBy": "string",
108 "lastModifiedBy": "string",
109 "createdDate": "2019-08-24T14:15:22Z",
110 "lastModifiedDate": "2019-08-24T14:15:22Z",
111 "archived": true,
112 "externalId": "string",
113 "id": 0,
114 "priority": 0,
115 "internalId": 0,
116 "pickListCode": "string",
117 "pickListLabel": "string",
118 "label": "string",
119 "cultureId": 0,
120 "labelDtos": [
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 "cultureId": 0,
130 "value": "string"
131 }
132 ]
133 },
134 "historiesDto": [
135 {
136 "createdBy": "string",
137 "lastModifiedBy": "string",
138 "createdDate": "2019-08-24T14:15:22Z",
139 "lastModifiedDate": "2019-08-24T14:15:22Z",
140 "archived": true,
141 "externalId": "string",
142 "id": 0,
143 "startDate": "2019-08-24",
144 "endDate": "2019-08-24",
145 "measure": 0,
146 "details": "string",
147 "floor": "string",
148 "suite": "string",
149 "areaId": 0,
150 "versionId": 0
151 }
152 ],
153 "archivedAssociation": true
154 }
155]
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 "typeId": 0,
11 "unitId": 0,
12 "sourceId": 0,
13 "proShareTypeId": 0,
14 "documentId": 0,
15 "grossUp": 0,
16 "lot": "string",
17 "cadaster": "string",
18 "name": "string",
19 "verified": true,
20 "toBeMeasured": true,
21 "gla": true,
22 "type": {
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 "source": {
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 "proShareType": {
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 "priority": 0,
87 "internalId": 0,
88 "pickListCode": "string",
89 "pickListLabel": "string",
90 "label": "string",
91 "cultureId": 0,
92 "labelDtos": [
93 {
94 "createdBy": "string",
95 "lastModifiedBy": "string",
96 "createdDate": "2019-08-24T14:15:22Z",
97 "lastModifiedDate": "2019-08-24T14:15:22Z",
98 "archived": true,
99 "externalId": "string",
100 "id": 0,
101 "cultureId": 0,
102 "value": "string"
103 }
104 ]
105 },
106 "unitType": {
107 "createdBy": "string",
108 "lastModifiedBy": "string",
109 "createdDate": "2019-08-24T14:15:22Z",
110 "lastModifiedDate": "2019-08-24T14:15:22Z",
111 "archived": true,
112 "externalId": "string",
113 "id": 0,
114 "priority": 0,
115 "internalId": 0,
116 "pickListCode": "string",
117 "pickListLabel": "string",
118 "label": "string",
119 "cultureId": 0,
120 "labelDtos": [
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 "cultureId": 0,
130 "value": "string"
131 }
132 ]
133 },
134 "historiesDto": [
135 {
136 "createdBy": "string",
137 "lastModifiedBy": "string",
138 "createdDate": "2019-08-24T14:15:22Z",
139 "lastModifiedDate": "2019-08-24T14:15:22Z",
140 "archived": true,
141 "externalId": "string",
142 "id": 0,
143 "startDate": "2019-08-24",
144 "endDate": "2019-08-24",
145 "measure": 0,
146 "details": "string",
147 "floor": "string",
148 "suite": "string",
149 "areaId": 0,
150 "versionId": 0
151 }
152 ],
153 "archivedAssociation": true
154 }
155]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a geographical area within the Nakisa Portfolio Management Suite, encompassing relevant attributes for portfolio analysis, asset management, and real estate property analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» typeId |
integer(int64) |
true |
none |
Unique identifier for the type |
» unitId |
integer(int64) |
false |
none |
Unique identifier for the unit |
» sourceId |
integer(int64) |
false |
none |
Unique identifier for the source |
» proShareTypeId |
integer(int64) |
false |
none |
Unique identifier for the pro share type |
» documentId |
integer(int64) |
false |
none |
Unique identifier for the document |
» grossUp |
integer(int64) |
false |
none |
Numeric value representing grossUp |
» lot |
string |
false |
none |
Represents the specific lot associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
» cadaster |
string |
false |
none |
Represents the cadastral information associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
» name |
string |
false |
none |
Name of the resource |
» verified |
boolean |
false |
none |
Boolean flag indicating verified status |
» toBeMeasured |
boolean |
false |
none |
Boolean flag indicating toBeMeasured status |
» gla |
boolean |
false |
none |
Boolean flag indicating gla status |
» 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. |
|
»» 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. |
» source |
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. |
|
» proShareType |
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. |
|
» unitType |
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. |
|
» historiesDto |
false |
none |
List of historiesDto 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 |
»» measure |
number |
false |
none |
Value for measure field |
»» details |
string |
false |
none |
Provides a detailed description of the historical context and analytics related to a specific portfolio or asset within the Nakisa Portfolio Management Suite. |
»» floor |
string |
false |
none |
Represents the specific floor designation within a real estate property, facilitating detailed portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
»» suite |
string |
false |
none |
Represents the name of the suite within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of portfolios, assets, and real estate properties. |
»» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
»» versionId |
integer(int64) |
false |
none |
none |
» archivedAssociation |
boolean |
false |
none |
Indicates whether the association has been archived, providing insight into the historical context of portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
Premise - Get Premise Areas History Versions¶
HTTP Request
GET /api/premises/{id}/areas-history-versions
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
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 "name": "string",
11 "date": "2019-08-24",
12 "premiseId": 0
13 }
14]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
none |
|
» createdBy |
string |
false |
none |
none |
» lastModifiedBy |
string |
false |
none |
none |
» createdDate |
string(date-time) |
false |
none |
none |
» lastModifiedDate |
string(date-time) |
false |
none |
none |
» archived |
boolean |
false |
none |
none |
» externalId |
string |
false |
none |
none |
» id |
integer(int64) |
false |
none |
none |
» name |
string |
false |
none |
none |
» date |
string(date) |
false |
none |
none |
» premiseId |
integer(int64) |
false |
none |
none |
Premise - Create Areas History Version¶
HTTP Request
POST /api/premises/{id}/areas-history-versions
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
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 "name": "string",
10 "date": "2019-08-24",
11 "premiseId": 0
12}
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 "name": "string",
10 "date": "2019-08-24",
11 "premiseId": 0
12}
Premise - Archive Premise¶
HTTP Request
POST /api/premises/{id}/archive
📋 Description: Archives the specified premises within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhancing portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}
Premise - Mass Delete Premises¶
HTTP Request
POST /api/premises/mass-delete
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "property1": "string",
3 "property2": "string"
4}
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» additionalProperties |
string |
false |
none |
none |
Premise - Get Image¶
HTTP Request
GET /api/premises/{premiseId}/pictures/{pictureId}/download
📋 Description: Downloads a specific picture associated with a premise, enabling users to access visual assets related to real estate properties within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Premise - Download Premise Document¶
HTTP Request
GET /api/premises/{premiseId}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a particular premise, enabling users to access critical information related to portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Premise - Get Premise Udf Field Values¶
HTTP Request
GET /api/premises/{id}/udf-field-values
📋 Description: Retrieves user-defined field values associated with a specific premise, enabling enhanced asset analytics and portfolio 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 |
Inline |
Example Responses
1[
2 {
3 "objectId": 0,
4 "valueType": "string",
5 "value": true,
6 "objectType": "string",
7 "createdBy": "string",
8 "lastModifiedBy": "string",
9 "createdDate": "2019-08-24T14:15:22Z",
10 "lastModifiedDate": "2019-08-24T14:15:22Z",
11 "archived": true,
12 "externalId": "string",
13 "id": 0,
14 "udfField": {
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 "typeId": 0,
23 "priority": 0,
24 "required": true,
25 "reportable": true,
26 "labels": [
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 }
41]
Response Schema
Premise - Get Transitions¶
HTTP Request
GET /api/premises/{id}/transitions
📋 Description: Fetches the transition history of a specified premise, providing insights into asset movements and changes within the portfolio for enhanced real estate analytics.
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 "name": "SEND_FOR_APPROVAL",
4 "from": {
5 "name": "DRAFT",
6 "end": true,
7 "readOnly": true
8 },
9 "to": {
10 "name": "DRAFT",
11 "end": true,
12 "readOnly": true
13 },
14 "permission": "string"
15 }
16]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a transition within the Nakisa Portfolio Management Suite, capturing the movement of assets across portfolios to enhance analytics and optimize real estate property management.] |
|
» name |
string |
false |
none |
Name of the resource |
» from |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
»» name |
string |
false |
none |
Name of the resource |
»» end |
boolean |
false |
none |
Boolean flag indicating end status |
»» readOnly |
boolean |
false |
none |
Boolean flag indicating readOnly status |
» to |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
» permission |
string |
false |
none |
Specifies the access level granted to users for managing portfolio, asset, and analytics data within the Nakisa Portfolio Management Suite. |
Enumerated Values
Attribute |
Value |
|---|---|
name |
ACTIVATE, ACTIVE, APPROVE, APPROVED, AWAITING_ACTIVATION, DEACTIVATE, DRAFT, INACTIVE, OPEN_FOR_MODIFICATIONS, PENDING_APPROVAL, PENDING_TERMINATE, PENDING_TERMINATION, REJECT, SEND_FOR_APPROVAL, TERMINATE, TERMINATED |
Premise - Get Sales Sorted By External Sale Category¶
HTTP Request
GET /api/premises/{id}/sales-by-external-category
📋 Description: Retrieves sales data categorized by external classifications for a specified premise, enabling enhanced analytics and insights within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
start-date |
query |
string(date) |
true |
Specifies the starting date for retrieving sales data by external category for a given premise, enabling analysis of sales performance over time within the Nakisa Portfolio Management Suite. |
end-date |
query |
string(date) |
true |
Specifies the end date for filtering sales data by external category within the specified premises, enabling targeted analytics in the context of portfolio and asset management. |
pageable |
query |
true |
Indicates whether the results of the sales data for the specified premise should be returned in a paginated format, facilitating efficient data retrieval and analysis within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "sales": [
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 "areaId": 0,
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "externalSaleSubCategoryId": 0,
16 "totalSales": 0,
17 "externalSaleSubCategory": {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "name": "string",
26 "saleSubCategoryId": 0,
27 "externalSaleCategory": {
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 "name": "string"
36 },
37 "externalSaleCategoryId": 0,
38 "saleSubCategory": {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "priority": 0,
47 "internalId": 0,
48 "pickListCode": "string",
49 "pickListLabel": "string",
50 "label": "string",
51 "cultureId": 0,
52 "labelDtos": [
53 {
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 "cultureId": 0,
62 "value": "string"
63 }
64 ]
65 },
66 "saleCategory": "string"
67 }
68 }
69 ]
70 },
71 "page": {
72 "size": 0,
73 "totalElements": 0,
74 "totalPages": 0,
75 "number": 0
76 }
77}
Premise - Get All Sale Groups¶
HTTP Request
GET /api/premises/{id}/sale-groups
📋 Description: Retrieves sale groups associated with a specific premise, enabling users to analyze and manage real estate property portfolios effectively within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the sale groups associated with a specific premise should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "saleGroups": [
4 {
5 "startDate": "2019-08-24",
6 "endDate": "2019-08-24",
7 "totalSales": 0
8 }
9 ]
10 },
11 "page": {
12 "size": 0,
13 "totalElements": 0,
14 "totalPages": 0,
15 "number": 0
16 }
17}
Premise - Get Premise Reminders¶
HTTP Request
GET /api/premises/{id}/reminders
📋 Description: Retrieves reminders associated with a specific premise 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 |
pageable |
query |
true |
Indicates whether the results of the reminders associated with a specific premise should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
subject-id |
query |
string |
false |
Unique identifier for the specific subject associated with reminders in the Nakisa Portfolio Management Suite, facilitating effective management of portfolio and asset analytics for real estate properties. |
category-id |
query |
string |
false |
Unique identifier for the category of reminders associated with a specific premise in the Nakisa Portfolio Management Suite, facilitating targeted analytics and management of real estate assets. |
lease-id |
query |
string |
false |
Unique identifier for the lease associated with the specified premises, used to retrieve relevant reminders within the Nakisa Portfolio Management Suite. |
lease-id-in |
query |
string |
false |
Unique identifier for the lease associated with the specified premises, used to retrieve relevant reminders within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of reminders associated with a specific premise within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
status-id-in |
query |
string |
false |
Specifies the status ID of reminders associated with the designated premises, facilitating targeted retrieval of reminder data within the Nakisa Portfolio Management Suite. |
reminder-type-id |
query |
string |
false |
Unique identifier for the type of reminder associated with a specific premise, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
reminder-type-id-in |
query |
string |
false |
Unique identifier for the type of reminder associated with a specific premise, facilitating targeted portfolio and asset management within the Nakisa Portfolio Management Suite. |
date |
query |
string |
false |
Date of the resource |
follow-up-date |
query |
string |
false |
Specifies the date for follow-up reminders related to a particular real estate property within the Nakisa Portfolio Management Suite. |
follow-up-date-before |
query |
string |
false |
Specifies the cutoff date for retrieving reminders related to a particular premise, enabling users to focus on upcoming tasks within the context of portfolio and asset management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "reminders": [
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 "subjectId": 0,
13 "categoryId": 0,
14 "statusId": 0,
15 "reminderTypeId": 0,
16 "date": "2019-08-24",
17 "followUpDate": "2019-08-24",
18 "comments": "string",
19 "primaryUserId": 0,
20 "subject": {
21 "createdBy": "string",
22 "lastModifiedBy": "string",
23 "createdDate": "2019-08-24T14:15:22Z",
24 "lastModifiedDate": "2019-08-24T14:15:22Z",
25 "archived": true,
26 "externalId": "string",
27 "id": 0,
28 "priority": 0,
29 "internalId": 0,
30 "pickListCode": "string",
31 "pickListLabel": "string",
32 "label": "string",
33 "cultureId": 0,
34 "labelDtos": [
35 {
36 "createdBy": "string",
37 "lastModifiedBy": "string",
38 "createdDate": "2019-08-24T14:15:22Z",
39 "lastModifiedDate": "2019-08-24T14:15:22Z",
40 "archived": true,
41 "externalId": "string",
42 "id": 0,
43 "cultureId": 0,
44 "value": "string"
45 }
46 ]
47 },
48 "category": {
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 "priority": 0,
57 "internalId": 0,
58 "pickListCode": "string",
59 "pickListLabel": "string",
60 "label": "string",
61 "cultureId": 0,
62 "labelDtos": [
63 {
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 "cultureId": 0,
72 "value": "string"
73 }
74 ]
75 },
76 "status": {
77 "createdBy": "string",
78 "lastModifiedBy": "string",
79 "createdDate": "2019-08-24T14:15:22Z",
80 "lastModifiedDate": "2019-08-24T14:15:22Z",
81 "archived": true,
82 "externalId": "string",
83 "id": 0,
84 "priority": 0,
85 "internalId": 0,
86 "pickListCode": "string",
87 "pickListLabel": "string",
88 "label": "string",
89 "cultureId": 0,
90 "labelDtos": [
91 {
92 "createdBy": "string",
93 "lastModifiedBy": "string",
94 "createdDate": "2019-08-24T14:15:22Z",
95 "lastModifiedDate": "2019-08-24T14:15:22Z",
96 "archived": true,
97 "externalId": "string",
98 "id": 0,
99 "cultureId": 0,
100 "value": "string"
101 }
102 ]
103 },
104 "reminderType": {
105 "createdBy": "string",
106 "lastModifiedBy": "string",
107 "createdDate": "2019-08-24T14:15:22Z",
108 "lastModifiedDate": "2019-08-24T14:15:22Z",
109 "archived": true,
110 "externalId": "string",
111 "id": 0,
112 "priority": 0,
113 "internalId": 0,
114 "pickListCode": "string",
115 "pickListLabel": "string",
116 "label": "string",
117 "cultureId": 0,
118 "labelDtos": [
119 {
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 "cultureId": 0,
128 "value": "string"
129 }
130 ]
131 },
132 "primaryUser": {
133 "createdBy": "string",
134 "lastModifiedBy": "string",
135 "createdDate": "2019-08-24T14:15:22Z",
136 "lastModifiedDate": "2019-08-24T14:15:22Z",
137 "archived": true,
138 "externalId": "string",
139 "id": 0,
140 "email": "string",
141 "userName": "string",
142 "firstName": "string",
143 "lastName": "string",
144 "displayName": "string",
145 "permissions": "string",
146 "internalId": "string",
147 "preferredCulture": {
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 "name": "string",
156 "code": "string",
157 "defaultCulture": true,
158 "enable": true
159 },
160 "userGroups": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "name": "string",
170 "description": "string",
171 "internalId": "string"
172 }
173 ],
174 "partnerIds": [
175 0
176 ],
177 "partners": [
178 {
179 "id": 0,
180 "status": "CREATED",
181 "displayId": "string",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string",
184 "name": "string",
185 "fax": "string",
186 "phone": "string",
187 "parentId": 0,
188 "parentName": "string",
189 "parentDisplayId": "string",
190 "companyId": 0,
191 "partnerRoleId": 0,
192 "partnerContactId": 0
193 }
194 ]
195 },
196 "leaseExternalId": "string",
197 "premiseName": "string",
198 "reminderUserDtos": [
199 {
200 "createdBy": "string",
201 "lastModifiedBy": "string",
202 "createdDate": "2019-08-24T14:15:22Z",
203 "lastModifiedDate": "2019-08-24T14:15:22Z",
204 "archived": true,
205 "externalId": "string",
206 "acknowledge": true,
207 "userDto": {
208 "createdBy": "string",
209 "lastModifiedBy": "string",
210 "createdDate": "2019-08-24T14:15:22Z",
211 "lastModifiedDate": "2019-08-24T14:15:22Z",
212 "archived": true,
213 "externalId": "string",
214 "id": 0,
215 "email": "string",
216 "userName": "string",
217 "firstName": "string",
218 "lastName": "string",
219 "displayName": "string",
220 "permissions": "string",
221 "internalId": "string",
222 "preferredCulture": {
223 "createdBy": "string",
224 "lastModifiedBy": "string",
225 "createdDate": "2019-08-24T14:15:22Z",
226 "lastModifiedDate": "2019-08-24T14:15:22Z",
227 "archived": true,
228 "externalId": "string",
229 "id": 0,
230 "name": "string",
231 "code": "string",
232 "defaultCulture": true,
233 "enable": true
234 },
235 "userGroups": [
236 {
237 "createdBy": "string",
238 "lastModifiedBy": "string",
239 "createdDate": "2019-08-24T14:15:22Z",
240 "lastModifiedDate": "2019-08-24T14:15:22Z",
241 "archived": true,
242 "externalId": "string",
243 "id": 0,
244 "name": "string",
245 "description": "string",
246 "internalId": "string"
247 }
248 ],
249 "partnerIds": [
250 0
251 ],
252 "partners": [
253 {
254 "id": 0,
255 "status": "CREATED",
256 "displayId": "string",
257 "erpSystemId": 0,
258 "erpSystemDisplayId": "string",
259 "name": "string",
260 "fax": "string",
261 "phone": "string",
262 "parentId": 0,
263 "parentName": "string",
264 "parentDisplayId": "string",
265 "companyId": 0,
266 "partnerRoleId": 0,
267 "partnerContactId": 0
268 }
269 ]
270 }
271 }
272 ]
273 }
274 ]
275 },
276 "page": {
277 "size": 0,
278 "totalElements": 0,
279 "totalPages": 0,
280 "number": 0
281 }
282}
Premise - Get Recurring Payments For Premise ID¶
HTTP Request
GET /api/premises/{id}/recurring-payments
📋 Description: Fetches recurring payment details for a specified premise within the Nakisa Portfolio Management Suite, enabling users to analyze financial commitments related to real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
year |
query |
integer(int32) |
false |
Specifies the fiscal year for which recurring payment data is being requested for the specified premises within the Nakisa Portfolio Management Suite. |
principal-position-type |
query |
string |
false |
Specifies the type of principal position for recurring payments associated with a real estate property within the Nakisa Portfolio Management Suite. |
premise-external-id |
query |
string |
false |
Unique identifier for the external reference of a premise, facilitating the retrieval of recurring payment information within the Nakisa Portfolio Management Suite. |
lease-external-id |
query |
string |
false |
Unique identifier for the external lease associated with the specified premises, facilitating accurate tracking and management of recurring payments within the Nakisa Portfolio Management Suite. |
expense-category-id |
query |
integer(int64) |
false |
Unique identifier for the expense category associated with recurring payments in the Nakisa Portfolio Management Suite, facilitating detailed financial analytics for real estate property management. |
posting-status |
query |
string |
false |
Indicates the current status of the posting for recurring payments associated with a specific real estate property within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "recurringPayments": [
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 "paymentId": 0,
13 "paymentDate": "2019-08-24",
14 "period": 0,
15 "periodStartDate": "2019-08-24",
16 "periodEndDate": "2019-08-24",
17 "termType": "PAYMENT_TERM",
18 "expenseCategory": "string",
19 "expenseCategoryId": 0,
20 "amount": 0,
21 "nonLeaseAmount": 0,
22 "taxAmount": 0,
23 "postingTransactionType": "POST",
24 "internalPostingStatus": {
25 "documentNumber": "string",
26 "status": "NA",
27 "postingMessage": "string"
28 },
29 "leaseComponentDisplayId": "string",
30 "activationGroupState": "MLA_DEFINE",
31 "currencyCode": "string",
32 "activationGroupRevisionId": 0,
33 "journalId": 0,
34 "journalEntryId": 0,
35 "unitId": 0,
36 "termId": 0,
37 "hasTaxes": true,
38 "leaseComponentFinancialTermId": 0,
39 "postingDate": "2019-08-24",
40 "expenseAccount": "string",
41 "costCenter": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemId": 0
47 },
48 "principalPositionType": "LESSEE",
49 "leaseExternalId": "string",
50 "companyId": 0,
51 "erpSystemId": 0,
52 "leaseId": 0,
53 "premiseId": 0,
54 "premiseExternalId": "string"
55 }
56 ]
57 },
58 "page": {
59 "size": 0,
60 "totalElements": 0,
61 "totalPages": 0,
62 "number": 0
63 }
64}
Premise - Get Leases For Premise¶
HTTP Request
GET /api/premises/{id}/leases
📋 Description: Fetches lease details associated with a specific real estate property identified by the given ID, enabling portfolio and asset management analysis within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the lease query for the specified premise should be returned in a paginated format, facilitating efficient data retrieval and analysis within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific lease records associated with a designated premise within the Nakisa Portfolio Management Suite. |
premise-id |
query |
string |
false |
Unique identifier for the real estate property within the Nakisa Portfolio Management Suite, used to retrieve associated lease information. |
premise-id-in |
query |
string |
false |
Unique identifier for the specific premise within the Nakisa Portfolio Management Suite, used to retrieve associated lease information. |
premise-id-not-null |
query |
string |
false |
Unique identifier for the premise, ensuring that only valid premises are queried for lease information within the Nakisa Portfolio Management Suite. |
premise-number |
query |
string |
false |
Identifier for the specific premise within the Nakisa Portfolio Management Suite, used to retrieve associated lease information for effective portfolio and asset management. |
premise-number-like |
query |
string |
false |
Specifies a string pattern to filter lease records associated with a particular premise, enhancing asset management and analytics within the Nakisa Portfolio Management Suite. |
premise-external-id |
query |
string |
false |
Unique identifier for the external premise, used to retrieve lease information within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics. |
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve lease information associated with that premises. |
location-number |
query |
string |
false |
Specifies the location number associated with the lease for a given premises, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
location-number-like |
query |
string |
false |
Specifies a string pattern to filter lease records associated with a particular premise, enhancing the search capabilities within the Nakisa Portfolio Management Suite for real estate property analytics. |
location-external-id |
query |
string |
false |
Unique identifier for the external location associated with the lease, facilitating accurate tracking and management of real estate assets within the Nakisa Portfolio Management Suite. |
address-id |
query |
string |
false |
Unique identifier for the specific address associated with the leases in the Nakisa Portfolio Management Suite, facilitating targeted analytics and management of real estate properties. |
city-id |
query |
string |
false |
Unique identifier for the city associated with the premises, used to retrieve lease information within the Nakisa Portfolio Management Suite. |
province-id |
query |
string |
false |
Unique identifier for the province associated with the leases of a specified premise, facilitating targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
country-id |
query |
string |
false |
Unique identifier for the country associated with the lease, used to filter lease data within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
contract-id |
query |
string |
false |
Unique identifier for the lease contract associated with the specified premises, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
Represents the lease number associated with the specified premises, facilitating accurate retrieval of lease information within the Nakisa Portfolio Management Suite. |
number-like |
query |
string |
false |
Specifies a numeric or string representation of a lease identifier within the Nakisa Portfolio Management Suite, facilitating the retrieval of lease data for real estate property analytics. |
number-in |
query |
string |
false |
none |
id |
query |
string |
false |
none |
id-in |
query |
string |
false |
none |
type-id |
query |
string |
false |
Identifier for the specific lease type associated with the premises, facilitating targeted analytics and management within the Nakisa Portfolio Management Suite. |
terminating-lease |
query |
string |
false |
Indicates the status of the lease termination for the specified premises, providing critical insights for portfolio management and real estate analytics. |
signature-date |
query |
string |
false |
Specifies the date for which lease information is being requested, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite. |
category-id |
query |
string |
false |
Unique identifier for the category of leases associated with a specific premise, facilitating targeted analytics within the Nakisa Portfolio Management Suite. |
registration-number |
query |
string |
false |
Unique identifier for the registration of a real estate property, used to retrieve lease information within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of leases associated with a specific premises, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
status-id-is-not |
query |
string |
false |
Excludes leases with the specified status ID from the response, enabling users to filter lease data effectively within the Nakisa Portfolio Management Suite. |
status-id-in |
query |
string |
false |
Specifies the status identifier for filtering lease records associated with a particular premise within the Nakisa Portfolio Management Suite. |
original-lease-id |
query |
string |
false |
Unique identifier for the original lease associated with a specific premises, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
parent-lease-id-is-null |
query |
string |
false |
none |
state-id |
query |
string |
false |
Unique identifier for the specific state associated with the lease, facilitating precise retrieval of lease information within the Nakisa Portfolio Management Suite. |
areas-history-version-id |
query |
string |
false |
none |
valid-from |
query |
string |
false |
Specifies the start date for the lease, enabling users to filter lease data within the context of portfolio and asset management in real estate analytics. |
valid-to |
query |
string |
false |
Specifies the expiration date of the lease associated with the identified premises, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
valid-to-greater-than |
query |
string |
false |
Specifies a date string to filter leases that are valid beyond the given date, enhancing portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
valid-to-less-than |
query |
string |
false |
Specifies the upper limit for the lease end date, enabling users to filter leases based on their validity period within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leases": [
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 "typeId": 0,
13 "terminatingLease": "2019-08-24",
14 "maximumDateTo": "2019-08-24",
15 "number": "string",
16 "validFrom": "2019-08-24",
17 "validTo": "2019-08-24",
18 "categoryId": 0,
19 "registrationNumber": "string",
20 "statusId": 0,
21 "stateId": 0,
22 "calculateTax": true,
23 "autoMonthToMonth": true,
24 "originalLeaseId": 0,
25 "scenario": true,
26 "parentLeaseId": 0,
27 "areasHistoryVersionId": 0,
28 "provisioningFrequencyName": "string",
29 "accountingApproved": true,
30 "indexationType": "string",
31 "cpiGlobalCategoryId": 0,
32 "indexationReferenceDate": "2019-08-24",
33 "currentIndexLevel": 0.1,
34 "conditionallyIndexed": true,
35 "applicableCurrentIndexLevel": 0.1,
36 "indexLevelPercentageChangeLowerBound": 0.1,
37 "indexLevelPercentageChangeUpperBound": 0.1,
38 "indexationTypeNonLease": "string",
39 "cpiGlobalCategoryIdNonLease": 0,
40 "indexationReferenceDateNonLease": "2019-08-24",
41 "currentIndexLevelNonLease": 0.1,
42 "conditionallyIndexedNonLease": true,
43 "applicableCurrentIndexLevelNonLease": 0.1,
44 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
45 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
46 "signatureDate": "2019-08-24",
47 "premiseId": 0,
48 "type": {
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 "priority": 0,
57 "internalId": 0,
58 "pickListCode": "string",
59 "pickListLabel": "string",
60 "label": "string",
61 "cultureId": 0,
62 "labelDtos": [
63 {
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 "cultureId": 0,
72 "value": "string"
73 }
74 ]
75 },
76 "category": {
77 "createdBy": "string",
78 "lastModifiedBy": "string",
79 "createdDate": "2019-08-24T14:15:22Z",
80 "lastModifiedDate": "2019-08-24T14:15:22Z",
81 "archived": true,
82 "externalId": "string",
83 "id": 0,
84 "priority": 0,
85 "internalId": 0,
86 "pickListCode": "string",
87 "pickListLabel": "string",
88 "label": "string",
89 "cultureId": 0,
90 "labelDtos": [
91 {
92 "createdBy": "string",
93 "lastModifiedBy": "string",
94 "createdDate": "2019-08-24T14:15:22Z",
95 "lastModifiedDate": "2019-08-24T14:15:22Z",
96 "archived": true,
97 "externalId": "string",
98 "id": 0,
99 "cultureId": 0,
100 "value": "string"
101 }
102 ]
103 },
104 "status": {
105 "createdBy": "string",
106 "lastModifiedBy": "string",
107 "createdDate": "2019-08-24T14:15:22Z",
108 "lastModifiedDate": "2019-08-24T14:15:22Z",
109 "archived": true,
110 "externalId": "string",
111 "id": 0,
112 "priority": 0,
113 "internalId": 0,
114 "pickListCode": "string",
115 "pickListLabel": "string",
116 "label": "string",
117 "cultureId": 0,
118 "labelDtos": [
119 {
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 "cultureId": 0,
128 "value": "string"
129 }
130 ]
131 },
132 "state": {
133 "createdBy": "string",
134 "lastModifiedBy": "string",
135 "createdDate": "2019-08-24T14:15:22Z",
136 "lastModifiedDate": "2019-08-24T14:15:22Z",
137 "archived": true,
138 "externalId": "string",
139 "id": 0,
140 "priority": 0,
141 "internalId": 0,
142 "pickListCode": "string",
143 "pickListLabel": "string",
144 "label": "string",
145 "cultureId": 0,
146 "labelDtos": [
147 {
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 "cultureId": 0,
156 "value": "string"
157 }
158 ]
159 },
160 "version": {
161 "createdBy": "string",
162 "lastModifiedBy": "string",
163 "createdDate": "2019-08-24T14:15:22Z",
164 "lastModifiedDate": "2019-08-24T14:15:22Z",
165 "archived": true,
166 "externalId": "string",
167 "id": 0,
168 "name": "string",
169 "description": "string",
170 "modificationDate": "2019-08-24",
171 "updateContractRate": true,
172 "leaseEvent": {
173 "createdBy": "string",
174 "lastModifiedBy": "string",
175 "createdDate": "2019-08-24T14:15:22Z",
176 "lastModifiedDate": "2019-08-24T14:15:22Z",
177 "archived": true,
178 "externalId": "string",
179 "id": 0,
180 "typeId": 0,
181 "code": "string",
182 "reviewedBy": "string",
183 "reviewedDate": "2019-08-24",
184 "reviewedStatusId": 0,
185 "activityDate": "2019-08-24",
186 "relatedPickListOptionId": 0,
187 "detail": "string",
188 "note": {
189 "createdBy": "string",
190 "lastModifiedBy": "string",
191 "createdDate": "2019-08-24T14:15:22Z",
192 "lastModifiedDate": "2019-08-24T14:15:22Z",
193 "archived": true,
194 "externalId": "string",
195 "id": 0,
196 "message": "string",
197 "preserveOriginalAudit": true,
198 "originalCreatedBy": "string",
199 "originalCreatedDate": "2019-08-24T14:15:22Z",
200 "originalLastModifiedBy": "string",
201 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
202 },
203 "type": {
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 "reviewedStatus": {
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 "priority": 0,
240 "internalId": 0,
241 "pickListCode": "string",
242 "pickListLabel": "string",
243 "label": "string",
244 "cultureId": 0,
245 "labelDtos": [
246 {
247 "createdBy": "string",
248 "lastModifiedBy": "string",
249 "createdDate": "2019-08-24T14:15:22Z",
250 "lastModifiedDate": "2019-08-24T14:15:22Z",
251 "archived": true,
252 "externalId": "string",
253 "id": 0,
254 "cultureId": 0,
255 "value": "string"
256 }
257 ]
258 },
259 "relatedPickListOption": {
260 "createdBy": "string",
261 "lastModifiedBy": "string",
262 "createdDate": "2019-08-24T14:15:22Z",
263 "lastModifiedDate": "2019-08-24T14:15:22Z",
264 "archived": true,
265 "externalId": "string",
266 "id": 0,
267 "priority": 0,
268 "internalId": 0,
269 "pickListCode": "string",
270 "pickListLabel": "string",
271 "label": "string",
272 "cultureId": 0,
273 "labelDtos": [
274 {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "cultureId": 0,
283 "value": "string"
284 }
285 ]
286 },
287 "isVisiblePartnerPortal": true
288 },
289 "isVisibleVendorPortal": true,
290 "isTerminationVersion": true,
291 "terminationDate": "2019-08-24",
292 "penaltyAmount": 0.1,
293 "areasHistoryVersionId": 0
294 },
295 "premiseDto": {
296 "createdBy": "string",
297 "lastModifiedBy": "string",
298 "createdDate": "2019-08-24T14:15:22Z",
299 "lastModifiedDate": "2019-08-24T14:15:22Z",
300 "archived": true,
301 "externalId": "string",
302 "id": 0,
303 "number": "string",
304 "name": "string",
305 "headPremise": true,
306 "possessionDate": "2019-08-24",
307 "openingDate": "2019-08-24",
308 "closingDate": "2019-08-24",
309 "relocationDate": "2019-08-24",
310 "vacatingDate": "2019-08-24",
311 "expansionDate": "2019-08-24",
312 "statusId": 0,
313 "usageId": 0,
314 "parentPremiseId": 0,
315 "costCenterId": 0,
316 "profitCenterId": 0,
317 "legalEntityId": 0,
318 "occupancyIds": [
319 0
320 ],
321 "locationId": 0,
322 "locationDto": {
323 "createdBy": "string",
324 "lastModifiedBy": "string",
325 "createdDate": "2019-08-24T14:15:22Z",
326 "lastModifiedDate": "2019-08-24T14:15:22Z",
327 "archived": true,
328 "externalId": "string",
329 "id": 0,
330 "number": "string",
331 "name": "string",
332 "storeNumber": "string",
333 "defaultCurrencyId": 0,
334 "defaultMeasureId": 0,
335 "typeId": 0,
336 "qualityId": 0,
337 "propertyTypeId": 0,
338 "categoryId": 0,
339 "statusId": 0,
340 "businessUnitId": 0,
341 "groupIds": [
342 0
343 ],
344 "legalEntityIds": [
345 0
346 ],
347 "defaultCurrency": {
348 "id": 0,
349 "status": "CREATED",
350 "displayId": "string",
351 "erpSystemId": 0,
352 "erpSystemDisplayId": "string",
353 "name": "string",
354 "decimalPoints": 0,
355 "depreciationAreaId": 0
356 },
357 "defaultUnitValue": {
358 "createdBy": "string",
359 "lastModifiedBy": "string",
360 "createdDate": "2019-08-24T14:15:22Z",
361 "lastModifiedDate": "2019-08-24T14:15:22Z",
362 "archived": true,
363 "externalId": "string",
364 "id": 0,
365 "unitId": 0,
366 "unitOfMeasureId": 0,
367 "erpSystemId": 0,
368 "unit": {
369 "createdBy": "string",
370 "lastModifiedBy": "string",
371 "createdDate": "2019-08-24T14:15:22Z",
372 "lastModifiedDate": "2019-08-24T14:15:22Z",
373 "archived": true,
374 "externalId": "string",
375 "id": 0,
376 "priority": 0,
377 "internalId": 0,
378 "pickListCode": "string",
379 "pickListLabel": "string",
380 "label": "string",
381 "cultureId": 0,
382 "labelDtos": [
383 {
384 "createdBy": "string",
385 "lastModifiedBy": "string",
386 "createdDate": "2019-08-24T14:15:22Z",
387 "lastModifiedDate": "2019-08-24T14:15:22Z",
388 "archived": true,
389 "externalId": "string",
390 "id": 0,
391 "cultureId": 0,
392 "value": "string"
393 }
394 ]
395 },
396 "unitOfMeasure": {
397 "id": 0,
398 "status": "CREATED",
399 "displayId": "string",
400 "erpSystemId": 0,
401 "erpSystemDisplayId": "string",
402 "name": "string"
403 }
404 },
405 "type": {
406 "createdBy": "string",
407 "lastModifiedBy": "string",
408 "createdDate": "2019-08-24T14:15:22Z",
409 "lastModifiedDate": "2019-08-24T14:15:22Z",
410 "archived": true,
411 "externalId": "string",
412 "id": 0,
413 "priority": 0,
414 "internalId": 0,
415 "pickListCode": "string",
416 "pickListLabel": "string",
417 "label": "string",
418 "cultureId": 0,
419 "labelDtos": [
420 {
421 "createdBy": "string",
422 "lastModifiedBy": "string",
423 "createdDate": "2019-08-24T14:15:22Z",
424 "lastModifiedDate": "2019-08-24T14:15:22Z",
425 "archived": true,
426 "externalId": "string",
427 "id": 0,
428 "cultureId": 0,
429 "value": "string"
430 }
431 ]
432 },
433 "quality": {
434 "createdBy": "string",
435 "lastModifiedBy": "string",
436 "createdDate": "2019-08-24T14:15:22Z",
437 "lastModifiedDate": "2019-08-24T14:15:22Z",
438 "archived": true,
439 "externalId": "string",
440 "id": 0,
441 "priority": 0,
442 "internalId": 0,
443 "pickListCode": "string",
444 "pickListLabel": "string",
445 "label": "string",
446 "cultureId": 0,
447 "labelDtos": [
448 {
449 "createdBy": "string",
450 "lastModifiedBy": "string",
451 "createdDate": "2019-08-24T14:15:22Z",
452 "lastModifiedDate": "2019-08-24T14:15:22Z",
453 "archived": true,
454 "externalId": "string",
455 "id": 0,
456 "cultureId": 0,
457 "value": "string"
458 }
459 ]
460 },
461 "propertyType": {
462 "createdBy": "string",
463 "lastModifiedBy": "string",
464 "createdDate": "2019-08-24T14:15:22Z",
465 "lastModifiedDate": "2019-08-24T14:15:22Z",
466 "archived": true,
467 "externalId": "string",
468 "id": 0,
469 "priority": 0,
470 "internalId": 0,
471 "pickListCode": "string",
472 "pickListLabel": "string",
473 "label": "string",
474 "cultureId": 0,
475 "labelDtos": [
476 {
477 "createdBy": "string",
478 "lastModifiedBy": "string",
479 "createdDate": "2019-08-24T14:15:22Z",
480 "lastModifiedDate": "2019-08-24T14:15:22Z",
481 "archived": true,
482 "externalId": "string",
483 "id": 0,
484 "cultureId": 0,
485 "value": "string"
486 }
487 ]
488 },
489 "category": {
490 "createdBy": "string",
491 "lastModifiedBy": "string",
492 "createdDate": "2019-08-24T14:15:22Z",
493 "lastModifiedDate": "2019-08-24T14:15:22Z",
494 "archived": true,
495 "externalId": "string",
496 "id": 0,
497 "priority": 0,
498 "internalId": 0,
499 "pickListCode": "string",
500 "pickListLabel": "string",
501 "label": "string",
502 "cultureId": 0,
503 "labelDtos": [
504 {
505 "createdBy": "string",
506 "lastModifiedBy": "string",
507 "createdDate": "2019-08-24T14:15:22Z",
508 "lastModifiedDate": "2019-08-24T14:15:22Z",
509 "archived": true,
510 "externalId": "string",
511 "id": 0,
512 "cultureId": 0,
513 "value": "string"
514 }
515 ]
516 },
517 "status": {
518 "createdBy": "string",
519 "lastModifiedBy": "string",
520 "createdDate": "2019-08-24T14:15:22Z",
521 "lastModifiedDate": "2019-08-24T14:15:22Z",
522 "archived": true,
523 "externalId": "string",
524 "id": 0,
525 "priority": 0,
526 "internalId": 0,
527 "pickListCode": "string",
528 "pickListLabel": "string",
529 "label": "string",
530 "cultureId": 0,
531 "labelDtos": [
532 {
533 "createdBy": "string",
534 "lastModifiedBy": "string",
535 "createdDate": "2019-08-24T14:15:22Z",
536 "lastModifiedDate": "2019-08-24T14:15:22Z",
537 "archived": true,
538 "externalId": "string",
539 "id": 0,
540 "cultureId": 0,
541 "value": "string"
542 }
543 ]
544 },
545 "addressDto": {
546 "createdBy": "string",
547 "lastModifiedBy": "string",
548 "createdDate": "2019-08-24T14:15:22Z",
549 "lastModifiedDate": "2019-08-24T14:15:22Z",
550 "archived": true,
551 "externalId": "string",
552 "id": 0,
553 "street": "string",
554 "civicNumber": "string",
555 "suite": "string",
556 "postalCode": "string",
557 "lon": 0.1,
558 "lat": 0.1,
559 "city": {
560 "createdBy": "string",
561 "lastModifiedBy": "string",
562 "createdDate": "2019-08-24T14:15:22Z",
563 "lastModifiedDate": "2019-08-24T14:15:22Z",
564 "archived": true,
565 "externalId": "string",
566 "id": 0,
567 "name": "string",
568 "province": {
569 "createdBy": "string",
570 "lastModifiedBy": "string",
571 "createdDate": "2019-08-24T14:15:22Z",
572 "lastModifiedDate": "2019-08-24T14:15:22Z",
573 "archived": true,
574 "externalId": "string",
575 "id": 0,
576 "name": "string",
577 "code": "string",
578 "country": {
579 "createdBy": "string",
580 "lastModifiedBy": "string",
581 "createdDate": "2019-08-24T14:15:22Z",
582 "lastModifiedDate": "2019-08-24T14:15:22Z",
583 "archived": true,
584 "externalId": "string",
585 "id": 0,
586 "name": "string",
587 "code": "string"
588 },
589 "provinceCountryKey": "string"
590 },
591 "cityProvinceCountryKey": "string"
592 },
593 "district": {
594 "createdBy": "string",
595 "lastModifiedBy": "string",
596 "createdDate": "2019-08-24T14:15:22Z",
597 "lastModifiedDate": "2019-08-24T14:15:22Z",
598 "archived": true,
599 "externalId": "string",
600 "id": 0,
601 "name": "string",
602 "city": {
603 "createdBy": "string",
604 "lastModifiedBy": "string",
605 "createdDate": "2019-08-24T14:15:22Z",
606 "lastModifiedDate": "2019-08-24T14:15:22Z",
607 "archived": true,
608 "externalId": "string",
609 "id": 0,
610 "name": "string",
611 "province": {
612 "createdBy": "string",
613 "lastModifiedBy": "string",
614 "createdDate": "2019-08-24T14:15:22Z",
615 "lastModifiedDate": "2019-08-24T14:15:22Z",
616 "archived": true,
617 "externalId": "string",
618 "id": 0,
619 "name": "string",
620 "code": "string",
621 "country": {},
622 "provinceCountryKey": "string"
623 },
624 "cityProvinceCountryKey": "string"
625 }
626 },
627 "cityId": 0,
628 "districtId": 0
629 },
630 "secondAddressDto": {
631 "createdBy": "string",
632 "lastModifiedBy": "string",
633 "createdDate": "2019-08-24T14:15:22Z",
634 "lastModifiedDate": "2019-08-24T14:15:22Z",
635 "archived": true,
636 "externalId": "string",
637 "id": 0,
638 "street": "string",
639 "civicNumber": "string",
640 "suite": "string",
641 "postalCode": "string",
642 "lon": 0.1,
643 "lat": 0.1,
644 "city": {
645 "createdBy": "string",
646 "lastModifiedBy": "string",
647 "createdDate": "2019-08-24T14:15:22Z",
648 "lastModifiedDate": "2019-08-24T14:15:22Z",
649 "archived": true,
650 "externalId": "string",
651 "id": 0,
652 "name": "string",
653 "province": {
654 "createdBy": "string",
655 "lastModifiedBy": "string",
656 "createdDate": "2019-08-24T14:15:22Z",
657 "lastModifiedDate": "2019-08-24T14:15:22Z",
658 "archived": true,
659 "externalId": "string",
660 "id": 0,
661 "name": "string",
662 "code": "string",
663 "country": {
664 "createdBy": "string",
665 "lastModifiedBy": "string",
666 "createdDate": "2019-08-24T14:15:22Z",
667 "lastModifiedDate": "2019-08-24T14:15:22Z",
668 "archived": true,
669 "externalId": "string",
670 "id": 0,
671 "name": "string",
672 "code": "string"
673 },
674 "provinceCountryKey": "string"
675 },
676 "cityProvinceCountryKey": "string"
677 },
678 "district": {
679 "createdBy": "string",
680 "lastModifiedBy": "string",
681 "createdDate": "2019-08-24T14:15:22Z",
682 "lastModifiedDate": "2019-08-24T14:15:22Z",
683 "archived": true,
684 "externalId": "string",
685 "id": 0,
686 "name": "string",
687 "city": {
688 "createdBy": "string",
689 "lastModifiedBy": "string",
690 "createdDate": "2019-08-24T14:15:22Z",
691 "lastModifiedDate": "2019-08-24T14:15:22Z",
692 "archived": true,
693 "externalId": "string",
694 "id": 0,
695 "name": "string",
696 "province": {
697 "createdBy": "string",
698 "lastModifiedBy": "string",
699 "createdDate": "2019-08-24T14:15:22Z",
700 "lastModifiedDate": "2019-08-24T14:15:22Z",
701 "archived": true,
702 "externalId": "string",
703 "id": 0,
704 "name": "string",
705 "code": "string",
706 "country": {},
707 "provinceCountryKey": "string"
708 },
709 "cityProvinceCountryKey": "string"
710 }
711 },
712 "cityId": 0,
713 "districtId": 0
714 }
715 },
716 "status": {
717 "createdBy": "string",
718 "lastModifiedBy": "string",
719 "createdDate": "2019-08-24T14:15:22Z",
720 "lastModifiedDate": "2019-08-24T14:15:22Z",
721 "archived": true,
722 "externalId": "string",
723 "id": 0,
724 "priority": 0,
725 "internalId": 0,
726 "pickListCode": "string",
727 "pickListLabel": "string",
728 "label": "string",
729 "cultureId": 0,
730 "labelDtos": [
731 {
732 "createdBy": "string",
733 "lastModifiedBy": "string",
734 "createdDate": "2019-08-24T14:15:22Z",
735 "lastModifiedDate": "2019-08-24T14:15:22Z",
736 "archived": true,
737 "externalId": "string",
738 "id": 0,
739 "cultureId": 0,
740 "value": "string"
741 }
742 ]
743 },
744 "usage": {
745 "createdBy": "string",
746 "lastModifiedBy": "string",
747 "createdDate": "2019-08-24T14:15:22Z",
748 "lastModifiedDate": "2019-08-24T14:15:22Z",
749 "archived": true,
750 "externalId": "string",
751 "id": 0,
752 "priority": 0,
753 "internalId": 0,
754 "pickListCode": "string",
755 "pickListLabel": "string",
756 "label": "string",
757 "cultureId": 0,
758 "labelDtos": [
759 {
760 "createdBy": "string",
761 "lastModifiedBy": "string",
762 "createdDate": "2019-08-24T14:15:22Z",
763 "lastModifiedDate": "2019-08-24T14:15:22Z",
764 "archived": true,
765 "externalId": "string",
766 "id": 0,
767 "cultureId": 0,
768 "value": "string"
769 }
770 ]
771 },
772 "occupanciesDto": [
773 {
774 "createdBy": "string",
775 "lastModifiedBy": "string",
776 "createdDate": "2019-08-24T14:15:22Z",
777 "lastModifiedDate": "2019-08-24T14:15:22Z",
778 "archived": true,
779 "externalId": "string",
780 "id": 0,
781 "priority": 0,
782 "internalId": 0,
783 "pickListCode": "string",
784 "pickListLabel": "string",
785 "label": "string",
786 "cultureId": 0,
787 "labelDtos": [
788 {
789 "createdBy": "string",
790 "lastModifiedBy": "string",
791 "createdDate": "2019-08-24T14:15:22Z",
792 "lastModifiedDate": "2019-08-24T14:15:22Z",
793 "archived": true,
794 "externalId": "string",
795 "id": 0,
796 "cultureId": 0,
797 "value": "string"
798 }
799 ]
800 }
801 ]
802 },
803 "isTerminationVersion": true
804 }
805 ]
806 },
807 "page": {
808 "size": 0,
809 "totalElements": 0,
810 "totalPages": 0,
811 "number": 0
812 }
813}
Premise - Get Premise Financial Summary¶
HTTP Request
GET /api/premises/{id}/financial-summary
📋 Description: Retrieves the financial summary for a specified real estate property within the Nakisa Portfolio Management Suite, providing essential analytics for portfolio and asset 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 "currencyCode": "string",
4 "totalPaid": 0,
5 "totalReceived": 0,
6 "totalPayables": 0,
7 "totalReceivables": 0
8 }
9]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a comprehensive financial summary for real estate properties within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics to support informed decision-making.] |
|
» currencyCode |
string |
false |
none |
Code for the currency |
» totalPaid |
number |
false |
none |
Unique identifier for the portfolio |
» totalReceived |
number |
false |
none |
Value for totalReceived field |
» totalPayables |
number |
false |
none |
Value for totalPayables field |
» totalReceivables |
number |
false |
none |
Value for totalReceivables field |
Premise - Get Premise Charges¶
HTTP Request
GET /api/premises/{id}/charges
📋 Description: Retrieves a list of charges associated with a specific real estate property identified by the provided ID, facilitating portfolio and asset management analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
mainAccountingStandard |
query |
boolean |
true |
Indicates whether the charges for the specified premise should be calculated using the main accounting standard applicable to the portfolio, asset, and real estate property analytics. |
pageable |
query |
true |
Indicates whether the results of the charges associated with a specific premise should be returned in a paginated format, enhancing data retrieval efficiency for portfolio and asset management analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "name": "string",
23 "description": "string",
24 "dueDate": "2019-08-24",
25 "amount": 0.1,
26 "hasPostedDocument": true,
27 "fiscalYear": 0,
28 "fiscalPeriod": 0,
29 "expenseCategory": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "expenseCategoryType": "PAYMENT"
35 },
36 "unitId": 0,
37 "unitDisplayId": "string",
38 "activationGroupId": 0,
39 "vendorPaymentSplits": [
40 {
41 "percentage": 0,
42 "calculateTax": true,
43 "taxExemptionPercentage": 0,
44 "partner": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemDisplayId": "string"
50 },
51 "partnerRole": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "taxCodeDetermination": {
58 "id": 0,
59 "displayId": "string",
60 "companyId": 0,
61 "partnerId": 0,
62 "taxJurisdictionId": 0,
63 "taxJurisdictionDisplayId": "string",
64 "defaultTaxCodeId": 0,
65 "defaultTaxCodeDisplayId": "string",
66 "defaultExemptionTaxCodeId": 0,
67 "defaultExemptionTaxCodeDisplayId": "string",
68 "defaultExemptionPercentage": 0,
69 "mapping": {
70 "isLeaseExpense": true,
71 "nonLeaseTaxCodeId": 0,
72 "nonLeaseTaxCodeDisplayId": "string",
73 "nonLeaseExemptionTaxCodeId": 0,
74 "nonLeaseExemptionTaxCodeDisplayId": "string",
75 "nonLeaseExemptionTaxPercentage": 0.1,
76 "principalTaxCodeId": 0,
77 "principalTaxCodeDisplayId": "string",
78 "principalExemptionTaxCodeId": 0,
79 "principalExemptionTaxCodeDisplayId": "string",
80 "principalExemptionTaxPercentage": 0.1
81 }
82 }
83 }
84 ],
85 "currency": "string",
86 "postingTransactionType": "string",
87 "status": "string",
88 "taxAmount": 0,
89 "journalId": 0,
90 "journalEntryId": 0,
91 "activationGroupRevisionId": 0,
92 "postingDate": "2019-08-24",
93 "termId": 0,
94 "expenseAccount": "string",
95 "smartTaxCalculationRequest": {
96 "requestUniqueId": "string",
97 "taxCalculationType": "NET",
98 "erpSystem": {
99 "id": 0,
100 "displayId": "string"
101 },
102 "company": {
103 "id": 0,
104 "displayId": "string"
105 },
106 "contractCurrency": {
107 "id": 0,
108 "displayId": "string"
109 },
110 "documentDate": "2019-08-24",
111 "postingDate": "2019-08-24",
112 "transactionDate": "2019-08-24",
113 "ledgerType": "LIABILITY",
114 "generateVendorInvoice": true,
115 "reference1": "string",
116 "reference2": "string",
117 "reference3": "string",
118 "accountingStandardDisplayId": "string",
119 "businessAreaDisplayId": "string",
120 "transactionType": "string",
121 "documentNumber": "string",
122 "documentType": "string",
123 "entries": [
124 {
125 "itemNoAcc": "string",
126 "amount": 0,
127 "vendor": {
128 "id": 0,
129 "displayId": "string"
130 },
131 "taxCode": {
132 "id": 0,
133 "displayId": "string"
134 },
135 "taxJurisdiction": {
136 "id": 0,
137 "displayId": "string"
138 },
139 "allocationNumber": "string",
140 "currencyType": "string",
141 "transactionType": "string",
142 "postingType": "PAYMENT",
143 "fosReferences": {
144 "system": {
145 "id": 0,
146 "displayId": "string"
147 },
148 "company": {
149 "id": 0,
150 "displayId": "string"
151 },
152 "leaseArea": {
153 "id": 0,
154 "displayId": "string"
155 },
156 "leaseGroup": {
157 "id": 0,
158 "displayId": "string"
159 },
160 "leaseDepartment": {
161 "id": 0,
162 "displayId": "string"
163 },
164 "businessUnit": {
165 "id": 0,
166 "displayId": "string"
167 },
168 "mainCostCenter": {
169 "id": 0,
170 "displayId": "string"
171 },
172 "internalAssetClass": {
173 "id": 0,
174 "displayId": "string"
175 },
176 "documentType": {
177 "id": 0,
178 "displayId": "string"
179 },
180 "depreciationArea": {
181 "id": 0,
182 "displayId": "string"
183 },
184 "reversalReason": {
185 "id": 0,
186 "displayId": "string"
187 },
188 "tradingPartner": {
189 "id": 0,
190 "displayId": "string"
191 },
192 "allocationNumber": {
193 "id": 0,
194 "displayId": "string"
195 },
196 "responsibleCostCenter": {
197 "id": 0,
198 "displayId": "string"
199 },
200 "workBreakdownStructure": {
201 "id": 0,
202 "displayId": "string"
203 },
204 "businessArea": {
205 "id": 0,
206 "displayId": "string"
207 },
208 "functionalArea": {
209 "id": 0,
210 "displayId": "string"
211 },
212 "plant": {
213 "id": 0,
214 "displayId": "string"
215 },
216 "internalOrder": {
217 "id": 0,
218 "displayId": "string"
219 },
220 "network": {
221 "id": 0,
222 "displayId": "string"
223 },
224 "paymentTerm": {
225 "id": 0,
226 "displayId": "string"
227 },
228 "paymentBlock": {
229 "id": 0,
230 "displayId": "string"
231 },
232 "paymentMethod": {
233 "id": 0,
234 "displayId": "string"
235 },
236 "paymentMethodType": "string",
237 "segment": {
238 "id": 0,
239 "displayId": "string"
240 },
241 "purchasingOrganization": {
242 "id": 0,
243 "displayId": "string"
244 },
245 "purchasingOrder": {
246 "id": 0,
247 "displayId": "string"
248 }
249 },
250 "profitCenter": {
251 "id": 0,
252 "displayId": "string"
253 },
254 "costCenter": {
255 "id": 0,
256 "displayId": "string"
257 },
258 "entryType": "D",
259 "generalLedger": {
260 "id": 0,
261 "displayId": "string"
262 }
263 }
264 ]
265 },
266 "vendorSplits": [
267 {
268 "id": 0,
269 "vendorId": 0,
270 "vendorName": "string",
271 "expenseAccount": "string",
272 "percentage": 0.1,
273 "amount": 0,
274 "taxableAmount": 0.1,
275 "taxJurisdiction": "string",
276 "taxCode": "string",
277 "taxRate": 0.1,
278 "taxAmount": 0.1,
279 "vendorDisplayId": "string"
280 }
281 ],
282 "simpleExchangeRateRequestDto": {
283 "erpSystem": {
284 "id": 0,
285 "displayId": "string"
286 },
287 "fromCurrency": {
288 "id": 0,
289 "displayId": "string"
290 },
291 "toCurrency": {
292 "id": 0,
293 "displayId": "string"
294 },
295 "referenceCurrency": {
296 "id": 0,
297 "displayId": "string"
298 },
299 "exchangeRateType": "string",
300 "conversionDate": "2019-08-24"
301 },
302 "leaseId": 0,
303 "leaseExternalId": "string",
304 "numberRangeIdentifierType": {
305 "name": "string"
306 },
307 "numberRangeIdentifierValue": "string",
308 "allowsSystemGenerateNewId": true,
309 "numberRangeType": {
310 "name": "string"
311 }
312 }
313 ],
314 "number": 0,
315 "sort": {
316 "sorted": true,
317 "unsorted": true,
318 "empty": true
319 },
320 "first": true,
321 "last": true,
322 "empty": true
323}
Premise - Get Default Premise¶
HTTP Request
GET /api/premises/default/{userId}
📋 Description: Retrieves the default premises information for a specified user, enabling insights into portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
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 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}
Premise - Get Premises By File Number¶
HTTP Request
GET /api/premises-by-file-number
📋 Description: Retrieves premises information associated with a specified file number, enabling users to access detailed asset data for enhanced portfolio analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
file-number-like |
query |
string |
true |
Specifies a string pattern to filter and retrieve premises associated with a particular file number within the Nakisa Portfolio Management Suite, enhancing asset and portfolio analytics in the real estate sector. |
pageable |
query |
true |
Indicates whether the results of the premises query should be returned in a paginated format, enhancing the user experience when analyzing large datasets within the Nakisa Portfolio Management Suite. |
|
listing |
query |
boolean |
false |
Indicates whether to include detailed listing information for premises in the response, facilitating enhanced asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
search |
query |
string |
false |
Search term used to filter and retrieve specific premises information based on the provided file number within the Nakisa Portfolio Management Suite. |
city-id |
query |
string |
false |
Unique identifier for the city associated with the premises, enabling precise retrieval of real estate property data within the Nakisa Portfolio Management Suite. |
province-id |
query |
string |
false |
Unique identifier for the province associated with the premises, used to filter real estate property data within the Nakisa Portfolio Management Suite. |
country-id |
query |
string |
false |
Unique identifier for the country associated with the premises, enabling targeted retrieval of portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
city-id-in |
query |
string |
false |
Unique identifier for the city associated with the premises, used to filter real estate property data within the Nakisa Portfolio Management Suite. |
province-id-in |
query |
string |
false |
Unique identifier for the province associated with the premises, used to filter results in the Nakisa Portfolio Management Suite for enhanced asset and real estate property analytics. |
country-id-in |
query |
string |
false |
Identifier for the country associated with the premises, used to filter results in the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
id-in |
query |
string |
false |
Unique identifier for the premises associated with a specific file number, facilitating accurate retrieval of real estate property data within the Nakisa Portfolio Management Suite. |
legal-entity-id-in |
query |
string |
false |
Unique identifier for the legal entity associated with the premises, facilitating accurate retrieval of portfolio and asset data within the Nakisa Portfolio Management Suite. |
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve detailed premises information associated with a given file number. |
location-type-id |
query |
string |
false |
Identifier for the type of location associated with the premises, facilitating targeted analytics and asset management within the Nakisa Portfolio Management Suite. |
location-id-in |
query |
string |
false |
Unique identifier for the location within the Nakisa Portfolio Management Suite, used to retrieve premises information associated with a specific file number in the context of portfolio and asset analytics. |
location-number-like |
query |
string |
false |
Specifies a location number pattern to retrieve associated premises data within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
location-external-id |
query |
string |
false |
Unique identifier for the external location associated with a real estate property, used to retrieve specific premises information in the Nakisa Portfolio Management Suite. |
external-id-like |
query |
string |
false |
String used to filter premises based on a partial match of their external identifiers, facilitating efficient asset and portfolio management within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
String representing the unique file number of a premise, used to retrieve specific portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
number-like |
query |
string |
false |
String representation of a file number used to retrieve specific premises information within the Nakisa Portfolio Management Suite, facilitating asset and portfolio analytics in the real estate sector. |
name |
query |
string |
false |
Name of the resource |
name-like |
query |
string |
false |
Filters the results to return premises that have names similar to the specified string, facilitating targeted searches within the real estate portfolio. |
head-premise |
query |
string |
false |
Specifies the head premise identifier to retrieve associated portfolio and asset analytics for real estate properties within the Nakisa Portfolio Management Suite. |
possession-date |
query |
string |
false |
Specifies the date of possession for the real estate property, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
opening-date |
query |
string |
false |
Specifies the opening date of the real estate property, enabling users to filter premises data within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
closing-date |
query |
string |
false |
Specifies the closing date for the real estate property transaction, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
relocation-date |
query |
string |
false |
Specifies the date of relocation for the premises, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
vacating-date |
query |
string |
false |
Specifies the date on which the premises will be vacated, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
expansion-date |
query |
string |
false |
Specifies the date for which the premises data is being requested, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of a real estate property within the portfolio, used to filter results in the premises retrieval process. |
status-id-is-not |
query |
string |
false |
none |
status-id-in |
query |
string |
false |
Specifies the status identifier to filter premises by their current status within the Nakisa Portfolio Management Suite, facilitating targeted analytics for portfolio and asset management in real estate properties. |
usage-id |
query |
string |
false |
Unique identifier for the specific usage instance within the Nakisa Portfolio Management Suite, facilitating the retrieval of premises data by file number in the context of portfolio and asset analytics. |
parent-premise-id |
query |
string |
false |
Unique identifier for the parent premise associated with the specified file number, facilitating the retrieval of relevant portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
contract-id-not-null |
query |
string |
false |
Unique identifier for the contract, ensuring that only valid contracts are retrieved in the context of portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
master-agreement-id-in |
query |
string |
false |
Unique identifier for the master agreement associated with the premises, facilitating accurate retrieval of portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
business-unit-id-in |
query |
string |
false |
Unique identifier for the business unit, used to filter and retrieve premises data associated with specific assets within the Nakisa Portfolio Management Suite. |
group-id-in |
query |
string |
false |
Unique identifier for the asset group, used to retrieve premises information associated with a specific file number in the Nakisa Portfolio Management Suite. |
contract-id-in |
query |
string |
false |
Unique identifier for the contract associated with the specified premises, facilitating asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
head-premise-opt |
query |
string |
false |
Specifies the head premise option to filter real estate property data within the portfolio analytics in the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "premises": [
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 "number": "string",
13 "name": "string",
14 "headPremise": true,
15 "possessionDate": "2019-08-24",
16 "openingDate": "2019-08-24",
17 "closingDate": "2019-08-24",
18 "relocationDate": "2019-08-24",
19 "vacatingDate": "2019-08-24",
20 "expansionDate": "2019-08-24",
21 "statusId": 0,
22 "usageId": 0,
23 "parentPremiseId": 0,
24 "costCenterId": 0,
25 "profitCenterId": 0,
26 "legalEntityId": 0,
27 "occupancyIds": [
28 0
29 ],
30 "locationId": 0,
31 "locationDto": {
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 "number": "string",
40 "name": "string",
41 "storeNumber": "string",
42 "defaultCurrencyId": 0,
43 "defaultMeasureId": 0,
44 "typeId": 0,
45 "qualityId": 0,
46 "propertyTypeId": 0,
47 "categoryId": 0,
48 "statusId": 0,
49 "businessUnitId": 0,
50 "groupIds": [
51 0
52 ],
53 "legalEntityIds": [
54 0
55 ],
56 "defaultCurrency": {
57 "id": 0,
58 "status": "CREATED",
59 "displayId": "string",
60 "erpSystemId": 0,
61 "erpSystemDisplayId": "string",
62 "name": "string",
63 "decimalPoints": 0,
64 "depreciationAreaId": 0
65 },
66 "defaultUnitValue": {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "unitId": 0,
75 "unitOfMeasureId": 0,
76 "erpSystemId": 0,
77 "unit": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
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 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitOfMeasure": {
106 "id": 0,
107 "status": "CREATED",
108 "displayId": "string",
109 "erpSystemId": 0,
110 "erpSystemDisplayId": "string",
111 "name": "string"
112 }
113 },
114 "type": {
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 "priority": 0,
123 "internalId": 0,
124 "pickListCode": "string",
125 "pickListLabel": "string",
126 "label": "string",
127 "cultureId": 0,
128 "labelDtos": [
129 {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "cultureId": 0,
138 "value": "string"
139 }
140 ]
141 },
142 "quality": {
143 "createdBy": "string",
144 "lastModifiedBy": "string",
145 "createdDate": "2019-08-24T14:15:22Z",
146 "lastModifiedDate": "2019-08-24T14:15:22Z",
147 "archived": true,
148 "externalId": "string",
149 "id": 0,
150 "priority": 0,
151 "internalId": 0,
152 "pickListCode": "string",
153 "pickListLabel": "string",
154 "label": "string",
155 "cultureId": 0,
156 "labelDtos": [
157 {
158 "createdBy": "string",
159 "lastModifiedBy": "string",
160 "createdDate": "2019-08-24T14:15:22Z",
161 "lastModifiedDate": "2019-08-24T14:15:22Z",
162 "archived": true,
163 "externalId": "string",
164 "id": 0,
165 "cultureId": 0,
166 "value": "string"
167 }
168 ]
169 },
170 "propertyType": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
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 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "category": {
199 "createdBy": "string",
200 "lastModifiedBy": "string",
201 "createdDate": "2019-08-24T14:15:22Z",
202 "lastModifiedDate": "2019-08-24T14:15:22Z",
203 "archived": true,
204 "externalId": "string",
205 "id": 0,
206 "priority": 0,
207 "internalId": 0,
208 "pickListCode": "string",
209 "pickListLabel": "string",
210 "label": "string",
211 "cultureId": 0,
212 "labelDtos": [
213 {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "cultureId": 0,
222 "value": "string"
223 }
224 ]
225 },
226 "status": {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "priority": 0,
235 "internalId": 0,
236 "pickListCode": "string",
237 "pickListLabel": "string",
238 "label": "string",
239 "cultureId": 0,
240 "labelDtos": [
241 {
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 "cultureId": 0,
250 "value": "string"
251 }
252 ]
253 },
254 "addressDto": {
255 "createdBy": "string",
256 "lastModifiedBy": "string",
257 "createdDate": "2019-08-24T14:15:22Z",
258 "lastModifiedDate": "2019-08-24T14:15:22Z",
259 "archived": true,
260 "externalId": "string",
261 "id": 0,
262 "street": "string",
263 "civicNumber": "string",
264 "suite": "string",
265 "postalCode": "string",
266 "lon": 0.1,
267 "lat": 0.1,
268 "city": {
269 "createdBy": "string",
270 "lastModifiedBy": "string",
271 "createdDate": "2019-08-24T14:15:22Z",
272 "lastModifiedDate": "2019-08-24T14:15:22Z",
273 "archived": true,
274 "externalId": "string",
275 "id": 0,
276 "name": "string",
277 "province": {
278 "createdBy": "string",
279 "lastModifiedBy": "string",
280 "createdDate": "2019-08-24T14:15:22Z",
281 "lastModifiedDate": "2019-08-24T14:15:22Z",
282 "archived": true,
283 "externalId": "string",
284 "id": 0,
285 "name": "string",
286 "code": "string",
287 "country": {
288 "createdBy": "string",
289 "lastModifiedBy": "string",
290 "createdDate": "2019-08-24T14:15:22Z",
291 "lastModifiedDate": "2019-08-24T14:15:22Z",
292 "archived": true,
293 "externalId": "string",
294 "id": 0,
295 "name": "string",
296 "code": "string"
297 },
298 "provinceCountryKey": "string"
299 },
300 "cityProvinceCountryKey": "string"
301 },
302 "district": {
303 "createdBy": "string",
304 "lastModifiedBy": "string",
305 "createdDate": "2019-08-24T14:15:22Z",
306 "lastModifiedDate": "2019-08-24T14:15:22Z",
307 "archived": true,
308 "externalId": "string",
309 "id": 0,
310 "name": "string",
311 "city": {
312 "createdBy": "string",
313 "lastModifiedBy": "string",
314 "createdDate": "2019-08-24T14:15:22Z",
315 "lastModifiedDate": "2019-08-24T14:15:22Z",
316 "archived": true,
317 "externalId": "string",
318 "id": 0,
319 "name": "string",
320 "province": {
321 "createdBy": "string",
322 "lastModifiedBy": "string",
323 "createdDate": "2019-08-24T14:15:22Z",
324 "lastModifiedDate": "2019-08-24T14:15:22Z",
325 "archived": true,
326 "externalId": "string",
327 "id": 0,
328 "name": "string",
329 "code": "string",
330 "country": {
331 "createdBy": "string",
332 "lastModifiedBy": "string",
333 "createdDate": "2019-08-24T14:15:22Z",
334 "lastModifiedDate": "2019-08-24T14:15:22Z",
335 "archived": true,
336 "externalId": "string",
337 "id": 0,
338 "name": "string",
339 "code": "string"
340 },
341 "provinceCountryKey": "string"
342 },
343 "cityProvinceCountryKey": "string"
344 }
345 },
346 "cityId": 0,
347 "districtId": 0
348 },
349 "secondAddressDto": {
350 "createdBy": "string",
351 "lastModifiedBy": "string",
352 "createdDate": "2019-08-24T14:15:22Z",
353 "lastModifiedDate": "2019-08-24T14:15:22Z",
354 "archived": true,
355 "externalId": "string",
356 "id": 0,
357 "street": "string",
358 "civicNumber": "string",
359 "suite": "string",
360 "postalCode": "string",
361 "lon": 0.1,
362 "lat": 0.1,
363 "city": {
364 "createdBy": "string",
365 "lastModifiedBy": "string",
366 "createdDate": "2019-08-24T14:15:22Z",
367 "lastModifiedDate": "2019-08-24T14:15:22Z",
368 "archived": true,
369 "externalId": "string",
370 "id": 0,
371 "name": "string",
372 "province": {
373 "createdBy": "string",
374 "lastModifiedBy": "string",
375 "createdDate": "2019-08-24T14:15:22Z",
376 "lastModifiedDate": "2019-08-24T14:15:22Z",
377 "archived": true,
378 "externalId": "string",
379 "id": 0,
380 "name": "string",
381 "code": "string",
382 "country": {
383 "createdBy": "string",
384 "lastModifiedBy": "string",
385 "createdDate": "2019-08-24T14:15:22Z",
386 "lastModifiedDate": "2019-08-24T14:15:22Z",
387 "archived": true,
388 "externalId": "string",
389 "id": 0,
390 "name": "string",
391 "code": "string"
392 },
393 "provinceCountryKey": "string"
394 },
395 "cityProvinceCountryKey": "string"
396 },
397 "district": {
398 "createdBy": "string",
399 "lastModifiedBy": "string",
400 "createdDate": "2019-08-24T14:15:22Z",
401 "lastModifiedDate": "2019-08-24T14:15:22Z",
402 "archived": true,
403 "externalId": "string",
404 "id": 0,
405 "name": "string",
406 "city": {
407 "createdBy": "string",
408 "lastModifiedBy": "string",
409 "createdDate": "2019-08-24T14:15:22Z",
410 "lastModifiedDate": "2019-08-24T14:15:22Z",
411 "archived": true,
412 "externalId": "string",
413 "id": 0,
414 "name": "string",
415 "province": {
416 "createdBy": "string",
417 "lastModifiedBy": "string",
418 "createdDate": "2019-08-24T14:15:22Z",
419 "lastModifiedDate": "2019-08-24T14:15:22Z",
420 "archived": true,
421 "externalId": "string",
422 "id": 0,
423 "name": "string",
424 "code": "string",
425 "country": {
426 "createdBy": "string",
427 "lastModifiedBy": "string",
428 "createdDate": "2019-08-24T14:15:22Z",
429 "lastModifiedDate": "2019-08-24T14:15:22Z",
430 "archived": true,
431 "externalId": "string",
432 "id": 0,
433 "name": "string",
434 "code": "string"
435 },
436 "provinceCountryKey": "string"
437 },
438 "cityProvinceCountryKey": "string"
439 }
440 },
441 "cityId": 0,
442 "districtId": 0
443 }
444 },
445 "status": {
446 "createdBy": "string",
447 "lastModifiedBy": "string",
448 "createdDate": "2019-08-24T14:15:22Z",
449 "lastModifiedDate": "2019-08-24T14:15:22Z",
450 "archived": true,
451 "externalId": "string",
452 "id": 0,
453 "priority": 0,
454 "internalId": 0,
455 "pickListCode": "string",
456 "pickListLabel": "string",
457 "label": "string",
458 "cultureId": 0,
459 "labelDtos": [
460 {
461 "createdBy": "string",
462 "lastModifiedBy": "string",
463 "createdDate": "2019-08-24T14:15:22Z",
464 "lastModifiedDate": "2019-08-24T14:15:22Z",
465 "archived": true,
466 "externalId": "string",
467 "id": 0,
468 "cultureId": 0,
469 "value": "string"
470 }
471 ]
472 },
473 "usage": {
474 "createdBy": "string",
475 "lastModifiedBy": "string",
476 "createdDate": "2019-08-24T14:15:22Z",
477 "lastModifiedDate": "2019-08-24T14:15:22Z",
478 "archived": true,
479 "externalId": "string",
480 "id": 0,
481 "priority": 0,
482 "internalId": 0,
483 "pickListCode": "string",
484 "pickListLabel": "string",
485 "label": "string",
486 "cultureId": 0,
487 "labelDtos": [
488 {
489 "createdBy": "string",
490 "lastModifiedBy": "string",
491 "createdDate": "2019-08-24T14:15:22Z",
492 "lastModifiedDate": "2019-08-24T14:15:22Z",
493 "archived": true,
494 "externalId": "string",
495 "id": 0,
496 "cultureId": 0,
497 "value": "string"
498 }
499 ]
500 },
501 "occupanciesDto": [
502 {
503 "createdBy": "string",
504 "lastModifiedBy": "string",
505 "createdDate": "2019-08-24T14:15:22Z",
506 "lastModifiedDate": "2019-08-24T14:15:22Z",
507 "archived": true,
508 "externalId": "string",
509 "id": 0,
510 "priority": 0,
511 "internalId": 0,
512 "pickListCode": "string",
513 "pickListLabel": "string",
514 "label": "string",
515 "cultureId": 0,
516 "labelDtos": [
517 {
518 "createdBy": "string",
519 "lastModifiedBy": "string",
520 "createdDate": "2019-08-24T14:15:22Z",
521 "lastModifiedDate": "2019-08-24T14:15:22Z",
522 "archived": true,
523 "externalId": "string",
524 "id": 0,
525 "cultureId": 0,
526 "value": "string"
527 }
528 ]
529 }
530 ]
531 }
532 ]
533 },
534 "page": {
535 "size": 0,
536 "totalElements": 0,
537 "totalPages": 0,
538 "number": 0
539 }
540}
Premise - Delete Premise Picture¶
HTTP Request
DELETE /api/premises/{premiseId}/pictures/{pictureId}
📋 Description: Deletes a specified picture associated with a premise in the Nakisa Portfolio Management Suite, streamlining asset management and enhancing real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Premise - Delete Premise Document¶
HTTP Request
DELETE /api/premises/{premiseId}/documents/{documentId}
📋 Description: Deletes a specified document associated with a particular premise within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio and asset documentation in the real estate property sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseId |
path |
integer(int64) |
true |
Unique identifier for the premise |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Premise - Delete Premise Occupancy¶
HTTP Request
DELETE /api/premises/{id}/occupancies/{occupancyId}
📋 Description: Deletes a specific occupancy record associated with a designated premise within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset management in real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
occupancyId |
path |
integer(int64) |
true |
Unique identifier for the occupancy |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
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 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}
Premise - Delete Premise Group¶
HTTP Request
DELETE /api/premises/{id}/groups/{groupId}
📋 Description: Deletes a specified group from a designated premises within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio assets and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
groupId |
path |
integer(int64) |
true |
Unique identifier for the group |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
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 "number": "string",
10 "name": "string",
11 "headPremise": true,
12 "possessionDate": "2019-08-24",
13 "openingDate": "2019-08-24",
14 "closingDate": "2019-08-24",
15 "relocationDate": "2019-08-24",
16 "vacatingDate": "2019-08-24",
17 "expansionDate": "2019-08-24",
18 "statusId": 0,
19 "usageId": 0,
20 "parentPremiseId": 0,
21 "costCenterId": 0,
22 "profitCenterId": 0,
23 "legalEntityId": 0,
24 "occupancyIds": [
25 0
26 ],
27 "locationId": 0,
28 "locationDto": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "number": "string",
37 "name": "string",
38 "storeNumber": "string",
39 "defaultCurrencyId": 0,
40 "defaultMeasureId": 0,
41 "typeId": 0,
42 "qualityId": 0,
43 "propertyTypeId": 0,
44 "categoryId": 0,
45 "statusId": 0,
46 "businessUnitId": 0,
47 "groupIds": [
48 0
49 ],
50 "legalEntityIds": [
51 0
52 ],
53 "defaultCurrency": {
54 "id": 0,
55 "status": "CREATED",
56 "displayId": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string",
59 "name": "string",
60 "decimalPoints": 0,
61 "depreciationAreaId": 0
62 },
63 "defaultUnitValue": {
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 "unitId": 0,
72 "unitOfMeasureId": 0,
73 "erpSystemId": 0,
74 "unit": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
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 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "unitOfMeasure": {
103 "id": 0,
104 "status": "CREATED",
105 "displayId": "string",
106 "erpSystemId": 0,
107 "erpSystemDisplayId": "string",
108 "name": "string"
109 }
110 },
111 "type": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "quality": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "propertyType": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "category": {
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 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "status": {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "priority": 0,
232 "internalId": 0,
233 "pickListCode": "string",
234 "pickListLabel": "string",
235 "label": "string",
236 "cultureId": 0,
237 "labelDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "cultureId": 0,
247 "value": "string"
248 }
249 ]
250 },
251 "addressDto": {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "street": "string",
260 "civicNumber": "string",
261 "suite": "string",
262 "postalCode": "string",
263 "lon": 0.1,
264 "lat": 0.1,
265 "city": {
266 "createdBy": "string",
267 "lastModifiedBy": "string",
268 "createdDate": "2019-08-24T14:15:22Z",
269 "lastModifiedDate": "2019-08-24T14:15:22Z",
270 "archived": true,
271 "externalId": "string",
272 "id": 0,
273 "name": "string",
274 "province": {
275 "createdBy": "string",
276 "lastModifiedBy": "string",
277 "createdDate": "2019-08-24T14:15:22Z",
278 "lastModifiedDate": "2019-08-24T14:15:22Z",
279 "archived": true,
280 "externalId": "string",
281 "id": 0,
282 "name": "string",
283 "code": "string",
284 "country": {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "name": "string",
293 "code": "string"
294 },
295 "provinceCountryKey": "string"
296 },
297 "cityProvinceCountryKey": "string"
298 },
299 "district": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "city": {
309 "createdBy": "string",
310 "lastModifiedBy": "string",
311 "createdDate": "2019-08-24T14:15:22Z",
312 "lastModifiedDate": "2019-08-24T14:15:22Z",
313 "archived": true,
314 "externalId": "string",
315 "id": 0,
316 "name": "string",
317 "province": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "name": "string",
326 "code": "string",
327 "country": {
328 "createdBy": "string",
329 "lastModifiedBy": "string",
330 "createdDate": "2019-08-24T14:15:22Z",
331 "lastModifiedDate": "2019-08-24T14:15:22Z",
332 "archived": true,
333 "externalId": "string",
334 "id": 0,
335 "name": "string",
336 "code": "string"
337 },
338 "provinceCountryKey": "string"
339 },
340 "cityProvinceCountryKey": "string"
341 }
342 },
343 "cityId": 0,
344 "districtId": 0
345 },
346 "secondAddressDto": {
347 "createdBy": "string",
348 "lastModifiedBy": "string",
349 "createdDate": "2019-08-24T14:15:22Z",
350 "lastModifiedDate": "2019-08-24T14:15:22Z",
351 "archived": true,
352 "externalId": "string",
353 "id": 0,
354 "street": "string",
355 "civicNumber": "string",
356 "suite": "string",
357 "postalCode": "string",
358 "lon": 0.1,
359 "lat": 0.1,
360 "city": {
361 "createdBy": "string",
362 "lastModifiedBy": "string",
363 "createdDate": "2019-08-24T14:15:22Z",
364 "lastModifiedDate": "2019-08-24T14:15:22Z",
365 "archived": true,
366 "externalId": "string",
367 "id": 0,
368 "name": "string",
369 "province": {
370 "createdBy": "string",
371 "lastModifiedBy": "string",
372 "createdDate": "2019-08-24T14:15:22Z",
373 "lastModifiedDate": "2019-08-24T14:15:22Z",
374 "archived": true,
375 "externalId": "string",
376 "id": 0,
377 "name": "string",
378 "code": "string",
379 "country": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string"
389 },
390 "provinceCountryKey": "string"
391 },
392 "cityProvinceCountryKey": "string"
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 },
433 "provinceCountryKey": "string"
434 },
435 "cityProvinceCountryKey": "string"
436 }
437 },
438 "cityId": 0,
439 "districtId": 0
440 }
441 },
442 "status": {
443 "createdBy": "string",
444 "lastModifiedBy": "string",
445 "createdDate": "2019-08-24T14:15:22Z",
446 "lastModifiedDate": "2019-08-24T14:15:22Z",
447 "archived": true,
448 "externalId": "string",
449 "id": 0,
450 "priority": 0,
451 "internalId": 0,
452 "pickListCode": "string",
453 "pickListLabel": "string",
454 "label": "string",
455 "cultureId": 0,
456 "labelDtos": [
457 {
458 "createdBy": "string",
459 "lastModifiedBy": "string",
460 "createdDate": "2019-08-24T14:15:22Z",
461 "lastModifiedDate": "2019-08-24T14:15:22Z",
462 "archived": true,
463 "externalId": "string",
464 "id": 0,
465 "cultureId": 0,
466 "value": "string"
467 }
468 ]
469 },
470 "usage": {
471 "createdBy": "string",
472 "lastModifiedBy": "string",
473 "createdDate": "2019-08-24T14:15:22Z",
474 "lastModifiedDate": "2019-08-24T14:15:22Z",
475 "archived": true,
476 "externalId": "string",
477 "id": 0,
478 "priority": 0,
479 "internalId": 0,
480 "pickListCode": "string",
481 "pickListLabel": "string",
482 "label": "string",
483 "cultureId": 0,
484 "labelDtos": [
485 {
486 "createdBy": "string",
487 "lastModifiedBy": "string",
488 "createdDate": "2019-08-24T14:15:22Z",
489 "lastModifiedDate": "2019-08-24T14:15:22Z",
490 "archived": true,
491 "externalId": "string",
492 "id": 0,
493 "cultureId": 0,
494 "value": "string"
495 }
496 ]
497 },
498 "occupanciesDto": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "priority": 0,
508 "internalId": 0,
509 "pickListCode": "string",
510 "pickListLabel": "string",
511 "label": "string",
512 "cultureId": 0,
513 "labelDtos": [
514 {
515 "createdBy": "string",
516 "lastModifiedBy": "string",
517 "createdDate": "2019-08-24T14:15:22Z",
518 "lastModifiedDate": "2019-08-24T14:15:22Z",
519 "archived": true,
520 "externalId": "string",
521 "id": 0,
522 "cultureId": 0,
523 "value": "string"
524 }
525 ]
526 }
527 ]
528}