Periodic Posting Status Report Job

Get

HTTP Request

GET /api/v1/periodic_posting_status_reports/jobs/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": {
 15    "id": 0,
 16    "taskCount": 0,
 17    "failedTaskCount": 0,
 18    "doneTaskCount": 0,
 19    "inProgressTaskCount": 0,
 20    "cancelledTaskCount": 0,
 21    "errorMessage": "string",
 22    "executor": "SCHEDULER",
 23    "scheduleJobId": 0,
 24    "batchSize": 1000,
 25    "totalObjectCount": 0,
 26    "profileId": 0,
 27    "readOnly": true,
 28    "status": "CREATED",
 29    "fileStorageId": "string",
 30    "generatingExportFile": true,
 31    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 32    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33    "input": {
 34      "id": 0,
 35      "accountingStandardType": "GAAP",
 36      "classifications": [
 37        "NON_LEASE"
 38      ],
 39      "fromYear": 0,
 40      "fromPeriod": {
 41        "id": 0,
 42        "displayId": "string",
 43        "status": "CREATED",
 44        "day": 0,
 45        "year": 0,
 46        "month": 0,
 47        "postingPeriod": 0,
 48        "yearShift": 0
 49      },
 50      "toYear": 0,
 51      "toPeriod": {
 52        "id": 0,
 53        "displayId": "string",
 54        "status": "CREATED",
 55        "day": 0,
 56        "year": 0,
 57        "month": 0,
 58        "postingPeriod": 0,
 59        "yearShift": 0
 60      },
 61      "fromDate": "2019-08-24",
 62      "toDate": "2019-08-24",
 63      "postingType": "ALL",
 64      "externalStatusFilterType": "ALL",
 65      "externalStatuses": [
 66        "NA"
 67      ],
 68      "internalStatusFilterType": "ALL",
 69      "internalStatuses": [
 70        "NA"
 71      ],
 72      "listObjectType": "ACTIVATION_GROUP",
 73      "objectList": [
 74        {
 75          "id": 0,
 76          "displayId": "string",
 77          "name": "string"
 78        }
 79      ],
 80      "migratedFilterType": "MIGRATED",
 81      "internalAssetClassFilterType": "ALL",
 82      "internalAssetClasses": [
 83        {
 84          "id": 10000001,
 85          "displayId": "IAC-001",
 86          "status": {
 87            "name": "ACTIVE",
 88            "captionKey": "enum.objectStatus.active",
 89            "active": true,
 90            "caption": "Active"
 91          },
 92          "name": "Machinery and Equipment",
 93          "assetClassType": "PROPERTY",
 94          "infiniteUsefulLife": false
 95        }
 96      ],
 97      "businessAreaFilterType": "ALL",
 98      "businessAreas": [
 99        {
100          "id": 3001,
101          "displayId": "BA-2025-001",
102          "status": {
103            "name": "ACTIVE",
104            "captionKey": "enum.objectStatus.active",
105            "active": true,
106            "caption": "Active"
107          },
108          "name": "North America Operations"
109        }
110      ],
111      "functionalAreaFilterType": "ALL",
112      "functionalAreas": [
113        {
114          "id": 2001,
115          "displayId": "FA-2025-001",
116          "status": {
117            "name": "ACTIVE",
118            "captionKey": "enum.objectStatus.active",
119            "active": true,
120            "caption": "Active"
121          },
122          "name": "Accounting Department"
123        }
124      ]
125    },
126    "filter": {
127      "id": 0,
128      "name": "string",
129      "principalPositionType": "LESSEE",
130      "calendarType": "REGULAR_CALENDAR",
131      "fiscalYearVariant": {
132        "id": "string",
133        "displayId": "Euro"
134      },
135      "profileId": 0,
136      "jobId": 0,
137      "objectList": [
138        {
139          "id": "string",
140          "displayId": "Euro"
141        }
142      ],
143      "filterTypes": {
144        "erpSystemFilterType": "ALL",
145        "erpSystems": [
146          {
147            "id": 0,
148            "displayId": "string",
149            "status": "CREATED",
150            "name": "string",
151            "type": "NAKISA",
152            "sapVersion": "ECC_EHP5"
153          }
154        ],
155        "leaseAreaFilterType": "ALL",
156        "leaseAreas": [
157          {
158            "id": 10000001,
159            "displayId": "0001",
160            "status": {
161              "name": "ACTIVE",
162              "captionKey": "enum.objectStatus.active",
163              "active": true,
164              "caption": "Active"
165            },
166            "name": "Global Lease Area"
167          }
168        ],
169        "businessUnitFilterType": "ALL",
170        "businessUnits": [
171          {
172            "id": 10000001,
173            "displayId": "BU0001",
174            "status": {
175              "name": "ACTIVE",
176              "captionKey": "enum.objectStatus.active",
177              "active": true,
178              "caption": "Active"
179            },
180            "name": "North America Business Unit"
181          }
182        ],
183        "companyFilterType": "ALL",
184        "companies": [
185          {
186            "id": 10000006,
187            "displayId": "1005",
188            "status": {
189              "name": "ACTIVE",
190              "captionKey": "enum.objectStatus.active",
191              "active": true,
192              "caption": "Active"
193            },
194            "erpSystemId": 10000001,
195            "erpSystemDisplayId": "FINQ8S-300",
196            "countryId": 10000095,
197            "countryDisplayId": "CA",
198            "postingPeriodVariantId": 0,
199            "fiscalVariantId": 0
200          }
201        ],
202        "leaseDepartmentFilterType": "ALL",
203        "leaseDepartments": [
204          {
205            "id": 300001,
206            "displayId": "DEP-01",
207            "status": {
208              "name": "ACTIVE",
209              "captionKey": "enum.objectStatus.active",
210              "active": true,
211              "caption": "Active"
212            },
213            "name": "Finance Department"
214          }
215        ],
216        "leaseGroupFilterType": "ALL",
217        "leaseGroups": [
218          {
219            "id": 60000001,
220            "displayId": "LG-001",
221            "status": {
222              "name": "ACTIVE",
223              "captionKey": "enum.objectStatus.active",
224              "active": true,
225              "caption": "Active"
226            },
227            "name": "Global Lease Group"
228          }
229        ],
230        "costCenterFilterType": "ALL",
231        "costCenters": [
232          {
233            "id": 14001,
234            "displayId": "CC-001",
235            "status": {
236              "name": "ACTIVE",
237              "captionKey": "enum.objectStatus.active",
238              "active": true,
239              "caption": "Active"
240            },
241            "name": "Cost Center A"
242          }
243        ],
244        "profitCenterFilterType": "ALL",
245        "profitCenters": [
246          {
247            "id": 9001,
248            "displayId": "PC-001",
249            "status": {
250              "name": "ACTIVE",
251              "captionKey": "enum.objectStatus.active",
252              "active": true,
253              "caption": "Active"
254            },
255            "name": "North Region Profit Center",
256            "validTo": "2025-12-31",
257            "erpSystemId": 101,
258            "erpSystemDisplayId": "SAP-01"
259          }
260        ],
261        "wbsFilterType": "ALL",
262        "wbses": [
263          {
264            "id": 1001,
265            "displayId": "WBS-2025-001",
266            "status": {
267              "name": "ACTIVE",
268              "captionKey": "enum.objectStatus.active",
269              "active": true,
270              "caption": "Active"
271            },
272            "name": "Main Project WBS"
273          }
274        ],
275        "businessAreaFilterType": "ALL",
276        "businessAreas": [
277          {
278            "id": 3001,
279            "displayId": "BA-2025-001",
280            "status": {
281              "name": "ACTIVE",
282              "captionKey": "enum.objectStatus.active",
283              "active": true,
284              "caption": "Active"
285            },
286            "name": "North America Operations"
287          }
288        ],
289        "functionalAreaFilterType": "ALL",
290        "functionalAreas": [
291          {
292            "id": 2001,
293            "displayId": "FA-2025-001",
294            "status": {
295              "name": "ACTIVE",
296              "captionKey": "enum.objectStatus.active",
297              "active": true,
298              "caption": "Active"
299            },
300            "name": "Accounting Department"
301          }
302        ]
303      }
304    },
305    "tasks": [
306      {
307        "id": 0,
308        "queueTime": "2019-08-24T14:15:22Z",
309        "startTime": "2019-08-24T14:15:22Z",
310        "endTime": "2019-08-24T14:15:22Z",
311        "interruptedAt": "2019-08-24T14:15:22Z",
312        "recoveredAt": "2019-08-24T14:15:22Z",
313        "status": "CREATED",
314        "recover": true,
315        "interrupted": true,
316        "interruptionMessage": "string",
317        "errorMessage": "string",
318        "reportJobId": 0,
319        "unitIds": [
320          0
321        ],
322        "jsonFileStorageId": "string",
323        "jsonDocStoreIds": [
324          0
325        ]
326      }
327    ],
328    "docStoreId": 0
329  }
330}

Update

HTTP Request

PUT /api/v1/periodic_posting_status_reports/jobs/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

body

body

PeriodicPostingStatusReportJobDto

true

none

Body Parameters

  1{
  2  "id": 0,
  3  "taskCount": 0,
  4  "failedTaskCount": 0,
  5  "doneTaskCount": 0,
  6  "inProgressTaskCount": 0,
  7  "cancelledTaskCount": 0,
  8  "errorMessage": "string",
  9  "executor": "SCHEDULER",
 10  "scheduleJobId": 0,
 11  "batchSize": 1000,
 12  "totalObjectCount": 0,
 13  "profileId": 0,
 14  "readOnly": true,
 15  "status": "CREATED",
 16  "fileStorageId": "string",
 17  "generatingExportFile": true,
 18  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 19  "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 20  "input": {
 21    "id": 0,
 22    "accountingStandardType": "GAAP",
 23    "classifications": [
 24      "NON_LEASE"
 25    ],
 26    "fromYear": 0,
 27    "fromPeriod": {
 28      "id": 0,
 29      "displayId": "string",
 30      "status": "CREATED",
 31      "day": 0,
 32      "year": 0,
 33      "month": 0,
 34      "postingPeriod": 0,
 35      "yearShift": 0
 36    },
 37    "toYear": 0,
 38    "toPeriod": {
 39      "id": 0,
 40      "displayId": "string",
 41      "status": "CREATED",
 42      "day": 0,
 43      "year": 0,
 44      "month": 0,
 45      "postingPeriod": 0,
 46      "yearShift": 0
 47    },
 48    "fromDate": "2019-08-24",
 49    "toDate": "2019-08-24",
 50    "postingType": "ALL",
 51    "externalStatusFilterType": "ALL",
 52    "externalStatuses": [
 53      "NA"
 54    ],
 55    "internalStatusFilterType": "ALL",
 56    "internalStatuses": [
 57      "NA"
 58    ],
 59    "listObjectType": "ACTIVATION_GROUP",
 60    "objectList": [
 61      {
 62        "id": 0,
 63        "displayId": "string",
 64        "name": "string"
 65      }
 66    ],
 67    "migratedFilterType": "MIGRATED",
 68    "internalAssetClassFilterType": "ALL",
 69    "internalAssetClasses": [
 70      {
 71        "id": 10000001,
 72        "displayId": "IAC-001",
 73        "status": {
 74          "name": "ACTIVE",
 75          "captionKey": "enum.objectStatus.active",
 76          "active": true,
 77          "caption": "Active"
 78        },
 79        "name": "Machinery and Equipment",
 80        "assetClassType": "PROPERTY",
 81        "infiniteUsefulLife": false
 82      }
 83    ],
 84    "businessAreaFilterType": "ALL",
 85    "businessAreas": [
 86      {
 87        "id": 3001,
 88        "displayId": "BA-2025-001",
 89        "status": {
 90          "name": "ACTIVE",
 91          "captionKey": "enum.objectStatus.active",
 92          "active": true,
 93          "caption": "Active"
 94        },
 95        "name": "North America Operations"
 96      }
 97    ],
 98    "functionalAreaFilterType": "ALL",
 99    "functionalAreas": [
100      {
101        "id": 2001,
102        "displayId": "FA-2025-001",
103        "status": {
104          "name": "ACTIVE",
105          "captionKey": "enum.objectStatus.active",
106          "active": true,
107          "caption": "Active"
108        },
109        "name": "Accounting Department"
110      }
111    ]
112  },
113  "filter": {
114    "id": 0,
115    "name": "string",
116    "principalPositionType": "LESSEE",
117    "calendarType": "REGULAR_CALENDAR",
118    "fiscalYearVariant": {
119      "id": "string",
120      "displayId": "Euro"
121    },
122    "profileId": 0,
123    "jobId": 0,
124    "objectList": [
125      {
126        "id": "string",
127        "displayId": "Euro"
128      }
129    ],
130    "filterTypes": {
131      "erpSystemFilterType": "ALL",
132      "erpSystems": [
133        {
134          "id": 0,
135          "displayId": "string",
136          "status": "CREATED",
137          "name": "string",
138          "type": "NAKISA",
139          "sapVersion": "ECC_EHP5"
140        }
141      ],
142      "leaseAreaFilterType": "ALL",
143      "leaseAreas": [
144        {
145          "id": 10000001,
146          "displayId": "0001",
147          "status": {
148            "name": "ACTIVE",
149            "captionKey": "enum.objectStatus.active",
150            "active": true,
151            "caption": "Active"
152          },
153          "name": "Global Lease Area"
154        }
155      ],
156      "businessUnitFilterType": "ALL",
157      "businessUnits": [
158        {
159          "id": 10000001,
160          "displayId": "BU0001",
161          "status": {
162            "name": "ACTIVE",
163            "captionKey": "enum.objectStatus.active",
164            "active": true,
165            "caption": "Active"
166          },
167          "name": "North America Business Unit"
168        }
169      ],
170      "companyFilterType": "ALL",
171      "companies": [
172        {
173          "id": 10000006,
174          "displayId": "1005",
175          "status": {
176            "name": "ACTIVE",
177            "captionKey": "enum.objectStatus.active",
178            "active": true,
179            "caption": "Active"
180          },
181          "erpSystemId": 10000001,
182          "erpSystemDisplayId": "FINQ8S-300",
183          "countryId": 10000095,
184          "countryDisplayId": "CA",
185          "postingPeriodVariantId": 0,
186          "fiscalVariantId": 0
187        }
188      ],
189      "leaseDepartmentFilterType": "ALL",
190      "leaseDepartments": [
191        {
192          "id": 300001,
193          "displayId": "DEP-01",
194          "status": {
195            "name": "ACTIVE",
196            "captionKey": "enum.objectStatus.active",
197            "active": true,
198            "caption": "Active"
199          },
200          "name": "Finance Department"
201        }
202      ],
203      "leaseGroupFilterType": "ALL",
204      "leaseGroups": [
205        {
206          "id": 60000001,
207          "displayId": "LG-001",
208          "status": {
209            "name": "ACTIVE",
210            "captionKey": "enum.objectStatus.active",
211            "active": true,
212            "caption": "Active"
213          },
214          "name": "Global Lease Group"
215        }
216      ],
217      "costCenterFilterType": "ALL",
218      "costCenters": [
219        {
220          "id": 14001,
221          "displayId": "CC-001",
222          "status": {
223            "name": "ACTIVE",
224            "captionKey": "enum.objectStatus.active",
225            "active": true,
226            "caption": "Active"
227          },
228          "name": "Cost Center A"
229        }
230      ],
231      "profitCenterFilterType": "ALL",
232      "profitCenters": [
233        {
234          "id": 9001,
235          "displayId": "PC-001",
236          "status": {
237            "name": "ACTIVE",
238            "captionKey": "enum.objectStatus.active",
239            "active": true,
240            "caption": "Active"
241          },
242          "name": "North Region Profit Center",
243          "validTo": "2025-12-31",
244          "erpSystemId": 101,
245          "erpSystemDisplayId": "SAP-01"
246        }
247      ],
248      "wbsFilterType": "ALL",
249      "wbses": [
250        {
251          "id": 1001,
252          "displayId": "WBS-2025-001",
253          "status": {
254            "name": "ACTIVE",
255            "captionKey": "enum.objectStatus.active",
256            "active": true,
257            "caption": "Active"
258          },
259          "name": "Main Project WBS"
260        }
261      ],
262      "businessAreaFilterType": "ALL",
263      "businessAreas": [
264        {
265          "id": 3001,
266          "displayId": "BA-2025-001",
267          "status": {
268            "name": "ACTIVE",
269            "captionKey": "enum.objectStatus.active",
270            "active": true,
271            "caption": "Active"
272          },
273          "name": "North America Operations"
274        }
275      ],
276      "functionalAreaFilterType": "ALL",
277      "functionalAreas": [
278        {
279          "id": 2001,
280          "displayId": "FA-2025-001",
281          "status": {
282            "name": "ACTIVE",
283            "captionKey": "enum.objectStatus.active",
284            "active": true,
285            "caption": "Active"
286          },
287          "name": "Accounting Department"
288        }
289      ]
290    }
291  },
292  "tasks": [
293    {
294      "id": 0,
295      "queueTime": "2019-08-24T14:15:22Z",
296      "startTime": "2019-08-24T14:15:22Z",
297      "endTime": "2019-08-24T14:15:22Z",
298      "interruptedAt": "2019-08-24T14:15:22Z",
299      "recoveredAt": "2019-08-24T14:15:22Z",
300      "status": "CREATED",
301      "recover": true,
302      "interrupted": true,
303      "interruptionMessage": "string",
304      "errorMessage": "string",
305      "reportJobId": 0,
306      "unitIds": [
307        0
308      ],
309      "jsonFileStorageId": "string",
310      "jsonDocStoreIds": [
311        0
312      ]
313    }
314  ],
315  "docStoreId": 0
316}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": {
 15    "id": 0,
 16    "taskCount": 0,
 17    "failedTaskCount": 0,
 18    "doneTaskCount": 0,
 19    "inProgressTaskCount": 0,
 20    "cancelledTaskCount": 0,
 21    "errorMessage": "string",
 22    "executor": "SCHEDULER",
 23    "scheduleJobId": 0,
 24    "batchSize": 1000,
 25    "totalObjectCount": 0,
 26    "profileId": 0,
 27    "readOnly": true,
 28    "status": "CREATED",
 29    "fileStorageId": "string",
 30    "generatingExportFile": true,
 31    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 32    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33    "input": {
 34      "id": 0,
 35      "accountingStandardType": "GAAP",
 36      "classifications": [
 37        "NON_LEASE"
 38      ],
 39      "fromYear": 0,
 40      "fromPeriod": {
 41        "id": 0,
 42        "displayId": "string",
 43        "status": "CREATED",
 44        "day": 0,
 45        "year": 0,
 46        "month": 0,
 47        "postingPeriod": 0,
 48        "yearShift": 0
 49      },
 50      "toYear": 0,
 51      "toPeriod": {
 52        "id": 0,
 53        "displayId": "string",
 54        "status": "CREATED",
 55        "day": 0,
 56        "year": 0,
 57        "month": 0,
 58        "postingPeriod": 0,
 59        "yearShift": 0
 60      },
 61      "fromDate": "2019-08-24",
 62      "toDate": "2019-08-24",
 63      "postingType": "ALL",
 64      "externalStatusFilterType": "ALL",
 65      "externalStatuses": [
 66        "NA"
 67      ],
 68      "internalStatusFilterType": "ALL",
 69      "internalStatuses": [
 70        "NA"
 71      ],
 72      "listObjectType": "ACTIVATION_GROUP",
 73      "objectList": [
 74        {
 75          "id": 0,
 76          "displayId": "string",
 77          "name": "string"
 78        }
 79      ],
 80      "migratedFilterType": "MIGRATED",
 81      "internalAssetClassFilterType": "ALL",
 82      "internalAssetClasses": [
 83        {
 84          "id": 10000001,
 85          "displayId": "IAC-001",
 86          "status": {
 87            "name": "ACTIVE",
 88            "captionKey": "enum.objectStatus.active",
 89            "active": true,
 90            "caption": "Active"
 91          },
 92          "name": "Machinery and Equipment",
 93          "assetClassType": "PROPERTY",
 94          "infiniteUsefulLife": false
 95        }
 96      ],
 97      "businessAreaFilterType": "ALL",
 98      "businessAreas": [
 99        {
100          "id": 3001,
101          "displayId": "BA-2025-001",
102          "status": {
103            "name": "ACTIVE",
104            "captionKey": "enum.objectStatus.active",
105            "active": true,
106            "caption": "Active"
107          },
108          "name": "North America Operations"
109        }
110      ],
111      "functionalAreaFilterType": "ALL",
112      "functionalAreas": [
113        {
114          "id": 2001,
115          "displayId": "FA-2025-001",
116          "status": {
117            "name": "ACTIVE",
118            "captionKey": "enum.objectStatus.active",
119            "active": true,
120            "caption": "Active"
121          },
122          "name": "Accounting Department"
123        }
124      ]
125    },
126    "filter": {
127      "id": 0,
128      "name": "string",
129      "principalPositionType": "LESSEE",
130      "calendarType": "REGULAR_CALENDAR",
131      "fiscalYearVariant": {
132        "id": "string",
133        "displayId": "Euro"
134      },
135      "profileId": 0,
136      "jobId": 0,
137      "objectList": [
138        {
139          "id": "string",
140          "displayId": "Euro"
141        }
142      ],
143      "filterTypes": {
144        "erpSystemFilterType": "ALL",
145        "erpSystems": [
146          {
147            "id": 0,
148            "displayId": "string",
149            "status": "CREATED",
150            "name": "string",
151            "type": "NAKISA",
152            "sapVersion": "ECC_EHP5"
153          }
154        ],
155        "leaseAreaFilterType": "ALL",
156        "leaseAreas": [
157          {
158            "id": 10000001,
159            "displayId": "0001",
160            "status": {
161              "name": "ACTIVE",
162              "captionKey": "enum.objectStatus.active",
163              "active": true,
164              "caption": "Active"
165            },
166            "name": "Global Lease Area"
167          }
168        ],
169        "businessUnitFilterType": "ALL",
170        "businessUnits": [
171          {
172            "id": 10000001,
173            "displayId": "BU0001",
174            "status": {
175              "name": "ACTIVE",
176              "captionKey": "enum.objectStatus.active",
177              "active": true,
178              "caption": "Active"
179            },
180            "name": "North America Business Unit"
181          }
182        ],
183        "companyFilterType": "ALL",
184        "companies": [
185          {
186            "id": 10000006,
187            "displayId": "1005",
188            "status": {
189              "name": "ACTIVE",
190              "captionKey": "enum.objectStatus.active",
191              "active": true,
192              "caption": "Active"
193            },
194            "erpSystemId": 10000001,
195            "erpSystemDisplayId": "FINQ8S-300",
196            "countryId": 10000095,
197            "countryDisplayId": "CA",
198            "postingPeriodVariantId": 0,
199            "fiscalVariantId": 0
200          }
201        ],
202        "leaseDepartmentFilterType": "ALL",
203        "leaseDepartments": [
204          {
205            "id": 300001,
206            "displayId": "DEP-01",
207            "status": {
208              "name": "ACTIVE",
209              "captionKey": "enum.objectStatus.active",
210              "active": true,
211              "caption": "Active"
212            },
213            "name": "Finance Department"
214          }
215        ],
216        "leaseGroupFilterType": "ALL",
217        "leaseGroups": [
218          {
219            "id": 60000001,
220            "displayId": "LG-001",
221            "status": {
222              "name": "ACTIVE",
223              "captionKey": "enum.objectStatus.active",
224              "active": true,
225              "caption": "Active"
226            },
227            "name": "Global Lease Group"
228          }
229        ],
230        "costCenterFilterType": "ALL",
231        "costCenters": [
232          {
233            "id": 14001,
234            "displayId": "CC-001",
235            "status": {
236              "name": "ACTIVE",
237              "captionKey": "enum.objectStatus.active",
238              "active": true,
239              "caption": "Active"
240            },
241            "name": "Cost Center A"
242          }
243        ],
244        "profitCenterFilterType": "ALL",
245        "profitCenters": [
246          {
247            "id": 9001,
248            "displayId": "PC-001",
249            "status": {
250              "name": "ACTIVE",
251              "captionKey": "enum.objectStatus.active",
252              "active": true,
253              "caption": "Active"
254            },
255            "name": "North Region Profit Center",
256            "validTo": "2025-12-31",
257            "erpSystemId": 101,
258            "erpSystemDisplayId": "SAP-01"
259          }
260        ],
261        "wbsFilterType": "ALL",
262        "wbses": [
263          {
264            "id": 1001,
265            "displayId": "WBS-2025-001",
266            "status": {
267              "name": "ACTIVE",
268              "captionKey": "enum.objectStatus.active",
269              "active": true,
270              "caption": "Active"
271            },
272            "name": "Main Project WBS"
273          }
274        ],
275        "businessAreaFilterType": "ALL",
276        "businessAreas": [
277          {
278            "id": 3001,
279            "displayId": "BA-2025-001",
280            "status": {
281              "name": "ACTIVE",
282              "captionKey": "enum.objectStatus.active",
283              "active": true,
284              "caption": "Active"
285            },
286            "name": "North America Operations"
287          }
288        ],
289        "functionalAreaFilterType": "ALL",
290        "functionalAreas": [
291          {
292            "id": 2001,
293            "displayId": "FA-2025-001",
294            "status": {
295              "name": "ACTIVE",
296              "captionKey": "enum.objectStatus.active",
297              "active": true,
298              "caption": "Active"
299            },
300            "name": "Accounting Department"
301          }
302        ]
303      }
304    },
305    "tasks": [
306      {
307        "id": 0,
308        "queueTime": "2019-08-24T14:15:22Z",
309        "startTime": "2019-08-24T14:15:22Z",
310        "endTime": "2019-08-24T14:15:22Z",
311        "interruptedAt": "2019-08-24T14:15:22Z",
312        "recoveredAt": "2019-08-24T14:15:22Z",
313        "status": "CREATED",
314        "recover": true,
315        "interrupted": true,
316        "interruptionMessage": "string",
317        "errorMessage": "string",
318        "reportJobId": 0,
319        "unitIds": [
320          0
321        ],
322        "jsonFileStorageId": "string",
323        "jsonDocStoreIds": [
324          0
325        ]
326      }
327    ],
328    "docStoreId": 0
329  }
330}

