Interface StatutoryReportingReportDefinitionService

All Known Implementing Classes:
DefaultStatutoryReportingReportDefinitionService

public interface StatutoryReportingReportDefinitionService

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. .

Business Documentation

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 Details

  • Method Details

    • withServicePath

      @Nonnull StatutoryReportingReportDefinitionService withServicePath(@Nonnull String servicePath)
      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

      @Nonnull BatchRequestBuilder batch()
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.
    • getAllDocumentDef

      @Nonnull GetAllRequestBuilder<DocumentDef> getAllDocumentDef()
      Fetch multiple DocumentDef entities.
      Returns:
      A request builder to fetch multiple DocumentDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countDocumentDef

      @Nonnull CountRequestBuilder<DocumentDef> countDocumentDef()
      Fetch the number of entries from the DocumentDef entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of DocumentDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getDocumentDefByKey

      @Nonnull GetByKeyRequestBuilder<DocumentDef> getDocumentDefByKey(String statryRptDef, String statryRptDocumentID)
      Fetch a single DocumentDef entity using key fields.
      Parameters:
      statryRptDocumentID - Document ID

      Constraints: Not nullable, Maximum length: 30

      statryRptDef - Report Definition

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single DocumentDef entity 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 the execute method on the request builder object.
    • getAllReportDef

      @Nonnull GetAllRequestBuilder<ReportDef> getAllReportDef()
      Fetch multiple ReportDef entities.
      Returns:
      A request builder to fetch multiple ReportDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countReportDef

      @Nonnull CountRequestBuilder<ReportDef> countReportDef()
      Fetch the number of entries from the ReportDef entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of ReportDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getReportDefByKey

      @Nonnull GetByKeyRequestBuilder<ReportDef> getReportDefByKey(String statryRptDef)
      Fetch a single ReportDef entity using key fields.
      Parameters:
      statryRptDef - Report Definition

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single ReportDef entity 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 the execute method on the request builder object.
    • getAllReportParameterDef

      @Nonnull GetAllRequestBuilder<ReportParameterDef> getAllReportParameterDef()
      Fetch multiple ReportParameterDef entities.
      Returns:
      A request builder to fetch multiple ReportParameterDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countReportParameterDef

      @Nonnull CountRequestBuilder<ReportParameterDef> countReportParameterDef()
      Fetch the number of entries from the ReportParameterDef entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of ReportParameterDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getReportParameterDefByKey

      @Nonnull GetByKeyRequestBuilder<ReportParameterDef> getReportParameterDefByKey(String statryRptDef, String statryRptParameterID)
      Fetch a single ReportParameterDef entity using key fields.
      Parameters:
      statryRptDef - Report Definition

      Constraints: Not nullable, Maximum length: 30

      statryRptParameterID - Report parameter identificator

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single ReportParameterDef entity 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 the execute method on the request builder object.