Mass Indexation Job¶
Mass Indexation Job - Get¶
HTTP Request
GET /api/v1/batch/mass-indexation/jobs/{id}
📋 Description: Retrieves the details of a specific mass indexation job by its unique identifier, facilitating the management of lease contracts and associated financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "taskCount": 0,
9 "failedTaskCount": 0,
10 "doneTaskCount": 0,
11 "inProgressTaskCount": 0,
12 "cancelledTaskCount": 0,
13 "errorMessage": "string",
14 "queueTime": "2019-08-24T14:15:22Z",
15 "startTime": "2019-08-24T14:15:22Z",
16 "endTime": "2019-08-24T14:15:22Z",
17 "status": "CREATED",
18 "executor": "SCHEDULER",
19 "scheduleJobId": 0,
20 "batchSize": 10,
21 "totalObjectCount": 0,
22 "readOnly": true,
23 "profileId": 0,
24 "filter": {
25 "id": 70000001,
26 "profileId": 20000001,
27 "jobId": 10000001,
28 "name": "US Leases Filter",
29 "principalPositionType": {
30 "name": "LESSEE",
31 "captionKey": "enum.principalpositiontype.lessee",
32 "caption": "Lessee"
33 },
34 "filterObject": {
35 "erpSystemFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "erpSystems": [
41 {
42 "id": 10000001,
43 "displayId": "ERP-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "SAP Production System",
51 "type": {
52 "name": "NAKISA",
53 "captionKey": "enum.erpSystemType.NAKISA",
54 "caption": "NAKISA"
55 },
56 "sapVersion": {
57 "name": "ECC_EHP5",
58 "captionKey": "enum.sapVersion.ECC_EHP5",
59 "caption": "ECC_EHP5"
60 }
61 }
62 ],
63 "leaseAreaFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseAreas": [
69 {
70 "id": 10000001,
71 "displayId": "0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "Global Lease Area"
79 }
80 ],
81 "businessUnitFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "businessUnits": [
87 {
88 "id": 10000001,
89 "displayId": "BU0001",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "North America Business Unit"
97 }
98 ],
99 "companyFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "companies": [
105 {
106 "id": 10000006,
107 "displayId": "1005",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "erpSystemId": 10000001,
115 "erpSystemDisplayId": "FINQ8S-300",
116 "countryId": 10000095,
117 "countryDisplayId": "CA",
118 "name": "string",
119 "postingPeriodVariantId": 0,
120 "fiscalVariantId": 0
121 }
122 ],
123 "leaseDepartmentFilterType": {
124 "name": "ALL",
125 "captionKey": "enum.filterType.all",
126 "caption": "All"
127 },
128 "leaseDepartments": [
129 {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 }
140 ],
141 "leaseGroupFilterType": {
142 "name": "ALL",
143 "captionKey": "enum.filterType.all",
144 "caption": "All"
145 },
146 "leaseGroups": [
147 {
148 "id": 60000001,
149 "displayId": "LG-001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "Global Lease Group"
157 }
158 ],
159 "costCenterFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A",
175 "erpSystemId": 0
176 }
177 ],
178 "profitCenterFilterType": {
179 "name": "ALL",
180 "captionKey": "enum.filterType.all",
181 "caption": "All"
182 },
183 "profitCenters": [
184 {
185 "id": 9001,
186 "displayId": "PC-001",
187 "status": {
188 "name": "ACTIVE",
189 "captionKey": "enum.objectStatus.active",
190 "active": true,
191 "caption": "Active"
192 },
193 "name": "North Region Profit Center",
194 "validTo": "2025-12-31",
195 "erpSystemId": 101,
196 "erpSystemDisplayId": "SAP-01"
197 }
198 ],
199 "wbsFilterType": {
200 "name": "ALL",
201 "captionKey": "enum.filterType.all",
202 "caption": "All"
203 },
204 "wbses": [
205 {
206 "id": 1001,
207 "displayId": "WBS-2025-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Main Project WBS",
215 "erpSystemId": 0
216 }
217 ],
218 "businessAreaFilterType": {
219 "name": "ALL",
220 "captionKey": "enum.filterType.all",
221 "caption": "All"
222 },
223 "businessAreas": [
224 {
225 "id": 3001,
226 "displayId": "BA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "North America Operations",
234 "erpSystemId": 0
235 }
236 ],
237 "functionalAreaFilterType": {
238 "name": "ALL",
239 "captionKey": "enum.filterType.all",
240 "caption": "All"
241 },
242 "functionalAreas": [
243 {
244 "id": 2001,
245 "displayId": "FA-2025-001",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "name": "Accounting Department",
253 "erpSystemId": 0
254 }
255 ]
256 }
257 },
258 "input": {
259 "id": 30000001,
260 "jobIndexationType": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "jobIndexationTypeNonLease": {
266 "name": "CPI_LOCAL",
267 "captionKey": "enum.jobIndexationType.cpiLocal",
268 "caption": "CPI Local"
269 },
270 "modificationDateType": {
271 "name": "JOB_DATE",
272 "captionKey": "enum.modificationDateType.jobDate",
273 "caption": "Job Date"
274 },
275 "modificationDate": "2024-12-01",
276 "referenceDateType": {
277 "name": "MODIFICATION_DATE",
278 "captionKey": "enum.referenceDateType.modificationDate",
279 "caption": "Modification Date"
280 },
281 "referenceDate": "2024-12-01",
282 "referenceDateTypeNonLease": {
283 "name": "MODIFICATION_DATE",
284 "captionKey": "enum.referenceDateType.modificationDate",
285 "caption": "Modification Date"
286 },
287 "referenceDateNonLease": "2024-12-01",
288 "indexLevelType": {
289 "name": "RATE",
290 "captionKey": "enum.indexLevelType.rate",
291 "caption": "Rate"
292 },
293 "newIndexLevel": 105.5,
294 "indexLevelTypeNonLease": {
295 "name": "RATE",
296 "captionKey": "enum.indexLevelType.rate",
297 "caption": "Rate"
298 },
299 "newIndexLevelNonLease": 103.2,
300 "indexationDateType": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationDateTypeNonLease": {
306 "name": "ROU_ANNIVERSARY_DATE",
307 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
308 "caption": "ROU Anniversary Date"
309 },
310 "indexationStartDate": "2024-12-01",
311 "indexationStartDateNonLease": "2024-12-01",
312 "postingDateType": {
313 "name": "JOB_DATE",
314 "captionKey": "enum.postingDateType.jobDate",
315 "caption": "Job Date"
316 },
317 "postingDate": "2024-12-01",
318 "documentDate": "2024-12-01",
319 "translationDate": "2024-12-01",
320 "indexationTreatmentType": {
321 "name": "DEFAULT",
322 "captionKey": "enum.indexationTreatmentType.default",
323 "caption": "Default"
324 },
325 "skipActivationGroupsWithOpenDraft": true,
326 "migratedFilterType": {
327 "name": "ALL",
328 "captionKey": "enum.migratedFilterType.all",
329 "caption": "All"
330 },
331 "overrideCPICategoryInputs": [
332 {
333 "consumerPriceIndexCategoryId": 40000001,
334 "consumerPriceIndexCategoryIdNonLease": 40000002,
335 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
336 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
337 "modificationDateType": {
338 "name": "JOB_DATE",
339 "captionKey": "enum.modificationDateType.jobDate",
340 "caption": "Job Date"
341 },
342 "modificationDate": "2024-12-01",
343 "referenceDateType": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDateTypeNonLease": {
349 "name": "MODIFICATION_DATE",
350 "captionKey": "enum.referenceDateType.modificationDate",
351 "caption": "Modification Date"
352 },
353 "referenceDate": "2024-12-01",
354 "referenceDateNonLease": "2024-12-01",
355 "postingDateType": {
356 "name": "JOB_DATE",
357 "captionKey": "enum.postingDateType.jobDate",
358 "caption": "Job Date"
359 },
360 "postingDate": "2024-12-01",
361 "documentDate": "2024-12-01",
362 "translationDate": "2024-12-01"
363 }
364 ],
365 "revert": false,
366 "reversalReason": {
367 "id": 50000001,
368 "displayId": "REV-001",
369 "status": {
370 "name": "ACTIVE",
371 "captionKey": "enum.objectStatus.active",
372 "active": true,
373 "caption": "Active"
374 },
375 "name": "Incorrect Indexation",
376 "erpSystemId": 60000001,
377 "erpSystemDisplayId": "SAP-PROD"
378 },
379 "assetClassFilterType": {
380 "name": "ALL",
381 "captionKey": "enum.assetClassFilterType.all",
382 "caption": "All"
383 },
384 "assetClasses": [
385 {
386 "id": 10000001,
387 "displayId": "IAC-001",
388 "status": {
389 "name": "ACTIVE",
390 "captionKey": "enum.objectStatus.active",
391 "active": true,
392 "caption": "Active"
393 },
394 "name": "Machinery and Equipment",
395 "assetClassType": "PROPERTY",
396 "infiniteUsefulLife": false
397 }
398 ],
399 "cpiCategoryFilterType": {
400 "name": "ALL",
401 "captionKey": "enum.cpiCategoryFilterType.all",
402 "caption": "All"
403 },
404 "cpiCategories": [
405 {
406 "id": 101,
407 "displayId": "CPI-2025-001",
408 "status": {
409 "name": "ACTIVE",
410 "captionKey": "enum.objectStatus.active",
411 "active": true,
412 "caption": "Active"
413 },
414 "name": "Consumer Price Index - City A",
415 "city": "New York",
416 "country": "USA",
417 "province": "NY",
418 "erpSystemId": 0
419 }
420 ],
421 "listObjectType": {
422 "name": "CONTRACT",
423 "captionKey": "enum.listObjectType.contract",
424 "caption": "Contract"
425 },
426 "objectList": [
427 {
428 "id": 10000001,
429 "displayId": "ENT-001",
430 "name": "Entity Name"
431 }
432 ]
433 },
434 "tasks": [
435 {
436 "id": 10000001,
437 "queueTime": "2025-01-01T10:00:00Z",
438 "startTime": "2025-01-01T10:00:00Z",
439 "endTime": "2025-01-01T10:00:00Z",
440 "interruptedAt": "2025-01-01T10:00:00Z",
441 "recoveredAt": "2025-01-01T10:00:00Z",
442 "status": {
443 "name": "PROCESSING",
444 "captionKey": "enum.batchJobStatus.processing",
445 "caption": "Processing"
446 },
447 "recover": false,
448 "interrupted": false,
449 "interruptionMessage": "sample_interruptionMessage",
450 "errorMessage": "sample_errorMessage",
451 "totalObjectCount": 100,
452 "jobId": 10000001,
453 "batchTaskObjectType": {
454 "name": "CONTRACT",
455 "captionKey": "enum.objectType.contract",
456 "caption": "Contract"
457 },
458 "objectIds": [],
459 "failedObjectIds": [],
460 "taskReport": {
461 "id": 10000001,
462 "scheduledItemCount": 100,
463 "processingItemCount": 100,
464 "doneItemCount": 100,
465 "failedItemCount": 100,
466 "cancelledItemCount": 100,
467 "skippedItemCount": 100,
468 "totalItemCount": 100,
469 "taskId": 10000001
470 }
471 }
472 ]
473 }
474}
Mass Indexation Job - Update¶
HTTP Request
PUT /api/v1/batch/mass-indexation/jobs/{id}
📋 Description: Updates the status or details of a specific mass indexation job identified by its ID within the Nakisa Lease Accounting Suite, facilitating the management of lease and contract-related financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the mass indexation job details, including lease, contract, and financial obligation information necessary for updating accounting entries. |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "filter": {
20 "id": 70000001,
21 "profileId": 20000001,
22 "jobId": 10000001,
23 "name": "US Leases Filter",
24 "principalPositionType": {
25 "name": "LESSEE",
26 "captionKey": "enum.principalpositiontype.lessee",
27 "caption": "Lessee"
28 },
29 "filterObject": {
30 "erpSystemFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "erpSystems": [
36 {
37 "id": 10000001,
38 "displayId": "ERP-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "SAP Production System",
46 "type": {
47 "name": "NAKISA",
48 "captionKey": "enum.erpSystemType.NAKISA",
49 "caption": "NAKISA"
50 },
51 "sapVersion": {
52 "name": "ECC_EHP5",
53 "captionKey": "enum.sapVersion.ECC_EHP5",
54 "caption": "ECC_EHP5"
55 }
56 }
57 ],
58 "leaseAreaFilterType": {
59 "name": "ALL",
60 "captionKey": "enum.filterType.all",
61 "caption": "All"
62 },
63 "leaseAreas": [
64 {
65 "id": 10000001,
66 "displayId": "0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Global Lease Area"
74 }
75 ],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [
82 {
83 "id": 10000001,
84 "displayId": "BU0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "North America Business Unit"
92 }
93 ],
94 "companyFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "companies": [
100 {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 }
117 ],
118 "leaseDepartmentFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "leaseDepartments": [
124 {
125 "id": 300001,
126 "displayId": "DEP-01",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "Finance Department"
134 }
135 ],
136 "leaseGroupFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "leaseGroups": [
142 {
143 "id": 60000001,
144 "displayId": "LG-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Global Lease Group"
152 }
153 ],
154 "costCenterFilterType": {
155 "name": "ALL",
156 "captionKey": "enum.filterType.all",
157 "caption": "All"
158 },
159 "costCenters": [
160 {
161 "id": 14001,
162 "displayId": "CC-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Cost Center A",
170 "erpSystemId": 0
171 }
172 ],
173 "profitCenterFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "wbses": [
200 {
201 "id": 1001,
202 "displayId": "WBS-2025-001",
203 "status": {
204 "name": "ACTIVE",
205 "captionKey": "enum.objectStatus.active",
206 "active": true,
207 "caption": "Active"
208 },
209 "name": "Main Project WBS",
210 "erpSystemId": 0
211 }
212 ],
213 "businessAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "businessAreas": [
219 {
220 "id": 3001,
221 "displayId": "BA-2025-001",
222 "status": {
223 "name": "ACTIVE",
224 "captionKey": "enum.objectStatus.active",
225 "active": true,
226 "caption": "Active"
227 },
228 "name": "North America Operations",
229 "erpSystemId": 0
230 }
231 ],
232 "functionalAreaFilterType": {
233 "name": "ALL",
234 "captionKey": "enum.filterType.all",
235 "caption": "All"
236 },
237 "functionalAreas": [
238 {
239 "id": 2001,
240 "displayId": "FA-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Accounting Department",
248 "erpSystemId": 0
249 }
250 ]
251 }
252 },
253 "input": {
254 "id": 30000001,
255 "jobIndexationType": {
256 "name": "CPI_LOCAL",
257 "captionKey": "enum.jobIndexationType.cpiLocal",
258 "caption": "CPI Local"
259 },
260 "jobIndexationTypeNonLease": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "modificationDateType": {
266 "name": "JOB_DATE",
267 "captionKey": "enum.modificationDateType.jobDate",
268 "caption": "Job Date"
269 },
270 "modificationDate": "2024-12-01",
271 "referenceDateType": {
272 "name": "MODIFICATION_DATE",
273 "captionKey": "enum.referenceDateType.modificationDate",
274 "caption": "Modification Date"
275 },
276 "referenceDate": "2024-12-01",
277 "referenceDateTypeNonLease": {
278 "name": "MODIFICATION_DATE",
279 "captionKey": "enum.referenceDateType.modificationDate",
280 "caption": "Modification Date"
281 },
282 "referenceDateNonLease": "2024-12-01",
283 "indexLevelType": {
284 "name": "RATE",
285 "captionKey": "enum.indexLevelType.rate",
286 "caption": "Rate"
287 },
288 "newIndexLevel": 105.5,
289 "indexLevelTypeNonLease": {
290 "name": "RATE",
291 "captionKey": "enum.indexLevelType.rate",
292 "caption": "Rate"
293 },
294 "newIndexLevelNonLease": 103.2,
295 "indexationDateType": {
296 "name": "ROU_ANNIVERSARY_DATE",
297 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
298 "caption": "ROU Anniversary Date"
299 },
300 "indexationDateTypeNonLease": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationStartDate": "2024-12-01",
306 "indexationStartDateNonLease": "2024-12-01",
307 "postingDateType": {
308 "name": "JOB_DATE",
309 "captionKey": "enum.postingDateType.jobDate",
310 "caption": "Job Date"
311 },
312 "postingDate": "2024-12-01",
313 "documentDate": "2024-12-01",
314 "translationDate": "2024-12-01",
315 "indexationTreatmentType": {
316 "name": "DEFAULT",
317 "captionKey": "enum.indexationTreatmentType.default",
318 "caption": "Default"
319 },
320 "skipActivationGroupsWithOpenDraft": true,
321 "migratedFilterType": {
322 "name": "ALL",
323 "captionKey": "enum.migratedFilterType.all",
324 "caption": "All"
325 },
326 "overrideCPICategoryInputs": [
327 {
328 "consumerPriceIndexCategoryId": 40000001,
329 "consumerPriceIndexCategoryIdNonLease": 40000002,
330 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
331 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
332 "modificationDateType": {
333 "name": "JOB_DATE",
334 "captionKey": "enum.modificationDateType.jobDate",
335 "caption": "Job Date"
336 },
337 "modificationDate": "2024-12-01",
338 "referenceDateType": {
339 "name": "MODIFICATION_DATE",
340 "captionKey": "enum.referenceDateType.modificationDate",
341 "caption": "Modification Date"
342 },
343 "referenceDateTypeNonLease": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDate": "2024-12-01",
349 "referenceDateNonLease": "2024-12-01",
350 "postingDateType": {
351 "name": "JOB_DATE",
352 "captionKey": "enum.postingDateType.jobDate",
353 "caption": "Job Date"
354 },
355 "postingDate": "2024-12-01",
356 "documentDate": "2024-12-01",
357 "translationDate": "2024-12-01"
358 }
359 ],
360 "revert": false,
361 "reversalReason": {
362 "id": 50000001,
363 "displayId": "REV-001",
364 "status": {
365 "name": "ACTIVE",
366 "captionKey": "enum.objectStatus.active",
367 "active": true,
368 "caption": "Active"
369 },
370 "name": "Incorrect Indexation",
371 "erpSystemId": 60000001,
372 "erpSystemDisplayId": "SAP-PROD"
373 },
374 "assetClassFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.assetClassFilterType.all",
377 "caption": "All"
378 },
379 "assetClasses": [
380 {
381 "id": 10000001,
382 "displayId": "IAC-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Machinery and Equipment",
390 "assetClassType": "PROPERTY",
391 "infiniteUsefulLife": false
392 }
393 ],
394 "cpiCategoryFilterType": {
395 "name": "ALL",
396 "captionKey": "enum.cpiCategoryFilterType.all",
397 "caption": "All"
398 },
399 "cpiCategories": [
400 {
401 "id": 101,
402 "displayId": "CPI-2025-001",
403 "status": {
404 "name": "ACTIVE",
405 "captionKey": "enum.objectStatus.active",
406 "active": true,
407 "caption": "Active"
408 },
409 "name": "Consumer Price Index - City A",
410 "city": "New York",
411 "country": "USA",
412 "province": "NY",
413 "erpSystemId": 0
414 }
415 ],
416 "listObjectType": {
417 "name": "CONTRACT",
418 "captionKey": "enum.listObjectType.contract",
419 "caption": "Contract"
420 },
421 "objectList": [
422 {
423 "id": 10000001,
424 "displayId": "ENT-001",
425 "name": "Entity Name"
426 }
427 ]
428 },
429 "tasks": [
430 {
431 "id": 10000001,
432 "queueTime": "2025-01-01T10:00:00Z",
433 "startTime": "2025-01-01T10:00:00Z",
434 "endTime": "2025-01-01T10:00:00Z",
435 "interruptedAt": "2025-01-01T10:00:00Z",
436 "recoveredAt": "2025-01-01T10:00:00Z",
437 "status": {
438 "name": "PROCESSING",
439 "captionKey": "enum.batchJobStatus.processing",
440 "caption": "Processing"
441 },
442 "recover": false,
443 "interrupted": false,
444 "interruptionMessage": "sample_interruptionMessage",
445 "errorMessage": "sample_errorMessage",
446 "totalObjectCount": 100,
447 "jobId": 10000001,
448 "batchTaskObjectType": {
449 "name": "CONTRACT",
450 "captionKey": "enum.objectType.contract",
451 "caption": "Contract"
452 },
453 "objectIds": [],
454 "failedObjectIds": [],
455 "taskReport": {
456 "id": 10000001,
457 "scheduledItemCount": 100,
458 "processingItemCount": 100,
459 "doneItemCount": 100,
460 "failedItemCount": 100,
461 "cancelledItemCount": 100,
462 "skippedItemCount": 100,
463 "totalItemCount": 100,
464 "taskId": 10000001
465 }
466 }
467 ]
468}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "taskCount": 0,
9 "failedTaskCount": 0,
10 "doneTaskCount": 0,
11 "inProgressTaskCount": 0,
12 "cancelledTaskCount": 0,
13 "errorMessage": "string",
14 "queueTime": "2019-08-24T14:15:22Z",
15 "startTime": "2019-08-24T14:15:22Z",
16 "endTime": "2019-08-24T14:15:22Z",
17 "status": "CREATED",
18 "executor": "SCHEDULER",
19 "scheduleJobId": 0,
20 "batchSize": 10,
21 "totalObjectCount": 0,
22 "readOnly": true,
23 "profileId": 0,
24 "filter": {
25 "id": 70000001,
26 "profileId": 20000001,
27 "jobId": 10000001,
28 "name": "US Leases Filter",
29 "principalPositionType": {
30 "name": "LESSEE",
31 "captionKey": "enum.principalpositiontype.lessee",
32 "caption": "Lessee"
33 },
34 "filterObject": {
35 "erpSystemFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "erpSystems": [
41 {
42 "id": 10000001,
43 "displayId": "ERP-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "SAP Production System",
51 "type": {
52 "name": "NAKISA",
53 "captionKey": "enum.erpSystemType.NAKISA",
54 "caption": "NAKISA"
55 },
56 "sapVersion": {
57 "name": "ECC_EHP5",
58 "captionKey": "enum.sapVersion.ECC_EHP5",
59 "caption": "ECC_EHP5"
60 }
61 }
62 ],
63 "leaseAreaFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseAreas": [
69 {
70 "id": 10000001,
71 "displayId": "0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "Global Lease Area"
79 }
80 ],
81 "businessUnitFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "businessUnits": [
87 {
88 "id": 10000001,
89 "displayId": "BU0001",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "North America Business Unit"
97 }
98 ],
99 "companyFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "companies": [
105 {
106 "id": 10000006,
107 "displayId": "1005",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "erpSystemId": 10000001,
115 "erpSystemDisplayId": "FINQ8S-300",
116 "countryId": 10000095,
117 "countryDisplayId": "CA",
118 "name": "string",
119 "postingPeriodVariantId": 0,
120 "fiscalVariantId": 0
121 }
122 ],
123 "leaseDepartmentFilterType": {
124 "name": "ALL",
125 "captionKey": "enum.filterType.all",
126 "caption": "All"
127 },
128 "leaseDepartments": [
129 {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 }
140 ],
141 "leaseGroupFilterType": {
142 "name": "ALL",
143 "captionKey": "enum.filterType.all",
144 "caption": "All"
145 },
146 "leaseGroups": [
147 {
148 "id": 60000001,
149 "displayId": "LG-001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "Global Lease Group"
157 }
158 ],
159 "costCenterFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A",
175 "erpSystemId": 0
176 }
177 ],
178 "profitCenterFilterType": {
179 "name": "ALL",
180 "captionKey": "enum.filterType.all",
181 "caption": "All"
182 },
183 "profitCenters": [
184 {
185 "id": 9001,
186 "displayId": "PC-001",
187 "status": {
188 "name": "ACTIVE",
189 "captionKey": "enum.objectStatus.active",
190 "active": true,
191 "caption": "Active"
192 },
193 "name": "North Region Profit Center",
194 "validTo": "2025-12-31",
195 "erpSystemId": 101,
196 "erpSystemDisplayId": "SAP-01"
197 }
198 ],
199 "wbsFilterType": {
200 "name": "ALL",
201 "captionKey": "enum.filterType.all",
202 "caption": "All"
203 },
204 "wbses": [
205 {
206 "id": 1001,
207 "displayId": "WBS-2025-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Main Project WBS",
215 "erpSystemId": 0
216 }
217 ],
218 "businessAreaFilterType": {
219 "name": "ALL",
220 "captionKey": "enum.filterType.all",
221 "caption": "All"
222 },
223 "businessAreas": [
224 {
225 "id": 3001,
226 "displayId": "BA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "North America Operations",
234 "erpSystemId": 0
235 }
236 ],
237 "functionalAreaFilterType": {
238 "name": "ALL",
239 "captionKey": "enum.filterType.all",
240 "caption": "All"
241 },
242 "functionalAreas": [
243 {
244 "id": 2001,
245 "displayId": "FA-2025-001",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "name": "Accounting Department",
253 "erpSystemId": 0
254 }
255 ]
256 }
257 },
258 "input": {
259 "id": 30000001,
260 "jobIndexationType": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "jobIndexationTypeNonLease": {
266 "name": "CPI_LOCAL",
267 "captionKey": "enum.jobIndexationType.cpiLocal",
268 "caption": "CPI Local"
269 },
270 "modificationDateType": {
271 "name": "JOB_DATE",
272 "captionKey": "enum.modificationDateType.jobDate",
273 "caption": "Job Date"
274 },
275 "modificationDate": "2024-12-01",
276 "referenceDateType": {
277 "name": "MODIFICATION_DATE",
278 "captionKey": "enum.referenceDateType.modificationDate",
279 "caption": "Modification Date"
280 },
281 "referenceDate": "2024-12-01",
282 "referenceDateTypeNonLease": {
283 "name": "MODIFICATION_DATE",
284 "captionKey": "enum.referenceDateType.modificationDate",
285 "caption": "Modification Date"
286 },
287 "referenceDateNonLease": "2024-12-01",
288 "indexLevelType": {
289 "name": "RATE",
290 "captionKey": "enum.indexLevelType.rate",
291 "caption": "Rate"
292 },
293 "newIndexLevel": 105.5,
294 "indexLevelTypeNonLease": {
295 "name": "RATE",
296 "captionKey": "enum.indexLevelType.rate",
297 "caption": "Rate"
298 },
299 "newIndexLevelNonLease": 103.2,
300 "indexationDateType": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationDateTypeNonLease": {
306 "name": "ROU_ANNIVERSARY_DATE",
307 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
308 "caption": "ROU Anniversary Date"
309 },
310 "indexationStartDate": "2024-12-01",
311 "indexationStartDateNonLease": "2024-12-01",
312 "postingDateType": {
313 "name": "JOB_DATE",
314 "captionKey": "enum.postingDateType.jobDate",
315 "caption": "Job Date"
316 },
317 "postingDate": "2024-12-01",
318 "documentDate": "2024-12-01",
319 "translationDate": "2024-12-01",
320 "indexationTreatmentType": {
321 "name": "DEFAULT",
322 "captionKey": "enum.indexationTreatmentType.default",
323 "caption": "Default"
324 },
325 "skipActivationGroupsWithOpenDraft": true,
326 "migratedFilterType": {
327 "name": "ALL",
328 "captionKey": "enum.migratedFilterType.all",
329 "caption": "All"
330 },
331 "overrideCPICategoryInputs": [
332 {
333 "consumerPriceIndexCategoryId": 40000001,
334 "consumerPriceIndexCategoryIdNonLease": 40000002,
335 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
336 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
337 "modificationDateType": {
338 "name": "JOB_DATE",
339 "captionKey": "enum.modificationDateType.jobDate",
340 "caption": "Job Date"
341 },
342 "modificationDate": "2024-12-01",
343 "referenceDateType": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDateTypeNonLease": {
349 "name": "MODIFICATION_DATE",
350 "captionKey": "enum.referenceDateType.modificationDate",
351 "caption": "Modification Date"
352 },
353 "referenceDate": "2024-12-01",
354 "referenceDateNonLease": "2024-12-01",
355 "postingDateType": {
356 "name": "JOB_DATE",
357 "captionKey": "enum.postingDateType.jobDate",
358 "caption": "Job Date"
359 },
360 "postingDate": "2024-12-01",
361 "documentDate": "2024-12-01",
362 "translationDate": "2024-12-01"
363 }
364 ],
365 "revert": false,
366 "reversalReason": {
367 "id": 50000001,
368 "displayId": "REV-001",
369 "status": {
370 "name": "ACTIVE",
371 "captionKey": "enum.objectStatus.active",
372 "active": true,
373 "caption": "Active"
374 },
375 "name": "Incorrect Indexation",
376 "erpSystemId": 60000001,
377 "erpSystemDisplayId": "SAP-PROD"
378 },
379 "assetClassFilterType": {
380 "name": "ALL",
381 "captionKey": "enum.assetClassFilterType.all",
382 "caption": "All"
383 },
384 "assetClasses": [
385 {
386 "id": 10000001,
387 "displayId": "IAC-001",
388 "status": {
389 "name": "ACTIVE",
390 "captionKey": "enum.objectStatus.active",
391 "active": true,
392 "caption": "Active"
393 },
394 "name": "Machinery and Equipment",
395 "assetClassType": "PROPERTY",
396 "infiniteUsefulLife": false
397 }
398 ],
399 "cpiCategoryFilterType": {
400 "name": "ALL",
401 "captionKey": "enum.cpiCategoryFilterType.all",
402 "caption": "All"
403 },
404 "cpiCategories": [
405 {
406 "id": 101,
407 "displayId": "CPI-2025-001",
408 "status": {
409 "name": "ACTIVE",
410 "captionKey": "enum.objectStatus.active",
411 "active": true,
412 "caption": "Active"
413 },
414 "name": "Consumer Price Index - City A",
415 "city": "New York",
416 "country": "USA",
417 "province": "NY",
418 "erpSystemId": 0
419 }
420 ],
421 "listObjectType": {
422 "name": "CONTRACT",
423 "captionKey": "enum.listObjectType.contract",
424 "caption": "Contract"
425 },
426 "objectList": [
427 {
428 "id": 10000001,
429 "displayId": "ENT-001",
430 "name": "Entity Name"
431 }
432 ]
433 },
434 "tasks": [
435 {
436 "id": 10000001,
437 "queueTime": "2025-01-01T10:00:00Z",
438 "startTime": "2025-01-01T10:00:00Z",
439 "endTime": "2025-01-01T10:00:00Z",
440 "interruptedAt": "2025-01-01T10:00:00Z",
441 "recoveredAt": "2025-01-01T10:00:00Z",
442 "status": {
443 "name": "PROCESSING",
444 "captionKey": "enum.batchJobStatus.processing",
445 "caption": "Processing"
446 },
447 "recover": false,
448 "interrupted": false,
449 "interruptionMessage": "sample_interruptionMessage",
450 "errorMessage": "sample_errorMessage",
451 "totalObjectCount": 100,
452 "jobId": 10000001,
453 "batchTaskObjectType": {
454 "name": "CONTRACT",
455 "captionKey": "enum.objectType.contract",
456 "caption": "Contract"
457 },
458 "objectIds": [],
459 "failedObjectIds": [],
460 "taskReport": {
461 "id": 10000001,
462 "scheduledItemCount": 100,
463 "processingItemCount": 100,
464 "doneItemCount": 100,
465 "failedItemCount": 100,
466 "cancelledItemCount": 100,
467 "skippedItemCount": 100,
468 "totalItemCount": 100,
469 "taskId": 10000001
470 }
471 }
472 ]
473 }
474}
Mass Indexation Job - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/batch/mass-indexation/jobs/createOrUpdate/bulk
📋 Description: Creates or updates multiple mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries in bulk.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating lease contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "queueTime": "2019-08-24T14:15:22Z",
11 "startTime": "2019-08-24T14:15:22Z",
12 "endTime": "2019-08-24T14:15:22Z",
13 "status": "CREATED",
14 "executor": "SCHEDULER",
15 "scheduleJobId": 0,
16 "batchSize": 10,
17 "totalObjectCount": 0,
18 "readOnly": true,
19 "profileId": 0,
20 "filter": {
21 "id": 70000001,
22 "profileId": 20000001,
23 "jobId": 10000001,
24 "name": "US Leases Filter",
25 "principalPositionType": {
26 "name": "LESSEE",
27 "captionKey": "enum.principalpositiontype.lessee",
28 "caption": "Lessee"
29 },
30 "filterObject": {
31 "erpSystemFilterType": {
32 "name": "ALL",
33 "captionKey": "enum.filterType.all",
34 "caption": "All"
35 },
36 "erpSystems": [
37 {
38 "id": 10000001,
39 "displayId": "ERP-001",
40 "status": {
41 "name": "ACTIVE",
42 "captionKey": "enum.objectStatus.active",
43 "active": true,
44 "caption": "Active"
45 },
46 "name": "SAP Production System",
47 "type": {
48 "name": "NAKISA",
49 "captionKey": "enum.erpSystemType.NAKISA",
50 "caption": "NAKISA"
51 },
52 "sapVersion": {
53 "name": "ECC_EHP5",
54 "captionKey": "enum.sapVersion.ECC_EHP5",
55 "caption": "ECC_EHP5"
56 }
57 }
58 ],
59 "leaseAreaFilterType": {
60 "name": "ALL",
61 "captionKey": "enum.filterType.all",
62 "caption": "All"
63 },
64 "leaseAreas": [
65 {
66 "id": 10000001,
67 "displayId": "0001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "Global Lease Area"
75 }
76 ],
77 "businessUnitFilterType": {
78 "name": "ALL",
79 "captionKey": "enum.filterType.all",
80 "caption": "All"
81 },
82 "businessUnits": [
83 {
84 "id": 10000001,
85 "displayId": "BU0001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "North America Business Unit"
93 }
94 ],
95 "companyFilterType": {
96 "name": "ALL",
97 "captionKey": "enum.filterType.all",
98 "caption": "All"
99 },
100 "companies": [
101 {
102 "id": 10000006,
103 "displayId": "1005",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "erpSystemId": 10000001,
111 "erpSystemDisplayId": "FINQ8S-300",
112 "countryId": 10000095,
113 "countryDisplayId": "CA",
114 "name": "string",
115 "postingPeriodVariantId": 0,
116 "fiscalVariantId": 0
117 }
118 ],
119 "leaseDepartmentFilterType": {
120 "name": "ALL",
121 "captionKey": "enum.filterType.all",
122 "caption": "All"
123 },
124 "leaseDepartments": [
125 {
126 "id": 300001,
127 "displayId": "DEP-01",
128 "status": {
129 "name": "ACTIVE",
130 "captionKey": "enum.objectStatus.active",
131 "active": true,
132 "caption": "Active"
133 },
134 "name": "Finance Department"
135 }
136 ],
137 "leaseGroupFilterType": {
138 "name": "ALL",
139 "captionKey": "enum.filterType.all",
140 "caption": "All"
141 },
142 "leaseGroups": [
143 {
144 "id": 60000001,
145 "displayId": "LG-001",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "Global Lease Group"
153 }
154 ],
155 "costCenterFilterType": {
156 "name": "ALL",
157 "captionKey": "enum.filterType.all",
158 "caption": "All"
159 },
160 "costCenters": [
161 {
162 "id": 14001,
163 "displayId": "CC-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "Cost Center A",
171 "erpSystemId": 0
172 }
173 ],
174 "profitCenterFilterType": {
175 "name": "ALL",
176 "captionKey": "enum.filterType.all",
177 "caption": "All"
178 },
179 "profitCenters": [
180 {
181 "id": 9001,
182 "displayId": "PC-001",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "North Region Profit Center",
190 "validTo": "2025-12-31",
191 "erpSystemId": 101,
192 "erpSystemDisplayId": "SAP-01"
193 }
194 ],
195 "wbsFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "wbses": [
201 {
202 "id": 1001,
203 "displayId": "WBS-2025-001",
204 "status": {
205 "name": "ACTIVE",
206 "captionKey": "enum.objectStatus.active",
207 "active": true,
208 "caption": "Active"
209 },
210 "name": "Main Project WBS",
211 "erpSystemId": 0
212 }
213 ],
214 "businessAreaFilterType": {
215 "name": "ALL",
216 "captionKey": "enum.filterType.all",
217 "caption": "All"
218 },
219 "businessAreas": [
220 {
221 "id": 3001,
222 "displayId": "BA-2025-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "North America Operations",
230 "erpSystemId": 0
231 }
232 ],
233 "functionalAreaFilterType": {
234 "name": "ALL",
235 "captionKey": "enum.filterType.all",
236 "caption": "All"
237 },
238 "functionalAreas": [
239 {
240 "id": 2001,
241 "displayId": "FA-2025-001",
242 "status": {
243 "name": "ACTIVE",
244 "captionKey": "enum.objectStatus.active",
245 "active": true,
246 "caption": "Active"
247 },
248 "name": "Accounting Department",
249 "erpSystemId": 0
250 }
251 ]
252 }
253 },
254 "input": {
255 "id": 30000001,
256 "jobIndexationType": {
257 "name": "CPI_LOCAL",
258 "captionKey": "enum.jobIndexationType.cpiLocal",
259 "caption": "CPI Local"
260 },
261 "jobIndexationTypeNonLease": {
262 "name": "CPI_LOCAL",
263 "captionKey": "enum.jobIndexationType.cpiLocal",
264 "caption": "CPI Local"
265 },
266 "modificationDateType": {
267 "name": "JOB_DATE",
268 "captionKey": "enum.modificationDateType.jobDate",
269 "caption": "Job Date"
270 },
271 "modificationDate": "2024-12-01",
272 "referenceDateType": {
273 "name": "MODIFICATION_DATE",
274 "captionKey": "enum.referenceDateType.modificationDate",
275 "caption": "Modification Date"
276 },
277 "referenceDate": "2024-12-01",
278 "referenceDateTypeNonLease": {
279 "name": "MODIFICATION_DATE",
280 "captionKey": "enum.referenceDateType.modificationDate",
281 "caption": "Modification Date"
282 },
283 "referenceDateNonLease": "2024-12-01",
284 "indexLevelType": {
285 "name": "RATE",
286 "captionKey": "enum.indexLevelType.rate",
287 "caption": "Rate"
288 },
289 "newIndexLevel": 105.5,
290 "indexLevelTypeNonLease": {
291 "name": "RATE",
292 "captionKey": "enum.indexLevelType.rate",
293 "caption": "Rate"
294 },
295 "newIndexLevelNonLease": 103.2,
296 "indexationDateType": {
297 "name": "ROU_ANNIVERSARY_DATE",
298 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
299 "caption": "ROU Anniversary Date"
300 },
301 "indexationDateTypeNonLease": {
302 "name": "ROU_ANNIVERSARY_DATE",
303 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
304 "caption": "ROU Anniversary Date"
305 },
306 "indexationStartDate": "2024-12-01",
307 "indexationStartDateNonLease": "2024-12-01",
308 "postingDateType": {
309 "name": "JOB_DATE",
310 "captionKey": "enum.postingDateType.jobDate",
311 "caption": "Job Date"
312 },
313 "postingDate": "2024-12-01",
314 "documentDate": "2024-12-01",
315 "translationDate": "2024-12-01",
316 "indexationTreatmentType": {
317 "name": "DEFAULT",
318 "captionKey": "enum.indexationTreatmentType.default",
319 "caption": "Default"
320 },
321 "skipActivationGroupsWithOpenDraft": true,
322 "migratedFilterType": {
323 "name": "ALL",
324 "captionKey": "enum.migratedFilterType.all",
325 "caption": "All"
326 },
327 "overrideCPICategoryInputs": [
328 {
329 "consumerPriceIndexCategoryId": 40000001,
330 "consumerPriceIndexCategoryIdNonLease": 40000002,
331 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
332 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
333 "modificationDateType": {
334 "name": "JOB_DATE",
335 "captionKey": "enum.modificationDateType.jobDate",
336 "caption": "Job Date"
337 },
338 "modificationDate": "2024-12-01",
339 "referenceDateType": {
340 "name": "MODIFICATION_DATE",
341 "captionKey": "enum.referenceDateType.modificationDate",
342 "caption": "Modification Date"
343 },
344 "referenceDateTypeNonLease": {
345 "name": "MODIFICATION_DATE",
346 "captionKey": "enum.referenceDateType.modificationDate",
347 "caption": "Modification Date"
348 },
349 "referenceDate": "2024-12-01",
350 "referenceDateNonLease": "2024-12-01",
351 "postingDateType": {
352 "name": "JOB_DATE",
353 "captionKey": "enum.postingDateType.jobDate",
354 "caption": "Job Date"
355 },
356 "postingDate": "2024-12-01",
357 "documentDate": "2024-12-01",
358 "translationDate": "2024-12-01"
359 }
360 ],
361 "revert": false,
362 "reversalReason": {
363 "id": 50000001,
364 "displayId": "REV-001",
365 "status": {
366 "name": "ACTIVE",
367 "captionKey": "enum.objectStatus.active",
368 "active": true,
369 "caption": "Active"
370 },
371 "name": "Incorrect Indexation",
372 "erpSystemId": 60000001,
373 "erpSystemDisplayId": "SAP-PROD"
374 },
375 "assetClassFilterType": {
376 "name": "ALL",
377 "captionKey": "enum.assetClassFilterType.all",
378 "caption": "All"
379 },
380 "assetClasses": [
381 {
382 "id": 10000001,
383 "displayId": "IAC-001",
384 "status": {
385 "name": "ACTIVE",
386 "captionKey": "enum.objectStatus.active",
387 "active": true,
388 "caption": "Active"
389 },
390 "name": "Machinery and Equipment",
391 "assetClassType": "PROPERTY",
392 "infiniteUsefulLife": false
393 }
394 ],
395 "cpiCategoryFilterType": {
396 "name": "ALL",
397 "captionKey": "enum.cpiCategoryFilterType.all",
398 "caption": "All"
399 },
400 "cpiCategories": [
401 {
402 "id": 101,
403 "displayId": "CPI-2025-001",
404 "status": {
405 "name": "ACTIVE",
406 "captionKey": "enum.objectStatus.active",
407 "active": true,
408 "caption": "Active"
409 },
410 "name": "Consumer Price Index - City A",
411 "city": "New York",
412 "country": "USA",
413 "province": "NY",
414 "erpSystemId": 0
415 }
416 ],
417 "listObjectType": {
418 "name": "CONTRACT",
419 "captionKey": "enum.listObjectType.contract",
420 "caption": "Contract"
421 },
422 "objectList": [
423 {
424 "id": 10000001,
425 "displayId": "ENT-001",
426 "name": "Entity Name"
427 }
428 ]
429 },
430 "tasks": [
431 {
432 "id": 10000001,
433 "queueTime": "2025-01-01T10:00:00Z",
434 "startTime": "2025-01-01T10:00:00Z",
435 "endTime": "2025-01-01T10:00:00Z",
436 "interruptedAt": "2025-01-01T10:00:00Z",
437 "recoveredAt": "2025-01-01T10:00:00Z",
438 "status": {
439 "name": "PROCESSING",
440 "captionKey": "enum.batchJobStatus.processing",
441 "caption": "Processing"
442 },
443 "recover": false,
444 "interrupted": false,
445 "interruptionMessage": "sample_interruptionMessage",
446 "errorMessage": "sample_errorMessage",
447 "totalObjectCount": 100,
448 "jobId": 10000001,
449 "batchTaskObjectType": {
450 "name": "CONTRACT",
451 "captionKey": "enum.objectType.contract",
452 "caption": "Contract"
453 },
454 "objectIds": [],
455 "failedObjectIds": [],
456 "taskReport": {
457 "id": 10000001,
458 "scheduledItemCount": 100,
459 "processingItemCount": 100,
460 "doneItemCount": 100,
461 "failedItemCount": 100,
462 "cancelledItemCount": 100,
463 "skippedItemCount": 100,
464 "totalItemCount": 100,
465 "taskId": 10000001
466 }
467 }
468 ]
469 }
470]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 0,
9 "taskCount": 0,
10 "failedTaskCount": 0,
11 "doneTaskCount": 0,
12 "inProgressTaskCount": 0,
13 "cancelledTaskCount": 0,
14 "errorMessage": "string",
15 "queueTime": "2019-08-24T14:15:22Z",
16 "startTime": "2019-08-24T14:15:22Z",
17 "endTime": "2019-08-24T14:15:22Z",
18 "status": "CREATED",
19 "executor": "SCHEDULER",
20 "scheduleJobId": 0,
21 "batchSize": 10,
22 "totalObjectCount": 0,
23 "readOnly": true,
24 "profileId": 0,
25 "filter": {
26 "id": 70000001,
27 "profileId": 20000001,
28 "jobId": 10000001,
29 "name": "US Leases Filter",
30 "principalPositionType": {
31 "name": "LESSEE",
32 "captionKey": "enum.principalpositiontype.lessee",
33 "caption": "Lessee"
34 },
35 "filterObject": {
36 "erpSystemFilterType": {
37 "name": "ALL",
38 "captionKey": "enum.filterType.all",
39 "caption": "All"
40 },
41 "erpSystems": [
42 {
43 "id": 10000001,
44 "displayId": "ERP-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "SAP Production System",
52 "type": {
53 "name": "NAKISA",
54 "captionKey": "enum.erpSystemType.NAKISA",
55 "caption": "NAKISA"
56 },
57 "sapVersion": {
58 "name": "ECC_EHP5",
59 "captionKey": "enum.sapVersion.ECC_EHP5",
60 "caption": "ECC_EHP5"
61 }
62 }
63 ],
64 "leaseAreaFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "leaseAreas": [
70 {
71 "id": 10000001,
72 "displayId": "0001",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "Global Lease Area"
80 }
81 ],
82 "businessUnitFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "businessUnits": [
88 {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 }
99 ],
100 "companyFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "companies": [
106 {
107 "id": 10000006,
108 "displayId": "1005",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "erpSystemId": 10000001,
116 "erpSystemDisplayId": "FINQ8S-300",
117 "countryId": 10000095,
118 "countryDisplayId": "CA",
119 "name": "string",
120 "postingPeriodVariantId": 0,
121 "fiscalVariantId": 0
122 }
123 ],
124 "leaseDepartmentFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "leaseDepartments": [
130 {
131 "id": 300001,
132 "displayId": "DEP-01",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "Finance Department"
140 }
141 ],
142 "leaseGroupFilterType": {
143 "name": "ALL",
144 "captionKey": "enum.filterType.all",
145 "caption": "All"
146 },
147 "leaseGroups": [
148 {
149 "id": 60000001,
150 "displayId": "LG-001",
151 "status": {
152 "name": "ACTIVE",
153 "captionKey": "enum.objectStatus.active",
154 "active": true,
155 "caption": "Active"
156 },
157 "name": "Global Lease Group"
158 }
159 ],
160 "costCenterFilterType": {
161 "name": "ALL",
162 "captionKey": "enum.filterType.all",
163 "caption": "All"
164 },
165 "costCenters": [
166 {
167 "id": 14001,
168 "displayId": "CC-001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "Cost Center A",
176 "erpSystemId": 0
177 }
178 ],
179 "profitCenterFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "profitCenters": [
185 {
186 "id": 9001,
187 "displayId": "PC-001",
188 "status": {
189 "name": "ACTIVE",
190 "captionKey": "enum.objectStatus.active",
191 "active": true,
192 "caption": "Active"
193 },
194 "name": "North Region Profit Center",
195 "validTo": "2025-12-31",
196 "erpSystemId": 101,
197 "erpSystemDisplayId": "SAP-01"
198 }
199 ],
200 "wbsFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "wbses": [
206 {
207 "id": 1001,
208 "displayId": "WBS-2025-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Main Project WBS",
216 "erpSystemId": 0
217 }
218 ],
219 "businessAreaFilterType": {
220 "name": "ALL",
221 "captionKey": "enum.filterType.all",
222 "caption": "All"
223 },
224 "businessAreas": [
225 {
226 "id": 3001,
227 "displayId": "BA-2025-001",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "name": "North America Operations",
235 "erpSystemId": 0
236 }
237 ],
238 "functionalAreaFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "functionalAreas": [
244 {
245 "id": 2001,
246 "displayId": "FA-2025-001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Accounting Department",
254 "erpSystemId": 0
255 }
256 ]
257 }
258 },
259 "input": {
260 "id": 30000001,
261 "jobIndexationType": {
262 "name": "CPI_LOCAL",
263 "captionKey": "enum.jobIndexationType.cpiLocal",
264 "caption": "CPI Local"
265 },
266 "jobIndexationTypeNonLease": {
267 "name": "CPI_LOCAL",
268 "captionKey": "enum.jobIndexationType.cpiLocal",
269 "caption": "CPI Local"
270 },
271 "modificationDateType": {
272 "name": "JOB_DATE",
273 "captionKey": "enum.modificationDateType.jobDate",
274 "caption": "Job Date"
275 },
276 "modificationDate": "2024-12-01",
277 "referenceDateType": {
278 "name": "MODIFICATION_DATE",
279 "captionKey": "enum.referenceDateType.modificationDate",
280 "caption": "Modification Date"
281 },
282 "referenceDate": "2024-12-01",
283 "referenceDateTypeNonLease": {
284 "name": "MODIFICATION_DATE",
285 "captionKey": "enum.referenceDateType.modificationDate",
286 "caption": "Modification Date"
287 },
288 "referenceDateNonLease": "2024-12-01",
289 "indexLevelType": {
290 "name": "RATE",
291 "captionKey": "enum.indexLevelType.rate",
292 "caption": "Rate"
293 },
294 "newIndexLevel": 105.5,
295 "indexLevelTypeNonLease": {
296 "name": "RATE",
297 "captionKey": "enum.indexLevelType.rate",
298 "caption": "Rate"
299 },
300 "newIndexLevelNonLease": 103.2,
301 "indexationDateType": {
302 "name": "ROU_ANNIVERSARY_DATE",
303 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
304 "caption": "ROU Anniversary Date"
305 },
306 "indexationDateTypeNonLease": {
307 "name": "ROU_ANNIVERSARY_DATE",
308 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
309 "caption": "ROU Anniversary Date"
310 },
311 "indexationStartDate": "2024-12-01",
312 "indexationStartDateNonLease": "2024-12-01",
313 "postingDateType": {
314 "name": "JOB_DATE",
315 "captionKey": "enum.postingDateType.jobDate",
316 "caption": "Job Date"
317 },
318 "postingDate": "2024-12-01",
319 "documentDate": "2024-12-01",
320 "translationDate": "2024-12-01",
321 "indexationTreatmentType": {
322 "name": "DEFAULT",
323 "captionKey": "enum.indexationTreatmentType.default",
324 "caption": "Default"
325 },
326 "skipActivationGroupsWithOpenDraft": true,
327 "migratedFilterType": {
328 "name": "ALL",
329 "captionKey": "enum.migratedFilterType.all",
330 "caption": "All"
331 },
332 "overrideCPICategoryInputs": [
333 {
334 "consumerPriceIndexCategoryId": 40000001,
335 "consumerPriceIndexCategoryIdNonLease": 40000002,
336 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
337 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
338 "modificationDateType": {
339 "name": "JOB_DATE",
340 "captionKey": "enum.modificationDateType.jobDate",
341 "caption": "Job Date"
342 },
343 "modificationDate": "2024-12-01",
344 "referenceDateType": {
345 "name": "MODIFICATION_DATE",
346 "captionKey": "enum.referenceDateType.modificationDate",
347 "caption": "Modification Date"
348 },
349 "referenceDateTypeNonLease": {
350 "name": "MODIFICATION_DATE",
351 "captionKey": "enum.referenceDateType.modificationDate",
352 "caption": "Modification Date"
353 },
354 "referenceDate": "2024-12-01",
355 "referenceDateNonLease": "2024-12-01",
356 "postingDateType": {
357 "name": "JOB_DATE",
358 "captionKey": "enum.postingDateType.jobDate",
359 "caption": "Job Date"
360 },
361 "postingDate": "2024-12-01",
362 "documentDate": "2024-12-01",
363 "translationDate": "2024-12-01"
364 }
365 ],
366 "revert": false,
367 "reversalReason": {
368 "id": 50000001,
369 "displayId": "REV-001",
370 "status": {
371 "name": "ACTIVE",
372 "captionKey": "enum.objectStatus.active",
373 "active": true,
374 "caption": "Active"
375 },
376 "name": "Incorrect Indexation",
377 "erpSystemId": 60000001,
378 "erpSystemDisplayId": "SAP-PROD"
379 },
380 "assetClassFilterType": {
381 "name": "ALL",
382 "captionKey": "enum.assetClassFilterType.all",
383 "caption": "All"
384 },
385 "assetClasses": [
386 {
387 "id": 10000001,
388 "displayId": "IAC-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "Machinery and Equipment",
396 "assetClassType": "PROPERTY",
397 "infiniteUsefulLife": false
398 }
399 ],
400 "cpiCategoryFilterType": {
401 "name": "ALL",
402 "captionKey": "enum.cpiCategoryFilterType.all",
403 "caption": "All"
404 },
405 "cpiCategories": [
406 {
407 "id": 101,
408 "displayId": "CPI-2025-001",
409 "status": {
410 "name": "ACTIVE",
411 "captionKey": "enum.objectStatus.active",
412 "active": true,
413 "caption": "Active"
414 },
415 "name": "Consumer Price Index - City A",
416 "city": "New York",
417 "country": "USA",
418 "province": "NY",
419 "erpSystemId": 0
420 }
421 ],
422 "listObjectType": {
423 "name": "CONTRACT",
424 "captionKey": "enum.listObjectType.contract",
425 "caption": "Contract"
426 },
427 "objectList": [
428 {
429 "id": 10000001,
430 "displayId": "ENT-001",
431 "name": "Entity Name"
432 }
433 ]
434 },
435 "tasks": [
436 {
437 "id": 10000001,
438 "queueTime": "2025-01-01T10:00:00Z",
439 "startTime": "2025-01-01T10:00:00Z",
440 "endTime": "2025-01-01T10:00:00Z",
441 "interruptedAt": "2025-01-01T10:00:00Z",
442 "recoveredAt": "2025-01-01T10:00:00Z",
443 "status": {
444 "name": "PROCESSING",
445 "captionKey": "enum.batchJobStatus.processing",
446 "caption": "Processing"
447 },
448 "recover": false,
449 "interrupted": false,
450 "interruptionMessage": "sample_interruptionMessage",
451 "errorMessage": "sample_errorMessage",
452 "totalObjectCount": 100,
453 "jobId": 10000001,
454 "batchTaskObjectType": {
455 "name": "CONTRACT",
456 "captionKey": "enum.objectType.contract",
457 "caption": "Contract"
458 },
459 "objectIds": [],
460 "failedObjectIds": [],
461 "taskReport": {
462 "id": 10000001,
463 "scheduledItemCount": 100,
464 "processingItemCount": 100,
465 "doneItemCount": 100,
466 "failedItemCount": 100,
467 "cancelledItemCount": 100,
468 "skippedItemCount": 100,
469 "totalItemCount": 100,
470 "taskId": 10000001
471 }
472 }
473 ]
474 }
475 ]
476}
Mass Indexation Job - Create Or Update¶
HTTP Request
PUT /api/v1/batch/mass-indexation/jobs/createOrUpdate
📋 Description: Creates or updates mass indexation jobs for leases and contracts within the Nakisa Lease Accounting Suite, ensuring accurate financial obligation and accounting entry management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing lease and contract data for creating or updating financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "filter": {
20 "id": 70000001,
21 "profileId": 20000001,
22 "jobId": 10000001,
23 "name": "US Leases Filter",
24 "principalPositionType": {
25 "name": "LESSEE",
26 "captionKey": "enum.principalpositiontype.lessee",
27 "caption": "Lessee"
28 },
29 "filterObject": {
30 "erpSystemFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "erpSystems": [
36 {
37 "id": 10000001,
38 "displayId": "ERP-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "SAP Production System",
46 "type": {
47 "name": "NAKISA",
48 "captionKey": "enum.erpSystemType.NAKISA",
49 "caption": "NAKISA"
50 },
51 "sapVersion": {
52 "name": "ECC_EHP5",
53 "captionKey": "enum.sapVersion.ECC_EHP5",
54 "caption": "ECC_EHP5"
55 }
56 }
57 ],
58 "leaseAreaFilterType": {
59 "name": "ALL",
60 "captionKey": "enum.filterType.all",
61 "caption": "All"
62 },
63 "leaseAreas": [
64 {
65 "id": 10000001,
66 "displayId": "0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Global Lease Area"
74 }
75 ],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [
82 {
83 "id": 10000001,
84 "displayId": "BU0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "North America Business Unit"
92 }
93 ],
94 "companyFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "companies": [
100 {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 }
117 ],
118 "leaseDepartmentFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "leaseDepartments": [
124 {
125 "id": 300001,
126 "displayId": "DEP-01",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "Finance Department"
134 }
135 ],
136 "leaseGroupFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "leaseGroups": [
142 {
143 "id": 60000001,
144 "displayId": "LG-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Global Lease Group"
152 }
153 ],
154 "costCenterFilterType": {
155 "name": "ALL",
156 "captionKey": "enum.filterType.all",
157 "caption": "All"
158 },
159 "costCenters": [
160 {
161 "id": 14001,
162 "displayId": "CC-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Cost Center A",
170 "erpSystemId": 0
171 }
172 ],
173 "profitCenterFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "wbses": [
200 {
201 "id": 1001,
202 "displayId": "WBS-2025-001",
203 "status": {
204 "name": "ACTIVE",
205 "captionKey": "enum.objectStatus.active",
206 "active": true,
207 "caption": "Active"
208 },
209 "name": "Main Project WBS",
210 "erpSystemId": 0
211 }
212 ],
213 "businessAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "businessAreas": [
219 {
220 "id": 3001,
221 "displayId": "BA-2025-001",
222 "status": {
223 "name": "ACTIVE",
224 "captionKey": "enum.objectStatus.active",
225 "active": true,
226 "caption": "Active"
227 },
228 "name": "North America Operations",
229 "erpSystemId": 0
230 }
231 ],
232 "functionalAreaFilterType": {
233 "name": "ALL",
234 "captionKey": "enum.filterType.all",
235 "caption": "All"
236 },
237 "functionalAreas": [
238 {
239 "id": 2001,
240 "displayId": "FA-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Accounting Department",
248 "erpSystemId": 0
249 }
250 ]
251 }
252 },
253 "input": {
254 "id": 30000001,
255 "jobIndexationType": {
256 "name": "CPI_LOCAL",
257 "captionKey": "enum.jobIndexationType.cpiLocal",
258 "caption": "CPI Local"
259 },
260 "jobIndexationTypeNonLease": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "modificationDateType": {
266 "name": "JOB_DATE",
267 "captionKey": "enum.modificationDateType.jobDate",
268 "caption": "Job Date"
269 },
270 "modificationDate": "2024-12-01",
271 "referenceDateType": {
272 "name": "MODIFICATION_DATE",
273 "captionKey": "enum.referenceDateType.modificationDate",
274 "caption": "Modification Date"
275 },
276 "referenceDate": "2024-12-01",
277 "referenceDateTypeNonLease": {
278 "name": "MODIFICATION_DATE",
279 "captionKey": "enum.referenceDateType.modificationDate",
280 "caption": "Modification Date"
281 },
282 "referenceDateNonLease": "2024-12-01",
283 "indexLevelType": {
284 "name": "RATE",
285 "captionKey": "enum.indexLevelType.rate",
286 "caption": "Rate"
287 },
288 "newIndexLevel": 105.5,
289 "indexLevelTypeNonLease": {
290 "name": "RATE",
291 "captionKey": "enum.indexLevelType.rate",
292 "caption": "Rate"
293 },
294 "newIndexLevelNonLease": 103.2,
295 "indexationDateType": {
296 "name": "ROU_ANNIVERSARY_DATE",
297 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
298 "caption": "ROU Anniversary Date"
299 },
300 "indexationDateTypeNonLease": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationStartDate": "2024-12-01",
306 "indexationStartDateNonLease": "2024-12-01",
307 "postingDateType": {
308 "name": "JOB_DATE",
309 "captionKey": "enum.postingDateType.jobDate",
310 "caption": "Job Date"
311 },
312 "postingDate": "2024-12-01",
313 "documentDate": "2024-12-01",
314 "translationDate": "2024-12-01",
315 "indexationTreatmentType": {
316 "name": "DEFAULT",
317 "captionKey": "enum.indexationTreatmentType.default",
318 "caption": "Default"
319 },
320 "skipActivationGroupsWithOpenDraft": true,
321 "migratedFilterType": {
322 "name": "ALL",
323 "captionKey": "enum.migratedFilterType.all",
324 "caption": "All"
325 },
326 "overrideCPICategoryInputs": [
327 {
328 "consumerPriceIndexCategoryId": 40000001,
329 "consumerPriceIndexCategoryIdNonLease": 40000002,
330 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
331 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
332 "modificationDateType": {
333 "name": "JOB_DATE",
334 "captionKey": "enum.modificationDateType.jobDate",
335 "caption": "Job Date"
336 },
337 "modificationDate": "2024-12-01",
338 "referenceDateType": {
339 "name": "MODIFICATION_DATE",
340 "captionKey": "enum.referenceDateType.modificationDate",
341 "caption": "Modification Date"
342 },
343 "referenceDateTypeNonLease": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDate": "2024-12-01",
349 "referenceDateNonLease": "2024-12-01",
350 "postingDateType": {
351 "name": "JOB_DATE",
352 "captionKey": "enum.postingDateType.jobDate",
353 "caption": "Job Date"
354 },
355 "postingDate": "2024-12-01",
356 "documentDate": "2024-12-01",
357 "translationDate": "2024-12-01"
358 }
359 ],
360 "revert": false,
361 "reversalReason": {
362 "id": 50000001,
363 "displayId": "REV-001",
364 "status": {
365 "name": "ACTIVE",
366 "captionKey": "enum.objectStatus.active",
367 "active": true,
368 "caption": "Active"
369 },
370 "name": "Incorrect Indexation",
371 "erpSystemId": 60000001,
372 "erpSystemDisplayId": "SAP-PROD"
373 },
374 "assetClassFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.assetClassFilterType.all",
377 "caption": "All"
378 },
379 "assetClasses": [
380 {
381 "id": 10000001,
382 "displayId": "IAC-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Machinery and Equipment",
390 "assetClassType": "PROPERTY",
391 "infiniteUsefulLife": false
392 }
393 ],
394 "cpiCategoryFilterType": {
395 "name": "ALL",
396 "captionKey": "enum.cpiCategoryFilterType.all",
397 "caption": "All"
398 },
399 "cpiCategories": [
400 {
401 "id": 101,
402 "displayId": "CPI-2025-001",
403 "status": {
404 "name": "ACTIVE",
405 "captionKey": "enum.objectStatus.active",
406 "active": true,
407 "caption": "Active"
408 },
409 "name": "Consumer Price Index - City A",
410 "city": "New York",
411 "country": "USA",
412 "province": "NY",
413 "erpSystemId": 0
414 }
415 ],
416 "listObjectType": {
417 "name": "CONTRACT",
418 "captionKey": "enum.listObjectType.contract",
419 "caption": "Contract"
420 },
421 "objectList": [
422 {
423 "id": 10000001,
424 "displayId": "ENT-001",
425 "name": "Entity Name"
426 }
427 ]
428 },
429 "tasks": [
430 {
431 "id": 10000001,
432 "queueTime": "2025-01-01T10:00:00Z",
433 "startTime": "2025-01-01T10:00:00Z",
434 "endTime": "2025-01-01T10:00:00Z",
435 "interruptedAt": "2025-01-01T10:00:00Z",
436 "recoveredAt": "2025-01-01T10:00:00Z",
437 "status": {
438 "name": "PROCESSING",
439 "captionKey": "enum.batchJobStatus.processing",
440 "caption": "Processing"
441 },
442 "recover": false,
443 "interrupted": false,
444 "interruptionMessage": "sample_interruptionMessage",
445 "errorMessage": "sample_errorMessage",
446 "totalObjectCount": 100,
447 "jobId": 10000001,
448 "batchTaskObjectType": {
449 "name": "CONTRACT",
450 "captionKey": "enum.objectType.contract",
451 "caption": "Contract"
452 },
453 "objectIds": [],
454 "failedObjectIds": [],
455 "taskReport": {
456 "id": 10000001,
457 "scheduledItemCount": 100,
458 "processingItemCount": 100,
459 "doneItemCount": 100,
460 "failedItemCount": 100,
461 "cancelledItemCount": 100,
462 "skippedItemCount": 100,
463 "totalItemCount": 100,
464 "taskId": 10000001
465 }
466 }
467 ]
468}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "taskCount": 0,
9 "failedTaskCount": 0,
10 "doneTaskCount": 0,
11 "inProgressTaskCount": 0,
12 "cancelledTaskCount": 0,
13 "errorMessage": "string",
14 "queueTime": "2019-08-24T14:15:22Z",
15 "startTime": "2019-08-24T14:15:22Z",
16 "endTime": "2019-08-24T14:15:22Z",
17 "status": "CREATED",
18 "executor": "SCHEDULER",
19 "scheduleJobId": 0,
20 "batchSize": 10,
21 "totalObjectCount": 0,
22 "readOnly": true,
23 "profileId": 0,
24 "filter": {
25 "id": 70000001,
26 "profileId": 20000001,
27 "jobId": 10000001,
28 "name": "US Leases Filter",
29 "principalPositionType": {
30 "name": "LESSEE",
31 "captionKey": "enum.principalpositiontype.lessee",
32 "caption": "Lessee"
33 },
34 "filterObject": {
35 "erpSystemFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "erpSystems": [
41 {
42 "id": 10000001,
43 "displayId": "ERP-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "SAP Production System",
51 "type": {
52 "name": "NAKISA",
53 "captionKey": "enum.erpSystemType.NAKISA",
54 "caption": "NAKISA"
55 },
56 "sapVersion": {
57 "name": "ECC_EHP5",
58 "captionKey": "enum.sapVersion.ECC_EHP5",
59 "caption": "ECC_EHP5"
60 }
61 }
62 ],
63 "leaseAreaFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseAreas": [
69 {
70 "id": 10000001,
71 "displayId": "0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "Global Lease Area"
79 }
80 ],
81 "businessUnitFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "businessUnits": [
87 {
88 "id": 10000001,
89 "displayId": "BU0001",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "North America Business Unit"
97 }
98 ],
99 "companyFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "companies": [
105 {
106 "id": 10000006,
107 "displayId": "1005",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "erpSystemId": 10000001,
115 "erpSystemDisplayId": "FINQ8S-300",
116 "countryId": 10000095,
117 "countryDisplayId": "CA",
118 "name": "string",
119 "postingPeriodVariantId": 0,
120 "fiscalVariantId": 0
121 }
122 ],
123 "leaseDepartmentFilterType": {
124 "name": "ALL",
125 "captionKey": "enum.filterType.all",
126 "caption": "All"
127 },
128 "leaseDepartments": [
129 {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 }
140 ],
141 "leaseGroupFilterType": {
142 "name": "ALL",
143 "captionKey": "enum.filterType.all",
144 "caption": "All"
145 },
146 "leaseGroups": [
147 {
148 "id": 60000001,
149 "displayId": "LG-001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "Global Lease Group"
157 }
158 ],
159 "costCenterFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A",
175 "erpSystemId": 0
176 }
177 ],
178 "profitCenterFilterType": {
179 "name": "ALL",
180 "captionKey": "enum.filterType.all",
181 "caption": "All"
182 },
183 "profitCenters": [
184 {
185 "id": 9001,
186 "displayId": "PC-001",
187 "status": {
188 "name": "ACTIVE",
189 "captionKey": "enum.objectStatus.active",
190 "active": true,
191 "caption": "Active"
192 },
193 "name": "North Region Profit Center",
194 "validTo": "2025-12-31",
195 "erpSystemId": 101,
196 "erpSystemDisplayId": "SAP-01"
197 }
198 ],
199 "wbsFilterType": {
200 "name": "ALL",
201 "captionKey": "enum.filterType.all",
202 "caption": "All"
203 },
204 "wbses": [
205 {
206 "id": 1001,
207 "displayId": "WBS-2025-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Main Project WBS",
215 "erpSystemId": 0
216 }
217 ],
218 "businessAreaFilterType": {
219 "name": "ALL",
220 "captionKey": "enum.filterType.all",
221 "caption": "All"
222 },
223 "businessAreas": [
224 {
225 "id": 3001,
226 "displayId": "BA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "North America Operations",
234 "erpSystemId": 0
235 }
236 ],
237 "functionalAreaFilterType": {
238 "name": "ALL",
239 "captionKey": "enum.filterType.all",
240 "caption": "All"
241 },
242 "functionalAreas": [
243 {
244 "id": 2001,
245 "displayId": "FA-2025-001",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "name": "Accounting Department",
253 "erpSystemId": 0
254 }
255 ]
256 }
257 },
258 "input": {
259 "id": 30000001,
260 "jobIndexationType": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "jobIndexationTypeNonLease": {
266 "name": "CPI_LOCAL",
267 "captionKey": "enum.jobIndexationType.cpiLocal",
268 "caption": "CPI Local"
269 },
270 "modificationDateType": {
271 "name": "JOB_DATE",
272 "captionKey": "enum.modificationDateType.jobDate",
273 "caption": "Job Date"
274 },
275 "modificationDate": "2024-12-01",
276 "referenceDateType": {
277 "name": "MODIFICATION_DATE",
278 "captionKey": "enum.referenceDateType.modificationDate",
279 "caption": "Modification Date"
280 },
281 "referenceDate": "2024-12-01",
282 "referenceDateTypeNonLease": {
283 "name": "MODIFICATION_DATE",
284 "captionKey": "enum.referenceDateType.modificationDate",
285 "caption": "Modification Date"
286 },
287 "referenceDateNonLease": "2024-12-01",
288 "indexLevelType": {
289 "name": "RATE",
290 "captionKey": "enum.indexLevelType.rate",
291 "caption": "Rate"
292 },
293 "newIndexLevel": 105.5,
294 "indexLevelTypeNonLease": {
295 "name": "RATE",
296 "captionKey": "enum.indexLevelType.rate",
297 "caption": "Rate"
298 },
299 "newIndexLevelNonLease": 103.2,
300 "indexationDateType": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationDateTypeNonLease": {
306 "name": "ROU_ANNIVERSARY_DATE",
307 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
308 "caption": "ROU Anniversary Date"
309 },
310 "indexationStartDate": "2024-12-01",
311 "indexationStartDateNonLease": "2024-12-01",
312 "postingDateType": {
313 "name": "JOB_DATE",
314 "captionKey": "enum.postingDateType.jobDate",
315 "caption": "Job Date"
316 },
317 "postingDate": "2024-12-01",
318 "documentDate": "2024-12-01",
319 "translationDate": "2024-12-01",
320 "indexationTreatmentType": {
321 "name": "DEFAULT",
322 "captionKey": "enum.indexationTreatmentType.default",
323 "caption": "Default"
324 },
325 "skipActivationGroupsWithOpenDraft": true,
326 "migratedFilterType": {
327 "name": "ALL",
328 "captionKey": "enum.migratedFilterType.all",
329 "caption": "All"
330 },
331 "overrideCPICategoryInputs": [
332 {
333 "consumerPriceIndexCategoryId": 40000001,
334 "consumerPriceIndexCategoryIdNonLease": 40000002,
335 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
336 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
337 "modificationDateType": {
338 "name": "JOB_DATE",
339 "captionKey": "enum.modificationDateType.jobDate",
340 "caption": "Job Date"
341 },
342 "modificationDate": "2024-12-01",
343 "referenceDateType": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDateTypeNonLease": {
349 "name": "MODIFICATION_DATE",
350 "captionKey": "enum.referenceDateType.modificationDate",
351 "caption": "Modification Date"
352 },
353 "referenceDate": "2024-12-01",
354 "referenceDateNonLease": "2024-12-01",
355 "postingDateType": {
356 "name": "JOB_DATE",
357 "captionKey": "enum.postingDateType.jobDate",
358 "caption": "Job Date"
359 },
360 "postingDate": "2024-12-01",
361 "documentDate": "2024-12-01",
362 "translationDate": "2024-12-01"
363 }
364 ],
365 "revert": false,
366 "reversalReason": {
367 "id": 50000001,
368 "displayId": "REV-001",
369 "status": {
370 "name": "ACTIVE",
371 "captionKey": "enum.objectStatus.active",
372 "active": true,
373 "caption": "Active"
374 },
375 "name": "Incorrect Indexation",
376 "erpSystemId": 60000001,
377 "erpSystemDisplayId": "SAP-PROD"
378 },
379 "assetClassFilterType": {
380 "name": "ALL",
381 "captionKey": "enum.assetClassFilterType.all",
382 "caption": "All"
383 },
384 "assetClasses": [
385 {
386 "id": 10000001,
387 "displayId": "IAC-001",
388 "status": {
389 "name": "ACTIVE",
390 "captionKey": "enum.objectStatus.active",
391 "active": true,
392 "caption": "Active"
393 },
394 "name": "Machinery and Equipment",
395 "assetClassType": "PROPERTY",
396 "infiniteUsefulLife": false
397 }
398 ],
399 "cpiCategoryFilterType": {
400 "name": "ALL",
401 "captionKey": "enum.cpiCategoryFilterType.all",
402 "caption": "All"
403 },
404 "cpiCategories": [
405 {
406 "id": 101,
407 "displayId": "CPI-2025-001",
408 "status": {
409 "name": "ACTIVE",
410 "captionKey": "enum.objectStatus.active",
411 "active": true,
412 "caption": "Active"
413 },
414 "name": "Consumer Price Index - City A",
415 "city": "New York",
416 "country": "USA",
417 "province": "NY",
418 "erpSystemId": 0
419 }
420 ],
421 "listObjectType": {
422 "name": "CONTRACT",
423 "captionKey": "enum.listObjectType.contract",
424 "caption": "Contract"
425 },
426 "objectList": [
427 {
428 "id": 10000001,
429 "displayId": "ENT-001",
430 "name": "Entity Name"
431 }
432 ]
433 },
434 "tasks": [
435 {
436 "id": 10000001,
437 "queueTime": "2025-01-01T10:00:00Z",
438 "startTime": "2025-01-01T10:00:00Z",
439 "endTime": "2025-01-01T10:00:00Z",
440 "interruptedAt": "2025-01-01T10:00:00Z",
441 "recoveredAt": "2025-01-01T10:00:00Z",
442 "status": {
443 "name": "PROCESSING",
444 "captionKey": "enum.batchJobStatus.processing",
445 "caption": "Processing"
446 },
447 "recover": false,
448 "interrupted": false,
449 "interruptionMessage": "sample_interruptionMessage",
450 "errorMessage": "sample_errorMessage",
451 "totalObjectCount": 100,
452 "jobId": 10000001,
453 "batchTaskObjectType": {
454 "name": "CONTRACT",
455 "captionKey": "enum.objectType.contract",
456 "caption": "Contract"
457 },
458 "objectIds": [],
459 "failedObjectIds": [],
460 "taskReport": {
461 "id": 10000001,
462 "scheduledItemCount": 100,
463 "processingItemCount": 100,
464 "doneItemCount": 100,
465 "failedItemCount": 100,
466 "cancelledItemCount": 100,
467 "skippedItemCount": 100,
468 "totalItemCount": 100,
469 "taskId": 10000001
470 }
471 }
472 ]
473 }
474}
Mass Indexation Job - Bulk Update¶
HTTP Request
PUT /api/v1/batch/mass-indexation/jobs/bulk
📋 Description: Updates multiple mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the efficient management of leases, contracts, financial obligations, and accounting entries in bulk.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk job data for mass indexation of leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "queueTime": "2019-08-24T14:15:22Z",
11 "startTime": "2019-08-24T14:15:22Z",
12 "endTime": "2019-08-24T14:15:22Z",
13 "status": "CREATED",
14 "executor": "SCHEDULER",
15 "scheduleJobId": 0,
16 "batchSize": 10,
17 "totalObjectCount": 0,
18 "readOnly": true,
19 "profileId": 0,
20 "filter": {
21 "id": 70000001,
22 "profileId": 20000001,
23 "jobId": 10000001,
24 "name": "US Leases Filter",
25 "principalPositionType": {
26 "name": "LESSEE",
27 "captionKey": "enum.principalpositiontype.lessee",
28 "caption": "Lessee"
29 },
30 "filterObject": {
31 "erpSystemFilterType": {
32 "name": "ALL",
33 "captionKey": "enum.filterType.all",
34 "caption": "All"
35 },
36 "erpSystems": [
37 {
38 "id": 10000001,
39 "displayId": "ERP-001",
40 "status": {
41 "name": "ACTIVE",
42 "captionKey": "enum.objectStatus.active",
43 "active": true,
44 "caption": "Active"
45 },
46 "name": "SAP Production System",
47 "type": {
48 "name": "NAKISA",
49 "captionKey": "enum.erpSystemType.NAKISA",
50 "caption": "NAKISA"
51 },
52 "sapVersion": {
53 "name": "ECC_EHP5",
54 "captionKey": "enum.sapVersion.ECC_EHP5",
55 "caption": "ECC_EHP5"
56 }
57 }
58 ],
59 "leaseAreaFilterType": {
60 "name": "ALL",
61 "captionKey": "enum.filterType.all",
62 "caption": "All"
63 },
64 "leaseAreas": [
65 {
66 "id": 10000001,
67 "displayId": "0001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "Global Lease Area"
75 }
76 ],
77 "businessUnitFilterType": {
78 "name": "ALL",
79 "captionKey": "enum.filterType.all",
80 "caption": "All"
81 },
82 "businessUnits": [
83 {
84 "id": 10000001,
85 "displayId": "BU0001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "North America Business Unit"
93 }
94 ],
95 "companyFilterType": {
96 "name": "ALL",
97 "captionKey": "enum.filterType.all",
98 "caption": "All"
99 },
100 "companies": [
101 {
102 "id": 10000006,
103 "displayId": "1005",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "erpSystemId": 10000001,
111 "erpSystemDisplayId": "FINQ8S-300",
112 "countryId": 10000095,
113 "countryDisplayId": "CA",
114 "name": "string",
115 "postingPeriodVariantId": 0,
116 "fiscalVariantId": 0
117 }
118 ],
119 "leaseDepartmentFilterType": {
120 "name": "ALL",
121 "captionKey": "enum.filterType.all",
122 "caption": "All"
123 },
124 "leaseDepartments": [
125 {
126 "id": 300001,
127 "displayId": "DEP-01",
128 "status": {
129 "name": "ACTIVE",
130 "captionKey": "enum.objectStatus.active",
131 "active": true,
132 "caption": "Active"
133 },
134 "name": "Finance Department"
135 }
136 ],
137 "leaseGroupFilterType": {
138 "name": "ALL",
139 "captionKey": "enum.filterType.all",
140 "caption": "All"
141 },
142 "leaseGroups": [
143 {
144 "id": 60000001,
145 "displayId": "LG-001",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "Global Lease Group"
153 }
154 ],
155 "costCenterFilterType": {
156 "name": "ALL",
157 "captionKey": "enum.filterType.all",
158 "caption": "All"
159 },
160 "costCenters": [
161 {
162 "id": 14001,
163 "displayId": "CC-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "Cost Center A",
171 "erpSystemId": 0
172 }
173 ],
174 "profitCenterFilterType": {
175 "name": "ALL",
176 "captionKey": "enum.filterType.all",
177 "caption": "All"
178 },
179 "profitCenters": [
180 {
181 "id": 9001,
182 "displayId": "PC-001",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "North Region Profit Center",
190 "validTo": "2025-12-31",
191 "erpSystemId": 101,
192 "erpSystemDisplayId": "SAP-01"
193 }
194 ],
195 "wbsFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "wbses": [
201 {
202 "id": 1001,
203 "displayId": "WBS-2025-001",
204 "status": {
205 "name": "ACTIVE",
206 "captionKey": "enum.objectStatus.active",
207 "active": true,
208 "caption": "Active"
209 },
210 "name": "Main Project WBS",
211 "erpSystemId": 0
212 }
213 ],
214 "businessAreaFilterType": {
215 "name": "ALL",
216 "captionKey": "enum.filterType.all",
217 "caption": "All"
218 },
219 "businessAreas": [
220 {
221 "id": 3001,
222 "displayId": "BA-2025-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "North America Operations",
230 "erpSystemId": 0
231 }
232 ],
233 "functionalAreaFilterType": {
234 "name": "ALL",
235 "captionKey": "enum.filterType.all",
236 "caption": "All"
237 },
238 "functionalAreas": [
239 {
240 "id": 2001,
241 "displayId": "FA-2025-001",
242 "status": {
243 "name": "ACTIVE",
244 "captionKey": "enum.objectStatus.active",
245 "active": true,
246 "caption": "Active"
247 },
248 "name": "Accounting Department",
249 "erpSystemId": 0
250 }
251 ]
252 }
253 },
254 "input": {
255 "id": 30000001,
256 "jobIndexationType": {
257 "name": "CPI_LOCAL",
258 "captionKey": "enum.jobIndexationType.cpiLocal",
259 "caption": "CPI Local"
260 },
261 "jobIndexationTypeNonLease": {
262 "name": "CPI_LOCAL",
263 "captionKey": "enum.jobIndexationType.cpiLocal",
264 "caption": "CPI Local"
265 },
266 "modificationDateType": {
267 "name": "JOB_DATE",
268 "captionKey": "enum.modificationDateType.jobDate",
269 "caption": "Job Date"
270 },
271 "modificationDate": "2024-12-01",
272 "referenceDateType": {
273 "name": "MODIFICATION_DATE",
274 "captionKey": "enum.referenceDateType.modificationDate",
275 "caption": "Modification Date"
276 },
277 "referenceDate": "2024-12-01",
278 "referenceDateTypeNonLease": {
279 "name": "MODIFICATION_DATE",
280 "captionKey": "enum.referenceDateType.modificationDate",
281 "caption": "Modification Date"
282 },
283 "referenceDateNonLease": "2024-12-01",
284 "indexLevelType": {
285 "name": "RATE",
286 "captionKey": "enum.indexLevelType.rate",
287 "caption": "Rate"
288 },
289 "newIndexLevel": 105.5,
290 "indexLevelTypeNonLease": {
291 "name": "RATE",
292 "captionKey": "enum.indexLevelType.rate",
293 "caption": "Rate"
294 },
295 "newIndexLevelNonLease": 103.2,
296 "indexationDateType": {
297 "name": "ROU_ANNIVERSARY_DATE",
298 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
299 "caption": "ROU Anniversary Date"
300 },
301 "indexationDateTypeNonLease": {
302 "name": "ROU_ANNIVERSARY_DATE",
303 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
304 "caption": "ROU Anniversary Date"
305 },
306 "indexationStartDate": "2024-12-01",
307 "indexationStartDateNonLease": "2024-12-01",
308 "postingDateType": {
309 "name": "JOB_DATE",
310 "captionKey": "enum.postingDateType.jobDate",
311 "caption": "Job Date"
312 },
313 "postingDate": "2024-12-01",
314 "documentDate": "2024-12-01",
315 "translationDate": "2024-12-01",
316 "indexationTreatmentType": {
317 "name": "DEFAULT",
318 "captionKey": "enum.indexationTreatmentType.default",
319 "caption": "Default"
320 },
321 "skipActivationGroupsWithOpenDraft": true,
322 "migratedFilterType": {
323 "name": "ALL",
324 "captionKey": "enum.migratedFilterType.all",
325 "caption": "All"
326 },
327 "overrideCPICategoryInputs": [
328 {
329 "consumerPriceIndexCategoryId": 40000001,
330 "consumerPriceIndexCategoryIdNonLease": 40000002,
331 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
332 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
333 "modificationDateType": {
334 "name": "JOB_DATE",
335 "captionKey": "enum.modificationDateType.jobDate",
336 "caption": "Job Date"
337 },
338 "modificationDate": "2024-12-01",
339 "referenceDateType": {
340 "name": "MODIFICATION_DATE",
341 "captionKey": "enum.referenceDateType.modificationDate",
342 "caption": "Modification Date"
343 },
344 "referenceDateTypeNonLease": {
345 "name": "MODIFICATION_DATE",
346 "captionKey": "enum.referenceDateType.modificationDate",
347 "caption": "Modification Date"
348 },
349 "referenceDate": "2024-12-01",
350 "referenceDateNonLease": "2024-12-01",
351 "postingDateType": {
352 "name": "JOB_DATE",
353 "captionKey": "enum.postingDateType.jobDate",
354 "caption": "Job Date"
355 },
356 "postingDate": "2024-12-01",
357 "documentDate": "2024-12-01",
358 "translationDate": "2024-12-01"
359 }
360 ],
361 "revert": false,
362 "reversalReason": {
363 "id": 50000001,
364 "displayId": "REV-001",
365 "status": {
366 "name": "ACTIVE",
367 "captionKey": "enum.objectStatus.active",
368 "active": true,
369 "caption": "Active"
370 },
371 "name": "Incorrect Indexation",
372 "erpSystemId": 60000001,
373 "erpSystemDisplayId": "SAP-PROD"
374 },
375 "assetClassFilterType": {
376 "name": "ALL",
377 "captionKey": "enum.assetClassFilterType.all",
378 "caption": "All"
379 },
380 "assetClasses": [
381 {
382 "id": 10000001,
383 "displayId": "IAC-001",
384 "status": {
385 "name": "ACTIVE",
386 "captionKey": "enum.objectStatus.active",
387 "active": true,
388 "caption": "Active"
389 },
390 "name": "Machinery and Equipment",
391 "assetClassType": "PROPERTY",
392 "infiniteUsefulLife": false
393 }
394 ],
395 "cpiCategoryFilterType": {
396 "name": "ALL",
397 "captionKey": "enum.cpiCategoryFilterType.all",
398 "caption": "All"
399 },
400 "cpiCategories": [
401 {
402 "id": 101,
403 "displayId": "CPI-2025-001",
404 "status": {
405 "name": "ACTIVE",
406 "captionKey": "enum.objectStatus.active",
407 "active": true,
408 "caption": "Active"
409 },
410 "name": "Consumer Price Index - City A",
411 "city": "New York",
412 "country": "USA",
413 "province": "NY",
414 "erpSystemId": 0
415 }
416 ],
417 "listObjectType": {
418 "name": "CONTRACT",
419 "captionKey": "enum.listObjectType.contract",
420 "caption": "Contract"
421 },
422 "objectList": [
423 {
424 "id": 10000001,
425 "displayId": "ENT-001",
426 "name": "Entity Name"
427 }
428 ]
429 },
430 "tasks": [
431 {
432 "id": 10000001,
433 "queueTime": "2025-01-01T10:00:00Z",
434 "startTime": "2025-01-01T10:00:00Z",
435 "endTime": "2025-01-01T10:00:00Z",
436 "interruptedAt": "2025-01-01T10:00:00Z",
437 "recoveredAt": "2025-01-01T10:00:00Z",
438 "status": {
439 "name": "PROCESSING",
440 "captionKey": "enum.batchJobStatus.processing",
441 "caption": "Processing"
442 },
443 "recover": false,
444 "interrupted": false,
445 "interruptionMessage": "sample_interruptionMessage",
446 "errorMessage": "sample_errorMessage",
447 "totalObjectCount": 100,
448 "jobId": 10000001,
449 "batchTaskObjectType": {
450 "name": "CONTRACT",
451 "captionKey": "enum.objectType.contract",
452 "caption": "Contract"
453 },
454 "objectIds": [],
455 "failedObjectIds": [],
456 "taskReport": {
457 "id": 10000001,
458 "scheduledItemCount": 100,
459 "processingItemCount": 100,
460 "doneItemCount": 100,
461 "failedItemCount": 100,
462 "cancelledItemCount": 100,
463 "skippedItemCount": 100,
464 "totalItemCount": 100,
465 "taskId": 10000001
466 }
467 }
468 ]
469 }
470]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 0,
9 "taskCount": 0,
10 "failedTaskCount": 0,
11 "doneTaskCount": 0,
12 "inProgressTaskCount": 0,
13 "cancelledTaskCount": 0,
14 "errorMessage": "string",
15 "queueTime": "2019-08-24T14:15:22Z",
16 "startTime": "2019-08-24T14:15:22Z",
17 "endTime": "2019-08-24T14:15:22Z",
18 "status": "CREATED",
19 "executor": "SCHEDULER",
20 "scheduleJobId": 0,
21 "batchSize": 10,
22 "totalObjectCount": 0,
23 "readOnly": true,
24 "profileId": 0,
25 "filter": {
26 "id": 70000001,
27 "profileId": 20000001,
28 "jobId": 10000001,
29 "name": "US Leases Filter",
30 "principalPositionType": {
31 "name": "LESSEE",
32 "captionKey": "enum.principalpositiontype.lessee",
33 "caption": "Lessee"
34 },
35 "filterObject": {
36 "erpSystemFilterType": {
37 "name": "ALL",
38 "captionKey": "enum.filterType.all",
39 "caption": "All"
40 },
41 "erpSystems": [
42 {
43 "id": 10000001,
44 "displayId": "ERP-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "SAP Production System",
52 "type": {
53 "name": "NAKISA",
54 "captionKey": "enum.erpSystemType.NAKISA",
55 "caption": "NAKISA"
56 },
57 "sapVersion": {
58 "name": "ECC_EHP5",
59 "captionKey": "enum.sapVersion.ECC_EHP5",
60 "caption": "ECC_EHP5"
61 }
62 }
63 ],
64 "leaseAreaFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "leaseAreas": [
70 {
71 "id": 10000001,
72 "displayId": "0001",
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "name": "Global Lease Area"
80 }
81 ],
82 "businessUnitFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "businessUnits": [
88 {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 }
99 ],
100 "companyFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "companies": [
106 {
107 "id": 10000006,
108 "displayId": "1005",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "erpSystemId": 10000001,
116 "erpSystemDisplayId": "FINQ8S-300",
117 "countryId": 10000095,
118 "countryDisplayId": "CA",
119 "name": "string",
120 "postingPeriodVariantId": 0,
121 "fiscalVariantId": 0
122 }
123 ],
124 "leaseDepartmentFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "leaseDepartments": [
130 {
131 "id": 300001,
132 "displayId": "DEP-01",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "Finance Department"
140 }
141 ],
142 "leaseGroupFilterType": {
143 "name": "ALL",
144 "captionKey": "enum.filterType.all",
145 "caption": "All"
146 },
147 "leaseGroups": [
148 {
149 "id": 60000001,
150 "displayId": "LG-001",
151 "status": {
152 "name": "ACTIVE",
153 "captionKey": "enum.objectStatus.active",
154 "active": true,
155 "caption": "Active"
156 },
157 "name": "Global Lease Group"
158 }
159 ],
160 "costCenterFilterType": {
161 "name": "ALL",
162 "captionKey": "enum.filterType.all",
163 "caption": "All"
164 },
165 "costCenters": [
166 {
167 "id": 14001,
168 "displayId": "CC-001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "Cost Center A",
176 "erpSystemId": 0
177 }
178 ],
179 "profitCenterFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "profitCenters": [
185 {
186 "id": 9001,
187 "displayId": "PC-001",
188 "status": {
189 "name": "ACTIVE",
190 "captionKey": "enum.objectStatus.active",
191 "active": true,
192 "caption": "Active"
193 },
194 "name": "North Region Profit Center",
195 "validTo": "2025-12-31",
196 "erpSystemId": 101,
197 "erpSystemDisplayId": "SAP-01"
198 }
199 ],
200 "wbsFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "wbses": [
206 {
207 "id": 1001,
208 "displayId": "WBS-2025-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Main Project WBS",
216 "erpSystemId": 0
217 }
218 ],
219 "businessAreaFilterType": {
220 "name": "ALL",
221 "captionKey": "enum.filterType.all",
222 "caption": "All"
223 },
224 "businessAreas": [
225 {
226 "id": 3001,
227 "displayId": "BA-2025-001",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "name": "North America Operations",
235 "erpSystemId": 0
236 }
237 ],
238 "functionalAreaFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "functionalAreas": [
244 {
245 "id": 2001,
246 "displayId": "FA-2025-001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Accounting Department",
254 "erpSystemId": 0
255 }
256 ]
257 }
258 },
259 "input": {
260 "id": 30000001,
261 "jobIndexationType": {
262 "name": "CPI_LOCAL",
263 "captionKey": "enum.jobIndexationType.cpiLocal",
264 "caption": "CPI Local"
265 },
266 "jobIndexationTypeNonLease": {
267 "name": "CPI_LOCAL",
268 "captionKey": "enum.jobIndexationType.cpiLocal",
269 "caption": "CPI Local"
270 },
271 "modificationDateType": {
272 "name": "JOB_DATE",
273 "captionKey": "enum.modificationDateType.jobDate",
274 "caption": "Job Date"
275 },
276 "modificationDate": "2024-12-01",
277 "referenceDateType": {
278 "name": "MODIFICATION_DATE",
279 "captionKey": "enum.referenceDateType.modificationDate",
280 "caption": "Modification Date"
281 },
282 "referenceDate": "2024-12-01",
283 "referenceDateTypeNonLease": {
284 "name": "MODIFICATION_DATE",
285 "captionKey": "enum.referenceDateType.modificationDate",
286 "caption": "Modification Date"
287 },
288 "referenceDateNonLease": "2024-12-01",
289 "indexLevelType": {
290 "name": "RATE",
291 "captionKey": "enum.indexLevelType.rate",
292 "caption": "Rate"
293 },
294 "newIndexLevel": 105.5,
295 "indexLevelTypeNonLease": {
296 "name": "RATE",
297 "captionKey": "enum.indexLevelType.rate",
298 "caption": "Rate"
299 },
300 "newIndexLevelNonLease": 103.2,
301 "indexationDateType": {
302 "name": "ROU_ANNIVERSARY_DATE",
303 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
304 "caption": "ROU Anniversary Date"
305 },
306 "indexationDateTypeNonLease": {
307 "name": "ROU_ANNIVERSARY_DATE",
308 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
309 "caption": "ROU Anniversary Date"
310 },
311 "indexationStartDate": "2024-12-01",
312 "indexationStartDateNonLease": "2024-12-01",
313 "postingDateType": {
314 "name": "JOB_DATE",
315 "captionKey": "enum.postingDateType.jobDate",
316 "caption": "Job Date"
317 },
318 "postingDate": "2024-12-01",
319 "documentDate": "2024-12-01",
320 "translationDate": "2024-12-01",
321 "indexationTreatmentType": {
322 "name": "DEFAULT",
323 "captionKey": "enum.indexationTreatmentType.default",
324 "caption": "Default"
325 },
326 "skipActivationGroupsWithOpenDraft": true,
327 "migratedFilterType": {
328 "name": "ALL",
329 "captionKey": "enum.migratedFilterType.all",
330 "caption": "All"
331 },
332 "overrideCPICategoryInputs": [
333 {
334 "consumerPriceIndexCategoryId": 40000001,
335 "consumerPriceIndexCategoryIdNonLease": 40000002,
336 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
337 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
338 "modificationDateType": {
339 "name": "JOB_DATE",
340 "captionKey": "enum.modificationDateType.jobDate",
341 "caption": "Job Date"
342 },
343 "modificationDate": "2024-12-01",
344 "referenceDateType": {
345 "name": "MODIFICATION_DATE",
346 "captionKey": "enum.referenceDateType.modificationDate",
347 "caption": "Modification Date"
348 },
349 "referenceDateTypeNonLease": {
350 "name": "MODIFICATION_DATE",
351 "captionKey": "enum.referenceDateType.modificationDate",
352 "caption": "Modification Date"
353 },
354 "referenceDate": "2024-12-01",
355 "referenceDateNonLease": "2024-12-01",
356 "postingDateType": {
357 "name": "JOB_DATE",
358 "captionKey": "enum.postingDateType.jobDate",
359 "caption": "Job Date"
360 },
361 "postingDate": "2024-12-01",
362 "documentDate": "2024-12-01",
363 "translationDate": "2024-12-01"
364 }
365 ],
366 "revert": false,
367 "reversalReason": {
368 "id": 50000001,
369 "displayId": "REV-001",
370 "status": {
371 "name": "ACTIVE",
372 "captionKey": "enum.objectStatus.active",
373 "active": true,
374 "caption": "Active"
375 },
376 "name": "Incorrect Indexation",
377 "erpSystemId": 60000001,
378 "erpSystemDisplayId": "SAP-PROD"
379 },
380 "assetClassFilterType": {
381 "name": "ALL",
382 "captionKey": "enum.assetClassFilterType.all",
383 "caption": "All"
384 },
385 "assetClasses": [
386 {
387 "id": 10000001,
388 "displayId": "IAC-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "Machinery and Equipment",
396 "assetClassType": "PROPERTY",
397 "infiniteUsefulLife": false
398 }
399 ],
400 "cpiCategoryFilterType": {
401 "name": "ALL",
402 "captionKey": "enum.cpiCategoryFilterType.all",
403 "caption": "All"
404 },
405 "cpiCategories": [
406 {
407 "id": 101,
408 "displayId": "CPI-2025-001",
409 "status": {
410 "name": "ACTIVE",
411 "captionKey": "enum.objectStatus.active",
412 "active": true,
413 "caption": "Active"
414 },
415 "name": "Consumer Price Index - City A",
416 "city": "New York",
417 "country": "USA",
418 "province": "NY",
419 "erpSystemId": 0
420 }
421 ],
422 "listObjectType": {
423 "name": "CONTRACT",
424 "captionKey": "enum.listObjectType.contract",
425 "caption": "Contract"
426 },
427 "objectList": [
428 {
429 "id": 10000001,
430 "displayId": "ENT-001",
431 "name": "Entity Name"
432 }
433 ]
434 },
435 "tasks": [
436 {
437 "id": 10000001,
438 "queueTime": "2025-01-01T10:00:00Z",
439 "startTime": "2025-01-01T10:00:00Z",
440 "endTime": "2025-01-01T10:00:00Z",
441 "interruptedAt": "2025-01-01T10:00:00Z",
442 "recoveredAt": "2025-01-01T10:00:00Z",
443 "status": {
444 "name": "PROCESSING",
445 "captionKey": "enum.batchJobStatus.processing",
446 "caption": "Processing"
447 },
448 "recover": false,
449 "interrupted": false,
450 "interruptionMessage": "sample_interruptionMessage",
451 "errorMessage": "sample_errorMessage",
452 "totalObjectCount": 100,
453 "jobId": 10000001,
454 "batchTaskObjectType": {
455 "name": "CONTRACT",
456 "captionKey": "enum.objectType.contract",
457 "caption": "Contract"
458 },
459 "objectIds": [],
460 "failedObjectIds": [],
461 "taskReport": {
462 "id": 10000001,
463 "scheduledItemCount": 100,
464 "processingItemCount": 100,
465 "doneItemCount": 100,
466 "failedItemCount": 100,
467 "cancelledItemCount": 100,
468 "skippedItemCount": 100,
469 "totalItemCount": 100,
470 "taskId": 10000001
471 }
472 }
473 ]
474 }
475 ]
476}
Mass Indexation Job - Search¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/search
📋 Description: Submits a request to search for mass indexation jobs related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient management of 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 the search criteria and filters for lease, contract, financial obligation, and accounting entry jobs to facilitate batch mass indexation. |
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 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "executorEqual": "SCHEDULER"
16}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "taskCount": 0,
22 "failedTaskCount": 0,
23 "doneTaskCount": 0,
24 "inProgressTaskCount": 0,
25 "cancelledTaskCount": 0,
26 "errorMessage": "string",
27 "queueTime": "2019-08-24T14:15:22Z",
28 "startTime": "2019-08-24T14:15:22Z",
29 "endTime": "2019-08-24T14:15:22Z",
30 "status": "CREATED",
31 "executor": "SCHEDULER",
32 "scheduleJobId": 0,
33 "batchSize": 10,
34 "totalObjectCount": 0,
35 "readOnly": true,
36 "profileId": 0,
37 "filter": {
38 "id": 70000001,
39 "profileId": 20000001,
40 "jobId": 10000001,
41 "name": "US Leases Filter",
42 "principalPositionType": {
43 "name": "LESSEE",
44 "captionKey": "enum.principalpositiontype.lessee",
45 "caption": "Lessee"
46 },
47 "filterObject": {
48 "erpSystemFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "erpSystems": [
54 {
55 "id": 10000001,
56 "displayId": "ERP-001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "SAP Production System",
64 "type": {
65 "name": "NAKISA",
66 "captionKey": "enum.erpSystemType.NAKISA",
67 "caption": "NAKISA"
68 },
69 "sapVersion": {
70 "name": "ECC_EHP5",
71 "captionKey": "enum.sapVersion.ECC_EHP5",
72 "caption": "ECC_EHP5"
73 }
74 }
75 ],
76 "leaseAreaFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "leaseAreas": [
82 {
83 "id": 10000001,
84 "displayId": "0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Global Lease Area"
92 }
93 ],
94 "businessUnitFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "businessUnits": [
100 {
101 "id": 10000001,
102 "displayId": "BU0001",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "North America Business Unit"
110 }
111 ],
112 "companyFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "companies": [
118 {
119 "id": 10000006,
120 "displayId": "1005",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "erpSystemId": 10000001,
128 "erpSystemDisplayId": "FINQ8S-300",
129 "countryId": 10000095,
130 "countryDisplayId": "CA",
131 "name": "string",
132 "postingPeriodVariantId": 0,
133 "fiscalVariantId": 0
134 }
135 ],
136 "leaseDepartmentFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "leaseDepartments": [
142 {
143 "id": 300001,
144 "displayId": "DEP-01",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Finance Department"
152 }
153 ],
154 "leaseGroupFilterType": {
155 "name": "ALL",
156 "captionKey": "enum.filterType.all",
157 "caption": "All"
158 },
159 "leaseGroups": [
160 {
161 "id": 60000001,
162 "displayId": "LG-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Global Lease Group"
170 }
171 ],
172 "costCenterFilterType": {
173 "name": "ALL",
174 "captionKey": "enum.filterType.all",
175 "caption": "All"
176 },
177 "costCenters": [
178 {
179 "id": 14001,
180 "displayId": "CC-001",
181 "status": {
182 "name": "ACTIVE",
183 "captionKey": "enum.objectStatus.active",
184 "active": true,
185 "caption": "Active"
186 },
187 "name": "Cost Center A",
188 "erpSystemId": 0
189 }
190 ],
191 "profitCenterFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "profitCenters": [
197 {
198 "id": 9001,
199 "displayId": "PC-001",
200 "status": {
201 "name": "ACTIVE",
202 "captionKey": "enum.objectStatus.active",
203 "active": true,
204 "caption": "Active"
205 },
206 "name": "North Region Profit Center",
207 "validTo": "2025-12-31",
208 "erpSystemId": 101,
209 "erpSystemDisplayId": "SAP-01"
210 }
211 ],
212 "wbsFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "wbses": [
218 {
219 "id": 1001,
220 "displayId": "WBS-2025-001",
221 "status": {
222 "name": "ACTIVE",
223 "captionKey": "enum.objectStatus.active",
224 "active": true,
225 "caption": "Active"
226 },
227 "name": "Main Project WBS",
228 "erpSystemId": 0
229 }
230 ],
231 "businessAreaFilterType": {
232 "name": "ALL",
233 "captionKey": "enum.filterType.all",
234 "caption": "All"
235 },
236 "businessAreas": [
237 {
238 "id": 3001,
239 "displayId": "BA-2025-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "North America Operations",
247 "erpSystemId": 0
248 }
249 ],
250 "functionalAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "functionalAreas": [
256 {
257 "id": 2001,
258 "displayId": "FA-2025-001",
259 "status": {
260 "name": "ACTIVE",
261 "captionKey": "enum.objectStatus.active",
262 "active": true,
263 "caption": "Active"
264 },
265 "name": "Accounting Department",
266 "erpSystemId": 0
267 }
268 ]
269 }
270 },
271 "input": {
272 "id": 30000001,
273 "jobIndexationType": {
274 "name": "CPI_LOCAL",
275 "captionKey": "enum.jobIndexationType.cpiLocal",
276 "caption": "CPI Local"
277 },
278 "jobIndexationTypeNonLease": {
279 "name": "CPI_LOCAL",
280 "captionKey": "enum.jobIndexationType.cpiLocal",
281 "caption": "CPI Local"
282 },
283 "modificationDateType": {
284 "name": "JOB_DATE",
285 "captionKey": "enum.modificationDateType.jobDate",
286 "caption": "Job Date"
287 },
288 "modificationDate": "2024-12-01",
289 "referenceDateType": {
290 "name": "MODIFICATION_DATE",
291 "captionKey": "enum.referenceDateType.modificationDate",
292 "caption": "Modification Date"
293 },
294 "referenceDate": "2024-12-01",
295 "referenceDateTypeNonLease": {
296 "name": "MODIFICATION_DATE",
297 "captionKey": "enum.referenceDateType.modificationDate",
298 "caption": "Modification Date"
299 },
300 "referenceDateNonLease": "2024-12-01",
301 "indexLevelType": {
302 "name": "RATE",
303 "captionKey": "enum.indexLevelType.rate",
304 "caption": "Rate"
305 },
306 "newIndexLevel": 105.5,
307 "indexLevelTypeNonLease": {
308 "name": "RATE",
309 "captionKey": "enum.indexLevelType.rate",
310 "caption": "Rate"
311 },
312 "newIndexLevelNonLease": 103.2,
313 "indexationDateType": {
314 "name": "ROU_ANNIVERSARY_DATE",
315 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
316 "caption": "ROU Anniversary Date"
317 },
318 "indexationDateTypeNonLease": {
319 "name": "ROU_ANNIVERSARY_DATE",
320 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
321 "caption": "ROU Anniversary Date"
322 },
323 "indexationStartDate": "2024-12-01",
324 "indexationStartDateNonLease": "2024-12-01",
325 "postingDateType": {
326 "name": "JOB_DATE",
327 "captionKey": "enum.postingDateType.jobDate",
328 "caption": "Job Date"
329 },
330 "postingDate": "2024-12-01",
331 "documentDate": "2024-12-01",
332 "translationDate": "2024-12-01",
333 "indexationTreatmentType": {
334 "name": "DEFAULT",
335 "captionKey": "enum.indexationTreatmentType.default",
336 "caption": "Default"
337 },
338 "skipActivationGroupsWithOpenDraft": true,
339 "migratedFilterType": {
340 "name": "ALL",
341 "captionKey": "enum.migratedFilterType.all",
342 "caption": "All"
343 },
344 "overrideCPICategoryInputs": [
345 {
346 "consumerPriceIndexCategoryId": 40000001,
347 "consumerPriceIndexCategoryIdNonLease": 40000002,
348 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
349 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
350 "modificationDateType": {
351 "name": "JOB_DATE",
352 "captionKey": "enum.modificationDateType.jobDate",
353 "caption": "Job Date"
354 },
355 "modificationDate": "2024-12-01",
356 "referenceDateType": {
357 "name": "MODIFICATION_DATE",
358 "captionKey": "enum.referenceDateType.modificationDate",
359 "caption": "Modification Date"
360 },
361 "referenceDateTypeNonLease": {
362 "name": "MODIFICATION_DATE",
363 "captionKey": "enum.referenceDateType.modificationDate",
364 "caption": "Modification Date"
365 },
366 "referenceDate": "2024-12-01",
367 "referenceDateNonLease": "2024-12-01",
368 "postingDateType": {
369 "name": "JOB_DATE",
370 "captionKey": "enum.postingDateType.jobDate",
371 "caption": "Job Date"
372 },
373 "postingDate": "2024-12-01",
374 "documentDate": "2024-12-01",
375 "translationDate": "2024-12-01"
376 }
377 ],
378 "revert": false,
379 "reversalReason": {
380 "id": 50000001,
381 "displayId": "REV-001",
382 "status": {
383 "name": "ACTIVE",
384 "captionKey": "enum.objectStatus.active",
385 "active": true,
386 "caption": "Active"
387 },
388 "name": "Incorrect Indexation",
389 "erpSystemId": 60000001,
390 "erpSystemDisplayId": "SAP-PROD"
391 },
392 "assetClassFilterType": {
393 "name": "ALL",
394 "captionKey": "enum.assetClassFilterType.all",
395 "caption": "All"
396 },
397 "assetClasses": [
398 {
399 "id": 10000001,
400 "displayId": "IAC-001",
401 "status": {
402 "name": "ACTIVE",
403 "captionKey": "enum.objectStatus.active",
404 "active": true,
405 "caption": "Active"
406 },
407 "name": "Machinery and Equipment",
408 "assetClassType": "PROPERTY",
409 "infiniteUsefulLife": false
410 }
411 ],
412 "cpiCategoryFilterType": {
413 "name": "ALL",
414 "captionKey": "enum.cpiCategoryFilterType.all",
415 "caption": "All"
416 },
417 "cpiCategories": [
418 {
419 "id": 101,
420 "displayId": "CPI-2025-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "Consumer Price Index - City A",
428 "city": "New York",
429 "country": "USA",
430 "province": "NY",
431 "erpSystemId": 0
432 }
433 ],
434 "listObjectType": {
435 "name": "CONTRACT",
436 "captionKey": "enum.listObjectType.contract",
437 "caption": "Contract"
438 },
439 "objectList": [
440 {
441 "id": 10000001,
442 "displayId": "ENT-001",
443 "name": "Entity Name"
444 }
445 ]
446 },
447 "tasks": [
448 {
449 "id": 10000001,
450 "queueTime": "2025-01-01T10:00:00Z",
451 "startTime": "2025-01-01T10:00:00Z",
452 "endTime": "2025-01-01T10:00:00Z",
453 "interruptedAt": "2025-01-01T10:00:00Z",
454 "recoveredAt": "2025-01-01T10:00:00Z",
455 "status": {
456 "name": "PROCESSING",
457 "captionKey": "enum.batchJobStatus.processing",
458 "caption": "Processing"
459 },
460 "recover": false,
461 "interrupted": false,
462 "interruptionMessage": "sample_interruptionMessage",
463 "errorMessage": "sample_errorMessage",
464 "totalObjectCount": 100,
465 "jobId": 10000001,
466 "batchTaskObjectType": {
467 "name": "CONTRACT",
468 "captionKey": "enum.objectType.contract",
469 "caption": "Contract"
470 },
471 "objectIds": [],
472 "failedObjectIds": [],
473 "taskReport": {
474 "id": 10000001,
475 "scheduledItemCount": 100,
476 "processingItemCount": 100,
477 "doneItemCount": 100,
478 "failedItemCount": 100,
479 "cancelledItemCount": 100,
480 "skippedItemCount": 100,
481 "totalItemCount": 100,
482 "taskId": 10000001
483 }
484 }
485 ]
486 }
487 ],
488 "number": 0,
489 "sort": {
490 "unsorted": false,
491 "sorted": true,
492 "empty": false
493 },
494 "first": true,
495 "last": true,
496 "empty": true
497}
Mass Indexation Job - Get Number Of Filtered Entities¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/number-of-filtered-entities
📋 Description: Submits a request to retrieve the count of filtered entities related to lease contracts and financial obligations for mass indexation jobs within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the criteria for filtering entities related to leases, contracts, financial obligations, and accounting entries for mass indexation jobs. |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "filter": {
20 "id": 70000001,
21 "profileId": 20000001,
22 "jobId": 10000001,
23 "name": "US Leases Filter",
24 "principalPositionType": {
25 "name": "LESSEE",
26 "captionKey": "enum.principalpositiontype.lessee",
27 "caption": "Lessee"
28 },
29 "filterObject": {
30 "erpSystemFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "erpSystems": [
36 {
37 "id": 10000001,
38 "displayId": "ERP-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "SAP Production System",
46 "type": {
47 "name": "NAKISA",
48 "captionKey": "enum.erpSystemType.NAKISA",
49 "caption": "NAKISA"
50 },
51 "sapVersion": {
52 "name": "ECC_EHP5",
53 "captionKey": "enum.sapVersion.ECC_EHP5",
54 "caption": "ECC_EHP5"
55 }
56 }
57 ],
58 "leaseAreaFilterType": {
59 "name": "ALL",
60 "captionKey": "enum.filterType.all",
61 "caption": "All"
62 },
63 "leaseAreas": [
64 {
65 "id": 10000001,
66 "displayId": "0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Global Lease Area"
74 }
75 ],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [
82 {
83 "id": 10000001,
84 "displayId": "BU0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "North America Business Unit"
92 }
93 ],
94 "companyFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "companies": [
100 {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 }
117 ],
118 "leaseDepartmentFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "leaseDepartments": [
124 {
125 "id": 300001,
126 "displayId": "DEP-01",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "Finance Department"
134 }
135 ],
136 "leaseGroupFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "leaseGroups": [
142 {
143 "id": 60000001,
144 "displayId": "LG-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Global Lease Group"
152 }
153 ],
154 "costCenterFilterType": {
155 "name": "ALL",
156 "captionKey": "enum.filterType.all",
157 "caption": "All"
158 },
159 "costCenters": [
160 {
161 "id": 14001,
162 "displayId": "CC-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Cost Center A",
170 "erpSystemId": 0
171 }
172 ],
173 "profitCenterFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "wbses": [
200 {
201 "id": 1001,
202 "displayId": "WBS-2025-001",
203 "status": {
204 "name": "ACTIVE",
205 "captionKey": "enum.objectStatus.active",
206 "active": true,
207 "caption": "Active"
208 },
209 "name": "Main Project WBS",
210 "erpSystemId": 0
211 }
212 ],
213 "businessAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "businessAreas": [
219 {
220 "id": 3001,
221 "displayId": "BA-2025-001",
222 "status": {
223 "name": "ACTIVE",
224 "captionKey": "enum.objectStatus.active",
225 "active": true,
226 "caption": "Active"
227 },
228 "name": "North America Operations",
229 "erpSystemId": 0
230 }
231 ],
232 "functionalAreaFilterType": {
233 "name": "ALL",
234 "captionKey": "enum.filterType.all",
235 "caption": "All"
236 },
237 "functionalAreas": [
238 {
239 "id": 2001,
240 "displayId": "FA-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Accounting Department",
248 "erpSystemId": 0
249 }
250 ]
251 }
252 },
253 "input": {
254 "id": 30000001,
255 "jobIndexationType": {
256 "name": "CPI_LOCAL",
257 "captionKey": "enum.jobIndexationType.cpiLocal",
258 "caption": "CPI Local"
259 },
260 "jobIndexationTypeNonLease": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "modificationDateType": {
266 "name": "JOB_DATE",
267 "captionKey": "enum.modificationDateType.jobDate",
268 "caption": "Job Date"
269 },
270 "modificationDate": "2024-12-01",
271 "referenceDateType": {
272 "name": "MODIFICATION_DATE",
273 "captionKey": "enum.referenceDateType.modificationDate",
274 "caption": "Modification Date"
275 },
276 "referenceDate": "2024-12-01",
277 "referenceDateTypeNonLease": {
278 "name": "MODIFICATION_DATE",
279 "captionKey": "enum.referenceDateType.modificationDate",
280 "caption": "Modification Date"
281 },
282 "referenceDateNonLease": "2024-12-01",
283 "indexLevelType": {
284 "name": "RATE",
285 "captionKey": "enum.indexLevelType.rate",
286 "caption": "Rate"
287 },
288 "newIndexLevel": 105.5,
289 "indexLevelTypeNonLease": {
290 "name": "RATE",
291 "captionKey": "enum.indexLevelType.rate",
292 "caption": "Rate"
293 },
294 "newIndexLevelNonLease": 103.2,
295 "indexationDateType": {
296 "name": "ROU_ANNIVERSARY_DATE",
297 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
298 "caption": "ROU Anniversary Date"
299 },
300 "indexationDateTypeNonLease": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationStartDate": "2024-12-01",
306 "indexationStartDateNonLease": "2024-12-01",
307 "postingDateType": {
308 "name": "JOB_DATE",
309 "captionKey": "enum.postingDateType.jobDate",
310 "caption": "Job Date"
311 },
312 "postingDate": "2024-12-01",
313 "documentDate": "2024-12-01",
314 "translationDate": "2024-12-01",
315 "indexationTreatmentType": {
316 "name": "DEFAULT",
317 "captionKey": "enum.indexationTreatmentType.default",
318 "caption": "Default"
319 },
320 "skipActivationGroupsWithOpenDraft": true,
321 "migratedFilterType": {
322 "name": "ALL",
323 "captionKey": "enum.migratedFilterType.all",
324 "caption": "All"
325 },
326 "overrideCPICategoryInputs": [
327 {
328 "consumerPriceIndexCategoryId": 40000001,
329 "consumerPriceIndexCategoryIdNonLease": 40000002,
330 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
331 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
332 "modificationDateType": {
333 "name": "JOB_DATE",
334 "captionKey": "enum.modificationDateType.jobDate",
335 "caption": "Job Date"
336 },
337 "modificationDate": "2024-12-01",
338 "referenceDateType": {
339 "name": "MODIFICATION_DATE",
340 "captionKey": "enum.referenceDateType.modificationDate",
341 "caption": "Modification Date"
342 },
343 "referenceDateTypeNonLease": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDate": "2024-12-01",
349 "referenceDateNonLease": "2024-12-01",
350 "postingDateType": {
351 "name": "JOB_DATE",
352 "captionKey": "enum.postingDateType.jobDate",
353 "caption": "Job Date"
354 },
355 "postingDate": "2024-12-01",
356 "documentDate": "2024-12-01",
357 "translationDate": "2024-12-01"
358 }
359 ],
360 "revert": false,
361 "reversalReason": {
362 "id": 50000001,
363 "displayId": "REV-001",
364 "status": {
365 "name": "ACTIVE",
366 "captionKey": "enum.objectStatus.active",
367 "active": true,
368 "caption": "Active"
369 },
370 "name": "Incorrect Indexation",
371 "erpSystemId": 60000001,
372 "erpSystemDisplayId": "SAP-PROD"
373 },
374 "assetClassFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.assetClassFilterType.all",
377 "caption": "All"
378 },
379 "assetClasses": [
380 {
381 "id": 10000001,
382 "displayId": "IAC-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Machinery and Equipment",
390 "assetClassType": "PROPERTY",
391 "infiniteUsefulLife": false
392 }
393 ],
394 "cpiCategoryFilterType": {
395 "name": "ALL",
396 "captionKey": "enum.cpiCategoryFilterType.all",
397 "caption": "All"
398 },
399 "cpiCategories": [
400 {
401 "id": 101,
402 "displayId": "CPI-2025-001",
403 "status": {
404 "name": "ACTIVE",
405 "captionKey": "enum.objectStatus.active",
406 "active": true,
407 "caption": "Active"
408 },
409 "name": "Consumer Price Index - City A",
410 "city": "New York",
411 "country": "USA",
412 "province": "NY",
413 "erpSystemId": 0
414 }
415 ],
416 "listObjectType": {
417 "name": "CONTRACT",
418 "captionKey": "enum.listObjectType.contract",
419 "caption": "Contract"
420 },
421 "objectList": [
422 {
423 "id": 10000001,
424 "displayId": "ENT-001",
425 "name": "Entity Name"
426 }
427 ]
428 },
429 "tasks": [
430 {
431 "id": 10000001,
432 "queueTime": "2025-01-01T10:00:00Z",
433 "startTime": "2025-01-01T10:00:00Z",
434 "endTime": "2025-01-01T10:00:00Z",
435 "interruptedAt": "2025-01-01T10:00:00Z",
436 "recoveredAt": "2025-01-01T10:00:00Z",
437 "status": {
438 "name": "PROCESSING",
439 "captionKey": "enum.batchJobStatus.processing",
440 "caption": "Processing"
441 },
442 "recover": false,
443 "interrupted": false,
444 "interruptionMessage": "sample_interruptionMessage",
445 "errorMessage": "sample_errorMessage",
446 "totalObjectCount": 100,
447 "jobId": 10000001,
448 "batchTaskObjectType": {
449 "name": "CONTRACT",
450 "captionKey": "enum.objectType.contract",
451 "caption": "Contract"
452 },
453 "objectIds": [],
454 "failedObjectIds": [],
455 "taskReport": {
456 "id": 10000001,
457 "scheduledItemCount": 100,
458 "processingItemCount": 100,
459 "doneItemCount": 100,
460 "failedItemCount": 100,
461 "cancelledItemCount": 100,
462 "skippedItemCount": 100,
463 "totalItemCount": 100,
464 "taskId": 10000001
465 }
466 }
467 ]
468}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
integer |
Example Responses
10
Mass Indexation Job - Search Master Agreements¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/master-agreements
📋 Description: Submits a batch job for mass indexation of master agreements, facilitating the efficient management of lease and contract data within the Nakisa Lease Accounting Suite to ensure accurate financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the master agreement details, including lease terms, contract identifiers, and associated financial obligations for batch processing in the Nakisa Lease Accounting Suite. |
» request |
body |
false |
Data transfer object representing a filter criteria for retrieving mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»» searchTerm |
body |
string |
false |
The searchTerm field allows users to specify a keyword or phrase to filter lease, contract, and financial obligation entries within the Nakisa Lease Accounting Suite. |
»» displayIds |
body |
[string] |
false |
List of displayIds items |
»» indexationType |
body |
string |
false |
Type of the indexation |
»» indexationTypeNonLease |
body |
string |
false |
Specifies the type of indexation applicable to non-lease financial obligations within the Nakisa Lease Accounting Suite. |
»» skipItemsWithOpenDraft |
body |
boolean |
false |
Boolean flag indicating skipItemsWithOpenDraft status |
»» assetClasses |
body |
false |
List of assetClasses items |
|
»»» id |
body |
integer(int64) |
true |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»» name |
body |
string |
false |
Enum name representing the object status. |
»»»» captionKey |
body |
string |
false |
Localization key for the object status caption. |
»»»» active |
body |
boolean |
false |
Indicates whether the status is active. |
»»»» caption |
body |
string |
false |
Localized caption of the object status. |
»»» name |
body |
string |
false |
Name of the resource |
»»» assetClassType |
body |
string |
false |
Type of the asset class |
»»» infiniteUsefulLife |
body |
boolean |
false |
Boolean flag indicating infiniteUsefulLife status |
»» cpiCategories |
body |
false |
List of cpiCategories items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»» name |
body |
string |
false |
Name of the resource |
»»» city |
body |
string |
false |
Represents the city associated with the lease or contract, providing essential location context for financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
»»» country |
body |
string |
false |
Represents the country associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» province |
body |
string |
false |
Represents the province associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» erpSystemId |
body |
integer(int64) |
false |
none |
»» profile |
body |
true |
Data transfer object representing the criteria used to filter mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»» persistable |
body |
boolean |
false |
Boolean flag indicating persistable status |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» modifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»»» profileId |
body |
integer(int64) |
false |
Unique identifier for the profile |
»»» name |
body |
string |
false |
Name of the resource |
»»» principalPositionType |
body |
string |
false |
Type of the principal position |
»»» filterObject |
body |
false |
Data transfer object representing the various filter types applicable to mass indexation processes within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»»» erpSystemFilterType |
body |
string |
false |
Type of the erp system filter |
»»»» leaseAreaFilterType |
body |
string |
false |
Type of the lease area filter |
»»»» businessUnitFilterType |
body |
string |
false |
Type of the business unit filter |
»»»» companyFilterType |
body |
string |
false |
Type of the company filter |
»»»» leaseDepartmentFilterType |
body |
string |
false |
Type of the lease department filter |
»»»» leaseGroupFilterType |
body |
string |
false |
Type of the lease group filter |
»»»» costCenterFilterType |
body |
string |
false |
Type of the cost center filter |
»»»» profitCenterFilterType |
body |
string |
false |
Type of the profit center filter |
»»»» wbsFilterType |
body |
string |
false |
Type of the wbs filter |
»»»» businessAreaFilterType |
body |
string |
false |
Type of the business area filter |
»»»» functionalAreaFilterType |
body |
string |
false |
Type of the functional area filter |
»»» baseIdList |
body |
false |
List of baseIdList items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» objectType |
body |
string |
false |
Type of the object |
»»» new |
body |
boolean |
false |
Boolean flag indicating new status |
»» migratedFilterType |
body |
string |
true |
Type of the migrated filter |
» pageable |
body |
false |
Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite. |
|
»» page |
body |
integer(int32) |
true |
Page number for pagination |
»» size |
body |
integer(int32) |
true |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»»» id |
|
body |
»»» displayId |
|
body |
»»»» name |
|
body |
»»»» captionKey |
|
body |
»»»» active |
|
body |
»»»» caption |
|
body |
»»» name |
|
body |
»»» assetClassType |
|
body |
»»» infiniteUsefulLife |
|
body |
»»» id |
|
body |
»»» displayId |
|
body |
»»» name |
|
body |
»»» city |
|
body |
»»» country |
|
body |
»»» province |
|
body |
»»»» id |
|
body |
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» indexationType |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» indexationTypeNonLease |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»»» assetClassType |
EQUIPMENT, PLANT, PROPERTY |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» name |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "displayIds": [
5 "string"
6 ],
7 "indexationType": "NONE",
8 "indexationTypeNonLease": "NONE",
9 "skipItemsWithOpenDraft": true,
10 "assetClasses": [
11 {
12 "id": 10000001,
13 "displayId": "IAC-001",
14 "status": {
15 "name": "ACTIVE",
16 "captionKey": "enum.objectStatus.active",
17 "active": true,
18 "caption": "Active"
19 },
20 "name": "Machinery and Equipment",
21 "assetClassType": "PROPERTY",
22 "infiniteUsefulLife": false
23 }
24 ],
25 "cpiCategories": [
26 {
27 "id": 101,
28 "displayId": "CPI-2025-001",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "name": "Consumer Price Index - City A",
36 "city": "New York",
37 "country": "USA",
38 "province": "NY",
39 "erpSystemId": 0
40 }
41 ],
42 "profile": {
43 "persistable": true,
44 "id": 0,
45 "createdBy": "string",
46 "createdAt": "2019-08-24T14:15:22Z",
47 "modifiedBy": "string",
48 "modifiedAt": "2019-08-24T14:15:22Z",
49 "profileId": 0,
50 "name": "string",
51 "principalPositionType": "LESSEE",
52 "filterObject": {
53 "erpSystemFilterType": "ALL",
54 "leaseAreaFilterType": "ALL",
55 "businessUnitFilterType": "ALL",
56 "companyFilterType": "ALL",
57 "leaseDepartmentFilterType": "ALL",
58 "leaseGroupFilterType": "ALL",
59 "costCenterFilterType": "ALL",
60 "profitCenterFilterType": "ALL",
61 "wbsFilterType": "ALL",
62 "businessAreaFilterType": "ALL",
63 "functionalAreaFilterType": "ALL"
64 },
65 "baseIdList": [
66 {
67 "id": 10000001,
68 "displayId": "string",
69 "objectType": "LEASE_AREA"
70 }
71 ],
72 "new": true
73 },
74 "migratedFilterType": "MIGRATED"
75 },
76 "pageable": {
77 "page": 0,
78 "size": 10,
79 "sort": [
80 "id,asc",
81 "name,desc"
82 ]
83 }
84}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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": 10000086,
21 "displayId": "MA-2025-0001",
22 "year": 2023,
23 "name": "Global HQ Lease Agreement",
24 "description": "Master lease agreement for HQ premises.",
25 "validFrom": "2019-08-24",
26 "validTo": "2019-08-24",
27 "targetValue": 1000000,
28 "legalJurisdiction": "Germany",
29 "approverComment": "Reviewed and approved by legal team.",
30 "signingPerson": "John Doe",
31 "placeOfSignature": "Berlin, Germany",
32 "dateOfSignature": "2019-08-24",
33 "state": {
34 "name": "MLA_ACTIVE",
35 "captionKey": "enum.mlaStatus.mlaActive",
36 "caption": "Active"
37 },
38 "dataCreationInfo": {
39 "id": 10000001,
40 "idGenerationType": {
41 "name": "AUTO",
42 "captionKey": "enum.idGenerationType.auto",
43 "caption": "Auto"
44 },
45 "source": "sample_source",
46 "type": {
47 "name": "MIGRATION",
48 "captionKey": "enum.dataType.migration",
49 "caption": "Migration"
50 },
51 "startDateTime": "2025-01-01T10:00:00Z",
52 "endDateTime": "2025-01-01T10:00:00Z"
53 },
54 "agreementGroup": {
55 "id": 20000001,
56 "displayId": "AG-001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "Global Agreement Group"
64 },
65 "currency": {
66 "id": 840,
67 "displayId": "USD",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "United States Dollar",
75 "decimalPoints": 2
76 },
77 "internalAssetClass": {
78 "id": 10000001,
79 "displayId": "IAC-001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Machinery and Equipment",
87 "assetClassType": "PROPERTY",
88 "infiniteUsefulLife": false
89 },
90 "leaseArea": {
91 "id": 10000001,
92 "displayId": "0001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Area"
100 },
101 "businessUnit": {
102 "id": 10000001,
103 "displayId": "BU0001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "North America Business Unit"
111 },
112 "companyCode": {
113 "id": 10000006,
114 "displayId": "1005",
115 "status": {
116 "name": "ACTIVE",
117 "captionKey": "enum.objectStatus.active",
118 "active": true,
119 "caption": "Active"
120 },
121 "erpSystemId": 10000001,
122 "erpSystemDisplayId": "FINQ8S-300",
123 "countryId": 10000095,
124 "countryDisplayId": "CA",
125 "name": "string",
126 "postingPeriodVariantId": 0,
127 "fiscalVariantId": 0
128 },
129 "department": {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 },
140 "leaseGroup": {
141 "id": 60000001,
142 "displayId": "LG-001",
143 "status": {
144 "name": "ACTIVE",
145 "captionKey": "enum.objectStatus.active",
146 "active": true,
147 "caption": "Active"
148 },
149 "name": "Global Lease Group"
150 },
151 "allowsSystemGenerateNewId": true,
152 "numberRangeIdentifierValue": "0001",
153 "numberRangeIdentifierType": {
154 "name": "COMPANY_CODE"
155 },
156 "numberRangeType": {
157 "name": "CONTRACT"
158 }
159 }
160 ],
161 "number": 0,
162 "sort": {
163 "unsorted": false,
164 "sorted": true,
165 "empty": false
166 },
167 "first": true,
168 "last": true,
169 "empty": false
170}
Mass Indexation Job - Search Lease Components¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/lease-components
📋 Description: Creates new lease component jobs for mass indexation within the Nakisa Lease Accounting Suite, facilitating the efficient management of lease contracts and associated financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the lease component data, including details on contracts, financial obligations, and associated accounting entries for mass indexation processing. |
» request |
body |
false |
Data transfer object representing a filter criteria for retrieving mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»» searchTerm |
body |
string |
false |
The searchTerm field allows users to specify a keyword or phrase to filter lease, contract, and financial obligation entries within the Nakisa Lease Accounting Suite. |
»» displayIds |
body |
[string] |
false |
List of displayIds items |
»» indexationType |
body |
string |
false |
Type of the indexation |
»» indexationTypeNonLease |
body |
string |
false |
Specifies the type of indexation applicable to non-lease financial obligations within the Nakisa Lease Accounting Suite. |
»» skipItemsWithOpenDraft |
body |
boolean |
false |
Boolean flag indicating skipItemsWithOpenDraft status |
»» assetClasses |
body |
false |
List of assetClasses items |
|
»»» id |
body |
integer(int64) |
true |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»» name |
body |
string |
false |
Enum name representing the object status. |
»»»» captionKey |
body |
string |
false |
Localization key for the object status caption. |
»»»» active |
body |
boolean |
false |
Indicates whether the status is active. |
»»»» caption |
body |
string |
false |
Localized caption of the object status. |
»»» name |
body |
string |
false |
Name of the resource |
»»» assetClassType |
body |
string |
false |
Type of the asset class |
»»» infiniteUsefulLife |
body |
boolean |
false |
Boolean flag indicating infiniteUsefulLife status |
»» cpiCategories |
body |
false |
List of cpiCategories items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»» name |
body |
string |
false |
Name of the resource |
»»» city |
body |
string |
false |
Represents the city associated with the lease or contract, providing essential location context for financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
»»» country |
body |
string |
false |
Represents the country associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» province |
body |
string |
false |
Represents the province associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» erpSystemId |
body |
integer(int64) |
false |
none |
»» profile |
body |
true |
Data transfer object representing the criteria used to filter mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»» persistable |
body |
boolean |
false |
Boolean flag indicating persistable status |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» modifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»»» profileId |
body |
integer(int64) |
false |
Unique identifier for the profile |
»»» name |
body |
string |
false |
Name of the resource |
»»» principalPositionType |
body |
string |
false |
Type of the principal position |
»»» filterObject |
body |
false |
Data transfer object representing the various filter types applicable to mass indexation processes within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»»» erpSystemFilterType |
body |
string |
false |
Type of the erp system filter |
»»»» leaseAreaFilterType |
body |
string |
false |
Type of the lease area filter |
»»»» businessUnitFilterType |
body |
string |
false |
Type of the business unit filter |
»»»» companyFilterType |
body |
string |
false |
Type of the company filter |
»»»» leaseDepartmentFilterType |
body |
string |
false |
Type of the lease department filter |
»»»» leaseGroupFilterType |
body |
string |
false |
Type of the lease group filter |
»»»» costCenterFilterType |
body |
string |
false |
Type of the cost center filter |
»»»» profitCenterFilterType |
body |
string |
false |
Type of the profit center filter |
»»»» wbsFilterType |
body |
string |
false |
Type of the wbs filter |
»»»» businessAreaFilterType |
body |
string |
false |
Type of the business area filter |
»»»» functionalAreaFilterType |
body |
string |
false |
Type of the functional area filter |
»»» baseIdList |
body |
false |
List of baseIdList items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» objectType |
body |
string |
false |
Type of the object |
»»» new |
body |
boolean |
false |
Boolean flag indicating new status |
»» migratedFilterType |
body |
string |
true |
Type of the migrated filter |
» pageable |
body |
false |
Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite. |
|
»» page |
body |
integer(int32) |
true |
Page number for pagination |
»» size |
body |
integer(int32) |
true |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»»» id |
|
body |
»»» displayId |
|
body |
»»»» name |
|
body |
»»»» captionKey |
|
body |
»»»» active |
|
body |
»»»» caption |
|
body |
»»» name |
|
body |
»»» assetClassType |
|
body |
»»» infiniteUsefulLife |
|
body |
»»» id |
|
body |
»»» displayId |
|
body |
»»» name |
|
body |
»»» city |
|
body |
»»» country |
|
body |
»»» province |
|
body |
»»»» id |
|
body |
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» indexationType |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» indexationTypeNonLease |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»»» assetClassType |
EQUIPMENT, PLANT, PROPERTY |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» name |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "displayIds": [
5 "string"
6 ],
7 "indexationType": "NONE",
8 "indexationTypeNonLease": "NONE",
9 "skipItemsWithOpenDraft": true,
10 "assetClasses": [
11 {
12 "id": 10000001,
13 "displayId": "IAC-001",
14 "status": {
15 "name": "ACTIVE",
16 "captionKey": "enum.objectStatus.active",
17 "active": true,
18 "caption": "Active"
19 },
20 "name": "Machinery and Equipment",
21 "assetClassType": "PROPERTY",
22 "infiniteUsefulLife": false
23 }
24 ],
25 "cpiCategories": [
26 {
27 "id": 101,
28 "displayId": "CPI-2025-001",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "name": "Consumer Price Index - City A",
36 "city": "New York",
37 "country": "USA",
38 "province": "NY",
39 "erpSystemId": 0
40 }
41 ],
42 "profile": {
43 "persistable": true,
44 "id": 0,
45 "createdBy": "string",
46 "createdAt": "2019-08-24T14:15:22Z",
47 "modifiedBy": "string",
48 "modifiedAt": "2019-08-24T14:15:22Z",
49 "profileId": 0,
50 "name": "string",
51 "principalPositionType": "LESSEE",
52 "filterObject": {
53 "erpSystemFilterType": "ALL",
54 "leaseAreaFilterType": "ALL",
55 "businessUnitFilterType": "ALL",
56 "companyFilterType": "ALL",
57 "leaseDepartmentFilterType": "ALL",
58 "leaseGroupFilterType": "ALL",
59 "costCenterFilterType": "ALL",
60 "profitCenterFilterType": "ALL",
61 "wbsFilterType": "ALL",
62 "businessAreaFilterType": "ALL",
63 "functionalAreaFilterType": "ALL"
64 },
65 "baseIdList": [
66 {
67 "id": 10000001,
68 "displayId": "string",
69 "objectType": "LEASE_AREA"
70 }
71 ],
72 "new": true
73 },
74 "migratedFilterType": "MIGRATED"
75 },
76 "pageable": {
77 "page": 0,
78 "size": 10,
79 "sort": [
80 "id,asc",
81 "name,desc"
82 ]
83 }
84}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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": 10000003,
21 "displayId": "LC-100000002",
22 "principalPositionType": {
23 "name": "LESSEE",
24 "captionKey": "enum.principalpositiontype.lessee",
25 "caption": "Lessee"
26 },
27 "name": "patched lease component",
28 "description": "string",
29 "bulkAsset": false,
30 "rouStartDate": "2019-08-24",
31 "rouEndDate": "2019-08-24",
32 "approverComment": "string",
33 "fairMarketValue": 0,
34 "allocationNumber": "string",
35 "guaranteedResidualValue": 0,
36 "unitDistributions": [],
37 "revision": {
38 "id": 10000003,
39 "displayId": "0461332847-20250827-142605",
40 "name": "Inception",
41 "inception": true,
42 "revisionType": "ACTIVE",
43 "state": "LC_DEFINE",
44 "approvedBy": "string",
45 "approvedAt": "2019-08-24",
46 "parentRevisionId": 0,
47 "approverComment": "string",
48 "leaseComponentId": 10000003,
49 "leaseComponentDisplayId": "LC-100000002",
50 "leaseComponentName": "Test2 lease component",
51 "contractRevisionId": 10000001,
52 "contractRevisionDisplayId": "1617141777-20250724-115809",
53 "numberRangeIdentifierValue": "string",
54 "numberRangeIdentifierType": {
55 "name": "COMPANY_CODE"
56 },
57 "numberRangeType": {
58 "name": "CONTRACT"
59 },
60 "allowsSystemGenerateNewId": false
61 },
62 "internalAssetClass": {
63 "id": 10000001,
64 "displayId": "IAC-001",
65 "status": {
66 "name": "ACTIVE",
67 "captionKey": "enum.objectStatus.active",
68 "active": true,
69 "caption": "Active"
70 },
71 "name": "Machinery and Equipment",
72 "assetClassType": "PROPERTY",
73 "infiniteUsefulLife": false
74 },
75 "unitOfMeasure": {
76 "id": 10000198,
77 "displayId": "MPA",
78 "status": {
79 "name": "ACTIVE",
80 "captionKey": "enum.objectStatus.active",
81 "active": true,
82 "caption": "Active"
83 },
84 "name": "Megapascal",
85 "erpSystemId": 10000001
86 },
87 "notifications": [],
88 "spreadingFrequency": "NONE",
89 "contractId": 10000001,
90 "contractDisplayId": "CT-100000000",
91 "companyCodeId": 10000002,
92 "companyCodeDisplayId": "string",
93 "userDeterminedLeaseType": {
94 "name": "LEASE_CONTRACT_FIX",
95 "captionKey": "enum.leaseType.fix",
96 "principalPositionType": "LESSEE",
97 "caption": "Fixed Lease Contract"
98 },
99 "endOfTermDate": "2019-08-24",
100 "endOfTermPeriod": "string",
101 "allowsSystemGenerateNewId": false,
102 "transferInfo": {
103 "transferredFromDisplayId": "CTR-00012",
104 "transferredFromRevisionId": 20000001,
105 "transferredToDisplayId": "CTR-00015",
106 "transferredToRevisionId": 20000005
107 },
108 "numberRangeIdentifierValue": "string",
109 "numberRangeIdentifierType": {
110 "name": "COMPANY_CODE"
111 },
112 "numberRangeType": {
113 "name": "CONTRACT"
114 },
115 "type": "LESSEE"
116 }
117 ],
118 "number": 0,
119 "sort": {
120 "unsorted": false,
121 "sorted": true,
122 "empty": false
123 },
124 "first": true,
125 "last": true,
126 "empty": false
127}
Mass Indexation Job - Search Contracts¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/contracts
📋 Description: Creates a new mass indexation job for contracts within the Nakisa Lease Accounting Suite, enabling efficient processing of financial obligations and accounting entries related to lease agreements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the contract details, including lease terms and financial obligations, necessary for initiating batch mass indexation jobs within the Nakisa Lease Accounting Suite. |
» request |
body |
false |
Data transfer object representing a filter criteria for retrieving mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»» searchTerm |
body |
string |
false |
The searchTerm field allows users to specify a keyword or phrase to filter lease, contract, and financial obligation entries within the Nakisa Lease Accounting Suite. |
»» displayIds |
body |
[string] |
false |
List of displayIds items |
»» indexationType |
body |
string |
false |
Type of the indexation |
»» indexationTypeNonLease |
body |
string |
false |
Specifies the type of indexation applicable to non-lease financial obligations within the Nakisa Lease Accounting Suite. |
»» skipItemsWithOpenDraft |
body |
boolean |
false |
Boolean flag indicating skipItemsWithOpenDraft status |
»» assetClasses |
body |
false |
List of assetClasses items |
|
»»» id |
body |
integer(int64) |
true |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»» name |
body |
string |
false |
Enum name representing the object status. |
»»»» captionKey |
body |
string |
false |
Localization key for the object status caption. |
»»»» active |
body |
boolean |
false |
Indicates whether the status is active. |
»»»» caption |
body |
string |
false |
Localized caption of the object status. |
»»» name |
body |
string |
false |
Name of the resource |
»»» assetClassType |
body |
string |
false |
Type of the asset class |
»»» infiniteUsefulLife |
body |
boolean |
false |
Boolean flag indicating infiniteUsefulLife status |
»» cpiCategories |
body |
false |
List of cpiCategories items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»» name |
body |
string |
false |
Name of the resource |
»»» city |
body |
string |
false |
Represents the city associated with the lease or contract, providing essential location context for financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
»»» country |
body |
string |
false |
Represents the country associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» province |
body |
string |
false |
Represents the province associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» erpSystemId |
body |
integer(int64) |
false |
none |
»» profile |
body |
true |
Data transfer object representing the criteria used to filter mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»» persistable |
body |
boolean |
false |
Boolean flag indicating persistable status |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» modifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»»» profileId |
body |
integer(int64) |
false |
Unique identifier for the profile |
»»» name |
body |
string |
false |
Name of the resource |
»»» principalPositionType |
body |
string |
false |
Type of the principal position |
»»» filterObject |
body |
false |
Data transfer object representing the various filter types applicable to mass indexation processes within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»»» erpSystemFilterType |
body |
string |
false |
Type of the erp system filter |
»»»» leaseAreaFilterType |
body |
string |
false |
Type of the lease area filter |
»»»» businessUnitFilterType |
body |
string |
false |
Type of the business unit filter |
»»»» companyFilterType |
body |
string |
false |
Type of the company filter |
»»»» leaseDepartmentFilterType |
body |
string |
false |
Type of the lease department filter |
»»»» leaseGroupFilterType |
body |
string |
false |
Type of the lease group filter |
»»»» costCenterFilterType |
body |
string |
false |
Type of the cost center filter |
»»»» profitCenterFilterType |
body |
string |
false |
Type of the profit center filter |
»»»» wbsFilterType |
body |
string |
false |
Type of the wbs filter |
»»»» businessAreaFilterType |
body |
string |
false |
Type of the business area filter |
»»»» functionalAreaFilterType |
body |
string |
false |
Type of the functional area filter |
»»» baseIdList |
body |
false |
List of baseIdList items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» objectType |
body |
string |
false |
Type of the object |
»»» new |
body |
boolean |
false |
Boolean flag indicating new status |
»» migratedFilterType |
body |
string |
true |
Type of the migrated filter |
» pageable |
body |
false |
Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite. |
|
»» page |
body |
integer(int32) |
true |
Page number for pagination |
»» size |
body |
integer(int32) |
true |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»»» id |
|
body |
»»» displayId |
|
body |
»»»» name |
|
body |
»»»» captionKey |
|
body |
»»»» active |
|
body |
»»»» caption |
|
body |
»»» name |
|
body |
»»» assetClassType |
|
body |
»»» infiniteUsefulLife |
|
body |
»»» id |
|
body |
»»» displayId |
|
body |
»»» name |
|
body |
»»» city |
|
body |
»»» country |
|
body |
»»» province |
|
body |
»»»» id |
|
body |
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» indexationType |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» indexationTypeNonLease |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»»» assetClassType |
EQUIPMENT, PLANT, PROPERTY |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» name |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "displayIds": [
5 "string"
6 ],
7 "indexationType": "NONE",
8 "indexationTypeNonLease": "NONE",
9 "skipItemsWithOpenDraft": true,
10 "assetClasses": [
11 {
12 "id": 10000001,
13 "displayId": "IAC-001",
14 "status": {
15 "name": "ACTIVE",
16 "captionKey": "enum.objectStatus.active",
17 "active": true,
18 "caption": "Active"
19 },
20 "name": "Machinery and Equipment",
21 "assetClassType": "PROPERTY",
22 "infiniteUsefulLife": false
23 }
24 ],
25 "cpiCategories": [
26 {
27 "id": 101,
28 "displayId": "CPI-2025-001",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "name": "Consumer Price Index - City A",
36 "city": "New York",
37 "country": "USA",
38 "province": "NY",
39 "erpSystemId": 0
40 }
41 ],
42 "profile": {
43 "persistable": true,
44 "id": 0,
45 "createdBy": "string",
46 "createdAt": "2019-08-24T14:15:22Z",
47 "modifiedBy": "string",
48 "modifiedAt": "2019-08-24T14:15:22Z",
49 "profileId": 0,
50 "name": "string",
51 "principalPositionType": "LESSEE",
52 "filterObject": {
53 "erpSystemFilterType": "ALL",
54 "leaseAreaFilterType": "ALL",
55 "businessUnitFilterType": "ALL",
56 "companyFilterType": "ALL",
57 "leaseDepartmentFilterType": "ALL",
58 "leaseGroupFilterType": "ALL",
59 "costCenterFilterType": "ALL",
60 "profitCenterFilterType": "ALL",
61 "wbsFilterType": "ALL",
62 "businessAreaFilterType": "ALL",
63 "functionalAreaFilterType": "ALL"
64 },
65 "baseIdList": [
66 {
67 "id": 10000001,
68 "displayId": "string",
69 "objectType": "LEASE_AREA"
70 }
71 ],
72 "new": true
73 },
74 "migratedFilterType": "MIGRATED"
75 },
76 "pageable": {
77 "page": 0,
78 "size": 10,
79 "sort": [
80 "id,asc",
81 "name,desc"
82 ]
83 }
84}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
Mass Indexation Job - Cancel Tasks¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/cancel/{jobId}
📋 Description: Cancels a specified mass indexation job within the Nakisa Lease Accounting Suite, allowing users to halt the processing of lease, contract, or financial obligation entries associated with that job.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
jobId |
path |
integer(int64) |
true |
Unique identifier for the job |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Mass Indexation Job - Search Activation Groups¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs/activation-groups
📋 Description: Creates activation groups for mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the efficient management of lease contracts and associated financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the activation group details for mass indexation jobs, including lease, contract, and financial obligation information essential for accurate accounting entries. |
» request |
body |
false |
Data transfer object representing a filter criteria for retrieving mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»» searchTerm |
body |
string |
false |
The searchTerm field allows users to specify a keyword or phrase to filter lease, contract, and financial obligation entries within the Nakisa Lease Accounting Suite. |
»» displayIds |
body |
[string] |
false |
List of displayIds items |
»» indexationType |
body |
string |
false |
Type of the indexation |
»» indexationTypeNonLease |
body |
string |
false |
Specifies the type of indexation applicable to non-lease financial obligations within the Nakisa Lease Accounting Suite. |
»» skipItemsWithOpenDraft |
body |
boolean |
false |
Boolean flag indicating skipItemsWithOpenDraft status |
»» assetClasses |
body |
false |
List of assetClasses items |
|
»»» id |
body |
integer(int64) |
true |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»» name |
body |
string |
false |
Enum name representing the object status. |
»»»» captionKey |
body |
string |
false |
Localization key for the object status caption. |
»»»» active |
body |
boolean |
false |
Indicates whether the status is active. |
»»»» caption |
body |
string |
false |
Localized caption of the object status. |
»»» name |
body |
string |
false |
Name of the resource |
»»» assetClassType |
body |
string |
false |
Type of the asset class |
»»» infiniteUsefulLife |
body |
boolean |
false |
Boolean flag indicating infiniteUsefulLife status |
»» cpiCategories |
body |
false |
List of cpiCategories items |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»» name |
body |
string |
false |
Name of the resource |
»»» city |
body |
string |
false |
Represents the city associated with the lease or contract, providing essential location context for financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
»»» country |
body |
string |
false |
Represents the country associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» province |
body |
string |
false |
Represents the province associated with the lease or contract, essential for accurate financial obligation tracking and accounting entries within the Nakisa Lease Accounting Suite. |
»»» erpSystemId |
body |
integer(int64) |
false |
none |
»» profile |
body |
true |
Data transfer object representing the criteria used to filter mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»» persistable |
body |
boolean |
false |
Boolean flag indicating persistable status |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» modifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»»» profileId |
body |
integer(int64) |
false |
Unique identifier for the profile |
»»» name |
body |
string |
false |
Name of the resource |
»»» principalPositionType |
body |
string |
false |
Type of the principal position |
»»» filterObject |
body |
false |
Data transfer object representing the various filter types applicable to mass indexation processes within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. |
|
»»»» erpSystemFilterType |
body |
string |
false |
Type of the erp system filter |
»»»» leaseAreaFilterType |
body |
string |
false |
Type of the lease area filter |
»»»» businessUnitFilterType |
body |
string |
false |
Type of the business unit filter |
»»»» companyFilterType |
body |
string |
false |
Type of the company filter |
»»»» leaseDepartmentFilterType |
body |
string |
false |
Type of the lease department filter |
»»»» leaseGroupFilterType |
body |
string |
false |
Type of the lease group filter |
»»»» costCenterFilterType |
body |
string |
false |
Type of the cost center filter |
»»»» profitCenterFilterType |
body |
string |
false |
Type of the profit center filter |
»»»» wbsFilterType |
body |
string |
false |
Type of the wbs filter |
»»»» businessAreaFilterType |
body |
string |
false |
Type of the business area filter |
»»»» functionalAreaFilterType |
body |
string |
false |
Type of the functional area filter |
»»» baseIdList |
body |
false |
List of baseIdList items |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»»» objectType |
body |
string |
false |
Type of the object |
»»» new |
body |
boolean |
false |
Boolean flag indicating new status |
»» migratedFilterType |
body |
string |
true |
Type of the migrated filter |
» pageable |
body |
false |
Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite. |
|
»» page |
body |
integer(int32) |
true |
Page number for pagination |
»» size |
body |
integer(int32) |
true |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»»» id |
|
body |
»»» displayId |
|
body |
»»»» name |
|
body |
»»»» captionKey |
|
body |
»»»» active |
|
body |
»»»» caption |
|
body |
»»» name |
|
body |
»»» assetClassType |
|
body |
»»» infiniteUsefulLife |
|
body |
»»» id |
|
body |
»»» displayId |
|
body |
»»» name |
|
body |
»»» city |
|
body |
»»» country |
|
body |
»»» province |
|
body |
»»»» id |
|
body |
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» indexationType |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» indexationTypeNonLease |
CPI_GLOBAL, CPI_LOCAL, NONE |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»»» assetClassType |
EQUIPMENT, PLANT, PROPERTY |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» name |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "displayIds": [
5 "string"
6 ],
7 "indexationType": "NONE",
8 "indexationTypeNonLease": "NONE",
9 "skipItemsWithOpenDraft": true,
10 "assetClasses": [
11 {
12 "id": 10000001,
13 "displayId": "IAC-001",
14 "status": {
15 "name": "ACTIVE",
16 "captionKey": "enum.objectStatus.active",
17 "active": true,
18 "caption": "Active"
19 },
20 "name": "Machinery and Equipment",
21 "assetClassType": "PROPERTY",
22 "infiniteUsefulLife": false
23 }
24 ],
25 "cpiCategories": [
26 {
27 "id": 101,
28 "displayId": "CPI-2025-001",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "name": "Consumer Price Index - City A",
36 "city": "New York",
37 "country": "USA",
38 "province": "NY",
39 "erpSystemId": 0
40 }
41 ],
42 "profile": {
43 "persistable": true,
44 "id": 0,
45 "createdBy": "string",
46 "createdAt": "2019-08-24T14:15:22Z",
47 "modifiedBy": "string",
48 "modifiedAt": "2019-08-24T14:15:22Z",
49 "profileId": 0,
50 "name": "string",
51 "principalPositionType": "LESSEE",
52 "filterObject": {
53 "erpSystemFilterType": "ALL",
54 "leaseAreaFilterType": "ALL",
55 "businessUnitFilterType": "ALL",
56 "companyFilterType": "ALL",
57 "leaseDepartmentFilterType": "ALL",
58 "leaseGroupFilterType": "ALL",
59 "costCenterFilterType": "ALL",
60 "profitCenterFilterType": "ALL",
61 "wbsFilterType": "ALL",
62 "businessAreaFilterType": "ALL",
63 "functionalAreaFilterType": "ALL"
64 },
65 "baseIdList": [
66 {
67 "id": 10000001,
68 "displayId": "string",
69 "objectType": "LEASE_AREA"
70 }
71 ],
72 "new": true
73 },
74 "migratedFilterType": "MIGRATED"
75 },
76 "pageable": {
77 "page": 0,
78 "size": 10,
79 "sort": [
80 "id,asc",
81 "name,desc"
82 ]
83 }
84}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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": 10000001,
21 "displayId": "AG-100000000",
22 "principalPositionType": {
23 "name": "LESSEE",
24 "captionKey": "enum.principalpositiontype.lessee",
25 "caption": "Lessee"
26 },
27 "name": "Test2",
28 "description": "test2",
29 "approverComment": "Approved after review",
30 "snapshotData": {
31 "isParallelCurrencyEnabled": true,
32 "isCostCenterAllocationEnabled": false,
33 "useSpotRateForGroupCurrency": true,
34 "usePostingOrDocumentDateForCurrency": true,
35 "exchangeRateTypes": [
36 {
37 "currencyDefinitionType": "CONTRACT_CURRENCY",
38 "sourceCurrencyType": "COMPANY_CURRENCY",
39 "translationDateType": "POSTING_DATE",
40 "targetCurrency": {
41 "id": "string",
42 "displayId": "US Dollar",
43 "decimalPoints": 2
44 },
45 "referenceCurrency": {
46 "id": "string",
47 "displayId": "Euro"
48 },
49 "currencyType": "GROUP_CURRENCY",
50 "exchangeRateType": "STANDARD"
51 }
52 ]
53 },
54 "revision": {
55 "id": 10000001,
56 "displayId": "0374999413-20250903-161147",
57 "name": "Inception",
58 "inception": true,
59 "revisionType": "REVISION",
60 "state": "MLA_DEFINE",
61 "approvedBy": "approver.admin@nakisa.com",
62 "approvedAt": "2019-08-24T14:15:22Z",
63 "parentRevisionId": 10000000,
64 "approverComment": "Approved after financial validation.",
65 "rouStartDate": "2025-08-01",
66 "rouEndDate": "2025-08-20",
67 "activationGroupModification": {
68 "modificationDate": "2025-08-15",
69 "terminationType": "CASUALTY",
70 "terminationDate": {
71 "timing": "START_OF_DAY",
72 "year": 2025,
73 "monthValue": 9,
74 "dayOfMonth": 4,
75 "leapYear": false,
76 "month": "SEPTEMBER",
77 "dayOfWeek": "THURSDAY",
78 "dayOfYear": 247
79 },
80 "useManualFmvValue": true,
81 "useManualAssetValues": false,
82 "enforceNonLeaseOnIndexation": false,
83 "applyIndexationLease": true,
84 "applyIndexationNonLease": false,
85 "indexationTreatmentType": "DEFAULT",
86 "indexationStartDate": "2025-09-01",
87 "indexationDateType": "USER_DEFINED",
88 "indexationStartDateNonLease": "2025-09-10",
89 "indexationDateTypeNonLease": "USER_DEFINED",
90 "modificationReasons": [
91 "CONTRACT_RATE_CHANGE",
92 "INDEXATION"
93 ],
94 "modificationPerClassificationList": [
95 {
96 "accountingStandardId": 1001,
97 "classificationType": "NON_LEASE",
98 "accountingStandardType": "IFRS",
99 "impairmentAmount": 2500.5,
100 "recoverableAmount": 2000,
101 "decreaseInAsset": 1500,
102 "decreaseInTerm": 6
103 }
104 ],
105 "massIndexationTaskId": 987654
106 },
107 "activationGroupId": 10000001,
108 "activationGroupDisplayId": "AG-100000000",
109 "activationGroupName": "Test2",
110 "leaseComponentRevisionId": 10000007,
111 "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
112 "lastLeaseComponentRevisionId": 10000006,
113 "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
114 "clonedFromRevisionId": 10000002,
115 "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
116 "lockReason": "PENDING_TERMINATION",
117 "infiniteUsefulLife": false,
118 "transferOfOwnership": false,
119 "specializedAsset": false,
120 "fairMarketValue": 1,
121 "residualValue": 1,
122 "endOfTermIntention": "TO_BE_DETERMINED",
123 "endOfTermDate": "2025-08-11",
124 "endOfTermPeriod": 9,
125 "activationDocumentDate": "2019-08-24",
126 "activationPostingDate": "2019-08-24",
127 "closingDocumentDate": "2019-08-24",
128 "closingPostingDate": "2019-08-24",
129 "numberRangeIdentifierValue": "1000",
130 "numberRangeIdentifierType": {
131 "name": "COMPANY_CODE"
132 },
133 "numberRangeType": {
134 "name": "CONTRACT"
135 },
136 "allowsSystemGenerateNewId": false
137 },
138 "leaseComponentId": 10000007,
139 "leaseComponentDisplayId": "LC-100000200",
140 "companyCodeId": 10000002,
141 "companyCodeDisplayId": "1000",
142 "splittedFromActivationGroupRevisionId": {
143 "id": 10000001,
144 "displayId": "0374999413-20250903-161147",
145 "name": "Inception",
146 "inception": true,
147 "revisionType": "REVISION",
148 "state": "MLA_DEFINE",
149 "approvedBy": "approver.admin@nakisa.com",
150 "approvedAt": "2019-08-24T14:15:22Z",
151 "parentRevisionId": 10000000,
152 "approverComment": "Approved after financial validation.",
153 "rouStartDate": "2025-08-01",
154 "rouEndDate": "2025-08-20",
155 "activationGroupModification": {
156 "modificationDate": "2025-08-15",
157 "terminationType": "CASUALTY",
158 "terminationDate": {
159 "timing": "START_OF_DAY",
160 "year": 2025,
161 "monthValue": 9,
162 "dayOfMonth": 4,
163 "leapYear": false,
164 "month": "SEPTEMBER",
165 "dayOfWeek": "THURSDAY",
166 "dayOfYear": 247
167 },
168 "useManualFmvValue": true,
169 "useManualAssetValues": false,
170 "enforceNonLeaseOnIndexation": false,
171 "applyIndexationLease": true,
172 "applyIndexationNonLease": false,
173 "indexationTreatmentType": "DEFAULT",
174 "indexationStartDate": "2025-09-01",
175 "indexationDateType": "USER_DEFINED",
176 "indexationStartDateNonLease": "2025-09-10",
177 "indexationDateTypeNonLease": "USER_DEFINED",
178 "modificationReasons": [
179 "CONTRACT_RATE_CHANGE",
180 "INDEXATION"
181 ],
182 "modificationPerClassificationList": [
183 {
184 "accountingStandardId": 1001,
185 "classificationType": "NON_LEASE",
186 "accountingStandardType": "IFRS",
187 "impairmentAmount": 2500.5,
188 "recoverableAmount": 2000,
189 "decreaseInAsset": 1500,
190 "decreaseInTerm": 6
191 }
192 ],
193 "massIndexationTaskId": 987654
194 },
195 "activationGroupId": 10000001,
196 "activationGroupDisplayId": "AG-100000000",
197 "activationGroupName": "Test2",
198 "leaseComponentRevisionId": 10000007,
199 "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
200 "lastLeaseComponentRevisionId": 10000006,
201 "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
202 "clonedFromRevisionId": 10000002,
203 "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
204 "lockReason": "PENDING_TERMINATION",
205 "infiniteUsefulLife": false,
206 "transferOfOwnership": false,
207 "specializedAsset": false,
208 "fairMarketValue": 1,
209 "residualValue": 1,
210 "endOfTermIntention": "TO_BE_DETERMINED",
211 "endOfTermDate": "2025-08-11",
212 "endOfTermPeriod": 9,
213 "activationDocumentDate": "2019-08-24",
214 "activationPostingDate": "2019-08-24",
215 "closingDocumentDate": "2019-08-24",
216 "closingPostingDate": "2019-08-24",
217 "numberRangeIdentifierValue": "1000",
218 "numberRangeIdentifierType": {
219 "name": "COMPANY_CODE"
220 },
221 "numberRangeType": {
222 "name": "CONTRACT"
223 },
224 "allowsSystemGenerateNewId": false
225 },
226 "notifications": [
227 {
228 "id": 100045,
229 "topic": {
230 "enCaption": "Lease Component Updated",
231 "frCaption": "Composant de bail mis à jour",
232 "name": "LEASE_COMPONENT_UPDATED",
233 "priority": "HIGH"
234 },
235 "username": "jdoe",
236 "activationGroupId": 20000123,
237 "activationGroupDisplayId": "AG-100045",
238 "targetId": "jdoe@example.com",
239 "targetType": "USER"
240 }
241 ],
242 "transferInfo": {
243 "transferredFromDisplayId": "CTR-00012",
244 "transferredFromRevisionId": 20000001,
245 "transferredToDisplayId": "CTR-00015",
246 "transferredToRevisionId": 20000005
247 },
248 "numberRangeIdentifierValue": "1000",
249 "numberRangeIdentifierType": {
250 "name": "COMPANY_CODE"
251 },
252 "numberRangeType": {
253 "name": "CONTRACT"
254 },
255 "allowsSystemGenerateNewId": false
256 }
257 ],
258 "number": 0,
259 "sort": {
260 "unsorted": false,
261 "sorted": true,
262 "empty": false
263 },
264 "first": true,
265 "last": true,
266 "empty": false
267}
Mass Indexation Job - Find All¶
HTTP Request
GET /api/v1/batch/mass-indexation/jobs
📋 Description: Retrieves a list of mass indexation jobs related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling users to monitor and manage accounting entries efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the mass indexation jobs query should be returned in a paginated format, facilitating efficient retrieval of lease and contract-related data within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "taskCount": 0,
22 "failedTaskCount": 0,
23 "doneTaskCount": 0,
24 "inProgressTaskCount": 0,
25 "cancelledTaskCount": 0,
26 "errorMessage": "string",
27 "queueTime": "2019-08-24T14:15:22Z",
28 "startTime": "2019-08-24T14:15:22Z",
29 "endTime": "2019-08-24T14:15:22Z",
30 "status": "CREATED",
31 "executor": "SCHEDULER",
32 "scheduleJobId": 0,
33 "batchSize": 10,
34 "totalObjectCount": 0,
35 "readOnly": true,
36 "profileId": 0,
37 "filter": {
38 "id": 70000001,
39 "profileId": 20000001,
40 "jobId": 10000001,
41 "name": "US Leases Filter",
42 "principalPositionType": {
43 "name": "LESSEE",
44 "captionKey": "enum.principalpositiontype.lessee",
45 "caption": "Lessee"
46 },
47 "filterObject": {
48 "erpSystemFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "erpSystems": [
54 {
55 "id": 10000001,
56 "displayId": "ERP-001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "SAP Production System",
64 "type": {
65 "name": "NAKISA",
66 "captionKey": "enum.erpSystemType.NAKISA",
67 "caption": "NAKISA"
68 },
69 "sapVersion": {
70 "name": "ECC_EHP5",
71 "captionKey": "enum.sapVersion.ECC_EHP5",
72 "caption": "ECC_EHP5"
73 }
74 }
75 ],
76 "leaseAreaFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "leaseAreas": [
82 {
83 "id": 10000001,
84 "displayId": "0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "Global Lease Area"
92 }
93 ],
94 "businessUnitFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "businessUnits": [
100 {
101 "id": 10000001,
102 "displayId": "BU0001",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "North America Business Unit"
110 }
111 ],
112 "companyFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "companies": [
118 {
119 "id": 10000006,
120 "displayId": "1005",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "erpSystemId": 10000001,
128 "erpSystemDisplayId": "FINQ8S-300",
129 "countryId": 10000095,
130 "countryDisplayId": "CA",
131 "name": "string",
132 "postingPeriodVariantId": 0,
133 "fiscalVariantId": 0
134 }
135 ],
136 "leaseDepartmentFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "leaseDepartments": [
142 {
143 "id": 300001,
144 "displayId": "DEP-01",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Finance Department"
152 }
153 ],
154 "leaseGroupFilterType": {
155 "name": "ALL",
156 "captionKey": "enum.filterType.all",
157 "caption": "All"
158 },
159 "leaseGroups": [
160 {
161 "id": 60000001,
162 "displayId": "LG-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Global Lease Group"
170 }
171 ],
172 "costCenterFilterType": {
173 "name": "ALL",
174 "captionKey": "enum.filterType.all",
175 "caption": "All"
176 },
177 "costCenters": [
178 {
179 "id": 14001,
180 "displayId": "CC-001",
181 "status": {
182 "name": "ACTIVE",
183 "captionKey": "enum.objectStatus.active",
184 "active": true,
185 "caption": "Active"
186 },
187 "name": "Cost Center A",
188 "erpSystemId": 0
189 }
190 ],
191 "profitCenterFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "profitCenters": [
197 {
198 "id": 9001,
199 "displayId": "PC-001",
200 "status": {
201 "name": "ACTIVE",
202 "captionKey": "enum.objectStatus.active",
203 "active": true,
204 "caption": "Active"
205 },
206 "name": "North Region Profit Center",
207 "validTo": "2025-12-31",
208 "erpSystemId": 101,
209 "erpSystemDisplayId": "SAP-01"
210 }
211 ],
212 "wbsFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "wbses": [
218 {
219 "id": 1001,
220 "displayId": "WBS-2025-001",
221 "status": {
222 "name": "ACTIVE",
223 "captionKey": "enum.objectStatus.active",
224 "active": true,
225 "caption": "Active"
226 },
227 "name": "Main Project WBS",
228 "erpSystemId": 0
229 }
230 ],
231 "businessAreaFilterType": {
232 "name": "ALL",
233 "captionKey": "enum.filterType.all",
234 "caption": "All"
235 },
236 "businessAreas": [
237 {
238 "id": 3001,
239 "displayId": "BA-2025-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "North America Operations",
247 "erpSystemId": 0
248 }
249 ],
250 "functionalAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "functionalAreas": [
256 {
257 "id": 2001,
258 "displayId": "FA-2025-001",
259 "status": {
260 "name": "ACTIVE",
261 "captionKey": "enum.objectStatus.active",
262 "active": true,
263 "caption": "Active"
264 },
265 "name": "Accounting Department",
266 "erpSystemId": 0
267 }
268 ]
269 }
270 },
271 "input": {
272 "id": 30000001,
273 "jobIndexationType": {
274 "name": "CPI_LOCAL",
275 "captionKey": "enum.jobIndexationType.cpiLocal",
276 "caption": "CPI Local"
277 },
278 "jobIndexationTypeNonLease": {
279 "name": "CPI_LOCAL",
280 "captionKey": "enum.jobIndexationType.cpiLocal",
281 "caption": "CPI Local"
282 },
283 "modificationDateType": {
284 "name": "JOB_DATE",
285 "captionKey": "enum.modificationDateType.jobDate",
286 "caption": "Job Date"
287 },
288 "modificationDate": "2024-12-01",
289 "referenceDateType": {
290 "name": "MODIFICATION_DATE",
291 "captionKey": "enum.referenceDateType.modificationDate",
292 "caption": "Modification Date"
293 },
294 "referenceDate": "2024-12-01",
295 "referenceDateTypeNonLease": {
296 "name": "MODIFICATION_DATE",
297 "captionKey": "enum.referenceDateType.modificationDate",
298 "caption": "Modification Date"
299 },
300 "referenceDateNonLease": "2024-12-01",
301 "indexLevelType": {
302 "name": "RATE",
303 "captionKey": "enum.indexLevelType.rate",
304 "caption": "Rate"
305 },
306 "newIndexLevel": 105.5,
307 "indexLevelTypeNonLease": {
308 "name": "RATE",
309 "captionKey": "enum.indexLevelType.rate",
310 "caption": "Rate"
311 },
312 "newIndexLevelNonLease": 103.2,
313 "indexationDateType": {
314 "name": "ROU_ANNIVERSARY_DATE",
315 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
316 "caption": "ROU Anniversary Date"
317 },
318 "indexationDateTypeNonLease": {
319 "name": "ROU_ANNIVERSARY_DATE",
320 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
321 "caption": "ROU Anniversary Date"
322 },
323 "indexationStartDate": "2024-12-01",
324 "indexationStartDateNonLease": "2024-12-01",
325 "postingDateType": {
326 "name": "JOB_DATE",
327 "captionKey": "enum.postingDateType.jobDate",
328 "caption": "Job Date"
329 },
330 "postingDate": "2024-12-01",
331 "documentDate": "2024-12-01",
332 "translationDate": "2024-12-01",
333 "indexationTreatmentType": {
334 "name": "DEFAULT",
335 "captionKey": "enum.indexationTreatmentType.default",
336 "caption": "Default"
337 },
338 "skipActivationGroupsWithOpenDraft": true,
339 "migratedFilterType": {
340 "name": "ALL",
341 "captionKey": "enum.migratedFilterType.all",
342 "caption": "All"
343 },
344 "overrideCPICategoryInputs": [
345 {
346 "consumerPriceIndexCategoryId": 40000001,
347 "consumerPriceIndexCategoryIdNonLease": 40000002,
348 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
349 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
350 "modificationDateType": {
351 "name": "JOB_DATE",
352 "captionKey": "enum.modificationDateType.jobDate",
353 "caption": "Job Date"
354 },
355 "modificationDate": "2024-12-01",
356 "referenceDateType": {
357 "name": "MODIFICATION_DATE",
358 "captionKey": "enum.referenceDateType.modificationDate",
359 "caption": "Modification Date"
360 },
361 "referenceDateTypeNonLease": {
362 "name": "MODIFICATION_DATE",
363 "captionKey": "enum.referenceDateType.modificationDate",
364 "caption": "Modification Date"
365 },
366 "referenceDate": "2024-12-01",
367 "referenceDateNonLease": "2024-12-01",
368 "postingDateType": {
369 "name": "JOB_DATE",
370 "captionKey": "enum.postingDateType.jobDate",
371 "caption": "Job Date"
372 },
373 "postingDate": "2024-12-01",
374 "documentDate": "2024-12-01",
375 "translationDate": "2024-12-01"
376 }
377 ],
378 "revert": false,
379 "reversalReason": {
380 "id": 50000001,
381 "displayId": "REV-001",
382 "status": {
383 "name": "ACTIVE",
384 "captionKey": "enum.objectStatus.active",
385 "active": true,
386 "caption": "Active"
387 },
388 "name": "Incorrect Indexation",
389 "erpSystemId": 60000001,
390 "erpSystemDisplayId": "SAP-PROD"
391 },
392 "assetClassFilterType": {
393 "name": "ALL",
394 "captionKey": "enum.assetClassFilterType.all",
395 "caption": "All"
396 },
397 "assetClasses": [
398 {
399 "id": 10000001,
400 "displayId": "IAC-001",
401 "status": {
402 "name": "ACTIVE",
403 "captionKey": "enum.objectStatus.active",
404 "active": true,
405 "caption": "Active"
406 },
407 "name": "Machinery and Equipment",
408 "assetClassType": "PROPERTY",
409 "infiniteUsefulLife": false
410 }
411 ],
412 "cpiCategoryFilterType": {
413 "name": "ALL",
414 "captionKey": "enum.cpiCategoryFilterType.all",
415 "caption": "All"
416 },
417 "cpiCategories": [
418 {
419 "id": 101,
420 "displayId": "CPI-2025-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "Consumer Price Index - City A",
428 "city": "New York",
429 "country": "USA",
430 "province": "NY",
431 "erpSystemId": 0
432 }
433 ],
434 "listObjectType": {
435 "name": "CONTRACT",
436 "captionKey": "enum.listObjectType.contract",
437 "caption": "Contract"
438 },
439 "objectList": [
440 {
441 "id": 10000001,
442 "displayId": "ENT-001",
443 "name": "Entity Name"
444 }
445 ]
446 },
447 "tasks": [
448 {
449 "id": 10000001,
450 "queueTime": "2025-01-01T10:00:00Z",
451 "startTime": "2025-01-01T10:00:00Z",
452 "endTime": "2025-01-01T10:00:00Z",
453 "interruptedAt": "2025-01-01T10:00:00Z",
454 "recoveredAt": "2025-01-01T10:00:00Z",
455 "status": {
456 "name": "PROCESSING",
457 "captionKey": "enum.batchJobStatus.processing",
458 "caption": "Processing"
459 },
460 "recover": false,
461 "interrupted": false,
462 "interruptionMessage": "sample_interruptionMessage",
463 "errorMessage": "sample_errorMessage",
464 "totalObjectCount": 100,
465 "jobId": 10000001,
466 "batchTaskObjectType": {
467 "name": "CONTRACT",
468 "captionKey": "enum.objectType.contract",
469 "caption": "Contract"
470 },
471 "objectIds": [],
472 "failedObjectIds": [],
473 "taskReport": {
474 "id": 10000001,
475 "scheduledItemCount": 100,
476 "processingItemCount": 100,
477 "doneItemCount": 100,
478 "failedItemCount": 100,
479 "cancelledItemCount": 100,
480 "skippedItemCount": 100,
481 "totalItemCount": 100,
482 "taskId": 10000001
483 }
484 }
485 ]
486 }
487 ],
488 "number": 0,
489 "sort": {
490 "unsorted": false,
491 "sorted": true,
492 "empty": false
493 },
494 "first": true,
495 "last": true,
496 "empty": true
497}
Mass Indexation Job - Create¶
HTTP Request
POST /api/v1/batch/mass-indexation/jobs
📋 Description: Creates a new mass indexation job for processing multiple lease and contract entries, facilitating the efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the mass indexation job details, including lease, contract, financial obligation, and accounting entry information necessary for processing batch operations. |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "filter": {
20 "id": 70000001,
21 "profileId": 20000001,
22 "jobId": 10000001,
23 "name": "US Leases Filter",
24 "principalPositionType": {
25 "name": "LESSEE",
26 "captionKey": "enum.principalpositiontype.lessee",
27 "caption": "Lessee"
28 },
29 "filterObject": {
30 "erpSystemFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "erpSystems": [
36 {
37 "id": 10000001,
38 "displayId": "ERP-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "SAP Production System",
46 "type": {
47 "name": "NAKISA",
48 "captionKey": "enum.erpSystemType.NAKISA",
49 "caption": "NAKISA"
50 },
51 "sapVersion": {
52 "name": "ECC_EHP5",
53 "captionKey": "enum.sapVersion.ECC_EHP5",
54 "caption": "ECC_EHP5"
55 }
56 }
57 ],
58 "leaseAreaFilterType": {
59 "name": "ALL",
60 "captionKey": "enum.filterType.all",
61 "caption": "All"
62 },
63 "leaseAreas": [
64 {
65 "id": 10000001,
66 "displayId": "0001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Global Lease Area"
74 }
75 ],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [
82 {
83 "id": 10000001,
84 "displayId": "BU0001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "North America Business Unit"
92 }
93 ],
94 "companyFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "companies": [
100 {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 }
117 ],
118 "leaseDepartmentFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "leaseDepartments": [
124 {
125 "id": 300001,
126 "displayId": "DEP-01",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "Finance Department"
134 }
135 ],
136 "leaseGroupFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "leaseGroups": [
142 {
143 "id": 60000001,
144 "displayId": "LG-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Global Lease Group"
152 }
153 ],
154 "costCenterFilterType": {
155 "name": "ALL",
156 "captionKey": "enum.filterType.all",
157 "caption": "All"
158 },
159 "costCenters": [
160 {
161 "id": 14001,
162 "displayId": "CC-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Cost Center A",
170 "erpSystemId": 0
171 }
172 ],
173 "profitCenterFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "wbses": [
200 {
201 "id": 1001,
202 "displayId": "WBS-2025-001",
203 "status": {
204 "name": "ACTIVE",
205 "captionKey": "enum.objectStatus.active",
206 "active": true,
207 "caption": "Active"
208 },
209 "name": "Main Project WBS",
210 "erpSystemId": 0
211 }
212 ],
213 "businessAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "businessAreas": [
219 {
220 "id": 3001,
221 "displayId": "BA-2025-001",
222 "status": {
223 "name": "ACTIVE",
224 "captionKey": "enum.objectStatus.active",
225 "active": true,
226 "caption": "Active"
227 },
228 "name": "North America Operations",
229 "erpSystemId": 0
230 }
231 ],
232 "functionalAreaFilterType": {
233 "name": "ALL",
234 "captionKey": "enum.filterType.all",
235 "caption": "All"
236 },
237 "functionalAreas": [
238 {
239 "id": 2001,
240 "displayId": "FA-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Accounting Department",
248 "erpSystemId": 0
249 }
250 ]
251 }
252 },
253 "input": {
254 "id": 30000001,
255 "jobIndexationType": {
256 "name": "CPI_LOCAL",
257 "captionKey": "enum.jobIndexationType.cpiLocal",
258 "caption": "CPI Local"
259 },
260 "jobIndexationTypeNonLease": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "modificationDateType": {
266 "name": "JOB_DATE",
267 "captionKey": "enum.modificationDateType.jobDate",
268 "caption": "Job Date"
269 },
270 "modificationDate": "2024-12-01",
271 "referenceDateType": {
272 "name": "MODIFICATION_DATE",
273 "captionKey": "enum.referenceDateType.modificationDate",
274 "caption": "Modification Date"
275 },
276 "referenceDate": "2024-12-01",
277 "referenceDateTypeNonLease": {
278 "name": "MODIFICATION_DATE",
279 "captionKey": "enum.referenceDateType.modificationDate",
280 "caption": "Modification Date"
281 },
282 "referenceDateNonLease": "2024-12-01",
283 "indexLevelType": {
284 "name": "RATE",
285 "captionKey": "enum.indexLevelType.rate",
286 "caption": "Rate"
287 },
288 "newIndexLevel": 105.5,
289 "indexLevelTypeNonLease": {
290 "name": "RATE",
291 "captionKey": "enum.indexLevelType.rate",
292 "caption": "Rate"
293 },
294 "newIndexLevelNonLease": 103.2,
295 "indexationDateType": {
296 "name": "ROU_ANNIVERSARY_DATE",
297 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
298 "caption": "ROU Anniversary Date"
299 },
300 "indexationDateTypeNonLease": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationStartDate": "2024-12-01",
306 "indexationStartDateNonLease": "2024-12-01",
307 "postingDateType": {
308 "name": "JOB_DATE",
309 "captionKey": "enum.postingDateType.jobDate",
310 "caption": "Job Date"
311 },
312 "postingDate": "2024-12-01",
313 "documentDate": "2024-12-01",
314 "translationDate": "2024-12-01",
315 "indexationTreatmentType": {
316 "name": "DEFAULT",
317 "captionKey": "enum.indexationTreatmentType.default",
318 "caption": "Default"
319 },
320 "skipActivationGroupsWithOpenDraft": true,
321 "migratedFilterType": {
322 "name": "ALL",
323 "captionKey": "enum.migratedFilterType.all",
324 "caption": "All"
325 },
326 "overrideCPICategoryInputs": [
327 {
328 "consumerPriceIndexCategoryId": 40000001,
329 "consumerPriceIndexCategoryIdNonLease": 40000002,
330 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
331 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
332 "modificationDateType": {
333 "name": "JOB_DATE",
334 "captionKey": "enum.modificationDateType.jobDate",
335 "caption": "Job Date"
336 },
337 "modificationDate": "2024-12-01",
338 "referenceDateType": {
339 "name": "MODIFICATION_DATE",
340 "captionKey": "enum.referenceDateType.modificationDate",
341 "caption": "Modification Date"
342 },
343 "referenceDateTypeNonLease": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDate": "2024-12-01",
349 "referenceDateNonLease": "2024-12-01",
350 "postingDateType": {
351 "name": "JOB_DATE",
352 "captionKey": "enum.postingDateType.jobDate",
353 "caption": "Job Date"
354 },
355 "postingDate": "2024-12-01",
356 "documentDate": "2024-12-01",
357 "translationDate": "2024-12-01"
358 }
359 ],
360 "revert": false,
361 "reversalReason": {
362 "id": 50000001,
363 "displayId": "REV-001",
364 "status": {
365 "name": "ACTIVE",
366 "captionKey": "enum.objectStatus.active",
367 "active": true,
368 "caption": "Active"
369 },
370 "name": "Incorrect Indexation",
371 "erpSystemId": 60000001,
372 "erpSystemDisplayId": "SAP-PROD"
373 },
374 "assetClassFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.assetClassFilterType.all",
377 "caption": "All"
378 },
379 "assetClasses": [
380 {
381 "id": 10000001,
382 "displayId": "IAC-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Machinery and Equipment",
390 "assetClassType": "PROPERTY",
391 "infiniteUsefulLife": false
392 }
393 ],
394 "cpiCategoryFilterType": {
395 "name": "ALL",
396 "captionKey": "enum.cpiCategoryFilterType.all",
397 "caption": "All"
398 },
399 "cpiCategories": [
400 {
401 "id": 101,
402 "displayId": "CPI-2025-001",
403 "status": {
404 "name": "ACTIVE",
405 "captionKey": "enum.objectStatus.active",
406 "active": true,
407 "caption": "Active"
408 },
409 "name": "Consumer Price Index - City A",
410 "city": "New York",
411 "country": "USA",
412 "province": "NY",
413 "erpSystemId": 0
414 }
415 ],
416 "listObjectType": {
417 "name": "CONTRACT",
418 "captionKey": "enum.listObjectType.contract",
419 "caption": "Contract"
420 },
421 "objectList": [
422 {
423 "id": 10000001,
424 "displayId": "ENT-001",
425 "name": "Entity Name"
426 }
427 ]
428 },
429 "tasks": [
430 {
431 "id": 10000001,
432 "queueTime": "2025-01-01T10:00:00Z",
433 "startTime": "2025-01-01T10:00:00Z",
434 "endTime": "2025-01-01T10:00:00Z",
435 "interruptedAt": "2025-01-01T10:00:00Z",
436 "recoveredAt": "2025-01-01T10:00:00Z",
437 "status": {
438 "name": "PROCESSING",
439 "captionKey": "enum.batchJobStatus.processing",
440 "caption": "Processing"
441 },
442 "recover": false,
443 "interrupted": false,
444 "interruptionMessage": "sample_interruptionMessage",
445 "errorMessage": "sample_errorMessage",
446 "totalObjectCount": 100,
447 "jobId": 10000001,
448 "batchTaskObjectType": {
449 "name": "CONTRACT",
450 "captionKey": "enum.objectType.contract",
451 "caption": "Contract"
452 },
453 "objectIds": [],
454 "failedObjectIds": [],
455 "taskReport": {
456 "id": 10000001,
457 "scheduledItemCount": 100,
458 "processingItemCount": 100,
459 "doneItemCount": 100,
460 "failedItemCount": 100,
461 "cancelledItemCount": 100,
462 "skippedItemCount": 100,
463 "totalItemCount": 100,
464 "taskId": 10000001
465 }
466 }
467 ]
468}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "taskCount": 0,
9 "failedTaskCount": 0,
10 "doneTaskCount": 0,
11 "inProgressTaskCount": 0,
12 "cancelledTaskCount": 0,
13 "errorMessage": "string",
14 "queueTime": "2019-08-24T14:15:22Z",
15 "startTime": "2019-08-24T14:15:22Z",
16 "endTime": "2019-08-24T14:15:22Z",
17 "status": "CREATED",
18 "executor": "SCHEDULER",
19 "scheduleJobId": 0,
20 "batchSize": 10,
21 "totalObjectCount": 0,
22 "readOnly": true,
23 "profileId": 0,
24 "filter": {
25 "id": 70000001,
26 "profileId": 20000001,
27 "jobId": 10000001,
28 "name": "US Leases Filter",
29 "principalPositionType": {
30 "name": "LESSEE",
31 "captionKey": "enum.principalpositiontype.lessee",
32 "caption": "Lessee"
33 },
34 "filterObject": {
35 "erpSystemFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "erpSystems": [
41 {
42 "id": 10000001,
43 "displayId": "ERP-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "SAP Production System",
51 "type": {
52 "name": "NAKISA",
53 "captionKey": "enum.erpSystemType.NAKISA",
54 "caption": "NAKISA"
55 },
56 "sapVersion": {
57 "name": "ECC_EHP5",
58 "captionKey": "enum.sapVersion.ECC_EHP5",
59 "caption": "ECC_EHP5"
60 }
61 }
62 ],
63 "leaseAreaFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseAreas": [
69 {
70 "id": 10000001,
71 "displayId": "0001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "Global Lease Area"
79 }
80 ],
81 "businessUnitFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "businessUnits": [
87 {
88 "id": 10000001,
89 "displayId": "BU0001",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "North America Business Unit"
97 }
98 ],
99 "companyFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "companies": [
105 {
106 "id": 10000006,
107 "displayId": "1005",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "erpSystemId": 10000001,
115 "erpSystemDisplayId": "FINQ8S-300",
116 "countryId": 10000095,
117 "countryDisplayId": "CA",
118 "name": "string",
119 "postingPeriodVariantId": 0,
120 "fiscalVariantId": 0
121 }
122 ],
123 "leaseDepartmentFilterType": {
124 "name": "ALL",
125 "captionKey": "enum.filterType.all",
126 "caption": "All"
127 },
128 "leaseDepartments": [
129 {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 }
140 ],
141 "leaseGroupFilterType": {
142 "name": "ALL",
143 "captionKey": "enum.filterType.all",
144 "caption": "All"
145 },
146 "leaseGroups": [
147 {
148 "id": 60000001,
149 "displayId": "LG-001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "Global Lease Group"
157 }
158 ],
159 "costCenterFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A",
175 "erpSystemId": 0
176 }
177 ],
178 "profitCenterFilterType": {
179 "name": "ALL",
180 "captionKey": "enum.filterType.all",
181 "caption": "All"
182 },
183 "profitCenters": [
184 {
185 "id": 9001,
186 "displayId": "PC-001",
187 "status": {
188 "name": "ACTIVE",
189 "captionKey": "enum.objectStatus.active",
190 "active": true,
191 "caption": "Active"
192 },
193 "name": "North Region Profit Center",
194 "validTo": "2025-12-31",
195 "erpSystemId": 101,
196 "erpSystemDisplayId": "SAP-01"
197 }
198 ],
199 "wbsFilterType": {
200 "name": "ALL",
201 "captionKey": "enum.filterType.all",
202 "caption": "All"
203 },
204 "wbses": [
205 {
206 "id": 1001,
207 "displayId": "WBS-2025-001",
208 "status": {
209 "name": "ACTIVE",
210 "captionKey": "enum.objectStatus.active",
211 "active": true,
212 "caption": "Active"
213 },
214 "name": "Main Project WBS",
215 "erpSystemId": 0
216 }
217 ],
218 "businessAreaFilterType": {
219 "name": "ALL",
220 "captionKey": "enum.filterType.all",
221 "caption": "All"
222 },
223 "businessAreas": [
224 {
225 "id": 3001,
226 "displayId": "BA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "North America Operations",
234 "erpSystemId": 0
235 }
236 ],
237 "functionalAreaFilterType": {
238 "name": "ALL",
239 "captionKey": "enum.filterType.all",
240 "caption": "All"
241 },
242 "functionalAreas": [
243 {
244 "id": 2001,
245 "displayId": "FA-2025-001",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "name": "Accounting Department",
253 "erpSystemId": 0
254 }
255 ]
256 }
257 },
258 "input": {
259 "id": 30000001,
260 "jobIndexationType": {
261 "name": "CPI_LOCAL",
262 "captionKey": "enum.jobIndexationType.cpiLocal",
263 "caption": "CPI Local"
264 },
265 "jobIndexationTypeNonLease": {
266 "name": "CPI_LOCAL",
267 "captionKey": "enum.jobIndexationType.cpiLocal",
268 "caption": "CPI Local"
269 },
270 "modificationDateType": {
271 "name": "JOB_DATE",
272 "captionKey": "enum.modificationDateType.jobDate",
273 "caption": "Job Date"
274 },
275 "modificationDate": "2024-12-01",
276 "referenceDateType": {
277 "name": "MODIFICATION_DATE",
278 "captionKey": "enum.referenceDateType.modificationDate",
279 "caption": "Modification Date"
280 },
281 "referenceDate": "2024-12-01",
282 "referenceDateTypeNonLease": {
283 "name": "MODIFICATION_DATE",
284 "captionKey": "enum.referenceDateType.modificationDate",
285 "caption": "Modification Date"
286 },
287 "referenceDateNonLease": "2024-12-01",
288 "indexLevelType": {
289 "name": "RATE",
290 "captionKey": "enum.indexLevelType.rate",
291 "caption": "Rate"
292 },
293 "newIndexLevel": 105.5,
294 "indexLevelTypeNonLease": {
295 "name": "RATE",
296 "captionKey": "enum.indexLevelType.rate",
297 "caption": "Rate"
298 },
299 "newIndexLevelNonLease": 103.2,
300 "indexationDateType": {
301 "name": "ROU_ANNIVERSARY_DATE",
302 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
303 "caption": "ROU Anniversary Date"
304 },
305 "indexationDateTypeNonLease": {
306 "name": "ROU_ANNIVERSARY_DATE",
307 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
308 "caption": "ROU Anniversary Date"
309 },
310 "indexationStartDate": "2024-12-01",
311 "indexationStartDateNonLease": "2024-12-01",
312 "postingDateType": {
313 "name": "JOB_DATE",
314 "captionKey": "enum.postingDateType.jobDate",
315 "caption": "Job Date"
316 },
317 "postingDate": "2024-12-01",
318 "documentDate": "2024-12-01",
319 "translationDate": "2024-12-01",
320 "indexationTreatmentType": {
321 "name": "DEFAULT",
322 "captionKey": "enum.indexationTreatmentType.default",
323 "caption": "Default"
324 },
325 "skipActivationGroupsWithOpenDraft": true,
326 "migratedFilterType": {
327 "name": "ALL",
328 "captionKey": "enum.migratedFilterType.all",
329 "caption": "All"
330 },
331 "overrideCPICategoryInputs": [
332 {
333 "consumerPriceIndexCategoryId": 40000001,
334 "consumerPriceIndexCategoryIdNonLease": 40000002,
335 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
336 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
337 "modificationDateType": {
338 "name": "JOB_DATE",
339 "captionKey": "enum.modificationDateType.jobDate",
340 "caption": "Job Date"
341 },
342 "modificationDate": "2024-12-01",
343 "referenceDateType": {
344 "name": "MODIFICATION_DATE",
345 "captionKey": "enum.referenceDateType.modificationDate",
346 "caption": "Modification Date"
347 },
348 "referenceDateTypeNonLease": {
349 "name": "MODIFICATION_DATE",
350 "captionKey": "enum.referenceDateType.modificationDate",
351 "caption": "Modification Date"
352 },
353 "referenceDate": "2024-12-01",
354 "referenceDateNonLease": "2024-12-01",
355 "postingDateType": {
356 "name": "JOB_DATE",
357 "captionKey": "enum.postingDateType.jobDate",
358 "caption": "Job Date"
359 },
360 "postingDate": "2024-12-01",
361 "documentDate": "2024-12-01",
362 "translationDate": "2024-12-01"
363 }
364 ],
365 "revert": false,
366 "reversalReason": {
367 "id": 50000001,
368 "displayId": "REV-001",
369 "status": {
370 "name": "ACTIVE",
371 "captionKey": "enum.objectStatus.active",
372 "active": true,
373 "caption": "Active"
374 },
375 "name": "Incorrect Indexation",
376 "erpSystemId": 60000001,
377 "erpSystemDisplayId": "SAP-PROD"
378 },
379 "assetClassFilterType": {
380 "name": "ALL",
381 "captionKey": "enum.assetClassFilterType.all",
382 "caption": "All"
383 },
384 "assetClasses": [
385 {
386 "id": 10000001,
387 "displayId": "IAC-001",
388 "status": {
389 "name": "ACTIVE",
390 "captionKey": "enum.objectStatus.active",
391 "active": true,
392 "caption": "Active"
393 },
394 "name": "Machinery and Equipment",
395 "assetClassType": "PROPERTY",
396 "infiniteUsefulLife": false
397 }
398 ],
399 "cpiCategoryFilterType": {
400 "name": "ALL",
401 "captionKey": "enum.cpiCategoryFilterType.all",
402 "caption": "All"
403 },
404 "cpiCategories": [
405 {
406 "id": 101,
407 "displayId": "CPI-2025-001",
408 "status": {
409 "name": "ACTIVE",
410 "captionKey": "enum.objectStatus.active",
411 "active": true,
412 "caption": "Active"
413 },
414 "name": "Consumer Price Index - City A",
415 "city": "New York",
416 "country": "USA",
417 "province": "NY",
418 "erpSystemId": 0
419 }
420 ],
421 "listObjectType": {
422 "name": "CONTRACT",
423 "captionKey": "enum.listObjectType.contract",
424 "caption": "Contract"
425 },
426 "objectList": [
427 {
428 "id": 10000001,
429 "displayId": "ENT-001",
430 "name": "Entity Name"
431 }
432 ]
433 },
434 "tasks": [
435 {
436 "id": 10000001,
437 "queueTime": "2025-01-01T10:00:00Z",
438 "startTime": "2025-01-01T10:00:00Z",
439 "endTime": "2025-01-01T10:00:00Z",
440 "interruptedAt": "2025-01-01T10:00:00Z",
441 "recoveredAt": "2025-01-01T10:00:00Z",
442 "status": {
443 "name": "PROCESSING",
444 "captionKey": "enum.batchJobStatus.processing",
445 "caption": "Processing"
446 },
447 "recover": false,
448 "interrupted": false,
449 "interruptionMessage": "sample_interruptionMessage",
450 "errorMessage": "sample_errorMessage",
451 "totalObjectCount": 100,
452 "jobId": 10000001,
453 "batchTaskObjectType": {
454 "name": "CONTRACT",
455 "captionKey": "enum.objectType.contract",
456 "caption": "Contract"
457 },
458 "objectIds": [],
459 "failedObjectIds": [],
460 "taskReport": {
461 "id": 10000001,
462 "scheduledItemCount": 100,
463 "processingItemCount": 100,
464 "doneItemCount": 100,
465 "failedItemCount": 100,
466 "cancelledItemCount": 100,
467 "skippedItemCount": 100,
468 "totalItemCount": 100,
469 "taskId": 10000001
470 }
471 }
472 ]
473 }
474}
Mass Indexation Job - Get List Object Types¶
HTTP Request
GET /api/v1/batch/mass-indexation/jobs/list-object-types
📋 Description: Retrieves a list of object types relevant to mass indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MASTER_AGREEMENT"
3]