Tax

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.

The Tax entity describes the tax rate charged to a customer for specific goods or services purchased in a specified geographic area. The goods and services are represented by a TaxCategory. The geographic area is represented by the a TaxRegion. There can be multiple TaxCategories per TaxRegion. Tax entities

NOTE  Any change made to the Tax entity will impact all items that are billed after the change is made.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: Tax
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • Only one tax rate can be compounded per TaxRegion and TaxCategory combination.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
id Tax ID integer    
IsCompounded Compounded boolean        
TaxCategoryID Tax Category ID integer TaxCategory  
TaxName Tax Name string (100)      
TaxRate Tax Rate double      
TaxRegionID Tax Region ID integer TaxRegion