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

Interface MaterialDocumentService

All Superinterfaces:

BatchService<MaterialDocumentServiceBatch>

All Known Implementing Classes:

DefaultMaterialDocumentService

public interface MaterialDocumentService
extends BatchService<MaterialDocumentServiceBatch>

This service enables you to retrieve and create material documents, e.g. to post a goods receipt for a purchase order or to document the transfer of materials between two storage locations. Additionally, the service allows to cancel existing material documents or single items. It can be consumed by external systems and user interfaces..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MATERIAL_DOCUMENT_SRV
API Version:	1
Communication Scenario:	Material Document Integration (SAP_COM_0108)
Scope Items:	Core Inventory Management (BMC)
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
CancelFluentHelper	cancel(String materialDocumentYear, String materialDocument, LocalDateTime postingDate) Creates a fluent helper for the Cancel OData function import.
CancelItemFluentHelper	cancelItem(String materialDocumentYear, String materialDocument, String materialDocumentItem, LocalDateTime postingDate) Creates a fluent helper for the CancelItem OData function import.
MaterialDocumentHeaderCreateFluentHelper	createMaterialDocumentHeader(MaterialDocumentHeader materialDocumentHeader) Create a new MaterialDocumentHeader entity and save it to the S/4HANA system.
MaterialDocumentHeaderFluentHelper	getAllMaterialDocumentHeader() Fetch multiple MaterialDocumentHeader entities.
MaterialDocumentItemFluentHelper	getAllMaterialDocumentItem() Fetch multiple MaterialDocumentItem entities.
MaterialDocumentHeaderByKeyFluentHelper	getMaterialDocumentHeaderByKey(String materialDocumentYear, String materialDocument) Fetch a single MaterialDocumentHeader entity using key fields.
MaterialDocumentItemByKeyFluentHelper	getMaterialDocumentItemByKey(String materialDocumentYear, String materialDocument, String materialDocumentItem) Fetch a single MaterialDocumentItem entity using key fields.
MaterialDocumentService	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
MaterialDocumentService 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.

getAllMaterialDocumentHeader

@Nonnull
MaterialDocumentHeaderFluentHelper getAllMaterialDocumentHeader()

Fetch multiple MaterialDocumentHeader entities.

Returns:

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

getMaterialDocumentHeaderByKey

@Nonnull
MaterialDocumentHeaderByKeyFluentHelper getMaterialDocumentHeaderByKey(String materialDocumentYear,
                                                                                String materialDocument)

Fetch a single MaterialDocumentHeader entity using key fields.

Parameters:

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

materialDocumentYear - Material Document Year

Constraints: Not nullable, Maximum length: 4

Returns:

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

createMaterialDocumentHeader

@Nonnull
MaterialDocumentHeaderCreateFluentHelper createMaterialDocumentHeader(@Nonnull
                                                                               MaterialDocumentHeader materialDocumentHeader)

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

Parameters:

materialDocumentHeader - MaterialDocumentHeader entity object that will be created in the S/4HANA system.

Returns:

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

getAllMaterialDocumentItem

@Nonnull
MaterialDocumentItemFluentHelper getAllMaterialDocumentItem()

Fetch multiple MaterialDocumentItem entities.

Returns:

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

getMaterialDocumentItemByKey

@Nonnull
MaterialDocumentItemByKeyFluentHelper getMaterialDocumentItemByKey(String materialDocumentYear,
                                                                            String materialDocument,
                                                                            String materialDocumentItem)

Fetch a single MaterialDocumentItem entity using key fields.

Parameters:

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

materialDocumentItem - Material Document Item

Constraints: Not nullable, Maximum length: 4

materialDocumentYear - Material Document Year

Constraints: Not nullable, Maximum length: 4

Returns:

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

cancel

@Nonnull
CancelFluentHelper cancel(String materialDocumentYear,
                                   String materialDocument,
                                   LocalDateTime postingDate)

Creates a fluent helper for the Cancel OData function import.

Parameters:

materialDocument - Material Document

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MaterialDocument

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentYear

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

Returns:

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

cancelItem

@Nonnull
CancelItemFluentHelper cancelItem(String materialDocumentYear,
                                           String materialDocument,
                                           String materialDocumentItem,
                                           LocalDateTime postingDate)

Creates a fluent helper for the CancelItem OData function import.

Parameters:

materialDocument - Material Document

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MaterialDocument

materialDocumentItem - Material Doc.Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentItem

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentYear

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

Returns:

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