Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Interface SettlementDocumentService

All Known Implementing Classes:
DefaultSettlementDocumentService
@Deprecated public interface SettlementDocumentService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

You can use this OData-based service to do the following: Read the Settlement Documents on header and item level. Release Settlement Documents that were blocked to accounting and where the application status was not set. Reverse Settlement Documents. Read the relevant pricing elements for the Settlement Document header and item level. Complete Settlement Documents. Revoke the completion of Settlement Documents. Read the relevant partners for the Settlement Document header and item level..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: SETTLMTDOC_0001
API Version: 1.2.1
Minimum ERP Version: 2302
Communication Scenario: Logistics - Settlement Document Integration(SAP_COM_0714)
Scope Items: Sales Rebate Processing(1B6), Purchasing Rebate Processing(2R7), Sales Commissions - External Sales Representative(2TT), Royalties Settlement for Sales(55I)
Authentication Methods: x509
Service Group Name: API_SETTLMT_DOC
Business Object: Settlement Document

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull SettlementDocumentService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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()
      Deprecated.
      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.

    • getAllCustItmPricingElement

      @Nonnull GetAllRequestBuilder<CustItmPricingElement> getAllCustItmPricingElement()
      Deprecated.
      Fetch multiple CustItmPricingElement entities.
      Returns:
      A request builder to fetch multiple CustItmPricingElement 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.

    • countCustItmPricingElement

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

    • getCustItmPricingElementByKey

      @Nonnull GetByKeyRequestBuilder<CustItmPricingElement> getCustItmPricingElementByKey(String settlmtDoc, String settlmtDocItem, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single CustItmPricingElement entity using key fields.
      Parameters:
      pricingProcedureCounter - Pricing Procedure Counter

      Constraints: Not nullable, Maximum length: 3

      settlmtDocItem - Document Item

      Constraints: Not nullable, Maximum length: 6

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

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

    • getAllCustPricingElement

      @Nonnull GetAllRequestBuilder<CustPricingElement> getAllCustPricingElement()
      Deprecated.
      Fetch multiple CustPricingElement entities.
      Returns:
      A request builder to fetch multiple CustPricingElement 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.

    • countCustPricingElement

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

    • getCustPricingElementByKey

      @Nonnull GetByKeyRequestBuilder<CustPricingElement> getCustPricingElementByKey(String settlmtDoc, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single CustPricingElement entity using key fields.
      Parameters:
      pricingProcedureCounter - Pricing Procedure Counter

      Constraints: Not nullable, Maximum length: 3

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

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

    • getAllSetlDoc

      @Nonnull GetAllRequestBuilder<SetlDoc> getAllSetlDoc()
      Deprecated.
      Fetch multiple SetlDoc entities.
      Returns:
      A request builder to fetch multiple SetlDoc 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.

    • countSetlDoc

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

    • getSetlDocByKey

      @Nonnull GetByKeyRequestBuilder<SetlDoc> getSetlDocByKey(String settlmtDoc)
      Deprecated.
      Fetch a single SetlDoc entity using key fields.
      Parameters:
      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

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

    • createSetlDoc

      @Nonnull CreateRequestBuilder<SetlDoc> createSetlDoc(@Nonnull SetlDoc setlDoc)
      Deprecated.
      Create a new SetlDoc entity and save it to the S/4HANA system.
      Parameters:
      setlDoc - SetlDoc entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new SetlDoc entity. To perform execution, call the execute method on the request builder object.

    • getAllSetlDocItm

      @Nonnull GetAllRequestBuilder<SetlDocItm> getAllSetlDocItm()
      Deprecated.
      Fetch multiple SetlDocItm entities.
      Returns:
      A request builder to fetch multiple SetlDocItm 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.

    • countSetlDocItm

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

    • getSetlDocItmByKey

      @Nonnull GetByKeyRequestBuilder<SetlDocItm> getSetlDocItmByKey(String settlmtDoc, String settlmtDocItem)
      Deprecated.
      Fetch a single SetlDocItm entity using key fields.
      Parameters:
      settlmtDocItem - Document Item

      Constraints: Not nullable, Maximum length: 6

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

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

    • getAllSettlementDocumentItemPartner

      @Nonnull GetAllRequestBuilder<SettlementDocumentItemPartner> getAllSettlementDocumentItemPartner()
      Deprecated.
      Fetch multiple SettlementDocumentItemPartner entities.
      Returns:
      A request builder to fetch multiple SettlementDocumentItemPartner 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.

    • countSettlementDocumentItemPartner

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

    • getSettlementDocumentItemPartnerByKey

      @Nonnull GetByKeyRequestBuilder<SettlementDocumentItemPartner> getSettlementDocumentItemPartnerByKey(String settlmtDoc, String settlmtDocItem, String partnerFunction, String partnerCounter)
      Deprecated.
      Fetch a single SettlementDocumentItemPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      settlmtDocItem - Document Item

      Constraints: Not nullable, Maximum length: 6

      partnerCounter - Partner counter

      Constraints: Not nullable, Maximum length: 3

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

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

    • getAllSettlementDocumentPartner

      @Nonnull GetAllRequestBuilder<SettlementDocumentPartner> getAllSettlementDocumentPartner()
      Deprecated.
      Fetch multiple SettlementDocumentPartner entities.
      Returns:
      A request builder to fetch multiple SettlementDocumentPartner 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.

    • countSettlementDocumentPartner

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

    • getSettlementDocumentPartnerByKey

      @Nonnull GetByKeyRequestBuilder<SettlementDocumentPartner> getSettlementDocumentPartnerByKey(String settlmtDoc, String partnerFunction, String partnerCounter)
      Deprecated.
      Fetch a single SettlementDocumentPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      partnerCounter - Partner counter

      Constraints: Not nullable, Maximum length: 3

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

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

    • getAllSuplrItmPricingElement

      @Nonnull GetAllRequestBuilder<SuplrItmPricingElement> getAllSuplrItmPricingElement()
      Deprecated.
      Fetch multiple SuplrItmPricingElement entities.
      Returns:
      A request builder to fetch multiple SuplrItmPricingElement 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.

    • countSuplrItmPricingElement

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

    • getSuplrItmPricingElementByKey

      @Nonnull GetByKeyRequestBuilder<SuplrItmPricingElement> getSuplrItmPricingElementByKey(String settlmtDoc, String settlmtDocItem, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single SuplrItmPricingElement entity using key fields.
      Parameters:
      pricingProcedureCounter - Pricing Procedure Counter

      Constraints: Not nullable, Maximum length: 3

      settlmtDocItem - Document Item

      Constraints: Not nullable, Maximum length: 6

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

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

    • getAllSuplrPricingElement

      @Nonnull GetAllRequestBuilder<SuplrPricingElement> getAllSuplrPricingElement()
      Deprecated.
      Fetch multiple SuplrPricingElement entities.
      Returns:
      A request builder to fetch multiple SuplrPricingElement 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.

    • countSuplrPricingElement

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

    • getSuplrPricingElementByKey

      @Nonnull GetByKeyRequestBuilder<SuplrPricingElement> getSuplrPricingElementByKey(String settlmtDoc, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single SuplrPricingElement entity using key fields.
      Parameters:
      pricingProcedureCounter - Pricing Procedure Counter

      Constraints: Not nullable, Maximum length: 3

      settlmtDoc - Settlement Document Number

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

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