Delete

HTTP Request

DELETE /api/v1/periodic_posting_status_reports/jobs/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "source": {},
 8        "field": "string",
 9        "errorKey": "string",
10        "errorMessage": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Patch

HTTP Request

PATCH /api/v1/periodic_posting_status_reports/jobs/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

body

body

JsonPatch

true

none

Example Values

Parameter

Example

Type

body

{"op":"replace","path":"/name","value":"patched contract"}

body

Body Parameters

1{
2  "op": "replace",
3  "path": "/name",
4  "value": "patched contract"
5}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": {
 15    "id": 0,
 16    "taskCount": 0,
 17    "failedTaskCount": 0,
 18    "doneTaskCount": 0,
 19    "inProgressTaskCount": 0,
 20    "cancelledTaskCount": 0,
 21    "errorMessage": "string",
 22    "executor": "SCHEDULER",
 23    "scheduleJobId": 0,
 24    "batchSize": 1000,
 25    "totalObjectCount": 0,
 26    "profileId": 0,
 27    "readOnly": true,
 28    "status": "CREATED",
 29    "fileStorageId": "string",
 30    "generatingExportFile": true,
 31    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 32    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33    "input": {
 34      "id": 0,
 35      "accountingStandardType": "GAAP",
 36      "classifications": [
 37        "NON_LEASE"
 38      ],
 39      "fromYear": 0,
 40      "fromPeriod": {
 41        "id": 0,
 42        "displayId": "string",
 43        "status": "CREATED",
 44        "day": 0,
 45        "year": 0,
 46        "month": 0,
 47        "postingPeriod": 0,
 48        "yearShift": 0
 49      },
 50      "toYear": 0,
 51      "toPeriod": {
 52        "id": 0,
 53        "displayId": "string",
 54        "status": "CREATED",
 55        "day": 0,
 56        "year": 0,
 57        "month": 0,
 58        "postingPeriod": 0,
 59        "yearShift": 0
 60      },
 61      "fromDate": "2019-08-24",
 62      "toDate": "2019-08-24",
 63      "postingType": "ALL",
 64      "externalStatusFilterType": "ALL",
 65      "externalStatuses": [
 66        "NA"
 67      ],
 68      "internalStatusFilterType": "ALL",
 69      "internalStatuses": [
 70        "NA"
 71      ],
 72      "listObjectType": "ACTIVATION_GROUP",
 73      "objectList": [
 74        {
 75          "id": 0,
 76          "displayId": "string",
 77          "name": "string"
 78        }
 79      ],
 80      "migratedFilterType": "MIGRATED",
 81      "internalAssetClassFilterType": "ALL",
 82      "internalAssetClasses": [
 83        {
 84          "id": 10000001,
 85          "displayId": "IAC-001",
 86          "status": {
 87            "name": "ACTIVE",
 88            "captionKey": "enum.objectStatus.active",
 89            "active": true,
 90            "caption": "Active"
 91          },
 92          "name": "Machinery and Equipment",
 93          "assetClassType": "PROPERTY",
 94          "infiniteUsefulLife": false
 95        }
 96      ],
 97      "businessAreaFilterType": "ALL",
 98      "businessAreas": [
 99        {
100          "id": 3001,
101          "displayId": "BA-2025-001",
102          "status": {
103            "name": "ACTIVE",
104            "captionKey": "enum.objectStatus.active",
105            "active": true,
106            "caption": "Active"
107          },
108          "name": "North America Operations"
109        }
110      ],
111      "functionalAreaFilterType": "ALL",
112      "functionalAreas": [
113        {
114          "id": 2001,
115          "displayId": "FA-2025-001",
116          "status": {
117            "name": "ACTIVE",
118            "captionKey": "enum.objectStatus.active",
119            "active": true,
120            "caption": "Active"
121          },
122          "name": "Accounting Department"
123        }
124      ]
125    },
126    "filter": {
127      "id": 0,
128      "name": "string",
129      "principalPositionType": "LESSEE",
130      "calendarType": "REGULAR_CALENDAR",
131      "fiscalYearVariant": {
132        "id": "string",
133        "displayId": "Euro"
134      },
135      "profileId": 0,
136      "jobId": 0,
137      "objectList": [
138        {
139          "id": "string",
140          "displayId": "Euro"
141        }
142      ],
143      "filterTypes": {
144        "erpSystemFilterType": "ALL",
145        "erpSystems": [
146          {
147            "id": 0,
148            "displayId": "string",
149            "status": "CREATED",
150            "name": "string",
151            "type": "NAKISA",
152            "sapVersion": "ECC_EHP5"
153          }
154        ],
155        "leaseAreaFilterType": "ALL",
156        "leaseAreas": [
157          {
158            "id": 10000001,
159            "displayId": "0001",
160            "status": {
161              "name": "ACTIVE",
162              "captionKey": "enum.objectStatus.active",
163              "active": true,
164              "caption": "Active"
165            },
166            "name": "Global Lease Area"
167          }
168        ],
169        "businessUnitFilterType": "ALL",
170        "businessUnits": [
171          {
172            "id": 10000001,
173            "displayId": "BU0001",
174            "status": {
175              "name": "ACTIVE",
176              "captionKey": "enum.objectStatus.active",
177              "active": true,
178              "caption": "Active"
179            },
180            "name": "North America Business Unit"
181          }
182        ],
183        "companyFilterType": "ALL",
184        "companies": [
185          {
186            "id": 10000006,
187            "displayId": "1005",
188            "status": {
189              "name": "ACTIVE",
190              "captionKey": "enum.objectStatus.active",
191              "active": true,
192              "caption": "Active"
193            },
194            "erpSystemId": 10000001,
195            "erpSystemDisplayId": "FINQ8S-300",
196            "countryId": 10000095,
197            "countryDisplayId": "CA",
198            "postingPeriodVariantId": 0,
199            "fiscalVariantId": 0
200          }
201        ],
202        "leaseDepartmentFilterType": "ALL",
203        "leaseDepartments": [
204          {
205            "id": 300001,
206            "displayId": "DEP-01",
207            "status": {
208              "name": "ACTIVE",
209              "captionKey": "enum.objectStatus.active",
210              "active": true,
211              "caption": "Active"
212            },
213            "name": "Finance Department"
214          }
215        ],
216        "leaseGroupFilterType": "ALL",
217        "leaseGroups": [
218          {
219            "id": 60000001,
220            "displayId": "LG-001",
221            "status": {
222              "name": "ACTIVE",
223              "captionKey": "enum.objectStatus.active",
224              "active": true,
225              "caption": "Active"
226            },
227            "name": "Global Lease Group"
228          }
229        ],
230        "costCenterFilterType": "ALL",
231        "costCenters": [
232          {
233            "id": 14001,
234            "displayId": "CC-001",
235            "status": {
236              "name": "ACTIVE",
237              "captionKey": "enum.objectStatus.active",
238              "active": true,
239              "caption": "Active"
240            },
241            "name": "Cost Center A"
242          }
243        ],
244        "profitCenterFilterType": "ALL",
245        "profitCenters": [
246          {
247            "id": 9001,
248            "displayId": "PC-001",
249            "status": {
250              "name": "ACTIVE",
251              "captionKey": "enum.objectStatus.active",
252              "active": true,
253              "caption": "Active"
254            },
255            "name": "North Region Profit Center",
256            "validTo": "2025-12-31",
257            "erpSystemId": 101,
258            "erpSystemDisplayId": "SAP-01"
259          }
260        ],
261        "wbsFilterType": "ALL",
262        "wbses": [
263          {
264            "id": 1001,
265            "displayId": "WBS-2025-001",
266            "status": {
267              "name": "ACTIVE",
268              "captionKey": "enum.objectStatus.active",
269              "active": true,
270              "caption": "Active"
271            },
272            "name": "Main Project WBS"
273          }
274        ],
275        "businessAreaFilterType": "ALL",
276        "businessAreas": [
277          {
278            "id": 3001,
279            "displayId": "BA-2025-001",
280            "status": {
281              "name": "ACTIVE",
282              "captionKey": "enum.objectStatus.active",
283              "active": true,
284              "caption": "Active"
285            },
286            "name": "North America Operations"
287          }
288        ],
289        "functionalAreaFilterType": "ALL",
290        "functionalAreas": [
291          {
292            "id": 2001,
293            "displayId": "FA-2025-001",
294            "status": {
295              "name": "ACTIVE",
296              "captionKey": "enum.objectStatus.active",
297              "active": true,
298              "caption": "Active"
299            },
300            "name": "Accounting Department"
301          }
302        ]
303      }
304    },
305    "tasks": [
306      {
307        "id": 0,
308        "queueTime": "2019-08-24T14:15:22Z",
309        "startTime": "2019-08-24T14:15:22Z",
310        "endTime": "2019-08-24T14:15:22Z",
311        "interruptedAt": "2019-08-24T14:15:22Z",
312        "recoveredAt": "2019-08-24T14:15:22Z",
313        "status": "CREATED",
314        "recover": true,
315        "interrupted": true,
316        "interruptionMessage": "string",
317        "errorMessage": "string",
318        "reportJobId": 0,
319        "unitIds": [
320          0
321        ],
322        "jsonFileStorageId": "string",
323        "jsonDocStoreIds": [
324          0
325        ]
326      }
327    ],
328    "docStoreId": 0
329  }
330}

Create Or Update Bulk

HTTP Request

PUT /api/v1/periodic_posting_status_reports/jobs/createOrUpdate/bulk

Parameters

Name

In

Type

Required

Description

body

body

PeriodicPostingStatusReportJobDto

true

none

Body Parameters

  1[
  2  {
  3    "id": 0,
  4    "taskCount": 0,
  5    "failedTaskCount": 0,
  6    "doneTaskCount": 0,
  7    "inProgressTaskCount": 0,
  8    "cancelledTaskCount": 0,
  9    "errorMessage": "string",
 10    "executor": "SCHEDULER",
 11    "scheduleJobId": 0,
 12    "batchSize": 1000,
 13    "totalObjectCount": 0,
 14    "profileId": 0,
 15    "readOnly": true,
 16    "status": "CREATED",
 17    "fileStorageId": "string",
 18    "generatingExportFile": true,
 19    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 20    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 21    "input": {
 22      "id": 0,
 23      "accountingStandardType": "GAAP",
 24      "classifications": [
 25        "NON_LEASE"
 26      ],
 27      "fromYear": 0,
 28      "fromPeriod": {
 29        "id": 0,
 30        "displayId": "string",
 31        "status": "CREATED",
 32        "day": 0,
 33        "year": 0,
 34        "month": 0,
 35        "postingPeriod": 0,
 36        "yearShift": 0
 37      },
 38      "toYear": 0,
 39      "toPeriod": {
 40        "id": 0,
 41        "displayId": "string",
 42        "status": "CREATED",
 43        "day": 0,
 44        "year": 0,
 45        "month": 0,
 46        "postingPeriod": 0,
 47        "yearShift": 0
 48      },
 49      "fromDate": "2019-08-24",
 50      "toDate": "2019-08-24",
 51      "postingType": "ALL",
 52      "externalStatusFilterType": "ALL",
 53      "externalStatuses": [
 54        "NA"
 55      ],
 56      "internalStatusFilterType": "ALL",
 57      "internalStatuses": [
 58        "NA"
 59      ],
 60      "listObjectType": "ACTIVATION_GROUP",
 61      "objectList": [
 62        {
 63          "id": 0,
 64          "displayId": "string",
 65          "name": "string"
 66        }
 67      ],
 68      "migratedFilterType": "MIGRATED",
 69      "internalAssetClassFilterType": "ALL",
 70      "internalAssetClasses": [
 71        {
 72          "id": 10000001,
 73          "displayId": "IAC-001",
 74          "status": {
 75            "name": "ACTIVE",
 76            "captionKey": "enum.objectStatus.active",
 77            "active": true,
 78            "caption": "Active"
 79          },
 80          "name": "Machinery and Equipment",
 81          "assetClassType": "PROPERTY",
 82          "infiniteUsefulLife": false
 83        }
 84      ],
 85      "businessAreaFilterType": "ALL",
 86      "businessAreas": [
 87        {
 88          "id": 3001,
 89          "displayId": "BA-2025-001",
 90          "status": {
 91            "name": "ACTIVE",
 92            "captionKey": "enum.objectStatus.active",
 93            "active": true,
 94            "caption": "Active"
 95          },
 96          "name": "North America Operations"
 97        }
 98      ],
 99      "functionalAreaFilterType": "ALL",
100      "functionalAreas": [
101        {
102          "id": 2001,
103          "displayId": "FA-2025-001",
104          "status": {
105            "name": "ACTIVE",
106            "captionKey": "enum.objectStatus.active",
107            "active": true,
108            "caption": "Active"
109          },
110          "name": "Accounting Department"
111        }
112      ]
113    },
114    "filter": {
115      "id": 0,
116      "name": "string",
117      "principalPositionType": "LESSEE",
118      "calendarType": "REGULAR_CALENDAR",
119      "fiscalYearVariant": {
120        "id": "string",
121        "displayId": "Euro"
122      },
123      "profileId": 0,
124      "jobId": 0,
125      "objectList": [
126        {
127          "id": "string",
128          "displayId": "Euro"
129        }
130      ],
131      "filterTypes": {
132        "erpSystemFilterType": "ALL",
133        "erpSystems": [
134          {
135            "id": 0,
136            "displayId": "string",
137            "status": "CREATED",
138            "name": "string",
139            "type": "NAKISA",
140            "sapVersion": "ECC_EHP5"
141          }
142        ],
143        "leaseAreaFilterType": "ALL",
144        "leaseAreas": [
145          {
146            "id": 10000001,
147            "displayId": "0001",
148            "status": {
149              "name": "ACTIVE",
150              "captionKey": "enum.objectStatus.active",
151              "active": true,
152              "caption": "Active"
153            },
154            "name": "Global Lease Area"
155          }
156        ],
157        "businessUnitFilterType": "ALL",
158        "businessUnits": [
159          {
160            "id": 10000001,
161            "displayId": "BU0001",
162            "status": {
163              "name": "ACTIVE",
164              "captionKey": "enum.objectStatus.active",
165              "active": true,
166              "caption": "Active"
167            },
168            "name": "North America Business Unit"
169          }
170        ],
171        "companyFilterType": "ALL",
172        "companies": [
173          {
174            "id": 10000006,
175            "displayId": "1005",
176            "status": {
177              "name": "ACTIVE",
178              "captionKey": "enum.objectStatus.active",
179              "active": true,
180              "caption": "Active"
181            },
182            "erpSystemId": 10000001,
183            "erpSystemDisplayId": "FINQ8S-300",
184            "countryId": 10000095,
185            "countryDisplayId": "CA",
186            "postingPeriodVariantId": 0,
187            "fiscalVariantId": 0
188          }
189        ],
190        "leaseDepartmentFilterType": "ALL",
191        "leaseDepartments": [
192          {
193            "id": 300001,
194            "displayId": "DEP-01",
195            "status": {
196              "name": "ACTIVE",
197              "captionKey": "enum.objectStatus.active",
198              "active": true,
199              "caption": "Active"
200            },
201            "name": "Finance Department"
202          }
203        ],
204        "leaseGroupFilterType": "ALL",
205        "leaseGroups": [
206          {
207            "id": 60000001,
208            "displayId": "LG-001",
209            "status": {
210              "name": "ACTIVE",
211              "captionKey": "enum.objectStatus.active",
212              "active": true,
213              "caption": "Active"
214            },
215            "name": "Global Lease Group"
216          }
217        ],
218        "costCenterFilterType": "ALL",
219        "costCenters": [
220          {
221            "id": 14001,
222            "displayId": "CC-001",
223            "status": {
224              "name": "ACTIVE",
225              "captionKey": "enum.objectStatus.active",
226              "active": true,
227              "caption": "Active"
228            },
229            "name": "Cost Center A"
230          }
231        ],
232        "profitCenterFilterType": "ALL",
233        "profitCenters": [
234          {
235            "id": 9001,
236            "displayId": "PC-001",
237            "status": {
238              "name": "ACTIVE",
239              "captionKey": "enum.objectStatus.active",
240              "active": true,
241              "caption": "Active"
242            },
243            "name": "North Region Profit Center",
244            "validTo": "2025-12-31",
245            "erpSystemId": 101,
246            "erpSystemDisplayId": "SAP-01"
247          }
248        ],
249        "wbsFilterType": "ALL",
250        "wbses": [
251          {
252            "id": 1001,
253            "displayId": "WBS-2025-001",
254            "status": {
255              "name": "ACTIVE",
256              "captionKey": "enum.objectStatus.active",
257              "active": true,
258              "caption": "Active"
259            },
260            "name": "Main Project WBS"
261          }
262        ],
263        "businessAreaFilterType": "ALL",
264        "businessAreas": [
265          {
266            "id": 3001,
267            "displayId": "BA-2025-001",
268            "status": {
269              "name": "ACTIVE",
270              "captionKey": "enum.objectStatus.active",
271              "active": true,
272              "caption": "Active"
273            },
274            "name": "North America Operations"
275          }
276        ],
277        "functionalAreaFilterType": "ALL",
278        "functionalAreas": [
279          {
280            "id": 2001,
281            "displayId": "FA-2025-001",
282            "status": {
283              "name": "ACTIVE",
284              "captionKey": "enum.objectStatus.active",
285              "active": true,
286              "caption": "Active"
287            },
288            "name": "Accounting Department"
289          }
290        ]
291      }
292    },
293    "tasks": [
294      {
295        "id": 0,
296        "queueTime": "2019-08-24T14:15:22Z",
297        "startTime": "2019-08-24T14:15:22Z",
298        "endTime": "2019-08-24T14:15:22Z",
299        "interruptedAt": "2019-08-24T14:15:22Z",
300        "recoveredAt": "2019-08-24T14:15:22Z",
301        "status": "CREATED",
302        "recover": true,
303        "interrupted": true,
304        "interruptionMessage": "string",
305        "errorMessage": "string",
306        "reportJobId": 0,
307        "unitIds": [
308          0
309        ],
310        "jsonFileStorageId": "string",
311        "jsonDocStoreIds": [
312          0
313        ]
314      }
315    ],
316    "docStoreId": 0
317  }
318]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": [
 15    {
 16      "id": 0,
 17      "taskCount": 0,
 18      "failedTaskCount": 0,
 19      "doneTaskCount": 0,
 20      "inProgressTaskCount": 0,
 21      "cancelledTaskCount": 0,
 22      "errorMessage": "string",
 23      "executor": "SCHEDULER",
 24      "scheduleJobId": 0,
 25      "batchSize": 1000,
 26      "totalObjectCount": 0,
 27      "profileId": 0,
 28      "readOnly": true,
 29      "status": "CREATED",
 30      "fileStorageId": "string",
 31      "generatingExportFile": true,
 32      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33      "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 34      "input": {
 35        "id": 0,
 36        "accountingStandardType": "GAAP",
 37        "classifications": [
 38          "NON_LEASE"
 39        ],
 40        "fromYear": 0,
 41        "fromPeriod": {
 42          "id": 0,
 43          "displayId": "string",
 44          "status": "CREATED",
 45          "day": 0,
 46          "year": 0,
 47          "month": 0,
 48          "postingPeriod": 0,
 49          "yearShift": 0
 50        },
 51        "toYear": 0,
 52        "toPeriod": {
 53          "id": 0,
 54          "displayId": "string",
 55          "status": "CREATED",
 56          "day": 0,
 57          "year": 0,
 58          "month": 0,
 59          "postingPeriod": 0,
 60          "yearShift": 0
 61        },
 62        "fromDate": "2019-08-24",
 63        "toDate": "2019-08-24",
 64        "postingType": "ALL",
 65        "externalStatusFilterType": "ALL",
 66        "externalStatuses": [
 67          "NA"
 68        ],
 69        "internalStatusFilterType": "ALL",
 70        "internalStatuses": [
 71          "NA"
 72        ],
 73        "listObjectType": "ACTIVATION_GROUP",
 74        "objectList": [
 75          {
 76            "id": 0,
 77            "displayId": "string",
 78            "name": "string"
 79          }
 80        ],
 81        "migratedFilterType": "MIGRATED",
 82        "internalAssetClassFilterType": "ALL",
 83        "internalAssetClasses": [
 84          {
 85            "id": 10000001,
 86            "displayId": "IAC-001",
 87            "status": {
 88              "name": "ACTIVE",
 89              "captionKey": "enum.objectStatus.active",
 90              "active": true,
 91              "caption": "Active"
 92            },
 93            "name": "Machinery and Equipment",
 94            "assetClassType": "PROPERTY",
 95            "infiniteUsefulLife": false
 96          }
 97        ],
 98        "businessAreaFilterType": "ALL",
 99        "businessAreas": [
100          {
101            "id": 3001,
102            "displayId": "BA-2025-001",
103            "status": {
104              "name": "ACTIVE",
105              "captionKey": "enum.objectStatus.active",
106              "active": true,
107              "caption": "Active"
108            },
109            "name": "North America Operations"
110          }
111        ],
112        "functionalAreaFilterType": "ALL",
113        "functionalAreas": [
114          {
115            "id": 2001,
116            "displayId": "FA-2025-001",
117            "status": {
118              "name": "ACTIVE",
119              "captionKey": "enum.objectStatus.active",
120              "active": true,
121              "caption": "Active"
122            },
123            "name": "Accounting Department"
124          }
125        ]
126      },
127      "filter": {
128        "id": 0,
129        "name": "string",
130        "principalPositionType": "LESSEE",
131        "calendarType": "REGULAR_CALENDAR",
132        "fiscalYearVariant": {
133          "id": "string",
134          "displayId": "Euro"
135        },
136        "profileId": 0,
137        "jobId": 0,
138        "objectList": [
139          {
140            "id": "string",
141            "displayId": "Euro"
142          }
143        ],
144        "filterTypes": {
145          "erpSystemFilterType": "ALL",
146          "erpSystems": [
147            {
148              "id": 0,
149              "displayId": "string",
150              "status": "CREATED",
151              "name": "string",
152              "type": "NAKISA",
153              "sapVersion": "ECC_EHP5"
154            }
155          ],
156          "leaseAreaFilterType": "ALL",
157          "leaseAreas": [
158            {
159              "id": 10000001,
160              "displayId": "0001",
161              "status": {
162                "name": "ACTIVE",
163                "captionKey": "enum.objectStatus.active",
164                "active": true,
165                "caption": "Active"
166              },
167              "name": "Global Lease Area"
168            }
169          ],
170          "businessUnitFilterType": "ALL",
171          "businessUnits": [
172            {
173              "id": 10000001,
174              "displayId": "BU0001",
175              "status": {
176                "name": "ACTIVE",
177                "captionKey": "enum.objectStatus.active",
178                "active": true,
179                "caption": "Active"
180              },
181              "name": "North America Business Unit"
182            }
183          ],
184          "companyFilterType": "ALL",
185          "companies": [
186            {
187              "id": 10000006,
188              "displayId": "1005",
189              "status": {
190                "name": "ACTIVE",
191                "captionKey": "enum.objectStatus.active",
192                "active": true,
193                "caption": "Active"
194              },
195              "erpSystemId": 10000001,
196              "erpSystemDisplayId": "FINQ8S-300",
197              "countryId": 10000095,
198              "countryDisplayId": "CA",
199              "postingPeriodVariantId": 0,
200              "fiscalVariantId": 0
201            }
202          ],
203          "leaseDepartmentFilterType": "ALL",
204          "leaseDepartments": [
205            {
206              "id": 300001,
207              "displayId": "DEP-01",
208              "status": {
209                "name": "ACTIVE",
210                "captionKey": "enum.objectStatus.active",
211                "active": true,
212                "caption": "Active"
213              },
214              "name": "Finance Department"
215            }
216          ],
217          "leaseGroupFilterType": "ALL",
218          "leaseGroups": [
219            {
220              "id": 60000001,
221              "displayId": "LG-001",
222              "status": {
223                "name": "ACTIVE",
224                "captionKey": "enum.objectStatus.active",
225                "active": true,
226                "caption": "Active"
227              },
228              "name": "Global Lease Group"
229            }
230          ],
231          "costCenterFilterType": "ALL",
232          "costCenters": [
233            {
234              "id": 14001,
235              "displayId": "CC-001",
236              "status": {
237                "name": "ACTIVE",
238                "captionKey": "enum.objectStatus.active",
239                "active": true,
240                "caption": "Active"
241              },
242              "name": "Cost Center A"
243            }
244          ],
245          "profitCenterFilterType": "ALL",
246          "profitCenters": [
247            {
248              "id": 9001,
249              "displayId": "PC-001",
250              "status": {
251                "name": "ACTIVE",
252                "captionKey": "enum.objectStatus.active",
253                "active": true,
254                "caption": "Active"
255              },
256              "name": "North Region Profit Center",
257              "validTo": "2025-12-31",
258              "erpSystemId": 101,
259              "erpSystemDisplayId": "SAP-01"
260            }
261          ],
262          "wbsFilterType": "ALL",
263          "wbses": [
264            {
265              "id": 1001,
266              "displayId": "WBS-2025-001",
267              "status": {
268                "name": "ACTIVE",
269                "captionKey": "enum.objectStatus.active",
270                "active": true,
271                "caption": "Active"
272              },
273              "name": "Main Project WBS"
274            }
275          ],
276          "businessAreaFilterType": "ALL",
277          "businessAreas": [
278            {
279              "id": 3001,
280              "displayId": "BA-2025-001",
281              "status": {
282                "name": "ACTIVE",
283                "captionKey": "enum.objectStatus.active",
284                "active": true,
285                "caption": "Active"
286              },
287              "name": "North America Operations"
288            }
289          ],
290          "functionalAreaFilterType": "ALL",
291          "functionalAreas": [
292            {
293              "id": 2001,
294              "displayId": "FA-2025-001",
295              "status": {
296                "name": "ACTIVE",
297                "captionKey": "enum.objectStatus.active",
298                "active": true,
299                "caption": "Active"
300              },
301              "name": "Accounting Department"
302            }
303          ]
304        }
305      },
306      "tasks": [
307        {
308          "id": 0,
309          "queueTime": "2019-08-24T14:15:22Z",
310          "startTime": "2019-08-24T14:15:22Z",
311          "endTime": "2019-08-24T14:15:22Z",
312          "interruptedAt": "2019-08-24T14:15:22Z",
313          "recoveredAt": "2019-08-24T14:15:22Z",
314          "status": "CREATED",
315          "recover": true,
316          "interrupted": true,
317          "interruptionMessage": "string",
318          "errorMessage": "string",
319          "reportJobId": 0,
320          "unitIds": [
321            0
322          ],
323          "jsonFileStorageId": "string",
324          "jsonDocStoreIds": [
325            0
326          ]
327        }
328      ],
329      "docStoreId": 0
330    }
331  ]
332}

