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

Interface PhysicalInventoryDocumentService

All Superinterfaces:

BatchService<PhysicalInventoryDocumentServiceBatch>

All Known Implementing Classes:

DefaultPhysicalInventoryDocumentService

public interface PhysicalInventoryDocumentService
extends BatchService<PhysicalInventoryDocumentServiceBatch>

You can count items and post differences on both document and item level. The service can be consumed by external systems..

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)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

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.
PhysicalInventoryDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
PhysicalInventoryDocumentService withServicePath(@Nonnull
                                                          String servicePath)

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.

getAllPhysInventoryDocHeader

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

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

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

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

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

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

Original parameter name from the Odata EDM: PostingThresholdValue

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PhysicalInventoryDocument

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

Post Difference on Item

Creates a fluent helper for the PostDifferencesOnItem OData function import.

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

reasonForPhysInvtryDifference - Reason for Man. Val.

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: ReasonForPhysInvtryDifference

batch - Batch

Constraints: Nullable, Maximum length: 10

Original parameter name from the Odata EDM: Batch

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PhysicalInventoryDocument

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

Original parameter name from the Odata EDM: DocumentDate

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

Original parameter name from the Odata EDM: PhysInvtryDocHasQtySnapshot

postingThresholdValue - Threshold Value

Constraints: Nullable, Precision: 14, Scale: 3

Original parameter name from the Odata EDM: PostingThresholdValue

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PhysInventoryPlannedCountDate

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

Original parameter name from the Odata EDM: PostingIsBlockedForPhysInvtry

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: PhysicalInventoryNumber

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PhysicalInventoryDocument

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

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

Creates a fluent helper for the InitiateRecountOnItem OData function import.

Parameters:

documentDate - Document Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: DocumentDate

physicalInventoryDocumentItem - Item

Constraints: Not nullable, Maximum length: 3

Original parameter name from the Odata EDM: PhysicalInventoryDocumentItem

physInvtryDocHasQtySnapshot - Freeze Book Invtry

Constraints: Nullable

Original parameter name from the Odata EDM: PhysInvtryDocHasQtySnapshot

physInventoryPlannedCountDate - Planned Count Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PhysInventoryPlannedCountDate

postingIsBlockedForPhysInvtry - Phys. Inv. Block

Constraints: Nullable

Original parameter name from the Odata EDM: PostingIsBlockedForPhysInvtry

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

physicalInventoryNumber - Phys. inventory no.

Constraints: Nullable, Maximum length: 16

Original parameter name from the Odata EDM: PhysicalInventoryNumber

physicalInventoryDocument - Phys. Inventory Doc.

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PhysicalInventoryDocument

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

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.