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        "type": "GENERIC",
 10        "source": {},
 11        "field": "string",
 12        "errorKey": "string",
 13        "errorMessage": "string"
 14      }
 15    ]
 16  },
 17  "object": {
 18    "id": 10000018,
 19    "displayId": "CT-100001000",
 20    "name": "Testtt Contract",
 21    "principalPositionType": {
 22      "name": "LESSEE",
 23      "captionKey": "enum.principalpositiontype.lessee",
 24      "caption": "Lessee"
 25    },
 26    "validFrom": "2019-08-24",
 27    "validTo": "2019-08-24",
 28    "amendmentDate": "2019-08-24",
 29    "approverComment": "string",
 30    "contractPhase": "INITIAL",
 31    "dataCreationInfo": {
 32      "id": 0,
 33      "idGenerationType": "AUTO",
 34      "source": "string",
 35      "type": "MIGRATION",
 36      "startDateTime": "2019-08-24T14:15:22Z",
 37      "endDateTime": "2019-08-24T14:15:22Z"
 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": 0,
 87        "displayId": "string",
 88        "status": "CREATED",
 89        "name": "string"
 90      },
 91      "contractGroup1": {
 92        "id": 400001,
 93        "displayId": "CG1-01",
 94        "status": {
 95          "name": "ACTIVE",
 96          "captionKey": "enum.objectStatus.active",
 97          "active": true,
 98          "caption": "Active"
 99        },
100        "name": "Real Estate Contracts"
101      },
102      "contractGroup2": {
103        "id": 500001,
104        "displayId": "CG2-01",
105        "status": {
106          "name": "ACTIVE",
107          "captionKey": "enum.objectStatus.active",
108          "active": true,
109          "caption": "Active"
110        },
111        "name": "Equipment Leasing Contracts"
112      },
113      "group3": "Group3-Value",
114      "group4": "Group4-Value",
115      "signingPerson": "John Doe",
116      "placeOfSignature": "Montreal, Canada",
117      "dateOfSignature": "2019-08-24T14:15:22Z",
118      "numberRangeIdentifierType": {
119        "name": "COMPANY_CODE"
120      },
121      "numberRangeIdentifierValue": "0001",
122      "numberRangeType": {
123        "name": "CONTRACT"
124      },
125      "allowsSystemGenerateNewId": true
126    },
127    "currency": {
128      "id": 840,
129      "displayId": "USD",
130      "status": {
131        "name": "ACTIVE",
132        "captionKey": "enum.objectStatus.active",
133        "active": true,
134        "caption": "Active"
135      },
136      "name": "United States Dollar",
137      "decimalPoints": 2
138    },
139    "companyCurrency": {
140      "id": 840,
141      "displayId": "USD",
142      "status": {
143        "name": "ACTIVE",
144        "captionKey": "enum.objectStatus.active",
145        "active": true,
146        "caption": "Active"
147      },
148      "name": "United States Dollar",
149      "decimalPoints": 2
150    },
151    "indexedCurrency": true,
152    "assetValueCurrencyType": "CONTRACT_CURRENCY",
153    "currencyLocked": true,
154    "leaseArea": {
155      "id": 10000001,
156      "displayId": "0001",
157      "status": {
158        "name": "ACTIVE",
159        "captionKey": "enum.objectStatus.active",
160        "active": true,
161        "caption": "Active"
162      },
163      "name": "Global Lease Area"
164    },
165    "businessUnit": {
166      "id": 10000001,
167      "displayId": "BU0001",
168      "status": {
169        "name": "ACTIVE",
170        "captionKey": "enum.objectStatus.active",
171        "active": true,
172        "caption": "Active"
173      },
174      "name": "North America Business Unit"
175    },
176    "businessUnitLocked": true,
177    "companyCode": {
178      "id": 10000006,
179      "displayId": "1005",
180      "status": {
181        "name": "ACTIVE",
182        "captionKey": "enum.objectStatus.active",
183        "active": true,
184        "caption": "Active"
185      },
186      "erpSystemId": 10000001,
187      "erpSystemDisplayId": "FINQ8S-300",
188      "countryId": 10000095,
189      "countryDisplayId": "CA",
190      "postingPeriodVariantId": 0,
191      "fiscalVariantId": 0
192    },
193    "companyCodeLocked": true,
194    "department": {
195      "id": 300001,
196      "displayId": "DEP-01",
197      "status": {
198        "name": "ACTIVE",
199        "captionKey": "enum.objectStatus.active",
200        "active": true,
201        "caption": "Active"
202      },
203      "name": "Finance Department"
204    },
205    "departmentLocked": true,
206    "leaseGroup": {
207      "id": 60000001,
208      "displayId": "LG-001",
209      "status": {
210        "name": "ACTIVE",
211        "captionKey": "enum.objectStatus.active",
212        "active": true,
213        "caption": "Active"
214      },
215      "name": "Global Lease Group"
216    },
217    "leaseGroupLocked": true,
218    "subleasingInternalAssetClass": {
219      "id": 10000001,
220      "displayId": "IAC-001",
221      "status": {
222        "name": "ACTIVE",
223        "captionKey": "enum.objectStatus.active",
224        "active": true,
225        "caption": "Active"
226      },
227      "name": "Machinery and Equipment",
228      "assetClassType": "PROPERTY",
229      "infiniteUsefulLife": false
230    },
231    "contractGroup1": {
232      "id": 400001,
233      "displayId": "CG1-01",
234      "status": {
235        "name": "ACTIVE",
236        "captionKey": "enum.objectStatus.active",
237        "active": true,
238        "caption": "Active"
239      },
240      "name": "Real Estate Contracts"
241    },
242    "contractGroup2": {
243      "id": 500001,
244      "displayId": "CG2-01",
245      "status": {
246        "name": "ACTIVE",
247        "captionKey": "enum.objectStatus.active",
248        "active": true,
249        "caption": "Active"
250      },
251      "name": "Equipment Leasing Contracts"
252    },
253    "subleasing": false,
254    "subleasingContractRevisionInfo": {
255      "id": 50000001,
256      "contractId": 40000001,
257      "contractDisplayId": "CTR-0001",
258      "contractName": "Sublease Agreement for Office Space"
259    },
260    "subleasingLeaseComponentRevisionInfo": {
261      "id": 61000001,
262      "leaseComponentId": 80000001,
263      "leaseComponentDisplayId": "LC-0001",
264      "leaseComponentName": "Vehicle Lease Component"
265    },
266    "subleasingActivationGroupRevisionInfo": {
267      "id": 60000001,
268      "activationGroupId": 70000001,
269      "activationGroupDisplayId": "AG-001",
270      "activationGroupName": "Office Equipment Activation Group"
271    },
272    "notifications": [
273      {
274        "id": 10000001,
275        "topic": {
276          "enCaption": "Lease Component Updated",
277          "frCaption": "Composant de bail mis à jour",
278          "name": "LEASE_COMPONENT_UPDATED",
279          "priority": "HIGH"
280        },
281        "username": "super.admin@nakisa.com",
282        "contractId": 10000001,
283        "contractDisplayId": "CT-100000000",
284        "targetId": "CT-100000000",
285        "targetType": "CONTRACT"
286      }
287    ],
288    "masterAgreementId": 10000001,
289    "masterAgreementDisplayId": "string",
290    "allowsSystemGenerateNewId": true,
291    "transferInfo": {
292      "transferredFromDisplayId": "CTR-00012",
293      "transferredFromRevisionId": 20000001,
294      "transferredToDisplayId": "CTR-00015",
295      "transferredToRevisionId": 20000005
296    },
297    "numberRangeIdentifierType": {
298      "name": "COMPANY_CODE"
299    },
300    "numberRangeIdentifierValue": "",
301    "numberRangeType": {
302      "name": "CONTRACT"
303    }
304  }
305}

📄 Description: Represents a response wrapper for a contract entity.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Response status code.

message

string

false

write-only

Message.

defaultMessage

string

false

write-only

none

debugMessage

string

false

write-only

Debug message

errors

Errors

false

none

none

object

ContractDto

false

none

Represents a Contract entity

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