Mass Indexation Schedule Job¶
Get Mass Indexation Resource By ID¶
HTTP Request
GET /api/v1/batch/mass-indexation/schedule-jobs/{id}
📋 Description: Retrieves the scheduled job details for mass indexation within the Nakisa Lease Accounting Suite, providing insights into lease, contract, financial obligation, and accounting entry processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved mass indexation schedule job |
||
400 |
Invalid ID supplied |
None |
|
404 |
Mass indexation schedule job not found |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "code": {
3 "name": "OK",
4 "captionKey": "enum.responseCode.ok",
5 "caption": "OK"
6 },
7 "errors": {
8 "all": []
9 },
10 "object": {
11 "id": 10000001,
12 "cronExpression": "0 0 2 * * ?",
13 "cronReadable": "Every day at 2:00 AM",
14 "active": true,
15 "unauthorized": false,
16 "nextExecution": "2024-12-02T02:00:00Z",
17 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
18 "previousExecution": "2024-12-01T02:00:00Z",
19 "previousExecutionMessage": "Execution completed successfully",
20 "batchSize": 100,
21 "name": "Monthly CPI Indexation",
22 "profileId": 20000001,
23 "input": {
24 "id": 30000001,
25 "jobIndexationType": {
26 "name": "CPI_LOCAL",
27 "captionKey": "enum.jobIndexationType.cpiLocal",
28 "caption": "CPI Local"
29 },
30 "jobIndexationTypeNonLease": {
31 "name": "CPI_LOCAL",
32 "captionKey": "enum.jobIndexationType.cpiLocal",
33 "caption": "CPI Local"
34 },
35 "modificationDateType": {
36 "name": "JOB_DATE",
37 "captionKey": "enum.modificationDateType.jobDate",
38 "caption": "Job Date"
39 },
40 "modificationDate": "2024-12-01",
41 "referenceDateType": {
42 "name": "MODIFICATION_DATE",
43 "captionKey": "enum.referenceDateType.modificationDate",
44 "caption": "Modification Date"
45 },
46 "referenceDate": "2024-12-01",
47 "referenceDateTypeNonLease": {
48 "name": "MODIFICATION_DATE",
49 "captionKey": "enum.referenceDateType.modificationDate",
50 "caption": "Modification Date"
51 },
52 "referenceDateNonLease": "2024-12-01",
53 "indexLevelType": {
54 "name": "RATE",
55 "captionKey": "enum.indexLevelType.rate",
56 "caption": "Rate"
57 },
58 "newIndexLevel": 105.5,
59 "indexLevelTypeNonLease": {
60 "name": "RATE",
61 "captionKey": "enum.indexLevelType.rate",
62 "caption": "Rate"
63 },
64 "newIndexLevelNonLease": 103.2,
65 "indexationDateType": {
66 "name": "ROU_ANNIVERSARY_DATE",
67 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
68 "caption": "ROU Anniversary Date"
69 },
70 "indexationDateTypeNonLease": {
71 "name": "ROU_ANNIVERSARY_DATE",
72 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
73 "caption": "ROU Anniversary Date"
74 },
75 "indexationStartDate": "2024-12-01",
76 "indexationStartDateNonLease": "2024-12-01",
77 "postingDateType": {
78 "name": "JOB_DATE",
79 "captionKey": "enum.postingDateType.jobDate",
80 "caption": "Job Date"
81 },
82 "postingDate": "2024-12-01",
83 "documentDate": "2024-12-01",
84 "translationDate": "2024-12-01",
85 "indexationTreatmentType": {
86 "name": "DEFAULT",
87 "captionKey": "enum.indexationTreatmentType.default",
88 "caption": "Default"
89 },
90 "skipActivationGroupsWithOpenDraft": true,
91 "migratedFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.migratedFilterType.all",
94 "caption": "All"
95 },
96 "overrideCPICategoryInputs": [
97 {
98 "consumerPriceIndexCategoryId": 40000001,
99 "consumerPriceIndexCategoryIdNonLease": 40000002,
100 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
101 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
102 "modificationDateType": {
103 "name": "JOB_DATE",
104 "captionKey": "enum.modificationDateType.jobDate",
105 "caption": "Job Date"
106 },
107 "modificationDate": "2024-12-01",
108 "referenceDateType": {
109 "name": "MODIFICATION_DATE",
110 "captionKey": "enum.referenceDateType.modificationDate",
111 "caption": "Modification Date"
112 },
113 "referenceDateTypeNonLease": {
114 "name": "MODIFICATION_DATE",
115 "captionKey": "enum.referenceDateType.modificationDate",
116 "caption": "Modification Date"
117 },
118 "referenceDate": "2024-12-01",
119 "referenceDateNonLease": "2024-12-01",
120 "postingDateType": {
121 "name": "JOB_DATE",
122 "captionKey": "enum.postingDateType.jobDate",
123 "caption": "Job Date"
124 },
125 "postingDate": "2024-12-01",
126 "documentDate": "2024-12-01",
127 "translationDate": "2024-12-01"
128 }
129 ],
130 "revert": false,
131 "reversalReason": {
132 "id": 50000001,
133 "displayId": "REV-001",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "Incorrect Indexation",
141 "erpSystemId": 60000001,
142 "erpSystemDisplayId": "SAP-PROD"
143 },
144 "assetClassFilterType": {
145 "name": "ALL",
146 "captionKey": "enum.assetClassFilterType.all",
147 "caption": "All"
148 },
149 "assetClasses": [
150 {
151 "id": 10000001,
152 "displayId": "IAC-001",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Machinery and Equipment",
160 "assetClassType": "PROPERTY",
161 "infiniteUsefulLife": false
162 }
163 ],
164 "cpiCategoryFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.cpiCategoryFilterType.all",
167 "caption": "All"
168 },
169 "cpiCategories": [
170 {
171 "id": 101,
172 "displayId": "CPI-2025-001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Consumer Price Index - City A",
180 "city": "New York",
181 "country": "USA",
182 "province": "NY",
183 "erpSystemId": 0
184 }
185 ],
186 "listObjectType": {
187 "name": "CONTRACT",
188 "captionKey": "enum.listObjectType.contract",
189 "caption": "Contract"
190 },
191 "objectList": [
192 {
193 "id": 10000001,
194 "displayId": "ENT-001",
195 "name": "Entity Name"
196 }
197 ]
198 },
199 "profile": {
200 "id": 70000001,
201 "profileId": 20000001,
202 "jobId": 10000001,
203 "name": "US Leases Filter",
204 "principalPositionType": {
205 "name": "LESSEE",
206 "captionKey": "enum.principalpositiontype.lessee",
207 "caption": "Lessee"
208 },
209 "filterObject": {
210 "erpSystemFilterType": {
211 "name": "ALL",
212 "captionKey": "enum.filterType.all",
213 "caption": "All"
214 },
215 "erpSystems": [
216 {
217 "id": 10000001,
218 "displayId": "ERP-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "SAP Production System",
226 "type": {
227 "name": "NAKISA",
228 "captionKey": "enum.erpSystemType.NAKISA",
229 "caption": "NAKISA"
230 },
231 "sapVersion": {
232 "name": "ECC_EHP5",
233 "captionKey": "enum.sapVersion.ECC_EHP5",
234 "caption": "ECC_EHP5"
235 }
236 }
237 ],
238 "leaseAreaFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "leaseAreas": [
244 {
245 "id": 10000001,
246 "displayId": "0001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Global Lease Area"
254 }
255 ],
256 "businessUnitFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "businessUnits": [
262 {
263 "id": 10000001,
264 "displayId": "BU0001",
265 "status": {
266 "name": "ACTIVE",
267 "captionKey": "enum.objectStatus.active",
268 "active": true,
269 "caption": "Active"
270 },
271 "name": "North America Business Unit"
272 }
273 ],
274 "companyFilterType": {
275 "name": "ALL",
276 "captionKey": "enum.filterType.all",
277 "caption": "All"
278 },
279 "companies": [
280 {
281 "id": 10000006,
282 "displayId": "1005",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "erpSystemId": 10000001,
290 "erpSystemDisplayId": "FINQ8S-300",
291 "countryId": 10000095,
292 "countryDisplayId": "CA",
293 "name": "string",
294 "postingPeriodVariantId": 0,
295 "fiscalVariantId": 0
296 }
297 ],
298 "leaseDepartmentFilterType": {
299 "name": "ALL",
300 "captionKey": "enum.filterType.all",
301 "caption": "All"
302 },
303 "leaseDepartments": [
304 {
305 "id": 300001,
306 "displayId": "DEP-01",
307 "status": {
308 "name": "ACTIVE",
309 "captionKey": "enum.objectStatus.active",
310 "active": true,
311 "caption": "Active"
312 },
313 "name": "Finance Department"
314 }
315 ],
316 "leaseGroupFilterType": {
317 "name": "ALL",
318 "captionKey": "enum.filterType.all",
319 "caption": "All"
320 },
321 "leaseGroups": [
322 {
323 "id": 60000001,
324 "displayId": "LG-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Global Lease Group"
332 }
333 ],
334 "costCenterFilterType": {
335 "name": "ALL",
336 "captionKey": "enum.filterType.all",
337 "caption": "All"
338 },
339 "costCenters": [
340 {
341 "id": 14001,
342 "displayId": "CC-001",
343 "status": {
344 "name": "ACTIVE",
345 "captionKey": "enum.objectStatus.active",
346 "active": true,
347 "caption": "Active"
348 },
349 "name": "Cost Center A",
350 "erpSystemId": 0
351 }
352 ],
353 "profitCenterFilterType": {
354 "name": "ALL",
355 "captionKey": "enum.filterType.all",
356 "caption": "All"
357 },
358 "profitCenters": [
359 {
360 "id": 9001,
361 "displayId": "PC-001",
362 "status": {
363 "name": "ACTIVE",
364 "captionKey": "enum.objectStatus.active",
365 "active": true,
366 "caption": "Active"
367 },
368 "name": "North Region Profit Center",
369 "validTo": "2025-12-31",
370 "erpSystemId": 101,
371 "erpSystemDisplayId": "SAP-01"
372 }
373 ],
374 "wbsFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.filterType.all",
377 "caption": "All"
378 },
379 "wbses": [
380 {
381 "id": 1001,
382 "displayId": "WBS-2025-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Main Project WBS",
390 "erpSystemId": 0
391 }
392 ],
393 "businessAreaFilterType": {
394 "name": "ALL",
395 "captionKey": "enum.filterType.all",
396 "caption": "All"
397 },
398 "businessAreas": [
399 {
400 "id": 3001,
401 "displayId": "BA-2025-001",
402 "status": {
403 "name": "ACTIVE",
404 "captionKey": "enum.objectStatus.active",
405 "active": true,
406 "caption": "Active"
407 },
408 "name": "North America Operations",
409 "erpSystemId": 0
410 }
411 ],
412 "functionalAreaFilterType": {
413 "name": "ALL",
414 "captionKey": "enum.filterType.all",
415 "caption": "All"
416 },
417 "functionalAreas": [
418 {
419 "id": 2001,
420 "displayId": "FA-2025-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "Accounting Department",
428 "erpSystemId": 0
429 }
430 ]
431 }
432 }
433 }
434}
Update Mass Indexation Resource¶
HTTP Request
PUT /api/v1/batch/mass-indexation/schedule-jobs/{id}
📋 Description: Updates the scheduling details for a mass indexation job identified by the specified ID within the Nakisa Lease Accounting Suite, ensuring accurate alignment of lease, contract, and financial obligation data for accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the schedule job details for mass indexation, including lease, contract, and financial obligation parameters essential for accurate accounting entry management. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Body Parameters
1{
2 "id": 10000001,
3 "cronExpression": "0 0 2 * * ?",
4 "cronReadable": "Every day at 2:00 AM",
5 "active": true,
6 "unauthorized": false,
7 "nextExecution": "2024-12-02T02:00:00Z",
8 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
9 "previousExecution": "2024-12-01T02:00:00Z",
10 "previousExecutionMessage": "Execution completed successfully",
11 "batchSize": 100,
12 "name": "Monthly CPI Indexation",
13 "profileId": 20000001,
14 "input": {
15 "id": 30000001,
16 "jobIndexationType": {
17 "name": "CPI_LOCAL",
18 "captionKey": "enum.jobIndexationType.cpiLocal",
19 "caption": "CPI Local"
20 },
21 "jobIndexationTypeNonLease": {
22 "name": "CPI_LOCAL",
23 "captionKey": "enum.jobIndexationType.cpiLocal",
24 "caption": "CPI Local"
25 },
26 "modificationDateType": {
27 "name": "JOB_DATE",
28 "captionKey": "enum.modificationDateType.jobDate",
29 "caption": "Job Date"
30 },
31 "modificationDate": "2024-12-01",
32 "referenceDateType": {
33 "name": "MODIFICATION_DATE",
34 "captionKey": "enum.referenceDateType.modificationDate",
35 "caption": "Modification Date"
36 },
37 "referenceDate": "2024-12-01",
38 "referenceDateTypeNonLease": {
39 "name": "MODIFICATION_DATE",
40 "captionKey": "enum.referenceDateType.modificationDate",
41 "caption": "Modification Date"
42 },
43 "referenceDateNonLease": "2024-12-01",
44 "indexLevelType": {
45 "name": "RATE",
46 "captionKey": "enum.indexLevelType.rate",
47 "caption": "Rate"
48 },
49 "newIndexLevel": 105.5,
50 "indexLevelTypeNonLease": {
51 "name": "RATE",
52 "captionKey": "enum.indexLevelType.rate",
53 "caption": "Rate"
54 },
55 "newIndexLevelNonLease": 103.2,
56 "indexationDateType": {
57 "name": "ROU_ANNIVERSARY_DATE",
58 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
59 "caption": "ROU Anniversary Date"
60 },
61 "indexationDateTypeNonLease": {
62 "name": "ROU_ANNIVERSARY_DATE",
63 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
64 "caption": "ROU Anniversary Date"
65 },
66 "indexationStartDate": "2024-12-01",
67 "indexationStartDateNonLease": "2024-12-01",
68 "postingDateType": {
69 "name": "JOB_DATE",
70 "captionKey": "enum.postingDateType.jobDate",
71 "caption": "Job Date"
72 },
73 "postingDate": "2024-12-01",
74 "documentDate": "2024-12-01",
75 "translationDate": "2024-12-01",
76 "indexationTreatmentType": {
77 "name": "DEFAULT",
78 "captionKey": "enum.indexationTreatmentType.default",
79 "caption": "Default"
80 },
81 "skipActivationGroupsWithOpenDraft": true,
82 "migratedFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.migratedFilterType.all",
85 "caption": "All"
86 },
87 "overrideCPICategoryInputs": [
88 {
89 "consumerPriceIndexCategoryId": 40000001,
90 "consumerPriceIndexCategoryIdNonLease": 40000002,
91 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
92 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
93 "modificationDateType": {
94 "name": "JOB_DATE",
95 "captionKey": "enum.modificationDateType.jobDate",
96 "caption": "Job Date"
97 },
98 "modificationDate": "2024-12-01",
99 "referenceDateType": {
100 "name": "MODIFICATION_DATE",
101 "captionKey": "enum.referenceDateType.modificationDate",
102 "caption": "Modification Date"
103 },
104 "referenceDateTypeNonLease": {
105 "name": "MODIFICATION_DATE",
106 "captionKey": "enum.referenceDateType.modificationDate",
107 "caption": "Modification Date"
108 },
109 "referenceDate": "2024-12-01",
110 "referenceDateNonLease": "2024-12-01",
111 "postingDateType": {
112 "name": "JOB_DATE",
113 "captionKey": "enum.postingDateType.jobDate",
114 "caption": "Job Date"
115 },
116 "postingDate": "2024-12-01",
117 "documentDate": "2024-12-01",
118 "translationDate": "2024-12-01"
119 }
120 ],
121 "revert": false,
122 "reversalReason": {
123 "id": 50000001,
124 "displayId": "REV-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Incorrect Indexation",
132 "erpSystemId": 60000001,
133 "erpSystemDisplayId": "SAP-PROD"
134 },
135 "assetClassFilterType": {
136 "name": "ALL",
137 "captionKey": "enum.assetClassFilterType.all",
138 "caption": "All"
139 },
140 "assetClasses": [
141 {
142 "id": 10000001,
143 "displayId": "IAC-001",
144 "status": {
145 "name": "ACTIVE",
146 "captionKey": "enum.objectStatus.active",
147 "active": true,
148 "caption": "Active"
149 },
150 "name": "Machinery and Equipment",
151 "assetClassType": "PROPERTY",
152 "infiniteUsefulLife": false
153 }
154 ],
155 "cpiCategoryFilterType": {
156 "name": "ALL",
157 "captionKey": "enum.cpiCategoryFilterType.all",
158 "caption": "All"
159 },
160 "cpiCategories": [
161 {
162 "id": 101,
163 "displayId": "CPI-2025-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "Consumer Price Index - City A",
171 "city": "New York",
172 "country": "USA",
173 "province": "NY",
174 "erpSystemId": 0
175 }
176 ],
177 "listObjectType": {
178 "name": "CONTRACT",
179 "captionKey": "enum.listObjectType.contract",
180 "caption": "Contract"
181 },
182 "objectList": [
183 {
184 "id": 10000001,
185 "displayId": "ENT-001",
186 "name": "Entity Name"
187 }
188 ]
189 },
190 "profile": {
191 "id": 70000001,
192 "profileId": 20000001,
193 "jobId": 10000001,
194 "name": "US Leases Filter",
195 "principalPositionType": {
196 "name": "LESSEE",
197 "captionKey": "enum.principalpositiontype.lessee",
198 "caption": "Lessee"
199 },
200 "filterObject": {
201 "erpSystemFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "erpSystems": [
207 {
208 "id": 10000001,
209 "displayId": "ERP-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "SAP Production System",
217 "type": {
218 "name": "NAKISA",
219 "captionKey": "enum.erpSystemType.NAKISA",
220 "caption": "NAKISA"
221 },
222 "sapVersion": {
223 "name": "ECC_EHP5",
224 "captionKey": "enum.sapVersion.ECC_EHP5",
225 "caption": "ECC_EHP5"
226 }
227 }
228 ],
229 "leaseAreaFilterType": {
230 "name": "ALL",
231 "captionKey": "enum.filterType.all",
232 "caption": "All"
233 },
234 "leaseAreas": [
235 {
236 "id": 10000001,
237 "displayId": "0001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Global Lease Area"
245 }
246 ],
247 "businessUnitFilterType": {
248 "name": "ALL",
249 "captionKey": "enum.filterType.all",
250 "caption": "All"
251 },
252 "businessUnits": [
253 {
254 "id": 10000001,
255 "displayId": "BU0001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "North America Business Unit"
263 }
264 ],
265 "companyFilterType": {
266 "name": "ALL",
267 "captionKey": "enum.filterType.all",
268 "caption": "All"
269 },
270 "companies": [
271 {
272 "id": 10000006,
273 "displayId": "1005",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "erpSystemId": 10000001,
281 "erpSystemDisplayId": "FINQ8S-300",
282 "countryId": 10000095,
283 "countryDisplayId": "CA",
284 "name": "string",
285 "postingPeriodVariantId": 0,
286 "fiscalVariantId": 0
287 }
288 ],
289 "leaseDepartmentFilterType": {
290 "name": "ALL",
291 "captionKey": "enum.filterType.all",
292 "caption": "All"
293 },
294 "leaseDepartments": [
295 {
296 "id": 300001,
297 "displayId": "DEP-01",
298 "status": {
299 "name": "ACTIVE",
300 "captionKey": "enum.objectStatus.active",
301 "active": true,
302 "caption": "Active"
303 },
304 "name": "Finance Department"
305 }
306 ],
307 "leaseGroupFilterType": {
308 "name": "ALL",
309 "captionKey": "enum.filterType.all",
310 "caption": "All"
311 },
312 "leaseGroups": [
313 {
314 "id": 60000001,
315 "displayId": "LG-001",
316 "status": {
317 "name": "ACTIVE",
318 "captionKey": "enum.objectStatus.active",
319 "active": true,
320 "caption": "Active"
321 },
322 "name": "Global Lease Group"
323 }
324 ],
325 "costCenterFilterType": {
326 "name": "ALL",
327 "captionKey": "enum.filterType.all",
328 "caption": "All"
329 },
330 "costCenters": [
331 {
332 "id": 14001,
333 "displayId": "CC-001",
334 "status": {
335 "name": "ACTIVE",
336 "captionKey": "enum.objectStatus.active",
337 "active": true,
338 "caption": "Active"
339 },
340 "name": "Cost Center A",
341 "erpSystemId": 0
342 }
343 ],
344 "profitCenterFilterType": {
345 "name": "ALL",
346 "captionKey": "enum.filterType.all",
347 "caption": "All"
348 },
349 "profitCenters": [
350 {
351 "id": 9001,
352 "displayId": "PC-001",
353 "status": {
354 "name": "ACTIVE",
355 "captionKey": "enum.objectStatus.active",
356 "active": true,
357 "caption": "Active"
358 },
359 "name": "North Region Profit Center",
360 "validTo": "2025-12-31",
361 "erpSystemId": 101,
362 "erpSystemDisplayId": "SAP-01"
363 }
364 ],
365 "wbsFilterType": {
366 "name": "ALL",
367 "captionKey": "enum.filterType.all",
368 "caption": "All"
369 },
370 "wbses": [
371 {
372 "id": 1001,
373 "displayId": "WBS-2025-001",
374 "status": {
375 "name": "ACTIVE",
376 "captionKey": "enum.objectStatus.active",
377 "active": true,
378 "caption": "Active"
379 },
380 "name": "Main Project WBS",
381 "erpSystemId": 0
382 }
383 ],
384 "businessAreaFilterType": {
385 "name": "ALL",
386 "captionKey": "enum.filterType.all",
387 "caption": "All"
388 },
389 "businessAreas": [
390 {
391 "id": 3001,
392 "displayId": "BA-2025-001",
393 "status": {
394 "name": "ACTIVE",
395 "captionKey": "enum.objectStatus.active",
396 "active": true,
397 "caption": "Active"
398 },
399 "name": "North America Operations",
400 "erpSystemId": 0
401 }
402 ],
403 "functionalAreaFilterType": {
404 "name": "ALL",
405 "captionKey": "enum.filterType.all",
406 "caption": "All"
407 },
408 "functionalAreas": [
409 {
410 "id": 2001,
411 "displayId": "FA-2025-001",
412 "status": {
413 "name": "ACTIVE",
414 "captionKey": "enum.objectStatus.active",
415 "active": true,
416 "caption": "Active"
417 },
418 "name": "Accounting Department",
419 "erpSystemId": 0
420 }
421 ]
422 }
423 }
424}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule job updated successfully |
||
400 |
Invalid request body or ID supplied |
None |
|
404 |
Mass indexation schedule job not found |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "code": {
3 "name": "OK",
4 "captionKey": "enum.responseCode.ok",
5 "caption": "OK"
6 },
7 "errors": {
8 "all": []
9 },
10 "object": {
11 "id": 10000001,
12 "cronExpression": "0 0 2 * * ?",
13 "cronReadable": "Every day at 2:00 AM",
14 "active": true,
15 "unauthorized": false,
16 "nextExecution": "2024-12-02T02:00:00Z",
17 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
18 "previousExecution": "2024-12-01T02:00:00Z",
19 "previousExecutionMessage": "Execution completed successfully",
20 "batchSize": 100,
21 "name": "Monthly CPI Indexation",
22 "profileId": 20000001,
23 "input": {
24 "id": 30000001,
25 "jobIndexationType": {
26 "name": "CPI_LOCAL",
27 "captionKey": "enum.jobIndexationType.cpiLocal",
28 "caption": "CPI Local"
29 },
30 "jobIndexationTypeNonLease": {
31 "name": "CPI_LOCAL",
32 "captionKey": "enum.jobIndexationType.cpiLocal",
33 "caption": "CPI Local"
34 },
35 "modificationDateType": {
36 "name": "JOB_DATE",
37 "captionKey": "enum.modificationDateType.jobDate",
38 "caption": "Job Date"
39 },
40 "modificationDate": "2024-12-01",
41 "referenceDateType": {
42 "name": "MODIFICATION_DATE",
43 "captionKey": "enum.referenceDateType.modificationDate",
44 "caption": "Modification Date"
45 },
46 "referenceDate": "2024-12-01",
47 "referenceDateTypeNonLease": {
48 "name": "MODIFICATION_DATE",
49 "captionKey": "enum.referenceDateType.modificationDate",
50 "caption": "Modification Date"
51 },
52 "referenceDateNonLease": "2024-12-01",
53 "indexLevelType": {
54 "name": "RATE",
55 "captionKey": "enum.indexLevelType.rate",
56 "caption": "Rate"
57 },
58 "newIndexLevel": 105.5,
59 "indexLevelTypeNonLease": {
60 "name": "RATE",
61 "captionKey": "enum.indexLevelType.rate",
62 "caption": "Rate"
63 },
64 "newIndexLevelNonLease": 103.2,
65 "indexationDateType": {
66 "name": "ROU_ANNIVERSARY_DATE",
67 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
68 "caption": "ROU Anniversary Date"
69 },
70 "indexationDateTypeNonLease": {
71 "name": "ROU_ANNIVERSARY_DATE",
72 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
73 "caption": "ROU Anniversary Date"
74 },
75 "indexationStartDate": "2024-12-01",
76 "indexationStartDateNonLease": "2024-12-01",
77 "postingDateType": {
78 "name": "JOB_DATE",
79 "captionKey": "enum.postingDateType.jobDate",
80 "caption": "Job Date"
81 },
82 "postingDate": "2024-12-01",
83 "documentDate": "2024-12-01",
84 "translationDate": "2024-12-01",
85 "indexationTreatmentType": {
86 "name": "DEFAULT",
87 "captionKey": "enum.indexationTreatmentType.default",
88 "caption": "Default"
89 },
90 "skipActivationGroupsWithOpenDraft": true,
91 "migratedFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.migratedFilterType.all",
94 "caption": "All"
95 },
96 "overrideCPICategoryInputs": [
97 {
98 "consumerPriceIndexCategoryId": 40000001,
99 "consumerPriceIndexCategoryIdNonLease": 40000002,
100 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
101 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
102 "modificationDateType": {
103 "name": "JOB_DATE",
104 "captionKey": "enum.modificationDateType.jobDate",
105 "caption": "Job Date"
106 },
107 "modificationDate": "2024-12-01",
108 "referenceDateType": {
109 "name": "MODIFICATION_DATE",
110 "captionKey": "enum.referenceDateType.modificationDate",
111 "caption": "Modification Date"
112 },
113 "referenceDateTypeNonLease": {
114 "name": "MODIFICATION_DATE",
115 "captionKey": "enum.referenceDateType.modificationDate",
116 "caption": "Modification Date"
117 },
118 "referenceDate": "2024-12-01",
119 "referenceDateNonLease": "2024-12-01",
120 "postingDateType": {
121 "name": "JOB_DATE",
122 "captionKey": "enum.postingDateType.jobDate",
123 "caption": "Job Date"
124 },
125 "postingDate": "2024-12-01",
126 "documentDate": "2024-12-01",
127 "translationDate": "2024-12-01"
128 }
129 ],
130 "revert": false,
131 "reversalReason": {
132 "id": 50000001,
133 "displayId": "REV-001",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "Incorrect Indexation",
141 "erpSystemId": 60000001,
142 "erpSystemDisplayId": "SAP-PROD"
143 },
144 "assetClassFilterType": {
145 "name": "ALL",
146 "captionKey": "enum.assetClassFilterType.all",
147 "caption": "All"
148 },
149 "assetClasses": [
150 {
151 "id": 10000001,
152 "displayId": "IAC-001",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Machinery and Equipment",
160 "assetClassType": "PROPERTY",
161 "infiniteUsefulLife": false
162 }
163 ],
164 "cpiCategoryFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.cpiCategoryFilterType.all",
167 "caption": "All"
168 },
169 "cpiCategories": [
170 {
171 "id": 101,
172 "displayId": "CPI-2025-001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Consumer Price Index - City A",
180 "city": "New York",
181 "country": "USA",
182 "province": "NY",
183 "erpSystemId": 0
184 }
185 ],
186 "listObjectType": {
187 "name": "CONTRACT",
188 "captionKey": "enum.listObjectType.contract",
189 "caption": "Contract"
190 },
191 "objectList": [
192 {
193 "id": 10000001,
194 "displayId": "ENT-001",
195 "name": "Entity Name"
196 }
197 ]
198 },
199 "profile": {
200 "id": 70000001,
201 "profileId": 20000001,
202 "jobId": 10000001,
203 "name": "US Leases Filter",
204 "principalPositionType": {
205 "name": "LESSEE",
206 "captionKey": "enum.principalpositiontype.lessee",
207 "caption": "Lessee"
208 },
209 "filterObject": {
210 "erpSystemFilterType": {
211 "name": "ALL",
212 "captionKey": "enum.filterType.all",
213 "caption": "All"
214 },
215 "erpSystems": [
216 {
217 "id": 10000001,
218 "displayId": "ERP-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "SAP Production System",
226 "type": {
227 "name": "NAKISA",
228 "captionKey": "enum.erpSystemType.NAKISA",
229 "caption": "NAKISA"
230 },
231 "sapVersion": {
232 "name": "ECC_EHP5",
233 "captionKey": "enum.sapVersion.ECC_EHP5",
234 "caption": "ECC_EHP5"
235 }
236 }
237 ],
238 "leaseAreaFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "leaseAreas": [
244 {
245 "id": 10000001,
246 "displayId": "0001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Global Lease Area"
254 }
255 ],
256 "businessUnitFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "businessUnits": [
262 {
263 "id": 10000001,
264 "displayId": "BU0001",
265 "status": {
266 "name": "ACTIVE",
267 "captionKey": "enum.objectStatus.active",
268 "active": true,
269 "caption": "Active"
270 },
271 "name": "North America Business Unit"
272 }
273 ],
274 "companyFilterType": {
275 "name": "ALL",
276 "captionKey": "enum.filterType.all",
277 "caption": "All"
278 },
279 "companies": [
280 {
281 "id": 10000006,
282 "displayId": "1005",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "erpSystemId": 10000001,
290 "erpSystemDisplayId": "FINQ8S-300",
291 "countryId": 10000095,
292 "countryDisplayId": "CA",
293 "name": "string",
294 "postingPeriodVariantId": 0,
295 "fiscalVariantId": 0
296 }
297 ],
298 "leaseDepartmentFilterType": {
299 "name": "ALL",
300 "captionKey": "enum.filterType.all",
301 "caption": "All"
302 },
303 "leaseDepartments": [
304 {
305 "id": 300001,
306 "displayId": "DEP-01",
307 "status": {
308 "name": "ACTIVE",
309 "captionKey": "enum.objectStatus.active",
310 "active": true,
311 "caption": "Active"
312 },
313 "name": "Finance Department"
314 }
315 ],
316 "leaseGroupFilterType": {
317 "name": "ALL",
318 "captionKey": "enum.filterType.all",
319 "caption": "All"
320 },
321 "leaseGroups": [
322 {
323 "id": 60000001,
324 "displayId": "LG-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Global Lease Group"
332 }
333 ],
334 "costCenterFilterType": {
335 "name": "ALL",
336 "captionKey": "enum.filterType.all",
337 "caption": "All"
338 },
339 "costCenters": [
340 {
341 "id": 14001,
342 "displayId": "CC-001",
343 "status": {
344 "name": "ACTIVE",
345 "captionKey": "enum.objectStatus.active",
346 "active": true,
347 "caption": "Active"
348 },
349 "name": "Cost Center A",
350 "erpSystemId": 0
351 }
352 ],
353 "profitCenterFilterType": {
354 "name": "ALL",
355 "captionKey": "enum.filterType.all",
356 "caption": "All"
357 },
358 "profitCenters": [
359 {
360 "id": 9001,
361 "displayId": "PC-001",
362 "status": {
363 "name": "ACTIVE",
364 "captionKey": "enum.objectStatus.active",
365 "active": true,
366 "caption": "Active"
367 },
368 "name": "North Region Profit Center",
369 "validTo": "2025-12-31",
370 "erpSystemId": 101,
371 "erpSystemDisplayId": "SAP-01"
372 }
373 ],
374 "wbsFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.filterType.all",
377 "caption": "All"
378 },
379 "wbses": [
380 {
381 "id": 1001,
382 "displayId": "WBS-2025-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Main Project WBS",
390 "erpSystemId": 0
391 }
392 ],
393 "businessAreaFilterType": {
394 "name": "ALL",
395 "captionKey": "enum.filterType.all",
396 "caption": "All"
397 },
398 "businessAreas": [
399 {
400 "id": 3001,
401 "displayId": "BA-2025-001",
402 "status": {
403 "name": "ACTIVE",
404 "captionKey": "enum.objectStatus.active",
405 "active": true,
406 "caption": "Active"
407 },
408 "name": "North America Operations",
409 "erpSystemId": 0
410 }
411 ],
412 "functionalAreaFilterType": {
413 "name": "ALL",
414 "captionKey": "enum.filterType.all",
415 "caption": "All"
416 },
417 "functionalAreas": [
418 {
419 "id": 2001,
420 "displayId": "FA-2025-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "Accounting Department",
428 "erpSystemId": 0
429 }
430 ]
431 }
432 }
433 }
434}
Delete Mass Indexation Resource¶
HTTP Request
DELETE /api/v1/batch/mass-indexation/schedule-jobs/{id}
📋 Description: Deletes a scheduled mass indexation job identified by the specified ID, facilitating the management of lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule job deleted successfully |
None |
|
400 |
Invalid ID supplied |
None |
|
404 |
Mass indexation schedule job not found |
None |
|
500 |
Internal server error |
None |
Bulk Upsert Mass Indexation Resources¶
HTTP Request
PUT /api/v1/batch/mass-indexation/schedule-jobs/createOrUpdate/bulk
📋 Description: Creates or updates multiple schedule jobs for mass indexation within the Nakisa Lease Accounting Suite, facilitating efficient management of lease, contract, financial obligation, and accounting entry data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk data for creating or updating lease contracts and associated financial obligations within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000001,
4 "cronExpression": "0 0 2 * * ?",
5 "cronReadable": "Every day at 2:00 AM",
6 "active": true,
7 "unauthorized": false,
8 "nextExecution": "2024-12-02T02:00:00Z",
9 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
10 "previousExecution": "2024-12-01T02:00:00Z",
11 "previousExecutionMessage": "Execution completed successfully",
12 "batchSize": 100,
13 "name": "Monthly CPI Indexation",
14 "profileId": 20000001,
15 "input": {
16 "id": 30000001,
17 "jobIndexationType": {
18 "name": "CPI_LOCAL",
19 "captionKey": "enum.jobIndexationType.cpiLocal",
20 "caption": "CPI Local"
21 },
22 "jobIndexationTypeNonLease": {
23 "name": "CPI_LOCAL",
24 "captionKey": "enum.jobIndexationType.cpiLocal",
25 "caption": "CPI Local"
26 },
27 "modificationDateType": {
28 "name": "JOB_DATE",
29 "captionKey": "enum.modificationDateType.jobDate",
30 "caption": "Job Date"
31 },
32 "modificationDate": "2024-12-01",
33 "referenceDateType": {
34 "name": "MODIFICATION_DATE",
35 "captionKey": "enum.referenceDateType.modificationDate",
36 "caption": "Modification Date"
37 },
38 "referenceDate": "2024-12-01",
39 "referenceDateTypeNonLease": {
40 "name": "MODIFICATION_DATE",
41 "captionKey": "enum.referenceDateType.modificationDate",
42 "caption": "Modification Date"
43 },
44 "referenceDateNonLease": "2024-12-01",
45 "indexLevelType": {
46 "name": "RATE",
47 "captionKey": "enum.indexLevelType.rate",
48 "caption": "Rate"
49 },
50 "newIndexLevel": 105.5,
51 "indexLevelTypeNonLease": {
52 "name": "RATE",
53 "captionKey": "enum.indexLevelType.rate",
54 "caption": "Rate"
55 },
56 "newIndexLevelNonLease": 103.2,
57 "indexationDateType": {
58 "name": "ROU_ANNIVERSARY_DATE",
59 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
60 "caption": "ROU Anniversary Date"
61 },
62 "indexationDateTypeNonLease": {
63 "name": "ROU_ANNIVERSARY_DATE",
64 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
65 "caption": "ROU Anniversary Date"
66 },
67 "indexationStartDate": "2024-12-01",
68 "indexationStartDateNonLease": "2024-12-01",
69 "postingDateType": {
70 "name": "JOB_DATE",
71 "captionKey": "enum.postingDateType.jobDate",
72 "caption": "Job Date"
73 },
74 "postingDate": "2024-12-01",
75 "documentDate": "2024-12-01",
76 "translationDate": "2024-12-01",
77 "indexationTreatmentType": {
78 "name": "DEFAULT",
79 "captionKey": "enum.indexationTreatmentType.default",
80 "caption": "Default"
81 },
82 "skipActivationGroupsWithOpenDraft": true,
83 "migratedFilterType": {
84 "name": "ALL",
85 "captionKey": "enum.migratedFilterType.all",
86 "caption": "All"
87 },
88 "overrideCPICategoryInputs": [
89 {
90 "consumerPriceIndexCategoryId": 40000001,
91 "consumerPriceIndexCategoryIdNonLease": 40000002,
92 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
93 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
94 "modificationDateType": {
95 "name": "JOB_DATE",
96 "captionKey": "enum.modificationDateType.jobDate",
97 "caption": "Job Date"
98 },
99 "modificationDate": "2024-12-01",
100 "referenceDateType": {
101 "name": "MODIFICATION_DATE",
102 "captionKey": "enum.referenceDateType.modificationDate",
103 "caption": "Modification Date"
104 },
105 "referenceDateTypeNonLease": {
106 "name": "MODIFICATION_DATE",
107 "captionKey": "enum.referenceDateType.modificationDate",
108 "caption": "Modification Date"
109 },
110 "referenceDate": "2024-12-01",
111 "referenceDateNonLease": "2024-12-01",
112 "postingDateType": {
113 "name": "JOB_DATE",
114 "captionKey": "enum.postingDateType.jobDate",
115 "caption": "Job Date"
116 },
117 "postingDate": "2024-12-01",
118 "documentDate": "2024-12-01",
119 "translationDate": "2024-12-01"
120 }
121 ],
122 "revert": false,
123 "reversalReason": {
124 "id": 50000001,
125 "displayId": "REV-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "Incorrect Indexation",
133 "erpSystemId": 60000001,
134 "erpSystemDisplayId": "SAP-PROD"
135 },
136 "assetClassFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.assetClassFilterType.all",
139 "caption": "All"
140 },
141 "assetClasses": [
142 {
143 "id": 10000001,
144 "displayId": "IAC-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Machinery and Equipment",
152 "assetClassType": "PROPERTY",
153 "infiniteUsefulLife": false
154 }
155 ],
156 "cpiCategoryFilterType": {
157 "name": "ALL",
158 "captionKey": "enum.cpiCategoryFilterType.all",
159 "caption": "All"
160 },
161 "cpiCategories": [
162 {
163 "id": 101,
164 "displayId": "CPI-2025-001",
165 "status": {
166 "name": "ACTIVE",
167 "captionKey": "enum.objectStatus.active",
168 "active": true,
169 "caption": "Active"
170 },
171 "name": "Consumer Price Index - City A",
172 "city": "New York",
173 "country": "USA",
174 "province": "NY",
175 "erpSystemId": 0
176 }
177 ],
178 "listObjectType": {
179 "name": "CONTRACT",
180 "captionKey": "enum.listObjectType.contract",
181 "caption": "Contract"
182 },
183 "objectList": [
184 {
185 "id": 10000001,
186 "displayId": "ENT-001",
187 "name": "Entity Name"
188 }
189 ]
190 },
191 "profile": {
192 "id": 70000001,
193 "profileId": 20000001,
194 "jobId": 10000001,
195 "name": "US Leases Filter",
196 "principalPositionType": {
197 "name": "LESSEE",
198 "captionKey": "enum.principalpositiontype.lessee",
199 "caption": "Lessee"
200 },
201 "filterObject": {
202 "erpSystemFilterType": {
203 "name": "ALL",
204 "captionKey": "enum.filterType.all",
205 "caption": "All"
206 },
207 "erpSystems": [
208 {
209 "id": 10000001,
210 "displayId": "ERP-001",
211 "status": {
212 "name": "ACTIVE",
213 "captionKey": "enum.objectStatus.active",
214 "active": true,
215 "caption": "Active"
216 },
217 "name": "SAP Production System",
218 "type": {
219 "name": "NAKISA",
220 "captionKey": "enum.erpSystemType.NAKISA",
221 "caption": "NAKISA"
222 },
223 "sapVersion": {
224 "name": "ECC_EHP5",
225 "captionKey": "enum.sapVersion.ECC_EHP5",
226 "caption": "ECC_EHP5"
227 }
228 }
229 ],
230 "leaseAreaFilterType": {
231 "name": "ALL",
232 "captionKey": "enum.filterType.all",
233 "caption": "All"
234 },
235 "leaseAreas": [
236 {
237 "id": 10000001,
238 "displayId": "0001",
239 "status": {
240 "name": "ACTIVE",
241 "captionKey": "enum.objectStatus.active",
242 "active": true,
243 "caption": "Active"
244 },
245 "name": "Global Lease Area"
246 }
247 ],
248 "businessUnitFilterType": {
249 "name": "ALL",
250 "captionKey": "enum.filterType.all",
251 "caption": "All"
252 },
253 "businessUnits": [
254 {
255 "id": 10000001,
256 "displayId": "BU0001",
257 "status": {
258 "name": "ACTIVE",
259 "captionKey": "enum.objectStatus.active",
260 "active": true,
261 "caption": "Active"
262 },
263 "name": "North America Business Unit"
264 }
265 ],
266 "companyFilterType": {
267 "name": "ALL",
268 "captionKey": "enum.filterType.all",
269 "caption": "All"
270 },
271 "companies": [
272 {
273 "id": 10000006,
274 "displayId": "1005",
275 "status": {
276 "name": "ACTIVE",
277 "captionKey": "enum.objectStatus.active",
278 "active": true,
279 "caption": "Active"
280 },
281 "erpSystemId": 10000001,
282 "erpSystemDisplayId": "FINQ8S-300",
283 "countryId": 10000095,
284 "countryDisplayId": "CA",
285 "name": "string",
286 "postingPeriodVariantId": 0,
287 "fiscalVariantId": 0
288 }
289 ],
290 "leaseDepartmentFilterType": {
291 "name": "ALL",
292 "captionKey": "enum.filterType.all",
293 "caption": "All"
294 },
295 "leaseDepartments": [
296 {
297 "id": 300001,
298 "displayId": "DEP-01",
299 "status": {
300 "name": "ACTIVE",
301 "captionKey": "enum.objectStatus.active",
302 "active": true,
303 "caption": "Active"
304 },
305 "name": "Finance Department"
306 }
307 ],
308 "leaseGroupFilterType": {
309 "name": "ALL",
310 "captionKey": "enum.filterType.all",
311 "caption": "All"
312 },
313 "leaseGroups": [
314 {
315 "id": 60000001,
316 "displayId": "LG-001",
317 "status": {
318 "name": "ACTIVE",
319 "captionKey": "enum.objectStatus.active",
320 "active": true,
321 "caption": "Active"
322 },
323 "name": "Global Lease Group"
324 }
325 ],
326 "costCenterFilterType": {
327 "name": "ALL",
328 "captionKey": "enum.filterType.all",
329 "caption": "All"
330 },
331 "costCenters": [
332 {
333 "id": 14001,
334 "displayId": "CC-001",
335 "status": {
336 "name": "ACTIVE",
337 "captionKey": "enum.objectStatus.active",
338 "active": true,
339 "caption": "Active"
340 },
341 "name": "Cost Center A",
342 "erpSystemId": 0
343 }
344 ],
345 "profitCenterFilterType": {
346 "name": "ALL",
347 "captionKey": "enum.filterType.all",
348 "caption": "All"
349 },
350 "profitCenters": [
351 {
352 "id": 9001,
353 "displayId": "PC-001",
354 "status": {
355 "name": "ACTIVE",
356 "captionKey": "enum.objectStatus.active",
357 "active": true,
358 "caption": "Active"
359 },
360 "name": "North Region Profit Center",
361 "validTo": "2025-12-31",
362 "erpSystemId": 101,
363 "erpSystemDisplayId": "SAP-01"
364 }
365 ],
366 "wbsFilterType": {
367 "name": "ALL",
368 "captionKey": "enum.filterType.all",
369 "caption": "All"
370 },
371 "wbses": [
372 {
373 "id": 1001,
374 "displayId": "WBS-2025-001",
375 "status": {
376 "name": "ACTIVE",
377 "captionKey": "enum.objectStatus.active",
378 "active": true,
379 "caption": "Active"
380 },
381 "name": "Main Project WBS",
382 "erpSystemId": 0
383 }
384 ],
385 "businessAreaFilterType": {
386 "name": "ALL",
387 "captionKey": "enum.filterType.all",
388 "caption": "All"
389 },
390 "businessAreas": [
391 {
392 "id": 3001,
393 "displayId": "BA-2025-001",
394 "status": {
395 "name": "ACTIVE",
396 "captionKey": "enum.objectStatus.active",
397 "active": true,
398 "caption": "Active"
399 },
400 "name": "North America Operations",
401 "erpSystemId": 0
402 }
403 ],
404 "functionalAreaFilterType": {
405 "name": "ALL",
406 "captionKey": "enum.filterType.all",
407 "caption": "All"
408 },
409 "functionalAreas": [
410 {
411 "id": 2001,
412 "displayId": "FA-2025-001",
413 "status": {
414 "name": "ACTIVE",
415 "captionKey": "enum.objectStatus.active",
416 "active": true,
417 "caption": "Active"
418 },
419 "name": "Accounting Department",
420 "erpSystemId": 0
421 }
422 ]
423 }
424 }
425 }
426]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule jobs created or updated successfully |
||
400 |
Invalid request body |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "code": {
3 "name": "OK",
4 "captionKey": "enum.responseCode.ok",
5 "caption": "OK"
6 },
7 "errors": {
8 "all": []
9 },
10 "object": [
11 {
12 "id": 10000001,
13 "cronExpression": "0 0 2 * * ?",
14 "cronReadable": "Every day at 2:00 AM",
15 "active": true,
16 "unauthorized": false,
17 "nextExecution": "2024-12-02T02:00:00Z",
18 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
19 "previousExecution": "2024-12-01T02:00:00Z",
20 "previousExecutionMessage": "Execution completed successfully",
21 "batchSize": 100,
22 "name": "Monthly CPI Indexation",
23 "profileId": 20000001,
24 "input": {
25 "id": 30000001,
26 "jobIndexationType": {
27 "name": "CPI_LOCAL",
28 "captionKey": "enum.jobIndexationType.cpiLocal",
29 "caption": "CPI Local"
30 },
31 "jobIndexationTypeNonLease": {
32 "name": "CPI_LOCAL",
33 "captionKey": "enum.jobIndexationType.cpiLocal",
34 "caption": "CPI Local"
35 },
36 "modificationDateType": {
37 "name": "JOB_DATE",
38 "captionKey": "enum.modificationDateType.jobDate",
39 "caption": "Job Date"
40 },
41 "modificationDate": "2024-12-01",
42 "referenceDateType": {
43 "name": "MODIFICATION_DATE",
44 "captionKey": "enum.referenceDateType.modificationDate",
45 "caption": "Modification Date"
46 },
47 "referenceDate": "2024-12-01",
48 "referenceDateTypeNonLease": {
49 "name": "MODIFICATION_DATE",
50 "captionKey": "enum.referenceDateType.modificationDate",
51 "caption": "Modification Date"
52 },
53 "referenceDateNonLease": "2024-12-01",
54 "indexLevelType": {
55 "name": "RATE",
56 "captionKey": "enum.indexLevelType.rate",
57 "caption": "Rate"
58 },
59 "newIndexLevel": 105.5,
60 "indexLevelTypeNonLease": {
61 "name": "RATE",
62 "captionKey": "enum.indexLevelType.rate",
63 "caption": "Rate"
64 },
65 "newIndexLevelNonLease": 103.2,
66 "indexationDateType": {
67 "name": "ROU_ANNIVERSARY_DATE",
68 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
69 "caption": "ROU Anniversary Date"
70 },
71 "indexationDateTypeNonLease": {
72 "name": "ROU_ANNIVERSARY_DATE",
73 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
74 "caption": "ROU Anniversary Date"
75 },
76 "indexationStartDate": "2024-12-01",
77 "indexationStartDateNonLease": "2024-12-01",
78 "postingDateType": {
79 "name": "JOB_DATE",
80 "captionKey": "enum.postingDateType.jobDate",
81 "caption": "Job Date"
82 },
83 "postingDate": "2024-12-01",
84 "documentDate": "2024-12-01",
85 "translationDate": "2024-12-01",
86 "indexationTreatmentType": {
87 "name": "DEFAULT",
88 "captionKey": "enum.indexationTreatmentType.default",
89 "caption": "Default"
90 },
91 "skipActivationGroupsWithOpenDraft": true,
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 },
97 "overrideCPICategoryInputs": [
98 {
99 "consumerPriceIndexCategoryId": 40000001,
100 "consumerPriceIndexCategoryIdNonLease": 40000002,
101 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
102 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
103 "modificationDateType": {
104 "name": "JOB_DATE",
105 "captionKey": "enum.modificationDateType.jobDate",
106 "caption": "Job Date"
107 },
108 "modificationDate": "2024-12-01",
109 "referenceDateType": {
110 "name": "MODIFICATION_DATE",
111 "captionKey": "enum.referenceDateType.modificationDate",
112 "caption": "Modification Date"
113 },
114 "referenceDateTypeNonLease": {
115 "name": "MODIFICATION_DATE",
116 "captionKey": "enum.referenceDateType.modificationDate",
117 "caption": "Modification Date"
118 },
119 "referenceDate": "2024-12-01",
120 "referenceDateNonLease": "2024-12-01",
121 "postingDateType": {
122 "name": "JOB_DATE",
123 "captionKey": "enum.postingDateType.jobDate",
124 "caption": "Job Date"
125 },
126 "postingDate": "2024-12-01",
127 "documentDate": "2024-12-01",
128 "translationDate": "2024-12-01"
129 }
130 ],
131 "revert": false,
132 "reversalReason": {
133 "id": 50000001,
134 "displayId": "REV-001",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "name": "Incorrect Indexation",
142 "erpSystemId": 60000001,
143 "erpSystemDisplayId": "SAP-PROD"
144 },
145 "assetClassFilterType": {
146 "name": "ALL",
147 "captionKey": "enum.assetClassFilterType.all",
148 "caption": "All"
149 },
150 "assetClasses": [
151 {
152 "id": 10000001,
153 "displayId": "IAC-001",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Machinery and Equipment",
161 "assetClassType": "PROPERTY",
162 "infiniteUsefulLife": false
163 }
164 ],
165 "cpiCategoryFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.cpiCategoryFilterType.all",
168 "caption": "All"
169 },
170 "cpiCategories": [
171 {
172 "id": 101,
173 "displayId": "CPI-2025-001",
174 "status": {
175 "name": "ACTIVE",
176 "captionKey": "enum.objectStatus.active",
177 "active": true,
178 "caption": "Active"
179 },
180 "name": "Consumer Price Index - City A",
181 "city": "New York",
182 "country": "USA",
183 "province": "NY",
184 "erpSystemId": 0
185 }
186 ],
187 "listObjectType": {
188 "name": "CONTRACT",
189 "captionKey": "enum.listObjectType.contract",
190 "caption": "Contract"
191 },
192 "objectList": [
193 {
194 "id": 10000001,
195 "displayId": "ENT-001",
196 "name": "Entity Name"
197 }
198 ]
199 },
200 "profile": {
201 "id": 70000001,
202 "profileId": 20000001,
203 "jobId": 10000001,
204 "name": "US Leases Filter",
205 "principalPositionType": {
206 "name": "LESSEE",
207 "captionKey": "enum.principalpositiontype.lessee",
208 "caption": "Lessee"
209 },
210 "filterObject": {
211 "erpSystemFilterType": {
212 "name": "ALL",
213 "captionKey": "enum.filterType.all",
214 "caption": "All"
215 },
216 "erpSystems": [
217 {
218 "id": 10000001,
219 "displayId": "ERP-001",
220 "status": {
221 "name": "ACTIVE",
222 "captionKey": "enum.objectStatus.active",
223 "active": true,
224 "caption": "Active"
225 },
226 "name": "SAP Production System",
227 "type": {
228 "name": "NAKISA",
229 "captionKey": "enum.erpSystemType.NAKISA",
230 "caption": "NAKISA"
231 },
232 "sapVersion": {
233 "name": "ECC_EHP5",
234 "captionKey": "enum.sapVersion.ECC_EHP5",
235 "caption": "ECC_EHP5"
236 }
237 }
238 ],
239 "leaseAreaFilterType": {
240 "name": "ALL",
241 "captionKey": "enum.filterType.all",
242 "caption": "All"
243 },
244 "leaseAreas": [
245 {
246 "id": 10000001,
247 "displayId": "0001",
248 "status": {
249 "name": "ACTIVE",
250 "captionKey": "enum.objectStatus.active",
251 "active": true,
252 "caption": "Active"
253 },
254 "name": "Global Lease Area"
255 }
256 ],
257 "businessUnitFilterType": {
258 "name": "ALL",
259 "captionKey": "enum.filterType.all",
260 "caption": "All"
261 },
262 "businessUnits": [
263 {
264 "id": 10000001,
265 "displayId": "BU0001",
266 "status": {
267 "name": "ACTIVE",
268 "captionKey": "enum.objectStatus.active",
269 "active": true,
270 "caption": "Active"
271 },
272 "name": "North America Business Unit"
273 }
274 ],
275 "companyFilterType": {
276 "name": "ALL",
277 "captionKey": "enum.filterType.all",
278 "caption": "All"
279 },
280 "companies": [
281 {
282 "id": 10000006,
283 "displayId": "1005",
284 "status": {
285 "name": "ACTIVE",
286 "captionKey": "enum.objectStatus.active",
287 "active": true,
288 "caption": "Active"
289 },
290 "erpSystemId": 10000001,
291 "erpSystemDisplayId": "FINQ8S-300",
292 "countryId": 10000095,
293 "countryDisplayId": "CA",
294 "name": "string",
295 "postingPeriodVariantId": 0,
296 "fiscalVariantId": 0
297 }
298 ],
299 "leaseDepartmentFilterType": {
300 "name": "ALL",
301 "captionKey": "enum.filterType.all",
302 "caption": "All"
303 },
304 "leaseDepartments": [
305 {
306 "id": 300001,
307 "displayId": "DEP-01",
308 "status": {
309 "name": "ACTIVE",
310 "captionKey": "enum.objectStatus.active",
311 "active": true,
312 "caption": "Active"
313 },
314 "name": "Finance Department"
315 }
316 ],
317 "leaseGroupFilterType": {
318 "name": "ALL",
319 "captionKey": "enum.filterType.all",
320 "caption": "All"
321 },
322 "leaseGroups": [
323 {
324 "id": 60000001,
325 "displayId": "LG-001",
326 "status": {
327 "name": "ACTIVE",
328 "captionKey": "enum.objectStatus.active",
329 "active": true,
330 "caption": "Active"
331 },
332 "name": "Global Lease Group"
333 }
334 ],
335 "costCenterFilterType": {
336 "name": "ALL",
337 "captionKey": "enum.filterType.all",
338 "caption": "All"
339 },
340 "costCenters": [
341 {
342 "id": 14001,
343 "displayId": "CC-001",
344 "status": {
345 "name": "ACTIVE",
346 "captionKey": "enum.objectStatus.active",
347 "active": true,
348 "caption": "Active"
349 },
350 "name": "Cost Center A",
351 "erpSystemId": 0
352 }
353 ],
354 "profitCenterFilterType": {
355 "name": "ALL",
356 "captionKey": "enum.filterType.all",
357 "caption": "All"
358 },
359 "profitCenters": [
360 {
361 "id": 9001,
362 "displayId": "PC-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "North Region Profit Center",
370 "validTo": "2025-12-31",
371 "erpSystemId": 101,
372 "erpSystemDisplayId": "SAP-01"
373 }
374 ],
375 "wbsFilterType": {
376 "name": "ALL",
377 "captionKey": "enum.filterType.all",
378 "caption": "All"
379 },
380 "wbses": [
381 {
382 "id": 1001,
383 "displayId": "WBS-2025-001",
384 "status": {
385 "name": "ACTIVE",
386 "captionKey": "enum.objectStatus.active",
387 "active": true,
388 "caption": "Active"
389 },
390 "name": "Main Project WBS",
391 "erpSystemId": 0
392 }
393 ],
394 "businessAreaFilterType": {
395 "name": "ALL",
396 "captionKey": "enum.filterType.all",
397 "caption": "All"
398 },
399 "businessAreas": [
400 {
401 "id": 3001,
402 "displayId": "BA-2025-001",
403 "status": {
404 "name": "ACTIVE",
405 "captionKey": "enum.objectStatus.active",
406 "active": true,
407 "caption": "Active"
408 },
409 "name": "North America Operations",
410 "erpSystemId": 0
411 }
412 ],
413 "functionalAreaFilterType": {
414 "name": "ALL",
415 "captionKey": "enum.filterType.all",
416 "caption": "All"
417 },
418 "functionalAreas": [
419 {
420 "id": 2001,
421 "displayId": "FA-2025-001",
422 "status": {
423 "name": "ACTIVE",
424 "captionKey": "enum.objectStatus.active",
425 "active": true,
426 "caption": "Active"
427 },
428 "name": "Accounting Department",
429 "erpSystemId": 0
430 }
431 ]
432 }
433 }
434 }
435 ]
436}
Upsert Mass Indexation Resource¶
HTTP Request
PUT /api/v1/batch/mass-indexation/schedule-jobs/createOrUpdate
📋 Description: Creates or updates scheduled jobs for mass indexation within the Nakisa Lease Accounting Suite, facilitating the efficient management of leases, contracts, financial obligations, and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease and contract data necessary for creating or updating scheduled jobs related to financial obligations and accounting entries. |
Body Parameters
1{
2 "id": 10000001,
3 "cronExpression": "0 0 2 * * ?",
4 "cronReadable": "Every day at 2:00 AM",
5 "active": true,
6 "unauthorized": false,
7 "nextExecution": "2024-12-02T02:00:00Z",
8 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
9 "previousExecution": "2024-12-01T02:00:00Z",
10 "previousExecutionMessage": "Execution completed successfully",
11 "batchSize": 100,
12 "name": "Monthly CPI Indexation",
13 "profileId": 20000001,
14 "input": {
15 "id": 30000001,
16 "jobIndexationType": {
17 "name": "CPI_LOCAL",
18 "captionKey": "enum.jobIndexationType.cpiLocal",
19 "caption": "CPI Local"
20 },
21 "jobIndexationTypeNonLease": {
22 "name": "CPI_LOCAL",
23 "captionKey": "enum.jobIndexationType.cpiLocal",
24 "caption": "CPI Local"
25 },
26 "modificationDateType": {
27 "name": "JOB_DATE",
28 "captionKey": "enum.modificationDateType.jobDate",
29 "caption": "Job Date"
30 },
31 "modificationDate": "2024-12-01",
32 "referenceDateType": {
33 "name": "MODIFICATION_DATE",
34 "captionKey": "enum.referenceDateType.modificationDate",
35 "caption": "Modification Date"
36 },
37 "referenceDate": "2024-12-01",
38 "referenceDateTypeNonLease": {
39 "name": "MODIFICATION_DATE",
40 "captionKey": "enum.referenceDateType.modificationDate",
41 "caption": "Modification Date"
42 },
43 "referenceDateNonLease": "2024-12-01",
44 "indexLevelType": {
45 "name": "RATE",
46 "captionKey": "enum.indexLevelType.rate",
47 "caption": "Rate"
48 },
49 "newIndexLevel": 105.5,
50 "indexLevelTypeNonLease": {
51 "name": "RATE",
52 "captionKey": "enum.indexLevelType.rate",
53 "caption": "Rate"
54 },
55 "newIndexLevelNonLease": 103.2,
56 "indexationDateType": {
57 "name": "ROU_ANNIVERSARY_DATE",
58 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
59 "caption": "ROU Anniversary Date"
60 },
61 "indexationDateTypeNonLease": {
62 "name": "ROU_ANNIVERSARY_DATE",
63 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
64 "caption": "ROU Anniversary Date"
65 },
66 "indexationStartDate": "2024-12-01",
67 "indexationStartDateNonLease": "2024-12-01",
68 "postingDateType": {
69 "name": "JOB_DATE",
70 "captionKey": "enum.postingDateType.jobDate",
71 "caption": "Job Date"
72 },
73 "postingDate": "2024-12-01",
74 "documentDate": "2024-12-01",
75 "translationDate": "2024-12-01",
76 "indexationTreatmentType": {
77 "name": "DEFAULT",
78 "captionKey": "enum.indexationTreatmentType.default",
79 "caption": "Default"
80 },
81 "skipActivationGroupsWithOpenDraft": true,
82 "migratedFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.migratedFilterType.all",
85 "caption": "All"
86 },
87 "overrideCPICategoryInputs": [
88 {
89 "consumerPriceIndexCategoryId": 40000001,
90 "consumerPriceIndexCategoryIdNonLease": 40000002,
91 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
92 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
93 "modificationDateType": {
94 "name": "JOB_DATE",
95 "captionKey": "enum.modificationDateType.jobDate",
96 "caption": "Job Date"
97 },
98 "modificationDate": "2024-12-01",
99 "referenceDateType": {
100 "name": "MODIFICATION_DATE",
101 "captionKey": "enum.referenceDateType.modificationDate",
102 "caption": "Modification Date"
103 },
104 "referenceDateTypeNonLease": {
105 "name": "MODIFICATION_DATE",
106 "captionKey": "enum.referenceDateType.modificationDate",
107 "caption": "Modification Date"
108 },
109 "referenceDate": "2024-12-01",
110 "referenceDateNonLease": "2024-12-01",
111 "postingDateType": {
112 "name": "JOB_DATE",
113 "captionKey": "enum.postingDateType.jobDate",
114 "caption": "Job Date"
115 },
116 "postingDate": "2024-12-01",
117 "documentDate": "2024-12-01",
118 "translationDate": "2024-12-01"
119 }
120 ],
121 "revert": false,
122 "reversalReason": {
123 "id": 50000001,
124 "displayId": "REV-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Incorrect Indexation",
132 "erpSystemId": 60000001,
133 "erpSystemDisplayId": "SAP-PROD"
134 },
135 "assetClassFilterType": {
136 "name": "ALL",
137 "captionKey": "enum.assetClassFilterType.all",
138 "caption": "All"
139 },
140 "assetClasses": [
141 {
142 "id": 10000001,
143 "displayId": "IAC-001",
144 "status": {
145 "name": "ACTIVE",
146 "captionKey": "enum.objectStatus.active",
147 "active": true,
148 "caption": "Active"
149 },
150 "name": "Machinery and Equipment",
151 "assetClassType": "PROPERTY",
152 "infiniteUsefulLife": false
153 }
154 ],
155 "cpiCategoryFilterType": {
156 "name": "ALL",
157 "captionKey": "enum.cpiCategoryFilterType.all",
158 "caption": "All"
159 },
160 "cpiCategories": [
161 {
162 "id": 101,
163 "displayId": "CPI-2025-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "Consumer Price Index - City A",
171 "city": "New York",
172 "country": "USA",
173 "province": "NY",
174 "erpSystemId": 0
175 }
176 ],
177 "listObjectType": {
178 "name": "CONTRACT",
179 "captionKey": "enum.listObjectType.contract",
180 "caption": "Contract"
181 },
182 "objectList": [
183 {
184 "id": 10000001,
185 "displayId": "ENT-001",
186 "name": "Entity Name"
187 }
188 ]
189 },
190 "profile": {
191 "id": 70000001,
192 "profileId": 20000001,
193 "jobId": 10000001,
194 "name": "US Leases Filter",
195 "principalPositionType": {
196 "name": "LESSEE",
197 "captionKey": "enum.principalpositiontype.lessee",
198 "caption": "Lessee"
199 },
200 "filterObject": {
201 "erpSystemFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "erpSystems": [
207 {
208 "id": 10000001,
209 "displayId": "ERP-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "SAP Production System",
217 "type": {
218 "name": "NAKISA",
219 "captionKey": "enum.erpSystemType.NAKISA",
220 "caption": "NAKISA"
221 },
222 "sapVersion": {
223 "name": "ECC_EHP5",
224 "captionKey": "enum.sapVersion.ECC_EHP5",
225 "caption": "ECC_EHP5"
226 }
227 }
228 ],
229 "leaseAreaFilterType": {
230 "name": "ALL",
231 "captionKey": "enum.filterType.all",
232 "caption": "All"
233 },
234 "leaseAreas": [
235 {
236 "id": 10000001,
237 "displayId": "0001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Global Lease Area"
245 }
246 ],
247 "businessUnitFilterType": {
248 "name": "ALL",
249 "captionKey": "enum.filterType.all",
250 "caption": "All"
251 },
252 "businessUnits": [
253 {
254 "id": 10000001,
255 "displayId": "BU0001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "North America Business Unit"
263 }
264 ],
265 "companyFilterType": {
266 "name": "ALL",
267 "captionKey": "enum.filterType.all",
268 "caption": "All"
269 },
270 "companies": [
271 {
272 "id": 10000006,
273 "displayId": "1005",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "erpSystemId": 10000001,
281 "erpSystemDisplayId": "FINQ8S-300",
282 "countryId": 10000095,
283 "countryDisplayId": "CA",
284 "name": "string",
285 "postingPeriodVariantId": 0,
286 "fiscalVariantId": 0
287 }
288 ],
289 "leaseDepartmentFilterType": {
290 "name": "ALL",
291 "captionKey": "enum.filterType.all",
292 "caption": "All"
293 },
294 "leaseDepartments": [
295 {
296 "id": 300001,
297 "displayId": "DEP-01",
298 "status": {
299 "name": "ACTIVE",
300 "captionKey": "enum.objectStatus.active",
301 "active": true,
302 "caption": "Active"
303 },
304 "name": "Finance Department"
305 }
306 ],
307 "leaseGroupFilterType": {
308 "name": "ALL",
309 "captionKey": "enum.filterType.all",
310 "caption": "All"
311 },
312 "leaseGroups": [
313 {
314 "id": 60000001,
315 "displayId": "LG-001",
316 "status": {
317 "name": "ACTIVE",
318 "captionKey": "enum.objectStatus.active",
319 "active": true,
320 "caption": "Active"
321 },
322 "name": "Global Lease Group"
323 }
324 ],
325 "costCenterFilterType": {
326 "name": "ALL",
327 "captionKey": "enum.filterType.all",
328 "caption": "All"
329 },
330 "costCenters": [
331 {
332 "id": 14001,
333 "displayId": "CC-001",
334 "status": {
335 "name": "ACTIVE",
336 "captionKey": "enum.objectStatus.active",
337 "active": true,
338 "caption": "Active"
339 },
340 "name": "Cost Center A",
341 "erpSystemId": 0
342 }
343 ],
344 "profitCenterFilterType": {
345 "name": "ALL",
346 "captionKey": "enum.filterType.all",
347 "caption": "All"
348 },
349 "profitCenters": [
350 {
351 "id": 9001,
352 "displayId": "PC-001",
353 "status": {
354 "name": "ACTIVE",
355 "captionKey": "enum.objectStatus.active",
356 "active": true,
357 "caption": "Active"
358 },
359 "name": "North Region Profit Center",
360 "validTo": "2025-12-31",
361 "erpSystemId": 101,
362 "erpSystemDisplayId": "SAP-01"
363 }
364 ],
365 "wbsFilterType": {
366 "name": "ALL",
367 "captionKey": "enum.filterType.all",
368 "caption": "All"
369 },
370 "wbses": [
371 {
372 "id": 1001,
373 "displayId": "WBS-2025-001",
374 "status": {
375 "name": "ACTIVE",
376 "captionKey": "enum.objectStatus.active",
377 "active": true,
378 "caption": "Active"
379 },
380 "name": "Main Project WBS",
381 "erpSystemId": 0
382 }
383 ],
384 "businessAreaFilterType": {
385 "name": "ALL",
386 "captionKey": "enum.filterType.all",
387 "caption": "All"
388 },
389 "businessAreas": [
390 {
391 "id": 3001,
392 "displayId": "BA-2025-001",
393 "status": {
394 "name": "ACTIVE",
395 "captionKey": "enum.objectStatus.active",
396 "active": true,
397 "caption": "Active"
398 },
399 "name": "North America Operations",
400 "erpSystemId": 0
401 }
402 ],
403 "functionalAreaFilterType": {
404 "name": "ALL",
405 "captionKey": "enum.filterType.all",
406 "caption": "All"
407 },
408 "functionalAreas": [
409 {
410 "id": 2001,
411 "displayId": "FA-2025-001",
412 "status": {
413 "name": "ACTIVE",
414 "captionKey": "enum.objectStatus.active",
415 "active": true,
416 "caption": "Active"
417 },
418 "name": "Accounting Department",
419 "erpSystemId": 0
420 }
421 ]
422 }
423 }
424}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule job created or updated successfully |
||
400 |
Invalid request body |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "code": {
3 "name": "OK",
4 "captionKey": "enum.responseCode.ok",
5 "caption": "OK"
6 },
7 "errors": {
8 "all": []
9 },
10 "object": {
11 "id": 10000001,
12 "cronExpression": "0 0 2 * * ?",
13 "cronReadable": "Every day at 2:00 AM",
14 "active": true,
15 "unauthorized": false,
16 "nextExecution": "2024-12-02T02:00:00Z",
17 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
18 "previousExecution": "2024-12-01T02:00:00Z",
19 "previousExecutionMessage": "Execution completed successfully",
20 "batchSize": 100,
21 "name": "Monthly CPI Indexation",
22 "profileId": 20000001,
23 "input": {
24 "id": 30000001,
25 "jobIndexationType": {
26 "name": "CPI_LOCAL",
27 "captionKey": "enum.jobIndexationType.cpiLocal",
28 "caption": "CPI Local"
29 },
30 "jobIndexationTypeNonLease": {
31 "name": "CPI_LOCAL",
32 "captionKey": "enum.jobIndexationType.cpiLocal",
33 "caption": "CPI Local"
34 },
35 "modificationDateType": {
36 "name": "JOB_DATE",
37 "captionKey": "enum.modificationDateType.jobDate",
38 "caption": "Job Date"
39 },
40 "modificationDate": "2024-12-01",
41 "referenceDateType": {
42 "name": "MODIFICATION_DATE",
43 "captionKey": "enum.referenceDateType.modificationDate",
44 "caption": "Modification Date"
45 },
46 "referenceDate": "2024-12-01",
47 "referenceDateTypeNonLease": {
48 "name": "MODIFICATION_DATE",
49 "captionKey": "enum.referenceDateType.modificationDate",
50 "caption": "Modification Date"
51 },
52 "referenceDateNonLease": "2024-12-01",
53 "indexLevelType": {
54 "name": "RATE",
55 "captionKey": "enum.indexLevelType.rate",
56 "caption": "Rate"
57 },
58 "newIndexLevel": 105.5,
59 "indexLevelTypeNonLease": {
60 "name": "RATE",
61 "captionKey": "enum.indexLevelType.rate",
62 "caption": "Rate"
63 },
64 "newIndexLevelNonLease": 103.2,
65 "indexationDateType": {
66 "name": "ROU_ANNIVERSARY_DATE",
67 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
68 "caption": "ROU Anniversary Date"
69 },
70 "indexationDateTypeNonLease": {
71 "name": "ROU_ANNIVERSARY_DATE",
72 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
73 "caption": "ROU Anniversary Date"
74 },
75 "indexationStartDate": "2024-12-01",
76 "indexationStartDateNonLease": "2024-12-01",
77 "postingDateType": {
78 "name": "JOB_DATE",
79 "captionKey": "enum.postingDateType.jobDate",
80 "caption": "Job Date"
81 },
82 "postingDate": "2024-12-01",
83 "documentDate": "2024-12-01",
84 "translationDate": "2024-12-01",
85 "indexationTreatmentType": {
86 "name": "DEFAULT",
87 "captionKey": "enum.indexationTreatmentType.default",
88 "caption": "Default"
89 },
90 "skipActivationGroupsWithOpenDraft": true,
91 "migratedFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.migratedFilterType.all",
94 "caption": "All"
95 },
96 "overrideCPICategoryInputs": [
97 {
98 "consumerPriceIndexCategoryId": 40000001,
99 "consumerPriceIndexCategoryIdNonLease": 40000002,
100 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
101 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
102 "modificationDateType": {
103 "name": "JOB_DATE",
104 "captionKey": "enum.modificationDateType.jobDate",
105 "caption": "Job Date"
106 },
107 "modificationDate": "2024-12-01",
108 "referenceDateType": {
109 "name": "MODIFICATION_DATE",
110 "captionKey": "enum.referenceDateType.modificationDate",
111 "caption": "Modification Date"
112 },
113 "referenceDateTypeNonLease": {
114 "name": "MODIFICATION_DATE",
115 "captionKey": "enum.referenceDateType.modificationDate",
116 "caption": "Modification Date"
117 },
118 "referenceDate": "2024-12-01",
119 "referenceDateNonLease": "2024-12-01",
120 "postingDateType": {
121 "name": "JOB_DATE",
122 "captionKey": "enum.postingDateType.jobDate",
123 "caption": "Job Date"
124 },
125 "postingDate": "2024-12-01",
126 "documentDate": "2024-12-01",
127 "translationDate": "2024-12-01"
128 }
129 ],
130 "revert": false,
131 "reversalReason": {
132 "id": 50000001,
133 "displayId": "REV-001",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "Incorrect Indexation",
141 "erpSystemId": 60000001,
142 "erpSystemDisplayId": "SAP-PROD"
143 },
144 "assetClassFilterType": {
145 "name": "ALL",
146 "captionKey": "enum.assetClassFilterType.all",
147 "caption": "All"
148 },
149 "assetClasses": [
150 {
151 "id": 10000001,
152 "displayId": "IAC-001",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Machinery and Equipment",
160 "assetClassType": "PROPERTY",
161 "infiniteUsefulLife": false
162 }
163 ],
164 "cpiCategoryFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.cpiCategoryFilterType.all",
167 "caption": "All"
168 },
169 "cpiCategories": [
170 {
171 "id": 101,
172 "displayId": "CPI-2025-001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Consumer Price Index - City A",
180 "city": "New York",
181 "country": "USA",
182 "province": "NY",
183 "erpSystemId": 0
184 }
185 ],
186 "listObjectType": {
187 "name": "CONTRACT",
188 "captionKey": "enum.listObjectType.contract",
189 "caption": "Contract"
190 },
191 "objectList": [
192 {
193 "id": 10000001,
194 "displayId": "ENT-001",
195 "name": "Entity Name"
196 }
197 ]
198 },
199 "profile": {
200 "id": 70000001,
201 "profileId": 20000001,
202 "jobId": 10000001,
203 "name": "US Leases Filter",
204 "principalPositionType": {
205 "name": "LESSEE",
206 "captionKey": "enum.principalpositiontype.lessee",
207 "caption": "Lessee"
208 },
209 "filterObject": {
210 "erpSystemFilterType": {
211 "name": "ALL",
212 "captionKey": "enum.filterType.all",
213 "caption": "All"
214 },
215 "erpSystems": [
216 {
217 "id": 10000001,
218 "displayId": "ERP-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "SAP Production System",
226 "type": {
227 "name": "NAKISA",
228 "captionKey": "enum.erpSystemType.NAKISA",
229 "caption": "NAKISA"
230 },
231 "sapVersion": {
232 "name": "ECC_EHP5",
233 "captionKey": "enum.sapVersion.ECC_EHP5",
234 "caption": "ECC_EHP5"
235 }
236 }
237 ],
238 "leaseAreaFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "leaseAreas": [
244 {
245 "id": 10000001,
246 "displayId": "0001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Global Lease Area"
254 }
255 ],
256 "businessUnitFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "businessUnits": [
262 {
263 "id": 10000001,
264 "displayId": "BU0001",
265 "status": {
266 "name": "ACTIVE",
267 "captionKey": "enum.objectStatus.active",
268 "active": true,
269 "caption": "Active"
270 },
271 "name": "North America Business Unit"
272 }
273 ],
274 "companyFilterType": {
275 "name": "ALL",
276 "captionKey": "enum.filterType.all",
277 "caption": "All"
278 },
279 "companies": [
280 {
281 "id": 10000006,
282 "displayId": "1005",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "erpSystemId": 10000001,
290 "erpSystemDisplayId": "FINQ8S-300",
291 "countryId": 10000095,
292 "countryDisplayId": "CA",
293 "name": "string",
294 "postingPeriodVariantId": 0,
295 "fiscalVariantId": 0
296 }
297 ],
298 "leaseDepartmentFilterType": {
299 "name": "ALL",
300 "captionKey": "enum.filterType.all",
301 "caption": "All"
302 },
303 "leaseDepartments": [
304 {
305 "id": 300001,
306 "displayId": "DEP-01",
307 "status": {
308 "name": "ACTIVE",
309 "captionKey": "enum.objectStatus.active",
310 "active": true,
311 "caption": "Active"
312 },
313 "name": "Finance Department"
314 }
315 ],
316 "leaseGroupFilterType": {
317 "name": "ALL",
318 "captionKey": "enum.filterType.all",
319 "caption": "All"
320 },
321 "leaseGroups": [
322 {
323 "id": 60000001,
324 "displayId": "LG-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Global Lease Group"
332 }
333 ],
334 "costCenterFilterType": {
335 "name": "ALL",
336 "captionKey": "enum.filterType.all",
337 "caption": "All"
338 },
339 "costCenters": [
340 {
341 "id": 14001,
342 "displayId": "CC-001",
343 "status": {
344 "name": "ACTIVE",
345 "captionKey": "enum.objectStatus.active",
346 "active": true,
347 "caption": "Active"
348 },
349 "name": "Cost Center A",
350 "erpSystemId": 0
351 }
352 ],
353 "profitCenterFilterType": {
354 "name": "ALL",
355 "captionKey": "enum.filterType.all",
356 "caption": "All"
357 },
358 "profitCenters": [
359 {
360 "id": 9001,
361 "displayId": "PC-001",
362 "status": {
363 "name": "ACTIVE",
364 "captionKey": "enum.objectStatus.active",
365 "active": true,
366 "caption": "Active"
367 },
368 "name": "North Region Profit Center",
369 "validTo": "2025-12-31",
370 "erpSystemId": 101,
371 "erpSystemDisplayId": "SAP-01"
372 }
373 ],
374 "wbsFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.filterType.all",
377 "caption": "All"
378 },
379 "wbses": [
380 {
381 "id": 1001,
382 "displayId": "WBS-2025-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Main Project WBS",
390 "erpSystemId": 0
391 }
392 ],
393 "businessAreaFilterType": {
394 "name": "ALL",
395 "captionKey": "enum.filterType.all",
396 "caption": "All"
397 },
398 "businessAreas": [
399 {
400 "id": 3001,
401 "displayId": "BA-2025-001",
402 "status": {
403 "name": "ACTIVE",
404 "captionKey": "enum.objectStatus.active",
405 "active": true,
406 "caption": "Active"
407 },
408 "name": "North America Operations",
409 "erpSystemId": 0
410 }
411 ],
412 "functionalAreaFilterType": {
413 "name": "ALL",
414 "captionKey": "enum.filterType.all",
415 "caption": "All"
416 },
417 "functionalAreas": [
418 {
419 "id": 2001,
420 "displayId": "FA-2025-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "Accounting Department",
428 "erpSystemId": 0
429 }
430 ]
431 }
432 }
433 }
434}
Bulk Update Mass Indexation Resources¶
HTTP Request
PUT /api/v1/batch/mass-indexation/schedule-jobs/bulk
📋 Description: Schedules bulk jobs for mass indexation of leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient management of accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk job scheduling data for lease, contract, financial obligation, and accounting entry mass indexation within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000001,
4 "cronExpression": "0 0 2 * * ?",
5 "cronReadable": "Every day at 2:00 AM",
6 "active": true,
7 "unauthorized": false,
8 "nextExecution": "2024-12-02T02:00:00Z",
9 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
10 "previousExecution": "2024-12-01T02:00:00Z",
11 "previousExecutionMessage": "Execution completed successfully",
12 "batchSize": 100,
13 "name": "Monthly CPI Indexation",
14 "profileId": 20000001,
15 "input": {
16 "id": 30000001,
17 "jobIndexationType": {
18 "name": "CPI_LOCAL",
19 "captionKey": "enum.jobIndexationType.cpiLocal",
20 "caption": "CPI Local"
21 },
22 "jobIndexationTypeNonLease": {
23 "name": "CPI_LOCAL",
24 "captionKey": "enum.jobIndexationType.cpiLocal",
25 "caption": "CPI Local"
26 },
27 "modificationDateType": {
28 "name": "JOB_DATE",
29 "captionKey": "enum.modificationDateType.jobDate",
30 "caption": "Job Date"
31 },
32 "modificationDate": "2024-12-01",
33 "referenceDateType": {
34 "name": "MODIFICATION_DATE",
35 "captionKey": "enum.referenceDateType.modificationDate",
36 "caption": "Modification Date"
37 },
38 "referenceDate": "2024-12-01",
39 "referenceDateTypeNonLease": {
40 "name": "MODIFICATION_DATE",
41 "captionKey": "enum.referenceDateType.modificationDate",
42 "caption": "Modification Date"
43 },
44 "referenceDateNonLease": "2024-12-01",
45 "indexLevelType": {
46 "name": "RATE",
47 "captionKey": "enum.indexLevelType.rate",
48 "caption": "Rate"
49 },
50 "newIndexLevel": 105.5,
51 "indexLevelTypeNonLease": {
52 "name": "RATE",
53 "captionKey": "enum.indexLevelType.rate",
54 "caption": "Rate"
55 },
56 "newIndexLevelNonLease": 103.2,
57 "indexationDateType": {
58 "name": "ROU_ANNIVERSARY_DATE",
59 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
60 "caption": "ROU Anniversary Date"
61 },
62 "indexationDateTypeNonLease": {
63 "name": "ROU_ANNIVERSARY_DATE",
64 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
65 "caption": "ROU Anniversary Date"
66 },
67 "indexationStartDate": "2024-12-01",
68 "indexationStartDateNonLease": "2024-12-01",
69 "postingDateType": {
70 "name": "JOB_DATE",
71 "captionKey": "enum.postingDateType.jobDate",
72 "caption": "Job Date"
73 },
74 "postingDate": "2024-12-01",
75 "documentDate": "2024-12-01",
76 "translationDate": "2024-12-01",
77 "indexationTreatmentType": {
78 "name": "DEFAULT",
79 "captionKey": "enum.indexationTreatmentType.default",
80 "caption": "Default"
81 },
82 "skipActivationGroupsWithOpenDraft": true,
83 "migratedFilterType": {
84 "name": "ALL",
85 "captionKey": "enum.migratedFilterType.all",
86 "caption": "All"
87 },
88 "overrideCPICategoryInputs": [
89 {
90 "consumerPriceIndexCategoryId": 40000001,
91 "consumerPriceIndexCategoryIdNonLease": 40000002,
92 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
93 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
94 "modificationDateType": {
95 "name": "JOB_DATE",
96 "captionKey": "enum.modificationDateType.jobDate",
97 "caption": "Job Date"
98 },
99 "modificationDate": "2024-12-01",
100 "referenceDateType": {
101 "name": "MODIFICATION_DATE",
102 "captionKey": "enum.referenceDateType.modificationDate",
103 "caption": "Modification Date"
104 },
105 "referenceDateTypeNonLease": {
106 "name": "MODIFICATION_DATE",
107 "captionKey": "enum.referenceDateType.modificationDate",
108 "caption": "Modification Date"
109 },
110 "referenceDate": "2024-12-01",
111 "referenceDateNonLease": "2024-12-01",
112 "postingDateType": {
113 "name": "JOB_DATE",
114 "captionKey": "enum.postingDateType.jobDate",
115 "caption": "Job Date"
116 },
117 "postingDate": "2024-12-01",
118 "documentDate": "2024-12-01",
119 "translationDate": "2024-12-01"
120 }
121 ],
122 "revert": false,
123 "reversalReason": {
124 "id": 50000001,
125 "displayId": "REV-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "Incorrect Indexation",
133 "erpSystemId": 60000001,
134 "erpSystemDisplayId": "SAP-PROD"
135 },
136 "assetClassFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.assetClassFilterType.all",
139 "caption": "All"
140 },
141 "assetClasses": [
142 {
143 "id": 10000001,
144 "displayId": "IAC-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Machinery and Equipment",
152 "assetClassType": "PROPERTY",
153 "infiniteUsefulLife": false
154 }
155 ],
156 "cpiCategoryFilterType": {
157 "name": "ALL",
158 "captionKey": "enum.cpiCategoryFilterType.all",
159 "caption": "All"
160 },
161 "cpiCategories": [
162 {
163 "id": 101,
164 "displayId": "CPI-2025-001",
165 "status": {
166 "name": "ACTIVE",
167 "captionKey": "enum.objectStatus.active",
168 "active": true,
169 "caption": "Active"
170 },
171 "name": "Consumer Price Index - City A",
172 "city": "New York",
173 "country": "USA",
174 "province": "NY",
175 "erpSystemId": 0
176 }
177 ],
178 "listObjectType": {
179 "name": "CONTRACT",
180 "captionKey": "enum.listObjectType.contract",
181 "caption": "Contract"
182 },
183 "objectList": [
184 {
185 "id": 10000001,
186 "displayId": "ENT-001",
187 "name": "Entity Name"
188 }
189 ]
190 },
191 "profile": {
192 "id": 70000001,
193 "profileId": 20000001,
194 "jobId": 10000001,
195 "name": "US Leases Filter",
196 "principalPositionType": {
197 "name": "LESSEE",
198 "captionKey": "enum.principalpositiontype.lessee",
199 "caption": "Lessee"
200 },
201 "filterObject": {
202 "erpSystemFilterType": {
203 "name": "ALL",
204 "captionKey": "enum.filterType.all",
205 "caption": "All"
206 },
207 "erpSystems": [
208 {
209 "id": 10000001,
210 "displayId": "ERP-001",
211 "status": {
212 "name": "ACTIVE",
213 "captionKey": "enum.objectStatus.active",
214 "active": true,
215 "caption": "Active"
216 },
217 "name": "SAP Production System",
218 "type": {
219 "name": "NAKISA",
220 "captionKey": "enum.erpSystemType.NAKISA",
221 "caption": "NAKISA"
222 },
223 "sapVersion": {
224 "name": "ECC_EHP5",
225 "captionKey": "enum.sapVersion.ECC_EHP5",
226 "caption": "ECC_EHP5"
227 }
228 }
229 ],
230 "leaseAreaFilterType": {
231 "name": "ALL",
232 "captionKey": "enum.filterType.all",
233 "caption": "All"
234 },
235 "leaseAreas": [
236 {
237 "id": 10000001,
238 "displayId": "0001",
239 "status": {
240 "name": "ACTIVE",
241 "captionKey": "enum.objectStatus.active",
242 "active": true,
243 "caption": "Active"
244 },
245 "name": "Global Lease Area"
246 }
247 ],
248 "businessUnitFilterType": {
249 "name": "ALL",
250 "captionKey": "enum.filterType.all",
251 "caption": "All"
252 },
253 "businessUnits": [
254 {
255 "id": 10000001,
256 "displayId": "BU0001",
257 "status": {
258 "name": "ACTIVE",
259 "captionKey": "enum.objectStatus.active",
260 "active": true,
261 "caption": "Active"
262 },
263 "name": "North America Business Unit"
264 }
265 ],
266 "companyFilterType": {
267 "name": "ALL",
268 "captionKey": "enum.filterType.all",
269 "caption": "All"
270 },
271 "companies": [
272 {
273 "id": 10000006,
274 "displayId": "1005",
275 "status": {
276 "name": "ACTIVE",
277 "captionKey": "enum.objectStatus.active",
278 "active": true,
279 "caption": "Active"
280 },
281 "erpSystemId": 10000001,
282 "erpSystemDisplayId": "FINQ8S-300",
283 "countryId": 10000095,
284 "countryDisplayId": "CA",
285 "name": "string",
286 "postingPeriodVariantId": 0,
287 "fiscalVariantId": 0
288 }
289 ],
290 "leaseDepartmentFilterType": {
291 "name": "ALL",
292 "captionKey": "enum.filterType.all",
293 "caption": "All"
294 },
295 "leaseDepartments": [
296 {
297 "id": 300001,
298 "displayId": "DEP-01",
299 "status": {
300 "name": "ACTIVE",
301 "captionKey": "enum.objectStatus.active",
302 "active": true,
303 "caption": "Active"
304 },
305 "name": "Finance Department"
306 }
307 ],
308 "leaseGroupFilterType": {
309 "name": "ALL",
310 "captionKey": "enum.filterType.all",
311 "caption": "All"
312 },
313 "leaseGroups": [
314 {
315 "id": 60000001,
316 "displayId": "LG-001",
317 "status": {
318 "name": "ACTIVE",
319 "captionKey": "enum.objectStatus.active",
320 "active": true,
321 "caption": "Active"
322 },
323 "name": "Global Lease Group"
324 }
325 ],
326 "costCenterFilterType": {
327 "name": "ALL",
328 "captionKey": "enum.filterType.all",
329 "caption": "All"
330 },
331 "costCenters": [
332 {
333 "id": 14001,
334 "displayId": "CC-001",
335 "status": {
336 "name": "ACTIVE",
337 "captionKey": "enum.objectStatus.active",
338 "active": true,
339 "caption": "Active"
340 },
341 "name": "Cost Center A",
342 "erpSystemId": 0
343 }
344 ],
345 "profitCenterFilterType": {
346 "name": "ALL",
347 "captionKey": "enum.filterType.all",
348 "caption": "All"
349 },
350 "profitCenters": [
351 {
352 "id": 9001,
353 "displayId": "PC-001",
354 "status": {
355 "name": "ACTIVE",
356 "captionKey": "enum.objectStatus.active",
357 "active": true,
358 "caption": "Active"
359 },
360 "name": "North Region Profit Center",
361 "validTo": "2025-12-31",
362 "erpSystemId": 101,
363 "erpSystemDisplayId": "SAP-01"
364 }
365 ],
366 "wbsFilterType": {
367 "name": "ALL",
368 "captionKey": "enum.filterType.all",
369 "caption": "All"
370 },
371 "wbses": [
372 {
373 "id": 1001,
374 "displayId": "WBS-2025-001",
375 "status": {
376 "name": "ACTIVE",
377 "captionKey": "enum.objectStatus.active",
378 "active": true,
379 "caption": "Active"
380 },
381 "name": "Main Project WBS",
382 "erpSystemId": 0
383 }
384 ],
385 "businessAreaFilterType": {
386 "name": "ALL",
387 "captionKey": "enum.filterType.all",
388 "caption": "All"
389 },
390 "businessAreas": [
391 {
392 "id": 3001,
393 "displayId": "BA-2025-001",
394 "status": {
395 "name": "ACTIVE",
396 "captionKey": "enum.objectStatus.active",
397 "active": true,
398 "caption": "Active"
399 },
400 "name": "North America Operations",
401 "erpSystemId": 0
402 }
403 ],
404 "functionalAreaFilterType": {
405 "name": "ALL",
406 "captionKey": "enum.filterType.all",
407 "caption": "All"
408 },
409 "functionalAreas": [
410 {
411 "id": 2001,
412 "displayId": "FA-2025-001",
413 "status": {
414 "name": "ACTIVE",
415 "captionKey": "enum.objectStatus.active",
416 "active": true,
417 "caption": "Active"
418 },
419 "name": "Accounting Department",
420 "erpSystemId": 0
421 }
422 ]
423 }
424 }
425 }
426]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule jobs updated successfully |
||
400 |
Invalid request body |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "code": {
3 "name": "OK",
4 "captionKey": "enum.responseCode.ok",
5 "caption": "OK"
6 },
7 "errors": {
8 "all": []
9 },
10 "object": [
11 {
12 "id": 10000001,
13 "cronExpression": "0 0 2 * * ?",
14 "cronReadable": "Every day at 2:00 AM",
15 "active": true,
16 "unauthorized": false,
17 "nextExecution": "2024-12-02T02:00:00Z",
18 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
19 "previousExecution": "2024-12-01T02:00:00Z",
20 "previousExecutionMessage": "Execution completed successfully",
21 "batchSize": 100,
22 "name": "Monthly CPI Indexation",
23 "profileId": 20000001,
24 "input": {
25 "id": 30000001,
26 "jobIndexationType": {
27 "name": "CPI_LOCAL",
28 "captionKey": "enum.jobIndexationType.cpiLocal",
29 "caption": "CPI Local"
30 },
31 "jobIndexationTypeNonLease": {
32 "name": "CPI_LOCAL",
33 "captionKey": "enum.jobIndexationType.cpiLocal",
34 "caption": "CPI Local"
35 },
36 "modificationDateType": {
37 "name": "JOB_DATE",
38 "captionKey": "enum.modificationDateType.jobDate",
39 "caption": "Job Date"
40 },
41 "modificationDate": "2024-12-01",
42 "referenceDateType": {
43 "name": "MODIFICATION_DATE",
44 "captionKey": "enum.referenceDateType.modificationDate",
45 "caption": "Modification Date"
46 },
47 "referenceDate": "2024-12-01",
48 "referenceDateTypeNonLease": {
49 "name": "MODIFICATION_DATE",
50 "captionKey": "enum.referenceDateType.modificationDate",
51 "caption": "Modification Date"
52 },
53 "referenceDateNonLease": "2024-12-01",
54 "indexLevelType": {
55 "name": "RATE",
56 "captionKey": "enum.indexLevelType.rate",
57 "caption": "Rate"
58 },
59 "newIndexLevel": 105.5,
60 "indexLevelTypeNonLease": {
61 "name": "RATE",
62 "captionKey": "enum.indexLevelType.rate",
63 "caption": "Rate"
64 },
65 "newIndexLevelNonLease": 103.2,
66 "indexationDateType": {
67 "name": "ROU_ANNIVERSARY_DATE",
68 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
69 "caption": "ROU Anniversary Date"
70 },
71 "indexationDateTypeNonLease": {
72 "name": "ROU_ANNIVERSARY_DATE",
73 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
74 "caption": "ROU Anniversary Date"
75 },
76 "indexationStartDate": "2024-12-01",
77 "indexationStartDateNonLease": "2024-12-01",
78 "postingDateType": {
79 "name": "JOB_DATE",
80 "captionKey": "enum.postingDateType.jobDate",
81 "caption": "Job Date"
82 },
83 "postingDate": "2024-12-01",
84 "documentDate": "2024-12-01",
85 "translationDate": "2024-12-01",
86 "indexationTreatmentType": {
87 "name": "DEFAULT",
88 "captionKey": "enum.indexationTreatmentType.default",
89 "caption": "Default"
90 },
91 "skipActivationGroupsWithOpenDraft": true,
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 },
97 "overrideCPICategoryInputs": [
98 {
99 "consumerPriceIndexCategoryId": 40000001,
100 "consumerPriceIndexCategoryIdNonLease": 40000002,
101 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
102 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
103 "modificationDateType": {
104 "name": "JOB_DATE",
105 "captionKey": "enum.modificationDateType.jobDate",
106 "caption": "Job Date"
107 },
108 "modificationDate": "2024-12-01",
109 "referenceDateType": {
110 "name": "MODIFICATION_DATE",
111 "captionKey": "enum.referenceDateType.modificationDate",
112 "caption": "Modification Date"
113 },
114 "referenceDateTypeNonLease": {
115 "name": "MODIFICATION_DATE",
116 "captionKey": "enum.referenceDateType.modificationDate",
117 "caption": "Modification Date"
118 },
119 "referenceDate": "2024-12-01",
120 "referenceDateNonLease": "2024-12-01",
121 "postingDateType": {
122 "name": "JOB_DATE",
123 "captionKey": "enum.postingDateType.jobDate",
124 "caption": "Job Date"
125 },
126 "postingDate": "2024-12-01",
127 "documentDate": "2024-12-01",
128 "translationDate": "2024-12-01"
129 }
130 ],
131 "revert": false,
132 "reversalReason": {
133 "id": 50000001,
134 "displayId": "REV-001",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "name": "Incorrect Indexation",
142 "erpSystemId": 60000001,
143 "erpSystemDisplayId": "SAP-PROD"
144 },
145 "assetClassFilterType": {
146 "name": "ALL",
147 "captionKey": "enum.assetClassFilterType.all",
148 "caption": "All"
149 },
150 "assetClasses": [
151 {
152 "id": 10000001,
153 "displayId": "IAC-001",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Machinery and Equipment",
161 "assetClassType": "PROPERTY",
162 "infiniteUsefulLife": false
163 }
164 ],
165 "cpiCategoryFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.cpiCategoryFilterType.all",
168 "caption": "All"
169 },
170 "cpiCategories": [
171 {
172 "id": 101,
173 "displayId": "CPI-2025-001",
174 "status": {
175 "name": "ACTIVE",
176 "captionKey": "enum.objectStatus.active",
177 "active": true,
178 "caption": "Active"
179 },
180 "name": "Consumer Price Index - City A",
181 "city": "New York",
182 "country": "USA",
183 "province": "NY",
184 "erpSystemId": 0
185 }
186 ],
187 "listObjectType": {
188 "name": "CONTRACT",
189 "captionKey": "enum.listObjectType.contract",
190 "caption": "Contract"
191 },
192 "objectList": [
193 {
194 "id": 10000001,
195 "displayId": "ENT-001",
196 "name": "Entity Name"
197 }
198 ]
199 },
200 "profile": {
201 "id": 70000001,
202 "profileId": 20000001,
203 "jobId": 10000001,
204 "name": "US Leases Filter",
205 "principalPositionType": {
206 "name": "LESSEE",
207 "captionKey": "enum.principalpositiontype.lessee",
208 "caption": "Lessee"
209 },
210 "filterObject": {
211 "erpSystemFilterType": {
212 "name": "ALL",
213 "captionKey": "enum.filterType.all",
214 "caption": "All"
215 },
216 "erpSystems": [
217 {
218 "id": 10000001,
219 "displayId": "ERP-001",
220 "status": {
221 "name": "ACTIVE",
222 "captionKey": "enum.objectStatus.active",
223 "active": true,
224 "caption": "Active"
225 },
226 "name": "SAP Production System",
227 "type": {
228 "name": "NAKISA",
229 "captionKey": "enum.erpSystemType.NAKISA",
230 "caption": "NAKISA"
231 },
232 "sapVersion": {
233 "name": "ECC_EHP5",
234 "captionKey": "enum.sapVersion.ECC_EHP5",
235 "caption": "ECC_EHP5"
236 }
237 }
238 ],
239 "leaseAreaFilterType": {
240 "name": "ALL",
241 "captionKey": "enum.filterType.all",
242 "caption": "All"
243 },
244 "leaseAreas": [
245 {
246 "id": 10000001,
247 "displayId": "0001",
248 "status": {
249 "name": "ACTIVE",
250 "captionKey": "enum.objectStatus.active",
251 "active": true,
252 "caption": "Active"
253 },
254 "name": "Global Lease Area"
255 }
256 ],
257 "businessUnitFilterType": {
258 "name": "ALL",
259 "captionKey": "enum.filterType.all",
260 "caption": "All"
261 },
262 "businessUnits": [
263 {
264 "id": 10000001,
265 "displayId": "BU0001",
266 "status": {
267 "name": "ACTIVE",
268 "captionKey": "enum.objectStatus.active",
269 "active": true,
270 "caption": "Active"
271 },
272 "name": "North America Business Unit"
273 }
274 ],
275 "companyFilterType": {
276 "name": "ALL",
277 "captionKey": "enum.filterType.all",
278 "caption": "All"
279 },
280 "companies": [
281 {
282 "id": 10000006,
283 "displayId": "1005",
284 "status": {
285 "name": "ACTIVE",
286 "captionKey": "enum.objectStatus.active",
287 "active": true,
288 "caption": "Active"
289 },
290 "erpSystemId": 10000001,
291 "erpSystemDisplayId": "FINQ8S-300",
292 "countryId": 10000095,
293 "countryDisplayId": "CA",
294 "name": "string",
295 "postingPeriodVariantId": 0,
296 "fiscalVariantId": 0
297 }
298 ],
299 "leaseDepartmentFilterType": {
300 "name": "ALL",
301 "captionKey": "enum.filterType.all",
302 "caption": "All"
303 },
304 "leaseDepartments": [
305 {
306 "id": 300001,
307 "displayId": "DEP-01",
308 "status": {
309 "name": "ACTIVE",
310 "captionKey": "enum.objectStatus.active",
311 "active": true,
312 "caption": "Active"
313 },
314 "name": "Finance Department"
315 }
316 ],
317 "leaseGroupFilterType": {
318 "name": "ALL",
319 "captionKey": "enum.filterType.all",
320 "caption": "All"
321 },
322 "leaseGroups": [
323 {
324 "id": 60000001,
325 "displayId": "LG-001",
326 "status": {
327 "name": "ACTIVE",
328 "captionKey": "enum.objectStatus.active",
329 "active": true,
330 "caption": "Active"
331 },
332 "name": "Global Lease Group"
333 }
334 ],
335 "costCenterFilterType": {
336 "name": "ALL",
337 "captionKey": "enum.filterType.all",
338 "caption": "All"
339 },
340 "costCenters": [
341 {
342 "id": 14001,
343 "displayId": "CC-001",
344 "status": {
345 "name": "ACTIVE",
346 "captionKey": "enum.objectStatus.active",
347 "active": true,
348 "caption": "Active"
349 },
350 "name": "Cost Center A",
351 "erpSystemId": 0
352 }
353 ],
354 "profitCenterFilterType": {
355 "name": "ALL",
356 "captionKey": "enum.filterType.all",
357 "caption": "All"
358 },
359 "profitCenters": [
360 {
361 "id": 9001,
362 "displayId": "PC-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "North Region Profit Center",
370 "validTo": "2025-12-31",
371 "erpSystemId": 101,
372 "erpSystemDisplayId": "SAP-01"
373 }
374 ],
375 "wbsFilterType": {
376 "name": "ALL",
377 "captionKey": "enum.filterType.all",
378 "caption": "All"
379 },
380 "wbses": [
381 {
382 "id": 1001,
383 "displayId": "WBS-2025-001",
384 "status": {
385 "name": "ACTIVE",
386 "captionKey": "enum.objectStatus.active",
387 "active": true,
388 "caption": "Active"
389 },
390 "name": "Main Project WBS",
391 "erpSystemId": 0
392 }
393 ],
394 "businessAreaFilterType": {
395 "name": "ALL",
396 "captionKey": "enum.filterType.all",
397 "caption": "All"
398 },
399 "businessAreas": [
400 {
401 "id": 3001,
402 "displayId": "BA-2025-001",
403 "status": {
404 "name": "ACTIVE",
405 "captionKey": "enum.objectStatus.active",
406 "active": true,
407 "caption": "Active"
408 },
409 "name": "North America Operations",
410 "erpSystemId": 0
411 }
412 ],
413 "functionalAreaFilterType": {
414 "name": "ALL",
415 "captionKey": "enum.filterType.all",
416 "caption": "All"
417 },
418 "functionalAreas": [
419 {
420 "id": 2001,
421 "displayId": "FA-2025-001",
422 "status": {
423 "name": "ACTIVE",
424 "captionKey": "enum.objectStatus.active",
425 "active": true,
426 "caption": "Active"
427 },
428 "name": "Accounting Department",
429 "erpSystemId": 0
430 }
431 ]
432 }
433 }
434 }
435 ]
436}
Bulk Delete Mass Indexation Resources¶
HTTP Request
DELETE /api/v1/batch/mass-indexation/schedule-jobs/bulk
📋 Description: Deletes scheduled bulk indexation jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease and contract-related financial obligations and ensuring accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
false |
Request body containing a list of scheduled jobs for bulk mass indexation, including details related to leases, contracts, financial obligations, and accounting entries. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule jobs deleted successfully |
None |
|
400 |
Invalid request body |
None |
|
404 |
One or more mass indexation schedule jobs not found |
None |
|
500 |
Internal server error |
None |
Enable Or Disable A Mass Indexation Schedule Job¶
HTTP Request
POST /api/v1/batch/mass-indexation/schedule-jobs/{id}/enable/{state}
📋 Description: Enables or disables scheduled mass indexation jobs for lease and contract management within the Nakisa Lease Accounting Suite, ensuring accurate financial obligation tracking and accounting entry updates.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
state |
path |
boolean |
true |
Indicates whether to enable or disable the scheduled jobs for mass indexation of leases and contracts within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search Mass Indexation Resources¶
HTTP Request
POST /api/v1/batch/mass-indexation/schedule-jobs/search
📋 Description: Schedules batch jobs for mass indexation of leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling efficient processing and 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 criteria for searching scheduled jobs related to lease contracts and financial obligations within the Nakisa Lease Accounting Suite. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Body Parameters
1{
2 "idIn": [
3 10000001,
4 10000002,
5 10000003
6 ],
7 "idEqual": 10000001,
8 "idLike": "10000",
9 "createdAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
10 "createdAtLessThanOrEqual": "2024-12-31T23:59:59Z",
11 "createdByLike": "john",
12 "createdByEqual": "john.doe@example.com",
13 "modifiedAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
14 "modifiedAtLessThanOrEqual": "2024-12-31T23:59:59Z",
15 "modifiedByLike": "jane",
16 "modifiedByEqual": "jane.smith@example.com",
17 "activeEqual": true,
18 "nameLike": "Monthly",
19 "profileIdEqual": 20000001
20}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved mass indexation schedule jobs |
||
400 |
Invalid filter criteria or pagination parameters |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "totalElements": 50,
3 "totalPages": 5,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000001,
21 "cronExpression": "0 0 2 * * ?",
22 "cronReadable": "Every day at 2:00 AM",
23 "active": true,
24 "unauthorized": false,
25 "nextExecution": "2024-12-02T02:00:00Z",
26 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
27 "previousExecution": "2024-12-01T02:00:00Z",
28 "previousExecutionMessage": "Execution completed successfully",
29 "batchSize": 100,
30 "name": "Monthly CPI Indexation",
31 "profileId": 20000001,
32 "input": {
33 "id": 30000001,
34 "jobIndexationType": {
35 "name": "CPI_LOCAL",
36 "captionKey": "enum.jobIndexationType.cpiLocal",
37 "caption": "CPI Local"
38 },
39 "jobIndexationTypeNonLease": {
40 "name": "CPI_LOCAL",
41 "captionKey": "enum.jobIndexationType.cpiLocal",
42 "caption": "CPI Local"
43 },
44 "modificationDateType": {
45 "name": "JOB_DATE",
46 "captionKey": "enum.modificationDateType.jobDate",
47 "caption": "Job Date"
48 },
49 "modificationDate": "2024-12-01",
50 "referenceDateType": {
51 "name": "MODIFICATION_DATE",
52 "captionKey": "enum.referenceDateType.modificationDate",
53 "caption": "Modification Date"
54 },
55 "referenceDate": "2024-12-01",
56 "referenceDateTypeNonLease": {
57 "name": "MODIFICATION_DATE",
58 "captionKey": "enum.referenceDateType.modificationDate",
59 "caption": "Modification Date"
60 },
61 "referenceDateNonLease": "2024-12-01",
62 "indexLevelType": {
63 "name": "RATE",
64 "captionKey": "enum.indexLevelType.rate",
65 "caption": "Rate"
66 },
67 "newIndexLevel": 105.5,
68 "indexLevelTypeNonLease": {
69 "name": "RATE",
70 "captionKey": "enum.indexLevelType.rate",
71 "caption": "Rate"
72 },
73 "newIndexLevelNonLease": 103.2,
74 "indexationDateType": {
75 "name": "ROU_ANNIVERSARY_DATE",
76 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
77 "caption": "ROU Anniversary Date"
78 },
79 "indexationDateTypeNonLease": {
80 "name": "ROU_ANNIVERSARY_DATE",
81 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
82 "caption": "ROU Anniversary Date"
83 },
84 "indexationStartDate": "2024-12-01",
85 "indexationStartDateNonLease": "2024-12-01",
86 "postingDateType": {
87 "name": "JOB_DATE",
88 "captionKey": "enum.postingDateType.jobDate",
89 "caption": "Job Date"
90 },
91 "postingDate": "2024-12-01",
92 "documentDate": "2024-12-01",
93 "translationDate": "2024-12-01",
94 "indexationTreatmentType": {
95 "name": "DEFAULT",
96 "captionKey": "enum.indexationTreatmentType.default",
97 "caption": "Default"
98 },
99 "skipActivationGroupsWithOpenDraft": true,
100 "migratedFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.migratedFilterType.all",
103 "caption": "All"
104 },
105 "overrideCPICategoryInputs": [
106 {
107 "consumerPriceIndexCategoryId": 40000001,
108 "consumerPriceIndexCategoryIdNonLease": 40000002,
109 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
110 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
111 "modificationDateType": {
112 "name": "JOB_DATE",
113 "captionKey": "enum.modificationDateType.jobDate",
114 "caption": "Job Date"
115 },
116 "modificationDate": "2024-12-01",
117 "referenceDateType": {
118 "name": "MODIFICATION_DATE",
119 "captionKey": "enum.referenceDateType.modificationDate",
120 "caption": "Modification Date"
121 },
122 "referenceDateTypeNonLease": {
123 "name": "MODIFICATION_DATE",
124 "captionKey": "enum.referenceDateType.modificationDate",
125 "caption": "Modification Date"
126 },
127 "referenceDate": "2024-12-01",
128 "referenceDateNonLease": "2024-12-01",
129 "postingDateType": {
130 "name": "JOB_DATE",
131 "captionKey": "enum.postingDateType.jobDate",
132 "caption": "Job Date"
133 },
134 "postingDate": "2024-12-01",
135 "documentDate": "2024-12-01",
136 "translationDate": "2024-12-01"
137 }
138 ],
139 "revert": false,
140 "reversalReason": {
141 "id": 50000001,
142 "displayId": "REV-001",
143 "status": {
144 "name": "ACTIVE",
145 "captionKey": "enum.objectStatus.active",
146 "active": true,
147 "caption": "Active"
148 },
149 "name": "Incorrect Indexation",
150 "erpSystemId": 60000001,
151 "erpSystemDisplayId": "SAP-PROD"
152 },
153 "assetClassFilterType": {
154 "name": "ALL",
155 "captionKey": "enum.assetClassFilterType.all",
156 "caption": "All"
157 },
158 "assetClasses": [
159 {
160 "id": 10000001,
161 "displayId": "IAC-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "Machinery and Equipment",
169 "assetClassType": "PROPERTY",
170 "infiniteUsefulLife": false
171 }
172 ],
173 "cpiCategoryFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.cpiCategoryFilterType.all",
176 "caption": "All"
177 },
178 "cpiCategories": [
179 {
180 "id": 101,
181 "displayId": "CPI-2025-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Consumer Price Index - City A",
189 "city": "New York",
190 "country": "USA",
191 "province": "NY",
192 "erpSystemId": 0
193 }
194 ],
195 "listObjectType": {
196 "name": "CONTRACT",
197 "captionKey": "enum.listObjectType.contract",
198 "caption": "Contract"
199 },
200 "objectList": [
201 {
202 "id": 10000001,
203 "displayId": "ENT-001",
204 "name": "Entity Name"
205 }
206 ]
207 },
208 "profile": {
209 "id": 70000001,
210 "profileId": 20000001,
211 "jobId": 10000001,
212 "name": "US Leases Filter",
213 "principalPositionType": {
214 "name": "LESSEE",
215 "captionKey": "enum.principalpositiontype.lessee",
216 "caption": "Lessee"
217 },
218 "filterObject": {
219 "erpSystemFilterType": {
220 "name": "ALL",
221 "captionKey": "enum.filterType.all",
222 "caption": "All"
223 },
224 "erpSystems": [
225 {
226 "id": 10000001,
227 "displayId": "ERP-001",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "name": "SAP Production System",
235 "type": {
236 "name": "NAKISA",
237 "captionKey": "enum.erpSystemType.NAKISA",
238 "caption": "NAKISA"
239 },
240 "sapVersion": {
241 "name": "ECC_EHP5",
242 "captionKey": "enum.sapVersion.ECC_EHP5",
243 "caption": "ECC_EHP5"
244 }
245 }
246 ],
247 "leaseAreaFilterType": {
248 "name": "ALL",
249 "captionKey": "enum.filterType.all",
250 "caption": "All"
251 },
252 "leaseAreas": [
253 {
254 "id": 10000001,
255 "displayId": "0001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "Global Lease Area"
263 }
264 ],
265 "businessUnitFilterType": {
266 "name": "ALL",
267 "captionKey": "enum.filterType.all",
268 "caption": "All"
269 },
270 "businessUnits": [
271 {
272 "id": 10000001,
273 "displayId": "BU0001",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "name": "North America Business Unit"
281 }
282 ],
283 "companyFilterType": {
284 "name": "ALL",
285 "captionKey": "enum.filterType.all",
286 "caption": "All"
287 },
288 "companies": [
289 {
290 "id": 10000006,
291 "displayId": "1005",
292 "status": {
293 "name": "ACTIVE",
294 "captionKey": "enum.objectStatus.active",
295 "active": true,
296 "caption": "Active"
297 },
298 "erpSystemId": 10000001,
299 "erpSystemDisplayId": "FINQ8S-300",
300 "countryId": 10000095,
301 "countryDisplayId": "CA",
302 "name": "string",
303 "postingPeriodVariantId": 0,
304 "fiscalVariantId": 0
305 }
306 ],
307 "leaseDepartmentFilterType": {
308 "name": "ALL",
309 "captionKey": "enum.filterType.all",
310 "caption": "All"
311 },
312 "leaseDepartments": [
313 {
314 "id": 300001,
315 "displayId": "DEP-01",
316 "status": {
317 "name": "ACTIVE",
318 "captionKey": "enum.objectStatus.active",
319 "active": true,
320 "caption": "Active"
321 },
322 "name": "Finance Department"
323 }
324 ],
325 "leaseGroupFilterType": {
326 "name": "ALL",
327 "captionKey": "enum.filterType.all",
328 "caption": "All"
329 },
330 "leaseGroups": [
331 {
332 "id": 60000001,
333 "displayId": "LG-001",
334 "status": {
335 "name": "ACTIVE",
336 "captionKey": "enum.objectStatus.active",
337 "active": true,
338 "caption": "Active"
339 },
340 "name": "Global Lease Group"
341 }
342 ],
343 "costCenterFilterType": {
344 "name": "ALL",
345 "captionKey": "enum.filterType.all",
346 "caption": "All"
347 },
348 "costCenters": [
349 {
350 "id": 14001,
351 "displayId": "CC-001",
352 "status": {
353 "name": "ACTIVE",
354 "captionKey": "enum.objectStatus.active",
355 "active": true,
356 "caption": "Active"
357 },
358 "name": "Cost Center A",
359 "erpSystemId": 0
360 }
361 ],
362 "profitCenterFilterType": {
363 "name": "ALL",
364 "captionKey": "enum.filterType.all",
365 "caption": "All"
366 },
367 "profitCenters": [
368 {
369 "id": 9001,
370 "displayId": "PC-001",
371 "status": {
372 "name": "ACTIVE",
373 "captionKey": "enum.objectStatus.active",
374 "active": true,
375 "caption": "Active"
376 },
377 "name": "North Region Profit Center",
378 "validTo": "2025-12-31",
379 "erpSystemId": 101,
380 "erpSystemDisplayId": "SAP-01"
381 }
382 ],
383 "wbsFilterType": {
384 "name": "ALL",
385 "captionKey": "enum.filterType.all",
386 "caption": "All"
387 },
388 "wbses": [
389 {
390 "id": 1001,
391 "displayId": "WBS-2025-001",
392 "status": {
393 "name": "ACTIVE",
394 "captionKey": "enum.objectStatus.active",
395 "active": true,
396 "caption": "Active"
397 },
398 "name": "Main Project WBS",
399 "erpSystemId": 0
400 }
401 ],
402 "businessAreaFilterType": {
403 "name": "ALL",
404 "captionKey": "enum.filterType.all",
405 "caption": "All"
406 },
407 "businessAreas": [
408 {
409 "id": 3001,
410 "displayId": "BA-2025-001",
411 "status": {
412 "name": "ACTIVE",
413 "captionKey": "enum.objectStatus.active",
414 "active": true,
415 "caption": "Active"
416 },
417 "name": "North America Operations",
418 "erpSystemId": 0
419 }
420 ],
421 "functionalAreaFilterType": {
422 "name": "ALL",
423 "captionKey": "enum.filterType.all",
424 "caption": "All"
425 },
426 "functionalAreas": [
427 {
428 "id": 2001,
429 "displayId": "FA-2025-001",
430 "status": {
431 "name": "ACTIVE",
432 "captionKey": "enum.objectStatus.active",
433 "active": true,
434 "caption": "Active"
435 },
436 "name": "Accounting Department",
437 "erpSystemId": 0
438 }
439 ]
440 }
441 }
442 }
443 ],
444 "number": 0,
445 "sort": {
446 "unsorted": false,
447 "sorted": true,
448 "empty": false
449 },
450 "first": true,
451 "last": false,
452 "empty": false
453}
Create New Mass Indexation Resource¶
HTTP Request
POST /api/v1/batch/mass-indexation/schedule-jobs/create
📋 Description: Schedules new mass indexation jobs for lease contracts and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient management of accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the details for scheduling mass indexation jobs, including lease, contract, financial obligation, and accounting entry information. |
Body Parameters
1{
2 "id": 10000001,
3 "cronExpression": "0 0 2 * * ?",
4 "cronReadable": "Every day at 2:00 AM",
5 "active": true,
6 "unauthorized": false,
7 "nextExecution": "2024-12-02T02:00:00Z",
8 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
9 "previousExecution": "2024-12-01T02:00:00Z",
10 "previousExecutionMessage": "Execution completed successfully",
11 "batchSize": 100,
12 "name": "Monthly CPI Indexation",
13 "profileId": 20000001,
14 "input": {
15 "id": 30000001,
16 "jobIndexationType": {
17 "name": "CPI_LOCAL",
18 "captionKey": "enum.jobIndexationType.cpiLocal",
19 "caption": "CPI Local"
20 },
21 "jobIndexationTypeNonLease": {
22 "name": "CPI_LOCAL",
23 "captionKey": "enum.jobIndexationType.cpiLocal",
24 "caption": "CPI Local"
25 },
26 "modificationDateType": {
27 "name": "JOB_DATE",
28 "captionKey": "enum.modificationDateType.jobDate",
29 "caption": "Job Date"
30 },
31 "modificationDate": "2024-12-01",
32 "referenceDateType": {
33 "name": "MODIFICATION_DATE",
34 "captionKey": "enum.referenceDateType.modificationDate",
35 "caption": "Modification Date"
36 },
37 "referenceDate": "2024-12-01",
38 "referenceDateTypeNonLease": {
39 "name": "MODIFICATION_DATE",
40 "captionKey": "enum.referenceDateType.modificationDate",
41 "caption": "Modification Date"
42 },
43 "referenceDateNonLease": "2024-12-01",
44 "indexLevelType": {
45 "name": "RATE",
46 "captionKey": "enum.indexLevelType.rate",
47 "caption": "Rate"
48 },
49 "newIndexLevel": 105.5,
50 "indexLevelTypeNonLease": {
51 "name": "RATE",
52 "captionKey": "enum.indexLevelType.rate",
53 "caption": "Rate"
54 },
55 "newIndexLevelNonLease": 103.2,
56 "indexationDateType": {
57 "name": "ROU_ANNIVERSARY_DATE",
58 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
59 "caption": "ROU Anniversary Date"
60 },
61 "indexationDateTypeNonLease": {
62 "name": "ROU_ANNIVERSARY_DATE",
63 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
64 "caption": "ROU Anniversary Date"
65 },
66 "indexationStartDate": "2024-12-01",
67 "indexationStartDateNonLease": "2024-12-01",
68 "postingDateType": {
69 "name": "JOB_DATE",
70 "captionKey": "enum.postingDateType.jobDate",
71 "caption": "Job Date"
72 },
73 "postingDate": "2024-12-01",
74 "documentDate": "2024-12-01",
75 "translationDate": "2024-12-01",
76 "indexationTreatmentType": {
77 "name": "DEFAULT",
78 "captionKey": "enum.indexationTreatmentType.default",
79 "caption": "Default"
80 },
81 "skipActivationGroupsWithOpenDraft": true,
82 "migratedFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.migratedFilterType.all",
85 "caption": "All"
86 },
87 "overrideCPICategoryInputs": [
88 {
89 "consumerPriceIndexCategoryId": 40000001,
90 "consumerPriceIndexCategoryIdNonLease": 40000002,
91 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
92 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
93 "modificationDateType": {
94 "name": "JOB_DATE",
95 "captionKey": "enum.modificationDateType.jobDate",
96 "caption": "Job Date"
97 },
98 "modificationDate": "2024-12-01",
99 "referenceDateType": {
100 "name": "MODIFICATION_DATE",
101 "captionKey": "enum.referenceDateType.modificationDate",
102 "caption": "Modification Date"
103 },
104 "referenceDateTypeNonLease": {
105 "name": "MODIFICATION_DATE",
106 "captionKey": "enum.referenceDateType.modificationDate",
107 "caption": "Modification Date"
108 },
109 "referenceDate": "2024-12-01",
110 "referenceDateNonLease": "2024-12-01",
111 "postingDateType": {
112 "name": "JOB_DATE",
113 "captionKey": "enum.postingDateType.jobDate",
114 "caption": "Job Date"
115 },
116 "postingDate": "2024-12-01",
117 "documentDate": "2024-12-01",
118 "translationDate": "2024-12-01"
119 }
120 ],
121 "revert": false,
122 "reversalReason": {
123 "id": 50000001,
124 "displayId": "REV-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Incorrect Indexation",
132 "erpSystemId": 60000001,
133 "erpSystemDisplayId": "SAP-PROD"
134 },
135 "assetClassFilterType": {
136 "name": "ALL",
137 "captionKey": "enum.assetClassFilterType.all",
138 "caption": "All"
139 },
140 "assetClasses": [
141 {
142 "id": 10000001,
143 "displayId": "IAC-001",
144 "status": {
145 "name": "ACTIVE",
146 "captionKey": "enum.objectStatus.active",
147 "active": true,
148 "caption": "Active"
149 },
150 "name": "Machinery and Equipment",
151 "assetClassType": "PROPERTY",
152 "infiniteUsefulLife": false
153 }
154 ],
155 "cpiCategoryFilterType": {
156 "name": "ALL",
157 "captionKey": "enum.cpiCategoryFilterType.all",
158 "caption": "All"
159 },
160 "cpiCategories": [
161 {
162 "id": 101,
163 "displayId": "CPI-2025-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "Consumer Price Index - City A",
171 "city": "New York",
172 "country": "USA",
173 "province": "NY",
174 "erpSystemId": 0
175 }
176 ],
177 "listObjectType": {
178 "name": "CONTRACT",
179 "captionKey": "enum.listObjectType.contract",
180 "caption": "Contract"
181 },
182 "objectList": [
183 {
184 "id": 10000001,
185 "displayId": "ENT-001",
186 "name": "Entity Name"
187 }
188 ]
189 },
190 "profile": {
191 "id": 70000001,
192 "profileId": 20000001,
193 "jobId": 10000001,
194 "name": "US Leases Filter",
195 "principalPositionType": {
196 "name": "LESSEE",
197 "captionKey": "enum.principalpositiontype.lessee",
198 "caption": "Lessee"
199 },
200 "filterObject": {
201 "erpSystemFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "erpSystems": [
207 {
208 "id": 10000001,
209 "displayId": "ERP-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "SAP Production System",
217 "type": {
218 "name": "NAKISA",
219 "captionKey": "enum.erpSystemType.NAKISA",
220 "caption": "NAKISA"
221 },
222 "sapVersion": {
223 "name": "ECC_EHP5",
224 "captionKey": "enum.sapVersion.ECC_EHP5",
225 "caption": "ECC_EHP5"
226 }
227 }
228 ],
229 "leaseAreaFilterType": {
230 "name": "ALL",
231 "captionKey": "enum.filterType.all",
232 "caption": "All"
233 },
234 "leaseAreas": [
235 {
236 "id": 10000001,
237 "displayId": "0001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Global Lease Area"
245 }
246 ],
247 "businessUnitFilterType": {
248 "name": "ALL",
249 "captionKey": "enum.filterType.all",
250 "caption": "All"
251 },
252 "businessUnits": [
253 {
254 "id": 10000001,
255 "displayId": "BU0001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "North America Business Unit"
263 }
264 ],
265 "companyFilterType": {
266 "name": "ALL",
267 "captionKey": "enum.filterType.all",
268 "caption": "All"
269 },
270 "companies": [
271 {
272 "id": 10000006,
273 "displayId": "1005",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "erpSystemId": 10000001,
281 "erpSystemDisplayId": "FINQ8S-300",
282 "countryId": 10000095,
283 "countryDisplayId": "CA",
284 "name": "string",
285 "postingPeriodVariantId": 0,
286 "fiscalVariantId": 0
287 }
288 ],
289 "leaseDepartmentFilterType": {
290 "name": "ALL",
291 "captionKey": "enum.filterType.all",
292 "caption": "All"
293 },
294 "leaseDepartments": [
295 {
296 "id": 300001,
297 "displayId": "DEP-01",
298 "status": {
299 "name": "ACTIVE",
300 "captionKey": "enum.objectStatus.active",
301 "active": true,
302 "caption": "Active"
303 },
304 "name": "Finance Department"
305 }
306 ],
307 "leaseGroupFilterType": {
308 "name": "ALL",
309 "captionKey": "enum.filterType.all",
310 "caption": "All"
311 },
312 "leaseGroups": [
313 {
314 "id": 60000001,
315 "displayId": "LG-001",
316 "status": {
317 "name": "ACTIVE",
318 "captionKey": "enum.objectStatus.active",
319 "active": true,
320 "caption": "Active"
321 },
322 "name": "Global Lease Group"
323 }
324 ],
325 "costCenterFilterType": {
326 "name": "ALL",
327 "captionKey": "enum.filterType.all",
328 "caption": "All"
329 },
330 "costCenters": [
331 {
332 "id": 14001,
333 "displayId": "CC-001",
334 "status": {
335 "name": "ACTIVE",
336 "captionKey": "enum.objectStatus.active",
337 "active": true,
338 "caption": "Active"
339 },
340 "name": "Cost Center A",
341 "erpSystemId": 0
342 }
343 ],
344 "profitCenterFilterType": {
345 "name": "ALL",
346 "captionKey": "enum.filterType.all",
347 "caption": "All"
348 },
349 "profitCenters": [
350 {
351 "id": 9001,
352 "displayId": "PC-001",
353 "status": {
354 "name": "ACTIVE",
355 "captionKey": "enum.objectStatus.active",
356 "active": true,
357 "caption": "Active"
358 },
359 "name": "North Region Profit Center",
360 "validTo": "2025-12-31",
361 "erpSystemId": 101,
362 "erpSystemDisplayId": "SAP-01"
363 }
364 ],
365 "wbsFilterType": {
366 "name": "ALL",
367 "captionKey": "enum.filterType.all",
368 "caption": "All"
369 },
370 "wbses": [
371 {
372 "id": 1001,
373 "displayId": "WBS-2025-001",
374 "status": {
375 "name": "ACTIVE",
376 "captionKey": "enum.objectStatus.active",
377 "active": true,
378 "caption": "Active"
379 },
380 "name": "Main Project WBS",
381 "erpSystemId": 0
382 }
383 ],
384 "businessAreaFilterType": {
385 "name": "ALL",
386 "captionKey": "enum.filterType.all",
387 "caption": "All"
388 },
389 "businessAreas": [
390 {
391 "id": 3001,
392 "displayId": "BA-2025-001",
393 "status": {
394 "name": "ACTIVE",
395 "captionKey": "enum.objectStatus.active",
396 "active": true,
397 "caption": "Active"
398 },
399 "name": "North America Operations",
400 "erpSystemId": 0
401 }
402 ],
403 "functionalAreaFilterType": {
404 "name": "ALL",
405 "captionKey": "enum.filterType.all",
406 "caption": "All"
407 },
408 "functionalAreas": [
409 {
410 "id": 2001,
411 "displayId": "FA-2025-001",
412 "status": {
413 "name": "ACTIVE",
414 "captionKey": "enum.objectStatus.active",
415 "active": true,
416 "caption": "Active"
417 },
418 "name": "Accounting Department",
419 "erpSystemId": 0
420 }
421 ]
422 }
423 }
424}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Mass indexation schedule job created successfully |
||
201 |
Mass indexation schedule job created successfully |
||
400 |
Invalid request body |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "code": {
3 "name": "OK",
4 "captionKey": "enum.responseCode.ok",
5 "caption": "OK"
6 },
7 "errors": {
8 "all": []
9 },
10 "object": {
11 "id": 10000001,
12 "cronExpression": "0 0 2 * * ?",
13 "cronReadable": "Every day at 2:00 AM",
14 "active": true,
15 "unauthorized": false,
16 "nextExecution": "2024-12-02T02:00:00Z",
17 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
18 "previousExecution": "2024-12-01T02:00:00Z",
19 "previousExecutionMessage": "Execution completed successfully",
20 "batchSize": 100,
21 "name": "Monthly CPI Indexation",
22 "profileId": 20000001,
23 "input": {
24 "id": 30000001,
25 "jobIndexationType": {
26 "name": "CPI_LOCAL",
27 "captionKey": "enum.jobIndexationType.cpiLocal",
28 "caption": "CPI Local"
29 },
30 "jobIndexationTypeNonLease": {
31 "name": "CPI_LOCAL",
32 "captionKey": "enum.jobIndexationType.cpiLocal",
33 "caption": "CPI Local"
34 },
35 "modificationDateType": {
36 "name": "JOB_DATE",
37 "captionKey": "enum.modificationDateType.jobDate",
38 "caption": "Job Date"
39 },
40 "modificationDate": "2024-12-01",
41 "referenceDateType": {
42 "name": "MODIFICATION_DATE",
43 "captionKey": "enum.referenceDateType.modificationDate",
44 "caption": "Modification Date"
45 },
46 "referenceDate": "2024-12-01",
47 "referenceDateTypeNonLease": {
48 "name": "MODIFICATION_DATE",
49 "captionKey": "enum.referenceDateType.modificationDate",
50 "caption": "Modification Date"
51 },
52 "referenceDateNonLease": "2024-12-01",
53 "indexLevelType": {
54 "name": "RATE",
55 "captionKey": "enum.indexLevelType.rate",
56 "caption": "Rate"
57 },
58 "newIndexLevel": 105.5,
59 "indexLevelTypeNonLease": {
60 "name": "RATE",
61 "captionKey": "enum.indexLevelType.rate",
62 "caption": "Rate"
63 },
64 "newIndexLevelNonLease": 103.2,
65 "indexationDateType": {
66 "name": "ROU_ANNIVERSARY_DATE",
67 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
68 "caption": "ROU Anniversary Date"
69 },
70 "indexationDateTypeNonLease": {
71 "name": "ROU_ANNIVERSARY_DATE",
72 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
73 "caption": "ROU Anniversary Date"
74 },
75 "indexationStartDate": "2024-12-01",
76 "indexationStartDateNonLease": "2024-12-01",
77 "postingDateType": {
78 "name": "JOB_DATE",
79 "captionKey": "enum.postingDateType.jobDate",
80 "caption": "Job Date"
81 },
82 "postingDate": "2024-12-01",
83 "documentDate": "2024-12-01",
84 "translationDate": "2024-12-01",
85 "indexationTreatmentType": {
86 "name": "DEFAULT",
87 "captionKey": "enum.indexationTreatmentType.default",
88 "caption": "Default"
89 },
90 "skipActivationGroupsWithOpenDraft": true,
91 "migratedFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.migratedFilterType.all",
94 "caption": "All"
95 },
96 "overrideCPICategoryInputs": [
97 {
98 "consumerPriceIndexCategoryId": 40000001,
99 "consumerPriceIndexCategoryIdNonLease": 40000002,
100 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
101 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
102 "modificationDateType": {
103 "name": "JOB_DATE",
104 "captionKey": "enum.modificationDateType.jobDate",
105 "caption": "Job Date"
106 },
107 "modificationDate": "2024-12-01",
108 "referenceDateType": {
109 "name": "MODIFICATION_DATE",
110 "captionKey": "enum.referenceDateType.modificationDate",
111 "caption": "Modification Date"
112 },
113 "referenceDateTypeNonLease": {
114 "name": "MODIFICATION_DATE",
115 "captionKey": "enum.referenceDateType.modificationDate",
116 "caption": "Modification Date"
117 },
118 "referenceDate": "2024-12-01",
119 "referenceDateNonLease": "2024-12-01",
120 "postingDateType": {
121 "name": "JOB_DATE",
122 "captionKey": "enum.postingDateType.jobDate",
123 "caption": "Job Date"
124 },
125 "postingDate": "2024-12-01",
126 "documentDate": "2024-12-01",
127 "translationDate": "2024-12-01"
128 }
129 ],
130 "revert": false,
131 "reversalReason": {
132 "id": 50000001,
133 "displayId": "REV-001",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "Incorrect Indexation",
141 "erpSystemId": 60000001,
142 "erpSystemDisplayId": "SAP-PROD"
143 },
144 "assetClassFilterType": {
145 "name": "ALL",
146 "captionKey": "enum.assetClassFilterType.all",
147 "caption": "All"
148 },
149 "assetClasses": [
150 {
151 "id": 10000001,
152 "displayId": "IAC-001",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Machinery and Equipment",
160 "assetClassType": "PROPERTY",
161 "infiniteUsefulLife": false
162 }
163 ],
164 "cpiCategoryFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.cpiCategoryFilterType.all",
167 "caption": "All"
168 },
169 "cpiCategories": [
170 {
171 "id": 101,
172 "displayId": "CPI-2025-001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Consumer Price Index - City A",
180 "city": "New York",
181 "country": "USA",
182 "province": "NY",
183 "erpSystemId": 0
184 }
185 ],
186 "listObjectType": {
187 "name": "CONTRACT",
188 "captionKey": "enum.listObjectType.contract",
189 "caption": "Contract"
190 },
191 "objectList": [
192 {
193 "id": 10000001,
194 "displayId": "ENT-001",
195 "name": "Entity Name"
196 }
197 ]
198 },
199 "profile": {
200 "id": 70000001,
201 "profileId": 20000001,
202 "jobId": 10000001,
203 "name": "US Leases Filter",
204 "principalPositionType": {
205 "name": "LESSEE",
206 "captionKey": "enum.principalpositiontype.lessee",
207 "caption": "Lessee"
208 },
209 "filterObject": {
210 "erpSystemFilterType": {
211 "name": "ALL",
212 "captionKey": "enum.filterType.all",
213 "caption": "All"
214 },
215 "erpSystems": [
216 {
217 "id": 10000001,
218 "displayId": "ERP-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "SAP Production System",
226 "type": {
227 "name": "NAKISA",
228 "captionKey": "enum.erpSystemType.NAKISA",
229 "caption": "NAKISA"
230 },
231 "sapVersion": {
232 "name": "ECC_EHP5",
233 "captionKey": "enum.sapVersion.ECC_EHP5",
234 "caption": "ECC_EHP5"
235 }
236 }
237 ],
238 "leaseAreaFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "leaseAreas": [
244 {
245 "id": 10000001,
246 "displayId": "0001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Global Lease Area"
254 }
255 ],
256 "businessUnitFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "businessUnits": [
262 {
263 "id": 10000001,
264 "displayId": "BU0001",
265 "status": {
266 "name": "ACTIVE",
267 "captionKey": "enum.objectStatus.active",
268 "active": true,
269 "caption": "Active"
270 },
271 "name": "North America Business Unit"
272 }
273 ],
274 "companyFilterType": {
275 "name": "ALL",
276 "captionKey": "enum.filterType.all",
277 "caption": "All"
278 },
279 "companies": [
280 {
281 "id": 10000006,
282 "displayId": "1005",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "erpSystemId": 10000001,
290 "erpSystemDisplayId": "FINQ8S-300",
291 "countryId": 10000095,
292 "countryDisplayId": "CA",
293 "name": "string",
294 "postingPeriodVariantId": 0,
295 "fiscalVariantId": 0
296 }
297 ],
298 "leaseDepartmentFilterType": {
299 "name": "ALL",
300 "captionKey": "enum.filterType.all",
301 "caption": "All"
302 },
303 "leaseDepartments": [
304 {
305 "id": 300001,
306 "displayId": "DEP-01",
307 "status": {
308 "name": "ACTIVE",
309 "captionKey": "enum.objectStatus.active",
310 "active": true,
311 "caption": "Active"
312 },
313 "name": "Finance Department"
314 }
315 ],
316 "leaseGroupFilterType": {
317 "name": "ALL",
318 "captionKey": "enum.filterType.all",
319 "caption": "All"
320 },
321 "leaseGroups": [
322 {
323 "id": 60000001,
324 "displayId": "LG-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Global Lease Group"
332 }
333 ],
334 "costCenterFilterType": {
335 "name": "ALL",
336 "captionKey": "enum.filterType.all",
337 "caption": "All"
338 },
339 "costCenters": [
340 {
341 "id": 14001,
342 "displayId": "CC-001",
343 "status": {
344 "name": "ACTIVE",
345 "captionKey": "enum.objectStatus.active",
346 "active": true,
347 "caption": "Active"
348 },
349 "name": "Cost Center A",
350 "erpSystemId": 0
351 }
352 ],
353 "profitCenterFilterType": {
354 "name": "ALL",
355 "captionKey": "enum.filterType.all",
356 "caption": "All"
357 },
358 "profitCenters": [
359 {
360 "id": 9001,
361 "displayId": "PC-001",
362 "status": {
363 "name": "ACTIVE",
364 "captionKey": "enum.objectStatus.active",
365 "active": true,
366 "caption": "Active"
367 },
368 "name": "North Region Profit Center",
369 "validTo": "2025-12-31",
370 "erpSystemId": 101,
371 "erpSystemDisplayId": "SAP-01"
372 }
373 ],
374 "wbsFilterType": {
375 "name": "ALL",
376 "captionKey": "enum.filterType.all",
377 "caption": "All"
378 },
379 "wbses": [
380 {
381 "id": 1001,
382 "displayId": "WBS-2025-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Main Project WBS",
390 "erpSystemId": 0
391 }
392 ],
393 "businessAreaFilterType": {
394 "name": "ALL",
395 "captionKey": "enum.filterType.all",
396 "caption": "All"
397 },
398 "businessAreas": [
399 {
400 "id": 3001,
401 "displayId": "BA-2025-001",
402 "status": {
403 "name": "ACTIVE",
404 "captionKey": "enum.objectStatus.active",
405 "active": true,
406 "caption": "Active"
407 },
408 "name": "North America Operations",
409 "erpSystemId": 0
410 }
411 ],
412 "functionalAreaFilterType": {
413 "name": "ALL",
414 "captionKey": "enum.filterType.all",
415 "caption": "All"
416 },
417 "functionalAreas": [
418 {
419 "id": 2001,
420 "displayId": "FA-2025-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "Accounting Department",
428 "erpSystemId": 0
429 }
430 ]
431 }
432 }
433 }
434}
List All Mass Indexation Resources¶
HTTP Request
GET /api/v1/batch/mass-indexation/schedule-jobs
📋 Description: Retrieves scheduled jobs for mass indexation within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
false |
Indicates whether the results of the scheduled jobs for mass indexation in the Nakisa Lease Accounting Suite should be returned in a paginated format, facilitating efficient data retrieval for lease and contract management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved mass indexation schedule jobs |
||
400 |
Invalid pagination parameters |
None |
|
500 |
Internal server error |
None |
Example Responses
1{
2 "totalElements": 50,
3 "totalPages": 5,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000001,
21 "cronExpression": "0 0 2 * * ?",
22 "cronReadable": "Every day at 2:00 AM",
23 "active": true,
24 "unauthorized": false,
25 "nextExecution": "2024-12-02T02:00:00Z",
26 "previousSuccessfulExecution": "2024-12-01T02:00:00Z",
27 "previousExecution": "2024-12-01T02:00:00Z",
28 "previousExecutionMessage": "Execution completed successfully",
29 "batchSize": 100,
30 "name": "Monthly CPI Indexation",
31 "profileId": 20000001,
32 "input": {
33 "id": 30000001,
34 "jobIndexationType": {
35 "name": "CPI_LOCAL",
36 "captionKey": "enum.jobIndexationType.cpiLocal",
37 "caption": "CPI Local"
38 },
39 "jobIndexationTypeNonLease": {
40 "name": "CPI_LOCAL",
41 "captionKey": "enum.jobIndexationType.cpiLocal",
42 "caption": "CPI Local"
43 },
44 "modificationDateType": {
45 "name": "JOB_DATE",
46 "captionKey": "enum.modificationDateType.jobDate",
47 "caption": "Job Date"
48 },
49 "modificationDate": "2024-12-01",
50 "referenceDateType": {
51 "name": "MODIFICATION_DATE",
52 "captionKey": "enum.referenceDateType.modificationDate",
53 "caption": "Modification Date"
54 },
55 "referenceDate": "2024-12-01",
56 "referenceDateTypeNonLease": {
57 "name": "MODIFICATION_DATE",
58 "captionKey": "enum.referenceDateType.modificationDate",
59 "caption": "Modification Date"
60 },
61 "referenceDateNonLease": "2024-12-01",
62 "indexLevelType": {
63 "name": "RATE",
64 "captionKey": "enum.indexLevelType.rate",
65 "caption": "Rate"
66 },
67 "newIndexLevel": 105.5,
68 "indexLevelTypeNonLease": {
69 "name": "RATE",
70 "captionKey": "enum.indexLevelType.rate",
71 "caption": "Rate"
72 },
73 "newIndexLevelNonLease": 103.2,
74 "indexationDateType": {
75 "name": "ROU_ANNIVERSARY_DATE",
76 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
77 "caption": "ROU Anniversary Date"
78 },
79 "indexationDateTypeNonLease": {
80 "name": "ROU_ANNIVERSARY_DATE",
81 "captionKey": "enum.indexationDateType.rouAnniversaryDate",
82 "caption": "ROU Anniversary Date"
83 },
84 "indexationStartDate": "2024-12-01",
85 "indexationStartDateNonLease": "2024-12-01",
86 "postingDateType": {
87 "name": "JOB_DATE",
88 "captionKey": "enum.postingDateType.jobDate",
89 "caption": "Job Date"
90 },
91 "postingDate": "2024-12-01",
92 "documentDate": "2024-12-01",
93 "translationDate": "2024-12-01",
94 "indexationTreatmentType": {
95 "name": "DEFAULT",
96 "captionKey": "enum.indexationTreatmentType.default",
97 "caption": "Default"
98 },
99 "skipActivationGroupsWithOpenDraft": true,
100 "migratedFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.migratedFilterType.all",
103 "caption": "All"
104 },
105 "overrideCPICategoryInputs": [
106 {
107 "consumerPriceIndexCategoryId": 40000001,
108 "consumerPriceIndexCategoryIdNonLease": 40000002,
109 "consumerPriceIndexCategoryDisplayId": "CPI-US-2024",
110 "consumerPriceIndexCategoryDisplayIdNonLease": "CPI-US-2024-NL",
111 "modificationDateType": {
112 "name": "JOB_DATE",
113 "captionKey": "enum.modificationDateType.jobDate",
114 "caption": "Job Date"
115 },
116 "modificationDate": "2024-12-01",
117 "referenceDateType": {
118 "name": "MODIFICATION_DATE",
119 "captionKey": "enum.referenceDateType.modificationDate",
120 "caption": "Modification Date"
121 },
122 "referenceDateTypeNonLease": {
123 "name": "MODIFICATION_DATE",
124 "captionKey": "enum.referenceDateType.modificationDate",
125 "caption": "Modification Date"
126 },
127 "referenceDate": "2024-12-01",
128 "referenceDateNonLease": "2024-12-01",
129 "postingDateType": {
130 "name": "JOB_DATE",
131 "captionKey": "enum.postingDateType.jobDate",
132 "caption": "Job Date"
133 },
134 "postingDate": "2024-12-01",
135 "documentDate": "2024-12-01",
136 "translationDate": "2024-12-01"
137 }
138 ],
139 "revert": false,
140 "reversalReason": {
141 "id": 50000001,
142 "displayId": "REV-001",
143 "status": {
144 "name": "ACTIVE",
145 "captionKey": "enum.objectStatus.active",
146 "active": true,
147 "caption": "Active"
148 },
149 "name": "Incorrect Indexation",
150 "erpSystemId": 60000001,
151 "erpSystemDisplayId": "SAP-PROD"
152 },
153 "assetClassFilterType": {
154 "name": "ALL",
155 "captionKey": "enum.assetClassFilterType.all",
156 "caption": "All"
157 },
158 "assetClasses": [
159 {
160 "id": 10000001,
161 "displayId": "IAC-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "Machinery and Equipment",
169 "assetClassType": "PROPERTY",
170 "infiniteUsefulLife": false
171 }
172 ],
173 "cpiCategoryFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.cpiCategoryFilterType.all",
176 "caption": "All"
177 },
178 "cpiCategories": [
179 {
180 "id": 101,
181 "displayId": "CPI-2025-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Consumer Price Index - City A",
189 "city": "New York",
190 "country": "USA",
191 "province": "NY",
192 "erpSystemId": 0
193 }
194 ],
195 "listObjectType": {
196 "name": "CONTRACT",
197 "captionKey": "enum.listObjectType.contract",
198 "caption": "Contract"
199 },
200 "objectList": [
201 {
202 "id": 10000001,
203 "displayId": "ENT-001",
204 "name": "Entity Name"
205 }
206 ]
207 },
208 "profile": {
209 "id": 70000001,
210 "profileId": 20000001,
211 "jobId": 10000001,
212 "name": "US Leases Filter",
213 "principalPositionType": {
214 "name": "LESSEE",
215 "captionKey": "enum.principalpositiontype.lessee",
216 "caption": "Lessee"
217 },
218 "filterObject": {
219 "erpSystemFilterType": {
220 "name": "ALL",
221 "captionKey": "enum.filterType.all",
222 "caption": "All"
223 },
224 "erpSystems": [
225 {
226 "id": 10000001,
227 "displayId": "ERP-001",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "name": "SAP Production System",
235 "type": {
236 "name": "NAKISA",
237 "captionKey": "enum.erpSystemType.NAKISA",
238 "caption": "NAKISA"
239 },
240 "sapVersion": {
241 "name": "ECC_EHP5",
242 "captionKey": "enum.sapVersion.ECC_EHP5",
243 "caption": "ECC_EHP5"
244 }
245 }
246 ],
247 "leaseAreaFilterType": {
248 "name": "ALL",
249 "captionKey": "enum.filterType.all",
250 "caption": "All"
251 },
252 "leaseAreas": [
253 {
254 "id": 10000001,
255 "displayId": "0001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "Global Lease Area"
263 }
264 ],
265 "businessUnitFilterType": {
266 "name": "ALL",
267 "captionKey": "enum.filterType.all",
268 "caption": "All"
269 },
270 "businessUnits": [
271 {
272 "id": 10000001,
273 "displayId": "BU0001",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "name": "North America Business Unit"
281 }
282 ],
283 "companyFilterType": {
284 "name": "ALL",
285 "captionKey": "enum.filterType.all",
286 "caption": "All"
287 },
288 "companies": [
289 {
290 "id": 10000006,
291 "displayId": "1005",
292 "status": {
293 "name": "ACTIVE",
294 "captionKey": "enum.objectStatus.active",
295 "active": true,
296 "caption": "Active"
297 },
298 "erpSystemId": 10000001,
299 "erpSystemDisplayId": "FINQ8S-300",
300 "countryId": 10000095,
301 "countryDisplayId": "CA",
302 "name": "string",
303 "postingPeriodVariantId": 0,
304 "fiscalVariantId": 0
305 }
306 ],
307 "leaseDepartmentFilterType": {
308 "name": "ALL",
309 "captionKey": "enum.filterType.all",
310 "caption": "All"
311 },
312 "leaseDepartments": [
313 {
314 "id": 300001,
315 "displayId": "DEP-01",
316 "status": {
317 "name": "ACTIVE",
318 "captionKey": "enum.objectStatus.active",
319 "active": true,
320 "caption": "Active"
321 },
322 "name": "Finance Department"
323 }
324 ],
325 "leaseGroupFilterType": {
326 "name": "ALL",
327 "captionKey": "enum.filterType.all",
328 "caption": "All"
329 },
330 "leaseGroups": [
331 {
332 "id": 60000001,
333 "displayId": "LG-001",
334 "status": {
335 "name": "ACTIVE",
336 "captionKey": "enum.objectStatus.active",
337 "active": true,
338 "caption": "Active"
339 },
340 "name": "Global Lease Group"
341 }
342 ],
343 "costCenterFilterType": {
344 "name": "ALL",
345 "captionKey": "enum.filterType.all",
346 "caption": "All"
347 },
348 "costCenters": [
349 {
350 "id": 14001,
351 "displayId": "CC-001",
352 "status": {
353 "name": "ACTIVE",
354 "captionKey": "enum.objectStatus.active",
355 "active": true,
356 "caption": "Active"
357 },
358 "name": "Cost Center A",
359 "erpSystemId": 0
360 }
361 ],
362 "profitCenterFilterType": {
363 "name": "ALL",
364 "captionKey": "enum.filterType.all",
365 "caption": "All"
366 },
367 "profitCenters": [
368 {
369 "id": 9001,
370 "displayId": "PC-001",
371 "status": {
372 "name": "ACTIVE",
373 "captionKey": "enum.objectStatus.active",
374 "active": true,
375 "caption": "Active"
376 },
377 "name": "North Region Profit Center",
378 "validTo": "2025-12-31",
379 "erpSystemId": 101,
380 "erpSystemDisplayId": "SAP-01"
381 }
382 ],
383 "wbsFilterType": {
384 "name": "ALL",
385 "captionKey": "enum.filterType.all",
386 "caption": "All"
387 },
388 "wbses": [
389 {
390 "id": 1001,
391 "displayId": "WBS-2025-001",
392 "status": {
393 "name": "ACTIVE",
394 "captionKey": "enum.objectStatus.active",
395 "active": true,
396 "caption": "Active"
397 },
398 "name": "Main Project WBS",
399 "erpSystemId": 0
400 }
401 ],
402 "businessAreaFilterType": {
403 "name": "ALL",
404 "captionKey": "enum.filterType.all",
405 "caption": "All"
406 },
407 "businessAreas": [
408 {
409 "id": 3001,
410 "displayId": "BA-2025-001",
411 "status": {
412 "name": "ACTIVE",
413 "captionKey": "enum.objectStatus.active",
414 "active": true,
415 "caption": "Active"
416 },
417 "name": "North America Operations",
418 "erpSystemId": 0
419 }
420 ],
421 "functionalAreaFilterType": {
422 "name": "ALL",
423 "captionKey": "enum.filterType.all",
424 "caption": "All"
425 },
426 "functionalAreas": [
427 {
428 "id": 2001,
429 "displayId": "FA-2025-001",
430 "status": {
431 "name": "ACTIVE",
432 "captionKey": "enum.objectStatus.active",
433 "active": true,
434 "caption": "Active"
435 },
436 "name": "Accounting Department",
437 "erpSystemId": 0
438 }
439 ]
440 }
441 }
442 }
443 ],
444 "number": 0,
445 "sort": {
446 "unsorted": false,
447 "sorted": true,
448 "empty": false
449 },
450 "first": true,
451 "last": false,
452 "empty": false
453}