Create Or Update

HTTP Request

PUT /api/v1/periodic_posting_status_reports/jobs/createOrUpdate

Parameters

Name

In

Type

Required

Description

body

body

PeriodicPostingStatusReportJobDto

true

none

Body Parameters

  1{
  2  "id": 0,
  3  "taskCount": 0,
  4  "failedTaskCount": 0,
  5  "doneTaskCount": 0,
  6  "inProgressTaskCount": 0,
  7  "cancelledTaskCount": 0,
  8  "errorMessage": "string",
  9  "executor": "SCHEDULER",
 10  "scheduleJobId": 0,
 11  "batchSize": 1000,
 12  "totalObjectCount": 0,
 13  "profileId": 0,
 14  "readOnly": true,
 15  "status": "CREATED",
 16  "fileStorageId": "string",
 17  "generatingExportFile": true,
 18  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 19  "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 20  "input": {
 21    "id": 0,
 22    "accountingStandardType": "GAAP",
 23    "classifications": [
 24      "NON_LEASE"
 25    ],
 26    "fromYear": 0,
 27    "fromPeriod": {
 28      "id": 0,
 29      "displayId": "string",
 30      "status": "CREATED",
 31      "day": 0,
 32      "year": 0,
 33      "month": 0,
 34      "postingPeriod": 0,
 35      "yearShift": 0
 36    },
 37    "toYear": 0,
 38    "toPeriod": {
 39      "id": 0,
 40      "displayId": "string",
 41      "status": "CREATED",
 42      "day": 0,
 43      "year": 0,
 44      "month": 0,
 45      "postingPeriod": 0,
 46      "yearShift": 0
 47    },
 48    "fromDate": "2019-08-24",
 49    "toDate": "2019-08-24",
 50    "postingType": "ALL",
 51    "externalStatusFilterType": "ALL",
 52    "externalStatuses": [
 53      "NA"
 54    ],
 55    "internalStatusFilterType": "ALL",
 56    "internalStatuses": [
 57      "NA"
 58    ],
 59    "listObjectType": "ACTIVATION_GROUP",
 60    "objectList": [
 61      {
 62        "id": 0,
 63        "displayId": "string",
 64        "name": "string"
 65      }
 66    ],
 67    "migratedFilterType": "MIGRATED",
 68    "internalAssetClassFilterType": "ALL",
 69    "internalAssetClasses": [
 70      {
 71        "id": 10000001,
 72        "displayId": "IAC-001",
 73        "status": {
 74          "name": "ACTIVE",
 75          "captionKey": "enum.objectStatus.active",
 76          "active": true,
 77          "caption": "Active"
 78        },
 79        "name": "Machinery and Equipment",
 80        "assetClassType": "PROPERTY",
 81        "infiniteUsefulLife": false
 82      }
 83    ],
 84    "businessAreaFilterType": "ALL",
 85    "businessAreas": [
 86      {
 87        "id": 3001,
 88        "displayId": "BA-2025-001",
 89        "status": {
 90          "name": "ACTIVE",
 91          "captionKey": "enum.objectStatus.active",
 92          "active": true,
 93          "caption": "Active"
 94        },
 95        "name": "North America Operations"
 96      }
 97    ],
 98    "functionalAreaFilterType": "ALL",
 99    "functionalAreas": [
100      {
101        "id": 2001,
102        "displayId": "FA-2025-001",
103        "status": {
104          "name": "ACTIVE",
105          "captionKey": "enum.objectStatus.active",
106          "active": true,
107          "caption": "Active"
108        },
109        "name": "Accounting Department"
110      }
111    ]
112  },
113  "filter": {
114    "id": 0,
115    "name": "string",
116    "principalPositionType": "LESSEE",
117    "calendarType": "REGULAR_CALENDAR",
118    "fiscalYearVariant": {
119      "id": "string",
120      "displayId": "Euro"
121    },
122    "profileId": 0,
123    "jobId": 0,
124    "objectList": [
125      {
126        "id": "string",
127        "displayId": "Euro"
128      }
129    ],
130    "filterTypes": {
131      "erpSystemFilterType": "ALL",
132      "erpSystems": [
133        {
134          "id": 0,
135          "displayId": "string",
136          "status": "CREATED",
137          "name": "string",
138          "type": "NAKISA",
139          "sapVersion": "ECC_EHP5"
140        }
141      ],
142      "leaseAreaFilterType": "ALL",
143      "leaseAreas": [
144        {
145          "id": 10000001,
146          "displayId": "0001",
147          "status": {
148            "name": "ACTIVE",
149            "captionKey": "enum.objectStatus.active",
150            "active": true,
151            "caption": "Active"
152          },
153          "name": "Global Lease Area"
154        }
155      ],
156      "businessUnitFilterType": "ALL",
157      "businessUnits": [
158        {
159          "id": 10000001,
160          "displayId": "BU0001",
161          "status": {
162            "name": "ACTIVE",
163            "captionKey": "enum.objectStatus.active",
164            "active": true,
165            "caption": "Active"
166          },
167          "name": "North America Business Unit"
168        }
169      ],
170      "companyFilterType": "ALL",
171      "companies": [
172        {
173          "id": 10000006,
174          "displayId": "1005",
175          "status": {
176            "name": "ACTIVE",
177            "captionKey": "enum.objectStatus.active",
178            "active": true,
179            "caption": "Active"
180          },
181          "erpSystemId": 10000001,
182          "erpSystemDisplayId": "FINQ8S-300",
183          "countryId": 10000095,
184          "countryDisplayId": "CA",
185          "postingPeriodVariantId": 0,
186          "fiscalVariantId": 0
187        }
188      ],
189      "leaseDepartmentFilterType": "ALL",
190      "leaseDepartments": [
191        {
192          "id": 300001,
193          "displayId": "DEP-01",
194          "status": {
195            "name": "ACTIVE",
196            "captionKey": "enum.objectStatus.active",
197            "active": true,
198            "caption": "Active"
199          },
200          "name": "Finance Department"
201        }
202      ],
203      "leaseGroupFilterType": "ALL",
204      "leaseGroups": [
205        {
206          "id": 60000001,
207          "displayId": "LG-001",
208          "status": {
209            "name": "ACTIVE",
210            "captionKey": "enum.objectStatus.active",
211            "active": true,
212            "caption": "Active"
213          },
214          "name": "Global Lease Group"
215        }
216      ],
217      "costCenterFilterType": "ALL",
218      "costCenters": [
219        {
220          "id": 14001,
221          "displayId": "CC-001",
222          "status": {
223            "name": "ACTIVE",
224            "captionKey": "enum.objectStatus.active",
225            "active": true,
226            "caption": "Active"
227          },
228          "name": "Cost Center A"
229        }
230      ],
231      "profitCenterFilterType": "ALL",
232      "profitCenters": [
233        {
234          "id": 9001,
235          "displayId": "PC-001",
236          "status": {
237            "name": "ACTIVE",
238            "captionKey": "enum.objectStatus.active",
239            "active": true,
240            "caption": "Active"
241          },
242          "name": "North Region Profit Center",
243          "validTo": "2025-12-31",
244          "erpSystemId": 101,
245          "erpSystemDisplayId": "SAP-01"
246        }
247      ],
248      "wbsFilterType": "ALL",
249      "wbses": [
250        {
251          "id": 1001,
252          "displayId": "WBS-2025-001",
253          "status": {
254            "name": "ACTIVE",
255            "captionKey": "enum.objectStatus.active",
256            "active": true,
257            "caption": "Active"
258          },
259          "name": "Main Project WBS"
260        }
261      ],
262      "businessAreaFilterType": "ALL",
263      "businessAreas": [
264        {
265          "id": 3001,
266          "displayId": "BA-2025-001",
267          "status": {
268            "name": "ACTIVE",
269            "captionKey": "enum.objectStatus.active",
270            "active": true,
271            "caption": "Active"
272          },
273          "name": "North America Operations"
274        }
275      ],
276      "functionalAreaFilterType": "ALL",
277      "functionalAreas": [
278        {
279          "id": 2001,
280          "displayId": "FA-2025-001",
281          "status": {
282            "name": "ACTIVE",
283            "captionKey": "enum.objectStatus.active",
284            "active": true,
285            "caption": "Active"
286          },
287          "name": "Accounting Department"
288        }
289      ]
290    }
291  },
292  "tasks": [
293    {
294      "id": 0,
295      "queueTime": "2019-08-24T14:15:22Z",
296      "startTime": "2019-08-24T14:15:22Z",
297      "endTime": "2019-08-24T14:15:22Z",
298      "interruptedAt": "2019-08-24T14:15:22Z",
299      "recoveredAt": "2019-08-24T14:15:22Z",
300      "status": "CREATED",
301      "recover": true,
302      "interrupted": true,
303      "interruptionMessage": "string",
304      "errorMessage": "string",
305      "reportJobId": 0,
306      "unitIds": [
307        0
308      ],
309      "jsonFileStorageId": "string",
310      "jsonDocStoreIds": [
311        0
312      ]
313    }
314  ],
315  "docStoreId": 0
316}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": {
 15    "id": 0,
 16    "taskCount": 0,
 17    "failedTaskCount": 0,
 18    "doneTaskCount": 0,
 19    "inProgressTaskCount": 0,
 20    "cancelledTaskCount": 0,
 21    "errorMessage": "string",
 22    "executor": "SCHEDULER",
 23    "scheduleJobId": 0,
 24    "batchSize": 1000,
 25    "totalObjectCount": 0,
 26    "profileId": 0,
 27    "readOnly": true,
 28    "status": "CREATED",
 29    "fileStorageId": "string",
 30    "generatingExportFile": true,
 31    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 32    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33    "input": {
 34      "id": 0,
 35      "accountingStandardType": "GAAP",
 36      "classifications": [
 37        "NON_LEASE"
 38      ],
 39      "fromYear": 0,
 40      "fromPeriod": {
 41        "id": 0,
 42        "displayId": "string",
 43        "status": "CREATED",
 44        "day": 0,
 45        "year": 0,
 46        "month": 0,
 47        "postingPeriod": 0,
 48        "yearShift": 0
 49      },
 50      "toYear": 0,
 51      "toPeriod": {
 52        "id": 0,
 53        "displayId": "string",
 54        "status": "CREATED",
 55        "day": 0,
 56        "year": 0,
 57        "month": 0,
 58        "postingPeriod": 0,
 59        "yearShift": 0
 60      },
 61      "fromDate": "2019-08-24",
 62      "toDate": "2019-08-24",
 63      "postingType": "ALL",
 64      "externalStatusFilterType": "ALL",
 65      "externalStatuses": [
 66        "NA"
 67      ],
 68      "internalStatusFilterType": "ALL",
 69      "internalStatuses": [
 70        "NA"
 71      ],
 72      "listObjectType": "ACTIVATION_GROUP",
 73      "objectList": [
 74        {
 75          "id": 0,
 76          "displayId": "string",
 77          "name": "string"
 78        }
 79      ],
 80      "migratedFilterType": "MIGRATED",
 81      "internalAssetClassFilterType": "ALL",
 82      "internalAssetClasses": [
 83        {
 84          "id": 10000001,
 85          "displayId": "IAC-001",
 86          "status": {
 87            "name": "ACTIVE",
 88            "captionKey": "enum.objectStatus.active",
 89            "active": true,
 90            "caption": "Active"
 91          },
 92          "name": "Machinery and Equipment",
 93          "assetClassType": "PROPERTY",
 94          "infiniteUsefulLife": false
 95        }
 96      ],
 97      "businessAreaFilterType": "ALL",
 98      "businessAreas": [
 99        {
100          "id": 3001,
101          "displayId": "BA-2025-001",
102          "status": {
103            "name": "ACTIVE",
104            "captionKey": "enum.objectStatus.active",
105            "active": true,
106            "caption": "Active"
107          },
108          "name": "North America Operations"
109        }
110      ],
111      "functionalAreaFilterType": "ALL",
112      "functionalAreas": [
113        {
114          "id": 2001,
115          "displayId": "FA-2025-001",
116          "status": {
117            "name": "ACTIVE",
118            "captionKey": "enum.objectStatus.active",
119            "active": true,
120            "caption": "Active"
121          },
122          "name": "Accounting Department"
123        }
124      ]
125    },
126    "filter": {
127      "id": 0,
128      "name": "string",
129      "principalPositionType": "LESSEE",
130      "calendarType": "REGULAR_CALENDAR",
131      "fiscalYearVariant": {
132        "id": "string",
133        "displayId": "Euro"
134      },
135      "profileId": 0,
136      "jobId": 0,
137      "objectList": [
138        {
139          "id": "string",
140          "displayId": "Euro"
141        }
142      ],
143      "filterTypes": {
144        "erpSystemFilterType": "ALL",
145        "erpSystems": [
146          {
147            "id": 0,
148            "displayId": "string",
149            "status": "CREATED",
150            "name": "string",
151            "type": "NAKISA",
152            "sapVersion": "ECC_EHP5"
153          }
154        ],
155        "leaseAreaFilterType": "ALL",
156        "leaseAreas": [
157          {
158            "id": 10000001,
159            "displayId": "0001",
160            "status": {
161              "name": "ACTIVE",
162              "captionKey": "enum.objectStatus.active",
163              "active": true,
164              "caption": "Active"
165            },
166            "name": "Global Lease Area"
167          }
168        ],
169        "businessUnitFilterType": "ALL",
170        "businessUnits": [
171          {
172            "id": 10000001,
173            "displayId": "BU0001",
174            "status": {
175              "name": "ACTIVE",
176              "captionKey": "enum.objectStatus.active",
177              "active": true,
178              "caption": "Active"
179            },
180            "name": "North America Business Unit"
181          }
182        ],
183        "companyFilterType": "ALL",
184        "companies": [
185          {
186            "id": 10000006,
187            "displayId": "1005",
188            "status": {
189              "name": "ACTIVE",
190              "captionKey": "enum.objectStatus.active",
191              "active": true,
192              "caption": "Active"
193            },
194            "erpSystemId": 10000001,
195            "erpSystemDisplayId": "FINQ8S-300",
196            "countryId": 10000095,
197            "countryDisplayId": "CA",
198            "postingPeriodVariantId": 0,
199            "fiscalVariantId": 0
200          }
201        ],
202        "leaseDepartmentFilterType": "ALL",
203        "leaseDepartments": [
204          {
205            "id": 300001,
206            "displayId": "DEP-01",
207            "status": {
208              "name": "ACTIVE",
209              "captionKey": "enum.objectStatus.active",
210              "active": true,
211              "caption": "Active"
212            },
213            "name": "Finance Department"
214          }
215        ],
216        "leaseGroupFilterType": "ALL",
217        "leaseGroups": [
218          {
219            "id": 60000001,
220            "displayId": "LG-001",
221            "status": {
222              "name": "ACTIVE",
223              "captionKey": "enum.objectStatus.active",
224              "active": true,
225              "caption": "Active"
226            },
227            "name": "Global Lease Group"
228          }
229        ],
230        "costCenterFilterType": "ALL",
231        "costCenters": [
232          {
233            "id": 14001,
234            "displayId": "CC-001",
235            "status": {
236              "name": "ACTIVE",
237              "captionKey": "enum.objectStatus.active",
238              "active": true,
239              "caption": "Active"
240            },
241            "name": "Cost Center A"
242          }
243        ],
244        "profitCenterFilterType": "ALL",
245        "profitCenters": [
246          {
247            "id": 9001,
248            "displayId": "PC-001",
249            "status": {
250              "name": "ACTIVE",
251              "captionKey": "enum.objectStatus.active",
252              "active": true,
253              "caption": "Active"
254            },
255            "name": "North Region Profit Center",
256            "validTo": "2025-12-31",
257            "erpSystemId": 101,
258            "erpSystemDisplayId": "SAP-01"
259          }
260        ],
261        "wbsFilterType": "ALL",
262        "wbses": [
263          {
264            "id": 1001,
265            "displayId": "WBS-2025-001",
266            "status": {
267              "name": "ACTIVE",
268              "captionKey": "enum.objectStatus.active",
269              "active": true,
270              "caption": "Active"
271            },
272            "name": "Main Project WBS"
273          }
274        ],
275        "businessAreaFilterType": "ALL",
276        "businessAreas": [
277          {
278            "id": 3001,
279            "displayId": "BA-2025-001",
280            "status": {
281              "name": "ACTIVE",
282              "captionKey": "enum.objectStatus.active",
283              "active": true,
284              "caption": "Active"
285            },
286            "name": "North America Operations"
287          }
288        ],
289        "functionalAreaFilterType": "ALL",
290        "functionalAreas": [
291          {
292            "id": 2001,
293            "displayId": "FA-2025-001",
294            "status": {
295              "name": "ACTIVE",
296              "captionKey": "enum.objectStatus.active",
297              "active": true,
298              "caption": "Active"
299            },
300            "name": "Accounting Department"
301          }
302        ]
303      }
304    },
305    "tasks": [
306      {
307        "id": 0,
308        "queueTime": "2019-08-24T14:15:22Z",
309        "startTime": "2019-08-24T14:15:22Z",
310        "endTime": "2019-08-24T14:15:22Z",
311        "interruptedAt": "2019-08-24T14:15:22Z",
312        "recoveredAt": "2019-08-24T14:15:22Z",
313        "status": "CREATED",
314        "recover": true,
315        "interrupted": true,
316        "interruptionMessage": "string",
317        "errorMessage": "string",
318        "reportJobId": 0,
319        "unitIds": [
320          0
321        ],
322        "jsonFileStorageId": "string",
323        "jsonDocStoreIds": [
324          0
325        ]
326      }
327    ],
328    "docStoreId": 0
329  }
330}

Bulk Update

HTTP Request

PUT /api/v1/periodic_posting_status_reports/jobs/bulk

Parameters

Name

In

Type

Required

Description

body

body

PeriodicPostingStatusReportJobDto

true

none

