Chapter 4.2.2 - Exclusion

What is an Exclusion?

The Exclusion is a comma-delimited file used by Communications REST v2 to determine what states or countries should be excluded from consideration for taxation.

  • If a state is excluded, Federal taxes may still apply
  • If a country is excluded, no taxes are applied

The Exclusion is made up of a list of countries or country and state pairs.

Creating the Exclusion

Exclusions can be created in the Communications Customer Portal. For instructions on how to create Exclusions, click here.

Using the Exclusion

The Exclusion is applied to a client profile. You must pass the associated client_profile_id as part of the header to use the Exclusion.

Nothing special needs to be included in the transaction for the Exclusion to be applied. Simply run a transaction with the applicable client_profile_id. Remove any instances of the Exclusion object (excl) that may be included in the transaction.
For example, the Kansas taxes are excluded in this transaction, assuming a client profile is in use that has been updated with an Exclusion excluding USA,KS.

{
  "cmpn": {
    "bscl": 1,
    "svcl": 1,
    "fclt": true,
    "frch": true,
    "reg": true
  },
  "inv": [
    {
      "bill": {
        "ctry": "USA",
        "st": "KS",
        "cty": "Overland Park",
        "zip": 66212
      },
      "cust": 1,
      "date": "2018-09-24T11:00:00",
      "itms": [
        {
          "chg": 100,
          "line": 10,
          "sale": 1,
          "tran": 19,
          "serv": 6
        }
      ]
    }
  ]
}

PreviousNext