Chapter 4.2.4 - Nexus File

What is a Nexus file?

The Nexus file is a file used by Communications REST v2 to determine which states you have nexus in for Sales and Use transactions.

The Nexus file a list of states where you have nexus. Only US states can be used.

Note

The Nexus file only applies to Sales and Use transactions. Telecom transactions are not affected by the Nexus file.

Creating the Nexus file

The Nexus file can be created manually. The file contains a list of abbreviated states.

Nexus files use a *.nex file extension.

Sample

For this example, the Exclusion file contains these states where you have nexus:

  • Kansas
  • Missouri
  • California
  • North Carolina
  • Washington
KS
MO
NC
WA
CA

Using the Nexus file

The Nexus file is applied to a client profile. You must pass the associated client_profile_id as part of the header to use the Nexus file.
Nothing special needs to be included in the transaction for the Nexus file to be applied. Simply run a transaction with the applicable client_profile_id.
For example, California taxes are returned for this transaction, assuming a client profile is in use that has been updated with an Nexus file with CA included.

{
  "cmpn": {
    "bscl": 0,
    "svcl": 0,
    "fclt": false,
    "frch": false,
    "reg": false
  },
  "inv": [
    {
      "doc": "TEST-SAU INVOICE",
      "cmmt": false,
      "bill": {
        "cnty": "San Francisco",
        "ctry": "USA",
        "int": true,
        "geo": false,
        "city": "San Francisco",
        "st": "CA",
        "zip": "94102"
      },
      "cust": 0,
      "lfln": false,
      "date": "2018-05-01T12:00:00Z",
      "itms": [
        {
          "ref": "Line Item 001 - Retail Sale General Merchandise/General Rule Default Attribute-Property",
          "chg": 100,
          "line": 0,
          "sale": 1,
          "incl": false,
          "tran": 34,
          "serv": 106,
          "prop": 0,
          "dbt": false,
          "adj": false
        },
        {
          "ref": "Line Item 002 - Consumer Use General Merchandise/General Rule Discount Attribute-Cash Discount Property",
          "chg": 100,
          "line": 0,
          "sale": 2,
          "incl": false,
          "tran": 34,
          "serv": 106,
          "prop": 13,
          "dbt": false,
          "adj": false
        },
        {
          "ref": "Line Item 003 - Vendor Use General Merchandise/General Rule Discount Attribute-Coupons Third Party Property",
          "chg": 100,
          "line": 0,
          "sale": 3,
          "incl": false,
          "tran": 34,
          "serv": 106,
          "prop": 7,
          "dbt": false,
          "adj": false
        }
      ],
      "invm": true,
      "dtl": true,
      "summ": true
    }
  ]
}

Requesting a new client profile or changes to an existing client profile

Contact CommunicationSupport@avalara.com:

  1. Request the customization files and configurations. Attach existing customization files to the email
  2. Include the environment(s)
  3. Include the client_profile_id to be updated if changes are needed to an existing client profile
  4. The client profiles could take up to 8 hours to become available once applied