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

Interface ProcessPhysicalInventoryDocumentsService

All Known Implementing Classes:

DefaultProcessPhysicalInventoryDocumentsService

public interface ProcessPhysicalInventoryDocumentsService

This service enables you to retrieve and create physical inventory documents, as well as count items and post differences on both document and item level. It can be consumed by external systems and user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PHYSICAL_INVENTORY_DOC_SRV
API Version:	1
Communication Scenario:	Physical Inventory Document Integration (SAP_COM_0107)
Scope Items:	Physical Inventory - Inventory Count and Adjustment (BML)

Method Summary

Methods

Modifier and Type	Method and Description
PhysInventoryDocHeaderCreateFluentHelper	createPhysInventoryDocHeader(PhysInventoryDocHeader physInventoryDocHeader) Create a new PhysInventoryDocHeader entity and save it to the S/4HANA system.
PhysInventoryDocHeaderFluentHelper	getAllPhysInventoryDocHeader() Fetch multiple PhysInventoryDocHeader entities.
PhysInventoryDocItemFluentHelper	getAllPhysInventoryDocItem() Fetch multiple PhysInventoryDocItem entities.
PhysInventoryDocHeaderByKeyFluentHelper	getPhysInventoryDocHeaderByKey(String fiscalYear, String physicalInventoryDocument) Fetch a single PhysInventoryDocHeader entity using key fields.
PhysInventoryDocItemByKeyFluentHelper	getPhysInventoryDocItemByKey(String fiscalYear, String physicalInventoryDocument, String physicalInventoryDocumentItem) Fetch a single PhysInventoryDocItem entity using key fields.
InitiateRecountFluentHelper	initiateRecount(String physicalInventoryDocument, String fiscalYear, Calendar physInventoryPlannedCountDate, Calendar documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, BigDecimal postingThresholdValue, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry) Trigger Recount
InitiateRecountOnItemFluentHelper	initiateRecountOnItem(String physicalInventoryDocument, String fiscalYear, String physicalInventoryDocumentItem, Calendar physInventoryPlannedCountDate, Calendar documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry) Trigger Recount on Item
PostDifferencesFluentHelper	postDifferences(BigDecimal postingThresholdValue, Calendar postingDate, String physicalInventoryDocument, String fiscalYear) Post Differences
PostDifferencesOnItemFluentHelper	postDifferencesOnItem(String physicalInventoryDocumentItem, String material, String physicalInventoryDocument, String fiscalYear, String batch, String reasonForPhysInvtryDifference, Calendar postingDate) Post Difference on Item
PhysInventoryDocItemUpdateFluentHelper	updatePhysInventoryDocItem(PhysInventoryDocItem physInventoryDocItem) Update an existing PhysInventoryDocItem entity and save it to the S/4HANA system.

Method Detail

getAllPhysInventoryDocHeader

PhysInventoryDocHeaderFluentHelper getAllPhysInventoryDocHeader()

Fetch multiple PhysInventoryDocHeader entities.

Returns:

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

getPhysInventoryDocHeaderByKey

PhysInventoryDocHeaderByKeyFluentHelper getPhysInventoryDocHeaderByKey(String fiscalYear,
                                                                     String physicalInventoryDocument)

Fetch a single PhysInventoryDocHeader entity using key fields.

Parameters:

fiscalYear - Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be.

Constraints: Not nullable, Maximum length: 4

physicalInventoryDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createPhysInventoryDocHeader

PhysInventoryDocHeaderCreateFluentHelper createPhysInventoryDocHeader(PhysInventoryDocHeader physInventoryDocHeader)

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

Parameters:

physInventoryDocHeader - PhysInventoryDocHeader entity object that will be created in the S/4HANA system.

Returns:

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

getAllPhysInventoryDocItem

PhysInventoryDocItemFluentHelper getAllPhysInventoryDocItem()

Fetch multiple PhysInventoryDocItem entities.

Returns:

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

getPhysInventoryDocItemByKey

PhysInventoryDocItemByKeyFluentHelper getPhysInventoryDocItemByKey(String fiscalYear,
                                                                 String physicalInventoryDocument,
                                                                 String physicalInventoryDocumentItem)

