ContractDto

Example Json Object

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "principalPositionType": "LESSEE",
  6  "validFrom": "2019-08-24",
  7  "validTo": "2019-08-24",
  8  "amendmentDate": "2019-08-24",
  9  "approverComment": "string",
 10  "contractPhase": "INITIAL",
 11  "dataCreationInfo": {
 12    "id": 0,
 13    "idGenerationType": "AUTO",
 14    "source": "string",
 15    "type": "MIGRATION",
 16    "startDateTime": "2019-08-24T14:15:22Z",
 17    "endDateTime": "2019-08-24T14:15:22Z"
 18  },
 19  "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
 20  "revision": {
 21    "id": 0,
 22    "displayId": "string",
 23    "name": "string",
 24    "inception": true,
 25    "revisionType": "REVISION",
 26    "state": "MLA_DEFINE",
 27    "approvedBy": "string",
 28    "approvedAt": "2019-08-24T14:15:22Z",
 29    "parentRevisionId": 0,
 30    "approverComment": "string",
 31    "contractId": 0,
 32    "contractDisplayId": "string",
 33    "contractName": "string",
 34    "principalPositionType": "LESSEE",
 35    "mlaId": 0,
 36    "companyId": 0,
 37    "description": "string",
 38    "externalReference": "string",
 39    "internalReference": "string",
 40    "formOfLease": "FULL",
 41    "jointVentureLeaseType": "GROSS_LEASE",
 42    "businessPlace": "string",
 43    "tradingPartner": {
 44      "id": 0,
 45      "displayId": "string",
 46      "status": "CREATED",
 47      "name": "string",
 48      "erpSystemId": 0,
 49      "erpSystemDisplayId": "string"
 50    },
 51    "contractCategoryGroup": {
 52      "id": 0,
 53      "displayId": "string",
 54      "status": "CREATED",
 55      "name": "string"
 56    },
 57    "contractGroup1": {
 58      "id": 0,
 59      "displayId": "string",
 60      "status": "CREATED",
 61      "name": "string"
 62    },
 63    "contractGroup2": {
 64      "id": 0,
 65      "displayId": "string",
 66      "status": "CREATED",
 67      "name": "string"
 68    },
 69    "group3": "string",
 70    "group4": "string",
 71    "signingPerson": "string",
 72    "placeOfSignature": "string",
 73    "dateOfSignature": "2019-08-24",
 74    "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
 75    "numberRangeIdentifierType": {
 76      "name": "string"
 77    },
 78    "numberRangeIdentifierValue": "string",
 79    "allowsSystemGenerateNewId": true,
 80    "numberRangeType": {
 81      "name": "string"
 82    }
 83  },
 84  "currency": {
 85    "id": 0,
 86    "displayId": "string",
 87    "status": "CREATED",
 88    "name": "string",
 89    "decimalPoints": 0
 90  },
 91  "companyCurrency": {
 92    "id": 0,
 93    "displayId": "string",
 94    "status": "CREATED",
 95    "name": "string",
 96    "decimalPoints": 0
 97  },
 98  "indexedCurrency": true,
 99  "assetValueCurrencyType": "CONTRACT_CURRENCY",
