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

Interface MaterialDocumentService

All Superinterfaces:
BatchService<MaterialDocumentServiceBatch>
All Known Implementing Classes:
DefaultMaterialDocumentService
@Deprecated public interface MaterialDocumentService extends BatchService<MaterialDocumentServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_MATERIAL_DOCUMENT_SRV
API Version: 1.2.0
Minimum ERP Version: 2302
Communication Scenario: Material Document Integration(SAP_COM_0108)
Scope Items: Core Inventory Management(BMC), Core Inventory Management(OMC)
Authentication Methods: x509
Business Object: Material Document

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull MaterialDocumentService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single MaterialDocumentHeader entity using key fields.
      Parameters:
      materialDocument - Number of Material 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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single MaterialDocumentItem entity using key fields.
      Parameters:
      materialDocument - Number of Material 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.

    • getAllSerialNumberMaterialDocument

      @Nonnull SerialNumberMaterialDocumentFluentHelper getAllSerialNumberMaterialDocument()
      Deprecated.
      Fetch multiple SerialNumberMaterialDocument entities.
      Returns:
      A fluent helper to fetch multiple SerialNumberMaterialDocument 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.

    • getSerialNumberMaterialDocumentByKey

      @Nonnull SerialNumberMaterialDocumentByKeyFluentHelper getSerialNumberMaterialDocumentByKey(String material, String serialNumber, String materialDocument, String materialDocumentItem, String materialDocumentYear)
      Deprecated.
      Fetch a single SerialNumberMaterialDocument entity using key fields.
      Parameters:
      materialDocument - Number of Material Document

      Constraints: Not nullable, Maximum length: 10

      serialNumber - Serial Number

      Constraints: Not nullable, Maximum length: 18

      material - Material Number

      Constraints: Not nullable, Maximum length: 40

      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 SerialNumberMaterialDocument 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(@Nonnull String materialDocumentYear, @Nonnull String materialDocument, @Nullable LocalDateTime postingDate)
      Deprecated.

      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(@Nonnull String materialDocumentYear, @Nonnull String materialDocument, @Nonnull String materialDocumentItem, @Nullable LocalDateTime postingDate)
      Deprecated.

      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.