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

Interface CustomerMaterialService

All Superinterfaces:

BatchService<CustomerMaterialServiceBatch>

All Known Implementing Classes:

DefaultCustomerMaterialService

public interface CustomerMaterialService
extends BatchService<CustomerMaterialServiceBatch>

You can use this service to integrate external applications with customer material processing in SAP S/4HANA Cloud.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CUSTOMER_MATERIAL_SRV
API Version:	1
Communication Scenario:	Customer Material Info Record Integration (SAP_COM_0134)
Scope Items:	Sell from Stock (BD9)
Authentication Methods:	Basic, x509
Business Object:	CustomerMaterial

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
CustomerMaterialCreateFluentHelper	createCustomerMaterial(CustomerMaterial customerMaterial) Create a new CustomerMaterial entity and save it to the S/4HANA system.
CustomerMaterialDeleteFluentHelper	deleteCustomerMaterial(CustomerMaterial customerMaterial) Deletes an existing CustomerMaterial entity in the S/4HANA system.
CustomerMaterialFluentHelper	getAllCustomerMaterial() Fetch multiple CustomerMaterial entities.
CustomerMaterialByKeyFluentHelper	getCustomerMaterialByKey(String salesOrganization, String distributionChannel, String customer, String material) Fetch a single CustomerMaterial entity using key fields.
CustomerMaterialUpdateFluentHelper	updateCustomerMaterial(CustomerMaterial customerMaterial) Update an existing CustomerMaterial entity and save it to the S/4HANA system.
CustomerMaterialService	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.s4hana.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
CustomerMaterialService 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.

getAllCustomerMaterial

@Nonnull
CustomerMaterialFluentHelper getAllCustomerMaterial()

Fetch multiple CustomerMaterial entities.

Returns:

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

getCustomerMaterialByKey

@Nonnull
CustomerMaterialByKeyFluentHelper getCustomerMaterialByKey(String salesOrganization,
                                                                    String distributionChannel,
                                                                    String customer,
                                                                    String material)

Fetch a single CustomerMaterial entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

distributionChannel - The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.

Constraints: Not nullable, Maximum length: 2

salesOrganization - An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims.

Constraints: Not nullable, Maximum length: 4

customer - The customer to whom the condition or the customer-material info record applies.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createCustomerMaterial

@Nonnull
CustomerMaterialCreateFluentHelper createCustomerMaterial(@Nonnull
                                                                   CustomerMaterial customerMaterial)

Create a new CustomerMaterial entity and save it to the S/4HANA system.

Parameters:

customerMaterial - CustomerMaterial entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustomerMaterial entity. To perform execution, call the execute method on the fluent helper object.

updateCustomerMaterial

@Nonnull
CustomerMaterialUpdateFluentHelper updateCustomerMaterial(@Nonnull
                                                                   CustomerMaterial customerMaterial)

Update an existing CustomerMaterial entity and save it to the S/4HANA system.

Parameters:

customerMaterial - CustomerMaterial entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerMaterial entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerMaterial

@Nonnull
CustomerMaterialDeleteFluentHelper deleteCustomerMaterial(@Nonnull
                                                                   CustomerMaterial customerMaterial)

Deletes an existing CustomerMaterial entity in the S/4HANA system.

Parameters:

customerMaterial - CustomerMaterial entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerMaterial entity. To perform execution, call the execute method on the fluent helper object.