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

Interface PaymentItemService

All Superinterfaces:

BatchService<PaymentItemServiceBatch>

All Known Implementing Classes:

DefaultPaymentItemService

public interface PaymentItemService
extends BatchService<PaymentItemServiceBatch>

This service contains payment header and payment item. The payment header is read by groups, and in each group, there are one or more payment items. Appropriate checks for restricted values and authorizations are executed for updating the approval status of payment items. Once the update has been completed, the status code is sent in the response. If there are any issues during updating the approval status of payment item, the system display error messages in the response. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CN_PAYMENTRELEASELIST_APPR_SRV
API Version:	1
Communication Scenario:	Finance - China Payment Approval Integration (SAP_COM_0711)
Scope Items:	Accounts Payable (J60)
Authentication Methods:	Basic, x509
Business Object:	PaymentMedium

Field Summary

Fields

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.

Method Summary

Modifier and Type	Method and Description
PaymentReleaseListHeaderFluentHelper	getAllPaymentReleaseListHeader() Fetch multiple PaymentReleaseListHeader entities.
PaymentReleaseListItemFluentHelper	getAllPaymentReleaseListItem() Fetch multiple PaymentReleaseListItem entities.
PaymentReleaseListHeaderByKeyFluentHelper	getPaymentReleaseListHeaderByKey(String paymentreleaselist) Fetch a single PaymentReleaseListHeader entity using key fields.
PaymentReleaseListItemByKeyFluentHelper	getPaymentReleaseListItemByKey(UUID paymentreleaselistitemuuid) Fetch a single PaymentReleaseListItem entity using key fields.
PaymentReleaseListItemUpdateFluentHelper	updatePaymentReleaseListItem(PaymentReleaseListItem paymentReleaseListItem) Update an existing PaymentReleaseListItem entity and save it to the S/4HANA system.
PaymentItemService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final 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.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
PaymentItemService withServicePath(@Nonnull
                                            String servicePath)

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.

getAllPaymentReleaseListHeader

@Nonnull
PaymentReleaseListHeaderFluentHelper getAllPaymentReleaseListHeader()

Fetch multiple PaymentReleaseListHeader entities.

Returns:

A fluent helper to fetch multiple PaymentReleaseListHeader 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.

getPaymentReleaseListHeaderByKey

@Nonnull
PaymentReleaseListHeaderByKeyFluentHelper getPaymentReleaseListHeaderByKey(String paymentreleaselist)

Fetch a single PaymentReleaseListHeader entity using key fields.

Parameters:

paymentreleaselist - Uniquely identifies a list created in the Payment Release List application and is generated by the application.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single PaymentReleaseListHeader 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.

getAllPaymentReleaseListItem

@Nonnull
PaymentReleaseListItemFluentHelper getAllPaymentReleaseListItem()

Fetch multiple PaymentReleaseListItem entities.

Returns:

A fluent helper to fetch multiple PaymentReleaseListItem 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.

getPaymentReleaseListItemByKey

@Nonnull
PaymentReleaseListItemByKeyFluentHelper getPaymentReleaseListItemByKey(UUID paymentreleaselistitemuuid)

Fetch a single PaymentReleaseListItem entity using key fields.

Parameters:

paymentreleaselistitemuuid - UUID in X form (binary)

Constraints: Not nullable

Returns:

A fluent helper to fetch a single PaymentReleaseListItem 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.

updatePaymentReleaseListItem

@Nonnull
PaymentReleaseListItemUpdateFluentHelper updatePaymentReleaseListItem(@Nonnull
                                                                               PaymentReleaseListItem paymentReleaseListItem)

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

Parameters:

paymentReleaseListItem - PaymentReleaseListItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing PaymentReleaseListItem entity. To perform execution, call the execute method on the fluent helper object.