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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "isVisibleVendorPortal": true,
285 "isTerminationVersion": true,
286 "terminationDate": "2019-08-24",
287 "penaltyAmount": 0.1
288 },
289 "premiseDto": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "number": "string",
298 "name": "string",
299 "headPremise": true,
300 "possessionDate": "2019-08-24",
301 "openingDate": "2019-08-24",
302 "closingDate": "2019-08-24",
303 "relocationDate": "2019-08-24",
304 "vacatingDate": "2019-08-24",
305 "expansionDate": "2019-08-24",
306 "statusId": 0,
307 "usageId": 0,
308 "parentPremiseId": 0,
309 "costCenterId": 0,
310 "profitCenterId": 0,
311 "legalEntityId": 0,
312 "occupancyIds": [
313 0
314 ],
315 "locationId": 0,
316 "locationDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "number": "string",
325 "name": "string",
326 "storeNumber": "string",
327 "defaultCurrencyId": 0,
328 "defaultMeasureId": 0,
329 "typeId": 0,
330 "qualityId": 0,
331 "propertyTypeId": 0,
332 "categoryId": 0,
333 "statusId": 0,
334 "businessUnitId": 0,
335 "groupIds": [
336 0
337 ],
338 "legalEntityIds": [
339 0
340 ],
341 "defaultCurrency": {
342 "id": 0,
343 "status": "CREATED",
344 "displayId": "string",
345 "erpSystemId": 0,
346 "erpSystemDisplayId": "string",
347 "name": "string",
348 "decimalPoints": 0,
349 "depreciationAreaId": 0
350 },
351 "defaultUnitValue": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "unitId": 0,
360 "unitOfMeasureId": 0,
361 "erpSystemId": 0,
362 "unit": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "unitOfMeasure": {
391 "id": 0,
392 "status": "CREATED",
393 "displayId": "string",
394 "erpSystemId": 0,
395 "erpSystemDisplayId": "string",
396 "name": "string"
397 }
398 },
399 "type": {
400 "createdBy": "string",
401 "lastModifiedBy": "string",
402 "createdDate": "2019-08-24T14:15:22Z",
403 "lastModifiedDate": "2019-08-24T14:15:22Z",
404 "archived": true,
405 "externalId": "string",
406 "id": 0,
407 "priority": 0,
408 "internalId": 0,
409 "pickListCode": "string",
410 "pickListLabel": "string",
411 "label": "string",
412 "cultureId": 0,
413 "labelDtos": [
414 {
415 "createdBy": "string",
416 "lastModifiedBy": "string",
417 "createdDate": "2019-08-24T14:15:22Z",
418 "lastModifiedDate": "2019-08-24T14:15:22Z",
419 "archived": true,
420 "externalId": "string",
421 "id": 0,
422 "cultureId": 0,
423 "value": "string"
424 }
425 ]
426 },
427 "quality": {
428 "createdBy": "string",
429 "lastModifiedBy": "string",
430 "createdDate": "2019-08-24T14:15:22Z",
431 "lastModifiedDate": "2019-08-24T14:15:22Z",
432 "archived": true,
433 "externalId": "string",
434 "id": 0,
435 "priority": 0,
436 "internalId": 0,
437 "pickListCode": "string",
438 "pickListLabel": "string",
439 "label": "string",
440 "cultureId": 0,
441 "labelDtos": [
442 {
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 "cultureId": 0,
451 "value": "string"
452 }
453 ]
454 },
455 "propertyType": {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "priority": 0,
464 "internalId": 0,
465 "pickListCode": "string",
466 "pickListLabel": "string",
467 "label": "string",
468 "cultureId": 0,
469 "labelDtos": [
470 {
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 "cultureId": 0,
479 "value": "string"
480 }
481 ]
482 },
483 "category": {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "priority": 0,
492 "internalId": 0,
493 "pickListCode": "string",
494 "pickListLabel": "string",
495 "label": "string",
496 "cultureId": 0,
497 "labelDtos": [
498 {
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 "cultureId": 0,
507 "value": "string"
508 }
509 ]
510 },
511 "status": {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "priority": 0,
520 "internalId": 0,
521 "pickListCode": "string",
522 "pickListLabel": "string",
523 "label": "string",
524 "cultureId": 0,
525 "labelDtos": [
526 {
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 "cultureId": 0,
535 "value": "string"
536 }
537 ]
538 },
539 "addressDto": {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "street": "string",
548 "civicNumber": "string",
549 "suite": "string",
550 "postalCode": "string",
551 "lon": 0.1,
552 "lat": 0.1,
553 "city": {
554 "createdBy": "string",
555 "lastModifiedBy": "string",
556 "createdDate": "2019-08-24T14:15:22Z",
557 "lastModifiedDate": "2019-08-24T14:15:22Z",
558 "archived": true,
559 "externalId": "string",
560 "id": 0,
561 "name": "string",
562 "province": {
563 "createdBy": "string",
564 "lastModifiedBy": "string",
565 "createdDate": "2019-08-24T14:15:22Z",
566 "lastModifiedDate": "2019-08-24T14:15:22Z",
567 "archived": true,
568 "externalId": "string",
569 "id": 0,
570 "name": "string",
571 "code": "string",
572 "country": {
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 "code": "string"
582 }
583 }
584 },
585 "district": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
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 }
675 },
676 "district": {
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 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 }
717 },
718 "cityId": 0,
719 "districtId": 0
720 }
721 },
722 "status": {
723 "createdBy": "string",
724 "lastModifiedBy": "string",
725 "createdDate": "2019-08-24T14:15:22Z",
726 "lastModifiedDate": "2019-08-24T14:15:22Z",
727 "archived": true,
728 "externalId": "string",
729 "id": 0,
730 "priority": 0,
731 "internalId": 0,
732 "pickListCode": "string",
733 "pickListLabel": "string",
734 "label": "string",
735 "cultureId": 0,
736 "labelDtos": [
737 {
738 "createdBy": "string",
739 "lastModifiedBy": "string",
740 "createdDate": "2019-08-24T14:15:22Z",
741 "lastModifiedDate": "2019-08-24T14:15:22Z",
742 "archived": true,
743 "externalId": "string",
744 "id": 0,
745 "cultureId": 0,
746 "value": "string"
747 }
748 ]
749 },
750 "usage": {
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 "priority": 0,
759 "internalId": 0,
760 "pickListCode": "string",
761 "pickListLabel": "string",
762 "label": "string",
763 "cultureId": 0,
764 "labelDtos": [
765 {
766 "createdBy": "string",
767 "lastModifiedBy": "string",
768 "createdDate": "2019-08-24T14:15:22Z",
769 "lastModifiedDate": "2019-08-24T14:15:22Z",
770 "archived": true,
771 "externalId": "string",
772 "id": 0,
773 "cultureId": 0,
774 "value": "string"
775 }
776 ]
777 },
778 "occupanciesDto": [
779 {
780 "createdBy": "string",
781 "lastModifiedBy": "string",
782 "createdDate": "2019-08-24T14:15:22Z",
783 "lastModifiedDate": "2019-08-24T14:15:22Z",
784 "archived": true,
785 "externalId": "string",
786 "id": 0,
787 "priority": 0,
788 "internalId": 0,
789 "pickListCode": "string",
790 "pickListLabel": "string",
791 "label": "string",
792 "cultureId": 0,
793 "labelDtos": [
794 {
795 "createdBy": "string",
796 "lastModifiedBy": "string",
797 "createdDate": "2019-08-24T14:15:22Z",
798 "lastModifiedDate": "2019-08-24T14:15:22Z",
799 "archived": true,
800 "externalId": "string",
801 "id": 0,
802 "cultureId": 0,
803 "value": "string"
804 }
805 ]
806 }
807 ]
808 },
809 "isTerminationVersion": true
810}
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "scenario": true,
285 "isVisibleVendorPortal": true,
286 "isTerminationVersion": true,
287 "terminationDate": "2019-08-24",
288 "penaltyAmount": 0.1
289 },
290 "premiseDto": {
291 "createdBy": "string",
292 "lastModifiedBy": "string",
293 "createdDate": "2019-08-24T14:15:22Z",
294 "lastModifiedDate": "2019-08-24T14:15:22Z",
295 "archived": true,
296 "externalId": "string",
297 "id": 0,
298 "number": "string",
299 "name": "string",
300 "headPremise": true,
301 "possessionDate": "2019-08-24",
302 "openingDate": "2019-08-24",
303 "closingDate": "2019-08-24",
304 "relocationDate": "2019-08-24",
305 "vacatingDate": "2019-08-24",
306 "expansionDate": "2019-08-24",
307 "statusId": 0,
308 "usageId": 0,
309 "parentPremiseId": 0,
310 "costCenterId": 0,
311 "profitCenterId": 0,
312 "legalEntityId": 0,
313 "occupancyIds": [
314 0
315 ],
316 "locationId": 0,
317 "locationDto": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "number": "string",
326 "name": "string",
327 "storeNumber": "string",
328 "defaultCurrencyId": 0,
329 "defaultMeasureId": 0,
330 "typeId": 0,
331 "qualityId": 0,
332 "propertyTypeId": 0,
333 "categoryId": 0,
334 "statusId": 0,
335 "businessUnitId": 0,
336 "groupIds": [
337 0
338 ],
339 "legalEntityIds": [
340 0
341 ],
342 "defaultCurrency": {
343 "id": 0,
344 "status": "CREATED",
345 "displayId": "string",
346 "erpSystemId": 0,
347 "erpSystemDisplayId": "string",
348 "name": "string",
349 "decimalPoints": 0,
350 "depreciationAreaId": 0
351 },
352 "defaultUnitValue": {
353 "createdBy": "string",
354 "lastModifiedBy": "string",
355 "createdDate": "2019-08-24T14:15:22Z",
356 "lastModifiedDate": "2019-08-24T14:15:22Z",
357 "archived": true,
358 "externalId": "string",
359 "id": 0,
360 "unitId": 0,
361 "unitOfMeasureId": 0,
362 "erpSystemId": 0,
363 "unit": {
364 "createdBy": "string",
365 "lastModifiedBy": "string",
366 "createdDate": "2019-08-24T14:15:22Z",
367 "lastModifiedDate": "2019-08-24T14:15:22Z",
368 "archived": true,
369 "externalId": "string",
370 "id": 0,
371 "priority": 0,
372 "internalId": 0,
373 "pickListCode": "string",
374 "pickListLabel": "string",
375 "label": "string",
376 "cultureId": 0,
377 "labelDtos": [
378 {
379 "createdBy": "string",
380 "lastModifiedBy": "string",
381 "createdDate": "2019-08-24T14:15:22Z",
382 "lastModifiedDate": "2019-08-24T14:15:22Z",
383 "archived": true,
384 "externalId": "string",
385 "id": 0,
386 "cultureId": 0,
387 "value": "string"
388 }
389 ]
390 },
391 "unitOfMeasure": {
392 "id": 0,
393 "status": "CREATED",
394 "displayId": "string",
395 "erpSystemId": 0,
396 "erpSystemDisplayId": "string",
397 "name": "string"
398 }
399 },
400 "type": {
401 "createdBy": "string",
402 "lastModifiedBy": "string",
403 "createdDate": "2019-08-24T14:15:22Z",
404 "lastModifiedDate": "2019-08-24T14:15:22Z",
405 "archived": true,
406 "externalId": "string",
407 "id": 0,
408 "priority": 0,
409 "internalId": 0,
410 "pickListCode": "string",
411 "pickListLabel": "string",
412 "label": "string",
413 "cultureId": 0,
414 "labelDtos": [
415 {
416 "createdBy": "string",
417 "lastModifiedBy": "string",
418 "createdDate": "2019-08-24T14:15:22Z",
419 "lastModifiedDate": "2019-08-24T14:15:22Z",
420 "archived": true,
421 "externalId": "string",
422 "id": 0,
423 "cultureId": 0,
424 "value": "string"
425 }
426 ]
427 },
428 "quality": {
429 "createdBy": "string",
430 "lastModifiedBy": "string",
431 "createdDate": "2019-08-24T14:15:22Z",
432 "lastModifiedDate": "2019-08-24T14:15:22Z",
433 "archived": true,
434 "externalId": "string",
435 "id": 0,
436 "priority": 0,
437 "internalId": 0,
438 "pickListCode": "string",
439 "pickListLabel": "string",
440 "label": "string",
441 "cultureId": 0,
442 "labelDtos": [
443 {
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 "cultureId": 0,
452 "value": "string"
453 }
454 ]
455 },
456 "propertyType": {
457 "createdBy": "string",
458 "lastModifiedBy": "string",
459 "createdDate": "2019-08-24T14:15:22Z",
460 "lastModifiedDate": "2019-08-24T14:15:22Z",
461 "archived": true,
462 "externalId": "string",
463 "id": 0,
464 "priority": 0,
465 "internalId": 0,
466 "pickListCode": "string",
467 "pickListLabel": "string",
468 "label": "string",
469 "cultureId": 0,
470 "labelDtos": [
471 {
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 "cultureId": 0,
480 "value": "string"
481 }
482 ]
483 },
484 "category": {
485 "createdBy": "string",
486 "lastModifiedBy": "string",
487 "createdDate": "2019-08-24T14:15:22Z",
488 "lastModifiedDate": "2019-08-24T14:15:22Z",
489 "archived": true,
490 "externalId": "string",
491 "id": 0,
492 "priority": 0,
493 "internalId": 0,
494 "pickListCode": "string",
495 "pickListLabel": "string",
496 "label": "string",
497 "cultureId": 0,
498 "labelDtos": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "cultureId": 0,
508 "value": "string"
509 }
510 ]
511 },
512 "status": {
513 "createdBy": "string",
514 "lastModifiedBy": "string",
515 "createdDate": "2019-08-24T14:15:22Z",
516 "lastModifiedDate": "2019-08-24T14:15:22Z",
517 "archived": true,
518 "externalId": "string",
519 "id": 0,
520 "priority": 0,
521 "internalId": 0,
522 "pickListCode": "string",
523 "pickListLabel": "string",
524 "label": "string",
525 "cultureId": 0,
526 "labelDtos": [
527 {
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 "cultureId": 0,
536 "value": "string"
537 }
538 ]
539 },
540 "addressDto": {
541 "createdBy": "string",
542 "lastModifiedBy": "string",
543 "createdDate": "2019-08-24T14:15:22Z",
544 "lastModifiedDate": "2019-08-24T14:15:22Z",
545 "archived": true,
546 "externalId": "string",
547 "id": 0,
548 "street": "string",
549 "civicNumber": "string",
550 "suite": "string",
551 "postalCode": "string",
552 "lon": 0.1,
553 "lat": 0.1,
554 "city": {
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 "name": "string",
563 "province": {
564 "createdBy": "string",
565 "lastModifiedBy": "string",
566 "createdDate": "2019-08-24T14:15:22Z",
567 "lastModifiedDate": "2019-08-24T14:15:22Z",
568 "archived": true,
569 "externalId": "string",
570 "id": 0,
571 "name": "string",
572 "code": "string",
573 "country": {
574 "createdBy": "string",
575 "lastModifiedBy": "string",
576 "createdDate": "2019-08-24T14:15:22Z",
577 "lastModifiedDate": "2019-08-24T14:15:22Z",
578 "archived": true,
579 "externalId": "string",
580 "id": 0,
581 "name": "string",
582 "code": "string"
583 }
584 }
585 },
586 "district": {
587 "createdBy": "string",
588 "lastModifiedBy": "string",
589 "createdDate": "2019-08-24T14:15:22Z",
590 "lastModifiedDate": "2019-08-24T14:15:22Z",
591 "archived": true,
592 "externalId": "string",
593 "id": 0,
594 "name": "string",
595 "city": {
596 "createdBy": "string",
597 "lastModifiedBy": "string",
598 "createdDate": "2019-08-24T14:15:22Z",
599 "lastModifiedDate": "2019-08-24T14:15:22Z",
600 "archived": true,
601 "externalId": "string",
602 "id": 0,
603 "name": "string",
604 "province": {
605 "createdBy": "string",
606 "lastModifiedBy": "string",
607 "createdDate": "2019-08-24T14:15:22Z",
608 "lastModifiedDate": "2019-08-24T14:15:22Z",
609 "archived": true,
610 "externalId": "string",
611 "id": 0,
612 "name": "string",
613 "code": "string",
614 "country": {
615 "createdBy": "string",
616 "lastModifiedBy": "string",
617 "createdDate": "2019-08-24T14:15:22Z",
618 "lastModifiedDate": "2019-08-24T14:15:22Z",
619 "archived": true,
620 "externalId": "string",
621 "id": 0,
622 "name": "string",
623 "code": "string"
624 }
625 }
626 }
627 },
628 "cityId": 0,
629 "districtId": 0
630 },
631 "secondAddressDto": {
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 "street": "string",
640 "civicNumber": "string",
641 "suite": "string",
642 "postalCode": "string",
643 "lon": 0.1,
644 "lat": 0.1,
645 "city": {
646 "createdBy": "string",
647 "lastModifiedBy": "string",
648 "createdDate": "2019-08-24T14:15:22Z",
649 "lastModifiedDate": "2019-08-24T14:15:22Z",
650 "archived": true,
651 "externalId": "string",
652 "id": 0,
653 "name": "string",
654 "province": {
655 "createdBy": "string",
656 "lastModifiedBy": "string",
657 "createdDate": "2019-08-24T14:15:22Z",
658 "lastModifiedDate": "2019-08-24T14:15:22Z",
659 "archived": true,
660 "externalId": "string",
661 "id": 0,
662 "name": "string",
663 "code": "string",
664 "country": {
665 "createdBy": "string",
666 "lastModifiedBy": "string",
667 "createdDate": "2019-08-24T14:15:22Z",
668 "lastModifiedDate": "2019-08-24T14:15:22Z",
669 "archived": true,
670 "externalId": "string",
671 "id": 0,
672 "name": "string",
673 "code": "string"
674 }
675 }
676 },
677 "district": {
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 "name": "string",
686 "city": {
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 "province": {
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 "code": "string",
705 "country": {
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 }
716 }
717 }
718 },
719 "cityId": 0,
720 "districtId": 0
721 }
722 },
723 "status": {
724 "createdBy": "string",
725 "lastModifiedBy": "string",
726 "createdDate": "2019-08-24T14:15:22Z",
727 "lastModifiedDate": "2019-08-24T14:15:22Z",
728 "archived": true,
729 "externalId": "string",
730 "id": 0,
731 "priority": 0,
732 "internalId": 0,
733 "pickListCode": "string",
734 "pickListLabel": "string",
735 "label": "string",
736 "cultureId": 0,
737 "labelDtos": [
738 {
739 "createdBy": "string",
740 "lastModifiedBy": "string",
741 "createdDate": "2019-08-24T14:15:22Z",
742 "lastModifiedDate": "2019-08-24T14:15:22Z",
743 "archived": true,
744 "externalId": "string",
745 "id": 0,
746 "cultureId": 0,
747 "value": "string"
748 }
749 ]
750 },
751 "usage": {
752 "createdBy": "string",
753 "lastModifiedBy": "string",
754 "createdDate": "2019-08-24T14:15:22Z",
755 "lastModifiedDate": "2019-08-24T14:15:22Z",
756 "archived": true,
757 "externalId": "string",
758 "id": 0,
759 "priority": 0,
760 "internalId": 0,
761 "pickListCode": "string",
762 "pickListLabel": "string",
763 "label": "string",
764 "cultureId": 0,
765 "labelDtos": [
766 {
767 "createdBy": "string",
768 "lastModifiedBy": "string",
769 "createdDate": "2019-08-24T14:15:22Z",
770 "lastModifiedDate": "2019-08-24T14:15:22Z",
771 "archived": true,
772 "externalId": "string",
773 "id": 0,
774 "cultureId": 0,
775 "value": "string"
776 }
777 ]
778 },
779 "occupanciesDto": [
780 {
781 "createdBy": "string",
782 "lastModifiedBy": "string",
783 "createdDate": "2019-08-24T14:15:22Z",
784 "lastModifiedDate": "2019-08-24T14:15:22Z",
785 "archived": true,
786 "externalId": "string",
787 "id": 0,
788 "priority": 0,
789 "internalId": 0,
790 "pickListCode": "string",
791 "pickListLabel": "string",
792 "label": "string",
793 "cultureId": 0,
794 "labelDtos": [
795 {
796 "createdBy": "string",
797 "lastModifiedBy": "string",
798 "createdDate": "2019-08-24T14:15:22Z",
799 "lastModifiedDate": "2019-08-24T14:15:22Z",
800 "archived": true,
801 "externalId": "string",
802 "id": 0,
803 "cultureId": 0,
804 "value": "string"
805 }
806 ]
807 }
808 ]
809 },
810 "isTerminationVersion": true
811}
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "isVisibleVendorPortal": true,
285 "isTerminationVersion": true,
286 "terminationDate": "2019-08-24",
287 "penaltyAmount": 0.1
288 },
289 "premiseDto": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "number": "string",
298 "name": "string",
299 "headPremise": true,
300 "possessionDate": "2019-08-24",
301 "openingDate": "2019-08-24",
302 "closingDate": "2019-08-24",
303 "relocationDate": "2019-08-24",
304 "vacatingDate": "2019-08-24",
305 "expansionDate": "2019-08-24",
306 "statusId": 0,
307 "usageId": 0,
308 "parentPremiseId": 0,
309 "costCenterId": 0,
310 "profitCenterId": 0,
311 "legalEntityId": 0,
312 "occupancyIds": [
313 0
314 ],
315 "locationId": 0,
316 "locationDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "number": "string",
325 "name": "string",
326 "storeNumber": "string",
327 "defaultCurrencyId": 0,
328 "defaultMeasureId": 0,
329 "typeId": 0,
330 "qualityId": 0,
331 "propertyTypeId": 0,
332 "categoryId": 0,
333 "statusId": 0,
334 "businessUnitId": 0,
335 "groupIds": [
336 0
337 ],
338 "legalEntityIds": [
339 0
340 ],
341 "defaultCurrency": {
342 "id": 0,
343 "status": "CREATED",
344 "displayId": "string",
345 "erpSystemId": 0,
346 "erpSystemDisplayId": "string",
347 "name": "string",
348 "decimalPoints": 0,
349 "depreciationAreaId": 0
350 },
351 "defaultUnitValue": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "unitId": 0,
360 "unitOfMeasureId": 0,
361 "erpSystemId": 0,
362 "unit": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "unitOfMeasure": {
391 "id": 0,
392 "status": "CREATED",
393 "displayId": "string",
394 "erpSystemId": 0,
395 "erpSystemDisplayId": "string",
396 "name": "string"
397 }
398 },
399 "type": {
400 "createdBy": "string",
401 "lastModifiedBy": "string",
402 "createdDate": "2019-08-24T14:15:22Z",
403 "lastModifiedDate": "2019-08-24T14:15:22Z",
404 "archived": true,
405 "externalId": "string",
406 "id": 0,
407 "priority": 0,
408 "internalId": 0,
409 "pickListCode": "string",
410 "pickListLabel": "string",
411 "label": "string",
412 "cultureId": 0,
413 "labelDtos": [
414 {
415 "createdBy": "string",
416 "lastModifiedBy": "string",
417 "createdDate": "2019-08-24T14:15:22Z",
418 "lastModifiedDate": "2019-08-24T14:15:22Z",
419 "archived": true,
420 "externalId": "string",
421 "id": 0,
422 "cultureId": 0,
423 "value": "string"
424 }
425 ]
426 },
427 "quality": {
428 "createdBy": "string",
429 "lastModifiedBy": "string",
430 "createdDate": "2019-08-24T14:15:22Z",
431 "lastModifiedDate": "2019-08-24T14:15:22Z",
432 "archived": true,
433 "externalId": "string",
434 "id": 0,
435 "priority": 0,
436 "internalId": 0,
437 "pickListCode": "string",
438 "pickListLabel": "string",
439 "label": "string",
440 "cultureId": 0,
441 "labelDtos": [
442 {
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 "cultureId": 0,
451 "value": "string"
452 }
453 ]
454 },
455 "propertyType": {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "priority": 0,
464 "internalId": 0,
465 "pickListCode": "string",
466 "pickListLabel": "string",
467 "label": "string",
468 "cultureId": 0,
469 "labelDtos": [
470 {
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 "cultureId": 0,
479 "value": "string"
480 }
481 ]
482 },
483 "category": {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "priority": 0,
492 "internalId": 0,
493 "pickListCode": "string",
494 "pickListLabel": "string",
495 "label": "string",
496 "cultureId": 0,
497 "labelDtos": [
498 {
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 "cultureId": 0,
507 "value": "string"
508 }
509 ]
510 },
511 "status": {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "priority": 0,
520 "internalId": 0,
521 "pickListCode": "string",
522 "pickListLabel": "string",
523 "label": "string",
524 "cultureId": 0,
525 "labelDtos": [
526 {
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 "cultureId": 0,
535 "value": "string"
536 }
537 ]
538 },
539 "addressDto": {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "street": "string",
548 "civicNumber": "string",
549 "suite": "string",
550 "postalCode": "string",
551 "lon": 0.1,
552 "lat": 0.1,
553 "city": {
554 "createdBy": "string",
555 "lastModifiedBy": "string",
556 "createdDate": "2019-08-24T14:15:22Z",
557 "lastModifiedDate": "2019-08-24T14:15:22Z",
558 "archived": true,
559 "externalId": "string",
560 "id": 0,
561 "name": "string",
562 "province": {
563 "createdBy": "string",
564 "lastModifiedBy": "string",
565 "createdDate": "2019-08-24T14:15:22Z",
566 "lastModifiedDate": "2019-08-24T14:15:22Z",
567 "archived": true,
568 "externalId": "string",
569 "id": 0,
570 "name": "string",
571 "code": "string",
572 "country": {
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 "code": "string"
582 }
583 }
584 },
585 "district": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
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 }
675 },
676 "district": {
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 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 }
717 },
718 "cityId": 0,
719 "districtId": 0
720 }
721 },
722 "status": {
723 "createdBy": "string",
724 "lastModifiedBy": "string",
725 "createdDate": "2019-08-24T14:15:22Z",
726 "lastModifiedDate": "2019-08-24T14:15:22Z",
727 "archived": true,
728 "externalId": "string",
729 "id": 0,
730 "priority": 0,
731 "internalId": 0,
732 "pickListCode": "string",
733 "pickListLabel": "string",
734 "label": "string",
735 "cultureId": 0,
736 "labelDtos": [
737 {
738 "createdBy": "string",
739 "lastModifiedBy": "string",
740 "createdDate": "2019-08-24T14:15:22Z",
741 "lastModifiedDate": "2019-08-24T14:15:22Z",
742 "archived": true,
743 "externalId": "string",
744 "id": 0,
745 "cultureId": 0,
746 "value": "string"
747 }
748 ]
749 },
750 "usage": {
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 "priority": 0,
759 "internalId": 0,
760 "pickListCode": "string",
761 "pickListLabel": "string",
762 "label": "string",
763 "cultureId": 0,
764 "labelDtos": [
765 {
766 "createdBy": "string",
767 "lastModifiedBy": "string",
768 "createdDate": "2019-08-24T14:15:22Z",
769 "lastModifiedDate": "2019-08-24T14:15:22Z",
770 "archived": true,
771 "externalId": "string",
772 "id": 0,
773 "cultureId": 0,
774 "value": "string"
775 }
776 ]
777 },
778 "occupanciesDto": [
779 {
780 "createdBy": "string",
781 "lastModifiedBy": "string",
782 "createdDate": "2019-08-24T14:15:22Z",
783 "lastModifiedDate": "2019-08-24T14:15:22Z",
784 "archived": true,
785 "externalId": "string",
786 "id": 0,
787 "priority": 0,
788 "internalId": 0,
789 "pickListCode": "string",
790 "pickListLabel": "string",
791 "label": "string",
792 "cultureId": 0,
793 "labelDtos": [
794 {
795 "createdBy": "string",
796 "lastModifiedBy": "string",
797 "createdDate": "2019-08-24T14:15:22Z",
798 "lastModifiedDate": "2019-08-24T14:15:22Z",
799 "archived": true,
800 "externalId": "string",
801 "id": 0,
802 "cultureId": 0,
803 "value": "string"
804 }
805 ]
806 }
807 ]
808 },
809 "isTerminationVersion": true
810}
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 |
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. |
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. |
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. |
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 |
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 "provisioningFrequencyName": "string",
28 "accountingApproved": true,
29 "indexationType": "string",
30 "cpiGlobalCategoryId": 0,
31 "indexationReferenceDate": "2019-08-24",
32 "currentIndexLevel": 0.1,
33 "conditionallyIndexed": true,
34 "applicableCurrentIndexLevel": 0.1,
35 "indexLevelPercentageChangeLowerBound": 0.1,
36 "indexLevelPercentageChangeUpperBound": 0.1,
37 "indexationTypeNonLease": "string",
38 "cpiGlobalCategoryIdNonLease": 0,
39 "indexationReferenceDateNonLease": "2019-08-24",
40 "currentIndexLevelNonLease": 0.1,
41 "conditionallyIndexedNonLease": true,
42 "applicableCurrentIndexLevelNonLease": 0.1,
43 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
44 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
45 "signatureDate": "2019-08-24",
46 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "version": {
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 "modificationDate": "2019-08-24",
170 "updateContractRate": true,
171 "leaseEvent": {
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 "typeId": 0,
180 "code": "string",
181 "reviewedBy": "string",
182 "reviewedDate": "2019-08-24",
183 "reviewedStatusId": 0,
184 "activityDate": "2019-08-24",
185 "relatedPickListOptionId": 0,
186 "detail": "string",
187 "note": {
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 "message": "string",
196 "preserveOriginalAudit": true,
197 "originalCreatedBy": "string",
198 "originalCreatedDate": "2019-08-24T14:15:22Z",
199 "originalLastModifiedBy": "string",
200 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
201 },
202 "type": {
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 "priority": 0,
211 "internalId": 0,
212 "pickListCode": "string",
213 "pickListLabel": "string",
214 "label": "string",
215 "cultureId": 0,
216 "labelDtos": [
217 {
218 "createdBy": "string",
219 "lastModifiedBy": "string",
220 "createdDate": "2019-08-24T14:15:22Z",
221 "lastModifiedDate": "2019-08-24T14:15:22Z",
222 "archived": true,
223 "externalId": "string",
224 "id": 0,
225 "cultureId": 0,
226 "value": "string"
227 }
228 ]
229 },
230 "reviewedStatus": {
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 "priority": 0,
239 "internalId": 0,
240 "pickListCode": "string",
241 "pickListLabel": "string",
242 "label": "string",
243 "cultureId": 0,
244 "labelDtos": [
245 {
246 "createdBy": "string",
247 "lastModifiedBy": "string",
248 "createdDate": "2019-08-24T14:15:22Z",
249 "lastModifiedDate": "2019-08-24T14:15:22Z",
250 "archived": true,
251 "externalId": "string",
252 "id": 0,
253 "cultureId": 0,
254 "value": "string"
255 }
256 ]
257 },
258 "relatedPickListOption": {
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 "priority": 0,
267 "internalId": 0,
268 "pickListCode": "string",
269 "pickListLabel": "string",
270 "label": "string",
271 "cultureId": 0,
272 "labelDtos": [
273 {
274 "createdBy": "string",
275 "lastModifiedBy": "string",
276 "createdDate": "2019-08-24T14:15:22Z",
277 "lastModifiedDate": "2019-08-24T14:15:22Z",
278 "archived": true,
279 "externalId": "string",
280 "id": 0,
281 "cultureId": 0,
282 "value": "string"
283 }
284 ]
285 }
286 },
287 "isVisibleVendorPortal": true,
288 "isTerminationVersion": true,
289 "terminationDate": "2019-08-24",
290 "penaltyAmount": 0.1
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 }
587 },
588 "district": {
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 "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 }
618 }
619 },
620 "cityId": 0,
621 "districtId": 0
622 },
623 "secondAddressDto": {
624 "createdBy": "string",
625 "lastModifiedBy": "string",
626 "createdDate": "2019-08-24T14:15:22Z",
627 "lastModifiedDate": "2019-08-24T14:15:22Z",
628 "archived": true,
629 "externalId": "string",
630 "id": 0,
631 "street": "string",
632 "civicNumber": "string",
633 "suite": "string",
634 "postalCode": "string",
635 "lon": 0.1,
636 "lat": 0.1,
637 "city": {
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 "name": "string",
646 "province": {
647 "createdBy": "string",
648 "lastModifiedBy": "string",
649 "createdDate": "2019-08-24T14:15:22Z",
650 "lastModifiedDate": "2019-08-24T14:15:22Z",
651 "archived": true,
652 "externalId": "string",
653 "id": 0,
654 "name": "string",
655 "code": "string",
656 "country": {
657 "createdBy": "string",
658 "lastModifiedBy": "string",
659 "createdDate": "2019-08-24T14:15:22Z",
660 "lastModifiedDate": "2019-08-24T14:15:22Z",
661 "archived": true,
662 "externalId": "string",
663 "id": 0,
664 "name": "string",
665 "code": "string"
666 }
667 }
668 },
669 "district": {
670 "createdBy": "string",
671 "lastModifiedBy": "string",
672 "createdDate": "2019-08-24T14:15:22Z",
673 "lastModifiedDate": "2019-08-24T14:15:22Z",
674 "archived": true,
675 "externalId": "string",
676 "id": 0,
677 "name": "string",
678 "city": {
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 "province": {
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 "code": "string",
697 "country": {}
698 }
699 }
700 },
701 "cityId": 0,
702 "districtId": 0
703 }
704 },
705 "status": {
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 "priority": 0,
714 "internalId": 0,
715 "pickListCode": "string",
716 "pickListLabel": "string",
717 "label": "string",
718 "cultureId": 0,
719 "labelDtos": [
720 {
721 "createdBy": "string",
722 "lastModifiedBy": "string",
723 "createdDate": "2019-08-24T14:15:22Z",
724 "lastModifiedDate": "2019-08-24T14:15:22Z",
725 "archived": true,
726 "externalId": "string",
727 "id": 0,
728 "cultureId": 0,
729 "value": "string"
730 }
731 ]
732 },
733 "usage": {
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 "occupanciesDto": [
762 {
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 ]
791 },
792 "isTerminationVersion": true
793 }
794 ]
795 },
796 "page": {
797 "size": 0,
798 "totalElements": 0,
799 "totalPages": 0,
800 "number": 0
801 }
802}
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 "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 },
285 "scenario": true,
286 "isVisibleVendorPortal": true,
287 "isTerminationVersion": true,
288 "terminationDate": "2019-08-24",
289 "penaltyAmount": 0.1
290 },
291 "premiseDto": {
292 "createdBy": "string",
293 "lastModifiedBy": "string",
294 "createdDate": "2019-08-24T14:15:22Z",
295 "lastModifiedDate": "2019-08-24T14:15:22Z",
296 "archived": true,
297 "externalId": "string",
298 "id": 0,
299 "number": "string",
300 "name": "string",
301 "headPremise": true,
302 "possessionDate": "2019-08-24",
303 "openingDate": "2019-08-24",
304 "closingDate": "2019-08-24",
305 "relocationDate": "2019-08-24",
306 "vacatingDate": "2019-08-24",
307 "expansionDate": "2019-08-24",
308 "statusId": 0,
309 "usageId": 0,
310 "parentPremiseId": 0,
311 "costCenterId": 0,
312 "profitCenterId": 0,
313 "legalEntityId": 0,
314 "occupancyIds": [
315 0
316 ],
317 "locationId": 0,
318 "locationDto": {
319 "createdBy": "string",
320 "lastModifiedBy": "string",
321 "createdDate": "2019-08-24T14:15:22Z",
322 "lastModifiedDate": "2019-08-24T14:15:22Z",
323 "archived": true,
324 "externalId": "string",
325 "id": 0,
326 "number": "string",
327 "name": "string",
328 "storeNumber": "string",
329 "defaultCurrencyId": 0,
330 "defaultMeasureId": 0,
331 "typeId": 0,
332 "qualityId": 0,
333 "propertyTypeId": 0,
334 "categoryId": 0,
335 "statusId": 0,
336 "businessUnitId": 0,
337 "groupIds": [
338 0
339 ],
340 "legalEntityIds": [
341 0
342 ],
343 "defaultCurrency": {
344 "id": 0,
345 "status": "CREATED",
346 "displayId": "string",
347 "erpSystemId": 0,
348 "erpSystemDisplayId": "string",
349 "name": "string",
350 "decimalPoints": 0,
351 "depreciationAreaId": 0
352 },
353 "defaultUnitValue": {
354 "createdBy": "string",
355 "lastModifiedBy": "string",
356 "createdDate": "2019-08-24T14:15:22Z",
357 "lastModifiedDate": "2019-08-24T14:15:22Z",
358 "archived": true,
359 "externalId": "string",
360 "id": 0,
361 "unitId": 0,
362 "unitOfMeasureId": 0,
363 "erpSystemId": 0,
364 "unit": {
365 "createdBy": "string",
366 "lastModifiedBy": "string",
367 "createdDate": "2019-08-24T14:15:22Z",
368 "lastModifiedDate": "2019-08-24T14:15:22Z",
369 "archived": true,
370 "externalId": "string",
371 "id": 0,
372 "priority": 0,
373 "internalId": 0,
374 "pickListCode": "string",
375 "pickListLabel": "string",
376 "label": "string",
377 "cultureId": 0,
378 "labelDtos": [
379 {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "cultureId": 0,
388 "value": "string"
389 }
390 ]
391 },
392 "unitOfMeasure": {
393 "id": 0,
394 "status": "CREATED",
395 "displayId": "string",
396 "erpSystemId": 0,
397 "erpSystemDisplayId": "string",
398 "name": "string"
399 }
400 },
401 "type": {
402 "createdBy": "string",
403 "lastModifiedBy": "string",
404 "createdDate": "2019-08-24T14:15:22Z",
405 "lastModifiedDate": "2019-08-24T14:15:22Z",
406 "archived": true,
407 "externalId": "string",
408 "id": 0,
409 "priority": 0,
410 "internalId": 0,
411 "pickListCode": "string",
412 "pickListLabel": "string",
413 "label": "string",
414 "cultureId": 0,
415 "labelDtos": [
416 {
417 "createdBy": "string",
418 "lastModifiedBy": "string",
419 "createdDate": "2019-08-24T14:15:22Z",
420 "lastModifiedDate": "2019-08-24T14:15:22Z",
421 "archived": true,
422 "externalId": "string",
423 "id": 0,
424 "cultureId": 0,
425 "value": "string"
426 }
427 ]
428 },
429 "quality": {
430 "createdBy": "string",
431 "lastModifiedBy": "string",
432 "createdDate": "2019-08-24T14:15:22Z",
433 "lastModifiedDate": "2019-08-24T14:15:22Z",
434 "archived": true,
435 "externalId": "string",
436 "id": 0,
437 "priority": 0,
438 "internalId": 0,
439 "pickListCode": "string",
440 "pickListLabel": "string",
441 "label": "string",
442 "cultureId": 0,
443 "labelDtos": [
444 {
445 "createdBy": "string",
446 "lastModifiedBy": "string",
447 "createdDate": "2019-08-24T14:15:22Z",
448 "lastModifiedDate": "2019-08-24T14:15:22Z",
449 "archived": true,
450 "externalId": "string",
451 "id": 0,
452 "cultureId": 0,
453 "value": "string"
454 }
455 ]
456 },
457 "propertyType": {
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 "priority": 0,
466 "internalId": 0,
467 "pickListCode": "string",
468 "pickListLabel": "string",
469 "label": "string",
470 "cultureId": 0,
471 "labelDtos": [
472 {
473 "createdBy": "string",
474 "lastModifiedBy": "string",
475 "createdDate": "2019-08-24T14:15:22Z",
476 "lastModifiedDate": "2019-08-24T14:15:22Z",
477 "archived": true,
478 "externalId": "string",
479 "id": 0,
480 "cultureId": 0,
481 "value": "string"
482 }
483 ]
484 },
485 "category": {
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 "priority": 0,
494 "internalId": 0,
495 "pickListCode": "string",
496 "pickListLabel": "string",
497 "label": "string",
498 "cultureId": 0,
499 "labelDtos": [
500 {
501 "createdBy": "string",
502 "lastModifiedBy": "string",
503 "createdDate": "2019-08-24T14:15:22Z",
504 "lastModifiedDate": "2019-08-24T14:15:22Z",
505 "archived": true,
506 "externalId": "string",
507 "id": 0,
508 "cultureId": 0,
509 "value": "string"
510 }
511 ]
512 },
513 "status": {
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 "priority": 0,
522 "internalId": 0,
523 "pickListCode": "string",
524 "pickListLabel": "string",
525 "label": "string",
526 "cultureId": 0,
527 "labelDtos": [
528 {
529 "createdBy": "string",
530 "lastModifiedBy": "string",
531 "createdDate": "2019-08-24T14:15:22Z",
532 "lastModifiedDate": "2019-08-24T14:15:22Z",
533 "archived": true,
534 "externalId": "string",
535 "id": 0,
536 "cultureId": 0,
537 "value": "string"
538 }
539 ]
540 },
541 "addressDto": {
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 "street": "string",
550 "civicNumber": "string",
551 "suite": "string",
552 "postalCode": "string",
553 "lon": 0.1,
554 "lat": 0.1,
555 "city": {
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 "name": "string",
564 "province": {
565 "createdBy": "string",
566 "lastModifiedBy": "string",
567 "createdDate": "2019-08-24T14:15:22Z",
568 "lastModifiedDate": "2019-08-24T14:15:22Z",
569 "archived": true,
570 "externalId": "string",
571 "id": 0,
572 "name": "string",
573 "code": "string",
574 "country": {
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 "name": "string",
583 "code": "string"
584 }
585 }
586 },
587 "district": {
588 "createdBy": "string",
589 "lastModifiedBy": "string",
590 "createdDate": "2019-08-24T14:15:22Z",
591 "lastModifiedDate": "2019-08-24T14:15:22Z",
592 "archived": true,
593 "externalId": "string",
594 "id": 0,
595 "name": "string",
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 }
627 }
628 },
629 "cityId": 0,
630 "districtId": 0
631 },
632 "secondAddressDto": {
633 "createdBy": "string",
634 "lastModifiedBy": "string",
635 "createdDate": "2019-08-24T14:15:22Z",
636 "lastModifiedDate": "2019-08-24T14:15:22Z",
637 "archived": true,
638 "externalId": "string",
639 "id": 0,
640 "street": "string",
641 "civicNumber": "string",
642 "suite": "string",
643 "postalCode": "string",
644 "lon": 0.1,
645 "lat": 0.1,
646 "city": {
647 "createdBy": "string",
648 "lastModifiedBy": "string",
649 "createdDate": "2019-08-24T14:15:22Z",
650 "lastModifiedDate": "2019-08-24T14:15:22Z",
651 "archived": true,
652 "externalId": "string",
653 "id": 0,
654 "name": "string",
655 "province": {
656 "createdBy": "string",
657 "lastModifiedBy": "string",
658 "createdDate": "2019-08-24T14:15:22Z",
659 "lastModifiedDate": "2019-08-24T14:15:22Z",
660 "archived": true,
661 "externalId": "string",
662 "id": 0,
663 "name": "string",
664 "code": "string",
665 "country": {
666 "createdBy": "string",
667 "lastModifiedBy": "string",
668 "createdDate": "2019-08-24T14:15:22Z",
669 "lastModifiedDate": "2019-08-24T14:15:22Z",
670 "archived": true,
671 "externalId": "string",
672 "id": 0,
673 "name": "string",
674 "code": "string"
675 }
676 }
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 "createdBy": "string",
708 "lastModifiedBy": "string",
709 "createdDate": "2019-08-24T14:15:22Z",
710 "lastModifiedDate": "2019-08-24T14:15:22Z",
711 "archived": true,
712 "externalId": "string",
713 "id": 0,
714 "name": "string",
715 "code": "string"
716 }
717 }
718 }
719 },
720 "cityId": 0,
721 "districtId": 0
722 }
723 },
724 "status": {
725 "createdBy": "string",
726 "lastModifiedBy": "string",
727 "createdDate": "2019-08-24T14:15:22Z",
728 "lastModifiedDate": "2019-08-24T14:15:22Z",
729 "archived": true,
730 "externalId": "string",
731 "id": 0,
732 "priority": 0,
733 "internalId": 0,
734 "pickListCode": "string",
735 "pickListLabel": "string",
736 "label": "string",
737 "cultureId": 0,
738 "labelDtos": [
739 {
740 "createdBy": "string",
741 "lastModifiedBy": "string",
742 "createdDate": "2019-08-24T14:15:22Z",
743 "lastModifiedDate": "2019-08-24T14:15:22Z",
744 "archived": true,
745 "externalId": "string",
746 "id": 0,
747 "cultureId": 0,
748 "value": "string"
749 }
750 ]
751 },
752 "usage": {
753 "createdBy": "string",
754 "lastModifiedBy": "string",
755 "createdDate": "2019-08-24T14:15:22Z",
756 "lastModifiedDate": "2019-08-24T14:15:22Z",
757 "archived": true,
758 "externalId": "string",
759 "id": 0,
760 "priority": 0,
761 "internalId": 0,
762 "pickListCode": "string",
763 "pickListLabel": "string",
764 "label": "string",
765 "cultureId": 0,
766 "labelDtos": [
767 {
768 "createdBy": "string",
769 "lastModifiedBy": "string",
770 "createdDate": "2019-08-24T14:15:22Z",
771 "lastModifiedDate": "2019-08-24T14:15:22Z",
772 "archived": true,
773 "externalId": "string",
774 "id": 0,
775 "cultureId": 0,
776 "value": "string"
777 }
778 ]
779 },
780 "occupanciesDto": [
781 {
782 "createdBy": "string",
783 "lastModifiedBy": "string",
784 "createdDate": "2019-08-24T14:15:22Z",
785 "lastModifiedDate": "2019-08-24T14:15:22Z",
786 "archived": true,
787 "externalId": "string",
788 "id": 0,
789 "priority": 0,
790 "internalId": 0,
791 "pickListCode": "string",
792 "pickListLabel": "string",
793 "label": "string",
794 "cultureId": 0,
795 "labelDtos": [
796 {
797 "createdBy": "string",
798 "lastModifiedBy": "string",
799 "createdDate": "2019-08-24T14:15:22Z",
800 "lastModifiedDate": "2019-08-24T14:15:22Z",
801 "archived": true,
802 "externalId": "string",
803 "id": 0,
804 "cultureId": 0,
805 "value": "string"
806 }
807 ]
808 }
809 ]
810 },
811 "isTerminationVersion": true
812 }
813]
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 "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 },
285 "isVisibleVendorPortal": true,
286 "isTerminationVersion": true,
287 "terminationDate": "2019-08-24",
288 "penaltyAmount": 0.1
289 },
290 "premiseDto": {
291 "createdBy": "string",
292 "lastModifiedBy": "string",
293 "createdDate": "2019-08-24T14:15:22Z",
294 "lastModifiedDate": "2019-08-24T14:15:22Z",
295 "archived": true,
296 "externalId": "string",
297 "id": 0,
298 "number": "string",
299 "name": "string",
300 "headPremise": true,
301 "possessionDate": "2019-08-24",
302 "openingDate": "2019-08-24",
303 "closingDate": "2019-08-24",
304 "relocationDate": "2019-08-24",
305 "vacatingDate": "2019-08-24",
306 "expansionDate": "2019-08-24",
307 "statusId": 0,
308 "usageId": 0,
309 "parentPremiseId": 0,
310 "costCenterId": 0,
311 "profitCenterId": 0,
312 "legalEntityId": 0,
313 "occupancyIds": [
314 0
315 ],
316 "locationId": 0,
317 "locationDto": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "number": "string",
326 "name": "string",
327 "storeNumber": "string",
328 "defaultCurrencyId": 0,
329 "defaultMeasureId": 0,
330 "typeId": 0,
331 "qualityId": 0,
332 "propertyTypeId": 0,
333 "categoryId": 0,
334 "statusId": 0,
335 "businessUnitId": 0,
336 "groupIds": [
337 0
338 ],
339 "legalEntityIds": [
340 0
341 ],
342 "defaultCurrency": {
343 "id": 0,
344 "status": "CREATED",
345 "displayId": "string",
346 "erpSystemId": 0,
347 "erpSystemDisplayId": "string",
348 "name": "string",
349 "decimalPoints": 0,
350 "depreciationAreaId": 0
351 },
352 "defaultUnitValue": {
353 "createdBy": "string",
354 "lastModifiedBy": "string",
355 "createdDate": "2019-08-24T14:15:22Z",
356 "lastModifiedDate": "2019-08-24T14:15:22Z",
357 "archived": true,
358 "externalId": "string",
359 "id": 0,
360 "unitId": 0,
361 "unitOfMeasureId": 0,
362 "erpSystemId": 0,
363 "unit": {
364 "createdBy": "string",
365 "lastModifiedBy": "string",
366 "createdDate": "2019-08-24T14:15:22Z",
367 "lastModifiedDate": "2019-08-24T14:15:22Z",
368 "archived": true,
369 "externalId": "string",
370 "id": 0,
371 "priority": 0,
372 "internalId": 0,
373 "pickListCode": "string",
374 "pickListLabel": "string",
375 "label": "string",
376 "cultureId": 0,
377 "labelDtos": [
378 {
379 "createdBy": "string",
380 "lastModifiedBy": "string",
381 "createdDate": "2019-08-24T14:15:22Z",
382 "lastModifiedDate": "2019-08-24T14:15:22Z",
383 "archived": true,
384 "externalId": "string",
385 "id": 0,
386 "cultureId": 0,
387 "value": "string"
388 }
389 ]
390 },
391 "unitOfMeasure": {
392 "id": 0,
393 "status": "CREATED",
394 "displayId": "string",
395 "erpSystemId": 0,
396 "erpSystemDisplayId": "string",
397 "name": "string"
398 }
399 },
400 "type": {
401 "createdBy": "string",
402 "lastModifiedBy": "string",
403 "createdDate": "2019-08-24T14:15:22Z",
404 "lastModifiedDate": "2019-08-24T14:15:22Z",
405 "archived": true,
406 "externalId": "string",
407 "id": 0,
408 "priority": 0,
409 "internalId": 0,
410 "pickListCode": "string",
411 "pickListLabel": "string",
412 "label": "string",
413 "cultureId": 0,
414 "labelDtos": [
415 {
416 "createdBy": "string",
417 "lastModifiedBy": "string",
418 "createdDate": "2019-08-24T14:15:22Z",
419 "lastModifiedDate": "2019-08-24T14:15:22Z",
420 "archived": true,
421 "externalId": "string",
422 "id": 0,
423 "cultureId": 0,
424 "value": "string"
425 }
426 ]
427 },
428 "quality": {
429 "createdBy": "string",
430 "lastModifiedBy": "string",
431 "createdDate": "2019-08-24T14:15:22Z",
432 "lastModifiedDate": "2019-08-24T14:15:22Z",
433 "archived": true,
434 "externalId": "string",
435 "id": 0,
436 "priority": 0,
437 "internalId": 0,
438 "pickListCode": "string",
439 "pickListLabel": "string",
440 "label": "string",
441 "cultureId": 0,
442 "labelDtos": [
443 {
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 "cultureId": 0,
452 "value": "string"
453 }
454 ]
455 },
456 "propertyType": {
457 "createdBy": "string",
458 "lastModifiedBy": "string",
459 "createdDate": "2019-08-24T14:15:22Z",
460 "lastModifiedDate": "2019-08-24T14:15:22Z",
461 "archived": true,
462 "externalId": "string",
463 "id": 0,
464 "priority": 0,
465 "internalId": 0,
466 "pickListCode": "string",
467 "pickListLabel": "string",
468 "label": "string",
469 "cultureId": 0,
470 "labelDtos": [
471 {
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 "cultureId": 0,
480 "value": "string"
481 }
482 ]
483 },
484 "category": {
485 "createdBy": "string",
486 "lastModifiedBy": "string",
487 "createdDate": "2019-08-24T14:15:22Z",
488 "lastModifiedDate": "2019-08-24T14:15:22Z",
489 "archived": true,
490 "externalId": "string",
491 "id": 0,
492 "priority": 0,
493 "internalId": 0,
494 "pickListCode": "string",
495 "pickListLabel": "string",
496 "label": "string",
497 "cultureId": 0,
498 "labelDtos": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "cultureId": 0,
508 "value": "string"
509 }
510 ]
511 },
512 "status": {
513 "createdBy": "string",
514 "lastModifiedBy": "string",
515 "createdDate": "2019-08-24T14:15:22Z",
516 "lastModifiedDate": "2019-08-24T14:15:22Z",
517 "archived": true,
518 "externalId": "string",
519 "id": 0,
520 "priority": 0,
521 "internalId": 0,
522 "pickListCode": "string",
523 "pickListLabel": "string",
524 "label": "string",
525 "cultureId": 0,
526 "labelDtos": [
527 {
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 "cultureId": 0,
536 "value": "string"
537 }
538 ]
539 },
540 "addressDto": {
541 "createdBy": "string",
542 "lastModifiedBy": "string",
543 "createdDate": "2019-08-24T14:15:22Z",
544 "lastModifiedDate": "2019-08-24T14:15:22Z",
545 "archived": true,
546 "externalId": "string",
547 "id": 0,
548 "street": "string",
549 "civicNumber": "string",
550 "suite": "string",
551 "postalCode": "string",
552 "lon": 0.1,
553 "lat": 0.1,
554 "city": {
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 "name": "string",
563 "province": {
564 "createdBy": "string",
565 "lastModifiedBy": "string",
566 "createdDate": "2019-08-24T14:15:22Z",
567 "lastModifiedDate": "2019-08-24T14:15:22Z",
568 "archived": true,
569 "externalId": "string",
570 "id": 0,
571 "name": "string",
572 "code": "string",
573 "country": {
574 "createdBy": "string",
575 "lastModifiedBy": "string",
576 "createdDate": "2019-08-24T14:15:22Z",
577 "lastModifiedDate": "2019-08-24T14:15:22Z",
578 "archived": true,
579 "externalId": "string",
580 "id": 0,
581 "name": "string",
582 "code": "string"
583 }
584 }
585 },
586 "district": {
587 "createdBy": "string",
588 "lastModifiedBy": "string",
589 "createdDate": "2019-08-24T14:15:22Z",
590 "lastModifiedDate": "2019-08-24T14:15:22Z",
591 "archived": true,
592 "externalId": "string",
593 "id": 0,
594 "name": "string",
595 "city": {
596 "createdBy": "string",
597 "lastModifiedBy": "string",
598 "createdDate": "2019-08-24T14:15:22Z",
599 "lastModifiedDate": "2019-08-24T14:15:22Z",
600 "archived": true,
601 "externalId": "string",
602 "id": 0,
603 "name": "string",
604 "province": {
605 "createdBy": "string",
606 "lastModifiedBy": "string",
607 "createdDate": "2019-08-24T14:15:22Z",
608 "lastModifiedDate": "2019-08-24T14:15:22Z",
609 "archived": true,
610 "externalId": "string",
611 "id": 0,
612 "name": "string",
613 "code": "string",
614 "country": {
615 "createdBy": "string",
616 "lastModifiedBy": "string",
617 "createdDate": "2019-08-24T14:15:22Z",
618 "lastModifiedDate": "2019-08-24T14:15:22Z",
619 "archived": true,
620 "externalId": "string",
621 "id": 0,
622 "name": "string",
623 "code": "string"
624 }
625 }
626 }
627 },
628 "cityId": 0,
629 "districtId": 0
630 },
631 "secondAddressDto": {
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 "street": "string",
640 "civicNumber": "string",
641 "suite": "string",
642 "postalCode": "string",
643 "lon": 0.1,
644 "lat": 0.1,
645 "city": {
646 "createdBy": "string",
647 "lastModifiedBy": "string",
648 "createdDate": "2019-08-24T14:15:22Z",
649 "lastModifiedDate": "2019-08-24T14:15:22Z",
650 "archived": true,
651 "externalId": "string",
652 "id": 0,
653 "name": "string",
654 "province": {
655 "createdBy": "string",
656 "lastModifiedBy": "string",
657 "createdDate": "2019-08-24T14:15:22Z",
658 "lastModifiedDate": "2019-08-24T14:15:22Z",
659 "archived": true,
660 "externalId": "string",
661 "id": 0,
662 "name": "string",
663 "code": "string",
664 "country": {
665 "createdBy": "string",
666 "lastModifiedBy": "string",
667 "createdDate": "2019-08-24T14:15:22Z",
668 "lastModifiedDate": "2019-08-24T14:15:22Z",
669 "archived": true,
670 "externalId": "string",
671 "id": 0,
672 "name": "string",
673 "code": "string"
674 }
675 }
676 },
677 "district": {
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 "name": "string",
686 "city": {
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 "province": {
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 "code": "string",
705 "country": {
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 }
716 }
717 }
718 },
719 "cityId": 0,
720 "districtId": 0
721 }
722 },
723 "status": {
724 "createdBy": "string",
725 "lastModifiedBy": "string",
726 "createdDate": "2019-08-24T14:15:22Z",
727 "lastModifiedDate": "2019-08-24T14:15:22Z",
728 "archived": true,
729 "externalId": "string",
730 "id": 0,
731 "priority": 0,
732 "internalId": 0,
733 "pickListCode": "string",
734 "pickListLabel": "string",
735 "label": "string",
736 "cultureId": 0,
737 "labelDtos": [
738 {
739 "createdBy": "string",
740 "lastModifiedBy": "string",
741 "createdDate": "2019-08-24T14:15:22Z",
742 "lastModifiedDate": "2019-08-24T14:15:22Z",
743 "archived": true,
744 "externalId": "string",
745 "id": 0,
746 "cultureId": 0,
747 "value": "string"
748 }
749 ]
750 },
751 "usage": {
752 "createdBy": "string",
753 "lastModifiedBy": "string",
754 "createdDate": "2019-08-24T14:15:22Z",
755 "lastModifiedDate": "2019-08-24T14:15:22Z",
756 "archived": true,
757 "externalId": "string",
758 "id": 0,
759 "priority": 0,
760 "internalId": 0,
761 "pickListCode": "string",
762 "pickListLabel": "string",
763 "label": "string",
764 "cultureId": 0,
765 "labelDtos": [
766 {
767 "createdBy": "string",
768 "lastModifiedBy": "string",
769 "createdDate": "2019-08-24T14:15:22Z",
770 "lastModifiedDate": "2019-08-24T14:15:22Z",
771 "archived": true,
772 "externalId": "string",
773 "id": 0,
774 "cultureId": 0,
775 "value": "string"
776 }
777 ]
778 },
779 "occupanciesDto": [
780 {
781 "createdBy": "string",
782 "lastModifiedBy": "string",
783 "createdDate": "2019-08-24T14:15:22Z",
784 "lastModifiedDate": "2019-08-24T14:15:22Z",
785 "archived": true,
786 "externalId": "string",
787 "id": 0,
788 "priority": 0,
789 "internalId": 0,
790 "pickListCode": "string",
791 "pickListLabel": "string",
792 "label": "string",
793 "cultureId": 0,
794 "labelDtos": [
795 {
796 "createdBy": "string",
797 "lastModifiedBy": "string",
798 "createdDate": "2019-08-24T14:15:22Z",
799 "lastModifiedDate": "2019-08-24T14:15:22Z",
800 "archived": true,
801 "externalId": "string",
802 "id": 0,
803 "cultureId": 0,
804 "value": "string"
805 }
806 ]
807 }
808 ]
809 },
810 "isTerminationVersion": true
811 }
812]
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 |
Text value for terminatingLease in LeaseDto |
» maximumDateTo |
string(date) |
false |
none |
Text value for maximumDateTo in LeaseDto |
» number |
string |
false |
none |
Text value for number in LeaseDto |
» 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 |
Text value for registrationNumber in LeaseDto |
» 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 |
» 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 |
Text value for indexationTypeNonLease in LeaseDto |
» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
» indexationReferenceDateNonLease |
string(date) |
false |
none |
Text value for indexationReferenceDateNonLease in LeaseDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Text value for reviewedBy in EventDto |
»»» 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 |
Text value for detail in EventDto |
»»» 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 |
Text value for message in Note |
»»»» preserveOriginalAudit |
boolean |
false |
none |
none |
»»»» originalCreatedBy |
string |
false |
none |
none |
»»»» originalCreatedDate |
string(date-time) |
false |
none |
none |
»»»» originalLastModifiedBy |
string |
false |
none |
none |
»»»» originalLastModifiedDate |
string(date-time) |
false |
none |
none |
»»» 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. |
|
»» 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 |
» 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 |
Text value for number in PremiseDto |
»» 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 |
Text value for number in LocationDto |
»»» name |
string |
true |
none |
Name of the resource |
»»» storeNumber |
string |
true |
none |
Text value for storeNumber in LocationDto |
»»» 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 |
Text value for street in AddressDto |
»»»» civicNumber |
string |
false |
none |
Text value for civicNumber in AddressDto |
»»»» suite |
string |
false |
none |
Text value for suite in AddressDto |
»»»» 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 |
»»»» 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 |
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}
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 |
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 |
Text value for delimitedArguments in CpiLeaseIndexationResultDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Text value for cpiGlobalReferenceDateNonLease in CpiIndexationPlanDto |
»» 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 |
Text value for indexationDateLease in CpiIndexationPlanDto |
»» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
»» indexationDateNonLease |
string(date) |
false |
none |
Text value for indexationDateNonLease in CpiIndexationPlanDto |
»» executionDate |
string(date) |
false |
none |
Date of the execution |
»» executedModificationDate |
string(date) |
false |
none |
Date of the executed modification |
»» executedIndexationDateLease |
string(date) |
false |
none |
Text value for executedIndexationDateLease in CpiIndexationPlanDto |
»» executedIndexationDateNonLease |
string(date) |
false |
none |
Text value for executedIndexationDateNonLease in CpiIndexationPlanDto |
»» messageCode |
string |
false |
none |
Code for the message |
»» messageCodeIndexationDateLease |
string |
false |
none |
Text value for messageCodeIndexationDateLease in CpiIndexationPlanDto |
»» messageCodeIndexationDateNonLease |
string |
false |
none |
Text value for messageCodeIndexationDateNonLease in CpiIndexationPlanDto |
»» 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 |
Text value for message in CpiIndexationPlanDto |
»» messageIndexationDateLease |
string |
false |
none |
Text value for messageIndexationDateLease in CpiIndexationPlanDto |
»» messageIndexationDateNonLease |
string |
false |
none |
Text value for messageIndexationDateNonLease in CpiIndexationPlanDto |
»» 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 |
Text value for country in ConsumerPriceIndexCategoryDto |
»»» province |
string |
true |
none |
Text value for province in ConsumerPriceIndexCategoryDto |
»»» city |
string |
true |
none |
Text value for city in ConsumerPriceIndexCategoryDto |
»»» consumerPriceIndexSourceType |
string |
true |
none |
Type of the consumer price index source |
»»» source |
string |
true |
none |
Text value for source in ConsumerPriceIndexCategoryDto |
»»» formula |
string |
false |
none |
Text value for formula in ConsumerPriceIndexCategoryDto |
»»» 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 |
Text value for desiredIndexationDateLease in CpiLeaseIndexationPreviewDto |
»» actualIndexationDateLease |
string(date) |
false |
none |
Text value for actualIndexationDateLease in CpiLeaseIndexationPreviewDto |
»» desiredIndexationDateNonLease |
string(date) |
false |
none |
Text value for desiredIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
»» actualIndexationDateNonLease |
string(date) |
false |
none |
Text value for actualIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
»» messageCode |
string |
false |
none |
Code for the message |
»» delimitedArguments |
string |
false |
none |
Text value for delimitedArguments in CpiLeaseIndexationPreviewDto |
»» messageCodeIndexationDateLease |
string |
false |
none |
Text value for messageCodeIndexationDateLease in CpiLeaseIndexationPreviewDto |
»» messageCodeIndexationDateNonLease |
string |
false |
none |
Text value for messageCodeIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
»» 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 |
Text value for message in CpiLeaseIndexationPreviewDto |
»» messageIndexationDateLease |
string |
false |
none |
Text value for messageIndexationDateLease in CpiLeaseIndexationPreviewDto |
»» messageIndexationDateNonLease |
string |
false |
none |
Text value for messageIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
» message |
string |
false |
none |
Text value for message in CpiLeaseIndexationResultDto |
Enumerated Values
Attribute |
Value |
|---|---|
consumerPriceIndexSourceType |
EXCEL, WEB |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
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}
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 |
Text value for link in DocumentDto |
»» 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 |
Text value for value in LabelDto |
»» 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}
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}
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 |
Text value for cpiGlobalReferenceDateNonLease in CpiIndexationPlanDto |
» 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 |
Text value for indexationDateLease in CpiIndexationPlanDto |
» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
» indexationDateNonLease |
string(date) |
false |
none |
Text value for indexationDateNonLease in CpiIndexationPlanDto |
» executionDate |
string(date) |
false |
none |
Date of the execution |
» executedModificationDate |
string(date) |
false |
none |
Date of the executed modification |
» executedIndexationDateLease |
string(date) |
false |
none |
Text value for executedIndexationDateLease in CpiIndexationPlanDto |
» executedIndexationDateNonLease |
string(date) |
false |
none |
Text value for executedIndexationDateNonLease in CpiIndexationPlanDto |
» messageCode |
string |
false |
none |
Code for the message |
» messageCodeIndexationDateLease |
string |
false |
none |
Text value for messageCodeIndexationDateLease in CpiIndexationPlanDto |
» messageCodeIndexationDateNonLease |
string |
false |
none |
Text value for messageCodeIndexationDateNonLease in CpiIndexationPlanDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Text value for message in CpiIndexationPlanDto |
» messageIndexationDateLease |
string |
false |
none |
Text value for messageIndexationDateLease in CpiIndexationPlanDto |
» messageIndexationDateNonLease |
string |
false |
none |
Text value for messageIndexationDateNonLease in CpiIndexationPlanDto |
» 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 |
Text value for country in ConsumerPriceIndexCategoryDto |
»» province |
string |
true |
none |
Text value for province in ConsumerPriceIndexCategoryDto |
»» city |
string |
true |
none |
Text value for city in ConsumerPriceIndexCategoryDto |
»» consumerPriceIndexSourceType |
string |
true |
none |
Type of the consumer price index source |
»» source |
string |
true |
none |
Text value for source in ConsumerPriceIndexCategoryDto |
»» formula |
string |
false |
none |
Text value for formula in ConsumerPriceIndexCategoryDto |
»» 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 |
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "scenario": true,
285 "isVisibleVendorPortal": true,
286 "isTerminationVersion": true,
287 "terminationDate": "2019-08-24",
288 "penaltyAmount": 0.1
289 },
290 "premiseDto": {
291 "createdBy": "string",
292 "lastModifiedBy": "string",
293 "createdDate": "2019-08-24T14:15:22Z",
294 "lastModifiedDate": "2019-08-24T14:15:22Z",
295 "archived": true,
296 "externalId": "string",
297 "id": 0,
298 "number": "string",
299 "name": "string",
300 "headPremise": true,
301 "possessionDate": "2019-08-24",
302 "openingDate": "2019-08-24",
303 "closingDate": "2019-08-24",
304 "relocationDate": "2019-08-24",
305 "vacatingDate": "2019-08-24",
306 "expansionDate": "2019-08-24",
307 "statusId": 0,
308 "usageId": 0,
309 "parentPremiseId": 0,
310 "costCenterId": 0,
311 "profitCenterId": 0,
312 "legalEntityId": 0,
313 "occupancyIds": [
314 0
315 ],
316 "locationId": 0,
317 "locationDto": {
318 "createdBy": "string",
319 "lastModifiedBy": "string",
320 "createdDate": "2019-08-24T14:15:22Z",
321 "lastModifiedDate": "2019-08-24T14:15:22Z",
322 "archived": true,
323 "externalId": "string",
324 "id": 0,
325 "number": "string",
326 "name": "string",
327 "storeNumber": "string",
328 "defaultCurrencyId": 0,
329 "defaultMeasureId": 0,
330 "typeId": 0,
331 "qualityId": 0,
332 "propertyTypeId": 0,
333 "categoryId": 0,
334 "statusId": 0,
335 "businessUnitId": 0,
336 "groupIds": [
337 0
338 ],
339 "legalEntityIds": [
340 0
341 ],
342 "defaultCurrency": {
343 "id": 0,
344 "status": "CREATED",
345 "displayId": "string",
346 "erpSystemId": 0,
347 "erpSystemDisplayId": "string",
348 "name": "string",
349 "decimalPoints": 0,
350 "depreciationAreaId": 0
351 },
352 "defaultUnitValue": {
353 "createdBy": "string",
354 "lastModifiedBy": "string",
355 "createdDate": "2019-08-24T14:15:22Z",
356 "lastModifiedDate": "2019-08-24T14:15:22Z",
357 "archived": true,
358 "externalId": "string",
359 "id": 0,
360 "unitId": 0,
361 "unitOfMeasureId": 0,
362 "erpSystemId": 0,
363 "unit": {
364 "createdBy": "string",
365 "lastModifiedBy": "string",
366 "createdDate": "2019-08-24T14:15:22Z",
367 "lastModifiedDate": "2019-08-24T14:15:22Z",
368 "archived": true,
369 "externalId": "string",
370 "id": 0,
371 "priority": 0,
372 "internalId": 0,
373 "pickListCode": "string",
374 "pickListLabel": "string",
375 "label": "string",
376 "cultureId": 0,
377 "labelDtos": [
378 {
379 "createdBy": "string",
380 "lastModifiedBy": "string",
381 "createdDate": "2019-08-24T14:15:22Z",
382 "lastModifiedDate": "2019-08-24T14:15:22Z",
383 "archived": true,
384 "externalId": "string",
385 "id": 0,
386 "cultureId": 0,
387 "value": "string"
388 }
389 ]
390 },
391 "unitOfMeasure": {
392 "id": 0,
393 "status": "CREATED",
394 "displayId": "string",
395 "erpSystemId": 0,
396 "erpSystemDisplayId": "string",
397 "name": "string"
398 }
399 },
400 "type": {
401 "createdBy": "string",
402 "lastModifiedBy": "string",
403 "createdDate": "2019-08-24T14:15:22Z",
404 "lastModifiedDate": "2019-08-24T14:15:22Z",
405 "archived": true,
406 "externalId": "string",
407 "id": 0,
408 "priority": 0,
409 "internalId": 0,
410 "pickListCode": "string",
411 "pickListLabel": "string",
412 "label": "string",
413 "cultureId": 0,
414 "labelDtos": [
415 {
416 "createdBy": "string",
417 "lastModifiedBy": "string",
418 "createdDate": "2019-08-24T14:15:22Z",
419 "lastModifiedDate": "2019-08-24T14:15:22Z",
420 "archived": true,
421 "externalId": "string",
422 "id": 0,
423 "cultureId": 0,
424 "value": "string"
425 }
426 ]
427 },
428 "quality": {
429 "createdBy": "string",
430 "lastModifiedBy": "string",
431 "createdDate": "2019-08-24T14:15:22Z",
432 "lastModifiedDate": "2019-08-24T14:15:22Z",
433 "archived": true,
434 "externalId": "string",
435 "id": 0,
436 "priority": 0,
437 "internalId": 0,
438 "pickListCode": "string",
439 "pickListLabel": "string",
440 "label": "string",
441 "cultureId": 0,
442 "labelDtos": [
443 {
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 "cultureId": 0,
452 "value": "string"
453 }
454 ]
455 },
456 "propertyType": {
457 "createdBy": "string",
458 "lastModifiedBy": "string",
459 "createdDate": "2019-08-24T14:15:22Z",
460 "lastModifiedDate": "2019-08-24T14:15:22Z",
461 "archived": true,
462 "externalId": "string",
463 "id": 0,
464 "priority": 0,
465 "internalId": 0,
466 "pickListCode": "string",
467 "pickListLabel": "string",
468 "label": "string",
469 "cultureId": 0,
470 "labelDtos": [
471 {
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 "cultureId": 0,
480 "value": "string"
481 }
482 ]
483 },
484 "category": {
485 "createdBy": "string",
486 "lastModifiedBy": "string",
487 "createdDate": "2019-08-24T14:15:22Z",
488 "lastModifiedDate": "2019-08-24T14:15:22Z",
489 "archived": true,
490 "externalId": "string",
491 "id": 0,
492 "priority": 0,
493 "internalId": 0,
494 "pickListCode": "string",
495 "pickListLabel": "string",
496 "label": "string",
497 "cultureId": 0,
498 "labelDtos": [
499 {
500 "createdBy": "string",
501 "lastModifiedBy": "string",
502 "createdDate": "2019-08-24T14:15:22Z",
503 "lastModifiedDate": "2019-08-24T14:15:22Z",
504 "archived": true,
505 "externalId": "string",
506 "id": 0,
507 "cultureId": 0,
508 "value": "string"
509 }
510 ]
511 },
512 "status": {
513 "createdBy": "string",
514 "lastModifiedBy": "string",
515 "createdDate": "2019-08-24T14:15:22Z",
516 "lastModifiedDate": "2019-08-24T14:15:22Z",
517 "archived": true,
518 "externalId": "string",
519 "id": 0,
520 "priority": 0,
521 "internalId": 0,
522 "pickListCode": "string",
523 "pickListLabel": "string",
524 "label": "string",
525 "cultureId": 0,
526 "labelDtos": [
527 {
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 "cultureId": 0,
536 "value": "string"
537 }
538 ]
539 },
540 "addressDto": {
541 "createdBy": "string",
542 "lastModifiedBy": "string",
543 "createdDate": "2019-08-24T14:15:22Z",
544 "lastModifiedDate": "2019-08-24T14:15:22Z",
545 "archived": true,
546 "externalId": "string",
547 "id": 0,
548 "street": "string",
549 "civicNumber": "string",
550 "suite": "string",
551 "postalCode": "string",
552 "lon": 0.1,
553 "lat": 0.1,
554 "city": {
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 "name": "string",
563 "province": {
564 "createdBy": "string",
565 "lastModifiedBy": "string",
566 "createdDate": "2019-08-24T14:15:22Z",
567 "lastModifiedDate": "2019-08-24T14:15:22Z",
568 "archived": true,
569 "externalId": "string",
570 "id": 0,
571 "name": "string",
572 "code": "string",
573 "country": {
574 "createdBy": "string",
575 "lastModifiedBy": "string",
576 "createdDate": "2019-08-24T14:15:22Z",
577 "lastModifiedDate": "2019-08-24T14:15:22Z",
578 "archived": true,
579 "externalId": "string",
580 "id": 0,
581 "name": "string",
582 "code": "string"
583 }
584 }
585 },
586 "district": {
587 "createdBy": "string",
588 "lastModifiedBy": "string",
589 "createdDate": "2019-08-24T14:15:22Z",
590 "lastModifiedDate": "2019-08-24T14:15:22Z",
591 "archived": true,
592 "externalId": "string",
593 "id": 0,
594 "name": "string",
595 "city": {
596 "createdBy": "string",
597 "lastModifiedBy": "string",
598 "createdDate": "2019-08-24T14:15:22Z",
599 "lastModifiedDate": "2019-08-24T14:15:22Z",
600 "archived": true,
601 "externalId": "string",
602 "id": 0,
603 "name": "string",
604 "province": {
605 "createdBy": "string",
606 "lastModifiedBy": "string",
607 "createdDate": "2019-08-24T14:15:22Z",
608 "lastModifiedDate": "2019-08-24T14:15:22Z",
609 "archived": true,
610 "externalId": "string",
611 "id": 0,
612 "name": "string",
613 "code": "string",
614 "country": {
615 "createdBy": "string",
616 "lastModifiedBy": "string",
617 "createdDate": "2019-08-24T14:15:22Z",
618 "lastModifiedDate": "2019-08-24T14:15:22Z",
619 "archived": true,
620 "externalId": "string",
621 "id": 0,
622 "name": "string",
623 "code": "string"
624 }
625 }
626 }
627 },
628 "cityId": 0,
629 "districtId": 0
630 },
631 "secondAddressDto": {
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 "street": "string",
640 "civicNumber": "string",
641 "suite": "string",
642 "postalCode": "string",
643 "lon": 0.1,
644 "lat": 0.1,
645 "city": {
646 "createdBy": "string",
647 "lastModifiedBy": "string",
648 "createdDate": "2019-08-24T14:15:22Z",
649 "lastModifiedDate": "2019-08-24T14:15:22Z",
650 "archived": true,
651 "externalId": "string",
652 "id": 0,
653 "name": "string",
654 "province": {
655 "createdBy": "string",
656 "lastModifiedBy": "string",
657 "createdDate": "2019-08-24T14:15:22Z",
658 "lastModifiedDate": "2019-08-24T14:15:22Z",
659 "archived": true,
660 "externalId": "string",
661 "id": 0,
662 "name": "string",
663 "code": "string",
664 "country": {
665 "createdBy": "string",
666 "lastModifiedBy": "string",
667 "createdDate": "2019-08-24T14:15:22Z",
668 "lastModifiedDate": "2019-08-24T14:15:22Z",
669 "archived": true,
670 "externalId": "string",
671 "id": 0,
672 "name": "string",
673 "code": "string"
674 }
675 }
676 },
677 "district": {
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 "name": "string",
686 "city": {
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 "province": {
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 "code": "string",
705 "country": {
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 }
716 }
717 }
718 },
719 "cityId": 0,
720 "districtId": 0
721 }
722 },
723 "status": {
724 "createdBy": "string",
725 "lastModifiedBy": "string",
726 "createdDate": "2019-08-24T14:15:22Z",
727 "lastModifiedDate": "2019-08-24T14:15:22Z",
728 "archived": true,
729 "externalId": "string",
730 "id": 0,
731 "priority": 0,
732 "internalId": 0,
733 "pickListCode": "string",
734 "pickListLabel": "string",
735 "label": "string",
736 "cultureId": 0,
737 "labelDtos": [
738 {
739 "createdBy": "string",
740 "lastModifiedBy": "string",
741 "createdDate": "2019-08-24T14:15:22Z",
742 "lastModifiedDate": "2019-08-24T14:15:22Z",
743 "archived": true,
744 "externalId": "string",
745 "id": 0,
746 "cultureId": 0,
747 "value": "string"
748 }
749 ]
750 },
751 "usage": {
752 "createdBy": "string",
753 "lastModifiedBy": "string",
754 "createdDate": "2019-08-24T14:15:22Z",
755 "lastModifiedDate": "2019-08-24T14:15:22Z",
756 "archived": true,
757 "externalId": "string",
758 "id": 0,
759 "priority": 0,
760 "internalId": 0,
761 "pickListCode": "string",
762 "pickListLabel": "string",
763 "label": "string",
764 "cultureId": 0,
765 "labelDtos": [
766 {
767 "createdBy": "string",
768 "lastModifiedBy": "string",
769 "createdDate": "2019-08-24T14:15:22Z",
770 "lastModifiedDate": "2019-08-24T14:15:22Z",
771 "archived": true,
772 "externalId": "string",
773 "id": 0,
774 "cultureId": 0,
775 "value": "string"
776 }
777 ]
778 },
779 "occupanciesDto": [
780 {
781 "createdBy": "string",
782 "lastModifiedBy": "string",
783 "createdDate": "2019-08-24T14:15:22Z",
784 "lastModifiedDate": "2019-08-24T14:15:22Z",
785 "archived": true,
786 "externalId": "string",
787 "id": 0,
788 "priority": 0,
789 "internalId": 0,
790 "pickListCode": "string",
791 "pickListLabel": "string",
792 "label": "string",
793 "cultureId": 0,
794 "labelDtos": [
795 {
796 "createdBy": "string",
797 "lastModifiedBy": "string",
798 "createdDate": "2019-08-24T14:15:22Z",
799 "lastModifiedDate": "2019-08-24T14:15:22Z",
800 "archived": true,
801 "externalId": "string",
802 "id": 0,
803 "cultureId": 0,
804 "value": "string"
805 }
806 ]
807 }
808 ]
809 },
810 "isTerminationVersion": true
811}
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "isVisibleVendorPortal": true,
285 "isTerminationVersion": true,
286 "terminationDate": "2019-08-24",
287 "penaltyAmount": 0.1
288 },
289 "premiseDto": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "number": "string",
298 "name": "string",
299 "headPremise": true,
300 "possessionDate": "2019-08-24",
301 "openingDate": "2019-08-24",
302 "closingDate": "2019-08-24",
303 "relocationDate": "2019-08-24",
304 "vacatingDate": "2019-08-24",
305 "expansionDate": "2019-08-24",
306 "statusId": 0,
307 "usageId": 0,
308 "parentPremiseId": 0,
309 "costCenterId": 0,
310 "profitCenterId": 0,
311 "legalEntityId": 0,
312 "occupancyIds": [
313 0
314 ],
315 "locationId": 0,
316 "locationDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "number": "string",
325 "name": "string",
326 "storeNumber": "string",
327 "defaultCurrencyId": 0,
328 "defaultMeasureId": 0,
329 "typeId": 0,
330 "qualityId": 0,
331 "propertyTypeId": 0,
332 "categoryId": 0,
333 "statusId": 0,
334 "businessUnitId": 0,
335 "groupIds": [
336 0
337 ],
338 "legalEntityIds": [
339 0
340 ],
341 "defaultCurrency": {
342 "id": 0,
343 "status": "CREATED",
344 "displayId": "string",
345 "erpSystemId": 0,
346 "erpSystemDisplayId": "string",
347 "name": "string",
348 "decimalPoints": 0,
349 "depreciationAreaId": 0
350 },
351 "defaultUnitValue": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "unitId": 0,
360 "unitOfMeasureId": 0,
361 "erpSystemId": 0,
362 "unit": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "unitOfMeasure": {
391 "id": 0,
392 "status": "CREATED",
393 "displayId": "string",
394 "erpSystemId": 0,
395 "erpSystemDisplayId": "string",
396 "name": "string"
397 }
398 },
399 "type": {
400 "createdBy": "string",
401 "lastModifiedBy": "string",
402 "createdDate": "2019-08-24T14:15:22Z",
403 "lastModifiedDate": "2019-08-24T14:15:22Z",
404 "archived": true,
405 "externalId": "string",
406 "id": 0,
407 "priority": 0,
408 "internalId": 0,
409 "pickListCode": "string",
410 "pickListLabel": "string",
411 "label": "string",
412 "cultureId": 0,
413 "labelDtos": [
414 {
415 "createdBy": "string",
416 "lastModifiedBy": "string",
417 "createdDate": "2019-08-24T14:15:22Z",
418 "lastModifiedDate": "2019-08-24T14:15:22Z",
419 "archived": true,
420 "externalId": "string",
421 "id": 0,
422 "cultureId": 0,
423 "value": "string"
424 }
425 ]
426 },
427 "quality": {
428 "createdBy": "string",
429 "lastModifiedBy": "string",
430 "createdDate": "2019-08-24T14:15:22Z",
431 "lastModifiedDate": "2019-08-24T14:15:22Z",
432 "archived": true,
433 "externalId": "string",
434 "id": 0,
435 "priority": 0,
436 "internalId": 0,
437 "pickListCode": "string",
438 "pickListLabel": "string",
439 "label": "string",
440 "cultureId": 0,
441 "labelDtos": [
442 {
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 "cultureId": 0,
451 "value": "string"
452 }
453 ]
454 },
455 "propertyType": {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "priority": 0,
464 "internalId": 0,
465 "pickListCode": "string",
466 "pickListLabel": "string",
467 "label": "string",
468 "cultureId": 0,
469 "labelDtos": [
470 {
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 "cultureId": 0,
479 "value": "string"
480 }
481 ]
482 },
483 "category": {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "priority": 0,
492 "internalId": 0,
493 "pickListCode": "string",
494 "pickListLabel": "string",
495 "label": "string",
496 "cultureId": 0,
497 "labelDtos": [
498 {
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 "cultureId": 0,
507 "value": "string"
508 }
509 ]
510 },
511 "status": {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "priority": 0,
520 "internalId": 0,
521 "pickListCode": "string",
522 "pickListLabel": "string",
523 "label": "string",
524 "cultureId": 0,
525 "labelDtos": [
526 {
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 "cultureId": 0,
535 "value": "string"
536 }
537 ]
538 },
539 "addressDto": {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "street": "string",
548 "civicNumber": "string",
549 "suite": "string",
550 "postalCode": "string",
551 "lon": 0.1,
552 "lat": 0.1,
553 "city": {
554 "createdBy": "string",
555 "lastModifiedBy": "string",
556 "createdDate": "2019-08-24T14:15:22Z",
557 "lastModifiedDate": "2019-08-24T14:15:22Z",
558 "archived": true,
559 "externalId": "string",
560 "id": 0,
561 "name": "string",
562 "province": {
563 "createdBy": "string",
564 "lastModifiedBy": "string",
565 "createdDate": "2019-08-24T14:15:22Z",
566 "lastModifiedDate": "2019-08-24T14:15:22Z",
567 "archived": true,
568 "externalId": "string",
569 "id": 0,
570 "name": "string",
571 "code": "string",
572 "country": {
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 "code": "string"
582 }
583 }
584 },
585 "district": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
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 }
675 },
676 "district": {
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 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 }
717 },
718 "cityId": 0,
719 "districtId": 0
720 }
721 },
722 "status": {
723 "createdBy": "string",
724 "lastModifiedBy": "string",
725 "createdDate": "2019-08-24T14:15:22Z",
726 "lastModifiedDate": "2019-08-24T14:15:22Z",
727 "archived": true,
728 "externalId": "string",
729 "id": 0,
730 "priority": 0,
731 "internalId": 0,
732 "pickListCode": "string",
733 "pickListLabel": "string",
734 "label": "string",
735 "cultureId": 0,
736 "labelDtos": [
737 {
738 "createdBy": "string",
739 "lastModifiedBy": "string",
740 "createdDate": "2019-08-24T14:15:22Z",
741 "lastModifiedDate": "2019-08-24T14:15:22Z",
742 "archived": true,
743 "externalId": "string",
744 "id": 0,
745 "cultureId": 0,
746 "value": "string"
747 }
748 ]
749 },
750 "usage": {
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 "priority": 0,
759 "internalId": 0,
760 "pickListCode": "string",
761 "pickListLabel": "string",
762 "label": "string",
763 "cultureId": 0,
764 "labelDtos": [
765 {
766 "createdBy": "string",
767 "lastModifiedBy": "string",
768 "createdDate": "2019-08-24T14:15:22Z",
769 "lastModifiedDate": "2019-08-24T14:15:22Z",
770 "archived": true,
771 "externalId": "string",
772 "id": 0,
773 "cultureId": 0,
774 "value": "string"
775 }
776 ]
777 },
778 "occupanciesDto": [
779 {
780 "createdBy": "string",
781 "lastModifiedBy": "string",
782 "createdDate": "2019-08-24T14:15:22Z",
783 "lastModifiedDate": "2019-08-24T14:15:22Z",
784 "archived": true,
785 "externalId": "string",
786 "id": 0,
787 "priority": 0,
788 "internalId": 0,
789 "pickListCode": "string",
790 "pickListLabel": "string",
791 "label": "string",
792 "cultureId": 0,
793 "labelDtos": [
794 {
795 "createdBy": "string",
796 "lastModifiedBy": "string",
797 "createdDate": "2019-08-24T14:15:22Z",
798 "lastModifiedDate": "2019-08-24T14:15:22Z",
799 "archived": true,
800 "externalId": "string",
801 "id": 0,
802 "cultureId": 0,
803 "value": "string"
804 }
805 ]
806 }
807 ]
808 },
809 "isTerminationVersion": true
810}
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 },
129 "scenario": true,
130 "isVisibleVendorPortal": true,
131 "isTerminationVersion": true,
132 "terminationDate": "2019-08-24",
133 "penaltyAmount": 0.1
134}
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "isVisibleVendorPortal": true,
285 "isTerminationVersion": true,
286 "terminationDate": "2019-08-24",
287 "penaltyAmount": 0.1
288 },
289 "premiseDto": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "number": "string",
298 "name": "string",
299 "headPremise": true,
300 "possessionDate": "2019-08-24",
301 "openingDate": "2019-08-24",
302 "closingDate": "2019-08-24",
303 "relocationDate": "2019-08-24",
304 "vacatingDate": "2019-08-24",
305 "expansionDate": "2019-08-24",
306 "statusId": 0,
307 "usageId": 0,
308 "parentPremiseId": 0,
309 "costCenterId": 0,
310 "profitCenterId": 0,
311 "legalEntityId": 0,
312 "occupancyIds": [
313 0
314 ],
315 "locationId": 0,
316 "locationDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "number": "string",
325 "name": "string",
326 "storeNumber": "string",
327 "defaultCurrencyId": 0,
328 "defaultMeasureId": 0,
329 "typeId": 0,
330 "qualityId": 0,
331 "propertyTypeId": 0,
332 "categoryId": 0,
333 "statusId": 0,
334 "businessUnitId": 0,
335 "groupIds": [
336 0
337 ],
338 "legalEntityIds": [
339 0
340 ],
341 "defaultCurrency": {
342 "id": 0,
343 "status": "CREATED",
344 "displayId": "string",
345 "erpSystemId": 0,
346 "erpSystemDisplayId": "string",
347 "name": "string",
348 "decimalPoints": 0,
349 "depreciationAreaId": 0
350 },
351 "defaultUnitValue": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "unitId": 0,
360 "unitOfMeasureId": 0,
361 "erpSystemId": 0,
362 "unit": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "unitOfMeasure": {
391 "id": 0,
392 "status": "CREATED",
393 "displayId": "string",
394 "erpSystemId": 0,
395 "erpSystemDisplayId": "string",
396 "name": "string"
397 }
398 },
399 "type": {
400 "createdBy": "string",
401 "lastModifiedBy": "string",
402 "createdDate": "2019-08-24T14:15:22Z",
403 "lastModifiedDate": "2019-08-24T14:15:22Z",
404 "archived": true,
405 "externalId": "string",
406 "id": 0,
407 "priority": 0,
408 "internalId": 0,
409 "pickListCode": "string",
410 "pickListLabel": "string",
411 "label": "string",
412 "cultureId": 0,
413 "labelDtos": [
414 {
415 "createdBy": "string",
416 "lastModifiedBy": "string",
417 "createdDate": "2019-08-24T14:15:22Z",
418 "lastModifiedDate": "2019-08-24T14:15:22Z",
419 "archived": true,
420 "externalId": "string",
421 "id": 0,
422 "cultureId": 0,
423 "value": "string"
424 }
425 ]
426 },
427 "quality": {
428 "createdBy": "string",
429 "lastModifiedBy": "string",
430 "createdDate": "2019-08-24T14:15:22Z",
431 "lastModifiedDate": "2019-08-24T14:15:22Z",
432 "archived": true,
433 "externalId": "string",
434 "id": 0,
435 "priority": 0,
436 "internalId": 0,
437 "pickListCode": "string",
438 "pickListLabel": "string",
439 "label": "string",
440 "cultureId": 0,
441 "labelDtos": [
442 {
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 "cultureId": 0,
451 "value": "string"
452 }
453 ]
454 },
455 "propertyType": {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "priority": 0,
464 "internalId": 0,
465 "pickListCode": "string",
466 "pickListLabel": "string",
467 "label": "string",
468 "cultureId": 0,
469 "labelDtos": [
470 {
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 "cultureId": 0,
479 "value": "string"
480 }
481 ]
482 },
483 "category": {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "priority": 0,
492 "internalId": 0,
493 "pickListCode": "string",
494 "pickListLabel": "string",
495 "label": "string",
496 "cultureId": 0,
497 "labelDtos": [
498 {
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 "cultureId": 0,
507 "value": "string"
508 }
509 ]
510 },
511 "status": {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "priority": 0,
520 "internalId": 0,
521 "pickListCode": "string",
522 "pickListLabel": "string",
523 "label": "string",
524 "cultureId": 0,
525 "labelDtos": [
526 {
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 "cultureId": 0,
535 "value": "string"
536 }
537 ]
538 },
539 "addressDto": {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "street": "string",
548 "civicNumber": "string",
549 "suite": "string",
550 "postalCode": "string",
551 "lon": 0.1,
552 "lat": 0.1,
553 "city": {
554 "createdBy": "string",
555 "lastModifiedBy": "string",
556 "createdDate": "2019-08-24T14:15:22Z",
557 "lastModifiedDate": "2019-08-24T14:15:22Z",
558 "archived": true,
559 "externalId": "string",
560 "id": 0,
561 "name": "string",
562 "province": {
563 "createdBy": "string",
564 "lastModifiedBy": "string",
565 "createdDate": "2019-08-24T14:15:22Z",
566 "lastModifiedDate": "2019-08-24T14:15:22Z",
567 "archived": true,
568 "externalId": "string",
569 "id": 0,
570 "name": "string",
571 "code": "string",
572 "country": {
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 "code": "string"
582 }
583 }
584 },
585 "district": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
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 }
675 },
676 "district": {
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 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 }
717 },
718 "cityId": 0,
719 "districtId": 0
720 }
721 },
722 "status": {
723 "createdBy": "string",
724 "lastModifiedBy": "string",
725 "createdDate": "2019-08-24T14:15:22Z",
726 "lastModifiedDate": "2019-08-24T14:15:22Z",
727 "archived": true,
728 "externalId": "string",
729 "id": 0,
730 "priority": 0,
731 "internalId": 0,
732 "pickListCode": "string",
733 "pickListLabel": "string",
734 "label": "string",
735 "cultureId": 0,
736 "labelDtos": [
737 {
738 "createdBy": "string",
739 "lastModifiedBy": "string",
740 "createdDate": "2019-08-24T14:15:22Z",
741 "lastModifiedDate": "2019-08-24T14:15:22Z",
742 "archived": true,
743 "externalId": "string",
744 "id": 0,
745 "cultureId": 0,
746 "value": "string"
747 }
748 ]
749 },
750 "usage": {
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 "priority": 0,
759 "internalId": 0,
760 "pickListCode": "string",
761 "pickListLabel": "string",
762 "label": "string",
763 "cultureId": 0,
764 "labelDtos": [
765 {
766 "createdBy": "string",
767 "lastModifiedBy": "string",
768 "createdDate": "2019-08-24T14:15:22Z",
769 "lastModifiedDate": "2019-08-24T14:15:22Z",
770 "archived": true,
771 "externalId": "string",
772 "id": 0,
773 "cultureId": 0,
774 "value": "string"
775 }
776 ]
777 },
778 "occupanciesDto": [
779 {
780 "createdBy": "string",
781 "lastModifiedBy": "string",
782 "createdDate": "2019-08-24T14:15:22Z",
783 "lastModifiedDate": "2019-08-24T14:15:22Z",
784 "archived": true,
785 "externalId": "string",
786 "id": 0,
787 "priority": 0,
788 "internalId": 0,
789 "pickListCode": "string",
790 "pickListLabel": "string",
791 "label": "string",
792 "cultureId": 0,
793 "labelDtos": [
794 {
795 "createdBy": "string",
796 "lastModifiedBy": "string",
797 "createdDate": "2019-08-24T14:15:22Z",
798 "lastModifiedDate": "2019-08-24T14:15:22Z",
799 "archived": true,
800 "externalId": "string",
801 "id": 0,
802 "cultureId": 0,
803 "value": "string"
804 }
805 ]
806 }
807 ]
808 },
809 "isTerminationVersion": true
810}
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 }
102]
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 }
102]
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 |
Text value for note in TermDefinitionDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Enumerated Values
Attribute |
Value |
|---|---|
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
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 |
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}
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 |
Text value for comments in ReminderDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Text value for email in UserDto |
|
»» 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 |
Text value for permissions in UserDto |
»» 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 |
Text value for fax in PartnerDto |
»»» phone |
string |
false |
none |
Text value for phone in PartnerDto |
»»» 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 |
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 |
Text value for permission in Transition |
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 |
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 |
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 |
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}
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 |
Text value for message in NoteDto |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
Text value for redirectUrl in NoteDto |
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 "postingPeriodVariantId": 0,
66 "fiscalVariantId": 0
67 },
68 "department": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string"
73 },
74 "leaseGroup": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string"
79 },
80 "allowsSystemGenerateNewId": true,
81 "numberRangeIdentifierType": {
82 "name": "string"
83 },
84 "numberRangeIdentifierValue": "string",
85 "numberRangeType": {
86 "name": "string"
87 }
88}
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 "postingPeriodVariantId": 0,
66 "fiscalVariantId": 0
67 },
68 "department": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string"
73 },
74 "leaseGroup": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string"
79 },
80 "allowsSystemGenerateNewId": true,
81 "numberRangeIdentifierType": {
82 "name": "string"
83 },
84 "numberRangeIdentifierValue": "string",
85 "numberRangeType": {
86 "name": "string"
87 }
88}
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 "typeId": 0,
155 "startDate": "2019-08-24",
156 "endDate": "2019-08-24",
157 "replaceById": 0,
158 "managedById": 0,
159 "payById": 0,
160 "adminFee": 0,
161 "fixedIncreasePercentage": 0,
162 "note": "string",
163 "pageNumber": "string",
164 "section": "string",
165 "type": {
166 "createdBy": "string",
167 "lastModifiedBy": "string",
168 "createdDate": "2019-08-24T14:15:22Z",
169 "lastModifiedDate": "2019-08-24T14:15:22Z",
170 "archived": true,
171 "externalId": "string",
172 "id": 0,
173 "priority": 0,
174 "internalId": 0,
175 "pickListCode": "string",
176 "pickListLabel": "string",
177 "label": "string",
178 "cultureId": 0,
179 "labelDtos": []
180 },
181 "replaceBy": {
182 "createdBy": "string",
183 "lastModifiedBy": "string",
184 "createdDate": "2019-08-24T14:15:22Z",
185 "lastModifiedDate": "2019-08-24T14:15:22Z",
186 "archived": true,
187 "externalId": "string",
188 "id": 0,
189 "priority": 0,
190 "internalId": 0,
191 "pickListCode": "string",
192 "pickListLabel": "string",
193 "label": "string",
194 "cultureId": 0,
195 "labelDtos": []
196 },
197 "managedBy": {
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 "priority": 0,
206 "internalId": 0,
207 "pickListCode": "string",
208 "pickListLabel": "string",
209 "label": "string",
210 "cultureId": 0,
211 "labelDtos": []
212 },
213 "payBy": {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "priority": 0,
222 "internalId": 0,
223 "pickListCode": "string",
224 "pickListLabel": "string",
225 "label": "string",
226 "cultureId": 0,
227 "labelDtos": []
228 },
229 "proShareDto": {
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 "type": "string"
238 },
239 "capDto": {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "type": "string"
248 }
249 }
250 }
251 ]
252 }
253 ],
254 "hasWarning": true
255 }
256 ]
257 }
258]
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 "typeId": 0,
155 "startDate": "2019-08-24",
156 "endDate": "2019-08-24",
157 "replaceById": 0,
158 "managedById": 0,
159 "payById": 0,
160 "adminFee": 0,
161 "fixedIncreasePercentage": 0,
162 "note": "string",
163 "pageNumber": "string",
164 "section": "string",
165 "type": {
166 "createdBy": "string",
167 "lastModifiedBy": "string",
168 "createdDate": "2019-08-24T14:15:22Z",
169 "lastModifiedDate": "2019-08-24T14:15:22Z",
170 "archived": true,
171 "externalId": "string",
172 "id": 0,
173 "priority": 0,
174 "internalId": 0,
175 "pickListCode": "string",
176 "pickListLabel": "string",
177 "label": "string",
178 "cultureId": 0,
179 "labelDtos": []
180 },
181 "replaceBy": {
182 "createdBy": "string",
183 "lastModifiedBy": "string",
184 "createdDate": "2019-08-24T14:15:22Z",
185 "lastModifiedDate": "2019-08-24T14:15:22Z",
186 "archived": true,
187 "externalId": "string",
188 "id": 0,
189 "priority": 0,
190 "internalId": 0,
191 "pickListCode": "string",
192 "pickListLabel": "string",
193 "label": "string",
194 "cultureId": 0,
195 "labelDtos": []
196 },
197 "managedBy": {
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 "priority": 0,
206 "internalId": 0,
207 "pickListCode": "string",
208 "pickListLabel": "string",
209 "label": "string",
210 "cultureId": 0,
211 "labelDtos": []
212 },
213 "payBy": {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "priority": 0,
222 "internalId": 0,
223 "pickListCode": "string",
224 "pickListLabel": "string",
225 "label": "string",
226 "cultureId": 0,
227 "labelDtos": []
228 },
229 "proShareDto": {
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 "type": "string"
238 },
239 "capDto": {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "type": "string"
248 }
249 }
250 }
251 ]
252 }
253 ],
254 "hasWarning": true
255 }
256 ]
257 }
258]
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 |
Text value for reviewedBy in LeaseReconciliationPeriodDto |
» 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 |
Text value for value in LabelDto |
» 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 |
»»»»» 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 |
Text value for note in LeaseConditionDto |
»»»»» pageNumber |
string |
false |
none |
Page number for pagination |
»»»»» section |
string |
false |
none |
Text value for section in LeaseConditionDto |
»»»»» 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 |
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 |
Text value for section in LeaseIncentiveDto |
» 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 |
Text value for value in LabelDto |
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 "provisioningFrequencyName": "string",
65 "accountingApproved": true,
66 "indexationType": "string",
67 "cpiGlobalCategoryId": 0,
68 "indexationReferenceDate": "2019-08-24",
69 "currentIndexLevel": 0.1,
70 "conditionallyIndexed": true,
71 "applicableCurrentIndexLevel": 0.1,
72 "indexLevelPercentageChangeLowerBound": 0.1,
73 "indexLevelPercentageChangeUpperBound": 0.1,
74 "indexationTypeNonLease": "string",
75 "cpiGlobalCategoryIdNonLease": 0,
76 "indexationReferenceDateNonLease": "2019-08-24",
77 "currentIndexLevelNonLease": 0.1,
78 "conditionallyIndexedNonLease": true,
79 "applicableCurrentIndexLevelNonLease": 0.1,
80 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
81 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
82 "signatureDate": "2019-08-24",
83 "premiseId": 0,
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "category": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "status": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "state": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "version": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "name": "string",
205 "description": "string",
206 "modificationDate": "2019-08-24",
207 "updateContractRate": true,
208 "leaseEvent": {
209 "createdBy": "string",
210 "lastModifiedBy": "string",
211 "createdDate": "2019-08-24T14:15:22Z",
212 "lastModifiedDate": "2019-08-24T14:15:22Z",
213 "archived": true,
214 "externalId": "string",
215 "id": 0,
216 "typeId": 0,
217 "code": "string",
218 "reviewedBy": "string",
219 "reviewedDate": "2019-08-24",
220 "reviewedStatusId": 0,
221 "activityDate": "2019-08-24",
222 "relatedPickListOptionId": 0,
223 "detail": "string",
224 "note": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "message": "string",
233 "preserveOriginalAudit": true,
234 "originalCreatedBy": "string",
235 "originalCreatedDate": "2019-08-24T14:15:22Z",
236 "originalLastModifiedBy": "string",
237 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
238 },
239 "type": {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "priority": 0,
248 "internalId": 0,
249 "pickListCode": "string",
250 "pickListLabel": "string",
251 "label": "string",
252 "cultureId": 0,
253 "labelDtos": [
254 {
255 "createdBy": "string",
256 "lastModifiedBy": "string",
257 "createdDate": "2019-08-24T14:15:22Z",
258 "lastModifiedDate": "2019-08-24T14:15:22Z",
259 "archived": true,
260 "externalId": "string",
261 "id": 0,
262 "cultureId": 0,
263 "value": "string"
264 }
265 ]
266 },
267 "reviewedStatus": {
268 "createdBy": "string",
269 "lastModifiedBy": "string",
270 "createdDate": "2019-08-24T14:15:22Z",
271 "lastModifiedDate": "2019-08-24T14:15:22Z",
272 "archived": true,
273 "externalId": "string",
274 "id": 0,
275 "priority": 0,
276 "internalId": 0,
277 "pickListCode": "string",
278 "pickListLabel": "string",
279 "label": "string",
280 "cultureId": 0,
281 "labelDtos": [
282 {
283 "createdBy": "string",
284 "lastModifiedBy": "string",
285 "createdDate": "2019-08-24T14:15:22Z",
286 "lastModifiedDate": "2019-08-24T14:15:22Z",
287 "archived": true,
288 "externalId": "string",
289 "id": 0,
290 "cultureId": 0,
291 "value": "string"
292 }
293 ]
294 },
295 "relatedPickListOption": {
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 "priority": 0,
304 "internalId": 0,
305 "pickListCode": "string",
306 "pickListLabel": "string",
307 "label": "string",
308 "cultureId": 0,
309 "labelDtos": [
310 {
311 "createdBy": "string",
312 "lastModifiedBy": "string",
313 "createdDate": "2019-08-24T14:15:22Z",
314 "lastModifiedDate": "2019-08-24T14:15:22Z",
315 "archived": true,
316 "externalId": "string",
317 "id": 0,
318 "cultureId": 0,
319 "value": "string"
320 }
321 ]
322 }
323 },
324 "scenario": true,
325 "isVisibleVendorPortal": true,
326 "isTerminationVersion": true,
327 "terminationDate": "2019-08-24",
328 "penaltyAmount": 0.1
329 },
330 "premiseDto": {
331 "createdBy": "string",
332 "lastModifiedBy": "string",
333 "createdDate": "2019-08-24T14:15:22Z",
334 "lastModifiedDate": "2019-08-24T14:15:22Z",
335 "archived": true,
336 "externalId": "string",
337 "id": 0,
338 "number": "string",
339 "name": "string",
340 "headPremise": true,
341 "possessionDate": "2019-08-24",
342 "openingDate": "2019-08-24",
343 "closingDate": "2019-08-24",
344 "relocationDate": "2019-08-24",
345 "vacatingDate": "2019-08-24",
346 "expansionDate": "2019-08-24",
347 "statusId": 0,
348 "usageId": 0,
349 "parentPremiseId": 0,
350 "costCenterId": 0,
351 "profitCenterId": 0,
352 "legalEntityId": 0,
353 "occupancyIds": [
354 0
355 ],
356 "locationId": 0,
357 "locationDto": {
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 "number": "string",
366 "name": "string",
367 "storeNumber": "string",
368 "defaultCurrencyId": 0,
369 "defaultMeasureId": 0,
370 "typeId": 0,
371 "qualityId": 0,
372 "propertyTypeId": 0,
373 "categoryId": 0,
374 "statusId": 0,
375 "businessUnitId": 0,
376 "groupIds": [
377 0
378 ],
379 "legalEntityIds": [
380 0
381 ],
382 "defaultCurrency": {
383 "id": 0,
384 "status": "CREATED",
385 "displayId": "string",
386 "erpSystemId": 0,
387 "erpSystemDisplayId": "string",
388 "name": "string",
389 "decimalPoints": 0,
390 "depreciationAreaId": 0
391 },
392 "defaultUnitValue": {
393 "createdBy": "string",
394 "lastModifiedBy": "string",
395 "createdDate": "2019-08-24T14:15:22Z",
396 "lastModifiedDate": "2019-08-24T14:15:22Z",
397 "archived": true,
398 "externalId": "string",
399 "id": 0,
400 "unitId": 0,
401 "unitOfMeasureId": 0,
402 "erpSystemId": 0,
403 "unit": {
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 "unitOfMeasure": {
432 "id": 0,
433 "status": "CREATED",
434 "displayId": "string",
435 "erpSystemId": 0,
436 "erpSystemDisplayId": "string",
437 "name": "string"
438 }
439 },
440 "type": {
441 "createdBy": "string",
442 "lastModifiedBy": "string",
443 "createdDate": "2019-08-24T14:15:22Z",
444 "lastModifiedDate": "2019-08-24T14:15:22Z",
445 "archived": true,
446 "externalId": "string",
447 "id": 0,
448 "priority": 0,
449 "internalId": 0,
450 "pickListCode": "string",
451 "pickListLabel": "string",
452 "label": "string",
453 "cultureId": 0,
454 "labelDtos": [
455 {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "cultureId": 0,
464 "value": "string"
465 }
466 ]
467 },
468 "quality": {
469 "createdBy": "string",
470 "lastModifiedBy": "string",
471 "createdDate": "2019-08-24T14:15:22Z",
472 "lastModifiedDate": "2019-08-24T14:15:22Z",
473 "archived": true,
474 "externalId": "string",
475 "id": 0,
476 "priority": 0,
477 "internalId": 0,
478 "pickListCode": "string",
479 "pickListLabel": "string",
480 "label": "string",
481 "cultureId": 0,
482 "labelDtos": [
483 {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "cultureId": 0,
492 "value": "string"
493 }
494 ]
495 },
496 "propertyType": {
497 "createdBy": "string",
498 "lastModifiedBy": "string",
499 "createdDate": "2019-08-24T14:15:22Z",
500 "lastModifiedDate": "2019-08-24T14:15:22Z",
501 "archived": true,
502 "externalId": "string",
503 "id": 0,
504 "priority": 0,
505 "internalId": 0,
506 "pickListCode": "string",
507 "pickListLabel": "string",
508 "label": "string",
509 "cultureId": 0,
510 "labelDtos": [
511 {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "cultureId": 0,
520 "value": "string"
521 }
522 ]
523 },
524 "category": {
525 "createdBy": "string",
526 "lastModifiedBy": "string",
527 "createdDate": "2019-08-24T14:15:22Z",
528 "lastModifiedDate": "2019-08-24T14:15:22Z",
529 "archived": true,
530 "externalId": "string",
531 "id": 0,
532 "priority": 0,
533 "internalId": 0,
534 "pickListCode": "string",
535 "pickListLabel": "string",
536 "label": "string",
537 "cultureId": 0,
538 "labelDtos": [
539 {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "cultureId": 0,
548 "value": "string"
549 }
550 ]
551 },
552 "status": {
553 "createdBy": "string",
554 "lastModifiedBy": "string",
555 "createdDate": "2019-08-24T14:15:22Z",
556 "lastModifiedDate": "2019-08-24T14:15:22Z",
557 "archived": true,
558 "externalId": "string",
559 "id": 0,
560 "priority": 0,
561 "internalId": 0,
562 "pickListCode": "string",
563 "pickListLabel": "string",
564 "label": "string",
565 "cultureId": 0,
566 "labelDtos": [
567 {
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 "cultureId": 0,
576 "value": "string"
577 }
578 ]
579 },
580 "addressDto": {
581 "createdBy": "string",
582 "lastModifiedBy": "string",
583 "createdDate": "2019-08-24T14:15:22Z",
584 "lastModifiedDate": "2019-08-24T14:15:22Z",
585 "archived": true,
586 "externalId": "string",
587 "id": 0,
588 "street": "string",
589 "civicNumber": "string",
590 "suite": "string",
591 "postalCode": "string",
592 "lon": 0.1,
593 "lat": 0.1,
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
625 },
626 "district": {
627 "createdBy": "string",
628 "lastModifiedBy": "string",
629 "createdDate": "2019-08-24T14:15:22Z",
630 "lastModifiedDate": "2019-08-24T14:15:22Z",
631 "archived": true,
632 "externalId": "string",
633 "id": 0,
634 "name": "string",
635 "city": {
636 "createdBy": "string",
637 "lastModifiedBy": "string",
638 "createdDate": "2019-08-24T14:15:22Z",
639 "lastModifiedDate": "2019-08-24T14:15:22Z",
640 "archived": true,
641 "externalId": "string",
642 "id": 0,
643 "name": "string",
644 "province": {
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 "code": "string",
654 "country": {
655 "createdBy": "string",
656 "lastModifiedBy": "string",
657 "createdDate": "2019-08-24T14:15:22Z",
658 "lastModifiedDate": "2019-08-24T14:15:22Z",
659 "archived": true,
660 "externalId": "string",
661 "id": 0,
662 "name": "string",
663 "code": "string"
664 }
665 }
666 }
667 },
668 "cityId": 0,
669 "districtId": 0
670 },
671 "secondAddressDto": {
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 "street": "string",
680 "civicNumber": "string",
681 "suite": "string",
682 "postalCode": "string",
683 "lon": 0.1,
684 "lat": 0.1,
685 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 },
717 "district": {
718 "createdBy": "string",
719 "lastModifiedBy": "string",
720 "createdDate": "2019-08-24T14:15:22Z",
721 "lastModifiedDate": "2019-08-24T14:15:22Z",
722 "archived": true,
723 "externalId": "string",
724 "id": 0,
725 "name": "string",
726 "city": {
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 "province": {
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 "code": "string",
745 "country": {
746 "createdBy": "string",
747 "lastModifiedBy": "string",
748 "createdDate": "2019-08-24T14:15:22Z",
749 "lastModifiedDate": "2019-08-24T14:15:22Z",
750 "archived": true,
751 "externalId": "string",
752 "id": 0,
753 "name": "string",
754 "code": "string"
755 }
756 }
757 }
758 },
759 "cityId": 0,
760 "districtId": 0
761 }
762 },
763 "status": {
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 "usage": {
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 "occupanciesDto": [
820 {
821 "createdBy": "string",
822 "lastModifiedBy": "string",
823 "createdDate": "2019-08-24T14:15:22Z",
824 "lastModifiedDate": "2019-08-24T14:15:22Z",
825 "archived": true,
826 "externalId": "string",
827 "id": 0,
828 "priority": 0,
829 "internalId": 0,
830 "pickListCode": "string",
831 "pickListLabel": "string",
832 "label": "string",
833 "cultureId": 0,
834 "labelDtos": [
835 {
836 "createdBy": "string",
837 "lastModifiedBy": "string",
838 "createdDate": "2019-08-24T14:15:22Z",
839 "lastModifiedDate": "2019-08-24T14:15:22Z",
840 "archived": true,
841 "externalId": "string",
842 "id": 0,
843 "cultureId": 0,
844 "value": "string"
845 }
846 ]
847 }
848 ]
849 },
850 "isTerminationVersion": true
851 }
852 }
853]
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 "provisioningFrequencyName": "string",
65 "accountingApproved": true,
66 "indexationType": "string",
67 "cpiGlobalCategoryId": 0,
68 "indexationReferenceDate": "2019-08-24",
69 "currentIndexLevel": 0.1,
70 "conditionallyIndexed": true,
71 "applicableCurrentIndexLevel": 0.1,
72 "indexLevelPercentageChangeLowerBound": 0.1,
73 "indexLevelPercentageChangeUpperBound": 0.1,
74 "indexationTypeNonLease": "string",
75 "cpiGlobalCategoryIdNonLease": 0,
76 "indexationReferenceDateNonLease": "2019-08-24",
77 "currentIndexLevelNonLease": 0.1,
78 "conditionallyIndexedNonLease": true,
79 "applicableCurrentIndexLevelNonLease": 0.1,
80 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
81 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
82 "signatureDate": "2019-08-24",
83 "premiseId": 0,
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "category": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "status": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "state": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "version": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "name": "string",
205 "description": "string",
206 "modificationDate": "2019-08-24",
207 "updateContractRate": true,
208 "leaseEvent": {
209 "createdBy": "string",
210 "lastModifiedBy": "string",
211 "createdDate": "2019-08-24T14:15:22Z",
212 "lastModifiedDate": "2019-08-24T14:15:22Z",
213 "archived": true,
214 "externalId": "string",
215 "id": 0,
216 "typeId": 0,
217 "code": "string",
218 "reviewedBy": "string",
219 "reviewedDate": "2019-08-24",
220 "reviewedStatusId": 0,
221 "activityDate": "2019-08-24",
222 "relatedPickListOptionId": 0,
223 "detail": "string",
224 "note": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "message": "string",
233 "preserveOriginalAudit": true,
234 "originalCreatedBy": "string",
235 "originalCreatedDate": "2019-08-24T14:15:22Z",
236 "originalLastModifiedBy": "string",
237 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
238 },
239 "type": {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "priority": 0,
248 "internalId": 0,
249 "pickListCode": "string",
250 "pickListLabel": "string",
251 "label": "string",
252 "cultureId": 0,
253 "labelDtos": [
254 {
255 "createdBy": "string",
256 "lastModifiedBy": "string",
257 "createdDate": "2019-08-24T14:15:22Z",
258 "lastModifiedDate": "2019-08-24T14:15:22Z",
259 "archived": true,
260 "externalId": "string",
261 "id": 0,
262 "cultureId": 0,
263 "value": "string"
264 }
265 ]
266 },
267 "reviewedStatus": {
268 "createdBy": "string",
269 "lastModifiedBy": "string",
270 "createdDate": "2019-08-24T14:15:22Z",
271 "lastModifiedDate": "2019-08-24T14:15:22Z",
272 "archived": true,
273 "externalId": "string",
274 "id": 0,
275 "priority": 0,
276 "internalId": 0,
277 "pickListCode": "string",
278 "pickListLabel": "string",
279 "label": "string",
280 "cultureId": 0,
281 "labelDtos": [
282 {
283 "createdBy": "string",
284 "lastModifiedBy": "string",
285 "createdDate": "2019-08-24T14:15:22Z",
286 "lastModifiedDate": "2019-08-24T14:15:22Z",
287 "archived": true,
288 "externalId": "string",
289 "id": 0,
290 "cultureId": 0,
291 "value": "string"
292 }
293 ]
294 },
295 "relatedPickListOption": {
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 "priority": 0,
304 "internalId": 0,
305 "pickListCode": "string",
306 "pickListLabel": "string",
307 "label": "string",
308 "cultureId": 0,
309 "labelDtos": [
310 {
311 "createdBy": "string",
312 "lastModifiedBy": "string",
313 "createdDate": "2019-08-24T14:15:22Z",
314 "lastModifiedDate": "2019-08-24T14:15:22Z",
315 "archived": true,
316 "externalId": "string",
317 "id": 0,
318 "cultureId": 0,
319 "value": "string"
320 }
321 ]
322 }
323 },
324 "isVisibleVendorPortal": true,
325 "isTerminationVersion": true,
326 "terminationDate": "2019-08-24",
327 "penaltyAmount": 0.1
328 },
329 "premiseDto": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "number": "string",
338 "name": "string",
339 "headPremise": true,
340 "possessionDate": "2019-08-24",
341 "openingDate": "2019-08-24",
342 "closingDate": "2019-08-24",
343 "relocationDate": "2019-08-24",
344 "vacatingDate": "2019-08-24",
345 "expansionDate": "2019-08-24",
346 "statusId": 0,
347 "usageId": 0,
348 "parentPremiseId": 0,
349 "costCenterId": 0,
350 "profitCenterId": 0,
351 "legalEntityId": 0,
352 "occupancyIds": [
353 0
354 ],
355 "locationId": 0,
356 "locationDto": {
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 "number": "string",
365 "name": "string",
366 "storeNumber": "string",
367 "defaultCurrencyId": 0,
368 "defaultMeasureId": 0,
369 "typeId": 0,
370 "qualityId": 0,
371 "propertyTypeId": 0,
372 "categoryId": 0,
373 "statusId": 0,
374 "businessUnitId": 0,
375 "groupIds": [
376 0
377 ],
378 "legalEntityIds": [
379 0
380 ],
381 "defaultCurrency": {
382 "id": 0,
383 "status": "CREATED",
384 "displayId": "string",
385 "erpSystemId": 0,
386 "erpSystemDisplayId": "string",
387 "name": "string",
388 "decimalPoints": 0,
389 "depreciationAreaId": 0
390 },
391 "defaultUnitValue": {
392 "createdBy": "string",
393 "lastModifiedBy": "string",
394 "createdDate": "2019-08-24T14:15:22Z",
395 "lastModifiedDate": "2019-08-24T14:15:22Z",
396 "archived": true,
397 "externalId": "string",
398 "id": 0,
399 "unitId": 0,
400 "unitOfMeasureId": 0,
401 "erpSystemId": 0,
402 "unit": {
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 "unitOfMeasure": {
431 "id": 0,
432 "status": "CREATED",
433 "displayId": "string",
434 "erpSystemId": 0,
435 "erpSystemDisplayId": "string",
436 "name": "string"
437 }
438 },
439 "type": {
440 "createdBy": "string",
441 "lastModifiedBy": "string",
442 "createdDate": "2019-08-24T14:15:22Z",
443 "lastModifiedDate": "2019-08-24T14:15:22Z",
444 "archived": true,
445 "externalId": "string",
446 "id": 0,
447 "priority": 0,
448 "internalId": 0,
449 "pickListCode": "string",
450 "pickListLabel": "string",
451 "label": "string",
452 "cultureId": 0,
453 "labelDtos": [
454 {
455 "createdBy": "string",
456 "lastModifiedBy": "string",
457 "createdDate": "2019-08-24T14:15:22Z",
458 "lastModifiedDate": "2019-08-24T14:15:22Z",
459 "archived": true,
460 "externalId": "string",
461 "id": 0,
462 "cultureId": 0,
463 "value": "string"
464 }
465 ]
466 },
467 "quality": {
468 "createdBy": "string",
469 "lastModifiedBy": "string",
470 "createdDate": "2019-08-24T14:15:22Z",
471 "lastModifiedDate": "2019-08-24T14:15:22Z",
472 "archived": true,
473 "externalId": "string",
474 "id": 0,
475 "priority": 0,
476 "internalId": 0,
477 "pickListCode": "string",
478 "pickListLabel": "string",
479 "label": "string",
480 "cultureId": 0,
481 "labelDtos": [
482 {
483 "createdBy": "string",
484 "lastModifiedBy": "string",
485 "createdDate": "2019-08-24T14:15:22Z",
486 "lastModifiedDate": "2019-08-24T14:15:22Z",
487 "archived": true,
488 "externalId": "string",
489 "id": 0,
490 "cultureId": 0,
491 "value": "string"
492 }
493 ]
494 },
495 "propertyType": {
496 "createdBy": "string",
497 "lastModifiedBy": "string",
498 "createdDate": "2019-08-24T14:15:22Z",
499 "lastModifiedDate": "2019-08-24T14:15:22Z",
500 "archived": true,
501 "externalId": "string",
502 "id": 0,
503 "priority": 0,
504 "internalId": 0,
505 "pickListCode": "string",
506 "pickListLabel": "string",
507 "label": "string",
508 "cultureId": 0,
509 "labelDtos": [
510 {
511 "createdBy": "string",
512 "lastModifiedBy": "string",
513 "createdDate": "2019-08-24T14:15:22Z",
514 "lastModifiedDate": "2019-08-24T14:15:22Z",
515 "archived": true,
516 "externalId": "string",
517 "id": 0,
518 "cultureId": 0,
519 "value": "string"
520 }
521 ]
522 },
523 "category": {
524 "createdBy": "string",
525 "lastModifiedBy": "string",
526 "createdDate": "2019-08-24T14:15:22Z",
527 "lastModifiedDate": "2019-08-24T14:15:22Z",
528 "archived": true,
529 "externalId": "string",
530 "id": 0,
531 "priority": 0,
532 "internalId": 0,
533 "pickListCode": "string",
534 "pickListLabel": "string",
535 "label": "string",
536 "cultureId": 0,
537 "labelDtos": [
538 {
539 "createdBy": "string",
540 "lastModifiedBy": "string",
541 "createdDate": "2019-08-24T14:15:22Z",
542 "lastModifiedDate": "2019-08-24T14:15:22Z",
543 "archived": true,
544 "externalId": "string",
545 "id": 0,
546 "cultureId": 0,
547 "value": "string"
548 }
549 ]
550 },
551 "status": {
552 "createdBy": "string",
553 "lastModifiedBy": "string",
554 "createdDate": "2019-08-24T14:15:22Z",
555 "lastModifiedDate": "2019-08-24T14:15:22Z",
556 "archived": true,
557 "externalId": "string",
558 "id": 0,
559 "priority": 0,
560 "internalId": 0,
561 "pickListCode": "string",
562 "pickListLabel": "string",
563 "label": "string",
564 "cultureId": 0,
565 "labelDtos": [
566 {
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 "cultureId": 0,
575 "value": "string"
576 }
577 ]
578 },
579 "addressDto": {
580 "createdBy": "string",
581 "lastModifiedBy": "string",
582 "createdDate": "2019-08-24T14:15:22Z",
583 "lastModifiedDate": "2019-08-24T14:15:22Z",
584 "archived": true,
585 "externalId": "string",
586 "id": 0,
587 "street": "string",
588 "civicNumber": "string",
589 "suite": "string",
590 "postalCode": "string",
591 "lon": 0.1,
592 "lat": 0.1,
593 "city": {
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 "province": {
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 "code": "string",
612 "country": {
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 "code": "string"
622 }
623 }
624 },
625 "district": {
626 "createdBy": "string",
627 "lastModifiedBy": "string",
628 "createdDate": "2019-08-24T14:15:22Z",
629 "lastModifiedDate": "2019-08-24T14:15:22Z",
630 "archived": true,
631 "externalId": "string",
632 "id": 0,
633 "name": "string",
634 "city": {
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 "province": {
644 "createdBy": "string",
645 "lastModifiedBy": "string",
646 "createdDate": "2019-08-24T14:15:22Z",
647 "lastModifiedDate": "2019-08-24T14:15:22Z",
648 "archived": true,
649 "externalId": "string",
650 "id": 0,
651 "name": "string",
652 "code": "string",
653 "country": {
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 }
664 }
665 }
666 },
667 "cityId": 0,
668 "districtId": 0
669 },
670 "secondAddressDto": {
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 "street": "string",
679 "civicNumber": "string",
680 "suite": "string",
681 "postalCode": "string",
682 "lon": 0.1,
683 "lat": 0.1,
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 "createdBy": "string",
695 "lastModifiedBy": "string",
696 "createdDate": "2019-08-24T14:15:22Z",
697 "lastModifiedDate": "2019-08-24T14:15:22Z",
698 "archived": true,
699 "externalId": "string",
700 "id": 0,
701 "name": "string",
702 "code": "string",
703 "country": {
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 }
714 }
715 },
716 "district": {
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 "name": "string",
725 "city": {
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 "province": {
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 "code": "string",
744 "country": {
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 }
755 }
756 }
757 },
758 "cityId": 0,
759 "districtId": 0
760 }
761 },
762 "status": {
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 "usage": {
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 "occupanciesDto": [
819 {
820 "createdBy": "string",
821 "lastModifiedBy": "string",
822 "createdDate": "2019-08-24T14:15:22Z",
823 "lastModifiedDate": "2019-08-24T14:15:22Z",
824 "archived": true,
825 "externalId": "string",
826 "id": 0,
827 "priority": 0,
828 "internalId": 0,
829 "pickListCode": "string",
830 "pickListLabel": "string",
831 "label": "string",
832 "cultureId": 0,
833 "labelDtos": [
834 {
835 "createdBy": "string",
836 "lastModifiedBy": "string",
837 "createdDate": "2019-08-24T14:15:22Z",
838 "lastModifiedDate": "2019-08-24T14:15:22Z",
839 "archived": true,
840 "externalId": "string",
841 "id": 0,
842 "cultureId": 0,
843 "value": "string"
844 }
845 ]
846 }
847 ]
848 },
849 "isTerminationVersion": true
850 }
851 }
852]
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 |
Text value for value in LabelDto |
» 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 |
Text value for terminatingLease in LeaseDto |
»» maximumDateTo |
string(date) |
false |
none |
Text value for maximumDateTo in LeaseDto |
»» number |
string |
false |
none |
Text value for number in LeaseDto |
»» 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 |
Text value for registrationNumber in LeaseDto |
»» 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 |
»» 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 |
Text value for indexationTypeNonLease in LeaseDto |
»» cpiGlobalCategoryIdNonLease |
integer(int64) |
false |
none |
Numeric value representing cpiGlobalCategoryIdNonLease |
»» indexationReferenceDateNonLease |
string(date) |
false |
none |
Text value for indexationReferenceDateNonLease in LeaseDto |
»» 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 |
Text value for reviewedBy in EventDto |
»»»» 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 |
Text value for detail in EventDto |
»»»» 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 |
Text value for message in Note |
»»»»» preserveOriginalAudit |
boolean |
false |
none |
none |
»»»»» originalCreatedBy |
string |
false |
none |
none |
»»»»» originalCreatedDate |
string(date-time) |
false |
none |
none |
»»»»» originalLastModifiedBy |
string |
false |
none |
none |
»»»»» originalLastModifiedDate |
string(date-time) |
false |
none |
none |
»»»» 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. |
|
»»» 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 |
»» 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 |
Text value for number in PremiseDto |
»»» 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 |
Text value for number in LocationDto |
»»»» name |
string |
true |
none |
Name of the resource |
»»»» storeNumber |
string |
true |
none |
Text value for storeNumber in LocationDto |
»»»» 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 |
Text value for street in AddressDto |
»»»»» civicNumber |
string |
false |
none |
Text value for civicNumber in AddressDto |
»»»»» suite |
string |
false |
none |
Text value for suite in AddressDto |
»»»»» 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 |
»»»»» 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 |
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 "typeId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "replaceById": 0,
14 "managedById": 0,
15 "payById": 0,
16 "adminFee": 0,
17 "fixedIncreasePercentage": 0,
18 "note": "string",
19 "pageNumber": "string",
20 "section": "string",
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "replaceBy": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 },
77 "managedBy": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "payBy": {
106 "createdBy": "string",
107 "lastModifiedBy": "string",
108 "createdDate": "2019-08-24T14:15:22Z",
109 "lastModifiedDate": "2019-08-24T14:15:22Z",
110 "archived": true,
111 "externalId": "string",
112 "id": 0,
113 "priority": 0,
114 "internalId": 0,
115 "pickListCode": "string",
116 "pickListLabel": "string",
117 "label": "string",
118 "cultureId": 0,
119 "labelDtos": [
120 {
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 "cultureId": 0,
129 "value": "string"
130 }
131 ]
132 },
133 "proShareDto": {
134 "createdBy": "string",
135 "lastModifiedBy": "string",
136 "createdDate": "2019-08-24T14:15:22Z",
137 "lastModifiedDate": "2019-08-24T14:15:22Z",
138 "archived": true,
139 "externalId": "string",
140 "id": 0,
141 "type": "string"
142 },
143 "capDto": {
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 "type": "string"
152 }
153 }
154]
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 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "replaceById": 0,
14 "managedById": 0,
15 "payById": 0,
16 "adminFee": 0,
17 "fixedIncreasePercentage": 0,
18 "note": "string",
19 "pageNumber": "string",
20 "section": "string",
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "replaceBy": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 },
77 "managedBy": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "payBy": {
106 "createdBy": "string",
107 "lastModifiedBy": "string",
108 "createdDate": "2019-08-24T14:15:22Z",
109 "lastModifiedDate": "2019-08-24T14:15:22Z",
110 "archived": true,
111 "externalId": "string",
112 "id": 0,
113 "priority": 0,
114 "internalId": 0,
115 "pickListCode": "string",
116 "pickListLabel": "string",
117 "label": "string",
118 "cultureId": 0,
119 "labelDtos": [
120 {
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 "cultureId": 0,
129 "value": "string"
130 }
131 ]
132 },
133 "proShareDto": {
134 "createdBy": "string",
135 "lastModifiedBy": "string",
136 "createdDate": "2019-08-24T14:15:22Z",
137 "lastModifiedDate": "2019-08-24T14:15:22Z",
138 "archived": true,
139 "externalId": "string",
140 "id": 0,
141 "type": "string"
142 },
143 "capDto": {
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 "type": "string"
152 }
153 }
154]
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 |
» 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 |
Text value for note in LeaseConditionDto |
» pageNumber |
string |
false |
none |
Page number for pagination |
» section |
string |
false |
none |
Text value for section in LeaseConditionDto |
» 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 |
Text value for value in LabelDto |
» 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 |
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 |
Text value for value in LabelDto |
» leaseId |
integer(int64) |
false |
none |
Unique identifier for the 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 |
Text value for section in InsuranceDto |
» 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 |
Text value for value in LabelDto |
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 |
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 "version": {
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 "name": "string",
128 "description": "string",
129 "modificationDate": "2019-08-24",
130 "updateContractRate": true,
131 "leaseEvent": {
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 "typeId": 0,
140 "code": "string",
141 "reviewedBy": "string",
142 "reviewedDate": "2019-08-24",
143 "reviewedStatusId": 0,
144 "activityDate": "2019-08-24",
145 "relatedPickListOptionId": 0,
146 "detail": "string",
147 "note": {
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 "message": "string",
156 "preserveOriginalAudit": true,
157 "originalCreatedBy": "string",
158 "originalCreatedDate": "2019-08-24T14:15:22Z",
159 "originalLastModifiedBy": "string",
160 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
161 },
162 "type": {
163 "createdBy": "string",
164 "lastModifiedBy": "string",
165 "createdDate": "2019-08-24T14:15:22Z",
166 "lastModifiedDate": "2019-08-24T14:15:22Z",
167 "archived": true,
168 "externalId": "string",
169 "id": 0,
170 "priority": 0,
171 "internalId": 0,
172 "pickListCode": "string",
173 "pickListLabel": "string",
174 "label": "string",
175 "cultureId": 0,
176 "labelDtos": [
177 {
178 "createdBy": "string",
179 "lastModifiedBy": "string",
180 "createdDate": "2019-08-24T14:15:22Z",
181 "lastModifiedDate": "2019-08-24T14:15:22Z",
182 "archived": true,
183 "externalId": "string",
184 "id": 0,
185 "cultureId": 0,
186 "value": "string"
187 }
188 ]
189 },
190 "reviewedStatus": {
191 "createdBy": "string",
192 "lastModifiedBy": "string",
193 "createdDate": "2019-08-24T14:15:22Z",
194 "lastModifiedDate": "2019-08-24T14:15:22Z",
195 "archived": true,
196 "externalId": "string",
197 "id": 0,
198 "priority": 0,
199 "internalId": 0,
200 "pickListCode": "string",
201 "pickListLabel": "string",
202 "label": "string",
203 "cultureId": 0,
204 "labelDtos": [
205 {
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 "cultureId": 0,
214 "value": "string"
215 }
216 ]
217 },
218 "relatedPickListOption": {
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 "priority": 0,
227 "internalId": 0,
228 "pickListCode": "string",
229 "pickListLabel": "string",
230 "label": "string",
231 "cultureId": 0,
232 "labelDtos": [
233 {
234 "createdBy": "string",
235 "lastModifiedBy": "string",
236 "createdDate": "2019-08-24T14:15:22Z",
237 "lastModifiedDate": "2019-08-24T14:15:22Z",
238 "archived": true,
239 "externalId": "string",
240 "id": 0,
241 "cultureId": 0,
242 "value": "string"
243 }
244 ]
245 }
246 },
247 "isVisibleVendorPortal": true,
248 "isTerminationVersion": true,
249 "terminationDate": "2019-08-24",
250 "penaltyAmount": 0.1
251 }
252 }
253 ]
254 },
255 "page": {
256 "size": 0,
257 "totalElements": 0,
258 "totalPages": 0,
259 "number": 0
260 }
261}
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 }
118]
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 }
118]
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 |
Text value for reviewedBy in EventDto |
» 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 |
Text value for detail in EventDto |
» 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 |
Text value for message in Note |
»» preserveOriginalAudit |
boolean |
false |
none |
none |
»» originalCreatedBy |
string |
false |
none |
none |
»» originalCreatedDate |
string(date-time) |
false |
none |
none |
»» originalLastModifiedBy |
string |
false |
none |
none |
»» originalLastModifiedDate |
string(date-time) |
false |
none |
none |
» 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 |
Text value for value in LabelDto |
» 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. |
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 |
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "isVisibleVendorPortal": true,
285 "isTerminationVersion": true,
286 "terminationDate": "2019-08-24",
287 "penaltyAmount": 0.1
288 },
289 "premiseDto": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "number": "string",
298 "name": "string",
299 "headPremise": true,
300 "possessionDate": "2019-08-24",
301 "openingDate": "2019-08-24",
302 "closingDate": "2019-08-24",
303 "relocationDate": "2019-08-24",
304 "vacatingDate": "2019-08-24",
305 "expansionDate": "2019-08-24",
306 "statusId": 0,
307 "usageId": 0,
308 "parentPremiseId": 0,
309 "costCenterId": 0,
310 "profitCenterId": 0,
311 "legalEntityId": 0,
312 "occupancyIds": [
313 0
314 ],
315 "locationId": 0,
316 "locationDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "number": "string",
325 "name": "string",
326 "storeNumber": "string",
327 "defaultCurrencyId": 0,
328 "defaultMeasureId": 0,
329 "typeId": 0,
330 "qualityId": 0,
331 "propertyTypeId": 0,
332 "categoryId": 0,
333 "statusId": 0,
334 "businessUnitId": 0,
335 "groupIds": [
336 0
337 ],
338 "legalEntityIds": [
339 0
340 ],
341 "defaultCurrency": {
342 "id": 0,
343 "status": "CREATED",
344 "displayId": "string",
345 "erpSystemId": 0,
346 "erpSystemDisplayId": "string",
347 "name": "string",
348 "decimalPoints": 0,
349 "depreciationAreaId": 0
350 },
351 "defaultUnitValue": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "unitId": 0,
360 "unitOfMeasureId": 0,
361 "erpSystemId": 0,
362 "unit": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "unitOfMeasure": {
391 "id": 0,
392 "status": "CREATED",
393 "displayId": "string",
394 "erpSystemId": 0,
395 "erpSystemDisplayId": "string",
396 "name": "string"
397 }
398 },
399 "type": {
400 "createdBy": "string",
401 "lastModifiedBy": "string",
402 "createdDate": "2019-08-24T14:15:22Z",
403 "lastModifiedDate": "2019-08-24T14:15:22Z",
404 "archived": true,
405 "externalId": "string",
406 "id": 0,
407 "priority": 0,
408 "internalId": 0,
409 "pickListCode": "string",
410 "pickListLabel": "string",
411 "label": "string",
412 "cultureId": 0,
413 "labelDtos": [
414 {
415 "createdBy": "string",
416 "lastModifiedBy": "string",
417 "createdDate": "2019-08-24T14:15:22Z",
418 "lastModifiedDate": "2019-08-24T14:15:22Z",
419 "archived": true,
420 "externalId": "string",
421 "id": 0,
422 "cultureId": 0,
423 "value": "string"
424 }
425 ]
426 },
427 "quality": {
428 "createdBy": "string",
429 "lastModifiedBy": "string",
430 "createdDate": "2019-08-24T14:15:22Z",
431 "lastModifiedDate": "2019-08-24T14:15:22Z",
432 "archived": true,
433 "externalId": "string",
434 "id": 0,
435 "priority": 0,
436 "internalId": 0,
437 "pickListCode": "string",
438 "pickListLabel": "string",
439 "label": "string",
440 "cultureId": 0,
441 "labelDtos": [
442 {
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 "cultureId": 0,
451 "value": "string"
452 }
453 ]
454 },
455 "propertyType": {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "priority": 0,
464 "internalId": 0,
465 "pickListCode": "string",
466 "pickListLabel": "string",
467 "label": "string",
468 "cultureId": 0,
469 "labelDtos": [
470 {
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 "cultureId": 0,
479 "value": "string"
480 }
481 ]
482 },
483 "category": {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "priority": 0,
492 "internalId": 0,
493 "pickListCode": "string",
494 "pickListLabel": "string",
495 "label": "string",
496 "cultureId": 0,
497 "labelDtos": [
498 {
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 "cultureId": 0,
507 "value": "string"
508 }
509 ]
510 },
511 "status": {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "priority": 0,
520 "internalId": 0,
521 "pickListCode": "string",
522 "pickListLabel": "string",
523 "label": "string",
524 "cultureId": 0,
525 "labelDtos": [
526 {
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 "cultureId": 0,
535 "value": "string"
536 }
537 ]
538 },
539 "addressDto": {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "street": "string",
548 "civicNumber": "string",
549 "suite": "string",
550 "postalCode": "string",
551 "lon": 0.1,
552 "lat": 0.1,
553 "city": {
554 "createdBy": "string",
555 "lastModifiedBy": "string",
556 "createdDate": "2019-08-24T14:15:22Z",
557 "lastModifiedDate": "2019-08-24T14:15:22Z",
558 "archived": true,
559 "externalId": "string",
560 "id": 0,
561 "name": "string",
562 "province": {
563 "createdBy": "string",
564 "lastModifiedBy": "string",
565 "createdDate": "2019-08-24T14:15:22Z",
566 "lastModifiedDate": "2019-08-24T14:15:22Z",
567 "archived": true,
568 "externalId": "string",
569 "id": 0,
570 "name": "string",
571 "code": "string",
572 "country": {
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 "code": "string"
582 }
583 }
584 },
585 "district": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
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 }
675 },
676 "district": {
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 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 }
717 },
718 "cityId": 0,
719 "districtId": 0
720 }
721 },
722 "status": {
723 "createdBy": "string",
724 "lastModifiedBy": "string",
725 "createdDate": "2019-08-24T14:15:22Z",
726 "lastModifiedDate": "2019-08-24T14:15:22Z",
727 "archived": true,
728 "externalId": "string",
729 "id": 0,
730 "priority": 0,
731 "internalId": 0,
732 "pickListCode": "string",
733 "pickListLabel": "string",
734 "label": "string",
735 "cultureId": 0,
736 "labelDtos": [
737 {
738 "createdBy": "string",
739 "lastModifiedBy": "string",
740 "createdDate": "2019-08-24T14:15:22Z",
741 "lastModifiedDate": "2019-08-24T14:15:22Z",
742 "archived": true,
743 "externalId": "string",
744 "id": 0,
745 "cultureId": 0,
746 "value": "string"
747 }
748 ]
749 },
750 "usage": {
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 "priority": 0,
759 "internalId": 0,
760 "pickListCode": "string",
761 "pickListLabel": "string",
762 "label": "string",
763 "cultureId": 0,
764 "labelDtos": [
765 {
766 "createdBy": "string",
767 "lastModifiedBy": "string",
768 "createdDate": "2019-08-24T14:15:22Z",
769 "lastModifiedDate": "2019-08-24T14:15:22Z",
770 "archived": true,
771 "externalId": "string",
772 "id": 0,
773 "cultureId": 0,
774 "value": "string"
775 }
776 ]
777 },
778 "occupanciesDto": [
779 {
780 "createdBy": "string",
781 "lastModifiedBy": "string",
782 "createdDate": "2019-08-24T14:15:22Z",
783 "lastModifiedDate": "2019-08-24T14:15:22Z",
784 "archived": true,
785 "externalId": "string",
786 "id": 0,
787 "priority": 0,
788 "internalId": 0,
789 "pickListCode": "string",
790 "pickListLabel": "string",
791 "label": "string",
792 "cultureId": 0,
793 "labelDtos": [
794 {
795 "createdBy": "string",
796 "lastModifiedBy": "string",
797 "createdDate": "2019-08-24T14:15:22Z",
798 "lastModifiedDate": "2019-08-24T14:15:22Z",
799 "archived": true,
800 "externalId": "string",
801 "id": 0,
802 "cultureId": 0,
803 "value": "string"
804 }
805 ]
806 }
807 ]
808 },
809 "isTerminationVersion": true
810}
Search Leases By CPI Leases Profile Filter¶
HTTP Request
POST /api/leases/cpi-profile-filters/search
📋 Description: Submits a search request for CPI profile filters within the Nakisa Portfolio Management Suite, enabling users to analyze and refine portfolio and asset data related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results for CPI profile filters should be paginated, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific lease-related data within the Nakisa Portfolio Management Suite, enhancing analytics for portfolio and asset management in real estate properties. |
premise-id |
query |
string |
false |
Unique identifier for the real estate property within the Nakisa Portfolio Management Suite, used to filter CPI profile search results in the context of portfolio and asset analytics. |
premise-id-in |
query |
string |
false |
Unique identifier for the real estate property within the portfolio, used to filter CPI profile search results in the Nakisa Portfolio Management Suite. |
premise-id-not-null |
query |
string |
false |
Unique identifier for the real estate property, ensuring that the search for CPI profile filters in the Nakisa Portfolio Management Suite is associated with a valid premise. |
premise-number |
query |
string |
false |
Unique identifier for the real estate property associated with the lease, used to filter CPI profile search results within the Nakisa Portfolio Management Suite. |
premise-number-like |
query |
string |
false |
Specifies a string pattern to filter lease records based on the premise number, facilitating targeted searches within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
premise-external-id |
query |
string |
false |
Unique identifier for the external premise associated with the lease, facilitating precise asset tracking and analytics within the Nakisa Portfolio Management Suite. |
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to filter CPI profile search results related to portfolio and asset analytics in real estate properties. |
location-number |
query |
string |
false |
Represents the specific location number associated with the real estate property within the portfolio, used to filter CPI profile search results. |
location-number-like |
query |
string |
false |
Specifies a location number pattern to filter search results for leases within the Nakisa Portfolio Management Suite, enhancing asset and portfolio analytics in real estate property management. |
location-external-id |
query |
string |
false |
Unique identifier for the external location associated with the lease, facilitating precise asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
address-id |
query |
string |
false |
Unique identifier for the specific address associated with the lease, facilitating targeted searches within the Nakisa Portfolio Management Suite’s asset and portfolio analytics. |
city-id |
query |
string |
false |
Unique identifier for the city associated with the lease, used to filter CPI profile search results within the Nakisa Portfolio Management Suite. |
province-id |
query |
string |
false |
Unique identifier for the province associated with the lease search, facilitating targeted analytics within the Nakisa Portfolio Management Suite. |
country-id |
query |
string |
false |
Unique identifier for the country, used to filter and refine search results within the CPI profile in the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
contract-id |
query |
string |
false |
Unique identifier for the lease contract, used to filter and retrieve specific CPI profile data within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
Represents the numerical identifier associated with a specific lease within the Nakisa Portfolio Management Suite, facilitating targeted searches in the context of portfolio and asset analytics. |
number-like |
query |
string |
false |
Represents a numeric value or identifier relevant to portfolio analytics and asset management within the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Unique identifier for the type of asset or portfolio being filtered in the CPI profile search within the Nakisa Portfolio Management Suite. |
terminating-lease |
query |
string |
false |
Specifies the type of terminating lease to filter search results within the portfolio and asset analytics for real estate properties. |
signature-date |
query |
string |
false |
Specifies the date of the signature for the lease agreement, which is essential for portfolio analytics and asset management within the Nakisa Portfolio Management Suite. |
category-id |
query |
string |
false |
Unique identifier for the category associated with the lease search, enabling targeted filtering within the Nakisa Portfolio Management Suite’s analytics for real estate properties. |
registration-number |
query |
string |
false |
Unique identifier for the lease registration, used to filter and retrieve specific CPI profiles within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of a lease, used to filter CPI profile search results within the Nakisa Portfolio Management Suite. |
status-id-is-not |
query |
string |
false |
Specifies a string value to exclude leases with the given status ID from the search results, enhancing the filtering capabilities for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id-in |
query |
string |
false |
Specifies the status identifier to filter lease profiles in the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
original-lease-id |
query |
string |
false |
Unique identifier for the original lease, used to filter and retrieve specific lease-related analytics within the Nakisa Portfolio Management Suite. |
state-id |
query |
string |
false |
Unique identifier for the state associated with the lease, used to filter CPI profile search results within the Nakisa Portfolio Management Suite. |
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 |
Request body containing the criteria for filtering CPI profiles, including portfolio, asset, and real estate property attributes for analytical purposes. |
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 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "cityIds": [
18 0
19 ],
20 "provinceIds": [
21 0
22 ],
23 "countryIds": [
24 0
25 ],
26 "premiseIds": [
27 0
28 ],
29 "locationIds": [
30 0
31 ],
32 "businessUnitIds": [
33 0
34 ],
35 "legalEntityIds": [
36 0
37 ],
38 "groupIds": [
39 "string"
40 ],
41 "groupOptionIds": [
42 0
43 ],
44 "masterAgreementIds": [
45 0
46 ],
47 "contractIds": [
48 0
49 ],
50 "cities": [
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 "name": "string",
60 "province": {
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 "name": "string",
69 "country": {
70 "createdBy": "string",
71 "lastModifiedBy": "string",
72 "createdDate": "2019-08-24T14:15:22Z",
73 "lastModifiedDate": "2019-08-24T14:15:22Z",
74 "archived": true,
75 "externalId": "string",
76 "id": 0,
77 "name": "string",
78 "code": "string"
79 },
80 "code": "string",
81 "countryId": 0
82 },
83 "provinceId": 0
84 }
85 ],
86 "provinces": [
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 "name": "string",
96 "country": {
97 "createdBy": "string",
98 "lastModifiedBy": "string",
99 "createdDate": "2019-08-24T14:15:22Z",
100 "lastModifiedDate": "2019-08-24T14:15:22Z",
101 "archived": true,
102 "externalId": "string",
103 "id": 0,
104 "name": "string",
105 "code": "string"
106 },
107 "code": "string",
108 "countryId": 0
109 }
110 ],
111 "countries": [
112 {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "name": "string",
121 "code": "string"
122 }
123 ],
124 "locations": [
125 {
126 "createdBy": "string",
127 "lastModifiedBy": "string",
128 "createdDate": "2019-08-24T14:15:22Z",
129 "lastModifiedDate": "2019-08-24T14:15:22Z",
130 "archived": true,
131 "externalId": "string",
132 "id": 0,
133 "number": "string",
134 "name": "string",
135 "storeNumber": "string",
136 "defaultCurrencyId": 0,
137 "defaultMeasureId": 0,
138 "typeId": 0,
139 "qualityId": 0,
140 "propertyTypeId": 0,
141 "categoryId": 0,
142 "statusId": 0,
143 "businessUnitId": 0,
144 "groupIds": [
145 0
146 ],
147 "legalEntityIds": [
148 0
149 ],
150 "defaultCurrency": {
151 "id": 0,
152 "status": "CREATED",
153 "displayId": "string",
154 "erpSystemId": 0,
155 "erpSystemDisplayId": "string",
156 "name": "string",
157 "decimalPoints": 0,
158 "depreciationAreaId": 0
159 },
160 "defaultUnitValue": {
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 "unitId": 0,
169 "unitOfMeasureId": 0,
170 "erpSystemId": 0,
171 "unit": {
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 "unitOfMeasure": {
200 "id": 0,
201 "status": "CREATED",
202 "displayId": "string",
203 "erpSystemId": 0,
204 "erpSystemDisplayId": "string",
205 "name": "string"
206 }
207 },
208 "type": {
209 "createdBy": "string",
210 "lastModifiedBy": "string",
211 "createdDate": "2019-08-24T14:15:22Z",
212 "lastModifiedDate": "2019-08-24T14:15:22Z",
213 "archived": true,
214 "externalId": "string",
215 "id": 0,
216 "priority": 0,
217 "internalId": 0,
218 "pickListCode": "string",
219 "pickListLabel": "string",
220 "label": "string",
221 "cultureId": 0,
222 "labelDtos": [
223 {
224 "createdBy": "string",
225 "lastModifiedBy": "string",
226 "createdDate": "2019-08-24T14:15:22Z",
227 "lastModifiedDate": "2019-08-24T14:15:22Z",
228 "archived": true,
229 "externalId": "string",
230 "id": 0,
231 "cultureId": 0,
232 "value": "string"
233 }
234 ]
235 },
236 "quality": {
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 "priority": 0,
245 "internalId": 0,
246 "pickListCode": "string",
247 "pickListLabel": "string",
248 "label": "string",
249 "cultureId": 0,
250 "labelDtos": [
251 {
252 "createdBy": "string",
253 "lastModifiedBy": "string",
254 "createdDate": "2019-08-24T14:15:22Z",
255 "lastModifiedDate": "2019-08-24T14:15:22Z",
256 "archived": true,
257 "externalId": "string",
258 "id": 0,
259 "cultureId": 0,
260 "value": "string"
261 }
262 ]
263 },
264 "propertyType": {
265 "createdBy": "string",
266 "lastModifiedBy": "string",
267 "createdDate": "2019-08-24T14:15:22Z",
268 "lastModifiedDate": "2019-08-24T14:15:22Z",
269 "archived": true,
270 "externalId": "string",
271 "id": 0,
272 "priority": 0,
273 "internalId": 0,
274 "pickListCode": "string",
275 "pickListLabel": "string",
276 "label": "string",
277 "cultureId": 0,
278 "labelDtos": [
279 {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "cultureId": 0,
288 "value": "string"
289 }
290 ]
291 },
292 "category": {
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 "priority": 0,
301 "internalId": 0,
302 "pickListCode": "string",
303 "pickListLabel": "string",
304 "label": "string",
305 "cultureId": 0,
306 "labelDtos": [
307 {
308 "createdBy": "string",
309 "lastModifiedBy": "string",
310 "createdDate": "2019-08-24T14:15:22Z",
311 "lastModifiedDate": "2019-08-24T14:15:22Z",
312 "archived": true,
313 "externalId": "string",
314 "id": 0,
315 "cultureId": 0,
316 "value": "string"
317 }
318 ]
319 },
320 "status": {
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 "priority": 0,
329 "internalId": 0,
330 "pickListCode": "string",
331 "pickListLabel": "string",
332 "label": "string",
333 "cultureId": 0,
334 "labelDtos": [
335 {
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 "cultureId": 0,
344 "value": "string"
345 }
346 ]
347 },
348 "addressDto": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "street": "string",
357 "civicNumber": "string",
358 "suite": "string",
359 "postalCode": "string",
360 "lon": 0.1,
361 "lat": 0.1,
362 "city": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "name": "string",
371 "province": {
372 "createdBy": "string",
373 "lastModifiedBy": "string",
374 "createdDate": "2019-08-24T14:15:22Z",
375 "lastModifiedDate": "2019-08-24T14:15:22Z",
376 "archived": true,
377 "externalId": "string",
378 "id": 0,
379 "name": "string",
380 "code": "string",
381 "country": {
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 "name": "string",
390 "code": "string"
391 }
392 }
393 },
394 "district": {
395 "createdBy": "string",
396 "lastModifiedBy": "string",
397 "createdDate": "2019-08-24T14:15:22Z",
398 "lastModifiedDate": "2019-08-24T14:15:22Z",
399 "archived": true,
400 "externalId": "string",
401 "id": 0,
402 "name": "string",
403 "city": {
404 "createdBy": "string",
405 "lastModifiedBy": "string",
406 "createdDate": "2019-08-24T14:15:22Z",
407 "lastModifiedDate": "2019-08-24T14:15:22Z",
408 "archived": true,
409 "externalId": "string",
410 "id": 0,
411 "name": "string",
412 "province": {
413 "createdBy": "string",
414 "lastModifiedBy": "string",
415 "createdDate": "2019-08-24T14:15:22Z",
416 "lastModifiedDate": "2019-08-24T14:15:22Z",
417 "archived": true,
418 "externalId": "string",
419 "id": 0,
420 "name": "string",
421 "code": "string",
422 "country": {
423 "createdBy": "string",
424 "lastModifiedBy": "string",
425 "createdDate": "2019-08-24T14:15:22Z",
426 "lastModifiedDate": "2019-08-24T14:15:22Z",
427 "archived": true,
428 "externalId": "string",
429 "id": 0,
430 "name": "string",
431 "code": "string"
432 }
433 }
434 }
435 },
436 "cityId": 0,
437 "districtId": 0
438 },
439 "secondAddressDto": {
440 "createdBy": "string",
441 "lastModifiedBy": "string",
442 "createdDate": "2019-08-24T14:15:22Z",
443 "lastModifiedDate": "2019-08-24T14:15:22Z",
444 "archived": true,
445 "externalId": "string",
446 "id": 0,
447 "street": "string",
448 "civicNumber": "string",
449 "suite": "string",
450 "postalCode": "string",
451 "lon": 0.1,
452 "lat": 0.1,
453 "city": {
454 "createdBy": "string",
455 "lastModifiedBy": "string",
456 "createdDate": "2019-08-24T14:15:22Z",
457 "lastModifiedDate": "2019-08-24T14:15:22Z",
458 "archived": true,
459 "externalId": "string",
460 "id": 0,
461 "name": "string",
462 "province": {
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 "name": "string",
471 "code": "string",
472 "country": {
473 "createdBy": "string",
474 "lastModifiedBy": "string",
475 "createdDate": "2019-08-24T14:15:22Z",
476 "lastModifiedDate": "2019-08-24T14:15:22Z",
477 "archived": true,
478 "externalId": "string",
479 "id": 0,
480 "name": "string",
481 "code": "string"
482 }
483 }
484 },
485 "district": {
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 "name": "string",
494 "city": {
495 "createdBy": "string",
496 "lastModifiedBy": "string",
497 "createdDate": "2019-08-24T14:15:22Z",
498 "lastModifiedDate": "2019-08-24T14:15:22Z",
499 "archived": true,
500 "externalId": "string",
501 "id": 0,
502 "name": "string",
503 "province": {
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 "name": "string",
512 "code": "string",
513 "country": {
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 "name": "string",
522 "code": "string"
523 }
524 }
525 }
526 },
527 "cityId": 0,
528 "districtId": 0
529 }
530 }
531 ],
532 "premises": [
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 "number": "string",
542 "name": "string",
543 "headPremise": true,
544 "possessionDate": "2019-08-24",
545 "openingDate": "2019-08-24",
546 "closingDate": "2019-08-24",
547 "relocationDate": "2019-08-24",
548 "vacatingDate": "2019-08-24",
549 "expansionDate": "2019-08-24",
550 "statusId": 0,
551 "usageId": 0,
552 "parentPremiseId": 0,
553 "costCenterId": 0,
554 "profitCenterId": 0,
555 "legalEntityId": 0,
556 "occupancyIds": [
557 0
558 ],
559 "locationId": 0,
560 "locationDto": {
561 "createdBy": "string",
562 "lastModifiedBy": "string",
563 "createdDate": "2019-08-24T14:15:22Z",
564 "lastModifiedDate": "2019-08-24T14:15:22Z",
565 "archived": true,
566 "externalId": "string",
567 "id": 0,
568 "number": "string",
569 "name": "string",
570 "storeNumber": "string",
571 "defaultCurrencyId": 0,
572 "defaultMeasureId": 0,
573 "typeId": 0,
574 "qualityId": 0,
575 "propertyTypeId": 0,
576 "categoryId": 0,
577 "statusId": 0,
578 "businessUnitId": 0,
579 "groupIds": [
580 0
581 ],
582 "legalEntityIds": [
583 0
584 ],
585 "defaultCurrency": {
586 "id": 0,
587 "status": "CREATED",
588 "displayId": "string",
589 "erpSystemId": 0,
590 "erpSystemDisplayId": "string",
591 "name": "string",
592 "decimalPoints": 0,
593 "depreciationAreaId": 0
594 },
595 "defaultUnitValue": {
596 "createdBy": "string",
597 "lastModifiedBy": "string",
598 "createdDate": "2019-08-24T14:15:22Z",
599 "lastModifiedDate": "2019-08-24T14:15:22Z",
600 "archived": true,
601 "externalId": "string",
602 "id": 0,
603 "unitId": 0,
604 "unitOfMeasureId": 0,
605 "erpSystemId": 0,
606 "unit": {
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 "priority": 0,
615 "internalId": 0,
616 "pickListCode": "string",
617 "pickListLabel": "string",
618 "label": "string",
619 "cultureId": 0,
620 "labelDtos": [
621 {
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 "cultureId": 0,
630 "value": "string"
631 }
632 ]
633 },
634 "unitOfMeasure": {
635 "id": 0,
636 "status": "CREATED",
637 "displayId": "string",
638 "erpSystemId": 0,
639 "erpSystemDisplayId": "string",
640 "name": "string"
641 }
642 },
643 "type": {
644 "createdBy": "string",
645 "lastModifiedBy": "string",
646 "createdDate": "2019-08-24T14:15:22Z",
647 "lastModifiedDate": "2019-08-24T14:15:22Z",
648 "archived": true,
649 "externalId": "string",
650 "id": 0,
651 "priority": 0,
652 "internalId": 0,
653 "pickListCode": "string",
654 "pickListLabel": "string",
655 "label": "string",
656 "cultureId": 0,
657 "labelDtos": [
658 {
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 "cultureId": 0,
667 "value": "string"
668 }
669 ]
670 },
671 "quality": {
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 "priority": 0,
680 "internalId": 0,
681 "pickListCode": "string",
682 "pickListLabel": "string",
683 "label": "string",
684 "cultureId": 0,
685 "labelDtos": [
686 {
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 "cultureId": 0,
695 "value": "string"
696 }
697 ]
698 },
699 "propertyType": {
700 "createdBy": "string",
701 "lastModifiedBy": "string",
702 "createdDate": "2019-08-24T14:15:22Z",
703 "lastModifiedDate": "2019-08-24T14:15:22Z",
704 "archived": true,
705 "externalId": "string",
706 "id": 0,
707 "priority": 0,
708 "internalId": 0,
709 "pickListCode": "string",
710 "pickListLabel": "string",
711 "label": "string",
712 "cultureId": 0,
713 "labelDtos": [
714 {
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 "cultureId": 0,
723 "value": "string"
724 }
725 ]
726 },
727 "category": {
728 "createdBy": "string",
729 "lastModifiedBy": "string",
730 "createdDate": "2019-08-24T14:15:22Z",
731 "lastModifiedDate": "2019-08-24T14:15:22Z",
732 "archived": true,
733 "externalId": "string",
734 "id": 0,
735 "priority": 0,
736 "internalId": 0,
737 "pickListCode": "string",
738 "pickListLabel": "string",
739 "label": "string",
740 "cultureId": 0,
741 "labelDtos": [
742 {
743 "createdBy": "string",
744 "lastModifiedBy": "string",
745 "createdDate": "2019-08-24T14:15:22Z",
746 "lastModifiedDate": "2019-08-24T14:15:22Z",
747 "archived": true,
748 "externalId": "string",
749 "id": 0,
750 "cultureId": 0,
751 "value": "string"
752 }
753 ]
754 },
755 "status": {
756 "createdBy": "string",
757 "lastModifiedBy": "string",
758 "createdDate": "2019-08-24T14:15:22Z",
759 "lastModifiedDate": "2019-08-24T14:15:22Z",
760 "archived": true,
761 "externalId": "string",
762 "id": 0,
763 "priority": 0,
764 "internalId": 0,
765 "pickListCode": "string",
766 "pickListLabel": "string",
767 "label": "string",
768 "cultureId": 0,
769 "labelDtos": [
770 {
771 "createdBy": "string",
772 "lastModifiedBy": "string",
773 "createdDate": "2019-08-24T14:15:22Z",
774 "lastModifiedDate": "2019-08-24T14:15:22Z",
775 "archived": true,
776 "externalId": "string",
777 "id": 0,
778 "cultureId": 0,
779 "value": "string"
780 }
781 ]
782 },
783 "addressDto": {
784 "createdBy": "string",
785 "lastModifiedBy": "string",
786 "createdDate": "2019-08-24T14:15:22Z",
787 "lastModifiedDate": "2019-08-24T14:15:22Z",
788 "archived": true,
789 "externalId": "string",
790 "id": 0,
791 "street": "string",
792 "civicNumber": "string",
793 "suite": "string",
794 "postalCode": "string",
795 "lon": 0.1,
796 "lat": 0.1,
797 "city": {
798 "createdBy": "string",
799 "lastModifiedBy": "string",
800 "createdDate": "2019-08-24T14:15:22Z",
801 "lastModifiedDate": "2019-08-24T14:15:22Z",
802 "archived": true,
803 "externalId": "string",
804 "id": 0,
805 "name": "string",
806 "province": {
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 "name": "string",
815 "code": "string",
816 "country": {
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 "name": "string",
825 "code": "string"
826 }
827 }
828 },
829 "district": {
830 "createdBy": "string",
831 "lastModifiedBy": "string",
832 "createdDate": "2019-08-24T14:15:22Z",
833 "lastModifiedDate": "2019-08-24T14:15:22Z",
834 "archived": true,
835 "externalId": "string",
836 "id": 0,
837 "name": "string",
838 "city": {
839 "createdBy": "string",
840 "lastModifiedBy": "string",
841 "createdDate": "2019-08-24T14:15:22Z",
842 "lastModifiedDate": "2019-08-24T14:15:22Z",
843 "archived": true,
844 "externalId": "string",
845 "id": 0,
846 "name": "string",
847 "province": {
848 "createdBy": "string",
849 "lastModifiedBy": "string",
850 "createdDate": "2019-08-24T14:15:22Z",
851 "lastModifiedDate": "2019-08-24T14:15:22Z",
852 "archived": true,
853 "externalId": "string",
854 "id": 0,
855 "name": "string",
856 "code": "string",
857 "country": {
858 "createdBy": "string",
859 "lastModifiedBy": "string",
860 "createdDate": "2019-08-24T14:15:22Z",
861 "lastModifiedDate": "2019-08-24T14:15:22Z",
862 "archived": true,
863 "externalId": "string",
864 "id": 0,
865 "name": "string",
866 "code": "string"
867 }
868 }
869 }
870 },
871 "cityId": 0,
872 "districtId": 0
873 },
874 "secondAddressDto": {
875 "createdBy": "string",
876 "lastModifiedBy": "string",
877 "createdDate": "2019-08-24T14:15:22Z",
878 "lastModifiedDate": "2019-08-24T14:15:22Z",
879 "archived": true,
880 "externalId": "string",
881 "id": 0,
882 "street": "string",
883 "civicNumber": "string",
884 "suite": "string",
885 "postalCode": "string",
886 "lon": 0.1,
887 "lat": 0.1,
888 "city": {
889 "createdBy": "string",
890 "lastModifiedBy": "string",
891 "createdDate": "2019-08-24T14:15:22Z",
892 "lastModifiedDate": "2019-08-24T14:15:22Z",
893 "archived": true,
894 "externalId": "string",
895 "id": 0,
896 "name": "string",
897 "province": {
898 "createdBy": "string",
899 "lastModifiedBy": "string",
900 "createdDate": "2019-08-24T14:15:22Z",
901 "lastModifiedDate": "2019-08-24T14:15:22Z",
902 "archived": true,
903 "externalId": "string",
904 "id": 0,
905 "name": "string",
906 "code": "string",
907 "country": {
908 "createdBy": "string",
909 "lastModifiedBy": "string",
910 "createdDate": "2019-08-24T14:15:22Z",
911 "lastModifiedDate": "2019-08-24T14:15:22Z",
912 "archived": true,
913 "externalId": "string",
914 "id": 0,
915 "name": "string",
916 "code": "string"
917 }
918 }
919 },
920 "district": {
921 "createdBy": "string",
922 "lastModifiedBy": "string",
923 "createdDate": "2019-08-24T14:15:22Z",
924 "lastModifiedDate": "2019-08-24T14:15:22Z",
925 "archived": true,
926 "externalId": "string",
927 "id": 0,
928 "name": "string",
929 "city": {
930 "createdBy": "string",
931 "lastModifiedBy": "string",
932 "createdDate": "2019-08-24T14:15:22Z",
933 "lastModifiedDate": "2019-08-24T14:15:22Z",
934 "archived": true,
935 "externalId": "string",
936 "id": 0,
937 "name": "string",
938 "province": {
939 "createdBy": "string",
940 "lastModifiedBy": "string",
941 "createdDate": "2019-08-24T14:15:22Z",
942 "lastModifiedDate": "2019-08-24T14:15:22Z",
943 "archived": true,
944 "externalId": "string",
945 "id": 0,
946 "name": "string",
947 "code": "string",
948 "country": {
949 "createdBy": "string",
950 "lastModifiedBy": "string",
951 "createdDate": "2019-08-24T14:15:22Z",
952 "lastModifiedDate": "2019-08-24T14:15:22Z",
953 "archived": true,
954 "externalId": "string",
955 "id": 0,
956 "name": "string",
957 "code": "string"
958 }
959 }
960 }
961 },
962 "cityId": 0,
963 "districtId": 0
964 }
965 },
966 "status": {
967 "createdBy": "string",
968 "lastModifiedBy": "string",
969 "createdDate": "2019-08-24T14:15:22Z",
970 "lastModifiedDate": "2019-08-24T14:15:22Z",
971 "archived": true,
972 "externalId": "string",
973 "id": 0,
974 "priority": 0,
975 "internalId": 0,
976 "pickListCode": "string",
977 "pickListLabel": "string",
978 "label": "string",
979 "cultureId": 0,
980 "labelDtos": [
981 {
982 "createdBy": "string",
983 "lastModifiedBy": "string",
984 "createdDate": "2019-08-24T14:15:22Z",
985 "lastModifiedDate": "2019-08-24T14:15:22Z",
986 "archived": true,
987 "externalId": "string",
988 "id": 0,
989 "cultureId": 0,
990 "value": "string"
991 }
992 ]
993 },
994 "usage": {
995 "createdBy": "string",
996 "lastModifiedBy": "string",
997 "createdDate": "2019-08-24T14:15:22Z",
998 "lastModifiedDate": "2019-08-24T14:15:22Z",
999 "archived": true,
1000 "externalId": "string",
1001 "id": 0,
1002 "priority": 0,
1003 "internalId": 0,
1004 "pickListCode": "string",
1005 "pickListLabel": "string",
1006 "label": "string",
1007 "cultureId": 0,
1008 "labelDtos": [
1009 {
1010 "createdBy": "string",
1011 "lastModifiedBy": "string",
1012 "createdDate": "2019-08-24T14:15:22Z",
1013 "lastModifiedDate": "2019-08-24T14:15:22Z",
1014 "archived": true,
1015 "externalId": "string",
1016 "id": 0,
1017 "cultureId": 0,
1018 "value": "string"
1019 }
1020 ]
1021 },
1022 "occupanciesDto": [
1023 {
1024 "createdBy": "string",
1025 "lastModifiedBy": "string",
1026 "createdDate": "2019-08-24T14:15:22Z",
1027 "lastModifiedDate": "2019-08-24T14:15:22Z",
1028 "archived": true,
1029 "externalId": "string",
1030 "id": 0,
1031 "priority": 0,
1032 "internalId": 0,
1033 "pickListCode": "string",
1034 "pickListLabel": "string",
1035 "label": "string",
1036 "cultureId": 0,
1037 "labelDtos": [
1038 {
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 "cultureId": 0,
1047 "value": "string"
1048 }
1049 ]
1050 }
1051 ]
1052 }
1053 ],
1054 "groups": [
1055 {
1056 "createdBy": "string",
1057 "lastModifiedBy": "string",
1058 "createdDate": "2019-08-24T14:15:22Z",
1059 "lastModifiedDate": "2019-08-24T14:15:22Z",
1060 "archived": true,
1061 "externalId": "string",
1062 "id": "string",
1063 "code": "string",
1064 "priority": 0,
1065 "pickListType": "string",
1066 "label": "string",
1067 "cultureId": 0,
1068 "reportable": true,
1069 "labelDtos": [
1070 {
1071 "createdBy": "string",
1072 "lastModifiedBy": "string",
1073 "createdDate": "2019-08-24T14:15:22Z",
1074 "lastModifiedDate": "2019-08-24T14:15:22Z",
1075 "archived": true,
1076 "externalId": "string",
1077 "id": 0,
1078 "cultureId": 0,
1079 "value": "string"
1080 }
1081 ]
1082 }
1083 ],
1084 "groupOptions": [
1085 {
1086 "createdBy": "string",
1087 "lastModifiedBy": "string",
1088 "createdDate": "2019-08-24T14:15:22Z",
1089 "lastModifiedDate": "2019-08-24T14:15:22Z",
1090 "archived": true,
1091 "externalId": "string",
1092 "id": 0,
1093 "priority": 0,
1094 "internalId": 0,
1095 "pickListCode": "string",
1096 "pickListLabel": "string",
1097 "label": "string",
1098 "cultureId": 0,
1099 "labelDtos": [
1100 {
1101 "createdBy": "string",
1102 "lastModifiedBy": "string",
1103 "createdDate": "2019-08-24T14:15:22Z",
1104 "lastModifiedDate": "2019-08-24T14:15:22Z",
1105 "archived": true,
1106 "externalId": "string",
1107 "id": 0,
1108 "cultureId": 0,
1109 "value": "string"
1110 }
1111 ]
1112 }
1113 ],
1114 "businessUnits": [
1115 {
1116 "id": 0,
1117 "status": "CREATED",
1118 "displayId": "string",
1119 "name": "string",
1120 "leaseAreaId": 0,
1121 "companyId": 0
1122 }
1123 ],
1124 "legalEntities": [
1125 {
1126 "id": 0,
1127 "status": "CREATED",
1128 "displayId": "string",
1129 "erpSystemId": 0,
1130 "erpSystemDisplayId": "string",
1131 "countryId": 0,
1132 "countryDisplayId": "string",
1133 "postingPeriodVariantId": 0,
1134 "postingPeriodVariantDisplayId": "string",
1135 "controllingAreaId": 0,
1136 "controllingAreaDisplayId": "string",
1137 "chartOfAccountId": 0,
1138 "chartOfAccountDisplayId": "string",
1139 "fiscalVariantId": 0,
1140 "fiscalVariantDisplayId": "string",
1141 "chartOfDepreciationId": 0,
1142 "chartOfDepreciationDisplayId": "string",
1143 "purchasingOrganizationId": 0,
1144 "assetId": 0,
1145 "exchangeRateTypeId": 0,
1146 "plantId": 0,
1147 "incrementalBorrowingRateId": 0,
1148 "businessUnitId": 0,
1149 "projectId": 0,
1150 "transferVariantId": 0,
1151 "partnerId": 0,
1152 "departmentId": 0,
1153 "accountingStandardId": 0,
1154 "generalLedgerAccountId": 0,
1155 "consumerPriceIndexCategoryId": 0,
1156 "costCenterId": 0,
1157 "costCenterRelationValidFrom": "2019-08-24",
1158 "costCenterRelationValidTo": "2019-08-24"
1159 }
1160 ],
1161 "masterAgreements": [
1162 {
1163 "id": 0,
1164 "displayId": "string",
1165 "year": 1900,
1166 "name": "string",
1167 "description": "string",
1168 "validFrom": "2019-08-24",
1169 "validTo": "2019-08-24",
1170 "targetValue": 0.1,
1171 "legalJurisdiction": "string",
1172 "approverComment": "string",
1173 "signingPerson": "string",
1174 "placeOfSignature": "string",
1175 "dateOfSignature": "2019-08-24",
1176 "state": "MLA_DEFINE",
1177 "dataCreationInfo": {
1178 "id": 0,
1179 "idGenerationType": "AUTO",
1180 "source": "string",
1181 "type": "MIGRATION",
1182 "startDateTime": "2019-08-24T14:15:22Z",
1183 "endDateTime": "2019-08-24T14:15:22Z"
1184 },
1185 "agreementGroup": {
1186 "id": 0,
1187 "displayId": "string",
1188 "status": "CREATED",
1189 "name": "string"
1190 },
1191 "currency": {
1192 "id": 0,
1193 "displayId": "string",
1194 "status": "CREATED",
1195 "name": "string",
1196 "decimalPoints": 0
1197 },
1198 "internalAssetClass": {
1199 "id": 0,
1200 "displayId": "string",
1201 "status": "CREATED",
1202 "name": "string",
1203 "assetClassType": "PROPERTY",
1204 "infiniteUsefulLife": true
1205 },
1206 "leaseArea": {
1207 "id": 0,
1208 "displayId": "string",
1209 "status": "CREATED",
1210 "name": "string"
1211 },
1212 "businessUnit": {
1213 "id": 0,
1214 "displayId": "string",
1215 "status": "CREATED",
1216 "name": "string"
1217 },
1218 "companyCode": {
1219 "id": 0,
1220 "displayId": "string",
1221 "status": "CREATED",
1222 "erpSystemId": 0,
1223 "erpSystemDisplayId": "string",
1224 "countryId": 0,
1225 "countryDisplayId": "string",
1226 "postingPeriodVariantId": 0,
1227 "fiscalVariantId": 0
1228 },
1229 "department": {
1230 "id": 0,
1231 "displayId": "string",
1232 "status": "CREATED",
1233 "name": "string"
1234 },
1235 "leaseGroup": {
1236 "id": 0,
1237 "displayId": "string",
1238 "status": "CREATED",
1239 "name": "string"
1240 },
1241 "allowsSystemGenerateNewId": true,
1242 "numberRangeIdentifierType": {
1243 "name": "string"
1244 },
1245 "numberRangeIdentifierValue": "string",
1246 "numberRangeType": {
1247 "name": "string"
1248 }
1249 }
1250 ],
1251 "contracts": [
1252 {
1253 "id": 0,
1254 "displayId": "string",
1255 "name": "string",
1256 "principalPositionType": "LESSEE",
1257 "validFrom": "2019-08-24",
1258 "validTo": "2019-08-24",
1259 "amendmentDate": "2019-08-24",
1260 "approverComment": "string",
1261 "contractPhase": "INITIAL",
1262 "dataCreationInfo": {
1263 "id": 0,
1264 "idGenerationType": "AUTO",
1265 "source": "string",
1266 "type": "MIGRATION",
1267 "startDateTime": "2019-08-24T14:15:22Z",
1268 "endDateTime": "2019-08-24T14:15:22Z"
1269 },
1270 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
1271 "revision": {
1272 "id": 0,
1273 "displayId": "string",
1274 "name": "string",
1275 "inception": true,
1276 "revisionType": "REVISION",
1277 "state": "MLA_DEFINE",
1278 "approvedBy": "string",
1279 "approvedAt": "2019-08-24T14:15:22Z",
1280 "parentRevisionId": 0,
1281 "approverComment": "string",
1282 "contractId": 0,
1283 "contractDisplayId": "string",
1284 "contractName": "string",
1285 "principalPositionType": "LESSEE",
1286 "mlaId": 0,
1287 "companyId": 0,
1288 "description": "string",
1289 "externalReference": "string",
1290 "internalReference": "string",
1291 "formOfLease": "FULL",
1292 "jointVentureLeaseType": "GROSS_LEASE",
1293 "businessPlace": "string",
1294 "tradingPartner": {
1295 "id": 0,
1296 "displayId": "string",
1297 "status": "CREATED",
1298 "name": "string",
1299 "erpSystemId": 0,
1300 "erpSystemDisplayId": "string"
1301 },
1302 "contractCategoryGroup": {
1303 "id": 0,
1304 "displayId": "string",
1305 "status": "CREATED",
1306 "name": "string"
1307 },
1308 "contractGroup1": {
1309 "id": 0,
1310 "displayId": "string",
1311 "status": "CREATED",
1312 "name": "string"
1313 },
1314 "contractGroup2": {
1315 "id": 0,
1316 "displayId": "string",
1317 "status": "CREATED",
1318 "name": "string"
1319 },
1320 "group3": "string",
1321 "group4": "string",
1322 "signingPerson": "string",
1323 "placeOfSignature": "string",
1324 "dateOfSignature": "2019-08-24",
1325 "numberRangeIdentifierType": {
1326 "name": "string"
1327 },
1328 "numberRangeIdentifierValue": "string",
1329 "allowsSystemGenerateNewId": true,
1330 "numberRangeType": {
1331 "name": "string"
1332 }
1333 },
1334 "currency": {
1335 "id": 0,
1336 "displayId": "string",
1337 "status": "CREATED",
1338 "name": "string",
1339 "decimalPoints": 0
1340 },
1341 "companyCurrency": {
1342 "id": 0,
1343 "displayId": "string",
1344 "status": "CREATED",
1345 "name": "string",
1346 "decimalPoints": 0
1347 },
1348 "indexedCurrency": true,
1349 "assetValueCurrencyType": "CONTRACT_CURRENCY",
1350 "currencyLocked": true,
1351 "leaseArea": {
1352 "id": 0,
1353 "displayId": "string",
1354 "status": "CREATED",
1355 "name": "string"
1356 },
1357 "businessUnit": {
1358 "id": 0,
1359 "displayId": "string",
1360 "status": "CREATED",
1361 "name": "string"
1362 },
1363 "businessUnitLocked": true,
1364 "companyCode": {
1365 "id": 0,
1366 "displayId": "string",
1367 "status": "CREATED",
1368 "erpSystemId": 0,
1369 "erpSystemDisplayId": "string",
1370 "countryId": 0,
1371 "countryDisplayId": "string",
1372 "postingPeriodVariantId": 0,
1373 "fiscalVariantId": 0
1374 },
1375 "companyCodeLocked": true,
1376 "department": {
1377 "id": 0,
1378 "displayId": "string",
1379 "status": "CREATED",
1380 "name": "string"
1381 },
1382 "departmentLocked": true,
1383 "leaseGroup": {
1384 "id": 0,
1385 "displayId": "string",
1386 "status": "CREATED",
1387 "name": "string"
1388 },
1389 "leaseGroupLocked": true,
1390 "subleasingInternalAssetClass": {
1391 "id": 0,
1392 "displayId": "string",
1393 "status": "CREATED",
1394 "name": "string",
1395 "assetClassType": "PROPERTY",
1396 "infiniteUsefulLife": true
1397 },
1398 "contractGroup1": {
1399 "id": 0,
1400 "displayId": "string",
1401 "status": "CREATED",
1402 "name": "string"
1403 },
1404 "contractGroup2": {
1405 "id": 0,
1406 "displayId": "string",
1407 "status": "CREATED",
1408 "name": "string"
1409 },
1410 "subleasing": true,
1411 "subleasingContractRevisionInfo": {
1412 "id": 0,
1413 "contractId": 0,
1414 "contractDisplayId": "string",
1415 "contractName": "string"
1416 },
1417 "subleasingLeaseComponentRevisionInfo": {
1418 "id": 0,
1419 "leaseComponentId": 0,
1420 "leaseComponentDisplayId": "string",
1421 "leaseComponentName": "string"
1422 },
1423 "subleasingActivationGroupRevisionInfo": {
1424 "id": 0,
1425 "activationGroupId": 0,
1426 "activationGroupDisplayId": "string",
1427 "activationGroupName": "string"
1428 },
1429 "notifications": [
1430 {
1431 "id": 0,
1432 "topic": {
1433 "enCaption": "string",
1434 "frCaption": "string",
1435 "name": "string",
1436 "priority": "HIGH"
1437 },
1438 "username": "string",
1439 "contractId": 0,
1440 "contractDisplayId": "string",
1441 "targetId": "string",
1442 "targetType": "string"
1443 }
1444 ],
1445 "masterAgreementId": 0,
1446 "masterAgreementDisplayId": "string",
1447 "allowsSystemGenerateNewId": true,
1448 "transferInfo": {
1449 "transferredFromDisplayId": "string",
1450 "transferredFromRevisionId": 0,
1451 "transferredToDisplayId": "string",
1452 "transferredToRevisionId": 0
1453 },
1454 "numberRangeIdentifierType": {
1455 "name": "string"
1456 },
1457 "numberRangeIdentifierValue": "string",
1458 "numberRangeType": {
1459 "name": "string"
1460 }
1461 }
1462 ],
1463 "listingCitiesValues": [
1464 "string"
1465 ],
1466 "listingProvincesValues": [
1467 "string"
1468 ],
1469 "listingCountriesValues": [
1470 "string"
1471 ],
1472 "listingLocationsValues": [
1473 "string"
1474 ],
1475 "listingPremisesValues": [
1476 "string"
1477 ],
1478 "listingGroupsValues": [
1479 "string"
1480 ],
1481 "listingGroupOptionsValues": [
1482 "string"
1483 ],
1484 "listingBusinessUnitsValues": [
1485 "string"
1486 ],
1487 "listingLegalEntitiesValues": [
1488 "string"
1489 ],
1490 "listingMasterAgreementsValues": [
1491 "string"
1492 ],
1493 "listingContractsValues": [
1494 "string"
1495 ]
1496}
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 "provisioningFrequencyName": "string",
28 "accountingApproved": true,
29 "indexationType": "string",
30 "cpiGlobalCategoryId": 0,
31 "indexationReferenceDate": "2019-08-24",
32 "currentIndexLevel": 0.1,
33 "conditionallyIndexed": true,
34 "applicableCurrentIndexLevel": 0.1,
35 "indexLevelPercentageChangeLowerBound": 0.1,
36 "indexLevelPercentageChangeUpperBound": 0.1,
37 "indexationTypeNonLease": "string",
38 "cpiGlobalCategoryIdNonLease": 0,
39 "indexationReferenceDateNonLease": "2019-08-24",
40 "currentIndexLevelNonLease": 0.1,
41 "conditionallyIndexedNonLease": true,
42 "applicableCurrentIndexLevelNonLease": 0.1,
43 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
44 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
45 "signatureDate": "2019-08-24",
46 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "version": {
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 "modificationDate": "2019-08-24",
170 "updateContractRate": true,
171 "leaseEvent": {
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 "typeId": 0,
180 "code": "string",
181 "reviewedBy": "string",
182 "reviewedDate": "2019-08-24",
183 "reviewedStatusId": 0,
184 "activityDate": "2019-08-24",
185 "relatedPickListOptionId": 0,
186 "detail": "string",
187 "note": {
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 "message": "string",
196 "preserveOriginalAudit": true,
197 "originalCreatedBy": "string",
198 "originalCreatedDate": "2019-08-24T14:15:22Z",
199 "originalLastModifiedBy": "string",
200 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
201 },
202 "type": {
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 "priority": 0,
211 "internalId": 0,
212 "pickListCode": "string",
213 "pickListLabel": "string",
214 "label": "string",
215 "cultureId": 0,
216 "labelDtos": [
217 {
218 "createdBy": "string",
219 "lastModifiedBy": "string",
220 "createdDate": "2019-08-24T14:15:22Z",
221 "lastModifiedDate": "2019-08-24T14:15:22Z",
222 "archived": true,
223 "externalId": "string",
224 "id": 0,
225 "cultureId": 0,
226 "value": "string"
227 }
228 ]
229 },
230 "reviewedStatus": {
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 "priority": 0,
239 "internalId": 0,
240 "pickListCode": "string",
241 "pickListLabel": "string",
242 "label": "string",
243 "cultureId": 0,
244 "labelDtos": [
245 {
246 "createdBy": "string",
247 "lastModifiedBy": "string",
248 "createdDate": "2019-08-24T14:15:22Z",
249 "lastModifiedDate": "2019-08-24T14:15:22Z",
250 "archived": true,
251 "externalId": "string",
252 "id": 0,
253 "cultureId": 0,
254 "value": "string"
255 }
256 ]
257 },
258 "relatedPickListOption": {
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 "priority": 0,
267 "internalId": 0,
268 "pickListCode": "string",
269 "pickListLabel": "string",
270 "label": "string",
271 "cultureId": 0,
272 "labelDtos": [
273 {
274 "createdBy": "string",
275 "lastModifiedBy": "string",
276 "createdDate": "2019-08-24T14:15:22Z",
277 "lastModifiedDate": "2019-08-24T14:15:22Z",
278 "archived": true,
279 "externalId": "string",
280 "id": 0,
281 "cultureId": 0,
282 "value": "string"
283 }
284 ]
285 }
286 },
287 "isVisibleVendorPortal": true,
288 "isTerminationVersion": true,
289 "terminationDate": "2019-08-24",
290 "penaltyAmount": 0.1
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 }
587 },
588 "district": {
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 "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 }
618 }
619 },
620 "cityId": 0,
621 "districtId": 0
622 },
623 "secondAddressDto": {
624 "createdBy": "string",
625 "lastModifiedBy": "string",
626 "createdDate": "2019-08-24T14:15:22Z",
627 "lastModifiedDate": "2019-08-24T14:15:22Z",
628 "archived": true,
629 "externalId": "string",
630 "id": 0,
631 "street": "string",
632 "civicNumber": "string",
633 "suite": "string",
634 "postalCode": "string",
635 "lon": 0.1,
636 "lat": 0.1,
637 "city": {
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 "name": "string",
646 "province": {
647 "createdBy": "string",
648 "lastModifiedBy": "string",
649 "createdDate": "2019-08-24T14:15:22Z",
650 "lastModifiedDate": "2019-08-24T14:15:22Z",
651 "archived": true,
652 "externalId": "string",
653 "id": 0,
654 "name": "string",
655 "code": "string",
656 "country": {
657 "createdBy": "string",
658 "lastModifiedBy": "string",
659 "createdDate": "2019-08-24T14:15:22Z",
660 "lastModifiedDate": "2019-08-24T14:15:22Z",
661 "archived": true,
662 "externalId": "string",
663 "id": 0,
664 "name": "string",
665 "code": "string"
666 }
667 }
668 },
669 "district": {
670 "createdBy": "string",
671 "lastModifiedBy": "string",
672 "createdDate": "2019-08-24T14:15:22Z",
673 "lastModifiedDate": "2019-08-24T14:15:22Z",
674 "archived": true,
675 "externalId": "string",
676 "id": 0,
677 "name": "string",
678 "city": {
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 "province": {
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 "code": "string",
697 "country": {}
698 }
699 }
700 },
701 "cityId": 0,
702 "districtId": 0
703 }
704 },
705 "status": {
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 "priority": 0,
714 "internalId": 0,
715 "pickListCode": "string",
716 "pickListLabel": "string",
717 "label": "string",
718 "cultureId": 0,
719 "labelDtos": [
720 {
721 "createdBy": "string",
722 "lastModifiedBy": "string",
723 "createdDate": "2019-08-24T14:15:22Z",
724 "lastModifiedDate": "2019-08-24T14:15:22Z",
725 "archived": true,
726 "externalId": "string",
727 "id": 0,
728 "cultureId": 0,
729 "value": "string"
730 }
731 ]
732 },
733 "usage": {
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 "occupanciesDto": [
762 {
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 ]
791 },
792 "isTerminationVersion": true
793 }
794 ]
795 },
796 "page": {
797 "size": 0,
798 "totalElements": 0,
799 "totalPages": 0,
800 "number": 0
801 }
802}
Search Leases By CPI Leases Profile Filter Ids¶
HTTP Request
POST /api/leases/cpi-profile-filters/search-by-ids
📋 Description: Submits a request to retrieve CPI profile filters based on specified IDs, enabling enhanced analytics and insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results for lease CPI profiles should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search string used to filter and retrieve specific lease profiles based on provided identifiers within the Nakisa Portfolio Management Suite. |
premise-id |
query |
string |
false |
Unique identifier for the real estate property within the portfolio, used to filter CPI profile search results in the Nakisa Portfolio Management Suite. |
premise-id-in |
query |
string |
false |
Unique identifier for the real estate property within the portfolio, used to filter CPI profile searches in the Nakisa Portfolio Management Suite. |
premise-id-not-null |
query |
string |
false |
Unique identifier for the premise, ensuring that only valid premises are included in the CPI profile filters search within the Nakisa Portfolio Management Suite. |
premise-number |
query |
string |
false |
Unique identifier for the real estate property associated with the lease, used to filter CPI profile search results within the Nakisa Portfolio Management Suite. |
premise-number-like |
query |
string |
false |
String representing a partial or complete premise number used to filter lease records in the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
premise-external-id |
query |
string |
false |
Unique identifier for the external premise associated with a lease, used to filter search results in the Nakisa Portfolio Management Suite. |
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to filter and retrieve relevant lease data in the context of portfolio and asset analytics. |
location-number |
query |
string |
false |
Represents the specific location number associated with the real estate property for filtering CPI profiles in the Nakisa Portfolio Management Suite. |
location-number-like |
query |
string |
false |
Specifies a location number pattern to filter and retrieve relevant 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 the lease, used to filter CPI profile searches within the Nakisa Portfolio Management Suite. |
address-id |
query |
string |
false |
Unique identifier for the address associated with the lease, used to filter CPI profile search results within the Nakisa Portfolio Management Suite. |
city-id |
query |
string |
false |
Unique identifier for the city, used to filter and retrieve relevant lease data within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
province-id |
query |
string |
false |
Unique identifier for the province, used to filter lease-related data within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
country-id |
query |
string |
false |
Unique identifier for the country associated with the lease, used to filter CPI profile searches within the Nakisa Portfolio Management Suite. |
contract-id |
query |
string |
false |
Unique identifier for the lease contract, used to filter and retrieve specific CPI profile data within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
String representation of the unique identifiers for the leases being queried, facilitating targeted searches within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
number-like |
query |
string |
false |
String representation of a numeric value used to filter lease profiles based on specified criteria within the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Unique identifier for the specific type of asset or portfolio category used to filter CPI profiles in the Nakisa Portfolio Management Suite. |
terminating-lease |
query |
string |
false |
Specifies the lease termination status to filter search results for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
signature-date |
query |
string |
false |
Specifies the date of the signature associated with the lease, providing critical context for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
category-id |
query |
string |
false |
Unique identifier for the category associated with the lease, facilitating targeted searches within the Nakisa Portfolio Management Suite for portfolio, asset, and real estate property analytics. |
registration-number |
query |
string |
false |
Unique identifier for the registration of real estate properties, used to filter and retrieve specific asset data within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of the lease, utilized in the context of portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id-is-not |
query |
string |
false |
Excludes leases with the specified status ID from the search results, facilitating targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
status-id-in |
query |
string |
false |
Specifies the unique status identifiers for filtering lease records within the Nakisa Portfolio Management Suite, facilitating targeted analytics in portfolio and asset management. |
original-lease-id |
query |
string |
false |
Unique identifier for the original lease, used to filter and retrieve specific lease data within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
state-id |
query |
string |
false |
Unique identifier for the state associated with the lease, used to filter CPI profiles within the Nakisa Portfolio Management Suite. |
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 |
Request body containing a list of lease IDs for filtering CPI profiles within the Nakisa Portfolio Management Suite, facilitating targeted analytics in real estate asset management. |
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 "provisioningFrequencyName": "string",
28 "accountingApproved": true,
29 "indexationType": "string",
30 "cpiGlobalCategoryId": 0,
31 "indexationReferenceDate": "2019-08-24",
32 "currentIndexLevel": 0.1,
33 "conditionallyIndexed": true,
34 "applicableCurrentIndexLevel": 0.1,
35 "indexLevelPercentageChangeLowerBound": 0.1,
36 "indexLevelPercentageChangeUpperBound": 0.1,
37 "indexationTypeNonLease": "string",
38 "cpiGlobalCategoryIdNonLease": 0,
39 "indexationReferenceDateNonLease": "2019-08-24",
40 "currentIndexLevelNonLease": 0.1,
41 "conditionallyIndexedNonLease": true,
42 "applicableCurrentIndexLevelNonLease": 0.1,
43 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
44 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
45 "signatureDate": "2019-08-24",
46 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "version": {
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 "modificationDate": "2019-08-24",
170 "updateContractRate": true,
171 "leaseEvent": {
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 "typeId": 0,
180 "code": "string",
181 "reviewedBy": "string",
182 "reviewedDate": "2019-08-24",
183 "reviewedStatusId": 0,
184 "activityDate": "2019-08-24",
185 "relatedPickListOptionId": 0,
186 "detail": "string",
187 "note": {
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 "message": "string",
196 "preserveOriginalAudit": true,
197 "originalCreatedBy": "string",
198 "originalCreatedDate": "2019-08-24T14:15:22Z",
199 "originalLastModifiedBy": "string",
200 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
201 },
202 "type": {
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 "priority": 0,
211 "internalId": 0,
212 "pickListCode": "string",
213 "pickListLabel": "string",
214 "label": "string",
215 "cultureId": 0,
216 "labelDtos": [
217 {
218 "createdBy": "string",
219 "lastModifiedBy": "string",
220 "createdDate": "2019-08-24T14:15:22Z",
221 "lastModifiedDate": "2019-08-24T14:15:22Z",
222 "archived": true,
223 "externalId": "string",
224 "id": 0,
225 "cultureId": 0,
226 "value": "string"
227 }
228 ]
229 },
230 "reviewedStatus": {
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 "priority": 0,
239 "internalId": 0,
240 "pickListCode": "string",
241 "pickListLabel": "string",
242 "label": "string",
243 "cultureId": 0,
244 "labelDtos": [
245 {
246 "createdBy": "string",
247 "lastModifiedBy": "string",
248 "createdDate": "2019-08-24T14:15:22Z",
249 "lastModifiedDate": "2019-08-24T14:15:22Z",
250 "archived": true,
251 "externalId": "string",
252 "id": 0,
253 "cultureId": 0,
254 "value": "string"
255 }
256 ]
257 },
258 "relatedPickListOption": {
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 "priority": 0,
267 "internalId": 0,
268 "pickListCode": "string",
269 "pickListLabel": "string",
270 "label": "string",
271 "cultureId": 0,
272 "labelDtos": [
273 {
274 "createdBy": "string",
275 "lastModifiedBy": "string",
276 "createdDate": "2019-08-24T14:15:22Z",
277 "lastModifiedDate": "2019-08-24T14:15:22Z",
278 "archived": true,
279 "externalId": "string",
280 "id": 0,
281 "cultureId": 0,
282 "value": "string"
283 }
284 ]
285 }
286 },
287 "isVisibleVendorPortal": true,
288 "isTerminationVersion": true,
289 "terminationDate": "2019-08-24",
290 "penaltyAmount": 0.1
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 }
587 },
588 "district": {
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 "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 }
618 }
619 },
620 "cityId": 0,
621 "districtId": 0
622 },
623 "secondAddressDto": {
624 "createdBy": "string",
625 "lastModifiedBy": "string",
626 "createdDate": "2019-08-24T14:15:22Z",
627 "lastModifiedDate": "2019-08-24T14:15:22Z",
628 "archived": true,
629 "externalId": "string",
630 "id": 0,
631 "street": "string",
632 "civicNumber": "string",
633 "suite": "string",
634 "postalCode": "string",
635 "lon": 0.1,
636 "lat": 0.1,
637 "city": {
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 "name": "string",
646 "province": {
647 "createdBy": "string",
648 "lastModifiedBy": "string",
649 "createdDate": "2019-08-24T14:15:22Z",
650 "lastModifiedDate": "2019-08-24T14:15:22Z",
651 "archived": true,
652 "externalId": "string",
653 "id": 0,
654 "name": "string",
655 "code": "string",
656 "country": {
657 "createdBy": "string",
658 "lastModifiedBy": "string",
659 "createdDate": "2019-08-24T14:15:22Z",
660 "lastModifiedDate": "2019-08-24T14:15:22Z",
661 "archived": true,
662 "externalId": "string",
663 "id": 0,
664 "name": "string",
665 "code": "string"
666 }
667 }
668 },
669 "district": {
670 "createdBy": "string",
671 "lastModifiedBy": "string",
672 "createdDate": "2019-08-24T14:15:22Z",
673 "lastModifiedDate": "2019-08-24T14:15:22Z",
674 "archived": true,
675 "externalId": "string",
676 "id": 0,
677 "name": "string",
678 "city": {
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 "province": {
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 "code": "string",
697 "country": {}
698 }
699 }
700 },
701 "cityId": 0,
702 "districtId": 0
703 }
704 },
705 "status": {
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 "priority": 0,
714 "internalId": 0,
715 "pickListCode": "string",
716 "pickListLabel": "string",
717 "label": "string",
718 "cultureId": 0,
719 "labelDtos": [
720 {
721 "createdBy": "string",
722 "lastModifiedBy": "string",
723 "createdDate": "2019-08-24T14:15:22Z",
724 "lastModifiedDate": "2019-08-24T14:15:22Z",
725 "archived": true,
726 "externalId": "string",
727 "id": 0,
728 "cultureId": 0,
729 "value": "string"
730 }
731 ]
732 },
733 "usage": {
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 "occupanciesDto": [
762 {
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 ]
791 },
792 "isTerminationVersion": true
793 }
794 ]
795 },
796 "page": {
797 "size": 0,
798 "totalElements": 0,
799 "totalPages": 0,
800 "number": 0
801 }
802}
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 },
132 "isVisibleVendorPortal": true,
133 "isTerminationVersion": true,
134 "terminationDate": "2019-08-24",
135 "penaltyAmount": 0.1
136 }
137 ]
138 },
139 "page": {
140 "size": 0,
141 "totalElements": 0,
142 "totalPages": 0,
143 "number": 0
144 }
145}
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
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}
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 }
104 ]
105 },
106 "page": {
107 "size": 0,
108 "totalElements": 0,
109 "totalPages": 0,
110 "number": 0
111 }
112}
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 }
151 ],
152 "archivedAssociation": true
153 }
154]
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 |
Text value for lot in AreaDto |
» cadaster |
string |
false |
none |
Text value for cadaster in AreaDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Text value for details in AreaHistoryDto |
»» floor |
string |
false |
none |
Text value for floor in AreaHistoryDto |
»» suite |
string |
false |
none |
Text value for suite in AreaHistoryDto |
»» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
» archivedAssociation |
boolean |
false |
none |
none |
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 |
Text value for desiredIndexationDateLease in CpiLeaseIndexationPreviewDto |
» actualIndexationDateLease |
string(date) |
false |
none |
Text value for actualIndexationDateLease in CpiLeaseIndexationPreviewDto |
» desiredIndexationDateNonLease |
string(date) |
false |
none |
Text value for desiredIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
» actualIndexationDateNonLease |
string(date) |
false |
none |
Text value for actualIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
» messageCode |
string |
false |
none |
Code for the message |
» delimitedArguments |
string |
false |
none |
Text value for delimitedArguments in CpiLeaseIndexationPreviewDto |
» messageCodeIndexationDateLease |
string |
false |
none |
Text value for messageCodeIndexationDateLease in CpiLeaseIndexationPreviewDto |
» messageCodeIndexationDateNonLease |
string |
false |
none |
Text value for messageCodeIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
» 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 |
Text value for value in LabelDto |
» 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 |
Text value for cpiGlobalReferenceDateNonLease in CpiIndexationPlanDto |
»» 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 |
Text value for indexationDateLease in CpiIndexationPlanDto |
»» applyIndexationNonLease |
boolean |
false |
none |
Boolean flag indicating applyIndexationNonLease status |
»» indexationDateNonLease |
string(date) |
false |
none |
Text value for indexationDateNonLease in CpiIndexationPlanDto |
»» executionDate |
string(date) |
false |
none |
Date of the execution |
»» executedModificationDate |
string(date) |
false |
none |
Date of the executed modification |
»» executedIndexationDateLease |
string(date) |
false |
none |
Text value for executedIndexationDateLease in CpiIndexationPlanDto |
»» executedIndexationDateNonLease |
string(date) |
false |
none |
Text value for executedIndexationDateNonLease in CpiIndexationPlanDto |
»» messageCode |
string |
false |
none |
Code for the message |
»» messageCodeIndexationDateLease |
string |
false |
none |
Text value for messageCodeIndexationDateLease in CpiIndexationPlanDto |
»» messageCodeIndexationDateNonLease |
string |
false |
none |
Text value for messageCodeIndexationDateNonLease in CpiIndexationPlanDto |
»» 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 |
Text value for message in CpiIndexationPlanDto |
»» messageIndexationDateLease |
string |
false |
none |
Text value for messageIndexationDateLease in CpiIndexationPlanDto |
»» messageIndexationDateNonLease |
string |
false |
none |
Text value for messageIndexationDateNonLease in CpiIndexationPlanDto |
»» 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 |
Text value for country in ConsumerPriceIndexCategoryDto |
»»» province |
string |
true |
none |
Text value for province in ConsumerPriceIndexCategoryDto |
»»» city |
string |
true |
none |
Text value for city in ConsumerPriceIndexCategoryDto |
»»» consumerPriceIndexSourceType |
string |
true |
none |
Type of the consumer price index source |
»»» source |
string |
true |
none |
Text value for source in ConsumerPriceIndexCategoryDto |
»»» formula |
string |
false |
none |
Text value for formula in ConsumerPriceIndexCategoryDto |
»»» 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 |
Text value for message in CpiLeaseIndexationPreviewDto |
» messageIndexationDateLease |
string |
false |
none |
Text value for messageIndexationDateLease in CpiLeaseIndexationPreviewDto |
» messageIndexationDateNonLease |
string |
false |
none |
Text value for messageIndexationDateNonLease in CpiLeaseIndexationPreviewDto |
Enumerated Values
Attribute |
Value |
|---|---|
consumerPriceIndexSourceType |
EXCEL, WEB |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
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}
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}
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}
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}
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 "provisioningFrequencyName": "string",
67 "accountingApproved": true,
68 "indexationType": "string",
69 "cpiGlobalCategoryId": 0,
70 "indexationReferenceDate": "2019-08-24",
71 "currentIndexLevel": 0.1,
72 "conditionallyIndexed": true,
73 "applicableCurrentIndexLevel": 0.1,
74 "indexLevelPercentageChangeLowerBound": 0.1,
75 "indexLevelPercentageChangeUpperBound": 0.1,
76 "indexationTypeNonLease": "string",
77 "cpiGlobalCategoryIdNonLease": 0,
78 "indexationReferenceDateNonLease": "2019-08-24",
79 "currentIndexLevelNonLease": 0.1,
80 "conditionallyIndexedNonLease": true,
81 "applicableCurrentIndexLevelNonLease": 0.1,
82 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
83 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
84 "signatureDate": "2019-08-24",
85 "premiseId": 0,
86 "type": {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "priority": 0,
95 "internalId": 0,
96 "pickListCode": "string",
97 "pickListLabel": "string",
98 "label": "string",
99 "cultureId": 0,
100 "labelDtos": [
101 {
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 "cultureId": 0,
110 "value": "string"
111 }
112 ]
113 },
114 "category": {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "priority": 0,
123 "internalId": 0,
124 "pickListCode": "string",
125 "pickListLabel": "string",
126 "label": "string",
127 "cultureId": 0,
128 "labelDtos": [
129 {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "cultureId": 0,
138 "value": "string"
139 }
140 ]
141 },
142 "status": {
143 "createdBy": "string",
144 "lastModifiedBy": "string",
145 "createdDate": "2019-08-24T14:15:22Z",
146 "lastModifiedDate": "2019-08-24T14:15:22Z",
147 "archived": true,
148 "externalId": "string",
149 "id": 0,
150 "priority": 0,
151 "internalId": 0,
152 "pickListCode": "string",
153 "pickListLabel": "string",
154 "label": "string",
155 "cultureId": 0,
156 "labelDtos": [
157 {
158 "createdBy": "string",
159 "lastModifiedBy": "string",
160 "createdDate": "2019-08-24T14:15:22Z",
161 "lastModifiedDate": "2019-08-24T14:15:22Z",
162 "archived": true,
163 "externalId": "string",
164 "id": 0,
165 "cultureId": 0,
166 "value": "string"
167 }
168 ]
169 },
170 "state": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
186 "createdBy": "string",
187 "lastModifiedBy": "string",
188 "createdDate": "2019-08-24T14:15:22Z",
189 "lastModifiedDate": "2019-08-24T14:15:22Z",
190 "archived": true,
191 "externalId": "string",
192 "id": 0,
193 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "version": {
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 "name": "string",
207 "description": "string",
208 "modificationDate": "2019-08-24",
209 "updateContractRate": true,
210 "leaseEvent": {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "typeId": 0,
219 "code": "string",
220 "reviewedBy": "string",
221 "reviewedDate": "2019-08-24",
222 "reviewedStatusId": 0,
223 "activityDate": "2019-08-24",
224 "relatedPickListOptionId": 0,
225 "detail": "string",
226 "note": {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "message": "string",
235 "preserveOriginalAudit": true,
236 "originalCreatedBy": "string",
237 "originalCreatedDate": "2019-08-24T14:15:22Z",
238 "originalLastModifiedBy": "string",
239 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
240 },
241 "type": {
242 "createdBy": "string",
243 "lastModifiedBy": "string",
244 "createdDate": "2019-08-24T14:15:22Z",
245 "lastModifiedDate": "2019-08-24T14:15:22Z",
246 "archived": true,
247 "externalId": "string",
248 "id": 0,
249 "priority": 0,
250 "internalId": 0,
251 "pickListCode": "string",
252 "pickListLabel": "string",
253 "label": "string",
254 "cultureId": 0,
255 "labelDtos": [
256 {
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 "cultureId": 0,
265 "value": "string"
266 }
267 ]
268 },
269 "reviewedStatus": {
270 "createdBy": "string",
271 "lastModifiedBy": "string",
272 "createdDate": "2019-08-24T14:15:22Z",
273 "lastModifiedDate": "2019-08-24T14:15:22Z",
274 "archived": true,
275 "externalId": "string",
276 "id": 0,
277 "priority": 0,
278 "internalId": 0,
279 "pickListCode": "string",
280 "pickListLabel": "string",
281 "label": "string",
282 "cultureId": 0,
283 "labelDtos": [
284 {
285 "createdBy": "string",
286 "lastModifiedBy": "string",
287 "createdDate": "2019-08-24T14:15:22Z",
288 "lastModifiedDate": "2019-08-24T14:15:22Z",
289 "archived": true,
290 "externalId": "string",
291 "id": 0,
292 "cultureId": 0,
293 "value": "string"
294 }
295 ]
296 },
297 "relatedPickListOption": {
298 "createdBy": "string",
299 "lastModifiedBy": "string",
300 "createdDate": "2019-08-24T14:15:22Z",
301 "lastModifiedDate": "2019-08-24T14:15:22Z",
302 "archived": true,
303 "externalId": "string",
304 "id": 0,
305 "priority": 0,
306 "internalId": 0,
307 "pickListCode": "string",
308 "pickListLabel": "string",
309 "label": "string",
310 "cultureId": 0,
311 "labelDtos": [
312 {
313 "createdBy": "string",
314 "lastModifiedBy": "string",
315 "createdDate": "2019-08-24T14:15:22Z",
316 "lastModifiedDate": "2019-08-24T14:15:22Z",
317 "archived": true,
318 "externalId": "string",
319 "id": 0,
320 "cultureId": 0,
321 "value": "string"
322 }
323 ]
324 }
325 },
326 "isVisibleVendorPortal": true,
327 "isTerminationVersion": true,
328 "terminationDate": "2019-08-24",
329 "penaltyAmount": 0.1
330 },
331 "premiseDto": {
332 "createdBy": "string",
333 "lastModifiedBy": "string",
334 "createdDate": "2019-08-24T14:15:22Z",
335 "lastModifiedDate": "2019-08-24T14:15:22Z",
336 "archived": true,
337 "externalId": "string",
338 "id": 0,
339 "number": "string",
340 "name": "string",
341 "headPremise": true,
342 "possessionDate": "2019-08-24",
343 "openingDate": "2019-08-24",
344 "closingDate": "2019-08-24",
345 "relocationDate": "2019-08-24",
346 "vacatingDate": "2019-08-24",
347 "expansionDate": "2019-08-24",
348 "statusId": 0,
349 "usageId": 0,
350 "parentPremiseId": 0,
351 "costCenterId": 0,
352 "profitCenterId": 0,
353 "legalEntityId": 0,
354 "occupancyIds": [
355 0
356 ],
357 "locationId": 0,
358 "locationDto": {
359 "createdBy": "string",
360 "lastModifiedBy": "string",
361 "createdDate": "2019-08-24T14:15:22Z",
362 "lastModifiedDate": "2019-08-24T14:15:22Z",
363 "archived": true,
364 "externalId": "string",
365 "id": 0,
366 "number": "string",
367 "name": "string",
368 "storeNumber": "string",
369 "defaultCurrencyId": 0,
370 "defaultMeasureId": 0,
371 "typeId": 0,
372 "qualityId": 0,
373 "propertyTypeId": 0,
374 "categoryId": 0,
375 "statusId": 0,
376 "businessUnitId": 0,
377 "groupIds": [
378 0
379 ],
380 "legalEntityIds": [
381 0
382 ],
383 "defaultCurrency": {
384 "id": 0,
385 "status": "CREATED",
386 "displayId": "string",
387 "erpSystemId": 0,
388 "erpSystemDisplayId": "string",
389 "name": "string",
390 "decimalPoints": 0,
391 "depreciationAreaId": 0
392 },
393 "defaultUnitValue": {
394 "createdBy": "string",
395 "lastModifiedBy": "string",
396 "createdDate": "2019-08-24T14:15:22Z",
397 "lastModifiedDate": "2019-08-24T14:15:22Z",
398 "archived": true,
399 "externalId": "string",
400 "id": 0,
401 "unitId": 0,
402 "unitOfMeasureId": 0,
403 "erpSystemId": 0,
404 "unit": {
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 ]
421 },
422 "unitOfMeasure": {
423 "id": 0,
424 "status": "CREATED",
425 "displayId": "string",
426 "erpSystemId": 0,
427 "erpSystemDisplayId": "string",
428 "name": "string"
429 }
430 },
431 "type": {
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 "quality": {
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 "propertyType": {
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 "category": {
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 "status": {
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 "priority": 0,
552 "internalId": 0,
553 "pickListCode": "string",
554 "pickListLabel": "string",
555 "label": "string",
556 "cultureId": 0,
557 "labelDtos": [
558 {
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 "cultureId": 0,
567 "value": "string"
568 }
569 ]
570 },
571 "addressDto": {
572 "createdBy": "string",
573 "lastModifiedBy": "string",
574 "createdDate": "2019-08-24T14:15:22Z",
575 "lastModifiedDate": "2019-08-24T14:15:22Z",
576 "archived": true,
577 "externalId": "string",
578 "id": 0,
579 "street": "string",
580 "civicNumber": "string",
581 "suite": "string",
582 "postalCode": "string",
583 "lon": 0.1,
584 "lat": 0.1,
585 "city": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "province": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "code": "string",
604 "country": {}
605 }
606 },
607 "district": {
608 "createdBy": "string",
609 "lastModifiedBy": "string",
610 "createdDate": "2019-08-24T14:15:22Z",
611 "lastModifiedDate": "2019-08-24T14:15:22Z",
612 "archived": true,
613 "externalId": "string",
614 "id": 0,
615 "name": "string",
616 "city": {
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 "province": {}
626 }
627 },
628 "cityId": 0,
629 "districtId": 0
630 },
631 "secondAddressDto": {
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 "street": "string",
640 "civicNumber": "string",
641 "suite": "string",
642 "postalCode": "string",
643 "lon": 0.1,
644 "lat": 0.1,
645 "city": {
646 "createdBy": "string",
647 "lastModifiedBy": "string",
648 "createdDate": "2019-08-24T14:15:22Z",
649 "lastModifiedDate": "2019-08-24T14:15:22Z",
650 "archived": true,
651 "externalId": "string",
652 "id": 0,
653 "name": "string",
654 "province": {
655 "createdBy": "string",
656 "lastModifiedBy": "string",
657 "createdDate": "2019-08-24T14:15:22Z",
658 "lastModifiedDate": "2019-08-24T14:15:22Z",
659 "archived": true,
660 "externalId": "string",
661 "id": 0,
662 "name": "string",
663 "code": "string",
664 "country": {}
665 }
666 },
667 "district": {
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 "city": {
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 "province": {}
686 }
687 },
688 "cityId": 0,
689 "districtId": 0
690 }
691 },
692 "status": {
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 "priority": 0,
701 "internalId": 0,
702 "pickListCode": "string",
703 "pickListLabel": "string",
704 "label": "string",
705 "cultureId": 0,
706 "labelDtos": [
707 {
708 "createdBy": "string",
709 "lastModifiedBy": "string",
710 "createdDate": "2019-08-24T14:15:22Z",
711 "lastModifiedDate": "2019-08-24T14:15:22Z",
712 "archived": true,
713 "externalId": "string",
714 "id": 0,
715 "cultureId": 0,
716 "value": "string"
717 }
718 ]
719 },
720 "usage": {
721 "createdBy": "string",
722 "lastModifiedBy": "string",
723 "createdDate": "2019-08-24T14:15:22Z",
724 "lastModifiedDate": "2019-08-24T14:15:22Z",
725 "archived": true,
726 "externalId": "string",
727 "id": 0,
728 "priority": 0,
729 "internalId": 0,
730 "pickListCode": "string",
731 "pickListLabel": "string",
732 "label": "string",
733 "cultureId": 0,
734 "labelDtos": [
735 {
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 "cultureId": 0,
744 "value": "string"
745 }
746 ]
747 },
748 "occupanciesDto": [
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 "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 ]
778 },
779 "isTerminationVersion": true
780 }
781 }
782 ]
783 },
784 "page": {
785 "size": 0,
786 "totalElements": 0,
787 "totalPages": 0,
788 "number": 0
789 }
790}
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 "typeId": 0,
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "replaceById": 0,
16 "managedById": 0,
17 "payById": 0,
18 "adminFee": 0,
19 "fixedIncreasePercentage": 0,
20 "note": "string",
21 "pageNumber": "string",
22 "section": "string",
23 "type": {
24 "createdBy": "string",
25 "lastModifiedBy": "string",
26 "createdDate": "2019-08-24T14:15:22Z",
27 "lastModifiedDate": "2019-08-24T14:15:22Z",
28 "archived": true,
29 "externalId": "string",
30 "id": 0,
31 "priority": 0,
32 "internalId": 0,
33 "pickListCode": "string",
34 "pickListLabel": "string",
35 "label": "string",
36 "cultureId": 0,
37 "labelDtos": [
38 {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "cultureId": 0,
47 "value": "string"
48 }
49 ]
50 },
51 "replaceBy": {
52 "createdBy": "string",
53 "lastModifiedBy": "string",
54 "createdDate": "2019-08-24T14:15:22Z",
55 "lastModifiedDate": "2019-08-24T14:15:22Z",
56 "archived": true,
57 "externalId": "string",
58 "id": 0,
59 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 },
79 "managedBy": {
80 "createdBy": "string",
81 "lastModifiedBy": "string",
82 "createdDate": "2019-08-24T14:15:22Z",
83 "lastModifiedDate": "2019-08-24T14:15:22Z",
84 "archived": true,
85 "externalId": "string",
86 "id": 0,
87 "priority": 0,
88 "internalId": 0,
89 "pickListCode": "string",
90 "pickListLabel": "string",
91 "label": "string",
92 "cultureId": 0,
93 "labelDtos": [
94 {
95 "createdBy": "string",
96 "lastModifiedBy": "string",
97 "createdDate": "2019-08-24T14:15:22Z",
98 "lastModifiedDate": "2019-08-24T14:15:22Z",
99 "archived": true,
100 "externalId": "string",
101 "id": 0,
102 "cultureId": 0,
103 "value": "string"
104 }
105 ]
106 },
107 "payBy": {
108 "createdBy": "string",
109 "lastModifiedBy": "string",
110 "createdDate": "2019-08-24T14:15:22Z",
111 "lastModifiedDate": "2019-08-24T14:15:22Z",
112 "archived": true,
113 "externalId": "string",
114 "id": 0,
115 "priority": 0,
116 "internalId": 0,
117 "pickListCode": "string",
118 "pickListLabel": "string",
119 "label": "string",
120 "cultureId": 0,
121 "labelDtos": [
122 {
123 "createdBy": "string",
124 "lastModifiedBy": "string",
125 "createdDate": "2019-08-24T14:15:22Z",
126 "lastModifiedDate": "2019-08-24T14:15:22Z",
127 "archived": true,
128 "externalId": "string",
129 "id": 0,
130 "cultureId": 0,
131 "value": "string"
132 }
133 ]
134 },
135 "proShareDto": {
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 "type": "string"
144 },
145 "capDto": {
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 "type": "string"
154 }
155 }
156 ]
157 },
158 "page": {
159 "size": 0,
160 "totalElements": 0,
161 "totalPages": 0,
162 "number": 0
163 }
164}
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}
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}
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{}
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}
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
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 |
Text value for permission in Transition |
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 |
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}
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. |
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 "vendorIdToExpenseAccount": {
41 "property1": "string",
42 "property2": "string"
43 },
44 "costCenter": {
45 "id": 0,
46 "status": "CREATED",
47 "displayId": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string",
50 "name": "string",
51 "blocked": true,
52 "taxJurisdictionId": 0,
53 "taxJurisdictionDisplayId": "string",
54 "controllingAreaId": 0,
55 "controllingAreaDisplayId": "string",
56 "profitCenterId": 0,
57 "profitCenterRelationValidFrom": "2019-08-24",
58 "profitCenterRelationValidTo": "2019-08-24",
59 "companyId": 0,
60 "companyRelationValidFrom": "2019-08-24",
61 "companyRelationValidTo": "2019-08-24"
62 },
63 "principalPositionType": "LESSEE",
64 "leaseExternalId": "string"
65 }
66 ]
67 },
68 "page": {
69 "size": 0,
70 "totalElements": 0,
71 "totalPages": 0,
72 "number": 0
73 }
74}
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}
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 "numberRangeIdentifierType": {
90 "name": "string"
91 },
92 "numberRangeIdentifierValue": "string",
93 "allowsSystemGenerateNewId": true,
94 "numberRangeType": {
95 "name": "string"
96 }
97 },
98 "currency": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "decimalPoints": 0
104 },
105 "companyCurrency": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "decimalPoints": 0
111 },
112 "indexedCurrency": true,
113 "assetValueCurrencyType": "CONTRACT_CURRENCY",
114 "currencyLocked": true,
115 "leaseArea": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string"
120 },
121 "businessUnit": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string"
126 },
127 "businessUnitLocked": true,
128 "companyCode": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "erpSystemId": 0,
133 "erpSystemDisplayId": "string",
134 "countryId": 0,
135 "countryDisplayId": "string",
136 "postingPeriodVariantId": 0,
137 "fiscalVariantId": 0
138 },
139 "companyCodeLocked": true,
140 "department": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string"
145 },
146 "departmentLocked": true,
147 "leaseGroup": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string"
152 },
153 "leaseGroupLocked": true,
154 "subleasingInternalAssetClass": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "assetClassType": "PROPERTY",
160 "infiniteUsefulLife": true
161 },
162 "contractGroup1": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string"
167 },
168 "contractGroup2": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string"
173 },
174 "subleasing": true,
175 "subleasingContractRevisionInfo": {
176 "id": 0,
177 "contractId": 0,
178 "contractDisplayId": "string",
179 "contractName": "string"
180 },
181 "subleasingLeaseComponentRevisionInfo": {
182 "id": 0,
183 "leaseComponentId": 0,
184 "leaseComponentDisplayId": "string",
185 "leaseComponentName": "string"
186 },
187 "subleasingActivationGroupRevisionInfo": {
188 "id": 0,
189 "activationGroupId": 0,
190 "activationGroupDisplayId": "string",
191 "activationGroupName": "string"
192 },
193 "notifications": [
194 {
195 "id": 0,
196 "topic": {
197 "enCaption": "string",
198 "frCaption": "string",
199 "name": "string",
200 "priority": "HIGH"
201 },
202 "username": "string",
203 "contractId": 0,
204 "contractDisplayId": "string",
205 "targetId": "string",
206 "targetType": "string"
207 }
208 ],
209 "masterAgreementId": 0,
210 "masterAgreementDisplayId": "string",
211 "allowsSystemGenerateNewId": true,
212 "transferInfo": {
213 "transferredFromDisplayId": "string",
214 "transferredFromRevisionId": 0,
215 "transferredToDisplayId": "string",
216 "transferredToRevisionId": 0
217 },
218 "numberRangeIdentifierType": {
219 "name": "string"
220 },
221 "numberRangeIdentifierValue": "string",
222 "numberRangeType": {
223 "name": "string"
224 }
225 },
226 "masterAgreementDto": {
227 "id": 0,
228 "displayId": "string",
229 "year": 1900,
230 "name": "string",
231 "description": "string",
232 "validFrom": "2019-08-24",
233 "validTo": "2019-08-24",
234 "targetValue": 0.1,
235 "legalJurisdiction": "string",
236 "approverComment": "string",
237 "signingPerson": "string",
238 "placeOfSignature": "string",
239 "dateOfSignature": "2019-08-24",
240 "state": "MLA_DEFINE",
241 "dataCreationInfo": {
242 "id": 0,
243 "idGenerationType": "AUTO",
244 "source": "string",
245 "type": "MIGRATION",
246 "startDateTime": "2019-08-24T14:15:22Z",
247 "endDateTime": "2019-08-24T14:15:22Z"
248 },
249 "agreementGroup": {
250 "id": 0,
251 "displayId": "string",
252 "status": "CREATED",
253 "name": "string"
254 },
255 "currency": {
256 "id": 0,
257 "displayId": "string",
258 "status": "CREATED",
259 "name": "string",
260 "decimalPoints": 0
261 },
262 "internalAssetClass": {
263 "id": 0,
264 "displayId": "string",
265 "status": "CREATED",
266 "name": "string",
267 "assetClassType": "PROPERTY",
268 "infiniteUsefulLife": true
269 },
270 "leaseArea": {
271 "id": 0,
272 "displayId": "string",
273 "status": "CREATED",
274 "name": "string"
275 },
276 "businessUnit": {
277 "id": 0,
278 "displayId": "string",
279 "status": "CREATED",
280 "name": "string"
281 },
282 "companyCode": {
283 "id": 0,
284 "displayId": "string",
285 "status": "CREATED",
286 "erpSystemId": 0,
287 "erpSystemDisplayId": "string",
288 "countryId": 0,
289 "countryDisplayId": "string",
290 "postingPeriodVariantId": 0,
291 "fiscalVariantId": 0
292 },
293 "department": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string"
298 },
299 "leaseGroup": {
300 "id": 0,
301 "displayId": "string",
302 "status": "CREATED",
303 "name": "string"
304 },
305 "allowsSystemGenerateNewId": true,
306 "numberRangeIdentifierType": {
307 "name": "string"
308 },
309 "numberRangeIdentifierValue": "string",
310 "numberRangeType": {
311 "name": "string"
312 }
313 },
314 "leaseComponentDto": {
315 "id": 0,
316 "displayId": "string",
317 "principalPositionType": "LESSEE",
318 "name": "string",
319 "description": "string",
320 "bulkAsset": true,
321 "rouStartDate": "2019-08-24",
322 "rouEndDate": "2019-08-24",
323 "approverComment": "string",
324 "fairMarketValue": 0.1,
325 "allocationNumber": "string",
326 "guaranteedResidualValue": 0.1,
327 "unitDistributions": [
328 {
329 "id": 0,
330 "leaseComponentId": 0,
331 "leaseComponentDisplayId": "string",
332 "activationGroupName": "string",
333 "activationGroupDisplayId": "string",
334 "numberOfUnits": 0,
335 "unitDisplayIds": [
336 "string"
337 ]
338 }
339 ],
340 "revision": {
341 "id": 0,
342 "displayId": "string",
343 "name": "string",
344 "inception": true,
345 "revisionType": "REVISION",
346 "state": "MLA_DEFINE",
347 "approvedBy": "string",
348 "approvedAt": "2019-08-24T14:15:22Z",
349 "parentRevisionId": 0,
350 "approverComment": "string",
351 "leaseComponentId": 0,
352 "leaseComponentDisplayId": "string",
353 "leaseComponentName": "string",
354 "contractRevisionId": 0,
355 "contractRevisionDisplayId": "string",
356 "numberRangeIdentifierType": {
357 "name": "string"
358 },
359 "numberRangeIdentifierValue": "string",
360 "allowsSystemGenerateNewId": true,
361 "numberRangeType": {
362 "name": "string"
363 }
364 },
365 "internalAssetClass": {
366 "id": 0,
367 "displayId": "string",
368 "status": "CREATED",
369 "name": "string",
370 "assetClassType": "PROPERTY",
371 "infiniteUsefulLife": true
372 },
373 "unitOfMeasure": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "name": "string",
378 "erpSystemId": 0
379 },
380 "notifications": [
381 {
382 "id": 0,
383 "topic": {
384 "enCaption": "string",
385 "frCaption": "string",
386 "name": "string",
387 "priority": "HIGH"
388 },
389 "username": "string",
390 "leaseComponentId": 0,
391 "leaseComponentDisplayId": "string",
392 "targetId": "string",
393 "targetType": "string"
394 }
395 ],
396 "spreadingFrequency": "NONE",
397 "contractId": 0,
398 "contractDisplayId": "string",
399 "companyCodeId": 0,
400 "companyCodeDisplayId": "string",
401 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
402 "endOfTermDate": "2019-08-24",
403 "endOfTermPeriod": 0,
404 "allowsSystemGenerateNewId": true,
405 "transferInfo": {
406 "transferredFromDisplayId": "string",
407 "transferredFromRevisionId": 0,
408 "transferredToDisplayId": "string",
409 "transferredToRevisionId": 0
410 },
411 "numberRangeIdentifierType": {
412 "name": "string"
413 },
414 "numberRangeIdentifierValue": "string",
415 "numberRangeType": {
416 "name": "string"
417 },
418 "type": "string"
419 },
420 "activationGroupDto": {
421 "id": 0,
422 "displayId": "string",
423 "principalPositionType": "LESSEE",
424 "name": "string",
425 "description": "string",
426 "approverComment": "string",
427 "snapshotData": {
428 "isParallelCurrencyEnabled": true,
429 "isCostCenterAllocationEnabled": true,
430 "useSpotRateForGroupCurrency": true,
431 "exchangeRateTypes": [
432 {
433 "currencyDefinitionType": "CONTRACT_CURRENCY",
434 "sourceCurrencyType": "CONTRACT_CURRENCY",
435 "translationDateType": "DOCUMENT_DATE",
436 "targetCurrency": {
437 "id": 0,
438 "displayId": "string",
439 "decimalPoints": 0
440 },
441 "referenceCurrency": {
442 "id": 0,
443 "displayId": "string"
444 },
445 "currencyType": "string",
446 "exchangeRateType": "string"
447 }
448 ]
449 },
450 "revision": {
451 "id": 0,
452 "displayId": "string",
453 "name": "string",
454 "inception": true,
455 "revisionType": "REVISION",
456 "state": "MLA_DEFINE",
457 "approvedBy": "string",
458 "approvedAt": "2019-08-24T14:15:22Z",
459 "parentRevisionId": 0,
460 "approverComment": "string",
461 "rouStartDate": "2019-08-24",
462 "rouEndDate": "2019-08-24",
463 "activationGroupModification": {
464 "modificationDate": "2019-08-24",
465 "terminationType": "CASUALTY",
466 "terminationDate": {
467 "timing": "START_OF_DAY",
468 "year": 0,
469 "monthValue": 0,
470 "dayOfMonth": 0,
471 "dayOfWeek": "MONDAY",
472 "leapYear": true,
473 "dayOfYear": 0,
474 "month": "JANUARY"
475 },
476 "useManualFmvValue": true,
477 "useManualAssetValues": true,
478 "enforceNonLeaseOnIndexation": true,
479 "applyIndexationLease": true,
480 "applyIndexationNonLease": true,
481 "indexationTreatmentType": "DEFAULT",
482 "indexationStartDate": "2019-08-24",
483 "indexationDateType": "ROU_ANNIVERSARY_DATE",
484 "indexationStartDateNonLease": "2019-08-24",
485 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
486 "modificationReasons": [
487 "CONTRACT_RATE_CHANGE"
488 ],
489 "modificationPerClassificationList": [
490 {
491 "accountingStandardId": 0,
492 "classificationType": "NON_LEASE",
493 "accountingStandardType": "GAAP",
494 "impairmentAmount": 0.1,
495 "recoverableAmount": 0.1,
496 "decreaseInAsset": 0.1,
497 "decreaseInTerm": 0.1
498 }
499 ],
500 "massIndexationTaskId": 0
501 },
502 "activationGroupId": 0,
503 "activationGroupDisplayId": "string",
504 "activationGroupName": "string",
505 "leaseComponentRevisionId": 0,
506 "leaseComponentRevisionDisplayId": "string",
507 "lastLeaseComponentRevisionId": 0,
508 "lastLeaseComponentRevisionDisplayId": "string",
509 "clonedFromRevisionId": 0,
510 "clonedFromRevisionDisplayId": "string",
511 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
512 "infiniteUsefulLife": true,
513 "transferOfOwnership": true,
514 "specializedAsset": true,
515 "fairMarketValue": 0.1,
516 "residualValue": 0,
517 "endOfTermIntention": "TO_BE_DETERMINED",
518 "endOfTermDate": "2019-08-24",
519 "endOfTermPeriod": 0,
520 "activationDocumentDate": "2019-08-24",
521 "activationPostingDate": "2019-08-24",
522 "closingDocumentDate": "2019-08-24",
523 "closingPostingDate": "2019-08-24",
524 "numberRangeIdentifierType": {
525 "name": "string"
526 },
527 "numberRangeIdentifierValue": "string",
528 "allowsSystemGenerateNewId": true,
529 "numberRangeType": {
530 "name": "string"
531 }
532 },
533 "leaseComponentId": 0,
534 "leaseComponentDisplayId": "string",
535 "companyCodeId": 0,
536 "companyCodeDisplayId": "string",
537 "splittedFromActivationGroupRevisionId": {
538 "id": 0,
539 "displayId": "string",
540 "name": "string",
541 "inception": true,
542 "revisionType": "REVISION",
543 "state": "MLA_DEFINE",
544 "approvedBy": "string",
545 "approvedAt": "2019-08-24T14:15:22Z",
546 "parentRevisionId": 0,
547 "approverComment": "string",
548 "rouStartDate": "2019-08-24",
549 "rouEndDate": "2019-08-24",
550 "activationGroupModification": {
551 "modificationDate": "2019-08-24",
552 "terminationType": "CASUALTY",
553 "terminationDate": {
554 "timing": "START_OF_DAY",
555 "year": 0,
556 "monthValue": 0,
557 "dayOfMonth": 0,
558 "dayOfWeek": "MONDAY",
559 "leapYear": true,
560 "dayOfYear": 0,
561 "month": "JANUARY"
562 },
563 "useManualFmvValue": true,
564 "useManualAssetValues": true,
565 "enforceNonLeaseOnIndexation": true,
566 "applyIndexationLease": true,
567 "applyIndexationNonLease": true,
568 "indexationTreatmentType": "DEFAULT",
569 "indexationStartDate": "2019-08-24",
570 "indexationDateType": "ROU_ANNIVERSARY_DATE",
571 "indexationStartDateNonLease": "2019-08-24",
572 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
573 "modificationReasons": [
574 "CONTRACT_RATE_CHANGE"
575 ],
576 "modificationPerClassificationList": [
577 {
578 "accountingStandardId": 0,
579 "classificationType": "NON_LEASE",
580 "accountingStandardType": "GAAP",
581 "impairmentAmount": 0.1,
582 "recoverableAmount": 0.1,
583 "decreaseInAsset": 0.1,
584 "decreaseInTerm": 0.1
585 }
586 ],
587 "massIndexationTaskId": 0
588 },
589 "activationGroupId": 0,
590 "activationGroupDisplayId": "string",
591 "activationGroupName": "string",
592 "leaseComponentRevisionId": 0,
593 "leaseComponentRevisionDisplayId": "string",
594 "lastLeaseComponentRevisionId": 0,
595 "lastLeaseComponentRevisionDisplayId": "string",
596 "clonedFromRevisionId": 0,
597 "clonedFromRevisionDisplayId": "string",
598 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
599 "infiniteUsefulLife": true,
600 "transferOfOwnership": true,
601 "specializedAsset": true,
602 "fairMarketValue": 0.1,
603 "residualValue": 0,
604 "endOfTermIntention": "TO_BE_DETERMINED",
605 "endOfTermDate": "2019-08-24",
606 "endOfTermPeriod": 0,
607 "activationDocumentDate": "2019-08-24",
608 "activationPostingDate": "2019-08-24",
609 "closingDocumentDate": "2019-08-24",
610 "closingPostingDate": "2019-08-24",
611 "numberRangeIdentifierType": {
612 "name": "string"
613 },
614 "numberRangeIdentifierValue": "string",
615 "allowsSystemGenerateNewId": true,
616 "numberRangeType": {
617 "name": "string"
618 }
619 },
620 "notifications": [
621 {
622 "id": 0,
623 "topic": {
624 "enCaption": "string",
625 "frCaption": "string",
626 "name": "string",
627 "priority": "HIGH"
628 },
629 "username": "string",
630 "activationGroupId": 0,
631 "activationGroupDisplayId": "string",
632 "targetId": "string",
633 "targetType": "string"
634 }
635 ],
636 "transferInfo": {
637 "transferredFromDisplayId": "string",
638 "transferredFromRevisionId": 0,
639 "transferredToDisplayId": "string",
640 "transferredToRevisionId": 0
641 },
642 "numberRangeIdentifierType": {
643 "name": "string"
644 },
645 "numberRangeIdentifierValue": "string",
646 "numberRangeType": {
647 "name": "string"
648 },
649 "allowsSystemGenerateNewId": true
650 }
651 }
652]
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 |
Text value for approverComment in ContractDto |
»» contractPhase |
string |
false |
none |
Text value for contractPhase in ContractDto |
»» dataCreationInfo |
false |
none |
none |
|
»»» id |
integer(int64) |
true |
none |
none |
»»» idGenerationType |
string |
true |
none |
none |
»»» source |
string |
false |
none |
none |
»»» type |
string |
true |
none |
none |
»»» startDateTime |
string(date-time) |
true |
none |
none |
»»» endDateTime |
string(date-time) |
false |
none |
none |
»» 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 |
Text value for approvedBy in ContractRevisionDto |
»»» approvedAt |
string(date-time) |
false |
none |
Text value for approvedAt in ContractRevisionDto |
»»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»»» approverComment |
string |
false |
none |
Text value for approverComment in ContractRevisionDto |
»»» 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 |
Text value for externalReference in ContractRevisionDto |
»»» internalReference |
string |
false |
none |
Text value for internalReference in ContractRevisionDto |
»»» formOfLease |
string |
false |
none |
Text value for formOfLease in ContractRevisionDto |
»»» jointVentureLeaseType |
string |
false |
none |
Type of the joint venture lease |
»»» businessPlace |
string |
false |
none |
Text value for businessPlace in ContractRevisionDto |
»»» 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 |
Text value for group3 in ContractRevisionDto |
»»» group4 |
string |
false |
none |
Text value for group4 in ContractRevisionDto |
»»» signingPerson |
string |
false |
none |
Text value for signingPerson in ContractRevisionDto |
»»» placeOfSignature |
string |
false |
none |
Text value for placeOfSignature in ContractRevisionDto |
»»» dateOfSignature |
string(date) |
false |
none |
Text value for dateOfSignature in ContractRevisionDto |
»»» 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 |
Text value for numberRangeIdentifierValue in ContractRevisionDto |
»»» 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 |
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. |
|
»»» 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 |
»»» 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 |
Text value for enCaption in INotificationTopicType |
»»»» frCaption |
string |
false |
none |
Text value for frCaption in INotificationTopicType |
»»»» 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 |
»»» targetId |
string |
false |
none |
Unique identifier for the target |
»»» targetType |
string |
false |
none |
Type of 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 |
Text value for numberRangeIdentifierValue in ContractDto |
»» 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 |
Text value for legalJurisdiction in MasterAgreementDto |
»» approverComment |
string |
false |
none |
Text value for approverComment in MasterAgreementDto |
»» signingPerson |
string |
false |
none |
Text value for signingPerson in MasterAgreementDto |
»» placeOfSignature |
string |
false |
none |
Text value for placeOfSignature in MasterAgreementDto |
»» dateOfSignature |
string(date) |
false |
none |
Text value for dateOfSignature in MasterAgreementDto |
»» state |
string |
false |
none |
Current state of the portfolio |
»» dataCreationInfo |
false |
none |
none |
|
»» 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 |
Text value for numberRangeIdentifierValue in MasterAgreementDto |
»» 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 |
Text value for approverComment in LeaseComponentDto |
»»» fairMarketValue |
number(double) |
false |
none |
Value for fairMarketValue field |
»»» allocationNumber |
string |
false |
none |
Text value for allocationNumber in LeaseComponentDto |
»»» 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 |
Text value for approvedBy in LeaseComponentRevisionDto |
»»»» approvedAt |
string(date-time) |
false |
none |
Text value for approvedAt in LeaseComponentRevisionDto |
»»»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»»»» approverComment |
string |
false |
none |
Text value for approverComment in LeaseComponentRevisionDto |
»»»» 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 |
Text value for numberRangeIdentifierValue in LeaseComponentRevisionDto |
»»»» 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 |
»»»» targetId |
string |
false |
none |
Unique identifier for the target |
»»»» targetType |
string |
false |
none |
Type of the target |
»»» spreadingFrequency |
string |
false |
none |
Text value for spreadingFrequency in LeaseComponentDto |
»»» 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 |
Text value for numberRangeIdentifierValue in LeaseComponentDto |
»»» 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 |
Text value for approverComment in ActivationGroupDto |
»» 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 |
»»» 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 |
Text value for approvedBy in ActivationGroupRevisionDto |
»»» approvedAt |
string(date-time) |
false |
none |
Text value for approvedAt in ActivationGroupRevisionDto |
»»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»»» approverComment |
string |
false |
none |
Text value for approverComment in ActivationGroupRevisionDto |
»»» 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 |
Text value for timing in TimeOfDay |
»»»»» 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 |
»»»»» dayOfWeek |
string |
false |
none |
Text value for dayOfWeek in TimeOfDay |
»»»»» leapYear |
boolean |
false |
none |
Boolean flag indicating leapYear status |
»»»»» dayOfYear |
integer(int32) |
false |
none |
Numeric value representing dayOfYear |
»»»»» month |
string |
false |
none |
Text value for month in TimeOfDay |
»»»» 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 |
Text value for indexationStartDateNonLease in ActivationGroupModification |
»»»» indexationDateTypeNonLease |
string |
false |
none |
Text value for indexationDateTypeNonLease in ActivationGroupModification |
»»»» 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 |
Text value for lockReason in ActivationGroupRevisionDto |
»»» 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 |
Text value for endOfTermIntention in ActivationGroupRevisionDto |
»»» 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 |
none |
»»» activationPostingDate |
string(date) |
false |
none |
none |
»»» closingDocumentDate |
string(date) |
false |
none |
none |
»»» closingPostingDate |
string(date) |
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. |
|
»»» numberRangeIdentifierValue |
string |
false |
none |
Text value for numberRangeIdentifierValue in ActivationGroupRevisionDto |
»»» 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 |
»»» targetId |
string |
false |
none |
Unique identifier for the target |
»»» targetType |
string |
false |
none |
Type of 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 |
Text value for numberRangeIdentifierValue in ActivationGroupDto |
»» 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 |
assetClassType |
EQUIPMENT, PLANT, PROPERTY |
assetValueCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY |
classificationType |
DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, 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, nan |
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 |
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 |
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 |
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 "numberOfElements": 0,
5 "pageable": {
6 "unpaged": true,
7 "paged": true,
8 "pageNumber": 0,
9 "pageSize": 0,
10 "offset": 0,
11 "sort": {
12 "unsorted": true,
13 "sorted": true,
14 "empty": true
15 }
16 },
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 "taxJurisdictionId": 0,
62 "taxJurisdictionDisplayId": "string",
63 "defaultTaxCodeId": 0,
64 "defaultTaxCodeDisplayId": "string",
65 "defaultExemptionTaxCodeId": 0,
66 "defaultExemptionTaxCodeDisplayId": "string",
67 "defaultExemptionPercentage": 0,
68 "mapping": {
69 "isLeaseExpense": true,
70 "nonLeaseTaxCodeId": 0,
71 "nonLeaseTaxCodeDisplayId": "string",
72 "nonLeaseExemptionTaxCodeId": 0,
73 "nonLeaseExemptionTaxCodeDisplayId": "string",
74 "nonLeaseExemptionTaxPercentage": 0.1,
75 "principalTaxCodeId": 0,
76 "principalTaxCodeDisplayId": "string",
77 "principalExemptionTaxCodeId": 0,
78 "principalExemptionTaxCodeDisplayId": "string",
79 "principalExemptionTaxPercentage": 0.1
80 }
81 }
82 }
83 ],
84 "currency": "string",
85 "postingTransactionType": "string",
86 "status": "string",
87 "taxAmount": 0,
88 "journalId": 0,
89 "journalEntryId": 0,
90 "activationGroupRevisionId": 0,
91 "postingDate": "2019-08-24",
92 "termId": 0,
93 "vendorIdToExpenseAccount": {
94 "property1": "string",
95 "property2": "string"
96 },
97 "smartTaxCalculationRequest": {
98 "requestUniqueId": "string",
99 "taxCalculationType": "NET",
100 "erpSystem": {
101 "id": 0,
102 "displayId": "string"
103 },
104 "company": {
105 "id": 0,
106 "displayId": "string"
107 },
108 "contractCurrency": {
109 "id": 0,
110 "displayId": "string"
111 },
112 "documentDate": "2019-08-24",
113 "postingDate": "2019-08-24",
114 "transactionDate": "2019-08-24",
115 "ledgerType": "LIABILITY",
116 "generateVendorInvoice": true,
117 "reference1": "string",
118 "reference2": "string",
119 "reference3": "string",
120 "accountingStandardDisplayId": "string",
121 "businessAreaDisplayId": "string",
122 "transactionType": "string",
123 "documentNumber": "string",
124 "documentType": "string",
125 "entries": [
126 {
127 "itemNoAcc": "string",
128 "amount": 0,
129 "vendor": {
130 "id": 0,
131 "displayId": "string"
132 },
133 "taxCode": {
134 "id": 0,
135 "displayId": "string"
136 },
137 "taxJurisdiction": {
138 "id": 0,
139 "displayId": "string"
140 },
141 "allocationNumber": "string",
142 "currencyType": "string",
143 "transactionType": "string",
144 "postingType": "PAYMENT",
145 "fosReferences": {
146 "system": {
147 "id": 0,
148 "displayId": "string"
149 },
150 "company": {
151 "id": 0,
152 "displayId": "string"
153 },
154 "leaseArea": {
155 "id": 0,
156 "displayId": "string"
157 },
158 "leaseGroup": {
159 "id": 0,
160 "displayId": "string"
161 },
162 "leaseDepartment": {
163 "id": 0,
164 "displayId": "string"
165 },
166 "businessUnit": {
167 "id": 0,
168 "displayId": "string"
169 },
170 "mainCostCenter": {
171 "id": 0,
172 "displayId": "string"
173 },
174 "internalAssetClass": {
175 "id": 0,
176 "displayId": "string"
177 },
178 "documentType": {
179 "id": 0,
180 "displayId": "string"
181 },
182 "depreciationArea": {
183 "id": 0,
184 "displayId": "string"
185 },
186 "reversalReason": {
187 "id": 0,
188 "displayId": "string"
189 },
190 "tradingPartner": {
191 "id": 0,
192 "displayId": "string"
193 },
194 "allocationNumber": {
195 "id": 0,
196 "displayId": "string"
197 },
198 "responsibleCostCenter": {
199 "id": 0,
200 "displayId": "string"
201 },
202 "workBreakdownStructure": {
203 "id": 0,
204 "displayId": "string"
205 },
206 "businessArea": {
207 "id": 0,
208 "displayId": "string"
209 },
210 "functionalArea": {
211 "id": 0,
212 "displayId": "string"
213 },
214 "plant": {
215 "id": 0,
216 "displayId": "string"
217 },
218 "internalOrder": {
219 "id": 0,
220 "displayId": "string"
221 },
222 "network": {
223 "id": 0,
224 "displayId": "string"
225 },
226 "paymentTerm": {
227 "id": 0,
228 "displayId": "string"
229 },
230 "paymentBlock": {
231 "id": 0,
232 "displayId": "string"
233 },
234 "paymentMethod": {
235 "id": 0,
236 "displayId": "string"
237 },
238 "paymentMethodType": "string",
239 "segment": {
240 "id": 0,
241 "displayId": "string"
242 },
243 "purchasingOrganization": {
244 "id": 0,
245 "displayId": "string"
246 },
247 "purchasingOrder": {
248 "id": 0,
249 "displayId": "string"
250 }
251 },
252 "profitCenter": {
253 "id": 0,
254 "displayId": "string"
255 },
256 "costCenter": {
257 "id": 0,
258 "displayId": "string"
259 },
260 "entryType": "D",
261 "generalLedger": {
262 "id": 0,
263 "displayId": "string"
264 }
265 }
266 ]
267 },
268 "vendorSplits": [
269 {
270 "id": 0,
271 "vendorId": 0,
272 "vendorName": "string",
273 "expenseAccount": "string",
274 "percentage": 0.1,
275 "amount": 0,
276 "taxableAmount": 0.1,
277 "taxJurisdiction": "string",
278 "taxCode": "string",
279 "taxRate": 0.1,
280 "taxAmount": 0.1,
281 "vendorDisplayId": "string"
282 }
283 ],
284 "simpleExchangeRateRequestDto": {
285 "erpSystem": {
286 "id": 0,
287 "displayId": "string"
288 },
289 "fromCurrency": {
290 "id": 0,
291 "displayId": "string"
292 },
293 "toCurrency": {
294 "id": 0,
295 "displayId": "string"
296 },
297 "referenceCurrency": {
298 "id": 0,
299 "displayId": "string"
300 },
301 "exchangeRateType": "string",
302 "conversionDate": "2019-08-24"
303 },
304 "numberRangeIdentifierType": {
305 "name": "string"
306 },
307 "numberRangeIdentifierValue": "string",
308 "allowsSystemGenerateNewId": true,
309 "numberRangeType": {
310 "name": "string"
311 }
312 }
313 ],
314 "number": 0,
315 "sort": {
316 "unsorted": true,
317 "sorted": true,
318 "empty": true
319 },
320 "first": true,
321 "last": true,
322 "empty": true
323}
Get Recurring Payment Vendor Splits For Lease And Payment¶
HTTP Request
GET /api/leases/{id}/activation-group-revisions/{activationGroupRevisionId}/recurring-payments/{paymentId}/vendor-splits
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
activationGroupRevisionId |
path |
integer(int64) |
true |
none |
paymentId |
path |
integer(int64) |
true |
none |
pageable |
query |
true |
none |
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}
Get Charge Vendor Splits For Lease And Charge¶
HTTP Request
GET /api/leases/{id}/activation-group-revisions/{activationGroupRevisionId}/charges/{chargeId}/vendor-splits
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
activationGroupRevisionId |
path |
integer(int64) |
true |
none |
chargeId |
path |
integer(int64) |
true |
none |
pageable |
query |
true |
none |
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}
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 "provisioningFrequencyName": "string",
25 "accountingApproved": true,
26 "indexationType": "string",
27 "cpiGlobalCategoryId": 0,
28 "indexationReferenceDate": "2019-08-24",
29 "currentIndexLevel": 0.1,
30 "conditionallyIndexed": true,
31 "applicableCurrentIndexLevel": 0.1,
32 "indexLevelPercentageChangeLowerBound": 0.1,
33 "indexLevelPercentageChangeUpperBound": 0.1,
34 "indexationTypeNonLease": "string",
35 "cpiGlobalCategoryIdNonLease": 0,
36 "indexationReferenceDateNonLease": "2019-08-24",
37 "currentIndexLevelNonLease": 0.1,
38 "conditionallyIndexedNonLease": true,
39 "applicableCurrentIndexLevelNonLease": 0.1,
40 "indexLevelPercentageChangeLowerBoundNonLease": 0.1,
41 "indexLevelPercentageChangeUpperBoundNonLease": 0.1,
42 "signatureDate": "2019-08-24",
43 "premiseId": 0,
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 "category": {
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 "status": {
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 "state": {
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 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
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 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "version": {
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 "name": "string",
165 "description": "string",
166 "modificationDate": "2019-08-24",
167 "updateContractRate": true,
168 "leaseEvent": {
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 "typeId": 0,
177 "code": "string",
178 "reviewedBy": "string",
179 "reviewedDate": "2019-08-24",
180 "reviewedStatusId": 0,
181 "activityDate": "2019-08-24",
182 "relatedPickListOptionId": 0,
183 "detail": "string",
184 "note": {
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 "message": "string",
193 "preserveOriginalAudit": true,
194 "originalCreatedBy": "string",
195 "originalCreatedDate": "2019-08-24T14:15:22Z",
196 "originalLastModifiedBy": "string",
197 "originalLastModifiedDate": "2019-08-24T14:15:22Z"
198 },
199 "type": {
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 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
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 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "reviewedStatus": {
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 "priority": 0,
236 "internalId": 0,
237 "pickListCode": "string",
238 "pickListLabel": "string",
239 "label": "string",
240 "cultureId": 0,
241 "labelDtos": [
242 {
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 "cultureId": 0,
251 "value": "string"
252 }
253 ]
254 },
255 "relatedPickListOption": {
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 "priority": 0,
264 "internalId": 0,
265 "pickListCode": "string",
266 "pickListLabel": "string",
267 "label": "string",
268 "cultureId": 0,
269 "labelDtos": [
270 {
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 "cultureId": 0,
279 "value": "string"
280 }
281 ]
282 }
283 },
284 "isVisibleVendorPortal": true,
285 "isTerminationVersion": true,
286 "terminationDate": "2019-08-24",
287 "penaltyAmount": 0.1
288 },
289 "premiseDto": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "number": "string",
298 "name": "string",
299 "headPremise": true,
300 "possessionDate": "2019-08-24",
301 "openingDate": "2019-08-24",
302 "closingDate": "2019-08-24",
303 "relocationDate": "2019-08-24",
304 "vacatingDate": "2019-08-24",
305 "expansionDate": "2019-08-24",
306 "statusId": 0,
307 "usageId": 0,
308 "parentPremiseId": 0,
309 "costCenterId": 0,
310 "profitCenterId": 0,
311 "legalEntityId": 0,
312 "occupancyIds": [
313 0
314 ],
315 "locationId": 0,
316 "locationDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "number": "string",
325 "name": "string",
326 "storeNumber": "string",
327 "defaultCurrencyId": 0,
328 "defaultMeasureId": 0,
329 "typeId": 0,
330 "qualityId": 0,
331 "propertyTypeId": 0,
332 "categoryId": 0,
333 "statusId": 0,
334 "businessUnitId": 0,
335 "groupIds": [
336 0
337 ],
338 "legalEntityIds": [
339 0
340 ],
341 "defaultCurrency": {
342 "id": 0,
343 "status": "CREATED",
344 "displayId": "string",
345 "erpSystemId": 0,
346 "erpSystemDisplayId": "string",
347 "name": "string",
348 "decimalPoints": 0,
349 "depreciationAreaId": 0
350 },
351 "defaultUnitValue": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "unitId": 0,
360 "unitOfMeasureId": 0,
361 "erpSystemId": 0,
362 "unit": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "unitOfMeasure": {
391 "id": 0,
392 "status": "CREATED",
393 "displayId": "string",
394 "erpSystemId": 0,
395 "erpSystemDisplayId": "string",
396 "name": "string"
397 }
398 },
399 "type": {
400 "createdBy": "string",
401 "lastModifiedBy": "string",
402 "createdDate": "2019-08-24T14:15:22Z",
403 "lastModifiedDate": "2019-08-24T14:15:22Z",
404 "archived": true,
405 "externalId": "string",
406 "id": 0,
407 "priority": 0,
408 "internalId": 0,
409 "pickListCode": "string",
410 "pickListLabel": "string",
411 "label": "string",
412 "cultureId": 0,
413 "labelDtos": [
414 {
415 "createdBy": "string",
416 "lastModifiedBy": "string",
417 "createdDate": "2019-08-24T14:15:22Z",
418 "lastModifiedDate": "2019-08-24T14:15:22Z",
419 "archived": true,
420 "externalId": "string",
421 "id": 0,
422 "cultureId": 0,
423 "value": "string"
424 }
425 ]
426 },
427 "quality": {
428 "createdBy": "string",
429 "lastModifiedBy": "string",
430 "createdDate": "2019-08-24T14:15:22Z",
431 "lastModifiedDate": "2019-08-24T14:15:22Z",
432 "archived": true,
433 "externalId": "string",
434 "id": 0,
435 "priority": 0,
436 "internalId": 0,
437 "pickListCode": "string",
438 "pickListLabel": "string",
439 "label": "string",
440 "cultureId": 0,
441 "labelDtos": [
442 {
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 "cultureId": 0,
451 "value": "string"
452 }
453 ]
454 },
455 "propertyType": {
456 "createdBy": "string",
457 "lastModifiedBy": "string",
458 "createdDate": "2019-08-24T14:15:22Z",
459 "lastModifiedDate": "2019-08-24T14:15:22Z",
460 "archived": true,
461 "externalId": "string",
462 "id": 0,
463 "priority": 0,
464 "internalId": 0,
465 "pickListCode": "string",
466 "pickListLabel": "string",
467 "label": "string",
468 "cultureId": 0,
469 "labelDtos": [
470 {
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 "cultureId": 0,
479 "value": "string"
480 }
481 ]
482 },
483 "category": {
484 "createdBy": "string",
485 "lastModifiedBy": "string",
486 "createdDate": "2019-08-24T14:15:22Z",
487 "lastModifiedDate": "2019-08-24T14:15:22Z",
488 "archived": true,
489 "externalId": "string",
490 "id": 0,
491 "priority": 0,
492 "internalId": 0,
493 "pickListCode": "string",
494 "pickListLabel": "string",
495 "label": "string",
496 "cultureId": 0,
497 "labelDtos": [
498 {
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 "cultureId": 0,
507 "value": "string"
508 }
509 ]
510 },
511 "status": {
512 "createdBy": "string",
513 "lastModifiedBy": "string",
514 "createdDate": "2019-08-24T14:15:22Z",
515 "lastModifiedDate": "2019-08-24T14:15:22Z",
516 "archived": true,
517 "externalId": "string",
518 "id": 0,
519 "priority": 0,
520 "internalId": 0,
521 "pickListCode": "string",
522 "pickListLabel": "string",
523 "label": "string",
524 "cultureId": 0,
525 "labelDtos": [
526 {
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 "cultureId": 0,
535 "value": "string"
536 }
537 ]
538 },
539 "addressDto": {
540 "createdBy": "string",
541 "lastModifiedBy": "string",
542 "createdDate": "2019-08-24T14:15:22Z",
543 "lastModifiedDate": "2019-08-24T14:15:22Z",
544 "archived": true,
545 "externalId": "string",
546 "id": 0,
547 "street": "string",
548 "civicNumber": "string",
549 "suite": "string",
550 "postalCode": "string",
551 "lon": 0.1,
552 "lat": 0.1,
553 "city": {
554 "createdBy": "string",
555 "lastModifiedBy": "string",
556 "createdDate": "2019-08-24T14:15:22Z",
557 "lastModifiedDate": "2019-08-24T14:15:22Z",
558 "archived": true,
559 "externalId": "string",
560 "id": 0,
561 "name": "string",
562 "province": {
563 "createdBy": "string",
564 "lastModifiedBy": "string",
565 "createdDate": "2019-08-24T14:15:22Z",
566 "lastModifiedDate": "2019-08-24T14:15:22Z",
567 "archived": true,
568 "externalId": "string",
569 "id": 0,
570 "name": "string",
571 "code": "string",
572 "country": {
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 "code": "string"
582 }
583 }
584 },
585 "district": {
586 "createdBy": "string",
587 "lastModifiedBy": "string",
588 "createdDate": "2019-08-24T14:15:22Z",
589 "lastModifiedDate": "2019-08-24T14:15:22Z",
590 "archived": true,
591 "externalId": "string",
592 "id": 0,
593 "name": "string",
594 "city": {
595 "createdBy": "string",
596 "lastModifiedBy": "string",
597 "createdDate": "2019-08-24T14:15:22Z",
598 "lastModifiedDate": "2019-08-24T14:15:22Z",
599 "archived": true,
600 "externalId": "string",
601 "id": 0,
602 "name": "string",
603 "province": {
604 "createdBy": "string",
605 "lastModifiedBy": "string",
606 "createdDate": "2019-08-24T14:15:22Z",
607 "lastModifiedDate": "2019-08-24T14:15:22Z",
608 "archived": true,
609 "externalId": "string",
610 "id": 0,
611 "name": "string",
612 "code": "string",
613 "country": {
614 "createdBy": "string",
615 "lastModifiedBy": "string",
616 "createdDate": "2019-08-24T14:15:22Z",
617 "lastModifiedDate": "2019-08-24T14:15:22Z",
618 "archived": true,
619 "externalId": "string",
620 "id": 0,
621 "name": "string",
622 "code": "string"
623 }
624 }
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 }
675 },
676 "district": {
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 "city": {
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 "province": {
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 "code": "string",
704 "country": {
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 }
715 }
716 }
717 },
718 "cityId": 0,
719 "districtId": 0
720 }
721 },
722 "status": {
723 "createdBy": "string",
724 "lastModifiedBy": "string",
725 "createdDate": "2019-08-24T14:15:22Z",
726 "lastModifiedDate": "2019-08-24T14:15:22Z",
727 "archived": true,
728 "externalId": "string",
729 "id": 0,
730 "priority": 0,
731 "internalId": 0,
732 "pickListCode": "string",
733 "pickListLabel": "string",
734 "label": "string",
735 "cultureId": 0,
736 "labelDtos": [
737 {
738 "createdBy": "string",
739 "lastModifiedBy": "string",
740 "createdDate": "2019-08-24T14:15:22Z",
741 "lastModifiedDate": "2019-08-24T14:15:22Z",
742 "archived": true,
743 "externalId": "string",
744 "id": 0,
745 "cultureId": 0,
746 "value": "string"
747 }
748 ]
749 },
750 "usage": {
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 "priority": 0,
759 "internalId": 0,
760 "pickListCode": "string",
761 "pickListLabel": "string",
762 "label": "string",
763 "cultureId": 0,
764 "labelDtos": [
765 {
766 "createdBy": "string",
767 "lastModifiedBy": "string",
768 "createdDate": "2019-08-24T14:15:22Z",
769 "lastModifiedDate": "2019-08-24T14:15:22Z",
770 "archived": true,
771 "externalId": "string",
772 "id": 0,
773 "cultureId": 0,
774 "value": "string"
775 }
776 ]
777 },
778 "occupanciesDto": [
779 {
780 "createdBy": "string",
781 "lastModifiedBy": "string",
782 "createdDate": "2019-08-24T14:15:22Z",
783 "lastModifiedDate": "2019-08-24T14:15:22Z",
784 "archived": true,
785 "externalId": "string",
786 "id": 0,
787 "priority": 0,
788 "internalId": 0,
789 "pickListCode": "string",
790 "pickListLabel": "string",
791 "label": "string",
792 "cultureId": 0,
793 "labelDtos": [
794 {
795 "createdBy": "string",
796 "lastModifiedBy": "string",
797 "createdDate": "2019-08-24T14:15:22Z",
798 "lastModifiedDate": "2019-08-24T14:15:22Z",
799 "archived": true,
800 "externalId": "string",
801 "id": 0,
802 "cultureId": 0,
803 "value": "string"
804 }
805 ]
806 }
807 ]
808 },
809 "isTerminationVersion": true
810}
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 |
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 |
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 |