NfsLinkDto

Example Json Object

  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  "masterAgreementId": 0,
 10  "contractId": 0,
 11  "leaseComponentId": 0,
 12  "contractRevisionId": 0,
 13  "leaseComponentRevisionId": 0,
 14  "activationGroupRevisionId": 0,
 15  "contractDto": {
 16    "id": 0,
 17    "displayId": "string",
 18    "name": "string",
 19    "principalPositionType": "LESSEE",
 20    "validFrom": "2019-08-24",
 21    "validTo": "2019-08-24",
 22    "amendmentDate": "2019-08-24",
 23    "approverComment": "string",
 24    "contractPhase": "INITIAL",
 25    "dataCreationInfo": {
 26      "id": 0,
 27      "idGenerationType": "AUTO",
 28      "source": "string",
 29      "type": "MIGRATION",
 30      "startDateTime": "2019-08-24T14:15:22Z",
 31      "endDateTime": "2019-08-24T14:15:22Z"
 32    },
 33    "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
 34    "revision": {
 35      "id": 0,
 36      "displayId": "string",
 37      "name": "string",
 38      "inception": true,
 39      "revisionType": "REVISION",
 40      "state": "MLA_DEFINE",
 41      "approvedBy": "string",
 42      "approvedAt": "2019-08-24T14:15:22Z",
 43      "parentRevisionId": 0,
 44      "approverComment": "string",
 45      "contractId": 0,
 46      "contractDisplayId": "string",
 47      "contractName": "string",
 48      "principalPositionType": "LESSEE",
 49      "mlaId": 0,
 50      "companyId": 0,
 51      "description": "string",
 52      "externalReference": "string",
 53      "internalReference": "string",
 54      "formOfLease": "FULL",
 55      "jointVentureLeaseType": "GROSS_LEASE",
 56      "businessPlace": "string",
 57      "tradingPartner": {
 58        "id": 0,
 59        "displayId": "string",
 60        "status": "CREATED",
 61        "name": "string",
 62        "erpSystemId": 0,
 63        "erpSystemDisplayId": "string"
 64      },
 65      "contractCategoryGroup": {
 66        "id": 0,
 67        "displayId": "string",
 68        "status": "CREATED",
 69        "name": "string"
 70      },
 71      "contractGroup1": {
 72        "id": 0,
 73        "displayId": "string",
 74        "status": "CREATED",
 75        "name": "string"
 76      },
 77      "contractGroup2": {
 78        "id": 0,
 79        "displayId": "string",
 80        "status": "CREATED",
 81        "name": "string"
 82      },
 83      "group3": "string",
 84      "group4": "string",
 85      "signingPerson": "string",
 86      "placeOfSignature": "string",
 87      "dateOfSignature": "2019-08-24",
 88      "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
 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      "name": "string",
137      "postingPeriodVariantId": 0,
138      "fiscalVariantId": 0
139    },
140    "companyCodeLocked": true,
141    "department": {
142      "id": 0,
143      "displayId": "string",
144      "status": "CREATED",
145      "name": "string"
146    },
147    "departmentLocked": true,
148    "leaseGroup": {
149      "id": 0,
150      "displayId": "string",
151      "status": "CREATED",
152      "name": "string"
153    },
154    "leaseGroupLocked": true,
155    "subleasingInternalAssetClass": {
156      "id": 0,
157      "displayId": "string",
158      "status": "CREATED",
159      "name": "string",
160      "assetClassType": "PROPERTY",
161      "infiniteUsefulLife": true
162    },
163    "contractGroup1": {
164      "id": 0,
165      "displayId": "string",
166      "status": "CREATED",
167      "name": "string"
168    },
169    "contractGroup2": {
170      "id": 0,
171      "displayId": "string",
172      "status": "CREATED",
173      "name": "string"
174    },
175    "subleasing": true,
176    "subleasingContractRevisionInfo": {
177      "id": 0,
178      "contractId": 0,
179      "contractDisplayId": "string",
180      "contractName": "string"
181    },
182    "subleasingLeaseComponentRevisionInfo": {
183      "id": 0,
184      "leaseComponentId": 0,
185      "leaseComponentDisplayId": "string",
186      "leaseComponentName": "string"
187    },
188    "subleasingActivationGroupRevisionInfo": {
189      "id": 0,
190      "activationGroupId": 0,
191      "activationGroupDisplayId": "string",
192      "activationGroupName": "string"
193    },
194    "notifications": [
195      {
196        "id": 0,
197        "topic": {
198          "enCaption": "string",
199          "frCaption": "string",
200          "name": "string",
201          "priority": "HIGH"
202        },
203        "username": "string",
204        "contractId": 0,
205        "contractDisplayId": "string",
206        "targetType": "string",
207        "targetId": "string"
208      }
209    ],
210    "masterAgreementId": 0,
211    "masterAgreementDisplayId": "string",
212    "allowsSystemGenerateNewId": true,
213    "transferInfo": {
214      "transferredFromDisplayId": "string",
215      "transferredFromRevisionId": 0,
216      "transferredToDisplayId": "string",
217      "transferredToRevisionId": 0
218    },
219    "numberRangeIdentifierType": {
220      "name": "string"
221    },
222    "numberRangeIdentifierValue": "string",
223    "numberRangeType": {
224      "name": "string"
225    }
226  },
227  "masterAgreementDto": {
228    "id": 0,
229    "displayId": "string",
230    "year": 1900,
231    "name": "string",
232    "description": "string",
233    "validFrom": "2019-08-24",
234    "validTo": "2019-08-24",
235    "targetValue": 0.1,
236    "legalJurisdiction": "string",
237    "approverComment": "string",
238    "signingPerson": "string",
239    "placeOfSignature": "string",
240    "dateOfSignature": "2019-08-24",
241    "state": "MLA_DEFINE",
242    "dataCreationInfo": {
243      "id": 0,
244      "idGenerationType": "AUTO",
245      "source": "string",
246      "type": "MIGRATION",
247      "startDateTime": "2019-08-24T14:15:22Z",
248      "endDateTime": "2019-08-24T14:15:22Z"
249    },
250    "agreementGroup": {
251      "id": 0,
252      "displayId": "string",
253      "status": "CREATED",
254      "name": "string"
255    },
256    "currency": {
257      "id": 0,
258      "displayId": "string",
259      "status": "CREATED",
260      "name": "string",
261      "decimalPoints": 0
262    },
263    "internalAssetClass": {
264      "id": 0,
265      "displayId": "string",
266      "status": "CREATED",
267      "name": "string",
268      "assetClassType": "PROPERTY",
269      "infiniteUsefulLife": true
270    },
271    "leaseArea": {
272      "id": 0,
273      "displayId": "string",
274      "status": "CREATED",
275      "name": "string"
276    },
277    "businessUnit": {
278      "id": 0,
279      "displayId": "string",
280      "status": "CREATED",
281      "name": "string"
282    },
283    "companyCode": {
284      "id": 0,
285      "displayId": "string",
286      "status": "CREATED",
287      "erpSystemId": 0,
288      "erpSystemDisplayId": "string",
289      "countryId": 0,
290      "countryDisplayId": "string",
291      "name": "string",
292      "postingPeriodVariantId": 0,
293      "fiscalVariantId": 0
294    },
295    "department": {
296      "id": 0,
297      "displayId": "string",
298      "status": "CREATED",
299      "name": "string"
300    },
301    "leaseGroup": {
302      "id": 0,
303      "displayId": "string",
304      "status": "CREATED",
305      "name": "string"
306    },
307    "allowsSystemGenerateNewId": true,
308    "numberRangeIdentifierType": {
309      "name": "string"
310    },
311    "numberRangeIdentifierValue": "string",
312    "numberRangeType": {
313      "name": "string"
314    }
315  },
316  "leaseComponentDto": {
317    "id": 0,
318    "displayId": "string",
319    "principalPositionType": "LESSEE",
320    "name": "string",
321    "description": "string",
322    "bulkAsset": true,
323    "rouStartDate": "2019-08-24",
324    "rouEndDate": "2019-08-24",
325    "approverComment": "string",
326    "fairMarketValue": 0.1,
327    "allocationNumber": "string",
328    "guaranteedResidualValue": 0.1,
329    "unitDistributions": [
330      {
331        "id": 0,
332        "leaseComponentId": 0,
333        "leaseComponentDisplayId": "string",
334        "activationGroupName": "string",
335        "activationGroupDisplayId": "string",
336        "numberOfUnits": 0,
337        "unitDisplayIds": [
338          "string"
339        ]
340      }
341    ],
342    "revision": {
343      "id": 0,
344      "displayId": "string",
345      "name": "string",
346      "inception": true,
347      "revisionType": "REVISION",
348      "state": "MLA_DEFINE",
349      "approvedBy": "string",
350      "approvedAt": "2019-08-24T14:15:22Z",
351      "parentRevisionId": 0,
352      "approverComment": "string",
353      "leaseComponentId": 0,
354      "leaseComponentDisplayId": "string",
355      "leaseComponentName": "string",
356      "contractRevisionId": 0,
357      "contractRevisionDisplayId": "string",
358      "numberRangeIdentifierType": {
359        "name": "string"
360      },
361      "numberRangeIdentifierValue": "string",
362      "allowsSystemGenerateNewId": true,
363      "numberRangeType": {
364        "name": "string"
365      }
366    },
367    "internalAssetClass": {
368      "id": 0,
369      "displayId": "string",
370      "status": "CREATED",
371      "name": "string",
372      "assetClassType": "PROPERTY",
373      "infiniteUsefulLife": true
374    },
375    "unitOfMeasure": {
376      "id": 0,
377      "displayId": "string",
378      "status": "CREATED",
379      "name": "string",
380      "erpSystemId": 0
381    },
382    "notifications": [
383      {
384        "id": 0,
385        "topic": {
386          "enCaption": "string",
387          "frCaption": "string",
388          "name": "string",
389          "priority": "HIGH"
390        },
391        "username": "string",
392        "leaseComponentId": 0,
393        "leaseComponentDisplayId": "string",
394        "targetType": "string",
395        "targetId": "string"
396      }
397    ],
398    "spreadingFrequency": "NONE",
399    "contractId": 0,
400    "contractDisplayId": "string",
401    "companyCodeId": 0,
402    "companyCodeDisplayId": "string",
403    "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
404    "endOfTermDate": "2019-08-24",
405    "endOfTermPeriod": 0,
406    "allowsSystemGenerateNewId": true,
407    "transferInfo": {
408      "transferredFromDisplayId": "string",
409      "transferredFromRevisionId": 0,
410      "transferredToDisplayId": "string",
411      "transferredToRevisionId": 0
412    },
413    "numberRangeIdentifierType": {
414      "name": "string"
415    },
416    "numberRangeIdentifierValue": "string",
417    "numberRangeType": {
418      "name": "string"
419    },
420    "type": "string"
421  },
422  "activationGroupDto": {
423    "id": 0,
424    "displayId": "string",
425    "principalPositionType": "LESSEE",
426    "name": "string",
427    "description": "string",
428    "approverComment": "string",
429    "snapshotData": {
430      "isParallelCurrencyEnabled": true,
431      "isCostCenterAllocationEnabled": true,
432      "useSpotRateForGroupCurrency": true,
433      "usePostingOrDocumentDateForCurrency": true,
434      "exchangeRateTypes": [
435        {
436          "currencyDefinitionType": "CONTRACT_CURRENCY",
437          "sourceCurrencyType": "CONTRACT_CURRENCY",
438          "translationDateType": "DOCUMENT_DATE",
439          "targetCurrency": {
440            "id": 0,
441            "displayId": "string",
442            "decimalPoints": 0
443          },
444          "referenceCurrency": {
445            "id": 0,
446            "displayId": "string"
447          },
448          "currencyType": "string",
449          "exchangeRateType": "string"
450        }
451      ]
452    },
453    "revision": {
454      "id": 0,
455      "displayId": "string",
456      "name": "string",
457      "inception": true,
458      "revisionType": "REVISION",
459      "state": "MLA_DEFINE",
460      "approvedBy": "string",
461      "approvedAt": "2019-08-24T14:15:22Z",
462      "parentRevisionId": 0,
463      "approverComment": "string",
464      "rouStartDate": "2019-08-24",
465      "rouEndDate": "2019-08-24",
466      "activationGroupModification": {
467        "modificationDate": "2019-08-24",
468        "terminationType": "CASUALTY",
469        "terminationDate": {
470          "timing": "START_OF_DAY",
471          "year": 0,
472          "monthValue": 0,
473          "dayOfMonth": 0,
474          "leapYear": true,
475          "month": "JANUARY",
476          "dayOfWeek": "MONDAY",
477          "dayOfYear": 0
478        },
479        "useManualFmvValue": true,
480        "useManualAssetValues": true,
481        "enforceNonLeaseOnIndexation": true,
482        "applyIndexationLease": true,
483        "applyIndexationNonLease": true,
484        "indexationTreatmentType": "DEFAULT",
485        "indexationStartDate": "2019-08-24",
486        "indexationDateType": "ROU_ANNIVERSARY_DATE",
487        "indexationStartDateNonLease": "2019-08-24",
488        "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
489        "modificationReasons": [
490          "CONTRACT_RATE_CHANGE"
491        ],
492        "modificationPerClassificationList": [
493          {
494            "accountingStandardId": 0,
495            "classificationType": "NON_LEASE",
496            "accountingStandardType": "GAAP",
497            "impairmentAmount": 0.1,
498            "recoverableAmount": 0.1,
499            "decreaseInAsset": 0.1,
500            "decreaseInTerm": 0.1
501          }
502        ],
503        "massIndexationTaskId": 0
504      },
505      "activationGroupId": 0,
506      "activationGroupDisplayId": "string",
507      "activationGroupName": "string",
508      "leaseComponentRevisionId": 0,
509      "leaseComponentRevisionDisplayId": "string",
510      "lastLeaseComponentRevisionId": 0,
511      "lastLeaseComponentRevisionDisplayId": "string",
512      "clonedFromRevisionId": 0,
513      "clonedFromRevisionDisplayId": "string",
514      "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
515      "infiniteUsefulLife": true,
516      "transferOfOwnership": true,
517      "specializedAsset": true,
518      "fairMarketValue": 0.1,
519      "residualValue": 0,
520      "endOfTermIntention": "TO_BE_DETERMINED",
521      "endOfTermDate": "2019-08-24",
522      "endOfTermPeriod": 0,
523      "activationDocumentDate": "2019-08-24",
524      "activationPostingDate": "2019-08-24",
525      "closingDocumentDate": "2019-08-24",
526      "closingPostingDate": "2019-08-24",
527      "numberRangeIdentifierType": {
528        "name": "string"
529      },
530      "numberRangeIdentifierValue": "string",
531      "allowsSystemGenerateNewId": true,
532      "numberRangeType": {
533        "name": "string"
534      }
535    },
536    "leaseComponentId": 0,
537    "leaseComponentDisplayId": "string",
538    "companyCodeId": 0,
539    "companyCodeDisplayId": "string",
540    "splittedFromActivationGroupRevisionId": {
541      "id": 0,
542      "displayId": "string",
543      "name": "string",
544      "inception": true,
545      "revisionType": "REVISION",
546      "state": "MLA_DEFINE",
547      "approvedBy": "string",
548      "approvedAt": "2019-08-24T14:15:22Z",
549      "parentRevisionId": 0,
550      "approverComment": "string",
551      "rouStartDate": "2019-08-24",
552      "rouEndDate": "2019-08-24",
553      "activationGroupModification": {
554        "modificationDate": "2019-08-24",
555        "terminationType": "CASUALTY",
556        "terminationDate": {
557          "timing": "START_OF_DAY",
558          "year": 0,
559          "monthValue": 0,
560          "dayOfMonth": 0,
561          "leapYear": true,
562          "month": "JANUARY",
563          "dayOfWeek": "MONDAY",
564          "dayOfYear": 0
565        },
566        "useManualFmvValue": true,
567        "useManualAssetValues": true,
568        "enforceNonLeaseOnIndexation": true,
569        "applyIndexationLease": true,
570        "applyIndexationNonLease": true,
571        "indexationTreatmentType": "DEFAULT",
572        "indexationStartDate": "2019-08-24",
573        "indexationDateType": "ROU_ANNIVERSARY_DATE",
574        "indexationStartDateNonLease": "2019-08-24",
575        "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
576        "modificationReasons": [
577          "CONTRACT_RATE_CHANGE"
578        ],
579        "modificationPerClassificationList": [
580          {
581            "accountingStandardId": 0,
582            "classificationType": "NON_LEASE",
583            "accountingStandardType": "GAAP",
584            "impairmentAmount": 0.1,
585            "recoverableAmount": 0.1,
586            "decreaseInAsset": 0.1,
587            "decreaseInTerm": 0.1
588          }
589        ],
590        "massIndexationTaskId": 0
591      },
592      "activationGroupId": 0,
593      "activationGroupDisplayId": "string",
594      "activationGroupName": "string",
595      "leaseComponentRevisionId": 0,
596      "leaseComponentRevisionDisplayId": "string",
597      "lastLeaseComponentRevisionId": 0,
598      "lastLeaseComponentRevisionDisplayId": "string",
599      "clonedFromRevisionId": 0,
600      "clonedFromRevisionDisplayId": "string",
601      "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
602      "infiniteUsefulLife": true,
603      "transferOfOwnership": true,
604      "specializedAsset": true,
605      "fairMarketValue": 0.1,
606      "residualValue": 0,
607      "endOfTermIntention": "TO_BE_DETERMINED",
608      "endOfTermDate": "2019-08-24",
609      "endOfTermPeriod": 0,
610      "activationDocumentDate": "2019-08-24",
611      "activationPostingDate": "2019-08-24",
612      "closingDocumentDate": "2019-08-24",
613      "closingPostingDate": "2019-08-24",
614      "numberRangeIdentifierType": {
615        "name": "string"
616      },
617      "numberRangeIdentifierValue": "string",
618      "allowsSystemGenerateNewId": true,
619      "numberRangeType": {
620        "name": "string"
621      }
622    },
623    "notifications": [
624      {
625        "id": 0,
626        "topic": {
627          "enCaption": "string",
628          "frCaption": "string",
629          "name": "string",
630          "priority": "HIGH"
631        },
632        "username": "string",
633        "activationGroupId": 0,
634        "activationGroupDisplayId": "string",
635        "targetType": "string",
636        "targetId": "string"
637      }
638    ],
639    "transferInfo": {
640      "transferredFromDisplayId": "string",
641      "transferredFromRevisionId": 0,
642      "transferredToDisplayId": "string",
643      "transferredToRevisionId": 0
644    },
645    "numberRangeIdentifierType": {
646      "name": "string"
647    },
648    "numberRangeIdentifierValue": "string",
649    "numberRangeType": {
650      "name": "string"
651    },
652    "allowsSystemGenerateNewId": true
653  }
654}

📄 Description: 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.

Properties

Name

Type

Required

Restrictions

Description

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

ContractDto

false

none

Value for contractDto field

masterAgreementDto

MasterAgreementDto

false

none

Value for masterAgreementDto field

leaseComponentDto

any

false

none

Value for leaseComponentDto field

📄 Description: oneOf - discriminator: LeaseComponentDto.type

Name

Type

Required

Restrictions

Description

» anonymous

LeaseComponentDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

LesseeLeaseComponentDto

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.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

LessorLeaseComponentDto

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.

📄 Description: continued

Name

Type

Required

Restrictions

Description

activationGroupDto

ActivationGroupDto

false

none

Value for activationGroupDto field