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

Interface PurchasingSourceService

All Superinterfaces:

BatchService<PurchasingSourceServiceBatch>

All Known Implementing Classes:

DefaultPurchasingSourceService

public interface PurchasingSourceService
extends BatchService<PurchasingSourceServiceBatch>

This synchronous inbound service enables you to create, update, and delete purchasing source lists. It is based on the OData protocol. The information is sent in the request as a payload. All information is used when creating a purchasing source list, and they are checked for authorizations. Once the purchasing source list has been created, the purchasing source list number is sent in the response. If there are any issues when the purchasing source list is created, the system displays error messages in the response.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PURCHASING_SOURCE_SRV
API Version:	1
Communication Scenario:	Purchasing Source Integration (SAP_COM_0162)
Scope Items:	Purchase Contract (BMD), Purchase Contract (OMD)
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
PurchasingSourceCreateFluentHelper	createPurchasingSource(PurchasingSource purchasingSource) Create a new PurchasingSource entity and save it to the S/4HANA system.
PurchasingSourceDeleteFluentHelper	deletePurchasingSource(PurchasingSource purchasingSource) Deletes an existing PurchasingSource entity in the S/4HANA system.
PurchasingSourceFluentHelper	getAllPurchasingSource() Fetch multiple PurchasingSource entities.
PurchasingSourceByKeyFluentHelper	getPurchasingSourceByKey(String material, String plant, String sourceListRecord) Fetch a single PurchasingSource entity using key fields.
PurchasingSourceUpdateFluentHelper	updatePurchasingSource(PurchasingSource purchasingSource) Update an existing PurchasingSource entity and save it to the S/4HANA system.
PurchasingSourceService	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
PurchasingSourceService 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.

getAllPurchasingSource

@Nonnull
PurchasingSourceFluentHelper getAllPurchasingSource()

Fetch multiple PurchasingSource entities.

Returns:

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

getPurchasingSourceByKey

@Nonnull
PurchasingSourceByKeyFluentHelper getPurchasingSourceByKey(String material,
                                                                    String plant,
                                                                    String sourceListRecord)

Fetch a single PurchasingSource entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

plant - Specifies the key for a production facility or branch office within the company (that is, the company code).

Constraints: Not nullable, Maximum length: 4

sourceListRecord - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 5

Returns:

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

createPurchasingSource

@Nonnull
PurchasingSourceCreateFluentHelper createPurchasingSource(@Nonnull
                                                                   PurchasingSource purchasingSource)

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

Parameters:

purchasingSource - PurchasingSource entity object that will be created in the S/4HANA system.

Returns:

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

updatePurchasingSource

@Nonnull
PurchasingSourceUpdateFluentHelper updatePurchasingSource(@Nonnull
                                                                   PurchasingSource purchasingSource)

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

Parameters:

purchasingSource - PurchasingSource entity object that will be updated in the S/4HANA system.

Returns:

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

deletePurchasingSource

@Nonnull
PurchasingSourceDeleteFluentHelper deletePurchasingSource(@Nonnull
                                                                   PurchasingSource purchasingSource)

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

Parameters:

purchasingSource - PurchasingSource entity object that will be deleted in the S/4HANA system.

Returns:

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