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

Interface ContractAccountingSEPAMandateService

All Superinterfaces:

BatchService<ContractAccountingSEPAMandateServiceBatch>

All Known Implementing Classes:

DefaultContractAccountingSEPAMandateService

public interface ContractAccountingSEPAMandateService
extends BatchService<ContractAccountingSEPAMandateServiceBatch>

With this service you can create, read and update SEPA Mandates for Contract Accounting (FI- CA). You can also create and read the usage of SEPA mandates..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_O2C_FICA_SEPA_MANDATE_SRV
API Version:	1
Communication Scenario:	Finance - Contract Accounting SEPA Mandate Integration (SAP_COM_0458)
Scope Items:	Contract Accounting - Master Data and Basic Functions (2AR)
Authentication Methods:	Basic, x509
Business Object:	SEPAMandate

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
SEPAMandateCreateFluentHelper	createSEPAMandate(SEPAMandate sEPAMandate) Create a new SEPAMandate entity and save it to the S/4HANA system.
SEPAMandateUsageCreateFluentHelper	createSEPAMandateUsage(SEPAMandateUsage sEPAMandateUsage) Create a new SEPAMandateUsage entity and save it to the S/4HANA system.
SEPAMandateFluentHelper	getAllSEPAMandate() Fetch multiple SEPAMandate entities.
SEPAMandateUsageFluentHelper	getAllSEPAMandateUsage() Fetch multiple SEPAMandateUsage entities.
SEPAMandateByKeyFluentHelper	getSEPAMandateByKey(String creditor, String sEPAMandate) Fetch a single SEPAMandate entity using key fields.
SEPAMandateUsageByKeyFluentHelper	getSEPAMandateUsageByKey(String creditor, String sEPAMandate, LocalDateTime sEPAMandateUseDate, String sEPAMandateUseObjectType, String sEPAMandateUsePaymentDoc) Fetch a single SEPAMandateUsage entity using key fields.
SEPAMandateUpdateFluentHelper	updateSEPAMandate(SEPAMandate sEPAMandate) Update an existing SEPAMandate entity and save it to the S/4HANA system.
ContractAccountingSEPAMandateService	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
ContractAccountingSEPAMandateService 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.

getAllSEPAMandate

@Nonnull
SEPAMandateFluentHelper getAllSEPAMandate()

Fetch multiple SEPAMandate entities.

Returns:

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

getSEPAMandateByKey

@Nonnull
SEPAMandateByKeyFluentHelper getSEPAMandateByKey(String creditor,
                                                          String sEPAMandate)

Fetch a single SEPAMandate entity using key fields.

Parameters:

creditor - Specifies a cross-country unique identification of the creditor of a SEPA direct debit.

Constraints: Not nullable, Maximum length: 35

sEPAMandate - Identifies, together with the Creditor Identifier, the mandate uniquely.

Constraints: Not nullable, Maximum length: 35

Returns:

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

createSEPAMandate

@Nonnull
SEPAMandateCreateFluentHelper createSEPAMandate(@Nonnull
                                                         SEPAMandate sEPAMandate)

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

Parameters:

sEPAMandate - SEPAMandate entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SEPAMandate entity. To perform execution, call the execute method on the fluent helper object.

updateSEPAMandate

@Nonnull
SEPAMandateUpdateFluentHelper updateSEPAMandate(@Nonnull
                                                         SEPAMandate sEPAMandate)

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

Parameters:

sEPAMandate - SEPAMandate entity object that will be updated in the S/4HANA system.

Returns:

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

getAllSEPAMandateUsage

@Nonnull
SEPAMandateUsageFluentHelper getAllSEPAMandateUsage()

Fetch multiple SEPAMandateUsage entities.

Returns:

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

getSEPAMandateUsageByKey

@Nonnull
SEPAMandateUsageByKeyFluentHelper getSEPAMandateUsageByKey(String creditor,
                                                                    String sEPAMandate,
                                                                    LocalDateTime sEPAMandateUseDate,
                                                                    String sEPAMandateUseObjectType,
                                                                    String sEPAMandateUsePaymentDoc)

Fetch a single SEPAMandateUsage entity using key fields.

Parameters:

sEPAMandateUsePaymentDoc - Linked key for an object.

Constraints: Not nullable, Maximum length: 70

sEPAMandateUseObjectType - Internal technical key of a business object in the Business Object Repository (BOR).

Constraints: Not nullable, Maximum length: 10

creditor - Specifies a cross-country unique identification of the creditor of a SEPA direct debit.

Constraints: Not nullable, Maximum length: 35

sEPAMandate - Identifies, together with the Creditor Identifier, the mandate uniquely.

Constraints: Not nullable, Maximum length: 35

sEPAMandateUseDate - Date (YYYYMMDD)

Constraints: Not nullable, Precision: 7

Returns:

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

createSEPAMandateUsage

@Nonnull
SEPAMandateUsageCreateFluentHelper createSEPAMandateUsage(@Nonnull
                                                                   SEPAMandateUsage sEPAMandateUsage)

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

Parameters:

sEPAMandateUsage - SEPAMandateUsage entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SEPAMandateUsage entity. To perform execution, call the execute method on the fluent helper object.