Open the Portico Developer Guide site
PosGateway Schema
VisaLineItemsType Complex Type
PosGateway Schema : VisaLineItemsType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
ItemTaxTreatment Element ItemTotalAmt Element DiscountAmt Element VATTaxRate Element VATTaxAmt Element UnitCost Element UnitOfMeasure Element Quantity Element ProductCode Element ItemDescription Element ItemCommodityCode Element Sequence VisaLineItemsType Complex Type
Overview
Sequence
ItemCommodityCode optional Restriction of xs:string

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

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 optional Restriction of xs:decimal

The number of units of the product being purchased. Must be numeric and greater than 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.

VATTaxAmt optional Restriction of xs:decimal

Contains any Value Added Tax Amount or Other Sales Tax Amount.

Note: Not applicable for US merchants.

VATTaxRate optional Restriction of xs:decimal

The tax rate (percentage) of the Value Added Tax or Other Sales Tax.

Note: Not applicable for US merchants.

DiscountAmt optional Restriction of xs:decimal

Contains any discount on this line item.

ItemTotalAmt optional Restriction of xs:decimal

Contains the total amount of the line item; calculated as unit cost multiplied by quantity, less discount. The total amount must be greater than zero.

ItemTaxTreatment optional Restriction of xs:int

0 No discount applied

1 Tax was calculated before the discount was applied

2 Tax was calculated after the discount was applied

Used By
LineItemDetail Element
Source
<xs:complexType name="VisaLineItemsType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <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="12" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <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="26" />
        </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="12" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="Quantity" minOccurs="0">
      <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:totalDigits value="12" />
          <xs:fractionDigits value="4" />
          <xs:minExclusive value="0" />
          <xs:maxExclusive value="100000000" />
        </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="VATTaxAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains any Value Added Tax Amount or Other Sales Tax Amount.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Not applicable for US merchants.
            </p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="12" />
          <xs:fractionDigits value="2" />
          <xs:maxExclusive value="10000000000" />
          <xs:minInclusive value="0" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="VATTaxRate" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The tax rate (percentage) of the Value Added Tax or Other Sales Tax.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Not applicable for US merchants.
            </p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:totalDigits value="4" />
          <xs:fractionDigits value="2" />
          <xs:maxExclusive value="100" />
          <xs:minInclusive value="0" />
        </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="ItemTotalAmt" minOccurs="0">
      <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. The total amount must be greater than zero.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ItemTaxTreatment" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">0 No discount applied</p>
          <p xmlns="http://Hps.Exchange.PosGateway">1 Tax was calculated before the discount was applied</p>
          <p xmlns="http://Hps.Exchange.PosGateway">2 Tax was calculated after the discount was applied</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="0" />
          <xs:maxInclusive value="2" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
  </xs:sequence>
</xs:complexType>
See Also
PosGateway Schema