Contracts¶
Get Contract By ID¶
HTTP Request
GET /api/v1/contracts/{id}
📋 Description: Fetches detailed information about a specific lease contract identified by its unique ID, providing essential data for financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved contract |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}
Update Contract¶
HTTP Request
PUT /api/v1/contracts/{id}
📋 Description: Updates an existing lease contract identified by the specified ID, allowing for modifications to financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated contract details, including lease terms, financial obligations, and accounting entries, for the specified contract ID. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Body Parameters
1{
2 "id": 10000018,
3 "displayId": "CT-100001000",
4 "name": "Testtt Contract",
5 "principalPositionType": {
6 "name": "LESSEE",
7 "captionKey": "enum.principalpositiontype.lessee",
8 "caption": "Lessee"
9 },
10 "validFrom": "2019-08-24",
11 "validTo": "2019-08-24",
12 "amendmentDate": "2019-08-24",
13 "approverComment": "string",
14 "contractPhase": "INITIAL",
15 "dataCreationInfo": {
16 "id": 10000001,
17 "idGenerationType": {
18 "name": "AUTO",
19 "captionKey": "enum.idGenerationType.auto",
20 "caption": "Auto"
21 },
22 "source": "sample_source",
23 "type": {
24 "name": "MIGRATION",
25 "captionKey": "enum.dataType.migration",
26 "caption": "Migration"
27 },
28 "startDateTime": "2025-01-01T10:00:00Z",
29 "endDateTime": "2025-01-01T10:00:00Z"
30 },
31 "leaseType": {
32 "name": "LEASE_CONTRACT_FIX",
33 "captionKey": "enum.leaseType.fix",
34 "principalPositionType": "LESSEE",
35 "caption": "Fixed Lease Contract"
36 },
37 "revision": {
38 "id": 10000008,
39 "displayId": "CR-0001",
40 "name": "Initial Revision",
41 "inception": "2019-08-24",
42 "revisionType": "ACTIVE",
43 "state": "LC_DEFINE",
44 "approvedBy": "manager.user@company.com",
45 "approvedAt": "2019-08-24T14:15:22Z",
46 "parentRevisionId": 10000010,
47 "approverComment": "Approved with changes.",
48 "contractId": 20000001,
49 "contractDisplayId": "C-0001",
50 "contractName": "Office Lease Contract",
51 "principalPositionType": {
52 "name": "LESSEE",
53 "captionKey": "enum.principalpositiontype.lessee",
54 "caption": "Lessee"
55 },
56 "mlaId": 30000001,
57 "companyId": 40000001,
58 "description": "Revision to adjust payment terms.",
59 "externalReference": "EXT-REF-001",
60 "internalReference": "INT-REF-001",
61 "formOfLease": "FULL",
62 "jointVentureLeaseType": "GROSS_LEASE",
63 "businessPlace": "New York Office",
64 "tradingPartner": {
65 "id": 50000001,
66 "displayId": "TP-0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "ABC Real Estate Partners",
74 "erpSystemId": 60000001,
75 "erpSystemDisplayId": "ERP-SYS-01"
76 },
77 "contractCategoryGroup": {
78 "id": 10000001,
79 "displayId": "sample_displayId",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Sample Name"
87 },
88 "contractGroup1": {
89 "id": 400001,
90 "displayId": "CG1-01",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "Real Estate Contracts"
98 },
99 "contractGroup2": {
100 "id": 500001,
101 "displayId": "CG2-01",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "Equipment Leasing Contracts"
109 },
110 "group3": "Group3-Value",
111 "group4": "Group4-Value",
112 "signingPerson": "John Doe",
113 "placeOfSignature": "Montreal, Canada",
114 "dateOfSignature": "2019-08-24T14:15:22Z",
115 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
116 "numberRangeIdentifierValue": "0001",
117 "numberRangeIdentifierType": {
118 "name": "COMPANY_CODE"
119 },
120 "numberRangeType": {
121 "name": "CONTRACT"
122 },
123 "allowsSystemGenerateNewId": true
124 },
125 "currency": {
126 "id": 840,
127 "displayId": "USD",
128 "status": {
129 "name": "ACTIVE",
130 "captionKey": "enum.objectStatus.active",
131 "active": true,
132 "caption": "Active"
133 },
134 "name": "United States Dollar",
135 "decimalPoints": 2
136 },
137 "companyCurrency": {
138 "id": 840,
139 "displayId": "USD",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "United States Dollar",
147 "decimalPoints": 2
148 },
149 "indexedCurrency": true,
150 "assetValueCurrencyType": "CONTRACT_CURRENCY",
151 "currencyLocked": true,
152 "leaseArea": {
153 "id": 10000001,
154 "displayId": "0001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Area"
162 },
163 "businessUnit": {
164 "id": 10000001,
165 "displayId": "BU0001",
166 "status": {
167 "name": "ACTIVE",
168 "captionKey": "enum.objectStatus.active",
169 "active": true,
170 "caption": "Active"
171 },
172 "name": "North America Business Unit"
173 },
174 "businessUnitLocked": true,
175 "companyCode": {
176 "id": 10000006,
177 "displayId": "1005",
178 "status": {
179 "name": "ACTIVE",
180 "captionKey": "enum.objectStatus.active",
181 "active": true,
182 "caption": "Active"
183 },
184 "erpSystemId": 10000001,
185 "erpSystemDisplayId": "FINQ8S-300",
186 "countryId": 10000095,
187 "countryDisplayId": "CA",
188 "name": "string",
189 "postingPeriodVariantId": 0,
190 "fiscalVariantId": 0
191 },
192 "companyCodeLocked": true,
193 "department": {
194 "id": 300001,
195 "displayId": "DEP-01",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Finance Department"
203 },
204 "departmentLocked": true,
205 "leaseGroup": {
206 "id": 60000001,
207 "displayId": "LG-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Global Lease Group"
215 },
216 "leaseGroupLocked": true,
217 "subleasingInternalAssetClass": {
218 "id": 10000001,
219 "displayId": "IAC-001",
220 "status": {
221 "name": "ACTIVE",
222 "captionKey": "enum.objectStatus.active",
223 "active": true,
224 "caption": "Active"
225 },
226 "name": "Machinery and Equipment",
227 "assetClassType": "PROPERTY",
228 "infiniteUsefulLife": false
229 },
230 "contractGroup1": {
231 "id": 400001,
232 "displayId": "CG1-01",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "name": "Real Estate Contracts"
240 },
241 "contractGroup2": {
242 "id": 500001,
243 "displayId": "CG2-01",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "Equipment Leasing Contracts"
251 },
252 "subleasing": false,
253 "subleasingContractRevisionInfo": {
254 "id": 50000001,
255 "contractId": 40000001,
256 "contractDisplayId": "CTR-0001",
257 "contractName": "Sublease Agreement for Office Space"
258 },
259 "subleasingLeaseComponentRevisionInfo": {
260 "id": 61000001,
261 "leaseComponentId": 80000001,
262 "leaseComponentDisplayId": "LC-0001",
263 "leaseComponentName": "Vehicle Lease Component"
264 },
265 "subleasingActivationGroupRevisionInfo": {
266 "id": 60000001,
267 "activationGroupId": 70000001,
268 "activationGroupDisplayId": "AG-001",
269 "activationGroupName": "Office Equipment Activation Group"
270 },
271 "notifications": [
272 {
273 "id": 10000001,
274 "topic": {
275 "enCaption": "Lease Component Updated",
276 "frCaption": "Composant de bail mis à jour",
277 "name": "LEASE_COMPONENT_UPDATED",
278 "priority": "HIGH"
279 },
280 "username": "super.admin@nakisa.com",
281 "contractId": 10000001,
282 "contractDisplayId": "CT-100000000",
283 "targetId": "CT-100000000",
284 "targetType": "CONTRACT"
285 }
286 ],
287 "masterAgreementId": 10000001,
288 "masterAgreementDisplayId": "string",
289 "allowsSystemGenerateNewId": true,
290 "transferInfo": {
291 "transferredFromDisplayId": "CTR-00012",
292 "transferredFromRevisionId": 20000001,
293 "transferredToDisplayId": "CTR-00015",
294 "transferredToRevisionId": 20000005
295 },
296 "numberRangeIdentifierValue": "",
297 "numberRangeIdentifierType": {
298 "name": "COMPANY_CODE"
299 },
300 "numberRangeType": {
301 "name": "CONTRACT"
302 }
303}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contract successfully updated. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}
Delete A Contract¶
HTTP Request
DELETE /api/v1/contracts/{id}
📋 Description: Deletes a specified lease contract from the Nakisa Lease Accounting Suite, thereby removing the associated financial obligations and accounting entries from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contract successfully deleted. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
Partially Update Contract¶
HTTP Request
PATCH /api/v1/contracts/{id}
📋 Description: Updates the specified lease contract in the Nakisa Lease Accounting Suite, allowing for modifications to financial obligations and accounting entries associated with the contract.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated contract details, including lease terms, financial obligations, and accounting entry adjustments for the specified contract ID. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
body |
|
body |
Body Parameters
1{
2 "op": "replace",
3 "path": "/name",
4 "value": "patched contract"
5}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully patched contract. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}
Create Or Update A Contract¶
HTTP Request
PUT /api/v1/contracts/createOrUpdate
📋 Description: Updates or creates a lease contract within the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are maintained in compliance with organizational standards.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease contract details, including financial obligations and accounting entries, for creating or updating a contract in the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "id": 10000018,
3 "displayId": "CT-100001000",
4 "name": "Testtt Contract",
5 "principalPositionType": {
6 "name": "LESSEE",
7 "captionKey": "enum.principalpositiontype.lessee",
8 "caption": "Lessee"
9 },
10 "validFrom": "2019-08-24",
11 "validTo": "2019-08-24",
12 "amendmentDate": "2019-08-24",
13 "approverComment": "string",
14 "contractPhase": "INITIAL",
15 "dataCreationInfo": {
16 "id": 10000001,
17 "idGenerationType": {
18 "name": "AUTO",
19 "captionKey": "enum.idGenerationType.auto",
20 "caption": "Auto"
21 },
22 "source": "sample_source",
23 "type": {
24 "name": "MIGRATION",
25 "captionKey": "enum.dataType.migration",
26 "caption": "Migration"
27 },
28 "startDateTime": "2025-01-01T10:00:00Z",
29 "endDateTime": "2025-01-01T10:00:00Z"
30 },
31 "leaseType": {
32 "name": "LEASE_CONTRACT_FIX",
33 "captionKey": "enum.leaseType.fix",
34 "principalPositionType": "LESSEE",
35 "caption": "Fixed Lease Contract"
36 },
37 "revision": {
38 "id": 10000008,
39 "displayId": "CR-0001",
40 "name": "Initial Revision",
41 "inception": "2019-08-24",
42 "revisionType": "ACTIVE",
43 "state": "LC_DEFINE",
44 "approvedBy": "manager.user@company.com",
45 "approvedAt": "2019-08-24T14:15:22Z",
46 "parentRevisionId": 10000010,
47 "approverComment": "Approved with changes.",
48 "contractId": 20000001,
49 "contractDisplayId": "C-0001",
50 "contractName": "Office Lease Contract",
51 "principalPositionType": {
52 "name": "LESSEE",
53 "captionKey": "enum.principalpositiontype.lessee",
54 "caption": "Lessee"
55 },
56 "mlaId": 30000001,
57 "companyId": 40000001,
58 "description": "Revision to adjust payment terms.",
59 "externalReference": "EXT-REF-001",
60 "internalReference": "INT-REF-001",
61 "formOfLease": "FULL",
62 "jointVentureLeaseType": "GROSS_LEASE",
63 "businessPlace": "New York Office",
64 "tradingPartner": {
65 "id": 50000001,
66 "displayId": "TP-0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "ABC Real Estate Partners",
74 "erpSystemId": 60000001,
75 "erpSystemDisplayId": "ERP-SYS-01"
76 },
77 "contractCategoryGroup": {
78 "id": 10000001,
79 "displayId": "sample_displayId",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Sample Name"
87 },
88 "contractGroup1": {
89 "id": 400001,
90 "displayId": "CG1-01",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "Real Estate Contracts"
98 },
99 "contractGroup2": {
100 "id": 500001,
101 "displayId": "CG2-01",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "Equipment Leasing Contracts"
109 },
110 "group3": "Group3-Value",
111 "group4": "Group4-Value",
112 "signingPerson": "John Doe",
113 "placeOfSignature": "Montreal, Canada",
114 "dateOfSignature": "2019-08-24T14:15:22Z",
115 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
116 "numberRangeIdentifierValue": "0001",
117 "numberRangeIdentifierType": {
118 "name": "COMPANY_CODE"
119 },
120 "numberRangeType": {
121 "name": "CONTRACT"
122 },
123 "allowsSystemGenerateNewId": true
124 },
125 "currency": {
126 "id": 840,
127 "displayId": "USD",
128 "status": {
129 "name": "ACTIVE",
130 "captionKey": "enum.objectStatus.active",
131 "active": true,
132 "caption": "Active"
133 },
134 "name": "United States Dollar",
135 "decimalPoints": 2
136 },
137 "companyCurrency": {
138 "id": 840,
139 "displayId": "USD",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "United States Dollar",
147 "decimalPoints": 2
148 },
149 "indexedCurrency": true,
150 "assetValueCurrencyType": "CONTRACT_CURRENCY",
151 "currencyLocked": true,
152 "leaseArea": {
153 "id": 10000001,
154 "displayId": "0001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Area"
162 },
163 "businessUnit": {
164 "id": 10000001,
165 "displayId": "BU0001",
166 "status": {
167 "name": "ACTIVE",
168 "captionKey": "enum.objectStatus.active",
169 "active": true,
170 "caption": "Active"
171 },
172 "name": "North America Business Unit"
173 },
174 "businessUnitLocked": true,
175 "companyCode": {
176 "id": 10000006,
177 "displayId": "1005",
178 "status": {
179 "name": "ACTIVE",
180 "captionKey": "enum.objectStatus.active",
181 "active": true,
182 "caption": "Active"
183 },
184 "erpSystemId": 10000001,
185 "erpSystemDisplayId": "FINQ8S-300",
186 "countryId": 10000095,
187 "countryDisplayId": "CA",
188 "name": "string",
189 "postingPeriodVariantId": 0,
190 "fiscalVariantId": 0
191 },
192 "companyCodeLocked": true,
193 "department": {
194 "id": 300001,
195 "displayId": "DEP-01",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Finance Department"
203 },
204 "departmentLocked": true,
205 "leaseGroup": {
206 "id": 60000001,
207 "displayId": "LG-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Global Lease Group"
215 },
216 "leaseGroupLocked": true,
217 "subleasingInternalAssetClass": {
218 "id": 10000001,
219 "displayId": "IAC-001",
220 "status": {
221 "name": "ACTIVE",
222 "captionKey": "enum.objectStatus.active",
223 "active": true,
224 "caption": "Active"
225 },
226 "name": "Machinery and Equipment",
227 "assetClassType": "PROPERTY",
228 "infiniteUsefulLife": false
229 },
230 "contractGroup1": {
231 "id": 400001,
232 "displayId": "CG1-01",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "name": "Real Estate Contracts"
240 },
241 "contractGroup2": {
242 "id": 500001,
243 "displayId": "CG2-01",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "Equipment Leasing Contracts"
251 },
252 "subleasing": false,
253 "subleasingContractRevisionInfo": {
254 "id": 50000001,
255 "contractId": 40000001,
256 "contractDisplayId": "CTR-0001",
257 "contractName": "Sublease Agreement for Office Space"
258 },
259 "subleasingLeaseComponentRevisionInfo": {
260 "id": 61000001,
261 "leaseComponentId": 80000001,
262 "leaseComponentDisplayId": "LC-0001",
263 "leaseComponentName": "Vehicle Lease Component"
264 },
265 "subleasingActivationGroupRevisionInfo": {
266 "id": 60000001,
267 "activationGroupId": 70000001,
268 "activationGroupDisplayId": "AG-001",
269 "activationGroupName": "Office Equipment Activation Group"
270 },
271 "notifications": [
272 {
273 "id": 10000001,
274 "topic": {
275 "enCaption": "Lease Component Updated",
276 "frCaption": "Composant de bail mis à jour",
277 "name": "LEASE_COMPONENT_UPDATED",
278 "priority": "HIGH"
279 },
280 "username": "super.admin@nakisa.com",
281 "contractId": 10000001,
282 "contractDisplayId": "CT-100000000",
283 "targetId": "CT-100000000",
284 "targetType": "CONTRACT"
285 }
286 ],
287 "masterAgreementId": 10000001,
288 "masterAgreementDisplayId": "string",
289 "allowsSystemGenerateNewId": true,
290 "transferInfo": {
291 "transferredFromDisplayId": "CTR-00012",
292 "transferredFromRevisionId": 20000001,
293 "transferredToDisplayId": "CTR-00015",
294 "transferredToRevisionId": 20000005
295 },
296 "numberRangeIdentifierValue": "",
297 "numberRangeIdentifierType": {
298 "name": "COMPANY_CODE"
299 },
300 "numberRangeType": {
301 "name": "CONTRACT"
302 }
303}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully created or updated the contract. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}
Create Or Update Contracts In Bulk¶
HTTP Request
PUT /api/v1/contracts/createOrUpdate/bulk
📋 Description: Updates or creates multiple lease contracts in the Nakisa Lease Accounting Suite, facilitating efficient management of financial obligations and accounting entries in bulk. This operation streamlines the contract lifecycle by ensuring timely adjustments to lease agreements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk lease and contract data, including financial obligations and accounting entries, for creation or update within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000018,
4 "displayId": "CT-100001000",
5 "name": "Testtt Contract",
6 "principalPositionType": {
7 "name": "LESSEE",
8 "captionKey": "enum.principalpositiontype.lessee",
9 "caption": "Lessee"
10 },
11 "validFrom": "2019-08-24",
12 "validTo": "2019-08-24",
13 "amendmentDate": "2019-08-24",
14 "approverComment": "string",
15 "contractPhase": "INITIAL",
16 "dataCreationInfo": {
17 "id": 10000001,
18 "idGenerationType": {
19 "name": "AUTO",
20 "captionKey": "enum.idGenerationType.auto",
21 "caption": "Auto"
22 },
23 "source": "sample_source",
24 "type": {
25 "name": "MIGRATION",
26 "captionKey": "enum.dataType.migration",
27 "caption": "Migration"
28 },
29 "startDateTime": "2025-01-01T10:00:00Z",
30 "endDateTime": "2025-01-01T10:00:00Z"
31 },
32 "leaseType": {
33 "name": "LEASE_CONTRACT_FIX",
34 "captionKey": "enum.leaseType.fix",
35 "principalPositionType": "LESSEE",
36 "caption": "Fixed Lease Contract"
37 },
38 "revision": {
39 "id": 10000008,
40 "displayId": "CR-0001",
41 "name": "Initial Revision",
42 "inception": "2019-08-24",
43 "revisionType": "ACTIVE",
44 "state": "LC_DEFINE",
45 "approvedBy": "manager.user@company.com",
46 "approvedAt": "2019-08-24T14:15:22Z",
47 "parentRevisionId": 10000010,
48 "approverComment": "Approved with changes.",
49 "contractId": 20000001,
50 "contractDisplayId": "C-0001",
51 "contractName": "Office Lease Contract",
52 "principalPositionType": {
53 "name": "LESSEE",
54 "captionKey": "enum.principalpositiontype.lessee",
55 "caption": "Lessee"
56 },
57 "mlaId": 30000001,
58 "companyId": 40000001,
59 "description": "Revision to adjust payment terms.",
60 "externalReference": "EXT-REF-001",
61 "internalReference": "INT-REF-001",
62 "formOfLease": "FULL",
63 "jointVentureLeaseType": "GROSS_LEASE",
64 "businessPlace": "New York Office",
65 "tradingPartner": {
66 "id": 50000001,
67 "displayId": "TP-0001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "ABC Real Estate Partners",
75 "erpSystemId": 60000001,
76 "erpSystemDisplayId": "ERP-SYS-01"
77 },
78 "contractCategoryGroup": {
79 "id": 10000001,
80 "displayId": "sample_displayId",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "Sample Name"
88 },
89 "contractGroup1": {
90 "id": 400001,
91 "displayId": "CG1-01",
92 "status": {
93 "name": "ACTIVE",
94 "captionKey": "enum.objectStatus.active",
95 "active": true,
96 "caption": "Active"
97 },
98 "name": "Real Estate Contracts"
99 },
100 "contractGroup2": {
101 "id": 500001,
102 "displayId": "CG2-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Equipment Leasing Contracts"
110 },
111 "group3": "Group3-Value",
112 "group4": "Group4-Value",
113 "signingPerson": "John Doe",
114 "placeOfSignature": "Montreal, Canada",
115 "dateOfSignature": "2019-08-24T14:15:22Z",
116 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
117 "numberRangeIdentifierValue": "0001",
118 "numberRangeIdentifierType": {
119 "name": "COMPANY_CODE"
120 },
121 "numberRangeType": {
122 "name": "CONTRACT"
123 },
124 "allowsSystemGenerateNewId": true
125 },
126 "currency": {
127 "id": 840,
128 "displayId": "USD",
129 "status": {
130 "name": "ACTIVE",
131 "captionKey": "enum.objectStatus.active",
132 "active": true,
133 "caption": "Active"
134 },
135 "name": "United States Dollar",
136 "decimalPoints": 2
137 },
138 "companyCurrency": {
139 "id": 840,
140 "displayId": "USD",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "United States Dollar",
148 "decimalPoints": 2
149 },
150 "indexedCurrency": true,
151 "assetValueCurrencyType": "CONTRACT_CURRENCY",
152 "currencyLocked": true,
153 "leaseArea": {
154 "id": 10000001,
155 "displayId": "0001",
156 "status": {
157 "name": "ACTIVE",
158 "captionKey": "enum.objectStatus.active",
159 "active": true,
160 "caption": "Active"
161 },
162 "name": "Global Lease Area"
163 },
164 "businessUnit": {
165 "id": 10000001,
166 "displayId": "BU0001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "North America Business Unit"
174 },
175 "businessUnitLocked": true,
176 "companyCode": {
177 "id": 10000006,
178 "displayId": "1005",
179 "status": {
180 "name": "ACTIVE",
181 "captionKey": "enum.objectStatus.active",
182 "active": true,
183 "caption": "Active"
184 },
185 "erpSystemId": 10000001,
186 "erpSystemDisplayId": "FINQ8S-300",
187 "countryId": 10000095,
188 "countryDisplayId": "CA",
189 "name": "string",
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 "numberRangeIdentifierValue": "",
298 "numberRangeIdentifierType": {
299 "name": "COMPANY_CODE"
300 },
301 "numberRangeType": {
302 "name": "CONTRACT"
303 }
304 }
305]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully processed all contracts. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000018,
9 "displayId": "CT-100001000",
10 "name": "Testtt Contract",
11 "principalPositionType": {
12 "name": "LESSEE",
13 "captionKey": "enum.principalpositiontype.lessee",
14 "caption": "Lessee"
15 },
16 "validFrom": "2019-08-24",
17 "validTo": "2019-08-24",
18 "amendmentDate": "2019-08-24",
19 "approverComment": "string",
20 "contractPhase": "INITIAL",
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "leaseType": {
38 "name": "LEASE_CONTRACT_FIX",
39 "captionKey": "enum.leaseType.fix",
40 "principalPositionType": "LESSEE",
41 "caption": "Fixed Lease Contract"
42 },
43 "revision": {
44 "id": 10000008,
45 "displayId": "CR-0001",
46 "name": "Initial Revision",
47 "inception": "2019-08-24",
48 "revisionType": "ACTIVE",
49 "state": "LC_DEFINE",
50 "approvedBy": "manager.user@company.com",
51 "approvedAt": "2019-08-24T14:15:22Z",
52 "parentRevisionId": 10000010,
53 "approverComment": "Approved with changes.",
54 "contractId": 20000001,
55 "contractDisplayId": "C-0001",
56 "contractName": "Office Lease Contract",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "mlaId": 30000001,
63 "companyId": 40000001,
64 "description": "Revision to adjust payment terms.",
65 "externalReference": "EXT-REF-001",
66 "internalReference": "INT-REF-001",
67 "formOfLease": "FULL",
68 "jointVentureLeaseType": "GROSS_LEASE",
69 "businessPlace": "New York Office",
70 "tradingPartner": {
71 "id": 50000001,
72 "displayId": "TP-0001",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "ABC Real Estate Partners",
80 "erpSystemId": 60000001,
81 "erpSystemDisplayId": "ERP-SYS-01"
82 },
83 "contractCategoryGroup": {
84 "id": 10000001,
85 "displayId": "sample_displayId",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "Sample Name"
93 },
94 "contractGroup1": {
95 "id": 400001,
96 "displayId": "CG1-01",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "Real Estate Contracts"
104 },
105 "contractGroup2": {
106 "id": 500001,
107 "displayId": "CG2-01",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "Equipment Leasing Contracts"
115 },
116 "group3": "Group3-Value",
117 "group4": "Group4-Value",
118 "signingPerson": "John Doe",
119 "placeOfSignature": "Montreal, Canada",
120 "dateOfSignature": "2019-08-24T14:15:22Z",
121 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
122 "numberRangeIdentifierValue": "0001",
123 "numberRangeIdentifierType": {
124 "name": "COMPANY_CODE"
125 },
126 "numberRangeType": {
127 "name": "CONTRACT"
128 },
129 "allowsSystemGenerateNewId": true
130 },
131 "currency": {
132 "id": 840,
133 "displayId": "USD",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "United States Dollar",
141 "decimalPoints": 2
142 },
143 "companyCurrency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "indexedCurrency": true,
156 "assetValueCurrencyType": "CONTRACT_CURRENCY",
157 "currencyLocked": true,
158 "leaseArea": {
159 "id": 10000001,
160 "displayId": "0001",
161 "status": {
162 "name": "ACTIVE",
163 "captionKey": "enum.objectStatus.active",
164 "active": true,
165 "caption": "Active"
166 },
167 "name": "Global Lease Area"
168 },
169 "businessUnit": {
170 "id": 10000001,
171 "displayId": "BU0001",
172 "status": {
173 "name": "ACTIVE",
174 "captionKey": "enum.objectStatus.active",
175 "active": true,
176 "caption": "Active"
177 },
178 "name": "North America Business Unit"
179 },
180 "businessUnitLocked": true,
181 "companyCode": {
182 "id": 10000006,
183 "displayId": "1005",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "erpSystemId": 10000001,
191 "erpSystemDisplayId": "FINQ8S-300",
192 "countryId": 10000095,
193 "countryDisplayId": "CA",
194 "name": "string",
195 "postingPeriodVariantId": 0,
196 "fiscalVariantId": 0
197 },
198 "companyCodeLocked": true,
199 "department": {
200 "id": 300001,
201 "displayId": "DEP-01",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "Finance Department"
209 },
210 "departmentLocked": true,
211 "leaseGroup": {
212 "id": 60000001,
213 "displayId": "LG-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Global Lease Group"
221 },
222 "leaseGroupLocked": true,
223 "subleasingInternalAssetClass": {
224 "id": 10000001,
225 "displayId": "IAC-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Machinery and Equipment",
233 "assetClassType": "PROPERTY",
234 "infiniteUsefulLife": false
235 },
236 "contractGroup1": {
237 "id": 400001,
238 "displayId": "CG1-01",
239 "status": {
240 "name": "ACTIVE",
241 "captionKey": "enum.objectStatus.active",
242 "active": true,
243 "caption": "Active"
244 },
245 "name": "Real Estate Contracts"
246 },
247 "contractGroup2": {
248 "id": 500001,
249 "displayId": "CG2-01",
250 "status": {
251 "name": "ACTIVE",
252 "captionKey": "enum.objectStatus.active",
253 "active": true,
254 "caption": "Active"
255 },
256 "name": "Equipment Leasing Contracts"
257 },
258 "subleasing": false,
259 "subleasingContractRevisionInfo": {
260 "id": 50000001,
261 "contractId": 40000001,
262 "contractDisplayId": "CTR-0001",
263 "contractName": "Sublease Agreement for Office Space"
264 },
265 "subleasingLeaseComponentRevisionInfo": {
266 "id": 61000001,
267 "leaseComponentId": 80000001,
268 "leaseComponentDisplayId": "LC-0001",
269 "leaseComponentName": "Vehicle Lease Component"
270 },
271 "subleasingActivationGroupRevisionInfo": {
272 "id": 60000001,
273 "activationGroupId": 70000001,
274 "activationGroupDisplayId": "AG-001",
275 "activationGroupName": "Office Equipment Activation Group"
276 },
277 "notifications": [
278 {
279 "id": 10000001,
280 "topic": {
281 "enCaption": "Lease Component Updated",
282 "frCaption": "Composant de bail mis à jour",
283 "name": "LEASE_COMPONENT_UPDATED",
284 "priority": "HIGH"
285 },
286 "username": "super.admin@nakisa.com",
287 "contractId": 10000001,
288 "contractDisplayId": "CT-100000000",
289 "targetId": "CT-100000000",
290 "targetType": "CONTRACT"
291 }
292 ],
293 "masterAgreementId": 10000001,
294 "masterAgreementDisplayId": "string",
295 "allowsSystemGenerateNewId": true,
296 "transferInfo": {
297 "transferredFromDisplayId": "CTR-00012",
298 "transferredFromRevisionId": 20000001,
299 "transferredToDisplayId": "CTR-00015",
300 "transferredToRevisionId": 20000005
301 },
302 "numberRangeIdentifierValue": "",
303 "numberRangeIdentifierType": {
304 "name": "COMPANY_CODE"
305 },
306 "numberRangeType": {
307 "name": "CONTRACT"
308 }
309 }
310 ]
311}
Update Contracts In Bulk¶
HTTP Request
PUT /api/v1/contracts/bulk
📋 Description: Updates multiple lease contracts in bulk within the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are reflected in the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing an array of contract data for bulk updates, including lease terms, financial obligations, and associated accounting entries. |
Body Parameters
1[
2 {
3 "id": 10000018,
4 "displayId": "CT-100001000",
5 "name": "Testtt Contract",
6 "principalPositionType": {
7 "name": "LESSEE",
8 "captionKey": "enum.principalpositiontype.lessee",
9 "caption": "Lessee"
10 },
11 "validFrom": "2019-08-24",
12 "validTo": "2019-08-24",
13 "amendmentDate": "2019-08-24",
14 "approverComment": "string",
15 "contractPhase": "INITIAL",
16 "dataCreationInfo": {
17 "id": 10000001,
18 "idGenerationType": {
19 "name": "AUTO",
20 "captionKey": "enum.idGenerationType.auto",
21 "caption": "Auto"
22 },
23 "source": "sample_source",
24 "type": {
25 "name": "MIGRATION",
26 "captionKey": "enum.dataType.migration",
27 "caption": "Migration"
28 },
29 "startDateTime": "2025-01-01T10:00:00Z",
30 "endDateTime": "2025-01-01T10:00:00Z"
31 },
32 "leaseType": {
33 "name": "LEASE_CONTRACT_FIX",
34 "captionKey": "enum.leaseType.fix",
35 "principalPositionType": "LESSEE",
36 "caption": "Fixed Lease Contract"
37 },
38 "revision": {
39 "id": 10000008,
40 "displayId": "CR-0001",
41 "name": "Initial Revision",
42 "inception": "2019-08-24",
43 "revisionType": "ACTIVE",
44 "state": "LC_DEFINE",
45 "approvedBy": "manager.user@company.com",
46 "approvedAt": "2019-08-24T14:15:22Z",
47 "parentRevisionId": 10000010,
48 "approverComment": "Approved with changes.",
49 "contractId": 20000001,
50 "contractDisplayId": "C-0001",
51 "contractName": "Office Lease Contract",
52 "principalPositionType": {
53 "name": "LESSEE",
54 "captionKey": "enum.principalpositiontype.lessee",
55 "caption": "Lessee"
56 },
57 "mlaId": 30000001,
58 "companyId": 40000001,
59 "description": "Revision to adjust payment terms.",
60 "externalReference": "EXT-REF-001",
61 "internalReference": "INT-REF-001",
62 "formOfLease": "FULL",
63 "jointVentureLeaseType": "GROSS_LEASE",
64 "businessPlace": "New York Office",
65 "tradingPartner": {
66 "id": 50000001,
67 "displayId": "TP-0001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "ABC Real Estate Partners",
75 "erpSystemId": 60000001,
76 "erpSystemDisplayId": "ERP-SYS-01"
77 },
78 "contractCategoryGroup": {
79 "id": 10000001,
80 "displayId": "sample_displayId",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "Sample Name"
88 },
89 "contractGroup1": {
90 "id": 400001,
91 "displayId": "CG1-01",
92 "status": {
93 "name": "ACTIVE",
94 "captionKey": "enum.objectStatus.active",
95 "active": true,
96 "caption": "Active"
97 },
98 "name": "Real Estate Contracts"
99 },
100 "contractGroup2": {
101 "id": 500001,
102 "displayId": "CG2-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Equipment Leasing Contracts"
110 },
111 "group3": "Group3-Value",
112 "group4": "Group4-Value",
113 "signingPerson": "John Doe",
114 "placeOfSignature": "Montreal, Canada",
115 "dateOfSignature": "2019-08-24T14:15:22Z",
116 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
117 "numberRangeIdentifierValue": "0001",
118 "numberRangeIdentifierType": {
119 "name": "COMPANY_CODE"
120 },
121 "numberRangeType": {
122 "name": "CONTRACT"
123 },
124 "allowsSystemGenerateNewId": true
125 },
126 "currency": {
127 "id": 840,
128 "displayId": "USD",
129 "status": {
130 "name": "ACTIVE",
131 "captionKey": "enum.objectStatus.active",
132 "active": true,
133 "caption": "Active"
134 },
135 "name": "United States Dollar",
136 "decimalPoints": 2
137 },
138 "companyCurrency": {
139 "id": 840,
140 "displayId": "USD",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "United States Dollar",
148 "decimalPoints": 2
149 },
150 "indexedCurrency": true,
151 "assetValueCurrencyType": "CONTRACT_CURRENCY",
152 "currencyLocked": true,
153 "leaseArea": {
154 "id": 10000001,
155 "displayId": "0001",
156 "status": {
157 "name": "ACTIVE",
158 "captionKey": "enum.objectStatus.active",
159 "active": true,
160 "caption": "Active"
161 },
162 "name": "Global Lease Area"
163 },
164 "businessUnit": {
165 "id": 10000001,
166 "displayId": "BU0001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "North America Business Unit"
174 },
175 "businessUnitLocked": true,
176 "companyCode": {
177 "id": 10000006,
178 "displayId": "1005",
179 "status": {
180 "name": "ACTIVE",
181 "captionKey": "enum.objectStatus.active",
182 "active": true,
183 "caption": "Active"
184 },
185 "erpSystemId": 10000001,
186 "erpSystemDisplayId": "FINQ8S-300",
187 "countryId": 10000095,
188 "countryDisplayId": "CA",
189 "name": "string",
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 "numberRangeIdentifierValue": "",
298 "numberRangeIdentifierType": {
299 "name": "COMPANY_CODE"
300 },
301 "numberRangeType": {
302 "name": "CONTRACT"
303 }
304 }
305]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
All contracts successfully updated. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000018,
9 "displayId": "CT-100001000",
10 "name": "Testtt Contract",
11 "principalPositionType": {
12 "name": "LESSEE",
13 "captionKey": "enum.principalpositiontype.lessee",
14 "caption": "Lessee"
15 },
16 "validFrom": "2019-08-24",
17 "validTo": "2019-08-24",
18 "amendmentDate": "2019-08-24",
19 "approverComment": "string",
20 "contractPhase": "INITIAL",
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "leaseType": {
38 "name": "LEASE_CONTRACT_FIX",
39 "captionKey": "enum.leaseType.fix",
40 "principalPositionType": "LESSEE",
41 "caption": "Fixed Lease Contract"
42 },
43 "revision": {
44 "id": 10000008,
45 "displayId": "CR-0001",
46 "name": "Initial Revision",
47 "inception": "2019-08-24",
48 "revisionType": "ACTIVE",
49 "state": "LC_DEFINE",
50 "approvedBy": "manager.user@company.com",
51 "approvedAt": "2019-08-24T14:15:22Z",
52 "parentRevisionId": 10000010,
53 "approverComment": "Approved with changes.",
54 "contractId": 20000001,
55 "contractDisplayId": "C-0001",
56 "contractName": "Office Lease Contract",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "mlaId": 30000001,
63 "companyId": 40000001,
64 "description": "Revision to adjust payment terms.",
65 "externalReference": "EXT-REF-001",
66 "internalReference": "INT-REF-001",
67 "formOfLease": "FULL",
68 "jointVentureLeaseType": "GROSS_LEASE",
69 "businessPlace": "New York Office",
70 "tradingPartner": {
71 "id": 50000001,
72 "displayId": "TP-0001",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "ABC Real Estate Partners",
80 "erpSystemId": 60000001,
81 "erpSystemDisplayId": "ERP-SYS-01"
82 },
83 "contractCategoryGroup": {
84 "id": 10000001,
85 "displayId": "sample_displayId",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "Sample Name"
93 },
94 "contractGroup1": {
95 "id": 400001,
96 "displayId": "CG1-01",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "Real Estate Contracts"
104 },
105 "contractGroup2": {
106 "id": 500001,
107 "displayId": "CG2-01",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "Equipment Leasing Contracts"
115 },
116 "group3": "Group3-Value",
117 "group4": "Group4-Value",
118 "signingPerson": "John Doe",
119 "placeOfSignature": "Montreal, Canada",
120 "dateOfSignature": "2019-08-24T14:15:22Z",
121 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
122 "numberRangeIdentifierValue": "0001",
123 "numberRangeIdentifierType": {
124 "name": "COMPANY_CODE"
125 },
126 "numberRangeType": {
127 "name": "CONTRACT"
128 },
129 "allowsSystemGenerateNewId": true
130 },
131 "currency": {
132 "id": 840,
133 "displayId": "USD",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "United States Dollar",
141 "decimalPoints": 2
142 },
143 "companyCurrency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "indexedCurrency": true,
156 "assetValueCurrencyType": "CONTRACT_CURRENCY",
157 "currencyLocked": true,
158 "leaseArea": {
159 "id": 10000001,
160 "displayId": "0001",
161 "status": {
162 "name": "ACTIVE",
163 "captionKey": "enum.objectStatus.active",
164 "active": true,
165 "caption": "Active"
166 },
167 "name": "Global Lease Area"
168 },
169 "businessUnit": {
170 "id": 10000001,
171 "displayId": "BU0001",
172 "status": {
173 "name": "ACTIVE",
174 "captionKey": "enum.objectStatus.active",
175 "active": true,
176 "caption": "Active"
177 },
178 "name": "North America Business Unit"
179 },
180 "businessUnitLocked": true,
181 "companyCode": {
182 "id": 10000006,
183 "displayId": "1005",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "erpSystemId": 10000001,
191 "erpSystemDisplayId": "FINQ8S-300",
192 "countryId": 10000095,
193 "countryDisplayId": "CA",
194 "name": "string",
195 "postingPeriodVariantId": 0,
196 "fiscalVariantId": 0
197 },
198 "companyCodeLocked": true,
199 "department": {
200 "id": 300001,
201 "displayId": "DEP-01",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "Finance Department"
209 },
210 "departmentLocked": true,
211 "leaseGroup": {
212 "id": 60000001,
213 "displayId": "LG-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Global Lease Group"
221 },
222 "leaseGroupLocked": true,
223 "subleasingInternalAssetClass": {
224 "id": 10000001,
225 "displayId": "IAC-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Machinery and Equipment",
233 "assetClassType": "PROPERTY",
234 "infiniteUsefulLife": false
235 },
236 "contractGroup1": {
237 "id": 400001,
238 "displayId": "CG1-01",
239 "status": {
240 "name": "ACTIVE",
241 "captionKey": "enum.objectStatus.active",
242 "active": true,
243 "caption": "Active"
244 },
245 "name": "Real Estate Contracts"
246 },
247 "contractGroup2": {
248 "id": 500001,
249 "displayId": "CG2-01",
250 "status": {
251 "name": "ACTIVE",
252 "captionKey": "enum.objectStatus.active",
253 "active": true,
254 "caption": "Active"
255 },
256 "name": "Equipment Leasing Contracts"
257 },
258 "subleasing": false,
259 "subleasingContractRevisionInfo": {
260 "id": 50000001,
261 "contractId": 40000001,
262 "contractDisplayId": "CTR-0001",
263 "contractName": "Sublease Agreement for Office Space"
264 },
265 "subleasingLeaseComponentRevisionInfo": {
266 "id": 61000001,
267 "leaseComponentId": 80000001,
268 "leaseComponentDisplayId": "LC-0001",
269 "leaseComponentName": "Vehicle Lease Component"
270 },
271 "subleasingActivationGroupRevisionInfo": {
272 "id": 60000001,
273 "activationGroupId": 70000001,
274 "activationGroupDisplayId": "AG-001",
275 "activationGroupName": "Office Equipment Activation Group"
276 },
277 "notifications": [
278 {
279 "id": 10000001,
280 "topic": {
281 "enCaption": "Lease Component Updated",
282 "frCaption": "Composant de bail mis à jour",
283 "name": "LEASE_COMPONENT_UPDATED",
284 "priority": "HIGH"
285 },
286 "username": "super.admin@nakisa.com",
287 "contractId": 10000001,
288 "contractDisplayId": "CT-100000000",
289 "targetId": "CT-100000000",
290 "targetType": "CONTRACT"
291 }
292 ],
293 "masterAgreementId": 10000001,
294 "masterAgreementDisplayId": "string",
295 "allowsSystemGenerateNewId": true,
296 "transferInfo": {
297 "transferredFromDisplayId": "CTR-00012",
298 "transferredFromRevisionId": 20000001,
299 "transferredToDisplayId": "CTR-00015",
300 "transferredToRevisionId": 20000005
301 },
302 "numberRangeIdentifierValue": "",
303 "numberRangeIdentifierType": {
304 "name": "COMPANY_CODE"
305 },
306 "numberRangeType": {
307 "name": "CONTRACT"
308 }
309 }
310 ]
311}
Bulk Create Contract¶
HTTP Request
POST /api/v1/contracts/bulk
📋 Description: Submits multiple lease contracts in bulk to the Nakisa Lease Accounting Suite, facilitating efficient management of financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk contract data, including lease details, financial obligations, and accounting entries for streamlined processing within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000018,
4 "displayId": "CT-100001000",
5 "name": "Testtt Contract",
6 "principalPositionType": {
7 "name": "LESSEE",
8 "captionKey": "enum.principalpositiontype.lessee",
9 "caption": "Lessee"
10 },
11 "validFrom": "2019-08-24",
12 "validTo": "2019-08-24",
13 "amendmentDate": "2019-08-24",
14 "approverComment": "string",
15 "contractPhase": "INITIAL",
16 "dataCreationInfo": {
17 "id": 10000001,
18 "idGenerationType": {
19 "name": "AUTO",
20 "captionKey": "enum.idGenerationType.auto",
21 "caption": "Auto"
22 },
23 "source": "sample_source",
24 "type": {
25 "name": "MIGRATION",
26 "captionKey": "enum.dataType.migration",
27 "caption": "Migration"
28 },
29 "startDateTime": "2025-01-01T10:00:00Z",
30 "endDateTime": "2025-01-01T10:00:00Z"
31 },
32 "leaseType": {
33 "name": "LEASE_CONTRACT_FIX",
34 "captionKey": "enum.leaseType.fix",
35 "principalPositionType": "LESSEE",
36 "caption": "Fixed Lease Contract"
37 },
38 "revision": {
39 "id": 10000008,
40 "displayId": "CR-0001",
41 "name": "Initial Revision",
42 "inception": "2019-08-24",
43 "revisionType": "ACTIVE",
44 "state": "LC_DEFINE",
45 "approvedBy": "manager.user@company.com",
46 "approvedAt": "2019-08-24T14:15:22Z",
47 "parentRevisionId": 10000010,
48 "approverComment": "Approved with changes.",
49 "contractId": 20000001,
50 "contractDisplayId": "C-0001",
51 "contractName": "Office Lease Contract",
52 "principalPositionType": {
53 "name": "LESSEE",
54 "captionKey": "enum.principalpositiontype.lessee",
55 "caption": "Lessee"
56 },
57 "mlaId": 30000001,
58 "companyId": 40000001,
59 "description": "Revision to adjust payment terms.",
60 "externalReference": "EXT-REF-001",
61 "internalReference": "INT-REF-001",
62 "formOfLease": "FULL",
63 "jointVentureLeaseType": "GROSS_LEASE",
64 "businessPlace": "New York Office",
65 "tradingPartner": {
66 "id": 50000001,
67 "displayId": "TP-0001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "ABC Real Estate Partners",
75 "erpSystemId": 60000001,
76 "erpSystemDisplayId": "ERP-SYS-01"
77 },
78 "contractCategoryGroup": {
79 "id": 10000001,
80 "displayId": "sample_displayId",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "Sample Name"
88 },
89 "contractGroup1": {
90 "id": 400001,
91 "displayId": "CG1-01",
92 "status": {
93 "name": "ACTIVE",
94 "captionKey": "enum.objectStatus.active",
95 "active": true,
96 "caption": "Active"
97 },
98 "name": "Real Estate Contracts"
99 },
100 "contractGroup2": {
101 "id": 500001,
102 "displayId": "CG2-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Equipment Leasing Contracts"
110 },
111 "group3": "Group3-Value",
112 "group4": "Group4-Value",
113 "signingPerson": "John Doe",
114 "placeOfSignature": "Montreal, Canada",
115 "dateOfSignature": "2019-08-24T14:15:22Z",
116 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
117 "numberRangeIdentifierValue": "0001",
118 "numberRangeIdentifierType": {
119 "name": "COMPANY_CODE"
120 },
121 "numberRangeType": {
122 "name": "CONTRACT"
123 },
124 "allowsSystemGenerateNewId": true
125 },
126 "currency": {
127 "id": 840,
128 "displayId": "USD",
129 "status": {
130 "name": "ACTIVE",
131 "captionKey": "enum.objectStatus.active",
132 "active": true,
133 "caption": "Active"
134 },
135 "name": "United States Dollar",
136 "decimalPoints": 2
137 },
138 "companyCurrency": {
139 "id": 840,
140 "displayId": "USD",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "United States Dollar",
148 "decimalPoints": 2
149 },
150 "indexedCurrency": true,
151 "assetValueCurrencyType": "CONTRACT_CURRENCY",
152 "currencyLocked": true,
153 "leaseArea": {
154 "id": 10000001,
155 "displayId": "0001",
156 "status": {
157 "name": "ACTIVE",
158 "captionKey": "enum.objectStatus.active",
159 "active": true,
160 "caption": "Active"
161 },
162 "name": "Global Lease Area"
163 },
164 "businessUnit": {
165 "id": 10000001,
166 "displayId": "BU0001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "North America Business Unit"
174 },
175 "businessUnitLocked": true,
176 "companyCode": {
177 "id": 10000006,
178 "displayId": "1005",
179 "status": {
180 "name": "ACTIVE",
181 "captionKey": "enum.objectStatus.active",
182 "active": true,
183 "caption": "Active"
184 },
185 "erpSystemId": 10000001,
186 "erpSystemDisplayId": "FINQ8S-300",
187 "countryId": 10000095,
188 "countryDisplayId": "CA",
189 "name": "string",
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 "numberRangeIdentifierValue": "",
298 "numberRangeIdentifierType": {
299 "name": "COMPANY_CODE"
300 },
301 "numberRangeType": {
302 "name": "CONTRACT"
303 }
304 }
305]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contracts successfully created. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000018,
9 "displayId": "CT-100001000",
10 "name": "Testtt Contract",
11 "principalPositionType": {
12 "name": "LESSEE",
13 "captionKey": "enum.principalpositiontype.lessee",
14 "caption": "Lessee"
15 },
16 "validFrom": "2019-08-24",
17 "validTo": "2019-08-24",
18 "amendmentDate": "2019-08-24",
19 "approverComment": "string",
20 "contractPhase": "INITIAL",
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "leaseType": {
38 "name": "LEASE_CONTRACT_FIX",
39 "captionKey": "enum.leaseType.fix",
40 "principalPositionType": "LESSEE",
41 "caption": "Fixed Lease Contract"
42 },
43 "revision": {
44 "id": 10000008,
45 "displayId": "CR-0001",
46 "name": "Initial Revision",
47 "inception": "2019-08-24",
48 "revisionType": "ACTIVE",
49 "state": "LC_DEFINE",
50 "approvedBy": "manager.user@company.com",
51 "approvedAt": "2019-08-24T14:15:22Z",
52 "parentRevisionId": 10000010,
53 "approverComment": "Approved with changes.",
54 "contractId": 20000001,
55 "contractDisplayId": "C-0001",
56 "contractName": "Office Lease Contract",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "mlaId": 30000001,
63 "companyId": 40000001,
64 "description": "Revision to adjust payment terms.",
65 "externalReference": "EXT-REF-001",
66 "internalReference": "INT-REF-001",
67 "formOfLease": "FULL",
68 "jointVentureLeaseType": "GROSS_LEASE",
69 "businessPlace": "New York Office",
70 "tradingPartner": {
71 "id": 50000001,
72 "displayId": "TP-0001",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "ABC Real Estate Partners",
80 "erpSystemId": 60000001,
81 "erpSystemDisplayId": "ERP-SYS-01"
82 },
83 "contractCategoryGroup": {
84 "id": 10000001,
85 "displayId": "sample_displayId",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "Sample Name"
93 },
94 "contractGroup1": {
95 "id": 400001,
96 "displayId": "CG1-01",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "Real Estate Contracts"
104 },
105 "contractGroup2": {
106 "id": 500001,
107 "displayId": "CG2-01",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "Equipment Leasing Contracts"
115 },
116 "group3": "Group3-Value",
117 "group4": "Group4-Value",
118 "signingPerson": "John Doe",
119 "placeOfSignature": "Montreal, Canada",
120 "dateOfSignature": "2019-08-24T14:15:22Z",
121 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
122 "numberRangeIdentifierValue": "0001",
123 "numberRangeIdentifierType": {
124 "name": "COMPANY_CODE"
125 },
126 "numberRangeType": {
127 "name": "CONTRACT"
128 },
129 "allowsSystemGenerateNewId": true
130 },
131 "currency": {
132 "id": 840,
133 "displayId": "USD",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "United States Dollar",
141 "decimalPoints": 2
142 },
143 "companyCurrency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "indexedCurrency": true,
156 "assetValueCurrencyType": "CONTRACT_CURRENCY",
157 "currencyLocked": true,
158 "leaseArea": {
159 "id": 10000001,
160 "displayId": "0001",
161 "status": {
162 "name": "ACTIVE",
163 "captionKey": "enum.objectStatus.active",
164 "active": true,
165 "caption": "Active"
166 },
167 "name": "Global Lease Area"
168 },
169 "businessUnit": {
170 "id": 10000001,
171 "displayId": "BU0001",
172 "status": {
173 "name": "ACTIVE",
174 "captionKey": "enum.objectStatus.active",
175 "active": true,
176 "caption": "Active"
177 },
178 "name": "North America Business Unit"
179 },
180 "businessUnitLocked": true,
181 "companyCode": {
182 "id": 10000006,
183 "displayId": "1005",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "erpSystemId": 10000001,
191 "erpSystemDisplayId": "FINQ8S-300",
192 "countryId": 10000095,
193 "countryDisplayId": "CA",
194 "name": "string",
195 "postingPeriodVariantId": 0,
196 "fiscalVariantId": 0
197 },
198 "companyCodeLocked": true,
199 "department": {
200 "id": 300001,
201 "displayId": "DEP-01",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "Finance Department"
209 },
210 "departmentLocked": true,
211 "leaseGroup": {
212 "id": 60000001,
213 "displayId": "LG-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Global Lease Group"
221 },
222 "leaseGroupLocked": true,
223 "subleasingInternalAssetClass": {
224 "id": 10000001,
225 "displayId": "IAC-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Machinery and Equipment",
233 "assetClassType": "PROPERTY",
234 "infiniteUsefulLife": false
235 },
236 "contractGroup1": {
237 "id": 400001,
238 "displayId": "CG1-01",
239 "status": {
240 "name": "ACTIVE",
241 "captionKey": "enum.objectStatus.active",
242 "active": true,
243 "caption": "Active"
244 },
245 "name": "Real Estate Contracts"
246 },
247 "contractGroup2": {
248 "id": 500001,
249 "displayId": "CG2-01",
250 "status": {
251 "name": "ACTIVE",
252 "captionKey": "enum.objectStatus.active",
253 "active": true,
254 "caption": "Active"
255 },
256 "name": "Equipment Leasing Contracts"
257 },
258 "subleasing": false,
259 "subleasingContractRevisionInfo": {
260 "id": 50000001,
261 "contractId": 40000001,
262 "contractDisplayId": "CTR-0001",
263 "contractName": "Sublease Agreement for Office Space"
264 },
265 "subleasingLeaseComponentRevisionInfo": {
266 "id": 61000001,
267 "leaseComponentId": 80000001,
268 "leaseComponentDisplayId": "LC-0001",
269 "leaseComponentName": "Vehicle Lease Component"
270 },
271 "subleasingActivationGroupRevisionInfo": {
272 "id": 60000001,
273 "activationGroupId": 70000001,
274 "activationGroupDisplayId": "AG-001",
275 "activationGroupName": "Office Equipment Activation Group"
276 },
277 "notifications": [
278 {
279 "id": 10000001,
280 "topic": {
281 "enCaption": "Lease Component Updated",
282 "frCaption": "Composant de bail mis à jour",
283 "name": "LEASE_COMPONENT_UPDATED",
284 "priority": "HIGH"
285 },
286 "username": "super.admin@nakisa.com",
287 "contractId": 10000001,
288 "contractDisplayId": "CT-100000000",
289 "targetId": "CT-100000000",
290 "targetType": "CONTRACT"
291 }
292 ],
293 "masterAgreementId": 10000001,
294 "masterAgreementDisplayId": "string",
295 "allowsSystemGenerateNewId": true,
296 "transferInfo": {
297 "transferredFromDisplayId": "CTR-00012",
298 "transferredFromRevisionId": 20000001,
299 "transferredToDisplayId": "CTR-00015",
300 "transferredToRevisionId": 20000005
301 },
302 "numberRangeIdentifierValue": "",
303 "numberRangeIdentifierType": {
304 "name": "COMPANY_CODE"
305 },
306 "numberRangeType": {
307 "name": "CONTRACT"
308 }
309 }
310 ]
311}
Delete Contracts In Bulk¶
HTTP Request
DELETE /api/v1/contracts/bulk
📋 Description: Deletes multiple contracts in bulk from the Nakisa Lease Accounting Suite, effectively managing lease-related financial obligations and ensuring accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
false |
Request body containing an array of contract identifiers to facilitate the bulk deletion of lease agreements and associated financial obligations within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 10000004
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contracts successfully deleted. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
List All Contracts¶
HTTP Request
GET /api/v1/contracts
📋 Description: Retrieves a list of contracts associated with leases, providing essential details for financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
false |
Indicates whether the results of the lease contract retrieval should be paginated, facilitating efficient management of financial obligations and accounting entries. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved list of contracts. |
Example Responses
1{
2 "totalElements": 76,
3 "totalPages": 1,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 76,
17 "size": 100,
18 "content": [
19 {
20 "id": 10000018,
21 "displayId": "CT-100001000",
22 "name": "Testtt Contract",
23 "principalPositionType": {
24 "name": "LESSEE",
25 "captionKey": "enum.principalpositiontype.lessee",
26 "caption": "Lessee"
27 },
28 "validFrom": "2019-08-24",
29 "validTo": "2019-08-24",
30 "amendmentDate": "2019-08-24",
31 "approverComment": "string",
32 "contractPhase": "INITIAL",
33 "dataCreationInfo": {
34 "id": 10000001,
35 "idGenerationType": {
36 "name": "AUTO",
37 "captionKey": "enum.idGenerationType.auto",
38 "caption": "Auto"
39 },
40 "source": "sample_source",
41 "type": {
42 "name": "MIGRATION",
43 "captionKey": "enum.dataType.migration",
44 "caption": "Migration"
45 },
46 "startDateTime": "2025-01-01T10:00:00Z",
47 "endDateTime": "2025-01-01T10:00:00Z"
48 },
49 "leaseType": {
50 "name": "LEASE_CONTRACT_FIX",
51 "captionKey": "enum.leaseType.fix",
52 "principalPositionType": "LESSEE",
53 "caption": "Fixed Lease Contract"
54 },
55 "revision": {
56 "id": 10000008,
57 "displayId": "CR-0001",
58 "name": "Initial Revision",
59 "inception": "2019-08-24",
60 "revisionType": "ACTIVE",
61 "state": "LC_DEFINE",
62 "approvedBy": "manager.user@company.com",
63 "approvedAt": "2019-08-24T14:15:22Z",
64 "parentRevisionId": 10000010,
65 "approverComment": "Approved with changes.",
66 "contractId": 20000001,
67 "contractDisplayId": "C-0001",
68 "contractName": "Office Lease Contract",
69 "principalPositionType": {
70 "name": "LESSEE",
71 "captionKey": "enum.principalpositiontype.lessee",
72 "caption": "Lessee"
73 },
74 "mlaId": 30000001,
75 "companyId": 40000001,
76 "description": "Revision to adjust payment terms.",
77 "externalReference": "EXT-REF-001",
78 "internalReference": "INT-REF-001",
79 "formOfLease": "FULL",
80 "jointVentureLeaseType": "GROSS_LEASE",
81 "businessPlace": "New York Office",
82 "tradingPartner": {
83 "id": 50000001,
84 "displayId": "TP-0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "ABC Real Estate Partners",
92 "erpSystemId": 60000001,
93 "erpSystemDisplayId": "ERP-SYS-01"
94 },
95 "contractCategoryGroup": {
96 "id": 10000001,
97 "displayId": "sample_displayId",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "name": "Sample Name"
105 },
106 "contractGroup1": {
107 "id": 400001,
108 "displayId": "CG1-01",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "Real Estate Contracts"
116 },
117 "contractGroup2": {
118 "id": 500001,
119 "displayId": "CG2-01",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "Equipment Leasing Contracts"
127 },
128 "group3": "Group3-Value",
129 "group4": "Group4-Value",
130 "signingPerson": "John Doe",
131 "placeOfSignature": "Montreal, Canada",
132 "dateOfSignature": "2019-08-24T14:15:22Z",
133 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
134 "numberRangeIdentifierValue": "0001",
135 "numberRangeIdentifierType": {
136 "name": "COMPANY_CODE"
137 },
138 "numberRangeType": {
139 "name": "CONTRACT"
140 },
141 "allowsSystemGenerateNewId": true
142 },
143 "currency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "companyCurrency": {
156 "id": 840,
157 "displayId": "USD",
158 "status": {
159 "name": "ACTIVE",
160 "captionKey": "enum.objectStatus.active",
161 "active": true,
162 "caption": "Active"
163 },
164 "name": "United States Dollar",
165 "decimalPoints": 2
166 },
167 "indexedCurrency": true,
168 "assetValueCurrencyType": "CONTRACT_CURRENCY",
169 "currencyLocked": true,
170 "leaseArea": {
171 "id": 10000001,
172 "displayId": "0001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Global Lease Area"
180 },
181 "businessUnit": {
182 "id": 10000001,
183 "displayId": "BU0001",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "name": "North America Business Unit"
191 },
192 "businessUnitLocked": true,
193 "companyCode": {
194 "id": 10000006,
195 "displayId": "1005",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "erpSystemId": 10000001,
203 "erpSystemDisplayId": "FINQ8S-300",
204 "countryId": 10000095,
205 "countryDisplayId": "CA",
206 "name": "string",
207 "postingPeriodVariantId": 0,
208 "fiscalVariantId": 0
209 },
210 "companyCodeLocked": true,
211 "department": {
212 "id": 300001,
213 "displayId": "DEP-01",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Finance Department"
221 },
222 "departmentLocked": true,
223 "leaseGroup": {
224 "id": 60000001,
225 "displayId": "LG-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Global Lease Group"
233 },
234 "leaseGroupLocked": true,
235 "subleasingInternalAssetClass": {
236 "id": 10000001,
237 "displayId": "IAC-001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Machinery and Equipment",
245 "assetClassType": "PROPERTY",
246 "infiniteUsefulLife": false
247 },
248 "contractGroup1": {
249 "id": 400001,
250 "displayId": "CG1-01",
251 "status": {
252 "name": "ACTIVE",
253 "captionKey": "enum.objectStatus.active",
254 "active": true,
255 "caption": "Active"
256 },
257 "name": "Real Estate Contracts"
258 },
259 "contractGroup2": {
260 "id": 500001,
261 "displayId": "CG2-01",
262 "status": {
263 "name": "ACTIVE",
264 "captionKey": "enum.objectStatus.active",
265 "active": true,
266 "caption": "Active"
267 },
268 "name": "Equipment Leasing Contracts"
269 },
270 "subleasing": false,
271 "subleasingContractRevisionInfo": {
272 "id": 50000001,
273 "contractId": 40000001,
274 "contractDisplayId": "CTR-0001",
275 "contractName": "Sublease Agreement for Office Space"
276 },
277 "subleasingLeaseComponentRevisionInfo": {
278 "id": 61000001,
279 "leaseComponentId": 80000001,
280 "leaseComponentDisplayId": "LC-0001",
281 "leaseComponentName": "Vehicle Lease Component"
282 },
283 "subleasingActivationGroupRevisionInfo": {
284 "id": 60000001,
285 "activationGroupId": 70000001,
286 "activationGroupDisplayId": "AG-001",
287 "activationGroupName": "Office Equipment Activation Group"
288 },
289 "notifications": [
290 {
291 "id": 10000001,
292 "topic": {
293 "enCaption": "Lease Component Updated",
294 "frCaption": "Composant de bail mis à jour",
295 "name": "LEASE_COMPONENT_UPDATED",
296 "priority": "HIGH"
297 },
298 "username": "super.admin@nakisa.com",
299 "contractId": 10000001,
300 "contractDisplayId": "CT-100000000",
301 "targetId": "CT-100000000",
302 "targetType": "CONTRACT"
303 }
304 ],
305 "masterAgreementId": 10000001,
306 "masterAgreementDisplayId": "string",
307 "allowsSystemGenerateNewId": true,
308 "transferInfo": {
309 "transferredFromDisplayId": "CTR-00012",
310 "transferredFromRevisionId": 20000001,
311 "transferredToDisplayId": "CTR-00015",
312 "transferredToRevisionId": 20000005
313 },
314 "numberRangeIdentifierValue": "",
315 "numberRangeIdentifierType": {
316 "name": "COMPANY_CODE"
317 },
318 "numberRangeType": {
319 "name": "CONTRACT"
320 }
321 }
322 ],
323 "number": 0,
324 "sort": {
325 "unsorted": false,
326 "sorted": true,
327 "empty": false
328 },
329 "first": true,
330 "last": true,
331 "empty": false
332}
Creates A Contract¶
HTTP Request
POST /api/v1/contracts
📋 Description: Creates a new lease contract within the Nakisa Lease Accounting Suite, establishing a financial obligation and generating the necessary accounting entries for accurate financial reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease contract details, including financial obligations and accounting entries necessary for processing within the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "id": 10000018,
3 "displayId": "CT-100001000",
4 "name": "Testtt Contract",
5 "principalPositionType": {
6 "name": "LESSEE",
7 "captionKey": "enum.principalpositiontype.lessee",
8 "caption": "Lessee"
9 },
10 "validFrom": "2019-08-24",
11 "validTo": "2019-08-24",
12 "amendmentDate": "2019-08-24",
13 "approverComment": "string",
14 "contractPhase": "INITIAL",
15 "dataCreationInfo": {
16 "id": 10000001,
17 "idGenerationType": {
18 "name": "AUTO",
19 "captionKey": "enum.idGenerationType.auto",
20 "caption": "Auto"
21 },
22 "source": "sample_source",
23 "type": {
24 "name": "MIGRATION",
25 "captionKey": "enum.dataType.migration",
26 "caption": "Migration"
27 },
28 "startDateTime": "2025-01-01T10:00:00Z",
29 "endDateTime": "2025-01-01T10:00:00Z"
30 },
31 "leaseType": {
32 "name": "LEASE_CONTRACT_FIX",
33 "captionKey": "enum.leaseType.fix",
34 "principalPositionType": "LESSEE",
35 "caption": "Fixed Lease Contract"
36 },
37 "revision": {
38 "id": 10000008,
39 "displayId": "CR-0001",
40 "name": "Initial Revision",
41 "inception": "2019-08-24",
42 "revisionType": "ACTIVE",
43 "state": "LC_DEFINE",
44 "approvedBy": "manager.user@company.com",
45 "approvedAt": "2019-08-24T14:15:22Z",
46 "parentRevisionId": 10000010,
47 "approverComment": "Approved with changes.",
48 "contractId": 20000001,
49 "contractDisplayId": "C-0001",
50 "contractName": "Office Lease Contract",
51 "principalPositionType": {
52 "name": "LESSEE",
53 "captionKey": "enum.principalpositiontype.lessee",
54 "caption": "Lessee"
55 },
56 "mlaId": 30000001,
57 "companyId": 40000001,
58 "description": "Revision to adjust payment terms.",
59 "externalReference": "EXT-REF-001",
60 "internalReference": "INT-REF-001",
61 "formOfLease": "FULL",
62 "jointVentureLeaseType": "GROSS_LEASE",
63 "businessPlace": "New York Office",
64 "tradingPartner": {
65 "id": 50000001,
66 "displayId": "TP-0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "ABC Real Estate Partners",
74 "erpSystemId": 60000001,
75 "erpSystemDisplayId": "ERP-SYS-01"
76 },
77 "contractCategoryGroup": {
78 "id": 10000001,
79 "displayId": "sample_displayId",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Sample Name"
87 },
88 "contractGroup1": {
89 "id": 400001,
90 "displayId": "CG1-01",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "Real Estate Contracts"
98 },
99 "contractGroup2": {
100 "id": 500001,
101 "displayId": "CG2-01",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "Equipment Leasing Contracts"
109 },
110 "group3": "Group3-Value",
111 "group4": "Group4-Value",
112 "signingPerson": "John Doe",
113 "placeOfSignature": "Montreal, Canada",
114 "dateOfSignature": "2019-08-24T14:15:22Z",
115 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
116 "numberRangeIdentifierValue": "0001",
117 "numberRangeIdentifierType": {
118 "name": "COMPANY_CODE"
119 },
120 "numberRangeType": {
121 "name": "CONTRACT"
122 },
123 "allowsSystemGenerateNewId": true
124 },
125 "currency": {
126 "id": 840,
127 "displayId": "USD",
128 "status": {
129 "name": "ACTIVE",
130 "captionKey": "enum.objectStatus.active",
131 "active": true,
132 "caption": "Active"
133 },
134 "name": "United States Dollar",
135 "decimalPoints": 2
136 },
137 "companyCurrency": {
138 "id": 840,
139 "displayId": "USD",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "United States Dollar",
147 "decimalPoints": 2
148 },
149 "indexedCurrency": true,
150 "assetValueCurrencyType": "CONTRACT_CURRENCY",
151 "currencyLocked": true,
152 "leaseArea": {
153 "id": 10000001,
154 "displayId": "0001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Area"
162 },
163 "businessUnit": {
164 "id": 10000001,
165 "displayId": "BU0001",
166 "status": {
167 "name": "ACTIVE",
168 "captionKey": "enum.objectStatus.active",
169 "active": true,
170 "caption": "Active"
171 },
172 "name": "North America Business Unit"
173 },
174 "businessUnitLocked": true,
175 "companyCode": {
176 "id": 10000006,
177 "displayId": "1005",
178 "status": {
179 "name": "ACTIVE",
180 "captionKey": "enum.objectStatus.active",
181 "active": true,
182 "caption": "Active"
183 },
184 "erpSystemId": 10000001,
185 "erpSystemDisplayId": "FINQ8S-300",
186 "countryId": 10000095,
187 "countryDisplayId": "CA",
188 "name": "string",
189 "postingPeriodVariantId": 0,
190 "fiscalVariantId": 0
191 },
192 "companyCodeLocked": true,
193 "department": {
194 "id": 300001,
195 "displayId": "DEP-01",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Finance Department"
203 },
204 "departmentLocked": true,
205 "leaseGroup": {
206 "id": 60000001,
207 "displayId": "LG-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Global Lease Group"
215 },
216 "leaseGroupLocked": true,
217 "subleasingInternalAssetClass": {
218 "id": 10000001,
219 "displayId": "IAC-001",
220 "status": {
221 "name": "ACTIVE",
222 "captionKey": "enum.objectStatus.active",
223 "active": true,
224 "caption": "Active"
225 },
226 "name": "Machinery and Equipment",
227 "assetClassType": "PROPERTY",
228 "infiniteUsefulLife": false
229 },
230 "contractGroup1": {
231 "id": 400001,
232 "displayId": "CG1-01",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "name": "Real Estate Contracts"
240 },
241 "contractGroup2": {
242 "id": 500001,
243 "displayId": "CG2-01",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "Equipment Leasing Contracts"
251 },
252 "subleasing": false,
253 "subleasingContractRevisionInfo": {
254 "id": 50000001,
255 "contractId": 40000001,
256 "contractDisplayId": "CTR-0001",
257 "contractName": "Sublease Agreement for Office Space"
258 },
259 "subleasingLeaseComponentRevisionInfo": {
260 "id": 61000001,
261 "leaseComponentId": 80000001,
262 "leaseComponentDisplayId": "LC-0001",
263 "leaseComponentName": "Vehicle Lease Component"
264 },
265 "subleasingActivationGroupRevisionInfo": {
266 "id": 60000001,
267 "activationGroupId": 70000001,
268 "activationGroupDisplayId": "AG-001",
269 "activationGroupName": "Office Equipment Activation Group"
270 },
271 "notifications": [
272 {
273 "id": 10000001,
274 "topic": {
275 "enCaption": "Lease Component Updated",
276 "frCaption": "Composant de bail mis à jour",
277 "name": "LEASE_COMPONENT_UPDATED",
278 "priority": "HIGH"
279 },
280 "username": "super.admin@nakisa.com",
281 "contractId": 10000001,
282 "contractDisplayId": "CT-100000000",
283 "targetId": "CT-100000000",
284 "targetType": "CONTRACT"
285 }
286 ],
287 "masterAgreementId": 10000001,
288 "masterAgreementDisplayId": "string",
289 "allowsSystemGenerateNewId": true,
290 "transferInfo": {
291 "transferredFromDisplayId": "CTR-00012",
292 "transferredFromRevisionId": 20000001,
293 "transferredToDisplayId": "CTR-00015",
294 "transferredToRevisionId": 20000005
295 },
296 "numberRangeIdentifierValue": "",
297 "numberRangeIdentifierType": {
298 "name": "COMPANY_CODE"
299 },
300 "numberRangeType": {
301 "name": "CONTRACT"
302 }
303}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contract created. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}
Searches Contracts¶
HTTP Request
POST /api/v1/contracts/search
📋 Description: Submits a search request for contracts within the Nakisa Lease Accounting Suite, allowing users to identify specific lease agreements and associated financial obligations for streamlined accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing search criteria and filters for retrieving lease contract information, including relevant financial obligations and accounting entries. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 10000001,
4 10000002
5 ],
6 "idEqual": 10000001,
7 "idLike": "1000%",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "admin%",
11 "createdByEqual": "super.admin@company.com",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "admin%",
15 "modifiedByEqual": "super.admin@company.com",
16 "displayIdIn": [
17 "CT-10000001",
18 "CT-10000002"
19 ],
20 "displayIdLike": "CT-1000%",
21 "nameOrDisplayIdLike": "Lease%",
22 "nameLike": "Global%",
23 "principalPositionTypeEqual": "LESSEE",
24 "revisionIdEqual": 10000010,
25 "revisionTypeEqual": "ACTIVE",
26 "revisionStateEqual": "AG_DEFINE",
27 "currencyIdEqual": 100,
28 "leaseAreaIdIn": [
29 2001,
30 2002
31 ],
32 "leaseAreaIdEqual": 2001,
33 "businessUnitIdIn": [
34 3001,
35 3002
36 ],
37 "businessUnitIdEqual": 3001,
38 "companyCodeIdEqual": 4001,
39 "companyCodeIdIn": [
40 4001,
41 4002
42 ],
43 "departmentIdIn": [
44 5001,
45 5002
46 ],
47 "departmentIdEqual": 5001,
48 "leaseGroupIdIn": [
49 6001,
50 6002
51 ],
52 "leaseGroupIdEqual": 6001,
53 "subleasingEqual": true,
54 "masterAgreementIdIn": [
55 10000086,
56 10000087
57 ],
58 "masterAgreementDisplayIdIn": [
59 "MA-2025-0001",
60 "MA-2025-0002"
61 ]
62}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Search results successfully returned. |
Example Responses
1{
2 "totalElements": 76,
3 "totalPages": 1,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 76,
17 "size": 100,
18 "content": [
19 {
20 "id": 10000018,
21 "displayId": "CT-100001000",
22 "name": "Testtt Contract",
23 "principalPositionType": {
24 "name": "LESSEE",
25 "captionKey": "enum.principalpositiontype.lessee",
26 "caption": "Lessee"
27 },
28 "validFrom": "2019-08-24",
29 "validTo": "2019-08-24",
30 "amendmentDate": "2019-08-24",
31 "approverComment": "string",
32 "contractPhase": "INITIAL",
33 "dataCreationInfo": {
34 "id": 10000001,
35 "idGenerationType": {
36 "name": "AUTO",
37 "captionKey": "enum.idGenerationType.auto",
38 "caption": "Auto"
39 },
40 "source": "sample_source",
41 "type": {
42 "name": "MIGRATION",
43 "captionKey": "enum.dataType.migration",
44 "caption": "Migration"
45 },
46 "startDateTime": "2025-01-01T10:00:00Z",
47 "endDateTime": "2025-01-01T10:00:00Z"
48 },
49 "leaseType": {
50 "name": "LEASE_CONTRACT_FIX",
51 "captionKey": "enum.leaseType.fix",
52 "principalPositionType": "LESSEE",
53 "caption": "Fixed Lease Contract"
54 },
55 "revision": {
56 "id": 10000008,
57 "displayId": "CR-0001",
58 "name": "Initial Revision",
59 "inception": "2019-08-24",
60 "revisionType": "ACTIVE",
61 "state": "LC_DEFINE",
62 "approvedBy": "manager.user@company.com",
63 "approvedAt": "2019-08-24T14:15:22Z",
64 "parentRevisionId": 10000010,
65 "approverComment": "Approved with changes.",
66 "contractId": 20000001,
67 "contractDisplayId": "C-0001",
68 "contractName": "Office Lease Contract",
69 "principalPositionType": {
70 "name": "LESSEE",
71 "captionKey": "enum.principalpositiontype.lessee",
72 "caption": "Lessee"
73 },
74 "mlaId": 30000001,
75 "companyId": 40000001,
76 "description": "Revision to adjust payment terms.",
77 "externalReference": "EXT-REF-001",
78 "internalReference": "INT-REF-001",
79 "formOfLease": "FULL",
80 "jointVentureLeaseType": "GROSS_LEASE",
81 "businessPlace": "New York Office",
82 "tradingPartner": {
83 "id": 50000001,
84 "displayId": "TP-0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "ABC Real Estate Partners",
92 "erpSystemId": 60000001,
93 "erpSystemDisplayId": "ERP-SYS-01"
94 },
95 "contractCategoryGroup": {
96 "id": 10000001,
97 "displayId": "sample_displayId",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "name": "Sample Name"
105 },
106 "contractGroup1": {
107 "id": 400001,
108 "displayId": "CG1-01",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "Real Estate Contracts"
116 },
117 "contractGroup2": {
118 "id": 500001,
119 "displayId": "CG2-01",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "Equipment Leasing Contracts"
127 },
128 "group3": "Group3-Value",
129 "group4": "Group4-Value",
130 "signingPerson": "John Doe",
131 "placeOfSignature": "Montreal, Canada",
132 "dateOfSignature": "2019-08-24T14:15:22Z",
133 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
134 "numberRangeIdentifierValue": "0001",
135 "numberRangeIdentifierType": {
136 "name": "COMPANY_CODE"
137 },
138 "numberRangeType": {
139 "name": "CONTRACT"
140 },
141 "allowsSystemGenerateNewId": true
142 },
143 "currency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "companyCurrency": {
156 "id": 840,
157 "displayId": "USD",
158 "status": {
159 "name": "ACTIVE",
160 "captionKey": "enum.objectStatus.active",
161 "active": true,
162 "caption": "Active"
163 },
164 "name": "United States Dollar",
165 "decimalPoints": 2
166 },
167 "indexedCurrency": true,
168 "assetValueCurrencyType": "CONTRACT_CURRENCY",
169 "currencyLocked": true,
170 "leaseArea": {
171 "id": 10000001,
172 "displayId": "0001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Global Lease Area"
180 },
181 "businessUnit": {
182 "id": 10000001,
183 "displayId": "BU0001",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "name": "North America Business Unit"
191 },
192 "businessUnitLocked": true,
193 "companyCode": {
194 "id": 10000006,
195 "displayId": "1005",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "erpSystemId": 10000001,
203 "erpSystemDisplayId": "FINQ8S-300",
204 "countryId": 10000095,
205 "countryDisplayId": "CA",
206 "name": "string",
207 "postingPeriodVariantId": 0,
208 "fiscalVariantId": 0
209 },
210 "companyCodeLocked": true,
211 "department": {
212 "id": 300001,
213 "displayId": "DEP-01",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Finance Department"
221 },
222 "departmentLocked": true,
223 "leaseGroup": {
224 "id": 60000001,
225 "displayId": "LG-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Global Lease Group"
233 },
234 "leaseGroupLocked": true,
235 "subleasingInternalAssetClass": {
236 "id": 10000001,
237 "displayId": "IAC-001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Machinery and Equipment",
245 "assetClassType": "PROPERTY",
246 "infiniteUsefulLife": false
247 },
248 "contractGroup1": {
249 "id": 400001,
250 "displayId": "CG1-01",
251 "status": {
252 "name": "ACTIVE",
253 "captionKey": "enum.objectStatus.active",
254 "active": true,
255 "caption": "Active"
256 },
257 "name": "Real Estate Contracts"
258 },
259 "contractGroup2": {
260 "id": 500001,
261 "displayId": "CG2-01",
262 "status": {
263 "name": "ACTIVE",
264 "captionKey": "enum.objectStatus.active",
265 "active": true,
266 "caption": "Active"
267 },
268 "name": "Equipment Leasing Contracts"
269 },
270 "subleasing": false,
271 "subleasingContractRevisionInfo": {
272 "id": 50000001,
273 "contractId": 40000001,
274 "contractDisplayId": "CTR-0001",
275 "contractName": "Sublease Agreement for Office Space"
276 },
277 "subleasingLeaseComponentRevisionInfo": {
278 "id": 61000001,
279 "leaseComponentId": 80000001,
280 "leaseComponentDisplayId": "LC-0001",
281 "leaseComponentName": "Vehicle Lease Component"
282 },
283 "subleasingActivationGroupRevisionInfo": {
284 "id": 60000001,
285 "activationGroupId": 70000001,
286 "activationGroupDisplayId": "AG-001",
287 "activationGroupName": "Office Equipment Activation Group"
288 },
289 "notifications": [
290 {
291 "id": 10000001,
292 "topic": {
293 "enCaption": "Lease Component Updated",
294 "frCaption": "Composant de bail mis à jour",
295 "name": "LEASE_COMPONENT_UPDATED",
296 "priority": "HIGH"
297 },
298 "username": "super.admin@nakisa.com",
299 "contractId": 10000001,
300 "contractDisplayId": "CT-100000000",
301 "targetId": "CT-100000000",
302 "targetType": "CONTRACT"
303 }
304 ],
305 "masterAgreementId": 10000001,
306 "masterAgreementDisplayId": "string",
307 "allowsSystemGenerateNewId": true,
308 "transferInfo": {
309 "transferredFromDisplayId": "CTR-00012",
310 "transferredFromRevisionId": 20000001,
311 "transferredToDisplayId": "CTR-00015",
312 "transferredToRevisionId": 20000005
313 },
314 "numberRangeIdentifierValue": "",
315 "numberRangeIdentifierType": {
316 "name": "COMPANY_CODE"
317 },
318 "numberRangeType": {
319 "name": "CONTRACT"
320 }
321 }
322 ],
323 "number": 0,
324 "sort": {
325 "unsorted": false,
326 "sorted": true,
327 "empty": false
328 },
329 "first": true,
330 "last": true,
331 "empty": false
332}
Clone A Contract¶
HTTP Request
POST /api/v1/contracts/clone/{id}
📋 Description: Clones an existing contract identified by the specified ID, enabling users to efficiently replicate lease agreements and associated financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the contract details to be cloned, including lease terms, financial obligations, and relevant accounting entries. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Body Parameters
1{
2 "name": "Cloned Contract - HQ Lease",
3 "idGenerationType": {
4 "name": "AUTO",
5 "captionKey": "enum.idGenerationType.auto",
6 "caption": "Auto"
7 },
8 "masterAgreementId": 10000086,
9 "leaseArea": {
10 "id": 10000001,
11 "displayId": "0001",
12 "status": {
13 "name": "ACTIVE",
14 "captionKey": "enum.objectStatus.active",
15 "active": true,
16 "caption": "Active"
17 },
18 "name": "Global Lease Area"
19 },
20 "principalPositionType": "LESSEE",
21 "businessUnit": {
22 "id": 10000001,
23 "displayId": "BU0001",
24 "status": {
25 "name": "ACTIVE",
26 "captionKey": "enum.objectStatus.active",
27 "active": true,
28 "caption": "Active"
29 },
30 "name": "North America Business Unit"
31 },
32 "companyCode": {
33 "id": 10000006,
34 "displayId": "1005",
35 "status": {
36 "name": "ACTIVE",
37 "captionKey": "enum.objectStatus.active",
38 "active": true,
39 "caption": "Active"
40 },
41 "erpSystemId": 10000001,
42 "erpSystemDisplayId": "FINQ8S-300",
43 "countryId": 10000095,
44 "countryDisplayId": "CA",
45 "name": "string",
46 "postingPeriodVariantId": 0,
47 "fiscalVariantId": 0
48 }
49}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contract successfully cloned. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}
Clone Multiple Contracts In Batch¶
HTTP Request
POST /api/v1/contracts/batch-clone
📋 Description: Creates multiple cloned lease contracts in a single operation, facilitating efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing an array of lease contract details to facilitate the batch cloning of financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "contractIds": [
3 10000004,
4 10000005,
5 10000006
6 ],
7 "masterAgreementId": 10000086,
8 "masterAgreementDisplayId": "MA-2025-0001",
9 "principalPositionType": {
10 "name": "LESSEE",
11 "captionKey": "enum.principalpositiontype.lessee",
12 "caption": "Lessee"
13 },
14 "businessUnit": {
15 "id": 10000001,
16 "displayId": "BU0001",
17 "status": {
18 "name": "ACTIVE",
19 "captionKey": "enum.objectStatus.active",
20 "active": true,
21 "caption": "Active"
22 },
23 "name": "North America Business Unit"
24 },
25 "companyCode": {
26 "id": 10000006,
27 "displayId": "1005",
28 "status": {
29 "name": "ACTIVE",
30 "captionKey": "enum.objectStatus.active",
31 "active": true,
32 "caption": "Active"
33 },
34 "erpSystemId": 10000001,
35 "erpSystemDisplayId": "FINQ8S-300",
36 "countryId": 10000095,
37 "countryDisplayId": "CA",
38 "name": "string",
39 "postingPeriodVariantId": 0,
40 "fiscalVariantId": 0
41 }
42}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Contracts successfully cloned. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000018,
9 "displayId": "CT-100001000",
10 "name": "Testtt Contract",
11 "principalPositionType": {
12 "name": "LESSEE",
13 "captionKey": "enum.principalpositiontype.lessee",
14 "caption": "Lessee"
15 },
16 "validFrom": "2019-08-24",
17 "validTo": "2019-08-24",
18 "amendmentDate": "2019-08-24",
19 "approverComment": "string",
20 "contractPhase": "INITIAL",
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "leaseType": {
38 "name": "LEASE_CONTRACT_FIX",
39 "captionKey": "enum.leaseType.fix",
40 "principalPositionType": "LESSEE",
41 "caption": "Fixed Lease Contract"
42 },
43 "revision": {
44 "id": 10000008,
45 "displayId": "CR-0001",
46 "name": "Initial Revision",
47 "inception": "2019-08-24",
48 "revisionType": "ACTIVE",
49 "state": "LC_DEFINE",
50 "approvedBy": "manager.user@company.com",
51 "approvedAt": "2019-08-24T14:15:22Z",
52 "parentRevisionId": 10000010,
53 "approverComment": "Approved with changes.",
54 "contractId": 20000001,
55 "contractDisplayId": "C-0001",
56 "contractName": "Office Lease Contract",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "mlaId": 30000001,
63 "companyId": 40000001,
64 "description": "Revision to adjust payment terms.",
65 "externalReference": "EXT-REF-001",
66 "internalReference": "INT-REF-001",
67 "formOfLease": "FULL",
68 "jointVentureLeaseType": "GROSS_LEASE",
69 "businessPlace": "New York Office",
70 "tradingPartner": {
71 "id": 50000001,
72 "displayId": "TP-0001",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "ABC Real Estate Partners",
80 "erpSystemId": 60000001,
81 "erpSystemDisplayId": "ERP-SYS-01"
82 },
83 "contractCategoryGroup": {
84 "id": 10000001,
85 "displayId": "sample_displayId",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "Sample Name"
93 },
94 "contractGroup1": {
95 "id": 400001,
96 "displayId": "CG1-01",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "Real Estate Contracts"
104 },
105 "contractGroup2": {
106 "id": 500001,
107 "displayId": "CG2-01",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "Equipment Leasing Contracts"
115 },
116 "group3": "Group3-Value",
117 "group4": "Group4-Value",
118 "signingPerson": "John Doe",
119 "placeOfSignature": "Montreal, Canada",
120 "dateOfSignature": "2019-08-24T14:15:22Z",
121 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
122 "numberRangeIdentifierValue": "0001",
123 "numberRangeIdentifierType": {
124 "name": "COMPANY_CODE"
125 },
126 "numberRangeType": {
127 "name": "CONTRACT"
128 },
129 "allowsSystemGenerateNewId": true
130 },
131 "currency": {
132 "id": 840,
133 "displayId": "USD",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "United States Dollar",
141 "decimalPoints": 2
142 },
143 "companyCurrency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "indexedCurrency": true,
156 "assetValueCurrencyType": "CONTRACT_CURRENCY",
157 "currencyLocked": true,
158 "leaseArea": {
159 "id": 10000001,
160 "displayId": "0001",
161 "status": {
162 "name": "ACTIVE",
163 "captionKey": "enum.objectStatus.active",
164 "active": true,
165 "caption": "Active"
166 },
167 "name": "Global Lease Area"
168 },
169 "businessUnit": {
170 "id": 10000001,
171 "displayId": "BU0001",
172 "status": {
173 "name": "ACTIVE",
174 "captionKey": "enum.objectStatus.active",
175 "active": true,
176 "caption": "Active"
177 },
178 "name": "North America Business Unit"
179 },
180 "businessUnitLocked": true,
181 "companyCode": {
182 "id": 10000006,
183 "displayId": "1005",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "erpSystemId": 10000001,
191 "erpSystemDisplayId": "FINQ8S-300",
192 "countryId": 10000095,
193 "countryDisplayId": "CA",
194 "name": "string",
195 "postingPeriodVariantId": 0,
196 "fiscalVariantId": 0
197 },
198 "companyCodeLocked": true,
199 "department": {
200 "id": 300001,
201 "displayId": "DEP-01",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "Finance Department"
209 },
210 "departmentLocked": true,
211 "leaseGroup": {
212 "id": 60000001,
213 "displayId": "LG-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Global Lease Group"
221 },
222 "leaseGroupLocked": true,
223 "subleasingInternalAssetClass": {
224 "id": 10000001,
225 "displayId": "IAC-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Machinery and Equipment",
233 "assetClassType": "PROPERTY",
234 "infiniteUsefulLife": false
235 },
236 "contractGroup1": {
237 "id": 400001,
238 "displayId": "CG1-01",
239 "status": {
240 "name": "ACTIVE",
241 "captionKey": "enum.objectStatus.active",
242 "active": true,
243 "caption": "Active"
244 },
245 "name": "Real Estate Contracts"
246 },
247 "contractGroup2": {
248 "id": 500001,
249 "displayId": "CG2-01",
250 "status": {
251 "name": "ACTIVE",
252 "captionKey": "enum.objectStatus.active",
253 "active": true,
254 "caption": "Active"
255 },
256 "name": "Equipment Leasing Contracts"
257 },
258 "subleasing": false,
259 "subleasingContractRevisionInfo": {
260 "id": 50000001,
261 "contractId": 40000001,
262 "contractDisplayId": "CTR-0001",
263 "contractName": "Sublease Agreement for Office Space"
264 },
265 "subleasingLeaseComponentRevisionInfo": {
266 "id": 61000001,
267 "leaseComponentId": 80000001,
268 "leaseComponentDisplayId": "LC-0001",
269 "leaseComponentName": "Vehicle Lease Component"
270 },
271 "subleasingActivationGroupRevisionInfo": {
272 "id": 60000001,
273 "activationGroupId": 70000001,
274 "activationGroupDisplayId": "AG-001",
275 "activationGroupName": "Office Equipment Activation Group"
276 },
277 "notifications": [
278 {
279 "id": 10000001,
280 "topic": {
281 "enCaption": "Lease Component Updated",
282 "frCaption": "Composant de bail mis à jour",
283 "name": "LEASE_COMPONENT_UPDATED",
284 "priority": "HIGH"
285 },
286 "username": "super.admin@nakisa.com",
287 "contractId": 10000001,
288 "contractDisplayId": "CT-100000000",
289 "targetId": "CT-100000000",
290 "targetType": "CONTRACT"
291 }
292 ],
293 "masterAgreementId": 10000001,
294 "masterAgreementDisplayId": "string",
295 "allowsSystemGenerateNewId": true,
296 "transferInfo": {
297 "transferredFromDisplayId": "CTR-00012",
298 "transferredFromRevisionId": 20000001,
299 "transferredToDisplayId": "CTR-00015",
300 "transferredToRevisionId": 20000005
301 },
302 "numberRangeIdentifierValue": "",
303 "numberRangeIdentifierType": {
304 "name": "COMPANY_CODE"
305 },
306 "numberRangeType": {
307 "name": "CONTRACT"
308 }
309 }
310 ]
311}
Get Contract Revisions¶
HTTP Request
GET /api/v1/contracts/{id}/revisions
📋 Description: Retrieves the revision history for a specific contract identified by its unique ID, providing insights into changes made over time that impact lease management and financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
pageable |
query |
false |
Indicates whether the response should be paginated, allowing users to efficiently retrieve multiple revisions of a contract within the Nakisa Lease Accounting Suite. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved list of revisions. |
Example Responses
1{
2 "totalElements": 150,
3 "totalPages": 15,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000008,
21 "displayId": "CR-0001",
22 "name": "Initial Revision",
23 "inception": "2019-08-24",
24 "revisionType": "ACTIVE",
25 "state": "LC_DEFINE",
26 "approvedBy": "manager.user@company.com",
27 "approvedAt": "2019-08-24T14:15:22Z",
28 "parentRevisionId": 10000010,
29 "approverComment": "Approved with changes.",
30 "contractId": 20000001,
31 "contractDisplayId": "C-0001",
32 "contractName": "Office Lease Contract",
33 "principalPositionType": {
34 "name": "LESSEE",
35 "captionKey": "enum.principalpositiontype.lessee",
36 "caption": "Lessee"
37 },
38 "mlaId": 30000001,
39 "companyId": 40000001,
40 "description": "Revision to adjust payment terms.",
41 "externalReference": "EXT-REF-001",
42 "internalReference": "INT-REF-001",
43 "formOfLease": "FULL",
44 "jointVentureLeaseType": "GROSS_LEASE",
45 "businessPlace": "New York Office",
46 "tradingPartner": {
47 "id": 50000001,
48 "displayId": "TP-0001",
49 "status": {
50 "name": "ACTIVE",
51 "captionKey": "enum.objectStatus.active",
52 "active": true,
53 "caption": "Active"
54 },
55 "name": "ABC Real Estate Partners",
56 "erpSystemId": 60000001,
57 "erpSystemDisplayId": "ERP-SYS-01"
58 },
59 "contractCategoryGroup": {
60 "id": 10000001,
61 "displayId": "sample_displayId",
62 "status": {
63 "name": "ACTIVE",
64 "captionKey": "enum.objectStatus.active",
65 "active": true,
66 "caption": "Active"
67 },
68 "name": "Sample Name"
69 },
70 "contractGroup1": {
71 "id": 400001,
72 "displayId": "CG1-01",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "Real Estate Contracts"
80 },
81 "contractGroup2": {
82 "id": 500001,
83 "displayId": "CG2-01",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "name": "Equipment Leasing Contracts"
91 },
92 "group3": "Group3-Value",
93 "group4": "Group4-Value",
94 "signingPerson": "John Doe",
95 "placeOfSignature": "Montreal, Canada",
96 "dateOfSignature": "2019-08-24T14:15:22Z",
97 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
98 "numberRangeIdentifierValue": "0001",
99 "numberRangeIdentifierType": {
100 "name": "COMPANY_CODE"
101 },
102 "numberRangeType": {
103 "name": "CONTRACT"
104 },
105 "allowsSystemGenerateNewId": true
106 }
107 ],
108 "number": 0,
109 "sort": {
110 "unsorted": false,
111 "sorted": true,
112 "empty": false
113 },
114 "first": true,
115 "last": false,
116 "empty": false
117}
Get Contract By ID (With Revision And Revision ID)¶
HTTP Request
GET /api/v1/contracts/revision/{revisionId}
📋 Description: Retrieves the details of a specific contract revision identified by the provided revision ID, facilitating effective management of lease agreements and associated financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
revisionId |
path |
integer |
true |
Unique identifier for the revision |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
revisionId |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved contract |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000018,
8 "displayId": "CT-100001000",
9 "name": "Testtt Contract",
10 "principalPositionType": {
11 "name": "LESSEE",
12 "captionKey": "enum.principalpositiontype.lessee",
13 "caption": "Lessee"
14 },
15 "validFrom": "2019-08-24",
16 "validTo": "2019-08-24",
17 "amendmentDate": "2019-08-24",
18 "approverComment": "string",
19 "contractPhase": "INITIAL",
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "leaseType": {
37 "name": "LEASE_CONTRACT_FIX",
38 "captionKey": "enum.leaseType.fix",
39 "principalPositionType": "LESSEE",
40 "caption": "Fixed Lease Contract"
41 },
42 "revision": {
43 "id": 10000008,
44 "displayId": "CR-0001",
45 "name": "Initial Revision",
46 "inception": "2019-08-24",
47 "revisionType": "ACTIVE",
48 "state": "LC_DEFINE",
49 "approvedBy": "manager.user@company.com",
50 "approvedAt": "2019-08-24T14:15:22Z",
51 "parentRevisionId": 10000010,
52 "approverComment": "Approved with changes.",
53 "contractId": 20000001,
54 "contractDisplayId": "C-0001",
55 "contractName": "Office Lease Contract",
56 "principalPositionType": {
57 "name": "LESSEE",
58 "captionKey": "enum.principalpositiontype.lessee",
59 "caption": "Lessee"
60 },
61 "mlaId": 30000001,
62 "companyId": 40000001,
63 "description": "Revision to adjust payment terms.",
64 "externalReference": "EXT-REF-001",
65 "internalReference": "INT-REF-001",
66 "formOfLease": "FULL",
67 "jointVentureLeaseType": "GROSS_LEASE",
68 "businessPlace": "New York Office",
69 "tradingPartner": {
70 "id": 50000001,
71 "displayId": "TP-0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "ABC Real Estate Partners",
79 "erpSystemId": 60000001,
80 "erpSystemDisplayId": "ERP-SYS-01"
81 },
82 "contractCategoryGroup": {
83 "id": 10000001,
84 "displayId": "sample_displayId",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Sample Name"
92 },
93 "contractGroup1": {
94 "id": 400001,
95 "displayId": "CG1-01",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Real Estate Contracts"
103 },
104 "contractGroup2": {
105 "id": 500001,
106 "displayId": "CG2-01",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Equipment Leasing Contracts"
114 },
115 "group3": "Group3-Value",
116 "group4": "Group4-Value",
117 "signingPerson": "John Doe",
118 "placeOfSignature": "Montreal, Canada",
119 "dateOfSignature": "2019-08-24T14:15:22Z",
120 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
121 "numberRangeIdentifierValue": "0001",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeType": {
126 "name": "CONTRACT"
127 },
128 "allowsSystemGenerateNewId": true
129 },
130 "currency": {
131 "id": 840,
132 "displayId": "USD",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "United States Dollar",
140 "decimalPoints": 2
141 },
142 "companyCurrency": {
143 "id": 840,
144 "displayId": "USD",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "United States Dollar",
152 "decimalPoints": 2
153 },
154 "indexedCurrency": true,
155 "assetValueCurrencyType": "CONTRACT_CURRENCY",
156 "currencyLocked": true,
157 "leaseArea": {
158 "id": 10000001,
159 "displayId": "0001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Global Lease Area"
167 },
168 "businessUnit": {
169 "id": 10000001,
170 "displayId": "BU0001",
171 "status": {
172 "name": "ACTIVE",
173 "captionKey": "enum.objectStatus.active",
174 "active": true,
175 "caption": "Active"
176 },
177 "name": "North America Business Unit"
178 },
179 "businessUnitLocked": true,
180 "companyCode": {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "name": "string",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierValue": "",
302 "numberRangeIdentifierType": {
303 "name": "COMPANY_CODE"
304 },
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309}