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

Class DefaultContractAccountingBusinessPartnerPaymentService

java.lang.Object

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

All Implemented Interfaces:

ServiceWithNavigableEntities, ContractAccountingBusinessPartnerPaymentService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultContractAccountingBusinessPartnerPaymentService")
public class DefaultContractAccountingBusinessPartnerPaymentService
extends Object
implements ServiceWithNavigableEntities, 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.ContractAccountingBusinessPartnerPaymentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultContractAccountingBusinessPartnerPaymentService() Creates a service using ContractAccountingBusinessPartnerPaymentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<BusPartPaymentHeader>	countBusPartPaymentHeader() Fetch the number of entries from the BusPartPaymentHeader entity collection matching the filter and search expressions.
CountRequestBuilder<BusPartPaymentItemParameters>	countBusPartPaymentItemParameters() Fetch the number of entries from the BusPartPaymentItemParameters entity collection matching the filter and search expressions.
CountRequestBuilder<BusPartPaymentParameters>	countBusPartPaymentParameters() Fetch the number of entries from the BusPartPaymentParameters 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<BusPartPaymentHeader>	getAllBusPartPaymentHeader() Fetch multiple BusPartPaymentHeader entities.
GetAllRequestBuilder<BusPartPaymentItemParameters>	getAllBusPartPaymentItemParameters() Fetch multiple BusPartPaymentItemParameters entities.
GetAllRequestBuilder<BusPartPaymentParameters>	getAllBusPartPaymentParameters() Fetch multiple BusPartPaymentParameters entities.
GetByKeyRequestBuilder<BusPartPaymentHeader>	getBusPartPaymentHeaderByKey(UUID cADocumentContainerPaymentUUID) Fetch a single BusPartPaymentHeader entity using key fields.
GetByKeyRequestBuilder<BusPartPaymentItemParameters>	getBusPartPaymentItemParametersByKey(String p_DisplayCurrency) Fetch a single BusPartPaymentItemParameters entity using key fields.
GetByKeyRequestBuilder<BusPartPaymentParameters>	getBusPartPaymentParametersByKey(String p_DisplayCurrency) Fetch a single BusPartPaymentParameters entity using key fields.
String	getServicePath() Getter for the OData service root path.
DefaultContractAccountingBusinessPartnerPaymentService	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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

forEntity

Constructor Detail

DefaultContractAccountingBusinessPartnerPaymentService

public DefaultContractAccountingBusinessPartnerPaymentService()

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

Method Detail

withServicePath

@Nonnull
public DefaultContractAccountingBusinessPartnerPaymentService withServicePath(@Nonnull
                                                                                       String servicePath)

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

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 ContractAccountingBusinessPartnerPaymentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Creates a batch request builder object.

Specified by:

batch in interface ContractAccountingBusinessPartnerPaymentService

Returns:

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

getAllBusPartPaymentParameters

@Nonnull
public GetAllRequestBuilder<BusPartPaymentParameters> getAllBusPartPaymentParameters()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Fetch multiple BusPartPaymentParameters entities.

Specified by:

getAllBusPartPaymentParameters in interface ContractAccountingBusinessPartnerPaymentService

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.

countBusPartPaymentParameters

@Nonnull
public CountRequestBuilder<BusPartPaymentParameters> countBusPartPaymentParameters()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

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

Specified by:

countBusPartPaymentParameters in interface ContractAccountingBusinessPartnerPaymentService

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.

getBusPartPaymentParametersByKey

@Nonnull
public GetByKeyRequestBuilder<BusPartPaymentParameters> getBusPartPaymentParametersByKey(@Nonnull
                                                                                                  String p_DisplayCurrency)

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Fetch a single BusPartPaymentParameters entity using key fields.

Specified by:

getBusPartPaymentParametersByKey in interface ContractAccountingBusinessPartnerPaymentService

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
public GetAllRequestBuilder<BusPartPaymentHeader> getAllBusPartPaymentHeader()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Fetch multiple BusPartPaymentHeader entities.

Specified by:

getAllBusPartPaymentHeader in interface ContractAccountingBusinessPartnerPaymentService

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
public CountRequestBuilder<BusPartPaymentHeader> countBusPartPaymentHeader()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

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

Specified by:

countBusPartPaymentHeader in interface ContractAccountingBusinessPartnerPaymentService

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
public GetByKeyRequestBuilder<BusPartPaymentHeader> getBusPartPaymentHeaderByKey(@Nonnull
                                                                                          UUID cADocumentContainerPaymentUUID)

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Fetch a single BusPartPaymentHeader entity using key fields.

Specified by:

getBusPartPaymentHeaderByKey in interface ContractAccountingBusinessPartnerPaymentService

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
public CreateRequestBuilder<BusPartPaymentHeader> createBusPartPaymentHeader(@Nonnull
                                                                                      BusPartPaymentHeader busPartPaymentHeader)

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

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

Specified by:

createBusPartPaymentHeader in interface ContractAccountingBusinessPartnerPaymentService

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.

getAllBusPartPaymentItemParameters

@Nonnull
public GetAllRequestBuilder<BusPartPaymentItemParameters> getAllBusPartPaymentItemParameters()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Fetch multiple BusPartPaymentItemParameters entities.

Specified by:

getAllBusPartPaymentItemParameters in interface ContractAccountingBusinessPartnerPaymentService

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.

countBusPartPaymentItemParameters

@Nonnull
public CountRequestBuilder<BusPartPaymentItemParameters> countBusPartPaymentItemParameters()

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

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

Specified by:

countBusPartPaymentItemParameters in interface ContractAccountingBusinessPartnerPaymentService

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.

getBusPartPaymentItemParametersByKey

@Nonnull
public GetByKeyRequestBuilder<BusPartPaymentItemParameters> getBusPartPaymentItemParametersByKey(@Nonnull
                                                                                                          String p_DisplayCurrency)

Description copied from interface: ContractAccountingBusinessPartnerPaymentService

Fetch a single BusPartPaymentItemParameters entity using key fields.

Specified by:

getBusPartPaymentItemParametersByKey in interface ContractAccountingBusinessPartnerPaymentService

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.

getServicePath

@Nonnull
public String getServicePath()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.