Interface StatutoryReportingReportDefinitionService
- All Known Implementing Classes:
DefaultStatutoryReportingReportDefinitionService
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 Report Definition. - Report Definition – Read reports for specified report definition. - Report Parameter Definition – Read phases for the specified report definition. - Document Definition – Read activities for the specified report definition. .
Reference: SAP API Business Hub
Details:
| OData Service: | CE_STATRYRPTRPTDEFINITION_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_STATRYRPTRPTDEFINITION |
| Business Object: | Statutory Reporting Report 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 theDocumentDefentity collection matching the filter and search expressions.Fetch the number of entries from theReportDefentity collection matching the filter and search expressions.Fetch the number of entries from theReportParameterDefentity collection matching the filter and search expressions.Fetch multipleDocumentDefentities.Fetch multipleReportDefentities.Fetch multipleReportParameterDefentities.getDocumentDefByKey(String statryRptDef, String statryRptDocumentID) Fetch a singleDocumentDefentity using key fields.getReportDefByKey(String statryRptDef) Fetch a singleReportDefentity using key fields.getReportParameterDefByKey(String statryRptDef, String statryRptParameterID) Fetch a singleReportParameterDefentity 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.
-
getAllDocumentDef
Fetch multipleDocumentDefentities.- Returns:
- A request builder to fetch multiple
DocumentDefentities. 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.
-
countDocumentDef
Fetch the number of entries from theDocumentDefentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
DocumentDefentities. 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.
-
getDocumentDefByKey
@Nonnull GetByKeyRequestBuilder<DocumentDef> getDocumentDefByKey(String statryRptDef, String statryRptDocumentID) Fetch a singleDocumentDefentity using key fields.- Parameters:
statryRptDocumentID- Document IDConstraints: Not nullable, Maximum length: 30
statryRptDef- Report DefinitionConstraints: Not nullable, Maximum length: 30
- Returns:
- A request builder to fetch a single
DocumentDefentity 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.
-
getAllReportDef
Fetch multipleReportDefentities. -
countReportDef
Fetch the number of entries from theReportDefentity collection matching the filter and search expressions. -
getReportDefByKey
Fetch a singleReportDefentity using key fields.- Parameters:
statryRptDef- Report DefinitionConstraints: Not nullable, Maximum length: 30
- Returns:
- A request builder to fetch a single
ReportDefentity 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.
-
getAllReportParameterDef
Fetch multipleReportParameterDefentities.- Returns:
- A request builder to fetch multiple
ReportParameterDefentities. 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.
-
countReportParameterDef
Fetch the number of entries from theReportParameterDefentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ReportParameterDefentities. 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.
-
getReportParameterDefByKey
@Nonnull GetByKeyRequestBuilder<ReportParameterDef> getReportParameterDefByKey(String statryRptDef, String statryRptParameterID) Fetch a singleReportParameterDefentity using key fields.- Parameters:
statryRptDef- Report DefinitionConstraints: Not nullable, Maximum length: 30
statryRptParameterID- Report parameter identificatorConstraints: Not nullable, Maximum length: 30
- Returns:
- A request builder to fetch a single
ReportParameterDefentity 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.
-