Body Parameters

  1[
  2  {
  3    "id": 0,
  4    "taskCount": 0,
  5    "failedTaskCount": 0,
  6    "doneTaskCount": 0,
  7    "inProgressTaskCount": 0,
  8    "cancelledTaskCount": 0,
  9    "errorMessage": "string",
 10    "executor": "SCHEDULER",
 11    "scheduleJobId": 0,
 12    "batchSize": 1000,
 13    "totalObjectCount": 0,
 14    "profileId": 0,
 15    "readOnly": true,
 16    "status": "CREATED",
 17    "fileStorageId": "string",
 18    "generatingExportFile": true,
 19    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 20    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 21    "input": {
 22      "id": 0,
 23      "accountingStandardType": "GAAP",
 24      "classifications": [
 25        "NON_LEASE"
 26      ],
 27      "fromYear": 0,
 28      "fromPeriod": {
 29        "id": 0,
 30        "displayId": "string",
 31        "status": "CREATED",
 32        "day": 0,
 33        "year": 0,
 34        "month": 0,
 35        "postingPeriod": 0,
 36        "yearShift": 0
 37      },
 38      "toYear": 0,
 39      "toPeriod": {
 40        "id": 0,
 41        "displayId": "string",
 42        "status": "CREATED",
 43        "day": 0,
 44        "year": 0,
 45        "month": 0,
 46        "postingPeriod": 0,
 47        "yearShift": 0
 48      },
 49      "fromDate": "2019-08-24",
 50      "toDate": "2019-08-24",
 51      "postingType": "ALL",
 52      "externalStatusFilterType": "ALL",
 53      "externalStatuses": [
 54        "NA"
 55      ],
 56      "internalStatusFilterType": "ALL",
 57      "internalStatuses": [
 58        "NA"
 59      ],
 60      "listObjectType": "ACTIVATION_GROUP",
 61      "objectList": [
 62        {
 63          "id": 0,
 64          "displayId": "string",
 65          "name": "string"
 66        }
 67      ],
 68      "migratedFilterType": "MIGRATED",
 69      "internalAssetClassFilterType": "ALL",
 70      "internalAssetClasses": [
 71        {
 72          "id": 10000001,
 73          "displayId": "IAC-001",
 74          "status": {
 75            "name": "ACTIVE",
 76            "captionKey": "enum.objectStatus.active",
 77            "active": true,
 78            "caption": "Active"
 79          },
 80          "name": "Machinery and Equipment",
 81          "assetClassType": "PROPERTY",
 82          "infiniteUsefulLife": false
 83        }
 84      ],
 85      "businessAreaFilterType": "ALL",
 86      "businessAreas": [
 87        {
 88          "id": 3001,
 89          "displayId": "BA-2025-001",
 90          "status": {
 91            "name": "ACTIVE",
 92            "captionKey": "enum.objectStatus.active",
 93            "active": true,
 94            "caption": "Active"
 95          },
 96          "name": "North America Operations"
 97        }
 98      ],
 99      "functionalAreaFilterType": "ALL",
100      "functionalAreas": [
101        {
102          "id": 2001,
103          "displayId": "FA-2025-001",
104          "status": {
105            "name": "ACTIVE",
106            "captionKey": "enum.objectStatus.active",
107            "active": true,
108            "caption": "Active"
109          },
110          "name": "Accounting Department"
111        }
112      ]
113    },
114    "filter": {
115      "id": 0,
116      "name": "string",
117      "principalPositionType": "LESSEE",
118      "calendarType": "REGULAR_CALENDAR",
119      "fiscalYearVariant": {
120        "id": "string",
121        "displayId": "Euro"
122      },
123      "profileId": 0,
124      "jobId": 0,
125      "objectList": [
126        {
127          "id": "string",
128          "displayId": "Euro"
129        }
130      ],
131      "filterTypes": {
132        "erpSystemFilterType": "ALL",
133        "erpSystems": [
134          {
135            "id": 0,
136            "displayId": "string",
137            "status": "CREATED",
138            "name": "string",
139            "type": "NAKISA",
140            "sapVersion": "ECC_EHP5"
141          }
142        ],
143        "leaseAreaFilterType": "ALL",
144        "leaseAreas": [
145          {
146            "id": 10000001,
147            "displayId": "0001",
148            "status": {
149              "name": "ACTIVE",
150              "captionKey": "enum.objectStatus.active",
151              "active": true,
152              "caption": "Active"
153            },
154            "name": "Global Lease Area"
155          }
156        ],
157        "businessUnitFilterType": "ALL",
158        "businessUnits": [
159          {
160            "id": 10000001,
161            "displayId": "BU0001",
162            "status": {
163              "name": "ACTIVE",
164              "captionKey": "enum.objectStatus.active",
165              "active": true,
166              "caption": "Active"
167            },
168            "name": "North America Business Unit"
169          }
170        ],
171        "companyFilterType": "ALL",
172        "companies": [
173          {
174            "id": 10000006,
175            "displayId": "1005",
176            "status": {
177              "name": "ACTIVE",
178              "captionKey": "enum.objectStatus.active",
179              "active": true,
180              "caption": "Active"
181            },
182            "erpSystemId": 10000001,
183            "erpSystemDisplayId": "FINQ8S-300",
184            "countryId": 10000095,
185            "countryDisplayId": "CA",
186            "postingPeriodVariantId": 0,
187            "fiscalVariantId": 0
188          }
189        ],
190        "leaseDepartmentFilterType": "ALL",
191        "leaseDepartments": [
192          {
193            "id": 300001,
194            "displayId": "DEP-01",
195            "status": {
196              "name": "ACTIVE",
197              "captionKey": "enum.objectStatus.active",
198              "active": true,
199              "caption": "Active"
200            },
201            "name": "Finance Department"
202          }
203        ],
204        "leaseGroupFilterType": "ALL",
205        "leaseGroups": [
206          {
207            "id": 60000001,
208            "displayId": "LG-001",
209            "status": {
210              "name": "ACTIVE",
211              "captionKey": "enum.objectStatus.active",
212              "active": true,
213              "caption": "Active"
214            },
215            "name": "Global Lease Group"
216          }
217        ],
218        "costCenterFilterType": "ALL",
219        "costCenters": [
220          {
221            "id": 14001,
222            "displayId": "CC-001",
223            "status": {
224              "name": "ACTIVE",
225              "captionKey": "enum.objectStatus.active",
226              "active": true,
227              "caption": "Active"
228            },
229            "name": "Cost Center A"
230          }
231        ],
232        "profitCenterFilterType": "ALL",
233        "profitCenters": [
234          {
235            "id": 9001,
236            "displayId": "PC-001",
237            "status": {
238              "name": "ACTIVE",
239              "captionKey": "enum.objectStatus.active",
240              "active": true,
241              "caption": "Active"
242            },
243            "name": "North Region Profit Center",
244            "validTo": "2025-12-31",
245            "erpSystemId": 101,
246            "erpSystemDisplayId": "SAP-01"
247          }
248        ],
249        "wbsFilterType": "ALL",
250        "wbses": [
251          {
252            "id": 1001,
253            "displayId": "WBS-2025-001",
254            "status": {
255              "name": "ACTIVE",
256              "captionKey": "enum.objectStatus.active",
257              "active": true,
258              "caption": "Active"
259            },
260            "name": "Main Project WBS"
261          }
262        ],
263        "businessAreaFilterType": "ALL",
264        "businessAreas": [
265          {
266            "id": 3001,
267            "displayId": "BA-2025-001",
268            "status": {
269              "name": "ACTIVE",
270              "captionKey": "enum.objectStatus.active",
271              "active": true,
272              "caption": "Active"
273            },
274            "name": "North America Operations"
275          }
276        ],
277        "functionalAreaFilterType": "ALL",
278        "functionalAreas": [
279          {
280            "id": 2001,
281            "displayId": "FA-2025-001",
282            "status": {
283              "name": "ACTIVE",
284              "captionKey": "enum.objectStatus.active",
285              "active": true,
286              "caption": "Active"
287            },
288            "name": "Accounting Department"
289          }
290        ]
291      }
292    },
293    "tasks": [
294      {
295        "id": 0,
296        "queueTime": "2019-08-24T14:15:22Z",
297        "startTime": "2019-08-24T14:15:22Z",
298        "endTime": "2019-08-24T14:15:22Z",
299        "interruptedAt": "2019-08-24T14:15:22Z",
300        "recoveredAt": "2019-08-24T14:15:22Z",
301        "status": "CREATED",
302        "recover": true,
303        "interrupted": true,
304        "interruptionMessage": "string",
305        "errorMessage": "string",
306        "reportJobId": 0,
307        "unitIds": [
308          0
309        ],
310        "jsonFileStorageId": "string",
311        "jsonDocStoreIds": [
312          0
313        ]
314      }
315    ],
316    "docStoreId": 0
317  }
318]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": [
 15    {
 16      "id": 0,
 17      "taskCount": 0,
 18      "failedTaskCount": 0,
 19      "doneTaskCount": 0,
 20      "inProgressTaskCount": 0,
 21      "cancelledTaskCount": 0,
 22      "errorMessage": "string",
 23      "executor": "SCHEDULER",
 24      "scheduleJobId": 0,
 25      "batchSize": 1000,
 26      "totalObjectCount": 0,
 27      "profileId": 0,
 28      "readOnly": true,
 29      "status": "CREATED",
 30      "fileStorageId": "string",
 31      "generatingExportFile": true,
 32      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33      "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 34      "input": {
 35        "id": 0,
 36        "accountingStandardType": "GAAP",
 37        "classifications": [
 38          "NON_LEASE"
 39        ],
 40        "fromYear": 0,
 41        "fromPeriod": {
 42          "id": 0,
 43          "displayId": "string",
 44          "status": "CREATED",
 45          "day": 0,
 46          "year": 0,
 47          "month": 0,
 48          "postingPeriod": 0,
 49          "yearShift": 0
 50        },
 51        "toYear": 0,
 52        "toPeriod": {
 53          "id": 0,
 54          "displayId": "string",
 55          "status": "CREATED",
 56          "day": 0,
 57          "year": 0,
 58          "month": 0,
 59          "postingPeriod": 0,
 60          "yearShift": 0
 61        },
 62        "fromDate": "2019-08-24",
 63        "toDate": "2019-08-24",
 64        "postingType": "ALL",
 65        "externalStatusFilterType": "ALL",
 66        "externalStatuses": [
 67          "NA"
 68        ],
 69        "internalStatusFilterType": "ALL",
 70        "internalStatuses": [
 71          "NA"
 72        ],
 73        "listObjectType": "ACTIVATION_GROUP",
 74        "objectList": [
 75          {
 76            "id": 0,
 77            "displayId": "string",
 78            "name": "string"
 79          }
 80        ],
 81        "migratedFilterType": "MIGRATED",
 82        "internalAssetClassFilterType": "ALL",
 83        "internalAssetClasses": [
 84          {
 85            "id": 10000001,
 86            "displayId": "IAC-001",
 87            "status": {
 88              "name": "ACTIVE",
 89              "captionKey": "enum.objectStatus.active",
 90              "active": true,
 91              "caption": "Active"
 92            },
 93            "name": "Machinery and Equipment",
 94            "assetClassType": "PROPERTY",
 95            "infiniteUsefulLife": false
 96          }
 97        ],
 98        "businessAreaFilterType": "ALL",
 99        "businessAreas": [
100          {
101            "id": 3001,
102            "displayId": "BA-2025-001",
103            "status": {
104              "name": "ACTIVE",
105              "captionKey": "enum.objectStatus.active",
106              "active": true,
107              "caption": "Active"
108            },
109            "name": "North America Operations"
110          }
111        ],
112        "functionalAreaFilterType": "ALL",
113        "functionalAreas": [
114          {
115            "id": 2001,
116            "displayId": "FA-2025-001",
117            "status": {
118              "name": "ACTIVE",
119              "captionKey": "enum.objectStatus.active",
120              "active": true,
121              "caption": "Active"
122            },
123            "name": "Accounting Department"
124          }
125        ]
126      },
127      "filter": {
128        "id": 0,
129        "name": "string",
130        "principalPositionType": "LESSEE",
131        "calendarType": "REGULAR_CALENDAR",
132        "fiscalYearVariant": {
133          "id": "string",
134          "displayId": "Euro"
135        },
136        "profileId": 0,
137        "jobId": 0,
138        "objectList": [
139          {
140            "id": "string",
141            "displayId": "Euro"
142          }
143        ],
144        "filterTypes": {
145          "erpSystemFilterType": "ALL",
146          "erpSystems": [
147            {
148              "id": 0,
149              "displayId": "string",
150              "status": "CREATED",
151              "name": "string",
152              "type": "NAKISA",
153              "sapVersion": "ECC_EHP5"
154            }
155          ],
156          "leaseAreaFilterType": "ALL",
157          "leaseAreas": [
158            {
159              "id": 10000001,
160              "displayId": "0001",
161              "status": {
162                "name": "ACTIVE",
163                "captionKey": "enum.objectStatus.active",
164                "active": true,
165                "caption": "Active"
166              },
167              "name": "Global Lease Area"
168            }
169          ],
170          "businessUnitFilterType": "ALL",
171          "businessUnits": [
172            {
173              "id": 10000001,
174              "displayId": "BU0001",
175              "status": {
176                "name": "ACTIVE",
177                "captionKey": "enum.objectStatus.active",
178                "active": true,
179                "caption": "Active"
180              },
181              "name": "North America Business Unit"
182            }
183          ],
184          "companyFilterType": "ALL",
185          "companies": [
186            {
187              "id": 10000006,
188              "displayId": "1005",
189              "status": {
190                "name": "ACTIVE",
191                "captionKey": "enum.objectStatus.active",
192                "active": true,
193                "caption": "Active"
194              },
195              "erpSystemId": 10000001,
196              "erpSystemDisplayId": "FINQ8S-300",
197              "countryId": 10000095,
198              "countryDisplayId": "CA",
199              "postingPeriodVariantId": 0,
200              "fiscalVariantId": 0
201            }
202          ],
203          "leaseDepartmentFilterType": "ALL",
204          "leaseDepartments": [
205            {
206              "id": 300001,
207              "displayId": "DEP-01",
208              "status": {
209                "name": "ACTIVE",
210                "captionKey": "enum.objectStatus.active",
211                "active": true,
212                "caption": "Active"
213              },
214              "name": "Finance Department"
215            }
216          ],
217          "leaseGroupFilterType": "ALL",
218          "leaseGroups": [
219            {
220              "id": 60000001,
221              "displayId": "LG-001",
222              "status": {
223                "name": "ACTIVE",
224                "captionKey": "enum.objectStatus.active",
225                "active": true,
226                "caption": "Active"
227              },
228              "name": "Global Lease Group"
229            }
230          ],
231          "costCenterFilterType": "ALL",
232          "costCenters": [
233            {
234              "id": 14001,
235              "displayId": "CC-001",
236              "status": {
237                "name": "ACTIVE",
238                "captionKey": "enum.objectStatus.active",
239                "active": true,
240                "caption": "Active"
241              },
242              "name": "Cost Center A"
243            }
244          ],
245          "profitCenterFilterType": "ALL",
246          "profitCenters": [
247            {
248              "id": 9001,
249              "displayId": "PC-001",
250              "status": {
251                "name": "ACTIVE",
252                "captionKey": "enum.objectStatus.active",
253                "active": true,
254                "caption": "Active"
255              },
256              "name": "North Region Profit Center",
257              "validTo": "2025-12-31",
258              "erpSystemId": 101,
259              "erpSystemDisplayId": "SAP-01"
260            }
261          ],
262          "wbsFilterType": "ALL",
263          "wbses": [
264            {
265              "id": 1001,
266              "displayId": "WBS-2025-001",
267              "status": {
268                "name": "ACTIVE",
269                "captionKey": "enum.objectStatus.active",
270                "active": true,
271                "caption": "Active"
272              },
273              "name": "Main Project WBS"
274            }
275          ],
276          "businessAreaFilterType": "ALL",
277          "businessAreas": [
278            {
279              "id": 3001,
280              "displayId": "BA-2025-001",
281              "status": {
282                "name": "ACTIVE",
283                "captionKey": "enum.objectStatus.active",
284                "active": true,
285                "caption": "Active"
286              },
287              "name": "North America Operations"
288            }
289          ],
290          "functionalAreaFilterType": "ALL",
291          "functionalAreas": [
292            {
293              "id": 2001,
294              "displayId": "FA-2025-001",
295              "status": {
296                "name": "ACTIVE",
297                "captionKey": "enum.objectStatus.active",
298                "active": true,
299                "caption": "Active"
300              },
301              "name": "Accounting Department"
302            }
303          ]
304        }
305      },
306      "tasks": [
307        {
308          "id": 0,
309          "queueTime": "2019-08-24T14:15:22Z",
310          "startTime": "2019-08-24T14:15:22Z",
311          "endTime": "2019-08-24T14:15:22Z",
312          "interruptedAt": "2019-08-24T14:15:22Z",
313          "recoveredAt": "2019-08-24T14:15:22Z",
314          "status": "CREATED",
315          "recover": true,
316          "interrupted": true,
317          "interruptionMessage": "string",
318          "errorMessage": "string",
319          "reportJobId": 0,
320          "unitIds": [
321            0
322          ],
323          "jsonFileStorageId": "string",
324          "jsonDocStoreIds": [
325            0
326          ]
327        }
328      ],
329      "docStoreId": 0
330    }
331  ]
332}

Bulk Create

HTTP Request

POST /api/v1/periodic_posting_status_reports/jobs/bulk

Parameters

Name

In

Type

Required

Description

body

body

PeriodicPostingStatusReportJobDto

true

none

Body Parameters

  1[
  2  {
  3    "id": 0,
  4    "taskCount": 0,
  5    "failedTaskCount": 0,
  6    "doneTaskCount": 0,
  7    "inProgressTaskCount": 0,
  8    "cancelledTaskCount": 0,
  9    "errorMessage": "string",
 10    "executor": "SCHEDULER",
 11    "scheduleJobId": 0,
 12    "batchSize": 1000,
 13    "totalObjectCount": 0,
 14    "profileId": 0,
 15    "readOnly": true,
 16    "status": "CREATED",
 17    "fileStorageId": "string",
 18    "generatingExportFile": true,
 19    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 20    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 21    "input": {
 22      "id": 0,
 23      "accountingStandardType": "GAAP",
 24      "classifications": [
 25        "NON_LEASE"
 26      ],
 27      "fromYear": 0,
 28      "fromPeriod": {
 29        "id": 0,
 30        "displayId": "string",
 31        "status": "CREATED",
 32        "day": 0,
 33        "year": 0,
 34        "month": 0,
 35        "postingPeriod": 0,
 36        "yearShift": 0
 37      },
 38      "toYear": 0,
 39      "toPeriod": {
 40        "id": 0,
 41        "displayId": "string",
 42        "status": "CREATED",
 43        "day": 0,
 44        "year": 0,
 45        "month": 0,
 46        "postingPeriod": 0,
 47        "yearShift": 0
 48      },
 49      "fromDate": "2019-08-24",
 50      "toDate": "2019-08-24",
 51      "postingType": "ALL",
 52      "externalStatusFilterType": "ALL",
 53      "externalStatuses": [
 54        "NA"
 55      ],
 56      "internalStatusFilterType": "ALL",
 57      "internalStatuses": [
 58        "NA"
 59      ],
 60      "listObjectType": "ACTIVATION_GROUP",
 61      "objectList": [
 62        {
 63          "id": 0,
 64          "displayId": "string",
 65          "name": "string"
 66        }
 67      ],
 68      "migratedFilterType": "MIGRATED",
 69      "internalAssetClassFilterType": "ALL",
 70      "internalAssetClasses": [
 71        {
 72          "id": 10000001,
 73          "displayId": "IAC-001",
 74          "status": {
 75            "name": "ACTIVE",
 76            "captionKey": "enum.objectStatus.active",
 77            "active": true,
 78            "caption": "Active"
 79          },
 80          "name": "Machinery and Equipment",
 81          "assetClassType": "PROPERTY",
 82          "infiniteUsefulLife": false
 83        }
 84      ],
 85      "businessAreaFilterType": "ALL",
 86      "businessAreas": [
 87        {
 88          "id": 3001,
 89          "displayId": "BA-2025-001",
 90          "status": {
 91            "name": "ACTIVE",
 92            "captionKey": "enum.objectStatus.active",
 93            "active": true,
 94            "caption": "Active"
 95          },
 96          "name": "North America Operations"
 97        }
 98      ],
 99      "functionalAreaFilterType": "ALL",
100      "functionalAreas": [
101        {
102          "id": 2001,
103          "displayId": "FA-2025-001",
104          "status": {
105            "name": "ACTIVE",
106            "captionKey": "enum.objectStatus.active",
107            "active": true,
108            "caption": "Active"
109          },
110          "name": "Accounting Department"
111        }
112      ]
113    },
114    "filter": {
115      "id": 0,
116      "name": "string",
117      "principalPositionType": "LESSEE",
118      "calendarType": "REGULAR_CALENDAR",
119      "fiscalYearVariant": {
120        "id": "string",
121        "displayId": "Euro"
122      },
123      "profileId": 0,
124      "jobId": 0,
125      "objectList": [
126        {
127          "id": "string",
128          "displayId": "Euro"
129        }
130      ],
131      "filterTypes": {
132        "erpSystemFilterType": "ALL",
133        "erpSystems": [
134          {
135            "id": 0,
136            "displayId": "string",
137            "status": "CREATED",
138            "name": "string",
139            "type": "NAKISA",
140            "sapVersion": "ECC_EHP5"
141          }
142        ],
143        "leaseAreaFilterType": "ALL",
144        "leaseAreas": [
145          {
146            "id": 10000001,
147            "displayId": "0001",
148            "status": {
149              "name": "ACTIVE",
150              "captionKey": "enum.objectStatus.active",
151              "active": true,
152              "caption": "Active"
153            },
154            "name": "Global Lease Area"
155          }
156        ],
157        "businessUnitFilterType": "ALL",
158        "businessUnits": [
159          {
160            "id": 10000001,
161            "displayId": "BU0001",
162            "status": {
163              "name": "ACTIVE",
164              "captionKey": "enum.objectStatus.active",
165              "active": true,
166              "caption": "Active"
167            },
168            "name": "North America Business Unit"
169          }
170        ],
171        "companyFilterType": "ALL",
172        "companies": [
173          {
174            "id": 10000006,
175            "displayId": "1005",
176            "status": {
177              "name": "ACTIVE",
178              "captionKey": "enum.objectStatus.active",
179              "active": true,
180              "caption": "Active"
181            },
182            "erpSystemId": 10000001,
183            "erpSystemDisplayId": "FINQ8S-300",
184            "countryId": 10000095,
185            "countryDisplayId": "CA",
186            "postingPeriodVariantId": 0,
187            "fiscalVariantId": 0
188          }
189        ],
190        "leaseDepartmentFilterType": "ALL",
191        "leaseDepartments": [
192          {
193            "id": 300001,
194            "displayId": "DEP-01",
195            "status": {
196              "name": "ACTIVE",
197              "captionKey": "enum.objectStatus.active",
198              "active": true,
199              "caption": "Active"
200            },
201            "name": "Finance Department"
202          }
203        ],
204        "leaseGroupFilterType": "ALL",
205        "leaseGroups": [
206          {
207            "id": 60000001,
208            "displayId": "LG-001",
209            "status": {
210              "name": "ACTIVE",
211              "captionKey": "enum.objectStatus.active",
212              "active": true,
213              "caption": "Active"
214            },
215            "name": "Global Lease Group"
216          }
217        ],
218        "costCenterFilterType": "ALL",
219        "costCenters": [
220          {
221            "id": 14001,
222            "displayId": "CC-001",
223            "status": {
224              "name": "ACTIVE",
225              "captionKey": "enum.objectStatus.active",
226              "active": true,
227              "caption": "Active"
228            },
229            "name": "Cost Center A"
230          }
231        ],
232        "profitCenterFilterType": "ALL",
233        "profitCenters": [
234          {
235            "id": 9001,
236            "displayId": "PC-001",
237            "status": {
238              "name": "ACTIVE",
239              "captionKey": "enum.objectStatus.active",
240              "active": true,
241              "caption": "Active"
242            },
243            "name": "North Region Profit Center",
244            "validTo": "2025-12-31",
245            "erpSystemId": 101,
246            "erpSystemDisplayId": "SAP-01"
247          }
248        ],
249        "wbsFilterType": "ALL",
250        "wbses": [
251          {
252            "id": 1001,
253            "displayId": "WBS-2025-001",
254            "status": {
255              "name": "ACTIVE",
256              "captionKey": "enum.objectStatus.active",
257              "active": true,
258              "caption": "Active"
259            },
260            "name": "Main Project WBS"
261          }
262        ],
263        "businessAreaFilterType": "ALL",
264        "businessAreas": [
265          {
266            "id": 3001,
267            "displayId": "BA-2025-001",
268            "status": {
269              "name": "ACTIVE",
270              "captionKey": "enum.objectStatus.active",
271              "active": true,
272              "caption": "Active"
273            },
274            "name": "North America Operations"
275          }
276        ],
277        "functionalAreaFilterType": "ALL",
278        "functionalAreas": [
279          {
280            "id": 2001,
281            "displayId": "FA-2025-001",
282            "status": {
283              "name": "ACTIVE",
284              "captionKey": "enum.objectStatus.active",
285              "active": true,
286              "caption": "Active"
287            },
288            "name": "Accounting Department"
289          }
290        ]
291      }
292    },
293    "tasks": [
294      {
295        "id": 0,
296        "queueTime": "2019-08-24T14:15:22Z",
297        "startTime": "2019-08-24T14:15:22Z",
298        "endTime": "2019-08-24T14:15:22Z",
299        "interruptedAt": "2019-08-24T14:15:22Z",
300        "recoveredAt": "2019-08-24T14:15:22Z",
301        "status": "CREATED",
302        "recover": true,
303        "interrupted": true,
304        "interruptionMessage": "string",
305        "errorMessage": "string",
306        "reportJobId": 0,
307        "unitIds": [
308          0
309        ],
310        "jsonFileStorageId": "string",
311        "jsonDocStoreIds": [
312          0
313        ]
314      }
315    ],
316    "docStoreId": 0
317  }
318]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": [
 15    {
 16      "id": 0,
 17      "taskCount": 0,
 18      "failedTaskCount": 0,
 19      "doneTaskCount": 0,
 20      "inProgressTaskCount": 0,
 21      "cancelledTaskCount": 0,
 22      "errorMessage": "string",
 23      "executor": "SCHEDULER",
 24      "scheduleJobId": 0,
 25      "batchSize": 1000,
 26      "totalObjectCount": 0,
 27      "profileId": 0,
 28      "readOnly": true,
 29      "status": "CREATED",
 30      "fileStorageId": "string",
 31      "generatingExportFile": true,
 32      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33      "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 34      "input": {
 35        "id": 0,
 36        "accountingStandardType": "GAAP",
 37        "classifications": [
 38          "NON_LEASE"
 39        ],
 40        "fromYear": 0,
 41        "fromPeriod": {
 42          "id": 0,
 43          "displayId": "string",
 44          "status": "CREATED",
 45          "day": 0,
 46          "year": 0,
 47          "month": 0,
 48          "postingPeriod": 0,
 49          "yearShift": 0
 50        },
 51        "toYear": 0,
 52        "toPeriod": {
 53          "id": 0,
 54          "displayId": "string",
 55          "status": "CREATED",
 56          "day": 0,
 57          "year": 0,
 58          "month": 0,
 59          "postingPeriod": 0,
 60          "yearShift": 0
 61        },
 62        "fromDate": "2019-08-24",
 63        "toDate": "2019-08-24",
 64        "postingType": "ALL",
 65        "externalStatusFilterType": "ALL",
 66        "externalStatuses": [
 67          "NA"
 68        ],
 69        "internalStatusFilterType": "ALL",
 70        "internalStatuses": [
 71          "NA"
 72        ],
 73        "listObjectType": "ACTIVATION_GROUP",
 74        "objectList": [
 75          {
 76            "id": 0,
 77            "displayId": "string",
 78            "name": "string"
 79          }
 80        ],
 81        "migratedFilterType": "MIGRATED",
 82        "internalAssetClassFilterType": "ALL",
 83        "internalAssetClasses": [
 84          {
 85            "id": 10000001,
 86            "displayId": "IAC-001",
 87            "status": {
 88              "name": "ACTIVE",
 89              "captionKey": "enum.objectStatus.active",
 90              "active": true,
 91              "caption": "Active"
 92            },
 93            "name": "Machinery and Equipment",
 94            "assetClassType": "PROPERTY",
 95            "infiniteUsefulLife": false
 96          }
 97        ],
 98        "businessAreaFilterType": "ALL",
 99        "businessAreas": [
100          {
101            "id": 3001,
102            "displayId": "BA-2025-001",
103            "status": {
104              "name": "ACTIVE",
105              "captionKey": "enum.objectStatus.active",
106              "active": true,
107              "caption": "Active"
108            },
109            "name": "North America Operations"
110          }
111        ],
112        "functionalAreaFilterType": "ALL",
113        "functionalAreas": [
114          {
115            "id": 2001,
116            "displayId": "FA-2025-001",
117            "status": {
118              "name": "ACTIVE",
119              "captionKey": "enum.objectStatus.active",
120              "active": true,
121              "caption": "Active"
122            },
123            "name": "Accounting Department"
124          }
125        ]
126      },
127      "filter": {
128        "id": 0,
129        "name": "string",
130        "principalPositionType": "LESSEE",
131        "calendarType": "REGULAR_CALENDAR",
132        "fiscalYearVariant": {
133          "id": "string",
134          "displayId": "Euro"
135        },
136        "profileId": 0,
137        "jobId": 0,
138        "objectList": [
139          {
140            "id": "string",
141            "displayId": "Euro"
142          }
143        ],
144        "filterTypes": {
145          "erpSystemFilterType": "ALL",
146          "erpSystems": [
147            {
148              "id": 0,
149              "displayId": "string",
150              "status": "CREATED",
151              "name": "string",
152              "type": "NAKISA",
153              "sapVersion": "ECC_EHP5"
154            }
155          ],
156          "leaseAreaFilterType": "ALL",
157          "leaseAreas": [
158            {
159              "id": 10000001,
160              "displayId": "0001",
161              "status": {
162                "name": "ACTIVE",
163                "captionKey": "enum.objectStatus.active",
164                "active": true,
165                "caption": "Active"
166              },
167              "name": "Global Lease Area"
168            }
169          ],
170          "businessUnitFilterType": "ALL",
171          "businessUnits": [
172            {
173              "id": 10000001,
174              "displayId": "BU0001",
175              "status": {
176                "name": "ACTIVE",
177                "captionKey": "enum.objectStatus.active",
178                "active": true,
179                "caption": "Active"
180              },
181              "name": "North America Business Unit"
182            }
183          ],
184          "companyFilterType": "ALL",
185          "companies": [
186            {
187              "id": 10000006,
188              "displayId": "1005",
189              "status": {
190                "name": "ACTIVE",
191                "captionKey": "enum.objectStatus.active",
192                "active": true,
193                "caption": "Active"
194              },
195              "erpSystemId": 10000001,
196              "erpSystemDisplayId": "FINQ8S-300",
197              "countryId": 10000095,
198              "countryDisplayId": "CA",
199              "postingPeriodVariantId": 0,
200              "fiscalVariantId": 0
201            }
202          ],
203          "leaseDepartmentFilterType": "ALL",
204          "leaseDepartments": [
205            {
206              "id": 300001,
207              "displayId": "DEP-01",
208              "status": {
209                "name": "ACTIVE",
210                "captionKey": "enum.objectStatus.active",
211                "active": true,
212                "caption": "Active"
213              },
214              "name": "Finance Department"
215            }
216          ],
217          "leaseGroupFilterType": "ALL",
218          "leaseGroups": [
219            {
220              "id": 60000001,
221              "displayId": "LG-001",
222              "status": {
223                "name": "ACTIVE",
224                "captionKey": "enum.objectStatus.active",
225                "active": true,
226                "caption": "Active"
227              },
228              "name": "Global Lease Group"
229            }
230          ],
231          "costCenterFilterType": "ALL",
232          "costCenters": [
233            {
234              "id": 14001,
235              "displayId": "CC-001",
236              "status": {
237                "name": "ACTIVE",
238                "captionKey": "enum.objectStatus.active",
239                "active": true,
240                "caption": "Active"
241              },
242              "name": "Cost Center A"
243            }
244          ],
245          "profitCenterFilterType": "ALL",
246          "profitCenters": [
247            {
248              "id": 9001,
249              "displayId": "PC-001",
250              "status": {
251                "name": "ACTIVE",
252                "captionKey": "enum.objectStatus.active",
253                "active": true,
254                "caption": "Active"
255              },
256              "name": "North Region Profit Center",
257              "validTo": "2025-12-31",
258              "erpSystemId": 101,
259              "erpSystemDisplayId": "SAP-01"
260            }
261          ],
262          "wbsFilterType": "ALL",
263          "wbses": [
264            {
265              "id": 1001,
266              "displayId": "WBS-2025-001",
267              "status": {
268                "name": "ACTIVE",
269                "captionKey": "enum.objectStatus.active",
270                "active": true,
271                "caption": "Active"
272              },
273              "name": "Main Project WBS"
274            }
275          ],
276          "businessAreaFilterType": "ALL",
277          "businessAreas": [
278            {
279              "id": 3001,
280              "displayId": "BA-2025-001",
281              "status": {
282                "name": "ACTIVE",
283                "captionKey": "enum.objectStatus.active",
284                "active": true,
285                "caption": "Active"
286              },
287              "name": "North America Operations"
288            }
289          ],
290          "functionalAreaFilterType": "ALL",
291          "functionalAreas": [
292            {
293              "id": 2001,
294              "displayId": "FA-2025-001",
295              "status": {
296                "name": "ACTIVE",
297                "captionKey": "enum.objectStatus.active",
298                "active": true,
299                "caption": "Active"
300              },
301              "name": "Accounting Department"
302            }
303          ]
304        }
305      },
306      "tasks": [
307        {
308          "id": 0,
309          "queueTime": "2019-08-24T14:15:22Z",
310          "startTime": "2019-08-24T14:15:22Z",
311          "endTime": "2019-08-24T14:15:22Z",
312          "interruptedAt": "2019-08-24T14:15:22Z",
313          "recoveredAt": "2019-08-24T14:15:22Z",
314          "status": "CREATED",
315          "recover": true,
316          "interrupted": true,
317          "interruptionMessage": "string",
318          "errorMessage": "string",
319          "reportJobId": 0,
320          "unitIds": [
321            0
322          ],
323          "jsonFileStorageId": "string",
324          "jsonDocStoreIds": [
325            0
326          ]
327        }
328      ],
329      "docStoreId": 0
330    }
331  ]
332}

