Interface StatutoryReportingCategoryDefinitionService
- All Known Implementing Classes:
DefaultStatutoryReportingCategoryDefinitionService
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 Category Definition. - Category Definition – Read categories for specified report category definition. - Phase Definition – Read phases for the specified report category definition. - Activity Definition – Read activities for the specified report category definition. .
Reference: SAP API Business Hub
Details:
| OData Service: | CE_STATRYRPTCATDEFINITION_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_STATRYRPTCATDEFINITION |
| Business Object: | Statutory Reporting Category Definition |
-
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 theActivityDefentity collection matching the filter and search expressions.Fetch the number of entries from theCategoryDefentity collection matching the filter and search expressions.Fetch the number of entries from thePhaseDefentity collection matching the filter and search expressions.getActivityDefByKey(String statryRptCategory, String statryRptActivityId) Fetch a singleActivityDefentity using key fields.Fetch multipleActivityDefentities.Fetch multipleCategoryDefentities.Fetch multiplePhaseDefentities.getCategoryDefByKey(String statryRptCategory) Fetch a singleCategoryDefentity using key fields.getPhaseDefByKey(String statryRptCategory, String statryRptCatPhase, LocalDate statryRptCatPhaseValidFromDate) Fetch a singlePhaseDefentity 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.
-
getAllActivityDef
Fetch multipleActivityDefentities.- Returns:
- A request builder to fetch multiple
ActivityDefentities. 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.
-
countActivityDef
Fetch the number of entries from theActivityDefentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ActivityDefentities. 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.
-
getActivityDefByKey
@Nonnull GetByKeyRequestBuilder<ActivityDef> getActivityDefByKey(String statryRptCategory, String statryRptActivityId) Fetch a singleActivityDefentity using key fields.- Parameters:
statryRptCategory- Report Category IDConstraints: Not nullable, Maximum length: 30
statryRptActivityId- Activity IDConstraints: Not nullable, Maximum length: 30
- Returns:
- A request builder to fetch a single
ActivityDefentity 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.
-
getAllCategoryDef
Fetch multipleCategoryDefentities.- Returns:
- A request builder to fetch multiple
CategoryDefentities. 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.
-
countCategoryDef
Fetch the number of entries from theCategoryDefentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CategoryDefentities. 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.
-
getCategoryDefByKey
Fetch a singleCategoryDefentity using key fields.- Parameters:
statryRptCategory- Report Category IDConstraints: Not nullable, Maximum length: 30
- Returns:
- A request builder to fetch a single
CategoryDefentity 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.
-
getAllPhaseDef
Fetch multiplePhaseDefentities. -
countPhaseDef
Fetch the number of entries from thePhaseDefentity collection matching the filter and search expressions. -
getPhaseDefByKey
@Nonnull GetByKeyRequestBuilder<PhaseDef> getPhaseDefByKey(String statryRptCategory, String statryRptCatPhase, LocalDate statryRptCatPhaseValidFromDate) Fetch a singlePhaseDefentity using key fields.- Parameters:
statryRptCatPhaseValidFromDate- Valid From DateConstraints: Not nullable
statryRptCatPhase- Report Category PhaseConstraints: Not nullable, Maximum length: 5
statryRptCategory- Report Category IDConstraints: Not nullable, Maximum length: 30
- Returns:
- A request builder to fetch a single
PhaseDefentity 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.
-