Avalara Developer Network Developer communications

Chapter 2.1 - Required Fields

While the CalcTaxes request has numerous fields available, only a handful are required.

CompanyData

More information about CompanyData can be found here.

  • BusinessClass (bscl)
  • ServiceClass (svcl)
  • Facilities (fclt)
  • Regulated (reg)


If using the Exclusion object (excl), the following fields are required:

  • Country (ctry)
  • State (st)
  • ExclusionOn (excl)

Invoice

More information about Invoice can be found here.

  • BillTo (bill) - See Location below for more information
  • CustomerType (cust)
  • Date (date)
  • DocumentCode (doc) - only required when the Commit flag (cmmt) is set to true
  • LineItem object - More information about LineItem can be found here
    • Sale (sale)
    • TransactionType (tran)
    • ServiceType (serv)


If using the Exemption object (exms), the following fields are required:

  • Location (loc) - See Location below for more information
  • TaxType (tpe) and one of the following OR TaxCategory (cat)
    • TaxLevel (lvl)
    • Domain (dom)

Tax Override

If using the TaxOverride object (ovr), the following fields are required:

  • BracketInfo (brkt)
    • Rate (rate)
    • MaxBase (max)
  • Location (loc) - See Location below for more information
  • Scope (scp)
  • TaxType (tid)
  • TaxLevel (lvl)

Safe Harbor Override

If using the SafeHarborOverride object (sovr), the following fields are required:

  • SafeHarborType (sh)
  • OriginalFederalTam (old)
  • NewFederalTam (new)

Location

Location is used by the following objects:


When using the Location object, the following fields are required. Please note that only one of the options below is required.

  • PCode (pcd)
  • FIPS (fips)
  • NPANXX (npa)
  • StreetAddress (addr), City (city), State (st), and PostalCode (zip) when geo is true