@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPaymentAdviceService") public class DefaultPaymentAdviceService extends Object implements PaymentAdviceService
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..
Reference: SAP API Business Hub
OData Service: | API_PAYMENT_ADVICE_SRV |
API Version: | 1 |
Communication Scenario: | Finance - Payment Advice Integration (SAP_COM_0331) |
Scope Items: | Accounts Receivable (J59), Accounts Receivable (O59) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | PaymentAdvice |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultPaymentAdviceService()
Creates a service using
PaymentAdviceService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultPaymentAdviceServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
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.
|
public DefaultPaymentAdviceService()
PaymentAdviceService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultPaymentAdviceService withServicePath(@Nonnull String servicePath)
PaymentAdviceService
withServicePath
in interface PaymentAdviceService
servicePath
- Service path that will override the default.@Nonnull public DefaultPaymentAdviceServiceBatch batch()
batch
in interface BatchService<PaymentAdviceServiceBatch>
@Nonnull public PaymentAdviceFluentHelper getAllPaymentAdvice()
PaymentAdviceService
PaymentAdvice
entities.getAllPaymentAdvice
in interface PaymentAdviceService
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.@Nonnull public PaymentAdviceByKeyFluentHelper getPaymentAdviceByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice)
PaymentAdviceService
PaymentAdvice
entity using key fields.getPaymentAdviceByKey
in interface PaymentAdviceService
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
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.@Nonnull public PaymentAdviceCreateFluentHelper createPaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
PaymentAdviceService
PaymentAdvice
entity and save it to the S/4HANA system.createPaymentAdvice
in interface PaymentAdviceService
paymentAdvice
- PaymentAdvice
entity object that will be created in the S/4HANA system.PaymentAdvice
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PaymentAdviceUpdateFluentHelper updatePaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
PaymentAdviceService
PaymentAdvice
entity and save it to the S/4HANA system.updatePaymentAdvice
in interface PaymentAdviceService
paymentAdvice
- PaymentAdvice
entity object that will be updated in the S/4HANA system.PaymentAdvice
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PaymentAdviceDeleteFluentHelper deletePaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
PaymentAdviceService
PaymentAdvice
entity in the S/4HANA system.deletePaymentAdvice
in interface PaymentAdviceService
paymentAdvice
- PaymentAdvice
entity object that will be deleted in the S/4HANA system.PaymentAdvice
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PaymentAdviceItemFluentHelper getAllPaymentAdviceItem()
PaymentAdviceService
PaymentAdviceItem
entities.getAllPaymentAdviceItem
in interface PaymentAdviceService
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.@Nonnull public PaymentAdviceItemByKeyFluentHelper getPaymentAdviceItemByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice, String paymentAdviceItem)
PaymentAdviceService
PaymentAdviceItem
entity using key fields.getPaymentAdviceItemByKey
in interface PaymentAdviceService
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
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.@Nonnull public PaymentAdviceItemCreateFluentHelper createPaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
PaymentAdviceService
PaymentAdviceItem
entity and save it to the S/4HANA system.createPaymentAdviceItem
in interface PaymentAdviceService
paymentAdviceItem
- PaymentAdviceItem
entity object that will be created in the S/4HANA system.PaymentAdviceItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PaymentAdviceItemUpdateFluentHelper updatePaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
PaymentAdviceService
PaymentAdviceItem
entity and save it to the S/4HANA system.updatePaymentAdviceItem
in interface PaymentAdviceService
paymentAdviceItem
- PaymentAdviceItem
entity object that will be updated in the S/4HANA system.PaymentAdviceItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PaymentAdviceItemDeleteFluentHelper deletePaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
PaymentAdviceService
PaymentAdviceItem
entity in the S/4HANA system.deletePaymentAdviceItem
in interface PaymentAdviceService
paymentAdviceItem
- PaymentAdviceItem
entity object that will be deleted in the S/4HANA system.PaymentAdviceItem
entity. To perform execution, call the
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.