100  "currencyLocked": true,
101  "leaseArea": {
102    "id": 0,
103    "displayId": "string",
104    "status": "CREATED",
105    "name": "string"
106  },
107  "businessUnit": {
108    "id": 0,
109    "displayId": "string",
110    "status": "CREATED",
111    "name": "string"
112  },
113  "businessUnitLocked": true,
114  "companyCode": {
115    "id": 0,
116    "displayId": "string",
117    "status": "CREATED",
118    "erpSystemId": 0,
119    "erpSystemDisplayId": "string",
120    "countryId": 0,
121    "countryDisplayId": "string",
122    "name": "string",
123    "postingPeriodVariantId": 0,
124    "fiscalVariantId": 0
125  },
126  "companyCodeLocked": true,
127  "department": {
128    "id": 0,
129    "displayId": "string",
130    "status": "CREATED",
131    "name": "string"
132  },
133  "departmentLocked": true,
134  "leaseGroup": {
135    "id": 0,
136    "displayId": "string",
137    "status": "CREATED",
138    "name": "string"
139  },
140  "leaseGroupLocked": true,
141  "subleasingInternalAssetClass": {
142    "id": 0,
143    "displayId": "string",
144    "status": "CREATED",
145    "name": "string",
146    "assetClassType": "PROPERTY",
147    "infiniteUsefulLife": true
148  },
149  "contractGroup1": {
150    "id": 0,
151    "displayId": "string",
152    "status": "CREATED",
153    "name": "string"
154  },
155  "contractGroup2": {
156    "id": 0,
157    "displayId": "string",
158    "status": "CREATED",
159    "name": "string"
160  },
161  "subleasing": true,
162  "subleasingContractRevisionInfo": {
163    "id": 0,
164    "contractId": 0,
165    "contractDisplayId": "string",
166    "contractName": "string"
167  },
168  "subleasingLeaseComponentRevisionInfo": {
169    "id": 0,
170    "leaseComponentId": 0,
171    "leaseComponentDisplayId": "string",
172    "leaseComponentName": "string"
173  },
174  "subleasingActivationGroupRevisionInfo": {
175    "id": 0,
176    "activationGroupId": 0,
177    "activationGroupDisplayId": "string",
178    "activationGroupName": "string"
179  },
180  "notifications": [
181    {
182      "id": 0,
183      "topic": {
184        "enCaption": "string",
185        "frCaption": "string",
186        "name": "string",
187        "priority": "HIGH"
188      },
189      "username": "string",
190      "contractId": 0,
191      "contractDisplayId": "string",
192      "targetType": "string",
193      "targetId": "string"
194    }
195  ],
196  "masterAgreementId": 0,
197  "masterAgreementDisplayId": "string",
198  "allowsSystemGenerateNewId": true,
199  "transferInfo": {
200    "transferredFromDisplayId": "string",
201    "transferredFromRevisionId": 0,
202    "transferredToDisplayId": "string",
203    "transferredToRevisionId": 0
204  },
205  "numberRangeIdentifierType": {
206    "name": "string"
207  },
208  "numberRangeIdentifierValue": "string",
209  "numberRangeType": {
210    "name": "string"
211  }
212}

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

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

name

string

true

none

Name of the resource

principalPositionType

string

true

none

Type of the principal position

validFrom

string(date)

false

none

Date from which the resource is valid

validTo

string(date)

false

none

Date until which the resource is valid

amendmentDate

string(date)

false

none

Date of the amendment

approverComment

string

false

none

Comment provided by the approver regarding the contract, facilitating transparency and communication within the portfolio management process.

contractPhase

string

false

none

Indicates the current phase of the contract within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate property analytics.

dataCreationInfo

DataCreationSettingLite

false

none

Contains metadata regarding the creation of the contract, providing essential insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

leaseType

string

false

none

Type of the lease

revision

ContractRevisionDto

false

none

Value for revision field

currency

CurrencyLite

false

none

Value for currency field

companyCurrency

CurrencyLite

false

none

Value for companyCurrency field

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

LeaseAreaLite

true

none

Value for leaseArea field

businessUnit

BusinessUnitLite

true

none

Value for businessUnit field

businessUnitLocked

boolean

false

none

Boolean flag indicating businessUnitLocked status

companyCode

CompanyLite

true

none

Code for the company

companyCodeLocked

boolean

false

none

Boolean flag indicating companyCodeLocked status

department

DepartmentLite

false

none

Value for department field

departmentLocked

boolean

false

none

Boolean flag indicating departmentLocked status

leaseGroup

LeaseGroupLite

false

none

Value for leaseGroup field

leaseGroupLocked

boolean

false

none

Boolean flag indicating leaseGroupLocked status

subleasingInternalAssetClass

InternalAssetClassLite

false

none

Value for subleasingInternalAssetClass field

contractGroup1

ContractGroup1Lite

false

none

Value for contractGroup1 field

contractGroup2

ContractGroup2Lite

false

none

Value for contractGroup2 field

subleasing

boolean

false

none

Boolean flag indicating subleasing status

subleasingContractRevisionInfo

SubleasingContractRevisionLite

false

none

Value for subleasingContractRevisionInfo field

subleasingLeaseComponentRevisionInfo

SubleasingLeaseComponentRevisionLite

false

none

Value for subleasingLeaseComponentRevisionInfo field

subleasingActivationGroupRevisionInfo

SubleasingActivationGroupRevisionLite

false

none

Value for subleasingActivationGroupRevisionInfo field

notifications

[ContractSubscriptionDto]

false

none

List of notifications items

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

MassInterCompanyTransferInfo

false

none

Value for transferInfo field

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeIdentifierValue

string

false

none

Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite.

numberRangeType

INumberRangeType

false

none

Type of the number range

Enumerated Values

Attribute

Value

assetValueCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY

contractPhase

CLOSED, DRAFT, INITIAL, REJECTED, SETUP

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

principalPositionType

LESSEE, LESSOR