TDV Adapter for Avalara

Build 22.0.8462

Nexus

Nexus table for AvalaraAvatax data provider.

Insert

To create a nexus declaration for your company, you must first obtain a list of Avalara-defined nexus querying NexusDefinitions table. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are CompanyId, EffectiveDate, EndDate, LocalNexusTypeId, TaxId, NexusTypeId, HasPermanentEstablishment, and IsSellerImporterOfRecord. When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. If any data does not match, AvaTax may not recognize your nexus declaration. To create a Nexus you must specify Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup of an existing Avalara-defined system nexus object and optionally any other selectable field.

INSERT INTO Nexus (CompanyId, Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup, EffectiveDate) VALUES (283040,'US','US','Country','US','UNITED STATES','UNITED STATES','Hospitality', '2019-11-08')

Update

Only user selectable fields can be updated. To update a nexus object, you need to specify Id and CompanyId in WHERE clause.

UPDATE Nexus SET HasPermanentEstablishment = true WHERE Id = 20684351 AND CompanyId = 283040

Delete

To delete a nexus object, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Nexus WHERE Id = 20684351 AND CompanyId = 283040

Columns

Name Type ReadOnly Description
Id [KEY] Int False

The unique ID number of this declaration of nexus.

CompanyId [KEY] Int False

The unique ID number of the company that declared nexus.

TaxAuthorityId Int False

A unique ID number of the tax authority that is associated with this nexus.

IsSellerImporterOfRecord Bool False

For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region. Set this value to `true` to consider your company as the importer of record and collect these taxes. Leave this value as false or null and taxes will be calculated as if your company is not the importer of record.

StateAssignedNo String False

The state assigned number of this jurisdiction.

Sourcing String False

Indicates whether this nexus is defined as origin or destination nexus.

JurisName String False

The common name of the jurisdiction in which this company declared nexus.

TaxId String False

Optional - the tax identification number under which you declared nexus.

JurisCode String False

The code identifying the jurisdiction in which this company declared nexus.

EffectiveDate Date False

The date when this nexus began. If not known, set to null.

CreatedUserId Int False

The User ID of the user who created this record.

Region String False

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

ModifiedDate Datetime False

The date/time when this record was last modified.

NexusTaxTypeGroup String False

The type of nexus that this company is declaring. Replaces NexusTypeId.

ShortName String False

The short name of the jurisdiction.

IsSSTActive Bool False

For the United States, this flag indicates whether this particular nexus falls within a U.S.

JurisdictionTypeId String False

The type of the jurisdiction in which this company declared nexus.

HasLocalNexus Bool False

True if you are also declaring local nexus within this jurisdiction. Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state.

ModifiedUserId Int False

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

Country String False

Name or ISO 3166 code identifying the country in which this company declared nexus.

HasPermanentEstablishment Bool False

Set this value to true if your company has a permanent establishment within this jurisdiction.

NexusTypeId String False

The type of nexus that this company is declaring.

EndDate Date False

If this nexus will end or has ended on a specific date, set this to the date when this nexus ends.

LocalNexusTypeId String False

If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions.

SignatureCode String False

The signature code of the boundary region as defined by Avalara.

CreatedDate Datetime False

The date when this record was created.

PageKey String False

Nexus table for AvalaraAvatax data provider.

Insert

To create a nexus declaration for your company, you must first obtain a list of Avalara-defined nexus querying NexusDefinitions table. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are CompanyId, EffectiveDate, EndDate, LocalNexusTypeId, TaxId, NexusTypeId, HasPermanentEstablishment, and IsSellerImporterOfRecord. When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. If any data does not match, AvaTax may not recognize your nexus declaration. To create a Nexus you must specify Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup of an existing Avalara-defined system nexus object and optionally any other selectable field.

INSERT INTO Nexus (CompanyId, Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup, EffectiveDate) VALUES (283040,'US','US','Country','US','UNITED STATES','UNITED STATES','Hospitality', '2019-11-08')

Update

Only user selectable fields can be updated. To update a nexus object, you need to specify Id and CompanyId in WHERE clause.

UPDATE Nexus SET HasPermanentEstablishment = true WHERE Id = 20684351 AND CompanyId = 283040

Delete

To delete a nexus object, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Nexus WHERE Id = 20684351 AND CompanyId = 283040

Columns

Name Type Description
Id [KEY] Int The unique ID number of this declaration of nexus.
TaxAuthorityId Int A unique ID number of the tax authority that is associated with this nexus.
IsSellerImporterOfRecord Bool For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region. Set this value to `true` to consider your company as the importer of record and collect these taxes. Leave this value as false or null and taxes will be calculated as if your company is not the importer of record.
StateAssignedNo String The state assigned number of this jurisdiction.
Sourcing String Indicates whether this nexus is defined as origin or destination nexus.
JurisName String The common name of the jurisdiction in which this company declared nexus.
TaxId String Optional - the tax identification number under which you declared nexus.
JurisCode String The code identifying the jurisdiction in which this company declared nexus.
EffectiveDate Date The date when this nexus began. If not known, set to null.
CreatedUserId Int The User ID of the user who created this record.
Region String Name or ISO 3166 code identifying the region within the country.
ModifiedDate Datetime The date/time when this record was last modified.
NexusTaxTypeGroup String The type of nexus that this company is declaring. Replaces NexusTypeId.
ShortName String The short name of the jurisdiction.
IsSSTActive Bool For the United States, this flag indicates whether this particular nexus falls within a U.S.
JurisdictionTypeId String The type of the jurisdiction in which this company declared nexus.
HasLocalNexus Bool True if you are also declaring local nexus within this jurisdiction. Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state.
ModifiedUserId Int The user ID of the user who last modified this record.
Country String Name or ISO 3166 code identifying the country in which this company declared nexus.
HasPermanentEstablishment Bool Set this value to true if your company has a permanent establishment within this jurisdiction.
NexusTypeId String The type of nexus that this company is declaring.
EndDate Date If this nexus will end or has ended on a specific date, set this to the date when this nexus ends.
LocalNexusTypeId String If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions.
SignatureCode String The signature code of the boundary region as defined by Avalara.
CreatedDate Datetime The date when this record was created.
PageKey String

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Rows@Next String Identifier for the next page of results. Do not set this value manually.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462