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

Interface LedgerService

All Superinterfaces:

BatchService<LedgerServiceBatch>

All Known Implementing Classes:

DefaultLedgerService

public interface LedgerService
extends BatchService<LedgerServiceBatch>

The service enables you to retrieve ledgers, their properties like leading ledger and their names in the respective language..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_LEDGER_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241)
Scope Items:	Import Connection setup with SAP Analytics Cloud (1YB), Group Reporting - Data from SAP Group Reporting Data Collection (287)
Authentication Methods:	Basic, x509, OAuth2

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
LedgerFluentHelper	getAllLedger() Fetch multiple Ledger entities.
LedgerTextFluentHelper	getAllLedgerText() Fetch multiple LedgerText entities.
LedgerByKeyFluentHelper	getLedgerByKey(String ledger) Fetch a single Ledger entity using key fields.
LedgerTextByKeyFluentHelper	getLedgerTextByKey(String ledger, String language) Fetch a single LedgerText entity using key fields.
LedgerService	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
LedgerService 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.

getAllLedger

@Nonnull
LedgerFluentHelper getAllLedger()

Fetch multiple Ledger entities.

Returns:

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

getLedgerByKey

@Nonnull
LedgerByKeyFluentHelper getLedgerByKey(String ledger)

Fetch a single Ledger entity using key fields.

Parameters:

ledger - Identifies a ledger in General Ledger Accounting.

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllLedgerText

@Nonnull
LedgerTextFluentHelper getAllLedgerText()

Fetch multiple LedgerText entities.

Returns:

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

getLedgerTextByKey

@Nonnull
LedgerTextByKeyFluentHelper getLedgerTextByKey(String ledger,
                                                        String language)

Fetch a single LedgerText entity using key fields.

Parameters:

ledger - Identifies a ledger in General Ledger Accounting.

Constraints: Not nullable, Maximum length: 2

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

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