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

Interface MaterialDocumentService

All Known Implementing Classes:

DefaultMaterialDocumentService

public interface MaterialDocumentService

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:	Stock Handling - Rework, Scrap, Blocked Stock (BMC)

Method Summary

Modifier and Type	Method and Description
CancelFluentHelper	cancel(String materialDocumentYear, String materialDocument, Calendar postingDate) Creates a fluent helper for the Cancel OData function import.
CancelItemFluentHelper	cancelItem(String materialDocumentYear, String materialDocument, String materialDocumentItem, Calendar 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.

Method Detail

getAllMaterialDocumentHeader

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

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

MaterialDocumentHeaderCreateFluentHelper createMaterialDocumentHeader(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

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

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

CancelFluentHelper cancel(String materialDocumentYear,
                          String materialDocument,
                          Calendar postingDate)

Creates a fluent helper for the Cancel OData function import.

Parameters:

materialDocument - Material Document

Constraints: Not nullable, Maximum length: 10

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

postingDate - Posting Date

Constraints: Nullable, Precision: 0

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

CancelItemFluentHelper cancelItem(String materialDocumentYear,
                                  String materialDocument,
                                  String materialDocumentItem,
                                  Calendar postingDate)

Creates a fluent helper for the CancelItem OData function import.

Parameters:

materialDocument - Material Document

Constraints: Not nullable, Maximum length: 10

materialDocumentItem - Material Doc.Item

Constraints: Not nullable, Maximum length: 4

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

postingDate - Posting Date

Constraints: Nullable, Precision: 0

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.