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)

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PhysicalInventoryDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPhysicalInventoryDocumentService() Creates a service using PhysicalInventoryDocumentService.DEFAULT_SERVICE_PATH to send the requests.

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, LocalDateTime physInventoryPlannedCountDate, LocalDateTime documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, BigDecimal postingThresholdValue, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry) Trigger Recount
InitiateRecountOnItemFluentHelper	initiateRecountOnItem(String physicalInventoryDocument, String fiscalYear, String physicalInventoryDocumentItem, LocalDateTime physInventoryPlannedCountDate, LocalDateTime documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry) Trigger Recount on Item
PostDifferencesFluentHelper	postDifferences(BigDecimal postingThresholdValue, LocalDateTime postingDate, String physicalInventoryDocument, String fiscalYear) Post Differences
PostDifferencesOnItemFluentHelper	postDifferencesOnItem(String physicalInventoryDocumentItem, String material, String physicalInventoryDocument, String fiscalYear, String batch, String reasonForPhysInvtryDifference, LocalDateTime postingDate) Post Difference on Item
PhysInventoryDocItemUpdateFluentHelper	updatePhysInventoryDocItem(PhysInventoryDocItem physInventoryDocItem) Update an existing PhysInventoryDocItem entity and save it to the S/4HANA system.
DefaultPhysicalInventoryDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPhysicalInventoryDocumentService

public DefaultPhysicalInventoryDocumentService()

Creates a service using PhysicalInventoryDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultPhysicalInventoryDocumentService withServicePath(@Nonnull
                                                                        String servicePath)

Description copied from interface: PhysicalInventoryDocumentService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface PhysicalInventoryDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllPhysInventoryDocHeader

@Nonnull
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

@Nonnull
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 - Physical Inventory 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

@Nonnull
public PhysInventoryDocHeaderCreateFluentHelper createPhysInventoryDocHeader(@Nonnull
                                                                                      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

@Nonnull
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

@Nonnull
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

@Nonnull
public PhysInventoryDocItemUpdateFluentHelper updatePhysInventoryDocItem(@Nonnull
                                                                                  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

@Nonnull
public PostDifferencesFluentHelper postDifferences(BigDecimal postingThresholdValue,
                                                            LocalDateTime 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

Original parameter name from the Odata EDM: PostingThresholdValue

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PhysicalInventoryDocument

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

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

@Nonnull
public PostDifferencesOnItemFluentHelper postDifferencesOnItem(String physicalInventoryDocumentItem,
                                                                        String material,
                                                                        String physicalInventoryDocument,
                                                                        String fiscalYear,
                                                                        String batch,
                                                                        String reasonForPhysInvtryDifference,
                                                                        LocalDateTime 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

Original parameter name from the Odata EDM: PhysicalInventoryDocumentItem

material - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PhysicalInventoryDocument

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

batch - Batch

Constraints: Nullable, Maximum length: 10

Original parameter name from the Odata EDM: Batch

reasonForPhysInvtryDifference - Reason for Man. Val.

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: ReasonForPhysInvtryDifference

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

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

@Nonnull
public InitiateRecountFluentHelper initiateRecount(String physicalInventoryDocument,
                                                            String fiscalYear,
                                                            LocalDateTime physInventoryPlannedCountDate,
                                                            LocalDateTime 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

Original parameter name from the Odata EDM: PhysicalInventoryDocument

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PhysInventoryPlannedCountDate

documentDate - Document Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: DocumentDate

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: PhysicalInventoryNumber

physInventoryReferenceNumber - Phys. inventory ref.

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: PhysInventoryReferenceNumber

physicalInventoryDocumentDesc - Description

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: PhysicalInventoryDocumentDesc

postingThresholdValue - Threshold Value

Constraints: Nullable, Precision: 14, Scale: 3

Original parameter name from the Odata EDM: PostingThresholdValue

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

Original parameter name from the Odata EDM: PhysInvtryDocHasQtySnapshot

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

Original parameter name from the Odata EDM: PostingIsBlockedForPhysInvtry

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

@Nonnull
public InitiateRecountOnItemFluentHelper initiateRecountOnItem(String physicalInventoryDocument,
                                                                        String fiscalYear,
                                                                        String physicalInventoryDocumentItem,
                                                                        LocalDateTime physInventoryPlannedCountDate,
                                                                        LocalDateTime 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

Original parameter name from the Odata EDM: PhysicalInventoryDocument

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

physicalInventoryDocumentItem - Item

Constraints: Not nullable, Maximum length: 3

Original parameter name from the Odata EDM: PhysicalInventoryDocumentItem

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PhysInventoryPlannedCountDate

documentDate - Document Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: DocumentDate

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: PhysicalInventoryNumber

physInventoryReferenceNumber - Phys. inventory ref.

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: PhysInventoryReferenceNumber

physicalInventoryDocumentDesc - Description

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: PhysicalInventoryDocumentDesc

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

Original parameter name from the Odata EDM: PhysInvtryDocHasQtySnapshot

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

Original parameter name from the Odata EDM: PostingIsBlockedForPhysInvtry

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.