Interface StatutoryReportingTaskService
- All Known Implementing Classes:
DefaultStatutoryReportingTaskService
The service contains entities that represent the actions you can complete with this API. Each entity contained in this service is named after an action of Document and Reporting Compliance Task. - Task – Manage an Ad hoc task for the specified report. - Phase – Manage phases for the specified report. - Activity – Manage the activities for the specified report. - Run – Manage runs for the specified report. - RunParameter – Check the Run parameters used for the specified report..
Reference: SAP API Business Hub
Details:
| OData Service: | CE_STATUTORYREPORTINGTASK_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Finance - ACR Services for Partner Enablement Integration(SAP_COM_0775) |
| Scope Items: | Compliance Formats - Support Preparation(1J2) |
| Authentication Methods: | x509 |
| Service Group Name: | API_STATUTORYREPORTINGTASK |
| Business Object: | Statutory Reporting Task |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringIf no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Creates a batch request builder object.Fetch the number of entries from theActivityentity collection matching the filter and search expressions.Fetch the number of entries from thePhaseentity collection matching the filter and search expressions.countRun()Fetch the number of entries from theRunentity collection matching the filter and search expressions.Fetch the number of entries from theRunParameterentity collection matching the filter and search expressions.Fetch the number of entries from theTaskentity collection matching the filter and search expressions.createActivity(Activity activity) Create a newActivityentity and save it to the S/4HANA system.createPhase(Phase phase) Create a newPhaseentity and save it to the S/4HANA system.Create a newRunentity and save it to the S/4HANA system.createTask(Task task) Create a newTaskentity and save it to the S/4HANA system.deleteTask(Task task) Deletes an existingTaskentity in the S/4HANA system.getActivityByKey(UUID statryRptActivityUUID) Fetch a singleActivityentity using key fields.Fetch multipleActivityentities.Fetch multiplePhaseentities.Fetch multipleRunentities.Fetch multipleRunParameterentities.Fetch multipleTaskentities.getPhaseByKey(UUID statryRptPhaseUUID) Fetch a singlePhaseentity using key fields.getRunByKey(UUID statryRptRunUUID) Fetch a singleRunentity using key fields.getRunParameterByKey(UUID statryRptRunParamUUID) Fetch a singleRunParameterentity using key fields.getTaskByKey(UUID statryRptTaskUUID) Fetch a singleTaskentity using key fields.withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllActivity
Fetch multipleActivityentities. -
countActivity
Fetch the number of entries from theActivityentity collection matching the filter and search expressions. -
getActivityByKey
Fetch a singleActivityentity using key fields.- Parameters:
statryRptActivityUUID- NodeIDConstraints: Not nullable
- Returns:
- A request builder to fetch a single
Activityentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createActivity
Create a newActivityentity and save it to the S/4HANA system. -
getAllPhase
Fetch multiplePhaseentities. -
countPhase
Fetch the number of entries from thePhaseentity collection matching the filter and search expressions. -
getPhaseByKey
Fetch a singlePhaseentity using key fields.- Parameters:
statryRptPhaseUUID- NodeIDConstraints: Not nullable
- Returns:
- A request builder to fetch a single
Phaseentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createPhase
Create a newPhaseentity and save it to the S/4HANA system. -
getAllRun
Fetch multipleRunentities. -
countRun
Fetch the number of entries from theRunentity collection matching the filter and search expressions. -
getRunByKey
Fetch a singleRunentity using key fields.- Parameters:
statryRptRunUUID- NodeIDConstraints: Not nullable
- Returns:
- A request builder to fetch a single
Runentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createRun
Create a newRunentity and save it to the S/4HANA system. -
getAllRunParameter
Fetch multipleRunParameterentities.- Returns:
- A request builder to fetch multiple
RunParameterentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countRunParameter
Fetch the number of entries from theRunParameterentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
RunParameterentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getRunParameterByKey
Fetch a singleRunParameterentity using key fields.- Parameters:
statryRptRunParamUUID- NodeIDConstraints: Not nullable
- Returns:
- A request builder to fetch a single
RunParameterentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllTask
Fetch multipleTaskentities. -
countTask
Fetch the number of entries from theTaskentity collection matching the filter and search expressions. -
getTaskByKey
Fetch a singleTaskentity using key fields.- Parameters:
statryRptTaskUUID- NodeIDConstraints: Not nullable
- Returns:
- A request builder to fetch a single
Taskentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createTask
Create a newTaskentity and save it to the S/4HANA system. -
deleteTask
Deletes an existingTaskentity in the S/4HANA system.
-