ResponseListContractDto

Example Json Object

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

📄 Description: Data transfer object representing a collection of lease contracts, detailing associated financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

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 insights into the financial obligations and accounting entries associated with it.

defaultMessage

string

false

write-only

Default message to be displayed for lease contracts within the Nakisa Lease Accounting Suite, providing essential context for financial obligations and accounting entries.

debugMessage

string

false

write-only

Provides detailed information regarding any issues encountered during the processing of lease, contract, or financial obligation entries within the Nakisa Lease Accounting Suite.

errors

Errors

false

none

Value for errors field

object

[ContractDto]

false

none

List of object items

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