@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.
Reference: SAP API Business Hub
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) |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultPhysicalInventoryDocumentService()
Creates a service using
PhysicalInventoryDocumentService.DEFAULT_SERVICE_PATH to send the requests. |
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.
|
public DefaultPhysicalInventoryDocumentService()
PhysicalInventoryDocumentService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultPhysicalInventoryDocumentService withServicePath(@Nonnull String servicePath)
PhysicalInventoryDocumentService
withServicePath
in interface PhysicalInventoryDocumentService
servicePath
- Service path that will override the default.@Nonnull public PhysInventoryDocHeaderFluentHelper getAllPhysInventoryDocHeader()
PhysicalInventoryDocumentService
PhysInventoryDocHeader
entities.getAllPhysInventoryDocHeader
in interface PhysicalInventoryDocumentService
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.@Nonnull public PhysInventoryDocHeaderByKeyFluentHelper getPhysInventoryDocHeaderByKey(String fiscalYear, String physicalInventoryDocument)
PhysicalInventoryDocumentService
PhysInventoryDocHeader
entity using key fields.getPhysInventoryDocHeaderByKey
in interface PhysicalInventoryDocumentService
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
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.@Nonnull public PhysInventoryDocHeaderCreateFluentHelper createPhysInventoryDocHeader(@Nonnull PhysInventoryDocHeader physInventoryDocHeader)
PhysicalInventoryDocumentService
PhysInventoryDocHeader
entity and save it to the S/4HANA system.createPhysInventoryDocHeader
in interface PhysicalInventoryDocumentService
physInventoryDocHeader
- PhysInventoryDocHeader
entity object that will be created in the S/4HANA system.PhysInventoryDocHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PhysInventoryDocItemFluentHelper getAllPhysInventoryDocItem()
PhysicalInventoryDocumentService
PhysInventoryDocItem
entities.getAllPhysInventoryDocItem
in interface PhysicalInventoryDocumentService
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.@Nonnull public PhysInventoryDocItemByKeyFluentHelper getPhysInventoryDocItemByKey(String fiscalYear, String physicalInventoryDocument, String physicalInventoryDocumentItem)
PhysicalInventoryDocumentService
PhysInventoryDocItem
entity using key fields.getPhysInventoryDocItemByKey
in interface PhysicalInventoryDocumentService
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
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.@Nonnull public PhysInventoryDocItemUpdateFluentHelper updatePhysInventoryDocItem(@Nonnull PhysInventoryDocItem physInventoryDocItem)
PhysicalInventoryDocumentService
PhysInventoryDocItem
entity and save it to the S/4HANA system.updatePhysInventoryDocItem
in interface PhysicalInventoryDocumentService
physInventoryDocItem
- PhysInventoryDocItem
entity object that will be updated in the S/4HANA system.PhysInventoryDocItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PostDifferencesFluentHelper postDifferences(BigDecimal postingThresholdValue, LocalDateTime postingDate, String physicalInventoryDocument, String fiscalYear)
PhysicalInventoryDocumentService
Creates a fluent helper for the PostDifferences OData function import.
postDifferences
in interface PhysicalInventoryDocumentService
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
execute
method on the fluent helper object.@Nonnull public PostDifferencesOnItemFluentHelper postDifferencesOnItem(String physicalInventoryDocumentItem, String material, String physicalInventoryDocument, String fiscalYear, String batch, String reasonForPhysInvtryDifference, LocalDateTime postingDate)
PhysicalInventoryDocumentService
Creates a fluent helper for the PostDifferencesOnItem OData function import.
postDifferencesOnItem
in interface PhysicalInventoryDocumentService
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
execute
method on the fluent helper object.@Nonnull public InitiateRecountFluentHelper initiateRecount(String physicalInventoryDocument, String fiscalYear, LocalDateTime physInventoryPlannedCountDate, LocalDateTime documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, BigDecimal postingThresholdValue, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry)
PhysicalInventoryDocumentService
Creates a fluent helper for the InitiateRecount OData function import.
initiateRecount
in interface PhysicalInventoryDocumentService
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
execute
method on the fluent helper object.@Nonnull public InitiateRecountOnItemFluentHelper initiateRecountOnItem(String physicalInventoryDocument, String fiscalYear, String physicalInventoryDocumentItem, LocalDateTime physInventoryPlannedCountDate, LocalDateTime documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry)
PhysicalInventoryDocumentService
Creates a fluent helper for the InitiateRecountOnItem OData function import.
initiateRecountOnItem
in interface PhysicalInventoryDocumentService
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
execute
method on the fluent helper object.Copyright © 2019 SAP SE. All rights reserved.