public interface 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) |
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 RecountCreates a fluent helper for the InitiateRecount OData function import.
|
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 ItemCreates a fluent helper for the InitiateRecountOnItem OData function import.
|
PostDifferencesFluentHelper |
postDifferences(BigDecimal postingThresholdValue,
LocalDateTime 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,
LocalDateTime 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. |
PhysInventoryDocHeaderFluentHelper getAllPhysInventoryDocHeader()
PhysInventoryDocHeader
entities.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.PhysInventoryDocHeaderByKeyFluentHelper getPhysInventoryDocHeaderByKey(String fiscalYear, String physicalInventoryDocument)
PhysInventoryDocHeader
entity using key fields.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 DocumentConstraints: 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.PhysInventoryDocHeaderCreateFluentHelper createPhysInventoryDocHeader(PhysInventoryDocHeader physInventoryDocHeader)
PhysInventoryDocHeader
entity and save it to the S/4HANA system.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.PhysInventoryDocItemFluentHelper getAllPhysInventoryDocItem()
PhysInventoryDocItem
entities.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.PhysInventoryDocItemByKeyFluentHelper getPhysInventoryDocItemByKey(String fiscalYear, String physicalInventoryDocument, String physicalInventoryDocumentItem)
PhysInventoryDocItem
entity using key fields.physicalInventoryDocumentItem
- Physical Inventory Item NumberConstraints: 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 DocumentConstraints: Not nullable, Maximum length: 10
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.PhysInventoryDocItemUpdateFluentHelper updatePhysInventoryDocItem(PhysInventoryDocItem physInventoryDocItem)
PhysInventoryDocItem
entity and save it to the S/4HANA system.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.PostDifferencesFluentHelper postDifferences(BigDecimal postingThresholdValue, LocalDateTime postingDate, String physicalInventoryDocument, String fiscalYear)
Creates a fluent helper for the PostDifferences OData function import.
postingThresholdValue
- Threshold ValueConstraints: Nullable, Precision: 14, Scale: 3
Original parameter name from the Odata EDM: PostingThresholdValue
postingDate
- Posting DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: PostingDate
fiscalYear
- Fiscal YearConstraints: 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
execute
method on the fluent helper object.PostDifferencesOnItemFluentHelper postDifferencesOnItem(String physicalInventoryDocumentItem, String material, String physicalInventoryDocument, String fiscalYear, String batch, String reasonForPhysInvtryDifference, LocalDateTime postingDate)
Creates a fluent helper for the PostDifferencesOnItem OData function import.
physicalInventoryDocumentItem
- ItemConstraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: PhysicalInventoryDocumentItem
material
- MaterialConstraints: 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
- BatchConstraints: Nullable, Maximum length: 10
Original parameter name from the Odata EDM: Batch
postingDate
- Posting DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: PostingDate
fiscalYear
- Fiscal YearConstraints: 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
execute
method on the fluent helper object.InitiateRecountFluentHelper initiateRecount(String physicalInventoryDocument, String fiscalYear, LocalDateTime physInventoryPlannedCountDate, LocalDateTime documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, BigDecimal postingThresholdValue, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry)
Creates a fluent helper for the InitiateRecount OData function import.
documentDate
- Document DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: DocumentDate
physInvtryDocHasQtySnapshot
- Freeze Book InvtryConstraints: Nullable
Original parameter name from the Odata EDM: PhysInvtryDocHasQtySnapshot
postingThresholdValue
- Threshold ValueConstraints: Nullable, Precision: 14, Scale: 3
Original parameter name from the Odata EDM: PostingThresholdValue
physInventoryPlannedCountDate
- Planned Count DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: PhysInventoryPlannedCountDate
postingIsBlockedForPhysInvtry
- Phys. Inv. BlockConstraints: Nullable
Original parameter name from the Odata EDM: PostingIsBlockedForPhysInvtry
fiscalYear
- Fiscal YearConstraints: 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
- DescriptionConstraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: PhysicalInventoryDocumentDesc
execute
method on the fluent helper object.InitiateRecountOnItemFluentHelper initiateRecountOnItem(String physicalInventoryDocument, String fiscalYear, String physicalInventoryDocumentItem, LocalDateTime physInventoryPlannedCountDate, LocalDateTime documentDate, String physicalInventoryNumber, String physInventoryReferenceNumber, String physicalInventoryDocumentDesc, Boolean physInvtryDocHasQtySnapshot, Boolean postingIsBlockedForPhysInvtry)
Creates a fluent helper for the InitiateRecountOnItem OData function import.
documentDate
- Document DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: DocumentDate
physicalInventoryDocumentItem
- ItemConstraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: PhysicalInventoryDocumentItem
physInvtryDocHasQtySnapshot
- Freeze Book InvtryConstraints: Nullable
Original parameter name from the Odata EDM: PhysInvtryDocHasQtySnapshot
physInventoryPlannedCountDate
- Planned Count DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: PhysInventoryPlannedCountDate
postingIsBlockedForPhysInvtry
- Phys. Inv. BlockConstraints: Nullable
Original parameter name from the Odata EDM: PostingIsBlockedForPhysInvtry
fiscalYear
- Fiscal YearConstraints: 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
- DescriptionConstraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: PhysicalInventoryDocumentDesc
execute
method on the fluent helper object.Copyright © 2018 SAP SE. All rights reserved.