Skip to navigation
AvaTaxPublic reference

List Nexus By Form Code

View as Markdown

Access control: this endpoint is available to users with the everyone role.

Retrieves a list of nexus related to a tax form.

The concept of Nexus indicates a place where your company has sufficient physical presence and is obligated to collect and remit transaction-based taxes.

When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax in all jurisdictions affected by your transactions.

This API is intended to provide useful information when examining a tax form. If you are about to begin filing a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

formCodestringRequired
The form code that we are looking up the nexus for

Headers

X-Avalara-ClientstringOptionalDefaults to Swagger UI; 26.7.0; Custom; 1.0

Identifies the software you are using to call this API. For more information on the client header, see Client Headers .

Response

Success
formCodestringOptional
The code of the tax form that was requested
companyIdintegerOptional
The company ID of the company that was used to load the companyNexus array. If this value is null, no company data was loaded.
nexusDefinitionslist of objectsOptional

A list of all Avalara-defined nexus that are relevant to this tax form

companyNexuslist of objectsOptional

A list of all currently-defined company nexus that are related to this tax form