Get Units By Display Id And Activation Group States

HTTP Request

POST /api/v1/periodic_posting_status_reports/jobs/units

Parameters

Name

In

Type

Required

Description

unitDisplayIdLike

query

string

true

none

body

body

Pageable

false

none

Body Parameters

1{
2  "page": 0,
3  "size": 10,
4  "sort": [
5    "id,asc",
6    "name,desc"
7  ]
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageUnitDto

Example Responses

  1{
  2  "totalPages": 15,
  3  "totalElements": 10000001,
  4  "pageable": {
  5    "unpaged": false,
  6    "paged": true,
  7    "pageSize": 100,
  8    "pageNumber": 0,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 10,
 17  "first": true,
 18  "last": false,
 19  "size": 10,
 20  "content": [
 21    {
 22      "id": 10000001,
 23      "displayId": "UNIT-000123",
 24      "name": "Office Printer",
 25      "description": "High-speed color printer for main office.",
 26      "assetNumber": "A-1001",
 27      "referenceId": "REF-2024-001",
 28      "serialNumber": "SN12345678",
 29      "licenseNumber": "LIC-98765",
 30      "inventoryNumber": "INV-55555",
 31      "room": "Room 101",
 32      "location": "Head Office",
 33      "evaluationGroup1": "Group A",
 34      "evaluationGroup2": "Group B",
 35      "evaluationGroup3": "Group C",
 36      "investmentReason": "Replacement of outdated equipment",
 37      "typeName": "Printer",
 38      "calculateGrossTax": true,
 39      "shippingDate": "2024-01-15",
 40      "deliveryDate": "2024-01-20",
 41      "receptionDate": "2024-01-21",
 42      "activationDate": "2024-01-22",
 43      "rouEndDate": "2026-01-22",
 44      "erpAssetRetirementDate": "2028-01-01",
 45      "state": "UNIT_ACTIVE",
 46      "taxCalculationType": "NET",
 47      "internalAssetClass": {
 48        "id": 10000001,
 49        "displayId": "IAC-001",
 50        "status": {
 51          "name": "ACTIVE",
 52          "captionKey": "enum.objectStatus.active",
 53          "active": true,
 54          "caption": "Active"
 55        },
 56        "name": "Machinery and Equipment",
 57        "assetClassType": "PROPERTY",
 58        "infiniteUsefulLife": false
 59      },
 60      "profitCenter": {
 61        "id": 9001,
 62        "displayId": "PC-001",
 63        "status": {
 64          "name": "ACTIVE",
 65          "captionKey": "enum.objectStatus.active",
 66          "active": true,
 67          "caption": "Active"
 68        },
 69        "name": "North Region Profit Center",
 70        "validTo": "2025-12-31",
 71        "erpSystemId": 101,
 72        "erpSystemDisplayId": "SAP-01"
 73      },
 74      "workBreakdownStructure": {
 75        "id": 1001,
 76        "displayId": "WBS-2025-001",
 77        "status": {
 78          "name": "ACTIVE",
 79          "captionKey": "enum.objectStatus.active",
 80          "active": true,
 81          "caption": "Active"
 82        },
 83        "name": "Main Project WBS"
 84      },
 85      "functionalArea": {
 86        "id": 2001,
 87        "displayId": "FA-2025-001",
 88        "status": {
 89          "name": "ACTIVE",
 90          "captionKey": "enum.objectStatus.active",
 91          "active": true,
 92          "caption": "Active"
 93        },
 94        "name": "Accounting Department"
 95      },
 96      "businessArea": {
 97        "id": 3001,
 98        "displayId": "BA-2025-001",
 99        "status": {
100          "name": "ACTIVE",
101          "captionKey": "enum.objectStatus.active",
102          "active": true,
103          "caption": "Active"
104        },
105        "name": "North America Operations"
106      },
107      "network": {
108        "id": 10001,
109        "displayId": "NET-001",
110        "status": {
111          "name": "ACTIVE",
112          "captionKey": "enum.objectStatus.active",
113          "active": true,
114          "caption": "Active"
115        },
116        "name": "Global Network"
117      },
118      "segment": {
119        "id": 11001,
120        "displayId": "SEG-001",
121        "status": {
122          "name": "ACTIVE",
123          "captionKey": "enum.objectStatus.active",
124          "active": true,
125          "caption": "Active"
126        },
127        "name": "Segment Alpha"
128      },
129      "internalOrder": {
130        "id": 10000001,
131        "status": {
132          "name": "ACTIVE",
133          "captionKey": "enum.objectStatus.active",
134          "active": true,
135          "caption": "Active"
136        },
137        "displayId": "IO-2024-001",
138        "erpSystemId": 1001,
139        "erpSystemDisplayId": "SAP-001",
140        "name": "Office Renovation Order",
141        "internalOrderTypeId": 3001,
142        "internalOrderTypeDisplayId": "CAPEX",
143        "controllingAreaId": 4001,
144        "controllingAreaDisplayId": "CA-1001"
145      },
146      "internalOrderType": {
147        "id": 10000001,
148        "status": {
149          "name": "ACTIVE",
150          "captionKey": "enum.objectStatus.active",
151          "active": true,
152          "caption": "Active"
153        },
154        "displayId": "CAPEX",
155        "erpSystemId": 1001,
156        "erpSystemDisplayId": "SAP-001",
157        "name": "Capital Expenditure Orders",
158        "internalOrderId": 20004567
159      },
160      "currency": {
161        "id": 840,
162        "displayId": "USD",
163        "status": {
164          "name": "ACTIVE",
165          "captionKey": "enum.objectStatus.active",
166          "active": true,
167          "caption": "Active"
168        },
169        "name": "United States Dollar",
170        "decimalPoints": 2
171      },
172      "taxCodeForPrincipalPayment": {
173        "id": 5001,
174        "displayId": "TC-001",
175        "status": {
176          "name": "ACTIVE",
177          "captionKey": "enum.objectStatus.active",
178          "active": true,
179          "caption": "Active"
180        },
181        "name": "VAT Standard Rate"
182      },
183      "taxJurisdictionForPrincipalPayment": {
184        "id": 4001,
185        "displayId": "TJ-2025-001",
186        "status": {
187          "name": "ACTIVE",
188          "captionKey": "enum.objectStatus.active",
189          "active": true,
190          "caption": "Active"
191        },
192        "name": "California Tax Authority"
193      },
194      "taxCodeForInterestPayment": {
195        "id": 5001,
196        "displayId": "TC-001",
197        "status": {
198          "name": "ACTIVE",
199          "captionKey": "enum.objectStatus.active",
200          "active": true,
201          "caption": "Active"
202        },
203        "name": "VAT Standard Rate"
204      },
205      "taxJurisdictionForInterestPayment": {
206        "id": 4001,
207        "displayId": "TJ-2025-001",
208        "status": {
209          "name": "ACTIVE",
210          "captionKey": "enum.objectStatus.active",
211          "active": true,
212          "caption": "Active"
213        },
214        "name": "California Tax Authority"
215      },
216      "taxCodeForNonLeasePayment": {
217        "id": 5001,
218        "displayId": "TC-001",
219        "status": {
220          "name": "ACTIVE",
221          "captionKey": "enum.objectStatus.active",
222          "active": true,
223          "caption": "Active"
224        },
225        "name": "VAT Standard Rate"
226      },
227      "taxJurisdictionForNonLeasePayment": {
228        "id": 4001,
229        "displayId": "TJ-2025-001",
230        "status": {
231          "name": "ACTIVE",
232          "captionKey": "enum.objectStatus.active",
233          "active": true,
234          "caption": "Active"
235        },
236        "name": "California Tax Authority"
237      },
238      "costCenter": {
239        "id": 14001,
240        "displayId": "CC-001",
241        "status": {
242          "name": "ACTIVE",
243          "captionKey": "enum.objectStatus.active",
244          "active": true,
245          "caption": "Active"
246        },
247        "name": "Cost Center A"
248      },
249      "company": {
250        "id": 10000006,
251        "displayId": "1005",
252        "status": {
253          "name": "ACTIVE",
254          "captionKey": "enum.objectStatus.active",
255          "active": true,
256          "caption": "Active"
257        },
258        "erpSystemId": 10000001,
259        "erpSystemDisplayId": "FINQ8S-300",
260        "countryId": 10000095,
261        "countryDisplayId": "CA",
262        "postingPeriodVariantId": 0,
263        "fiscalVariantId": 0
264      },
265      "taxJurisdiction": {
266        "id": 4001,
267        "displayId": "TJ-2025-001",
268        "status": {
269          "name": "ACTIVE",
270          "captionKey": "enum.objectStatus.active",
271          "active": true,
272          "caption": "Active"
273        },
274        "name": "California Tax Authority"
275      },
276      "taxCode": {
277        "id": 5001,
278        "displayId": "TC-001",
279        "status": {
280          "name": "ACTIVE",
281          "captionKey": "enum.objectStatus.active",
282          "active": true,
283          "caption": "Active"
284        },
285        "name": "VAT Standard Rate"
286      },
287      "responsibleCostCenter": {
288        "id": 14001,
289        "displayId": "CC-001",
290        "status": {
291          "name": "ACTIVE",
292          "captionKey": "enum.objectStatus.active",
293          "active": true,
294          "caption": "Active"
295        },
296        "name": "Cost Center A"
297      },
298      "plant": {
299        "id": 10000001,
300        "displayId": "PLANT-001",
301        "status": {
302          "name": "ACTIVE",
303          "captionKey": "enum.objectStatus.active",
304          "active": true,
305          "caption": "Active"
306        },
307        "name": "Berlin Manufacturing Plant",
308        "companyId": 7001
309      },
310      "assetCostCenter": {
311        "id": 14001,
312        "displayId": "CC-001",
313        "status": {
314          "name": "ACTIVE",
315          "captionKey": "enum.objectStatus.active",
316          "active": true,
317          "caption": "Active"
318        },
319        "name": "Cost Center A"
320      },
321      "assetProfitCenter": {
322        "id": 9001,
323        "displayId": "PC-001",
324        "status": {
325          "name": "ACTIVE",
326          "captionKey": "enum.objectStatus.active",
327          "active": true,
328          "caption": "Active"
329        },
330        "name": "North Region Profit Center",
331        "validTo": "2025-12-31",
332        "erpSystemId": 101,
333        "erpSystemDisplayId": "SAP-01"
334      },
335      "assetWorkBreakdownStructure": {
336        "id": 1001,
337        "displayId": "WBS-2025-001",
338        "status": {
339          "name": "ACTIVE",
340          "captionKey": "enum.objectStatus.active",
341          "active": true,
342          "caption": "Active"
343        },
344        "name": "Main Project WBS"
345      },
346      "assetTaxJurisdiction": {
347        "id": 4001,
348        "displayId": "TJ-2025-001",
349        "status": {
350          "name": "ACTIVE",
351          "captionKey": "enum.objectStatus.active",
352          "active": true,
353          "caption": "Active"
354        },
355        "name": "California Tax Authority"
356      },
357      "assetBusinessArea": {
358        "id": 3001,
359        "displayId": "BA-2025-001",
360        "status": {
361          "name": "ACTIVE",
362          "captionKey": "enum.objectStatus.active",
363          "active": true,
364          "caption": "Active"
365        },
366        "name": "North America Operations"
367      },
368      "assetSegment": {
369        "id": 11001,
370        "displayId": "SEG-001",
371        "status": {
372          "name": "ACTIVE",
373          "captionKey": "enum.objectStatus.active",
374          "active": true,
375          "caption": "Active"
376        },
377        "name": "Segment Alpha"
378      },
379      "activationGroupId": 101,
380      "activationGroupDisplayId": "AG-001",
381      "principalPositionType": {
382        "name": "LESSEE",
383        "captionKey": "enum.principalpositiontype.lessee",
384        "caption": "Lessee"
385      },
386      "effectiveDate": "2024-01-01",
387      "costCenterAllocations": [
388        {
389          "id": 10001,
390          "mainCostCenter": true,
391          "allocationPercentage": 75,
392          "costCenter": {
393            "id": 14001,
394            "displayId": "CC-001",
395            "status": {
396              "name": "ACTIVE",
397              "captionKey": "enum.objectStatus.active",
398              "active": true,
399              "caption": "Active"
400            },
401            "name": "Cost Center A"
402          },
403          "profitCenter": {
404            "id": 9001,
405            "displayId": "PC-001",
406            "status": {
407              "name": "ACTIVE",
408              "captionKey": "enum.objectStatus.active",
409              "active": true,
410              "caption": "Active"
411            },
412            "name": "North Region Profit Center",
413            "validTo": "2025-12-31",
414            "erpSystemId": 101,
415            "erpSystemDisplayId": "SAP-01"
416          }
417        }
418      ],
419      "numberRangeIdentifierType": {
420        "name": "COMPANY_CODE"
421      },
422      "numberRangeIdentifierValue": "NR-0001",
423      "numberRangeType": {
424        "name": "CONTRACT"
425      },
426      "allowsSystemGenerateNewId": true
427    }
428  ],
429  "number": 0,
430  "sort": {
431    "unsorted": false,
432    "sorted": true,
433    "empty": false
434  },
435  "empty": false
436}

Search Units

HTTP Request

POST /api/v1/periodic_posting_status_reports/jobs/search-units

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» request

body

PeriodicPostingStatusReportJobListFilterTypeRequest

false

none

»» searchTerm

body

string

false

none

»» profile

body

PeriodicPostingStatusReportJobFilterDto

true

none

»»» id

body

integer(int64)

false

none

»»» name

body

string

false

none

»»» principalPositionType

body

string

false

none

»»» calendarType

body

string

false

none

»»» fiscalYearVariant

body

BaseId

false

Basic identifier object containing ID and display information.

»»»» id

body

string(int64)

false

Unique identifier of the entity.

»»»» displayId

body

string

false

Display identifier of the entity.

»»» profileId

body

integer(int64)

false

none

»»» jobId

body

integer(int64)

false

none

»»» objectList

body

[BaseId]

false

[Basic identifier object containing ID and display information.]

»»» filterTypes

body

PeriodicPostingStatusReportFilterTypesDto

false

none

»»»» erpSystemFilterType

body

string

false

none

»»»» erpSystems

body

[ErpSystemLite]

false

none

»»»»» id

body

integer(int64)

false

none

»»»»» displayId

body

string

false

none

»»»»» status

body

string

false

none

»»»»» name

body

string

false

none

»»»»» type

body

string

false

none

»»»»» sapVersion

body

string

false

none

»»»» leaseAreaFilterType

body

string

false

none

»»»» leaseAreas

body

[LeaseAreaLite]

false

[Represents a Lease Area entity containing organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the lease area.

»»»»» displayId

body

string

false

Display-friendly identifier of the lease area.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»»» name

body

string

false

Enum name representing the object status.

»»»»»» captionKey

body

string

false

Localization key for the object status caption.

»»»»»» active

body

boolean

false

Indicates whether the status is active.

»»»»»» caption

body

string

false

Localized caption of the object status.

»»»»» name

body

string

false

Name of the lease area.

»»»» businessUnitFilterType

body

string

false

none

»»»» businessUnits

body

[BusinessUnitLite]

false

[Represents a Business Unit entity containing organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the business unit.

»»»»» displayId

body

string

false

Display-friendly identifier of the business unit.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the business unit.

»»»» companyFilterType

body

string

false

none

»»»» companies

body

[CompanyLite]

false

[Represents a Company entity containing organizational, ERP, and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the company.

»»»»» displayId

body

string

false

Display-friendly identifier of the company.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» erpSystemId

body

integer(int64)

false

Unique identifier of the ERP system associated with the company.

»»»»» erpSystemDisplayId

body

string

false

Display-friendly identifier of the ERP system associated with the company.

»»»»» countryId

body

integer(int64)

false

Unique identifier of the country associated with the company.

»»»»» countryDisplayId

body

string

false

Display-friendly identifier of the country associated with the company.

»»»»» postingPeriodVariantId

body

integer(int64)

false

none

»»»»» fiscalVariantId

body

integer(int64)

false

none

»»»» leaseDepartmentFilterType

body

string

false

none

»»»» leaseDepartments

body

[DepartmentLite]

false

[Represents a Department entity with organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the department.

»»»»» displayId

body

string

false

Display-friendly identifier of the department.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

true

Name of the department.

»»»» leaseGroupFilterType

body

string

false

none

»»»» leaseGroups

body

[LeaseGroupLite]

false

[Represents a Lease Group entity containing organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the lease group.

»»»»» displayId

body

string

false

Display-friendly identifier of the lease group.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the lease group.

»»»» costCenterFilterType

body

string

false

none

»»»» costCenters

body

[CostCenterLite]

false

[Represents a simplified Cost Center entity.]

»»»»» id

body

integer(int64)

false

Unique identifier of the cost center.

»»»»» displayId

body

string

false

Display identifier for the cost center.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the cost center.

»»»» profitCenterFilterType

body

string

false

none

»»»» profitCenters

body

[ProfitCenterLite]

false

[Represents a simplified Profit Center entity.]

»»»»» id

body

integer(int64)

false

Unique identifier of the profit center.

»»»»» displayId

body

string

false

Display identifier for the profit center.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the profit center.

»»»»» validTo

body

string(date)

false

Expiration date for the profit center.

»»»»» erpSystemId

body

integer(int64)

false

ERP system identifier associated with the profit center.

»»»»» erpSystemDisplayId

body

string

false

ERP system display identifier.

»»»» wbsFilterType

body

string

false

none

»»»» wbses

body

[WorkBreakdownStructureLite]

false

[Represents a simplified Work Breakdown Structure (WBS) entity with basic identifiers and status.]

»»»»» id

body

integer(int64)

false

Unique identifier of the WBS.

»»»»» displayId

body

string

false

Display identifier for the WBS.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the WBS.

»»»» businessAreaFilterType

body

string

false

none

»»»» businessAreas

body

[BusinessAreaLite]

false

[Represents a simplified Business Area entity with basic identifiers and status.]

»»»»» id

body

integer(int64)

false

Unique identifier of the business area.

»»»»» displayId

body

string

false

Display identifier for the business area.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the business area.

»»»» functionalAreaFilterType

body

string

false

none

»»»» functionalAreas

body

[FunctionalAreaLite]

false

[Represents a simplified Functional Area entity with basic identifiers and status.]

»»»»» id

body

integer(int64)

false

Unique identifier of the functional area.

»»»»» displayId

body

string

false

Display identifier for the functional area.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the functional area.

»» migratedFilterType

body

string

true

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»»»» displayId

Euro

body

»»»»» id

10000001

body

»»»»» displayId

0001

body

»»»»»» name

ACTIVE

body

»»»»»» captionKey

enum.objectStatus.active

body

»»»»»» active

true

body

»»»»»» caption

Active

body

»»»»» name

Global Lease Area

body

»»»»» id

10000001

body

»»»»» displayId

BU0001

body

»»»»» name

North America Business Unit

body

»»»»» id

10000006

body

»»»»» displayId

1005

body

»»»»» erpSystemId

10000001

body

»»»»» erpSystemDisplayId

FINQ8S-300

body

»»»»» countryId

10000095

body

»»»»» countryDisplayId

CA

body

»»»»» id

300001

body

»»»»» displayId

DEP-01

body

»»»»» name

Finance Department

body

»»»»» id

60000001

body

»»»»» displayId

LG-001

body

»»»»» name

Global Lease Group

body

»»»»» id

14001

body

»»»»» displayId

CC-001

body

»»»»» name

Cost Center A

body

»»»»» id

9001

body

»»»»» displayId

PC-001

body

»»»»» name

North Region Profit Center

body

»»»»» validTo

2025-12-31

body

»»»»» erpSystemId

101

body

»»»»» erpSystemDisplayId

SAP-01

body

»»»»» id

1001

body

»»»»» displayId

WBS-2025-001

body

»»»»» name

Main Project WBS

body

»»»»» id

3001

body

»»»»» displayId

BA-2025-001

body

»»»»» name

North America Operations

body

»»»»» id

2001

body

»»»»» displayId

FA-2025-001

body

»»»»» name

Accounting Department

body

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»»» calendarType

FISCAL_VARIANT, REGULAR_CALENDAR, _360

»»» principalPositionType

LESSEE, LESSOR

»»»» businessAreaFilterType

ALL, LIST

»»»» businessUnitFilterType

ALL, LIST

»»»» companyFilterType

ALL, LIST

»»»» costCenterFilterType

ALL, LIST

»»»» erpSystemFilterType

ALL, LIST

»»»» functionalAreaFilterType

ALL, LIST

»»»» leaseAreaFilterType

ALL, LIST

»»»» leaseDepartmentFilterType

ALL, LIST

»»»» leaseGroupFilterType

ALL, LIST

»»»» profitCenterFilterType

ALL, LIST

»»»» wbsFilterType

ALL, LIST

»»»»» sapVersion

ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909

»»»»» status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

»»»»» type

NAKISA, SAP

»»»»»» name

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

  1{
  2  "request": {
  3    "searchTerm": "string",
  4    "profile": {
  5      "id": 0,
  6      "name": "string",
  7      "principalPositionType": "LESSEE",
  8      "calendarType": "REGULAR_CALENDAR",
  9      "fiscalYearVariant": {
 10        "id": "string",
 11        "displayId": "Euro"
 12      },
 13      "profileId": 0,
 14      "jobId": 0,
 15      "objectList": [
 16        {
 17          "id": "string",
 18          "displayId": "Euro"
 19        }
 20      ],
 21      "filterTypes": {
 22        "erpSystemFilterType": "ALL",
 23        "erpSystems": [
 24          {
 25            "id": 0,
 26            "displayId": "string",
 27            "status": "CREATED",
 28            "name": "string",
 29            "type": "NAKISA",
 30            "sapVersion": "ECC_EHP5"
 31          }
 32        ],
 33        "leaseAreaFilterType": "ALL",
 34        "leaseAreas": [
 35          {
 36            "id": 10000001,
 37            "displayId": "0001",
 38            "status": {
 39              "name": "ACTIVE",
 40              "captionKey": "enum.objectStatus.active",
 41              "active": true,
 42              "caption": "Active"
 43            },
 44            "name": "Global Lease Area"
 45          }
 46        ],
 47        "businessUnitFilterType": "ALL",
 48        "businessUnits": [
 49          {
 50            "id": 10000001,
 51            "displayId": "BU0001",
 52            "status": {
 53              "name": "ACTIVE",
 54              "captionKey": "enum.objectStatus.active",
 55              "active": true,
 56              "caption": "Active"
 57            },
 58            "name": "North America Business Unit"
 59          }
 60        ],
 61        "companyFilterType": "ALL",
 62        "companies": [
 63          {
 64            "id": 10000006,
 65            "displayId": "1005",
 66            "status": {
 67              "name": "ACTIVE",
 68              "captionKey": "enum.objectStatus.active",
 69              "active": true,
 70              "caption": "Active"
 71            },
 72            "erpSystemId": 10000001,
 73            "erpSystemDisplayId": "FINQ8S-300",
 74            "countryId": 10000095,
 75            "countryDisplayId": "CA",
 76            "postingPeriodVariantId": 0,
 77            "fiscalVariantId": 0
 78          }
 79        ],
 80        "leaseDepartmentFilterType": "ALL",
 81        "leaseDepartments": [
 82          {
 83            "id": 300001,
 84            "displayId": "DEP-01",
 85            "status": {
 86              "name": "ACTIVE",
 87              "captionKey": "enum.objectStatus.active",
 88              "active": true,
 89              "caption": "Active"
 90            },
 91            "name": "Finance Department"
 92          }
 93        ],
 94        "leaseGroupFilterType": "ALL",
 95        "leaseGroups": [
 96          {
 97            "id": 60000001,
 98            "displayId": "LG-001",
 99            "status": {
100              "name": "ACTIVE",
101              "captionKey": "enum.objectStatus.active",
102              "active": true,
103              "caption": "Active"
104            },
105            "name": "Global Lease Group"
106          }
107        ],
108        "costCenterFilterType": "ALL",
109        "costCenters": [
110          {
111            "id": 14001,
112            "displayId": "CC-001",
113            "status": {
114              "name": "ACTIVE",
115              "captionKey": "enum.objectStatus.active",
116              "active": true,
117              "caption": "Active"
118            },
119            "name": "Cost Center A"
120          }
121        ],
122        "profitCenterFilterType": "ALL",
123        "profitCenters": [
124          {
125            "id": 9001,
126            "displayId": "PC-001",
127            "status": {
128              "name": "ACTIVE",
129              "captionKey": "enum.objectStatus.active",
130              "active": true,
131              "caption": "Active"
132            },
133            "name": "North Region Profit Center",
134            "validTo": "2025-12-31",
135            "erpSystemId": 101,
136            "erpSystemDisplayId": "SAP-01"
137          }
138        ],
139        "wbsFilterType": "ALL",
140        "wbses": [
141          {
142            "id": 1001,
143            "displayId": "WBS-2025-001",
144            "status": {
145              "name": "ACTIVE",
146              "captionKey": "enum.objectStatus.active",
147              "active": true,
148              "caption": "Active"
149            },
150            "name": "Main Project WBS"
151          }
152        ],
153        "businessAreaFilterType": "ALL",
154        "businessAreas": [
155          {
156            "id": 3001,
157            "displayId": "BA-2025-001",
158            "status": {
159              "name": "ACTIVE",
160              "captionKey": "enum.objectStatus.active",
161              "active": true,
162              "caption": "Active"
163            },
164            "name": "North America Operations"
165          }
166        ],
167        "functionalAreaFilterType": "ALL",
168        "functionalAreas": [
169          {
170            "id": 2001,
171            "displayId": "FA-2025-001",
172            "status": {
173              "name": "ACTIVE",
174              "captionKey": "enum.objectStatus.active",
175              "active": true,
176              "caption": "Active"
177            },
178            "name": "Accounting Department"
179          }
180        ]
181      }
182    },
183    "migratedFilterType": "MIGRATED"
184  },
185  "pageable": {
186    "page": 0,
187    "size": 10,
188    "sort": [
189      "id,asc",
190      "name,desc"
191    ]
192  }
193}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageUnitDto

Example Responses

  1{
  2  "totalPages": 15,
  3  "totalElements": 10000001,
  4  "pageable": {
  5    "unpaged": false,
  6    "paged": true,
  7    "pageSize": 100,
  8    "pageNumber": 0,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 10,
 17  "first": true,
 18  "last": false,
 19  "size": 10,
 20  "content": [
 21    {
 22      "id": 10000001,
 23      "displayId": "UNIT-000123",
 24      "name": "Office Printer",
 25      "description": "High-speed color printer for main office.",
 26      "assetNumber": "A-1001",
 27      "referenceId": "REF-2024-001",
 28      "serialNumber": "SN12345678",
 29      "licenseNumber": "LIC-98765",
 30      "inventoryNumber": "INV-55555",
 31      "room": "Room 101",
 32      "location": "Head Office",
 33      "evaluationGroup1": "Group A",
 34      "evaluationGroup2": "Group B",
 35      "evaluationGroup3": "Group C",
 36      "investmentReason": "Replacement of outdated equipment",
 37      "typeName": "Printer",
 38      "calculateGrossTax": true,
 39      "shippingDate": "2024-01-15",
 40      "deliveryDate": "2024-01-20",
 41      "receptionDate": "2024-01-21",
 42      "activationDate": "2024-01-22",
 43      "rouEndDate": "2026-01-22",
 44      "erpAssetRetirementDate": "2028-01-01",
 45      "state": "UNIT_ACTIVE",
 46      "taxCalculationType": "NET",
 47      "internalAssetClass": {
 48        "id": 10000001,
 49        "displayId": "IAC-001",
 50        "status": {
 51          "name": "ACTIVE",
 52          "captionKey": "enum.objectStatus.active",
 53          "active": true,
 54          "caption": "Active"
 55        },
 56        "name": "Machinery and Equipment",
 57        "assetClassType": "PROPERTY",
 58        "infiniteUsefulLife": false
 59      },
 60      "profitCenter": {
 61        "id": 9001,
 62        "displayId": "PC-001",
 63        "status": {
 64          "name": "ACTIVE",
 65          "captionKey": "enum.objectStatus.active",
 66          "active": true,
 67          "caption": "Active"
 68        },
 69        "name": "North Region Profit Center",
 70        "validTo": "2025-12-31",
 71        "erpSystemId": 101,
 72        "erpSystemDisplayId": "SAP-01"
 73      },
 74      "workBreakdownStructure": {
 75        "id": 1001,
 76        "displayId": "WBS-2025-001",
 77        "status": {
 78          "name": "ACTIVE",
 79          "captionKey": "enum.objectStatus.active",
 80          "active": true,
 81          "caption": "Active"
 82        },
 83        "name": "Main Project WBS"
 84      },
 85      "functionalArea": {
 86        "id": 2001,
 87        "displayId": "FA-2025-001",
 88        "status": {
 89          "name": "ACTIVE",
 90          "captionKey": "enum.objectStatus.active",
 91          "active": true,
 92          "caption": "Active"
 93        },
 94        "name": "Accounting Department"
 95      },
 96      "businessArea": {
 97        "id": 3001,
 98        "displayId": "BA-2025-001",
 99        "status": {
100          "name": "ACTIVE",
101          "captionKey": "enum.objectStatus.active",
102          "active": true,
103          "caption": "Active"
104        },
105        "name": "North America Operations"
106      },
107      "network": {
108        "id": 10001,
109        "displayId": "NET-001",
110        "status": {
111          "name": "ACTIVE",
112          "captionKey": "enum.objectStatus.active",
113          "active": true,
114          "caption": "Active"
115        },
116        "name": "Global Network"
117      },
118      "segment": {
119        "id": 11001,
120        "displayId": "SEG-001",
121        "status": {
122          "name": "ACTIVE",
123          "captionKey": "enum.objectStatus.active",
124          "active": true,
125          "caption": "Active"
126        },
127        "name": "Segment Alpha"
128      },
129      "internalOrder": {
130        "id": 10000001,
131        "status": {
132          "name": "ACTIVE",
133          "captionKey": "enum.objectStatus.active",
134          "active": true,
135          "caption": "Active"
136        },
137        "displayId": "IO-2024-001",
138        "erpSystemId": 1001,
139        "erpSystemDisplayId": "SAP-001",
140        "name": "Office Renovation Order",
141        "internalOrderTypeId": 3001,
142        "internalOrderTypeDisplayId": "CAPEX",
143        "controllingAreaId": 4001,
144        "controllingAreaDisplayId": "CA-1001"
145      },
146      "internalOrderType": {
147        "id": 10000001,
148        "status": {
149          "name": "ACTIVE",
150          "captionKey": "enum.objectStatus.active",
151          "active": true,
152          "caption": "Active"
153        },
154        "displayId": "CAPEX",
155        "erpSystemId": 1001,
156        "erpSystemDisplayId": "SAP-001",
157        "name": "Capital Expenditure Orders",
158        "internalOrderId": 20004567
159      },
160      "currency": {
161        "id": 840,
162        "displayId": "USD",
163        "status": {
164          "name": "ACTIVE",
165          "captionKey": "enum.objectStatus.active",
166          "active": true,
167          "caption": "Active"
168        },
169        "name": "United States Dollar",
170        "decimalPoints": 2
171      },
172      "taxCodeForPrincipalPayment": {
173        "id": 5001,
174        "displayId": "TC-001",
175        "status": {
176          "name": "ACTIVE",
177          "captionKey": "enum.objectStatus.active",
178          "active": true,
179          "caption": "Active"
180        },
181        "name": "VAT Standard Rate"
182      },
183      "taxJurisdictionForPrincipalPayment": {
184        "id": 4001,
185        "displayId": "TJ-2025-001",
186        "status": {
187          "name": "ACTIVE",
188          "captionKey": "enum.objectStatus.active",
189          "active": true,
190          "caption": "Active"
191        },
192        "name": "California Tax Authority"
193      },
194      "taxCodeForInterestPayment": {
195        "id": 5001,
196        "displayId": "TC-001",
197        "status": {
198          "name": "ACTIVE",
199          "captionKey": "enum.objectStatus.active",
200          "active": true,
201          "caption": "Active"
202        },
203        "name": "VAT Standard Rate"
204      },
205      "taxJurisdictionForInterestPayment": {
206        "id": 4001,
207        "displayId": "TJ-2025-001",
208        "status": {
209          "name": "ACTIVE",
210          "captionKey": "enum.objectStatus.active",
211          "active": true,
212          "caption": "Active"
213        },
214        "name": "California Tax Authority"
215      },
216      "taxCodeForNonLeasePayment": {
217        "id": 5001,
218        "displayId": "TC-001",
219        "status": {
220          "name": "ACTIVE",
221          "captionKey": "enum.objectStatus.active",
222          "active": true,
223          "caption": "Active"
224        },
225        "name": "VAT Standard Rate"
226      },
227      "taxJurisdictionForNonLeasePayment": {
228        "id": 4001,
229        "displayId": "TJ-2025-001",
230        "status": {
231          "name": "ACTIVE",
232          "captionKey": "enum.objectStatus.active",
233          "active": true,
234          "caption": "Active"
235        },
236        "name": "California Tax Authority"
237      },
238      "costCenter": {
239        "id": 14001,
240        "displayId": "CC-001",
241        "status": {
242          "name": "ACTIVE",
243          "captionKey": "enum.objectStatus.active",
244          "active": true,
245          "caption": "Active"
246        },
247        "name": "Cost Center A"
248      },
249      "company": {
250        "id": 10000006,
251        "displayId": "1005",
252        "status": {
253          "name": "ACTIVE",
254          "captionKey": "enum.objectStatus.active",
255          "active": true,
256          "caption": "Active"
257        },
258        "erpSystemId": 10000001,
259        "erpSystemDisplayId": "FINQ8S-300",
260        "countryId": 10000095,
261        "countryDisplayId": "CA",
262        "postingPeriodVariantId": 0,
263        "fiscalVariantId": 0
264      },
265      "taxJurisdiction": {
266        "id": 4001,
267        "displayId": "TJ-2025-001",
268        "status": {
269          "name": "ACTIVE",
270          "captionKey": "enum.objectStatus.active",
271          "active": true,
272          "caption": "Active"
273        },
274        "name": "California Tax Authority"
275      },
276      "taxCode": {
277        "id": 5001,
278        "displayId": "TC-001",
279        "status": {
280          "name": "ACTIVE",
281          "captionKey": "enum.objectStatus.active",
282          "active": true,
283          "caption": "Active"
284        },
285        "name": "VAT Standard Rate"
286      },
287      "responsibleCostCenter": {
288        "id": 14001,
289        "displayId": "CC-001",
290        "status": {
291          "name": "ACTIVE",
292          "captionKey": "enum.objectStatus.active",
293          "active": true,
294          "caption": "Active"
295        },
296        "name": "Cost Center A"
297      },
298      "plant": {
299        "id": 10000001,
300        "displayId": "PLANT-001",
301        "status": {
302          "name": "ACTIVE",
303          "captionKey": "enum.objectStatus.active",
304          "active": true,
305          "caption": "Active"
306        },
307        "name": "Berlin Manufacturing Plant",
308        "companyId": 7001
309      },
310      "assetCostCenter": {
311        "id": 14001,
312        "displayId": "CC-001",
313        "status": {
314          "name": "ACTIVE",
315          "captionKey": "enum.objectStatus.active",
316          "active": true,
317          "caption": "Active"
318        },
319        "name": "Cost Center A"
320      },
321      "assetProfitCenter": {
322        "id": 9001,
323        "displayId": "PC-001",
324        "status": {
325          "name": "ACTIVE",
326          "captionKey": "enum.objectStatus.active",
327          "active": true,
328          "caption": "Active"
329        },
330        "name": "North Region Profit Center",
331        "validTo": "2025-12-31",
332        "erpSystemId": 101,
333        "erpSystemDisplayId": "SAP-01"
334      },
335      "assetWorkBreakdownStructure": {
336        "id": 1001,
337        "displayId": "WBS-2025-001",
338        "status": {
339          "name": "ACTIVE",
340          "captionKey": "enum.objectStatus.active",
341          "active": true,
342          "caption": "Active"
343        },
344        "name": "Main Project WBS"
345      },
346      "assetTaxJurisdiction": {
347        "id": 4001,
348        "displayId": "TJ-2025-001",
349        "status": {
350          "name": "ACTIVE",
351          "captionKey": "enum.objectStatus.active",
352          "active": true,
353          "caption": "Active"
354        },
355        "name": "California Tax Authority"
356      },
357      "assetBusinessArea": {
358        "id": 3001,
359        "displayId": "BA-2025-001",
360        "status": {
361          "name": "ACTIVE",
362          "captionKey": "enum.objectStatus.active",
363          "active": true,
364          "caption": "Active"
365        },
366        "name": "North America Operations"
367      },
368      "assetSegment": {
369        "id": 11001,
370        "displayId": "SEG-001",
371        "status": {
372          "name": "ACTIVE",
373          "captionKey": "enum.objectStatus.active",
374          "active": true,
375          "caption": "Active"
376        },
377        "name": "Segment Alpha"
378      },
379      "activationGroupId": 101,
380      "activationGroupDisplayId": "AG-001",
381      "principalPositionType": {
382        "name": "LESSEE",
383        "captionKey": "enum.principalpositiontype.lessee",
384        "caption": "Lessee"
385      },
386      "effectiveDate": "2024-01-01",
387      "costCenterAllocations": [
388        {
389          "id": 10001,
390          "mainCostCenter": true,
391          "allocationPercentage": 75,
392          "costCenter": {
393            "id": 14001,
394            "displayId": "CC-001",
395            "status": {
396              "name": "ACTIVE",
397              "captionKey": "enum.objectStatus.active",
398              "active": true,
399              "caption": "Active"
400            },
401            "name": "Cost Center A"
402          },
403          "profitCenter": {
404            "id": 9001,
405            "displayId": "PC-001",
406            "status": {
407              "name": "ACTIVE",
408              "captionKey": "enum.objectStatus.active",
409              "active": true,
410              "caption": "Active"
411            },
412            "name": "North Region Profit Center",
413            "validTo": "2025-12-31",
414            "erpSystemId": 101,
415            "erpSystemDisplayId": "SAP-01"
416          }
417        }
418      ],
419      "numberRangeIdentifierType": {
420        "name": "COMPANY_CODE"
421      },
422      "numberRangeIdentifierValue": "NR-0001",
423      "numberRangeType": {
424        "name": "CONTRACT"
425      },
426      "allowsSystemGenerateNewId": true
427    }
428  ],
429  "number": 0,
430  "sort": {
431    "unsorted": false,
432    "sorted": true,
433    "empty": false
434  },
435  "empty": false
436}

Cancel

HTTP Request

POST /api/v1/periodic_posting_status_reports/jobs/cancel/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Search Activation Groups

HTTP Request

POST /api/v1/periodic_posting_status_reports/jobs/activation-groups

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» request

body

PeriodicPostingStatusReportJobListFilterTypeRequest

false

none

»» searchTerm

body

string

false

none

»» profile

body

PeriodicPostingStatusReportJobFilterDto

true

none

»»» id

body

integer(int64)

false

none

»»» name

body

string

false

none

»»» principalPositionType

body

string

false

none

»»» calendarType

body

string

false

none

»»» fiscalYearVariant

body

BaseId

false

Basic identifier object containing ID and display information.

»»»» id

body

string(int64)

false

Unique identifier of the entity.

»»»» displayId

body

string

false

Display identifier of the entity.

»»» profileId

body

integer(int64)

false

none

»»» jobId

body

integer(int64)

false

none

»»» objectList

body

[BaseId]

false

[Basic identifier object containing ID and display information.]

»»» filterTypes

body

PeriodicPostingStatusReportFilterTypesDto

false

none

»»»» erpSystemFilterType

body

string

false

none

»»»» erpSystems

body

[ErpSystemLite]

false

none

»»»»» id

body

integer(int64)

false

none

»»»»» displayId

body

string

false

none

»»»»» status

body

string

false

none

»»»»» name

body

string

false

none

»»»»» type

body

string

false

none

»»»»» sapVersion

body

string

false

none

»»»» leaseAreaFilterType

body

string

false

none

»»»» leaseAreas

body

[LeaseAreaLite]

false

[Represents a Lease Area entity containing organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the lease area.

»»»»» displayId

body

string

false

Display-friendly identifier of the lease area.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»»» name

body

string

false

Enum name representing the object status.

»»»»»» captionKey

body

string

false

Localization key for the object status caption.

»»»»»» active

body

boolean

false

Indicates whether the status is active.

»»»»»» caption

body

string

false

Localized caption of the object status.

»»»»» name

body

string

false

Name of the lease area.

»»»» businessUnitFilterType

body

string

false

none

»»»» businessUnits

body

[BusinessUnitLite]

false

[Represents a Business Unit entity containing organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the business unit.

»»»»» displayId

body

string

false

Display-friendly identifier of the business unit.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the business unit.

»»»» companyFilterType

body

string

false

none

»»»» companies

body

[CompanyLite]

false

[Represents a Company entity containing organizational, ERP, and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the company.

»»»»» displayId

body

string

false

Display-friendly identifier of the company.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» erpSystemId

body

integer(int64)

false

Unique identifier of the ERP system associated with the company.

»»»»» erpSystemDisplayId

body

string

false

Display-friendly identifier of the ERP system associated with the company.

»»»»» countryId

body

integer(int64)

false

Unique identifier of the country associated with the company.

»»»»» countryDisplayId

body

string

false

Display-friendly identifier of the country associated with the company.

»»»»» postingPeriodVariantId

body

integer(int64)

false

none

»»»»» fiscalVariantId

body

integer(int64)

false

none

»»»» leaseDepartmentFilterType

body

string

false

none

»»»» leaseDepartments

body

[DepartmentLite]

false

[Represents a Department entity with organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the department.

»»»»» displayId

body

string

false

Display-friendly identifier of the department.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

true

Name of the department.

»»»» leaseGroupFilterType

body

string

false

none

»»»» leaseGroups

body

[LeaseGroupLite]

false

[Represents a Lease Group entity containing organizational and status information.]

»»»»» id

body

integer(int64)

true

Unique identifier of the lease group.

»»»»» displayId

body

string

false

Display-friendly identifier of the lease group.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the lease group.

»»»» costCenterFilterType

body

string

false

none

»»»» costCenters

body

[CostCenterLite]

false

[Represents a simplified Cost Center entity.]

»»»»» id

body

integer(int64)

false

Unique identifier of the cost center.

»»»»» displayId

body

string

false

Display identifier for the cost center.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the cost center.

»»»» profitCenterFilterType

body

string

false

none

»»»» profitCenters

body

[ProfitCenterLite]

false

[Represents a simplified Profit Center entity.]

»»»»» id

body

integer(int64)

false

Unique identifier of the profit center.

»»»»» displayId

body

string

false

Display identifier for the profit center.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the profit center.

»»»»» validTo

body

string(date)

false

Expiration date for the profit center.

»»»»» erpSystemId

body

integer(int64)

false

ERP system identifier associated with the profit center.

»»»»» erpSystemDisplayId

body

string

false

ERP system display identifier.

»»»» wbsFilterType

body

string

false

none

»»»» wbses

body

[WorkBreakdownStructureLite]

false

[Represents a simplified Work Breakdown Structure (WBS) entity with basic identifiers and status.]

»»»»» id

body

integer(int64)

false

Unique identifier of the WBS.

»»»»» displayId

body

string

false

Display identifier for the WBS.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the WBS.

»»»» businessAreaFilterType

body

string

false

none

»»»» businessAreas

body

[BusinessAreaLite]

false

[Represents a simplified Business Area entity with basic identifiers and status.]

»»»»» id

body

integer(int64)

false

Unique identifier of the business area.

»»»»» displayId

body

string

false

Display identifier for the business area.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the business area.

»»»» functionalAreaFilterType

body

string

false

none

»»»» functionalAreas

body

[FunctionalAreaLite]

false

[Represents a simplified Functional Area entity with basic identifiers and status.]

»»»»» id

body

integer(int64)

false

Unique identifier of the functional area.

»»»»» displayId

body

string

false

Display identifier for the functional area.

»»»»» status

body

Status

false

Represents the object status with localized captions and activity state.

»»»»» name

body

string

false

Name of the functional area.

»» migratedFilterType

body

string

true

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»»»» displayId

Euro

body

»»»»» id

10000001

body

»»»»» displayId

0001

body

»»»»»» name

ACTIVE

body

»»»»»» captionKey

enum.objectStatus.active

body

»»»»»» active

true

body

»»»»»» caption

Active

body

»»»»» name

Global Lease Area

body

»»»»» id

10000001

body

»»»»» displayId

BU0001

body

»»»»» name

North America Business Unit

body

»»»»» id

10000006

body

»»»»» displayId

1005

body

»»»»» erpSystemId

10000001

body

»»»»» erpSystemDisplayId

FINQ8S-300

body

»»»»» countryId

10000095

body

»»»»» countryDisplayId

CA

body

»»»»» id

300001

body

»»»»» displayId

DEP-01

body

»»»»» name

Finance Department

body

»»»»» id

60000001

body

»»»»» displayId

LG-001

body

»»»»» name

Global Lease Group

body

»»»»» id

14001

body

»»»»» displayId

CC-001

body

»»»»» name

Cost Center A

body

»»»»» id

9001

body

»»»»» displayId

PC-001

body

»»»»» name

North Region Profit Center

body

»»»»» validTo

2025-12-31

body

»»»»» erpSystemId

101

body

»»»»» erpSystemDisplayId

SAP-01

body

»»»»» id

1001

body

»»»»» displayId

WBS-2025-001

body

»»»»» name

Main Project WBS

body

»»»»» id

3001

body

»»»»» displayId

BA-2025-001

body

»»»»» name

North America Operations

body

»»»»» id

2001

body

»»»»» displayId

FA-2025-001

body

»»»»» name

Accounting Department

body

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»»» calendarType

FISCAL_VARIANT, REGULAR_CALENDAR, _360

»»» principalPositionType

LESSEE, LESSOR

»»»» businessAreaFilterType

ALL, LIST

»»»» businessUnitFilterType

ALL, LIST

»»»» companyFilterType

ALL, LIST

»»»» costCenterFilterType

ALL, LIST

»»»» erpSystemFilterType

ALL, LIST

»»»» functionalAreaFilterType

ALL, LIST

»»»» leaseAreaFilterType

ALL, LIST

»»»» leaseDepartmentFilterType

ALL, LIST

»»»» leaseGroupFilterType

ALL, LIST

»»»» profitCenterFilterType

ALL, LIST

»»»» wbsFilterType

ALL, LIST

»»»»» sapVersion

ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909

»»»»» status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

»»»»» type

NAKISA, SAP

»»»»»» name

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

  1{
  2  "request": {
  3    "searchTerm": "string",
  4    "profile": {
  5      "id": 0,
  6      "name": "string",
  7      "principalPositionType": "LESSEE",
  8      "calendarType": "REGULAR_CALENDAR",
  9      "fiscalYearVariant": {
 10        "id": "string",
 11        "displayId": "Euro"
 12      },
 13      "profileId": 0,
 14      "jobId": 0,
 15      "objectList": [
 16        {
 17          "id": "string",
 18          "displayId": "Euro"
 19        }
 20      ],
 21      "filterTypes": {
 22        "erpSystemFilterType": "ALL",
 23        "erpSystems": [
 24          {
 25            "id": 0,
 26            "displayId": "string",
 27            "status": "CREATED",
 28            "name": "string",
 29            "type": "NAKISA",
 30            "sapVersion": "ECC_EHP5"
 31          }
 32        ],
 33        "leaseAreaFilterType": "ALL",
 34        "leaseAreas": [
 35          {
 36            "id": 10000001,
 37            "displayId": "0001",
 38            "status": {
 39              "name": "ACTIVE",
 40              "captionKey": "enum.objectStatus.active",
 41              "active": true,
 42              "caption": "Active"
 43            },
 44            "name": "Global Lease Area"
 45          }
 46        ],
 47        "businessUnitFilterType": "ALL",
 48        "businessUnits": [
 49          {
 50            "id": 10000001,
 51            "displayId": "BU0001",
 52            "status": {
 53              "name": "ACTIVE",
 54              "captionKey": "enum.objectStatus.active",
 55              "active": true,
 56              "caption": "Active"
 57            },
 58            "name": "North America Business Unit"
 59          }
 60        ],
 61        "companyFilterType": "ALL",
 62        "companies": [
 63          {
 64            "id": 10000006,
 65            "displayId": "1005",
 66            "status": {
 67              "name": "ACTIVE",
 68              "captionKey": "enum.objectStatus.active",
 69              "active": true,
 70              "caption": "Active"
 71            },
 72            "erpSystemId": 10000001,
 73            "erpSystemDisplayId": "FINQ8S-300",
 74            "countryId": 10000095,
 75            "countryDisplayId": "CA",
 76            "postingPeriodVariantId": 0,
 77            "fiscalVariantId": 0
 78          }
 79        ],
 80        "leaseDepartmentFilterType": "ALL",
 81        "leaseDepartments": [
 82          {
 83            "id": 300001,
 84            "displayId": "DEP-01",
 85            "status": {
 86              "name": "ACTIVE",
 87              "captionKey": "enum.objectStatus.active",
 88              "active": true,
 89              "caption": "Active"
 90            },
 91            "name": "Finance Department"
 92          }
 93        ],
 94        "leaseGroupFilterType": "ALL",
 95        "leaseGroups": [
 96          {
 97            "id": 60000001,
 98            "displayId": "LG-001",
 99            "status": {
100              "name": "ACTIVE",
101              "captionKey": "enum.objectStatus.active",
102              "active": true,
103              "caption": "Active"
104            },
105            "name": "Global Lease Group"
106          }
107        ],
108        "costCenterFilterType": "ALL",
109        "costCenters": [
110          {
111            "id": 14001,
112            "displayId": "CC-001",
113            "status": {
114              "name": "ACTIVE",
115              "captionKey": "enum.objectStatus.active",
116              "active": true,
117              "caption": "Active"
118            },
119            "name": "Cost Center A"
120          }
121        ],
122        "profitCenterFilterType": "ALL",
123        "profitCenters": [
124          {
125            "id": 9001,
126            "displayId": "PC-001",
127            "status": {
128              "name": "ACTIVE",
129              "captionKey": "enum.objectStatus.active",
130              "active": true,
131              "caption": "Active"
132            },
133            "name": "North Region Profit Center",
134            "validTo": "2025-12-31",
135            "erpSystemId": 101,
136            "erpSystemDisplayId": "SAP-01"
137          }
138        ],
139        "wbsFilterType": "ALL",
140        "wbses": [
141          {
142            "id": 1001,
143            "displayId": "WBS-2025-001",
144            "status": {
145              "name": "ACTIVE",
146              "captionKey": "enum.objectStatus.active",
147              "active": true,
148              "caption": "Active"
149            },
150            "name": "Main Project WBS"
151          }
152        ],
153        "businessAreaFilterType": "ALL",
154        "businessAreas": [
155          {
156            "id": 3001,
157            "displayId": "BA-2025-001",
158            "status": {
159              "name": "ACTIVE",
160              "captionKey": "enum.objectStatus.active",
161              "active": true,
162              "caption": "Active"
163            },
164            "name": "North America Operations"
165          }
166        ],
167        "functionalAreaFilterType": "ALL",
168        "functionalAreas": [
169          {
170            "id": 2001,
171            "displayId": "FA-2025-001",
172            "status": {
173              "name": "ACTIVE",
174              "captionKey": "enum.objectStatus.active",
175              "active": true,
176              "caption": "Active"
177            },
178            "name": "Accounting Department"
179          }
180        ]
181      }
182    },
183    "migratedFilterType": "MIGRATED"
184  },
185  "pageable": {
186    "page": 0,
187    "size": 10,
188    "sort": [
189      "id,asc",
190      "name,desc"
191    ]
192  }
193}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageActivationGroupDto

Example Responses

  1{
  2  "totalPages": 1,
  3  "totalElements": 76,
  4  "pageable": {
  5    "unpaged": false,
  6    "paged": true,
  7    "pageSize": 100,
  8    "pageNumber": 0,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 76,
 17  "first": true,
 18  "last": true,
 19  "size": 100,
 20  "content": [
 21    {
 22      "id": 10000001,
 23      "displayId": "AG-100000000",
 24      "principalPositionType": {
 25        "name": "LESSEE",
 26        "captionKey": "enum.principalpositiontype.lessee",
 27        "caption": "Lessee"
 28      },
 29      "name": "Test2",
 30      "description": "test2",
 31      "approverComment": "Approved after review",
 32      "snapshotData": {
 33        "isParallelCurrencyEnabled": true,
 34        "isCostCenterAllocationEnabled": false,
 35        "useSpotRateForGroupCurrency": true,
 36        "exchangeRateTypes": [
 37          {
 38            "currencyDefinitionType": "CONTRACT_CURRENCY",
 39            "sourceCurrencyType": "COMPANY_CURRENCY",
 40            "translationDateType": "POSTING_DATE",
 41            "targetCurrency": {
 42              "id": "string",
 43              "displayId": "US Dollar",
 44              "decimalPoints": 2
 45            },
 46            "referenceCurrency": {
 47              "id": "string",
 48              "displayId": "Euro"
 49            },
 50            "currencyType": "GROUP_CURRENCY",
 51            "exchangeRateType": "STANDARD"
 52          }
 53        ]
 54      },
 55      "revision": {
 56        "id": 10000001,
 57        "displayId": "0374999413-20250903-161147",
 58        "name": "Inception",
 59        "inception": true,
 60        "revisionType": "REVISION",
 61        "state": "MLA_DEFINE",
 62        "approvedBy": "approver.admin@nakisa.com",
 63        "approvedAt": "2019-08-24T14:15:22Z",
 64        "parentRevisionId": 10000000,
 65        "approverComment": "Approved after financial validation.",
 66        "rouStartDate": "2025-08-01",
 67        "rouEndDate": "2025-08-20",
 68        "activationGroupModification": {
 69          "modificationDate": "2025-08-15",
 70          "terminationType": "CASUALTY",
 71          "terminationDate": {
 72            "timing": "START_OF_DAY",
 73            "year": 2025,
 74            "monthValue": 9,
 75            "dayOfMonth": 4,
 76            "dayOfWeek": "THURSDAY",
 77            "leapYear": false,
 78            "dayOfYear": 247,
 79            "month": "SEPTEMBER"
 80          },
 81          "useManualFmvValue": true,
 82          "useManualAssetValues": false,
 83          "enforceNonLeaseOnIndexation": false,
 84          "applyIndexationLease": true,
 85          "applyIndexationNonLease": false,
 86          "indexationTreatmentType": "DEFAULT",
 87          "indexationStartDate": "2025-09-01",
 88          "indexationDateType": "USER_DEFINED",
 89          "indexationStartDateNonLease": "2025-09-10",
 90          "indexationDateTypeNonLease": "USER_DEFINED",
 91          "modificationReasons": [
 92            "CONTRACT_RATE_CHANGE",
 93            "INDEXATION"
 94          ],
 95          "modificationPerClassificationList": [
 96            {
 97              "accountingStandardId": 1001,
 98              "classificationType": "NON_LEASE",
 99              "accountingStandardType": "IFRS",
100              "impairmentAmount": 2500.5,
101              "recoverableAmount": 2000,
102              "decreaseInAsset": 1500,
103              "decreaseInTerm": 6
104            }
105          ],
106          "massIndexationTaskId": 987654
107        },
108        "activationGroupId": 10000001,
109        "activationGroupDisplayId": "AG-100000000",
110        "activationGroupName": "Test2",
111        "leaseComponentRevisionId": 10000007,
112        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
113        "lastLeaseComponentRevisionId": 10000006,
114        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
115        "clonedFromRevisionId": 10000002,
116        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
117        "lockReason": "PENDING_TERMINATION",
118        "infiniteUsefulLife": false,
119        "transferOfOwnership": false,
120        "specializedAsset": false,
121        "fairMarketValue": 1,
122        "residualValue": 1,
123        "endOfTermIntention": "TO_BE_DETERMINED",
124        "endOfTermDate": "2025-08-11",
125        "endOfTermPeriod": 9,
126        "activationDocumentDate": "2019-08-24",
127        "activationPostingDate": "2019-08-24",
128        "closingDocumentDate": "2019-08-24",
129        "closingPostingDate": "2019-08-24",
130        "numberRangeIdentifierType": {
131          "name": "COMPANY_CODE"
132        },
133        "numberRangeIdentifierValue": "1000",
134        "numberRangeType": {
135          "name": "CONTRACT"
136        },
137        "allowsSystemGenerateNewId": false
138      },
139      "leaseComponentId": 10000007,
140      "leaseComponentDisplayId": "LC-100000200",
141      "companyCodeId": 10000002,
142      "companyCodeDisplayId": "1000",
143      "splittedFromActivationGroupRevisionId": {
144        "id": 10000001,
145        "displayId": "0374999413-20250903-161147",
146        "name": "Inception",
147        "inception": true,
148        "revisionType": "REVISION",
149        "state": "MLA_DEFINE",
150        "approvedBy": "approver.admin@nakisa.com",
151        "approvedAt": "2019-08-24T14:15:22Z",
152        "parentRevisionId": 10000000,
153        "approverComment": "Approved after financial validation.",
154        "rouStartDate": "2025-08-01",
155        "rouEndDate": "2025-08-20",
156        "activationGroupModification": {
157          "modificationDate": "2025-08-15",
158          "terminationType": "CASUALTY",
159          "terminationDate": {
160            "timing": "START_OF_DAY",
161            "year": 2025,
162            "monthValue": 9,
163            "dayOfMonth": 4,
164            "dayOfWeek": "THURSDAY",
165            "leapYear": false,
166            "dayOfYear": 247,
167            "month": "SEPTEMBER"
168          },
169          "useManualFmvValue": true,
170          "useManualAssetValues": false,
171          "enforceNonLeaseOnIndexation": false,
172          "applyIndexationLease": true,
173          "applyIndexationNonLease": false,
174          "indexationTreatmentType": "DEFAULT",
175          "indexationStartDate": "2025-09-01",
176          "indexationDateType": "USER_DEFINED",
177          "indexationStartDateNonLease": "2025-09-10",
178          "indexationDateTypeNonLease": "USER_DEFINED",
179          "modificationReasons": [
180            "CONTRACT_RATE_CHANGE",
181            "INDEXATION"
182          ],
183          "modificationPerClassificationList": [
184            {
185              "accountingStandardId": 1001,
186              "classificationType": "NON_LEASE",
187              "accountingStandardType": "IFRS",
188              "impairmentAmount": 2500.5,
189              "recoverableAmount": 2000,
190              "decreaseInAsset": 1500,
191              "decreaseInTerm": 6
192            }
193          ],
194          "massIndexationTaskId": 987654
195        },
196        "activationGroupId": 10000001,
197        "activationGroupDisplayId": "AG-100000000",
198        "activationGroupName": "Test2",
199        "leaseComponentRevisionId": 10000007,
200        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
201        "lastLeaseComponentRevisionId": 10000006,
202        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
203        "clonedFromRevisionId": 10000002,
204        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
205        "lockReason": "PENDING_TERMINATION",
206        "infiniteUsefulLife": false,
207        "transferOfOwnership": false,
208        "specializedAsset": false,
209        "fairMarketValue": 1,
210        "residualValue": 1,
211        "endOfTermIntention": "TO_BE_DETERMINED",
212        "endOfTermDate": "2025-08-11",
213        "endOfTermPeriod": 9,
214        "activationDocumentDate": "2019-08-24",
215        "activationPostingDate": "2019-08-24",
216        "closingDocumentDate": "2019-08-24",
217        "closingPostingDate": "2019-08-24",
218        "numberRangeIdentifierType": {
219          "name": "COMPANY_CODE"
220        },
221        "numberRangeIdentifierValue": "1000",
222        "numberRangeType": {
223          "name": "CONTRACT"
224        },
225        "allowsSystemGenerateNewId": false
226      },
227      "notifications": [
228        {
229          "id": 100045,
230          "topic": {
231            "enCaption": "Lease Component Updated",
232            "frCaption": "Composant de bail mis à jour",
233            "name": "LEASE_COMPONENT_UPDATED",
234            "priority": "HIGH"
235          },
236          "username": "jdoe",
237          "activationGroupId": 20000123,
238          "activationGroupDisplayId": "AG-100045",
239          "targetId": "jdoe@example.com",
240          "targetType": "USER"
241        }
242      ],
243      "transferInfo": {
244        "transferredFromDisplayId": "CTR-00012",
245        "transferredFromRevisionId": 20000001,
246        "transferredToDisplayId": "CTR-00015",
247        "transferredToRevisionId": 20000005
248      },
249      "numberRangeIdentifierType": {
250        "name": "COMPANY_CODE"
251      },
252      "numberRangeIdentifierValue": "1000",
253      "numberRangeType": {
254        "name": "CONTRACT"
255      },
256      "allowsSystemGenerateNewId": false
257    }
258  ],
259  "number": 0,
260  "sort": {
261    "unsorted": false,
262    "sorted": true,
263    "empty": false
264  },
265  "empty": false
266}

Find All

HTTP Request

GET /api/v1/periodic_posting_status_reports/jobs

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "totalPages": 0,
  3  "totalElements": 0,
  4  "pageable": {
  5    "unpaged": false,
  6    "paged": true,
  7    "pageSize": 100,
  8    "pageNumber": 0,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 0,
 17  "first": true,
 18  "last": true,
 19  "size": 0,
 20  "content": [
 21    {
 22      "id": 0,
 23      "taskCount": 0,
 24      "failedTaskCount": 0,
 25      "doneTaskCount": 0,
 26      "inProgressTaskCount": 0,
 27      "cancelledTaskCount": 0,
 28      "errorMessage": "string",
 29      "executor": "SCHEDULER",
 30      "scheduleJobId": 0,
 31      "batchSize": 1000,
 32      "totalObjectCount": 0,
 33      "profileId": 0,
 34      "readOnly": true,
 35      "status": "CREATED",
 36      "fileStorageId": "string",
 37      "generatingExportFile": true,
 38      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 39      "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 40      "input": {
 41        "id": 0,
 42        "accountingStandardType": "GAAP",
 43        "classifications": [
 44          "NON_LEASE"
 45        ],
 46        "fromYear": 0,
 47        "fromPeriod": {
 48          "id": 0,
 49          "displayId": "string",
 50          "status": "CREATED",
 51          "day": 0,
 52          "year": 0,
 53          "month": 0,
 54          "postingPeriod": 0,
 55          "yearShift": 0
 56        },
 57        "toYear": 0,
 58        "toPeriod": {
 59          "id": 0,
 60          "displayId": "string",
 61          "status": "CREATED",
 62          "day": 0,
 63          "year": 0,
 64          "month": 0,
 65          "postingPeriod": 0,
 66          "yearShift": 0
 67        },
 68        "fromDate": "2019-08-24",
 69        "toDate": "2019-08-24",
 70        "postingType": "ALL",
 71        "externalStatusFilterType": "ALL",
 72        "externalStatuses": [
 73          "NA"
 74        ],
 75        "internalStatusFilterType": "ALL",
 76        "internalStatuses": [
 77          "NA"
 78        ],
 79        "listObjectType": "ACTIVATION_GROUP",
 80        "objectList": [
 81          {
 82            "id": 0,
 83            "displayId": "string",
 84            "name": "string"
 85          }
 86        ],
 87        "migratedFilterType": "MIGRATED",
 88        "internalAssetClassFilterType": "ALL",
 89        "internalAssetClasses": [
 90          {
 91            "id": 10000001,
 92            "displayId": "IAC-001",
 93            "status": {
 94              "name": "ACTIVE",
 95              "captionKey": "enum.objectStatus.active",
 96              "active": true,
 97              "caption": "Active"
 98            },
 99            "name": "Machinery and Equipment",
100            "assetClassType": "PROPERTY",
101            "infiniteUsefulLife": false
102          }
103        ],
104        "businessAreaFilterType": "ALL",
105        "businessAreas": [
106          {
107            "id": 3001,
108            "displayId": "BA-2025-001",
109            "status": {
110              "name": "ACTIVE",
111              "captionKey": "enum.objectStatus.active",
112              "active": true,
113              "caption": "Active"
114            },
115            "name": "North America Operations"
116          }
117        ],
118        "functionalAreaFilterType": "ALL",
119        "functionalAreas": [
120          {
121            "id": 2001,
122            "displayId": "FA-2025-001",
123            "status": {
124              "name": "ACTIVE",
125              "captionKey": "enum.objectStatus.active",
126              "active": true,
127              "caption": "Active"
128            },
129            "name": "Accounting Department"
130          }
131        ]
132      },
133      "filter": {
134        "id": 0,
135        "name": "string",
136        "principalPositionType": "LESSEE",
137        "calendarType": "REGULAR_CALENDAR",
138        "fiscalYearVariant": {
139          "id": "string",
140          "displayId": "Euro"
141        },
142        "profileId": 0,
143        "jobId": 0,
144        "objectList": [
145          {
146            "id": "string",
147            "displayId": "Euro"
148          }
149        ],
150        "filterTypes": {
151          "erpSystemFilterType": "ALL",
152          "erpSystems": [
153            {
154              "id": 0,
155              "displayId": "string",
156              "status": "CREATED",
157              "name": "string",
158              "type": "NAKISA",
159              "sapVersion": "ECC_EHP5"
160            }
161          ],
162          "leaseAreaFilterType": "ALL",
163          "leaseAreas": [
164            {
165              "id": 10000001,
166              "displayId": "0001",
167              "status": {
168                "name": "ACTIVE",
169                "captionKey": "enum.objectStatus.active",
170                "active": true,
171                "caption": "Active"
172              },
173              "name": "Global Lease Area"
174            }
175          ],
176          "businessUnitFilterType": "ALL",
177          "businessUnits": [
178            {
179              "id": 10000001,
180              "displayId": "BU0001",
181              "status": {
182                "name": "ACTIVE",
183                "captionKey": "enum.objectStatus.active",
184                "active": true,
185                "caption": "Active"
186              },
187              "name": "North America Business Unit"
188            }
189          ],
190          "companyFilterType": "ALL",
191          "companies": [
192            {
193              "id": 10000006,
194              "displayId": "1005",
195              "status": {
196                "name": "ACTIVE",
197                "captionKey": "enum.objectStatus.active",
198                "active": true,
199                "caption": "Active"
200              },
201              "erpSystemId": 10000001,
202              "erpSystemDisplayId": "FINQ8S-300",
203              "countryId": 10000095,
204              "countryDisplayId": "CA",
205              "postingPeriodVariantId": 0,
206              "fiscalVariantId": 0
207            }
208          ],
209          "leaseDepartmentFilterType": "ALL",
210          "leaseDepartments": [
211            {
212              "id": 300001,
213              "displayId": "DEP-01",
214              "status": {
215                "name": "ACTIVE",
216                "captionKey": "enum.objectStatus.active",
217                "active": true,
218                "caption": "Active"
219              },
220              "name": "Finance Department"
221            }
222          ],
223          "leaseGroupFilterType": "ALL",
224          "leaseGroups": [
225            {
226              "id": 60000001,
227              "displayId": "LG-001",
228              "status": {
229                "name": "ACTIVE",
230                "captionKey": "enum.objectStatus.active",
231                "active": true,
232                "caption": "Active"
233              },
234              "name": "Global Lease Group"
235            }
236          ],
237          "costCenterFilterType": "ALL",
238          "costCenters": [
239            {
240              "id": 14001,
241              "displayId": "CC-001",
242              "status": {
243                "name": "ACTIVE",
244                "captionKey": "enum.objectStatus.active",
245                "active": true,
246                "caption": "Active"
247              },
248              "name": "Cost Center A"
249            }
250          ],
251          "profitCenterFilterType": "ALL",
252          "profitCenters": [
253            {
254              "id": 9001,
255              "displayId": "PC-001",
256              "status": {
257                "name": "ACTIVE",
258                "captionKey": "enum.objectStatus.active",
259                "active": true,
260                "caption": "Active"
261              },
262              "name": "North Region Profit Center",
263              "validTo": "2025-12-31",
264              "erpSystemId": 101,
265              "erpSystemDisplayId": "SAP-01"
266            }
267          ],
268          "wbsFilterType": "ALL",
269          "wbses": [
270            {
271              "id": 1001,
272              "displayId": "WBS-2025-001",
273              "status": {
274                "name": "ACTIVE",
275                "captionKey": "enum.objectStatus.active",
276                "active": true,
277                "caption": "Active"
278              },
279              "name": "Main Project WBS"
280            }
281          ],
282          "businessAreaFilterType": "ALL",
283          "businessAreas": [
284            {
285              "id": 3001,
286              "displayId": "BA-2025-001",
287              "status": {
288                "name": "ACTIVE",
289                "captionKey": "enum.objectStatus.active",
290                "active": true,
291                "caption": "Active"
292              },
293              "name": "North America Operations"
294            }
295          ],
296          "functionalAreaFilterType": "ALL",
297          "functionalAreas": [
298            {
299              "id": 2001,
300              "displayId": "FA-2025-001",
301              "status": {
302                "name": "ACTIVE",
303                "captionKey": "enum.objectStatus.active",
304                "active": true,
305                "caption": "Active"
306              },
307              "name": "Accounting Department"
308            }
309          ]
310        }
311      },
312      "tasks": [
313        {
314          "id": 0,
315          "queueTime": "2019-08-24T14:15:22Z",
316          "startTime": "2019-08-24T14:15:22Z",
317          "endTime": "2019-08-24T14:15:22Z",
318          "interruptedAt": "2019-08-24T14:15:22Z",
319          "recoveredAt": "2019-08-24T14:15:22Z",
320          "status": "CREATED",
321          "recover": true,
322          "interrupted": true,
323          "interruptionMessage": "string",
324          "errorMessage": "string",
325          "reportJobId": 0,
326          "unitIds": [
327            0
328          ],
329          "jsonFileStorageId": "string",
330          "jsonDocStoreIds": [
331            0
332          ]
333        }
334      ],
335      "docStoreId": 0
336    }
337  ],
338  "number": 0,
339  "sort": {
340    "unsorted": false,
341    "sorted": true,
342    "empty": false
343  },
344  "empty": true
345}

Create

HTTP Request

POST /api/v1/periodic_posting_status_reports/jobs

Parameters

Name

In

Type

Required

Description

body

body

PeriodicPostingStatusReportJobDto

true

none

Body Parameters

  1{
  2  "id": 0,
  3  "taskCount": 0,
  4  "failedTaskCount": 0,
  5  "doneTaskCount": 0,
  6  "inProgressTaskCount": 0,
  7  "cancelledTaskCount": 0,
  8  "errorMessage": "string",
  9  "executor": "SCHEDULER",
 10  "scheduleJobId": 0,
 11  "batchSize": 1000,
 12  "totalObjectCount": 0,
 13  "profileId": 0,
 14  "readOnly": true,
 15  "status": "CREATED",
 16  "fileStorageId": "string",
 17  "generatingExportFile": true,
 18  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 19  "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 20  "input": {
 21    "id": 0,
 22    "accountingStandardType": "GAAP",
 23    "classifications": [
 24      "NON_LEASE"
 25    ],
 26    "fromYear": 0,
 27    "fromPeriod": {
 28      "id": 0,
 29      "displayId": "string",
 30      "status": "CREATED",
 31      "day": 0,
 32      "year": 0,
 33      "month": 0,
 34      "postingPeriod": 0,
 35      "yearShift": 0
 36    },
 37    "toYear": 0,
 38    "toPeriod": {
 39      "id": 0,
 40      "displayId": "string",
 41      "status": "CREATED",
 42      "day": 0,
 43      "year": 0,
 44      "month": 0,
 45      "postingPeriod": 0,
 46      "yearShift": 0
 47    },
 48    "fromDate": "2019-08-24",
 49    "toDate": "2019-08-24",
 50    "postingType": "ALL",
 51    "externalStatusFilterType": "ALL",
 52    "externalStatuses": [
 53      "NA"
 54    ],
 55    "internalStatusFilterType": "ALL",
 56    "internalStatuses": [
 57      "NA"
 58    ],
 59    "listObjectType": "ACTIVATION_GROUP",
 60    "objectList": [
 61      {
 62        "id": 0,
 63        "displayId": "string",
 64        "name": "string"
 65      }
 66    ],
 67    "migratedFilterType": "MIGRATED",
 68    "internalAssetClassFilterType": "ALL",
 69    "internalAssetClasses": [
 70      {
 71        "id": 10000001,
 72        "displayId": "IAC-001",
 73        "status": {
 74          "name": "ACTIVE",
 75          "captionKey": "enum.objectStatus.active",
 76          "active": true,
 77          "caption": "Active"
 78        },
 79        "name": "Machinery and Equipment",
 80        "assetClassType": "PROPERTY",
 81        "infiniteUsefulLife": false
 82      }
 83    ],
 84    "businessAreaFilterType": "ALL",
 85    "businessAreas": [
 86      {
 87        "id": 3001,
 88        "displayId": "BA-2025-001",
 89        "status": {
 90          "name": "ACTIVE",
 91          "captionKey": "enum.objectStatus.active",
 92          "active": true,
 93          "caption": "Active"
 94        },
 95        "name": "North America Operations"
 96      }
 97    ],
 98    "functionalAreaFilterType": "ALL",
 99    "functionalAreas": [
100      {
101        "id": 2001,
102        "displayId": "FA-2025-001",
103        "status": {
104          "name": "ACTIVE",
105          "captionKey": "enum.objectStatus.active",
106          "active": true,
107          "caption": "Active"
108        },
109        "name": "Accounting Department"
110      }
111    ]
112  },
113  "filter": {
114    "id": 0,
115    "name": "string",
116    "principalPositionType": "LESSEE",
117    "calendarType": "REGULAR_CALENDAR",
118    "fiscalYearVariant": {
119      "id": "string",
120      "displayId": "Euro"
121    },
122    "profileId": 0,
123    "jobId": 0,
124    "objectList": [
125      {
126        "id": "string",
127        "displayId": "Euro"
128      }
129    ],
130    "filterTypes": {
131      "erpSystemFilterType": "ALL",
132      "erpSystems": [
133        {
134          "id": 0,
135          "displayId": "string",
136          "status": "CREATED",
137          "name": "string",
138          "type": "NAKISA",
139          "sapVersion": "ECC_EHP5"
140        }
141      ],
142      "leaseAreaFilterType": "ALL",
143      "leaseAreas": [
144        {
145          "id": 10000001,
146          "displayId": "0001",
147          "status": {
148            "name": "ACTIVE",
149            "captionKey": "enum.objectStatus.active",
150            "active": true,
151            "caption": "Active"
152          },
153          "name": "Global Lease Area"
154        }
155      ],
156      "businessUnitFilterType": "ALL",
157      "businessUnits": [
158        {
159          "id": 10000001,
160          "displayId": "BU0001",
161          "status": {
162            "name": "ACTIVE",
163            "captionKey": "enum.objectStatus.active",
164            "active": true,
165            "caption": "Active"
166          },
167          "name": "North America Business Unit"
168        }
169      ],
170      "companyFilterType": "ALL",
171      "companies": [
172        {
173          "id": 10000006,
174          "displayId": "1005",
175          "status": {
176            "name": "ACTIVE",
177            "captionKey": "enum.objectStatus.active",
178            "active": true,
179            "caption": "Active"
180          },
181          "erpSystemId": 10000001,
182          "erpSystemDisplayId": "FINQ8S-300",
183          "countryId": 10000095,
184          "countryDisplayId": "CA",
185          "postingPeriodVariantId": 0,
186          "fiscalVariantId": 0
187        }
188      ],
189      "leaseDepartmentFilterType": "ALL",
190      "leaseDepartments": [
191        {
192          "id": 300001,
193          "displayId": "DEP-01",
194          "status": {
195            "name": "ACTIVE",
196            "captionKey": "enum.objectStatus.active",
197            "active": true,
198            "caption": "Active"
199          },
200          "name": "Finance Department"
201        }
202      ],
203      "leaseGroupFilterType": "ALL",
204      "leaseGroups": [
205        {
206          "id": 60000001,
207          "displayId": "LG-001",
208          "status": {
209            "name": "ACTIVE",
210            "captionKey": "enum.objectStatus.active",
211            "active": true,
212            "caption": "Active"
213          },
214          "name": "Global Lease Group"
215        }
216      ],
217      "costCenterFilterType": "ALL",
218      "costCenters": [
219        {
220          "id": 14001,
221          "displayId": "CC-001",
222          "status": {
223            "name": "ACTIVE",
224            "captionKey": "enum.objectStatus.active",
225            "active": true,
226            "caption": "Active"
227          },
228          "name": "Cost Center A"
229        }
230      ],
231      "profitCenterFilterType": "ALL",
232      "profitCenters": [
233        {
234          "id": 9001,
235          "displayId": "PC-001",
236          "status": {
237            "name": "ACTIVE",
238            "captionKey": "enum.objectStatus.active",
239            "active": true,
240            "caption": "Active"
241          },
242          "name": "North Region Profit Center",
243          "validTo": "2025-12-31",
244          "erpSystemId": 101,
245          "erpSystemDisplayId": "SAP-01"
246        }
247      ],
248      "wbsFilterType": "ALL",
249      "wbses": [
250        {
251          "id": 1001,
252          "displayId": "WBS-2025-001",
253          "status": {
254            "name": "ACTIVE",
255            "captionKey": "enum.objectStatus.active",
256            "active": true,
257            "caption": "Active"
258          },
259          "name": "Main Project WBS"
260        }
261      ],
262      "businessAreaFilterType": "ALL",
263      "businessAreas": [
264        {
265          "id": 3001,
266          "displayId": "BA-2025-001",
267          "status": {
268            "name": "ACTIVE",
269            "captionKey": "enum.objectStatus.active",
270            "active": true,
271            "caption": "Active"
272          },
273          "name": "North America Operations"
274        }
275      ],
276      "functionalAreaFilterType": "ALL",
277      "functionalAreas": [
278        {
279          "id": 2001,
280          "displayId": "FA-2025-001",
281          "status": {
282            "name": "ACTIVE",
283            "captionKey": "enum.objectStatus.active",
284            "active": true,
285            "caption": "Active"
286          },
287          "name": "Accounting Department"
288        }
289      ]
290    }
291  },
292  "tasks": [
293    {
294      "id": 0,
295      "queueTime": "2019-08-24T14:15:22Z",
296      "startTime": "2019-08-24T14:15:22Z",
297      "endTime": "2019-08-24T14:15:22Z",
298      "interruptedAt": "2019-08-24T14:15:22Z",
299      "recoveredAt": "2019-08-24T14:15:22Z",
300      "status": "CREATED",
301      "recover": true,
302      "interrupted": true,
303      "interruptionMessage": "string",
304      "errorMessage": "string",
305      "reportJobId": 0,
306      "unitIds": [
307        0
308      ],
309      "jsonFileStorageId": "string",
310      "jsonDocStoreIds": [
311        0
312      ]
313    }
314  ],
315  "docStoreId": 0
316}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePeriodicPostingStatusReportJobDto

Example Responses

  1{
  2  "code": "UPDATED",
  3  "errors": {
  4    "all": [
  5      {
  6        "type": "GENERIC",
  7        "source": {},
  8        "field": "string",
  9        "errorKey": "string",
 10        "errorMessage": "string"
 11      }
 12    ]
 13  },
 14  "object": {
 15    "id": 0,
 16    "taskCount": 0,
 17    "failedTaskCount": 0,
 18    "doneTaskCount": 0,
 19    "inProgressTaskCount": 0,
 20    "cancelledTaskCount": 0,
 21    "errorMessage": "string",
 22    "executor": "SCHEDULER",
 23    "scheduleJobId": 0,
 24    "batchSize": 1000,
 25    "totalObjectCount": 0,
 26    "profileId": 0,
 27    "readOnly": true,
 28    "status": "CREATED",
 29    "fileStorageId": "string",
 30    "generatingExportFile": true,
 31    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 32    "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 33    "input": {
 34      "id": 0,
 35      "accountingStandardType": "GAAP",
 36      "classifications": [
 37        "NON_LEASE"
 38      ],
 39      "fromYear": 0,
 40      "fromPeriod": {
 41        "id": 0,
 42        "displayId": "string",
 43        "status": "CREATED",
 44        "day": 0,
 45        "year": 0,
 46        "month": 0,
 47        "postingPeriod": 0,
 48        "yearShift": 0
 49      },
 50      "toYear": 0,
 51      "toPeriod": {
 52        "id": 0,
 53        "displayId": "string",
 54        "status": "CREATED",
 55        "day": 0,
 56        "year": 0,
 57        "month": 0,
 58        "postingPeriod": 0,
 59        "yearShift": 0
 60      },
 61      "fromDate": "2019-08-24",
 62      "toDate": "2019-08-24",
 63      "postingType": "ALL",
 64      "externalStatusFilterType": "ALL",
 65      "externalStatuses": [
 66        "NA"
 67      ],
 68      "internalStatusFilterType": "ALL",
 69      "internalStatuses": [
 70        "NA"
 71      ],
 72      "listObjectType": "ACTIVATION_GROUP",
 73      "objectList": [
 74        {
 75          "id": 0,
 76          "displayId": "string",
 77          "name": "string"
 78        }
 79      ],
 80      "migratedFilterType": "MIGRATED",
 81      "internalAssetClassFilterType": "ALL",
 82      "internalAssetClasses": [
 83        {
 84          "id": 10000001,
 85          "displayId": "IAC-001",
 86          "status": {
 87            "name": "ACTIVE",
 88            "captionKey": "enum.objectStatus.active",
 89            "active": true,
 90            "caption": "Active"
 91          },
 92          "name": "Machinery and Equipment",
 93          "assetClassType": "PROPERTY",
 94          "infiniteUsefulLife": false
 95        }
 96      ],
 97      "businessAreaFilterType": "ALL",
 98      "businessAreas": [
 99        {
100          "id": 3001,
101          "displayId": "BA-2025-001",
102          "status": {
103            "name": "ACTIVE",
104            "captionKey": "enum.objectStatus.active",
105            "active": true,
106            "caption": "Active"
107          },
108          "name": "North America Operations"
109        }
110      ],
111      "functionalAreaFilterType": "ALL",
112      "functionalAreas": [
113        {
114          "id": 2001,
115          "displayId": "FA-2025-001",
116          "status": {
117            "name": "ACTIVE",
118            "captionKey": "enum.objectStatus.active",
119            "active": true,
120            "caption": "Active"
121          },
122          "name": "Accounting Department"
123        }
124      ]
125    },
126    "filter": {
127      "id": 0,
128      "name": "string",
129      "principalPositionType": "LESSEE",
130      "calendarType": "REGULAR_CALENDAR",
131      "fiscalYearVariant": {
132        "id": "string",
133        "displayId": "Euro"
134      },
135      "profileId": 0,
136      "jobId": 0,
137      "objectList": [
138        {
139          "id": "string",
140          "displayId": "Euro"
141        }
142      ],
143      "filterTypes": {
144        "erpSystemFilterType": "ALL",
145        "erpSystems": [
146          {
147            "id": 0,
148            "displayId": "string",
149            "status": "CREATED",
150            "name": "string",
151            "type": "NAKISA",
152            "sapVersion": "ECC_EHP5"
153          }
154        ],
155        "leaseAreaFilterType": "ALL",
156        "leaseAreas": [
157          {
158            "id": 10000001,
159            "displayId": "0001",
160            "status": {
161              "name": "ACTIVE",
162              "captionKey": "enum.objectStatus.active",
163              "active": true,
164              "caption": "Active"
165            },
166            "name": "Global Lease Area"
167          }
168        ],
169        "businessUnitFilterType": "ALL",
170        "businessUnits": [
171          {
172            "id": 10000001,
173            "displayId": "BU0001",
174            "status": {
175              "name": "ACTIVE",
176              "captionKey": "enum.objectStatus.active",
177              "active": true,
178              "caption": "Active"
179            },
180            "name": "North America Business Unit"
181          }
182        ],
183        "companyFilterType": "ALL",
184        "companies": [
185          {
186            "id": 10000006,
187            "displayId": "1005",
188            "status": {
189              "name": "ACTIVE",
190              "captionKey": "enum.objectStatus.active",
191              "active": true,
192              "caption": "Active"
193            },
194            "erpSystemId": 10000001,
195            "erpSystemDisplayId": "FINQ8S-300",
196            "countryId": 10000095,
197            "countryDisplayId": "CA",
198            "postingPeriodVariantId": 0,
199            "fiscalVariantId": 0
200          }
201        ],
202        "leaseDepartmentFilterType": "ALL",
203        "leaseDepartments": [
204          {
205            "id": 300001,
206            "displayId": "DEP-01",
207            "status": {
208              "name": "ACTIVE",
209              "captionKey": "enum.objectStatus.active",
210              "active": true,
211              "caption": "Active"
212            },
213            "name": "Finance Department"
214          }
215        ],
216        "leaseGroupFilterType": "ALL",
217        "leaseGroups": [
218          {
219            "id": 60000001,
220            "displayId": "LG-001",
221            "status": {
222              "name": "ACTIVE",
223              "captionKey": "enum.objectStatus.active",
224              "active": true,
225              "caption": "Active"
226            },
227            "name": "Global Lease Group"
228          }
229        ],
230        "costCenterFilterType": "ALL",
231        "costCenters": [
232          {
233            "id": 14001,
234            "displayId": "CC-001",
235            "status": {
236              "name": "ACTIVE",
237              "captionKey": "enum.objectStatus.active",
238              "active": true,
239              "caption": "Active"
240            },
241            "name": "Cost Center A"
242          }
243        ],
244        "profitCenterFilterType": "ALL",
245        "profitCenters": [
246          {
247            "id": 9001,
248            "displayId": "PC-001",
249            "status": {
250              "name": "ACTIVE",
251              "captionKey": "enum.objectStatus.active",
252              "active": true,
253              "caption": "Active"
254            },
255            "name": "North Region Profit Center",
256            "validTo": "2025-12-31",
257            "erpSystemId": 101,
258            "erpSystemDisplayId": "SAP-01"
259          }
260        ],
261        "wbsFilterType": "ALL",
262        "wbses": [
263          {
264            "id": 1001,
265            "displayId": "WBS-2025-001",
266            "status": {
267              "name": "ACTIVE",
268              "captionKey": "enum.objectStatus.active",
269              "active": true,
270              "caption": "Active"
271            },
272            "name": "Main Project WBS"
273          }
274        ],
275        "businessAreaFilterType": "ALL",
276        "businessAreas": [
277          {
278            "id": 3001,
279            "displayId": "BA-2025-001",
280            "status": {
281              "name": "ACTIVE",
282              "captionKey": "enum.objectStatus.active",
283              "active": true,
284              "caption": "Active"
285            },
286            "name": "North America Operations"
287          }
288        ],
289        "functionalAreaFilterType": "ALL",
290        "functionalAreas": [
291          {
292            "id": 2001,
293            "displayId": "FA-2025-001",
294            "status": {
295              "name": "ACTIVE",
296              "captionKey": "enum.objectStatus.active",
297              "active": true,
298              "caption": "Active"
299            },
300            "name": "Accounting Department"
301          }
302        ]
303      }
304    },
305    "tasks": [
306      {
307        "id": 0,
308        "queueTime": "2019-08-24T14:15:22Z",
309        "startTime": "2019-08-24T14:15:22Z",
310        "endTime": "2019-08-24T14:15:22Z",
311        "interruptedAt": "2019-08-24T14:15:22Z",
312        "recoveredAt": "2019-08-24T14:15:22Z",
313        "status": "CREATED",
314        "recover": true,
315        "interrupted": true,
316        "interruptionMessage": "string",
317        "errorMessage": "string",
318        "reportJobId": 0,
319        "unitIds": [
320          0
321        ],
322        "jsonFileStorageId": "string",
323        "jsonDocStoreIds": [
324          0
325        ]
326      }
327    ],
328    "docStoreId": 0
329  }
330}

Bulk Delete

HTTP Request

DELETE /api/v1/periodic_posting_status_reports/jobs

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

none

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "source": {},
 8        "field": "string",
 9        "errorKey": "string",
10        "errorMessage": "string"
11      }
12    ]
13  },
14  "object": {}
15}

List All Posting Type Options

HTTP Request

GET /api/v1/periodic_posting_status_reports/jobs/posting_types

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "ALL"
3]

Response Schema

Generate Report To Excel

HTTP Request

GET /api/v1/periodic_posting_status_reports/jobs/generate_report/{jobId}

Parameters

Name

In

Type

Required

Description

jobId

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Download Report To Excel

HTTP Request

GET /api/v1/periodic_posting_status_reports/jobs/download_report/{jobId}

Parameters

Name

In

Type

Required

Description

jobId

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Get Calendar Types

HTTP Request

GET /api/v1/periodic_posting_status_reports/jobs/calendar_types

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "REGULAR_CALENDAR"
3]

Response Schema