Lease¶
Lease - Get Lease¶
HTTP Request
GET /api/leases/{id}
📋 Description: Retrieves detailed information about a specific lease within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset data related to 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 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1,
290 "areasHistoryVersionId": 0
291 },
292 "premiseDto": {
293 "createdBy": "string",
294 "lastModifiedBy": "string",
295 "createdDate": "2019-08-24T14:15:22Z",
296 "lastModifiedDate": "2019-08-24T14:15:22Z",
297 "archived": true,
298 "externalId": "string",
299 "id": 0,
300 "number": "string",
301 "name": "string",
302 "headPremise": true,
303 "possessionDate": "2019-08-24",
304 "openingDate": "2019-08-24",
305 "closingDate": "2019-08-24",
306 "relocationDate": "2019-08-24",
307 "vacatingDate": "2019-08-24",
308 "expansionDate": "2019-08-24",
309 "statusId": 0,
310 "usageId": 0,
311 "parentPremiseId": 0,
312 "costCenterId": 0,
313 "profitCenterId": 0,
314 "legalEntityId": 0,
315 "occupancyIds": [
316 0
317 ],
318 "locationId": 0,
319 "locationDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "number": "string",
328 "name": "string",
329 "storeNumber": "string",
330 "defaultCurrencyId": 0,
331 "defaultMeasureId": 0,
332 "typeId": 0,
333 "qualityId": 0,
334 "propertyTypeId": 0,
335 "categoryId": 0,
336 "statusId": 0,
337 "businessUnitId": 0,
338 "groupIds": [
339 0
340 ],
341 "legalEntityIds": [
342 0
343 ],
344 "defaultCurrency": {
345 "id": 0,
346 "status": "CREATED",
347 "displayId": "string",
348 "erpSystemId": 0,
349 "erpSystemDisplayId": "string",
350 "name": "string",
351 "decimalPoints": 0,
352 "depreciationAreaId": 0
353 },
354 "defaultUnitValue": {
355 "createdBy": "string",
356 "lastModifiedBy": "string",
357 "createdDate": "2019-08-24T14:15:22Z",
358 "lastModifiedDate": "2019-08-24T14:15:22Z",
359 "archived": true,
360 "externalId": "string",
361 "id": 0,
362 "unitId": 0,
363 "unitOfMeasureId": 0,
364 "erpSystemId": 0,
365 "unit": {
366 "createdBy": "string",
367 "lastModifiedBy": "string",
368 "createdDate": "2019-08-24T14:15:22Z",
369 "lastModifiedDate": "2019-08-24T14:15:22Z",
370 "archived": true,
371 "externalId": "string",
372 "id": 0,
373 "priority": 0,
374 "internalId": 0,
375 "pickListCode": "string",
376 "pickListLabel": "string",
377 "label": "string",
378 "cultureId": 0,
379 "labelDtos": [
380 {
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 "cultureId": 0,
389 "value": "string"
390 }
391 ]
392 },
393 "unitOfMeasure": {
394 "id": 0,
395 "status": "CREATED",
396 "displayId": "string",
397 "erpSystemId": 0,
398 "erpSystemDisplayId": "string",
399 "name": "string"
400 }
401 },
402 "type": {
403 "createdBy": "string",
404 "lastModifiedBy": "string",
405 "createdDate": "2019-08-24T14:15:22Z",
406 "lastModifiedDate": "2019-08-24T14:15:22Z",
407 "archived": true,
408 "externalId": "string",
409 "id": 0,
410 "priority": 0,
411 "internalId": 0,
412 "pickListCode": "string",
413 "pickListLabel": "string",
414 "label": "string",
415 "cultureId": 0,
416 "labelDtos": [
417 {
418 "createdBy": "string",
419 "lastModifiedBy": "string",
420 "createdDate": "2019-08-24T14:15:22Z",
421 "lastModifiedDate": "2019-08-24T14:15:22Z",
422 "archived": true,
423 "externalId": "string",
424 "id": 0,
425 "cultureId": 0,
426 "value": "string"
427 }
428 ]
429 },
430 "quality": {
431 "createdBy": "string",
432 "lastModifiedBy": "string",
433 "createdDate": "2019-08-24T14:15:22Z",
434 "lastModifiedDate": "2019-08-24T14:15:22Z",
435 "archived": true,
436 "externalId": "string",
437 "id": 0,
438 "priority": 0,
439 "internalId": 0,
440 "pickListCode": "string",
441 "pickListLabel": "string",
442 "label": "string",
443 "cultureId": 0,
444 "labelDtos": [
445 {
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 "cultureId": 0,
454 "value": "string"
455 }
456 ]
457 },
458 "propertyType": {
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 "priority": 0,
467 "internalId": 0,
468 "pickListCode": "string",
469 "pickListLabel": "string",
470 "label": "string",
471 "cultureId": 0,
472 "labelDtos": [
473 {
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 "cultureId": 0,
482 "value": "string"
483 }
484 ]
485 },
486 "category": {
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 "priority": 0,
495 "internalId": 0,
496 "pickListCode": "string",
497 "pickListLabel": "string",
498 "label": "string",
499 "cultureId": 0,
500 "labelDtos": [
501 {
502 "createdBy": "string",
503 "lastModifiedBy": "string",
504 "createdDate": "2019-08-24T14:15:22Z",
505 "lastModifiedDate": "2019-08-24T14:15:22Z",
506 "archived": true,
507 "externalId": "string",
508 "id": 0,
509 "cultureId": 0,
510 "value": "string"
511 }
512 ]
513 },
514 "status": {
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 "priority": 0,
523 "internalId": 0,
524 "pickListCode": "string",
525 "pickListLabel": "string",
526 "label": "string",
527 "cultureId": 0,
528 "labelDtos": [
529 {
530 "createdBy": "string",
531 "lastModifiedBy": "string",
532 "createdDate": "2019-08-24T14:15:22Z",
533 "lastModifiedDate": "2019-08-24T14:15:22Z",
534 "archived": true,
535 "externalId": "string",
536 "id": 0,
537 "cultureId": 0,
538 "value": "string"
539 }
540 ]
541 },
542 "addressDto": {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "street": "string",
551 "civicNumber": "string",
552 "suite": "string",
553 "postalCode": "string",
554 "lon": 0.1,
555 "lat": 0.1,
556 "city": {
557 "createdBy": "string",
558 "lastModifiedBy": "string",
559 "createdDate": "2019-08-24T14:15:22Z",
560 "lastModifiedDate": "2019-08-24T14:15:22Z",
561 "archived": true,
562 "externalId": "string",
563 "id": 0,
564 "name": "string",
565 "province": {
566 "createdBy": "string",
567 "lastModifiedBy": "string",
568 "createdDate": "2019-08-24T14:15:22Z",
569 "lastModifiedDate": "2019-08-24T14:15:22Z",
570 "archived": true,
571 "externalId": "string",
572 "id": 0,
573 "name": "string",
574 "code": "string",
575 "country": {
576 "createdBy": "string",
577 "lastModifiedBy": "string",
578 "createdDate": "2019-08-24T14:15:22Z",
579 "lastModifiedDate": "2019-08-24T14:15:22Z",
580 "archived": true,
581 "externalId": "string",
582 "id": 0,
583 "name": "string",
584 "code": "string"
585 },
586 "provinceCountryKey": "string"
587 },
588 "cityProvinceCountryKey": "string"
589 },
590 "district": {
591 "createdBy": "string",
592 "lastModifiedBy": "string",
593 "createdDate": "2019-08-24T14:15:22Z",
594 "lastModifiedDate": "2019-08-24T14:15:22Z",
595 "archived": true,
596 "externalId": "string",
597 "id": 0,
598 "name": "string",
599 "city": {
600 "createdBy": "string",
601 "lastModifiedBy": "string",
602 "createdDate": "2019-08-24T14:15:22Z",
603 "lastModifiedDate": "2019-08-24T14:15:22Z",
604 "archived": true,
605 "externalId": "string",
606 "id": 0,
607 "name": "string",
608 "province": {
609 "createdBy": "string",
610 "lastModifiedBy": "string",
611 "createdDate": "2019-08-24T14:15:22Z",
612 "lastModifiedDate": "2019-08-24T14:15:22Z",
613 "archived": true,
614 "externalId": "string",
615 "id": 0,
616 "name": "string",
617 "code": "string",
618 "country": {
619 "createdBy": "string",
620 "lastModifiedBy": "string",
621 "createdDate": "2019-08-24T14:15:22Z",
622 "lastModifiedDate": "2019-08-24T14:15:22Z",
623 "archived": true,
624 "externalId": "string",
625 "id": 0,
626 "name": "string",
627 "code": "string"
628 },
629 "provinceCountryKey": "string"
630 },
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {
671 "createdBy": "string",
672 "lastModifiedBy": "string",
673 "createdDate": "2019-08-24T14:15:22Z",
674 "lastModifiedDate": "2019-08-24T14:15:22Z",
675 "archived": true,
676 "externalId": "string",
677 "id": 0,
678 "name": "string",
679 "code": "string"
680 },
681 "provinceCountryKey": "string"
682 },
683 "cityProvinceCountryKey": "string"
684 },
685 "district": {
686 "createdBy": "string",
687 "lastModifiedBy": "string",
688 "createdDate": "2019-08-24T14:15:22Z",
689 "lastModifiedDate": "2019-08-24T14:15:22Z",
690 "archived": true,
691 "externalId": "string",
692 "id": 0,
693 "name": "string",
694 "city": {
695 "createdBy": "string",
696 "lastModifiedBy": "string",
697 "createdDate": "2019-08-24T14:15:22Z",
698 "lastModifiedDate": "2019-08-24T14:15:22Z",
699 "archived": true,
700 "externalId": "string",
701 "id": 0,
702 "name": "string",
703 "province": {
704 "createdBy": "string",
705 "lastModifiedBy": "string",
706 "createdDate": "2019-08-24T14:15:22Z",
707 "lastModifiedDate": "2019-08-24T14:15:22Z",
708 "archived": true,
709 "externalId": "string",
710 "id": 0,
711 "name": "string",
712 "code": "string",
713 "country": {
714 "createdBy": "string",
715 "lastModifiedBy": "string",
716 "createdDate": "2019-08-24T14:15:22Z",
717 "lastModifiedDate": "2019-08-24T14:15:22Z",
718 "archived": true,
719 "externalId": "string",
720 "id": 0,
721 "name": "string",
722 "code": "string"
723 },
724 "provinceCountryKey": "string"
725 },
726 "cityProvinceCountryKey": "string"
727 }
728 },
729 "cityId": 0,
730 "districtId": 0
731 }
732 },
733 "status": {
734 "createdBy": "string",
735 "lastModifiedBy": "string",
736 "createdDate": "2019-08-24T14:15:22Z",
737 "lastModifiedDate": "2019-08-24T14:15:22Z",
738 "archived": true,
739 "externalId": "string",
740 "id": 0,
741 "priority": 0,
742 "internalId": 0,
743 "pickListCode": "string",
744 "pickListLabel": "string",
745 "label": "string",
746 "cultureId": 0,
747 "labelDtos": [
748 {
749 "createdBy": "string",
750 "lastModifiedBy": "string",
751 "createdDate": "2019-08-24T14:15:22Z",
752 "lastModifiedDate": "2019-08-24T14:15:22Z",
753 "archived": true,
754 "externalId": "string",
755 "id": 0,
756 "cultureId": 0,
757 "value": "string"
758 }
759 ]
760 },
761 "usage": {
762 "createdBy": "string",
763 "lastModifiedBy": "string",
764 "createdDate": "2019-08-24T14:15:22Z",
765 "lastModifiedDate": "2019-08-24T14:15:22Z",
766 "archived": true,
767 "externalId": "string",
768 "id": 0,
769 "priority": 0,
770 "internalId": 0,
771 "pickListCode": "string",
772 "pickListLabel": "string",
773 "label": "string",
774 "cultureId": 0,
775 "labelDtos": [
776 {
777 "createdBy": "string",
778 "lastModifiedBy": "string",
779 "createdDate": "2019-08-24T14:15:22Z",
780 "lastModifiedDate": "2019-08-24T14:15:22Z",
781 "archived": true,
782 "externalId": "string",
783 "id": 0,
784 "cultureId": 0,
785 "value": "string"
786 }
787 ]
788 },
789 "occupanciesDto": [
790 {
791 "createdBy": "string",
792 "lastModifiedBy": "string",
793 "createdDate": "2019-08-24T14:15:22Z",
794 "lastModifiedDate": "2019-08-24T14:15:22Z",
795 "archived": true,
796 "externalId": "string",
797 "id": 0,
798 "priority": 0,
799 "internalId": 0,
800 "pickListCode": "string",
801 "pickListLabel": "string",
802 "label": "string",
803 "cultureId": 0,
804 "labelDtos": [
805 {
806 "createdBy": "string",
807 "lastModifiedBy": "string",
808 "createdDate": "2019-08-24T14:15:22Z",
809 "lastModifiedDate": "2019-08-24T14:15:22Z",
810 "archived": true,
811 "externalId": "string",
812 "id": 0,
813 "cultureId": 0,
814 "value": "string"
815 }
816 ]
817 }
818 ]
819 },
820 "isTerminationVersion": true
821}
Lease - Update Lease¶
HTTP Request
PUT /api/leases/{id}
📋 Description: Updates the details of a specific lease within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset information 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 updated lease information, including terms, conditions, and associated asset details for effective portfolio management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "scenario": true,
287 "isVisibleVendorPortal": true,
288 "isTerminationVersion": true,
289 "terminationDate": "2019-08-24",
290 "penaltyAmount": 0.1,
291 "areasHistoryVersionId": 0
292 },
293 "premiseDto": {
294 "createdBy": "string",
295 "lastModifiedBy": "string",
296 "createdDate": "2019-08-24T14:15:22Z",
297 "lastModifiedDate": "2019-08-24T14:15:22Z",
298 "archived": true,
299 "externalId": "string",
300 "id": 0,
301 "number": "string",
302 "name": "string",
303 "headPremise": true,
304 "possessionDate": "2019-08-24",
305 "openingDate": "2019-08-24",
306 "closingDate": "2019-08-24",
307 "relocationDate": "2019-08-24",
308 "vacatingDate": "2019-08-24",
309 "expansionDate": "2019-08-24",
310 "statusId": 0,
311 "usageId": 0,
312 "parentPremiseId": 0,
313 "costCenterId": 0,
314 "profitCenterId": 0,
315 "legalEntityId": 0,
316 "occupancyIds": [
317 0
318 ],
319 "locationId": 0,
320 "locationDto": {
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 "number": "string",
329 "name": "string",
330 "storeNumber": "string",
331 "defaultCurrencyId": 0,
332 "defaultMeasureId": 0,
333 "typeId": 0,
334 "qualityId": 0,
335 "propertyTypeId": 0,
336 "categoryId": 0,
337 "statusId": 0,
338 "businessUnitId": 0,
339 "groupIds": [
340 0
341 ],
342 "legalEntityIds": [
343 0
344 ],
345 "defaultCurrency": {
346 "id": 0,
347 "status": "CREATED",
348 "displayId": "string",
349 "erpSystemId": 0,
350 "erpSystemDisplayId": "string",
351 "name": "string",
352 "decimalPoints": 0,
353 "depreciationAreaId": 0
354 },
355 "defaultUnitValue": {
356 "createdBy": "string",
357 "lastModifiedBy": "string",
358 "createdDate": "2019-08-24T14:15:22Z",
359 "lastModifiedDate": "2019-08-24T14:15:22Z",
360 "archived": true,
361 "externalId": "string",
362 "id": 0,
363 "unitId": 0,
364 "unitOfMeasureId": 0,
365 "erpSystemId": 0,
366 "unit": {
367 "createdBy": "string",
368 "lastModifiedBy": "string",
369 "createdDate": "2019-08-24T14:15:22Z",
370 "lastModifiedDate": "2019-08-24T14:15:22Z",
371 "archived": true,
372 "externalId": "string",
373 "id": 0,
374 "priority": 0,
375 "internalId": 0,
376 "pickListCode": "string",
377 "pickListLabel": "string",
378 "label": "string",
379 "cultureId": 0,
380 "labelDtos": [
381 {
382 "createdBy": "string",
383 "lastModifiedBy": "string",
384 "createdDate": "2019-08-24T14:15:22Z",
385 "lastModifiedDate": "2019-08-24T14:15:22Z",
386 "archived": true,
387 "externalId": "string",
388 "id": 0,
389 "cultureId": 0,
390 "value": "string"
391 }
392 ]
393 },
394 "unitOfMeasure": {
395 "id": 0,
396 "status": "CREATED",
397 "displayId": "string",
398 "erpSystemId": 0,
399 "erpSystemDisplayId": "string",
400 "name": "string"
401 }
402 },
403 "type": {
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 "priority": 0,
412 "internalId": 0,
413 "pickListCode": "string",
414 "pickListLabel": "string",
415 "label": "string",
416 "cultureId": 0,
417 "labelDtos": [
418 {
419 "createdBy": "string",
420 "lastModifiedBy": "string",
421 "createdDate": "2019-08-24T14:15:22Z",
422 "lastModifiedDate": "2019-08-24T14:15:22Z",
423 "archived": true,
424 "externalId": "string",
425 "id": 0,
426 "cultureId": 0,
427 "value": "string"
428 }
429 ]
430 },
431 "quality": {
432 "createdBy": "string",
433 "lastModifiedBy": "string",
434 "createdDate": "2019-08-24T14:15:22Z",
435 "lastModifiedDate": "2019-08-24T14:15:22Z",
436 "archived": true,
437 "externalId": "string",
438 "id": 0,
439 "priority": 0,
440 "internalId": 0,
441 "pickListCode": "string",
442 "pickListLabel": "string",
443 "label": "string",
444 "cultureId": 0,
445 "labelDtos": [
446 {
447 "createdBy": "string",
448 "lastModifiedBy": "string",
449 "createdDate": "2019-08-24T14:15:22Z",
450 "lastModifiedDate": "2019-08-24T14:15:22Z",
451 "archived": true,
452 "externalId": "string",
453 "id": 0,
454 "cultureId": 0,
455 "value": "string"
456 }
457 ]
458 },
459 "propertyType": {
460 "createdBy": "string",
461 "lastModifiedBy": "string",
462 "createdDate": "2019-08-24T14:15:22Z",
463 "lastModifiedDate": "2019-08-24T14:15:22Z",
464 "archived": true,
465 "externalId": "string",
466 "id": 0,
467 "priority": 0,
468 "internalId": 0,
469 "pickListCode": "string",
470 "pickListLabel": "string",
471 "label": "string",
472 "cultureId": 0,
473 "labelDtos": [
474 {
475 "createdBy": "string",
476 "lastModifiedBy": "string",
477 "createdDate": "2019-08-24T14:15:22Z",
478 "lastModifiedDate": "2019-08-24T14:15:22Z",
479 "archived": true,
480 "externalId": "string",
481 "id": 0,
482 "cultureId": 0,
483 "value": "string"
484 }
485 ]
486 },
487 "category": {
488 "createdBy": "string",
489 "lastModifiedBy": "string",
490 "createdDate": "2019-08-24T14:15:22Z",
491 "lastModifiedDate": "2019-08-24T14:15:22Z",
492 "archived": true,
493 "externalId": "string",
494 "id": 0,
495 "priority": 0,
496 "internalId": 0,
497 "pickListCode": "string",
498 "pickListLabel": "string",
499 "label": "string",
500 "cultureId": 0,
501 "labelDtos": [
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 "cultureId": 0,
511 "value": "string"
512 }
513 ]
514 },
515 "status": {
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 "priority": 0,
524 "internalId": 0,
525 "pickListCode": "string",
526 "pickListLabel": "string",
527 "label": "string",
528 "cultureId": 0,
529 "labelDtos": [
530 {
531 "createdBy": "string",
532 "lastModifiedBy": "string",
533 "createdDate": "2019-08-24T14:15:22Z",
534 "lastModifiedDate": "2019-08-24T14:15:22Z",
535 "archived": true,
536 "externalId": "string",
537 "id": 0,
538 "cultureId": 0,
539 "value": "string"
540 }
541 ]
542 },
543 "addressDto": {
544 "createdBy": "string",
545 "lastModifiedBy": "string",
546 "createdDate": "2019-08-24T14:15:22Z",
547 "lastModifiedDate": "2019-08-24T14:15:22Z",
548 "archived": true,
549 "externalId": "string",
550 "id": 0,
551 "street": "string",
552 "civicNumber": "string",
553 "suite": "string",
554 "postalCode": "string",
555 "lon": 0.1,
556 "lat": 0.1,
557 "city": {
558 "createdBy": "string",
559 "lastModifiedBy": "string",
560 "createdDate": "2019-08-24T14:15:22Z",
561 "lastModifiedDate": "2019-08-24T14:15:22Z",
562 "archived": true,
563 "externalId": "string",
564 "id": 0,
565 "name": "string",
566 "province": {
567 "createdBy": "string",
568 "lastModifiedBy": "string",
569 "createdDate": "2019-08-24T14:15:22Z",
570 "lastModifiedDate": "2019-08-24T14:15:22Z",
571 "archived": true,
572 "externalId": "string",
573 "id": 0,
574 "name": "string",
575 "code": "string",
576 "country": {
577 "createdBy": "string",
578 "lastModifiedBy": "string",
579 "createdDate": "2019-08-24T14:15:22Z",
580 "lastModifiedDate": "2019-08-24T14:15:22Z",
581 "archived": true,
582 "externalId": "string",
583 "id": 0,
584 "name": "string",
585 "code": "string"
586 },
587 "provinceCountryKey": "string"
588 },
589 "cityProvinceCountryKey": "string"
590 },
591 "district": {
592 "createdBy": "string",
593 "lastModifiedBy": "string",
594 "createdDate": "2019-08-24T14:15:22Z",
595 "lastModifiedDate": "2019-08-24T14:15:22Z",
596 "archived": true,
597 "externalId": "string",
598 "id": 0,
599 "name": "string",
600 "city": {
601 "createdBy": "string",
602 "lastModifiedBy": "string",
603 "createdDate": "2019-08-24T14:15:22Z",
604 "lastModifiedDate": "2019-08-24T14:15:22Z",
605 "archived": true,
606 "externalId": "string",
607 "id": 0,
608 "name": "string",
609 "province": {
610 "createdBy": "string",
611 "lastModifiedBy": "string",
612 "createdDate": "2019-08-24T14:15:22Z",
613 "lastModifiedDate": "2019-08-24T14:15:22Z",
614 "archived": true,
615 "externalId": "string",
616 "id": 0,
617 "name": "string",
618 "code": "string",
619 "country": {
620 "createdBy": "string",
621 "lastModifiedBy": "string",
622 "createdDate": "2019-08-24T14:15:22Z",
623 "lastModifiedDate": "2019-08-24T14:15:22Z",
624 "archived": true,
625 "externalId": "string",
626 "id": 0,
627 "name": "string",
628 "code": "string"
629 },
630 "provinceCountryKey": "string"
631 },
632 "cityProvinceCountryKey": "string"
633 }
634 },
635 "cityId": 0,
636 "districtId": 0
637 },
638 "secondAddressDto": {
639 "createdBy": "string",
640 "lastModifiedBy": "string",
641 "createdDate": "2019-08-24T14:15:22Z",
642 "lastModifiedDate": "2019-08-24T14:15:22Z",
643 "archived": true,
644 "externalId": "string",
645 "id": 0,
646 "street": "string",
647 "civicNumber": "string",
648 "suite": "string",
649 "postalCode": "string",
650 "lon": 0.1,
651 "lat": 0.1,
652 "city": {
653 "createdBy": "string",
654 "lastModifiedBy": "string",
655 "createdDate": "2019-08-24T14:15:22Z",
656 "lastModifiedDate": "2019-08-24T14:15:22Z",
657 "archived": true,
658 "externalId": "string",
659 "id": 0,
660 "name": "string",
661 "province": {
662 "createdBy": "string",
663 "lastModifiedBy": "string",
664 "createdDate": "2019-08-24T14:15:22Z",
665 "lastModifiedDate": "2019-08-24T14:15:22Z",
666 "archived": true,
667 "externalId": "string",
668 "id": 0,
669 "name": "string",
670 "code": "string",
671 "country": {
672 "createdBy": "string",
673 "lastModifiedBy": "string",
674 "createdDate": "2019-08-24T14:15:22Z",
675 "lastModifiedDate": "2019-08-24T14:15:22Z",
676 "archived": true,
677 "externalId": "string",
678 "id": 0,
679 "name": "string",
680 "code": "string"
681 },
682 "provinceCountryKey": "string"
683 },
684 "cityProvinceCountryKey": "string"
685 },
686 "district": {
687 "createdBy": "string",
688 "lastModifiedBy": "string",
689 "createdDate": "2019-08-24T14:15:22Z",
690 "lastModifiedDate": "2019-08-24T14:15:22Z",
691 "archived": true,
692 "externalId": "string",
693 "id": 0,
694 "name": "string",
695 "city": {
696 "createdBy": "string",
697 "lastModifiedBy": "string",
698 "createdDate": "2019-08-24T14:15:22Z",
699 "lastModifiedDate": "2019-08-24T14:15:22Z",
700 "archived": true,
701 "externalId": "string",
702 "id": 0,
703 "name": "string",
704 "province": {
705 "createdBy": "string",
706 "lastModifiedBy": "string",
707 "createdDate": "2019-08-24T14:15:22Z",
708 "lastModifiedDate": "2019-08-24T14:15:22Z",
709 "archived": true,
710 "externalId": "string",
711 "id": 0,
712 "name": "string",
713 "code": "string",
714 "country": {
715 "createdBy": "string",
716 "lastModifiedBy": "string",
717 "createdDate": "2019-08-24T14:15:22Z",
718 "lastModifiedDate": "2019-08-24T14:15:22Z",
719 "archived": true,
720 "externalId": "string",
721 "id": 0,
722 "name": "string",
723 "code": "string"
724 },
725 "provinceCountryKey": "string"
726 },
727 "cityProvinceCountryKey": "string"
728 }
729 },
730 "cityId": 0,
731 "districtId": 0
732 }
733 },
734 "status": {
735 "createdBy": "string",
736 "lastModifiedBy": "string",
737 "createdDate": "2019-08-24T14:15:22Z",
738 "lastModifiedDate": "2019-08-24T14:15:22Z",
739 "archived": true,
740 "externalId": "string",
741 "id": 0,
742 "priority": 0,
743 "internalId": 0,
744 "pickListCode": "string",
745 "pickListLabel": "string",
746 "label": "string",
747 "cultureId": 0,
748 "labelDtos": [
749 {
750 "createdBy": "string",
751 "lastModifiedBy": "string",
752 "createdDate": "2019-08-24T14:15:22Z",
753 "lastModifiedDate": "2019-08-24T14:15:22Z",
754 "archived": true,
755 "externalId": "string",
756 "id": 0,
757 "cultureId": 0,
758 "value": "string"
759 }
760 ]
761 },
762 "usage": {
763 "createdBy": "string",
764 "lastModifiedBy": "string",
765 "createdDate": "2019-08-24T14:15:22Z",
766 "lastModifiedDate": "2019-08-24T14:15:22Z",
767 "archived": true,
768 "externalId": "string",
769 "id": 0,
770 "priority": 0,
771 "internalId": 0,
772 "pickListCode": "string",
773 "pickListLabel": "string",
774 "label": "string",
775 "cultureId": 0,
776 "labelDtos": [
777 {
778 "createdBy": "string",
779 "lastModifiedBy": "string",
780 "createdDate": "2019-08-24T14:15:22Z",
781 "lastModifiedDate": "2019-08-24T14:15:22Z",
782 "archived": true,
783 "externalId": "string",
784 "id": 0,
785 "cultureId": 0,
786 "value": "string"
787 }
788 ]
789 },
790 "occupanciesDto": [
791 {
792 "createdBy": "string",
793 "lastModifiedBy": "string",
794 "createdDate": "2019-08-24T14:15:22Z",
795 "lastModifiedDate": "2019-08-24T14:15:22Z",
796 "archived": true,
797 "externalId": "string",
798 "id": 0,
799 "priority": 0,
800 "internalId": 0,
801 "pickListCode": "string",
802 "pickListLabel": "string",
803 "label": "string",
804 "cultureId": 0,
805 "labelDtos": [
806 {
807 "createdBy": "string",
808 "lastModifiedBy": "string",
809 "createdDate": "2019-08-24T14:15:22Z",
810 "lastModifiedDate": "2019-08-24T14:15:22Z",
811 "archived": true,
812 "externalId": "string",
813 "id": 0,
814 "cultureId": 0,
815 "value": "string"
816 }
817 ]
818 }
819 ]
820 },
821 "isTerminationVersion": true
822}
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 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1,
290 "areasHistoryVersionId": 0
291 },
292 "premiseDto": {
293 "createdBy": "string",
294 "lastModifiedBy": "string",
295 "createdDate": "2019-08-24T14:15:22Z",
296 "lastModifiedDate": "2019-08-24T14:15:22Z",
297 "archived": true,
298 "externalId": "string",
299 "id": 0,
300 "number": "string",
301 "name": "string",
302 "headPremise": true,
303 "possessionDate": "2019-08-24",
304 "openingDate": "2019-08-24",
305 "closingDate": "2019-08-24",
306 "relocationDate": "2019-08-24",
307 "vacatingDate": "2019-08-24",
308 "expansionDate": "2019-08-24",
309 "statusId": 0,
310 "usageId": 0,
311 "parentPremiseId": 0,
312 "costCenterId": 0,
313 "profitCenterId": 0,
314 "legalEntityId": 0,
315 "occupancyIds": [
316 0
317 ],
318 "locationId": 0,
319 "locationDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "number": "string",
328 "name": "string",
329 "storeNumber": "string",
330 "defaultCurrencyId": 0,
331 "defaultMeasureId": 0,
332 "typeId": 0,
333 "qualityId": 0,
334 "propertyTypeId": 0,
335 "categoryId": 0,
336 "statusId": 0,
337 "businessUnitId": 0,
338 "groupIds": [
339 0
340 ],
341 "legalEntityIds": [
342 0
343 ],
344 "defaultCurrency": {
345 "id": 0,
346 "status": "CREATED",
347 "displayId": "string",
348 "erpSystemId": 0,
349 "erpSystemDisplayId": "string",
350 "name": "string",
351 "decimalPoints": 0,
352 "depreciationAreaId": 0
353 },
354 "defaultUnitValue": {
355 "createdBy": "string",
356 "lastModifiedBy": "string",
357 "createdDate": "2019-08-24T14:15:22Z",
358 "lastModifiedDate": "2019-08-24T14:15:22Z",
359 "archived": true,
360 "externalId": "string",
361 "id": 0,
362 "unitId": 0,
363 "unitOfMeasureId": 0,
364 "erpSystemId": 0,
365 "unit": {
366 "createdBy": "string",
367 "lastModifiedBy": "string",
368 "createdDate": "2019-08-24T14:15:22Z",
369 "lastModifiedDate": "2019-08-24T14:15:22Z",
370 "archived": true,
371 "externalId": "string",
372 "id": 0,
373 "priority": 0,
374 "internalId": 0,
375 "pickListCode": "string",
376 "pickListLabel": "string",
377 "label": "string",
378 "cultureId": 0,
379 "labelDtos": [
380 {
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 "cultureId": 0,
389 "value": "string"
390 }
391 ]
392 },
393 "unitOfMeasure": {
394 "id": 0,
395 "status": "CREATED",
396 "displayId": "string",
397 "erpSystemId": 0,
398 "erpSystemDisplayId": "string",
399 "name": "string"
400 }
401 },
402 "type": {
403 "createdBy": "string",
404 "lastModifiedBy": "string",
405 "createdDate": "2019-08-24T14:15:22Z",
406 "lastModifiedDate": "2019-08-24T14:15:22Z",
407 "archived": true,
408 "externalId": "string",
409 "id": 0,
410 "priority": 0,
411 "internalId": 0,
412 "pickListCode": "string",
413 "pickListLabel": "string",
414 "label": "string",
415 "cultureId": 0,
416 "labelDtos": [
417 {
418 "createdBy": "string",
419 "lastModifiedBy": "string",
420 "createdDate": "2019-08-24T14:15:22Z",
421 "lastModifiedDate": "2019-08-24T14:15:22Z",
422 "archived": true,
423 "externalId": "string",
424 "id": 0,
425 "cultureId": 0,
426 "value": "string"
427 }
428 ]
429 },
430 "quality": {
431 "createdBy": "string",
432 "lastModifiedBy": "string",
433 "createdDate": "2019-08-24T14:15:22Z",
434 "lastModifiedDate": "2019-08-24T14:15:22Z",
435 "archived": true,
436 "externalId": "string",
437 "id": 0,
438 "priority": 0,
439 "internalId": 0,
440 "pickListCode": "string",
441 "pickListLabel": "string",
442 "label": "string",
443 "cultureId": 0,
444 "labelDtos": [
445 {
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 "cultureId": 0,
454 "value": "string"
455 }
456 ]
457 },
458 "propertyType": {
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 "priority": 0,
467 "internalId": 0,
468 "pickListCode": "string",
469 "pickListLabel": "string",
470 "label": "string",
471 "cultureId": 0,
472 "labelDtos": [
473 {
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 "cultureId": 0,
482 "value": "string"
483 }
484 ]
485 },
486 "category": {
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 "priority": 0,
495 "internalId": 0,
496 "pickListCode": "string",
497 "pickListLabel": "string",
498 "label": "string",
499 "cultureId": 0,
500 "labelDtos": [
501 {
502 "createdBy": "string",
503 "lastModifiedBy": "string",
504 "createdDate": "2019-08-24T14:15:22Z",
505 "lastModifiedDate": "2019-08-24T14:15:22Z",
506 "archived": true,
507 "externalId": "string",
508 "id": 0,
509 "cultureId": 0,
510 "value": "string"
511 }
512 ]
513 },
514 "status": {
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 "priority": 0,
523 "internalId": 0,
524 "pickListCode": "string",
525 "pickListLabel": "string",
526 "label": "string",
527 "cultureId": 0,
528 "labelDtos": [
529 {
530 "createdBy": "string",
531 "lastModifiedBy": "string",
532 "createdDate": "2019-08-24T14:15:22Z",
533 "lastModifiedDate": "2019-08-24T14:15:22Z",
534 "archived": true,
535 "externalId": "string",
536 "id": 0,
537 "cultureId": 0,
538 "value": "string"
539 }
540 ]
541 },
542 "addressDto": {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "street": "string",
551 "civicNumber": "string",
552 "suite": "string",
553 "postalCode": "string",
554 "lon": 0.1,
555 "lat": 0.1,
556 "city": {
557 "createdBy": "string",
558 "lastModifiedBy": "string",
559 "createdDate": "2019-08-24T14:15:22Z",
560 "lastModifiedDate": "2019-08-24T14:15:22Z",
561 "archived": true,
562 "externalId": "string",
563 "id": 0,
564 "name": "string",
565 "province": {
566 "createdBy": "string",
567 "lastModifiedBy": "string",
568 "createdDate": "2019-08-24T14:15:22Z",
569 "lastModifiedDate": "2019-08-24T14:15:22Z",
570 "archived": true,
571 "externalId": "string",
572 "id": 0,
573 "name": "string",
574 "code": "string",
575 "country": {
576 "createdBy": "string",
577 "lastModifiedBy": "string",
578 "createdDate": "2019-08-24T14:15:22Z",
579 "lastModifiedDate": "2019-08-24T14:15:22Z",
580 "archived": true,
581 "externalId": "string",
582 "id": 0,
583 "name": "string",
584 "code": "string"
585 },
586 "provinceCountryKey": "string"
587 },
588 "cityProvinceCountryKey": "string"
589 },
590 "district": {
591 "createdBy": "string",
592 "lastModifiedBy": "string",
593 "createdDate": "2019-08-24T14:15:22Z",
594 "lastModifiedDate": "2019-08-24T14:15:22Z",
595 "archived": true,
596 "externalId": "string",
597 "id": 0,
598 "name": "string",
599 "city": {
600 "createdBy": "string",
601 "lastModifiedBy": "string",
602 "createdDate": "2019-08-24T14:15:22Z",
603 "lastModifiedDate": "2019-08-24T14:15:22Z",
604 "archived": true,
605 "externalId": "string",
606 "id": 0,
607 "name": "string",
608 "province": {
609 "createdBy": "string",
610 "lastModifiedBy": "string",
611 "createdDate": "2019-08-24T14:15:22Z",
612 "lastModifiedDate": "2019-08-24T14:15:22Z",
613 "archived": true,
614 "externalId": "string",
615 "id": 0,
616 "name": "string",
617 "code": "string",
618 "country": {
619 "createdBy": "string",
620 "lastModifiedBy": "string",
621 "createdDate": "2019-08-24T14:15:22Z",
622 "lastModifiedDate": "2019-08-24T14:15:22Z",
623 "archived": true,
624 "externalId": "string",
625 "id": 0,
626 "name": "string",
627 "code": "string"
628 },
629 "provinceCountryKey": "string"
630 },
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {
671 "createdBy": "string",
672 "lastModifiedBy": "string",
673 "createdDate": "2019-08-24T14:15:22Z",
674 "lastModifiedDate": "2019-08-24T14:15:22Z",
675 "archived": true,
676 "externalId": "string",
677 "id": 0,
678 "name": "string",
679 "code": "string"
680 },
681 "provinceCountryKey": "string"
682 },
683 "cityProvinceCountryKey": "string"
684 },
685 "district": {
686 "createdBy": "string",
687 "lastModifiedBy": "string",
688 "createdDate": "2019-08-24T14:15:22Z",
689 "lastModifiedDate": "2019-08-24T14:15:22Z",
690 "archived": true,
691 "externalId": "string",
692 "id": 0,
693 "name": "string",
694 "city": {
695 "createdBy": "string",
696 "lastModifiedBy": "string",
697 "createdDate": "2019-08-24T14:15:22Z",
698 "lastModifiedDate": "2019-08-24T14:15:22Z",
699 "archived": true,
700 "externalId": "string",
701 "id": 0,
702 "name": "string",
703 "province": {
704 "createdBy": "string",
705 "lastModifiedBy": "string",
706 "createdDate": "2019-08-24T14:15:22Z",
707 "lastModifiedDate": "2019-08-24T14:15:22Z",
708 "archived": true,
709 "externalId": "string",
710 "id": 0,
711 "name": "string",
712 "code": "string",
713 "country": {
714 "createdBy": "string",
715 "lastModifiedBy": "string",
716 "createdDate": "2019-08-24T14:15:22Z",
717 "lastModifiedDate": "2019-08-24T14:15:22Z",
718 "archived": true,
719 "externalId": "string",
720 "id": 0,
721 "name": "string",
722 "code": "string"
723 },
724 "provinceCountryKey": "string"
725 },
726 "cityProvinceCountryKey": "string"
727 }
728 },
729 "cityId": 0,
730 "districtId": 0
731 }
732 },
733 "status": {
734 "createdBy": "string",
735 "lastModifiedBy": "string",
736 "createdDate": "2019-08-24T14:15:22Z",
737 "lastModifiedDate": "2019-08-24T14:15:22Z",
738 "archived": true,
739 "externalId": "string",
740 "id": 0,
741 "priority": 0,
742 "internalId": 0,
743 "pickListCode": "string",
744 "pickListLabel": "string",
745 "label": "string",
746 "cultureId": 0,
747 "labelDtos": [
748 {
749 "createdBy": "string",
750 "lastModifiedBy": "string",
751 "createdDate": "2019-08-24T14:15:22Z",
752 "lastModifiedDate": "2019-08-24T14:15:22Z",
753 "archived": true,
754 "externalId": "string",
755 "id": 0,
756 "cultureId": 0,
757 "value": "string"
758 }
759 ]
760 },
761 "usage": {
762 "createdBy": "string",
763 "lastModifiedBy": "string",
764 "createdDate": "2019-08-24T14:15:22Z",
765 "lastModifiedDate": "2019-08-24T14:15:22Z",
766 "archived": true,
767 "externalId": "string",
768 "id": 0,
769 "priority": 0,
770 "internalId": 0,
771 "pickListCode": "string",
772 "pickListLabel": "string",
773 "label": "string",
774 "cultureId": 0,
775 "labelDtos": [
776 {
777 "createdBy": "string",
778 "lastModifiedBy": "string",
779 "createdDate": "2019-08-24T14:15:22Z",
780 "lastModifiedDate": "2019-08-24T14:15:22Z",
781 "archived": true,
782 "externalId": "string",
783 "id": 0,
784 "cultureId": 0,
785 "value": "string"
786 }
787 ]
788 },
789 "occupanciesDto": [
790 {
791 "createdBy": "string",
792 "lastModifiedBy": "string",
793 "createdDate": "2019-08-24T14:15:22Z",
794 "lastModifiedDate": "2019-08-24T14:15:22Z",
795 "archived": true,
796 "externalId": "string",
797 "id": 0,
798 "priority": 0,
799 "internalId": 0,
800 "pickListCode": "string",
801 "pickListLabel": "string",
802 "label": "string",
803 "cultureId": 0,
804 "labelDtos": [
805 {
806 "createdBy": "string",
807 "lastModifiedBy": "string",
808 "createdDate": "2019-08-24T14:15:22Z",
809 "lastModifiedDate": "2019-08-24T14:15:22Z",
810 "archived": true,
811 "externalId": "string",
812 "id": 0,
813 "cultureId": 0,
814 "value": "string"
815 }
816 ]
817 }
818 ]
819 },
820 "isTerminationVersion": true
821}
Lease - Delete Lease¶
HTTP Request
DELETE /api/leases/{id}
📋 Description: Deletes a specified lease from the Nakisa Portfolio Management Suite, enabling users to effectively manage their real estate property portfolio and maintain accurate asset records.
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 |
Lease - Get Leases¶
HTTP Request
GET /api/leases
📋 Description: Retrieves a list of lease agreements associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset utilization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lease query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management within the Nakisa Portfolio Management Suite. |
|
listing |
query |
boolean |
false |
Indicates whether to include listing details in the response for lease data within the Nakisa Portfolio Management Suite, enhancing insights for portfolio and asset analytics in real estate property management. |
search |
query |
string |
false |
Search term used to filter lease records within the Nakisa Portfolio Management Suite, enabling users to efficiently locate specific portfolio, asset, or real estate property information. |
premise-id |
query |
string |
false |
Unique identifier for the real estate property within the portfolio, facilitating precise asset tracking and analytics in the Nakisa Portfolio Management Suite. |
premise-id-in |
query |
string |
false |
Unique identifier for the real estate property premise, used to retrieve lease information within the Nakisa Portfolio Management Suite. |
premise-id-not-null |
query |
string |
false |
Specifies a non-null unique identifier for the real estate property within the lease portfolio, enabling precise asset tracking and analytics. |
premise-number |
query |
string |
false |
Unique identifier for the specific real estate property within the portfolio, used to retrieve lease information in the Nakisa Portfolio Management Suite. |
premise-number-like |
query |
string |
false |
Filters the lease records by matching the specified premise number, facilitating targeted asset analytics within the Nakisa Portfolio Management Suite. |
premise-external-id |
query |
string |
false |
Unique identifier for the external premise associated with a lease, facilitating accurate portfolio and asset management 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 lease information relevant to portfolio and asset analytics in real estate property management. |
location-number |
query |
string |
false |
Specifies the unique location number associated with a real estate property within the portfolio for analytical purposes. |
location-number-like |
query |
string |
false |
Specifies a location number or pattern to filter lease data within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
location-external-id |
query |
string |
false |
Unique identifier for the external location associated with a lease, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
address-id |
query |
string |
false |
Unique identifier for the address associated with a lease, facilitating precise retrieval of real estate property data within the Nakisa Portfolio Management Suite. |
city-id |
query |
string |
false |
Unique identifier for the city associated with real estate properties in the Nakisa Portfolio Management Suite, used to filter lease data in the portfolio and asset analytics. |
province-id |
query |
string |
false |
Unique identifier for the province associated with the lease, 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 and retrieve relevant real estate property data within the Nakisa Portfolio Management Suite. |
contract-id |
query |
string |
false |
Unique identifier for the lease contract, enabling retrieval of specific lease details within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
Represents the unique identifier for a lease within the Nakisa Portfolio Management Suite, facilitating efficient retrieval of lease-related data for portfolio and asset analytics in real estate management. |
number-like |
query |
string |
false |
Represents a numeric value or identifier related to leases within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics for real estate properties. |
number-in |
query |
string |
false |
none |
id |
query |
string |
false |
none |
id-in |
query |
string |
false |
none |
type-id |
query |
string |
false |
Unique identifier for the type of lease being queried, facilitating targeted retrieval of lease data within the Nakisa Portfolio Management Suite. |
terminating-lease |
query |
string |
false |
Specifies the status of the lease termination, allowing users to filter lease data relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
signature-date |
query |
string |
false |
Specifies the date for which lease data is being requested, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
category-id |
query |
string |
false |
Unique identifier for the asset category within the Nakisa Portfolio Management Suite, used to filter lease data in the context of portfolio and real estate property analytics. |
registration-number |
query |
string |
false |
Unique identifier for the lease registration, facilitating the retrieval of specific lease data within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of a lease within the Nakisa Portfolio Management Suite, facilitating insights into portfolio and asset analytics related to real estate properties. |
status-id-is-not |
query |
string |
false |
Excludes leases with the specified status ID from the results, enabling targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id-in |
query |
string |
false |
Filters the lease records 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. |
original-lease-id |
query |
string |
false |
Unique identifier for the original lease, enabling retrieval of specific lease details within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
parent-lease-id-is-null |
query |
string |
false |
none |
state-id |
query |
string |
false |
Unique identifier for the state associated with a lease, enabling precise retrieval of portfolio, asset, and analytics data 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 validity period, enabling users to filter lease data relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
valid-to |
query |
string |
false |
Specifies the expiration date for lease agreements, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite. |
valid-to-greater-than |
query |
string |
false |
Specifies the minimum valid-to date for lease records returned in the portfolio analytics, ensuring that only leases with expiration dates beyond this threshold are included in the response. |
valid-to-less-than |
query |
string |
false |
Specifies the upper limit date for lease validity, enabling users to filter real estate property leases 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}
Lease - Create Leases¶
HTTP Request
POST /api/leases
📋 Description: Creates a new lease 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 the lease details, including asset information, terms, and financial metrics, essential for effective portfolio management and real estate analytics. |
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 "terminatingLease": "2019-08-24",
12 "maximumDateTo": "2019-08-24",
13 "number": "string",
14 "validFrom": "2019-08-24",
15 "validTo": "2019-08-24",
16 "categoryId": 0,
17 "registrationNumber": "string",
18 "statusId": 0,
19 "stateId": 0,
20 "calculateTax": true,
21 "autoMonthToMonth": true,
22 "originalLeaseId": 0,
23 "scenario": true,
24 "parentLeaseId": 0,
25 "areasHistoryVersionId": 0,
26 "provisioningFrequencyName": "string",
27 "accountingApproved": true,
28 "indexationType": "string",
29 "cpiGlobalCategoryId": 0,
30 "indexationReferenceDate": "2019-08-24",
31 "currentIndexLevel": 0.1,
32 "conditionallyIndexed": true,
33 "applicableCurrentIndexLevel": 0.1,
34 "indexLevelPercentageChangeLowerBound": 0.1,
35 "indexLevelPercentageChangeUpperBound": 0.1,
36 "indexationTypeNonLease": "string",
37 "cpiGlobalCategoryIdNonLease": 0,
38 "indexationReferenceDateNonLease": "2019-08-24",
39 "currentIndexLevelNonLease": 0.1,
40 "conditionallyIndexedNonLease": true,
41 "applicableCurrentIndexLevelNonLease": 0.1,
42 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
43 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
44 "signatureDate": "2019-08-24",
45 "premiseId": 0,
46 "type": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 },
74 "category": {
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 "status": {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "priority": 0,
111 "internalId": 0,
112 "pickListCode": "string",
113 "pickListLabel": "string",
114 "label": "string",
115 "cultureId": 0,
116 "labelDtos": [
117 {
118 "createdBy": "string",
119 "lastModifiedBy": "string",
120 "createdDate": "2019-08-24T14:15:22Z",
121 "lastModifiedDate": "2019-08-24T14:15:22Z",
122 "archived": true,
123 "externalId": "string",
124 "id": 0,
125 "cultureId": 0,
126 "value": "string"
127 }
128 ]
129 },
130 "state": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "priority": 0,
139 "internalId": 0,
140 "pickListCode": "string",
141 "pickListLabel": "string",
142 "label": "string",
143 "cultureId": 0,
144 "labelDtos": [
145 {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "cultureId": 0,
154 "value": "string"
155 }
156 ]
157 },
158 "version": {
159 "createdBy": "string",
160 "lastModifiedBy": "string",
161 "createdDate": "2019-08-24T14:15:22Z",
162 "lastModifiedDate": "2019-08-24T14:15:22Z",
163 "archived": true,
164 "externalId": "string",
165 "id": 0,
166 "name": "string",
167 "description": "string",
168 "modificationDate": "2019-08-24",
169 "updateContractRate": true,
170 "leaseEvent": {
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 "typeId": 0,
179 "code": "string",
180 "reviewedBy": "string",
181 "reviewedDate": "2019-08-24",
182 "reviewedStatusId": 0,
183 "activityDate": "2019-08-24",
184 "relatedPickListOptionId": 0,
185 "detail": "string",
186 "note": {
187 "createdBy": "string",
188 "lastModifiedBy": "string",
189 "createdDate": "2019-08-24T14:15:22Z",
190 "lastModifiedDate": "2019-08-24T14:15:22Z",
191 "archived": true,
192 "externalId": "string",
193 "id": 0,
194 "message": "string",
195 "preserveOriginalAudit": true,
196 "originalCreatedBy": "string",
197 "originalCreatedDate": "2019-08-24T14:15:22Z",
198 "originalLastModifiedBy": "string",
199 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
200 },
201 "type": {
202 "createdBy": "string",
203 "lastModifiedBy": "string",
204 "createdDate": "2019-08-24T14:15:22Z",
205 "lastModifiedDate": "2019-08-24T14:15:22Z",
206 "archived": true,
207 "externalId": "string",
208 "id": 0,
209 "priority": 0,
210 "internalId": 0,
211 "pickListCode": "string",
212 "pickListLabel": "string",
213 "label": "string",
214 "cultureId": 0,
215 "labelDtos": [
216 {
217 "createdBy": "string",
218 "lastModifiedBy": "string",
219 "createdDate": "2019-08-24T14:15:22Z",
220 "lastModifiedDate": "2019-08-24T14:15:22Z",
221 "archived": true,
222 "externalId": "string",
223 "id": 0,
224 "cultureId": 0,
225 "value": "string"
226 }
227 ]
228 },
229 "reviewedStatus": {
230 "createdBy": "string",
231 "lastModifiedBy": "string",
232 "createdDate": "2019-08-24T14:15:22Z",
233 "lastModifiedDate": "2019-08-24T14:15:22Z",
234 "archived": true,
235 "externalId": "string",
236 "id": 0,
237 "priority": 0,
238 "internalId": 0,
239 "pickListCode": "string",
240 "pickListLabel": "string",
241 "label": "string",
242 "cultureId": 0,
243 "labelDtos": [
244 {
245 "createdBy": "string",
246 "lastModifiedBy": "string",
247 "createdDate": "2019-08-24T14:15:22Z",
248 "lastModifiedDate": "2019-08-24T14:15:22Z",
249 "archived": true,
250 "externalId": "string",
251 "id": 0,
252 "cultureId": 0,
253 "value": "string"
254 }
255 ]
256 },
257 "relatedPickListOption": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "priority": 0,
266 "internalId": 0,
267 "pickListCode": "string",
268 "pickListLabel": "string",
269 "label": "string",
270 "cultureId": 0,
271 "labelDtos": [
272 {
273 "createdBy": "string",
274 "lastModifiedBy": "string",
275 "createdDate": "2019-08-24T14:15:22Z",
276 "lastModifiedDate": "2019-08-24T14:15:22Z",
277 "archived": true,
278 "externalId": "string",
279 "id": 0,
280 "cultureId": 0,
281 "value": "string"
282 }
283 ]
284 },
285 "isVisiblePartnerPortal": true
286 },
287 "scenario": true,
288 "isVisibleVendorPortal": true,
289 "isTerminationVersion": true,
290 "terminationDate": "2019-08-24",
291 "penaltyAmount": 0.1,
292 "areasHistoryVersionId": 0
293 },
294 "premiseDto": {
295 "createdBy": "string",
296 "lastModifiedBy": "string",
297 "createdDate": "2019-08-24T14:15:22Z",
298 "lastModifiedDate": "2019-08-24T14:15:22Z",
299 "archived": true,
300 "externalId": "string",
301 "id": 0,
302 "number": "string",
303 "name": "string",
304 "headPremise": true,
305 "possessionDate": "2019-08-24",
306 "openingDate": "2019-08-24",
307 "closingDate": "2019-08-24",
308 "relocationDate": "2019-08-24",
309 "vacatingDate": "2019-08-24",
310 "expansionDate": "2019-08-24",
311 "statusId": 0,
312 "usageId": 0,
313 "parentPremiseId": 0,
314 "costCenterId": 0,
315 "profitCenterId": 0,
316 "legalEntityId": 0,
317 "occupancyIds": [
318 0
319 ],
320 "locationId": 0,
321 "locationDto": {
322 "createdBy": "string",
323 "lastModifiedBy": "string",
324 "createdDate": "2019-08-24T14:15:22Z",
325 "lastModifiedDate": "2019-08-24T14:15:22Z",
326 "archived": true,
327 "externalId": "string",
328 "id": 0,
329 "number": "string",
330 "name": "string",
331 "storeNumber": "string",
332 "defaultCurrencyId": 0,
333 "defaultMeasureId": 0,
334 "typeId": 0,
335 "qualityId": 0,
336 "propertyTypeId": 0,
337 "categoryId": 0,
338 "statusId": 0,
339 "businessUnitId": 0,
340 "groupIds": [
341 0
342 ],
343 "legalEntityIds": [
344 0
345 ],
346 "defaultCurrency": {
347 "id": 0,
348 "status": "CREATED",
349 "displayId": "string",
350 "erpSystemId": 0,
351 "erpSystemDisplayId": "string",
352 "name": "string",
353 "decimalPoints": 0,
354 "depreciationAreaId": 0
355 },
356 "defaultUnitValue": {
357 "createdBy": "string",
358 "lastModifiedBy": "string",
359 "createdDate": "2019-08-24T14:15:22Z",
360 "lastModifiedDate": "2019-08-24T14:15:22Z",
361 "archived": true,
362 "externalId": "string",
363 "id": 0,
364 "unitId": 0,
365 "unitOfMeasureId": 0,
366 "erpSystemId": 0,
367 "unit": {
368 "createdBy": "string",
369 "lastModifiedBy": "string",
370 "createdDate": "2019-08-24T14:15:22Z",
371 "lastModifiedDate": "2019-08-24T14:15:22Z",
372 "archived": true,
373 "externalId": "string",
374 "id": 0,
375 "priority": 0,
376 "internalId": 0,
377 "pickListCode": "string",
378 "pickListLabel": "string",
379 "label": "string",
380 "cultureId": 0,
381 "labelDtos": [
382 {
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 "cultureId": 0,
391 "value": "string"
392 }
393 ]
394 },
395 "unitOfMeasure": {
396 "id": 0,
397 "status": "CREATED",
398 "displayId": "string",
399 "erpSystemId": 0,
400 "erpSystemDisplayId": "string",
401 "name": "string"
402 }
403 },
404 "type": {
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 "priority": 0,
413 "internalId": 0,
414 "pickListCode": "string",
415 "pickListLabel": "string",
416 "label": "string",
417 "cultureId": 0,
418 "labelDtos": [
419 {
420 "createdBy": "string",
421 "lastModifiedBy": "string",
422 "createdDate": "2019-08-24T14:15:22Z",
423 "lastModifiedDate": "2019-08-24T14:15:22Z",
424 "archived": true,
425 "externalId": "string",
426 "id": 0,
427 "cultureId": 0,
428 "value": "string"
429 }
430 ]
431 },
432 "quality": {
433 "createdBy": "string",
434 "lastModifiedBy": "string",
435 "createdDate": "2019-08-24T14:15:22Z",
436 "lastModifiedDate": "2019-08-24T14:15:22Z",
437 "archived": true,
438 "externalId": "string",
439 "id": 0,
440 "priority": 0,
441 "internalId": 0,
442 "pickListCode": "string",
443 "pickListLabel": "string",
444 "label": "string",
445 "cultureId": 0,
446 "labelDtos": [
447 {
448 "createdBy": "string",
449 "lastModifiedBy": "string",
450 "createdDate": "2019-08-24T14:15:22Z",
451 "lastModifiedDate": "2019-08-24T14:15:22Z",
452 "archived": true,
453 "externalId": "string",
454 "id": 0,
455 "cultureId": 0,
456 "value": "string"
457 }
458 ]
459 },
460 "propertyType": {
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 "priority": 0,
469 "internalId": 0,
470 "pickListCode": "string",
471 "pickListLabel": "string",
472 "label": "string",
473 "cultureId": 0,
474 "labelDtos": [
475 {
476 "createdBy": "string",
477 "lastModifiedBy": "string",
478 "createdDate": "2019-08-24T14:15:22Z",
479 "lastModifiedDate": "2019-08-24T14:15:22Z",
480 "archived": true,
481 "externalId": "string",
482 "id": 0,
483 "cultureId": 0,
484 "value": "string"
485 }
486 ]
487 },
488 "category": {
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 "priority": 0,
497 "internalId": 0,
498 "pickListCode": "string",
499 "pickListLabel": "string",
500 "label": "string",
501 "cultureId": 0,
502 "labelDtos": [
503 {
504 "createdBy": "string",
505 "lastModifiedBy": "string",
506 "createdDate": "2019-08-24T14:15:22Z",
507 "lastModifiedDate": "2019-08-24T14:15:22Z",
508 "archived": true,
509 "externalId": "string",
510 "id": 0,
511 "cultureId": 0,
512 "value": "string"
513 }
514 ]
515 },
516 "status": {
517 "createdBy": "string",
518 "lastModifiedBy": "string",
519 "createdDate": "2019-08-24T14:15:22Z",
520 "lastModifiedDate": "2019-08-24T14:15:22Z",
521 "archived": true,
522 "externalId": "string",
523 "id": 0,
524 "priority": 0,
525 "internalId": 0,
526 "pickListCode": "string",
527 "pickListLabel": "string",
528 "label": "string",
529 "cultureId": 0,
530 "labelDtos": [
531 {
532 "createdBy": "string",
533 "lastModifiedBy": "string",
534 "createdDate": "2019-08-24T14:15:22Z",
535 "lastModifiedDate": "2019-08-24T14:15:22Z",
536 "archived": true,
537 "externalId": "string",
538 "id": 0,
539 "cultureId": 0,
540 "value": "string"
541 }
542 ]
543 },
544 "addressDto": {
545 "createdBy": "string",
546 "lastModifiedBy": "string",
547 "createdDate": "2019-08-24T14:15:22Z",
548 "lastModifiedDate": "2019-08-24T14:15:22Z",
549 "archived": true,
550 "externalId": "string",
551 "id": 0,
552 "street": "string",
553 "civicNumber": "string",
554 "suite": "string",
555 "postalCode": "string",
556 "lon": 0.1,
557 "lat": 0.1,
558 "city": {
559 "createdBy": "string",
560 "lastModifiedBy": "string",
561 "createdDate": "2019-08-24T14:15:22Z",
562 "lastModifiedDate": "2019-08-24T14:15:22Z",
563 "archived": true,
564 "externalId": "string",
565 "id": 0,
566 "name": "string",
567 "province": {
568 "createdBy": "string",
569 "lastModifiedBy": "string",
570 "createdDate": "2019-08-24T14:15:22Z",
571 "lastModifiedDate": "2019-08-24T14:15:22Z",
572 "archived": true,
573 "externalId": "string",
574 "id": 0,
575 "name": "string",
576 "code": "string",
577 "country": {
578 "createdBy": "string",
579 "lastModifiedBy": "string",
580 "createdDate": "2019-08-24T14:15:22Z",
581 "lastModifiedDate": "2019-08-24T14:15:22Z",
582 "archived": true,
583 "externalId": "string",
584 "id": 0,
585 "name": "string",
586 "code": "string"
587 },
588 "provinceCountryKey": "string"
589 },
590 "cityProvinceCountryKey": "string"
591 },
592 "district": {
593 "createdBy": "string",
594 "lastModifiedBy": "string",
595 "createdDate": "2019-08-24T14:15:22Z",
596 "lastModifiedDate": "2019-08-24T14:15:22Z",
597 "archived": true,
598 "externalId": "string",
599 "id": 0,
600 "name": "string",
601 "city": {
602 "createdBy": "string",
603 "lastModifiedBy": "string",
604 "createdDate": "2019-08-24T14:15:22Z",
605 "lastModifiedDate": "2019-08-24T14:15:22Z",
606 "archived": true,
607 "externalId": "string",
608 "id": 0,
609 "name": "string",
610 "province": {
611 "createdBy": "string",
612 "lastModifiedBy": "string",
613 "createdDate": "2019-08-24T14:15:22Z",
614 "lastModifiedDate": "2019-08-24T14:15:22Z",
615 "archived": true,
616 "externalId": "string",
617 "id": 0,
618 "name": "string",
619 "code": "string",
620 "country": {
621 "createdBy": "string",
622 "lastModifiedBy": "string",
623 "createdDate": "2019-08-24T14:15:22Z",
624 "lastModifiedDate": "2019-08-24T14:15:22Z",
625 "archived": true,
626 "externalId": "string",
627 "id": 0,
628 "name": "string",
629 "code": "string"
630 },
631 "provinceCountryKey": "string"
632 },
633 "cityProvinceCountryKey": "string"
634 }
635 },
636 "cityId": 0,
637 "districtId": 0
638 },
639 "secondAddressDto": {
640 "createdBy": "string",
641 "lastModifiedBy": "string",
642 "createdDate": "2019-08-24T14:15:22Z",
643 "lastModifiedDate": "2019-08-24T14:15:22Z",
644 "archived": true,
645 "externalId": "string",
646 "id": 0,
647 "street": "string",
648 "civicNumber": "string",
649 "suite": "string",
650 "postalCode": "string",
651 "lon": 0.1,
652 "lat": 0.1,
653 "city": {
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 "province": {
663 "createdBy": "string",
664 "lastModifiedBy": "string",
665 "createdDate": "2019-08-24T14:15:22Z",
666 "lastModifiedDate": "2019-08-24T14:15:22Z",
667 "archived": true,
668 "externalId": "string",
669 "id": 0,
670 "name": "string",
671 "code": "string",
672 "country": {
673 "createdBy": "string",
674 "lastModifiedBy": "string",
675 "createdDate": "2019-08-24T14:15:22Z",
676 "lastModifiedDate": "2019-08-24T14:15:22Z",
677 "archived": true,
678 "externalId": "string",
679 "id": 0,
680 "name": "string",
681 "code": "string"
682 },
683 "provinceCountryKey": "string"
684 },
685 "cityProvinceCountryKey": "string"
686 },
687 "district": {
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 "city": {
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 "province": {
706 "createdBy": "string",
707 "lastModifiedBy": "string",
708 "createdDate": "2019-08-24T14:15:22Z",
709 "lastModifiedDate": "2019-08-24T14:15:22Z",
710 "archived": true,
711 "externalId": "string",
712 "id": 0,
713 "name": "string",
714 "code": "string",
715 "country": {
716 "createdBy": "string",
717 "lastModifiedBy": "string",
718 "createdDate": "2019-08-24T14:15:22Z",
719 "lastModifiedDate": "2019-08-24T14:15:22Z",
720 "archived": true,
721 "externalId": "string",
722 "id": 0,
723 "name": "string",
724 "code": "string"
725 },
726 "provinceCountryKey": "string"
727 },
728 "cityProvinceCountryKey": "string"
729 }
730 },
731 "cityId": 0,
732 "districtId": 0
733 }
734 },
735 "status": {
736 "createdBy": "string",
737 "lastModifiedBy": "string",
738 "createdDate": "2019-08-24T14:15:22Z",
739 "lastModifiedDate": "2019-08-24T14:15:22Z",
740 "archived": true,
741 "externalId": "string",
742 "id": 0,
743 "priority": 0,
744 "internalId": 0,
745 "pickListCode": "string",
746 "pickListLabel": "string",
747 "label": "string",
748 "cultureId": 0,
749 "labelDtos": [
750 {
751 "createdBy": "string",
752 "lastModifiedBy": "string",
753 "createdDate": "2019-08-24T14:15:22Z",
754 "lastModifiedDate": "2019-08-24T14:15:22Z",
755 "archived": true,
756 "externalId": "string",
757 "id": 0,
758 "cultureId": 0,
759 "value": "string"
760 }
761 ]
762 },
763 "usage": {
764 "createdBy": "string",
765 "lastModifiedBy": "string",
766 "createdDate": "2019-08-24T14:15:22Z",
767 "lastModifiedDate": "2019-08-24T14:15:22Z",
768 "archived": true,
769 "externalId": "string",
770 "id": 0,
771 "priority": 0,
772 "internalId": 0,
773 "pickListCode": "string",
774 "pickListLabel": "string",
775 "label": "string",
776 "cultureId": 0,
777 "labelDtos": [
778 {
779 "createdBy": "string",
780 "lastModifiedBy": "string",
781 "createdDate": "2019-08-24T14:15:22Z",
782 "lastModifiedDate": "2019-08-24T14:15:22Z",
783 "archived": true,
784 "externalId": "string",
785 "id": 0,
786 "cultureId": 0,
787 "value": "string"
788 }
789 ]
790 },
791 "occupanciesDto": [
792 {
793 "createdBy": "string",
794 "lastModifiedBy": "string",
795 "createdDate": "2019-08-24T14:15:22Z",
796 "lastModifiedDate": "2019-08-24T14:15:22Z",
797 "archived": true,
798 "externalId": "string",
799 "id": 0,
800 "priority": 0,
801 "internalId": 0,
802 "pickListCode": "string",
803 "pickListLabel": "string",
804 "label": "string",
805 "cultureId": 0,
806 "labelDtos": [
807 {
808 "createdBy": "string",
809 "lastModifiedBy": "string",
810 "createdDate": "2019-08-24T14:15:22Z",
811 "lastModifiedDate": "2019-08-24T14:15:22Z",
812 "archived": true,
813 "externalId": "string",
814 "id": 0,
815 "cultureId": 0,
816 "value": "string"
817 }
818 ]
819 }
820 ]
821 },
822 "isTerminationVersion": true
823 }
824]
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 "terminatingLease": "2019-08-24",
12 "maximumDateTo": "2019-08-24",
13 "number": "string",
14 "validFrom": "2019-08-24",
15 "validTo": "2019-08-24",
16 "categoryId": 0,
17 "registrationNumber": "string",
18 "statusId": 0,
19 "stateId": 0,
20 "calculateTax": true,
21 "autoMonthToMonth": true,
22 "originalLeaseId": 0,
23 "scenario": true,
24 "parentLeaseId": 0,
25 "areasHistoryVersionId": 0,
26 "provisioningFrequencyName": "string",
27 "accountingApproved": true,
28 "indexationType": "string",
29 "cpiGlobalCategoryId": 0,
30 "indexationReferenceDate": "2019-08-24",
31 "currentIndexLevel": 0.1,
32 "conditionallyIndexed": true,
33 "applicableCurrentIndexLevel": 0.1,
34 "indexLevelPercentageChangeLowerBound": 0.1,
35 "indexLevelPercentageChangeUpperBound": 0.1,
36 "indexationTypeNonLease": "string",
37 "cpiGlobalCategoryIdNonLease": 0,
38 "indexationReferenceDateNonLease": "2019-08-24",
39 "currentIndexLevelNonLease": 0.1,
40 "conditionallyIndexedNonLease": true,
41 "applicableCurrentIndexLevelNonLease": 0.1,
42 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
43 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
44 "signatureDate": "2019-08-24",
45 "premiseId": 0,
46 "type": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 },
74 "category": {
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 "status": {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "priority": 0,
111 "internalId": 0,
112 "pickListCode": "string",
113 "pickListLabel": "string",
114 "label": "string",
115 "cultureId": 0,
116 "labelDtos": [
117 {
118 "createdBy": "string",
119 "lastModifiedBy": "string",
120 "createdDate": "2019-08-24T14:15:22Z",
121 "lastModifiedDate": "2019-08-24T14:15:22Z",
122 "archived": true,
123 "externalId": "string",
124 "id": 0,
125 "cultureId": 0,
126 "value": "string"
127 }
128 ]
129 },
130 "state": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "priority": 0,
139 "internalId": 0,
140 "pickListCode": "string",
141 "pickListLabel": "string",
142 "label": "string",
143 "cultureId": 0,
144 "labelDtos": [
145 {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "cultureId": 0,
154 "value": "string"
155 }
156 ]
157 },
158 "version": {
159 "createdBy": "string",
160 "lastModifiedBy": "string",
161 "createdDate": "2019-08-24T14:15:22Z",
162 "lastModifiedDate": "2019-08-24T14:15:22Z",
163 "archived": true,
164 "externalId": "string",
165 "id": 0,
166 "name": "string",
167 "description": "string",
168 "modificationDate": "2019-08-24",
169 "updateContractRate": true,
170 "leaseEvent": {
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 "typeId": 0,
179 "code": "string",
180 "reviewedBy": "string",
181 "reviewedDate": "2019-08-24",
182 "reviewedStatusId": 0,
183 "activityDate": "2019-08-24",
184 "relatedPickListOptionId": 0,
185 "detail": "string",
186 "note": {
187 "createdBy": "string",
188 "lastModifiedBy": "string",
189 "createdDate": "2019-08-24T14:15:22Z",
190 "lastModifiedDate": "2019-08-24T14:15:22Z",
191 "archived": true,
192 "externalId": "string",
193 "id": 0,
194 "message": "string",
195 "preserveOriginalAudit": true,
196 "originalCreatedBy": "string",
197 "originalCreatedDate": "2019-08-24T14:15:22Z",
198 "originalLastModifiedBy": "string",
199 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
200 },
201 "type": {
202 "createdBy": "string",
203 "lastModifiedBy": "string",
204 "createdDate": "2019-08-24T14:15:22Z",
205 "lastModifiedDate": "2019-08-24T14:15:22Z",
206 "archived": true,
207 "externalId": "string",
208 "id": 0,
209 "priority": 0,
210 "internalId": 0,
211 "pickListCode": "string",
212 "pickListLabel": "string",
213 "label": "string",
214 "cultureId": 0,
215 "labelDtos": [
216 {
217 "createdBy": "string",
218 "lastModifiedBy": "string",
219 "createdDate": "2019-08-24T14:15:22Z",
220 "lastModifiedDate": "2019-08-24T14:15:22Z",
221 "archived": true,
222 "externalId": "string",
223 "id": 0,
224 "cultureId": 0,
225 "value": "string"
226 }
227 ]
228 },
229 "reviewedStatus": {
230 "createdBy": "string",
231 "lastModifiedBy": "string",
232 "createdDate": "2019-08-24T14:15:22Z",
233 "lastModifiedDate": "2019-08-24T14:15:22Z",
234 "archived": true,
235 "externalId": "string",
236 "id": 0,
237 "priority": 0,
238 "internalId": 0,
239 "pickListCode": "string",
240 "pickListLabel": "string",
241 "label": "string",
242 "cultureId": 0,
243 "labelDtos": [
244 {
245 "createdBy": "string",
246 "lastModifiedBy": "string",
247 "createdDate": "2019-08-24T14:15:22Z",
248 "lastModifiedDate": "2019-08-24T14:15:22Z",
249 "archived": true,
250 "externalId": "string",
251 "id": 0,
252 "cultureId": 0,
253 "value": "string"
254 }
255 ]
256 },
257 "relatedPickListOption": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "priority": 0,
266 "internalId": 0,
267 "pickListCode": "string",
268 "pickListLabel": "string",
269 "label": "string",
270 "cultureId": 0,
271 "labelDtos": [
272 {
273 "createdBy": "string",
274 "lastModifiedBy": "string",
275 "createdDate": "2019-08-24T14:15:22Z",
276 "lastModifiedDate": "2019-08-24T14:15:22Z",
277 "archived": true,
278 "externalId": "string",
279 "id": 0,
280 "cultureId": 0,
281 "value": "string"
282 }
283 ]
284 },
285 "isVisiblePartnerPortal": true
286 },
287 "isVisibleVendorPortal": true,
288 "isTerminationVersion": true,
289 "terminationDate": "2019-08-24",
290 "penaltyAmount": 0.1,
291 "areasHistoryVersionId": 0
292 },
293 "premiseDto": {
294 "createdBy": "string",
295 "lastModifiedBy": "string",
296 "createdDate": "2019-08-24T14:15:22Z",
297 "lastModifiedDate": "2019-08-24T14:15:22Z",
298 "archived": true,
299 "externalId": "string",
300 "id": 0,
301 "number": "string",
302 "name": "string",
303 "headPremise": true,
304 "possessionDate": "2019-08-24",
305 "openingDate": "2019-08-24",
306 "closingDate": "2019-08-24",
307 "relocationDate": "2019-08-24",
308 "vacatingDate": "2019-08-24",
309 "expansionDate": "2019-08-24",
310 "statusId": 0,
311 "usageId": 0,
312 "parentPremiseId": 0,
313 "costCenterId": 0,
314 "profitCenterId": 0,
315 "legalEntityId": 0,
316 "occupancyIds": [
317 0
318 ],
319 "locationId": 0,
320 "locationDto": {
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 "number": "string",
329 "name": "string",
330 "storeNumber": "string",
331 "defaultCurrencyId": 0,
332 "defaultMeasureId": 0,
333 "typeId": 0,
334 "qualityId": 0,
335 "propertyTypeId": 0,
336 "categoryId": 0,
337 "statusId": 0,
338 "businessUnitId": 0,
339 "groupIds": [
340 0
341 ],
342 "legalEntityIds": [
343 0
344 ],
345 "defaultCurrency": {
346 "id": 0,
347 "status": "CREATED",
348 "displayId": "string",
349 "erpSystemId": 0,
350 "erpSystemDisplayId": "string",
351 "name": "string",
352 "decimalPoints": 0,
353 "depreciationAreaId": 0
354 },
355 "defaultUnitValue": {
356 "createdBy": "string",
357 "lastModifiedBy": "string",
358 "createdDate": "2019-08-24T14:15:22Z",
359 "lastModifiedDate": "2019-08-24T14:15:22Z",
360 "archived": true,
361 "externalId": "string",
362 "id": 0,
363 "unitId": 0,
364 "unitOfMeasureId": 0,
365 "erpSystemId": 0,
366 "unit": {
367 "createdBy": "string",
368 "lastModifiedBy": "string",
369 "createdDate": "2019-08-24T14:15:22Z",
370 "lastModifiedDate": "2019-08-24T14:15:22Z",
371 "archived": true,
372 "externalId": "string",
373 "id": 0,
374 "priority": 0,
375 "internalId": 0,
376 "pickListCode": "string",
377 "pickListLabel": "string",
378 "label": "string",
379 "cultureId": 0,
380 "labelDtos": [
381 {
382 "createdBy": "string",
383 "lastModifiedBy": "string",
384 "createdDate": "2019-08-24T14:15:22Z",
385 "lastModifiedDate": "2019-08-24T14:15:22Z",
386 "archived": true,
387 "externalId": "string",
388 "id": 0,
389 "cultureId": 0,
390 "value": "string"
391 }
392 ]
393 },
394 "unitOfMeasure": {
395 "id": 0,
396 "status": "CREATED",
397 "displayId": "string",
398 "erpSystemId": 0,
399 "erpSystemDisplayId": "string",
400 "name": "string"
401 }
402 },
403 "type": {
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 "priority": 0,
412 "internalId": 0,
413 "pickListCode": "string",
414 "pickListLabel": "string",
415 "label": "string",
416 "cultureId": 0,
417 "labelDtos": [
418 {
419 "createdBy": "string",
420 "lastModifiedBy": "string",
421 "createdDate": "2019-08-24T14:15:22Z",
422 "lastModifiedDate": "2019-08-24T14:15:22Z",
423 "archived": true,
424 "externalId": "string",
425 "id": 0,
426 "cultureId": 0,
427 "value": "string"
428 }
429 ]
430 },
431 "quality": {
432 "createdBy": "string",
433 "lastModifiedBy": "string",
434 "createdDate": "2019-08-24T14:15:22Z",
435 "lastModifiedDate": "2019-08-24T14:15:22Z",
436 "archived": true,
437 "externalId": "string",
438 "id": 0,
439 "priority": 0,
440 "internalId": 0,
441 "pickListCode": "string",
442 "pickListLabel": "string",
443 "label": "string",
444 "cultureId": 0,
445 "labelDtos": [
446 {
447 "createdBy": "string",
448 "lastModifiedBy": "string",
449 "createdDate": "2019-08-24T14:15:22Z",
450 "lastModifiedDate": "2019-08-24T14:15:22Z",
451 "archived": true,
452 "externalId": "string",
453 "id": 0,
454 "cultureId": 0,
455 "value": "string"
456 }
457 ]
458 },
459 "propertyType": {
460 "createdBy": "string",
461 "lastModifiedBy": "string",
462 "createdDate": "2019-08-24T14:15:22Z",
463 "lastModifiedDate": "2019-08-24T14:15:22Z",
464 "archived": true,
465 "externalId": "string",
466 "id": 0,
467 "priority": 0,
468 "internalId": 0,
469 "pickListCode": "string",
470 "pickListLabel": "string",
471 "label": "string",
472 "cultureId": 0,
473 "labelDtos": [
474 {
475 "createdBy": "string",
476 "lastModifiedBy": "string",
477 "createdDate": "2019-08-24T14:15:22Z",
478 "lastModifiedDate": "2019-08-24T14:15:22Z",
479 "archived": true,
480 "externalId": "string",
481 "id": 0,
482 "cultureId": 0,
483 "value": "string"
484 }
485 ]
486 },
487 "category": {
488 "createdBy": "string",
489 "lastModifiedBy": "string",
490 "createdDate": "2019-08-24T14:15:22Z",
491 "lastModifiedDate": "2019-08-24T14:15:22Z",
492 "archived": true,
493 "externalId": "string",
494 "id": 0,
495 "priority": 0,
496 "internalId": 0,
497 "pickListCode": "string",
498 "pickListLabel": "string",
499 "label": "string",
500 "cultureId": 0,
501 "labelDtos": [
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 "cultureId": 0,
511 "value": "string"
512 }
513 ]
514 },
515 "status": {
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 "priority": 0,
524 "internalId": 0,
525 "pickListCode": "string",
526 "pickListLabel": "string",
527 "label": "string",
528 "cultureId": 0,
529 "labelDtos": [
530 {
531 "createdBy": "string",
532 "lastModifiedBy": "string",
533 "createdDate": "2019-08-24T14:15:22Z",
534 "lastModifiedDate": "2019-08-24T14:15:22Z",
535 "archived": true,
536 "externalId": "string",
537 "id": 0,
538 "cultureId": 0,
539 "value": "string"
540 }
541 ]
542 },
543 "addressDto": {
544 "createdBy": "string",
545 "lastModifiedBy": "string",
546 "createdDate": "2019-08-24T14:15:22Z",
547 "lastModifiedDate": "2019-08-24T14:15:22Z",
548 "archived": true,
549 "externalId": "string",
550 "id": 0,
551 "street": "string",
552 "civicNumber": "string",
553 "suite": "string",
554 "postalCode": "string",
555 "lon": 0.1,
556 "lat": 0.1,
557 "city": {
558 "createdBy": "string",
559 "lastModifiedBy": "string",
560 "createdDate": "2019-08-24T14:15:22Z",
561 "lastModifiedDate": "2019-08-24T14:15:22Z",
562 "archived": true,
563 "externalId": "string",
564 "id": 0,
565 "name": "string",
566 "province": {
567 "createdBy": "string",
568 "lastModifiedBy": "string",
569 "createdDate": "2019-08-24T14:15:22Z",
570 "lastModifiedDate": "2019-08-24T14:15:22Z",
571 "archived": true,
572 "externalId": "string",
573 "id": 0,
574 "name": "string",
575 "code": "string",
576 "country": {
577 "createdBy": "string",
578 "lastModifiedBy": "string",
579 "createdDate": "2019-08-24T14:15:22Z",
580 "lastModifiedDate": "2019-08-24T14:15:22Z",
581 "archived": true,
582 "externalId": "string",
583 "id": 0,
584 "name": "string",
585 "code": "string"
586 },
587 "provinceCountryKey": "string"
588 },
589 "cityProvinceCountryKey": "string"
590 },
591 "district": {
592 "createdBy": "string",
593 "lastModifiedBy": "string",
594 "createdDate": "2019-08-24T14:15:22Z",
595 "lastModifiedDate": "2019-08-24T14:15:22Z",
596 "archived": true,
597 "externalId": "string",
598 "id": 0,
599 "name": "string",
600 "city": {
601 "createdBy": "string",
602 "lastModifiedBy": "string",
603 "createdDate": "2019-08-24T14:15:22Z",
604 "lastModifiedDate": "2019-08-24T14:15:22Z",
605 "archived": true,
606 "externalId": "string",
607 "id": 0,
608 "name": "string",
609 "province": {
610 "createdBy": "string",
611 "lastModifiedBy": "string",
612 "createdDate": "2019-08-24T14:15:22Z",
613 "lastModifiedDate": "2019-08-24T14:15:22Z",
614 "archived": true,
615 "externalId": "string",
616 "id": 0,
617 "name": "string",
618 "code": "string",
619 "country": {
620 "createdBy": "string",
621 "lastModifiedBy": "string",
622 "createdDate": "2019-08-24T14:15:22Z",
623 "lastModifiedDate": "2019-08-24T14:15:22Z",
624 "archived": true,
625 "externalId": "string",
626 "id": 0,
627 "name": "string",
628 "code": "string"
629 },
630 "provinceCountryKey": "string"
631 },
632 "cityProvinceCountryKey": "string"
633 }
634 },
635 "cityId": 0,
636 "districtId": 0
637 },
638 "secondAddressDto": {
639 "createdBy": "string",
640 "lastModifiedBy": "string",
641 "createdDate": "2019-08-24T14:15:22Z",
642 "lastModifiedDate": "2019-08-24T14:15:22Z",
643 "archived": true,
644 "externalId": "string",
645 "id": 0,
646 "street": "string",
647 "civicNumber": "string",
648 "suite": "string",
649 "postalCode": "string",
650 "lon": 0.1,
651 "lat": 0.1,
652 "city": {
653 "createdBy": "string",
654 "lastModifiedBy": "string",
655 "createdDate": "2019-08-24T14:15:22Z",
656 "lastModifiedDate": "2019-08-24T14:15:22Z",
657 "archived": true,
658 "externalId": "string",
659 "id": 0,
660 "name": "string",
661 "province": {
662 "createdBy": "string",
663 "lastModifiedBy": "string",
664 "createdDate": "2019-08-24T14:15:22Z",
665 "lastModifiedDate": "2019-08-24T14:15:22Z",
666 "archived": true,
667 "externalId": "string",
668 "id": 0,
669 "name": "string",
670 "code": "string",
671 "country": {
672 "createdBy": "string",
673 "lastModifiedBy": "string",
674 "createdDate": "2019-08-24T14:15:22Z",
675 "lastModifiedDate": "2019-08-24T14:15:22Z",
676 "archived": true,
677 "externalId": "string",
678 "id": 0,
679 "name": "string",
680 "code": "string"
681 },
682 "provinceCountryKey": "string"
683 },
684 "cityProvinceCountryKey": "string"
685 },
686 "district": {
687 "createdBy": "string",
688 "lastModifiedBy": "string",
689 "createdDate": "2019-08-24T14:15:22Z",
690 "lastModifiedDate": "2019-08-24T14:15:22Z",
691 "archived": true,
692 "externalId": "string",
693 "id": 0,
694 "name": "string",
695 "city": {
696 "createdBy": "string",
697 "lastModifiedBy": "string",
698 "createdDate": "2019-08-24T14:15:22Z",
699 "lastModifiedDate": "2019-08-24T14:15:22Z",
700 "archived": true,
701 "externalId": "string",
702 "id": 0,
703 "name": "string",
704 "province": {
705 "createdBy": "string",
706 "lastModifiedBy": "string",
707 "createdDate": "2019-08-24T14:15:22Z",
708 "lastModifiedDate": "2019-08-24T14:15:22Z",
709 "archived": true,
710 "externalId": "string",
711 "id": 0,
712 "name": "string",
713 "code": "string",
714 "country": {
715 "createdBy": "string",
716 "lastModifiedBy": "string",
717 "createdDate": "2019-08-24T14:15:22Z",
718 "lastModifiedDate": "2019-08-24T14:15:22Z",
719 "archived": true,
720 "externalId": "string",
721 "id": 0,
722 "name": "string",
723 "code": "string"
724 },
725 "provinceCountryKey": "string"
726 },
727 "cityProvinceCountryKey": "string"
728 }
729 },
730 "cityId": 0,
731 "districtId": 0
732 }
733 },
734 "status": {
735 "createdBy": "string",
736 "lastModifiedBy": "string",
737 "createdDate": "2019-08-24T14:15:22Z",
738 "lastModifiedDate": "2019-08-24T14:15:22Z",
739 "archived": true,
740 "externalId": "string",
741 "id": 0,
742 "priority": 0,
743 "internalId": 0,
744 "pickListCode": "string",
745 "pickListLabel": "string",
746 "label": "string",
747 "cultureId": 0,
748 "labelDtos": [
749 {
750 "createdBy": "string",
751 "lastModifiedBy": "string",
752 "createdDate": "2019-08-24T14:15:22Z",
753 "lastModifiedDate": "2019-08-24T14:15:22Z",
754 "archived": true,
755 "externalId": "string",
756 "id": 0,
757 "cultureId": 0,
758 "value": "string"
759 }
760 ]
761 },
762 "usage": {
763 "createdBy": "string",
764 "lastModifiedBy": "string",
765 "createdDate": "2019-08-24T14:15:22Z",
766 "lastModifiedDate": "2019-08-24T14:15:22Z",
767 "archived": true,
768 "externalId": "string",
769 "id": 0,
770 "priority": 0,
771 "internalId": 0,
772 "pickListCode": "string",
773 "pickListLabel": "string",
774 "label": "string",
775 "cultureId": 0,
776 "labelDtos": [
777 {
778 "createdBy": "string",
779 "lastModifiedBy": "string",
780 "createdDate": "2019-08-24T14:15:22Z",
781 "lastModifiedDate": "2019-08-24T14:15:22Z",
782 "archived": true,
783 "externalId": "string",
784 "id": 0,
785 "cultureId": 0,
786 "value": "string"
787 }
788 ]
789 },
790 "occupanciesDto": [
791 {
792 "createdBy": "string",
793 "lastModifiedBy": "string",
794 "createdDate": "2019-08-24T14:15:22Z",
795 "lastModifiedDate": "2019-08-24T14:15:22Z",
796 "archived": true,
797 "externalId": "string",
798 "id": 0,
799 "priority": 0,
800 "internalId": 0,
801 "pickListCode": "string",
802 "pickListLabel": "string",
803 "label": "string",
804 "cultureId": 0,
805 "labelDtos": [
806 {
807 "createdBy": "string",
808 "lastModifiedBy": "string",
809 "createdDate": "2019-08-24T14:15:22Z",
810 "lastModifiedDate": "2019-08-24T14:15:22Z",
811 "archived": true,
812 "externalId": "string",
813 "id": 0,
814 "cultureId": 0,
815 "value": "string"
816 }
817 ]
818 }
819 ]
820 },
821 "isTerminationVersion": true
822 }
823]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a lease agreement within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset tracking, and real estate 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) |
false |
none |
Unique identifier for the type |
» terminatingLease |
string(date) |
false |
none |
Indicates the status of the lease termination within the Nakisa Portfolio Management Suite, providing critical insights for portfolio and asset analytics in real estate management. |
» maximumDateTo |
string(date) |
false |
none |
Specifies the latest date through which lease data can be analyzed within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics. |
» number |
string |
false |
none |
Represents the unique identification number assigned to a lease within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics. |
» validFrom |
string(date) |
true |
none |
Date from which the resource is valid |
» validTo |
string(date) |
true |
none |
Date until which the resource is valid |
» categoryId |
integer(int64) |
false |
none |
Unique identifier for the category |
» registrationNumber |
string |
false |
none |
Unique identifier assigned to a lease agreement, facilitating asset tracking and portfolio management within the Nakisa Portfolio Management Suite. |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» stateId |
integer(int64) |
false |
none |
Unique identifier for the state |
» calculateTax |
boolean |
false |
none |
Boolean flag indicating calculateTax status |
» autoMonthToMonth |
boolean |
false |
none |
Boolean flag indicating autoMonthToMonth status |
» originalLeaseId |
integer(int64) |
false |
none |
Unique identifier for the original lease |
» scenario |
boolean |
false |
none |
Boolean flag indicating scenario status |
» parentLeaseId |
integer(int64) |
false |
none |
Unique identifier for the parent lease |
» areasHistoryVersionId |
integer(int64) |
false |
none |
none |
» provisioningFrequencyName |
string |
false |
none |
Name of the provisioning frequency |
» accountingApproved |
boolean |
false |
none |
Boolean flag indicating accountingApproved status |
» indexationType |
string |
true |
none |
Type of the indexation |
» cpiGlobalCategoryId |
integer(int64) |
false |
none |
Unique identifier for the cpi global category |
» indexationReferenceDate |
string(date) |
false |
none |
Date of the indexation reference |
» currentIndexLevel |
number(double) |
false |
none |
Value for currentIndexLevel field |
» conditionallyIndexed |
boolean |
false |
none |
Indicates whether the lease is subject to conditional indexing, impacting portfolio analytics and asset valuation within the Nakisa Portfolio Management Suite. |
» applicableCurrentIndexLevel |
number(double) |
false |
none |
Value for applicableCurrentIndexLevel field |
» indexLevelPercentageChangeLowerBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBound field |
» indexLevelPercentageChangeUpperBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBound field |
» indexationTypeNonLease |
string |
true |
none |
Specifies the type of indexation applied to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
» indexationReferenceDateNonLease |
string(date) |
false |
none |
Represents the reference date for indexation adjustments related to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
» currentIndexLevelNonLease |
number(double) |
false |
none |
Value for currentIndexLevelNonLease field |
» conditionallyIndexedNonLease |
boolean |
false |
none |
Indicates whether the asset is conditionally indexed, providing critical insights for portfolio analytics and real estate property management within the Nakisa Portfolio Management Suite. |
» applicableCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for applicableCurrentIndexLevelNonLease field |
» indexLevelPercentageChangeLowerBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBoundNonLease field |
» indexLevelPercentageChangeUpperBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBoundNonLease field |
» signatureDate |
string(date) |
false |
none |
Date of the signature |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» 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. |
» 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. |
|
» state |
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. |
|
» version |
false |
none |
Data transfer object representing the versioning information of assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio analytics and management 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 |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» modificationDate |
string(date) |
false |
none |
Date of the modification |
»» updateContractRate |
boolean |
false |
none |
Rate of update contract |
»» leaseEvent |
false |
none |
Data transfer object representing an event within the Nakisa Portfolio Management Suite, encapsulating key details related to portfolio management, asset tracking, 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) |
false |
none |
Unique identifier for the type |
»»» code |
string |
false |
none |
Code identifier for the resource |
»»» reviewedBy |
string |
false |
none |
Identifier of the user or entity that has reviewed the event, providing accountability and transparency within the portfolio management process. |
»»» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
»»» reviewedStatusId |
integer(int64) |
false |
none |
Unique identifier for the reviewed status |
»»» activityDate |
string(date) |
false |
none |
Date of the activity |
»»» relatedPickListOptionId |
integer(int64) |
false |
none |
Unique identifier for the related pick list option |
»»» detail |
string |
false |
none |
Detailed description of the event, providing insights relevant to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»»» note |
false |
none |
Data transfer object representing a note associated with a portfolio or asset within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for real estate property management. |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» message |
string |
true |
none |
Textual content providing detailed insights or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»»»» preserveOriginalAudit |
boolean |
false |
none |
Indicates whether to retain the original audit trail for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»»» originalCreatedBy |
string |
false |
none |
Identifies the original creator of the note within the Nakisa Portfolio Management Suite, providing essential context for portfolio, asset, and real estate property analytics. |
»»»» originalCreatedDate |
string(date-time) |
false |
none |
Date of the original created |
»»»» originalLastModifiedBy |
string |
false |
none |
Identifier of the user who last modified the note, providing accountability and traceability within the context of portfolio, asset, and real estate property management. |
»»»» originalLastModifiedDate |
string(date-time) |
false |
none |
Date of the original last modified |
»»» 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. |
|
»»» reviewedStatus |
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. |
|
»»» relatedPickListOption |
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. |
|
»»» isVisiblePartnerPortal |
boolean |
false |
none |
none |
»» scenario |
boolean |
false |
write-only |
Boolean flag indicating scenario status |
»» isVisibleVendorPortal |
boolean |
false |
none |
Whether the resource is visible vendor portal |
»» isTerminationVersion |
boolean |
false |
none |
Whether the resource is termination version |
»» terminationDate |
string(date) |
false |
none |
Date of the termination |
»» penaltyAmount |
number(double) |
false |
none |
Amount of penalty |
»» areasHistoryVersionId |
integer(int64) |
false |
none |
none |
» premiseDto |
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. |
|
»»»» 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 |
|
» isTerminationVersion |
boolean |
false |
none |
Whether the resource is termination version |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Add Partner To Lease¶
HTTP Request
POST /api/leases/{leaseId}/vendors/{partnerId}
📋 Description: Adds a vendor partner to a specified lease within the Nakisa Portfolio Management Suite, enabling enhanced collaboration and management of real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
partnerId |
path |
integer(int64) |
true |
Unique identifier for the partner |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "fax": "string",
9 "phone": "string",
10 "parentId": 0,
11 "parentName": "string",
12 "parentDisplayId": "string",
13 "companyId": 0,
14 "partnerRoleId": 0,
15 "partnerContactId": 0
16}
Lease - Delete Lease Partner¶
HTTP Request
DELETE /api/leases/{leaseId}/vendors/{partnerId}
📋 Description: Deletes the specified vendor associated with a lease, enabling effective management of partnerships within the Nakisa Portfolio Management Suite’s real estate asset portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
partnerId |
path |
integer(int64) |
true |
Unique identifier for the partner |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Lease - Create Lease To Partner¶
HTTP Request
POST /api/leases/{leaseId}/partners
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
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 "partnerId": 0,
11 "partnerRoleId": 0,
12 "dateFrom": "2019-08-24",
13 "dateTo": "2019-08-24",
14 "leaseId": 0,
15 "leaseExternalId": "string",
16 "partner": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemDisplayId": "string"
22 },
23 "partnerParent": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "partnerRole": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string"
35 }
36 }
37]
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 "partnerId": 0,
11 "partnerRoleId": 0,
12 "dateFrom": "2019-08-24",
13 "dateTo": "2019-08-24",
14 "leaseId": 0,
15 "leaseExternalId": "string",
16 "partner": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemDisplayId": "string"
22 },
23 "partnerParent": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "partnerRole": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string"
35 }
36 }
37]
Response Schema
Status Code 201
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 |
» partnerId |
integer(int64) |
false |
none |
none |
» partnerRoleId |
integer(int64) |
false |
none |
none |
» dateFrom |
string(date) |
false |
none |
none |
» dateTo |
string(date) |
false |
none |
none |
» leaseId |
integer(int64) |
false |
none |
none |
» leaseExternalId |
string |
false |
none |
none |
» partner |
false |
none |
Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» partnerParent |
false |
none |
Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector. |
|
» partnerRole |
false |
none |
Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Execute Indexation¶
HTTP Request
POST /api/leases/{leaseId}/execute-indexation
📋 Description: Executes the indexation process for a specified lease within the Nakisa Portfolio Management Suite, ensuring accurate financial analytics and portfolio management for real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
body |
body |
true |
Request body containing the indexation parameters and associated metadata for executing lease adjustments 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 "statusId": 0,
11 "desiredModificationDate": "2019-08-24",
12 "actualModificationDate": "2019-08-24",
13 "desiredIndexationDateLease": "2019-08-24",
14 "actualIndexationDateLease": "2019-08-24",
15 "desiredIndexationDateNonLease": "2019-08-24",
16 "actualIndexationDateNonLease": "2019-08-24",
17 "messageCode": "string",
18 "delimitedArguments": "string",
19 "messageCodeIndexationDateLease": "string",
20 "messageCodeIndexationDateNonLease": "string",
21 "status": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "cpiIndexationPlanId": 0,
50 "cpiIndexationPlanDto": {
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 "modificationDate": "2019-08-24",
59 "currencyId": 0,
60 "activationGroupId": 0,
61 "cpiGlobalCategoryId": 0,
62 "cpiGlobalCategoryIdNonLease": 0,
63 "cpiGlobalReferenceDate": "2019-08-24",
64 "cpiGlobalReferenceDateNonLease": "2019-08-24",
65 "cpiLocalCurrentIndexLevel": 0.1,
66 "cpiLocalCurrentIndexLevelNonLease": 0.1,
67 "conditionallyIndexed": true,
68 "applicableCurrentIndexLevel": 0.1,
69 "indexLevelPercentageChangeLowerBound": 0.1,
70 "indexLevelPercentageChangeUpperBound": 0.1,
71 "conditionallyIndexedNonLease": true,
72 "applicableCurrentIndexLevelNonLease": 0.1,
73 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
74 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
75 "statusId": 0,
76 "applyIndexationLease": true,
77 "indexationDateLease": "2019-08-24",
78 "applyIndexationNonLease": true,
79 "indexationDateNonLease": "2019-08-24",
80 "executionDate": "2019-08-24",
81 "executedModificationDate": "2019-08-24",
82 "executedIndexationDateLease": "2019-08-24",
83 "executedIndexationDateNonLease": "2019-08-24",
84 "messageCode": "string",
85 "messageCodeIndexationDateLease": "string",
86 "messageCodeIndexationDateNonLease": "string",
87 "status": {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "priority": 0,
96 "internalId": 0,
97 "pickListCode": "string",
98 "pickListLabel": "string",
99 "label": "string",
100 "cultureId": 0,
101 "labelDtos": [
102 {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "cultureId": 0,
111 "value": "string"
112 }
113 ]
114 },
115 "currency": {
116 "id": 0,
117 "status": "CREATED",
118 "displayId": "string",
119 "erpSystemId": 0,
120 "erpSystemDisplayId": "string",
121 "name": "string",
122 "decimalPoints": 0,
123 "depreciationAreaId": 0
124 },
125 "activationGroupDisplayId": "string",
126 "leaseId": 0,
127 "message": "string",
128 "messageIndexationDateLease": "string",
129 "messageIndexationDateNonLease": "string",
130 "cpiGlobalCategory": {
131 "id": 0,
132 "status": "CREATED",
133 "displayId": "string",
134 "name": "string",
135 "country": "string",
136 "province": "string",
137 "city": "string",
138 "consumerPriceIndexSourceType": "WEB",
139 "source": "string",
140 "formula": "string",
141 "indexedCurrency": true,
142 "exchangeRateType": "string",
143 "erpSystemId": 0,
144 "erpSystemDisplayId": "string",
145 "fromCurrencyId": 0,
146 "fromCurrencyDisplayId": "string",
147 "toCurrencyId": 0,
148 "toCurrencyDisplayId": "string",
149 "consumerPriceIndexValueId": "string",
150 "companyId": 0
151 },
152 "cpiGlobalCategoryNonLease": {
153 "id": 0,
154 "status": "CREATED",
155 "displayId": "string",
156 "name": "string",
157 "country": "string",
158 "province": "string",
159 "city": "string",
160 "consumerPriceIndexSourceType": "WEB",
161 "source": "string",
162 "formula": "string",
163 "indexedCurrency": true,
164 "exchangeRateType": "string",
165 "erpSystemId": 0,
166 "erpSystemDisplayId": "string",
167 "fromCurrencyId": 0,
168 "fromCurrencyDisplayId": "string",
169 "toCurrencyId": 0,
170 "toCurrencyDisplayId": "string",
171 "consumerPriceIndexValueId": "string",
172 "companyId": 0
173 }
174 },
175 "message": "string",
176 "messageIndexationDateLease": "string",
177 "messageIndexationDateNonLease": "string"
178 }
179]
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 "statusId": 0,
11 "planId": 0,
12 "cpiLeaseIndexationPreviewId": 0,
13 "messageCode": "string",
14 "delimitedArguments": "string",
15 "status": {
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 "priority": 0,
24 "internalId": 0,
25 "pickListCode": "string",
26 "pickListLabel": "string",
27 "label": "string",
28 "cultureId": 0,
29 "labelDtos": [
30 {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "cultureId": 0,
39 "value": "string"
40 }
41 ]
42 },
43 "cpiIndexationPlanDto": {
44 "createdBy": "string",
45 "lastModifiedBy": "string",
46 "createdDate": "2019-08-24T14:15:22Z",
47 "lastModifiedDate": "2019-08-24T14:15:22Z",
48 "archived": true,
49 "externalId": "string",
50 "id": 0,
51 "modificationDate": "2019-08-24",
52 "currencyId": 0,
53 "activationGroupId": 0,
54 "cpiGlobalCategoryId": 0,
55 "cpiGlobalCategoryIdNonLease": 0,
56 "cpiGlobalReferenceDate": "2019-08-24",
57 "cpiGlobalReferenceDateNonLease": "2019-08-24",
58 "cpiLocalCurrentIndexLevel": 0.1,
59 "cpiLocalCurrentIndexLevelNonLease": 0.1,
60 "conditionallyIndexed": true,
61 "applicableCurrentIndexLevel": 0.1,
62 "indexLevelPercentageChangeLowerBound": 0.1,
63 "indexLevelPercentageChangeUpperBound": 0.1,
64 "conditionallyIndexedNonLease": true,
65 "applicableCurrentIndexLevelNonLease": 0.1,
66 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
67 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
68 "statusId": 0,
69 "applyIndexationLease": true,
70 "indexationDateLease": "2019-08-24",
71 "applyIndexationNonLease": true,
72 "indexationDateNonLease": "2019-08-24",
73 "executionDate": "2019-08-24",
74 "executedModificationDate": "2019-08-24",
75 "executedIndexationDateLease": "2019-08-24",
76 "executedIndexationDateNonLease": "2019-08-24",
77 "messageCode": "string",
78 "messageCodeIndexationDateLease": "string",
79 "messageCodeIndexationDateNonLease": "string",
80 "status": {
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 "currency": {
109 "id": 0,
110 "status": "CREATED",
111 "displayId": "string",
112 "erpSystemId": 0,
113 "erpSystemDisplayId": "string",
114 "name": "string",
115 "decimalPoints": 0,
116 "depreciationAreaId": 0
117 },
118 "activationGroupDisplayId": "string",
119 "leaseId": 0,
120 "message": "string",
121 "messageIndexationDateLease": "string",
122 "messageIndexationDateNonLease": "string",
123 "cpiGlobalCategory": {
124 "id": 0,
125 "status": "CREATED",
126 "displayId": "string",
127 "name": "string",
128 "country": "string",
129 "province": "string",
130 "city": "string",
131 "consumerPriceIndexSourceType": "WEB",
132 "source": "string",
133 "formula": "string",
134 "indexedCurrency": true,
135 "exchangeRateType": "string",
136 "erpSystemId": 0,
137 "erpSystemDisplayId": "string",
138 "fromCurrencyId": 0,
139 "fromCurrencyDisplayId": "string",
140 "toCurrencyId": 0,
141 "toCurrencyDisplayId": "string",
142 "consumerPriceIndexValueId": "string",
143 "companyId": 0
144 },
145 "cpiGlobalCategoryNonLease": {
146 "id": 0,
147 "status": "CREATED",
148 "displayId": "string",
149 "name": "string",
150 "country": "string",
151 "province": "string",
152 "city": "string",
153 "consumerPriceIndexSourceType": "WEB",
154 "source": "string",
155 "formula": "string",
156 "indexedCurrency": true,
157 "exchangeRateType": "string",
158 "erpSystemId": 0,
159 "erpSystemDisplayId": "string",
160 "fromCurrencyId": 0,
161 "fromCurrencyDisplayId": "string",
162 "toCurrencyId": 0,
163 "toCurrencyDisplayId": "string",
164 "consumerPriceIndexValueId": "string",
165 "companyId": 0
166 }
167 },
168 "cpiLeaseIndexationPreviewDto": {
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 "statusId": 0,
177 "desiredModificationDate": "2019-08-24",
178 "actualModificationDate": "2019-08-24",
179 "desiredIndexationDateLease": "2019-08-24",
180 "actualIndexationDateLease": "2019-08-24",
181 "desiredIndexationDateNonLease": "2019-08-24",
182 "actualIndexationDateNonLease": "2019-08-24",
183 "messageCode": "string",
184 "delimitedArguments": "string",
185 "messageCodeIndexationDateLease": "string",
186 "messageCodeIndexationDateNonLease": "string",
187 "status": {
188 "createdBy": "string",
189 "lastModifiedBy": "string",
190 "createdDate": "2019-08-24T14:15:22Z",
191 "lastModifiedDate": "2019-08-24T14:15:22Z",
192 "archived": true,
193 "externalId": "string",
194 "id": 0,
195 "priority": 0,
196 "internalId": 0,
197 "pickListCode": "string",
198 "pickListLabel": "string",
199 "label": "string",
200 "cultureId": 0,
201 "labelDtos": [
202 {
203 "createdBy": "string",
204 "lastModifiedBy": "string",
205 "createdDate": "2019-08-24T14:15:22Z",
206 "lastModifiedDate": "2019-08-24T14:15:22Z",
207 "archived": true,
208 "externalId": "string",
209 "id": 0,
210 "cultureId": 0,
211 "value": "string"
212 }
213 ]
214 },
215 "cpiIndexationPlanId": 0,
216 "cpiIndexationPlanDto": {
217 "createdBy": "string",
218 "lastModifiedBy": "string",
219 "createdDate": "2019-08-24T14:15:22Z",
220 "lastModifiedDate": "2019-08-24T14:15:22Z",
221 "archived": true,
222 "externalId": "string",
223 "id": 0,
224 "modificationDate": "2019-08-24",
225 "currencyId": 0,
226 "activationGroupId": 0,
227 "cpiGlobalCategoryId": 0,
228 "cpiGlobalCategoryIdNonLease": 0,
229 "cpiGlobalReferenceDate": "2019-08-24",
230 "cpiGlobalReferenceDateNonLease": "2019-08-24",
231 "cpiLocalCurrentIndexLevel": 0.1,
232 "cpiLocalCurrentIndexLevelNonLease": 0.1,
233 "conditionallyIndexed": true,
234 "applicableCurrentIndexLevel": 0.1,
235 "indexLevelPercentageChangeLowerBound": 0.1,
236 "indexLevelPercentageChangeUpperBound": 0.1,
237 "conditionallyIndexedNonLease": true,
238 "applicableCurrentIndexLevelNonLease": 0.1,
239 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
240 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
241 "statusId": 0,
242 "applyIndexationLease": true,
243 "indexationDateLease": "2019-08-24",
244 "applyIndexationNonLease": true,
245 "indexationDateNonLease": "2019-08-24",
246 "executionDate": "2019-08-24",
247 "executedModificationDate": "2019-08-24",
248 "executedIndexationDateLease": "2019-08-24",
249 "executedIndexationDateNonLease": "2019-08-24",
250 "messageCode": "string",
251 "messageCodeIndexationDateLease": "string",
252 "messageCodeIndexationDateNonLease": "string",
253 "status": {
254 "createdBy": "string",
255 "lastModifiedBy": "string",
256 "createdDate": "2019-08-24T14:15:22Z",
257 "lastModifiedDate": "2019-08-24T14:15:22Z",
258 "archived": true,
259 "externalId": "string",
260 "id": 0,
261 "priority": 0,
262 "internalId": 0,
263 "pickListCode": "string",
264 "pickListLabel": "string",
265 "label": "string",
266 "cultureId": 0,
267 "labelDtos": [
268 {
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 "cultureId": 0,
277 "value": "string"
278 }
279 ]
280 },
281 "currency": {
282 "id": 0,
283 "status": "CREATED",
284 "displayId": "string",
285 "erpSystemId": 0,
286 "erpSystemDisplayId": "string",
287 "name": "string",
288 "decimalPoints": 0,
289 "depreciationAreaId": 0
290 },
291 "activationGroupDisplayId": "string",
292 "leaseId": 0,
293 "message": "string",
294 "messageIndexationDateLease": "string",
295 "messageIndexationDateNonLease": "string",
296 "cpiGlobalCategory": {
297 "id": 0,
298 "status": "CREATED",
299 "displayId": "string",
300 "name": "string",
301 "country": "string",
302 "province": "string",
303 "city": "string",
304 "consumerPriceIndexSourceType": "WEB",
305 "source": "string",
306 "formula": "string",
307 "indexedCurrency": true,
308 "exchangeRateType": "string",
309 "erpSystemId": 0,
310 "erpSystemDisplayId": "string",
311 "fromCurrencyId": 0,
312 "fromCurrencyDisplayId": "string",
313 "toCurrencyId": 0,
314 "toCurrencyDisplayId": "string",
315 "consumerPriceIndexValueId": "string",
316 "companyId": 0
317 },
318 "cpiGlobalCategoryNonLease": {
319 "id": 0,
320 "status": "CREATED",
321 "displayId": "string",
322 "name": "string",
323 "country": "string",
324 "province": "string",
325 "city": "string",
326 "consumerPriceIndexSourceType": "WEB",
327 "source": "string",
328 "formula": "string",
329 "indexedCurrency": true,
330 "exchangeRateType": "string",
331 "erpSystemId": 0,
332 "erpSystemDisplayId": "string",
333 "fromCurrencyId": 0,
334 "fromCurrencyDisplayId": "string",
335 "toCurrencyId": 0,
336 "toCurrencyDisplayId": "string",
337 "consumerPriceIndexValueId": "string",
338 "companyId": 0
339 }
340 },
341 "message": "string",
342 "messageIndexationDateLease": "string",
343 "messageIndexationDateNonLease": "string"
344 },
345 "message": "string"
346 }
347]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[CpiLeaseIndexationResultDto is a data transfer object that encapsulates the results of lease indexation calculations within the Nakisa Portfolio Management Suite, providing essential insights for portfolio and asset analytics in the real estate property sector.] |
|
» 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 |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» planId |
integer(int64) |
false |
none |
Unique identifier for the plan |
» cpiLeaseIndexationPreviewId |
integer(int64) |
false |
none |
Unique identifier for the cpi lease indexation preview |
» messageCode |
string |
false |
none |
Code for the message |
» delimitedArguments |
string |
false |
none |
DelimitedArguments is a string field that captures specific parameters for portfolio and asset analytics within the Nakisa Portfolio Management Suite, facilitating enhanced insights into real estate property performance. |
» 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. |
|
»» 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. |
» cpiIndexationPlanDto |
false |
none |
CpiIndexationPlanDto is a data transfer object that encapsulates the details of a Consumer Price Index (CPI) indexation plan, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite, particularly in the context of 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 |
»» modificationDate |
string(date) |
true |
none |
Date of the modification |
»» currencyId |
integer(int64) |
true |
none |
Unique identifier for the currency |
»» activationGroupId |
integer(int64) |
false |
none |
Unique identifier for the activation group |
»» cpiGlobalCategoryId |
integer(int64) |
false |
none |
Unique identifier for the cpi global category |
»» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
»» cpiGlobalReferenceDate |
string(date) |
false |
none |
Date of the cpi global reference |
»» cpiGlobalReferenceDateNonLease |
string(date) |
false |
none |
Represents the global reference date for non-lease related CPI adjustments within the context of portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
»» cpiLocalCurrentIndexLevel |
number(double) |
false |
none |
Value for cpiLocalCurrentIndexLevel field |
»» cpiLocalCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for cpiLocalCurrentIndexLevelNonLease field |
»» conditionallyIndexed |
boolean |
false |
none |
Indicates whether the indexation plan for the asset is subject to conditional indexing, impacting portfolio analytics and real estate property evaluations. |
»» applicableCurrentIndexLevel |
number(double) |
false |
none |
Value for applicableCurrentIndexLevel field |
»» indexLevelPercentageChangeLowerBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBound field |
»» indexLevelPercentageChangeUpperBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBound field |
»» conditionallyIndexedNonLease |
boolean |
false |
none |
Indicates whether the asset’s indexation is conditionally applied, relevant for portfolio analytics and real estate property management within the Nakisa Portfolio Management Suite. |
»» applicableCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for applicableCurrentIndexLevelNonLease field |
»» indexLevelPercentageChangeLowerBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBoundNonLease field |
»» indexLevelPercentageChangeUpperBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBoundNonLease field |
»» statusId |
integer(int64) |
true |
none |
Unique identifier for the status |
»» applyIndexationLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationLease status |
»» indexationDateLease |
string(date) |
false |
none |
Represents the date of indexation for lease agreements within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
»» indexationDateNonLease |
string(date) |
false |
none |
Represents the date of indexation for non-lease assets within the portfolio, facilitating accurate analytics and management of real estate properties. |
»» executionDate |
string(date) |
false |
none |
Date of the execution |
»» executedModificationDate |
string(date) |
false |
none |
Date of the executed modification |
»» executedIndexationDateLease |
string(date) |
false |
none |
Represents the date on which the lease indexation was executed, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» executedIndexationDateNonLease |
string(date) |
false |
none |
Date on which the non-lease indexation was executed, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageCode |
string |
false |
none |
Code for the message |
»» messageCodeIndexationDateLease |
string |
false |
none |
Represents the date of indexation for the lease message code, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageCodeIndexationDateNonLease |
string |
false |
none |
Date indicating when the message code for non-lease indexation was recorded, relevant for portfolio and asset analytics 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. |
|
»» currency |
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 |
»» activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
»» leaseId |
integer(int64) |
true |
none |
Unique identifier for the lease |
»» message |
string |
false |
none |
Descriptive text providing insights or comments related to the portfolio asset’s indexation plan within the Nakisa Portfolio Management Suite. |
»» messageIndexationDateLease |
string |
false |
none |
Represents the date when the message indexation lease is established, facilitating accurate tracking and analytics within the Nakisa Portfolio Management Suite for portfolio and asset management. |
»» messageIndexationDateNonLease |
string |
false |
none |
Represents the date of message indexation for non-lease assets within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in the real estate sector. |
»» cpiGlobalCategory |
false |
none |
Data transfer object representing a category within the Consumer Price Index, utilized for portfolio and asset analytics in the Nakisa Portfolio Management Suite, specifically tailored for real estate property assessments. |
|
»»» 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 |
»»» name |
string |
true |
none |
Name of the resource |
»»» country |
string |
true |
none |
Represents the country associated with the consumer price index category, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»» province |
string |
true |
none |
Represents the province associated with the real estate property, facilitating portfolio analysis and asset management within the Nakisa Portfolio Management Suite. |
»»» city |
string |
true |
none |
Represents the city associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
»»» consumerPriceIndexSourceType |
string |
true |
none |
Type of the consumer price index source |
»»» source |
string |
true |
none |
Indicates the origin of the consumer price index category, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»» formula |
string |
false |
none |
String representation of the formula used for calculating the Consumer Price Index within the context of portfolio analytics and real estate asset management. |
»»» indexedCurrency |
boolean |
true |
none |
Boolean flag indicating indexedCurrency status |
»»» exchangeRateType |
string |
false |
none |
Type of the exchange rate |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» fromCurrencyId |
integer(int64) |
false |
none |
Unique identifier for the from currency |
»»» fromCurrencyDisplayId |
string |
false |
none |
Unique identifier for the from currency display |
»»» toCurrencyId |
integer(int64) |
false |
none |
Unique identifier for the to currency |
»»» toCurrencyDisplayId |
string |
false |
none |
Unique identifier for the to currency display |
»»» consumerPriceIndexValueId |
string |
false |
none |
Unique identifier for the consumer price index value |
»»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»» cpiGlobalCategoryNonLease |
false |
none |
Data transfer object representing a category within the Consumer Price Index, utilized for portfolio and asset analytics in the Nakisa Portfolio Management Suite, specifically tailored for real estate property assessments. |
|
» cpiLeaseIndexationPreviewDto |
false |
none |
CpiLeaseIndexationPreviewDto is a data transfer object that provides a preview of lease indexation calculations within the Nakisa Portfolio Management Suite, facilitating informed decision-making for portfolio and asset management in the real estate sector. |
|
»» 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 |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» desiredModificationDate |
string(date) |
false |
none |
Date of the desired modification |
»» actualModificationDate |
string(date) |
false |
none |
Date of the actual modification |
»» desiredIndexationDateLease |
string(date) |
false |
none |
Specifies the desired indexation date for lease agreements within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»» actualIndexationDateLease |
string(date) |
false |
none |
Represents the actual date of indexation for a lease, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» desiredIndexationDateNonLease |
string(date) |
false |
none |
Specifies the desired indexation date for non-lease assets within the portfolio, facilitating accurate analytics and reporting in real estate property management. |
»» actualIndexationDateNonLease |
string(date) |
false |
none |
Represents the actual date of indexation for non-lease assets within the portfolio, facilitating accurate analytics and reporting in real estate property management. |
»» messageCode |
string |
false |
none |
Code for the message |
»» delimitedArguments |
string |
false |
none |
String representation of the delimited arguments used for calculating lease indexation previews within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, and real estate property analytics. |
»» messageCodeIndexationDateLease |
string |
false |
none |
Represents the date of indexation for the lease message code, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageCodeIndexationDateNonLease |
string |
false |
none |
Date indicating when the message code related to non-lease indexation was last indexed, relevant for portfolio and asset analytics 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. |
|
»» cpiIndexationPlanId |
integer(int64) |
false |
none |
Unique identifier for the cpi indexation plan |
»» cpiIndexationPlanDto |
false |
none |
CpiIndexationPlanDto is a data transfer object that encapsulates the details of a Consumer Price Index (CPI) indexation plan, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite, particularly in the context of real estate property analytics. |
|
»» message |
string |
false |
none |
Textual representation of the message associated with the lease indexation preview, providing insights relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageIndexationDateLease |
string |
false |
none |
Represents the date on which the message indexation lease is established, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageIndexationDateNonLease |
string |
false |
none |
Represents the date of message indexation for non-lease assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
» message |
string |
false |
none |
Textual representation of the message associated with the lease indexation result, providing insights relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Enumerated Values
Attribute |
Value |
|---|---|
consumerPriceIndexSourceType |
EXCEL, WEB |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Get Documents For Lease¶
HTTP Request
GET /api/leases/{leaseId}/documents
📋 Description: Retrieves all documents associated with a specific lease identified by the leaseId, providing essential information for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of lease documents within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific documents related to a lease within the Nakisa Portfolio Management Suite. |
id |
query |
string |
false |
Unique identifier for the resource |
status-id |
query |
string |
false |
Unique identifier for the status of the lease document, facilitating effective tracking and management within the Nakisa Portfolio Management Suite. |
signed-date |
query |
string |
false |
Specifies the date on which the lease document was signed, providing essential context for portfolio and asset management analytics 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 lease documents are shareable, facilitating collaboration and access within the context of portfolio and asset management in real estate analytics. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with a specific lease, facilitating efficient management and analysis of real estate assets within the Nakisa Portfolio Management Suite. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with a specific lease, facilitating precise retrieval of relevant 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}
Lease - Upload Lease Document¶
HTTP Request
POST /api/leases/{leaseId}/documents
📋 Description: Uploads documents associated with a specific lease in the Nakisa Portfolio Management Suite, enhancing portfolio and asset management capabilities within the real estate property analytics framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
body |
body |
object |
false |
Request body containing the document details, including type, description, and associated metadata, for the specified lease within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
false |
none |
» document |
body |
true |
Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties. |
|
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»» externalId |
body |
string |
false |
Unique identifier for the external |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» title |
body |
string |
false |
Title of the resource |
»» type |
body |
string |
false |
Type of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» link |
body |
string |
false |
URL link to access detailed information or resources related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»» signedDate |
body |
string(date) |
false |
Date of the signed |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» statusId |
body |
integer(int64) |
false |
Unique identifier for the status |
»» shareable |
body |
boolean |
false |
Boolean flag indicating shareable status |
»» size |
body |
integer(int64) |
false |
Number of items per page |
»» documentType |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» priority |
body |
integer(int64) |
false |
Priority of the resource |
»»» internalId |
body |
integer(int64) |
false |
Unique identifier for the internal |
»»» pickListCode |
body |
string |
false |
Code for the pick list |
»»» pickListLabel |
body |
string |
false |
Label for the pick list |
»»» label |
body |
string |
false |
Label for the resource |
»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»» labelDtos |
body |
false |
List of labelDtos items |
|
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»»» value |
body |
string |
true |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
»» status |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
Body Parameters
1{
2 "document": {
3 "archived": true,
4 "createdBy": "string",
5 "createdDate": "2019-08-24 14:15:22+00:00",
6 "description": "string",
7 "documentType": {
8 "archived": true,
9 "createdBy": "string",
10 "createdDate": "2019-08-24 14:15:22+00:00",
11 "cultureId": 0,
12 "externalId": "string",
13 "id": 0,
14 "internalId": 0,
15 "label": "string",
16 "labelDtos": [
17 {
18 "archived": true,
19 "createdBy": "string",
20 "createdDate": "2019-08-24 14:15:22+00:00",
21 "cultureId": 0,
22 "externalId": "string",
23 "id": 0,
24 "lastModifiedBy": "string",
25 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26 "value": "string"
27 }
28 ],
29 "lastModifiedBy": "string",
30 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "priority": 0
34 },
35 "documentTypeId": 0,
36 "externalId": "string",
37 "id": 0,
38 "lastModifiedBy": "string",
39 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40 "link": "string",
41 "name": "string",
42 "shareable": true,
43 "signedDate": "2019-08-24",
44 "size": 0,
45 "status": {
46 "archived": true,
47 "createdBy": "string",
48 "createdDate": "2019-08-24 14:15:22+00:00",
49 "cultureId": 0,
50 "externalId": "string",
51 "id": 0,
52 "internalId": 0,
53 "label": "string",
54 "labelDtos": [
55 {
56 "archived": true,
57 "createdBy": "string",
58 "createdDate": "2019-08-24 14:15:22+00:00",
59 "cultureId": 0,
60 "externalId": "string",
61 "id": 0,
62 "lastModifiedBy": "string",
63 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64 "value": "string"
65 }
66 ],
67 "lastModifiedBy": "string",
68 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69 "pickListCode": "string",
70 "pickListLabel": "string",
71 "priority": 0
72 },
73 "statusId": 0,
74 "title": "string",
75 "type": "string"
76 },
77 "file": "string"
78}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "name": "string",
10 "title": "string",
11 "type": "string",
12 "description": "string",
13 "link": "string",
14 "signedDate": "2019-08-24",
15 "documentTypeId": 0,
16 "statusId": 0,
17 "shareable": true,
18 "size": 0,
19 "documentType": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "priority": 0,
28 "internalId": 0,
29 "pickListCode": "string",
30 "pickListLabel": "string",
31 "label": "string",
32 "cultureId": 0,
33 "labelDtos": [
34 {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "cultureId": 0,
43 "value": "string"
44 }
45 ]
46 },
47 "status": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 }
75}
Lease - Get CPI Indexation Plans Forlease¶
HTTP Request
GET /api/leases/{leaseId}/cpi-indexation-plans
📋 Description: Fetches the Consumer Price Index (CPI) indexation plans associated with a specific lease, enabling users to analyze potential adjustments in lease terms within the context of real estate portfolio management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of CPI indexation plans associated with a specific lease within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "cpiIndexationPlans": [
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 "modificationDate": "2019-08-24",
13 "currencyId": 0,
14 "activationGroupId": 0,
15 "cpiGlobalCategoryId": 0,
16 "cpiGlobalCategoryIdNonLease": 0,
17 "cpiGlobalReferenceDate": "2019-08-24",
18 "cpiGlobalReferenceDateNonLease": "2019-08-24",
19 "cpiLocalCurrentIndexLevel": 0.1,
20 "cpiLocalCurrentIndexLevelNonLease": 0.1,
21 "conditionallyIndexed": true,
22 "applicableCurrentIndexLevel": 0.1,
23 "indexLevelPercentageChangeLowerBound": 0.1,
24 "indexLevelPercentageChangeUpperBound": 0.1,
25 "conditionallyIndexedNonLease": true,
26 "applicableCurrentIndexLevelNonLease": 0.1,
27 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
28 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
29 "statusId": 0,
30 "applyIndexationLease": true,
31 "indexationDateLease": "2019-08-24",
32 "applyIndexationNonLease": true,
33 "indexationDateNonLease": "2019-08-24",
34 "executionDate": "2019-08-24",
35 "executedModificationDate": "2019-08-24",
36 "executedIndexationDateLease": "2019-08-24",
37 "executedIndexationDateNonLease": "2019-08-24",
38 "messageCode": "string",
39 "messageCodeIndexationDateLease": "string",
40 "messageCodeIndexationDateNonLease": "string",
41 "status": {
42 "createdBy": "string",
43 "lastModifiedBy": "string",
44 "createdDate": "2019-08-24T14:15:22Z",
45 "lastModifiedDate": "2019-08-24T14:15:22Z",
46 "archived": true,
47 "externalId": "string",
48 "id": 0,
49 "priority": 0,
50 "internalId": 0,
51 "pickListCode": "string",
52 "pickListLabel": "string",
53 "label": "string",
54 "cultureId": 0,
55 "labelDtos": [
56 {
57 "createdBy": "string",
58 "lastModifiedBy": "string",
59 "createdDate": "2019-08-24T14:15:22Z",
60 "lastModifiedDate": "2019-08-24T14:15:22Z",
61 "archived": true,
62 "externalId": "string",
63 "id": 0,
64 "cultureId": 0,
65 "value": "string"
66 }
67 ]
68 },
69 "currency": {
70 "id": 0,
71 "status": "CREATED",
72 "displayId": "string",
73 "erpSystemId": 0,
74 "erpSystemDisplayId": "string",
75 "name": "string",
76 "decimalPoints": 0,
77 "depreciationAreaId": 0
78 },
79 "activationGroupDisplayId": "string",
80 "leaseId": 0,
81 "message": "string",
82 "messageIndexationDateLease": "string",
83 "messageIndexationDateNonLease": "string",
84 "cpiGlobalCategory": {
85 "id": 0,
86 "status": "CREATED",
87 "displayId": "string",
88 "name": "string",
89 "country": "string",
90 "province": "string",
91 "city": "string",
92 "consumerPriceIndexSourceType": "WEB",
93 "source": "string",
94 "formula": "string",
95 "indexedCurrency": true,
96 "exchangeRateType": "string",
97 "erpSystemId": 0,
98 "erpSystemDisplayId": "string",
99 "fromCurrencyId": 0,
100 "fromCurrencyDisplayId": "string",
101 "toCurrencyId": 0,
102 "toCurrencyDisplayId": "string",
103 "consumerPriceIndexValueId": "string",
104 "companyId": 0
105 },
106 "cpiGlobalCategoryNonLease": {
107 "id": 0,
108 "status": "CREATED",
109 "displayId": "string",
110 "name": "string",
111 "country": "string",
112 "province": "string",
113 "city": "string",
114 "consumerPriceIndexSourceType": "WEB",
115 "source": "string",
116 "formula": "string",
117 "indexedCurrency": true,
118 "exchangeRateType": "string",
119 "erpSystemId": 0,
120 "erpSystemDisplayId": "string",
121 "fromCurrencyId": 0,
122 "fromCurrencyDisplayId": "string",
123 "toCurrencyId": 0,
124 "toCurrencyDisplayId": "string",
125 "consumerPriceIndexValueId": "string",
126 "companyId": 0
127 }
128 }
129 ]
130 },
131 "page": {
132 "size": 0,
133 "totalElements": 0,
134 "totalPages": 0,
135 "number": 0
136 }
137}
Lease - Create Lease CPI Indexation Plans¶
HTTP Request
POST /api/leases/{leaseId}/cpi-indexation-plans
📋 Description: Creates a new Consumer Price Index (CPI) indexation plan for a specified lease, enabling effective management of lease adjustments within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
body |
body |
true |
Request body containing the CPI indexation plan details, including adjustment parameters and effective dates, relevant for managing lease agreements 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 "modificationDate": "2019-08-24",
11 "currencyId": 0,
12 "activationGroupId": 0,
13 "cpiGlobalCategoryId": 0,
14 "cpiGlobalCategoryIdNonLease": 0,
15 "cpiGlobalReferenceDate": "2019-08-24",
16 "cpiGlobalReferenceDateNonLease": "2019-08-24",
17 "cpiLocalCurrentIndexLevel": 0.1,
18 "cpiLocalCurrentIndexLevelNonLease": 0.1,
19 "conditionallyIndexed": true,
20 "applicableCurrentIndexLevel": 0.1,
21 "indexLevelPercentageChangeLowerBound": 0.1,
22 "indexLevelPercentageChangeUpperBound": 0.1,
23 "conditionallyIndexedNonLease": true,
24 "applicableCurrentIndexLevelNonLease": 0.1,
25 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
26 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
27 "statusId": 0,
28 "applyIndexationLease": true,
29 "indexationDateLease": "2019-08-24",
30 "applyIndexationNonLease": true,
31 "indexationDateNonLease": "2019-08-24",
32 "executionDate": "2019-08-24",
33 "executedModificationDate": "2019-08-24",
34 "executedIndexationDateLease": "2019-08-24",
35 "executedIndexationDateNonLease": "2019-08-24",
36 "messageCode": "string",
37 "messageCodeIndexationDateLease": "string",
38 "messageCodeIndexationDateNonLease": "string",
39 "status": {
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 "priority": 0,
48 "internalId": 0,
49 "pickListCode": "string",
50 "pickListLabel": "string",
51 "label": "string",
52 "cultureId": 0,
53 "labelDtos": [
54 {
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 "cultureId": 0,
63 "value": "string"
64 }
65 ]
66 },
67 "currency": {
68 "id": 0,
69 "status": "CREATED",
70 "displayId": "string",
71 "erpSystemId": 0,
72 "erpSystemDisplayId": "string",
73 "name": "string",
74 "decimalPoints": 0,
75 "depreciationAreaId": 0
76 },
77 "activationGroupDisplayId": "string",
78 "leaseId": 0,
79 "message": "string",
80 "messageIndexationDateLease": "string",
81 "messageIndexationDateNonLease": "string",
82 "cpiGlobalCategory": {
83 "id": 0,
84 "status": "CREATED",
85 "displayId": "string",
86 "name": "string",
87 "country": "string",
88 "province": "string",
89 "city": "string",
90 "consumerPriceIndexSourceType": "WEB",
91 "source": "string",
92 "formula": "string",
93 "indexedCurrency": true,
94 "exchangeRateType": "string",
95 "erpSystemId": 0,
96 "erpSystemDisplayId": "string",
97 "fromCurrencyId": 0,
98 "fromCurrencyDisplayId": "string",
99 "toCurrencyId": 0,
100 "toCurrencyDisplayId": "string",
101 "consumerPriceIndexValueId": "string",
102 "companyId": 0
103 },
104 "cpiGlobalCategoryNonLease": {
105 "id": 0,
106 "status": "CREATED",
107 "displayId": "string",
108 "name": "string",
109 "country": "string",
110 "province": "string",
111 "city": "string",
112 "consumerPriceIndexSourceType": "WEB",
113 "source": "string",
114 "formula": "string",
115 "indexedCurrency": true,
116 "exchangeRateType": "string",
117 "erpSystemId": 0,
118 "erpSystemDisplayId": "string",
119 "fromCurrencyId": 0,
120 "fromCurrencyDisplayId": "string",
121 "toCurrencyId": 0,
122 "toCurrencyDisplayId": "string",
123 "consumerPriceIndexValueId": "string",
124 "companyId": 0
125 }
126 }
127]
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 "modificationDate": "2019-08-24",
11 "currencyId": 0,
12 "activationGroupId": 0,
13 "cpiGlobalCategoryId": 0,
14 "cpiGlobalCategoryIdNonLease": 0,
15 "cpiGlobalReferenceDate": "2019-08-24",
16 "cpiGlobalReferenceDateNonLease": "2019-08-24",
17 "cpiLocalCurrentIndexLevel": 0.1,
18 "cpiLocalCurrentIndexLevelNonLease": 0.1,
19 "conditionallyIndexed": true,
20 "applicableCurrentIndexLevel": 0.1,
21 "indexLevelPercentageChangeLowerBound": 0.1,
22 "indexLevelPercentageChangeUpperBound": 0.1,
23 "conditionallyIndexedNonLease": true,
24 "applicableCurrentIndexLevelNonLease": 0.1,
25 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
26 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
27 "statusId": 0,
28 "applyIndexationLease": true,
29 "indexationDateLease": "2019-08-24",
30 "applyIndexationNonLease": true,
31 "indexationDateNonLease": "2019-08-24",
32 "executionDate": "2019-08-24",
33 "executedModificationDate": "2019-08-24",
34 "executedIndexationDateLease": "2019-08-24",
35 "executedIndexationDateNonLease": "2019-08-24",
36 "messageCode": "string",
37 "messageCodeIndexationDateLease": "string",
38 "messageCodeIndexationDateNonLease": "string",
39 "status": {
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 "priority": 0,
48 "internalId": 0,
49 "pickListCode": "string",
50 "pickListLabel": "string",
51 "label": "string",
52 "cultureId": 0,
53 "labelDtos": [
54 {
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 "cultureId": 0,
63 "value": "string"
64 }
65 ]
66 },
67 "currency": {
68 "id": 0,
69 "status": "CREATED",
70 "displayId": "string",
71 "erpSystemId": 0,
72 "erpSystemDisplayId": "string",
73 "name": "string",
74 "decimalPoints": 0,
75 "depreciationAreaId": 0
76 },
77 "activationGroupDisplayId": "string",
78 "leaseId": 0,
79 "message": "string",
80 "messageIndexationDateLease": "string",
81 "messageIndexationDateNonLease": "string",
82 "cpiGlobalCategory": {
83 "id": 0,
84 "status": "CREATED",
85 "displayId": "string",
86 "name": "string",
87 "country": "string",
88 "province": "string",
89 "city": "string",
90 "consumerPriceIndexSourceType": "WEB",
91 "source": "string",
92 "formula": "string",
93 "indexedCurrency": true,
94 "exchangeRateType": "string",
95 "erpSystemId": 0,
96 "erpSystemDisplayId": "string",
97 "fromCurrencyId": 0,
98 "fromCurrencyDisplayId": "string",
99 "toCurrencyId": 0,
100 "toCurrencyDisplayId": "string",
101 "consumerPriceIndexValueId": "string",
102 "companyId": 0
103 },
104 "cpiGlobalCategoryNonLease": {
105 "id": 0,
106 "status": "CREATED",
107 "displayId": "string",
108 "name": "string",
109 "country": "string",
110 "province": "string",
111 "city": "string",
112 "consumerPriceIndexSourceType": "WEB",
113 "source": "string",
114 "formula": "string",
115 "indexedCurrency": true,
116 "exchangeRateType": "string",
117 "erpSystemId": 0,
118 "erpSystemDisplayId": "string",
119 "fromCurrencyId": 0,
120 "fromCurrencyDisplayId": "string",
121 "toCurrencyId": 0,
122 "toCurrencyDisplayId": "string",
123 "consumerPriceIndexValueId": "string",
124 "companyId": 0
125 }
126 }
127]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[CpiIndexationPlanDto is a data transfer object that encapsulates the details of a Consumer Price Index (CPI) indexation plan, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite, particularly in the context of 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 |
» modificationDate |
string(date) |
true |
none |
Date of the modification |
» currencyId |
integer(int64) |
true |
none |
Unique identifier for the currency |
» activationGroupId |
integer(int64) |
false |
none |
Unique identifier for the activation group |
» cpiGlobalCategoryId |
integer(int64) |
false |
none |
Unique identifier for the cpi global category |
» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
» cpiGlobalReferenceDate |
string(date) |
false |
none |
Date of the cpi global reference |
» cpiGlobalReferenceDateNonLease |
string(date) |
false |
none |
Represents the global reference date for non-lease related CPI adjustments within the context of portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
» cpiLocalCurrentIndexLevel |
number(double) |
false |
none |
Value for cpiLocalCurrentIndexLevel field |
» cpiLocalCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for cpiLocalCurrentIndexLevelNonLease field |
» conditionallyIndexed |
boolean |
false |
none |
Indicates whether the indexation plan for the asset is subject to conditional indexing, impacting portfolio analytics and real estate property evaluations. |
» applicableCurrentIndexLevel |
number(double) |
false |
none |
Value for applicableCurrentIndexLevel field |
» indexLevelPercentageChangeLowerBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBound field |
» indexLevelPercentageChangeUpperBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBound field |
» conditionallyIndexedNonLease |
boolean |
false |
none |
Indicates whether the asset’s indexation is conditionally applied, relevant for portfolio analytics and real estate property management within the Nakisa Portfolio Management Suite. |
» applicableCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for applicableCurrentIndexLevelNonLease field |
» indexLevelPercentageChangeLowerBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBoundNonLease field |
» indexLevelPercentageChangeUpperBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBoundNonLease field |
» statusId |
integer(int64) |
true |
none |
Unique identifier for the status |
» applyIndexationLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationLease status |
» indexationDateLease |
string(date) |
false |
none |
Represents the date of indexation for lease agreements within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
» indexationDateNonLease |
string(date) |
false |
none |
Represents the date of indexation for non-lease assets within the portfolio, facilitating accurate analytics and management of real estate properties. |
» executionDate |
string(date) |
false |
none |
Date of the execution |
» executedModificationDate |
string(date) |
false |
none |
Date of the executed modification |
» executedIndexationDateLease |
string(date) |
false |
none |
Represents the date on which the lease indexation was executed, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» executedIndexationDateNonLease |
string(date) |
false |
none |
Date on which the non-lease indexation was executed, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» messageCode |
string |
false |
none |
Code for the message |
» messageCodeIndexationDateLease |
string |
false |
none |
Represents the date of indexation for the lease message code, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» messageCodeIndexationDateNonLease |
string |
false |
none |
Date indicating when the message code for non-lease indexation was recorded, relevant for portfolio and asset analytics 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. |
|
»» 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. |
» currency |
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 |
» activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
» leaseId |
integer(int64) |
true |
none |
Unique identifier for the lease |
» message |
string |
false |
none |
Descriptive text providing insights or comments related to the portfolio asset’s indexation plan within the Nakisa Portfolio Management Suite. |
» messageIndexationDateLease |
string |
false |
none |
Represents the date when the message indexation lease is established, facilitating accurate tracking and analytics within the Nakisa Portfolio Management Suite for portfolio and asset management. |
» messageIndexationDateNonLease |
string |
false |
none |
Represents the date of message indexation for non-lease assets within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in the real estate sector. |
» cpiGlobalCategory |
false |
none |
Data transfer object representing a category within the Consumer Price Index, utilized for portfolio and asset analytics in the Nakisa Portfolio Management Suite, specifically tailored for real estate property assessments. |
|
»» 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 |
»» name |
string |
true |
none |
Name of the resource |
»» country |
string |
true |
none |
Represents the country associated with the consumer price index category, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» province |
string |
true |
none |
Represents the province associated with the real estate property, facilitating portfolio analysis and asset management within the Nakisa Portfolio Management Suite. |
»» city |
string |
true |
none |
Represents the city associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
»» consumerPriceIndexSourceType |
string |
true |
none |
Type of the consumer price index source |
»» source |
string |
true |
none |
Indicates the origin of the consumer price index category, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» formula |
string |
false |
none |
String representation of the formula used for calculating the Consumer Price Index within the context of portfolio analytics and real estate asset management. |
»» indexedCurrency |
boolean |
true |
none |
Boolean flag indicating indexedCurrency status |
»» exchangeRateType |
string |
false |
none |
Type of the exchange rate |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»» fromCurrencyId |
integer(int64) |
false |
none |
Unique identifier for the from currency |
»» fromCurrencyDisplayId |
string |
false |
none |
Unique identifier for the from currency display |
»» toCurrencyId |
integer(int64) |
false |
none |
Unique identifier for the to currency |
»» toCurrencyDisplayId |
string |
false |
none |
Unique identifier for the to currency display |
»» consumerPriceIndexValueId |
string |
false |
none |
Unique identifier for the consumer price index value |
»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
» cpiGlobalCategoryNonLease |
false |
none |
Data transfer object representing a category within the Consumer Price Index, utilized for portfolio and asset analytics in the Nakisa Portfolio Management Suite, specifically tailored for real estate property assessments. |
Enumerated Values
Attribute |
Value |
|---|---|
consumerPriceIndexSourceType |
EXCEL, WEB |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Copy Lease And Assign To Premise¶
HTTP Request
POST /api/leases/{leaseId}/clone
📋 Description: Clones an existing lease identified by the specified leaseId, facilitating efficient management of portfolio assets within the Nakisa Portfolio Management Suite. This operation streamlines the process of creating similar lease agreements, enhancing real estate property analytics and portfolio oversight.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
body |
body |
true |
Request body containing the lease details to be cloned, including asset information and relevant metadata for portfolio management and analytics. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "scenario": true,
287 "isVisibleVendorPortal": true,
288 "isTerminationVersion": true,
289 "terminationDate": "2019-08-24",
290 "penaltyAmount": 0.1,
291 "areasHistoryVersionId": 0
292 },
293 "premiseDto": {
294 "createdBy": "string",
295 "lastModifiedBy": "string",
296 "createdDate": "2019-08-24T14:15:22Z",
297 "lastModifiedDate": "2019-08-24T14:15:22Z",
298 "archived": true,
299 "externalId": "string",
300 "id": 0,
301 "number": "string",
302 "name": "string",
303 "headPremise": true,
304 "possessionDate": "2019-08-24",
305 "openingDate": "2019-08-24",
306 "closingDate": "2019-08-24",
307 "relocationDate": "2019-08-24",
308 "vacatingDate": "2019-08-24",
309 "expansionDate": "2019-08-24",
310 "statusId": 0,
311 "usageId": 0,
312 "parentPremiseId": 0,
313 "costCenterId": 0,
314 "profitCenterId": 0,
315 "legalEntityId": 0,
316 "occupancyIds": [
317 0
318 ],
319 "locationId": 0,
320 "locationDto": {
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 "number": "string",
329 "name": "string",
330 "storeNumber": "string",
331 "defaultCurrencyId": 0,
332 "defaultMeasureId": 0,
333 "typeId": 0,
334 "qualityId": 0,
335 "propertyTypeId": 0,
336 "categoryId": 0,
337 "statusId": 0,
338 "businessUnitId": 0,
339 "groupIds": [
340 0
341 ],
342 "legalEntityIds": [
343 0
344 ],
345 "defaultCurrency": {
346 "id": 0,
347 "status": "CREATED",
348 "displayId": "string",
349 "erpSystemId": 0,
350 "erpSystemDisplayId": "string",
351 "name": "string",
352 "decimalPoints": 0,
353 "depreciationAreaId": 0
354 },
355 "defaultUnitValue": {
356 "createdBy": "string",
357 "lastModifiedBy": "string",
358 "createdDate": "2019-08-24T14:15:22Z",
359 "lastModifiedDate": "2019-08-24T14:15:22Z",
360 "archived": true,
361 "externalId": "string",
362 "id": 0,
363 "unitId": 0,
364 "unitOfMeasureId": 0,
365 "erpSystemId": 0,
366 "unit": {
367 "createdBy": "string",
368 "lastModifiedBy": "string",
369 "createdDate": "2019-08-24T14:15:22Z",
370 "lastModifiedDate": "2019-08-24T14:15:22Z",
371 "archived": true,
372 "externalId": "string",
373 "id": 0,
374 "priority": 0,
375 "internalId": 0,
376 "pickListCode": "string",
377 "pickListLabel": "string",
378 "label": "string",
379 "cultureId": 0,
380 "labelDtos": [
381 {
382 "createdBy": "string",
383 "lastModifiedBy": "string",
384 "createdDate": "2019-08-24T14:15:22Z",
385 "lastModifiedDate": "2019-08-24T14:15:22Z",
386 "archived": true,
387 "externalId": "string",
388 "id": 0,
389 "cultureId": 0,
390 "value": "string"
391 }
392 ]
393 },
394 "unitOfMeasure": {
395 "id": 0,
396 "status": "CREATED",
397 "displayId": "string",
398 "erpSystemId": 0,
399 "erpSystemDisplayId": "string",
400 "name": "string"
401 }
402 },
403 "type": {
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 "priority": 0,
412 "internalId": 0,
413 "pickListCode": "string",
414 "pickListLabel": "string",
415 "label": "string",
416 "cultureId": 0,
417 "labelDtos": [
418 {
419 "createdBy": "string",
420 "lastModifiedBy": "string",
421 "createdDate": "2019-08-24T14:15:22Z",
422 "lastModifiedDate": "2019-08-24T14:15:22Z",
423 "archived": true,
424 "externalId": "string",
425 "id": 0,
426 "cultureId": 0,
427 "value": "string"
428 }
429 ]
430 },
431 "quality": {
432 "createdBy": "string",
433 "lastModifiedBy": "string",
434 "createdDate": "2019-08-24T14:15:22Z",
435 "lastModifiedDate": "2019-08-24T14:15:22Z",
436 "archived": true,
437 "externalId": "string",
438 "id": 0,
439 "priority": 0,
440 "internalId": 0,
441 "pickListCode": "string",
442 "pickListLabel": "string",
443 "label": "string",
444 "cultureId": 0,
445 "labelDtos": [
446 {
447 "createdBy": "string",
448 "lastModifiedBy": "string",
449 "createdDate": "2019-08-24T14:15:22Z",
450 "lastModifiedDate": "2019-08-24T14:15:22Z",
451 "archived": true,
452 "externalId": "string",
453 "id": 0,
454 "cultureId": 0,
455 "value": "string"
456 }
457 ]
458 },
459 "propertyType": {
460 "createdBy": "string",
461 "lastModifiedBy": "string",
462 "createdDate": "2019-08-24T14:15:22Z",
463 "lastModifiedDate": "2019-08-24T14:15:22Z",
464 "archived": true,
465 "externalId": "string",
466 "id": 0,
467 "priority": 0,
468 "internalId": 0,
469 "pickListCode": "string",
470 "pickListLabel": "string",
471 "label": "string",
472 "cultureId": 0,
473 "labelDtos": [
474 {
475 "createdBy": "string",
476 "lastModifiedBy": "string",
477 "createdDate": "2019-08-24T14:15:22Z",
478 "lastModifiedDate": "2019-08-24T14:15:22Z",
479 "archived": true,
480 "externalId": "string",
481 "id": 0,
482 "cultureId": 0,
483 "value": "string"
484 }
485 ]
486 },
487 "category": {
488 "createdBy": "string",
489 "lastModifiedBy": "string",
490 "createdDate": "2019-08-24T14:15:22Z",
491 "lastModifiedDate": "2019-08-24T14:15:22Z",
492 "archived": true,
493 "externalId": "string",
494 "id": 0,
495 "priority": 0,
496 "internalId": 0,
497 "pickListCode": "string",
498 "pickListLabel": "string",
499 "label": "string",
500 "cultureId": 0,
501 "labelDtos": [
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 "cultureId": 0,
511 "value": "string"
512 }
513 ]
514 },
515 "status": {
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 "priority": 0,
524 "internalId": 0,
525 "pickListCode": "string",
526 "pickListLabel": "string",
527 "label": "string",
528 "cultureId": 0,
529 "labelDtos": [
530 {
531 "createdBy": "string",
532 "lastModifiedBy": "string",
533 "createdDate": "2019-08-24T14:15:22Z",
534 "lastModifiedDate": "2019-08-24T14:15:22Z",
535 "archived": true,
536 "externalId": "string",
537 "id": 0,
538 "cultureId": 0,
539 "value": "string"
540 }
541 ]
542 },
543 "addressDto": {
544 "createdBy": "string",
545 "lastModifiedBy": "string",
546 "createdDate": "2019-08-24T14:15:22Z",
547 "lastModifiedDate": "2019-08-24T14:15:22Z",
548 "archived": true,
549 "externalId": "string",
550 "id": 0,
551 "street": "string",
552 "civicNumber": "string",
553 "suite": "string",
554 "postalCode": "string",
555 "lon": 0.1,
556 "lat": 0.1,
557 "city": {
558 "createdBy": "string",
559 "lastModifiedBy": "string",
560 "createdDate": "2019-08-24T14:15:22Z",
561 "lastModifiedDate": "2019-08-24T14:15:22Z",
562 "archived": true,
563 "externalId": "string",
564 "id": 0,
565 "name": "string",
566 "province": {
567 "createdBy": "string",
568 "lastModifiedBy": "string",
569 "createdDate": "2019-08-24T14:15:22Z",
570 "lastModifiedDate": "2019-08-24T14:15:22Z",
571 "archived": true,
572 "externalId": "string",
573 "id": 0,
574 "name": "string",
575 "code": "string",
576 "country": {
577 "createdBy": "string",
578 "lastModifiedBy": "string",
579 "createdDate": "2019-08-24T14:15:22Z",
580 "lastModifiedDate": "2019-08-24T14:15:22Z",
581 "archived": true,
582 "externalId": "string",
583 "id": 0,
584 "name": "string",
585 "code": "string"
586 },
587 "provinceCountryKey": "string"
588 },
589 "cityProvinceCountryKey": "string"
590 },
591 "district": {
592 "createdBy": "string",
593 "lastModifiedBy": "string",
594 "createdDate": "2019-08-24T14:15:22Z",
595 "lastModifiedDate": "2019-08-24T14:15:22Z",
596 "archived": true,
597 "externalId": "string",
598 "id": 0,
599 "name": "string",
600 "city": {
601 "createdBy": "string",
602 "lastModifiedBy": "string",
603 "createdDate": "2019-08-24T14:15:22Z",
604 "lastModifiedDate": "2019-08-24T14:15:22Z",
605 "archived": true,
606 "externalId": "string",
607 "id": 0,
608 "name": "string",
609 "province": {
610 "createdBy": "string",
611 "lastModifiedBy": "string",
612 "createdDate": "2019-08-24T14:15:22Z",
613 "lastModifiedDate": "2019-08-24T14:15:22Z",
614 "archived": true,
615 "externalId": "string",
616 "id": 0,
617 "name": "string",
618 "code": "string",
619 "country": {
620 "createdBy": "string",
621 "lastModifiedBy": "string",
622 "createdDate": "2019-08-24T14:15:22Z",
623 "lastModifiedDate": "2019-08-24T14:15:22Z",
624 "archived": true,
625 "externalId": "string",
626 "id": 0,
627 "name": "string",
628 "code": "string"
629 },
630 "provinceCountryKey": "string"
631 },
632 "cityProvinceCountryKey": "string"
633 }
634 },
635 "cityId": 0,
636 "districtId": 0
637 },
638 "secondAddressDto": {
639 "createdBy": "string",
640 "lastModifiedBy": "string",
641 "createdDate": "2019-08-24T14:15:22Z",
642 "lastModifiedDate": "2019-08-24T14:15:22Z",
643 "archived": true,
644 "externalId": "string",
645 "id": 0,
646 "street": "string",
647 "civicNumber": "string",
648 "suite": "string",
649 "postalCode": "string",
650 "lon": 0.1,
651 "lat": 0.1,
652 "city": {
653 "createdBy": "string",
654 "lastModifiedBy": "string",
655 "createdDate": "2019-08-24T14:15:22Z",
656 "lastModifiedDate": "2019-08-24T14:15:22Z",
657 "archived": true,
658 "externalId": "string",
659 "id": 0,
660 "name": "string",
661 "province": {
662 "createdBy": "string",
663 "lastModifiedBy": "string",
664 "createdDate": "2019-08-24T14:15:22Z",
665 "lastModifiedDate": "2019-08-24T14:15:22Z",
666 "archived": true,
667 "externalId": "string",
668 "id": 0,
669 "name": "string",
670 "code": "string",
671 "country": {
672 "createdBy": "string",
673 "lastModifiedBy": "string",
674 "createdDate": "2019-08-24T14:15:22Z",
675 "lastModifiedDate": "2019-08-24T14:15:22Z",
676 "archived": true,
677 "externalId": "string",
678 "id": 0,
679 "name": "string",
680 "code": "string"
681 },
682 "provinceCountryKey": "string"
683 },
684 "cityProvinceCountryKey": "string"
685 },
686 "district": {
687 "createdBy": "string",
688 "lastModifiedBy": "string",
689 "createdDate": "2019-08-24T14:15:22Z",
690 "lastModifiedDate": "2019-08-24T14:15:22Z",
691 "archived": true,
692 "externalId": "string",
693 "id": 0,
694 "name": "string",
695 "city": {
696 "createdBy": "string",
697 "lastModifiedBy": "string",
698 "createdDate": "2019-08-24T14:15:22Z",
699 "lastModifiedDate": "2019-08-24T14:15:22Z",
700 "archived": true,
701 "externalId": "string",
702 "id": 0,
703 "name": "string",
704 "province": {
705 "createdBy": "string",
706 "lastModifiedBy": "string",
707 "createdDate": "2019-08-24T14:15:22Z",
708 "lastModifiedDate": "2019-08-24T14:15:22Z",
709 "archived": true,
710 "externalId": "string",
711 "id": 0,
712 "name": "string",
713 "code": "string",
714 "country": {
715 "createdBy": "string",
716 "lastModifiedBy": "string",
717 "createdDate": "2019-08-24T14:15:22Z",
718 "lastModifiedDate": "2019-08-24T14:15:22Z",
719 "archived": true,
720 "externalId": "string",
721 "id": 0,
722 "name": "string",
723 "code": "string"
724 },
725 "provinceCountryKey": "string"
726 },
727 "cityProvinceCountryKey": "string"
728 }
729 },
730 "cityId": 0,
731 "districtId": 0
732 }
733 },
734 "status": {
735 "createdBy": "string",
736 "lastModifiedBy": "string",
737 "createdDate": "2019-08-24T14:15:22Z",
738 "lastModifiedDate": "2019-08-24T14:15:22Z",
739 "archived": true,
740 "externalId": "string",
741 "id": 0,
742 "priority": 0,
743 "internalId": 0,
744 "pickListCode": "string",
745 "pickListLabel": "string",
746 "label": "string",
747 "cultureId": 0,
748 "labelDtos": [
749 {
750 "createdBy": "string",
751 "lastModifiedBy": "string",
752 "createdDate": "2019-08-24T14:15:22Z",
753 "lastModifiedDate": "2019-08-24T14:15:22Z",
754 "archived": true,
755 "externalId": "string",
756 "id": 0,
757 "cultureId": 0,
758 "value": "string"
759 }
760 ]
761 },
762 "usage": {
763 "createdBy": "string",
764 "lastModifiedBy": "string",
765 "createdDate": "2019-08-24T14:15:22Z",
766 "lastModifiedDate": "2019-08-24T14:15:22Z",
767 "archived": true,
768 "externalId": "string",
769 "id": 0,
770 "priority": 0,
771 "internalId": 0,
772 "pickListCode": "string",
773 "pickListLabel": "string",
774 "label": "string",
775 "cultureId": 0,
776 "labelDtos": [
777 {
778 "createdBy": "string",
779 "lastModifiedBy": "string",
780 "createdDate": "2019-08-24T14:15:22Z",
781 "lastModifiedDate": "2019-08-24T14:15:22Z",
782 "archived": true,
783 "externalId": "string",
784 "id": 0,
785 "cultureId": 0,
786 "value": "string"
787 }
788 ]
789 },
790 "occupanciesDto": [
791 {
792 "createdBy": "string",
793 "lastModifiedBy": "string",
794 "createdDate": "2019-08-24T14:15:22Z",
795 "lastModifiedDate": "2019-08-24T14:15:22Z",
796 "archived": true,
797 "externalId": "string",
798 "id": 0,
799 "priority": 0,
800 "internalId": 0,
801 "pickListCode": "string",
802 "pickListLabel": "string",
803 "label": "string",
804 "cultureId": 0,
805 "labelDtos": [
806 {
807 "createdBy": "string",
808 "lastModifiedBy": "string",
809 "createdDate": "2019-08-24T14:15:22Z",
810 "lastModifiedDate": "2019-08-24T14:15:22Z",
811 "archived": true,
812 "externalId": "string",
813 "id": 0,
814 "cultureId": 0,
815 "value": "string"
816 }
817 ]
818 }
819 ]
820 },
821 "isTerminationVersion": true
822}
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 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1,
290 "areasHistoryVersionId": 0
291 },
292 "premiseDto": {
293 "createdBy": "string",
294 "lastModifiedBy": "string",
295 "createdDate": "2019-08-24T14:15:22Z",
296 "lastModifiedDate": "2019-08-24T14:15:22Z",
297 "archived": true,
298 "externalId": "string",
299 "id": 0,
300 "number": "string",
301 "name": "string",
302 "headPremise": true,
303 "possessionDate": "2019-08-24",
304 "openingDate": "2019-08-24",
305 "closingDate": "2019-08-24",
306 "relocationDate": "2019-08-24",
307 "vacatingDate": "2019-08-24",
308 "expansionDate": "2019-08-24",
309 "statusId": 0,
310 "usageId": 0,
311 "parentPremiseId": 0,
312 "costCenterId": 0,
313 "profitCenterId": 0,
314 "legalEntityId": 0,
315 "occupancyIds": [
316 0
317 ],
318 "locationId": 0,
319 "locationDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "number": "string",
328 "name": "string",
329 "storeNumber": "string",
330 "defaultCurrencyId": 0,
331 "defaultMeasureId": 0,
332 "typeId": 0,
333 "qualityId": 0,
334 "propertyTypeId": 0,
335 "categoryId": 0,
336 "statusId": 0,
337 "businessUnitId": 0,
338 "groupIds": [
339 0
340 ],
341 "legalEntityIds": [
342 0
343 ],
344 "defaultCurrency": {
345 "id": 0,
346 "status": "CREATED",
347 "displayId": "string",
348 "erpSystemId": 0,
349 "erpSystemDisplayId": "string",
350 "name": "string",
351 "decimalPoints": 0,
352 "depreciationAreaId": 0
353 },
354 "defaultUnitValue": {
355 "createdBy": "string",
356 "lastModifiedBy": "string",
357 "createdDate": "2019-08-24T14:15:22Z",
358 "lastModifiedDate": "2019-08-24T14:15:22Z",
359 "archived": true,
360 "externalId": "string",
361 "id": 0,
362 "unitId": 0,
363 "unitOfMeasureId": 0,
364 "erpSystemId": 0,
365 "unit": {
366 "createdBy": "string",
367 "lastModifiedBy": "string",
368 "createdDate": "2019-08-24T14:15:22Z",
369 "lastModifiedDate": "2019-08-24T14:15:22Z",
370 "archived": true,
371 "externalId": "string",
372 "id": 0,
373 "priority": 0,
374 "internalId": 0,
375 "pickListCode": "string",
376 "pickListLabel": "string",
377 "label": "string",
378 "cultureId": 0,
379 "labelDtos": [
380 {
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 "cultureId": 0,
389 "value": "string"
390 }
391 ]
392 },
393 "unitOfMeasure": {
394 "id": 0,
395 "status": "CREATED",
396 "displayId": "string",
397 "erpSystemId": 0,
398 "erpSystemDisplayId": "string",
399 "name": "string"
400 }
401 },
402 "type": {
403 "createdBy": "string",
404 "lastModifiedBy": "string",
405 "createdDate": "2019-08-24T14:15:22Z",
406 "lastModifiedDate": "2019-08-24T14:15:22Z",
407 "archived": true,
408 "externalId": "string",
409 "id": 0,
410 "priority": 0,
411 "internalId": 0,
412 "pickListCode": "string",
413 "pickListLabel": "string",
414 "label": "string",
415 "cultureId": 0,
416 "labelDtos": [
417 {
418 "createdBy": "string",
419 "lastModifiedBy": "string",
420 "createdDate": "2019-08-24T14:15:22Z",
421 "lastModifiedDate": "2019-08-24T14:15:22Z",
422 "archived": true,
423 "externalId": "string",
424 "id": 0,
425 "cultureId": 0,
426 "value": "string"
427 }
428 ]
429 },
430 "quality": {
431 "createdBy": "string",
432 "lastModifiedBy": "string",
433 "createdDate": "2019-08-24T14:15:22Z",
434 "lastModifiedDate": "2019-08-24T14:15:22Z",
435 "archived": true,
436 "externalId": "string",
437 "id": 0,
438 "priority": 0,
439 "internalId": 0,
440 "pickListCode": "string",
441 "pickListLabel": "string",
442 "label": "string",
443 "cultureId": 0,
444 "labelDtos": [
445 {
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 "cultureId": 0,
454 "value": "string"
455 }
456 ]
457 },
458 "propertyType": {
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 "priority": 0,
467 "internalId": 0,
468 "pickListCode": "string",
469 "pickListLabel": "string",
470 "label": "string",
471 "cultureId": 0,
472 "labelDtos": [
473 {
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 "cultureId": 0,
482 "value": "string"
483 }
484 ]
485 },
486 "category": {
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 "priority": 0,
495 "internalId": 0,
496 "pickListCode": "string",
497 "pickListLabel": "string",
498 "label": "string",
499 "cultureId": 0,
500 "labelDtos": [
501 {
502 "createdBy": "string",
503 "lastModifiedBy": "string",
504 "createdDate": "2019-08-24T14:15:22Z",
505 "lastModifiedDate": "2019-08-24T14:15:22Z",
506 "archived": true,
507 "externalId": "string",
508 "id": 0,
509 "cultureId": 0,
510 "value": "string"
511 }
512 ]
513 },
514 "status": {
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 "priority": 0,
523 "internalId": 0,
524 "pickListCode": "string",
525 "pickListLabel": "string",
526 "label": "string",
527 "cultureId": 0,
528 "labelDtos": [
529 {
530 "createdBy": "string",
531 "lastModifiedBy": "string",
532 "createdDate": "2019-08-24T14:15:22Z",
533 "lastModifiedDate": "2019-08-24T14:15:22Z",
534 "archived": true,
535 "externalId": "string",
536 "id": 0,
537 "cultureId": 0,
538 "value": "string"
539 }
540 ]
541 },
542 "addressDto": {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "street": "string",
551 "civicNumber": "string",
552 "suite": "string",
553 "postalCode": "string",
554 "lon": 0.1,
555 "lat": 0.1,
556 "city": {
557 "createdBy": "string",
558 "lastModifiedBy": "string",
559 "createdDate": "2019-08-24T14:15:22Z",
560 "lastModifiedDate": "2019-08-24T14:15:22Z",
561 "archived": true,
562 "externalId": "string",
563 "id": 0,
564 "name": "string",
565 "province": {
566 "createdBy": "string",
567 "lastModifiedBy": "string",
568 "createdDate": "2019-08-24T14:15:22Z",
569 "lastModifiedDate": "2019-08-24T14:15:22Z",
570 "archived": true,
571 "externalId": "string",
572 "id": 0,
573 "name": "string",
574 "code": "string",
575 "country": {
576 "createdBy": "string",
577 "lastModifiedBy": "string",
578 "createdDate": "2019-08-24T14:15:22Z",
579 "lastModifiedDate": "2019-08-24T14:15:22Z",
580 "archived": true,
581 "externalId": "string",
582 "id": 0,
583 "name": "string",
584 "code": "string"
585 },
586 "provinceCountryKey": "string"
587 },
588 "cityProvinceCountryKey": "string"
589 },
590 "district": {
591 "createdBy": "string",
592 "lastModifiedBy": "string",
593 "createdDate": "2019-08-24T14:15:22Z",
594 "lastModifiedDate": "2019-08-24T14:15:22Z",
595 "archived": true,
596 "externalId": "string",
597 "id": 0,
598 "name": "string",
599 "city": {
600 "createdBy": "string",
601 "lastModifiedBy": "string",
602 "createdDate": "2019-08-24T14:15:22Z",
603 "lastModifiedDate": "2019-08-24T14:15:22Z",
604 "archived": true,
605 "externalId": "string",
606 "id": 0,
607 "name": "string",
608 "province": {
609 "createdBy": "string",
610 "lastModifiedBy": "string",
611 "createdDate": "2019-08-24T14:15:22Z",
612 "lastModifiedDate": "2019-08-24T14:15:22Z",
613 "archived": true,
614 "externalId": "string",
615 "id": 0,
616 "name": "string",
617 "code": "string",
618 "country": {
619 "createdBy": "string",
620 "lastModifiedBy": "string",
621 "createdDate": "2019-08-24T14:15:22Z",
622 "lastModifiedDate": "2019-08-24T14:15:22Z",
623 "archived": true,
624 "externalId": "string",
625 "id": 0,
626 "name": "string",
627 "code": "string"
628 },
629 "provinceCountryKey": "string"
630 },
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {
671 "createdBy": "string",
672 "lastModifiedBy": "string",
673 "createdDate": "2019-08-24T14:15:22Z",
674 "lastModifiedDate": "2019-08-24T14:15:22Z",
675 "archived": true,
676 "externalId": "string",
677 "id": 0,
678 "name": "string",
679 "code": "string"
680 },
681 "provinceCountryKey": "string"
682 },
683 "cityProvinceCountryKey": "string"
684 },
685 "district": {
686 "createdBy": "string",
687 "lastModifiedBy": "string",
688 "createdDate": "2019-08-24T14:15:22Z",
689 "lastModifiedDate": "2019-08-24T14:15:22Z",
690 "archived": true,
691 "externalId": "string",
692 "id": 0,
693 "name": "string",
694 "city": {
695 "createdBy": "string",
696 "lastModifiedBy": "string",
697 "createdDate": "2019-08-24T14:15:22Z",
698 "lastModifiedDate": "2019-08-24T14:15:22Z",
699 "archived": true,
700 "externalId": "string",
701 "id": 0,
702 "name": "string",
703 "province": {
704 "createdBy": "string",
705 "lastModifiedBy": "string",
706 "createdDate": "2019-08-24T14:15:22Z",
707 "lastModifiedDate": "2019-08-24T14:15:22Z",
708 "archived": true,
709 "externalId": "string",
710 "id": 0,
711 "name": "string",
712 "code": "string",
713 "country": {
714 "createdBy": "string",
715 "lastModifiedBy": "string",
716 "createdDate": "2019-08-24T14:15:22Z",
717 "lastModifiedDate": "2019-08-24T14:15:22Z",
718 "archived": true,
719 "externalId": "string",
720 "id": 0,
721 "name": "string",
722 "code": "string"
723 },
724 "provinceCountryKey": "string"
725 },
726 "cityProvinceCountryKey": "string"
727 }
728 },
729 "cityId": 0,
730 "districtId": 0
731 }
732 },
733 "status": {
734 "createdBy": "string",
735 "lastModifiedBy": "string",
736 "createdDate": "2019-08-24T14:15:22Z",
737 "lastModifiedDate": "2019-08-24T14:15:22Z",
738 "archived": true,
739 "externalId": "string",
740 "id": 0,
741 "priority": 0,
742 "internalId": 0,
743 "pickListCode": "string",
744 "pickListLabel": "string",
745 "label": "string",
746 "cultureId": 0,
747 "labelDtos": [
748 {
749 "createdBy": "string",
750 "lastModifiedBy": "string",
751 "createdDate": "2019-08-24T14:15:22Z",
752 "lastModifiedDate": "2019-08-24T14:15:22Z",
753 "archived": true,
754 "externalId": "string",
755 "id": 0,
756 "cultureId": 0,
757 "value": "string"
758 }
759 ]
760 },
761 "usage": {
762 "createdBy": "string",
763 "lastModifiedBy": "string",
764 "createdDate": "2019-08-24T14:15:22Z",
765 "lastModifiedDate": "2019-08-24T14:15:22Z",
766 "archived": true,
767 "externalId": "string",
768 "id": 0,
769 "priority": 0,
770 "internalId": 0,
771 "pickListCode": "string",
772 "pickListLabel": "string",
773 "label": "string",
774 "cultureId": 0,
775 "labelDtos": [
776 {
777 "createdBy": "string",
778 "lastModifiedBy": "string",
779 "createdDate": "2019-08-24T14:15:22Z",
780 "lastModifiedDate": "2019-08-24T14:15:22Z",
781 "archived": true,
782 "externalId": "string",
783 "id": 0,
784 "cultureId": 0,
785 "value": "string"
786 }
787 ]
788 },
789 "occupanciesDto": [
790 {
791 "createdBy": "string",
792 "lastModifiedBy": "string",
793 "createdDate": "2019-08-24T14:15:22Z",
794 "lastModifiedDate": "2019-08-24T14:15:22Z",
795 "archived": true,
796 "externalId": "string",
797 "id": 0,
798 "priority": 0,
799 "internalId": 0,
800 "pickListCode": "string",
801 "pickListLabel": "string",
802 "label": "string",
803 "cultureId": 0,
804 "labelDtos": [
805 {
806 "createdBy": "string",
807 "lastModifiedBy": "string",
808 "createdDate": "2019-08-24T14:15:22Z",
809 "lastModifiedDate": "2019-08-24T14:15:22Z",
810 "archived": true,
811 "externalId": "string",
812 "id": 0,
813 "cultureId": 0,
814 "value": "string"
815 }
816 ]
817 }
818 ]
819 },
820 "isTerminationVersion": true
821}
Lease - Create Lease Version¶
HTTP Request
POST /api/leases/{id}/versions
📋 Description: Creates a new version of an existing lease within the Nakisa Portfolio Management Suite, enabling users to manage and track changes in lease agreements for enhanced portfolio analytics and asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the lease version data, including updated terms and conditions, to facilitate portfolio management and asset analytics for real estate properties. |
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 "description": "string",
11 "modificationDate": "2019-08-24",
12 "updateContractRate": true,
13 "leaseEvent": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "code": "string",
23 "reviewedBy": "string",
24 "reviewedDate": "2019-08-24",
25 "reviewedStatusId": 0,
26 "activityDate": "2019-08-24",
27 "relatedPickListOptionId": 0,
28 "detail": "string",
29 "note": {
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 "message": "string",
38 "preserveOriginalAudit": true,
39 "originalCreatedBy": "string",
40 "originalCreatedDate": "2019-08-24T14:15:22Z",
41 "originalLastModifiedBy": "string",
42 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
43 },
44 "type": {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "priority": 0,
53 "internalId": 0,
54 "pickListCode": "string",
55 "pickListLabel": "string",
56 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 },
72 "reviewedStatus": {
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 "priority": 0,
81 "internalId": 0,
82 "pickListCode": "string",
83 "pickListLabel": "string",
84 "label": "string",
85 "cultureId": 0,
86 "labelDtos": [
87 {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "cultureId": 0,
96 "value": "string"
97 }
98 ]
99 },
100 "relatedPickListOption": {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "priority": 0,
109 "internalId": 0,
110 "pickListCode": "string",
111 "pickListLabel": "string",
112 "label": "string",
113 "cultureId": 0,
114 "labelDtos": [
115 {
116 "createdBy": "string",
117 "lastModifiedBy": "string",
118 "createdDate": "2019-08-24T14:15:22Z",
119 "lastModifiedDate": "2019-08-24T14:15:22Z",
120 "archived": true,
121 "externalId": "string",
122 "id": 0,
123 "cultureId": 0,
124 "value": "string"
125 }
126 ]
127 },
128 "isVisiblePartnerPortal": true
129 },
130 "scenario": true,
131 "isVisibleVendorPortal": true,
132 "isTerminationVersion": true,
133 "terminationDate": "2019-08-24",
134 "penaltyAmount": 0.1,
135 "areasHistoryVersionId": 0
136}
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 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1,
290 "areasHistoryVersionId": 0
291 },
292 "premiseDto": {
293 "createdBy": "string",
294 "lastModifiedBy": "string",
295 "createdDate": "2019-08-24T14:15:22Z",
296 "lastModifiedDate": "2019-08-24T14:15:22Z",
297 "archived": true,
298 "externalId": "string",
299 "id": 0,
300 "number": "string",
301 "name": "string",
302 "headPremise": true,
303 "possessionDate": "2019-08-24",
304 "openingDate": "2019-08-24",
305 "closingDate": "2019-08-24",
306 "relocationDate": "2019-08-24",
307 "vacatingDate": "2019-08-24",
308 "expansionDate": "2019-08-24",
309 "statusId": 0,
310 "usageId": 0,
311 "parentPremiseId": 0,
312 "costCenterId": 0,
313 "profitCenterId": 0,
314 "legalEntityId": 0,
315 "occupancyIds": [
316 0
317 ],
318 "locationId": 0,
319 "locationDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "number": "string",
328 "name": "string",
329 "storeNumber": "string",
330 "defaultCurrencyId": 0,
331 "defaultMeasureId": 0,
332 "typeId": 0,
333 "qualityId": 0,
334 "propertyTypeId": 0,
335 "categoryId": 0,
336 "statusId": 0,
337 "businessUnitId": 0,
338 "groupIds": [
339 0
340 ],
341 "legalEntityIds": [
342 0
343 ],
344 "defaultCurrency": {
345 "id": 0,
346 "status": "CREATED",
347 "displayId": "string",
348 "erpSystemId": 0,
349 "erpSystemDisplayId": "string",
350 "name": "string",
351 "decimalPoints": 0,
352 "depreciationAreaId": 0
353 },
354 "defaultUnitValue": {
355 "createdBy": "string",
356 "lastModifiedBy": "string",
357 "createdDate": "2019-08-24T14:15:22Z",
358 "lastModifiedDate": "2019-08-24T14:15:22Z",
359 "archived": true,
360 "externalId": "string",
361 "id": 0,
362 "unitId": 0,
363 "unitOfMeasureId": 0,
364 "erpSystemId": 0,
365 "unit": {
366 "createdBy": "string",
367 "lastModifiedBy": "string",
368 "createdDate": "2019-08-24T14:15:22Z",
369 "lastModifiedDate": "2019-08-24T14:15:22Z",
370 "archived": true,
371 "externalId": "string",
372 "id": 0,
373 "priority": 0,
374 "internalId": 0,
375 "pickListCode": "string",
376 "pickListLabel": "string",
377 "label": "string",
378 "cultureId": 0,
379 "labelDtos": [
380 {
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 "cultureId": 0,
389 "value": "string"
390 }
391 ]
392 },
393 "unitOfMeasure": {
394 "id": 0,
395 "status": "CREATED",
396 "displayId": "string",
397 "erpSystemId": 0,
398 "erpSystemDisplayId": "string",
399 "name": "string"
400 }
401 },
402 "type": {
403 "createdBy": "string",
404 "lastModifiedBy": "string",
405 "createdDate": "2019-08-24T14:15:22Z",
406 "lastModifiedDate": "2019-08-24T14:15:22Z",
407 "archived": true,
408 "externalId": "string",
409 "id": 0,
410 "priority": 0,
411 "internalId": 0,
412 "pickListCode": "string",
413 "pickListLabel": "string",
414 "label": "string",
415 "cultureId": 0,
416 "labelDtos": [
417 {
418 "createdBy": "string",
419 "lastModifiedBy": "string",
420 "createdDate": "2019-08-24T14:15:22Z",
421 "lastModifiedDate": "2019-08-24T14:15:22Z",
422 "archived": true,
423 "externalId": "string",
424 "id": 0,
425 "cultureId": 0,
426 "value": "string"
427 }
428 ]
429 },
430 "quality": {
431 "createdBy": "string",
432 "lastModifiedBy": "string",
433 "createdDate": "2019-08-24T14:15:22Z",
434 "lastModifiedDate": "2019-08-24T14:15:22Z",
435 "archived": true,
436 "externalId": "string",
437 "id": 0,
438 "priority": 0,
439 "internalId": 0,
440 "pickListCode": "string",
441 "pickListLabel": "string",
442 "label": "string",
443 "cultureId": 0,
444 "labelDtos": [
445 {
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 "cultureId": 0,
454 "value": "string"
455 }
456 ]
457 },
458 "propertyType": {
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 "priority": 0,
467 "internalId": 0,
468 "pickListCode": "string",
469 "pickListLabel": "string",
470 "label": "string",
471 "cultureId": 0,
472 "labelDtos": [
473 {
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 "cultureId": 0,
482 "value": "string"
483 }
484 ]
485 },
486 "category": {
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 "priority": 0,
495 "internalId": 0,
496 "pickListCode": "string",
497 "pickListLabel": "string",
498 "label": "string",
499 "cultureId": 0,
500 "labelDtos": [
501 {
502 "createdBy": "string",
503 "lastModifiedBy": "string",
504 "createdDate": "2019-08-24T14:15:22Z",
505 "lastModifiedDate": "2019-08-24T14:15:22Z",
506 "archived": true,
507 "externalId": "string",
508 "id": 0,
509 "cultureId": 0,
510 "value": "string"
511 }
512 ]
513 },
514 "status": {
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 "priority": 0,
523 "internalId": 0,
524 "pickListCode": "string",
525 "pickListLabel": "string",
526 "label": "string",
527 "cultureId": 0,
528 "labelDtos": [
529 {
530 "createdBy": "string",
531 "lastModifiedBy": "string",
532 "createdDate": "2019-08-24T14:15:22Z",
533 "lastModifiedDate": "2019-08-24T14:15:22Z",
534 "archived": true,
535 "externalId": "string",
536 "id": 0,
537 "cultureId": 0,
538 "value": "string"
539 }
540 ]
541 },
542 "addressDto": {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "street": "string",
551 "civicNumber": "string",
552 "suite": "string",
553 "postalCode": "string",
554 "lon": 0.1,
555 "lat": 0.1,
556 "city": {
557 "createdBy": "string",
558 "lastModifiedBy": "string",
559 "createdDate": "2019-08-24T14:15:22Z",
560 "lastModifiedDate": "2019-08-24T14:15:22Z",
561 "archived": true,
562 "externalId": "string",
563 "id": 0,
564 "name": "string",
565 "province": {
566 "createdBy": "string",
567 "lastModifiedBy": "string",
568 "createdDate": "2019-08-24T14:15:22Z",
569 "lastModifiedDate": "2019-08-24T14:15:22Z",
570 "archived": true,
571 "externalId": "string",
572 "id": 0,
573 "name": "string",
574 "code": "string",
575 "country": {
576 "createdBy": "string",
577 "lastModifiedBy": "string",
578 "createdDate": "2019-08-24T14:15:22Z",
579 "lastModifiedDate": "2019-08-24T14:15:22Z",
580 "archived": true,
581 "externalId": "string",
582 "id": 0,
583 "name": "string",
584 "code": "string"
585 },
586 "provinceCountryKey": "string"
587 },
588 "cityProvinceCountryKey": "string"
589 },
590 "district": {
591 "createdBy": "string",
592 "lastModifiedBy": "string",
593 "createdDate": "2019-08-24T14:15:22Z",
594 "lastModifiedDate": "2019-08-24T14:15:22Z",
595 "archived": true,
596 "externalId": "string",
597 "id": 0,
598 "name": "string",
599 "city": {
600 "createdBy": "string",
601 "lastModifiedBy": "string",
602 "createdDate": "2019-08-24T14:15:22Z",
603 "lastModifiedDate": "2019-08-24T14:15:22Z",
604 "archived": true,
605 "externalId": "string",
606 "id": 0,
607 "name": "string",
608 "province": {
609 "createdBy": "string",
610 "lastModifiedBy": "string",
611 "createdDate": "2019-08-24T14:15:22Z",
612 "lastModifiedDate": "2019-08-24T14:15:22Z",
613 "archived": true,
614 "externalId": "string",
615 "id": 0,
616 "name": "string",
617 "code": "string",
618 "country": {
619 "createdBy": "string",
620 "lastModifiedBy": "string",
621 "createdDate": "2019-08-24T14:15:22Z",
622 "lastModifiedDate": "2019-08-24T14:15:22Z",
623 "archived": true,
624 "externalId": "string",
625 "id": 0,
626 "name": "string",
627 "code": "string"
628 },
629 "provinceCountryKey": "string"
630 },
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {
671 "createdBy": "string",
672 "lastModifiedBy": "string",
673 "createdDate": "2019-08-24T14:15:22Z",
674 "lastModifiedDate": "2019-08-24T14:15:22Z",
675 "archived": true,
676 "externalId": "string",
677 "id": 0,
678 "name": "string",
679 "code": "string"
680 },
681 "provinceCountryKey": "string"
682 },
683 "cityProvinceCountryKey": "string"
684 },
685 "district": {
686 "createdBy": "string",
687 "lastModifiedBy": "string",
688 "createdDate": "2019-08-24T14:15:22Z",
689 "lastModifiedDate": "2019-08-24T14:15:22Z",
690 "archived": true,
691 "externalId": "string",
692 "id": 0,
693 "name": "string",
694 "city": {
695 "createdBy": "string",
696 "lastModifiedBy": "string",
697 "createdDate": "2019-08-24T14:15:22Z",
698 "lastModifiedDate": "2019-08-24T14:15:22Z",
699 "archived": true,
700 "externalId": "string",
701 "id": 0,
702 "name": "string",
703 "province": {
704 "createdBy": "string",
705 "lastModifiedBy": "string",
706 "createdDate": "2019-08-24T14:15:22Z",
707 "lastModifiedDate": "2019-08-24T14:15:22Z",
708 "archived": true,
709 "externalId": "string",
710 "id": 0,
711 "name": "string",
712 "code": "string",
713 "country": {
714 "createdBy": "string",
715 "lastModifiedBy": "string",
716 "createdDate": "2019-08-24T14:15:22Z",
717 "lastModifiedDate": "2019-08-24T14:15:22Z",
718 "archived": true,
719 "externalId": "string",
720 "id": 0,
721 "name": "string",
722 "code": "string"
723 },
724 "provinceCountryKey": "string"
725 },
726 "cityProvinceCountryKey": "string"
727 }
728 },
729 "cityId": 0,
730 "districtId": 0
731 }
732 },
733 "status": {
734 "createdBy": "string",
735 "lastModifiedBy": "string",
736 "createdDate": "2019-08-24T14:15:22Z",
737 "lastModifiedDate": "2019-08-24T14:15:22Z",
738 "archived": true,
739 "externalId": "string",
740 "id": 0,
741 "priority": 0,
742 "internalId": 0,
743 "pickListCode": "string",
744 "pickListLabel": "string",
745 "label": "string",
746 "cultureId": 0,
747 "labelDtos": [
748 {
749 "createdBy": "string",
750 "lastModifiedBy": "string",
751 "createdDate": "2019-08-24T14:15:22Z",
752 "lastModifiedDate": "2019-08-24T14:15:22Z",
753 "archived": true,
754 "externalId": "string",
755 "id": 0,
756 "cultureId": 0,
757 "value": "string"
758 }
759 ]
760 },
761 "usage": {
762 "createdBy": "string",
763 "lastModifiedBy": "string",
764 "createdDate": "2019-08-24T14:15:22Z",
765 "lastModifiedDate": "2019-08-24T14:15:22Z",
766 "archived": true,
767 "externalId": "string",
768 "id": 0,
769 "priority": 0,
770 "internalId": 0,
771 "pickListCode": "string",
772 "pickListLabel": "string",
773 "label": "string",
774 "cultureId": 0,
775 "labelDtos": [
776 {
777 "createdBy": "string",
778 "lastModifiedBy": "string",
779 "createdDate": "2019-08-24T14:15:22Z",
780 "lastModifiedDate": "2019-08-24T14:15:22Z",
781 "archived": true,
782 "externalId": "string",
783 "id": 0,
784 "cultureId": 0,
785 "value": "string"
786 }
787 ]
788 },
789 "occupanciesDto": [
790 {
791 "createdBy": "string",
792 "lastModifiedBy": "string",
793 "createdDate": "2019-08-24T14:15:22Z",
794 "lastModifiedDate": "2019-08-24T14:15:22Z",
795 "archived": true,
796 "externalId": "string",
797 "id": 0,
798 "priority": 0,
799 "internalId": 0,
800 "pickListCode": "string",
801 "pickListLabel": "string",
802 "label": "string",
803 "cultureId": 0,
804 "labelDtos": [
805 {
806 "createdBy": "string",
807 "lastModifiedBy": "string",
808 "createdDate": "2019-08-24T14:15:22Z",
809 "lastModifiedDate": "2019-08-24T14:15:22Z",
810 "archived": true,
811 "externalId": "string",
812 "id": 0,
813 "cultureId": 0,
814 "value": "string"
815 }
816 ]
817 }
818 ]
819 },
820 "isTerminationVersion": true
821}
Lease - Create Term Definitions¶
HTTP Request
POST /api/leases/{id}/term-definitions
📋 Description: Creates a new term definition for a specified lease within the Nakisa Portfolio Management Suite, facilitating enhanced asset management and 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 term definition data for the specified lease, including relevant attributes and metadata to support 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 "paymentFrequencyName": "string",
11 "amountFrequencyName": "string",
12 "paymentModeName": "string",
13 "expenseCategoryId": 0,
14 "currencyId": 0,
15 "startDate": "2019-08-24",
16 "endDate": "2019-08-24",
17 "firstPaymentDate": "2019-08-24",
18 "endOfMonthPayment": true,
19 "proRata": true,
20 "note": "string",
21 "areaId": 0,
22 "parentTermDefinitionId": 0,
23 "expenseCategory": {
24 "id": 0,
25 "status": "CREATED",
26 "displayId": "string",
27 "name": "string",
28 "editable": true,
29 "expenseCategoryType": "PAYMENT"
30 },
31 "currency": {
32 "id": 0,
33 "status": "CREATED",
34 "displayId": "string",
35 "erpSystemId": 0,
36 "erpSystemDisplayId": "string",
37 "name": "string",
38 "decimalPoints": 0,
39 "depreciationAreaId": 0
40 },
41 "expenseGroup": {
42 "createdBy": "string",
43 "lastModifiedBy": "string",
44 "createdDate": "2019-08-24T14:15:22Z",
45 "lastModifiedDate": "2019-08-24T14:15:22Z",
46 "archived": true,
47 "externalId": "string",
48 "id": 0,
49 "priority": 0,
50 "internalId": 0,
51 "pickListCode": "string",
52 "pickListLabel": "string",
53 "label": "string",
54 "cultureId": 0,
55 "labelDtos": [
56 {
57 "createdBy": "string",
58 "lastModifiedBy": "string",
59 "createdDate": "2019-08-24T14:15:22Z",
60 "lastModifiedDate": "2019-08-24T14:15:22Z",
61 "archived": true,
62 "externalId": "string",
63 "id": 0,
64 "cultureId": 0,
65 "value": "string"
66 }
67 ]
68 },
69 "costCenterId": 0,
70 "leaseComponentId": 0,
71 "leaseComponentName": "string",
72 "assignmentNumber": {
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 "priority": 0,
81 "internalId": 0,
82 "pickListCode": "string",
83 "pickListLabel": "string",
84 "label": "string",
85 "cultureId": 0,
86 "labelDtos": [
87 {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "cultureId": 0,
96 "value": "string"
97 }
98 ]
99 },
100 "assignmentNumberId": 0,
101 "isAdjustmentTerm": true
102 }
103]
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 "paymentFrequencyName": "string",
11 "amountFrequencyName": "string",
12 "paymentModeName": "string",
13 "expenseCategoryId": 0,
14 "currencyId": 0,
15 "startDate": "2019-08-24",
16 "endDate": "2019-08-24",
17 "firstPaymentDate": "2019-08-24",
18 "endOfMonthPayment": true,
19 "proRata": true,
20 "note": "string",
21 "areaId": 0,
22 "parentTermDefinitionId": 0,
23 "expenseCategory": {
24 "id": 0,
25 "status": "CREATED",
26 "displayId": "string",
27 "name": "string",
28 "editable": true,
29 "expenseCategoryType": "PAYMENT"
30 },
31 "currency": {
32 "id": 0,
33 "status": "CREATED",
34 "displayId": "string",
35 "erpSystemId": 0,
36 "erpSystemDisplayId": "string",
37 "name": "string",
38 "decimalPoints": 0,
39 "depreciationAreaId": 0
40 },
41 "expenseGroup": {
42 "createdBy": "string",
43 "lastModifiedBy": "string",
44 "createdDate": "2019-08-24T14:15:22Z",
45 "lastModifiedDate": "2019-08-24T14:15:22Z",
46 "archived": true,
47 "externalId": "string",
48 "id": 0,
49 "priority": 0,
50 "internalId": 0,
51 "pickListCode": "string",
52 "pickListLabel": "string",
53 "label": "string",
54 "cultureId": 0,
55 "labelDtos": [
56 {
57 "createdBy": "string",
58 "lastModifiedBy": "string",
59 "createdDate": "2019-08-24T14:15:22Z",
60 "lastModifiedDate": "2019-08-24T14:15:22Z",
61 "archived": true,
62 "externalId": "string",
63 "id": 0,
64 "cultureId": 0,
65 "value": "string"
66 }
67 ]
68 },
69 "costCenterId": 0,
70 "leaseComponentId": 0,
71 "leaseComponentName": "string",
72 "assignmentNumber": {
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 "priority": 0,
81 "internalId": 0,
82 "pickListCode": "string",
83 "pickListLabel": "string",
84 "label": "string",
85 "cultureId": 0,
86 "labelDtos": [
87 {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "cultureId": 0,
96 "value": "string"
97 }
98 ]
99 },
100 "assignmentNumberId": 0,
101 "isAdjustmentTerm": true
102 }
103]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the definition of a term within the Nakisa Portfolio Management Suite, providing essential context for 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 |
» paymentFrequencyName |
string |
true |
none |
Name of the payment frequency |
» amountFrequencyName |
string |
true |
none |
Name of the amount frequency |
» paymentModeName |
string |
false |
none |
Name of the payment mode |
» expenseCategoryId |
integer(int64) |
true |
none |
Unique identifier for the expense category |
» currencyId |
integer(int64) |
false |
none |
Unique identifier for the currency |
» startDate |
string(date) |
true |
none |
Start date of the resource |
» endDate |
string(date) |
true |
none |
End date of the resource |
» firstPaymentDate |
string(date) |
true |
none |
Date of the first payment |
» endOfMonthPayment |
boolean |
true |
none |
Boolean flag indicating endOfMonthPayment status |
» proRata |
boolean |
false |
none |
Boolean flag indicating proRata status |
» note |
string |
false |
none |
Textual description or commentary related to the term definition, providing additional context for portfolio, asset, analytics, or real estate property management. |
» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
» parentTermDefinitionId |
integer(int64) |
false |
none |
Unique identifier for the parent term definition |
» expenseCategory |
false |
none |
Data transfer object representing an expense category within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of financial data related to 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 |
»» name |
string |
true |
none |
Name of the resource |
»» editable |
boolean |
true |
none |
Boolean flag indicating editable status |
»» expenseCategoryType |
string |
true |
none |
Type of the expense category |
» currency |
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 |
» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
» costCenterId |
integer(int64) |
false |
none |
Unique identifier for the cost center |
» leaseComponentId |
integer(int64) |
false |
none |
Unique identifier for the lease component |
» leaseComponentName |
string |
false |
none |
Name of the lease component |
» assignmentNumber |
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. |
|
» assignmentNumberId |
integer(int64) |
false |
none |
Unique identifier for the assignment number |
» isAdjustmentTerm |
boolean |
false |
none |
none |
Enumerated Values
Attribute |
Value |
|---|---|
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Sync Lease With NFS¶
HTTP Request
POST /api/leases/{id}/sync-with-nfs
📋 Description: Synchronizes lease data for a specified asset with the NFS (Network File System), ensuring that portfolio and real estate property information is consistently updated for accurate analytics and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Lease - Get Lease Reminders¶
HTTP Request
GET /api/leases/{id}/reminders
📋 Description: Retrieves reminders associated with a specific lease, enabling users to effectively manage portfolio and asset-related notifications 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 reminders retrieval should be paginated, enhancing the management of portfolio and asset data within the Nakisa Portfolio Management Suite. |
|
subject-id |
query |
string |
false |
Unique identifier for the specific lease within the Nakisa Portfolio Management Suite, used to retrieve associated reminders for effective portfolio and asset management. |
category-id |
query |
string |
false |
Unique identifier for the category associated with the lease reminders, facilitating targeted analytics and management within the Nakisa Portfolio Management Suite. |
lease-id |
query |
string |
false |
Unique identifier for the lease within the Nakisa Portfolio Management Suite, used to retrieve associated reminders for effective portfolio and asset management. |
lease-id-in |
query |
string |
false |
Unique identifier for the lease within the Nakisa Portfolio Management Suite, used to retrieve associated reminders for effective portfolio and asset management. |
status-id |
query |
string |
false |
Unique identifier for the status of reminders associated with a specific lease, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
status-id-in |
query |
string |
false |
Specifies the status identifier for filtering reminders associated with a particular lease within the Nakisa Portfolio Management Suite. |
reminder-type-id |
query |
string |
false |
Identifier for the type of reminder associated with a specific lease, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
reminder-type-id-in |
query |
string |
false |
Identifier for the specific type of reminder associated with the lease, facilitating targeted notifications 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 the lease, facilitating timely asset management and portfolio oversight within the Nakisa Portfolio Management Suite. |
follow-up-date-before |
query |
string |
false |
Specifies the cutoff date for retrieving reminders related to leases, enabling users to filter notifications before a designated date within the Nakisa Portfolio Management Suite. |
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}
Lease - Create Lease Reminders¶
HTTP Request
POST /api/leases/{id}/reminders
📋 Description: Creates a reminder for a specific lease within the Nakisa Portfolio Management Suite, enabling users to effectively manage lease obligations and enhance portfolio oversight.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the reminder details for a specific lease, including notification timing and associated metadata, to enhance portfolio management and asset oversight. |
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 "subjectId": 0,
11 "categoryId": 0,
12 "statusId": 0,
13 "reminderTypeId": 0,
14 "date": "2019-08-24",
15 "followUpDate": "2019-08-24",
16 "comments": "string",
17 "primaryUserId": 0,
18 "subject": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "category": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 },
74 "status": {
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 "reminderType": {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "priority": 0,
111 "internalId": 0,
112 "pickListCode": "string",
113 "pickListLabel": "string",
114 "label": "string",
115 "cultureId": 0,
116 "labelDtos": [
117 {
118 "createdBy": "string",
119 "lastModifiedBy": "string",
120 "createdDate": "2019-08-24T14:15:22Z",
121 "lastModifiedDate": "2019-08-24T14:15:22Z",
122 "archived": true,
123 "externalId": "string",
124 "id": 0,
125 "cultureId": 0,
126 "value": "string"
127 }
128 ]
129 },
130 "primaryUser": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "email": "string",
139 "userName": "string",
140 "firstName": "string",
141 "lastName": "string",
142 "displayName": "string",
143 "permissions": "string",
144 "internalId": "string",
145 "preferredCulture": {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "name": "string",
154 "code": "string",
155 "defaultCulture": true,
156 "enable": true
157 },
158 "userGroups": [
159 {
160 "createdBy": "string",
161 "lastModifiedBy": "string",
162 "createdDate": "2019-08-24T14:15:22Z",
163 "lastModifiedDate": "2019-08-24T14:15:22Z",
164 "archived": true,
165 "externalId": "string",
166 "id": 0,
167 "name": "string",
168 "description": "string",
169 "internalId": "string"
170 }
171 ],
172 "partnerIds": [
173 0
174 ],
175 "partners": [
176 {
177 "id": 0,
178 "status": "CREATED",
179 "displayId": "string",
180 "erpSystemId": 0,
181 "erpSystemDisplayId": "string",
182 "name": "string",
183 "fax": "string",
184 "phone": "string",
185 "parentId": 0,
186 "parentName": "string",
187 "parentDisplayId": "string",
188 "companyId": 0,
189 "partnerRoleId": 0,
190 "partnerContactId": 0
191 }
192 ]
193 },
194 "leaseExternalId": "string",
195 "premiseName": "string",
196 "reminderUserDtos": [
197 {
198 "createdBy": "string",
199 "lastModifiedBy": "string",
200 "createdDate": "2019-08-24T14:15:22Z",
201 "lastModifiedDate": "2019-08-24T14:15:22Z",
202 "archived": true,
203 "externalId": "string",
204 "acknowledge": true,
205 "userDto": {
206 "createdBy": "string",
207 "lastModifiedBy": "string",
208 "createdDate": "2019-08-24T14:15:22Z",
209 "lastModifiedDate": "2019-08-24T14:15:22Z",
210 "archived": true,
211 "externalId": "string",
212 "id": 0,
213 "email": "string",
214 "userName": "string",
215 "firstName": "string",
216 "lastName": "string",
217 "displayName": "string",
218 "permissions": "string",
219 "internalId": "string",
220 "preferredCulture": {
221 "createdBy": "string",
222 "lastModifiedBy": "string",
223 "createdDate": "2019-08-24T14:15:22Z",
224 "lastModifiedDate": "2019-08-24T14:15:22Z",
225 "archived": true,
226 "externalId": "string",
227 "id": 0,
228 "name": "string",
229 "code": "string",
230 "defaultCulture": true,
231 "enable": true
232 },
233 "userGroups": [
234 {
235 "createdBy": "string",
236 "lastModifiedBy": "string",
237 "createdDate": "2019-08-24T14:15:22Z",
238 "lastModifiedDate": "2019-08-24T14:15:22Z",
239 "archived": true,
240 "externalId": "string",
241 "id": 0,
242 "name": "string",
243 "description": "string",
244 "internalId": "string"
245 }
246 ],
247 "partnerIds": [
248 0
249 ],
250 "partners": [
251 {
252 "id": 0,
253 "status": "CREATED",
254 "displayId": "string",
255 "erpSystemId": 0,
256 "erpSystemDisplayId": "string",
257 "name": "string",
258 "fax": "string",
259 "phone": "string",
260 "parentId": 0,
261 "parentName": "string",
262 "parentDisplayId": "string",
263 "companyId": 0,
264 "partnerRoleId": 0,
265 "partnerContactId": 0
266 }
267 ]
268 }
269 }
270 ]
271 }
272]
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 "subjectId": 0,
11 "categoryId": 0,
12 "statusId": 0,
13 "reminderTypeId": 0,
14 "date": "2019-08-24",
15 "followUpDate": "2019-08-24",
16 "comments": "string",
17 "primaryUserId": 0,
18 "subject": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "category": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 },
74 "status": {
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 "reminderType": {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "priority": 0,
111 "internalId": 0,
112 "pickListCode": "string",
113 "pickListLabel": "string",
114 "label": "string",
115 "cultureId": 0,
116 "labelDtos": [
117 {
118 "createdBy": "string",
119 "lastModifiedBy": "string",
120 "createdDate": "2019-08-24T14:15:22Z",
121 "lastModifiedDate": "2019-08-24T14:15:22Z",
122 "archived": true,
123 "externalId": "string",
124 "id": 0,
125 "cultureId": 0,
126 "value": "string"
127 }
128 ]
129 },
130 "primaryUser": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "email": "string",
139 "userName": "string",
140 "firstName": "string",
141 "lastName": "string",
142 "displayName": "string",
143 "permissions": "string",
144 "internalId": "string",
145 "preferredCulture": {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "name": "string",
154 "code": "string",
155 "defaultCulture": true,
156 "enable": true
157 },
158 "userGroups": [
159 {
160 "createdBy": "string",
161 "lastModifiedBy": "string",
162 "createdDate": "2019-08-24T14:15:22Z",
163 "lastModifiedDate": "2019-08-24T14:15:22Z",
164 "archived": true,
165 "externalId": "string",
166 "id": 0,
167 "name": "string",
168 "description": "string",
169 "internalId": "string"
170 }
171 ],
172 "partnerIds": [
173 0
174 ],
175 "partners": [
176 {
177 "id": 0,
178 "status": "CREATED",
179 "displayId": "string",
180 "erpSystemId": 0,
181 "erpSystemDisplayId": "string",
182 "name": "string",
183 "fax": "string",
184 "phone": "string",
185 "parentId": 0,
186 "parentName": "string",
187 "parentDisplayId": "string",
188 "companyId": 0,
189 "partnerRoleId": 0,
190 "partnerContactId": 0
191 }
192 ]
193 },
194 "leaseExternalId": "string",
195 "premiseName": "string",
196 "reminderUserDtos": [
197 {
198 "createdBy": "string",
199 "lastModifiedBy": "string",
200 "createdDate": "2019-08-24T14:15:22Z",
201 "lastModifiedDate": "2019-08-24T14:15:22Z",
202 "archived": true,
203 "externalId": "string",
204 "acknowledge": true,
205 "userDto": {
206 "createdBy": "string",
207 "lastModifiedBy": "string",
208 "createdDate": "2019-08-24T14:15:22Z",
209 "lastModifiedDate": "2019-08-24T14:15:22Z",
210 "archived": true,
211 "externalId": "string",
212 "id": 0,
213 "email": "string",
214 "userName": "string",
215 "firstName": "string",
216 "lastName": "string",
217 "displayName": "string",
218 "permissions": "string",
219 "internalId": "string",
220 "preferredCulture": {
221 "createdBy": "string",
222 "lastModifiedBy": "string",
223 "createdDate": "2019-08-24T14:15:22Z",
224 "lastModifiedDate": "2019-08-24T14:15:22Z",
225 "archived": true,
226 "externalId": "string",
227 "id": 0,
228 "name": "string",
229 "code": "string",
230 "defaultCulture": true,
231 "enable": true
232 },
233 "userGroups": [
234 {
235 "createdBy": "string",
236 "lastModifiedBy": "string",
237 "createdDate": "2019-08-24T14:15:22Z",
238 "lastModifiedDate": "2019-08-24T14:15:22Z",
239 "archived": true,
240 "externalId": "string",
241 "id": 0,
242 "name": "string",
243 "description": "string",
244 "internalId": "string"
245 }
246 ],
247 "partnerIds": [
248 0
249 ],
250 "partners": [
251 {
252 "id": 0,
253 "status": "CREATED",
254 "displayId": "string",
255 "erpSystemId": 0,
256 "erpSystemDisplayId": "string",
257 "name": "string",
258 "fax": "string",
259 "phone": "string",
260 "parentId": 0,
261 "parentName": "string",
262 "parentDisplayId": "string",
263 "companyId": 0,
264 "partnerRoleId": 0,
265 "partnerContactId": 0
266 }
267 ]
268 }
269 }
270 ]
271 }
272]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a reminder associated with portfolio management activities, specifically designed to enhance asset tracking 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 |
» subjectId |
integer(int64) |
false |
none |
Unique identifier for the subject |
» categoryId |
integer(int64) |
false |
none |
Unique identifier for the category |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» reminderTypeId |
integer(int64) |
false |
none |
Unique identifier for the reminder type |
» date |
string(date) |
false |
none |
Date of the resource |
» followUpDate |
string(date) |
false |
none |
Date of the follow up |
» comments |
string |
false |
none |
User-provided remarks or notes related to the portfolio, asset, or real estate property, enhancing the analytical insights within the Nakisa Portfolio Management Suite. |
» primaryUserId |
integer(int64) |
true |
none |
Unique identifier for the primary user |
» subject |
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. |
» 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. |
|
» reminderType |
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. |
|
» primaryUser |
false |
none |
Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions 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 |
string |
true |
none |
Email address of the user, utilized for communication and notifications related to portfolio, asset, and analytics management within the Nakisa Portfolio Management Suite. |
|
»» userName |
string |
true |
none |
Name of the user |
»» firstName |
string |
true |
none |
Name of the first |
»» lastName |
string |
true |
none |
Name of the last |
»» displayName |
string |
false |
none |
Display name for user interface |
»» permissions |
string |
false |
none |
Specifies the access rights assigned to a user within the Nakisa Portfolio Management Suite, governing their interactions with portfolio, asset, analytics, and real estate property data. |
»» internalId |
string |
false |
none |
Unique identifier for the internal |
»» preferredCulture |
false |
none |
Data transfer object representing cultural attributes and insights related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating informed decision-making in 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 |
false |
none |
Name of the resource |
»»» code |
string |
false |
none |
Code identifier for the resource |
»»» defaultCulture |
boolean |
false |
none |
Boolean flag indicating defaultCulture status |
»»» enable |
boolean |
false |
none |
Boolean flag indicating enable status |
»» userGroups |
false |
none |
User information related to portfolio 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 |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalId |
string |
false |
none |
Unique identifier for the internal |
»» partnerIds |
[integer] |
false |
none |
List of partnerIds items |
»» partners |
false |
none |
List of partners items |
|
»»» 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 |
»»» fax |
string |
false |
none |
Fax number associated with the partner, used for communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»»» phone |
string |
false |
none |
Contact number for the partner associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»»» parentId |
integer(int64) |
false |
none |
Unique identifier for the parent |
»»» parentName |
string |
false |
none |
Name of the parent |
»»» parentDisplayId |
string |
false |
none |
Unique identifier for the parent display |
»»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»»» partnerRoleId |
integer(int64) |
false |
none |
Unique identifier for the partner role |
»»» partnerContactId |
integer(int64) |
false |
none |
Unique identifier for the partner contact |
» leaseExternalId |
string |
false |
none |
Unique identifier for the lease external |
» premiseName |
string |
false |
none |
Name of the premise |
» reminderUserDtos |
false |
none |
User information related to portfolio 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 |
»» acknowledge |
boolean |
false |
none |
Boolean flag indicating acknowledge status |
»» userDto |
false |
none |
Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions related to real estate properties. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Perform Transition¶
HTTP Request
POST /api/leases/{id}/perform-transition
📋 Description: Initiates a transition for a specified lease within the Nakisa Portfolio Management Suite, enabling users to manage lease lifecycle events effectively in the context of portfolio and asset analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the lease transition details, including the new status and relevant metadata for effective portfolio and asset management. |
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 |
Lease - Create Percentage Rent Periods¶
HTTP Request
POST /api/leases/{id}/percentage-rent-periods
📋 Description: Creates a new percentage rent period for a specified lease within the Nakisa Portfolio Management Suite, enabling enhanced financial analytics and management of real estate property assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the percentage rent period details, including start and end dates, applicable rates, and associated metadata for lease 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 "startDate": "2019-08-24",
11 "endDate": "2019-08-24"
12 }
13]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24"
12 }
13]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the percentage rent period details for real estate assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and financial assessments.] |
|
» 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) |
true |
none |
Start date of the resource |
» endDate |
string(date) |
true |
none |
End date of the resource |
Lease - Create Percentage Rent Generation Periods¶
HTTP Request
POST /api/leases/{id}/percentage-rent-generation-periods
📋 Description: Creates a new percentage rent generation period for a specified lease, enabling enhanced analytics and reporting capabilities within the Nakisa Portfolio Management Suite for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the percentage rent generation period data, including relevant financial metrics and lease details, for effective portfolio and asset management in real estate analytics. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24"
12 }
13]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24"
12 }
13]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the percentage rent generation period for real estate assets within the Nakisa Portfolio Management Suite, facilitating analytics and portfolio management by capturing essential rental metrics.] |
|
» 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) |
true |
none |
Start date of the resource |
» endDate |
string(date) |
true |
none |
End date of the resource |
Lease - Get Lease Notes¶
HTTP Request
GET /api/leases/{id}/notes
📋 Description: Retrieves notes associated with a specific lease, providing insights into portfolio management and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the lease notes retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter notes associated with a specific lease, enhancing the ability to analyze portfolio and asset information within the Nakisa Portfolio Management Suite. |
message |
query |
string |
false |
Textual content of the note associated with the specified lease, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Lease - Create Lease Notes¶
HTTP Request
POST /api/leases/{id}/notes
📋 Description: Adds a new note to the specified lease within the Nakisa Portfolio Management Suite, enhancing asset management and analytics capabilities 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, to be associated with a specific lease within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» message |
string |
true |
none |
Textual content providing detailed information or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
URL to which users will be redirected after completing a specific action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio, asset, and real estate property management. |
Lease - Create Lease Master Agreement¶
HTTP Request
POST /api/leases/{id}/master-agreement
📋 Description: Creates a master agreement for a specified lease within the Nakisa Portfolio Management Suite, enabling enhanced management and analytics of 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 the master agreement details for the specified lease, including terms, conditions, and associated metadata relevant to portfolio and asset management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "year": 1900,
5 "name": "string",
6 "description": "string",
7 "validFrom": "2019-08-24",
8 "validTo": "2019-08-24",
9 "targetValue": 0.1,
10 "legalJurisdiction": "string",
11 "approverComment": "string",
12 "signingPerson": "string",
13 "placeOfSignature": "string",
14 "dateOfSignature": "2019-08-24",
15 "state": "MLA_DEFINE",
16 "dataCreationInfo": {
17 "id": 0,
18 "idGenerationType": "AUTO",
19 "source": "string",
20 "type": "MIGRATION",
21 "startDateTime": "2019-08-24T14:15:22Z",
22 "endDateTime": "2019-08-24T14:15:22Z"
23 },
24 "agreementGroup": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string"
29 },
30 "currency": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "decimalPoints": 0
36 },
37 "internalAssetClass": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "assetClassType": "PROPERTY",
43 "infiniteUsefulLife": true
44 },
45 "leaseArea": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string"
50 },
51 "businessUnit": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "companyCode": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "erpSystemId": 0,
62 "erpSystemDisplayId": "string",
63 "countryId": 0,
64 "countryDisplayId": "string",
65 "name": "string",
66 "postingPeriodVariantId": 0,
67 "fiscalVariantId": 0
68 },
69 "department": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string"
74 },
75 "leaseGroup": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string"
80 },
81 "allowsSystemGenerateNewId": true,
82 "numberRangeIdentifierType": {
83 "name": "string"
84 },
85 "numberRangeIdentifierValue": "string",
86 "numberRangeType": {
87 "name": "string"
88 }
89}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "year": 1900,
5 "name": "string",
6 "description": "string",
7 "validFrom": "2019-08-24",
8 "validTo": "2019-08-24",
9 "targetValue": 0.1,
10 "legalJurisdiction": "string",
11 "approverComment": "string",
12 "signingPerson": "string",
13 "placeOfSignature": "string",
14 "dateOfSignature": "2019-08-24",
15 "state": "MLA_DEFINE",
16 "dataCreationInfo": {
17 "id": 0,
18 "idGenerationType": "AUTO",
19 "source": "string",
20 "type": "MIGRATION",
21 "startDateTime": "2019-08-24T14:15:22Z",
22 "endDateTime": "2019-08-24T14:15:22Z"
23 },
24 "agreementGroup": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string"
29 },
30 "currency": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "decimalPoints": 0
36 },
37 "internalAssetClass": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "assetClassType": "PROPERTY",
43 "infiniteUsefulLife": true
44 },
45 "leaseArea": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string"
50 },
51 "businessUnit": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "companyCode": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "erpSystemId": 0,
62 "erpSystemDisplayId": "string",
63 "countryId": 0,
64 "countryDisplayId": "string",
65 "name": "string",
66 "postingPeriodVariantId": 0,
67 "fiscalVariantId": 0
68 },
69 "department": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string"
74 },
75 "leaseGroup": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string"
80 },
81 "allowsSystemGenerateNewId": true,
82 "numberRangeIdentifierType": {
83 "name": "string"
84 },
85 "numberRangeIdentifierValue": "string",
86 "numberRangeType": {
87 "name": "string"
88 }
89}
Lease - Create Lease Reconciliation Periods¶
HTTP Request
POST /api/leases/{id}/lease-reconciliation-periods
📋 Description: Creates a new lease reconciliation period for the specified lease, enabling accurate tracking and analysis of financial obligations within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the lease reconciliation period details, including financial metrics and relevant asset identifiers, essential for accurate portfolio and asset analytics 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 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "statusId": 0,
13 "invoiceAmount": 0,
14 "receivedDate": "2019-08-24",
15 "acceptedAmount": 0,
16 "reviewedBy": "string",
17 "reviewedDate": "2019-08-24",
18 "fullReconciliation": true,
19 "status": {
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 "operatingCostPeriodId": 0,
48 "reconciledExpenseCategoryDtos": [
49 {
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 "expenseGroupId": 0,
58 "totalCost": 0,
59 "accrualAmount": 0,
60 "balance": 0,
61 "expenseGroup": {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "priority": 0,
70 "internalId": 0,
71 "pickListCode": "string",
72 "pickListLabel": "string",
73 "label": "string",
74 "cultureId": 0,
75 "labelDtos": [
76 {
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 "cultureId": 0,
85 "value": "string"
86 }
87 ]
88 },
89 "reconciledExpenseDtos": [
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 "totalCost": 0,
99 "operatingCostExpenseTypeId": 0,
100 "operatingCostExpenseType": {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "priority": 0,
109 "internalId": 0,
110 "pickListCode": "string",
111 "pickListLabel": "string",
112 "label": "string",
113 "cultureId": 0,
114 "labelDtos": [
115 {
116 "createdBy": "string",
117 "lastModifiedBy": "string",
118 "createdDate": "2019-08-24T14:15:22Z",
119 "lastModifiedDate": "2019-08-24T14:15:22Z",
120 "archived": true,
121 "externalId": "string",
122 "id": 0,
123 "cultureId": 0,
124 "value": "string"
125 }
126 ]
127 },
128 "reconciledExpenseSegmentDtos": [
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 "startDate": "2019-08-24",
138 "endDate": "2019-08-24",
139 "adjustedLocationCost": 0,
140 "proSharePercentage": 0,
141 "proShareCost": 0,
142 "cap": 0,
143 "subtotalCost": 0,
144 "adminFees": 0,
145 "totalCost": 0,
146 "conditionDto": {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "parentConditionId": 0,
155 "typeId": 0,
156 "startDate": "2019-08-24",
157 "endDate": "2019-08-24",
158 "replaceById": 0,
159 "managedById": 0,
160 "payById": 0,
161 "adminFee": 0,
162 "fixedIncreasePercentage": 0,
163 "note": "string",
164 "pageNumber": "string",
165 "section": "string",
166 "type": {
167 "createdBy": "string",
168 "lastModifiedBy": "string",
169 "createdDate": "2019-08-24T14:15:22Z",
170 "lastModifiedDate": "2019-08-24T14:15:22Z",
171 "archived": true,
172 "externalId": "string",
173 "id": 0,
174 "priority": 0,
175 "internalId": 0,
176 "pickListCode": "string",
177 "pickListLabel": "string",
178 "label": "string",
179 "cultureId": 0,
180 "labelDtos": []
181 },
182 "replaceBy": {
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 "priority": 0,
191 "internalId": 0,
192 "pickListCode": "string",
193 "pickListLabel": "string",
194 "label": "string",
195 "cultureId": 0,
196 "labelDtos": []
197 },
198 "managedBy": {
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 "payBy": {
215 "createdBy": "string",
216 "lastModifiedBy": "string",
217 "createdDate": "2019-08-24T14:15:22Z",
218 "lastModifiedDate": "2019-08-24T14:15:22Z",
219 "archived": true,
220 "externalId": "string",
221 "id": 0,
222 "priority": 0,
223 "internalId": 0,
224 "pickListCode": "string",
225 "pickListLabel": "string",
226 "label": "string",
227 "cultureId": 0,
228 "labelDtos": []
229 },
230 "proShareDto": {
231 "createdBy": "string",
232 "lastModifiedBy": "string",
233 "createdDate": "2019-08-24T14:15:22Z",
234 "lastModifiedDate": "2019-08-24T14:15:22Z",
235 "archived": true,
236 "externalId": "string",
237 "id": 0,
238 "type": "string"
239 },
240 "capDto": {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "type": "string"
249 }
250 }
251 }
252 ]
253 }
254 ],
255 "hasWarning": true
256 }
257 ]
258 }
259]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "statusId": 0,
13 "invoiceAmount": 0,
14 "receivedDate": "2019-08-24",
15 "acceptedAmount": 0,
16 "reviewedBy": "string",
17 "reviewedDate": "2019-08-24",
18 "fullReconciliation": true,
19 "status": {
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 "operatingCostPeriodId": 0,
48 "reconciledExpenseCategoryDtos": [
49 {
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 "expenseGroupId": 0,
58 "totalCost": 0,
59 "accrualAmount": 0,
60 "balance": 0,
61 "expenseGroup": {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "priority": 0,
70 "internalId": 0,
71 "pickListCode": "string",
72 "pickListLabel": "string",
73 "label": "string",
74 "cultureId": 0,
75 "labelDtos": [
76 {
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 "cultureId": 0,
85 "value": "string"
86 }
87 ]
88 },
89 "reconciledExpenseDtos": [
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 "totalCost": 0,
99 "operatingCostExpenseTypeId": 0,
100 "operatingCostExpenseType": {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "priority": 0,
109 "internalId": 0,
110 "pickListCode": "string",
111 "pickListLabel": "string",
112 "label": "string",
113 "cultureId": 0,
114 "labelDtos": [
115 {
116 "createdBy": "string",
117 "lastModifiedBy": "string",
118 "createdDate": "2019-08-24T14:15:22Z",
119 "lastModifiedDate": "2019-08-24T14:15:22Z",
120 "archived": true,
121 "externalId": "string",
122 "id": 0,
123 "cultureId": 0,
124 "value": "string"
125 }
126 ]
127 },
128 "reconciledExpenseSegmentDtos": [
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 "startDate": "2019-08-24",
138 "endDate": "2019-08-24",
139 "adjustedLocationCost": 0,
140 "proSharePercentage": 0,
141 "proShareCost": 0,
142 "cap": 0,
143 "subtotalCost": 0,
144 "adminFees": 0,
145 "totalCost": 0,
146 "conditionDto": {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "parentConditionId": 0,
155 "typeId": 0,
156 "startDate": "2019-08-24",
157 "endDate": "2019-08-24",
158 "replaceById": 0,
159 "managedById": 0,
160 "payById": 0,
161 "adminFee": 0,
162 "fixedIncreasePercentage": 0,
163 "note": "string",
164 "pageNumber": "string",
165 "section": "string",
166 "type": {
167 "createdBy": "string",
168 "lastModifiedBy": "string",
169 "createdDate": "2019-08-24T14:15:22Z",
170 "lastModifiedDate": "2019-08-24T14:15:22Z",
171 "archived": true,
172 "externalId": "string",
173 "id": 0,
174 "priority": 0,
175 "internalId": 0,
176 "pickListCode": "string",
177 "pickListLabel": "string",
178 "label": "string",
179 "cultureId": 0,
180 "labelDtos": []
181 },
182 "replaceBy": {
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 "priority": 0,
191 "internalId": 0,
192 "pickListCode": "string",
193 "pickListLabel": "string",
194 "label": "string",
195 "cultureId": 0,
196 "labelDtos": []
197 },
198 "managedBy": {
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 "payBy": {
215 "createdBy": "string",
216 "lastModifiedBy": "string",
217 "createdDate": "2019-08-24T14:15:22Z",
218 "lastModifiedDate": "2019-08-24T14:15:22Z",
219 "archived": true,
220 "externalId": "string",
221 "id": 0,
222 "priority": 0,
223 "internalId": 0,
224 "pickListCode": "string",
225 "pickListLabel": "string",
226 "label": "string",
227 "cultureId": 0,
228 "labelDtos": []
229 },
230 "proShareDto": {
231 "createdBy": "string",
232 "lastModifiedBy": "string",
233 "createdDate": "2019-08-24T14:15:22Z",
234 "lastModifiedDate": "2019-08-24T14:15:22Z",
235 "archived": true,
236 "externalId": "string",
237 "id": 0,
238 "type": "string"
239 },
240 "capDto": {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "type": "string"
249 }
250 }
251 }
252 ]
253 }
254 ],
255 "hasWarning": true
256 }
257 ]
258 }
259]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the lease reconciliation period, encompassing key details related to portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating analytics and reporting 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 |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» invoiceAmount |
number |
false |
none |
Amount of invoice |
» receivedDate |
string(date) |
false |
none |
Date of the received |
» acceptedAmount |
number |
false |
none |
Amount of accepted |
» reviewedBy |
string |
false |
none |
Identifier of the individual or entity that has reviewed the lease reconciliation period, facilitating accountability and transparency in portfolio and asset management within the Nakisa Portfolio Management Suite. |
» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
» fullReconciliation |
boolean |
false |
none |
Boolean flag indicating fullReconciliation status |
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» 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. |
» operatingCostPeriodId |
integer(int64) |
false |
none |
Unique identifier for the operating cost period |
» reconciledExpenseCategoryDtos |
false |
none |
List of reconciledExpenseCategoryDtos items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» expenseGroupId |
integer(int64) |
false |
none |
Unique identifier for the expense group |
»» totalCost |
number |
false |
none |
Value for totalCost field |
»» accrualAmount |
number |
false |
none |
Amount of accrual |
»» balance |
number |
false |
none |
Value for balance field |
»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» reconciledExpenseDtos |
false |
none |
List of reconciledExpenseDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» reconciledExpenseSegmentDtos |
false |
none |
List of reconciledExpenseSegmentDtos items |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»» adjustedLocationCost |
number |
false |
none |
Value for adjustedLocationCost field |
»»»» proSharePercentage |
number |
false |
none |
Percentage of pro share |
»»»» proShareCost |
number |
false |
none |
Value for proShareCost field |
»»»» cap |
number |
false |
none |
Value for cap field |
»»»» subtotalCost |
number |
false |
none |
Value for subtotalCost field |
»»»» adminFees |
number |
false |
none |
Value for adminFees field |
»»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»»» conditionDto |
false |
none |
Data transfer object representing the conditions associated with a lease within the Nakisa Portfolio Management Suite, facilitating insights and analytics for real estate property management and portfolio optimization. |
|
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» parentConditionId |
integer(int64) |
false |
none |
none |
»»»»» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»» replaceById |
integer(int64) |
false |
none |
Unique identifier for the replace by |
»»»»» managedById |
integer(int64) |
false |
none |
Unique identifier for the managed by |
»»»»» payById |
integer(int64) |
false |
none |
Unique identifier for the pay by |
»»»»» adminFee |
number |
false |
none |
Value for adminFee field |
»»»»» fixedIncreasePercentage |
number |
false |
none |
Percentage of fixed increase |
»»»»» note |
string |
false |
none |
Textual commentary or observations related to the lease condition, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»»»»» pageNumber |
string |
false |
none |
Page number for pagination |
»»»»» section |
string |
false |
none |
Identifies the specific section of the lease conditions relevant to the portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite. |
»»»»» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»» replaceBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»» managedBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»» payBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»» proShareDto |
any |
false |
none |
Value for proShareDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
|
»»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing area-based professional sharing insights within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making related to portfolio and asset management in real estate properties. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»» dividendAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»» divisorAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»» dividendAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»» divisorAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»» dividendAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»»»» divisorAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing a fixed percentage profit-sharing arrangement within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate property assets in portfolio management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»» fixedPercentage |
number |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»» capDto |
any |
false |
none |
Value for capDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
|
»»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing fixed capital assets within the Nakisa Portfolio Management Suite, encompassing key attributes for portfolio analysis, asset management, and real estate property evaluation. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»» amount |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»» cumulative |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» anonymous |
false |
none |
Data transfer object representing the annual capital allocation projections for real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and asset management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»» cumulative |
boolean |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» hasWarning |
boolean |
false |
none |
Whether the resource has has warning |
Lease - Create Lease Incentives¶
HTTP Request
POST /api/leases/{id}/lease-incentives
📋 Description: Creates a new lease incentive for a specified lease within the Nakisa Portfolio Management Suite, enabling enhanced financial analysis and optimization of 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 the lease incentive details, including financial terms and conditions, to enhance portfolio management and asset analytics 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 "totalAmount": 0,
11 "pageNumber": "string",
12 "section": "string",
13 "typeId": 0,
14 "type": {
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]
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 "totalAmount": 0,
11 "pageNumber": "string",
12 "section": "string",
13 "typeId": 0,
14 "type": {
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]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing lease incentives associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analysis for enhanced decision-making in real estate 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 |
» totalAmount |
number |
false |
none |
Amount of total |
» pageNumber |
string |
false |
none |
Page number for pagination |
» section |
string |
false |
none |
Specifies the designated section of the real estate property within the portfolio for analytical and management purposes. |
» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
» 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. |
Lease - Create Lease Critical Clause Types¶
HTTP Request
POST /api/leases/{id}/lease-critical-clause-types
📋 Description: Creates a new critical lease clause type for the specified lease, enhancing portfolio management and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the critical clause type data associated with a specific lease, including relevant attributes for effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "typeId": 0,
11 "notApplicable": true,
12 "type": {
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 "leaseId": 0,
41 "leaseDto": {
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 "typeId": 0,
50 "terminatingLease": "2019-08-24",
51 "maximumDateTo": "2019-08-24",
52 "number": "string",
53 "validFrom": "2019-08-24",
54 "validTo": "2019-08-24",
55 "categoryId": 0,
56 "registrationNumber": "string",
57 "statusId": 0,
58 "stateId": 0,
59 "calculateTax": true,
60 "autoMonthToMonth": true,
61 "originalLeaseId": 0,
62 "scenario": true,
63 "parentLeaseId": 0,
64 "areasHistoryVersionId": 0,
65 "provisioningFrequencyName": "string",
66 "accountingApproved": true,
67 "indexationType": "string",
68 "cpiGlobalCategoryId": 0,
69 "indexationReferenceDate": "2019-08-24",
70 "currentIndexLevel": 0.1,
71 "conditionallyIndexed": true,
72 "applicableCurrentIndexLevel": 0.1,
73 "indexLevelPercentageChangeLowerBound": 0.1,
74 "indexLevelPercentageChangeUpperBound": 0.1,
75 "indexationTypeNonLease": "string",
76 "cpiGlobalCategoryIdNonLease": 0,
77 "indexationReferenceDateNonLease": "2019-08-24",
78 "currentIndexLevelNonLease": 0.1,
79 "conditionallyIndexedNonLease": true,
80 "applicableCurrentIndexLevelNonLease": 0.1,
81 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
82 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
83 "signatureDate": "2019-08-24",
84 "premiseId": 0,
85 "type": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "category": {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "priority": 0,
122 "internalId": 0,
123 "pickListCode": "string",
124 "pickListLabel": "string",
125 "label": "string",
126 "cultureId": 0,
127 "labelDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "cultureId": 0,
137 "value": "string"
138 }
139 ]
140 },
141 "status": {
142 "createdBy": "string",
143 "lastModifiedBy": "string",
144 "createdDate": "2019-08-24T14:15:22Z",
145 "lastModifiedDate": "2019-08-24T14:15:22Z",
146 "archived": true,
147 "externalId": "string",
148 "id": 0,
149 "priority": 0,
150 "internalId": 0,
151 "pickListCode": "string",
152 "pickListLabel": "string",
153 "label": "string",
154 "cultureId": 0,
155 "labelDtos": [
156 {
157 "createdBy": "string",
158 "lastModifiedBy": "string",
159 "createdDate": "2019-08-24T14:15:22Z",
160 "lastModifiedDate": "2019-08-24T14:15:22Z",
161 "archived": true,
162 "externalId": "string",
163 "id": 0,
164 "cultureId": 0,
165 "value": "string"
166 }
167 ]
168 },
169 "state": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "priority": 0,
178 "internalId": 0,
179 "pickListCode": "string",
180 "pickListLabel": "string",
181 "label": "string",
182 "cultureId": 0,
183 "labelDtos": [
184 {
185 "createdBy": "string",
186 "lastModifiedBy": "string",
187 "createdDate": "2019-08-24T14:15:22Z",
188 "lastModifiedDate": "2019-08-24T14:15:22Z",
189 "archived": true,
190 "externalId": "string",
191 "id": 0,
192 "cultureId": 0,
193 "value": "string"
194 }
195 ]
196 },
197 "version": {
198 "createdBy": "string",
199 "lastModifiedBy": "string",
200 "createdDate": "2019-08-24T14:15:22Z",
201 "lastModifiedDate": "2019-08-24T14:15:22Z",
202 "archived": true,
203 "externalId": "string",
204 "id": 0,
205 "name": "string",
206 "description": "string",
207 "modificationDate": "2019-08-24",
208 "updateContractRate": true,
209 "leaseEvent": {
210 "createdBy": "string",
211 "lastModifiedBy": "string",
212 "createdDate": "2019-08-24T14:15:22Z",
213 "lastModifiedDate": "2019-08-24T14:15:22Z",
214 "archived": true,
215 "externalId": "string",
216 "id": 0,
217 "typeId": 0,
218 "code": "string",
219 "reviewedBy": "string",
220 "reviewedDate": "2019-08-24",
221 "reviewedStatusId": 0,
222 "activityDate": "2019-08-24",
223 "relatedPickListOptionId": 0,
224 "detail": "string",
225 "note": {
226 "createdBy": "string",
227 "lastModifiedBy": "string",
228 "createdDate": "2019-08-24T14:15:22Z",
229 "lastModifiedDate": "2019-08-24T14:15:22Z",
230 "archived": true,
231 "externalId": "string",
232 "id": 0,
233 "message": "string",
234 "preserveOriginalAudit": true,
235 "originalCreatedBy": "string",
236 "originalCreatedDate": "2019-08-24T14:15:22Z",
237 "originalLastModifiedBy": "string",
238 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
239 },
240 "type": {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "priority": 0,
249 "internalId": 0,
250 "pickListCode": "string",
251 "pickListLabel": "string",
252 "label": "string",
253 "cultureId": 0,
254 "labelDtos": [
255 {
256 "createdBy": "string",
257 "lastModifiedBy": "string",
258 "createdDate": "2019-08-24T14:15:22Z",
259 "lastModifiedDate": "2019-08-24T14:15:22Z",
260 "archived": true,
261 "externalId": "string",
262 "id": 0,
263 "cultureId": 0,
264 "value": "string"
265 }
266 ]
267 },
268 "reviewedStatus": {
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 "priority": 0,
277 "internalId": 0,
278 "pickListCode": "string",
279 "pickListLabel": "string",
280 "label": "string",
281 "cultureId": 0,
282 "labelDtos": [
283 {
284 "createdBy": "string",
285 "lastModifiedBy": "string",
286 "createdDate": "2019-08-24T14:15:22Z",
287 "lastModifiedDate": "2019-08-24T14:15:22Z",
288 "archived": true,
289 "externalId": "string",
290 "id": 0,
291 "cultureId": 0,
292 "value": "string"
293 }
294 ]
295 },
296 "relatedPickListOption": {
297 "createdBy": "string",
298 "lastModifiedBy": "string",
299 "createdDate": "2019-08-24T14:15:22Z",
300 "lastModifiedDate": "2019-08-24T14:15:22Z",
301 "archived": true,
302 "externalId": "string",
303 "id": 0,
304 "priority": 0,
305 "internalId": 0,
306 "pickListCode": "string",
307 "pickListLabel": "string",
308 "label": "string",
309 "cultureId": 0,
310 "labelDtos": [
311 {
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 "cultureId": 0,
320 "value": "string"
321 }
322 ]
323 },
324 "isVisiblePartnerPortal": true
325 },
326 "scenario": true,
327 "isVisibleVendorPortal": true,
328 "isTerminationVersion": true,
329 "terminationDate": "2019-08-24",
330 "penaltyAmount": 0.1,
331 "areasHistoryVersionId": 0
332 },
333 "premiseDto": {
334 "createdBy": "string",
335 "lastModifiedBy": "string",
336 "createdDate": "2019-08-24T14:15:22Z",
337 "lastModifiedDate": "2019-08-24T14:15:22Z",
338 "archived": true,
339 "externalId": "string",
340 "id": 0,
341 "number": "string",
342 "name": "string",
343 "headPremise": true,
344 "possessionDate": "2019-08-24",
345 "openingDate": "2019-08-24",
346 "closingDate": "2019-08-24",
347 "relocationDate": "2019-08-24",
348 "vacatingDate": "2019-08-24",
349 "expansionDate": "2019-08-24",
350 "statusId": 0,
351 "usageId": 0,
352 "parentPremiseId": 0,
353 "costCenterId": 0,
354 "profitCenterId": 0,
355 "legalEntityId": 0,
356 "occupancyIds": [
357 0
358 ],
359 "locationId": 0,
360 "locationDto": {
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 "number": "string",
369 "name": "string",
370 "storeNumber": "string",
371 "defaultCurrencyId": 0,
372 "defaultMeasureId": 0,
373 "typeId": 0,
374 "qualityId": 0,
375 "propertyTypeId": 0,
376 "categoryId": 0,
377 "statusId": 0,
378 "businessUnitId": 0,
379 "groupIds": [
380 0
381 ],
382 "legalEntityIds": [
383 0
384 ],
385 "defaultCurrency": {
386 "id": 0,
387 "status": "CREATED",
388 "displayId": "string",
389 "erpSystemId": 0,
390 "erpSystemDisplayId": "string",
391 "name": "string",
392 "decimalPoints": 0,
393 "depreciationAreaId": 0
394 },
395 "defaultUnitValue": {
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 "unitId": 0,
404 "unitOfMeasureId": 0,
405 "erpSystemId": 0,
406 "unit": {
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 "priority": 0,
415 "internalId": 0,
416 "pickListCode": "string",
417 "pickListLabel": "string",
418 "label": "string",
419 "cultureId": 0,
420 "labelDtos": [
421 {
422 "createdBy": "string",
423 "lastModifiedBy": "string",
424 "createdDate": "2019-08-24T14:15:22Z",
425 "lastModifiedDate": "2019-08-24T14:15:22Z",
426 "archived": true,
427 "externalId": "string",
428 "id": 0,
429 "cultureId": 0,
430 "value": "string"
431 }
432 ]
433 },
434 "unitOfMeasure": {
435 "id": 0,
436 "status": "CREATED",
437 "displayId": "string",
438 "erpSystemId": 0,
439 "erpSystemDisplayId": "string",
440 "name": "string"
441 }
442 },
443 "type": {
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 "quality": {
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 "propertyType": {
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 "category": {
528 "createdBy": "string",
529 "lastModifiedBy": "string",
530 "createdDate": "2019-08-24T14:15:22Z",
531 "lastModifiedDate": "2019-08-24T14:15:22Z",
532 "archived": true,
533 "externalId": "string",
534 "id": 0,
535 "priority": 0,
536 "internalId": 0,
537 "pickListCode": "string",
538 "pickListLabel": "string",
539 "label": "string",
540 "cultureId": 0,
541 "labelDtos": [
542 {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "cultureId": 0,
551 "value": "string"
552 }
553 ]
554 },
555 "status": {
556 "createdBy": "string",
557 "lastModifiedBy": "string",
558 "createdDate": "2019-08-24T14:15:22Z",
559 "lastModifiedDate": "2019-08-24T14:15:22Z",
560 "archived": true,
561 "externalId": "string",
562 "id": 0,
563 "priority": 0,
564 "internalId": 0,
565 "pickListCode": "string",
566 "pickListLabel": "string",
567 "label": "string",
568 "cultureId": 0,
569 "labelDtos": [
570 {
571 "createdBy": "string",
572 "lastModifiedBy": "string",
573 "createdDate": "2019-08-24T14:15:22Z",
574 "lastModifiedDate": "2019-08-24T14:15:22Z",
575 "archived": true,
576 "externalId": "string",
577 "id": 0,
578 "cultureId": 0,
579 "value": "string"
580 }
581 ]
582 },
583 "addressDto": {
584 "createdBy": "string",
585 "lastModifiedBy": "string",
586 "createdDate": "2019-08-24T14:15:22Z",
587 "lastModifiedDate": "2019-08-24T14:15:22Z",
588 "archived": true,
589 "externalId": "string",
590 "id": 0,
591 "street": "string",
592 "civicNumber": "string",
593 "suite": "string",
594 "postalCode": "string",
595 "lon": 0.1,
596 "lat": 0.1,
597 "city": {
598 "createdBy": "string",
599 "lastModifiedBy": "string",
600 "createdDate": "2019-08-24T14:15:22Z",
601 "lastModifiedDate": "2019-08-24T14:15:22Z",
602 "archived": true,
603 "externalId": "string",
604 "id": 0,
605 "name": "string",
606 "province": {
607 "createdBy": "string",
608 "lastModifiedBy": "string",
609 "createdDate": "2019-08-24T14:15:22Z",
610 "lastModifiedDate": "2019-08-24T14:15:22Z",
611 "archived": true,
612 "externalId": "string",
613 "id": 0,
614 "name": "string",
615 "code": "string",
616 "country": {
617 "createdBy": "string",
618 "lastModifiedBy": "string",
619 "createdDate": "2019-08-24T14:15:22Z",
620 "lastModifiedDate": "2019-08-24T14:15:22Z",
621 "archived": true,
622 "externalId": "string",
623 "id": 0,
624 "name": "string",
625 "code": "string"
626 },
627 "provinceCountryKey": "string"
628 },
629 "cityProvinceCountryKey": "string"
630 },
631 "district": {
632 "createdBy": "string",
633 "lastModifiedBy": "string",
634 "createdDate": "2019-08-24T14:15:22Z",
635 "lastModifiedDate": "2019-08-24T14:15:22Z",
636 "archived": true,
637 "externalId": "string",
638 "id": 0,
639 "name": "string",
640 "city": {
641 "createdBy": "string",
642 "lastModifiedBy": "string",
643 "createdDate": "2019-08-24T14:15:22Z",
644 "lastModifiedDate": "2019-08-24T14:15:22Z",
645 "archived": true,
646 "externalId": "string",
647 "id": 0,
648 "name": "string",
649 "province": {
650 "createdBy": "string",
651 "lastModifiedBy": "string",
652 "createdDate": "2019-08-24T14:15:22Z",
653 "lastModifiedDate": "2019-08-24T14:15:22Z",
654 "archived": true,
655 "externalId": "string",
656 "id": 0,
657 "name": "string",
658 "code": "string",
659 "country": {
660 "createdBy": "string",
661 "lastModifiedBy": "string",
662 "createdDate": "2019-08-24T14:15:22Z",
663 "lastModifiedDate": "2019-08-24T14:15:22Z",
664 "archived": true,
665 "externalId": "string",
666 "id": 0,
667 "name": "string",
668 "code": "string"
669 },
670 "provinceCountryKey": "string"
671 },
672 "cityProvinceCountryKey": "string"
673 }
674 },
675 "cityId": 0,
676 "districtId": 0
677 },
678 "secondAddressDto": {
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 "street": "string",
687 "civicNumber": "string",
688 "suite": "string",
689 "postalCode": "string",
690 "lon": 0.1,
691 "lat": 0.1,
692 "city": {
693 "createdBy": "string",
694 "lastModifiedBy": "string",
695 "createdDate": "2019-08-24T14:15:22Z",
696 "lastModifiedDate": "2019-08-24T14:15:22Z",
697 "archived": true,
698 "externalId": "string",
699 "id": 0,
700 "name": "string",
701 "province": {
702 "createdBy": "string",
703 "lastModifiedBy": "string",
704 "createdDate": "2019-08-24T14:15:22Z",
705 "lastModifiedDate": "2019-08-24T14:15:22Z",
706 "archived": true,
707 "externalId": "string",
708 "id": 0,
709 "name": "string",
710 "code": "string",
711 "country": {
712 "createdBy": "string",
713 "lastModifiedBy": "string",
714 "createdDate": "2019-08-24T14:15:22Z",
715 "lastModifiedDate": "2019-08-24T14:15:22Z",
716 "archived": true,
717 "externalId": "string",
718 "id": 0,
719 "name": "string",
720 "code": "string"
721 },
722 "provinceCountryKey": "string"
723 },
724 "cityProvinceCountryKey": "string"
725 },
726 "district": {
727 "createdBy": "string",
728 "lastModifiedBy": "string",
729 "createdDate": "2019-08-24T14:15:22Z",
730 "lastModifiedDate": "2019-08-24T14:15:22Z",
731 "archived": true,
732 "externalId": "string",
733 "id": 0,
734 "name": "string",
735 "city": {
736 "createdBy": "string",
737 "lastModifiedBy": "string",
738 "createdDate": "2019-08-24T14:15:22Z",
739 "lastModifiedDate": "2019-08-24T14:15:22Z",
740 "archived": true,
741 "externalId": "string",
742 "id": 0,
743 "name": "string",
744 "province": {
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 "name": "string",
753 "code": "string",
754 "country": {
755 "createdBy": "string",
756 "lastModifiedBy": "string",
757 "createdDate": "2019-08-24T14:15:22Z",
758 "lastModifiedDate": "2019-08-24T14:15:22Z",
759 "archived": true,
760 "externalId": "string",
761 "id": 0,
762 "name": "string",
763 "code": "string"
764 },
765 "provinceCountryKey": "string"
766 },
767 "cityProvinceCountryKey": "string"
768 }
769 },
770 "cityId": 0,
771 "districtId": 0
772 }
773 },
774 "status": {
775 "createdBy": "string",
776 "lastModifiedBy": "string",
777 "createdDate": "2019-08-24T14:15:22Z",
778 "lastModifiedDate": "2019-08-24T14:15:22Z",
779 "archived": true,
780 "externalId": "string",
781 "id": 0,
782 "priority": 0,
783 "internalId": 0,
784 "pickListCode": "string",
785 "pickListLabel": "string",
786 "label": "string",
787 "cultureId": 0,
788 "labelDtos": [
789 {
790 "createdBy": "string",
791 "lastModifiedBy": "string",
792 "createdDate": "2019-08-24T14:15:22Z",
793 "lastModifiedDate": "2019-08-24T14:15:22Z",
794 "archived": true,
795 "externalId": "string",
796 "id": 0,
797 "cultureId": 0,
798 "value": "string"
799 }
800 ]
801 },
802 "usage": {
803 "createdBy": "string",
804 "lastModifiedBy": "string",
805 "createdDate": "2019-08-24T14:15:22Z",
806 "lastModifiedDate": "2019-08-24T14:15:22Z",
807 "archived": true,
808 "externalId": "string",
809 "id": 0,
810 "priority": 0,
811 "internalId": 0,
812 "pickListCode": "string",
813 "pickListLabel": "string",
814 "label": "string",
815 "cultureId": 0,
816 "labelDtos": [
817 {
818 "createdBy": "string",
819 "lastModifiedBy": "string",
820 "createdDate": "2019-08-24T14:15:22Z",
821 "lastModifiedDate": "2019-08-24T14:15:22Z",
822 "archived": true,
823 "externalId": "string",
824 "id": 0,
825 "cultureId": 0,
826 "value": "string"
827 }
828 ]
829 },
830 "occupanciesDto": [
831 {
832 "createdBy": "string",
833 "lastModifiedBy": "string",
834 "createdDate": "2019-08-24T14:15:22Z",
835 "lastModifiedDate": "2019-08-24T14:15:22Z",
836 "archived": true,
837 "externalId": "string",
838 "id": 0,
839 "priority": 0,
840 "internalId": 0,
841 "pickListCode": "string",
842 "pickListLabel": "string",
843 "label": "string",
844 "cultureId": 0,
845 "labelDtos": [
846 {
847 "createdBy": "string",
848 "lastModifiedBy": "string",
849 "createdDate": "2019-08-24T14:15:22Z",
850 "lastModifiedDate": "2019-08-24T14:15:22Z",
851 "archived": true,
852 "externalId": "string",
853 "id": 0,
854 "cultureId": 0,
855 "value": "string"
856 }
857 ]
858 }
859 ]
860 },
861 "isTerminationVersion": true
862 }
863 }
864]
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 "notApplicable": true,
12 "type": {
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 "leaseId": 0,
41 "leaseDto": {
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 "typeId": 0,
50 "terminatingLease": "2019-08-24",
51 "maximumDateTo": "2019-08-24",
52 "number": "string",
53 "validFrom": "2019-08-24",
54 "validTo": "2019-08-24",
55 "categoryId": 0,
56 "registrationNumber": "string",
57 "statusId": 0,
58 "stateId": 0,
59 "calculateTax": true,
60 "autoMonthToMonth": true,
61 "originalLeaseId": 0,
62 "scenario": true,
63 "parentLeaseId": 0,
64 "areasHistoryVersionId": 0,
65 "provisioningFrequencyName": "string",
66 "accountingApproved": true,
67 "indexationType": "string",
68 "cpiGlobalCategoryId": 0,
69 "indexationReferenceDate": "2019-08-24",
70 "currentIndexLevel": 0.1,
71 "conditionallyIndexed": true,
72 "applicableCurrentIndexLevel": 0.1,
73 "indexLevelPercentageChangeLowerBound": 0.1,
74 "indexLevelPercentageChangeUpperBound": 0.1,
75 "indexationTypeNonLease": "string",
76 "cpiGlobalCategoryIdNonLease": 0,
77 "indexationReferenceDateNonLease": "2019-08-24",
78 "currentIndexLevelNonLease": 0.1,
79 "conditionallyIndexedNonLease": true,
80 "applicableCurrentIndexLevelNonLease": 0.1,
81 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
82 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
83 "signatureDate": "2019-08-24",
84 "premiseId": 0,
85 "type": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "category": {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "priority": 0,
122 "internalId": 0,
123 "pickListCode": "string",
124 "pickListLabel": "string",
125 "label": "string",
126 "cultureId": 0,
127 "labelDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "cultureId": 0,
137 "value": "string"
138 }
139 ]
140 },
141 "status": {
142 "createdBy": "string",
143 "lastModifiedBy": "string",
144 "createdDate": "2019-08-24T14:15:22Z",
145 "lastModifiedDate": "2019-08-24T14:15:22Z",
146 "archived": true,
147 "externalId": "string",
148 "id": 0,
149 "priority": 0,
150 "internalId": 0,
151 "pickListCode": "string",
152 "pickListLabel": "string",
153 "label": "string",
154 "cultureId": 0,
155 "labelDtos": [
156 {
157 "createdBy": "string",
158 "lastModifiedBy": "string",
159 "createdDate": "2019-08-24T14:15:22Z",
160 "lastModifiedDate": "2019-08-24T14:15:22Z",
161 "archived": true,
162 "externalId": "string",
163 "id": 0,
164 "cultureId": 0,
165 "value": "string"
166 }
167 ]
168 },
169 "state": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "priority": 0,
178 "internalId": 0,
179 "pickListCode": "string",
180 "pickListLabel": "string",
181 "label": "string",
182 "cultureId": 0,
183 "labelDtos": [
184 {
185 "createdBy": "string",
186 "lastModifiedBy": "string",
187 "createdDate": "2019-08-24T14:15:22Z",
188 "lastModifiedDate": "2019-08-24T14:15:22Z",
189 "archived": true,
190 "externalId": "string",
191 "id": 0,
192 "cultureId": 0,
193 "value": "string"
194 }
195 ]
196 },
197 "version": {
198 "createdBy": "string",
199 "lastModifiedBy": "string",
200 "createdDate": "2019-08-24T14:15:22Z",
201 "lastModifiedDate": "2019-08-24T14:15:22Z",
202 "archived": true,
203 "externalId": "string",
204 "id": 0,
205 "name": "string",
206 "description": "string",
207 "modificationDate": "2019-08-24",
208 "updateContractRate": true,
209 "leaseEvent": {
210 "createdBy": "string",
211 "lastModifiedBy": "string",
212 "createdDate": "2019-08-24T14:15:22Z",
213 "lastModifiedDate": "2019-08-24T14:15:22Z",
214 "archived": true,
215 "externalId": "string",
216 "id": 0,
217 "typeId": 0,
218 "code": "string",
219 "reviewedBy": "string",
220 "reviewedDate": "2019-08-24",
221 "reviewedStatusId": 0,
222 "activityDate": "2019-08-24",
223 "relatedPickListOptionId": 0,
224 "detail": "string",
225 "note": {
226 "createdBy": "string",
227 "lastModifiedBy": "string",
228 "createdDate": "2019-08-24T14:15:22Z",
229 "lastModifiedDate": "2019-08-24T14:15:22Z",
230 "archived": true,
231 "externalId": "string",
232 "id": 0,
233 "message": "string",
234 "preserveOriginalAudit": true,
235 "originalCreatedBy": "string",
236 "originalCreatedDate": "2019-08-24T14:15:22Z",
237 "originalLastModifiedBy": "string",
238 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
239 },
240 "type": {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "priority": 0,
249 "internalId": 0,
250 "pickListCode": "string",
251 "pickListLabel": "string",
252 "label": "string",
253 "cultureId": 0,
254 "labelDtos": [
255 {
256 "createdBy": "string",
257 "lastModifiedBy": "string",
258 "createdDate": "2019-08-24T14:15:22Z",
259 "lastModifiedDate": "2019-08-24T14:15:22Z",
260 "archived": true,
261 "externalId": "string",
262 "id": 0,
263 "cultureId": 0,
264 "value": "string"
265 }
266 ]
267 },
268 "reviewedStatus": {
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 "priority": 0,
277 "internalId": 0,
278 "pickListCode": "string",
279 "pickListLabel": "string",
280 "label": "string",
281 "cultureId": 0,
282 "labelDtos": [
283 {
284 "createdBy": "string",
285 "lastModifiedBy": "string",
286 "createdDate": "2019-08-24T14:15:22Z",
287 "lastModifiedDate": "2019-08-24T14:15:22Z",
288 "archived": true,
289 "externalId": "string",
290 "id": 0,
291 "cultureId": 0,
292 "value": "string"
293 }
294 ]
295 },
296 "relatedPickListOption": {
297 "createdBy": "string",
298 "lastModifiedBy": "string",
299 "createdDate": "2019-08-24T14:15:22Z",
300 "lastModifiedDate": "2019-08-24T14:15:22Z",
301 "archived": true,
302 "externalId": "string",
303 "id": 0,
304 "priority": 0,
305 "internalId": 0,
306 "pickListCode": "string",
307 "pickListLabel": "string",
308 "label": "string",
309 "cultureId": 0,
310 "labelDtos": [
311 {
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 "cultureId": 0,
320 "value": "string"
321 }
322 ]
323 },
324 "isVisiblePartnerPortal": true
325 },
326 "isVisibleVendorPortal": true,
327 "isTerminationVersion": true,
328 "terminationDate": "2019-08-24",
329 "penaltyAmount": 0.1,
330 "areasHistoryVersionId": 0
331 },
332 "premiseDto": {
333 "createdBy": "string",
334 "lastModifiedBy": "string",
335 "createdDate": "2019-08-24T14:15:22Z",
336 "lastModifiedDate": "2019-08-24T14:15:22Z",
337 "archived": true,
338 "externalId": "string",
339 "id": 0,
340 "number": "string",
341 "name": "string",
342 "headPremise": true,
343 "possessionDate": "2019-08-24",
344 "openingDate": "2019-08-24",
345 "closingDate": "2019-08-24",
346 "relocationDate": "2019-08-24",
347 "vacatingDate": "2019-08-24",
348 "expansionDate": "2019-08-24",
349 "statusId": 0,
350 "usageId": 0,
351 "parentPremiseId": 0,
352 "costCenterId": 0,
353 "profitCenterId": 0,
354 "legalEntityId": 0,
355 "occupancyIds": [
356 0
357 ],
358 "locationId": 0,
359 "locationDto": {
360 "createdBy": "string",
361 "lastModifiedBy": "string",
362 "createdDate": "2019-08-24T14:15:22Z",
363 "lastModifiedDate": "2019-08-24T14:15:22Z",
364 "archived": true,
365 "externalId": "string",
366 "id": 0,
367 "number": "string",
368 "name": "string",
369 "storeNumber": "string",
370 "defaultCurrencyId": 0,
371 "defaultMeasureId": 0,
372 "typeId": 0,
373 "qualityId": 0,
374 "propertyTypeId": 0,
375 "categoryId": 0,
376 "statusId": 0,
377 "businessUnitId": 0,
378 "groupIds": [
379 0
380 ],
381 "legalEntityIds": [
382 0
383 ],
384 "defaultCurrency": {
385 "id": 0,
386 "status": "CREATED",
387 "displayId": "string",
388 "erpSystemId": 0,
389 "erpSystemDisplayId": "string",
390 "name": "string",
391 "decimalPoints": 0,
392 "depreciationAreaId": 0
393 },
394 "defaultUnitValue": {
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 "unitId": 0,
403 "unitOfMeasureId": 0,
404 "erpSystemId": 0,
405 "unit": {
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 "unitOfMeasure": {
434 "id": 0,
435 "status": "CREATED",
436 "displayId": "string",
437 "erpSystemId": 0,
438 "erpSystemDisplayId": "string",
439 "name": "string"
440 }
441 },
442 "type": {
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 "quality": {
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 "propertyType": {
499 "createdBy": "string",
500 "lastModifiedBy": "string",
501 "createdDate": "2019-08-24T14:15:22Z",
502 "lastModifiedDate": "2019-08-24T14:15:22Z",
503 "archived": true,
504 "externalId": "string",
505 "id": 0,
506 "priority": 0,
507 "internalId": 0,
508 "pickListCode": "string",
509 "pickListLabel": "string",
510 "label": "string",
511 "cultureId": 0,
512 "labelDtos": [
513 {
514 "createdBy": "string",
515 "lastModifiedBy": "string",
516 "createdDate": "2019-08-24T14:15:22Z",
517 "lastModifiedDate": "2019-08-24T14:15:22Z",
518 "archived": true,
519 "externalId": "string",
520 "id": 0,
521 "cultureId": 0,
522 "value": "string"
523 }
524 ]
525 },
526 "category": {
527 "createdBy": "string",
528 "lastModifiedBy": "string",
529 "createdDate": "2019-08-24T14:15:22Z",
530 "lastModifiedDate": "2019-08-24T14:15:22Z",
531 "archived": true,
532 "externalId": "string",
533 "id": 0,
534 "priority": 0,
535 "internalId": 0,
536 "pickListCode": "string",
537 "pickListLabel": "string",
538 "label": "string",
539 "cultureId": 0,
540 "labelDtos": [
541 {
542 "createdBy": "string",
543 "lastModifiedBy": "string",
544 "createdDate": "2019-08-24T14:15:22Z",
545 "lastModifiedDate": "2019-08-24T14:15:22Z",
546 "archived": true,
547 "externalId": "string",
548 "id": 0,
549 "cultureId": 0,
550 "value": "string"
551 }
552 ]
553 },
554 "status": {
555 "createdBy": "string",
556 "lastModifiedBy": "string",
557 "createdDate": "2019-08-24T14:15:22Z",
558 "lastModifiedDate": "2019-08-24T14:15:22Z",
559 "archived": true,
560 "externalId": "string",
561 "id": 0,
562 "priority": 0,
563 "internalId": 0,
564 "pickListCode": "string",
565 "pickListLabel": "string",
566 "label": "string",
567 "cultureId": 0,
568 "labelDtos": [
569 {
570 "createdBy": "string",
571 "lastModifiedBy": "string",
572 "createdDate": "2019-08-24T14:15:22Z",
573 "lastModifiedDate": "2019-08-24T14:15:22Z",
574 "archived": true,
575 "externalId": "string",
576 "id": 0,
577 "cultureId": 0,
578 "value": "string"
579 }
580 ]
581 },
582 "addressDto": {
583 "createdBy": "string",
584 "lastModifiedBy": "string",
585 "createdDate": "2019-08-24T14:15:22Z",
586 "lastModifiedDate": "2019-08-24T14:15:22Z",
587 "archived": true,
588 "externalId": "string",
589 "id": 0,
590 "street": "string",
591 "civicNumber": "string",
592 "suite": "string",
593 "postalCode": "string",
594 "lon": 0.1,
595 "lat": 0.1,
596 "city": {
597 "createdBy": "string",
598 "lastModifiedBy": "string",
599 "createdDate": "2019-08-24T14:15:22Z",
600 "lastModifiedDate": "2019-08-24T14:15:22Z",
601 "archived": true,
602 "externalId": "string",
603 "id": 0,
604 "name": "string",
605 "province": {
606 "createdBy": "string",
607 "lastModifiedBy": "string",
608 "createdDate": "2019-08-24T14:15:22Z",
609 "lastModifiedDate": "2019-08-24T14:15:22Z",
610 "archived": true,
611 "externalId": "string",
612 "id": 0,
613 "name": "string",
614 "code": "string",
615 "country": {
616 "createdBy": "string",
617 "lastModifiedBy": "string",
618 "createdDate": "2019-08-24T14:15:22Z",
619 "lastModifiedDate": "2019-08-24T14:15:22Z",
620 "archived": true,
621 "externalId": "string",
622 "id": 0,
623 "name": "string",
624 "code": "string"
625 },
626 "provinceCountryKey": "string"
627 },
628 "cityProvinceCountryKey": "string"
629 },
630 "district": {
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 "name": "string",
639 "city": {
640 "createdBy": "string",
641 "lastModifiedBy": "string",
642 "createdDate": "2019-08-24T14:15:22Z",
643 "lastModifiedDate": "2019-08-24T14:15:22Z",
644 "archived": true,
645 "externalId": "string",
646 "id": 0,
647 "name": "string",
648 "province": {
649 "createdBy": "string",
650 "lastModifiedBy": "string",
651 "createdDate": "2019-08-24T14:15:22Z",
652 "lastModifiedDate": "2019-08-24T14:15:22Z",
653 "archived": true,
654 "externalId": "string",
655 "id": 0,
656 "name": "string",
657 "code": "string",
658 "country": {
659 "createdBy": "string",
660 "lastModifiedBy": "string",
661 "createdDate": "2019-08-24T14:15:22Z",
662 "lastModifiedDate": "2019-08-24T14:15:22Z",
663 "archived": true,
664 "externalId": "string",
665 "id": 0,
666 "name": "string",
667 "code": "string"
668 },
669 "provinceCountryKey": "string"
670 },
671 "cityProvinceCountryKey": "string"
672 }
673 },
674 "cityId": 0,
675 "districtId": 0
676 },
677 "secondAddressDto": {
678 "createdBy": "string",
679 "lastModifiedBy": "string",
680 "createdDate": "2019-08-24T14:15:22Z",
681 "lastModifiedDate": "2019-08-24T14:15:22Z",
682 "archived": true,
683 "externalId": "string",
684 "id": 0,
685 "street": "string",
686 "civicNumber": "string",
687 "suite": "string",
688 "postalCode": "string",
689 "lon": 0.1,
690 "lat": 0.1,
691 "city": {
692 "createdBy": "string",
693 "lastModifiedBy": "string",
694 "createdDate": "2019-08-24T14:15:22Z",
695 "lastModifiedDate": "2019-08-24T14:15:22Z",
696 "archived": true,
697 "externalId": "string",
698 "id": 0,
699 "name": "string",
700 "province": {
701 "createdBy": "string",
702 "lastModifiedBy": "string",
703 "createdDate": "2019-08-24T14:15:22Z",
704 "lastModifiedDate": "2019-08-24T14:15:22Z",
705 "archived": true,
706 "externalId": "string",
707 "id": 0,
708 "name": "string",
709 "code": "string",
710 "country": {
711 "createdBy": "string",
712 "lastModifiedBy": "string",
713 "createdDate": "2019-08-24T14:15:22Z",
714 "lastModifiedDate": "2019-08-24T14:15:22Z",
715 "archived": true,
716 "externalId": "string",
717 "id": 0,
718 "name": "string",
719 "code": "string"
720 },
721 "provinceCountryKey": "string"
722 },
723 "cityProvinceCountryKey": "string"
724 },
725 "district": {
726 "createdBy": "string",
727 "lastModifiedBy": "string",
728 "createdDate": "2019-08-24T14:15:22Z",
729 "lastModifiedDate": "2019-08-24T14:15:22Z",
730 "archived": true,
731 "externalId": "string",
732 "id": 0,
733 "name": "string",
734 "city": {
735 "createdBy": "string",
736 "lastModifiedBy": "string",
737 "createdDate": "2019-08-24T14:15:22Z",
738 "lastModifiedDate": "2019-08-24T14:15:22Z",
739 "archived": true,
740 "externalId": "string",
741 "id": 0,
742 "name": "string",
743 "province": {
744 "createdBy": "string",
745 "lastModifiedBy": "string",
746 "createdDate": "2019-08-24T14:15:22Z",
747 "lastModifiedDate": "2019-08-24T14:15:22Z",
748 "archived": true,
749 "externalId": "string",
750 "id": 0,
751 "name": "string",
752 "code": "string",
753 "country": {
754 "createdBy": "string",
755 "lastModifiedBy": "string",
756 "createdDate": "2019-08-24T14:15:22Z",
757 "lastModifiedDate": "2019-08-24T14:15:22Z",
758 "archived": true,
759 "externalId": "string",
760 "id": 0,
761 "name": "string",
762 "code": "string"
763 },
764 "provinceCountryKey": "string"
765 },
766 "cityProvinceCountryKey": "string"
767 }
768 },
769 "cityId": 0,
770 "districtId": 0
771 }
772 },
773 "status": {
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 "usage": {
802 "createdBy": "string",
803 "lastModifiedBy": "string",
804 "createdDate": "2019-08-24T14:15:22Z",
805 "lastModifiedDate": "2019-08-24T14:15:22Z",
806 "archived": true,
807 "externalId": "string",
808 "id": 0,
809 "priority": 0,
810 "internalId": 0,
811 "pickListCode": "string",
812 "pickListLabel": "string",
813 "label": "string",
814 "cultureId": 0,
815 "labelDtos": [
816 {
817 "createdBy": "string",
818 "lastModifiedBy": "string",
819 "createdDate": "2019-08-24T14:15:22Z",
820 "lastModifiedDate": "2019-08-24T14:15:22Z",
821 "archived": true,
822 "externalId": "string",
823 "id": 0,
824 "cultureId": 0,
825 "value": "string"
826 }
827 ]
828 },
829 "occupanciesDto": [
830 {
831 "createdBy": "string",
832 "lastModifiedBy": "string",
833 "createdDate": "2019-08-24T14:15:22Z",
834 "lastModifiedDate": "2019-08-24T14:15:22Z",
835 "archived": true,
836 "externalId": "string",
837 "id": 0,
838 "priority": 0,
839 "internalId": 0,
840 "pickListCode": "string",
841 "pickListLabel": "string",
842 "label": "string",
843 "cultureId": 0,
844 "labelDtos": [
845 {
846 "createdBy": "string",
847 "lastModifiedBy": "string",
848 "createdDate": "2019-08-24T14:15:22Z",
849 "lastModifiedDate": "2019-08-24T14:15:22Z",
850 "archived": true,
851 "externalId": "string",
852 "id": 0,
853 "cultureId": 0,
854 "value": "string"
855 }
856 ]
857 }
858 ]
859 },
860 "isTerminationVersion": true
861 }
862 }
863]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing critical lease clauses within the Nakisa Portfolio Management Suite, essential for managing portfolio and asset analytics in 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 |
» notApplicable |
boolean |
false |
none |
Boolean flag indicating notApplicable 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. |
» leaseId |
integer(int64) |
false |
none |
Unique identifier for the lease |
» leaseDto |
false |
none |
Data transfer object representing a lease agreement within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset tracking, and real estate 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) |
false |
none |
Unique identifier for the type |
»» terminatingLease |
string(date) |
false |
none |
Indicates the status of the lease termination within the Nakisa Portfolio Management Suite, providing critical insights for portfolio and asset analytics in real estate management. |
»» maximumDateTo |
string(date) |
false |
none |
Specifies the latest date through which lease data can be analyzed within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics. |
»» number |
string |
false |
none |
Represents the unique identification number assigned to a lease within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics. |
»» validFrom |
string(date) |
true |
none |
Date from which the resource is valid |
»» validTo |
string(date) |
true |
none |
Date until which the resource is valid |
»» categoryId |
integer(int64) |
false |
none |
Unique identifier for the category |
»» registrationNumber |
string |
false |
none |
Unique identifier assigned to a lease agreement, facilitating asset tracking and portfolio management within the Nakisa Portfolio Management Suite. |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» stateId |
integer(int64) |
false |
none |
Unique identifier for the state |
»» calculateTax |
boolean |
false |
none |
Boolean flag indicating calculateTax status |
»» autoMonthToMonth |
boolean |
false |
none |
Boolean flag indicating autoMonthToMonth status |
»» originalLeaseId |
integer(int64) |
false |
none |
Unique identifier for the original lease |
»» scenario |
boolean |
false |
none |
Boolean flag indicating scenario status |
»» parentLeaseId |
integer(int64) |
false |
none |
Unique identifier for the parent lease |
»» areasHistoryVersionId |
integer(int64) |
false |
none |
none |
»» provisioningFrequencyName |
string |
false |
none |
Name of the provisioning frequency |
»» accountingApproved |
boolean |
false |
none |
Boolean flag indicating accountingApproved status |
»» indexationType |
string |
true |
none |
Type of the indexation |
»» cpiGlobalCategoryId |
integer(int64) |
false |
none |
Unique identifier for the cpi global category |
»» indexationReferenceDate |
string(date) |
false |
none |
Date of the indexation reference |
»» currentIndexLevel |
number(double) |
false |
none |
Value for currentIndexLevel field |
»» conditionallyIndexed |
boolean |
false |
none |
Indicates whether the lease is subject to conditional indexing, impacting portfolio analytics and asset valuation within the Nakisa Portfolio Management Suite. |
»» applicableCurrentIndexLevel |
number(double) |
false |
none |
Value for applicableCurrentIndexLevel field |
»» indexLevelPercentageChangeLowerBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBound field |
»» indexLevelPercentageChangeUpperBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBound field |
»» indexationTypeNonLease |
string |
true |
none |
Specifies the type of indexation applied to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
»» indexationReferenceDateNonLease |
string(date) |
false |
none |
Represents the reference date for indexation adjustments related to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»» currentIndexLevelNonLease |
number(double) |
false |
none |
Value for currentIndexLevelNonLease field |
»» conditionallyIndexedNonLease |
boolean |
false |
none |
Indicates whether the asset is conditionally indexed, providing critical insights for portfolio analytics and real estate property management within the Nakisa Portfolio Management Suite. |
»» applicableCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for applicableCurrentIndexLevelNonLease field |
»» indexLevelPercentageChangeLowerBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBoundNonLease field |
»» indexLevelPercentageChangeUpperBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBoundNonLease field |
»» signatureDate |
string(date) |
false |
none |
Date of the signature |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» 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. |
|
»» 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. |
|
»» state |
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. |
|
»» version |
false |
none |
Data transfer object representing the versioning information of assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio analytics and management 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 |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» modificationDate |
string(date) |
false |
none |
Date of the modification |
»»» updateContractRate |
boolean |
false |
none |
Rate of update contract |
»»» leaseEvent |
false |
none |
Data transfer object representing an event within the Nakisa Portfolio Management Suite, encapsulating key details related to portfolio management, asset tracking, 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) |
false |
none |
Unique identifier for the type |
»»»» code |
string |
false |
none |
Code identifier for the resource |
»»»» reviewedBy |
string |
false |
none |
Identifier of the user or entity that has reviewed the event, providing accountability and transparency within the portfolio management process. |
»»»» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
»»»» reviewedStatusId |
integer(int64) |
false |
none |
Unique identifier for the reviewed status |
»»»» activityDate |
string(date) |
false |
none |
Date of the activity |
»»»» relatedPickListOptionId |
integer(int64) |
false |
none |
Unique identifier for the related pick list option |
»»»» detail |
string |
false |
none |
Detailed description of the event, providing insights relevant to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»»»» note |
false |
none |
Data transfer object representing a note associated with a portfolio or asset within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for real estate property management. |
|
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» message |
string |
true |
none |
Textual content providing detailed insights or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»»»»» preserveOriginalAudit |
boolean |
false |
none |
Indicates whether to retain the original audit trail for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»»»» originalCreatedBy |
string |
false |
none |
Identifies the original creator of the note within the Nakisa Portfolio Management Suite, providing essential context for portfolio, asset, and real estate property analytics. |
»»»»» originalCreatedDate |
string(date-time) |
false |
none |
Date of the original created |
»»»»» originalLastModifiedBy |
string |
false |
none |
Identifier of the user who last modified the note, providing accountability and traceability within the context of portfolio, asset, and real estate property management. |
»»»»» originalLastModifiedDate |
string(date-time) |
false |
none |
Date of the original last modified |
»»»» 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. |
|
»»»» reviewedStatus |
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. |
|
»»»» relatedPickListOption |
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. |
|
»»»» isVisiblePartnerPortal |
boolean |
false |
none |
none |
»»» scenario |
boolean |
false |
write-only |
Boolean flag indicating scenario status |
»»» isVisibleVendorPortal |
boolean |
false |
none |
Whether the resource is visible vendor portal |
»»» isTerminationVersion |
boolean |
false |
none |
Whether the resource is termination version |
»»» terminationDate |
string(date) |
false |
none |
Date of the termination |
»»» penaltyAmount |
number(double) |
false |
none |
Amount of penalty |
»»» areasHistoryVersionId |
integer(int64) |
false |
none |
none |
»» premiseDto |
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. |
|
»»»»» 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 |
|
»» isTerminationVersion |
boolean |
false |
none |
Whether the resource is termination version |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Create Lease Conditions¶
HTTP Request
POST /api/leases/{id}/lease-conditions
📋 Description: Creates new lease conditions for a specified lease within the Nakisa Portfolio Management Suite, enabling enhanced management and analytics of 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 the lease condition details, including terms and stipulations relevant to the specified lease, to facilitate effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "parentConditionId": 0,
11 "typeId": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "replaceById": 0,
15 "managedById": 0,
16 "payById": 0,
17 "adminFee": 0,
18 "fixedIncreasePercentage": 0,
19 "note": "string",
20 "pageNumber": "string",
21 "section": "string",
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 "replaceBy": {
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 "managedBy": {
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 "payBy": {
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 "proShareDto": {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "type": "string"
143 },
144 "capDto": {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "type": "string"
153 }
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 "parentConditionId": 0,
11 "typeId": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "replaceById": 0,
15 "managedById": 0,
16 "payById": 0,
17 "adminFee": 0,
18 "fixedIncreasePercentage": 0,
19 "note": "string",
20 "pageNumber": "string",
21 "section": "string",
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 "replaceBy": {
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 "managedBy": {
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 "payBy": {
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 "proShareDto": {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "type": "string"
143 },
144 "capDto": {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "type": "string"
153 }
154 }
155]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the conditions associated with a lease within the Nakisa Portfolio Management Suite, facilitating insights and analytics for real estate property management and portfolio optimization.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» parentConditionId |
integer(int64) |
false |
none |
none |
» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» replaceById |
integer(int64) |
false |
none |
Unique identifier for the replace by |
» managedById |
integer(int64) |
false |
none |
Unique identifier for the managed by |
» payById |
integer(int64) |
false |
none |
Unique identifier for the pay by |
» adminFee |
number |
false |
none |
Value for adminFee field |
» fixedIncreasePercentage |
number |
false |
none |
Percentage of fixed increase |
» note |
string |
false |
none |
Textual commentary or observations related to the lease condition, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite. |
» pageNumber |
string |
false |
none |
Page number for pagination |
» section |
string |
false |
none |
Identifies the specific section of the lease conditions relevant to the portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite. |
» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» 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. |
» replaceBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» managedBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» payBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» proShareDto |
any |
false |
none |
Value for proShareDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing area-based professional sharing insights within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making related to portfolio and asset management in real estate properties. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» dividendAreaTypeId |
integer(int64) |
false |
none |
none |
»»»» divisorAreaTypeId |
integer(int64) |
false |
none |
none |
»»»» dividendAreaId |
integer(int64) |
false |
none |
none |
»»»» divisorAreaId |
integer(int64) |
false |
none |
none |
»»»» dividendAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»» divisorAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing a fixed percentage profit-sharing arrangement within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate property assets in portfolio management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» fixedPercentage |
number |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» capDto |
any |
false |
none |
Value for capDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing fixed capital assets within the Nakisa Portfolio Management Suite, encompassing key attributes for portfolio analysis, asset management, and real estate property evaluation. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» amount |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»» baseAmount |
number |
false |
none |
none |
»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»» cumulative |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the annual capital allocation projections for real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and asset management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»» baseAmount |
number |
false |
none |
none |
»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»» cumulative |
boolean |
false |
none |
none |
Lease - Create Lease Clause Types¶
HTTP Request
POST /api/leases/{id}/lease-clause-types
📋 Description: Creates a new lease clause type associated with a specific lease, enhancing the management of portfolio and asset details within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the lease clause type data, including relevant attributes and configurations for managing real estate property leases 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 "notApplicable": true,
12 "type": {
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 "leaseId": 0
41 }
42]
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 "notApplicable": true,
12 "type": {
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 "leaseId": 0
41 }
42]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a lease clause within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio and asset management in 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) |
false |
none |
Unique identifier for the type |
» notApplicable |
boolean |
false |
none |
Boolean flag indicating notApplicable 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. |
» leaseId |
integer(int64) |
false |
none |
Unique identifier for the lease |
Lease - Create Lease Insurances¶
HTTP Request
POST /api/leases/{id}/insurances
📋 Description: Adds a new insurance policy to the specified lease within the Nakisa Portfolio Management Suite, enhancing asset protection and risk management 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 insurance details associated with a specific lease, including coverage types, amounts, and relevant dates, to support effective 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 "pageNumber": "string",
12 "section": "string",
13 "amount": 0,
14 "type": {
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]
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 "pageNumber": "string",
12 "section": "string",
13 "amount": 0,
14 "type": {
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]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing insurance details associated with real estate assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and informed decision-making.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
» pageNumber |
string |
false |
none |
Page number for pagination |
» section |
string |
false |
none |
Represents the specific section of the real estate property within the portfolio, facilitating detailed analytics and asset management in the Nakisa Portfolio Management Suite. |
» amount |
number |
false |
none |
Amount value |
» 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. |
Lease - Finalize Terms Accounting¶
HTTP Request
POST /api/leases/{id}/finalize-terms-accounting
📋 Description: Finalizes the accounting terms for a specified lease within the Nakisa Portfolio Management Suite, ensuring accurate financial reporting and compliance for real estate property management. This operation streamlines the lease management process by integrating 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 |
None |
Lease - Get Lease Events¶
HTTP Request
GET /api/leases/{id}/events
📋 Description: Fetches a list of events associated with a specific lease, providing insights into 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 lease events query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter events related to a specific lease within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
type-id |
query |
string |
false |
Identifier for the specific event type associated with the lease, facilitating targeted analytics within the Nakisa Portfolio Management Suite. |
code |
query |
string |
false |
Code identifier for the resource |
reviewed-by |
query |
string |
false |
Identifier for the user who reviewed the lease event, facilitating enhanced tracking and accountability within the Nakisa Portfolio Management Suite. |
reviewed-date |
query |
string |
false |
Specifies the date on which the lease event was reviewed, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
reviewed-status |
query |
string |
false |
Indicates the review status of events associated with a specific lease, facilitating portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseEvents": [
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 "code": "string",
14 "reviewedBy": "string",
15 "reviewedDate": "2019-08-24",
16 "reviewedStatusId": 0,
17 "activityDate": "2019-08-24",
18 "relatedPickListOptionId": 0,
19 "detail": "string",
20 "note": {
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 "message": "string",
29 "preserveOriginalAudit": true,
30 "originalCreatedBy": "string",
31 "originalCreatedDate": "2019-08-24T14:15:22Z",
32 "originalLastModifiedBy": "string",
33 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
34 },
35 "type": {
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 "priority": 0,
44 "internalId": 0,
45 "pickListCode": "string",
46 "pickListLabel": "string",
47 "label": "string",
48 "cultureId": 0,
49 "labelDtos": [
50 {
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 "cultureId": 0,
59 "value": "string"
60 }
61 ]
62 },
63 "reviewedStatus": {
64 "createdBy": "string",
65 "lastModifiedBy": "string",
66 "createdDate": "2019-08-24T14:15:22Z",
67 "lastModifiedDate": "2019-08-24T14:15:22Z",
68 "archived": true,
69 "externalId": "string",
70 "id": 0,
71 "priority": 0,
72 "internalId": 0,
73 "pickListCode": "string",
74 "pickListLabel": "string",
75 "label": "string",
76 "cultureId": 0,
77 "labelDtos": [
78 {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "cultureId": 0,
87 "value": "string"
88 }
89 ]
90 },
91 "relatedPickListOption": {
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 "priority": 0,
100 "internalId": 0,
101 "pickListCode": "string",
102 "pickListLabel": "string",
103 "label": "string",
104 "cultureId": 0,
105 "labelDtos": [
106 {
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 "cultureId": 0,
115 "value": "string"
116 }
117 ]
118 },
119 "isVisiblePartnerPortal": true,
120 "version": {
121 "createdBy": "string",
122 "lastModifiedBy": "string",
123 "createdDate": "2019-08-24T14:15:22Z",
124 "lastModifiedDate": "2019-08-24T14:15:22Z",
125 "archived": true,
126 "externalId": "string",
127 "id": 0,
128 "name": "string",
129 "description": "string",
130 "modificationDate": "2019-08-24",
131 "updateContractRate": true,
132 "leaseEvent": {
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 "typeId": 0,
141 "code": "string",
142 "reviewedBy": "string",
143 "reviewedDate": "2019-08-24",
144 "reviewedStatusId": 0,
145 "activityDate": "2019-08-24",
146 "relatedPickListOptionId": 0,
147 "detail": "string",
148 "note": {
149 "createdBy": "string",
150 "lastModifiedBy": "string",
151 "createdDate": "2019-08-24T14:15:22Z",
152 "lastModifiedDate": "2019-08-24T14:15:22Z",
153 "archived": true,
154 "externalId": "string",
155 "id": 0,
156 "message": "string",
157 "preserveOriginalAudit": true,
158 "originalCreatedBy": "string",
159 "originalCreatedDate": "2019-08-24T14:15:22Z",
160 "originalLastModifiedBy": "string",
161 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
162 },
163 "type": {
164 "createdBy": "string",
165 "lastModifiedBy": "string",
166 "createdDate": "2019-08-24T14:15:22Z",
167 "lastModifiedDate": "2019-08-24T14:15:22Z",
168 "archived": true,
169 "externalId": "string",
170 "id": 0,
171 "priority": 0,
172 "internalId": 0,
173 "pickListCode": "string",
174 "pickListLabel": "string",
175 "label": "string",
176 "cultureId": 0,
177 "labelDtos": [
178 {
179 "createdBy": "string",
180 "lastModifiedBy": "string",
181 "createdDate": "2019-08-24T14:15:22Z",
182 "lastModifiedDate": "2019-08-24T14:15:22Z",
183 "archived": true,
184 "externalId": "string",
185 "id": 0,
186 "cultureId": 0,
187 "value": "string"
188 }
189 ]
190 },
191 "reviewedStatus": {
192 "createdBy": "string",
193 "lastModifiedBy": "string",
194 "createdDate": "2019-08-24T14:15:22Z",
195 "lastModifiedDate": "2019-08-24T14:15:22Z",
196 "archived": true,
197 "externalId": "string",
198 "id": 0,
199 "priority": 0,
200 "internalId": 0,
201 "pickListCode": "string",
202 "pickListLabel": "string",
203 "label": "string",
204 "cultureId": 0,
205 "labelDtos": [
206 {
207 "createdBy": "string",
208 "lastModifiedBy": "string",
209 "createdDate": "2019-08-24T14:15:22Z",
210 "lastModifiedDate": "2019-08-24T14:15:22Z",
211 "archived": true,
212 "externalId": "string",
213 "id": 0,
214 "cultureId": 0,
215 "value": "string"
216 }
217 ]
218 },
219 "relatedPickListOption": {
220 "createdBy": "string",
221 "lastModifiedBy": "string",
222 "createdDate": "2019-08-24T14:15:22Z",
223 "lastModifiedDate": "2019-08-24T14:15:22Z",
224 "archived": true,
225 "externalId": "string",
226 "id": 0,
227 "priority": 0,
228 "internalId": 0,
229 "pickListCode": "string",
230 "pickListLabel": "string",
231 "label": "string",
232 "cultureId": 0,
233 "labelDtos": [
234 {
235 "createdBy": "string",
236 "lastModifiedBy": "string",
237 "createdDate": "2019-08-24T14:15:22Z",
238 "lastModifiedDate": "2019-08-24T14:15:22Z",
239 "archived": true,
240 "externalId": "string",
241 "id": 0,
242 "cultureId": 0,
243 "value": "string"
244 }
245 ]
246 },
247 "isVisiblePartnerPortal": true
248 },
249 "isVisibleVendorPortal": true,
250 "isTerminationVersion": true,
251 "terminationDate": "2019-08-24",
252 "penaltyAmount": 0.1,
253 "areasHistoryVersionId": 0
254 }
255 }
256 ]
257 },
258 "page": {
259 "size": 0,
260 "totalElements": 0,
261 "totalPages": 0,
262 "number": 0
263 }
264}
Lease - Create Lease Events¶
HTTP Request
POST /api/leases/{id}/events
📋 Description: Creates a new event associated with a specific lease in the Nakisa Portfolio Management Suite, enabling enhanced tracking and analytics of portfolio and asset activities related to 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 event details related to the specified lease, including attributes such as event type, date, and associated analytics 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 "typeId": 0,
11 "code": "string",
12 "reviewedBy": "string",
13 "reviewedDate": "2019-08-24",
14 "reviewedStatusId": 0,
15 "activityDate": "2019-08-24",
16 "relatedPickListOptionId": 0,
17 "detail": "string",
18 "note": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "message": "string",
27 "preserveOriginalAudit": true,
28 "originalCreatedBy": "string",
29 "originalCreatedDate": "2019-08-24T14:15:22Z",
30 "originalLastModifiedBy": "string",
31 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
32 },
33 "type": {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "priority": 0,
42 "internalId": 0,
43 "pickListCode": "string",
44 "pickListLabel": "string",
45 "label": "string",
46 "cultureId": 0,
47 "labelDtos": [
48 {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "cultureId": 0,
57 "value": "string"
58 }
59 ]
60 },
61 "reviewedStatus": {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "priority": 0,
70 "internalId": 0,
71 "pickListCode": "string",
72 "pickListLabel": "string",
73 "label": "string",
74 "cultureId": 0,
75 "labelDtos": [
76 {
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 "cultureId": 0,
85 "value": "string"
86 }
87 ]
88 },
89 "relatedPickListOption": {
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 "priority": 0,
98 "internalId": 0,
99 "pickListCode": "string",
100 "pickListLabel": "string",
101 "label": "string",
102 "cultureId": 0,
103 "labelDtos": [
104 {
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 "cultureId": 0,
113 "value": "string"
114 }
115 ]
116 },
117 "isVisiblePartnerPortal": true
118 }
119]
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 "code": "string",
12 "reviewedBy": "string",
13 "reviewedDate": "2019-08-24",
14 "reviewedStatusId": 0,
15 "activityDate": "2019-08-24",
16 "relatedPickListOptionId": 0,
17 "detail": "string",
18 "note": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "message": "string",
27 "preserveOriginalAudit": true,
28 "originalCreatedBy": "string",
29 "originalCreatedDate": "2019-08-24T14:15:22Z",
30 "originalLastModifiedBy": "string",
31 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
32 },
33 "type": {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "priority": 0,
42 "internalId": 0,
43 "pickListCode": "string",
44 "pickListLabel": "string",
45 "label": "string",
46 "cultureId": 0,
47 "labelDtos": [
48 {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "cultureId": 0,
57 "value": "string"
58 }
59 ]
60 },
61 "reviewedStatus": {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "priority": 0,
70 "internalId": 0,
71 "pickListCode": "string",
72 "pickListLabel": "string",
73 "label": "string",
74 "cultureId": 0,
75 "labelDtos": [
76 {
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 "cultureId": 0,
85 "value": "string"
86 }
87 ]
88 },
89 "relatedPickListOption": {
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 "priority": 0,
98 "internalId": 0,
99 "pickListCode": "string",
100 "pickListLabel": "string",
101 "label": "string",
102 "cultureId": 0,
103 "labelDtos": [
104 {
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 "cultureId": 0,
113 "value": "string"
114 }
115 ]
116 },
117 "isVisiblePartnerPortal": true
118 }
119]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an event within the Nakisa Portfolio Management Suite, encapsulating key details related to portfolio management, asset tracking, 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) |
false |
none |
Unique identifier for the type |
» code |
string |
false |
none |
Code identifier for the resource |
» reviewedBy |
string |
false |
none |
Identifier of the user or entity that has reviewed the event, providing accountability and transparency within the portfolio management process. |
» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
» reviewedStatusId |
integer(int64) |
false |
none |
Unique identifier for the reviewed status |
» activityDate |
string(date) |
false |
none |
Date of the activity |
» relatedPickListOptionId |
integer(int64) |
false |
none |
Unique identifier for the related pick list option |
» detail |
string |
false |
none |
Detailed description of the event, providing insights relevant to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
» note |
false |
none |
Data transfer object representing a note associated with a portfolio or asset within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» message |
string |
true |
none |
Textual content providing detailed insights or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»» preserveOriginalAudit |
boolean |
false |
none |
Indicates whether to retain the original audit trail for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» originalCreatedBy |
string |
false |
none |
Identifies the original creator of the note within the Nakisa Portfolio Management Suite, providing essential context for portfolio, asset, and real estate property analytics. |
»» originalCreatedDate |
string(date-time) |
false |
none |
Date of the original created |
»» originalLastModifiedBy |
string |
false |
none |
Identifier of the user who last modified the note, providing accountability and traceability within the context of portfolio, asset, and real estate property management. |
»» originalLastModifiedDate |
string(date-time) |
false |
none |
Date of the original last modified |
» 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. |
» reviewedStatus |
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. |
|
» relatedPickListOption |
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. |
|
» isVisiblePartnerPortal |
boolean |
false |
none |
none |
Lease - Check NFS Links¶
HTTP Request
POST /api/leases/{id}/check-nfs-links
📋 Description: Checks the Non-Financial Statement (NFS) links associated with a specific lease, enabling users to ensure data integrity and compliance 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 |
None |
Lease - Archive Lease¶
HTTP Request
POST /api/leases/{id}/archive
📋 Description: Archives a specified lease within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and 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 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1,
290 "areasHistoryVersionId": 0
291 },
292 "premiseDto": {
293 "createdBy": "string",
294 "lastModifiedBy": "string",
295 "createdDate": "2019-08-24T14:15:22Z",
296 "lastModifiedDate": "2019-08-24T14:15:22Z",
297 "archived": true,
298 "externalId": "string",
299 "id": 0,
300 "number": "string",
301 "name": "string",
302 "headPremise": true,
303 "possessionDate": "2019-08-24",
304 "openingDate": "2019-08-24",
305 "closingDate": "2019-08-24",
306 "relocationDate": "2019-08-24",
307 "vacatingDate": "2019-08-24",
308 "expansionDate": "2019-08-24",
309 "statusId": 0,
310 "usageId": 0,
311 "parentPremiseId": 0,
312 "costCenterId": 0,
313 "profitCenterId": 0,
314 "legalEntityId": 0,
315 "occupancyIds": [
316 0
317 ],
318 "locationId": 0,
319 "locationDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "number": "string",
328 "name": "string",
329 "storeNumber": "string",
330 "defaultCurrencyId": 0,
331 "defaultMeasureId": 0,
332 "typeId": 0,
333 "qualityId": 0,
334 "propertyTypeId": 0,
335 "categoryId": 0,
336 "statusId": 0,
337 "businessUnitId": 0,
338 "groupIds": [
339 0
340 ],
341 "legalEntityIds": [
342 0
343 ],
344 "defaultCurrency": {
345 "id": 0,
346 "status": "CREATED",
347 "displayId": "string",
348 "erpSystemId": 0,
349 "erpSystemDisplayId": "string",
350 "name": "string",
351 "decimalPoints": 0,
352 "depreciationAreaId": 0
353 },
354 "defaultUnitValue": {
355 "createdBy": "string",
356 "lastModifiedBy": "string",
357 "createdDate": "2019-08-24T14:15:22Z",
358 "lastModifiedDate": "2019-08-24T14:15:22Z",
359 "archived": true,
360 "externalId": "string",
361 "id": 0,
362 "unitId": 0,
363 "unitOfMeasureId": 0,
364 "erpSystemId": 0,
365 "unit": {
366 "createdBy": "string",
367 "lastModifiedBy": "string",
368 "createdDate": "2019-08-24T14:15:22Z",
369 "lastModifiedDate": "2019-08-24T14:15:22Z",
370 "archived": true,
371 "externalId": "string",
372 "id": 0,
373 "priority": 0,
374 "internalId": 0,
375 "pickListCode": "string",
376 "pickListLabel": "string",
377 "label": "string",
378 "cultureId": 0,
379 "labelDtos": [
380 {
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 "cultureId": 0,
389 "value": "string"
390 }
391 ]
392 },
393 "unitOfMeasure": {
394 "id": 0,
395 "status": "CREATED",
396 "displayId": "string",
397 "erpSystemId": 0,
398 "erpSystemDisplayId": "string",
399 "name": "string"
400 }
401 },
402 "type": {
403 "createdBy": "string",
404 "lastModifiedBy": "string",
405 "createdDate": "2019-08-24T14:15:22Z",
406 "lastModifiedDate": "2019-08-24T14:15:22Z",
407 "archived": true,
408 "externalId": "string",
409 "id": 0,
410 "priority": 0,
411 "internalId": 0,
412 "pickListCode": "string",
413 "pickListLabel": "string",
414 "label": "string",
415 "cultureId": 0,
416 "labelDtos": [
417 {
418 "createdBy": "string",
419 "lastModifiedBy": "string",
420 "createdDate": "2019-08-24T14:15:22Z",
421 "lastModifiedDate": "2019-08-24T14:15:22Z",
422 "archived": true,
423 "externalId": "string",
424 "id": 0,
425 "cultureId": 0,
426 "value": "string"
427 }
428 ]
429 },
430 "quality": {
431 "createdBy": "string",
432 "lastModifiedBy": "string",
433 "createdDate": "2019-08-24T14:15:22Z",
434 "lastModifiedDate": "2019-08-24T14:15:22Z",
435 "archived": true,
436 "externalId": "string",
437 "id": 0,
438 "priority": 0,
439 "internalId": 0,
440 "pickListCode": "string",
441 "pickListLabel": "string",
442 "label": "string",
443 "cultureId": 0,
444 "labelDtos": [
445 {
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 "cultureId": 0,
454 "value": "string"
455 }
456 ]
457 },
458 "propertyType": {
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 "priority": 0,
467 "internalId": 0,
468 "pickListCode": "string",
469 "pickListLabel": "string",
470 "label": "string",
471 "cultureId": 0,
472 "labelDtos": [
473 {
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 "cultureId": 0,
482 "value": "string"
483 }
484 ]
485 },
486 "category": {
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 "priority": 0,
495 "internalId": 0,
496 "pickListCode": "string",
497 "pickListLabel": "string",
498 "label": "string",
499 "cultureId": 0,
500 "labelDtos": [
501 {
502 "createdBy": "string",
503 "lastModifiedBy": "string",
504 "createdDate": "2019-08-24T14:15:22Z",
505 "lastModifiedDate": "2019-08-24T14:15:22Z",
506 "archived": true,
507 "externalId": "string",
508 "id": 0,
509 "cultureId": 0,
510 "value": "string"
511 }
512 ]
513 },
514 "status": {
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 "priority": 0,
523 "internalId": 0,
524 "pickListCode": "string",
525 "pickListLabel": "string",
526 "label": "string",
527 "cultureId": 0,
528 "labelDtos": [
529 {
530 "createdBy": "string",
531 "lastModifiedBy": "string",
532 "createdDate": "2019-08-24T14:15:22Z",
533 "lastModifiedDate": "2019-08-24T14:15:22Z",
534 "archived": true,
535 "externalId": "string",
536 "id": 0,
537 "cultureId": 0,
538 "value": "string"
539 }
540 ]
541 },
542 "addressDto": {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "street": "string",
551 "civicNumber": "string",
552 "suite": "string",
553 "postalCode": "string",
554 "lon": 0.1,
555 "lat": 0.1,
556 "city": {
557 "createdBy": "string",
558 "lastModifiedBy": "string",
559 "createdDate": "2019-08-24T14:15:22Z",
560 "lastModifiedDate": "2019-08-24T14:15:22Z",
561 "archived": true,
562 "externalId": "string",
563 "id": 0,
564 "name": "string",
565 "province": {
566 "createdBy": "string",
567 "lastModifiedBy": "string",
568 "createdDate": "2019-08-24T14:15:22Z",
569 "lastModifiedDate": "2019-08-24T14:15:22Z",
570 "archived": true,
571 "externalId": "string",
572 "id": 0,
573 "name": "string",
574 "code": "string",
575 "country": {
576 "createdBy": "string",
577 "lastModifiedBy": "string",
578 "createdDate": "2019-08-24T14:15:22Z",
579 "lastModifiedDate": "2019-08-24T14:15:22Z",
580 "archived": true,
581 "externalId": "string",
582 "id": 0,
583 "name": "string",
584 "code": "string"
585 },
586 "provinceCountryKey": "string"
587 },
588 "cityProvinceCountryKey": "string"
589 },
590 "district": {
591 "createdBy": "string",
592 "lastModifiedBy": "string",
593 "createdDate": "2019-08-24T14:15:22Z",
594 "lastModifiedDate": "2019-08-24T14:15:22Z",
595 "archived": true,
596 "externalId": "string",
597 "id": 0,
598 "name": "string",
599 "city": {
600 "createdBy": "string",
601 "lastModifiedBy": "string",
602 "createdDate": "2019-08-24T14:15:22Z",
603 "lastModifiedDate": "2019-08-24T14:15:22Z",
604 "archived": true,
605 "externalId": "string",
606 "id": 0,
607 "name": "string",
608 "province": {
609 "createdBy": "string",
610 "lastModifiedBy": "string",
611 "createdDate": "2019-08-24T14:15:22Z",
612 "lastModifiedDate": "2019-08-24T14:15:22Z",
613 "archived": true,
614 "externalId": "string",
615 "id": 0,
616 "name": "string",
617 "code": "string",
618 "country": {
619 "createdBy": "string",
620 "lastModifiedBy": "string",
621 "createdDate": "2019-08-24T14:15:22Z",
622 "lastModifiedDate": "2019-08-24T14:15:22Z",
623 "archived": true,
624 "externalId": "string",
625 "id": 0,
626 "name": "string",
627 "code": "string"
628 },
629 "provinceCountryKey": "string"
630 },
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {
671 "createdBy": "string",
672 "lastModifiedBy": "string",
673 "createdDate": "2019-08-24T14:15:22Z",
674 "lastModifiedDate": "2019-08-24T14:15:22Z",
675 "archived": true,
676 "externalId": "string",
677 "id": 0,
678 "name": "string",
679 "code": "string"
680 },
681 "provinceCountryKey": "string"
682 },
683 "cityProvinceCountryKey": "string"
684 },
685 "district": {
686 "createdBy": "string",
687 "lastModifiedBy": "string",
688 "createdDate": "2019-08-24T14:15:22Z",
689 "lastModifiedDate": "2019-08-24T14:15:22Z",
690 "archived": true,
691 "externalId": "string",
692 "id": 0,
693 "name": "string",
694 "city": {
695 "createdBy": "string",
696 "lastModifiedBy": "string",
697 "createdDate": "2019-08-24T14:15:22Z",
698 "lastModifiedDate": "2019-08-24T14:15:22Z",
699 "archived": true,
700 "externalId": "string",
701 "id": 0,
702 "name": "string",
703 "province": {
704 "createdBy": "string",
705 "lastModifiedBy": "string",
706 "createdDate": "2019-08-24T14:15:22Z",
707 "lastModifiedDate": "2019-08-24T14:15:22Z",
708 "archived": true,
709 "externalId": "string",
710 "id": 0,
711 "name": "string",
712 "code": "string",
713 "country": {
714 "createdBy": "string",
715 "lastModifiedBy": "string",
716 "createdDate": "2019-08-24T14:15:22Z",
717 "lastModifiedDate": "2019-08-24T14:15:22Z",
718 "archived": true,
719 "externalId": "string",
720 "id": 0,
721 "name": "string",
722 "code": "string"
723 },
724 "provinceCountryKey": "string"
725 },
726 "cityProvinceCountryKey": "string"
727 }
728 },
729 "cityId": 0,
730 "districtId": 0
731 }
732 },
733 "status": {
734 "createdBy": "string",
735 "lastModifiedBy": "string",
736 "createdDate": "2019-08-24T14:15:22Z",
737 "lastModifiedDate": "2019-08-24T14:15:22Z",
738 "archived": true,
739 "externalId": "string",
740 "id": 0,
741 "priority": 0,
742 "internalId": 0,
743 "pickListCode": "string",
744 "pickListLabel": "string",
745 "label": "string",
746 "cultureId": 0,
747 "labelDtos": [
748 {
749 "createdBy": "string",
750 "lastModifiedBy": "string",
751 "createdDate": "2019-08-24T14:15:22Z",
752 "lastModifiedDate": "2019-08-24T14:15:22Z",
753 "archived": true,
754 "externalId": "string",
755 "id": 0,
756 "cultureId": 0,
757 "value": "string"
758 }
759 ]
760 },
761 "usage": {
762 "createdBy": "string",
763 "lastModifiedBy": "string",
764 "createdDate": "2019-08-24T14:15:22Z",
765 "lastModifiedDate": "2019-08-24T14:15:22Z",
766 "archived": true,
767 "externalId": "string",
768 "id": 0,
769 "priority": 0,
770 "internalId": 0,
771 "pickListCode": "string",
772 "pickListLabel": "string",
773 "label": "string",
774 "cultureId": 0,
775 "labelDtos": [
776 {
777 "createdBy": "string",
778 "lastModifiedBy": "string",
779 "createdDate": "2019-08-24T14:15:22Z",
780 "lastModifiedDate": "2019-08-24T14:15:22Z",
781 "archived": true,
782 "externalId": "string",
783 "id": 0,
784 "cultureId": 0,
785 "value": "string"
786 }
787 ]
788 },
789 "occupanciesDto": [
790 {
791 "createdBy": "string",
792 "lastModifiedBy": "string",
793 "createdDate": "2019-08-24T14:15:22Z",
794 "lastModifiedDate": "2019-08-24T14:15:22Z",
795 "archived": true,
796 "externalId": "string",
797 "id": 0,
798 "priority": 0,
799 "internalId": 0,
800 "pickListCode": "string",
801 "pickListLabel": "string",
802 "label": "string",
803 "cultureId": 0,
804 "labelDtos": [
805 {
806 "createdBy": "string",
807 "lastModifiedBy": "string",
808 "createdDate": "2019-08-24T14:15:22Z",
809 "lastModifiedDate": "2019-08-24T14:15:22Z",
810 "archived": true,
811 "externalId": "string",
812 "id": 0,
813 "cultureId": 0,
814 "value": "string"
815 }
816 ]
817 }
818 ]
819 },
820 "isTerminationVersion": true
821}
Lease - Search Leases By Mass Profile Filter¶
HTTP Request
POST /api/leases/mass-profile-filters/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
|
search |
query |
string |
false |
none |
premise-id |
query |
string |
false |
none |
premise-id-in |
query |
string |
false |
none |
premise-id-not-null |
query |
string |
false |
none |
premise-number |
query |
string |
false |
none |
premise-number-like |
query |
string |
false |
none |
premise-external-id |
query |
string |
false |
none |
location-id |
query |
string |
false |
none |
location-number |
query |
string |
false |
none |
location-number-like |
query |
string |
false |
none |
location-external-id |
query |
string |
false |
none |
address-id |
query |
string |
false |
none |
city-id |
query |
string |
false |
none |
province-id |
query |
string |
false |
none |
country-id |
query |
string |
false |
none |
contract-id |
query |
string |
false |
none |
number |
query |
string |
false |
none |
number-like |
query |
string |
false |
none |
number-in |
query |
string |
false |
none |
id |
query |
string |
false |
none |
id-in |
query |
string |
false |
none |
type-id |
query |
string |
false |
none |
terminating-lease |
query |
string |
false |
none |
signature-date |
query |
string |
false |
none |
category-id |
query |
string |
false |
none |
registration-number |
query |
string |
false |
none |
status-id |
query |
string |
false |
none |
status-id-is-not |
query |
string |
false |
none |
status-id-in |
query |
string |
false |
none |
original-lease-id |
query |
string |
false |
none |
parent-lease-id-is-null |
query |
string |
false |
none |
state-id |
query |
string |
false |
none |
areas-history-version-id |
query |
string |
false |
none |
valid-from |
query |
string |
false |
none |
valid-to |
query |
string |
false |
none |
valid-to-greater-than |
query |
string |
false |
none |
valid-to-less-than |
query |
string |
false |
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 "description": "string",
11 "leaseList": true,
12 "leaseIds": [
13 0
14 ],
15 "leases": [
16 {
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 "typeId": 0,
25 "terminatingLease": "2019-08-24",
26 "maximumDateTo": "2019-08-24",
27 "number": "string",
28 "validFrom": "2019-08-24",
29 "validTo": "2019-08-24",
30 "categoryId": 0,
31 "registrationNumber": "string",
32 "statusId": 0,
33 "stateId": 0,
34 "calculateTax": true,
35 "autoMonthToMonth": true,
36 "originalLeaseId": 0,
37 "scenario": true,
38 "parentLeaseId": 0,
39 "areasHistoryVersionId": 0,
40 "provisioningFrequencyName": "string",
41 "accountingApproved": true,
42 "indexationType": "string",
43 "cpiGlobalCategoryId": 0,
44 "indexationReferenceDate": "2019-08-24",
45 "currentIndexLevel": 0.1,
46 "conditionallyIndexed": true,
47 "applicableCurrentIndexLevel": 0.1,
48 "indexLevelPercentageChangeLowerBound": 0.1,
49 "indexLevelPercentageChangeUpperBound": 0.1,
50 "indexationTypeNonLease": "string",
51 "cpiGlobalCategoryIdNonLease": 0,
52 "indexationReferenceDateNonLease": "2019-08-24",
53 "currentIndexLevelNonLease": 0.1,
54 "conditionallyIndexedNonLease": true,
55 "applicableCurrentIndexLevelNonLease": 0.1,
56 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
57 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
58 "signatureDate": "2019-08-24",
59 "premiseId": 0,
60 "type": {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "priority": 0,
69 "internalId": 0,
70 "pickListCode": "string",
71 "pickListLabel": "string",
72 "label": "string",
73 "cultureId": 0,
74 "labelDtos": [
75 {
76 "createdBy": "string",
77 "lastModifiedBy": "string",
78 "createdDate": "2019-08-24T14:15:22Z",
79 "lastModifiedDate": "2019-08-24T14:15:22Z",
80 "archived": true,
81 "externalId": "string",
82 "id": 0,
83 "cultureId": 0,
84 "value": "string"
85 }
86 ]
87 },
88 "category": {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "priority": 0,
97 "internalId": 0,
98 "pickListCode": "string",
99 "pickListLabel": "string",
100 "label": "string",
101 "cultureId": 0,
102 "labelDtos": [
103 {
104 "createdBy": "string",
105 "lastModifiedBy": "string",
106 "createdDate": "2019-08-24T14:15:22Z",
107 "lastModifiedDate": "2019-08-24T14:15:22Z",
108 "archived": true,
109 "externalId": "string",
110 "id": 0,
111 "cultureId": 0,
112 "value": "string"
113 }
114 ]
115 },
116 "status": {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "priority": 0,
125 "internalId": 0,
126 "pickListCode": "string",
127 "pickListLabel": "string",
128 "label": "string",
129 "cultureId": 0,
130 "labelDtos": [
131 {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "cultureId": 0,
140 "value": "string"
141 }
142 ]
143 },
144 "state": {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "priority": 0,
153 "internalId": 0,
154 "pickListCode": "string",
155 "pickListLabel": "string",
156 "label": "string",
157 "cultureId": 0,
158 "labelDtos": [
159 {
160 "createdBy": "string",
161 "lastModifiedBy": "string",
162 "createdDate": "2019-08-24T14:15:22Z",
163 "lastModifiedDate": "2019-08-24T14:15:22Z",
164 "archived": true,
165 "externalId": "string",
166 "id": 0,
167 "cultureId": 0,
168 "value": "string"
169 }
170 ]
171 },
172 "version": {
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 "name": "string",
181 "description": "string",
182 "modificationDate": "2019-08-24",
183 "updateContractRate": true,
184 "leaseEvent": {
185 "createdBy": "string",
186 "lastModifiedBy": "string",
187 "createdDate": "2019-08-24T14:15:22Z",
188 "lastModifiedDate": "2019-08-24T14:15:22Z",
189 "archived": true,
190 "externalId": "string",
191 "id": 0,
192 "typeId": 0,
193 "code": "string",
194 "reviewedBy": "string",
195 "reviewedDate": "2019-08-24",
196 "reviewedStatusId": 0,
197 "activityDate": "2019-08-24",
198 "relatedPickListOptionId": 0,
199 "detail": "string",
200 "note": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "message": "string",
209 "preserveOriginalAudit": true,
210 "originalCreatedBy": "string",
211 "originalCreatedDate": "2019-08-24T14:15:22Z",
212 "originalLastModifiedBy": "string",
213 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
214 },
215 "type": {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "priority": 0,
224 "internalId": 0,
225 "pickListCode": "string",
226 "pickListLabel": "string",
227 "label": "string",
228 "cultureId": 0,
229 "labelDtos": [
230 {
231 "createdBy": "string",
232 "lastModifiedBy": "string",
233 "createdDate": "2019-08-24T14:15:22Z",
234 "lastModifiedDate": "2019-08-24T14:15:22Z",
235 "archived": true,
236 "externalId": "string",
237 "id": 0,
238 "cultureId": 0,
239 "value": "string"
240 }
241 ]
242 },
243 "reviewedStatus": {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "priority": 0,
252 "internalId": 0,
253 "pickListCode": "string",
254 "pickListLabel": "string",
255 "label": "string",
256 "cultureId": 0,
257 "labelDtos": [
258 {
259 "createdBy": "string",
260 "lastModifiedBy": "string",
261 "createdDate": "2019-08-24T14:15:22Z",
262 "lastModifiedDate": "2019-08-24T14:15:22Z",
263 "archived": true,
264 "externalId": "string",
265 "id": 0,
266 "cultureId": 0,
267 "value": "string"
268 }
269 ]
270 },
271 "relatedPickListOption": {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "priority": 0,
280 "internalId": 0,
281 "pickListCode": "string",
282 "pickListLabel": "string",
283 "label": "string",
284 "cultureId": 0,
285 "labelDtos": [
286 {
287 "createdBy": "string",
288 "lastModifiedBy": "string",
289 "createdDate": "2019-08-24T14:15:22Z",
290 "lastModifiedDate": "2019-08-24T14:15:22Z",
291 "archived": true,
292 "externalId": "string",
293 "id": 0,
294 "cultureId": 0,
295 "value": "string"
296 }
297 ]
298 },
299 "isVisiblePartnerPortal": true
300 },
301 "scenario": true,
302 "isVisibleVendorPortal": true,
303 "isTerminationVersion": true,
304 "terminationDate": "2019-08-24",
305 "penaltyAmount": 0.1,
306 "areasHistoryVersionId": 0
307 },
308 "premiseDto": {
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 "number": "string",
317 "name": "string",
318 "headPremise": true,
319 "possessionDate": "2019-08-24",
320 "openingDate": "2019-08-24",
321 "closingDate": "2019-08-24",
322 "relocationDate": "2019-08-24",
323 "vacatingDate": "2019-08-24",
324 "expansionDate": "2019-08-24",
325 "statusId": 0,
326 "usageId": 0,
327 "parentPremiseId": 0,
328 "costCenterId": 0,
329 "profitCenterId": 0,
330 "legalEntityId": 0,
331 "occupancyIds": [
332 0
333 ],
334 "locationId": 0,
335 "locationDto": {
336 "createdBy": "string",
337 "lastModifiedBy": "string",
338 "createdDate": "2019-08-24T14:15:22Z",
339 "lastModifiedDate": "2019-08-24T14:15:22Z",
340 "archived": true,
341 "externalId": "string",
342 "id": 0,
343 "number": "string",
344 "name": "string",
345 "storeNumber": "string",
346 "defaultCurrencyId": 0,
347 "defaultMeasureId": 0,
348 "typeId": 0,
349 "qualityId": 0,
350 "propertyTypeId": 0,
351 "categoryId": 0,
352 "statusId": 0,
353 "businessUnitId": 0,
354 "groupIds": [
355 0
356 ],
357 "legalEntityIds": [
358 0
359 ],
360 "defaultCurrency": {
361 "id": 0,
362 "status": "CREATED",
363 "displayId": "string",
364 "erpSystemId": 0,
365 "erpSystemDisplayId": "string",
366 "name": "string",
367 "decimalPoints": 0,
368 "depreciationAreaId": 0
369 },
370 "defaultUnitValue": {
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 "unitId": 0,
379 "unitOfMeasureId": 0,
380 "erpSystemId": 0,
381 "unit": {
382 "createdBy": "string",
383 "lastModifiedBy": "string",
384 "createdDate": "2019-08-24T14:15:22Z",
385 "lastModifiedDate": "2019-08-24T14:15:22Z",
386 "archived": true,
387 "externalId": "string",
388 "id": 0,
389 "priority": 0,
390 "internalId": 0,
391 "pickListCode": "string",
392 "pickListLabel": "string",
393 "label": "string",
394 "cultureId": 0,
395 "labelDtos": [
396 {
397 "createdBy": "string",
398 "lastModifiedBy": "string",
399 "createdDate": "2019-08-24T14:15:22Z",
400 "lastModifiedDate": "2019-08-24T14:15:22Z",
401 "archived": true,
402 "externalId": "string",
403 "id": 0,
404 "cultureId": 0,
405 "value": "string"
406 }
407 ]
408 },
409 "unitOfMeasure": {
410 "id": 0,
411 "status": "CREATED",
412 "displayId": "string",
413 "erpSystemId": 0,
414 "erpSystemDisplayId": "string",
415 "name": "string"
416 }
417 },
418 "type": {
419 "createdBy": "string",
420 "lastModifiedBy": "string",
421 "createdDate": "2019-08-24T14:15:22Z",
422 "lastModifiedDate": "2019-08-24T14:15:22Z",
423 "archived": true,
424 "externalId": "string",
425 "id": 0,
426 "priority": 0,
427 "internalId": 0,
428 "pickListCode": "string",
429 "pickListLabel": "string",
430 "label": "string",
431 "cultureId": 0,
432 "labelDtos": [
433 {
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 "cultureId": 0,
442 "value": "string"
443 }
444 ]
445 },
446 "quality": {
447 "createdBy": "string",
448 "lastModifiedBy": "string",
449 "createdDate": "2019-08-24T14:15:22Z",
450 "lastModifiedDate": "2019-08-24T14:15:22Z",
451 "archived": true,
452 "externalId": "string",
453 "id": 0,
454 "priority": 0,
455 "internalId": 0,
456 "pickListCode": "string",
457 "pickListLabel": "string",
458 "label": "string",
459 "cultureId": 0,
460 "labelDtos": [
461 {
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 "cultureId": 0,
470 "value": "string"
471 }
472 ]
473 },
474 "propertyType": {
475 "createdBy": "string",
476 "lastModifiedBy": "string",
477 "createdDate": "2019-08-24T14:15:22Z",
478 "lastModifiedDate": "2019-08-24T14:15:22Z",
479 "archived": true,
480 "externalId": "string",
481 "id": 0,
482 "priority": 0,
483 "internalId": 0,
484 "pickListCode": "string",
485 "pickListLabel": "string",
486 "label": "string",
487 "cultureId": 0,
488 "labelDtos": [
489 {
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 "cultureId": 0,
498 "value": "string"
499 }
500 ]
501 },
502 "category": {
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 "status": {
531 "createdBy": "string",
532 "lastModifiedBy": "string",
533 "createdDate": "2019-08-24T14:15:22Z",
534 "lastModifiedDate": "2019-08-24T14:15:22Z",
535 "archived": true,
536 "externalId": "string",
537 "id": 0,
538 "priority": 0,
539 "internalId": 0,
540 "pickListCode": "string",
541 "pickListLabel": "string",
542 "label": "string",
543 "cultureId": 0,
544 "labelDtos": [
545 {
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 "cultureId": 0,
554 "value": "string"
555 }
556 ]
557 },
558 "addressDto": {
559 "createdBy": "string",
560 "lastModifiedBy": "string",
561 "createdDate": "2019-08-24T14:15:22Z",
562 "lastModifiedDate": "2019-08-24T14:15:22Z",
563 "archived": true,
564 "externalId": "string",
565 "id": 0,
566 "street": "string",
567 "civicNumber": "string",
568 "suite": "string",
569 "postalCode": "string",
570 "lon": 0.1,
571 "lat": 0.1,
572 "city": {
573 "createdBy": "string",
574 "lastModifiedBy": "string",
575 "createdDate": "2019-08-24T14:15:22Z",
576 "lastModifiedDate": "2019-08-24T14:15:22Z",
577 "archived": true,
578 "externalId": "string",
579 "id": 0,
580 "name": "string",
581 "province": {
582 "createdBy": "string",
583 "lastModifiedBy": "string",
584 "createdDate": "2019-08-24T14:15:22Z",
585 "lastModifiedDate": "2019-08-24T14:15:22Z",
586 "archived": true,
587 "externalId": "string",
588 "id": 0,
589 "name": "string",
590 "code": "string",
591 "country": {
592 "createdBy": "string",
593 "lastModifiedBy": "string",
594 "createdDate": "2019-08-24T14:15:22Z",
595 "lastModifiedDate": "2019-08-24T14:15:22Z",
596 "archived": true,
597 "externalId": "string",
598 "id": 0,
599 "name": "string",
600 "code": "string"
601 },
602 "provinceCountryKey": "string"
603 },
604 "cityProvinceCountryKey": "string"
605 },
606 "district": {
607 "createdBy": "string",
608 "lastModifiedBy": "string",
609 "createdDate": "2019-08-24T14:15:22Z",
610 "lastModifiedDate": "2019-08-24T14:15:22Z",
611 "archived": true,
612 "externalId": "string",
613 "id": 0,
614 "name": "string",
615 "city": {
616 "createdBy": "string",
617 "lastModifiedBy": "string",
618 "createdDate": "2019-08-24T14:15:22Z",
619 "lastModifiedDate": "2019-08-24T14:15:22Z",
620 "archived": true,
621 "externalId": "string",
622 "id": 0,
623 "name": "string",
624 "province": {
625 "createdBy": "string",
626 "lastModifiedBy": "string",
627 "createdDate": "2019-08-24T14:15:22Z",
628 "lastModifiedDate": "2019-08-24T14:15:22Z",
629 "archived": true,
630 "externalId": "string",
631 "id": 0,
632 "name": "string",
633 "code": "string",
634 "country": {
635 "createdBy": "string",
636 "lastModifiedBy": "string",
637 "createdDate": "2019-08-24T14:15:22Z",
638 "lastModifiedDate": "2019-08-24T14:15:22Z",
639 "archived": true,
640 "externalId": "string",
641 "id": 0,
642 "name": "string",
643 "code": "string"
644 },
645 "provinceCountryKey": "string"
646 },
647 "cityProvinceCountryKey": "string"
648 }
649 },
650 "cityId": 0,
651 "districtId": 0
652 },
653 "secondAddressDto": {
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 "street": "string",
662 "civicNumber": "string",
663 "suite": "string",
664 "postalCode": "string",
665 "lon": 0.1,
666 "lat": 0.1,
667 "city": {
668 "createdBy": "string",
669 "lastModifiedBy": "string",
670 "createdDate": "2019-08-24T14:15:22Z",
671 "lastModifiedDate": "2019-08-24T14:15:22Z",
672 "archived": true,
673 "externalId": "string",
674 "id": 0,
675 "name": "string",
676 "province": {
677 "createdBy": "string",
678 "lastModifiedBy": "string",
679 "createdDate": "2019-08-24T14:15:22Z",
680 "lastModifiedDate": "2019-08-24T14:15:22Z",
681 "archived": true,
682 "externalId": "string",
683 "id": 0,
684 "name": "string",
685 "code": "string",
686 "country": {
687 "createdBy": "string",
688 "lastModifiedBy": "string",
689 "createdDate": "2019-08-24T14:15:22Z",
690 "lastModifiedDate": "2019-08-24T14:15:22Z",
691 "archived": true,
692 "externalId": "string",
693 "id": 0,
694 "name": "string",
695 "code": "string"
696 },
697 "provinceCountryKey": "string"
698 },
699 "cityProvinceCountryKey": "string"
700 },
701 "district": {
702 "createdBy": "string",
703 "lastModifiedBy": "string",
704 "createdDate": "2019-08-24T14:15:22Z",
705 "lastModifiedDate": "2019-08-24T14:15:22Z",
706 "archived": true,
707 "externalId": "string",
708 "id": 0,
709 "name": "string",
710 "city": {
711 "createdBy": "string",
712 "lastModifiedBy": "string",
713 "createdDate": "2019-08-24T14:15:22Z",
714 "lastModifiedDate": "2019-08-24T14:15:22Z",
715 "archived": true,
716 "externalId": "string",
717 "id": 0,
718 "name": "string",
719 "province": {
720 "createdBy": "string",
721 "lastModifiedBy": "string",
722 "createdDate": "2019-08-24T14:15:22Z",
723 "lastModifiedDate": "2019-08-24T14:15:22Z",
724 "archived": true,
725 "externalId": "string",
726 "id": 0,
727 "name": "string",
728 "code": "string",
729 "country": {
730 "createdBy": "string",
731 "lastModifiedBy": "string",
732 "createdDate": "2019-08-24T14:15:22Z",
733 "lastModifiedDate": "2019-08-24T14:15:22Z",
734 "archived": true,
735 "externalId": "string",
736 "id": 0,
737 "name": "string",
738 "code": "string"
739 },
740 "provinceCountryKey": "string"
741 },
742 "cityProvinceCountryKey": "string"
743 }
744 },
745 "cityId": 0,
746 "districtId": 0
747 }
748 },
749 "status": {
750 "createdBy": "string",
751 "lastModifiedBy": "string",
752 "createdDate": "2019-08-24T14:15:22Z",
753 "lastModifiedDate": "2019-08-24T14:15:22Z",
754 "archived": true,
755 "externalId": "string",
756 "id": 0,
757 "priority": 0,
758 "internalId": 0,
759 "pickListCode": "string",
760 "pickListLabel": "string",
761 "label": "string",
762 "cultureId": 0,
763 "labelDtos": [
764 {
765 "createdBy": "string",
766 "lastModifiedBy": "string",
767 "createdDate": "2019-08-24T14:15:22Z",
768 "lastModifiedDate": "2019-08-24T14:15:22Z",
769 "archived": true,
770 "externalId": "string",
771 "id": 0,
772 "cultureId": 0,
773 "value": "string"
774 }
775 ]
776 },
777 "usage": {
778 "createdBy": "string",
779 "lastModifiedBy": "string",
780 "createdDate": "2019-08-24T14:15:22Z",
781 "lastModifiedDate": "2019-08-24T14:15:22Z",
782 "archived": true,
783 "externalId": "string",
784 "id": 0,
785 "priority": 0,
786 "internalId": 0,
787 "pickListCode": "string",
788 "pickListLabel": "string",
789 "label": "string",
790 "cultureId": 0,
791 "labelDtos": [
792 {
793 "createdBy": "string",
794 "lastModifiedBy": "string",
795 "createdDate": "2019-08-24T14:15:22Z",
796 "lastModifiedDate": "2019-08-24T14:15:22Z",
797 "archived": true,
798 "externalId": "string",
799 "id": 0,
800 "cultureId": 0,
801 "value": "string"
802 }
803 ]
804 },
805 "occupanciesDto": [
806 {
807 "createdBy": "string",
808 "lastModifiedBy": "string",
809 "createdDate": "2019-08-24T14:15:22Z",
810 "lastModifiedDate": "2019-08-24T14:15:22Z",
811 "archived": true,
812 "externalId": "string",
813 "id": 0,
814 "priority": 0,
815 "internalId": 0,
816 "pickListCode": "string",
817 "pickListLabel": "string",
818 "label": "string",
819 "cultureId": 0,
820 "labelDtos": [
821 {
822 "createdBy": "string",
823 "lastModifiedBy": "string",
824 "createdDate": "2019-08-24T14:15:22Z",
825 "lastModifiedDate": "2019-08-24T14:15:22Z",
826 "archived": true,
827 "externalId": "string",
828 "id": 0,
829 "cultureId": 0,
830 "value": "string"
831 }
832 ]
833 }
834 ]
835 },
836 "isTerminationVersion": true
837 }
838 ],
839 "leaseFileNumbers": [
840 "string"
841 ],
842 "validFrom": "2019-08-24",
843 "validTo": "2019-08-24",
844 "cityIds": [
845 0
846 ],
847 "provinceIds": [
848 0
849 ],
850 "countryIds": [
851 0
852 ],
853 "premiseIds": [
854 0
855 ],
856 "locationIds": [
857 0
858 ],
859 "businessUnitIds": [
860 0
861 ],
862 "legalEntityIds": [
863 0
864 ],
865 "groupIds": [
866 "string"
867 ],
868 "groupOptionIds": [
869 0
870 ],
871 "masterAgreementIds": [
872 0
873 ],
874 "contractIds": [
875 0
876 ],
877 "statusIds": [
878 0
879 ],
880 "cities": [
881 {
882 "createdBy": "string",
883 "lastModifiedBy": "string",
884 "createdDate": "2019-08-24T14:15:22Z",
885 "lastModifiedDate": "2019-08-24T14:15:22Z",
886 "archived": true,
887 "externalId": "string",
888 "id": 0,
889 "name": "string",
890 "province": {
891 "createdBy": "string",
892 "lastModifiedBy": "string",
893 "createdDate": "2019-08-24T14:15:22Z",
894 "lastModifiedDate": "2019-08-24T14:15:22Z",
895 "archived": true,
896 "externalId": "string",
897 "id": 0,
898 "name": "string",
899 "country": {
900 "createdBy": "string",
901 "lastModifiedBy": "string",
902 "createdDate": "2019-08-24T14:15:22Z",
903 "lastModifiedDate": "2019-08-24T14:15:22Z",
904 "archived": true,
905 "externalId": "string",
906 "id": 0,
907 "name": "string",
908 "code": "string"
909 },
910 "code": "string",
911 "countryId": 0
912 },
913 "provinceId": 0
914 }
915 ],
916 "provinces": [
917 {
918 "createdBy": "string",
919 "lastModifiedBy": "string",
920 "createdDate": "2019-08-24T14:15:22Z",
921 "lastModifiedDate": "2019-08-24T14:15:22Z",
922 "archived": true,
923 "externalId": "string",
924 "id": 0,
925 "name": "string",
926 "country": {
927 "createdBy": "string",
928 "lastModifiedBy": "string",
929 "createdDate": "2019-08-24T14:15:22Z",
930 "lastModifiedDate": "2019-08-24T14:15:22Z",
931 "archived": true,
932 "externalId": "string",
933 "id": 0,
934 "name": "string",
935 "code": "string"
936 },
937 "code": "string",
938 "countryId": 0
939 }
940 ],
941 "countries": [
942 {
943 "createdBy": "string",
944 "lastModifiedBy": "string",
945 "createdDate": "2019-08-24T14:15:22Z",
946 "lastModifiedDate": "2019-08-24T14:15:22Z",
947 "archived": true,
948 "externalId": "string",
949 "id": 0,
950 "name": "string",
951 "code": "string"
952 }
953 ],
954 "locations": [
955 {
956 "createdBy": "string",
957 "lastModifiedBy": "string",
958 "createdDate": "2019-08-24T14:15:22Z",
959 "lastModifiedDate": "2019-08-24T14:15:22Z",
960 "archived": true,
961 "externalId": "string",
962 "id": 0,
963 "number": "string",
964 "name": "string",
965 "storeNumber": "string",
966 "defaultCurrencyId": 0,
967 "defaultMeasureId": 0,
968 "typeId": 0,
969 "qualityId": 0,
970 "propertyTypeId": 0,
971 "categoryId": 0,
972 "statusId": 0,
973 "businessUnitId": 0,
974 "groupIds": [
975 0
976 ],
977 "legalEntityIds": [
978 0
979 ],
980 "defaultCurrency": {
981 "id": 0,
982 "status": "CREATED",
983 "displayId": "string",
984 "erpSystemId": 0,
985 "erpSystemDisplayId": "string",
986 "name": "string",
987 "decimalPoints": 0,
988 "depreciationAreaId": 0
989 },
990 "defaultUnitValue": {
991 "createdBy": "string",
992 "lastModifiedBy": "string",
993 "createdDate": "2019-08-24T14:15:22Z",
994 "lastModifiedDate": "2019-08-24T14:15:22Z",
995 "archived": true,
996 "externalId": "string",
997 "id": 0,
998 "unitId": 0,
999 "unitOfMeasureId": 0,
1000 "erpSystemId": 0,
1001 "unit": {
1002 "createdBy": "string",
1003 "lastModifiedBy": "string",
1004 "createdDate": "2019-08-24T14:15:22Z",
1005 "lastModifiedDate": "2019-08-24T14:15:22Z",
1006 "archived": true,
1007 "externalId": "string",
1008 "id": 0,
1009 "priority": 0,
1010 "internalId": 0,
1011 "pickListCode": "string",
1012 "pickListLabel": "string",
1013 "label": "string",
1014 "cultureId": 0,
1015 "labelDtos": [
1016 {
1017 "createdBy": "string",
1018 "lastModifiedBy": "string",
1019 "createdDate": "2019-08-24T14:15:22Z",
1020 "lastModifiedDate": "2019-08-24T14:15:22Z",
1021 "archived": true,
1022 "externalId": "string",
1023 "id": 0,
1024 "cultureId": 0,
1025 "value": "string"
1026 }
1027 ]
1028 },
1029 "unitOfMeasure": {
1030 "id": 0,
1031 "status": "CREATED",
1032 "displayId": "string",
1033 "erpSystemId": 0,
1034 "erpSystemDisplayId": "string",
1035 "name": "string"
1036 }
1037 },
1038 "type": {
1039 "createdBy": "string",
1040 "lastModifiedBy": "string",
1041 "createdDate": "2019-08-24T14:15:22Z",
1042 "lastModifiedDate": "2019-08-24T14:15:22Z",
1043 "archived": true,
1044 "externalId": "string",
1045 "id": 0,
1046 "priority": 0,
1047 "internalId": 0,
1048 "pickListCode": "string",
1049 "pickListLabel": "string",
1050 "label": "string",
1051 "cultureId": 0,
1052 "labelDtos": [
1053 {
1054 "createdBy": "string",
1055 "lastModifiedBy": "string",
1056 "createdDate": "2019-08-24T14:15:22Z",
1057 "lastModifiedDate": "2019-08-24T14:15:22Z",
1058 "archived": true,
1059 "externalId": "string",
1060 "id": 0,
1061 "cultureId": 0,
1062 "value": "string"
1063 }
1064 ]
1065 },
1066 "quality": {
1067 "createdBy": "string",
1068 "lastModifiedBy": "string",
1069 "createdDate": "2019-08-24T14:15:22Z",
1070 "lastModifiedDate": "2019-08-24T14:15:22Z",
1071 "archived": true,
1072 "externalId": "string",
1073 "id": 0,
1074 "priority": 0,
1075 "internalId": 0,
1076 "pickListCode": "string",
1077 "pickListLabel": "string",
1078 "label": "string",
1079 "cultureId": 0,
1080 "labelDtos": [
1081 {
1082 "createdBy": "string",
1083 "lastModifiedBy": "string",
1084 "createdDate": "2019-08-24T14:15:22Z",
1085 "lastModifiedDate": "2019-08-24T14:15:22Z",
1086 "archived": true,
1087 "externalId": "string",
1088 "id": 0,
1089 "cultureId": 0,
1090 "value": "string"
1091 }
1092 ]
1093 },
1094 "propertyType": {
1095 "createdBy": "string",
1096 "lastModifiedBy": "string",
1097 "createdDate": "2019-08-24T14:15:22Z",
1098 "lastModifiedDate": "2019-08-24T14:15:22Z",
1099 "archived": true,
1100 "externalId": "string",
1101 "id": 0,
1102 "priority": 0,
1103 "internalId": 0,
1104 "pickListCode": "string",
1105 "pickListLabel": "string",
1106 "label": "string",
1107 "cultureId": 0,
1108 "labelDtos": [
1109 {
1110 "createdBy": "string",
1111 "lastModifiedBy": "string",
1112 "createdDate": "2019-08-24T14:15:22Z",
1113 "lastModifiedDate": "2019-08-24T14:15:22Z",
1114 "archived": true,
1115 "externalId": "string",
1116 "id": 0,
1117 "cultureId": 0,
1118 "value": "string"
1119 }
1120 ]
1121 },
1122 "category": {
1123 "createdBy": "string",
1124 "lastModifiedBy": "string",
1125 "createdDate": "2019-08-24T14:15:22Z",
1126 "lastModifiedDate": "2019-08-24T14:15:22Z",
1127 "archived": true,
1128 "externalId": "string",
1129 "id": 0,
1130 "priority": 0,
1131 "internalId": 0,
1132 "pickListCode": "string",
1133 "pickListLabel": "string",
1134 "label": "string",
1135 "cultureId": 0,
1136 "labelDtos": [
1137 {
1138 "createdBy": "string",
1139 "lastModifiedBy": "string",
1140 "createdDate": "2019-08-24T14:15:22Z",
1141 "lastModifiedDate": "2019-08-24T14:15:22Z",
1142 "archived": true,
1143 "externalId": "string",
1144 "id": 0,
1145 "cultureId": 0,
1146 "value": "string"
1147 }
1148 ]
1149 },
1150 "status": {
1151 "createdBy": "string",
1152 "lastModifiedBy": "string",
1153 "createdDate": "2019-08-24T14:15:22Z",
1154 "lastModifiedDate": "2019-08-24T14:15:22Z",
1155 "archived": true,
1156 "externalId": "string",
1157 "id": 0,
1158 "priority": 0,
1159 "internalId": 0,
1160 "pickListCode": "string",
1161 "pickListLabel": "string",
1162 "label": "string",
1163 "cultureId": 0,
1164 "labelDtos": [
1165 {
1166 "createdBy": "string",
1167 "lastModifiedBy": "string",
1168 "createdDate": "2019-08-24T14:15:22Z",
1169 "lastModifiedDate": "2019-08-24T14:15:22Z",
1170 "archived": true,
1171 "externalId": "string",
1172 "id": 0,
1173 "cultureId": 0,
1174 "value": "string"
1175 }
1176 ]
1177 },
1178 "addressDto": {
1179 "createdBy": "string",
1180 "lastModifiedBy": "string",
1181 "createdDate": "2019-08-24T14:15:22Z",
1182 "lastModifiedDate": "2019-08-24T14:15:22Z",
1183 "archived": true,
1184 "externalId": "string",
1185 "id": 0,
1186 "street": "string",
1187 "civicNumber": "string",
1188 "suite": "string",
1189 "postalCode": "string",
1190 "lon": 0.1,
1191 "lat": 0.1,
1192 "city": {
1193 "createdBy": "string",
1194 "lastModifiedBy": "string",
1195 "createdDate": "2019-08-24T14:15:22Z",
1196 "lastModifiedDate": "2019-08-24T14:15:22Z",
1197 "archived": true,
1198 "externalId": "string",
1199 "id": 0,
1200 "name": "string",
1201 "province": {
1202 "createdBy": "string",
1203 "lastModifiedBy": "string",
1204 "createdDate": "2019-08-24T14:15:22Z",
1205 "lastModifiedDate": "2019-08-24T14:15:22Z",
1206 "archived": true,
1207 "externalId": "string",
1208 "id": 0,
1209 "name": "string",
1210 "code": "string",
1211 "country": {
1212 "createdBy": "string",
1213 "lastModifiedBy": "string",
1214 "createdDate": "2019-08-24T14:15:22Z",
1215 "lastModifiedDate": "2019-08-24T14:15:22Z",
1216 "archived": true,
1217 "externalId": "string",
1218 "id": 0,
1219 "name": "string",
1220 "code": "string"
1221 },
1222 "provinceCountryKey": "string"
1223 },
1224 "cityProvinceCountryKey": "string"
1225 },
1226 "district": {
1227 "createdBy": "string",
1228 "lastModifiedBy": "string",
1229 "createdDate": "2019-08-24T14:15:22Z",
1230 "lastModifiedDate": "2019-08-24T14:15:22Z",
1231 "archived": true,
1232 "externalId": "string",
1233 "id": 0,
1234 "name": "string",
1235 "city": {
1236 "createdBy": "string",
1237 "lastModifiedBy": "string",
1238 "createdDate": "2019-08-24T14:15:22Z",
1239 "lastModifiedDate": "2019-08-24T14:15:22Z",
1240 "archived": true,
1241 "externalId": "string",
1242 "id": 0,
1243 "name": "string",
1244 "province": {
1245 "createdBy": "string",
1246 "lastModifiedBy": "string",
1247 "createdDate": "2019-08-24T14:15:22Z",
1248 "lastModifiedDate": "2019-08-24T14:15:22Z",
1249 "archived": true,
1250 "externalId": "string",
1251 "id": 0,
1252 "name": "string",
1253 "code": "string",
1254 "country": {
1255 "createdBy": "string",
1256 "lastModifiedBy": "string",
1257 "createdDate": "2019-08-24T14:15:22Z",
1258 "lastModifiedDate": "2019-08-24T14:15:22Z",
1259 "archived": true,
1260 "externalId": "string",
1261 "id": 0,
1262 "name": "string",
1263 "code": "string"
1264 },
1265 "provinceCountryKey": "string"
1266 },
1267 "cityProvinceCountryKey": "string"
1268 }
1269 },
1270 "cityId": 0,
1271 "districtId": 0
1272 },
1273 "secondAddressDto": {
1274 "createdBy": "string",
1275 "lastModifiedBy": "string",
1276 "createdDate": "2019-08-24T14:15:22Z",
1277 "lastModifiedDate": "2019-08-24T14:15:22Z",
1278 "archived": true,
1279 "externalId": "string",
1280 "id": 0,
1281 "street": "string",
1282 "civicNumber": "string",
1283 "suite": "string",
1284 "postalCode": "string",
1285 "lon": 0.1,
1286 "lat": 0.1,
1287 "city": {
1288 "createdBy": "string",
1289 "lastModifiedBy": "string",
1290 "createdDate": "2019-08-24T14:15:22Z",
1291 "lastModifiedDate": "2019-08-24T14:15:22Z",
1292 "archived": true,
1293 "externalId": "string",
1294 "id": 0,
1295 "name": "string",
1296 "province": {
1297 "createdBy": "string",
1298 "lastModifiedBy": "string",
1299 "createdDate": "2019-08-24T14:15:22Z",
1300 "lastModifiedDate": "2019-08-24T14:15:22Z",
1301 "archived": true,
1302 "externalId": "string",
1303 "id": 0,
1304 "name": "string",
1305 "code": "string",
1306 "country": {
1307 "createdBy": "string",
1308 "lastModifiedBy": "string",
1309 "createdDate": "2019-08-24T14:15:22Z",
1310 "lastModifiedDate": "2019-08-24T14:15:22Z",
1311 "archived": true,
1312 "externalId": "string",
1313 "id": 0,
1314 "name": "string",
1315 "code": "string"
1316 },
1317 "provinceCountryKey": "string"
1318 },
1319 "cityProvinceCountryKey": "string"
1320 },
1321 "district": {
1322 "createdBy": "string",
1323 "lastModifiedBy": "string",
1324 "createdDate": "2019-08-24T14:15:22Z",
1325 "lastModifiedDate": "2019-08-24T14:15:22Z",
1326 "archived": true,
1327 "externalId": "string",
1328 "id": 0,
1329 "name": "string",
1330 "city": {
1331 "createdBy": "string",
1332 "lastModifiedBy": "string",
1333 "createdDate": "2019-08-24T14:15:22Z",
1334 "lastModifiedDate": "2019-08-24T14:15:22Z",
1335 "archived": true,
1336 "externalId": "string",
1337 "id": 0,
1338 "name": "string",
1339 "province": {
1340 "createdBy": "string",
1341 "lastModifiedBy": "string",
1342 "createdDate": "2019-08-24T14:15:22Z",
1343 "lastModifiedDate": "2019-08-24T14:15:22Z",
1344 "archived": true,
1345 "externalId": "string",
1346 "id": 0,
1347 "name": "string",
1348 "code": "string",
1349 "country": {
1350 "createdBy": "string",
1351 "lastModifiedBy": "string",
1352 "createdDate": "2019-08-24T14:15:22Z",
1353 "lastModifiedDate": "2019-08-24T14:15:22Z",
1354 "archived": true,
1355 "externalId": "string",
1356 "id": 0,
1357 "name": "string",
1358 "code": "string"
1359 },
1360 "provinceCountryKey": "string"
1361 },
1362 "cityProvinceCountryKey": "string"
1363 }
1364 },
1365 "cityId": 0,
1366 "districtId": 0
1367 }
1368 }
1369 ],
1370 "premises": [
1371 {
1372 "createdBy": "string",
1373 "lastModifiedBy": "string",
1374 "createdDate": "2019-08-24T14:15:22Z",
1375 "lastModifiedDate": "2019-08-24T14:15:22Z",
1376 "archived": true,
1377 "externalId": "string",
1378 "id": 0,
1379 "number": "string",
1380 "name": "string",
1381 "headPremise": true,
1382 "possessionDate": "2019-08-24",
1383 "openingDate": "2019-08-24",
1384 "closingDate": "2019-08-24",
1385 "relocationDate": "2019-08-24",
1386 "vacatingDate": "2019-08-24",
1387 "expansionDate": "2019-08-24",
1388 "statusId": 0,
1389 "usageId": 0,
1390 "parentPremiseId": 0,
1391 "costCenterId": 0,
1392 "profitCenterId": 0,
1393 "legalEntityId": 0,
1394 "occupancyIds": [
1395 0
1396 ],
1397 "locationId": 0,
1398 "locationDto": {
1399 "createdBy": "string",
1400 "lastModifiedBy": "string",
1401 "createdDate": "2019-08-24T14:15:22Z",
1402 "lastModifiedDate": "2019-08-24T14:15:22Z",
1403 "archived": true,
1404 "externalId": "string",
1405 "id": 0,
1406 "number": "string",
1407 "name": "string",
1408 "storeNumber": "string",
1409 "defaultCurrencyId": 0,
1410 "defaultMeasureId": 0,
1411 "typeId": 0,
1412 "qualityId": 0,
1413 "propertyTypeId": 0,
1414 "categoryId": 0,
1415 "statusId": 0,
1416 "businessUnitId": 0,
1417 "groupIds": [
1418 0
1419 ],
1420 "legalEntityIds": [
1421 0
1422 ],
1423 "defaultCurrency": {
1424 "id": 0,
1425 "status": "CREATED",
1426 "displayId": "string",
1427 "erpSystemId": 0,
1428 "erpSystemDisplayId": "string",
1429 "name": "string",
1430 "decimalPoints": 0,
1431 "depreciationAreaId": 0
1432 },
1433 "defaultUnitValue": {
1434 "createdBy": "string",
1435 "lastModifiedBy": "string",
1436 "createdDate": "2019-08-24T14:15:22Z",
1437 "lastModifiedDate": "2019-08-24T14:15:22Z",
1438 "archived": true,
1439 "externalId": "string",
1440 "id": 0,
1441 "unitId": 0,
1442 "unitOfMeasureId": 0,
1443 "erpSystemId": 0,
1444 "unit": {
1445 "createdBy": "string",
1446 "lastModifiedBy": "string",
1447 "createdDate": "2019-08-24T14:15:22Z",
1448 "lastModifiedDate": "2019-08-24T14:15:22Z",
1449 "archived": true,
1450 "externalId": "string",
1451 "id": 0,
1452 "priority": 0,
1453 "internalId": 0,
1454 "pickListCode": "string",
1455 "pickListLabel": "string",
1456 "label": "string",
1457 "cultureId": 0,
1458 "labelDtos": [
1459 {
1460 "createdBy": "string",
1461 "lastModifiedBy": "string",
1462 "createdDate": "2019-08-24T14:15:22Z",
1463 "lastModifiedDate": "2019-08-24T14:15:22Z",
1464 "archived": true,
1465 "externalId": "string",
1466 "id": 0,
1467 "cultureId": 0,
1468 "value": "string"
1469 }
1470 ]
1471 },
1472 "unitOfMeasure": {
1473 "id": 0,
1474 "status": "CREATED",
1475 "displayId": "string",
1476 "erpSystemId": 0,
1477 "erpSystemDisplayId": "string",
1478 "name": "string"
1479 }
1480 },
1481 "type": {
1482 "createdBy": "string",
1483 "lastModifiedBy": "string",
1484 "createdDate": "2019-08-24T14:15:22Z",
1485 "lastModifiedDate": "2019-08-24T14:15:22Z",
1486 "archived": true,
1487 "externalId": "string",
1488 "id": 0,
1489 "priority": 0,
1490 "internalId": 0,
1491 "pickListCode": "string",
1492 "pickListLabel": "string",
1493 "label": "string",
1494 "cultureId": 0,
1495 "labelDtos": [
1496 {
1497 "createdBy": "string",
1498 "lastModifiedBy": "string",
1499 "createdDate": "2019-08-24T14:15:22Z",
1500 "lastModifiedDate": "2019-08-24T14:15:22Z",
1501 "archived": true,
1502 "externalId": "string",
1503 "id": 0,
1504 "cultureId": 0,
1505 "value": "string"
1506 }
1507 ]
1508 },
1509 "quality": {
1510 "createdBy": "string",
1511 "lastModifiedBy": "string",
1512 "createdDate": "2019-08-24T14:15:22Z",
1513 "lastModifiedDate": "2019-08-24T14:15:22Z",
1514 "archived": true,
1515 "externalId": "string",
1516 "id": 0,
1517 "priority": 0,
1518 "internalId": 0,
1519 "pickListCode": "string",
1520 "pickListLabel": "string",
1521 "label": "string",
1522 "cultureId": 0,
1523 "labelDtos": [
1524 {
1525 "createdBy": "string",
1526 "lastModifiedBy": "string",
1527 "createdDate": "2019-08-24T14:15:22Z",
1528 "lastModifiedDate": "2019-08-24T14:15:22Z",
1529 "archived": true,
1530 "externalId": "string",
1531 "id": 0,
1532 "cultureId": 0,
1533 "value": "string"
1534 }
1535 ]
1536 },
1537 "propertyType": {
1538 "createdBy": "string",
1539 "lastModifiedBy": "string",
1540 "createdDate": "2019-08-24T14:15:22Z",
1541 "lastModifiedDate": "2019-08-24T14:15:22Z",
1542 "archived": true,
1543 "externalId": "string",
1544 "id": 0,
1545 "priority": 0,
1546 "internalId": 0,
1547 "pickListCode": "string",
1548 "pickListLabel": "string",
1549 "label": "string",
1550 "cultureId": 0,
1551 "labelDtos": [
1552 {
1553 "createdBy": "string",
1554 "lastModifiedBy": "string",
1555 "createdDate": "2019-08-24T14:15:22Z",
1556 "lastModifiedDate": "2019-08-24T14:15:22Z",
1557 "archived": true,
1558 "externalId": "string",
1559 "id": 0,
1560 "cultureId": 0,
1561 "value": "string"
1562 }
1563 ]
1564 },
1565 "category": {
1566 "createdBy": "string",
1567 "lastModifiedBy": "string",
1568 "createdDate": "2019-08-24T14:15:22Z",
1569 "lastModifiedDate": "2019-08-24T14:15:22Z",
1570 "archived": true,
1571 "externalId": "string",
1572 "id": 0,
1573 "priority": 0,
1574 "internalId": 0,
1575 "pickListCode": "string",
1576 "pickListLabel": "string",
1577 "label": "string",
1578 "cultureId": 0,
1579 "labelDtos": [
1580 {
1581 "createdBy": "string",
1582 "lastModifiedBy": "string",
1583 "createdDate": "2019-08-24T14:15:22Z",
1584 "lastModifiedDate": "2019-08-24T14:15:22Z",
1585 "archived": true,
1586 "externalId": "string",
1587 "id": 0,
1588 "cultureId": 0,
1589 "value": "string"
1590 }
1591 ]
1592 },
1593 "status": {
1594 "createdBy": "string",
1595 "lastModifiedBy": "string",
1596 "createdDate": "2019-08-24T14:15:22Z",
1597 "lastModifiedDate": "2019-08-24T14:15:22Z",
1598 "archived": true,
1599 "externalId": "string",
1600 "id": 0,
1601 "priority": 0,
1602 "internalId": 0,
1603 "pickListCode": "string",
1604 "pickListLabel": "string",
1605 "label": "string",
1606 "cultureId": 0,
1607 "labelDtos": [
1608 {
1609 "createdBy": "string",
1610 "lastModifiedBy": "string",
1611 "createdDate": "2019-08-24T14:15:22Z",
1612 "lastModifiedDate": "2019-08-24T14:15:22Z",
1613 "archived": true,
1614 "externalId": "string",
1615 "id": 0,
1616 "cultureId": 0,
1617 "value": "string"
1618 }
1619 ]
1620 },
1621 "addressDto": {
1622 "createdBy": "string",
1623 "lastModifiedBy": "string",
1624 "createdDate": "2019-08-24T14:15:22Z",
1625 "lastModifiedDate": "2019-08-24T14:15:22Z",
1626 "archived": true,
1627 "externalId": "string",
1628 "id": 0,
1629 "street": "string",
1630 "civicNumber": "string",
1631 "suite": "string",
1632 "postalCode": "string",
1633 "lon": 0.1,
1634 "lat": 0.1,
1635 "city": {
1636 "createdBy": "string",
1637 "lastModifiedBy": "string",
1638 "createdDate": "2019-08-24T14:15:22Z",
1639 "lastModifiedDate": "2019-08-24T14:15:22Z",
1640 "archived": true,
1641 "externalId": "string",
1642 "id": 0,
1643 "name": "string",
1644 "province": {
1645 "createdBy": "string",
1646 "lastModifiedBy": "string",
1647 "createdDate": "2019-08-24T14:15:22Z",
1648 "lastModifiedDate": "2019-08-24T14:15:22Z",
1649 "archived": true,
1650 "externalId": "string",
1651 "id": 0,
1652 "name": "string",
1653 "code": "string",
1654 "country": {
1655 "createdBy": "string",
1656 "lastModifiedBy": "string",
1657 "createdDate": "2019-08-24T14:15:22Z",
1658 "lastModifiedDate": "2019-08-24T14:15:22Z",
1659 "archived": true,
1660 "externalId": "string",
1661 "id": 0,
1662 "name": "string",
1663 "code": "string"
1664 },
1665 "provinceCountryKey": "string"
1666 },
1667 "cityProvinceCountryKey": "string"
1668 },
1669 "district": {
1670 "createdBy": "string",
1671 "lastModifiedBy": "string",
1672 "createdDate": "2019-08-24T14:15:22Z",
1673 "lastModifiedDate": "2019-08-24T14:15:22Z",
1674 "archived": true,
1675 "externalId": "string",
1676 "id": 0,
1677 "name": "string",
1678 "city": {
1679 "createdBy": "string",
1680 "lastModifiedBy": "string",
1681 "createdDate": "2019-08-24T14:15:22Z",
1682 "lastModifiedDate": "2019-08-24T14:15:22Z",
1683 "archived": true,
1684 "externalId": "string",
1685 "id": 0,
1686 "name": "string",
1687 "province": {
1688 "createdBy": "string",
1689 "lastModifiedBy": "string",
1690 "createdDate": "2019-08-24T14:15:22Z",
1691 "lastModifiedDate": "2019-08-24T14:15:22Z",
1692 "archived": true,
1693 "externalId": "string",
1694 "id": 0,
1695 "name": "string",
1696 "code": "string",
1697 "country": {
1698 "createdBy": "string",
1699 "lastModifiedBy": "string",
1700 "createdDate": "2019-08-24T14:15:22Z",
1701 "lastModifiedDate": "2019-08-24T14:15:22Z",
1702 "archived": true,
1703 "externalId": "string",
1704 "id": 0,
1705 "name": "string",
1706 "code": "string"
1707 },
1708 "provinceCountryKey": "string"
1709 },
1710 "cityProvinceCountryKey": "string"
1711 }
1712 },
1713 "cityId": 0,
1714 "districtId": 0
1715 },
1716 "secondAddressDto": {
1717 "createdBy": "string",
1718 "lastModifiedBy": "string",
1719 "createdDate": "2019-08-24T14:15:22Z",
1720 "lastModifiedDate": "2019-08-24T14:15:22Z",
1721 "archived": true,
1722 "externalId": "string",
1723 "id": 0,
1724 "street": "string",
1725 "civicNumber": "string",
1726 "suite": "string",
1727 "postalCode": "string",
1728 "lon": 0.1,
1729 "lat": 0.1,
1730 "city": {
1731 "createdBy": "string",
1732 "lastModifiedBy": "string",
1733 "createdDate": "2019-08-24T14:15:22Z",
1734 "lastModifiedDate": "2019-08-24T14:15:22Z",
1735 "archived": true,
1736 "externalId": "string",
1737 "id": 0,
1738 "name": "string",
1739 "province": {
1740 "createdBy": "string",
1741 "lastModifiedBy": "string",
1742 "createdDate": "2019-08-24T14:15:22Z",
1743 "lastModifiedDate": "2019-08-24T14:15:22Z",
1744 "archived": true,
1745 "externalId": "string",
1746 "id": 0,
1747 "name": "string",
1748 "code": "string",
1749 "country": {
1750 "createdBy": "string",
1751 "lastModifiedBy": "string",
1752 "createdDate": "2019-08-24T14:15:22Z",
1753 "lastModifiedDate": "2019-08-24T14:15:22Z",
1754 "archived": true,
1755 "externalId": "string",
1756 "id": 0,
1757 "name": "string",
1758 "code": "string"
1759 },
1760 "provinceCountryKey": "string"
1761 },
1762 "cityProvinceCountryKey": "string"
1763 },
1764 "district": {
1765 "createdBy": "string",
1766 "lastModifiedBy": "string",
1767 "createdDate": "2019-08-24T14:15:22Z",
1768 "lastModifiedDate": "2019-08-24T14:15:22Z",
1769 "archived": true,
1770 "externalId": "string",
1771 "id": 0,
1772 "name": "string",
1773 "city": {
1774 "createdBy": "string",
1775 "lastModifiedBy": "string",
1776 "createdDate": "2019-08-24T14:15:22Z",
1777 "lastModifiedDate": "2019-08-24T14:15:22Z",
1778 "archived": true,
1779 "externalId": "string",
1780 "id": 0,
1781 "name": "string",
1782 "province": {
1783 "createdBy": "string",
1784 "lastModifiedBy": "string",
1785 "createdDate": "2019-08-24T14:15:22Z",
1786 "lastModifiedDate": "2019-08-24T14:15:22Z",
1787 "archived": true,
1788 "externalId": "string",
1789 "id": 0,
1790 "name": "string",
1791 "code": "string",
1792 "country": {
1793 "createdBy": "string",
1794 "lastModifiedBy": "string",
1795 "createdDate": "2019-08-24T14:15:22Z",
1796 "lastModifiedDate": "2019-08-24T14:15:22Z",
1797 "archived": true,
1798 "externalId": "string",
1799 "id": 0,
1800 "name": "string",
1801 "code": "string"
1802 },
1803 "provinceCountryKey": "string"
1804 },
1805 "cityProvinceCountryKey": "string"
1806 }
1807 },
1808 "cityId": 0,
1809 "districtId": 0
1810 }
1811 },
1812 "status": {
1813 "createdBy": "string",
1814 "lastModifiedBy": "string",
1815 "createdDate": "2019-08-24T14:15:22Z",
1816 "lastModifiedDate": "2019-08-24T14:15:22Z",
1817 "archived": true,
1818 "externalId": "string",
1819 "id": 0,
1820 "priority": 0,
1821 "internalId": 0,
1822 "pickListCode": "string",
1823 "pickListLabel": "string",
1824 "label": "string",
1825 "cultureId": 0,
1826 "labelDtos": [
1827 {
1828 "createdBy": "string",
1829 "lastModifiedBy": "string",
1830 "createdDate": "2019-08-24T14:15:22Z",
1831 "lastModifiedDate": "2019-08-24T14:15:22Z",
1832 "archived": true,
1833 "externalId": "string",
1834 "id": 0,
1835 "cultureId": 0,
1836 "value": "string"
1837 }
1838 ]
1839 },
1840 "usage": {
1841 "createdBy": "string",
1842 "lastModifiedBy": "string",
1843 "createdDate": "2019-08-24T14:15:22Z",
1844 "lastModifiedDate": "2019-08-24T14:15:22Z",
1845 "archived": true,
1846 "externalId": "string",
1847 "id": 0,
1848 "priority": 0,
1849 "internalId": 0,
1850 "pickListCode": "string",
1851 "pickListLabel": "string",
1852 "label": "string",
1853 "cultureId": 0,
1854 "labelDtos": [
1855 {
1856 "createdBy": "string",
1857 "lastModifiedBy": "string",
1858 "createdDate": "2019-08-24T14:15:22Z",
1859 "lastModifiedDate": "2019-08-24T14:15:22Z",
1860 "archived": true,
1861 "externalId": "string",
1862 "id": 0,
1863 "cultureId": 0,
1864 "value": "string"
1865 }
1866 ]
1867 },
1868 "occupanciesDto": [
1869 {
1870 "createdBy": "string",
1871 "lastModifiedBy": "string",
1872 "createdDate": "2019-08-24T14:15:22Z",
1873 "lastModifiedDate": "2019-08-24T14:15:22Z",
1874 "archived": true,
1875 "externalId": "string",
1876 "id": 0,
1877 "priority": 0,
1878 "internalId": 0,
1879 "pickListCode": "string",
1880 "pickListLabel": "string",
1881 "label": "string",
1882 "cultureId": 0,
1883 "labelDtos": [
1884 {
1885 "createdBy": "string",
1886 "lastModifiedBy": "string",
1887 "createdDate": "2019-08-24T14:15:22Z",
1888 "lastModifiedDate": "2019-08-24T14:15:22Z",
1889 "archived": true,
1890 "externalId": "string",
1891 "id": 0,
1892 "cultureId": 0,
1893 "value": "string"
1894 }
1895 ]
1896 }
1897 ]
1898 }
1899 ],
1900 "groups": [
1901 {
1902 "createdBy": "string",
1903 "lastModifiedBy": "string",
1904 "createdDate": "2019-08-24T14:15:22Z",
1905 "lastModifiedDate": "2019-08-24T14:15:22Z",
1906 "archived": true,
1907 "externalId": "string",
1908 "id": "string",
1909 "code": "string",
1910 "priority": 0,
1911 "pickListType": "string",
1912 "label": "string",
1913 "cultureId": 0,
1914 "reportable": true,
1915 "labelDtos": [
1916 {
1917 "createdBy": "string",
1918 "lastModifiedBy": "string",
1919 "createdDate": "2019-08-24T14:15:22Z",
1920 "lastModifiedDate": "2019-08-24T14:15:22Z",
1921 "archived": true,
1922 "externalId": "string",
1923 "id": 0,
1924 "cultureId": 0,
1925 "value": "string"
1926 }
1927 ]
1928 }
1929 ],
1930 "groupOptions": [
1931 {
1932 "createdBy": "string",
1933 "lastModifiedBy": "string",
1934 "createdDate": "2019-08-24T14:15:22Z",
1935 "lastModifiedDate": "2019-08-24T14:15:22Z",
1936 "archived": true,
1937 "externalId": "string",
1938 "id": 0,
1939 "priority": 0,
1940 "internalId": 0,
1941 "pickListCode": "string",
1942 "pickListLabel": "string",
1943 "label": "string",
1944 "cultureId": 0,
1945 "labelDtos": [
1946 {
1947 "createdBy": "string",
1948 "lastModifiedBy": "string",
1949 "createdDate": "2019-08-24T14:15:22Z",
1950 "lastModifiedDate": "2019-08-24T14:15:22Z",
1951 "archived": true,
1952 "externalId": "string",
1953 "id": 0,
1954 "cultureId": 0,
1955 "value": "string"
1956 }
1957 ]
1958 }
1959 ],
1960 "businessUnits": [
1961 {
1962 "id": 0,
1963 "status": "CREATED",
1964 "displayId": "string",
1965 "name": "string",
1966 "leaseAreaId": 0,
1967 "companyId": 0
1968 }
1969 ],
1970 "legalEntities": [
1971 {
1972 "id": 0,
1973 "status": "CREATED",
1974 "displayId": "string",
1975 "erpSystemId": 0,
1976 "erpSystemDisplayId": "string",
1977 "countryId": 0,
1978 "countryDisplayId": "string",
1979 "postingPeriodVariantId": 0,
1980 "name": "string",
1981 "postingPeriodVariantDisplayId": "string",
1982 "controllingAreaId": 0,
1983 "controllingAreaDisplayId": "string",
1984 "chartOfAccountId": 0,
1985 "chartOfAccountDisplayId": "string",
1986 "fiscalVariantId": 0,
1987 "fiscalVariantDisplayId": "string",
1988 "chartOfDepreciationId": 0,
1989 "chartOfDepreciationDisplayId": "string",
1990 "purchasingOrganizationId": 0,
1991 "assetId": 0,
1992 "exchangeRateTypeId": 0,
1993 "plantId": 0,
1994 "incrementalBorrowingRateId": 0,
1995 "businessUnitId": 0,
1996 "projectId": 0,
1997 "transferVariantId": 0,
1998 "partnerId": 0,
1999 "departmentId": 0,
2000 "accountingStandardId": 0,
2001 "generalLedgerAccountId": 0,
2002 "consumerPriceIndexCategoryId": 0,
2003 "costCenterId": 0,
2004 "costCenterRelationValidFrom": "2019-08-24",
2005 "costCenterRelationValidTo": "2019-08-24"
2006 }
2007 ],
2008 "statusOptions": [
2009 {
2010 "createdBy": "string",
2011 "lastModifiedBy": "string",
2012 "createdDate": "2019-08-24T14:15:22Z",
2013 "lastModifiedDate": "2019-08-24T14:15:22Z",
2014 "archived": true,
2015 "externalId": "string",
2016 "id": 0,
2017 "priority": 0,
2018 "internalId": 0,
2019 "pickListCode": "string",
2020 "pickListLabel": "string",
2021 "label": "string",
2022 "cultureId": 0,
2023 "labelDtos": [
2024 {
2025 "createdBy": "string",
2026 "lastModifiedBy": "string",
2027 "createdDate": "2019-08-24T14:15:22Z",
2028 "lastModifiedDate": "2019-08-24T14:15:22Z",
2029 "archived": true,
2030 "externalId": "string",
2031 "id": 0,
2032 "cultureId": 0,
2033 "value": "string"
2034 }
2035 ]
2036 }
2037 ],
2038 "masterAgreements": [
2039 {
2040 "id": 0,
2041 "displayId": "string",
2042 "year": 1900,
2043 "name": "string",
2044 "description": "string",
2045 "validFrom": "2019-08-24",
2046 "validTo": "2019-08-24",
2047 "targetValue": 0.1,
2048 "legalJurisdiction": "string",
2049 "approverComment": "string",
2050 "signingPerson": "string",
2051 "placeOfSignature": "string",
2052 "dateOfSignature": "2019-08-24",
2053 "state": "MLA_DEFINE",
2054 "dataCreationInfo": {
2055 "id": 0,
2056 "idGenerationType": "AUTO",
2057 "source": "string",
2058 "type": "MIGRATION",
2059 "startDateTime": "2019-08-24T14:15:22Z",
2060 "endDateTime": "2019-08-24T14:15:22Z"
2061 },
2062 "agreementGroup": {
2063 "id": 0,
2064 "displayId": "string",
2065 "status": "CREATED",
2066 "name": "string"
2067 },
2068 "currency": {
2069 "id": 0,
2070 "displayId": "string",
2071 "status": "CREATED",
2072 "name": "string",
2073 "decimalPoints": 0
2074 },
2075 "internalAssetClass": {
2076 "id": 0,
2077 "displayId": "string",
2078 "status": "CREATED",
2079 "name": "string",
2080 "assetClassType": "PROPERTY",
2081 "infiniteUsefulLife": true
2082 },
2083 "leaseArea": {
2084 "id": 0,
2085 "displayId": "string",
2086 "status": "CREATED",
2087 "name": "string"
2088 },
2089 "businessUnit": {
2090 "id": 0,
2091 "displayId": "string",
2092 "status": "CREATED",
2093 "name": "string"
2094 },
2095 "companyCode": {
2096 "id": 0,
2097 "displayId": "string",
2098 "status": "CREATED",
2099 "erpSystemId": 0,
2100 "erpSystemDisplayId": "string",
2101 "countryId": 0,
2102 "countryDisplayId": "string",
2103 "name": "string",
2104 "postingPeriodVariantId": 0,
2105 "fiscalVariantId": 0
2106 },
2107 "department": {
2108 "id": 0,
2109 "displayId": "string",
2110 "status": "CREATED",
2111 "name": "string"
2112 },
2113 "leaseGroup": {
2114 "id": 0,
2115 "displayId": "string",
2116 "status": "CREATED",
2117 "name": "string"
2118 },
2119 "allowsSystemGenerateNewId": true,
2120 "numberRangeIdentifierType": {
2121 "name": "string"
2122 },
2123 "numberRangeIdentifierValue": "string",
2124 "numberRangeType": {
2125 "name": "string"
2126 }
2127 }
2128 ],
2129 "contracts": [
2130 {
2131 "id": 0,
2132 "displayId": "string",
2133 "name": "string",
2134 "principalPositionType": "LESSEE",
2135 "validFrom": "2019-08-24",
2136 "validTo": "2019-08-24",
2137 "amendmentDate": "2019-08-24",
2138 "approverComment": "string",
2139 "contractPhase": "INITIAL",
2140 "dataCreationInfo": {
2141 "id": 0,
2142 "idGenerationType": "AUTO",
2143 "source": "string",
2144 "type": "MIGRATION",
2145 "startDateTime": "2019-08-24T14:15:22Z",
2146 "endDateTime": "2019-08-24T14:15:22Z"
2147 },
2148 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
2149 "revision": {
2150 "id": 0,
2151 "displayId": "string",
2152 "name": "string",
2153 "inception": true,
2154 "revisionType": "REVISION",
2155 "state": "MLA_DEFINE",
2156 "approvedBy": "string",
2157 "approvedAt": "2019-08-24T14:15:22Z",
2158 "parentRevisionId": 0,
2159 "approverComment": "string",
2160 "contractId": 0,
2161 "contractDisplayId": "string",
2162 "contractName": "string",
2163 "principalPositionType": "LESSEE",
2164 "mlaId": 0,
2165 "companyId": 0,
2166 "description": "string",
2167 "externalReference": "string",
2168 "internalReference": "string",
2169 "formOfLease": "FULL",
2170 "jointVentureLeaseType": "GROSS_LEASE",
2171 "businessPlace": "string",
2172 "tradingPartner": {
2173 "id": 0,
2174 "displayId": "string",
2175 "status": "CREATED",
2176 "name": "string",
2177 "erpSystemId": 0,
2178 "erpSystemDisplayId": "string"
2179 },
2180 "contractCategoryGroup": {
2181 "id": 0,
2182 "displayId": "string",
2183 "status": "CREATED",
2184 "name": "string"
2185 },
2186 "contractGroup1": {
2187 "id": 0,
2188 "displayId": "string",
2189 "status": "CREATED",
2190 "name": "string"
2191 },
2192 "contractGroup2": {
2193 "id": 0,
2194 "displayId": "string",
2195 "status": "CREATED",
2196 "name": "string"
2197 },
2198 "group3": "string",
2199 "group4": "string",
2200 "signingPerson": "string",
2201 "placeOfSignature": "string",
2202 "dateOfSignature": "2019-08-24",
2203 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
2204 "numberRangeIdentifierType": {
2205 "name": "string"
2206 },
2207 "numberRangeIdentifierValue": "string",
2208 "allowsSystemGenerateNewId": true,
2209 "numberRangeType": {
2210 "name": "string"
2211 }
2212 },
2213 "currency": {
2214 "id": 0,
2215 "displayId": "string",
2216 "status": "CREATED",
2217 "name": "string",
2218 "decimalPoints": 0
2219 },
2220 "companyCurrency": {
2221 "id": 0,
2222 "displayId": "string",
2223 "status": "CREATED",
2224 "name": "string",
2225 "decimalPoints": 0
2226 },
2227 "indexedCurrency": true,
2228 "assetValueCurrencyType": "CONTRACT_CURRENCY",
2229 "currencyLocked": true,
2230 "leaseArea": {
2231 "id": 0,
2232 "displayId": "string",
2233 "status": "CREATED",
2234 "name": "string"
2235 },
2236 "businessUnit": {
2237 "id": 0,
2238 "displayId": "string",
2239 "status": "CREATED",
2240 "name": "string"
2241 },
2242 "businessUnitLocked": true,
2243 "companyCode": {
2244 "id": 0,
2245 "displayId": "string",
2246 "status": "CREATED",
2247 "erpSystemId": 0,
2248 "erpSystemDisplayId": "string",
2249 "countryId": 0,
2250 "countryDisplayId": "string",
2251 "name": "string",
2252 "postingPeriodVariantId": 0,
2253 "fiscalVariantId": 0
2254 },
2255 "companyCodeLocked": true,
2256 "department": {
2257 "id": 0,
2258 "displayId": "string",
2259 "status": "CREATED",
2260 "name": "string"
2261 },
2262 "departmentLocked": true,
2263 "leaseGroup": {
2264 "id": 0,
2265 "displayId": "string",
2266 "status": "CREATED",
2267 "name": "string"
2268 },
2269 "leaseGroupLocked": true,
2270 "subleasingInternalAssetClass": {
2271 "id": 0,
2272 "displayId": "string",
2273 "status": "CREATED",
2274 "name": "string",
2275 "assetClassType": "PROPERTY",
2276 "infiniteUsefulLife": true
2277 },
2278 "contractGroup1": {
2279 "id": 0,
2280 "displayId": "string",
2281 "status": "CREATED",
2282 "name": "string"
2283 },
2284 "contractGroup2": {
2285 "id": 0,
2286 "displayId": "string",
2287 "status": "CREATED",
2288 "name": "string"
2289 },
2290 "subleasing": true,
2291 "subleasingContractRevisionInfo": {
2292 "id": 0,
2293 "contractId": 0,
2294 "contractDisplayId": "string",
2295 "contractName": "string"
2296 },
2297 "subleasingLeaseComponentRevisionInfo": {
2298 "id": 0,
2299 "leaseComponentId": 0,
2300 "leaseComponentDisplayId": "string",
2301 "leaseComponentName": "string"
2302 },
2303 "subleasingActivationGroupRevisionInfo": {
2304 "id": 0,
2305 "activationGroupId": 0,
2306 "activationGroupDisplayId": "string",
2307 "activationGroupName": "string"
2308 },
2309 "notifications": [
2310 {
2311 "id": 0,
2312 "topic": {
2313 "enCaption": "string",
2314 "frCaption": "string",
2315 "name": "string",
2316 "priority": "HIGH"
2317 },
2318 "username": "string",
2319 "contractId": 0,
2320 "contractDisplayId": "string",
2321 "targetType": "string",
2322 "targetId": "string"
2323 }
2324 ],
2325 "masterAgreementId": 0,
2326 "masterAgreementDisplayId": "string",
2327 "allowsSystemGenerateNewId": true,
2328 "transferInfo": {
2329 "transferredFromDisplayId": "string",
2330 "transferredFromRevisionId": 0,
2331 "transferredToDisplayId": "string",
2332 "transferredToRevisionId": 0
2333 },
2334 "numberRangeIdentifierType": {
2335 "name": "string"
2336 },
2337 "numberRangeIdentifierValue": "string",
2338 "numberRangeType": {
2339 "name": "string"
2340 }
2341 }
2342 ],
2343 "listingCitiesValue": "string",
2344 "listingCitiesValues": [
2345 "string"
2346 ],
2347 "listingProvincesValue": "string",
2348 "listingProvincesValues": [
2349 "string"
2350 ],
2351 "listingCountriesValue": "string",
2352 "listingCountriesValues": [
2353 "string"
2354 ],
2355 "listingLocationsValue": "string",
2356 "listingLocationsValues": [
2357 "string"
2358 ],
2359 "listingPremisesValue": "string",
2360 "listingPremisesValues": [
2361 "string"
2362 ],
2363 "listingGroupsValue": "string",
2364 "listingGroupsValues": [
2365 "string"
2366 ],
2367 "listingGroupOptionsValue": "string",
2368 "listingGroupOptionsValues": [
2369 "string"
2370 ],
2371 "listingBusinessUnitsValue": "string",
2372 "listingBusinessUnitsValues": [
2373 "string"
2374 ],
2375 "listingLegalEntitiesValue": "string",
2376 "listingLegalEntitiesValues": [
2377 "string"
2378 ],
2379 "listingMasterAgreementsValue": "string",
2380 "listingMasterAgreementsValues": [
2381 "string"
2382 ],
2383 "listingContractsValue": "string",
2384 "listingContractsValues": [
2385 "string"
2386 ],
2387 "listingStatusOptionsValue": "string",
2388 "listingStatusOptionsValues": [
2389 "string"
2390 ]
2391}
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}
Lease - Search Leases By Mass Profile Filter IDs¶
HTTP Request
POST /api/leases/mass-profile-filters/search-by-ids
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
|
search |
query |
string |
false |
none |
premise-id |
query |
string |
false |
none |
premise-id-in |
query |
string |
false |
none |
premise-id-not-null |
query |
string |
false |
none |
premise-number |
query |
string |
false |
none |
premise-number-like |
query |
string |
false |
none |
premise-external-id |
query |
string |
false |
none |
location-id |
query |
string |
false |
none |
location-number |
query |
string |
false |
none |
location-number-like |
query |
string |
false |
none |
location-external-id |
query |
string |
false |
none |
address-id |
query |
string |
false |
none |
city-id |
query |
string |
false |
none |
province-id |
query |
string |
false |
none |
country-id |
query |
string |
false |
none |
contract-id |
query |
string |
false |
none |
number |
query |
string |
false |
none |
number-like |
query |
string |
false |
none |
number-in |
query |
string |
false |
none |
id |
query |
string |
false |
none |
id-in |
query |
string |
false |
none |
type-id |
query |
string |
false |
none |
terminating-lease |
query |
string |
false |
none |
signature-date |
query |
string |
false |
none |
category-id |
query |
string |
false |
none |
registration-number |
query |
string |
false |
none |
status-id |
query |
string |
false |
none |
status-id-is-not |
query |
string |
false |
none |
status-id-in |
query |
string |
false |
none |
original-lease-id |
query |
string |
false |
none |
parent-lease-id-is-null |
query |
string |
false |
none |
state-id |
query |
string |
false |
none |
areas-history-version-id |
query |
string |
false |
none |
valid-from |
query |
string |
false |
none |
valid-to |
query |
string |
false |
none |
valid-to-greater-than |
query |
string |
false |
none |
valid-to-less-than |
query |
string |
false |
none |
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
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}
Lease - Mass Delete Leases¶
HTTP Request
POST /api/leases/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 |
Lease - Get Lease Versions¶
HTTP Request
GET /api/leases/{originalLeaseId}/versions
📋 Description: Retrieves the version history of a specified lease, providing insights into changes and updates for effective portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
originalLeaseId |
path |
integer(int64) |
true |
Unique identifier for the original lease |
pageable |
query |
true |
Indicates whether the results of the lease versions query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
search |
query |
string |
false |
Search term used to filter lease versions based on specified criteria within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
name |
query |
string |
false |
Name of the resource |
description |
query |
string |
false |
Description of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "versions": [
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 "description": "string",
14 "modificationDate": "2019-08-24",
15 "updateContractRate": true,
16 "leaseEvent": {
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 "typeId": 0,
25 "code": "string",
26 "reviewedBy": "string",
27 "reviewedDate": "2019-08-24",
28 "reviewedStatusId": 0,
29 "activityDate": "2019-08-24",
30 "relatedPickListOptionId": 0,
31 "detail": "string",
32 "note": {
33 "createdBy": "string",
34 "lastModifiedBy": "string",
35 "createdDate": "2019-08-24T14:15:22Z",
36 "lastModifiedDate": "2019-08-24T14:15:22Z",
37 "archived": true,
38 "externalId": "string",
39 "id": 0,
40 "message": "string",
41 "preserveOriginalAudit": true,
42 "originalCreatedBy": "string",
43 "originalCreatedDate": "2019-08-24T14:15:22Z",
44 "originalLastModifiedBy": "string",
45 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
46 },
47 "type": {
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 "reviewedStatus": {
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 "relatedPickListOption": {
104 "createdBy": "string",
105 "lastModifiedBy": "string",
106 "createdDate": "2019-08-24T14:15:22Z",
107 "lastModifiedDate": "2019-08-24T14:15:22Z",
108 "archived": true,
109 "externalId": "string",
110 "id": 0,
111 "priority": 0,
112 "internalId": 0,
113 "pickListCode": "string",
114 "pickListLabel": "string",
115 "label": "string",
116 "cultureId": 0,
117 "labelDtos": [
118 {
119 "createdBy": "string",
120 "lastModifiedBy": "string",
121 "createdDate": "2019-08-24T14:15:22Z",
122 "lastModifiedDate": "2019-08-24T14:15:22Z",
123 "archived": true,
124 "externalId": "string",
125 "id": 0,
126 "cultureId": 0,
127 "value": "string"
128 }
129 ]
130 },
131 "isVisiblePartnerPortal": true
132 },
133 "isVisibleVendorPortal": true,
134 "isTerminationVersion": true,
135 "terminationDate": "2019-08-24",
136 "penaltyAmount": 0.1,
137 "areasHistoryVersionId": 0
138 }
139 ]
140 },
141 "page": {
142 "size": 0,
143 "totalElements": 0,
144 "totalPages": 0,
145 "number": 0
146 }
147}
Lease - Get Lease Versions Count¶
HTTP Request
GET /api/leases/{originalLeaseId}/versions/count
📋 Description: Retrieves the total count of versions associated with a specific lease identified by the originalLeaseId, providing valuable insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
originalLeaseId |
path |
integer(int64) |
true |
Unique identifier for the original lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
integer |
Example Responses
10
Lease - Get Term Indexations For Lease Group By Period¶
HTTP Request
GET /api/leases/{leaseId}/term-indexations/group-by-period
📋 Description: Retrieves term indexations for a specified lease, grouped by period, to facilitate comprehensive analytics and reporting within the Nakisa Portfolio Management Suite. This operation supports portfolio and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
pageable |
query |
true |
Indicates whether the results of the lease term indexations should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within real estate management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "termIndexationsGroupByPeriod": [
4 {
5 "startDate": "2019-08-24",
6 "endDate": "2019-08-24",
7 "currencyDisplayId": "string",
8 "expenseGroupToAmountMap": {
9 "property1": 0,
10 "property2": 0
11 },
12 "expenseGroupToAnnualRatePerAreaMap": {
13 "property1": 0,
14 "property2": 0
15 },
16 "expenseGroupToMessageMap": {
17 "property1": "string",
18 "property2": "string"
19 },
20 "legacy": true
21 }
22 ]
23 },
24 "page": {
25 "size": 0,
26 "totalElements": 0,
27 "totalPages": 0,
28 "number": 0
29 }
30}
Lease - Get Term Definitions For Lease¶
HTTP Request
GET /api/leases/{leaseId}/term-definitions
📋 Description: Retrieves the term definitions associated with a specific lease, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the term definitions for a specific lease should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
|
exclude-legacy |
query |
boolean |
false |
Indicates whether to exclude legacy term definitions from the lease term definitions response, enhancing clarity in portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
leaseId |
path |
string |
true |
Unique identifier for the lease |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
exclude-legacy |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "termDefinitions": [
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 "paymentFrequencyName": "string",
13 "amountFrequencyName": "string",
14 "paymentModeName": "string",
15 "expenseCategoryId": 0,
16 "currencyId": 0,
17 "startDate": "2019-08-24",
18 "endDate": "2019-08-24",
19 "firstPaymentDate": "2019-08-24",
20 "endOfMonthPayment": true,
21 "proRata": true,
22 "note": "string",
23 "areaId": 0,
24 "parentTermDefinitionId": 0,
25 "expenseCategory": {
26 "id": 0,
27 "status": "CREATED",
28 "displayId": "string",
29 "name": "string",
30 "editable": true,
31 "expenseCategoryType": "PAYMENT"
32 },
33 "currency": {
34 "id": 0,
35 "status": "CREATED",
36 "displayId": "string",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "name": "string",
40 "decimalPoints": 0,
41 "depreciationAreaId": 0
42 },
43 "expenseGroup": {
44 "createdBy": "string",
45 "lastModifiedBy": "string",
46 "createdDate": "2019-08-24T14:15:22Z",
47 "lastModifiedDate": "2019-08-24T14:15:22Z",
48 "archived": true,
49 "externalId": "string",
50 "id": 0,
51 "priority": 0,
52 "internalId": 0,
53 "pickListCode": "string",
54 "pickListLabel": "string",
55 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70 },
71 "costCenterId": 0,
72 "leaseComponentId": 0,
73 "leaseComponentName": "string",
74 "assignmentNumber": {
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 "assignmentNumberId": 0,
103 "isAdjustmentTerm": true
104 }
105 ]
106 },
107 "page": {
108 "size": 0,
109 "totalElements": 0,
110 "totalPages": 0,
111 "number": 0
112 }
113}
Lease - Get Term Definition Areas¶
HTTP Request
GET /api/leases/{leaseId}/term-definition-areas
📋 Description: Retrieves the term definition areas associated with a specific lease, providing insights into portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
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 "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 200
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. |
Lease - Get Plans Preview¶
HTTP Request
GET /api/leases/{leaseId}/plans-preview
📋 Description: Retrieves a preview of lease plans associated with a specific lease ID, enabling portfolio and asset managers to analyze potential financial impacts and optimize real estate property decisions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
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 "statusId": 0,
11 "desiredModificationDate": "2019-08-24",
12 "actualModificationDate": "2019-08-24",
13 "desiredIndexationDateLease": "2019-08-24",
14 "actualIndexationDateLease": "2019-08-24",
15 "desiredIndexationDateNonLease": "2019-08-24",
16 "actualIndexationDateNonLease": "2019-08-24",
17 "messageCode": "string",
18 "delimitedArguments": "string",
19 "messageCodeIndexationDateLease": "string",
20 "messageCodeIndexationDateNonLease": "string",
21 "status": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "cpiIndexationPlanId": 0,
50 "cpiIndexationPlanDto": {
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 "modificationDate": "2019-08-24",
59 "currencyId": 0,
60 "activationGroupId": 0,
61 "cpiGlobalCategoryId": 0,
62 "cpiGlobalCategoryIdNonLease": 0,
63 "cpiGlobalReferenceDate": "2019-08-24",
64 "cpiGlobalReferenceDateNonLease": "2019-08-24",
65 "cpiLocalCurrentIndexLevel": 0.1,
66 "cpiLocalCurrentIndexLevelNonLease": 0.1,
67 "conditionallyIndexed": true,
68 "applicableCurrentIndexLevel": 0.1,
69 "indexLevelPercentageChangeLowerBound": 0.1,
70 "indexLevelPercentageChangeUpperBound": 0.1,
71 "conditionallyIndexedNonLease": true,
72 "applicableCurrentIndexLevelNonLease": 0.1,
73 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
74 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
75 "statusId": 0,
76 "applyIndexationLease": true,
77 "indexationDateLease": "2019-08-24",
78 "applyIndexationNonLease": true,
79 "indexationDateNonLease": "2019-08-24",
80 "executionDate": "2019-08-24",
81 "executedModificationDate": "2019-08-24",
82 "executedIndexationDateLease": "2019-08-24",
83 "executedIndexationDateNonLease": "2019-08-24",
84 "messageCode": "string",
85 "messageCodeIndexationDateLease": "string",
86 "messageCodeIndexationDateNonLease": "string",
87 "status": {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "priority": 0,
96 "internalId": 0,
97 "pickListCode": "string",
98 "pickListLabel": "string",
99 "label": "string",
100 "cultureId": 0,
101 "labelDtos": [
102 {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "cultureId": 0,
111 "value": "string"
112 }
113 ]
114 },
115 "currency": {
116 "id": 0,
117 "status": "CREATED",
118 "displayId": "string",
119 "erpSystemId": 0,
120 "erpSystemDisplayId": "string",
121 "name": "string",
122 "decimalPoints": 0,
123 "depreciationAreaId": 0
124 },
125 "activationGroupDisplayId": "string",
126 "leaseId": 0,
127 "message": "string",
128 "messageIndexationDateLease": "string",
129 "messageIndexationDateNonLease": "string",
130 "cpiGlobalCategory": {
131 "id": 0,
132 "status": "CREATED",
133 "displayId": "string",
134 "name": "string",
135 "country": "string",
136 "province": "string",
137 "city": "string",
138 "consumerPriceIndexSourceType": "WEB",
139 "source": "string",
140 "formula": "string",
141 "indexedCurrency": true,
142 "exchangeRateType": "string",
143 "erpSystemId": 0,
144 "erpSystemDisplayId": "string",
145 "fromCurrencyId": 0,
146 "fromCurrencyDisplayId": "string",
147 "toCurrencyId": 0,
148 "toCurrencyDisplayId": "string",
149 "consumerPriceIndexValueId": "string",
150 "companyId": 0
151 },
152 "cpiGlobalCategoryNonLease": {
153 "id": 0,
154 "status": "CREATED",
155 "displayId": "string",
156 "name": "string",
157 "country": "string",
158 "province": "string",
159 "city": "string",
160 "consumerPriceIndexSourceType": "WEB",
161 "source": "string",
162 "formula": "string",
163 "indexedCurrency": true,
164 "exchangeRateType": "string",
165 "erpSystemId": 0,
166 "erpSystemDisplayId": "string",
167 "fromCurrencyId": 0,
168 "fromCurrencyDisplayId": "string",
169 "toCurrencyId": 0,
170 "toCurrencyDisplayId": "string",
171 "consumerPriceIndexValueId": "string",
172 "companyId": 0
173 }
174 },
175 "message": "string",
176 "messageIndexationDateLease": "string",
177 "messageIndexationDateNonLease": "string"
178 }
179]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[CpiLeaseIndexationPreviewDto is a data transfer object that provides a preview of lease indexation calculations within the Nakisa Portfolio Management Suite, facilitating informed decision-making for portfolio and asset management in the real estate sector.] |
|
» 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 |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» desiredModificationDate |
string(date) |
false |
none |
Date of the desired modification |
» actualModificationDate |
string(date) |
false |
none |
Date of the actual modification |
» desiredIndexationDateLease |
string(date) |
false |
none |
Specifies the desired indexation date for lease agreements within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
» actualIndexationDateLease |
string(date) |
false |
none |
Represents the actual date of indexation for a lease, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» desiredIndexationDateNonLease |
string(date) |
false |
none |
Specifies the desired indexation date for non-lease assets within the portfolio, facilitating accurate analytics and reporting in real estate property management. |
» actualIndexationDateNonLease |
string(date) |
false |
none |
Represents the actual date of indexation for non-lease assets within the portfolio, facilitating accurate analytics and reporting in real estate property management. |
» messageCode |
string |
false |
none |
Code for the message |
» delimitedArguments |
string |
false |
none |
String representation of the delimited arguments used for calculating lease indexation previews within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, and real estate property analytics. |
» messageCodeIndexationDateLease |
string |
false |
none |
Represents the date of indexation for the lease message code, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» messageCodeIndexationDateNonLease |
string |
false |
none |
Date indicating when the message code related to non-lease indexation was last indexed, relevant for portfolio and asset analytics 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. |
|
»» 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. |
» cpiIndexationPlanId |
integer(int64) |
false |
none |
Unique identifier for the cpi indexation plan |
» cpiIndexationPlanDto |
false |
none |
CpiIndexationPlanDto is a data transfer object that encapsulates the details of a Consumer Price Index (CPI) indexation plan, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite, particularly in the context of 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 |
»» modificationDate |
string(date) |
true |
none |
Date of the modification |
»» currencyId |
integer(int64) |
true |
none |
Unique identifier for the currency |
»» activationGroupId |
integer(int64) |
false |
none |
Unique identifier for the activation group |
»» cpiGlobalCategoryId |
integer(int64) |
false |
none |
Unique identifier for the cpi global category |
»» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
»» cpiGlobalReferenceDate |
string(date) |
false |
none |
Date of the cpi global reference |
»» cpiGlobalReferenceDateNonLease |
string(date) |
false |
none |
Represents the global reference date for non-lease related CPI adjustments within the context of portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
»» cpiLocalCurrentIndexLevel |
number(double) |
false |
none |
Value for cpiLocalCurrentIndexLevel field |
»» cpiLocalCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for cpiLocalCurrentIndexLevelNonLease field |
»» conditionallyIndexed |
boolean |
false |
none |
Indicates whether the indexation plan for the asset is subject to conditional indexing, impacting portfolio analytics and real estate property evaluations. |
»» applicableCurrentIndexLevel |
number(double) |
false |
none |
Value for applicableCurrentIndexLevel field |
»» indexLevelPercentageChangeLowerBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBound field |
»» indexLevelPercentageChangeUpperBound |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBound field |
»» conditionallyIndexedNonLease |
boolean |
false |
none |
Indicates whether the asset’s indexation is conditionally applied, relevant for portfolio analytics and real estate property management within the Nakisa Portfolio Management Suite. |
»» applicableCurrentIndexLevelNonLease |
number(double) |
false |
none |
Value for applicableCurrentIndexLevelNonLease field |
»» indexLevelPercentageChangeLowerBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeLowerBoundNonLease field |
»» indexLevelPercentageChangeUpperBoundNonLease |
number(double) |
false |
none |
Value for indexLevelPercentageChangeUpperBoundNonLease field |
»» statusId |
integer(int64) |
true |
none |
Unique identifier for the status |
»» applyIndexationLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationLease status |
»» indexationDateLease |
string(date) |
false |
none |
Represents the date of indexation for lease agreements within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
»» indexationDateNonLease |
string(date) |
false |
none |
Represents the date of indexation for non-lease assets within the portfolio, facilitating accurate analytics and management of real estate properties. |
»» executionDate |
string(date) |
false |
none |
Date of the execution |
»» executedModificationDate |
string(date) |
false |
none |
Date of the executed modification |
»» executedIndexationDateLease |
string(date) |
false |
none |
Represents the date on which the lease indexation was executed, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» executedIndexationDateNonLease |
string(date) |
false |
none |
Date on which the non-lease indexation was executed, providing critical insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageCode |
string |
false |
none |
Code for the message |
»» messageCodeIndexationDateLease |
string |
false |
none |
Represents the date of indexation for the lease message code, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»» messageCodeIndexationDateNonLease |
string |
false |
none |
Date indicating when the message code for non-lease indexation was recorded, relevant for portfolio and asset analytics 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. |
|
»» currency |
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 |
»» activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
»» leaseId |
integer(int64) |
true |
none |
Unique identifier for the lease |
»» message |
string |
false |
none |
Descriptive text providing insights or comments related to the portfolio asset’s indexation plan within the Nakisa Portfolio Management Suite. |
»» messageIndexationDateLease |
string |
false |
none |
Represents the date when the message indexation lease is established, facilitating accurate tracking and analytics within the Nakisa Portfolio Management Suite for portfolio and asset management. |
»» messageIndexationDateNonLease |
string |
false |
none |
Represents the date of message indexation for non-lease assets within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in the real estate sector. |
»» cpiGlobalCategory |
false |
none |
Data transfer object representing a category within the Consumer Price Index, utilized for portfolio and asset analytics in the Nakisa Portfolio Management Suite, specifically tailored for real estate property assessments. |
|
»»» 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 |
»»» name |
string |
true |
none |
Name of the resource |
»»» country |
string |
true |
none |
Represents the country associated with the consumer price index category, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»» province |
string |
true |
none |
Represents the province associated with the real estate property, facilitating portfolio analysis and asset management within the Nakisa Portfolio Management Suite. |
»»» city |
string |
true |
none |
Represents the city associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
»»» consumerPriceIndexSourceType |
string |
true |
none |
Type of the consumer price index source |
»»» source |
string |
true |
none |
Indicates the origin of the consumer price index category, providing essential context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»» formula |
string |
false |
none |
String representation of the formula used for calculating the Consumer Price Index within the context of portfolio analytics and real estate asset management. |
»»» indexedCurrency |
boolean |
true |
none |
Boolean flag indicating indexedCurrency status |
»»» exchangeRateType |
string |
false |
none |
Type of the exchange rate |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» fromCurrencyId |
integer(int64) |
false |
none |
Unique identifier for the from currency |
»»» fromCurrencyDisplayId |
string |
false |
none |
Unique identifier for the from currency display |
»»» toCurrencyId |
integer(int64) |
false |
none |
Unique identifier for the to currency |
»»» toCurrencyDisplayId |
string |
false |
none |
Unique identifier for the to currency display |
»»» consumerPriceIndexValueId |
string |
false |
none |
Unique identifier for the consumer price index value |
»»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»» cpiGlobalCategoryNonLease |
false |
none |
Data transfer object representing a category within the Consumer Price Index, utilized for portfolio and asset analytics in the Nakisa Portfolio Management Suite, specifically tailored for real estate property assessments. |
|
» message |
string |
false |
none |
Textual representation of the message associated with the lease indexation preview, providing insights relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» messageIndexationDateLease |
string |
false |
none |
Represents the date on which the message indexation lease is established, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
» messageIndexationDateNonLease |
string |
false |
none |
Represents the date of message indexation for non-lease assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
Enumerated Values
Attribute |
Value |
|---|---|
consumerPriceIndexSourceType |
EXCEL, WEB |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Get Percentage Rent Periods¶
HTTP Request
GET /api/leases/{leaseId}/percentage-rent-periods
📋 Description: Retrieves percentage rent periods associated with a specific lease, providing insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the percentage rent periods for the specified lease should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "percentageRentPeriods": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24"
14 }
15 ]
16 },
17 "page": {
18 "size": 0,
19 "totalElements": 0,
20 "totalPages": 0,
21 "number": 0
22 }
23}
Lease - Get Percentage Rent Generation Periods¶
HTTP Request
GET /api/leases/{leaseId}/percentage-rent-generation-periods
📋 Description: Fetches the percentage rent generation periods for a specified lease, enabling portfolio and asset managers to analyze financial performance within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results for the percentage rent generation periods associated with a specific lease should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "percentageRentGenerationPeriods": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24"
14 }
15 ]
16 },
17 "page": {
18 "size": 0,
19 "totalElements": 0,
20 "totalPages": 0,
21 "number": 0
22 }
23}
Lease - Get Lease Reconciliation Periods¶
HTTP Request
GET /api/leases/{leaseId}/lease-reconciliation-periods
📋 Description: Retrieves lease reconciliation periods associated with a specified lease, providing insights essential for portfolio and asset management within the Nakisa Portfolio Management Suite. This operation supports effective analytics for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lease reconciliation periods should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseReconciliationPeriods": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "statusId": 0,
15 "invoiceAmount": 0,
16 "receivedDate": "2019-08-24",
17 "acceptedAmount": 0,
18 "reviewedBy": "string",
19 "reviewedDate": "2019-08-24",
20 "fullReconciliation": true,
21 "status": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "operatingCostPeriodId": 0,
50 "reconciledExpenseCategoryDtos": [
51 {
52 "createdBy": "string",
53 "lastModifiedBy": "string",
54 "createdDate": "2019-08-24T14:15:22Z",
55 "lastModifiedDate": "2019-08-24T14:15:22Z",
56 "archived": true,
57 "externalId": "string",
58 "id": 0,
59 "expenseGroupId": 0,
60 "totalCost": 0,
61 "accrualAmount": 0,
62 "balance": 0,
63 "expenseGroup": {
64 "createdBy": "string",
65 "lastModifiedBy": "string",
66 "createdDate": "2019-08-24T14:15:22Z",
67 "lastModifiedDate": "2019-08-24T14:15:22Z",
68 "archived": true,
69 "externalId": "string",
70 "id": 0,
71 "priority": 0,
72 "internalId": 0,
73 "pickListCode": "string",
74 "pickListLabel": "string",
75 "label": "string",
76 "cultureId": 0,
77 "labelDtos": [
78 {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "cultureId": 0,
87 "value": "string"
88 }
89 ]
90 },
91 "reconciledExpenseDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "totalCost": 0,
101 "operatingCostExpenseTypeId": 0,
102 "operatingCostExpenseType": {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "priority": 0,
111 "internalId": 0,
112 "pickListCode": "string",
113 "pickListLabel": "string",
114 "label": "string",
115 "cultureId": 0,
116 "labelDtos": [
117 {}
118 ]
119 },
120 "reconciledExpenseSegmentDtos": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "startDate": "2019-08-24",
130 "endDate": "2019-08-24",
131 "adjustedLocationCost": 0,
132 "proSharePercentage": 0,
133 "proShareCost": 0,
134 "cap": 0,
135 "subtotalCost": 0,
136 "adminFees": 0,
137 "totalCost": 0,
138 "conditionDto": {}
139 }
140 ]
141 }
142 ],
143 "hasWarning": true
144 }
145 ]
146 }
147 ]
148 },
149 "page": {
150 "size": 0,
151 "totalElements": 0,
152 "totalPages": 0,
153 "number": 0
154 }
155}
Lease - Get Lease Incentives¶
HTTP Request
GET /api/leases/{leaseId}/lease-incentives
📋 Description: Retrieves lease incentive details for a specified lease, enabling portfolio managers to analyze financial benefits associated with real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lease incentives retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseIncentives": [
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 "totalAmount": 0,
13 "pageNumber": "string",
14 "section": "string",
15 "typeId": 0,
16 "type": {
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 }
45 ]
46 },
47 "page": {
48 "size": 0,
49 "totalElements": 0,
50 "totalPages": 0,
51 "number": 0
52 }
53}
Lease - Get Lease Critical Clause Types¶
HTTP Request
GET /api/leases/{leaseId}/lease-critical-clause-types
📋 Description: Retrieves critical clause types associated with a specific lease, enabling users to analyze key contractual elements within the context of portfolio and asset management in real estate.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results for lease critical clause types should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseCriticalClauseTypes": [
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 "notApplicable": true,
14 "type": {
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 "leaseId": 0,
43 "leaseDto": {
44 "createdBy": "string",
45 "lastModifiedBy": "string",
46 "createdDate": "2019-08-24T14:15:22Z",
47 "lastModifiedDate": "2019-08-24T14:15:22Z",
48 "archived": true,
49 "externalId": "string",
50 "id": 0,
51 "typeId": 0,
52 "terminatingLease": "2019-08-24",
53 "maximumDateTo": "2019-08-24",
54 "number": "string",
55 "validFrom": "2019-08-24",
56 "validTo": "2019-08-24",
57 "categoryId": 0,
58 "registrationNumber": "string",
59 "statusId": 0,
60 "stateId": 0,
61 "calculateTax": true,
62 "autoMonthToMonth": true,
63 "originalLeaseId": 0,
64 "scenario": true,
65 "parentLeaseId": 0,
66 "areasHistoryVersionId": 0,
67 "provisioningFrequencyName": "string",
68 "accountingApproved": true,
69 "indexationType": "string",
70 "cpiGlobalCategoryId": 0,
71 "indexationReferenceDate": "2019-08-24",
72 "currentIndexLevel": 0.1,
73 "conditionallyIndexed": true,
74 "applicableCurrentIndexLevel": 0.1,
75 "indexLevelPercentageChangeLowerBound": 0.1,
76 "indexLevelPercentageChangeUpperBound": 0.1,
77 "indexationTypeNonLease": "string",
78 "cpiGlobalCategoryIdNonLease": 0,
79 "indexationReferenceDateNonLease": "2019-08-24",
80 "currentIndexLevelNonLease": 0.1,
81 "conditionallyIndexedNonLease": true,
82 "applicableCurrentIndexLevelNonLease": 0.1,
83 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
84 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
85 "signatureDate": "2019-08-24",
86 "premiseId": 0,
87 "type": {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "priority": 0,
96 "internalId": 0,
97 "pickListCode": "string",
98 "pickListLabel": "string",
99 "label": "string",
100 "cultureId": 0,
101 "labelDtos": [
102 {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "cultureId": 0,
111 "value": "string"
112 }
113 ]
114 },
115 "category": {
116 "createdBy": "string",
117 "lastModifiedBy": "string",
118 "createdDate": "2019-08-24T14:15:22Z",
119 "lastModifiedDate": "2019-08-24T14:15:22Z",
120 "archived": true,
121 "externalId": "string",
122 "id": 0,
123 "priority": 0,
124 "internalId": 0,
125 "pickListCode": "string",
126 "pickListLabel": "string",
127 "label": "string",
128 "cultureId": 0,
129 "labelDtos": [
130 {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "cultureId": 0,
139 "value": "string"
140 }
141 ]
142 },
143 "status": {
144 "createdBy": "string",
145 "lastModifiedBy": "string",
146 "createdDate": "2019-08-24T14:15:22Z",
147 "lastModifiedDate": "2019-08-24T14:15:22Z",
148 "archived": true,
149 "externalId": "string",
150 "id": 0,
151 "priority": 0,
152 "internalId": 0,
153 "pickListCode": "string",
154 "pickListLabel": "string",
155 "label": "string",
156 "cultureId": 0,
157 "labelDtos": [
158 {
159 "createdBy": "string",
160 "lastModifiedBy": "string",
161 "createdDate": "2019-08-24T14:15:22Z",
162 "lastModifiedDate": "2019-08-24T14:15:22Z",
163 "archived": true,
164 "externalId": "string",
165 "id": 0,
166 "cultureId": 0,
167 "value": "string"
168 }
169 ]
170 },
171 "state": {
172 "createdBy": "string",
173 "lastModifiedBy": "string",
174 "createdDate": "2019-08-24T14:15:22Z",
175 "lastModifiedDate": "2019-08-24T14:15:22Z",
176 "archived": true,
177 "externalId": "string",
178 "id": 0,
179 "priority": 0,
180 "internalId": 0,
181 "pickListCode": "string",
182 "pickListLabel": "string",
183 "label": "string",
184 "cultureId": 0,
185 "labelDtos": [
186 {
187 "createdBy": "string",
188 "lastModifiedBy": "string",
189 "createdDate": "2019-08-24T14:15:22Z",
190 "lastModifiedDate": "2019-08-24T14:15:22Z",
191 "archived": true,
192 "externalId": "string",
193 "id": 0,
194 "cultureId": 0,
195 "value": "string"
196 }
197 ]
198 },
199 "version": {
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 "id": 0,
207 "name": "string",
208 "description": "string",
209 "modificationDate": "2019-08-24",
210 "updateContractRate": true,
211 "leaseEvent": {
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 "typeId": 0,
220 "code": "string",
221 "reviewedBy": "string",
222 "reviewedDate": "2019-08-24",
223 "reviewedStatusId": 0,
224 "activityDate": "2019-08-24",
225 "relatedPickListOptionId": 0,
226 "detail": "string",
227 "note": {
228 "createdBy": "string",
229 "lastModifiedBy": "string",
230 "createdDate": "2019-08-24T14:15:22Z",
231 "lastModifiedDate": "2019-08-24T14:15:22Z",
232 "archived": true,
233 "externalId": "string",
234 "id": 0,
235 "message": "string",
236 "preserveOriginalAudit": true,
237 "originalCreatedBy": "string",
238 "originalCreatedDate": "2019-08-24T14:15:22Z",
239 "originalLastModifiedBy": "string",
240 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
241 },
242 "type": {
243 "createdBy": "string",
244 "lastModifiedBy": "string",
245 "createdDate": "2019-08-24T14:15:22Z",
246 "lastModifiedDate": "2019-08-24T14:15:22Z",
247 "archived": true,
248 "externalId": "string",
249 "id": 0,
250 "priority": 0,
251 "internalId": 0,
252 "pickListCode": "string",
253 "pickListLabel": "string",
254 "label": "string",
255 "cultureId": 0,
256 "labelDtos": [
257 {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "cultureId": 0,
266 "value": "string"
267 }
268 ]
269 },
270 "reviewedStatus": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "priority": 0,
279 "internalId": 0,
280 "pickListCode": "string",
281 "pickListLabel": "string",
282 "label": "string",
283 "cultureId": 0,
284 "labelDtos": [
285 {
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 "cultureId": 0,
294 "value": "string"
295 }
296 ]
297 },
298 "relatedPickListOption": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "priority": 0,
307 "internalId": 0,
308 "pickListCode": "string",
309 "pickListLabel": "string",
310 "label": "string",
311 "cultureId": 0,
312 "labelDtos": [
313 {
314 "createdBy": "string",
315 "lastModifiedBy": "string",
316 "createdDate": "2019-08-24T14:15:22Z",
317 "lastModifiedDate": "2019-08-24T14:15:22Z",
318 "archived": true,
319 "externalId": "string",
320 "id": 0,
321 "cultureId": 0,
322 "value": "string"
323 }
324 ]
325 },
326 "isVisiblePartnerPortal": true
327 },
328 "isVisibleVendorPortal": true,
329 "isTerminationVersion": true,
330 "terminationDate": "2019-08-24",
331 "penaltyAmount": 0.1,
332 "areasHistoryVersionId": 0
333 },
334 "premiseDto": {
335 "createdBy": "string",
336 "lastModifiedBy": "string",
337 "createdDate": "2019-08-24T14:15:22Z",
338 "lastModifiedDate": "2019-08-24T14:15:22Z",
339 "archived": true,
340 "externalId": "string",
341 "id": 0,
342 "number": "string",
343 "name": "string",
344 "headPremise": true,
345 "possessionDate": "2019-08-24",
346 "openingDate": "2019-08-24",
347 "closingDate": "2019-08-24",
348 "relocationDate": "2019-08-24",
349 "vacatingDate": "2019-08-24",
350 "expansionDate": "2019-08-24",
351 "statusId": 0,
352 "usageId": 0,
353 "parentPremiseId": 0,
354 "costCenterId": 0,
355 "profitCenterId": 0,
356 "legalEntityId": 0,
357 "occupancyIds": [
358 0
359 ],
360 "locationId": 0,
361 "locationDto": {
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 "number": "string",
370 "name": "string",
371 "storeNumber": "string",
372 "defaultCurrencyId": 0,
373 "defaultMeasureId": 0,
374 "typeId": 0,
375 "qualityId": 0,
376 "propertyTypeId": 0,
377 "categoryId": 0,
378 "statusId": 0,
379 "businessUnitId": 0,
380 "groupIds": [
381 0
382 ],
383 "legalEntityIds": [
384 0
385 ],
386 "defaultCurrency": {
387 "id": 0,
388 "status": "CREATED",
389 "displayId": "string",
390 "erpSystemId": 0,
391 "erpSystemDisplayId": "string",
392 "name": "string",
393 "decimalPoints": 0,
394 "depreciationAreaId": 0
395 },
396 "defaultUnitValue": {
397 "createdBy": "string",
398 "lastModifiedBy": "string",
399 "createdDate": "2019-08-24T14:15:22Z",
400 "lastModifiedDate": "2019-08-24T14:15:22Z",
401 "archived": true,
402 "externalId": "string",
403 "id": 0,
404 "unitId": 0,
405 "unitOfMeasureId": 0,
406 "erpSystemId": 0,
407 "unit": {
408 "createdBy": "string",
409 "lastModifiedBy": "string",
410 "createdDate": "2019-08-24T14:15:22Z",
411 "lastModifiedDate": "2019-08-24T14:15:22Z",
412 "archived": true,
413 "externalId": "string",
414 "id": 0,
415 "priority": 0,
416 "internalId": 0,
417 "pickListCode": "string",
418 "pickListLabel": "string",
419 "label": "string",
420 "cultureId": 0,
421 "labelDtos": [
422 {}
423 ]
424 },
425 "unitOfMeasure": {
426 "id": 0,
427 "status": "CREATED",
428 "displayId": "string",
429 "erpSystemId": 0,
430 "erpSystemDisplayId": "string",
431 "name": "string"
432 }
433 },
434 "type": {
435 "createdBy": "string",
436 "lastModifiedBy": "string",
437 "createdDate": "2019-08-24T14:15:22Z",
438 "lastModifiedDate": "2019-08-24T14:15:22Z",
439 "archived": true,
440 "externalId": "string",
441 "id": 0,
442 "priority": 0,
443 "internalId": 0,
444 "pickListCode": "string",
445 "pickListLabel": "string",
446 "label": "string",
447 "cultureId": 0,
448 "labelDtos": [
449 {
450 "createdBy": "string",
451 "lastModifiedBy": "string",
452 "createdDate": "2019-08-24T14:15:22Z",
453 "lastModifiedDate": "2019-08-24T14:15:22Z",
454 "archived": true,
455 "externalId": "string",
456 "id": 0,
457 "cultureId": 0,
458 "value": "string"
459 }
460 ]
461 },
462 "quality": {
463 "createdBy": "string",
464 "lastModifiedBy": "string",
465 "createdDate": "2019-08-24T14:15:22Z",
466 "lastModifiedDate": "2019-08-24T14:15:22Z",
467 "archived": true,
468 "externalId": "string",
469 "id": 0,
470 "priority": 0,
471 "internalId": 0,
472 "pickListCode": "string",
473 "pickListLabel": "string",
474 "label": "string",
475 "cultureId": 0,
476 "labelDtos": [
477 {
478 "createdBy": "string",
479 "lastModifiedBy": "string",
480 "createdDate": "2019-08-24T14:15:22Z",
481 "lastModifiedDate": "2019-08-24T14:15:22Z",
482 "archived": true,
483 "externalId": "string",
484 "id": 0,
485 "cultureId": 0,
486 "value": "string"
487 }
488 ]
489 },
490 "propertyType": {
491 "createdBy": "string",
492 "lastModifiedBy": "string",
493 "createdDate": "2019-08-24T14:15:22Z",
494 "lastModifiedDate": "2019-08-24T14:15:22Z",
495 "archived": true,
496 "externalId": "string",
497 "id": 0,
498 "priority": 0,
499 "internalId": 0,
500 "pickListCode": "string",
501 "pickListLabel": "string",
502 "label": "string",
503 "cultureId": 0,
504 "labelDtos": [
505 {
506 "createdBy": "string",
507 "lastModifiedBy": "string",
508 "createdDate": "2019-08-24T14:15:22Z",
509 "lastModifiedDate": "2019-08-24T14:15:22Z",
510 "archived": true,
511 "externalId": "string",
512 "id": 0,
513 "cultureId": 0,
514 "value": "string"
515 }
516 ]
517 },
518 "category": {
519 "createdBy": "string",
520 "lastModifiedBy": "string",
521 "createdDate": "2019-08-24T14:15:22Z",
522 "lastModifiedDate": "2019-08-24T14:15:22Z",
523 "archived": true,
524 "externalId": "string",
525 "id": 0,
526 "priority": 0,
527 "internalId": 0,
528 "pickListCode": "string",
529 "pickListLabel": "string",
530 "label": "string",
531 "cultureId": 0,
532 "labelDtos": [
533 {
534 "createdBy": "string",
535 "lastModifiedBy": "string",
536 "createdDate": "2019-08-24T14:15:22Z",
537 "lastModifiedDate": "2019-08-24T14:15:22Z",
538 "archived": true,
539 "externalId": "string",
540 "id": 0,
541 "cultureId": 0,
542 "value": "string"
543 }
544 ]
545 },
546 "status": {
547 "createdBy": "string",
548 "lastModifiedBy": "string",
549 "createdDate": "2019-08-24T14:15:22Z",
550 "lastModifiedDate": "2019-08-24T14:15:22Z",
551 "archived": true,
552 "externalId": "string",
553 "id": 0,
554 "priority": 0,
555 "internalId": 0,
556 "pickListCode": "string",
557 "pickListLabel": "string",
558 "label": "string",
559 "cultureId": 0,
560 "labelDtos": [
561 {
562 "createdBy": "string",
563 "lastModifiedBy": "string",
564 "createdDate": "2019-08-24T14:15:22Z",
565 "lastModifiedDate": "2019-08-24T14:15:22Z",
566 "archived": true,
567 "externalId": "string",
568 "id": 0,
569 "cultureId": 0,
570 "value": "string"
571 }
572 ]
573 },
574 "addressDto": {
575 "createdBy": "string",
576 "lastModifiedBy": "string",
577 "createdDate": "2019-08-24T14:15:22Z",
578 "lastModifiedDate": "2019-08-24T14:15:22Z",
579 "archived": true,
580 "externalId": "string",
581 "id": 0,
582 "street": "string",
583 "civicNumber": "string",
584 "suite": "string",
585 "postalCode": "string",
586 "lon": 0.1,
587 "lat": 0.1,
588 "city": {
589 "createdBy": "string",
590 "lastModifiedBy": "string",
591 "createdDate": "2019-08-24T14:15:22Z",
592 "lastModifiedDate": "2019-08-24T14:15:22Z",
593 "archived": true,
594 "externalId": "string",
595 "id": 0,
596 "name": "string",
597 "province": {
598 "createdBy": "string",
599 "lastModifiedBy": "string",
600 "createdDate": "2019-08-24T14:15:22Z",
601 "lastModifiedDate": "2019-08-24T14:15:22Z",
602 "archived": true,
603 "externalId": "string",
604 "id": 0,
605 "name": "string",
606 "code": "string",
607 "country": {},
608 "provinceCountryKey": "string"
609 },
610 "cityProvinceCountryKey": "string"
611 },
612 "district": {
613 "createdBy": "string",
614 "lastModifiedBy": "string",
615 "createdDate": "2019-08-24T14:15:22Z",
616 "lastModifiedDate": "2019-08-24T14:15:22Z",
617 "archived": true,
618 "externalId": "string",
619 "id": 0,
620 "name": "string",
621 "city": {
622 "createdBy": "string",
623 "lastModifiedBy": "string",
624 "createdDate": "2019-08-24T14:15:22Z",
625 "lastModifiedDate": "2019-08-24T14:15:22Z",
626 "archived": true,
627 "externalId": "string",
628 "id": 0,
629 "name": "string",
630 "province": {},
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {},
671 "provinceCountryKey": "string"
672 },
673 "cityProvinceCountryKey": "string"
674 },
675 "district": {
676 "createdBy": "string",
677 "lastModifiedBy": "string",
678 "createdDate": "2019-08-24T14:15:22Z",
679 "lastModifiedDate": "2019-08-24T14:15:22Z",
680 "archived": true,
681 "externalId": "string",
682 "id": 0,
683 "name": "string",
684 "city": {
685 "createdBy": "string",
686 "lastModifiedBy": "string",
687 "createdDate": "2019-08-24T14:15:22Z",
688 "lastModifiedDate": "2019-08-24T14:15:22Z",
689 "archived": true,
690 "externalId": "string",
691 "id": 0,
692 "name": "string",
693 "province": {},
694 "cityProvinceCountryKey": "string"
695 }
696 },
697 "cityId": 0,
698 "districtId": 0
699 }
700 },
701 "status": {
702 "createdBy": "string",
703 "lastModifiedBy": "string",
704 "createdDate": "2019-08-24T14:15:22Z",
705 "lastModifiedDate": "2019-08-24T14:15:22Z",
706 "archived": true,
707 "externalId": "string",
708 "id": 0,
709 "priority": 0,
710 "internalId": 0,
711 "pickListCode": "string",
712 "pickListLabel": "string",
713 "label": "string",
714 "cultureId": 0,
715 "labelDtos": [
716 {
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 "cultureId": 0,
725 "value": "string"
726 }
727 ]
728 },
729 "usage": {
730 "createdBy": "string",
731 "lastModifiedBy": "string",
732 "createdDate": "2019-08-24T14:15:22Z",
733 "lastModifiedDate": "2019-08-24T14:15:22Z",
734 "archived": true,
735 "externalId": "string",
736 "id": 0,
737 "priority": 0,
738 "internalId": 0,
739 "pickListCode": "string",
740 "pickListLabel": "string",
741 "label": "string",
742 "cultureId": 0,
743 "labelDtos": [
744 {
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 "cultureId": 0,
753 "value": "string"
754 }
755 ]
756 },
757 "occupanciesDto": [
758 {
759 "createdBy": "string",
760 "lastModifiedBy": "string",
761 "createdDate": "2019-08-24T14:15:22Z",
762 "lastModifiedDate": "2019-08-24T14:15:22Z",
763 "archived": true,
764 "externalId": "string",
765 "id": 0,
766 "priority": 0,
767 "internalId": 0,
768 "pickListCode": "string",
769 "pickListLabel": "string",
770 "label": "string",
771 "cultureId": 0,
772 "labelDtos": [
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 "cultureId": 0,
782 "value": "string"
783 }
784 ]
785 }
786 ]
787 },
788 "isTerminationVersion": true
789 }
790 }
791 ]
792 },
793 "page": {
794 "size": 0,
795 "totalElements": 0,
796 "totalPages": 0,
797 "number": 0
798 }
799}
Lease - Get Lease Conditions¶
HTTP Request
GET /api/leases/{leaseId}/lease-conditions
📋 Description: Fetches the lease conditions associated with a specific lease identified by the leaseId, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the lease conditions query should be paginated, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite for portfolio and asset analysis. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseConditions": [
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 "parentConditionId": 0,
13 "typeId": 0,
14 "startDate": "2019-08-24",
15 "endDate": "2019-08-24",
16 "replaceById": 0,
17 "managedById": 0,
18 "payById": 0,
19 "adminFee": 0,
20 "fixedIncreasePercentage": 0,
21 "note": "string",
22 "pageNumber": "string",
23 "section": "string",
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 "replaceBy": {
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 "managedBy": {
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 "payBy": {
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 "proShareDto": {
137 "createdBy": "string",
138 "lastModifiedBy": "string",
139 "createdDate": "2019-08-24T14:15:22Z",
140 "lastModifiedDate": "2019-08-24T14:15:22Z",
141 "archived": true,
142 "externalId": "string",
143 "id": 0,
144 "type": "string"
145 },
146 "capDto": {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "type": "string"
155 }
156 }
157 ]
158 },
159 "page": {
160 "size": 0,
161 "totalElements": 0,
162 "totalPages": 0,
163 "number": 0
164 }
165}
Lease - Get Lease Clause Types¶
HTTP Request
GET /api/leases/{leaseId}/lease-clause-types
📋 Description: Retrieves the lease clause types associated with a specific lease, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results should be paginated, allowing for efficient retrieval of lease clause types within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseClauseTypes": [
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 "notApplicable": true,
14 "type": {
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 "leaseId": 0
43 }
44 ]
45 },
46 "page": {
47 "size": 0,
48 "totalElements": 0,
49 "totalPages": 0,
50 "number": 0
51 }
52}
Lease - Get Lease Insurances¶
HTTP Request
GET /api/leases/{leaseId}/insurances
📋 Description: Retrieves insurance details associated with a specific lease, enabling users to analyze risk management and compliance within their real estate portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the insurance data retrieval for a specific lease should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
leaseId |
path |
string |
true |
Unique identifier for the lease |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "insurances": [
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 "pageNumber": "string",
14 "section": "string",
15 "amount": 0,
16 "type": {
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 }
45 ]
46 },
47 "page": {
48 "size": 0,
49 "totalElements": 0,
50 "totalPages": 0,
51 "number": 0
52 }
53}
Lease - Download Lease Document¶
HTTP Request
GET /api/leases/{leaseId}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a lease, enabling users to access critical documentation for effective portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Lease - Get Lease Partners¶
HTTP Request
GET /api/leases/{id}/vendors
📋 Description: Retrieves a list of vendors associated with a specific lease, providing insights for portfolio management and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "partnerDtoList": [
4 {
5 "id": 0,
6 "status": "CREATED",
7 "displayId": "string",
8 "erpSystemId": 0,
9 "erpSystemDisplayId": "string",
10 "name": "string",
11 "fax": "string",
12 "phone": "string",
13 "parentId": 0,
14 "parentName": "string",
15 "parentDisplayId": "string",
16 "companyId": 0,
17 "partnerRoleId": 0,
18 "partnerContactId": 0
19 }
20 ]
21 },
22 "page": {
23 "size": 0,
24 "totalElements": 0,
25 "totalPages": 0,
26 "number": 0
27 }
28}
Lease - Get Lease Udf Field Values¶
HTTP Request
GET /api/leases/{id}/udf-field-values
📋 Description: Fetches user-defined field values associated with a specific lease, enabling enhanced analytics and insights within the Nakisa Portfolio Management Suite for effective 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 "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
Lease - Get Transitions¶
HTTP Request
GET /api/leases/{id}/transitions
📋 Description: Retrieves the transition history for a specific lease identified by its ID, providing insights into portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 |
Lease - Get Lease Separate Agreements¶
HTTP Request
GET /api/leases/{id}/separate-agreements
📋 Description: Fetches separate agreements associated with a specific lease, enabling users to analyze and manage real estate property agreements 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 separate agreements for the specified lease 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 and retrieve specific separate agreements related to a lease within the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Identifier for the specific type of separate agreement associated with the lease, facilitating targeted retrieval of relevant portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of the separate agreements associated with a specific lease, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
account-number |
query |
string |
false |
Unique identifier for the account associated with the lease, used to retrieve separate agreements within the Nakisa Portfolio Management Suite. |
meter-number |
query |
string |
false |
Unique identifier for the meter associated with the lease, used to retrieve separate agreements within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
other-reference |
query |
string |
false |
An optional string parameter that allows users to specify an additional reference for tracking separate agreements related to a lease within the Nakisa Portfolio Management Suite. |
start-date |
query |
string |
false |
Specifies the start date for retrieving separate agreements associated with a lease, facilitating portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
end-date |
query |
string |
false |
Specifies the end date for retrieving separate agreements related to a lease, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite. |
latest-notice |
query |
string |
false |
Specifies the latest notice associated with the lease, providing critical 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 "separateAgreements": [
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 "accountNumber": "string",
15 "meterNumber": "string",
16 "otherReference": "string",
17 "startDate": "2019-08-24",
18 "endDate": "2019-08-24",
19 "latestNotice": "2019-08-24",
20 "cost": 0,
21 "depositAmount": 0,
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 "status": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 }
78 }
79 ]
80 },
81 "page": {
82 "size": 0,
83 "totalElements": 0,
84 "totalPages": 0,
85 "number": 0
86 }
87}
Lease - Get Recurring Payments For Lease ID¶
HTTP Request
GET /api/leases/{id}/recurring-payments
📋 Description: Fetches recurring payment details for a specified lease, enabling portfolio managers to analyze cash flow and payment schedules within the Nakisa Portfolio Management Suite.
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, enabling targeted analytics for portfolio and asset management within real estate properties. |
start-date |
query |
string(date) |
false |
none |
end-date |
query |
string(date) |
false |
none |
payment-date |
query |
string(date) |
false |
none |
payment-date-less-than |
query |
string(date) |
false |
none |
payment-term-id |
query |
integer(int64) |
false |
none |
lease-component-financial-term-id |
query |
integer(int64) |
false |
none |
exclude-cost-centers |
query |
boolean |
false |
none |
principal-position-type |
query |
string |
false |
Specifies the type of principal position associated with the recurring payments for a lease, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
premise-display-id |
query |
string |
false |
Unique identifier for the premise display within the Nakisa Portfolio Management Suite, used to retrieve recurring payment details for a specific lease. |
lease-display-id |
query |
string |
false |
Unique identifier for the lease display, used to retrieve recurring payment information within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
expense-category-id |
query |
integer(int64) |
false |
Unique identifier for the expense category associated with recurring payments in the lease management process within the Nakisa Portfolio Management Suite. |
posting-status |
query |
string |
false |
Specifies the current status of the posting for recurring payments associated with a lease, enabling effective tracking and management 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 }
53 ]
54 },
55 "page": {
56 "size": 0,
57 "totalElements": 0,
58 "totalPages": 0,
59 "number": 0
60 }
61}
Lease - Get Provision For Lease¶
HTTP Request
GET /api/leases/{id}/provisions
📋 Description: Retrieves provisions associated with a specific lease, providing insights into contractual obligations and terms relevant to 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 lease provisions query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "provisions": [
4 {
5 "period": 0,
6 "provisionDate": "2019-08-24",
7 "numberOfDays": 0,
8 "leaseAmount": 0,
9 "nonLeaseAmount": 0,
10 "currencyCode": "string",
11 "postingTransactionType": "POST",
12 "status": "NA",
13 "leaseComponentDisplayId": "string"
14 }
15 ]
16 },
17 "page": {
18 "size": 0,
19 "totalElements": 0,
20 "totalPages": 0,
21 "number": 0
22 }
23}
Lease - Get Partners For Lease¶
HTTP Request
GET /api/leases/{id}/partners
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
pageable |
query |
true |
none |
|
partner-id |
query |
string |
false |
none |
partner-role-id |
query |
string |
false |
none |
partner-role-id-in |
query |
string |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "leaseToPartners": [
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 "partnerId": 0,
13 "partnerRoleId": 0,
14 "dateFrom": "2019-08-24",
15 "dateTo": "2019-08-24",
16 "leaseId": 0,
17 "leaseExternalId": "string",
18 "partner": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "partnerParent": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemDisplayId": "string"
31 },
32 "partnerRole": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string"
37 }
38 }
39 ]
40 },
41 "page": {
42 "size": 0,
43 "totalElements": 0,
44 "totalPages": 0,
45 "number": 0
46 }
47}
Lease - Get NFS Links¶
HTTP Request
GET /api/leases/{id}/nfs-links
📋 Description: Retrieves the network file system (NFS) links associated with a specific lease, enabling users to access relevant documentation and data 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 |
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 "masterAgreementId": 0,
11 "contractId": 0,
12 "leaseComponentId": 0,
13 "contractRevisionId": 0,
14 "leaseComponentRevisionId": 0,
15 "activationGroupRevisionId": 0,
16 "contractDto": {
17 "id": 0,
18 "displayId": "string",
19 "name": "string",
20 "principalPositionType": "LESSEE",
21 "validFrom": "2019-08-24",
22 "validTo": "2019-08-24",
23 "amendmentDate": "2019-08-24",
24 "approverComment": "string",
25 "contractPhase": "INITIAL",
26 "dataCreationInfo": {
27 "id": 0,
28 "idGenerationType": "AUTO",
29 "source": "string",
30 "type": "MIGRATION",
31 "startDateTime": "2019-08-24T14:15:22Z",
32 "endDateTime": "2019-08-24T14:15:22Z"
33 },
34 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
35 "revision": {
36 "id": 0,
37 "displayId": "string",
38 "name": "string",
39 "inception": true,
40 "revisionType": "REVISION",
41 "state": "MLA_DEFINE",
42 "approvedBy": "string",
43 "approvedAt": "2019-08-24T14:15:22Z",
44 "parentRevisionId": 0,
45 "approverComment": "string",
46 "contractId": 0,
47 "contractDisplayId": "string",
48 "contractName": "string",
49 "principalPositionType": "LESSEE",
50 "mlaId": 0,
51 "companyId": 0,
52 "description": "string",
53 "externalReference": "string",
54 "internalReference": "string",
55 "formOfLease": "FULL",
56 "jointVentureLeaseType": "GROSS_LEASE",
57 "businessPlace": "string",
58 "tradingPartner": {
59 "id": 0,
60 "displayId": "string",
61 "status": "CREATED",
62 "name": "string",
63 "erpSystemId": 0,
64 "erpSystemDisplayId": "string"
65 },
66 "contractCategoryGroup": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string"
71 },
72 "contractGroup1": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string"
77 },
78 "contractGroup2": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string"
83 },
84 "group3": "string",
85 "group4": "string",
86 "signingPerson": "string",
87 "placeOfSignature": "string",
88 "dateOfSignature": "2019-08-24",
89 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
90 "numberRangeIdentifierType": {
91 "name": "string"
92 },
93 "numberRangeIdentifierValue": "string",
94 "allowsSystemGenerateNewId": true,
95 "numberRangeType": {
96 "name": "string"
97 }
98 },
99 "currency": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "decimalPoints": 0
105 },
106 "companyCurrency": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "decimalPoints": 0
112 },
113 "indexedCurrency": true,
114 "assetValueCurrencyType": "CONTRACT_CURRENCY",
115 "currencyLocked": true,
116 "leaseArea": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string"
121 },
122 "businessUnit": {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string"
127 },
128 "businessUnitLocked": true,
129 "companyCode": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "erpSystemId": 0,
134 "erpSystemDisplayId": "string",
135 "countryId": 0,
136 "countryDisplayId": "string",
137 "name": "string",
138 "postingPeriodVariantId": 0,
139 "fiscalVariantId": 0
140 },
141 "companyCodeLocked": true,
142 "department": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string"
147 },
148 "departmentLocked": true,
149 "leaseGroup": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string"
154 },
155 "leaseGroupLocked": true,
156 "subleasingInternalAssetClass": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "assetClassType": "PROPERTY",
162 "infiniteUsefulLife": true
163 },
164 "contractGroup1": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string"
169 },
170 "contractGroup2": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string"
175 },
176 "subleasing": true,
177 "subleasingContractRevisionInfo": {
178 "id": 0,
179 "contractId": 0,
180 "contractDisplayId": "string",
181 "contractName": "string"
182 },
183 "subleasingLeaseComponentRevisionInfo": {
184 "id": 0,
185 "leaseComponentId": 0,
186 "leaseComponentDisplayId": "string",
187 "leaseComponentName": "string"
188 },
189 "subleasingActivationGroupRevisionInfo": {
190 "id": 0,
191 "activationGroupId": 0,
192 "activationGroupDisplayId": "string",
193 "activationGroupName": "string"
194 },
195 "notifications": [
196 {
197 "id": 0,
198 "topic": {
199 "enCaption": "string",
200 "frCaption": "string",
201 "name": "string",
202 "priority": "HIGH"
203 },
204 "username": "string",
205 "contractId": 0,
206 "contractDisplayId": "string",
207 "targetType": "string",
208 "targetId": "string"
209 }
210 ],
211 "masterAgreementId": 0,
212 "masterAgreementDisplayId": "string",
213 "allowsSystemGenerateNewId": true,
214 "transferInfo": {
215 "transferredFromDisplayId": "string",
216 "transferredFromRevisionId": 0,
217 "transferredToDisplayId": "string",
218 "transferredToRevisionId": 0
219 },
220 "numberRangeIdentifierType": {
221 "name": "string"
222 },
223 "numberRangeIdentifierValue": "string",
224 "numberRangeType": {
225 "name": "string"
226 }
227 },
228 "masterAgreementDto": {
229 "id": 0,
230 "displayId": "string",
231 "year": 1900,
232 "name": "string",
233 "description": "string",
234 "validFrom": "2019-08-24",
235 "validTo": "2019-08-24",
236 "targetValue": 0.1,
237 "legalJurisdiction": "string",
238 "approverComment": "string",
239 "signingPerson": "string",
240 "placeOfSignature": "string",
241 "dateOfSignature": "2019-08-24",
242 "state": "MLA_DEFINE",
243 "dataCreationInfo": {
244 "id": 0,
245 "idGenerationType": "AUTO",
246 "source": "string",
247 "type": "MIGRATION",
248 "startDateTime": "2019-08-24T14:15:22Z",
249 "endDateTime": "2019-08-24T14:15:22Z"
250 },
251 "agreementGroup": {
252 "id": 0,
253 "displayId": "string",
254 "status": "CREATED",
255 "name": "string"
256 },
257 "currency": {
258 "id": 0,
259 "displayId": "string",
260 "status": "CREATED",
261 "name": "string",
262 "decimalPoints": 0
263 },
264 "internalAssetClass": {
265 "id": 0,
266 "displayId": "string",
267 "status": "CREATED",
268 "name": "string",
269 "assetClassType": "PROPERTY",
270 "infiniteUsefulLife": true
271 },
272 "leaseArea": {
273 "id": 0,
274 "displayId": "string",
275 "status": "CREATED",
276 "name": "string"
277 },
278 "businessUnit": {
279 "id": 0,
280 "displayId": "string",
281 "status": "CREATED",
282 "name": "string"
283 },
284 "companyCode": {
285 "id": 0,
286 "displayId": "string",
287 "status": "CREATED",
288 "erpSystemId": 0,
289 "erpSystemDisplayId": "string",
290 "countryId": 0,
291 "countryDisplayId": "string",
292 "name": "string",
293 "postingPeriodVariantId": 0,
294 "fiscalVariantId": 0
295 },
296 "department": {
297 "id": 0,
298 "displayId": "string",
299 "status": "CREATED",
300 "name": "string"
301 },
302 "leaseGroup": {
303 "id": 0,
304 "displayId": "string",
305 "status": "CREATED",
306 "name": "string"
307 },
308 "allowsSystemGenerateNewId": true,
309 "numberRangeIdentifierType": {
310 "name": "string"
311 },
312 "numberRangeIdentifierValue": "string",
313 "numberRangeType": {
314 "name": "string"
315 }
316 },
317 "leaseComponentDto": {
318 "id": 0,
319 "displayId": "string",
320 "principalPositionType": "LESSEE",
321 "name": "string",
322 "description": "string",
323 "bulkAsset": true,
324 "rouStartDate": "2019-08-24",
325 "rouEndDate": "2019-08-24",
326 "approverComment": "string",
327 "fairMarketValue": 0.1,
328 "allocationNumber": "string",
329 "guaranteedResidualValue": 0.1,
330 "unitDistributions": [
331 {
332 "id": 0,
333 "leaseComponentId": 0,
334 "leaseComponentDisplayId": "string",
335 "activationGroupName": "string",
336 "activationGroupDisplayId": "string",
337 "numberOfUnits": 0,
338 "unitDisplayIds": [
339 "string"
340 ]
341 }
342 ],
343 "revision": {
344 "id": 0,
345 "displayId": "string",
346 "name": "string",
347 "inception": true,
348 "revisionType": "REVISION",
349 "state": "MLA_DEFINE",
350 "approvedBy": "string",
351 "approvedAt": "2019-08-24T14:15:22Z",
352 "parentRevisionId": 0,
353 "approverComment": "string",
354 "leaseComponentId": 0,
355 "leaseComponentDisplayId": "string",
356 "leaseComponentName": "string",
357 "contractRevisionId": 0,
358 "contractRevisionDisplayId": "string",
359 "numberRangeIdentifierType": {
360 "name": "string"
361 },
362 "numberRangeIdentifierValue": "string",
363 "allowsSystemGenerateNewId": true,
364 "numberRangeType": {
365 "name": "string"
366 }
367 },
368 "internalAssetClass": {
369 "id": 0,
370 "displayId": "string",
371 "status": "CREATED",
372 "name": "string",
373 "assetClassType": "PROPERTY",
374 "infiniteUsefulLife": true
375 },
376 "unitOfMeasure": {
377 "id": 0,
378 "displayId": "string",
379 "status": "CREATED",
380 "name": "string",
381 "erpSystemId": 0
382 },
383 "notifications": [
384 {
385 "id": 0,
386 "topic": {
387 "enCaption": "string",
388 "frCaption": "string",
389 "name": "string",
390 "priority": "HIGH"
391 },
392 "username": "string",
393 "leaseComponentId": 0,
394 "leaseComponentDisplayId": "string",
395 "targetType": "string",
396 "targetId": "string"
397 }
398 ],
399 "spreadingFrequency": "NONE",
400 "contractId": 0,
401 "contractDisplayId": "string",
402 "companyCodeId": 0,
403 "companyCodeDisplayId": "string",
404 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
405 "endOfTermDate": "2019-08-24",
406 "endOfTermPeriod": 0,
407 "allowsSystemGenerateNewId": true,
408 "transferInfo": {
409 "transferredFromDisplayId": "string",
410 "transferredFromRevisionId": 0,
411 "transferredToDisplayId": "string",
412 "transferredToRevisionId": 0
413 },
414 "numberRangeIdentifierType": {
415 "name": "string"
416 },
417 "numberRangeIdentifierValue": "string",
418 "numberRangeType": {
419 "name": "string"
420 },
421 "type": "string"
422 },
423 "activationGroupDto": {
424 "id": 0,
425 "displayId": "string",
426 "principalPositionType": "LESSEE",
427 "name": "string",
428 "description": "string",
429 "approverComment": "string",
430 "snapshotData": {
431 "isParallelCurrencyEnabled": true,
432 "isCostCenterAllocationEnabled": true,
433 "useSpotRateForGroupCurrency": true,
434 "usePostingOrDocumentDateForCurrency": true,
435 "exchangeRateTypes": [
436 {
437 "currencyDefinitionType": "CONTRACT_CURRENCY",
438 "sourceCurrencyType": "CONTRACT_CURRENCY",
439 "translationDateType": "DOCUMENT_DATE",
440 "targetCurrency": {
441 "id": 0,
442 "displayId": "string",
443 "decimalPoints": 0
444 },
445 "referenceCurrency": {
446 "id": 0,
447 "displayId": "string"
448 },
449 "currencyType": "string",
450 "exchangeRateType": "string"
451 }
452 ]
453 },
454 "revision": {
455 "id": 0,
456 "displayId": "string",
457 "name": "string",
458 "inception": true,
459 "revisionType": "REVISION",
460 "state": "MLA_DEFINE",
461 "approvedBy": "string",
462 "approvedAt": "2019-08-24T14:15:22Z",
463 "parentRevisionId": 0,
464 "approverComment": "string",
465 "rouStartDate": "2019-08-24",
466 "rouEndDate": "2019-08-24",
467 "activationGroupModification": {
468 "modificationDate": "2019-08-24",
469 "terminationType": "CASUALTY",
470 "terminationDate": {
471 "timing": "START_OF_DAY",
472 "year": 0,
473 "monthValue": 0,
474 "dayOfMonth": 0,
475 "leapYear": true,
476 "month": "JANUARY",
477 "dayOfWeek": "MONDAY",
478 "dayOfYear": 0
479 },
480 "useManualFmvValue": true,
481 "useManualAssetValues": true,
482 "enforceNonLeaseOnIndexation": true,
483 "applyIndexationLease": true,
484 "applyIndexationNonLease": true,
485 "indexationTreatmentType": "DEFAULT",
486 "indexationStartDate": "2019-08-24",
487 "indexationDateType": "ROU_ANNIVERSARY_DATE",
488 "indexationStartDateNonLease": "2019-08-24",
489 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
490 "modificationReasons": [
491 "CONTRACT_RATE_CHANGE"
492 ],
493 "modificationPerClassificationList": [
494 {
495 "accountingStandardId": 0,
496 "classificationType": "NON_LEASE",
497 "accountingStandardType": "GAAP",
498 "impairmentAmount": 0.1,
499 "recoverableAmount": 0.1,
500 "decreaseInAsset": 0.1,
501 "decreaseInTerm": 0.1
502 }
503 ],
504 "massIndexationTaskId": 0
505 },
506 "activationGroupId": 0,
507 "activationGroupDisplayId": "string",
508 "activationGroupName": "string",
509 "leaseComponentRevisionId": 0,
510 "leaseComponentRevisionDisplayId": "string",
511 "lastLeaseComponentRevisionId": 0,
512 "lastLeaseComponentRevisionDisplayId": "string",
513 "clonedFromRevisionId": 0,
514 "clonedFromRevisionDisplayId": "string",
515 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
516 "infiniteUsefulLife": true,
517 "transferOfOwnership": true,
518 "specializedAsset": true,
519 "fairMarketValue": 0.1,
520 "residualValue": 0,
521 "endOfTermIntention": "TO_BE_DETERMINED",
522 "endOfTermDate": "2019-08-24",
523 "endOfTermPeriod": 0,
524 "activationDocumentDate": "2019-08-24",
525 "activationPostingDate": "2019-08-24",
526 "closingDocumentDate": "2019-08-24",
527 "closingPostingDate": "2019-08-24",
528 "numberRangeIdentifierType": {
529 "name": "string"
530 },
531 "numberRangeIdentifierValue": "string",
532 "allowsSystemGenerateNewId": true,
533 "numberRangeType": {
534 "name": "string"
535 }
536 },
537 "leaseComponentId": 0,
538 "leaseComponentDisplayId": "string",
539 "companyCodeId": 0,
540 "companyCodeDisplayId": "string",
541 "splittedFromActivationGroupRevisionId": {
542 "id": 0,
543 "displayId": "string",
544 "name": "string",
545 "inception": true,
546 "revisionType": "REVISION",
547 "state": "MLA_DEFINE",
548 "approvedBy": "string",
549 "approvedAt": "2019-08-24T14:15:22Z",
550 "parentRevisionId": 0,
551 "approverComment": "string",
552 "rouStartDate": "2019-08-24",
553 "rouEndDate": "2019-08-24",
554 "activationGroupModification": {
555 "modificationDate": "2019-08-24",
556 "terminationType": "CASUALTY",
557 "terminationDate": {
558 "timing": "START_OF_DAY",
559 "year": 0,
560 "monthValue": 0,
561 "dayOfMonth": 0,
562 "leapYear": true,
563 "month": "JANUARY",
564 "dayOfWeek": "MONDAY",
565 "dayOfYear": 0
566 },
567 "useManualFmvValue": true,
568 "useManualAssetValues": true,
569 "enforceNonLeaseOnIndexation": true,
570 "applyIndexationLease": true,
571 "applyIndexationNonLease": true,
572 "indexationTreatmentType": "DEFAULT",
573 "indexationStartDate": "2019-08-24",
574 "indexationDateType": "ROU_ANNIVERSARY_DATE",
575 "indexationStartDateNonLease": "2019-08-24",
576 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
577 "modificationReasons": [
578 "CONTRACT_RATE_CHANGE"
579 ],
580 "modificationPerClassificationList": [
581 {
582 "accountingStandardId": 0,
583 "classificationType": "NON_LEASE",
584 "accountingStandardType": "GAAP",
585 "impairmentAmount": 0.1,
586 "recoverableAmount": 0.1,
587 "decreaseInAsset": 0.1,
588 "decreaseInTerm": 0.1
589 }
590 ],
591 "massIndexationTaskId": 0
592 },
593 "activationGroupId": 0,
594 "activationGroupDisplayId": "string",
595 "activationGroupName": "string",
596 "leaseComponentRevisionId": 0,
597 "leaseComponentRevisionDisplayId": "string",
598 "lastLeaseComponentRevisionId": 0,
599 "lastLeaseComponentRevisionDisplayId": "string",
600 "clonedFromRevisionId": 0,
601 "clonedFromRevisionDisplayId": "string",
602 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
603 "infiniteUsefulLife": true,
604 "transferOfOwnership": true,
605 "specializedAsset": true,
606 "fairMarketValue": 0.1,
607 "residualValue": 0,
608 "endOfTermIntention": "TO_BE_DETERMINED",
609 "endOfTermDate": "2019-08-24",
610 "endOfTermPeriod": 0,
611 "activationDocumentDate": "2019-08-24",
612 "activationPostingDate": "2019-08-24",
613 "closingDocumentDate": "2019-08-24",
614 "closingPostingDate": "2019-08-24",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeIdentifierValue": "string",
619 "allowsSystemGenerateNewId": true,
620 "numberRangeType": {
621 "name": "string"
622 }
623 },
624 "notifications": [
625 {
626 "id": 0,
627 "topic": {
628 "enCaption": "string",
629 "frCaption": "string",
630 "name": "string",
631 "priority": "HIGH"
632 },
633 "username": "string",
634 "activationGroupId": 0,
635 "activationGroupDisplayId": "string",
636 "targetType": "string",
637 "targetId": "string"
638 }
639 ],
640 "transferInfo": {
641 "transferredFromDisplayId": "string",
642 "transferredFromRevisionId": 0,
643 "transferredToDisplayId": "string",
644 "transferredToRevisionId": 0
645 },
646 "numberRangeIdentifierType": {
647 "name": "string"
648 },
649 "numberRangeIdentifierValue": "string",
650 "numberRangeType": {
651 "name": "string"
652 },
653 "allowsSystemGenerateNewId": true
654 }
655 }
656]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[NfsLinkDto is a data transfer object that encapsulates the relationships and attributes of assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights related to real estate properties in the portfolio.] |
|
» 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 |
» masterAgreementId |
integer(int64) |
false |
none |
Unique identifier for the master agreement |
» contractId |
integer(int64) |
false |
none |
Unique identifier for the contract |
» leaseComponentId |
integer(int64) |
false |
none |
Unique identifier for the lease component |
» contractRevisionId |
integer(int64) |
false |
none |
Unique identifier for the contract revision |
» leaseComponentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the lease component revision |
» activationGroupRevisionId |
integer(int64) |
false |
none |
Unique identifier for the activation group revision |
» contractDto |
false |
none |
Data transfer object representing a contract within the Nakisa Portfolio Management Suite, encapsulating essential details related to portfolio management, asset tracking, and real estate property analytics. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
true |
none |
Name of the resource |
»» principalPositionType |
string |
true |
none |
Type of the principal position |
»» validFrom |
string(date) |
false |
none |
Date from which the resource is valid |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» amendmentDate |
string(date) |
false |
none |
Date of the amendment |
»» approverComment |
string |
false |
none |
Comment provided by the approver regarding the contract, facilitating transparency and communication within the portfolio management process. |
»» contractPhase |
string |
false |
none |
Indicates the current phase of the contract within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate property analytics. |
»» dataCreationInfo |
false |
none |
DataCreationSettingLite is a streamlined data transfer object that encapsulates essential settings for creating and managing portfolio and asset data within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties. |
|
»»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»»» idGenerationType |
string |
true |
none |
Type of the id generation |
»»» source |
string |
false |
none |
Indicates the origin of the data entry within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management. |
»»» type |
string |
true |
none |
Type of the resource |
»»» startDateTime |
string(date-time) |
true |
none |
Time of the start date |
»»» endDateTime |
string(date-time) |
false |
none |
Time of the end date |
»» leaseType |
string |
false |
none |
Type of the lease |
»» revision |
false |
none |
Data transfer object representing a revision of a contract within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio and asset management in the context of real estate property analytics. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
true |
none |
Name of the resource |
»»» inception |
boolean |
false |
none |
Boolean flag indicating inception status |
»»» revisionType |
string |
false |
none |
Type of the revision |
»»» state |
string |
false |
none |
Current state of the portfolio |
»»» approvedBy |
string |
false |
none |
Identifier of the individual or entity that has approved the contract revision, ensuring compliance and accountability within the portfolio management process. |
»»» approvedAt |
string(date-time) |
false |
none |
Timestamp indicating when the contract revision was approved, relevant for portfolio and asset management analytics within the Nakisa Portfolio Management Suite. |
»»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»»» approverComment |
string |
false |
none |
Comment provided by the approver to offer feedback or rationale regarding the contract revision within the Nakisa Portfolio Management Suite. |
»»» contractId |
integer(int64) |
false |
none |
Unique identifier for the contract |
»»» contractDisplayId |
string |
false |
none |
Unique identifier for the contract display |
»»» contractName |
string |
false |
none |
Name of the contract |
»»» principalPositionType |
string |
false |
none |
Type of the principal position |
»»» mlaId |
integer(int64) |
false |
none |
Unique identifier for the mla |
»»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»»» description |
string |
false |
none |
Description of the resource |
»»» externalReference |
string |
false |
none |
String representing an external reference associated with the contract revision, facilitating integration and tracking within the Nakisa Portfolio Management Suite for portfolio, asset, and real estate property analytics. |
»»» internalReference |
string |
false |
none |
Unique identifier for the internal reference associated with a contract revision, facilitating streamlined management and analytics of portfolio assets within the Nakisa Portfolio Management Suite. |
»»» formOfLease |
string |
false |
none |
Indicates the type of lease agreement associated with the real estate property within the portfolio, facilitating asset management and analytics in the Nakisa Portfolio Management Suite. |
»»» jointVentureLeaseType |
string |
false |
none |
Type of the joint venture lease |
»»» businessPlace |
string |
false |
none |
Represents the designated location of the business entity within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate analytics. |
»»» tradingPartner |
false |
none |
Data transfer object representing a trading partner within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio, asset, and analytics for real estate property management. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» status |
string |
false |
none |
Status of the resource |
»»»» name |
string |
false |
none |
Name of the resource |
»»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» contractCategoryGroup |
false |
none |
Data transfer object representing a grouping of contract categories within the Nakisa Portfolio Management Suite, facilitating streamlined portfolio and asset analytics for real estate properties. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» status |
string |
false |
none |
Status of the resource |
»»»» name |
string |
false |
none |
Name of the resource |
»»» contractGroup1 |
false |
none |
Data transfer object representing a simplified grouping of contracts within the Nakisa Portfolio Management Suite, facilitating streamlined analytics and management of real estate assets in the portfolio. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» status |
string |
false |
none |
Status of the resource |
»»»» name |
string |
false |
none |
Name of the resource |
»»» contractGroup2 |
false |
none |
Data transfer object representing a collection of contracts within the Nakisa Portfolio Management Suite, designed to facilitate portfolio analysis and asset management for real estate properties. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» status |
string |
false |
none |
Status of the resource |
»»»» name |
string |
false |
none |
Name of the resource |
»»» group3 |
string |
false |
none |
Represents a categorization or classification within the portfolio management framework, facilitating enhanced analytics and reporting for real estate assets. |
»»» group4 |
string |
false |
none |
Represents a categorization label for a specific group within the portfolio, asset, or analytics domains in the Nakisa Portfolio Management Suite. |
»»» signingPerson |
string |
false |
none |
Represents the name of the individual authorized to sign the contract, essential for validating agreements within the Nakisa Portfolio Management Suite’s real estate property and asset management processes. |
»»» placeOfSignature |
string |
false |
none |
Indicates the location where the contract revision is signed, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»»» dateOfSignature |
string(date) |
false |
none |
Date of signature indicating when the contract revision was formally executed, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»»» leaseType |
string |
false |
none |
none |
»»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»»»» name |
string |
false |
none |
Name of the resource |
»»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite. |
»»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
»»»» name |
string |
true |
none |
Name of the resource |
»» currency |
false |
none |
Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
false |
none |
Numeric value representing decimalPoints |
»» companyCurrency |
false |
none |
Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios. |
|
»» indexedCurrency |
boolean |
false |
none |
Boolean flag indicating indexedCurrency status |
»» assetValueCurrencyType |
string |
false |
none |
Type of the asset value currency |
»» currencyLocked |
boolean |
false |
none |
Boolean flag indicating currencyLocked status |
»» leaseArea |
true |
none |
Data transfer object representing a simplified view of lease areas within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»» businessUnit |
true |
none |
Data transfer object representing a simplified view of a business unit within the Nakisa Portfolio Management Suite, encompassing key attributes relevant to portfolio management, asset tracking, analytics, and real estate properties. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»» businessUnitLocked |
boolean |
false |
none |
Boolean flag indicating businessUnitLocked status |
»» companyCode |
true |
none |
Data transfer object representing a streamlined view of a company within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets, analytics, and real estate properties. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» countryId |
integer(int64) |
false |
none |
Unique identifier for the country |
»»» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
»»» name |
string |
false |
none |
none |
»»» postingPeriodVariantId |
integer(int64) |
false |
none |
Unique identifier for the posting period variant |
»»» fiscalVariantId |
integer(int64) |
false |
none |
Unique identifier for the fiscal variant |
»» companyCodeLocked |
boolean |
false |
none |
Boolean flag indicating companyCodeLocked status |
»» department |
false |
none |
Data transfer object representing a department within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio and asset analytics in the context of real estate property management. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»» departmentLocked |
boolean |
false |
none |
Boolean flag indicating departmentLocked status |
»» leaseGroup |
false |
none |
Data transfer object representing a collection of lease agreements within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»» leaseGroupLocked |
boolean |
false |
none |
Boolean flag indicating leaseGroupLocked status |
»» subleasingInternalAssetClass |
false |
none |
Data transfer object representing a simplified classification of assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management of real estate properties. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» assetClassType |
string |
false |
none |
Type of the asset class |
»»» infiniteUsefulLife |
boolean |
false |
none |
Boolean flag indicating infiniteUsefulLife status |
»» contractGroup1 |
false |
none |
Data transfer object representing a simplified grouping of contracts within the Nakisa Portfolio Management Suite, facilitating streamlined analytics and management of real estate assets in the portfolio. |
|
»» contractGroup2 |
false |
none |
Data transfer object representing a collection of contracts within the Nakisa Portfolio Management Suite, designed to facilitate portfolio analysis and asset management for real estate properties. |
|
»» subleasing |
boolean |
false |
none |
Boolean flag indicating subleasing status |
»» subleasingContractRevisionInfo |
false |
none |
Data transfer object representing a simplified version of a subleasing contract revision, capturing essential details for portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making in real estate property management. |
|
»»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»»» contractId |
integer(int64) |
true |
none |
Unique identifier for the contract |
»»» contractDisplayId |
string |
true |
none |
Unique identifier for the contract display |
»»» contractName |
string |
true |
none |
Name of the contract |
»» subleasingLeaseComponentRevisionInfo |
false |
none |
Data transfer object representing a revision of a subleasing lease component within the Nakisa Portfolio Management Suite, facilitating the management and analysis of real estate assets in the context of portfolio optimization. |
|
»»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»»» leaseComponentId |
integer(int64) |
true |
none |
Unique identifier for the lease component |
»»» leaseComponentDisplayId |
string |
true |
none |
Unique identifier for the lease component display |
»»» leaseComponentName |
string |
true |
none |
Name of the lease component |
»» subleasingActivationGroupRevisionInfo |
false |
none |
Data transfer object representing a revision of a subleasing activation group within the Nakisa Portfolio Management Suite, providing essential insights for portfolio and asset management in the real estate sector. |
|
»»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»»» activationGroupId |
integer(int64) |
true |
none |
Unique identifier for the activation group |
»»» activationGroupDisplayId |
string |
true |
none |
Unique identifier for the activation group display |
»»» activationGroupName |
string |
true |
none |
Name of the activation group |
»» notifications |
false |
none |
List of notifications items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» topic |
false |
none |
Data transfer object representing a notification topic type within the Nakisa Portfolio Management Suite, facilitating communication and updates related to portfolio, asset, analytics, and real estate property management. |
|
»»»» enCaption |
string |
false |
none |
Textual representation of the English caption associated with a notification topic, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»»» frCaption |
string |
false |
none |
Descriptive label for the notification topic, facilitating clear communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»»»» name |
string |
false |
none |
Name of the resource |
»»»» priority |
string |
false |
none |
Priority of the resource |
»»» username |
string |
false |
none |
Human-readable name of the portfolio |
»»» contractId |
integer(int64) |
false |
none |
Unique identifier for the contract |
»»» contractDisplayId |
string |
false |
none |
Unique identifier for the contract display |
»»» targetType |
string |
false |
none |
Type of the target |
»»» targetId |
string |
false |
none |
Unique identifier for the target |
»» masterAgreementId |
integer(int64) |
true |
none |
Unique identifier for the master agreement |
»» masterAgreementDisplayId |
string |
false |
none |
Unique identifier for the master agreement display |
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»» transferInfo |
false |
none |
Data transfer object representing the details of mass inter-company asset transfers within the Nakisa Portfolio Management Suite, facilitating portfolio management and analytics for real estate properties. |
|
»»» transferredFromDisplayId |
string |
false |
none |
Unique identifier for the transferred from display |
»»» transferredFromRevisionId |
integer(int64) |
false |
none |
Unique identifier for the transferred from revision |
»»» transferredToDisplayId |
string |
false |
none |
Unique identifier for the transferred to display |
»»» transferredToRevisionId |
integer(int64) |
false |
none |
Unique identifier for the transferred to revision |
»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite. |
»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
» masterAgreementDto |
false |
none |
Data transfer object representing a comprehensive master agreement within the Nakisa Portfolio Management Suite, encapsulating critical details related to portfolio assets and analytics for real estate properties. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» year |
integer(int32) |
true |
none |
Numeric value representing year |
»» name |
string |
true |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» validFrom |
string(date) |
false |
none |
Date from which the resource is valid |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» targetValue |
number(double) |
false |
none |
Value for targetValue field |
»» legalJurisdiction |
string |
false |
none |
Specifies the legal jurisdiction applicable to the assets within the portfolio, ensuring compliance with relevant regulations in the context of real estate property management and analytics. |
»» approverComment |
string |
false |
none |
Comments provided by the approver regarding the Master Agreement, facilitating clarity and communication within the context of portfolio and asset management in the Nakisa Portfolio Management Suite. |
»» signingPerson |
string |
false |
none |
Represents the name of the individual authorized to sign the master agreement, essential for validating contractual commitments within the Nakisa Portfolio Management Suite. |
»» placeOfSignature |
string |
false |
none |
Indicates the location where the signature for the master agreement is obtained, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»» dateOfSignature |
string(date) |
false |
none |
Represents the date on which the master agreement was signed, providing critical context for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»» state |
string |
false |
none |
Current state of the portfolio |
»» dataCreationInfo |
false |
none |
DataCreationSettingLite is a streamlined data transfer object that encapsulates essential settings for creating and managing portfolio and asset data within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties. |
|
»» agreementGroup |
false |
none |
Data transfer object representing a collection of agreements related to portfolio management, enabling streamlined analytics and insights for real estate assets within the Nakisa Portfolio Management Suite. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»» currency |
false |
none |
Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios. |
|
»» internalAssetClass |
false |
none |
Data transfer object representing a simplified classification of assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management of real estate properties. |
|
»» leaseArea |
false |
none |
Data transfer object representing a simplified view of lease areas within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»» businessUnit |
false |
none |
Data transfer object representing a simplified view of a business unit within the Nakisa Portfolio Management Suite, encompassing key attributes relevant to portfolio management, asset tracking, analytics, and real estate properties. |
|
»» companyCode |
false |
none |
Data transfer object representing a streamlined view of a company within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets, analytics, and real estate properties. |
|
»» department |
false |
none |
Data transfer object representing a department within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio and asset analytics in the context of real estate property management. |
|
»» leaseGroup |
false |
none |
Data transfer object representing a collection of lease agreements within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a specific range of numbers associated with assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
» leaseComponentDto |
any |
false |
none |
Value for leaseComponentDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing a lease component within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio and asset management in the context of real estate property analytics. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» principalPositionType |
string |
true |
none |
Type of the principal position |
»»» name |
string |
true |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» bulkAsset |
boolean |
false |
none |
Boolean flag indicating bulkAsset status |
»»» rouStartDate |
string(date) |
false |
none |
Date of the rou start |
»»» rouEndDate |
string(date) |
false |
none |
Date of the rou end |
»»» approverComment |
string |
false |
none |
Comment provided by the approver regarding the lease component, facilitating enhanced communication and decision-making within the portfolio management process. |
»»» fairMarketValue |
number(double) |
false |
none |
Value for fairMarketValue field |
»»» allocationNumber |
string |
false |
none |
Unique identifier for the allocation associated with a lease component, facilitating effective management and analytics within the Nakisa Portfolio Management Suite. |
»»» guaranteedResidualValue |
number(double) |
false |
none |
Value for guaranteedResidualValue field |
»»» unitDistributions |
false |
none |
List of unitDistributions items |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» leaseComponentId |
integer(int64) |
false |
none |
Unique identifier for the lease component |
»»»» leaseComponentDisplayId |
string |
false |
none |
Unique identifier for the lease component display |
»»»» activationGroupName |
string |
false |
none |
Name of the activation group |
»»»» activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
»»»» numberOfUnits |
integer(int64) |
false |
none |
Numeric value representing numberOfUnits |
»»»» unitDisplayIds |
[string] |
false |
none |
List of unitDisplayIds items |
»»» revision |
false |
none |
Data transfer object representing a revision of lease components within the Nakisa Portfolio Management Suite, facilitating the management and analysis of real estate property assets in the context of portfolio optimization. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» name |
string |
true |
none |
Name of the resource |
»»»» inception |
boolean |
false |
none |
Boolean flag indicating inception status |
»»»» revisionType |
string |
false |
none |
Type of the revision |
»»»» state |
string |
false |
none |
Current state of the portfolio |
»»»» approvedBy |
string |
false |
none |
Identifier of the individual or entity that has approved the lease component revision, essential for maintaining compliance and accountability within the portfolio management process. |
»»»» approvedAt |
string(date-time) |
false |
none |
Timestamp indicating when the lease component revision was approved, relevant for portfolio and asset management analytics within the Nakisa Portfolio Management Suite. |
»»»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»»»» approverComment |
string |
false |
none |
Comment provided by the approver to offer insights or feedback regarding the lease component revision within the Nakisa Portfolio Management Suite. |
»»»» leaseComponentId |
integer(int64) |
false |
none |
Unique identifier for the lease component |
»»»» leaseComponentDisplayId |
string |
false |
none |
Unique identifier for the lease component display |
»»»» leaseComponentName |
string |
false |
none |
Name of the lease component |
»»»» contractRevisionId |
integer(int64) |
false |
none |
Unique identifier for the contract revision |
»»»» contractRevisionDisplayId |
string |
false |
none |
Unique identifier for the contract revision display |
»»»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»»»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a range of numbers associated with lease components, facilitating accurate asset tracking and analytics within the Nakisa Portfolio Management Suite. |
»»»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»»»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
»»» internalAssetClass |
false |
none |
Data transfer object representing a simplified classification of assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management of real estate properties. |
|
»»» unitOfMeasure |
false |
none |
Data transfer object representing a unit of measure within the Nakisa Portfolio Management Suite, utilized for quantifying and analyzing assets in the context of portfolio management and real estate properties. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» status |
string |
false |
none |
Status of the resource |
»»»» name |
string |
false |
none |
Name of the resource |
»»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» notifications |
false |
none |
List of notifications items |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» topic |
false |
none |
Data transfer object representing a notification topic type within the Nakisa Portfolio Management Suite, facilitating communication and updates related to portfolio, asset, analytics, and real estate property management. |
|
»»»» username |
string |
false |
none |
Human-readable name of the portfolio |
»»»» leaseComponentId |
integer(int64) |
false |
none |
Unique identifier for the lease component |
»»»» leaseComponentDisplayId |
string |
false |
none |
Unique identifier for the lease component display |
»»»» targetType |
string |
false |
none |
Type of the target |
»»»» targetId |
string |
false |
none |
Unique identifier for the target |
»»» spreadingFrequency |
string |
false |
none |
Specifies the frequency at which lease payments are spread over the term of the lease, providing essential insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»» contractId |
integer(int64) |
true |
none |
Unique identifier for the contract |
»»» contractDisplayId |
string |
false |
none |
Unique identifier for the contract display |
»»» companyCodeId |
integer(int64) |
false |
none |
Unique identifier for the company code |
»»» companyCodeDisplayId |
string |
false |
none |
Unique identifier for the company code display |
»»» userDeterminedLeaseType |
string |
false |
none |
Type of the user determined lease |
»»» endOfTermDate |
string(date) |
false |
none |
Date of the end of term |
»»» endOfTermPeriod |
integer(int32) |
false |
none |
Numeric value representing endOfTermPeriod |
»»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»»» transferInfo |
false |
none |
Data transfer object representing the details of mass inter-company asset transfers within the Nakisa Portfolio Management Suite, facilitating portfolio management and analytics for real estate properties. |
|
»»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string value that identifies a specific range of numbers associated with lease components within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
»»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
»»» type |
string |
false |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the details of a lessee’s lease component within the Nakisa Portfolio Management Suite, facilitating insights into portfolio management, asset utilization, and real estate analytics. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a lease component within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio and asset management in the context of real estate property analytics. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» residualValue |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
LessorLeaseComponentDto is a data transfer object that encapsulates essential details of lease agreements within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management for real estate properties and supporting analytical insights. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing a lease component within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio and asset management in the context of real estate property analytics. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» unguaranteedResidualValue |
number(double) |
false |
none |
none |
»»»» grossBookValue |
number(double) |
false |
none |
none |
»»»» totalResidualValue |
number(double) |
false |
none |
none |
»»»» subleasing |
boolean |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» activationGroupDto |
false |
none |
Data transfer object representing an activation group within the Nakisa Portfolio Management Suite, encapsulating relevant details for managing portfolio assets and analytics related to real estate properties. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» principalPositionType |
string |
false |
none |
Type of the principal position |
»» name |
string |
true |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» approverComment |
string |
false |
none |
Comment provided by the approver to offer insights or feedback regarding the activation group within the Nakisa Portfolio Management Suite. |
»» snapshotData |
false |
none |
Data transfer object representing a snapshot of activation group metrics within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset utilization, and real estate property analytics. |
|
»»» isParallelCurrencyEnabled |
boolean |
false |
none |
Whether the resource is parallel currency enabled |
»»» isCostCenterAllocationEnabled |
boolean |
false |
none |
Whether the resource is cost center allocation enabled |
»»» useSpotRateForGroupCurrency |
boolean |
false |
none |
Boolean flag indicating useSpotRateForGroupCurrency status |
»»» usePostingOrDocumentDateForCurrency |
boolean |
false |
none |
none |
»»» exchangeRateTypes |
false |
none |
List of exchangeRateTypes items |
|
»»»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»»»» sourceCurrencyType |
string |
false |
none |
Type of the source currency |
»»»» translationDateType |
string |
false |
none |
Type of the translation date |
»»»» targetCurrency |
false |
none |
Data transfer object representing the unique identifier for currency within the Nakisa Portfolio Management Suite, facilitating accurate financial analytics and reporting across portfolio assets and real estate properties. |
|
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»»» decimalPoints |
integer(int32) |
true |
none |
Numeric value representing decimalPoints |
»»»» referenceCurrency |
false |
none |
Data transfer object representing a unique identifier for assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio analytics and management of real estate properties. |
|
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» currencyType |
string |
false |
none |
Type of the currency |
»»»» exchangeRateType |
string |
false |
none |
Type of the exchange rate |
»» revision |
false |
none |
Data transfer object representing a revision of an activation group within the Nakisa Portfolio Management Suite, encompassing critical information related to portfolio, asset management, analytics, and real estate property. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
true |
none |
Name of the resource |
»»» inception |
boolean |
false |
none |
Boolean flag indicating inception status |
»»» revisionType |
string |
false |
none |
Type of the revision |
»»» state |
string |
false |
none |
Current state of the portfolio |
»»» approvedBy |
string |
false |
none |
Identifier of the user or entity that approved the activation group revision, ensuring accountability in portfolio and asset management within the Nakisa Portfolio Management Suite. |
»»» approvedAt |
string(date-time) |
false |
none |
Timestamp indicating when the activation group revision was approved, relevant for tracking changes in portfolio and asset management within the Nakisa Portfolio Management Suite. |
»»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»»» approverComment |
string |
false |
none |
Comment provided by the approver regarding the activation group revision, facilitating transparency and accountability in portfolio and asset management decisions. |
»»» rouStartDate |
string(date) |
true |
none |
Date of the rou start |
»»» rouEndDate |
string(date) |
true |
none |
Date of the rou end |
»»» activationGroupModification |
false |
none |
Data transfer object representing modifications to an activation group within the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing analytics for real estate property performance. |
|
»»»» modificationDate |
string(date) |
false |
none |
Date of the modification |
»»»» terminationType |
string |
false |
none |
Type of the termination |
»»»» terminationDate |
false |
none |
Data transfer object representing the specific time of day relevant to portfolio and asset management activities within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate properties. |
|
»»»»» timing |
string |
false |
none |
Represents the specific time of day associated with portfolio analytics and asset management activities within the Nakisa Portfolio Management Suite. |
»»»»» year |
integer(int32) |
false |
none |
Numeric value representing year |
»»»»» monthValue |
integer(int32) |
false |
none |
Numeric value representing monthValue |
»»»»» dayOfMonth |
integer(int32) |
false |
none |
Numeric value representing dayOfMonth |
»»»»» leapYear |
boolean |
false |
none |
Boolean flag indicating leapYear status |
»»»»» month |
string |
false |
none |
Represents the month associated with portfolio analytics and asset performance evaluation within the Nakisa Portfolio Management Suite. |
»»»»» dayOfWeek |
string |
false |
none |
Represents the day of the week relevant to portfolio analytics and asset management within the Nakisa Portfolio Management Suite. |
»»»»» dayOfYear |
integer(int32) |
false |
none |
Numeric value representing dayOfYear |
»»»» useManualFmvValue |
boolean |
false |
none |
Boolean flag indicating useManualFmvValue status |
»»»» useManualAssetValues |
boolean |
false |
none |
Boolean flag indicating useManualAssetValues status |
»»»» enforceNonLeaseOnIndexation |
boolean |
false |
none |
Boolean flag indicating enforceNonLeaseOnIndexation status |
»»»» applyIndexationLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationLease status |
»»»» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
»»»» indexationTreatmentType |
string |
false |
none |
Type of the indexation treatment |
»»»» indexationStartDate |
string(date) |
false |
none |
Date of the indexation start |
»»»» indexationDateType |
string |
false |
none |
Type of the indexation date |
»»»» indexationStartDateNonLease |
string(date) |
false |
none |
Specifies the start date for the indexation process of non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»»»» indexationDateTypeNonLease |
string |
false |
none |
Specifies the type of indexation date applicable to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
»»»» modificationReasons |
[string] |
false |
none |
List of modificationReasons items |
»»»» modificationPerClassificationList |
false |
none |
List of modificationPerClassificationList items |
|
»»»»» accountingStandardId |
integer(int64) |
false |
none |
Unique identifier for the accounting standard |
»»»»» classificationType |
string |
false |
none |
Type of the classification |
»»»»» accountingStandardType |
string |
false |
none |
Type of the accounting standard |
»»»»» impairmentAmount |
number(double) |
false |
none |
Amount of impairment |
»»»»» recoverableAmount |
number(double) |
false |
none |
Amount of recoverable |
»»»»» decreaseInAsset |
number(double) |
false |
none |
Value for decreaseInAsset field |
»»»»» decreaseInTerm |
number(double) |
false |
none |
Value for decreaseInTerm field |
»»»» massIndexationTaskId |
integer(int64) |
false |
none |
Unique identifier for the mass indexation task |
»»» activationGroupId |
integer(int64) |
false |
none |
Unique identifier for the activation group |
»»» activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
»»» activationGroupName |
string |
false |
none |
Name of the activation group |
»»» leaseComponentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the lease component revision |
»»» leaseComponentRevisionDisplayId |
string |
false |
none |
Unique identifier for the lease component revision display |
»»» lastLeaseComponentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the last lease component revision |
»»» lastLeaseComponentRevisionDisplayId |
string |
false |
none |
Unique identifier for the last lease component revision display |
»»» clonedFromRevisionId |
integer(int64) |
false |
none |
Unique identifier for the cloned from revision |
»»» clonedFromRevisionDisplayId |
string |
false |
none |
Unique identifier for the cloned from revision display |
»»» lockReason |
string |
false |
none |
Specifies the reason for locking an activation group revision within the Nakisa Portfolio Management Suite, ensuring clarity in portfolio and asset management activities. |
»»» infiniteUsefulLife |
boolean |
false |
none |
Boolean flag indicating infiniteUsefulLife status |
»»» transferOfOwnership |
boolean |
false |
none |
Boolean flag indicating transferOfOwnership status |
»»» specializedAsset |
boolean |
false |
none |
Boolean flag indicating specializedAsset status |
»»» fairMarketValue |
number(double) |
false |
none |
Value for fairMarketValue field |
»»» residualValue |
number |
false |
none |
Value for residualValue field |
»»» endOfTermIntention |
string |
false |
none |
Indicates the intended action regarding the asset’s status at the end of its term within the Nakisa Portfolio Management Suite, relevant for portfolio analysis and real estate property management. |
»»» endOfTermDate |
string(date) |
false |
none |
Date of the end of term |
»»» endOfTermPeriod |
integer(int32) |
false |
none |
Numeric value representing endOfTermPeriod |
»»» activationDocumentDate |
string(date) |
false |
none |
Date of the activation document |
»»» activationPostingDate |
string(date) |
false |
none |
Date of the activation posting |
»»» closingDocumentDate |
string(date) |
false |
none |
Date of the closing document |
»»» closingPostingDate |
string(date) |
false |
none |
Date of the closing posting |
»»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a specific range of numbers associated with assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and real estate property analytics. |
»»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
»» leaseComponentId |
integer(int64) |
false |
none |
Unique identifier for the lease component |
»» leaseComponentDisplayId |
string |
false |
none |
Unique identifier for the lease component display |
»» companyCodeId |
integer(int64) |
false |
none |
Unique identifier for the company code |
»» companyCodeDisplayId |
string |
false |
none |
Unique identifier for the company code display |
»» splittedFromActivationGroupRevisionId |
false |
none |
Data transfer object representing a revision of an activation group within the Nakisa Portfolio Management Suite, encompassing critical information related to portfolio, asset management, analytics, and real estate property. |
|
»» notifications |
false |
none |
List of notifications items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» topic |
false |
none |
Data transfer object representing a notification topic type within the Nakisa Portfolio Management Suite, facilitating communication and updates related to portfolio, asset, analytics, and real estate property management. |
|
»»» username |
string |
false |
none |
Human-readable name of the portfolio |
»»» activationGroupId |
integer(int64) |
false |
none |
Unique identifier for the activation group |
»»» activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
»»» targetType |
string |
false |
none |
Type of the target |
»»» targetId |
string |
false |
none |
Unique identifier for the target |
»» transferInfo |
false |
none |
Data transfer object representing the details of mass inter-company asset transfers within the Nakisa Portfolio Management Suite, facilitating portfolio management and analytics for real estate properties. |
|
»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»» numberRangeIdentifierValue |
string |
false |
none |
String value representing the unique identifier for a specific number range within the Nakisa Portfolio Management Suite, essential for managing portfolios, assets, and analytics related to real estate properties. |
»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
Enumerated Values
Attribute |
Value |
|---|---|
accountingStandardType |
GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET |
assetClassType |
EQUIPMENT, PLANT, PROPERTY |
assetValueCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY |
classificationType |
DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM |
contractPhase |
CLOSED, DRAFT, INITIAL, REJECTED, SETUP |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
dayOfWeek |
FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY |
endOfTermIntention |
NATURAL_LEASE_END, NOT_APPLICABLE, PURCHASE, RETURN, TO_BE_DETERMINED |
formOfLease |
FULL, NET |
idGenerationType |
AUTO, MANUAL |
indexationDateType |
JOB_DATE, MODIFICATION_DATE, NEXT_AVAILABLE_PAYMENT_DATE, ROU_ANNIVERSARY_DATE, USER_DEFINED |
indexationDateTypeNonLease |
JOB_DATE, MODIFICATION_DATE, NEXT_AVAILABLE_PAYMENT_DATE, ROU_ANNIVERSARY_DATE, USER_DEFINED |
indexationTreatmentType |
DEFAULT, ENFORCE_LEASE, ENFORCE_NON_LEASE, STANDARD |
jointVentureLeaseType |
GROSS_LEASE, NET_LEASE |
leaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
lockReason |
CLOSED_CLOSING_RECLOSE_REJECTED, PENDING_TERMINATION |
month |
APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER |
principalPositionType |
LESSEE, LESSOR |
priority |
HIGH, LOW, MEDIUM |
revisionType |
ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION |
sourceCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A |
spreadingFrequency |
NONE, PERIODIC, STRAIGHT_LINE |
state |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
terminationType |
CASUALTY, EARLY_TERMINATION, INTERCOMPANY_TRANSFER, PURCHASING_OPTION |
timing |
END_OF_DAY, START_OF_DAY |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
type |
MIGRATION, TESTING |
userDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
Lease - Get Lease Financial Summary¶
HTTP Request
GET /api/leases/{id}/financial-summary
📋 Description: Retrieves the financial summary for a specific lease identified by its ID, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
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 |
Lease - Get Lease Expense Type Categories¶
HTTP Request
GET /api/leases/{id}/expense-types
📋 Description: Fetches the expense types associated with a specific lease, enabling users to analyze financial obligations within their real estate portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "editable": true,
8 "expenseCategoryType": "PAYMENT"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an expense category within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of financial data related to 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 |
» name |
string |
true |
none |
Name of the resource |
» editable |
boolean |
true |
none |
Boolean flag indicating editable status |
» expenseCategoryType |
string |
true |
none |
Type of the expense category |
Enumerated Values
Attribute |
Value |
|---|---|
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Lease - Get Lease Charge Post For Main Accounting Standard¶
HTTP Request
GET /api/leases/{id}/charge-post/main-accounting-standard
📋 Description: Fetches the main accounting standard charge post for a specified lease, enabling users to analyze financial implications within the context of portfolio and asset management in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
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 "numberRangeIdentifierType": {
303 "name": "string"
304 },
305 "numberRangeIdentifierValue": "string",
306 "allowsSystemGenerateNewId": true,
307 "numberRangeType": {
308 "name": "string"
309 }
310 }
311 ],
312 "number": 0,
313 "sort": {
314 "sorted": true,
315 "unsorted": true,
316 "empty": true
317 },
318 "first": true,
319 "last": true,
320 "empty": true
321}
Lease - Get Recurring Payment Vendor Splits For Lease And Payment¶
HTTP Request
GET /api/leases/{id}/activation-group-revisions/{activationGroupRevisionId}/recurring-payments/{paymentId}/vendor-splits
📋 Description: Retrieves vendor split details for a specific recurring payment associated with a lease activation group revision, facilitating the management of financial allocations within the Nakisa Portfolio Management Suite. This operation supports effective portfolio and asset analytics in the context of real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
activationGroupRevisionId |
path |
integer(int64) |
true |
Unique identifier for the activation group revision |
paymentId |
path |
integer(int64) |
true |
Unique identifier for the payment |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "vendorSplits": [
4 {
5 "id": 0,
6 "vendorId": 0,
7 "vendorName": "string",
8 "expenseAccount": "string",
9 "percentage": 0.1,
10 "amount": 0,
11 "taxableAmount": 0.1,
12 "taxJurisdiction": "string",
13 "taxCode": "string",
14 "taxRate": 0.1,
15 "taxAmount": 0.1,
16 "vendorDisplayId": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Lease - Get Charge Vendor Splits For Lease And Charge¶
HTTP Request
GET /api/leases/{id}/activation-group-revisions/{activationGroupRevisionId}/charges/{chargeId}/vendor-splits
📋 Description: Retrieves vendor split details for a specific charge within an activation group revision of a lease, enabling enhanced financial analysis 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 |
activationGroupRevisionId |
path |
integer(int64) |
true |
Unique identifier for the activation group revision |
chargeId |
path |
integer(int64) |
true |
Unique identifier for the charge |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "vendorSplits": [
4 {
5 "id": 0,
6 "vendorId": 0,
7 "vendorName": "string",
8 "expenseAccount": "string",
9 "percentage": 0.1,
10 "amount": 0,
11 "taxableAmount": 0.1,
12 "taxJurisdiction": "string",
13 "taxCode": "string",
14 "taxRate": 0.1,
15 "taxAmount": 0.1,
16 "vendorDisplayId": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Lease - Get Default Lease¶
HTTP Request
GET /api/leases/default/{userId}
📋 Description: Retrieves the default lease information associated with a specified user, providing 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 "typeId": 0,
10 "terminatingLease": "2019-08-24",
11 "maximumDateTo": "2019-08-24",
12 "number": "string",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "categoryId": 0,
16 "registrationNumber": "string",
17 "statusId": 0,
18 "stateId": 0,
19 "calculateTax": true,
20 "autoMonthToMonth": true,
21 "originalLeaseId": 0,
22 "scenario": true,
23 "parentLeaseId": 0,
24 "areasHistoryVersionId": 0,
25 "provisioningFrequencyName": "string",
26 "accountingApproved": true,
27 "indexationType": "string",
28 "cpiGlobalCategoryId": 0,
29 "indexationReferenceDate": "2019-08-24",
30 "currentIndexLevel": 0.1,
31 "conditionallyIndexed": true,
32 "applicableCurrentIndexLevel": 0.1,
33 "indexLevelPercentageChangeLowerBound": 0.1,
34 "indexLevelPercentageChangeUpperBound": 0.1,
35 "indexationTypeNonLease": "string",
36 "cpiGlobalCategoryIdNonLease": 0,
37 "indexationReferenceDateNonLease": "2019-08-24",
38 "currentIndexLevelNonLease": 0.1,
39 "conditionallyIndexedNonLease": true,
40 "applicableCurrentIndexLevelNonLease": 0.1,
41 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
42 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
43 "signatureDate": "2019-08-24",
44 "premiseId": 0,
45 "type": {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "priority": 0,
54 "internalId": 0,
55 "pickListCode": "string",
56 "pickListLabel": "string",
57 "label": "string",
58 "cultureId": 0,
59 "labelDtos": [
60 {
61 "createdBy": "string",
62 "lastModifiedBy": "string",
63 "createdDate": "2019-08-24T14:15:22Z",
64 "lastModifiedDate": "2019-08-24T14:15:22Z",
65 "archived": true,
66 "externalId": "string",
67 "id": 0,
68 "cultureId": 0,
69 "value": "string"
70 }
71 ]
72 },
73 "category": {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "priority": 0,
82 "internalId": 0,
83 "pickListCode": "string",
84 "pickListLabel": "string",
85 "label": "string",
86 "cultureId": 0,
87 "labelDtos": [
88 {
89 "createdBy": "string",
90 "lastModifiedBy": "string",
91 "createdDate": "2019-08-24T14:15:22Z",
92 "lastModifiedDate": "2019-08-24T14:15:22Z",
93 "archived": true,
94 "externalId": "string",
95 "id": 0,
96 "cultureId": 0,
97 "value": "string"
98 }
99 ]
100 },
101 "status": {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "priority": 0,
110 "internalId": 0,
111 "pickListCode": "string",
112 "pickListLabel": "string",
113 "label": "string",
114 "cultureId": 0,
115 "labelDtos": [
116 {
117 "createdBy": "string",
118 "lastModifiedBy": "string",
119 "createdDate": "2019-08-24T14:15:22Z",
120 "lastModifiedDate": "2019-08-24T14:15:22Z",
121 "archived": true,
122 "externalId": "string",
123 "id": 0,
124 "cultureId": 0,
125 "value": "string"
126 }
127 ]
128 },
129 "state": {
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 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "version": {
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 "name": "string",
166 "description": "string",
167 "modificationDate": "2019-08-24",
168 "updateContractRate": true,
169 "leaseEvent": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "typeId": 0,
178 "code": "string",
179 "reviewedBy": "string",
180 "reviewedDate": "2019-08-24",
181 "reviewedStatusId": 0,
182 "activityDate": "2019-08-24",
183 "relatedPickListOptionId": 0,
184 "detail": "string",
185 "note": {
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 "message": "string",
194 "preserveOriginalAudit": true,
195 "originalCreatedBy": "string",
196 "originalCreatedDate": "2019-08-24T14:15:22Z",
197 "originalLastModifiedBy": "string",
198 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
199 },
200 "type": {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "priority": 0,
209 "internalId": 0,
210 "pickListCode": "string",
211 "pickListLabel": "string",
212 "label": "string",
213 "cultureId": 0,
214 "labelDtos": [
215 {
216 "createdBy": "string",
217 "lastModifiedBy": "string",
218 "createdDate": "2019-08-24T14:15:22Z",
219 "lastModifiedDate": "2019-08-24T14:15:22Z",
220 "archived": true,
221 "externalId": "string",
222 "id": 0,
223 "cultureId": 0,
224 "value": "string"
225 }
226 ]
227 },
228 "reviewedStatus": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "priority": 0,
237 "internalId": 0,
238 "pickListCode": "string",
239 "pickListLabel": "string",
240 "label": "string",
241 "cultureId": 0,
242 "labelDtos": [
243 {
244 "createdBy": "string",
245 "lastModifiedBy": "string",
246 "createdDate": "2019-08-24T14:15:22Z",
247 "lastModifiedDate": "2019-08-24T14:15:22Z",
248 "archived": true,
249 "externalId": "string",
250 "id": 0,
251 "cultureId": 0,
252 "value": "string"
253 }
254 ]
255 },
256 "relatedPickListOption": {
257 "createdBy": "string",
258 "lastModifiedBy": "string",
259 "createdDate": "2019-08-24T14:15:22Z",
260 "lastModifiedDate": "2019-08-24T14:15:22Z",
261 "archived": true,
262 "externalId": "string",
263 "id": 0,
264 "priority": 0,
265 "internalId": 0,
266 "pickListCode": "string",
267 "pickListLabel": "string",
268 "label": "string",
269 "cultureId": 0,
270 "labelDtos": [
271 {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "cultureId": 0,
280 "value": "string"
281 }
282 ]
283 },
284 "isVisiblePartnerPortal": true
285 },
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1,
290 "areasHistoryVersionId": 0
291 },
292 "premiseDto": {
293 "createdBy": "string",
294 "lastModifiedBy": "string",
295 "createdDate": "2019-08-24T14:15:22Z",
296 "lastModifiedDate": "2019-08-24T14:15:22Z",
297 "archived": true,
298 "externalId": "string",
299 "id": 0,
300 "number": "string",
301 "name": "string",
302 "headPremise": true,
303 "possessionDate": "2019-08-24",
304 "openingDate": "2019-08-24",
305 "closingDate": "2019-08-24",
306 "relocationDate": "2019-08-24",
307 "vacatingDate": "2019-08-24",
308 "expansionDate": "2019-08-24",
309 "statusId": 0,
310 "usageId": 0,
311 "parentPremiseId": 0,
312 "costCenterId": 0,
313 "profitCenterId": 0,
314 "legalEntityId": 0,
315 "occupancyIds": [
316 0
317 ],
318 "locationId": 0,
319 "locationDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "number": "string",
328 "name": "string",
329 "storeNumber": "string",
330 "defaultCurrencyId": 0,
331 "defaultMeasureId": 0,
332 "typeId": 0,
333 "qualityId": 0,
334 "propertyTypeId": 0,
335 "categoryId": 0,
336 "statusId": 0,
337 "businessUnitId": 0,
338 "groupIds": [
339 0
340 ],
341 "legalEntityIds": [
342 0
343 ],
344 "defaultCurrency": {
345 "id": 0,
346 "status": "CREATED",
347 "displayId": "string",
348 "erpSystemId": 0,
349 "erpSystemDisplayId": "string",
350 "name": "string",
351 "decimalPoints": 0,
352 "depreciationAreaId": 0
353 },
354 "defaultUnitValue": {
355 "createdBy": "string",
356 "lastModifiedBy": "string",
357 "createdDate": "2019-08-24T14:15:22Z",
358 "lastModifiedDate": "2019-08-24T14:15:22Z",
359 "archived": true,
360 "externalId": "string",
361 "id": 0,
362 "unitId": 0,
363 "unitOfMeasureId": 0,
364 "erpSystemId": 0,
365 "unit": {
366 "createdBy": "string",
367 "lastModifiedBy": "string",
368 "createdDate": "2019-08-24T14:15:22Z",
369 "lastModifiedDate": "2019-08-24T14:15:22Z",
370 "archived": true,
371 "externalId": "string",
372 "id": 0,
373 "priority": 0,
374 "internalId": 0,
375 "pickListCode": "string",
376 "pickListLabel": "string",
377 "label": "string",
378 "cultureId": 0,
379 "labelDtos": [
380 {
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 "cultureId": 0,
389 "value": "string"
390 }
391 ]
392 },
393 "unitOfMeasure": {
394 "id": 0,
395 "status": "CREATED",
396 "displayId": "string",
397 "erpSystemId": 0,
398 "erpSystemDisplayId": "string",
399 "name": "string"
400 }
401 },
402 "type": {
403 "createdBy": "string",
404 "lastModifiedBy": "string",
405 "createdDate": "2019-08-24T14:15:22Z",
406 "lastModifiedDate": "2019-08-24T14:15:22Z",
407 "archived": true,
408 "externalId": "string",
409 "id": 0,
410 "priority": 0,
411 "internalId": 0,
412 "pickListCode": "string",
413 "pickListLabel": "string",
414 "label": "string",
415 "cultureId": 0,
416 "labelDtos": [
417 {
418 "createdBy": "string",
419 "lastModifiedBy": "string",
420 "createdDate": "2019-08-24T14:15:22Z",
421 "lastModifiedDate": "2019-08-24T14:15:22Z",
422 "archived": true,
423 "externalId": "string",
424 "id": 0,
425 "cultureId": 0,
426 "value": "string"
427 }
428 ]
429 },
430 "quality": {
431 "createdBy": "string",
432 "lastModifiedBy": "string",
433 "createdDate": "2019-08-24T14:15:22Z",
434 "lastModifiedDate": "2019-08-24T14:15:22Z",
435 "archived": true,
436 "externalId": "string",
437 "id": 0,
438 "priority": 0,
439 "internalId": 0,
440 "pickListCode": "string",
441 "pickListLabel": "string",
442 "label": "string",
443 "cultureId": 0,
444 "labelDtos": [
445 {
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 "cultureId": 0,
454 "value": "string"
455 }
456 ]
457 },
458 "propertyType": {
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 "priority": 0,
467 "internalId": 0,
468 "pickListCode": "string",
469 "pickListLabel": "string",
470 "label": "string",
471 "cultureId": 0,
472 "labelDtos": [
473 {
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 "cultureId": 0,
482 "value": "string"
483 }
484 ]
485 },
486 "category": {
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 "priority": 0,
495 "internalId": 0,
496 "pickListCode": "string",
497 "pickListLabel": "string",
498 "label": "string",
499 "cultureId": 0,
500 "labelDtos": [
501 {
502 "createdBy": "string",
503 "lastModifiedBy": "string",
504 "createdDate": "2019-08-24T14:15:22Z",
505 "lastModifiedDate": "2019-08-24T14:15:22Z",
506 "archived": true,
507 "externalId": "string",
508 "id": 0,
509 "cultureId": 0,
510 "value": "string"
511 }
512 ]
513 },
514 "status": {
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 "priority": 0,
523 "internalId": 0,
524 "pickListCode": "string",
525 "pickListLabel": "string",
526 "label": "string",
527 "cultureId": 0,
528 "labelDtos": [
529 {
530 "createdBy": "string",
531 "lastModifiedBy": "string",
532 "createdDate": "2019-08-24T14:15:22Z",
533 "lastModifiedDate": "2019-08-24T14:15:22Z",
534 "archived": true,
535 "externalId": "string",
536 "id": 0,
537 "cultureId": 0,
538 "value": "string"
539 }
540 ]
541 },
542 "addressDto": {
543 "createdBy": "string",
544 "lastModifiedBy": "string",
545 "createdDate": "2019-08-24T14:15:22Z",
546 "lastModifiedDate": "2019-08-24T14:15:22Z",
547 "archived": true,
548 "externalId": "string",
549 "id": 0,
550 "street": "string",
551 "civicNumber": "string",
552 "suite": "string",
553 "postalCode": "string",
554 "lon": 0.1,
555 "lat": 0.1,
556 "city": {
557 "createdBy": "string",
558 "lastModifiedBy": "string",
559 "createdDate": "2019-08-24T14:15:22Z",
560 "lastModifiedDate": "2019-08-24T14:15:22Z",
561 "archived": true,
562 "externalId": "string",
563 "id": 0,
564 "name": "string",
565 "province": {
566 "createdBy": "string",
567 "lastModifiedBy": "string",
568 "createdDate": "2019-08-24T14:15:22Z",
569 "lastModifiedDate": "2019-08-24T14:15:22Z",
570 "archived": true,
571 "externalId": "string",
572 "id": 0,
573 "name": "string",
574 "code": "string",
575 "country": {
576 "createdBy": "string",
577 "lastModifiedBy": "string",
578 "createdDate": "2019-08-24T14:15:22Z",
579 "lastModifiedDate": "2019-08-24T14:15:22Z",
580 "archived": true,
581 "externalId": "string",
582 "id": 0,
583 "name": "string",
584 "code": "string"
585 },
586 "provinceCountryKey": "string"
587 },
588 "cityProvinceCountryKey": "string"
589 },
590 "district": {
591 "createdBy": "string",
592 "lastModifiedBy": "string",
593 "createdDate": "2019-08-24T14:15:22Z",
594 "lastModifiedDate": "2019-08-24T14:15:22Z",
595 "archived": true,
596 "externalId": "string",
597 "id": 0,
598 "name": "string",
599 "city": {
600 "createdBy": "string",
601 "lastModifiedBy": "string",
602 "createdDate": "2019-08-24T14:15:22Z",
603 "lastModifiedDate": "2019-08-24T14:15:22Z",
604 "archived": true,
605 "externalId": "string",
606 "id": 0,
607 "name": "string",
608 "province": {
609 "createdBy": "string",
610 "lastModifiedBy": "string",
611 "createdDate": "2019-08-24T14:15:22Z",
612 "lastModifiedDate": "2019-08-24T14:15:22Z",
613 "archived": true,
614 "externalId": "string",
615 "id": 0,
616 "name": "string",
617 "code": "string",
618 "country": {
619 "createdBy": "string",
620 "lastModifiedBy": "string",
621 "createdDate": "2019-08-24T14:15:22Z",
622 "lastModifiedDate": "2019-08-24T14:15:22Z",
623 "archived": true,
624 "externalId": "string",
625 "id": 0,
626 "name": "string",
627 "code": "string"
628 },
629 "provinceCountryKey": "string"
630 },
631 "cityProvinceCountryKey": "string"
632 }
633 },
634 "cityId": 0,
635 "districtId": 0
636 },
637 "secondAddressDto": {
638 "createdBy": "string",
639 "lastModifiedBy": "string",
640 "createdDate": "2019-08-24T14:15:22Z",
641 "lastModifiedDate": "2019-08-24T14:15:22Z",
642 "archived": true,
643 "externalId": "string",
644 "id": 0,
645 "street": "string",
646 "civicNumber": "string",
647 "suite": "string",
648 "postalCode": "string",
649 "lon": 0.1,
650 "lat": 0.1,
651 "city": {
652 "createdBy": "string",
653 "lastModifiedBy": "string",
654 "createdDate": "2019-08-24T14:15:22Z",
655 "lastModifiedDate": "2019-08-24T14:15:22Z",
656 "archived": true,
657 "externalId": "string",
658 "id": 0,
659 "name": "string",
660 "province": {
661 "createdBy": "string",
662 "lastModifiedBy": "string",
663 "createdDate": "2019-08-24T14:15:22Z",
664 "lastModifiedDate": "2019-08-24T14:15:22Z",
665 "archived": true,
666 "externalId": "string",
667 "id": 0,
668 "name": "string",
669 "code": "string",
670 "country": {
671 "createdBy": "string",
672 "lastModifiedBy": "string",
673 "createdDate": "2019-08-24T14:15:22Z",
674 "lastModifiedDate": "2019-08-24T14:15:22Z",
675 "archived": true,
676 "externalId": "string",
677 "id": 0,
678 "name": "string",
679 "code": "string"
680 },
681 "provinceCountryKey": "string"
682 },
683 "cityProvinceCountryKey": "string"
684 },
685 "district": {
686 "createdBy": "string",
687 "lastModifiedBy": "string",
688 "createdDate": "2019-08-24T14:15:22Z",
689 "lastModifiedDate": "2019-08-24T14:15:22Z",
690 "archived": true,
691 "externalId": "string",
692 "id": 0,
693 "name": "string",
694 "city": {
695 "createdBy": "string",
696 "lastModifiedBy": "string",
697 "createdDate": "2019-08-24T14:15:22Z",
698 "lastModifiedDate": "2019-08-24T14:15:22Z",
699 "archived": true,
700 "externalId": "string",
701 "id": 0,
702 "name": "string",
703 "province": {
704 "createdBy": "string",
705 "lastModifiedBy": "string",
706 "createdDate": "2019-08-24T14:15:22Z",
707 "lastModifiedDate": "2019-08-24T14:15:22Z",
708 "archived": true,
709 "externalId": "string",
710 "id": 0,
711 "name": "string",
712 "code": "string",
713 "country": {
714 "createdBy": "string",
715 "lastModifiedBy": "string",
716 "createdDate": "2019-08-24T14:15:22Z",
717 "lastModifiedDate": "2019-08-24T14:15:22Z",
718 "archived": true,
719 "externalId": "string",
720 "id": 0,
721 "name": "string",
722 "code": "string"
723 },
724 "provinceCountryKey": "string"
725 },
726 "cityProvinceCountryKey": "string"
727 }
728 },
729 "cityId": 0,
730 "districtId": 0
731 }
732 },
733 "status": {
734 "createdBy": "string",
735 "lastModifiedBy": "string",
736 "createdDate": "2019-08-24T14:15:22Z",
737 "lastModifiedDate": "2019-08-24T14:15:22Z",
738 "archived": true,
739 "externalId": "string",
740 "id": 0,
741 "priority": 0,
742 "internalId": 0,
743 "pickListCode": "string",
744 "pickListLabel": "string",
745 "label": "string",
746 "cultureId": 0,
747 "labelDtos": [
748 {
749 "createdBy": "string",
750 "lastModifiedBy": "string",
751 "createdDate": "2019-08-24T14:15:22Z",
752 "lastModifiedDate": "2019-08-24T14:15:22Z",
753 "archived": true,
754 "externalId": "string",
755 "id": 0,
756 "cultureId": 0,
757 "value": "string"
758 }
759 ]
760 },
761 "usage": {
762 "createdBy": "string",
763 "lastModifiedBy": "string",
764 "createdDate": "2019-08-24T14:15:22Z",
765 "lastModifiedDate": "2019-08-24T14:15:22Z",
766 "archived": true,
767 "externalId": "string",
768 "id": 0,
769 "priority": 0,
770 "internalId": 0,
771 "pickListCode": "string",
772 "pickListLabel": "string",
773 "label": "string",
774 "cultureId": 0,
775 "labelDtos": [
776 {
777 "createdBy": "string",
778 "lastModifiedBy": "string",
779 "createdDate": "2019-08-24T14:15:22Z",
780 "lastModifiedDate": "2019-08-24T14:15:22Z",
781 "archived": true,
782 "externalId": "string",
783 "id": 0,
784 "cultureId": 0,
785 "value": "string"
786 }
787 ]
788 },
789 "occupanciesDto": [
790 {
791 "createdBy": "string",
792 "lastModifiedBy": "string",
793 "createdDate": "2019-08-24T14:15:22Z",
794 "lastModifiedDate": "2019-08-24T14:15:22Z",
795 "archived": true,
796 "externalId": "string",
797 "id": 0,
798 "priority": 0,
799 "internalId": 0,
800 "pickListCode": "string",
801 "pickListLabel": "string",
802 "label": "string",
803 "cultureId": 0,
804 "labelDtos": [
805 {
806 "createdBy": "string",
807 "lastModifiedBy": "string",
808 "createdDate": "2019-08-24T14:15:22Z",
809 "lastModifiedDate": "2019-08-24T14:15:22Z",
810 "archived": true,
811 "externalId": "string",
812 "id": 0,
813 "cultureId": 0,
814 "value": "string"
815 }
816 ]
817 }
818 ]
819 },
820 "isTerminationVersion": true
821}
Lease - Delete Lease Event¶
HTTP Request
DELETE /api/leases/{leaseId}/events/{eventId}
📋 Description: Deletes a specified event associated with a lease in the Nakisa Portfolio Management Suite, enabling effective management of portfolio and asset-related activities within real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
eventId |
path |
integer(int64) |
true |
Unique identifier for the event |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Lease - Delete Lease Document¶
HTTP Request
DELETE /api/leases/{leaseId}/documents/{documentId}
📋 Description: Deletes a specified document associated with a lease within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Lease - Delete Lease Reconciliation Period¶
HTTP Request
DELETE /api/leases/{id}/lease-reconciliation-periods/{periodId}
📋 Description: Deletes a specified lease reconciliation period associated with a particular lease, enabling effective management of lease data within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
periodId |
path |
integer(int64) |
true |
Unique identifier for the period |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |