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

Class DefaultPhysicalInventoryDocumentService

java.lang.Object

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

All Implemented Interfaces:

PhysicalInventoryDocumentService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPhysicalInventoryDocumentService")
public class DefaultPhysicalInventoryDocumentService
extends Object
implements PhysicalInventoryDocumentService

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)

Constructor Summary

Constructors

Constructor and Description
DefaultPhysicalInventoryDocumentService()

Method Summary

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 RecountCreates a fluent helper for the InitiateRecount OData function import.
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 ItemCreates a fluent helper for the InitiateRecountOnItem OData function import.
PostDifferencesFluentHelper	postDifferences(BigDecimal postingThresholdValue, Calendar postingDate, String physicalInventoryDocument, String fiscalYear) Post DifferencesCreates a fluent helper for the PostDifferences OData function import.
PostDifferencesOnItemFluentHelper	postDifferencesOnItem(String physicalInventoryDocumentItem, String material, String physicalInventoryDocument, String fiscalYear, String batch, String reasonForPhysInvtryDifference, Calendar postingDate) Post Difference on ItemCreates a fluent helper for the PostDifferencesOnItem OData function import.
PhysInventoryDocItemUpdateFluentHelper	updatePhysInventoryDocItem(PhysInventoryDocItem physInventoryDocItem) Update an existing PhysInventoryDocItem entity and save it to the S/4HANA system.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPhysicalInventoryDocumentService

public DefaultPhysicalInventoryDocumentService()

Method Detail

getAllPhysInventoryDocHeader

public PhysInventoryDocHeaderFluentHelper getAllPhysInventoryDocHeader()

Description copied from interface: PhysicalInventoryDocumentService

Fetch multiple PhysInventoryDocHeader entities.

Specified by:

getAllPhysInventoryDocHeader in interface PhysicalInventoryDocumentService

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

public PhysInventoryDocHeaderByKeyFluentHelper getPhysInventoryDocHeaderByKey(String fiscalYear,
                                                                              String physicalInventoryDocument)

Description copied from interface: PhysicalInventoryDocumentService

Fetch a single PhysInventoryDocHeader entity using key fields.

Specified by:

getPhysInventoryDocHeaderByKey in interface PhysicalInventoryDocumentService

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

public PhysInventoryDocHeaderCreateFluentHelper createPhysInventoryDocHeader(PhysInventoryDocHeader physInventoryDocHeader)

Description copied from interface: PhysicalInventoryDocumentService

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

Specified by:

createPhysInventoryDocHeader in interface PhysicalInventoryDocumentService

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

public PhysInventoryDocItemFluentHelper getAllPhysInventoryDocItem()

Description copied from interface: PhysicalInventoryDocumentService

Fetch multiple PhysInventoryDocItem entities.

Specified by:

getAllPhysInventoryDocItem in interface PhysicalInventoryDocumentService

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

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

Description copied from interface: PhysicalInventoryDocumentService

Fetch a single PhysInventoryDocItem entity using key fields.

Specified by:

getPhysInventoryDocItemByKey in interface PhysicalInventoryDocumentService

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 - Physical Inventory Document

Constraints: Not nullable, Maximum length: 10

physicalInventoryDocumentItem - Physical Inventory Item Number

Constraints: Not nullable, Maximum length: 3

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

public PhysInventoryDocItemUpdateFluentHelper updatePhysInventoryDocItem(PhysInventoryDocItem physInventoryDocItem)

Description copied from interface: PhysicalInventoryDocumentService

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

Specified by:

updatePhysInventoryDocItem in interface PhysicalInventoryDocumentService

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

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

Description copied from interface: PhysicalInventoryDocumentService

Post Differences

Creates a fluent helper for the PostDifferences OData function import.

Specified by:

postDifferences in interface PhysicalInventoryDocumentService

Parameters:

postingThresholdValue - Threshold Value

Constraints: Nullable, Precision: 14, Scale: 3

postingDate - Posting Date

Constraints: Nullable, Precision: 0

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

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

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

Description copied from interface: PhysicalInventoryDocumentService

Post Difference on Item

Creates a fluent helper for the PostDifferencesOnItem OData function import.

Specified by:

postDifferencesOnItem in interface PhysicalInventoryDocumentService

Parameters:

physicalInventoryDocumentItem - Item

Constraints: Not nullable, Maximum length: 3

material - Material

Constraints: Not nullable, Maximum length: 40

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

batch - Batch

Constraints: Nullable, Maximum length: 10

reasonForPhysInvtryDifference - Reason for Man. Val.

Constraints: Nullable, Maximum length: 4

postingDate - Posting Date

Constraints: Nullable, Precision: 0

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

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

Description copied from interface: PhysicalInventoryDocumentService

Trigger Recount

Creates a fluent helper for the InitiateRecount OData function import.

Specified by:

initiateRecount in interface PhysicalInventoryDocumentService

Parameters:

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

documentDate - Document Date

Constraints: Nullable, Precision: 0

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

physInventoryReferenceNumber - Phys. inventory ref.

Constraints: Nullable, Maximum length: 16

physicalInventoryDocumentDesc - Description

Constraints: Nullable, Maximum length: 40

postingThresholdValue - Threshold Value

Constraints: Nullable, Precision: 14, Scale: 3

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

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

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

Description copied from interface: PhysicalInventoryDocumentService

Trigger Recount on Item

Creates a fluent helper for the InitiateRecountOnItem OData function import.

Specified by:

initiateRecountOnItem in interface PhysicalInventoryDocumentService

Parameters:

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

physicalInventoryDocumentItem - Item

Constraints: Not nullable, Maximum length: 3

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

documentDate - Document Date

Constraints: Nullable, Precision: 0

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

physInventoryReferenceNumber - Phys. inventory ref.

Constraints: Nullable, Maximum length: 16

physicalInventoryDocumentDesc - Description

Constraints: Nullable, Maximum length: 40

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

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.