On This Page
REST API

orderInformation. lineItems[].taxDetails[].code

Flag that indicates whether local sales tax is included in the order total.
Possible values:
  • 0
    : local sales tax not included
  • 1
    : local sales tax included
  • 2
    : tax exempt order
For Mastercard: Defines tax categories for domestic processing in certain locations.
Flag that indicates the type of tax collected for
orderInformation.lineItems[].taxDetails[].amount
.
Possible values:
  • 00
    : unknown
  • 01
    : federal or national sales tax
  • 02
    : states sales tax
  • 03
    : city sales tax
  • 04
    : local sales tax
  • 05
    : municipal sales tax
  • 06
    : other tax
  • 10
    : value-added tax (VAT)
  • 11
    : goods and services tax (GST)
  • 12
    : provincial sales tax
  • 20
    : room tax
  • 21
    : occupancy tax
  • 22
    : energy tax

Specifications

  • Data Type:
     String
  • Data Length:
     4

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxDetails[].code
  • SCMP API Fields:
    • alternate_tax_type_applied
    • local_tax_indicator
  • Simple Order API Fields:
    • item_#_alternateTaxTypeApplied
    • otherTax_localTaxIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:
  • Elavon Americas
    : Sales Tax Included
  • FDC Nashville Global
    : Item Tax Type Applied
  • OmniPay Direct
    : Local Tax Included
  • TSYS Acquiring Solutions
    : Local Tax Included Flag