Chapter 5.1.18 - Detailed Tax Result

Detailed Tax Result

The Tax object contains the taxes generated for each line item:

Key Value
bill [bool] Billable
Indicates if the tax is billable to your customer
  • true: Standard billable tax
  • false: Non-billable tax that cannot be billed to the customer
cmpl [bool] Compliance
Indicates if the tax is to be reported to the jurisdiction
  • true: Standard compliance tax
  • false: Non-compliance tax that should not be reported to the jurisdiction
tm [double] Taxable Measure
The basis for calculation of rate-based taxes. Simple transactions result in a taxable measure equal to the sale price. However, tax-on-tax, caps, thresholds, tiers, and taxable amount modifiers can all result in taxable measures that are greater than or less than the sale price. For rate-based taxes, Tax Amount = Taxable Measure * Rate.

Taxable measure is adjusted by any factor that changes the tax calculation. Examples:
  • Taxable measure exceeds the sale amount: Tax-on-tax occurs - the tax amount calculated includes tax amount from other taxes. The additional taxes to be included are added to the taxable measure
  • Taxable measure is less than the sale price: A discount is applied - safe harbor exemptions or internet tax in Texas where the first $25 is exempt from taxation
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
min [double] Amount of minutes taxed
pcd [int] Reporting PCode
PCode representing reporting tax jurisdiction
taxpcd [int] Taxing PCode
PCode representing taxing jurisdiction. Only returned when retext in RequestConfig is set to true
rate [double] Applicable tax rate
sur [bool] Surcharge
Indicates if this tax is a surcharge
  • true: Surcharge rules apply to this tax
  • false: Tax is not a surcharge
tax [double] Tax Amount
For rate-based taxes, Tax Amount = Taxable Measure * Rate
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
usexm [bool] User Exempt
Flag indicating if the tax has been exempted by the user via Exemptions (exms)
  • true: Tax has been exempted by the user
  • false: Tax hasn't been exempted by the user
Only returned when retext in RequestConfig is set to true
notax [bool] Is No Tax Transaction
Flag indicating that the transaction processed successfully but returned no taxes. If no taxes are generated, the taxing jurisdiction used in the response is returned.
  • true: Item is a no tax entry
  • false: Item returned taxes
Only returned when retext in RequestConfig is set to true
trans [int] Transaction Type
Transaction type use to calculate tax. For bundles, this field shows the specific bundled item transaction type. Only returned when retext in RequestConfig is set to true
svc [int] Service Type
Service type use to calculate tax. For bundles, this field shows the specific bundled item transaction type. Only returned when retext in RequestConfig is set to true
chg [double] Charge
Charge used to calculate tax.
  • For bundles, this field shows the percentage of the charge applied to the bundled item
  • For tax inclusive calls, this field shows the calculated charge
Only returned when retext in RequestConfig is set to true


Note about Bundle Files

Bundled tax calculations return summarized detailed results when more than one bundle item returns the same tax type.

Example

"txs": [
  {
    "bill": true,
    "cmpl": true,
    "tm": 35.099999999999994,
    "calc": 1,
    "cat": "CONNECTIVITY CHARGES",
    "cid": 5,
    "name": "Universal Lifeline Telephone Service Charge (VoIP)",
    "exm": 64.9,
    "lns": 0,
    "min": 0,
    "pcd": 253500,
    "taxpcd": 2533500,
    "rate": 0.0475,
    "sur": true,
    "tax": 1.6672499999999997,
    "lvl": 1,
    "tid": 454,
    "usexm": false,
    "notax": false,
    "trans": 19,
    "svc": 6,
    "chg": 100
  }
]