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
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: InventoryBalanceType
Properties: Global, Qualified, ID: oagis-id-cb3821c1e186420db1dcb48912a380ba
Content
- Sequence [1..1]
- GLEntityID [0..1] A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law. It is normally the primary balancing segment of the GL Account structure. Typically, this is the owning entity for the transaction. Synonyms are Business Unit, Fund, G/L Company, Joint Venture, Non-Profit Association Name
- 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] Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
- ReasonCode [0..*] Identifies the reason for an activity
- TransactionDateTime [0..1] The datetime of occurence of the transaction
- AvailableQuantity [0..1]
- 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.
- DensityConversionFactorNumber [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 actual weight of the ReceivedQuantity for the Item if the NetWeightQuantity cannot be calculated precisely via arithmetic because the goods do not have a consistent per unit weight. This quantity is generally used with the CatchWeightConversion Factor.
- CatchWeightConversionFactorNumber [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
- 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.
- WarehouseParty [0..1]
- CarrierParty [0..*] Identifies the party that serves as the carrier of the goods or services for the transaction.
- SupplierParty [0..*] Identifies the supplier organization/entity of the items or inventory for the associated transaction. In most cases there is one SupplierParty per transaction. i.e. one SupplierParty for a given PurchaseOrder. However in the cases where an transaction Broker is involved there are cases where a single transaction may have different SupplierParties at the line level or in the case of a Catalog for the Catalog.
- Party [0..*] A generic Party for non-validated or application-validated parties. A work-around for situations where Schema-validation of Parties is not feasible or not desired.
- Extension [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 Extension is always the last element in all components, except where the component has been extended inline.
from type IdentificationTypefrom type InventoryBalanceBaseTypefrom group InventoryTransactionGroupfrom group ReferencesGroup
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| typeCode | [0..1] | CodeType_1E7368 | from type IdentificationType | |
| actionCode | [0..1] | ActionCodeContentType | from type IdentificationType |
Used in
- Type AcknowledgeInventoryBalanceDataAreaType (Element DataArea)
- Type CancelAcknowledgeInventoryBalanceDataAreaType (Element DataArea)
- Type CancelInventoryBalanceDataAreaType (Element DataArea)
- Type ChangeAcknowledgeInventoryBalanceDataAreaType (Element DataArea)
- Type ChangeInventoryBalanceDataAreaType (Element DataArea)
- Type GetInventoryBalanceDataAreaType (Element DataArea)
- Type NotifyInventoryBalanceDataAreaType (Element DataArea)
- Type ProcessInventoryBalanceDataAreaType (Element DataArea)
- Type ShowInventoryBalanceDataAreaType (Element DataArea)
- Type SyncInventoryBalanceDataAreaType (Element DataArea)
- Type SyncResponseInventoryBalanceDataAreaType (Element DataArea)
Sample instance
<InventoryBalance> <ID/> <IDSet> <ID/> </IDSet> <GLEntityID>normalizedString</GLEntityID> <Facility> <ID/> <IDSet> <ID/> </IDSet> <Name/> <Description/> <Note/> <Address> <ID/> <IDSet>... </IDSet> <Name/> <AttentionOfName/> <CareOfName/> <BuildingNumber/> <BuildingName/> <BlockName/> <StreetName/> <StreetTypeCode>normalizedString</StreetTypeCode> <Floor/> <Unit/> <StairCase/> <Door/> <PostOfficeBox/> <DeliveryPointID>normalizedString</DeliveryPointID> <PlotID>normalizedString</PlotID> <CityName/> <CitySubDivisionName/> <CountrySubDivisionCode>token</CountrySubDivisionCode> <CountryCode>token</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <GeographicalCoordinate>... </GeographicalCoordinate> <Usage>... </Usage> <Extension>....................................... </Extension> </Address> <Coordinate> <ID/> <IDSet>... </IDSet> <Description/> <ReferenceSystemID/> <VerticalReferenceSystemID/> <VerticalMeasure>1.0</VerticalMeasure> <LatitudeMeasure>1.0</LatitudeMeasure> <LongitudeMeasure>1.0</LongitudeMeasure> <VerticalAccuracyMeasure>1.0</VerticalAccuracyMeasure> <HorizontalAccuracyMeasure>1.0</HorizontalAccuracyMeasure> <Extension>....................................... </Extension> </Coordinate> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Facility> <Status> <ID/> <IDSet> <ID/> </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </EffectiveTimePeriod> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Status> <ReasonCode>normalizedString</ReasonCode> <TransactionDateTime></TransactionDateTime> <AvailableQuantity>1.0</AvailableQuantity> <InspectedQuantity>1.0</InspectedQuantity> <AllocatedQuantity>1.0</AllocatedQuantity> <BlockedQuantity>1.0</BlockedQuantity> <StorageUOMCode>token</StorageUOMCode> <ValueClassification> <ID/> <IDSet> <ID/> </IDSet> <UNSPSCCode>normalizedString</UNSPSCCode> <Codes> <Code/> </Codes> <Description/> <Note/> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </ValueClassification> <DensityConversionFactorNumber>1.0</DensityConversionFactorNumber> <CatchWeightQuantity>1.0</CatchWeightQuantity> <CatchWeightConversionFactorNumber>1.0</CatchWeightConversionFactorNumber> <ActualTemperature>1.0</ActualTemperature> <ProductionOrderReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <ItemIdentification> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <ItemIDSet>... </ItemIDSet> <Extension>....................................... </Extension> </ItemIdentification> <Facility> <ID/> <IDSet>... </IDSet> <Name/> <Description/> <Note/> <Address>... </Address> <Coordinate>... </Coordinate> <Extension>....................................... </Extension> </Facility> <SerialLot> <ID/> <IDSet>... </IDSet> <ItemQuantity>1.0</ItemQuantity> <Lot>... </Lot> <Disposition>... </Disposition> <SerialNumberID>normalizedString</SerialNumberID> <ParentSerialNumberID>normalizedString</ParentSerialNumberID> <Description/> <Note/> <Extension>....................................... </Extension> </SerialLot> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </ProductionOrderReference> <SalesOrderReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <ReleaseNumberID>normalizedString</ReleaseNumberID> <ScheduleLineNumberID>normalizedString</ScheduleLineNumberID> <SubLineNumberID>normalizedString</SubLineNumberID> <OrderQuantity>1.0</OrderQuantity> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </SalesOrderReference> <DocumentReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Status> <LineNumberID/> <LineIDSet> <ID/> </LineIDSet> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </DocumentReference> <Attachment> <ID/> <IDSet> <ID/> </IDSet> <EmbeddedDataBinaryObject/> <URI>normalizedString</URI> <ISBN>normalizedString</ISBN> <FileName/> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <FileTypeCode>normalizedString</FileTypeCode> <FileSizeQuantity>1.0</FileSizeQuantity> <Title/> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Attachment> <WarehouseParty> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </WarehouseParty> <CarrierParty> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </CarrierParty> <SupplierParty> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <SalesContact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </SalesContact> <ShippingContact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </ShippingContact> <CustomerServiceContact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </CustomerServiceContact> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </SupplierParty> <Party> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Party> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </InventoryBalance>