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

Interface ContractAccountingBusinessPartnerPaymentService

All Known Implementing Classes:

DefaultContractAccountingBusinessPartnerPaymentService

public interface ContractAccountingBusinessPartnerPaymentService

Retrieve a list of payments and make, release or withdraw payments. Read payment items and corresponding payment headers for a business partner. Payment items are either document items which are cleared by payments, payments on account or released payments. Post or release payments for an invoice or an open document item. A released payment can also be withdrawn until the corresponding items are not cleared..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CABUSPARTPAYMENT_0001
API Version:	1
Communication Scenario:	Finance - Contract Accounting Open Item Management Integration (SAP_COM_0361)
Scope Items:	Contract Accounting - Open Item Management (2UJ)
Authentication Methods:	Basic, x509
Service Group Name:	API_CABUSPARTPAYMENT
Business Object:	ContrAcctgDocContainer

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
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<BusPartPaymentParameters>	countBusPartPayment() Fetch the number of entries from the BusPartPaymentParameters entity collection matching the filter and search expressions.
CountRequestBuilder<BusPartPaymentHeader>	countBusPartPaymentHeader() Fetch the number of entries from the BusPartPaymentHeader entity collection matching the filter and search expressions.
CountRequestBuilder<BusPartPaymentItemParameters>	countBusPartPaymentItem() Fetch the number of entries from the BusPartPaymentItemParameters entity collection matching the filter and search expressions.
CreateRequestBuilder<BusPartPaymentHeader>	createBusPartPaymentHeader(BusPartPaymentHeader busPartPaymentHeader) Create a new BusPartPaymentHeader entity and save it to the S/4HANA system.
GetAllRequestBuilder<BusPartPaymentParameters>	getAllBusPartPayment() Fetch multiple BusPartPaymentParameters entities.
GetAllRequestBuilder<BusPartPaymentHeader>	getAllBusPartPaymentHeader() Fetch multiple BusPartPaymentHeader entities.
GetAllRequestBuilder<BusPartPaymentItemParameters>	getAllBusPartPaymentItem() Fetch multiple BusPartPaymentItemParameters entities.
GetByKeyRequestBuilder<BusPartPaymentParameters>	getBusPartPaymentByKey(String p_DisplayCurrency) Fetch a single BusPartPaymentParameters entity using key fields.
GetByKeyRequestBuilder<BusPartPaymentHeader>	getBusPartPaymentHeaderByKey(UUID cADocumentContainerPaymentUUID) Fetch a single BusPartPaymentHeader entity using key fields.
GetByKeyRequestBuilder<BusPartPaymentItemParameters>	getBusPartPaymentItemByKey(String p_DisplayCurrency) Fetch a single BusPartPaymentItemParameters entity using key fields.
ContractAccountingBusinessPartnerPaymentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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
ContractAccountingBusinessPartnerPaymentService 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.

batch

@Nonnull
BatchRequestBuilder batch()

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllBusPartPayment

@Nonnull
GetAllRequestBuilder<BusPartPaymentParameters> getAllBusPartPayment()

Fetch multiple BusPartPaymentParameters entities.

Returns:

A request builder to fetch multiple BusPartPaymentParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countBusPartPayment

@Nonnull
CountRequestBuilder<BusPartPaymentParameters> countBusPartPayment()

Fetch the number of entries from the BusPartPaymentParameters entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of BusPartPaymentParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getBusPartPaymentByKey

@Nonnull
GetByKeyRequestBuilder<BusPartPaymentParameters> getBusPartPaymentByKey(@Nonnull
                                                                                 String p_DisplayCurrency)

Fetch a single BusPartPaymentParameters entity using key fields.

Parameters:

p_DisplayCurrency - Currency Key

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllBusPartPaymentHeader

@Nonnull
GetAllRequestBuilder<BusPartPaymentHeader> getAllBusPartPaymentHeader()

Fetch multiple BusPartPaymentHeader entities.

Returns:

A request builder to fetch multiple BusPartPaymentHeader entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countBusPartPaymentHeader

@Nonnull
CountRequestBuilder<BusPartPaymentHeader> countBusPartPaymentHeader()

Fetch the number of entries from the BusPartPaymentHeader entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of BusPartPaymentHeader entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getBusPartPaymentHeaderByKey

@Nonnull
GetByKeyRequestBuilder<BusPartPaymentHeader> getBusPartPaymentHeaderByKey(@Nonnull
                                                                                   UUID cADocumentContainerPaymentUUID)

Fetch a single BusPartPaymentHeader entity using key fields.

Parameters:

cADocumentContainerPaymentUUID - Document Container ID

Constraints: Not nullable

Returns:

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

createBusPartPaymentHeader

@Nonnull
CreateRequestBuilder<BusPartPaymentHeader> createBusPartPaymentHeader(@Nonnull
                                                                               BusPartPaymentHeader busPartPaymentHeader)

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

Parameters:

busPartPaymentHeader - BusPartPaymentHeader entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new BusPartPaymentHeader entity. To perform execution, call the execute method on the request builder object.

getAllBusPartPaymentItem

@Nonnull
GetAllRequestBuilder<BusPartPaymentItemParameters> getAllBusPartPaymentItem()

Fetch multiple BusPartPaymentItemParameters entities.

Returns:

A request builder to fetch multiple BusPartPaymentItemParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countBusPartPaymentItem

@Nonnull
CountRequestBuilder<BusPartPaymentItemParameters> countBusPartPaymentItem()

Fetch the number of entries from the BusPartPaymentItemParameters entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of BusPartPaymentItemParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getBusPartPaymentItemByKey

@Nonnull
GetByKeyRequestBuilder<BusPartPaymentItemParameters> getBusPartPaymentItemByKey(@Nonnull
                                                                                         String p_DisplayCurrency)

Fetch a single BusPartPaymentItemParameters entity using key fields.

Parameters:

p_DisplayCurrency - Currency Key

Constraints: Not nullable, Maximum length: 5

Returns:

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