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

Interface BankDetailService

All Known Implementing Classes:

DefaultBankDetailService

public interface BankDetailService

This service can be consumed by external applications in order to integrate with bank master data in SAP S/4HANA Cloud. It enables you to read bank data from SAP S/4HANA Cloud.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BANKDETAIL_SRV
API Version:	1
Communication Scenario:	Finance - Bank Integration (SAP_COM_0127)
Scope Items:	Advanced Bank Account Management (J77)
Authentication Methods:	Basic, x509

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
BankDetailFluentHelper	getAllBankDetail() Fetch multiple BankDetail entities.
BankDetailByKeyFluentHelper	getBankDetailByKey(String bankCountry, String bankInternalID) Fetch a single BankDetail entity using key fields.
BankDetailService	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
BankDetailService 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.

getAllBankDetail

@Nonnull
BankDetailFluentHelper getAllBankDetail()

Fetch multiple BankDetail entities.

Returns:

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

getBankDetailByKey

@Nonnull
BankDetailByKeyFluentHelper getBankDetailByKey(String bankCountry,
                                                        String bankInternalID)

Fetch a single BankDetail entity using key fields.

Parameters:

bankInternalID - In this field, you specify the bank key under which bank data from the respective country is stored.

Constraints: Not nullable, Maximum length: 15

bankCountry - Identifies the country in which the bank is located.

Constraints: Not nullable, Maximum length: 3

Returns:

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