ResponseContractDto

Example Json Object

  1{
  2  "code": "OK",
  3  "message": "response.validation.failed",
  4  "defaultMessage": "string",
  5  "debugMessage": "Response object is not valid due to: currency is required",
  6  "errors": {
  7    "all": []
  8  },
  9  "object": {
 10    "id": 10000018,
 11    "displayId": "CT-100001000",
 12    "name": "Testtt Contract",
 13    "principalPositionType": {
 14      "name": "LESSEE",
 15      "captionKey": "enum.principalpositiontype.lessee",
 16      "caption": "Lessee"
 17    },
 18    "validFrom": "2019-08-24",
 19    "validTo": "2019-08-24",
 20    "amendmentDate": "2019-08-24",
 21    "approverComment": "string",
 22    "contractPhase": "INITIAL",
 23    "dataCreationInfo": {
 24      "id": 10000001,
 25      "idGenerationType": {
 26        "name": "AUTO",
 27        "captionKey": "enum.idGenerationType.auto",
 28        "caption": "Auto"
 29      },
 30      "source": "sample_source",
 31      "type": {
 32        "name": "MIGRATION",
 33        "captionKey": "enum.dataType.migration",
 34        "caption": "Migration"
 35      },
 36      "startDateTime": "2025-01-01T10:00:00Z",
 37      "endDateTime": "2025-01-01T10:00:00Z"
 38    },
 39    "leaseType": {
 40      "name": "LEASE_CONTRACT_FIX",
 41      "captionKey": "enum.leaseType.fix",
 42      "principalPositionType": "LESSEE",
 43      "caption": "Fixed Lease Contract"
 44    },
 45    "revision": {
 46      "id": 10000008,
 47      "displayId": "CR-0001",
 48      "name": "Initial Revision",
 49      "inception": "2019-08-24",
 50      "revisionType": "ACTIVE",
 51      "state": "LC_DEFINE",
 52      "approvedBy": "manager.user@company.com",
 53      "approvedAt": "2019-08-24T14:15:22Z",
 54      "parentRevisionId": 10000010,
 55      "approverComment": "Approved with changes.",
 56      "contractId": 20000001,
 57      "contractDisplayId": "C-0001",
 58      "contractName": "Office Lease Contract",
 59      "principalPositionType": {
 60        "name": "LESSEE",
 61        "captionKey": "enum.principalpositiontype.lessee",
 62        "caption": "Lessee"
 63      },
 64      "mlaId": 30000001,
 65      "companyId": 40000001,
 66      "description": "Revision to adjust payment terms.",
 67      "externalReference": "EXT-REF-001",
 68      "internalReference": "INT-REF-001",
 69      "formOfLease": "FULL",
 70      "jointVentureLeaseType": "GROSS_LEASE",
 71      "businessPlace": "New York Office",
 72      "tradingPartner": {
 73        "id": 50000001,
 74        "displayId": "TP-0001",
 75        "status": {
 76          "name": "ACTIVE",
 77          "captionKey": "enum.objectStatus.active",
 78          "active": true,
 79          "caption": "Active"
 80        },
 81        "name": "ABC Real Estate Partners",
 82        "erpSystemId": 60000001,
 83        "erpSystemDisplayId": "ERP-SYS-01"
 84      },
 85      "contractCategoryGroup": {
 86        "id": 10000001,
 87        "displayId": "sample_displayId",
 88        "status": {
 89          "name": "ACTIVE",
 90          "captionKey": "enum.objectStatus.active",
 91          "active": true,
 92          "caption": "Active"
 93        },
 94        "name": "Sample Name"
 95      },
 96      "contractGroup1": {
 97        "id": 400001,
 98        "displayId": "CG1-01",
 99        "status": {
100          "name": "ACTIVE",
101          "captionKey": "enum.objectStatus.active",
102          "active": true,
103          "caption": "Active"
104        },
105        "name": "Real Estate Contracts"
106      },
107      "contractGroup2": {
108        "id": 500001,
109        "displayId": "CG2-01",
110        "status": {
111          "name": "ACTIVE",
112          "captionKey": "enum.objectStatus.active",
113          "active": true,
114          "caption": "Active"
115        },
116        "name": "Equipment Leasing Contracts"
117      },
118      "group3": "Group3-Value",
119      "group4": "Group4-Value",
120      "signingPerson": "John Doe",
121      "placeOfSignature": "Montreal, Canada",
122      "dateOfSignature": "2019-08-24T14:15:22Z",
123      "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
124      "numberRangeIdentifierValue": "0001",
125      "numberRangeIdentifierType": {
126        "name": "COMPANY_CODE"
127      },
128      "numberRangeType": {
129        "name": "CONTRACT"
130      },
131      "allowsSystemGenerateNewId": true
132    },
133    "currency": {
134      "id": 840,
135      "displayId": "USD",
136      "status": {
137        "name": "ACTIVE",
138        "captionKey": "enum.objectStatus.active",
139        "active": true,
140        "caption": "Active"
141      },
142      "name": "United States Dollar",
143      "decimalPoints": 2
144    },
145    "companyCurrency": {
146      "id": 840,
147      "displayId": "USD",
148      "status": {
149        "name": "ACTIVE",
150        "captionKey": "enum.objectStatus.active",
151        "active": true,
152        "caption": "Active"
153      },
154      "name": "United States Dollar",
155      "decimalPoints": 2
156    },
157    "indexedCurrency": true,
158    "assetValueCurrencyType": "CONTRACT_CURRENCY",
159    "currencyLocked": true,
160    "leaseArea": {
161      "id": 10000001,
162      "displayId": "0001",
163      "status": {
164        "name": "ACTIVE",
165        "captionKey": "enum.objectStatus.active",
166        "active": true,
167        "caption": "Active"
168      },
169      "name": "Global Lease Area"
170    },
171    "businessUnit": {
172      "id": 10000001,
173      "displayId": "BU0001",
174      "status": {
175        "name": "ACTIVE",
176        "captionKey": "enum.objectStatus.active",
177        "active": true,
178        "caption": "Active"
179      },
180      "name": "North America Business Unit"
181    },
182    "businessUnitLocked": true,
183    "companyCode": {
184      "id": 10000006,
185      "displayId": "1005",
186      "status": {
187        "name": "ACTIVE",
188        "captionKey": "enum.objectStatus.active",
189        "active": true,
190        "caption": "Active"
191      },
192      "erpSystemId": 10000001,
193      "erpSystemDisplayId": "FINQ8S-300",
194      "countryId": 10000095,
195      "countryDisplayId": "CA",
196      "name": "string",
197      "postingPeriodVariantId": 0,
198      "fiscalVariantId": 0
199    },
200    "companyCodeLocked": true,
201    "department": {
202      "id": 300001,
203      "displayId": "DEP-01",
204      "status": {
205        "name": "ACTIVE",
206        "captionKey": "enum.objectStatus.active",
207        "active": true,
208        "caption": "Active"
209      },
210      "name": "Finance Department"
211    },
212    "departmentLocked": true,
213    "leaseGroup": {
214      "id": 60000001,
215      "displayId": "LG-001",
216      "status": {
217        "name": "ACTIVE",
218        "captionKey": "enum.objectStatus.active",
219        "active": true,
220        "caption": "Active"
221      },
222      "name": "Global Lease Group"
223    },
224    "leaseGroupLocked": true,
225    "subleasingInternalAssetClass": {
226      "id": 10000001,
227      "displayId": "IAC-001",
228      "status": {
229        "name": "ACTIVE",
230        "captionKey": "enum.objectStatus.active",
231        "active": true,
232        "caption": "Active"
233      },
234      "name": "Machinery and Equipment",
235      "assetClassType": "PROPERTY",
236      "infiniteUsefulLife": false
237    },
238    "contractGroup1": {
239      "id": 400001,
240      "displayId": "CG1-01",
241      "status": {
242        "name": "ACTIVE",
243        "captionKey": "enum.objectStatus.active",
244        "active": true,
245        "caption": "Active"
246      },
247      "name": "Real Estate Contracts"
248    },
249    "contractGroup2": {
250      "id": 500001,
251      "displayId": "CG2-01",
252      "status": {
253        "name": "ACTIVE",
254        "captionKey": "enum.objectStatus.active",
255        "active": true,
256        "caption": "Active"
257      },
258      "name": "Equipment Leasing Contracts"
259    },
260    "subleasing": false,
261    "subleasingContractRevisionInfo": {
262      "id": 50000001,
263      "contractId": 40000001,
264      "contractDisplayId": "CTR-0001",
265      "contractName": "Sublease Agreement for Office Space"
266    },
267    "subleasingLeaseComponentRevisionInfo": {
268      "id": 61000001,
269      "leaseComponentId": 80000001,
270      "leaseComponentDisplayId": "LC-0001",
271      "leaseComponentName": "Vehicle Lease Component"
272    },
273    "subleasingActivationGroupRevisionInfo": {
274      "id": 60000001,
275      "activationGroupId": 70000001,
276      "activationGroupDisplayId": "AG-001",
277      "activationGroupName": "Office Equipment Activation Group"
278    },
279    "notifications": [
280      {
281        "id": 10000001,
282        "topic": {
283          "enCaption": "Lease Component Updated",
284          "frCaption": "Composant de bail mis à jour",
285          "name": "LEASE_COMPONENT_UPDATED",
286          "priority": "HIGH"
287        },
288        "username": "super.admin@nakisa.com",
289        "contractId": 10000001,
290        "contractDisplayId": "CT-100000000",
291        "targetId": "CT-100000000",
292        "targetType": "CONTRACT"
293      }
294    ],
295    "masterAgreementId": 10000001,
296    "masterAgreementDisplayId": "string",
297    "allowsSystemGenerateNewId": true,
298    "transferInfo": {
299      "transferredFromDisplayId": "CTR-00012",
300      "transferredFromRevisionId": 20000001,
301      "transferredToDisplayId": "CTR-00015",
302      "transferredToRevisionId": 20000005
303    },
304    "numberRangeIdentifierValue": "",
305    "numberRangeIdentifierType": {
306      "name": "COMPANY_CODE"
307    },
308    "numberRangeType": {
309      "name": "CONTRACT"
310    }
311  }
312}

📄 Description: Data transfer object representing the financial obligations and accounting entries associated with a lease contract within the Nakisa Lease Accounting Suite, facilitating accurate tracking and management of lease-related transactions.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains a descriptive message related to the lease contract, providing essential information about the financial obligation or accounting entry.

defaultMessage

string

false

write-only

Default message associated with the lease contract, providing essential information regarding financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of lease and contract-related transactions within the Nakisa Lease Accounting Suite.

errors

Errors

false

none

Value for errors field

object

ContractDto

false

none

Value for object field

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED