Interface ContractAccountingBusinessPartnerPaymentService

All Known Implementing Classes:
DefaultContractAccountingBusinessPartnerPaymentService

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

Retrieve a list of payments and make, release or withdraw payments. Read payment items and corresponding payment headers for a business partner. Payment items are either document items which are cleared by payments, payments on account or released payments. Post or release payments for an invoice or an open document item. A released payment can also be withdrawn until the corresponding items are not cleared. Only use the version 2 of the service. Do not use version 1 as this version is deprecated..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_CABUSPARTPAYMENT_0001
API Version: 1.1.0
Minimum ERP Version: 2208
Communication Scenario: Finance - Contract Accounting Open Item Management Integration(SAP_COM_0361)
Scope Items: Contract Accounting - Open Item Management(2UJ), Contract Accounting: Open Item Management(PUJ)
Service Group Name: API_CABUSPARTPAYMENT
Business Object: Contract Accounting Business Partner Payment
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull ContractAccountingBusinessPartnerPaymentService 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.
    • getBusPartPaymentByKey

      @Nonnull GetByKeyRequestBuilder<BusPartPaymentParameters> getBusPartPaymentByKey(String p_DisplayCurrency)
      Deprecated.
      Fetch a single BusPartPaymentParameters entity using key fields.
      Parameters:
      p_DisplayCurrency - Currency Key

      Constraints: Not nullable, Maximum length: 3

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

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

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

      @Nonnull GetByKeyRequestBuilder<BusPartPaymentHeader> getBusPartPaymentHeaderByKey(UUID cADocumentContainerPaymentUUID)
      Deprecated.
      Fetch a single BusPartPaymentHeader entity using key fields.
      Parameters:
      cADocumentContainerPaymentUUID - Document Container ID

      Constraints: Not nullable

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

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

      @Nonnull GetByKeyRequestBuilder<BusPartPaymentItemParameters> getBusPartPaymentItemByKey(String p_DisplayCurrency)
      Deprecated.
      Fetch a single BusPartPaymentItemParameters entity using key fields.
      Parameters:
      p_DisplayCurrency - Currency Key

      Constraints: Not nullable, Maximum length: 3

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