MCLineItemsType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

MCLineItemsType

Sequence

ItemDescription optional Restriction of xs:string

Description of the good or service being supplied.

ProductCode optional Restriction of xs:string

Identifies the product being purchased, for example, an inventory number or UPC code. A value other than spaces or zeros should be provided.

Quantity Restriction of xs:decimal

The number of units of the product being purchased. Must be numeric and greater than zero.

ItemTotalAmt Restriction of xs:decimal

Contains the total amount of the line item; calculated as unit cost multiplied by quantity, less discount.

For Mastercard only, the item total amount may be zero.

UnitOfMeasure optional Restriction of xs:string

Contains the code indicating the unit of measure (gallons, etc.).

UnitCost optional Restriction of xs:decimal

The cost per unit of measure.

DiscountAmt optional Restriction of xs:decimal

Contains any discount on this line item.

ItemDiscountRate optional Restriction of xs:decimal

The discount rate applied to the item.

ZeroCostInd optional zeroCostIndReqType Simple Type

Indicates whether a line item was provided at zero cost.

Y - The line item is at zero cost to the customer. The item total item amount may be equal to zero.

N - The line item is not at zero cost to the customer. The item total amount may not be equal to zero.

ItemCommodityCode optional Restriction of xs:string

The national standard description code of the good or service being supplied.

HSTAmt optional amtTypeGlobal Simple Type

Harmonized Sales Tax.

HSTRate optional Restriction of xs:decimal

Harmonized Sales Tax Rate.

GSTAmt optional amtTypeGlobal Simple Type

Goods and Services Tax.

GSTRate optional Restriction of xs:decimal

Goods and Services Tax Rate.

PSTAmt optional amtTypeGlobal Simple Type

Provincial Sales Tax.

PSTRate optional Restriction of xs:decimal

Provincial Sales Tax Rate.

QSTAmt optional amtTypeGlobal Simple Type

Quebec Sales Tax.

QSTRate optional Restriction of xs:decimal

Quebec Sales Tax Rate.

Used By

LineItemDetail Element

Source

<xs:complexType name="MCLineItemsType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element name="ItemDescription" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Description of the good or service being supplied.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="35" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ProductCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Identifies the product being purchased, for example, an inventory number or UPC code. A value other than spaces or zeros should be provided.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9]*$" />
          <xs:maxLength value="15" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="Quantity">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The number of units of the product being purchased. Must be numeric and greater than zero.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="5" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="0" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ItemTotalAmt">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the total amount of the line item; calculated as unit cost multiplied by quantity, less discount.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">For Mastercard only, the item total amount may be zero.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="5" />
          <xs:totalDigits value="9" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="UnitOfMeasure" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the code indicating the unit of measure (gallons, etc.).</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9]*$" />
          <xs:maxLength value="12" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="UnitCost" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The cost per unit of measure.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="4" />
          <xs:totalDigits value="12" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DiscountAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains any discount on this line item.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="12" />
          <xs:fractionDigits value="2" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ItemDiscountRate" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The discount rate applied to the item.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="5" />
          <xs:fractionDigits value="2" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ZeroCostInd" type="zeroCostIndReqType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether a line item was provided at zero cost.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Y - The line item is at zero cost to the customer. The item total item amount may be equal to zero.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">N - The line item is not at zero cost to the customer. The item total amount may not be equal to zero.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ItemCommodityCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The national standard description code of the good or service being supplied.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9]*$" />
          <xs:maxLength value="15" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="HSTAmt" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Harmonized Sales Tax.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="HSTRate" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Harmonized Sales Tax Rate.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="5" />
          <xs:fractionDigits value="2" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="GSTAmt" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Goods and Services Tax.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="GSTRate" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Goods and Services Tax Rate.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="5" />
          <xs:fractionDigits value="2" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="PSTAmt" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Provincial Sales Tax.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PSTRate" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Provincial Sales Tax Rate.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="5" />
          <xs:fractionDigits value="2" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="QSTAmt" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Quebec Sales Tax.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="QSTRate" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Quebec Sales Tax Rate.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="5" />
          <xs:fractionDigits value="2" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
  </xs:sequence>
</xs:complexType>