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

Interface BrazilBusinessPlaceService

All Superinterfaces:

BatchService<BrazilBusinessPlaceServiceBatch>

All Known Implementing Classes:

DefaultBrazilBusinessPlaceService

public interface BrazilBusinessPlaceService
extends BatchService<BrazilBusinessPlaceServiceBatch>

This inbound and synchronous service is based on the OData and can be consumed in Brazilian integration scenarios. Once the business place and company code numbers have been informed, the system returns business place data such as address, tax jurisdiction, telephone, CNPJ number, and municipal tax number.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_LOGBR_BUSINESS_PLACE_SRV
API Version:	1
Communication Scenario:	Logistics - Brazil Business Place Detail Integration (SAP_COM_0365)
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
BusinessPlaceFluentHelper	getAllBusinessPlace() Fetch multiple BusinessPlace entities.
BusinessPlaceByKeyFluentHelper	getBusinessPlaceByKey(String branch, String companyCode) Fetch a single BusinessPlace entity using key fields.
BrazilBusinessPlaceService	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
BrazilBusinessPlaceService 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 branch,
                                                              String companyCode)

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

branch - 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.