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

Interface LedgerService

All Known Implementing Classes:

DefaultLedgerService

public interface LedgerService

This service enables you to read ledger master data in an API call. It is based on the OData protocol, and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_LEDGER_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for Planning (1YB)

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.

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

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.