public interface PaymentAdviceService extends BatchService<PaymentAdviceServiceBatch>
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 |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path
used to access the endpoint. |
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. |
PaymentAdviceService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull PaymentAdviceService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull PaymentAdviceFluentHelper getAllPaymentAdvice()
PaymentAdvice
entities.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 PaymentAdviceByKeyFluentHelper getPaymentAdviceByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice)
PaymentAdvice
entity using key fields.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
paymentAdvice
- Payment Advice Number
Constraints: Not nullable, Maximum length: 16
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
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 PaymentAdviceCreateFluentHelper createPaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
PaymentAdvice
entity and save it to the S/4HANA system.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 PaymentAdviceUpdateFluentHelper updatePaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
PaymentAdvice
entity and save it to the S/4HANA system.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 PaymentAdviceDeleteFluentHelper deletePaymentAdvice(@Nonnull PaymentAdvice paymentAdvice)
PaymentAdvice
entity in the S/4HANA system.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 PaymentAdviceItemFluentHelper getAllPaymentAdviceItem()
PaymentAdviceItem
entities.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 PaymentAdviceItemByKeyFluentHelper getPaymentAdviceItemByKey(String companyCode, String paymentAdviceAccountType, String paymentAdviceAccount, String paymentAdvice, String paymentAdviceItem)
PaymentAdviceItem
entity using key fields.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
paymentAdvice
- Payment Advice Number
Constraints: Not nullable, Maximum length: 16
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
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 PaymentAdviceItemCreateFluentHelper createPaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
PaymentAdviceItem
entity and save it to the S/4HANA system.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 PaymentAdviceItemUpdateFluentHelper updatePaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
PaymentAdviceItem
entity and save it to the S/4HANA system.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 PaymentAdviceItemDeleteFluentHelper deletePaymentAdviceItem(@Nonnull PaymentAdviceItem paymentAdviceItem)
PaymentAdviceItem
entity in the S/4HANA system.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 © 2019 SAP SE. All rights reserved.