Chapter 5.1.19 - Summarized Tax Result

Summarized Tax Result

The SummarizedTax object contains the tax data for summarized invoice taxes:

Key Value
max [double] Max Base
The maximum base for the tax bracket
min [double] Min Base
The minimum base for the tax bracket
tchg [double] Total Charge
Summarized charge amounts applied to the tax item from Invoice processing. Each entry in the summarized data has an individual total charge as it applies to the calculation of that specific summarized tax type and jurisdiction
calc [int] Calculation Type
Indicates how the tax is calculated
  • 1 Rate: Taxable Measure is multiplied by Rate
  • 2 Fixed: Fixed taxes represent a fixed tax that applies to the product being taxed
  • 3 PerMinute: Number of Minutes is multiplied by Rate
  • 4 PerLine: Number of Lines is multiplied by Rate
  • 5 SelfTaxingRate: Taxable Measure is multiplied by Self-Taxing Rate
  • 6 PerBracket: Number of Lines is multiplied by Rate based on tax bracket for line count
  • 7 FixedOnTier: Sale Amount is multiplied by Rate based on tax tier for sale amount
cat [string] Tax Category Name
  • Max length: 50 bytes
cid [int] Tax Category ID
name [string] Tax Name
  • Max length: 50 bytes
exm [double] Exempt Sale Amount
lns [int] Number of lines taxed
pcd [int] Reporting PCode
PCode representing reporting tax jurisdiction
rate [double] Applicable tax rate
sur [bool] Surcharge (deprecated)
Surcharge in the summarized taxes has been deprecated and will always return false.
tax [double] Summarized Tax Amount
lvl [int] Tax Level
Indicates the jurisdiction level of the tax
  • 0: Federal
  • 1: State
  • 2: County
  • 3: City
  • 4: Unincorporated
tid [int] Tax Type ID

Example

"summ": [
  {
    "max": 2147483647,
    "min": 0,
    "tchg": 25,
    "calc": 1,
    "cat": "SALES AND USE TAXES",
    "cid": 1,
    "name": "Sales Tax",
    "exm": 0,
    "lns": 0,
    "pcd": 377300,
    "rate": 0.0125,
    "sur": false,
    "tax": 0.3125,
    "lvl": 2,
    "tid": 1
  }
]
PreviousNext