Interface SettlementDocumentTypeService

All Known Implementing Classes:
DefaultSettlementDocumentTypeService

@Deprecated public interface SettlementDocumentTypeService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

You retrieve the following data using this OData based service: You can read the Settlement Document Types and related information. You can navigate to the Header Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on header level. You can navigate to the Item Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on item level..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: SETTLMTDOCTYPE_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Logistics - Settlement Document Type Integration(SAP_COM_0709)
Scope Items: Sales Rebate Processing(1B6), Purchasing Rebate Processing(2R7), Sales Commissions - External Sales Representative(2TT), Internal Commissions Settlement with SAP Sales Cloud(3TD)
Authentication Methods: x509
Service Group Name: API_SETTLMT_DOC_TYPE
Business Object: Settlement Document Type
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull SettlementDocumentTypeService 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.
    • getAllSetlMgmtHdrTxtObjTypeAssgmt

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

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

      @Nonnull GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getSetlMgmtHdrTxtObjTypeAssgmtByKey(String settlmtHdrTxtDetnProced, String settlmtMgmtHdrTxtObjType)
      Deprecated.
      Fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields.
      Parameters:
      settlmtMgmtHdrTxtObjType - Specific Text ID for a Settlement Management Document Header

      Constraints: Not nullable, Maximum length: 4

      settlmtHdrTxtDetnProced - Text Determination Procedure for Header

      Constraints: Not nullable, Maximum length: 2

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

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

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

      @Nonnull GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getSetlMgmtItmTxtObjTypeAssgmtByKey(String settlmtItmTxtDetnProced, String settlmtMgmtItmTxtObjType)
      Deprecated.
      Fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields.
      Parameters:
      settlmtMgmtItmTxtObjType - Specific Text ID for a Settlement Management Document Item

      Constraints: Not nullable, Maximum length: 4

      settlmtItmTxtDetnProced - Text Determination Procedure for Item

      Constraints: Not nullable, Maximum length: 2

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

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

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

      @Nonnull GetByKeyRequestBuilder<SettlmtDocType> getSettlmtDocTypeByKey(String settlmtDocType)
      Deprecated.
      Fetch a single SettlmtDocType entity using key fields.
      Parameters:
      settlmtDocType - Settlement Document Type

      Constraints: Not nullable, Maximum length: 4

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