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

Interface BusinessPlaceService

All Superinterfaces:

BatchService<BusinessPlaceServiceBatch>

All Known Implementing Classes:

DefaultBusinessPlaceService

public interface BusinessPlaceService
extends BatchService<BusinessPlaceServiceBatch>

This service provides queries about business places based on countries/regions or scenarios. The detailed information you can query is as follows: - Enablement status of a business place in the current business scenario. Based on the enablement status, customers can decide the field status of the business place on the UI, which can be invisible, display only, optional or mandatory. - List of business places by input variants. - Detailed information about business places, such as tax registration number and address. - Attributes of country/region-specific business places..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_GLO_BUSINESSPLACE_SRV
API Version:	1
Communication Scenario:	Business Place Integration (SAP_COM_0394)
Scope Items:	Accounting and Financial Close (J58), Accounts Receivable (J59), Accounts Payable (J60)
Authentication Methods:	Basic, x509
Business Object:	BusinessPlace

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
BusinessPlaceFluentHelper	getAllBusinessPlace() Fetch multiple BusinessPlace entities.
BusinessPlaceByKeyFluentHelper	getBusinessPlaceByKey(String companyCode, String businessPlaceID) Fetch a single BusinessPlace entity using key fields.
GetBusinessPlaceFieldPropertiesFluentHelper	getBusinessPlaceFieldProperties(String scenarioID, String companyCode) Creates a fluent helper for the GetBusinessPlaceFieldProperties OData function import.
BusinessPlaceService	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
BusinessPlaceService 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.

getAllBusinessPlace

@Nonnull
BusinessPlaceFluentHelper getAllBusinessPlace()

Fetch multiple BusinessPlace entities.

Returns:

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

getBusinessPlaceByKey

@Nonnull
BusinessPlaceByKeyFluentHelper getBusinessPlaceByKey(String companyCode,
                                                              String businessPlaceID)

Fetch a single BusinessPlace entity using key fields.

Parameters:

companyCode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

businessPlaceID - Specifies the business place.

Constraints: Not nullable, Maximum length: 4

Returns:

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

getBusinessPlaceFieldProperties

@Nonnull
GetBusinessPlaceFieldPropertiesFluentHelper getBusinessPlaceFieldProperties(@Nonnull
                                                                                     String scenarioID,
                                                                                     @Nonnull
                                                                                     String companyCode)

Creates a fluent helper for the GetBusinessPlaceFieldProperties OData function import.

Parameters:

companyCode - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: CompanyCode

scenarioID - Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: ScenarioID

Returns:

A fluent helper object that will execute the GetBusinessPlaceFieldProperties OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.