Interface StatutoryReportingCategoryDefinitionService

All Known Implementing Classes:
DefaultStatutoryReportingCategoryDefinitionService

public interface StatutoryReportingCategoryDefinitionService

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

Business Documentation

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 Details

  • Method Details

    • withServicePath

      @Nonnull StatutoryReportingCategoryDefinitionService 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.
    • getAllActivityDef

      @Nonnull GetAllRequestBuilder<ActivityDef> getAllActivityDef()
      Fetch multiple ActivityDef entities.
      Returns:
      A request builder to fetch multiple ActivityDef 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.
    • countActivityDef

      @Nonnull CountRequestBuilder<ActivityDef> countActivityDef()
      Fetch the number of entries from the ActivityDef entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of ActivityDef 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.
    • getActivityDefByKey

      @Nonnull GetByKeyRequestBuilder<ActivityDef> getActivityDefByKey(String statryRptCategory, String statryRptActivityId)
      Fetch a single ActivityDef entity using key fields.
      Parameters:
      statryRptCategory - Report Category ID

      Constraints: Not nullable, Maximum length: 30

      statryRptActivityId - Activity ID

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single ActivityDef 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.
    • getAllCategoryDef

      @Nonnull GetAllRequestBuilder<CategoryDef> getAllCategoryDef()
      Fetch multiple CategoryDef entities.
      Returns:
      A request builder to fetch multiple CategoryDef 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.
    • countCategoryDef

      @Nonnull CountRequestBuilder<CategoryDef> countCategoryDef()
      Fetch the number of entries from the CategoryDef entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of CategoryDef 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.
    • getCategoryDefByKey

      @Nonnull GetByKeyRequestBuilder<CategoryDef> getCategoryDefByKey(String statryRptCategory)
      Fetch a single CategoryDef entity using key fields.
      Parameters:
      statryRptCategory - Report Category ID

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single CategoryDef 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.
    • getAllPhaseDef

      @Nonnull GetAllRequestBuilder<PhaseDef> getAllPhaseDef()
      Fetch multiple PhaseDef entities.
      Returns:
      A request builder to fetch multiple PhaseDef 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.
    • countPhaseDef

      @Nonnull CountRequestBuilder<PhaseDef> countPhaseDef()
      Fetch the number of entries from the PhaseDef entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of PhaseDef 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.
    • getPhaseDefByKey

      @Nonnull GetByKeyRequestBuilder<PhaseDef> getPhaseDefByKey(String statryRptCategory, String statryRptCatPhase, LocalDate statryRptCatPhaseValidFromDate)
      Fetch a single PhaseDef entity using key fields.
      Parameters:
      statryRptCatPhaseValidFromDate - Valid From Date

      Constraints: Not nullable

      statryRptCatPhase - Report Category Phase

      Constraints: Not nullable, Maximum length: 5

      statryRptCategory - Report Category ID

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single PhaseDef 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.