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..
Reference: SAP API Business Hub
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 |
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. |
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull ContractAccountingBusinessPartnerPaymentService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BatchRequestBuilder batch()
execute
method on the request builder object.@Nonnull GetAllRequestBuilder<BusPartPaymentParameters> getAllBusPartPaymentParameters()
BusPartPaymentParameters
entities.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.@Nonnull CountRequestBuilder<BusPartPaymentParameters> countBusPartPaymentParameters()
BusPartPaymentParameters
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<BusPartPaymentParameters> getBusPartPaymentParametersByKey(@Nonnull String p_DisplayCurrency)
BusPartPaymentParameters
entity using key fields.p_DisplayCurrency
- Currency Key
Constraints: Not nullable, Maximum length: 5
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.@Nonnull GetAllRequestBuilder<BusPartPaymentHeader> getAllBusPartPaymentHeader()
BusPartPaymentHeader
entities.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.@Nonnull CountRequestBuilder<BusPartPaymentHeader> countBusPartPaymentHeader()
BusPartPaymentHeader
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<BusPartPaymentHeader> getBusPartPaymentHeaderByKey(@Nonnull UUID cADocumentContainerPaymentUUID)
BusPartPaymentHeader
entity using key fields.cADocumentContainerPaymentUUID
- Document Container ID
Constraints: Not nullable
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.@Nonnull CreateRequestBuilder<BusPartPaymentHeader> createBusPartPaymentHeader(@Nonnull BusPartPaymentHeader busPartPaymentHeader)
BusPartPaymentHeader
entity and save it to the S/4HANA system.busPartPaymentHeader
- BusPartPaymentHeader
entity object that will be created in the S/4HANA system.BusPartPaymentHeader
entity. To perform execution, call the
execute
method on the request builder object.@Nonnull GetAllRequestBuilder<BusPartPaymentItemParameters> getAllBusPartPaymentItemParameters()
BusPartPaymentItemParameters
entities.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.@Nonnull CountRequestBuilder<BusPartPaymentItemParameters> countBusPartPaymentItemParameters()
BusPartPaymentItemParameters
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<BusPartPaymentItemParameters> getBusPartPaymentItemParametersByKey(@Nonnull String p_DisplayCurrency)
BusPartPaymentItemParameters
entity using key fields.p_DisplayCurrency
- Currency Key
Constraints: Not nullable, Maximum length: 5
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.Copyright © 2021 SAP SE. All rights reserved.