Fetch a single PhysInventoryDocItem entity using key fields.

Parameters:

physicalInventoryDocumentItem - Physical Inventory Item Number

Constraints: Not nullable, Maximum length: 3

fiscalYear - Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be.

Constraints: Not nullable, Maximum length: 4

physicalInventoryDocument - Physical Inventory Document

Constraints: Not nullable, Maximum length: 10

Returns:

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

updatePhysInventoryDocItem

PhysInventoryDocItemUpdateFluentHelper updatePhysInventoryDocItem(PhysInventoryDocItem physInventoryDocItem)

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

Parameters:

physInventoryDocItem - PhysInventoryDocItem entity object that will be updated in the S/4HANA system.

Returns:

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

postDifferences

PostDifferencesFluentHelper postDifferences(BigDecimal postingThresholdValue,
                                          Calendar postingDate,
                                          String physicalInventoryDocument,
                                          String fiscalYear)

Post Differences

Creates a fluent helper for the PostDifferences OData function import.

Parameters:

postingThresholdValue - Threshold Value

Constraints: Nullable, Precision: 14, Scale: 3

postingDate - Posting Date

Constraints: Nullable, Precision: 0

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Returns:

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

postDifferencesOnItem

PostDifferencesOnItemFluentHelper postDifferencesOnItem(String physicalInventoryDocumentItem,
                                                      String material,
                                                      String physicalInventoryDocument,
                                                      String fiscalYear,
                                                      String batch,
                                                      String reasonForPhysInvtryDifference,
                                                      Calendar postingDate)

Post Difference on Item

Creates a fluent helper for the PostDifferencesOnItem OData function import.

Parameters:

physicalInventoryDocumentItem - Item

Constraints: Not nullable, Maximum length: 3

material - Material

Constraints: Not nullable, Maximum length: 40

reasonForPhysInvtryDifference - Reason for Man. Val.

Constraints: Nullable, Maximum length: 4

batch - Batch

Constraints: Nullable, Maximum length: 10

postingDate - Posting Date

Constraints: Nullable, Precision: 0

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Returns:

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

initiateRecount

InitiateRecountFluentHelper initiateRecount(String physicalInventoryDocument,
                                          String fiscalYear,
                                          Calendar physInventoryPlannedCountDate,
                                          Calendar documentDate,
                                          String physicalInventoryNumber,
                                          String physInventoryReferenceNumber,
                                          String physicalInventoryDocumentDesc,
                                          BigDecimal postingThresholdValue,
                                          Boolean physInvtryDocHasQtySnapshot,
                                          Boolean postingIsBlockedForPhysInvtry)

Trigger Recount

Creates a fluent helper for the InitiateRecount OData function import.

Parameters:

documentDate - Document Date

Constraints: Nullable, Precision: 0

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

postingThresholdValue - Threshold Value

Constraints: Nullable, Precision: 14, Scale: 3

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

physInventoryReferenceNumber - Phys. inventory ref.

Constraints: Nullable, Maximum length: 16

physicalInventoryDocumentDesc - Description

Constraints: Nullable, Maximum length: 40

Returns:

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

initiateRecountOnItem

InitiateRecountOnItemFluentHelper initiateRecountOnItem(String physicalInventoryDocument,
                                                      String fiscalYear,
                                                      String physicalInventoryDocumentItem,
                                                      Calendar physInventoryPlannedCountDate,
                                                      Calendar documentDate,
                                                      String physicalInventoryNumber,
                                                      String physInventoryReferenceNumber,
                                                      String physicalInventoryDocumentDesc,
                                                      Boolean physInvtryDocHasQtySnapshot,
                                                      Boolean postingIsBlockedForPhysInvtry)

Trigger Recount on Item

Creates a fluent helper for the InitiateRecountOnItem OData function import.

Parameters:

documentDate - Document Date

Constraints: Nullable, Precision: 0

physicalInventoryDocumentItem - Item

Constraints: Not nullable, Maximum length: 3

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

physInventoryReferenceNumber - Phys. inventory ref.

Constraints: Nullable, Maximum length: 16

physicalInventoryDocumentDesc - Description

Constraints: Nullable, Maximum length: 40

Returns:

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