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

Interface PaymentAdviceService

All Superinterfaces:
BatchService<PaymentAdviceServiceBatch>
All Known Implementing Classes:
DefaultPaymentAdviceService
@Deprecated public interface PaymentAdviceService extends BatchService<PaymentAdviceServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

You can use this inbound synchronous service to create, read, update, and delete payment advices related to a customer or a supplier. It is based on the OData protocol and can be consumed in SAP Fiori apps and other user interfaces. The service can be used with payment advices of any supported type..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_PAYMENT_ADVICE_SRV
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Finance - Payment Advice Integration(SAP_COM_0331)
Scope Items: Accounts Receivable(J59), Accounts Receivable(O59)
Authentication Methods: x509
Business Object: Payment Advice

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull PaymentAdviceService 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.

    • getAllPaymentAdvice

      @Nonnull PaymentAdviceFluentHelper getAllPaymentAdvice()
      Deprecated.
      Fetch multiple PaymentAdvice entities.
      Returns:
      A fluent helper to fetch multiple PaymentAdvice entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getPaymentAdviceByKey

      @Nonnull PaymentAdviceByKeyFluentHelper getPaymentAdviceByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice)
      Deprecated.
      Fetch a single PaymentAdvice entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      paymentAdviceAccountType - Payment Advice Account Type

      Constraints: Not nullable, Maximum length: 1

      paymentAdvice - Payment Advice Number

      Constraints: Not nullable, Maximum length: 16

      paymentAdviceAccount - Account Number

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single PaymentAdvice entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • createPaymentAdvice

      @Nonnull PaymentAdviceCreateFluentHelper createPaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
      Deprecated.
      Create a new PaymentAdvice entity and save it to the S/4HANA system.
      Parameters:
      paymentAdvice - PaymentAdvice entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new PaymentAdvice entity. To perform execution, call the execute method on the fluent helper object.

    • updatePaymentAdvice

      @Nonnull PaymentAdviceUpdateFluentHelper updatePaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
      Deprecated.
      Update an existing PaymentAdvice entity and save it to the S/4HANA system.
      Parameters:
      paymentAdvice - PaymentAdvice entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing PaymentAdvice entity. To perform execution, call the execute method on the fluent helper object.

    • deletePaymentAdvice

      @Nonnull PaymentAdviceDeleteFluentHelper deletePaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
      Deprecated.
      Deletes an existing PaymentAdvice entity in the S/4HANA system.
      Parameters:
      paymentAdvice - PaymentAdvice entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing PaymentAdvice entity. To perform execution, call the execute method on the fluent helper object.

    • getAllPaymentAdviceItem

      @Nonnull PaymentAdviceItemFluentHelper getAllPaymentAdviceItem()
      Deprecated.
      Fetch multiple PaymentAdviceItem entities.
      Returns:
      A fluent helper to fetch multiple PaymentAdviceItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getPaymentAdviceItemByKey

      @Nonnull PaymentAdviceItemByKeyFluentHelper getPaymentAdviceItemByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice, String paymentAdviceItem)
      Deprecated.
      Fetch a single PaymentAdviceItem entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      paymentAdviceAccountType - Payment Advice Account Type

      Constraints: Not nullable, Maximum length: 1

      paymentAdvice - Payment Advice Number

      Constraints: Not nullable, Maximum length: 16

      paymentAdviceAccount - Account Number

      Constraints: Not nullable, Maximum length: 10

      paymentAdviceItem - Payment Advice Line Item

      Constraints: Not nullable, Maximum length: 5

      Returns:
      A fluent helper to fetch a single PaymentAdviceItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • createPaymentAdviceItem

      @Nonnull PaymentAdviceItemCreateFluentHelper createPaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
      Deprecated.
      Create a new PaymentAdviceItem entity and save it to the S/4HANA system.
      Parameters:
      paymentAdviceItem - PaymentAdviceItem entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new PaymentAdviceItem entity. To perform execution, call the execute method on the fluent helper object.

    • updatePaymentAdviceItem

      @Nonnull PaymentAdviceItemUpdateFluentHelper updatePaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
      Deprecated.
      Update an existing PaymentAdviceItem entity and save it to the S/4HANA system.
      Parameters:
      paymentAdviceItem - PaymentAdviceItem entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing PaymentAdviceItem entity. To perform execution, call the execute method on the fluent helper object.

    • deletePaymentAdviceItem

      @Nonnull PaymentAdviceItemDeleteFluentHelper deletePaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
      Deprecated.
      Deletes an existing PaymentAdviceItem entity in the S/4HANA system.
      Parameters:
      paymentAdviceItem - PaymentAdviceItem entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing PaymentAdviceItem entity. To perform execution, call the execute method on the fluent helper object.