<schema xmlns:pidx="http://www.api.org/pidXML" xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.api.org/pidXML" elementFormDefault="qualified" version="1.0">
<annotation>
<documentation>
<schemaName>Inventory Balance</schemaName>
<copyright>American Petroleum Institute (API), Petroleum Industry Data Exchange (PIDX) 2006</copyright>
<schemaVersion>1.0</schemaVersion>
<description>The InventoryBalance message can be used within two distinct business scenarios. The first is to return a response message back to a requesting party (i.e., shipper) containing inventory position information for that party for a given time period. The second is to publish inventory balance information to a pre-defined party(s) containing booked inventory and transaction summaries for given time period. This information is provided without a request invoking the transaction and may represent a scheduled job.</description>
</documentation>
</annotation>
<include schemaLocation="PIDXCodeLists.xsd"/>
<include schemaLocation="PIDXLib.xsd"/>
<complexType name="InventoryBalanceDetailsType">
<sequence>
<element ref="pidx:BeginningInventoryVolume" minOccurs="0"/>
<element ref="pidx:Shipments" minOccurs="0"/>
<element ref="pidx:Receipts" minOccurs="0"/>
<element ref="pidx:TransfersIn" minOccurs="0"/>
<element ref="pidx:TransfersOut" minOccurs="0"/>
<element ref="pidx:ExchangesIn" minOccurs="0"/>
<element ref="pidx:ExchangesOut" minOccurs="0"/>
<element ref="pidx:RegradesIn" minOccurs="0"/>
<element ref="pidx:RegradesOut" minOccurs="0"/>
<element ref="pidx:TruckRackOut" minOccurs="0"/>
<element ref="pidx:InventoryAdjustmentIn" minOccurs="0"/>
<element ref="pidx:InventoryAdjustmentOut" minOccurs="0"/>
<element ref="pidx:GainOrLoss" minOccurs="0"/>
<element ref="pidx:EndingInventoryVolume"/>
</sequence>
<attribute name="ProductCode" type="string" use="required">
<annotation>
<documentation>A code that identifies the inventoried product. Codes used are the Oil Industry Common Product Codes. The codes are maintained and available from the PIDX Downstream eBusiness Subcommittee. </documentation>
</annotation>
</attribute>
<attribute name="ProductName" type="string">
<annotation>
<documentation>The name of the product asscociated with the product code.</documentation>
</annotation>
</attribute>
</complexType>
<complexType name="InventoryBalanceHeaderType">
<sequence>
<element ref="pidx:ReportRunDateTime"/>
<element ref="pidx:StartDateTime"/>
<element ref="pidx:EndDateTime"/>
<element ref="pidx:TerminalInformation"/>
<element ref="pidx:Shipper"/>
<element ref="pidx:UnitOfMeasureCode"/>
</sequence>
</complexType>
<complexType name="InventoryBalanceInformationType">
<sequence>
<element ref="pidx:InventoryBalanceHeader"/>
<element ref="pidx:InventoryBalanceDetails" maxOccurs="99"/>
<element ref="pidx:InventoryBalanceSummary"/>
</sequence>
</complexType>
<complexType name="InventoryBalanceSummaryType">
<sequence>
<element ref="pidx:BeginningInventoryVolumeTotal"/>
<element ref="pidx:ShipmentsTotal"/>
<element ref="pidx:ReceiptsTotal"/>
<element ref="pidx:TransfersInTotal"/>
<element ref="pidx:TransfersOutTotal"/>
<element ref="pidx:ExchangesInTotal"/>
<element ref="pidx:ExchangesOutTotal"/>
<element ref="pidx:RegradesInTotal"/>
<element ref="pidx:RegradesOutTotal"/>
<element ref="pidx:TruckRackOutTotal"/>
<element ref="pidx:InventoryAdjustmentInTotal"/>
<element ref="pidx:InventoryAdjustmentOutTotal"/>
<element ref="pidx:GainOrLossTotal"/>
<element ref="pidx:EndingInventoryVolumeTotal"/>
</sequence>
</complexType>
<element name="BeginningInventoryVolume" type="integer">
<annotation>
<documentation>The inventory volume at the start datetime indicated in this request message</documentation>
</annotation>
</element>
<element name="BeginningInventoryVolumeTotal" type="integer">
<annotation>
<documentation>The book inventory volume (for all products in this message) at the begin datetime indicated in the header.</documentation>
</annotation>
</element>
<element name="EndDateTime" type="dateTime">
<annotation>
<documentation>The end datetime of the period requested.</documentation>
</annotation>
</element>
<element name="EndingInventoryVolume" type="integer">
<annotation>
<documentation>The book inventory volume (for a specific product) at the end datetime indicated in the header.</documentation>
</annotation>
</element>
<element name="EndingInventoryVolumeTotal" type="integer">
<annotation>
<documentation>The book inventory volume (for all products in this message) at the end datetime indicated in the header..</documentation>
</annotation>
</element>
<element name="ExchangesIn" type="integer">
<annotation>
<documentation>All exchanges in (other than truck rack)</documentation>
</annotation>
</element>
<element name="ExchangesInTotal" type="integer">
<annotation>
<documentation>All exchanges in (other than truck rack) for all products contained in this message.</documentation>
</annotation>
</element>
<element name="ExchangesOut" type="integer">
<annotation>
<documentation>All exchanges out (other than truck rack).</documentation>
</annotation>
</element>
<element name="ExchangesOutTotal" type="integer">
<annotation>
<documentation>All exchanges out (other than truck rack) for all products contained in this message.</documentation>
</annotation>
</element>
<element name="GainOrLoss" type="integer">
<annotation>
<documentation>The specific volume change (gain or loss) to the inventory for this product after all factors have been accounted for.</documentation>
</annotation>
</element>
<element name="GainOrLossTotal" type="integer">
<annotation>
<documentation>The specific volume change (gain or loss) to the inventory after all factors have been accounted for. This change represents all products contained in this message.</documentation>
</annotation>
</element>
<element name="InventoryAdjustmentIn" type="integer">
<annotation>
<documentation>Volume of all increase adjustments to inventory.</documentation>
</annotation>
</element>
<element name="InventoryAdjustmentInTotal" type="integer">
<annotation>
<documentation>Volume of all increase adjustments to inventory for all products contained in this message.</documentation>
</annotation>
</element>
<element name="InventoryAdjustmentOut" type="integer">
<annotation>
<documentation>Volume of all decrease adjustments to inventory.</documentation>
</annotation>
</element>
<element name="InventoryAdjustmentOutTotal" type="integer">
<annotation>
<documentation>Volume of all decrease adjustments to inventory for all products contained in this message.</documentation>
</annotation>
</element>
<element name="InventoryBalance">
<annotation>
<documentation xml:lang="en">Information regarding a book inventory position for all the products owned by a shipper at a given terminal.</documentation>
</annotation>
<complexType>
<choice>
<sequence>
<element name="Success" type="pidx:SuccessType" minOccurs="0">
<annotation>
<documentation xml:lang="en"> Standard way to indicate successful processing of a PIDX message. Returning an empty element of this type indicates success.</documentation>
</annotation>
</element>
<element name="Warnings" type="pidx:WarningsType" minOccurs="0">
<annotation>
<documentation xml:lang="en"> Standard way to indicate successful processing of an PIDX message, but one in which warnings are generated.</documentation>
</annotation>
</element>
<element ref="pidx:InventoryBalanceInformation">
<annotation>
<documentation>Information regarding a book inventory position for all the products owned by a shipper at a given terminal.</documentation>
</annotation>
</element>
</sequence>
<element name="Errors" type="pidx:ErrorsType">
<annotation>
<documentation xml:lang="en"> A collection of errors that occurred during the processing of a message.</documentation>
</annotation>
</element>
</choice>
<attribute ref="pidx:documentIdentifier" use="required"/>
<attribute ref="pidx:transactionPurposeIndicator" use="required"/>
<attribute ref="pidx:version"/>
</complexType>
</element>
<element name="InventoryBalanceDetails" type="pidx:InventoryBalanceDetailsType">
<annotation>
<documentation>Detailed inventory balance information.</documentation>
</annotation>
</element>
<element name="InventoryBalanceHeader" type="pidx:InventoryBalanceHeaderType">
<annotation>
<documentation>Header inventory balance information.</documentation>
</annotation>
</element>
<element name="InventoryBalanceInformation" type="pidx:InventoryBalanceInformationType">
<annotation>
<documentation>Inventory balance information.</documentation>
</annotation>
</element>
<element name="InventoryBalanceSummary" type="pidx:InventoryBalanceSummaryType">
<annotation>
<documentation>Summary inventory balance information.</documentation>
</annotation>
</element>
<element name="Product" type="pidx:ProductType">
<annotation>
<documentation>The inventoried product.</documentation>
</annotation>
</element>
<element name="Receipts" type="integer">
<annotation>
<documentation>Total volume of all receipts into the terminal (does not include exchange transactions).</documentation>
</annotation>
</element>
<element name="ReceiptsTotal" type="integer">
<annotation>
<documentation>Total volume of all receipts into the terminal (does not include exchange transactions). This volume represents alll products contained in this message.</documentation>
</annotation>
</element>
<element name="RegradesIn" type="integer">
<annotation>
<documentation>Volume of all reclassifications of an existing product or blending to covert to a new product.</documentation>
</annotation>
</element>
<element name="RegradesInTotal" type="integer">
<annotation>
<documentation>Volume of all reclassifications of an existing product or blending to covert to a new product. This volume represents alll products contained in this message.</documentation>
</annotation>
</element>
<element name="RegradesOut" type="integer">
<annotation>
<documentation>Volume of all reclassifications of an existing product or blending to covert to a new product.</documentation>
</annotation>
</element>
<element name="RegradesOutTotal" type="integer">
<annotation>
<documentation>Volume of all reclassifications of an existing product or blending to covert to a new product. This volume represents alll products contained in this message.</documentation>
</annotation>
</element>
<element name="ReportRunDateTime" type="dateTime">
<annotation>
<documentation> The date/time the actual summary report was run.</documentation>
</annotation>
</element>
<element name="Shipments" type="integer">
<annotation>
<documentation>Total volume of all shipments out of the terminal other than truck rack (does not include exchange transactions).</documentation>
</annotation>
</element>
<element name="ShipmentsTotal" type="integer">
<annotation>
<documentation>Total volume of all shipments out of the terminal other than truck rack (does not include exchange transactions). This volume represents alll products contained in this message.</documentation>
</annotation>
</element>
<element name="Shipper" type="pidx:CompanyInformationType">
<annotation>
<documentation> The owner of the product in the terminal.</documentation>
</annotation>
</element>
<element name="StartDateTime" type="dateTime">
<annotation>
<documentation> The start datetime of the period requested</documentation>
</annotation>
</element>
<element name="TransfersIn" type="integer">
<annotation>
<documentation>Stock transfers from another shipper within the same terminal (also referred to as PTO (product transfer order) or ITT (in-tank custody transfers)).</documentation>
</annotation>
</element>
<element name="TransfersInTotal" type="integer">
<annotation>
<documentation>The total number of stock transfers (for a given product for a given time period) from another shipper within the same terminal (also referred to as PTO (product transfer order) or ITT (in-tank custody transfers)).</documentation>
</annotation>
</element>
<element name="TransfersOut" type="integer">
<annotation>
<documentation>Stock transfers to another shipper within the same terminal (also referred to as PTO (product transfer order) or ITT (in-tank custody transfers)).</documentation>
</annotation>
</element>
<element name="TransfersOutTotal" type="integer">
<annotation>
<documentation>The total number of stock transfers (for a given product for a given time period) to another shipper within the same terminal (also referred to as PTO (product transfer order) or ITT (in-tank custody transfers)).</documentation>
</annotation>
</element>
<element name="TruckRackOut" type="integer">
<annotation>
<documentation>Sales and exchange volume for shipments through the truck rack.</documentation>
</annotation>
</element>
<element name="TruckRackOutTotal" type="integer">
<annotation>
<documentation>Sales and exchange volume for shipments through the truck rack. This volume represents alll products contained in this message.</documentation>
</annotation>
</element>
</schema>
|
XSD Schema Code: