AvaTax

Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

JurisdictionHierarchyModel

Represents information about a single legal taxing jurisdiction with parent jurisdiction

Parameters
parentIdOptional
integer

ParentId of the Jurisdiction

nexusOptional
array

List of Nexus details associated with the jurisdiction

codeRequired
string

The code that is used to identify this jurisdiction

nameRequired
string

The name of this jurisdiction

typeRequired
string

The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.

Enum: Country, State, County, City, Special
rateOptional
number

The base rate of tax specific to this jurisdiction.

salesRateOptional
number

The "Sales" tax rate specific to this jurisdiction.

signatureCodeRequired
string

The Avalara-supplied signature code for this jurisdiction.

regionOptional
string

Name or ISO 3166 code identifying the region within the country.

This field supports many different region identifiers:

  • Two and three character ISO 3166 region codes
  • Fully spelled out names of the region in ISO supported languages
  • Common alternative spellings for many regions

For a full list of all supported codes and names, please see the Definitions API ListRegions.

useRateOptional
number

The "Seller's Use" tax rate specific to this jurisdiction.

cityOptional
string

The city name of this jurisdiction

countyOptional
string

The county name of this jurisdiction

countryOptional
string

Name or ISO 3166 code identifying the country of this jurisdiction.

This field supports many different country identifiers:

  • Two character ISO 3166 codes
  • Three character ISO 3166 codes
  • Fully spelled out names of the country in ISO supported languages
  • Common alternative spellings for many countries

For a full list of all supported codes and names, please see the Definitions API ListCountries.

shortNameOptional
string

A short name of the jurisidiction

stateFipsOptional
string

State FIPS code

countyFipsOptional
string

County FIPS code

placeFipsOptional
string

City FIPS code

idOptional
integer

Unique AvaTax Id of this Jurisdiction

effectiveDateOptional
string

The date this jurisdiction starts to take effect on tax calculations

endDateOptional
string

The date this jurisdiction stops to take effect on tax calculations

isAcmOptional
boolean

The isAcm specific to this jurisdiction.

isSstOptional
boolean

The isSst specific to this jurisdiction.

createDateOptional
string

The CreateDate specific to this jurisdiction.

isLocalAdminOptional
boolean

IsLocalAdmin.

modifiedDateOptional
string

ModifiedDate

taxAuthorityTypeIdOptional
integer

TaxAuthorityTypeId.