Connectors
Finance, Billing & Payments
Avalara AvaTax
Sales tax calculation: transactions, companies, nexus, items, and exemption certificates
- Signs in with
- Username and password
- Runs on
- Cloud or On-Prem Worker
- Operations
- 491
- Ready-made triggers
- 4
Connect Avalara AvaTax
- In Neblex open Connect › Connections and click New Connection.
- Search for Avalara AvaTax and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| EnvironmentRequired | Production uses rest.avatax.com; Sandbox uses sandbox-rest.avatax.com. |
| Account ID or usernameRequired | Your AvaTax account ID (with a license key) or your AvaTax username (with its password). |
| License key or passwordRequiredSecret | The license key for the account ID, or the password for the username. |
Triggers
Start a flow when something changes in Avalara AvaTax: add a Poll for changes trigger, choose Avalara AvaTax and pick the event.
| Event | What it does | How |
|---|---|---|
| Exemption certificate created | Fires for each exemption certificate created since the last check. | Checks for changes by createdDate |
| Company created | Fires for each company created since the last check. | Checks for changes by createdDate |
| Customer created | Fires for each exemption customer created since the last check. | Checks for changes by createdDate |
| Transaction created or changed | Fires for each transaction created or changed in a company since the last check. | Checks for changes by modifiedDate |
Use it in a flow
- Open a flow, open the node library and search for Avalara AvaTax.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
491 operations in 51 groups. Each one is a step you can add to a flow.
Accounts12
Activate an account by accepting terms and conditionsactivateAccount | POST | Activate the account specified by the unique accountId number. |
Change configuration settings for this accountsetAccountConfiguration | POST | Update configuration settings tied to this account. |
Create license key for this accountcreateLicenseKey | POST | Creates a new license key for this account. |
Delete license key for this account by license key namedeleteLicenseKey | DELETE | Deletes the license key for this account using license key name. |
Get configuration settings for this accountgetAccountConfiguration | GET | Retrieve a list of all configuration settings tied to this account. |
Reset this account's license keyaccountResetLicenseKey | POST | Resets the existing license key for this account to a new key. |
Retrieve a list of MRS AccountslistMrsAccounts | GET | This API is available by invitation only. |
Retrieve a single accountgetAccount | GET | Get the account object identified by this URL. |
Retrieve all accountsqueryAccounts | GET | List all account objects that can be seen by the current user. |
Retrieve all license keys for this accountgetLicenseKeys | GET | Gets list of all the license keys used by the account. |
Retrieve audit history for an account.auditAccount | GET | Retrieve audit trace history for an account. |
Retrieve license key by license key namegetLicenseKey | GET | Security Policies |
Addresses2
Retrieve geolocation information for a specified US or Canadian addressresolveAddress | GET | Resolve a US or Canadian address against Avalara's address validation system. |
Retrieve geolocation information for a specified US or Canadian addressresolveAddressPost | POST | Resolve a US or Canadian address against Avalara's address validation system. |
APConfigSetting4
Create new rulecreateAPConfigSetting | POST | Create new rule |
Retrieve all rulesqueryAPConfigSetting | GET | Retrieve all rules |
Retrieve rule for this companygetAPConfigSettingByCompany | GET | Retrieve rule for this company |
Update a AP config settingupdateAPConfigSetting | PUT | Update a AP config setting |
AvaFileForms5
Create a new AvaFileFormcreateAvaFileForms | POST | Create one or more AvaFileForms A 'AvaFileForm' represents a form supported by our returns team |
Delete a single AvaFileFormdeleteAvaFileForm | DELETE | Marks the existing AvaFileForm object at this URL as deleted. |
Retrieve a single AvaFileFormgetAvaFileForm | GET | Get the AvaFileForm object identified by this URL. |
Retrieve all AvaFileFormsqueryAvaFileForms | GET | Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST . |
Update a AvaFileFormupdateAvaFileForm | PUT | All data from the existing object will be replaced with data in the object you PUT. |
Batches11
Cancel an in progress batchcancelBatch | POST | Marks the in progress batch identified by this URL as cancelled. |
Create a new Advanced Rules batchcreateAdvancedRulesBatch | POST | Create a new Advanced Rules batch objects attached to this company. |
Create a new batchcreateBatches | POST | Create one or more new batch objects attached to this company. |
Create a new transaction batchcreateTransactionBatch | POST | Create a new transaction batch objects attached to this company. |
Create custom rules import batch.createCustomRulesBatch | POST | Create a new custom rules import batch object attached to this company. |
Create item import batch.createItemImportBatch | POST | Create a new item import batch objects attached to this company. |
Delete a single batchdeleteBatch | DELETE | Marks the batch identified by this URL as deleted. |
Download a single batch filedownloadBatch | GET | Download a single batch file identified by this URL. |
Retrieve a single batchgetBatch | GET | Get the batch object identified by this URL. |
Retrieve all batchesqueryBatches | GET | Get multiple batch objects across all companies. |
Retrieve all batches for this companylistBatchesByCompany | GET | List all batch objects attached to the specified company. |
CertExpressInvites3
Create a CertExpress invitationcreateCertExpressInvitation | POST | Creates an invitation for a customer to self-report certificates using the CertExpress website. |
List CertExpress invitationslistCertExpressInvitations | GET | Retrieve CertExpress invitations sent by this company. |
Retrieve a single CertExpress invitationgetCertExpressInvitation | GET | Retrieve an existing CertExpress invitation sent to a customer. |
Certificates21
Check a company's exemption certificate status.getCertificateSetup | GET | Checks whether this company is configured to use exemption certificates in AvaTax. |
Create certificates for this companycreateCertificates | POST | Record one or more certificates document for this company. |
Delete Certificate Custom FieldsdeleteCertificateCustomFields | DELETE | Deletes custom fields for a specified certificate. |
Download an image for this certificatedownloadCertificateImage | GET | Download an image or PDF file for this certificate. |
Link attributes to a certificatelinkAttributesToCertificate | POST | Link one or many attributes to a certificate. |
Link customers to a certificatelinkCustomersToCertificate | POST | Link one or more customers to an existing certificate. |
List all attributes applied to this certificatelistAttributesForCertificate | GET | Retrieve the list of attributes that are linked to this certificate. |
List all certificates for a companyqueryCertificates | GET | List all certificates recorded by a company |
List customers linked to this certificatelistCustomersForCertificate | GET | List all customers linked to this certificate. |
List local exempt jurisdictions for a given exposure zone and tax codelistLocalExemptJurisdictions | GET | Returns the list of jurisdictions that are valid for a given combination of exposure zone and exemption tax code. |
List the certificate tax-type hierarchy available to this companylistCertificateTaxTypes | GET | Returns the TPS multi-tax type hierarchy that is applicable when configuring exemption certificates for the given country. |
List the exemption matrix entries for an exposure zonelistExemptionMatrix | GET | Returns the entries in this company's exemption matrix for one exposure zone. |
Request setup of exemption certificates for this company.requestCertificateSetup | POST | Requests the setup of exemption certificates for this company. |
Retrieve a single certificategetCertificate | GET | Get the current certificate identified by this URL. |
Retrieve Certificate Custom FieldslistCustomFieldsForCertificate | GET | This API is used to retrieve custom fields for a certificate. |
Revoke and delete a certificatedeleteCertificate | DELETE | Revoke the certificate identified by this URL, then delete it. |
Unlink attributes from a certificateunlinkAttributesFromCertificate | POST | Unlink one or many attributes from a certificate. |
Unlink customers from a certificateunlinkCustomersFromCertificate | POST | Unlinks one or more customers from a certificate. |
Update a single certificateupdateCertificate | PUT | Replace the certificate identified by this URL with a new one. |
Update Certificate Custom FieldsupdateCertificateCustomFields | PUT | Updates the values of custom fields for a certificate |
Upload an image or PDF attachment for this certificateuploadCertificateImage | POST | Upload an image or PDF attachment for this certificate. |
Clerk1
Retrieves a list of location records associated with the specified account. This endpoint is secured and requires...listLocationByAccount | GET | Security Policies |
CommunicationCertificates2
Retrieve a single communication certificate.getCommunicationCertificate | GET | Security Policies |
Retrieve all communication certificates.listCommunicationCertificates | GET | List all communication certificates that can be seen by the current user. |
Companies29
Add parameters to a company.createCompanyParameters | POST | Add parameters to a company. |
Change configuration settings for this companysetCompanyConfiguration | POST | Update configuration settings tied to this company. |
Change the filing status of this companychangeFilingStatus | POST | Changes the current filing status of this company. |
Check managed returns funding status for a companylistFundingRequestsByCompany | GET | This API is available by invitation only. |
Check the funding configuration of a companyfundingConfigurationByCompany | GET | This API is available by invitation only. |
Check the funding configuration of a companyfundingConfigurationsByCompanyAndCurrency | GET | This API is available by invitation only. |
Checks whether the integration being used to set up this company and run transactions onto this company is compliant to...certifyIntegration | GET | Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations. |
Create new companiescreateCompanies | POST | Create one or more new company objects. |
Create VAT Numbers for a companycreateVatNumbers | POST | Create one or more VAT number records for a company. |
Delete a single companydeleteCompany | DELETE | Deleting a company will delete all child companies, and all users attached to this company. |
Delete a single company parameterdeleteCompanyParameter | DELETE | Delete a parameter of a company. |
Delete a single VAT NumberdeleteVatNumber | DELETE | Marks the VAT number record identified by this URL as deleted. |
Get ACH entry detail report for company and periodlistACHEntryDetailsForCompany | GET | This API is available by invitation only. |
Get configuration settings for this companygetCompanyConfiguration | GET | Retrieve a list of all configuration settings tied to this company. |
Get this company's filing statusgetFilingStatus | GET | Retrieve the current filing status of this company. |
Quick setup for a company with a single physical addresscompanyInitialize | POST | Shortcut to quickly setup a single-physical-location company with critical information and activate it. |
Request managed returns funding setup for a companycreateFundingRequest | POST | This API is available by invitation only. |
Retrieve a list of MRS Companies with accountlistMrsCompanies | GET | This API is available by invitation only. |
Retrieve a single companygetCompany | GET | Get the company object identified by this URL. |
Retrieve a single company parametergetCompanyParameterDetail | GET | Retrieves a single parameter of a company. |
Retrieve a single VAT NumbergetVatNumber | GET | Retrieve a single VAT Number record by its unique ID. |
Retrieve all companiesqueryCompanies | GET | Get multiple company objects. |
Retrieve all customers and suppliers with their country parameters for a companygetAllCustomersAndSuppliersWithCountryParams | GET | Retrieves all customers and suppliers for a company along with their country parameters. |
Retrieve parameters for a companylistCompanyParameterDetails | GET | Retrieve all parameters of a company. |
Retrieve VAT Numbers for a companylistVatNumbers | GET | Retrieve all VAT Numbers associated with this company. |
Update a company parameterupdateCompanyParameterDetail | PUT | Update a parameter of a company. |
Update a single companyupdateCompany | PUT | Replace the existing company object at this URL with an updated object. |
Update a single VAT NumberupdateVatNumber | PUT | Replace the existing VAT number record with the data in the object you PUT. |
Validate a VAT Number without storing itvalidateVatNumber | POST | Performs a synchronous VAT number validation against the ELR / Directory Search service (which proxies VIES) without persisting any record in the CustomerVatNumber table. |
Compliance5
Retrieve all RateOptions.queryRateOptions | GET | This API is available by invitation only. |
Retrieve all State Reporting Codes based on filter.queryStateReportingCodes | GET | Security Policies |
Retrieve all tax type mappings based on filter.queryTaxTypeMappings | GET | Security Policies |
Retrieve all unique jurisnames based on filter.queryJurisNames | GET | Security Policies |
Retrieve StateConfig informationqueryStateConfig | GET | This API is available by invitation only. |
Contacts6
Create a new contactcreateContacts | POST | Create one or more new contact objects. |
Delete a single contactdeleteContact | DELETE | Mark the existing contact object at this URL as deleted. |
Retrieve a single contactgetContact | GET | Get the contact object identified by this URL. |
Retrieve all contactsqueryContacts | GET | Get multiple contact objects across all companies. |
Retrieve contacts for this companylistContactsByCompany | GET | List all contact objects assigned to this company. |
Update a single contactupdateContact | PUT | Replace the existing contact object at this URL with an updated object. |
CostCenter7
Bulk upload cost centersbulkUploadCostCenters | POST | Allows bulk upload of cost centers for the specified company. |
Create new cost centercreateCostCenter | POST | Creates one or more new item objects attached to this company. |
Delete cost center for the given iddeleteCostCenter | DELETE | Deletes a cost center with the specified costcenterId that belongs to the company. |
Retrieve a single cost centergetCostCenterById | GET | Retrieves details of a single cost center identified by costcenterId, which is owned by the company. |
Retrieve all cost centersqueryCostCenters | GET | Retrieves all cost centers available. |
Retrieve cost centers for this companylistCostCentersByCompany | GET | Retrieves a list of cost centers attached to this company. |
Update a single cost centerupdateCostCenter | PUT | Updates a single cost center owned by the company. |
CurrencyRoundingRules5
Create one or more currency rounding rulescreateCurrencyRoundingRules | POST | Create one or more currency rounding rules for this account. |
Delete a single currency rounding ruledeleteCurrencyRoundingRule | DELETE | Deletes the currency rounding rule identified by this URL. |
Retrieve a single currency rounding rulegetCurrencyRoundingRule | GET | Retrieves a single currency rounding rule identified by this URL. |
Retrieve all currency rounding rules for this account.listCurrencyRoundingRules | GET | Lists all account-specific currency rounding rules for this account. |
Update a currency rounding ruleupdateCurrencyRoundingRule | PUT | Replace the existing currency rounding rule at this URL with an updated object. |
Customers21
Add ship-to states to a customeraddShipToStatesForCustomer | POST | Adds one or more ship-to states to the specified customer. |
Create customers for this companycreateCustomers | POST | Create one or more customers for this company. |
Delete a customer recorddeleteCustomer | DELETE | Deletes the customer object referenced by this URL. |
Delete custom fieldsdeleteCustomFields | DELETE | Deletes the value of the custom field. |
Link attributes to a customerlinkAttributesToCustomer | PUT | Link one or many attributes to a customer. |
Link certificates to a customerlinkCertificatesToCustomer | POST | Link one or more certificates to a customer. |
Link two customer records togetherlinkShipToCustomersToBillCustomer | POST | Links a Ship-To customer record with a Bill-To customer record. |
List all customers for this companyqueryCustomers | GET | List all customers recorded by this company matching the specified criteria. |
List certificates linked to a customerlistCertificatesForCustomer | GET | List all certificates linked to a customer. |
List ship-to states linked to a customerlistShipToStatesForCustomer | GET | Retrieves the ship-to states associated with the specified customer. |
List valid certificates for a locationlistValidCertificatesForCustomer | GET | List valid certificates linked to a customer in a particular country and region. |
Remove ship-to states from a customerremoveShipToStatesForCustomer | DELETE | Removes one or more ship-to states from the specified customer. |
Retrieve a customer's attributeslistAttributesForCustomer | GET | Retrieve the attributes linked to the customer identified by this URL. |
Retrieve a single customergetCustomer | GET | Retrieve the customer identified by this URL. |
Retrieves a list of active certificates for a specified customer within a company.listActiveCertificatesForCustomer | GET | This API is intended to identify whether a customer has any active certificates. |
Retrieves a list of custom fields for a specified customer within a company.listCustomFieldsForCustomer | GET | This API is used to retrieve custom field for a customer. |
Retrieves a list of inactive certificates for a specified customer within a company.listInActiveCertificatesForCustomer | GET | This API is used to retrieve inactive certificates for a customer. |
Unlink attributes from a customerunlinkAttributesFromCustomer | PUT | Unlink one or many attributes from a customer. |
Unlink certificates from a customerunlinkCertificatesFromCustomer | POST | Remove one or more certificates to a customer. |
Update a single customerupdateCustomer | PUT | Replace the customer object at this URL with a new record. |
Update custom fieldsupdateCustomFields | PUT | Update the value of the custom field. |
CustomRules11
Construct an empty template for a rule definitiongetCustomRuleTemplate | POST | Generate a starter graph with empty nodes based on parameters specified in the request body. |
Create a new custom rulecreateCustomRule | POST | Creates a new custom rule object attached to this company. |
Delete a custom ruledeleteCustomRule | DELETE | Delete a single custom rule object attached to this company. |
Export custom rules for a companyexportCustomRules | GET | Export all rule objects defined for this company as a portable JSON envelope. |
Fetch a filtered list of components used in custom rule definitionsgetCustomRuleComponents | GET | Retrieve a list of supported custom rule components. |
Fetch a filtered list of supported custom rule expression tokensgetCustomRuleTokens | GET | Query the list of supported tokens for use in custom rule expressions. |
Fetch a filtered list of transaction fields supported by custom rulesgetCustomRuleFields | GET | Query the transaction properties which may be used in custom rules. |
Retrieve a single custom rulegetCustomRule | GET | Retrieves a single custom rule object attached to this company. |
Retrieve all custom rules for a companylistCustomRules | GET | Query the custom rule objects defined for this company. |
Update a custom ruleupdateCustomRule | PUT | Updates an existing custom rule object attached to this company. |
Validate a custom rulevalidateCustomRule | POST | Validates a custom rule and returns a detailed validation result. |
DataSources6
Create and store new datasources for the respective companies.createDataSources | POST | Create one or more datasource objects. |
Delete a datasource by datasource id for a company.deleteDataSource | DELETE | Marks the existing datasource for a company as deleted. |
Get data source by data source idgetDataSourceById | GET | Retrieve the data source by its unique ID number. |
Retrieve all datasourcesqueryDataSources | GET | Get multiple datasource objects across all companies. |
Retrieve all datasources for this companylistDataSources | GET | Gets multiple datasource objects for a given company. |
Update a datasource identified by id for a companyupdateDataSource | PUT | Updates a datasource for a company. |
Definitions78
List all available product classification systems.listProductClassificationSystems | GET | List all available product classification systems. |
List all customs duty programs recognized by AvaTaxlistPreferredPrograms | GET | List all preferred customs duty programs recognized by AvaTax. |
List all defined units of measurementlistUnitOfMeasurement | GET | List all units of measurement systems defined by Avalara. |
List all ISO 3166 countrieslistCountries | GET | Returns a list of ISO 3166 country codes based on the scope filter. |
List all ISO 3166 regionslistRegions | GET | Returns a list of all ISO 3166 region codes and their US English friendly names. |
List all ISO 3166 regions for a countrylistRegionsByCountry | GET | Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. |
List all ISO 4217 currencies supported by AvaTax.listCurrencies | GET | Lists all ISO 4217 currencies supported by AvaTax. |
List all market place locations.listAllMarketplaceLocations | GET | List all market place locations. |
List all nexus that apply to a specific address.listNexusByAddress | GET | Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. |
List all product classification systems available to a company based on its nexus.listProductClassificationSystemsByCompany | GET | Lists all product classification systems available to a company based on its nexus. |
List certificate attributes used by a companylistCertificateAttributes | GET | List the certificate attributes defined by a company either specified by the user or the user's default company. |
List certificate exposure zones used by a companylistCertificateExposureZones | GET | List the certificate exposure zones defined by a company. |
List certificate exposure zones used by a companylistCoverLetters | GET | List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. |
List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeIdlistJurisdictionTypesByRateTypeTaxTypeMapping | GET | Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId |
List jurisdictions based on the filter providedlistJurisdictions | GET | Returns a list of all Avalara-supported taxing jurisdictions. |
List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeIdlistJurisdictionsByRateTypeTaxTypeMapping | GET | Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId. |
List jurisdictions hierarchy based on the filter providedlistJurisdictionsHierarchy | GET | Returns a list of all Avalara-supported taxing jurisdictions hirearchy. |
List jurisdictions near a specific addresslistJurisdictionsByAddress | GET | Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. |
List nexus related to a tax formlistNexusByFormCode | GET | Retrieves a list of nexus related to a tax form. |
List of all event types that can be subscribed to for Item reverse sync webhook registrations.listItemReverseSyncEvents | GET | Security Policies |
List of all HS code classification statuses that can be assigned to an Item.listItemHSCodeClassificationStatus | GET | Security Policies |
List of all possible status which can be assigned to an itemlistItemsStatus | GET | Security Policies |
List of all recommendation status which can be assigned to an itemlistItemsRecommendationsStatus | GET | Security Policies |
List tax types, subtypes, and rate types applicable for a given jurisdictionlistJurisdictionTaxTypesAndSubTypes | GET | Returns a list of tax type and subtype groups, and optionally the available rate types for each group, applicable for a given jurisdiction. |
List the Avalara system default currency rounding rules.listCurrencyRoundingRuleDefaults | GET | Lists the Avalara system default currency rounding rules - the rounding Avalara applies to a currency when an account has no rule of its own. |
List the certificate exempt reasons defined by a companylistCertificateExemptReasons | GET | List the certificate exempt reasons defined by a company. |
List top level HS Code Sections.listCrossBorderSections | GET | Returns the full list of top level HS Code Sections. |
Lists all parents of an HS Code.getCrossBorderCode | GET | Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings |
Lists the next level of HS Codes given a destination country and HS Code prefix.listCrossBorderCodes | GET | Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if additional children are available. |
Retrieve the full list of Avalara-supported entity use codeslistEntityUseCodes | GET | Returns the full list of Avalara-supported entity use codes. |
Retrieve the full list of Avalara-supported extra parameters for creating transactions.listParameters | GET | Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. |
Retrieve the full list of Avalara-supported filing frequencies.listFilingFrequencies | GET | Returns the full list of Avalara-supported filing frequencies. |
Retrieve the full list of Avalara-supported forms for each tax authority.listTaxAuthorityForms | GET | Returns the full list of Avalara-supported forms for each tax authority. |
Retrieve the full list of Avalara-supported nexus for a country and region.listNexusByCountryAndRegion | GET | Returns all Avalara-supported nexus for the specified country and region. |
Retrieve the full list of Avalara-supported nexus for a country.listNexusByCountry | GET | Returns all Avalara-supported nexus for the specified country. |
Retrieve the full list of Avalara-supported nexus for a tax type group.listNexusByTaxTypeGroup | GET | Returns all Avalara-supported nexus for the specified specified tax type group. |
Retrieve the full list of Avalara-supported nexus for all countries and regions.listNexus | GET | Returns the full list of all Avalara-supported nexus for all countries and regions. |
Retrieve the full list of Avalara-supported permissionslistPermissions | GET | Returns the full list of Avalara-supported permission types. |
Retrieve the full list of Avalara-supported permissionslistSecurityRoles | GET | Returns the full list of Avalara-supported permission types. |
Retrieve the full list of Avalara-supported postal codes.listPostalCodes | GET | Retrieves the list of Avalara-supported postal codes. |
Retrieve the full list of Avalara-supported subscription typeslistSubscriptionTypes | GET | Returns the full list of Avalara-supported subscription types. |
Retrieve the full list of Avalara-supported tax authorities.listTaxAuthorities | GET | Returns the full list of Avalara-supported tax authorities. |
Retrieve the full list of Avalara-supported tax authority types.listTaxAuthorityTypes | GET | Returns the full list of Avalara-supported tax authority types. |
Retrieve the full list of Avalara-supported tax code types.listTaxCodeTypes | GET | Returns the full list of recognized tax code types. |
Retrieve the full list of Avalara-supported tax codes.listTaxCodes | GET | Retrieves the list of Avalara-supported system tax codes. |
Retrieve the full list of Avalara-supported tax notice customer funding options.listNoticeCustomerFundingOptions | GET | Returns the full list of Avalara-supported tax notice customer funding options. |
Retrieve the full list of Avalara-supported tax notice customer types.listNoticeCustomerTypes | GET | Returns the full list of Avalara-supported tax notice customer types. |
Retrieve the full list of Avalara-supported tax notice filing types.listNoticeFilingtypes | GET | Returns the full list of Avalara-supported tax notice filing types. |
Retrieve the full list of Avalara-supported tax notice priorities.listNoticePriorities | GET | Returns the full list of Avalara-supported tax notice priorities. |
Retrieve the full list of Avalara-supported tax notice reasons.listNoticeReasons | GET | Returns the full list of Avalara-supported tax notice reasons. |
Retrieve the full list of Avalara-supported tax notice responsibility idslistNoticeResponsibilities | GET | Returns the full list of Avalara-supported tax notice responsibility ids This API is intended to be useful to identify all the different tax notice responsibilities. |
Retrieve the full list of Avalara-supported tax notice root causeslistNoticeRootCauses | GET | Returns the full list of Avalara-supported tax notice root causes This API is intended to be useful to identify all the different tax notice root causes. |
Retrieve the full list of Avalara-supported tax notice statuses.listNoticeStatuses | GET | Returns the full list of Avalara-supported tax notice statuses. |
Retrieve the full list of Avalara-supported tax notice types.listNoticeTypes | GET | Returns the full list of Avalara-supported tax notice types. |
Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.listClassificationParametersUsage | GET | Returns the full list of Avalara-supported usage of extra parameters for item classification. |
Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.listParametersUsage | GET | Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. |
Retrieve the full list of Avalara-supported usage of parameters used for returns.listReturnsParametersUsage | GET | Returns the full list of Avalara-supported usage of extra parameters for the returns. |
Retrieve the full list of communications service typeslistCommunicationsServiceTypes | GET | Returns full list of service types for a given transaction type ID. |
Retrieve the full list of communications transaction/service type pairslistCommunicationsTSPairs | GET | Returns full list of communications transaction/service type pairs which are accepted in communication tax calculation requests. |
Retrieve the full list of communications transactiontypeslistCommunicationsTransactionTypes | GET | Returns full list of communications transaction types which are accepted in communication tax calculation requests. |
Retrieve the full list of nexus tax type groupslistNexusTaxTypeGroups | GET | Returns the full list of Avalara-supported nexus tax type groups This API is intended to be useful to identify all the different tax sub-types. |
Retrieve the full list of rate types for each countrylistRateTypesByCountry | GET | Returns the full list of Avalara-supported rate type file types This API is intended to be useful to identify all the different rate types. |
Retrieve the full list of tax sub typeslistTaxSubTypes | GET | Returns the full list of Avalara-supported tax sub-types This API is intended to be useful to identify all the different tax sub-types. |
Retrieve the full list of tax sub types by Country and TaxTypelistTaxSubTypesByCountryAndTaxType | GET | Returns the full list of Avalara-supported tax sub-types This API is intended to be useful to identify all the different tax sub-types for given country and TaxType. |
Retrieve the full list of tax sub types by jurisdiction code and regionlistTaxSubTypesByJurisdictionAndRegion | GET | Returns the full list of Avalara-supported tax sub-types by jurisdiction and region This API is intended to be useful to identify all the different tax sub-types. |
Retrieve the full list of tax type groupslistTaxTypeGroups | GET | Returns the full list of Avalara-supported tax type groups This API is intended to be useful to identify all the different tax type groups. |
Retrieve the full list of the AvaFile Forms availablelistAvaFileForms | GET | This API is deprecated. |
Retrieve the full list of the Tax Forms availablelistTaxForms | GET | Returns the full list of Avalara-supported Tax Forms This API is intended to be useful to identify all the different Tax Forms |
Retrieve the list all tags supported by avalaralistTags | GET | Retrieves the list of suggested locations for a marketplace. |
Retrieve the list of all valid unit of basislistAllUnitOfBasis | GET | Retrieve the list of all valid unit of basis |
Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeIdlistRegionsByCountryAndTaxTypeAndTaxSubTypeAndRateType | GET | Returns a list of all ISO 3166 region codes for a specific country code and their US English friendly names. |
Retrieve the list of applicable TaxTypeslistTaxTypesByNexusAndCountry | GET | Retrieves the list of applicable TaxTypes based on Nexus of the company. |
Retrieve the list of applicable UnitOfBasislistUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType | GET | Retrieves the list of applicable UnitOfBasis |
Retrieve the list of Avalara-supported parameters based on account subscriptions.listParametersByAccount | GET | Returns the list of Avalara-supported parameters based on account subscriptions. |
Retrieve the list of locations for a marketplace.listMarketplaceLocations | GET | Retrieves the list of suggested locations for a marketplace. |
Retrieve the list of questions that are required for a tax locationlistLocationQuestionsByAddress | GET | Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. |
Retrieve the list of rate types by country, TaxType and by TaxSubTypelistRateTypesByCountryTaxTypeTaxSubType | GET | Returns the list of Avalara-supported rate type file types This API is intended to be useful to identify all the different rate types. |
Retrieve the parameters by companyCode and itemCode.listParametersByItem | GET | Returns the list of parameters based on the company's service types and the item code. |
DistanceThresholds6
Create one or more DistanceThreshold objectscreateDistanceThreshold | POST | Create one or more DistanceThreshold objects for this company. |
Delete a single DistanceThreshold objectdeleteDistanceThreshold | DELETE | Marks the DistanceThreshold object identified by this URL as deleted. |
Retrieve a single DistanceThresholdgetDistanceThreshold | GET | Retrieves a single DistanceThreshold object defined by this URL. |
Retrieve all DistanceThreshold objectsqueryDistanceThresholds | GET | Lists all DistanceThreshold objects that belong to this account. |
Retrieve all DistanceThresholds for this company.listDistanceThresholds | GET | Lists all DistanceThreshold objects that belong to this company. |
Update a DistanceThreshold objectupdateDistanceThreshold | PUT | Replace the existing DistanceThreshold object at this URL with an updated object. |
DomainControlVerification3
Create Domain control verificationcreateDcv | POST | Create Domain control verification |
Get domain control verification by domainControlVerificationIdgetDcvById | GET | Get domain control verification by domainControlVerificationId |
Get domain control verifications by logged in user/domain name.filterDcv | GET | Get domain control verifications by logged in user/domain name. |
EcmEventNotifications4
Delete AFC event notifications.deleteAfcEventNotifications | DELETE | Security Policies |
Delete company event notificationsdeleteEventNotifications | DELETE | Security Policies |
Retrieve AFC event notificationslistAfcEventNotifications | GET | Security Policies |
Retrieve company event notifications.getEventNotifications | GET | Security Policies |
ECommerceToken2
Create a new ecommerce token.createECommerceToken | POST | Creates a new ecommerce token. |
Refresh an eCommerce token.refreshECommerceToken | PUT | Refresh an eCommerce token. |
EcoNexusThreshold1
Retrieve economic nexus threshold statuses for a companygetEcoNexusThresholds | GET | Retrieve the economic nexus threshold status for each US state in which activity has been evaluated for this company. |
FirmClientLinkages11
Approves linkage to a firm for a client accountapproveFirmClientLinkage | POST | This API enables the account admin of a client account to approve linkage request by a firm. |
Delete a linkagedeleteFirmClientLinkage | DELETE | This API marks a linkage between a firm and client as deleted. |
Get linkage between a firm and client by idgetFirmClientLinkage | GET | This API enables the firm admins/firm users to request the linkage of a firm account and a client account. |
Insert a full FirmClientLinkage recordinsertFirmClientLinkage | POST | Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. |
Links a firm account with the client accountcreateFirmClientLinkage | POST | This API enables the firm admins/firm users to request the linkage of a firm account and a client account. |
List client linkages for a firm or clientlistFirmClientLinkage | GET | This API enables the firm or account users to request the associated linkages to the account. |
Rejects linkage to a firm for a client accountrejectFirmClientLinkage | POST | This API enables the account admin of a client account to reject linkage request by a firm. |
Request a new FirmClient account and create an approved linkage to itcreateAndLinkNewFirmClientAccount | POST | This API is for use by Firms only. |
Reset linkage status between a client and firm back to requestedresetFirmClientLinkage | POST | This API enables the firm admin of a client account to reset a previously created linkage request by a firm. |
Revokes previously approved linkage to a firm for a client accountrevokeFirmClientLinkage | POST | This API enables the account admin of a client account to revoke a previously approved linkage request by a firm. |
Update a full FirmClientLinkage recordupdateFirmClientLinkage | PUT | Avalara allow updating the firm client linkage as a pass thru call. |
FormTypeMapping1
Resolves a form type to an extraction task identifier.resolveFormTypeTask | GET | Security Policies |
FundingRequests2
Request the javascript for a funding setup widgetactivateFundingRequest | GET | This API is available by invitation only. |
Retrieve status about a funding setup requestfundingRequestStatus | GET | This API is available by invitation only. |
GLAccount6
Bulk upload GL accountsbulkUploadGLAccounts | POST | Allows a bulk upload of GL accounts for the specified company. |
Create a new GL accountcreateGLAccount | POST | Creates one or more new GL account objects attached to this company. |
Delete the GL account associated with the given company ID and GL account IDdeleteGLAccount | DELETE | Deletes the GL account associated with the specified glaccountid and companyid |
Retrieve a single GL accountgetGLAccountById | GET | Retrieve details of a single GL account identified by its glaccountid and companyid |
Retrieve GL accounts for this companylistGLAccountsByCompany | GET | Retrieves a list of GL accounts attached to this company. |
Update a single GL accountupdateGLAccount | PUT | Updates a single GL account owned by the company. |
Items60
Add classifications to an item.createItemClassifications | POST | Add classifications to an item. |
Add custom parameters to an item.createItemCustomParameters | POST | Add custom parameters to an item. |
Add parameters to an item.createItemParameters | POST | Add parameters to an item. |
Add/update an item custom parameterupsertItemCustomParameter | PUT | Add/update an item custom parameter. |
Add/update an item parameter.upsertItemParameter | PUT | Add/update an item parameter. |
Add/update item classifications.upsertItemClassifications | PUT | Add/update classifications to an item. |
Bulk upload items from a product catalogbulkUploadItems | POST | Create/Update one or more item objects attached to this company. |
Create a new itemcreateItems | POST | Creates one or more new item objects attached to this company. |
Create a new tax code classification requestcreateTaxCodeClassificationRequest | POST | Creates a new tax code classification request. |
Create an HS code classification request.initiateHSCodeClassification | POST | Security Policies |
Create or update items from a product catalog.syncItemCatalogue | POST | Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company. |
Create tags for a itemcreateItemTags | POST | Creates one or more new Tag objects attached to this Item. |
Creates a batch to generate tax code recommendations asynchronously.createTaxcodeBatch | POST | Creates a new batch for asynchronous tax code recommendations processing. |
Delete a single itemdeleteCatalogueItem | DELETE | Deletes the item object at this URL. |
Delete a single itemdeleteItem | DELETE | Deletes the item object at this URL. |
Delete a single item classification.deleteItemClassification | DELETE | Delete a single item classification. |
Delete a single item custom parameterdeleteItemCustomParameter | DELETE | Delete a single item custom parameter. |
Delete a single item parameterdeleteItemParameter | DELETE | Delete a single item parameter. |
Delete all classifications for an itembatchDeleteItemClassifications | DELETE | Delete all the classifications for a given item. |
Delete all custom parameters for an itembatchDeleteItemCustomParameters | DELETE | Delete all the custom parameters for a given item. |
Delete all item tagsdeleteItemTags | DELETE | Deletes all Tags objects of an Item at this URL. |
Delete all parameters for an itembatchDeleteItemParameters | DELETE | Delete all the parameters for a given item. |
Delete item tag by iddeleteItemTag | DELETE | Deletes the Tag object of an Item at this URL. |
Delete the image associated with an item.deleteItemImage | DELETE | Delete the image associated with an item. |
Deletes a tax code recommendation batch.deleteBatchTaxCodeRecommendations | DELETE | Deletes the specified tax code recommendation batch. |
Deletes HS Code classification status for the item by status id.deleteHSCodeClassificationStatus | DELETE | Security Policies |
Dismiss the `Status` and `Details` values of the given ItemHSCodeClassificationStatus.dismissHSCodeClassificationStatus | PUT | Dismiss the existing Status and Details of the ItemHSCodeClassificationStatus object at this URL with an updated object. |
Fetch Additional HS Duty Details for itemsfetchAdditionalHSCodeDutyDetails | POST | Security Policies |
Get Item TaxCode RecommendationsgetItemTaxCodeRecommendations | GET | Provides at least three tax-code recommendations for the given company ID and item ID |
Get the image associated with an item.getProductImage | GET | Get the image file for the specified image ID linked to the item. |
Get the real-time tax code recommendations for the specified items without saving item data.getSyncTaxCodeRecommendations | POST | Provides immediate tax code recommendations for item details submitted in the request. |
Parse natural language query into structured filtersaIsearch | POST | Parse natural language queries into structured API filters. |
Patch a single itempatchItem | PATCH | Update the existing item object at this URL with the specified patch changes. |
Retrieve a single itemgetItem | GET | Get the Item object identified by this URL. |
Retrieve a single item classification.getItemClassification | GET | Retrieve a single item classification. |
Retrieve a single item custom parametergetItemCustomParameter | GET | Retrieve a single item custom parameter. |
Retrieve a single item parametergetItemParameter | GET | Retrieve a single item parameter. |
Retrieve all itemsqueryItems | GET | Get multiple item objects across all companies. |
Retrieve all items associated with given tagqueryItemsByTag | GET | Get multiple item objects associated with given tag. |
Retrieve classifications for an item.listItemClassifications | GET | List classifications for an item. |
Retrieve custom parameters for an itemlistItemCustomParameters | GET | List custom parameters for an item. |
Retrieve items for this companylistItemsByCompany | GET | List all items defined for the current company. |
Retrieve items for this company based on System Code and filter criteria(optional) providedqueryItemsBySystemCode | POST | Retrieve items based on System Code |
Retrieve parameters for an itemlistItemParameters | GET | List parameters for an item. |
Retrieve premium classification for a company's item based on its ItemCode and SystemCode.getPremiumClassification | GET | Retrieves the premium classification for an ItemCode and SystemCode. |
Retrieve premium classification for an item based on its `companyId` and `itemCode`.listItemPremiumClassifications | GET | Retrieve the premium classification for an Item based on its itemCode and companyId. |
Retrieve Restrictions for Item by CountryOfImportlistImportRestrictions | GET | Retrieve Restrictions for Item by CountryOfImport. |
Retrieve tags for an itemgetItemTags | GET | Get the Tag objects of an Item identified by this URL. |
Retrieve the HS code classification SLA details for a company.getHSCodeClassificationSLA | GET | This endpoint returns the SLA details for HS code classification for the specified company. |
Retrieve the parameters by companyId and itemId.listRecommendedParameterByCompanyIdAndItemId | GET | Returns the list of parameters based on the company's service types and the item code. |
Retrieves the status and results of a tax code recommendation batch.getBatchTaxCodeRecommendations | GET | Retrieves the status and results of a tax code recommendation batch for the specified company. |
Sync items from a product catalogsyncItems | POST | Syncs a list of items with AvaTax without waiting for them to be created. |
Update a single itemupdateItem | PUT | Replace the existing Item object at this URL with an updated object. |
Update an existing image for an item.updateImage | PUT | This endpoint allows users to update the existing image associated with a specific item by uploading a new image file. |
Update an item classification.updateItemClassification | PUT | Update an item classification. |
Update an item custom parameterupdateItemCustomParameter | PUT | Update an item custom parameter. |
Update an item parameterupdateItemParameter | PUT | Update an item parameter. |
Update HS Duty Details for an item.updateHSCodeDutyDetails | PUT | Security Policies |
Upload an image for an item.uploadImage | POST | This endpoint allows users to upload an image file for a specific item. |
Verify the HSCode to be valid/invalidverifyHSCode | POST | Security Policies |
ItemsReverseSync5
Create a webhook registration for a company.createReverseSyncRegistration | POST | Creates a webhook registration for the specified company. |
Delete a webhook registration.deleteReverseSyncRegistration | DELETE | Deletes the webhook registration identified by the specified registration ID for the given company. |
List webhook registrations for a company.listReverseSyncRegistrations | GET | Returns all webhook registrations for the specified company. |
Retrieve a webhook registration.getReverseSyncRegistration | GET | Returns the webhook registration identified by the specified registration ID for the given company. |
Update a webhook registration.updateReverseSyncRegistration | PATCH | Updates the webhook registration with the provided fields. |
Jobs11
Create a new job for a companycreateJob | POST | Security Policies |
Create a new phase on a jobcreateJobPhase | POST | Security Policies |
Create a new task on a phasecreateJobTask | POST | Security Policies |
Delete a jobdeleteJob | DELETE | Security Policies |
Delete a phase from a jobdeleteJobPhase | DELETE | Security Policies |
Delete a task from a phasedeleteJobTask | DELETE | Security Policies |
List all jobs for a companylistJobs | GET | List all jobs recorded by a company. |
Retrieve a single jobgetJob | GET | Retrieve a single job by its unique ID. |
Update an existing jobupdateJob | PUT | Security Policies |
Update an existing phase on a jobupdateJobPhase | PUT | Security Policies |
Update an existing task on a phaseupdateJobTask | PUT | Security Policies |
JurisdictionOverrides6
Create one or more overridescreateJurisdictionOverrides | POST | Creates one or more jurisdiction override objects for this account. |
Delete a single overridedeleteJurisdictionOverride | DELETE | Marks the item object at this URL as deleted. |
Retrieve a single overridegetJurisdictionOverride | GET | Get the item object identified by this URL. |
Retrieve all overridesqueryJurisdictionOverrides | GET | Get multiple jurisdiction override objects across all companies. |
Retrieve overrides for this accountlistJurisdictionOverridesByAccount | GET | List all jurisdiction override objects defined for this account. |
Update a single jurisdictionoverrideupdateJurisdictionOverride | PUT | Replace the existing jurisdictionoverride object at this URL with an updated object. |
Locations12
Add parameters to a location.createLocationParameters | POST | Add parameters to a location. |
Create a new locationcreateLocations | POST | Create one or more new location objects attached to this company. |
Delete a single locationdeleteLocation | DELETE | Mark the location object at this URL as deleted. |
Delete a single location parameterdeleteLocationParameter | DELETE | Delete a single location parameter. |
Retrieve a single company location parametergetLocationParameter | GET | Retrieve a single location parameter. |
Retrieve a single locationgetLocation | GET | Get the location object identified by this URL. |
Retrieve all locationsqueryLocations | GET | Get multiple location objects across all companies. |
Retrieve locations for this companylistLocationsByCompany | GET | List all location objects defined for this company. |
Retrieve parameters for a locationlistLocationParameters | GET | List parameters for a location. |
Update a location parameterupdateLocationParameter | PUT | Update a location parameter. |
Update a single locationupdateLocation | PUT | Replace the existing location object at this URL with an updated object. |
Validate the location against local requirementsvalidateLocation | GET | Returns validation information for this location. |
MultiDocument10
Adjust a MultiDocument transactionadjustMultiDocumentTransaction | POST | Adjusts the current MultiDocument transaction uniquely identified by this URL. |
Commit a MultiDocument transactioncommitMultiDocumentTransaction | POST | Marks a list of transactions by changing its status to Committed. |
Create a new MultiDocument transactioncreateMultiDocumentTransaction | POST | Records a new MultiDocument transaction in AvaTax. |
Create a refund for a MultiDocument transactionrefundMultiDocumentTransaction | POST | Create a refund for a MultiDocument transaction. |
Get audit information about a MultiDocument transactionauditMultiDocumentTransaction | GET | Retrieve audit information about a MultiDocument transaction stored in AvaTax. |
Retrieve a MultiDocument transactiongetMultiDocumentTransactionByCodeAndType | GET | Get the current MultiDocument transaction identified by this URL. |
Retrieve a MultiDocument transaction by IDgetMultiDocumentTransactionById | GET | Get the unique MultiDocument transaction identified by this URL. |
Retrieve all MultiDocument transactionslistMultiDocumentTransactions | GET | List all MultiDocument transactions within this account. |
Verify a MultiDocument transactionverifyMultiDocumentTransaction | POST | Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values. |
Void a MultiDocument transactionvoidMultiDocumentTransaction | POST | Voids the current transaction uniquely identified by this URL. |
Nexus15
Add parameters to a nexus.createNexusParameters | POST | Add parameters to the nexus. |
Create a new nexuscreateNexus | POST | Creates one or more new nexus declarations attached to this company. |
Creates nexus for a list of addresses.declareNexusByAddress | POST | This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. |
Delete a single nexusdeleteNexus | DELETE | Marks the existing nexus object at this URL as deleted. |
Delete a single nexus parameterdeleteNexusParameter | DELETE | Delete a single nexus parameter. |
Delete all parameters for a nexusdeleteNexusParameters | DELETE | Delete all the parameters for a given nexus. |
List company nexus related to a tax formgetNexusByFormCode | GET | Retrieves a list of nexus related to a tax form. |
Retrieve a single nexusgetNexus | GET | Get the nexus object identified by this URL. |
Retrieve a single nexus parametergetNexusParameter | GET | Retrieve a single nexus parameter. |
Retrieve all nexusqueryNexus | GET | Get multiple nexus objects across all companies. |
Retrieve nexus for this companylistNexusByCompany | GET | List all nexus objects defined for this company. |
Retrieve nexus for this company By TaxTypeGrouplistNexusByCompanyAndTaxTypeGroup | GET | List all nexus objects defined for this company filtered by TaxTypeGroup. |
Retrieve parameters for a nexuslistNexusParameters | GET | List parameters for a nexus. |
Update a nexus parameterupdateNexusParameter | PUT | Update a nexus parameter. |
Update a single nexusupdateNexus | PUT | Replace the existing nexus declaration object at this URL with an updated object. |
Notices4
Creates a new tax notice responsibility type.createNoticeResponsibilityType | POST | This API is available by invitation only and only available for users with Compliance admin access. |
Creates a new tax notice root cause type.createNoticeRootCauseType | POST | This API is available by invitation only and only available for users with Compliance admin access. |
Delete a tax notice responsibility type.deleteNoticeResponsibilityType | DELETE | This API is available by invitation only and only available for users with Compliance admin access. |
Delete a tax notice root cause type.deleteNoticeRootCauseType | DELETE | This API is available by invitation only and only available for users with Compliance admin access. |
Notifications3
List all notifications.listNotifications | GET | List all notifications. |
Mark a single notification as dismissed.dismissNotification | PUT | Marks the notification identified by this URL as dismissed. |
Retrieve a single notification.getNotification | GET | Retrieve a single notification by its unique ID number. |
Provisioning2
Request a new Avalara accountrequestNewAccount | POST | This API is for use by partner provisioning services customers only. |
Request a new entitilement to an existing customerrequestNewEntitlement | POST | This API is for use by partner provisioning services customers only. |
Registrar11
Create a new accountcreateAccount | POST | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Create a new subscriptioncreateSubscriptions | POST | This API is for use by Avalara Registrar administrative users only. |
Create new notifications.createNotifications | POST | This API is available by invitation only. |
Delete a single accountdeleteAccount | DELETE | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Delete a single notification.deleteNotification | DELETE | This API is available by invitation only. |
Delete a single subscriptiondeleteSubscription | DELETE | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Reset a user's password programmaticallyresetPassword | POST | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Retrieve the full list of Avalara-supported subscription (ServiceTypes)listServiceTypes | GET | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Update a single accountupdateAccount | PUT | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Update a single notification.updateNotification | PUT | This API is available by invitation only. |
Update a single subscriptionupdateSubscription | PUT | For Registrar Use Only This API is for use by Avalara Registrar administrative users only. |
Reports7
Download a reportdownloadReport | GET | This API downloads the file associated with a report. |
Download an audit log reportdownloadAuditLogReport | GET | This API downloads the file associated with an audit log report. |
Initiate an ExportAuditLogs report taskexportAuditLogs | POST | Begins running an ExportAuditLogs report task and returns the identity of the report. |
Initiate an ExportDocumentLine report taskinitiateExportDocumentLineReport | POST | Begins running an ExportDocumentLine report task and returns the identity of the report. |
List all report tasks for accountlistReports | GET | List all report tasks for your account. |
Retrieve a single audit log reportgetAuditLogReport | GET | Retrieve a single audit log report by its unique ID number. |
Retrieve a single reportgetReport | GET | Retrieve a single report by its unique ID number. |
Settings6
Create a new settingcreateSettings | POST | Create one or more new setting objects attached to this company. |
Delete a single settingdeleteSetting | DELETE | Mark the setting object at this URL as deleted. |
Retrieve a single settinggetSetting | GET | Get a single setting object by its unique ID. |
Retrieve all settingsquerySettings | GET | Get multiple setting objects across all companies. |
Retrieve all settings for this companylistSettingsByCompany | GET | List all setting objects attached to this company. |
Update a single settingupdateSetting | PUT | Replace the existing setting object at this URL with an updated object. |
Subscriptions3
Retrieve a single subscriptiongetSubscription | GET | Get the subscription object identified by this URL. |
Retrieve all subscriptionsquerySubscriptions | GET | Get multiple subscription objects across all accounts. |
Retrieve subscriptions for this accountlistSubscriptionsByAccount | GET | List all subscription objects attached to this account. |
TaxCodes6
Create a new tax codecreateTaxCodes | POST | Create one or more new taxcode objects attached to this company. |
Delete a single tax codedeleteTaxCode | DELETE | Marks the existing TaxCode object at this URL as deleted. |
Retrieve a single tax codegetTaxCode | GET | Get the taxcode object identified by this URL. |
Retrieve all tax codesqueryTaxCodes | GET | Get multiple taxcode objects across all companies. |
Retrieve tax codes for this companylistTaxCodesByCompany | GET | List all taxcode objects attached to this company. |
Update a single tax codeupdateTaxCode | PUT | Replace the existing taxcode object at this URL with an updated object. |
TaxContent6
Build a multi-location tax content filebuildTaxContentFile | POST | Builds a tax content file containing information useful for a retail point-of-sale solution. |
Build a tax content file for a single locationbuildTaxContentFileForLocation | GET | Builds a tax content file containing information useful for a retail point-of-sale solution. |
Download a file listing tax rates by postal codedownloadTaxRatesByZipCode | GET | Download a CSV file containing all five digit postal codes in the United States and their sales and use tax rates for tangible personal property. |
Get VAT rates for a countrygetVATRatesByCountry | GET | Returns VAT/GST rates for the specified country. |
Sales tax rates for a specified addresstaxRatesByAddress | GET | This API assumes that you are selling general tangible personal property at a retail point-of-sale location in the United States only. |
Sales tax rates for a specified country and postal code. This API is only available for US postal codes.taxRatesByPostalCode | GET | This API is only available for a US postal codes. |
TaxRules8
Create a new tax rulecreateTaxRules | POST | Create one or more custom tax rules attached to this company. |
Create new Country Coefficients. If already exist update them.createCountryCoefficients | PUT | Create one or more Country Coefficients for particular country. |
Delete a single tax ruledeleteTaxRule | DELETE | Mark the custom tax rule identified by this URL as deleted. |
Retrieve a single tax rulegetTaxRule | GET | Get the taxrule object identified by this URL. |
Retrieve all tax rulesqueryTaxRules | GET | Get multiple taxrule objects across all companies. |
Retrieve country coefficients for specific countrylistCountryCoefficients | GET | Retrieve all or any specific records of Country Coefficients based on the filters(optional) for specific country. |
Retrieve tax rules for this companylistTaxRules | GET | List all taxrule objects attached to this company. |
Update a single tax ruleupdateTaxRule | PUT | Replace the existing custom tax rule object at this URL with an updated object. |
Transactions24
Add lines to an existing unlocked transactionaddLines | POST | Add lines to an existing unlocked transaction. |
Change a transaction's codechangeTransactionCode | POST | Renames a transaction uniquely identified by this URL by changing its code value. |
Commit a transaction for reportingcommitTransaction | POST | Marks a transaction by changing its status to Committed. |
Correct a previously created transactionadjustTransaction | POST | Replaces the current transaction uniquely identified by this URL with a new transaction. |
Create a new transactioncreateTransaction | POST | Records a new transaction in AvaTax. |
Create a refund for a transactionrefundTransaction | POST | Create a refund for a transaction. |
Create or adjust a transactioncreateOrAdjustTransaction | POST | Records a new transaction or adjust an existing transaction in AvaTax. |
Fetches the Variance data generated for all the transactions done by Company.getAllVarianceReportByCompanyCode | GET | Security Policies |
Fetches the Variance data generated for particular Company by transaction IDgetVarianceReportByCompanyCodeByTransactionId | GET | Security Policies |
Generates the Variance report which will capture the difference between "Tax Calculated by Avalara" Vs "Actual Tax"...varianceReport | POST | Security Policies |
Get audit information about a transactionauditTransaction | GET | Retrieve audit information about a transaction stored in AvaTax. |
Get audit information about a transactionauditTransactionWithType | GET | Retrieve audit information about a transaction stored in AvaTax. |
Lock a set of documentsbulkLockTransaction | POST | This API is available by invitation only. |
Lock a single transactionlockTransaction | POST | Lock a transaction uniquely identified by this URL. |
Perform multiple actions on a transactionsettleTransaction | POST | Performs one or more actions against the current transaction uniquely identified by this URL. |
Remove lines from an existing unlocked transactiondeleteLines | POST | Remove lines to an existing unlocked transaction. |
Retrieve a single transaction by codegetTransactionByCode | GET | Get the current transaction identified by this company code, transaction code, and document type. |
Retrieve a single transaction by codegetTransactionByCodeAndType | GET | DEPRECATED: Please use the GetTransactionByCode API instead. |
Retrieve a single transaction by IDgetTransactionById | GET | Get the unique transaction identified by this URL. |
Retrieve all transactionslistTransactionsByCompany | GET | List all transactions attached to this company. |
Uncommit a transaction for reportinguncommitTransaction | POST | Adjusts a transaction by changing it to an uncommitted status. |
Unvoids a transactionunvoidTransaction | POST | Unvoids a voided transaction |
Verify a transactionverifyTransaction | POST | Verifies that the transaction uniquely identified by this URL matches certain expected values. |
Void a transactionvoidTransaction | POST | Voids the current transaction uniquely identified by this URL. |
Upcs6
Create a new UPCcreateUPCs | POST | Create one or more new UPC objects attached to this company. |
Delete a single UPCdeleteUPC | DELETE | Marks the UPC object identified by this URL as deleted. |
Retrieve a single UPCgetUPC | GET | Get the UPC object identified by this URL. |
Retrieve all UPCsqueryUPCs | GET | Get multiple UPC objects across all companies. |
Retrieve UPCs for this companylistUPCsByCompany | GET | List all UPC objects attached to this company. |
Update a single UPCupdateUPC | PUT | Replace the existing UPC object at this URL with an updated object. |
UserDefinedFields3
Delete a User Defined Field by User Defined Field id for a company.deleteUserDefinedField | DELETE | Marks the existing user defined field for a company as deleted. |
List user defined fields by company idlistUserDefinedFieldsByCompanyId | GET | Security Policies |
Update a User Defined Field identified by id for a companyupdateUserDefinedField | POST | Updates a User Defined Field for a company. |
Users8
Change PasswordchangePassword | PUT | Allows a user to change their password via an API call. |
Create new userscreateUsers | POST | Create one or more new user objects attached to this account. |
Delete a single userdeleteUser | DELETE | Mark the user object identified by this URL as deleted. |
Retrieve a single usergetUser | GET | Get the user object identified by this URL. |
Retrieve all entitlements for a single usergetUserEntitlements | GET | Return a list of all entitlements to which this user has rights to access. |
Retrieve all usersqueryUsers | GET | Get multiple user objects across all accounts. |
Retrieve users for this accountlistUsersByAccount | GET | List all user objects attached to this account. |
Update a single userupdateUser | PUT | Replace the existing user object at this URL with an updated object. |
Utilities3
Checks if the current user is subscribed to a specific servicegetMySubscription | GET | Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account. |
List all services to which the current user is subscribedlistMySubscriptions | GET | Returns the list of all subscriptions enabled for the currently logged in user. |
Tests connectivity and version of the serviceping | GET | Check connectivity to AvaTax and return information about the AvaTax API server. |
VendorCertificates1
List all vendor certificates for a companyqueryVendorCertificates | GET | List all certificates recorded by a company |
Vendors6
Create vendors for this companycreateVendors | POST | Create one or more vendors for this company. |
Delete a vendor recorddeleteVendor | DELETE | Deletes the vendor object referenced by this URL. |
List all vendors for this companyqueryVendors | GET | List all vendors recorded by this company matching the specified criteria. |
List certificates linked to a vendorlistCertificatesForVendor | GET | List all certificates linked to a vendor. |
Retrieve a single vendorgetVendor | GET | Retrieve the vendor identified by this URL. |
Update a single vendorupdateVendor | PUT | Replace the vendor object with a new record. |