VisaType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

VisaType

All

SummaryCommodityCode optional Restriction of xs:string

Contains the 4-character national standard coding structure for the description of goods.May contain be null or all spaces.

DiscountAmt optional Restriction of xs:decimal

Contains the total discount amount applied to the transaction. This field may be null or contain zeroes if no discount was given.

If amount value is positive, then value is treated as discount for the invoice.

If amount value is negative, then value is treated as refund discount for the invoice.

FreightAmt optional Restriction of xs:decimal

Contains the total Freight/Shipping Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

DutyAmt optional Restriction of xs:decimal

Contains the Duty Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

NOTE: Duty may also be called Import Tax, Excise, or Customs Tax.

DestinationPostalZipCode optional Restriction of xs:string

Postal code of destination location. May contain spaces.

ShipFromPostalZipCode optional Restriction of xs:string

Postal code of the location being shipped from. May contain spaces.

DestinationCountryCode optional Restriction of xs:string

The 3-digit ISO Numeric Country Code of destination location (eg, 840). May contain spaces

InvoiceRefNbr optional Restriction of xs:string

Value Added Tax invoice reference number. May contain spaces.

OrderDate optional xs:dateTime

Date the order was taken. May be null or contain zeros.

VATTaxAmtFreight optional Restriction of xs:decimal

Contains any Value Added Tax Amount or Other Sales Tax Amount. This field may be null or contain zeroes if no freight/shipping tax amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

VATTaxRateFreight optional Restriction of xs:decimal

The Tax Rate of the Value Added Tax or Other Sales Tax.

DiscountTreatment optional Restriction of xs:int

Indicates how the merchant is managing discount.

Valid values:

0 - no invoice level discount provided

1 - tax was calculated on the post-discount invoice total.

2 - tax was calculated on the pre-discount invoice total.

TaxTreatment optional Restriction of xs:int

Indicates how the merchant is handling taxes

Valid values:

0 - NLL (net prices with tax calculated a line item level)

1 - NIL (net prices with tax calculated at invoice level)

2 - GLL (gross prices given with tax information provided at the line item level)

3 - GIL (gross prices given with tax information provided at invoice level)

4 - NON (no tax applies on the invoice for the transaction)

LineItems optional

Sequence 0..∞

LineItemDetail VisaLineItemsType Complex Type

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

Visa Element

Source

<xs:complexType name="VisaType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="SummaryCommodityCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the 4-character national standard coding structure for the description of goods.May contain be null or all spaces.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="4" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DiscountAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the total discount amount applied to the transaction. This field may be null or contain zeroes if no discount was given.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as discount for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as refund discount for the invoice.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="FreightAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the total Freight/Shipping Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as positive for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as negative for the invoice.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DutyAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the Duty Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as positive for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as negative for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">NOTE:  Duty may also be called Import Tax, Excise, or Customs Tax.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DestinationPostalZipCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Postal code of destination location. May contain spaces.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="10" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ShipFromPostalZipCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Postal code of the location being shipped from. May contain spaces.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="10" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DestinationCountryCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The 3-digit ISO Numeric Country Code of destination location (eg, 840). May contain spaces</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="3" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="InvoiceRefNbr" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Value Added Tax invoice reference number. May contain spaces.</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="OrderDate" type="xs:dateTime" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Date the order was taken. May be null or contain zeros.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="VATTaxAmtFreight" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains any Value Added Tax Amount or Other Sales Tax Amount. This field may be null or contain zeroes if no freight/shipping tax amount was applied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as positive for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as negative for the invoice.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="VATTaxRateFreight" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The Tax Rate of the Value Added Tax or Other Sales Tax.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="4" />
          <xs:minInclusive value="0" />
          <xs:maxExclusive value="100" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DiscountTreatment" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates how the merchant is managing discount.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Valid values:</p>
          <p xmlns="http://Hps.Exchange.PosGateway">0 - no invoice level discount provided</p>
          <p xmlns="http://Hps.Exchange.PosGateway">1 - tax was calculated on the post-discount invoice total.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">2 - tax was calculated on the pre-discount invoice total.</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:element name="TaxTreatment" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates how the merchant is handling taxes</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Valid values:</p>
          <p xmlns="http://Hps.Exchange.PosGateway">0 - NLL (net prices with tax calculated a line item level)</p>
          <p xmlns="http://Hps.Exchange.PosGateway">1 - NIL (net prices with tax calculated at invoice level)</p>
          <p xmlns="http://Hps.Exchange.PosGateway">2 - GLL (gross prices given with tax information provided at the line item level)</p>
          <p xmlns="http://Hps.Exchange.PosGateway">3 - GIL (gross prices given with tax information provided at invoice level)</p>
          <p xmlns="http://Hps.Exchange.PosGateway">4 - NON (no tax applies on the invoice for the transaction)</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="0" />
          <xs:maxInclusive value="4" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="LineItems" minOccurs="0">
      <xs:complexType>
        <xs:sequence minOccurs="0" maxOccurs="unbounded">
          <xs:element name="LineItemDetail" type="VisaLineItemsType" />
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:all>
</xs:complexType>