InventoryBalance
Includes all stocked items and primarily represents the quantities of each item by location. Other item-by-location information, such as serial numbers or lot numbers, can also be included. The use of this noun does not include basic item master data that is independent of location, such as item description and dimensions. All Quantity information will be updated as replacing the entire field, not incremented by the quantity
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/Nouns/InventoryBalance.xsd
Type: InventoryBalanceType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- Sequence
[0..1]
- Sequence
[0..1]
- Item [0..1] Identifies the Item associated with the Line or Detail of a transaction. The item provides the details of the generic Item component information.
- SerialNumber [0..*] Unique serial number assigned to the given item instance by the manufacturer.
- SerializedLot [0..*] Is the Lot and Setial numbers for the items contained in the associated component by identifing the number of items and the uniques serial number of those items that belong to a given Lot.
- UID [0..*] Is a two dimensional data matrix bar code identifier. For example, a concatenation of a Cage Code and serial number.
- RFID [0..*] Allows an instance of an item to carry any radio frequency identifier (RFID) that maybe used by a supply chain.
- Quantity [0..1] Identifies the quantity of the associated service or item that is addresses by the component in which the quantity is associated.
- GLEntityID [0..1] Idenitifies GLEntity owns the item and takes the credit or debit for the item on the balance sheet.
- Facility [0..*] A Facility identifies a location within an entity. The facility may have sub-locators identified using a sequenced identification notation e.g. Warehouse A100 Sub-Location 11, Row R10 would be represented as an array of three Facility elements with values as A100, 11, R10, name attribute as Warehouse, Sub-Location and Row and sequence attribute as 1,2 and 3 respectively.
- Status [0..1] This determines the receipt routing of an item or part. Examples of values include: Customer consignment, Inspection, Vendor consignment, Blocked Bonded, User defined Possible synonyms are Receipt Routing, Material Status, Material Condition Code
- ReasonCode [0..*] Identifies the reason for the transaction.
- TransactionDateTime [0..1] Identifies the DateTime at which the inventory transaction was carried out
from group ItemInstanceGroup - Sequence
[0..1]
- AvailableQuantity [0..1] Number of inventory items that are available to be used.
- InspectedQuantity [0..1] Number of inventory items that have been inspected.
- AllocatedQuantity [0..1] Number of inventory items that have been allocated for other uses as such are no longer availble. Unless the allocation is overriden.
- BlockedQuantity [0..1] Number of inventory items that are blocked or unavailable.
- StorageUOMCode [0..1] This is the storage unit of measure of the item. This is sometimes different from the unit of measure that is used to count a product as it is consumed, sold or accounted for
- ValueClassification [0..1] Is a grouping used to determine the General Ledger accounting effect. These are user defined values, with the exception of the values TOTAL, MATERIAL, LABOR, BURDEN, OVERHEAD, SUBCONTRACT.
- DensityConversionFactor [0..1] The density factor is a simple field with a numeric value that enables a conversion rate to the standard density of a liquid.
- CatchWeightQuantity [0..1] This is the quantity of product as it is shipped. This quantity is generally used with the CatchWeightConversion Factor. This provides for the business case in process manufacturing when one is converting such things as the number of chickens that go into a box.
- CatchWeightConversionFactor [0..1] The catch weight conversion factor is a stock keeping conversion factor for inventory goods. This is a special conversion factor for when the units of measure can not be converted using arithmetic. This conversion factor is used with the CatchWeightQuantity. Examples of the use of this factor include: Number of Chickens to a Box Number of units of a chemical in a barrel
- ActualTemperature [0..*] Is the actual temperature taken at periodic times.
- ProductionOrderReference [0..*] Is reference to a ProductionOrder
- SalesOrderReference [0..*] Is a reference to a SalesOrder
- Sequence
[0..1]
- DocumentReference [0..*]
- Attachment [0..*] The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
- UserArea [0..1] Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.
from group InventoryTransactionGroupfrom group ReferencesGroup - Sequence
[0..1]
Attributes
None
Used in
- Type AcknowledgeInventoryBalanceDataAreaType (Element DataArea)
- Type CancelInventoryBalanceDataAreaType (Element DataArea)
- Type ChangeInventoryBalanceDataAreaType (Element DataArea)
- Type GetInventoryBalanceDataAreaType (Element DataArea)
- Type NotifyInventoryBalanceDataAreaType (Element DataArea)
- Type OAGIS9NounsType (Element OAGIS9Nouns)
- Type ProcessInventoryBalanceDataAreaType (Element DataArea)
- Type RespondInventoryBalanceDataAreaType (Element DataArea)
- Type ShowInventoryBalanceDataAreaType (Element DataArea)
- Type SyncInventoryBalanceDataAreaType (Element DataArea)
- Type UpdateInventoryBalanceDataAreaType (Element DataArea)
Sample instance
<InventoryBalance> <Item> <ItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </ItemID> <CustomerItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </CustomerItemID> <ManufacturerItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </ManufacturerItemID> <SupplierItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <ServiceIndicator>true</ServiceIndicator> <Description>string</Description> <Note>string</Note> <Classification> <Codes> </Codes> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Classification> <Specification> <ID>normalizedString</ID> <Property>... </Property> <UserArea> <!--any element--> </UserArea> </Specification> <HazardousMaterial> <ID>normalizedString</ID> <MFAGID>normalizedString</MFAGID> <TechnicalName>string</TechnicalName> <PlacardEndorsement>string</PlacardEndorsement> <PlacardNotation>string</PlacardNotation> <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode> <ToxicityZoneCode>normalizedString</ToxicityZoneCode> <Temperature unitCode="normalizedString">1.0</Temperature> <FlashpointTemperature unitCode="normalizedString">1.0</FlashpointTemperature> <PrimaryEntryRoute>string</PrimaryEntryRoute> <Description>string</Description> <EmergencyContact>... </EmergencyContact> <UserArea> <!--any element--> </UserArea> </HazardousMaterial> <Packaging> <ID>normalizedString</ID> <Description>string</Description> <Note>string</Note> <Type>normalizedString</Type> <Dimensions>... </Dimensions> <UPCPackagingLevelCode>normalizedString</UPCPackagingLevelCode> <PerPackageQuantity>1.0</PerPackageQuantity> <CapacityPerPackageQuantity>1.0</CapacityPerPackageQuantity> <UserArea> <!--any element--> </UserArea> </Packaging> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumber>normalizedString</SerialNumber> <Lot> <LotIDs>... </LotIDs> <EffectiveTimePeriod>... </EffectiveTimePeriod> <Quantity>1.0</Quantity> <SerialNumber>normalizedString</SerialNumber> <RFID>normalizedString</RFID> <UserArea> <!--any element--> </UserArea> </Lot> <UserArea> <!--any element--> </UserArea> </Item> <SerialNumber>normalizedString</SerialNumber> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot> <LotIDs>... </LotIDs> <EffectiveTimePeriod>... </EffectiveTimePeriod> <Quantity>1.0</Quantity> <SerialNumber>normalizedString</SerialNumber> <RFID>normalizedString</RFID> <UserArea> <!--any element--> </UserArea> </Lot> <Disposition> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <UID>normalizedString</UID> <RFID>normalizedString</RFID> <Quantity>1.0</Quantity> <GLEntityID>normalizedString</GLEntityID> <Facility> <IDs> <ID>normalizedString</ID> </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address> <ID>normalizedString</ID> <FormatCode>normalizedString</FormatCode> <AttentionOfName>string</AttentionOfName> <CareOfName>string</CareOfName> <AddressLine>string</AddressLine> <CitySubDivisionName>string</CitySubDivisionName> <CityName>string</CityName> <CountrySubDivisionCode>normalizedString</CountrySubDivisionCode> <CountryCode>normalizedString</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </Address> <Coordinate> <Latitude>... </Latitude> <Longitude>... </Longitude> <AltitudeMeasure unitCode="normalizedString">1.0</AltitudeMeasure> <UserArea> <!--any element--> </UserArea> </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <ReasonCode>normalizedString</ReasonCode> <TransactionDateTime>2000-01-01</TransactionDateTime> <AvailableQuantity>1.0</AvailableQuantity> <InspectedQuantity>1.0</InspectedQuantity> <AllocatedQuantity>1.0</AllocatedQuantity> <BlockedQuantity>1.0</BlockedQuantity> <StorageUOMCode>normalizedString</StorageUOMCode> <ValueClassification> <Codes> <Code>normalizedString</Code> </Codes> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </ValueClassification> <DensityConversionFactor>1.0</DensityConversionFactor> <CatchWeightQuantity>1.0</CatchWeightQuantity> <CatchWeightConversionFactor>1.0</CatchWeightConversionFactor> <ActualTemperature unitCode="normalizedString">1.0</ActualTemperature> <ProductionOrderReference> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> </ItemIDs> <Facility> <IDs>... </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address>... </Address> <Coordinate>... </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot>... </Lot> <Disposition>... </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <SalesOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <PurchaseOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </PurchaseOrderReference> <UserArea> <!--any element--> </UserArea> </ProductionOrderReference> <SalesOrderReference> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <DocumentReference> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> </ItemIDs> <Facility> <IDs>... </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address>... </Address> <Coordinate>... </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot>... </Lot> <Disposition>... </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <SalesOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <PurchaseOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </PurchaseOrderReference> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <IssuingParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </IssuingParty> <OperationReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <UserArea> <!--any element--> </UserArea> </OperationReference> <ReleaseNumber>normalizedString</ReleaseNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <ShipUnitReference> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <UserArea> <!--any element--> </UserArea> </ShipUnitReference> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </EffectiveTimePeriod> <Item> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <ServiceIndicator>true</ServiceIndicator> <Description>string</Description> <Note>string</Note> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumber>normalizedString</SerialNumber> <Lot>... </Lot> <UserArea> <!--any element--> </UserArea> </Item> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <Quantity>1.0</Quantity> <UserArea> <!--any element--> </UserArea> </DocumentReference> <Attachment> <EmbeddedData mimeCode="normalizedString">GpM7</EmbeddedData> <URI>http://www.example.com/</URI> <ISBN>normalizedString</ISBN> <FileName>string</FileName> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <FileType>normalizedString</FileType> <FileSizeQuantity>1.0</FileSizeQuantity> <Title>string</Title> <UserArea> <!--any element--> </UserArea> </Attachment> <UserArea> <!--any element--> </UserArea> </InventoryBalance>