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

Interface CompanyCodeService

All Superinterfaces:

BatchService<CompanyCodeServiceBatch>

All Known Implementing Classes:

DefaultCompanyCodeService

public interface CompanyCodeService
extends BatchService<CompanyCodeServiceBatch>

The service enables you to retrieve company code master data. It contains a header and nodes with business information. You can read company codes and their properties like name, country and currency..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_COMPANYCODE_SRV
API Version:	1
Minimum ERP Version:	2020
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
CompanyCodeFluentHelper	getAllCompanyCode() Fetch multiple CompanyCode entities.
CompanyCodeByKeyFluentHelper	getCompanyCodeByKey(String companyCode) Fetch a single CompanyCode entity using key fields.
CompanyCodeService	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
CompanyCodeService 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.

getAllCompanyCode

@Nonnull
CompanyCodeFluentHelper getAllCompanyCode()

Fetch multiple CompanyCode entities.

Returns:

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

getCompanyCodeByKey

@Nonnull
CompanyCodeByKeyFluentHelper getCompanyCodeByKey(String companyCode)

Fetch a single CompanyCode entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

Returns:

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