Exclusions allow you to specify the state(s) where you want to exclude all taxes. Exclusions generally apply at the company level. State or country exclusions can either be applied to a client_profile_id in an exclusion file for the account or included in the transaction. We do not recommend doing both.
If a state is excluded, Federal taxes may still apply. If a country is excluded, no taxes will apply.
Although the CalcTaxes request gives the user the flexibility to input exclusion information for each transaction, we recommend using a client profile with a custom exclusion file applied. This results in better performance from the Tax Engine because your exclusion settings are cached before tax calculation begins.
Excluded tax jurisdictions will either appear as unknown or will not be included in any Transaction Service Reports (TSR) produced.
California (st) in the USA (ctry) is being excluded within the Exclusion (excl) object.
{ "cmpn": { "bscl": 0, "svcl": 0, "fclt": false, "frch": false, "reg": false, "excl": [ { "ctry": "USA", "st": "CA", "excl": true } ] }, "inv": [ { "doc": "TEST-VOIP 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": "2017-05-01T12:00:00Z", "itms": [ { "ref": "Line Item 001 - VoIP/Access Charge", "chg": 100, "line": 0, "sale": 1, "incl": false, "tran": 19, "serv": 6, "dbt": false, "adj": false }, { "ref": "Line Item 002 - VoIP/Lines", "chg": 0, "line": 10, "sale": 1, "incl": false, "tran": 19, "serv": 21, "dbt": false, "adj": false }, { "ref": "Line Item 003 - VoIP/Equip Rental", "chg": 25, "line": 0, "sale": 1, "incl": false, "tran": 19, "serv": 37, "dbt": false, "adj": false } ], "invm": true, "dtl": true, "summ": true, "opt": [ { "key": "1", "val": "VoIP Sample Line Items Invoice ABC-ZZZ" } ] } ]}All California state level taxes (lvl of 1) are excluded from the response.
{ "inv": [ { "doc": "TEST-VOIP INVOICE", "itms": [ { "ref": "Line Item 001 - VoIP/Access Charge", "txs": [ { "bill": true, "cmpl": true, "tm": 64.9, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "FUSF (VoIP)", "exm": 35.099999999999994, "lns": 0, "min": 0, "pcd": 0, "rate": 0.174, "sur": false, "tax": 11.2926, "lvl": 0, "tid": 162 }, { "bill": true, "cmpl": true, "tm": 64.9, "calc": 1, "cat": "REGULATORY CHARGES", "cid": 6, "name": "FCC Regulatory Fee (VoIP)", "exm": 35.099999999999994, "lns": 0, "min": 0, "pcd": 0, "rate": 0.00302, "sur": false, "tax": 0.19599800000000003, "lvl": 0, "tid": 226 } ] }, { "ref": "Line Item 002 - VoIP/Lines" }, { "ref": "Line Item 003 - VoIP/Equip Rental" } ], "summ": [ { "max": 2147483647, "min": 0, "tchg": 64.9, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "FUSF (VoIP)", "exm": 35.099999999999994, "lns": 0, "pcd": 0, "rate": 0.174, "sur": false, "tax": 11.2926, "lvl": 0, "tid": 162 }, { "max": 2147483647, "min": 0, "tchg": 64.9, "calc": 1, "cat": "REGULATORY CHARGES", "cid": 6, "name": "FCC Regulatory Fee (VoIP)", "exm": 35.099999999999994, "lns": 0, "pcd": 0, "rate": 0.00302, "sur": false, "tax": 0.19599800000000003, "lvl": 0, "tid": 226 } ] } ]}USA (ctry) is being excluded within the Exclusion (excl) object.
{ "cmpn": { "bscl": 0, "svcl": 0, "fclt": false, "frch": false, "reg": false, "excl": [ { "ctry": "USA", "excl": true } ] }, "inv": [ { "doc": "TEST-VOIP 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": "2017-05-01T12:00:00Z", "itms": [ { "ref": "Line Item 001 - VoIP/Access Charge", "chg": 100, "line": 0, "sale": 1, "incl": false, "tran": 19, "serv": 6, "dbt": false, "adj": false }, { "ref": "Line Item 002 - VoIP/Lines", "chg": 0, "line": 10, "sale": 1, "incl": false, "tran": 19, "serv": 21, "dbt": false, "adj": false }, { "ref": "Line Item 003 - VoIP/Equip Rental", "chg": 25, "line": 0, "sale": 1, "incl": false, "tran": 19, "serv": 37, "dbt": false, "adj": false } ], "invm": true, "dtl": true, "summ": true, "opt": [ { "key": "1", "val": "VoIP Sample Line Items Invoice ABC-ZZZ" } ] } ]}All taxes are excluded from the response.
{ "inv": [ { "doc": "TEST-VOIP INVOICE", "itms": [ { "ref": "Line Item 001 - VoIP/Access Charge" }, { "ref": "Line Item 002 - VoIP/Lines" }, { "ref": "Line Item 003 - VoIP/Equip Rental" } ] } ]}