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

LocationModel

A location where this company does business. Some jurisdictions may require you to list all locations where your company does business.

This model is used in the following APIs:

Parameters
idRequired
integer

The unique ID number of this location.

companyIdOptional
integer

The unique ID number of the company that operates at this location.

locationCodeRequired
string

A code that identifies this location. Must be unique within your company.

descriptionOptional
string

A friendly name for this location.

addressTypeIdRequired
string

Indicates whether this location is a physical place of business or a temporary salesperson location.

Enum: Location, Salesperson, Marketplace
addressCategoryIdRequired
string

Indicates the type of place of business represented by this location.

Enum: Storefront, MainOffice, Warehouse, Salesperson, Other, SellerRemitsTax, MarketplaceRemitsTax, NonPhysical, Vendor
isMarketplaceOutsideUsaOptional
boolean

Indicates whether the Marketplace is outside or in USA

line1Optional
string

The first line of the physical address of this location.

line2Optional
string

The second line of the physical address of this location.

line3Optional
string

The third line of the physical address of this location.

cityOptional
string

The city of the physical address of this location.

countyOptional
string

The county name of the physical address of this location. Not required.

regionOptional
string

Name or ISO 3166 code identifying the region within the country of the physical address of this location.

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.

postalCodeOptional
string

The postal code or zip code of the physical address of this location.

countryOptional
string

Name or ISO 3166 code identifying the country of the physical address of this location.

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.

latitudeOptional
number

Geospatial latitude measurement, in Decimal Degrees floating point format. If provided along with longitude, these coordinates will be used for tax calculations and will take precedence over the address fields.

longitudeOptional
number

Geospatial longitude measurement, in Decimal Degrees floating point format. If provided along with latitude, these coordinates will be used for tax calculations and will take precedence over the address fields.

isDefaultOptional
boolean

Set this flag to true to indicate that this is the default location for this company.

isRegisteredOptional
boolean

Set this flag to true to indicate that this location has been registered with a tax authority.

dbaNameOptional
string

If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.

outletNameOptional
string

A friendly name for this location.

effectiveDateOptional
string

The date when this location was opened for business, or null if not known.

endDateOptional
string

If this place of business has closed, the date when this location closed business.

lastTransactionDateOptional
string

The most recent date when a transaction was processed for this location. Set by AvaTax.

registeredDateOptional
string

The date when this location was registered with a tax authority. Not required.

createdDateOptional
string

The date when this record was created.

createdUserIdOptional
integer

The User ID of the user who created this record.

modifiedDateOptional
string

The date/time when this record was last modified.

modifiedUserIdOptional
integer

The user ID of the user who last modified this record.

settingsOptional
array

Extra information required by certain jurisdictions for filing. For a list of settings recognized by Avalara, query the endpoint "/api/v2/definitions/locationquestions". To determine the list of settings required for this location, query the endpoint "/api/v2/companies/(id)/locations/(id)/validate".

parametersOptional
array

List of location parameters.