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

Class DefaultPaymentAdviceService

java.lang.Object

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

All Implemented Interfaces:

PaymentAdviceService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPaymentAdviceService")
public class DefaultPaymentAdviceService
extends Object
implements PaymentAdviceService

This service enables you to create, read, update, and delete payment advices of any supported type, both for customers and suppliers. 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 API Business Hub

Details:

OData Service:	API_PAYMENT_ADVICE_SRV
API Version:	1
Communication Scenario:	Finance - Payment Advice Integration (SAP_COM_0331)
Scope Items:	Accounts Receivable (J59)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	PaymentAdvice

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PaymentAdviceService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPaymentAdviceService() Creates a service using PaymentAdviceService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
PaymentAdviceCreateFluentHelper	createPaymentAdvice(PaymentAdvice paymentAdvice) Create a new PaymentAdvice entity and save it to the S/4HANA system.
PaymentAdviceItemCreateFluentHelper	createPaymentAdviceItem(PaymentAdviceItem paymentAdviceItem) Create a new PaymentAdviceItem entity and save it to the S/4HANA system.
PaymentAdviceDeleteFluentHelper	deletePaymentAdvice(PaymentAdvice paymentAdvice) Deletes an existing PaymentAdvice entity in the S/4HANA system.
PaymentAdviceItemDeleteFluentHelper	deletePaymentAdviceItem(PaymentAdviceItem paymentAdviceItem) Deletes an existing PaymentAdviceItem entity in the S/4HANA system.
PaymentAdviceFluentHelper	getAllPaymentAdvice() Fetch multiple PaymentAdvice entities.
PaymentAdviceItemFluentHelper	getAllPaymentAdviceItem() Fetch multiple PaymentAdviceItem entities.
PaymentAdviceByKeyFluentHelper	getPaymentAdviceByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice) Fetch a single PaymentAdvice entity using key fields.
PaymentAdviceItemByKeyFluentHelper	getPaymentAdviceItemByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice, String paymentAdviceItem) Fetch a single PaymentAdviceItem entity using key fields.
PaymentAdviceUpdateFluentHelper	updatePaymentAdvice(PaymentAdvice paymentAdvice) Update an existing PaymentAdvice entity and save it to the S/4HANA system.
PaymentAdviceItemUpdateFluentHelper	updatePaymentAdviceItem(PaymentAdviceItem paymentAdviceItem) Update an existing PaymentAdviceItem entity and save it to the S/4HANA system.
DefaultPaymentAdviceService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPaymentAdviceService

public DefaultPaymentAdviceService()

Creates a service using PaymentAdviceService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultPaymentAdviceService withServicePath(@Nonnull
                                                            String servicePath)

Description copied from interface: PaymentAdviceService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface PaymentAdviceService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllPaymentAdvice

@Nonnull
public PaymentAdviceFluentHelper getAllPaymentAdvice()

Description copied from interface: PaymentAdviceService

Fetch multiple PaymentAdvice entities.

Specified by:

getAllPaymentAdvice in interface PaymentAdviceService

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
public PaymentAdviceByKeyFluentHelper getPaymentAdviceByKey(String companyCode,
                                                                     String paymentAdviceAccountType,
                                                                     String paymentAdviceAccount,
                                                                     String paymentAdvice)

Description copied from interface: PaymentAdviceService

Fetch a single PaymentAdvice entity using key fields.

Specified by:

getPaymentAdviceByKey in interface PaymentAdviceService

Parameters:

companyCode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

paymentAdviceAccountType - The account type identifies a payment advice together with the company code, the account number, and the payment advice number.

Constraints: Not nullable, Maximum length: 1

paymentAdviceAccount - The account number identifies a payment advice together with the company code, the account type and the payment advice number.

Constraints: Not nullable, Maximum length: 10

paymentAdvice - Payment Advice Number

Constraints: Not nullable, Maximum length: 16

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
public PaymentAdviceCreateFluentHelper createPaymentAdvice(@Nonnull
                                                                    PaymentAdvice paymentAdvice)

Description copied from interface: PaymentAdviceService

Create a new PaymentAdvice entity and save it to the S/4HANA system.

Specified by:

createPaymentAdvice in interface PaymentAdviceService

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
public PaymentAdviceUpdateFluentHelper updatePaymentAdvice(@Nonnull
                                                                    PaymentAdvice paymentAdvice)

Description copied from interface: PaymentAdviceService

Update an existing PaymentAdvice entity and save it to the S/4HANA system.

Specified by:

updatePaymentAdvice in interface PaymentAdviceService

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
public PaymentAdviceDeleteFluentHelper deletePaymentAdvice(@Nonnull
                                                                    PaymentAdvice paymentAdvice)

Description copied from interface: PaymentAdviceService

Deletes an existing PaymentAdvice entity in the S/4HANA system.

Specified by:

deletePaymentAdvice in interface PaymentAdviceService

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
public PaymentAdviceItemFluentHelper getAllPaymentAdviceItem()

Description copied from interface: PaymentAdviceService

Fetch multiple PaymentAdviceItem entities.

Specified by:

getAllPaymentAdviceItem in interface PaymentAdviceService

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
public PaymentAdviceItemByKeyFluentHelper getPaymentAdviceItemByKey(String companyCode,
                                                                             String paymentAdviceAccountType,
                                                                             String paymentAdviceAccount,
                                                                             String paymentAdvice,
                                                                             String paymentAdviceItem)

Description copied from interface: PaymentAdviceService

Fetch a single PaymentAdviceItem entity using key fields.

Specified by:

getPaymentAdviceItemByKey in interface PaymentAdviceService

Parameters:

companyCode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

paymentAdviceAccountType - The account type identifies a payment advice together with the company code, the account number, and the payment advice number.

Constraints: Not nullable, Maximum length: 1

paymentAdviceAccount - The account number identifies a payment advice together with the company code, the account type and the payment advice number.

Constraints: Not nullable, Maximum length: 10

paymentAdvice - Payment Advice Number

Constraints: Not nullable, Maximum length: 16

paymentAdviceItem - All items within a payment advice contain a number via which they can be identified. The numbers are assigned consecutively by the system when entering a payment advice.

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
public PaymentAdviceItemCreateFluentHelper createPaymentAdviceItem(@Nonnull
                                                                            PaymentAdviceItem paymentAdviceItem)

Description copied from interface: PaymentAdviceService

Create a new PaymentAdviceItem entity and save it to the S/4HANA system.

Specified by:

createPaymentAdviceItem in interface PaymentAdviceService

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
public PaymentAdviceItemUpdateFluentHelper updatePaymentAdviceItem(@Nonnull
                                                                            PaymentAdviceItem paymentAdviceItem)

Description copied from interface: PaymentAdviceService

Update an existing PaymentAdviceItem entity and save it to the S/4HANA system.

Specified by:

updatePaymentAdviceItem in interface PaymentAdviceService

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
public PaymentAdviceItemDeleteFluentHelper deletePaymentAdviceItem(@Nonnull
                                                                            PaymentAdviceItem paymentAdviceItem)

Description copied from interface: PaymentAdviceService

Deletes an existing PaymentAdviceItem entity in the S/4HANA system.

Specified by:

deletePaymentAdviceItem in interface PaymentAdviceService

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.