A tax type exemption allows you to exempt taxes based on a tax type (tpe) and domain (dom) for a jurisdiction (loc). The tax type exemption is set on the invoice and applies to all line items included in the invoice.
Use the tax type wildcard (set both tpe and dom to 0) to exempt all taxes types.
A list of tax types is available in the /api/v2/afc/taxtype/{taxType} Lookup endpoint. Pass “*” in {taxType} to return all tax types.
Exemption fields used for tax type exemptions and default values for the applicable fields:
| Key | Name | Default if Not Set |
|---|---|---|
tpe | Tax Type ID | No default - must be set |
loc | Jurisdiction | No default - must be set |
exnb | Exempt Non-Billable | false |
dom | Domain | No default - must be set For more information, see Domain |
scp | Scope | Scope level For more information, see Scope |
frc | Force Level Exemptible | true when the tax type wildcard is used |
For more information about fields, see Exemptions.
This example demonstrates the use of domain (dom) and scope, unique for each exemption.
{ "cmpn": { "bscl": 1, "svcl": 0, "fclt": true, "frch": true, "reg": false }, "inv": [ { "bill": { "ctry": "USA", "st": "PR", "city": "Adjuntas", "zip": "00601", "int": true }, "cust": 1, "lfln": false, "date": "2018-02-01T12:00:00Z", "exms": [ { "loc": { "pcd": 5116000 }, "tpe": 35, "dom": 1, "scp": 256 }, { "loc": { "pcd": 5116000 }, "tpe": 1, "dom": 3, "scp": 1792 }, { "loc": { "pcd": 5116000 }, "tpe": 170, "dom": 0, "scp": 128 }, { "loc": { "pcd": 2604100 }, "tpe": 232, "dom": 1, "scp": 1920 } ], "itms": [ { "ref": "1.03.dom", "chg": 100, "line": 0, "sale": 1, "incl": false, "tran": 13, "serv": 6, "dbt": false, "adj": false } ], "invm": true, "dtl": true, "summ": false } ]}The effects of domain and scope are seen in the tax type (tid) and tax level (lvl).
{ "inv": [ { "itms": [ { "ref": "1.03.dom", "txs": [ { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "E-911 CHARGES", "cid": 7, "name": "E911 (Business)", "exm": 0, "lns": 0, "min": 0, "pcd": 5115900, "rate": 1, "sur": false, "tax": 0, "lvl": 1, "tid": 35 }, { "bill": true, "cmpl": true, "tm": 62.9, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "State Universal Service Fund", "exm": 37.1, "lns": 0, "min": 0, "pcd": 5115900, "rate": 0.0139, "sur": false, "tax": 0.8743099999999999, "lvl": 1, "tid": 13 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.01, "sur": false, "tax": 0, "lvl": 3, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.105, "sur": false, "tax": 0, "lvl": 1, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 37.1, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Fed USF Cellular", "exm": 62.9, "lns": 0, "min": 0, "pcd": 0, "rate": 0.195, "sur": false, "tax": 7.234500000000001, "lvl": 0, "tid": 55 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "REGULATORY CHARGES", "cid": 6, "name": "FCC Regulatory Fee (Wireless)", "exm": 100, "lns": 0, "min": 0, "pcd": 0, "rate": 0.0175, "sur": false, "tax": 0, "lvl": 0, "tid": 170 }, { "bill": false, "cmpl": true, "tm": 37.1, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Telecommunications Relay Surcharge (Cellular)", "exm": 62.9, "lns": 0, "min": 0, "pcd": 0, "rate": 0.02289, "sur": false, "tax": 0.8492190000000001, "lvl": 0, "tid": 232 } ] } ] } ]}This example demonstrates the use of the wildcard tax type (tpe and dom both are 0) to exempt all tax types at all levels (scp is 1920). Update the scope (scp) to limit where the wildcard tax type is applied.
{ "cmpn": { "bscl": 1, "svcl": 0, "fclt": true, "frch": true, "reg": false }, "inv": [ { "bill": { "ctry": "USA", "st": "PR", "city": "Adjuntas", "zip": "00601", "int": true }, "cust": 1, "lfln": false, "date": "2018-02-01T12:00:00Z", "exms": [ { "loc": { "pcd": 5116000 }, "tpe": 0, "dom": 0, "scp": 1920 } ], "itms": [ { "ref": "1.04.wild", "chg": 100, "line": 0, "sale": 1, "incl": false, "tran": 13, "serv": 6, "dbt": false, "adj": false } ], "invm": true, "dtl": true, "summ": false } ]}All taxes are exempt except for the non-billable tax (bill is false).
{ "inv": [ { "itms": [ { "ref": "1.04.wild", "txs": [ { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "E-911 CHARGES", "cid": 7, "name": "E911 (Business)", "exm": 0, "lns": 0, "min": 0, "pcd": 5115900, "rate": 1, "sur": false, "tax": 0, "lvl": 1, "tid": 35 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "State Universal Service Fund", "exm": 100, "lns": 0, "min": 0, "pcd": 5115900, "rate": 0.0139, "sur": false, "tax": 0, "lvl": 1, "tid": 13 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.01, "sur": false, "tax": 0, "lvl": 3, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.105, "sur": false, "tax": 0, "lvl": 1, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Fed USF Cellular", "exm": 100, "lns": 0, "min": 0, "pcd": 0, "rate": 0.195, "sur": false, "tax": 0, "lvl": 0, "tid": 55 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "REGULATORY CHARGES", "cid": 6, "name": "FCC Regulatory Fee (Wireless)", "exm": 100, "lns": 0, "min": 0, "pcd": 0, "rate": 0.0175, "sur": false, "tax": 0, "lvl": 0, "tid": 170 }, { "bill": false, "cmpl": true, "tm": 37.1, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Telecommunications Relay Surcharge (Cellular)", "exm": 62.9, "lns": 0, "min": 0, "pcd": 0, "rate": 0.02289, "sur": false, "tax": 0.8492190000000001, "lvl": 0, "tid": 232 } ] } ] } ]}This example sets the wildcard tax type (tpe and dom both 0) to exempt all tax types at all levels (scp is 1920), with the additional Exclude Non-Billable flag (exnb) set to true. Update the scope (scp) to limit where the wildcard tax type is applied.
{ "cmpn": { "bscl": 1, "svcl": 0, "fclt": true, "frch": true, "reg": false }, "inv": [ { "bill": { "ctry": "USA", "st": "PR", "city": "Adjuntas", "zip": "00601", "int": true }, "cust": 1, "lfln": false, "date": "2018-02-01T12:00:00Z", "exms": [ { "loc": { "pcd": 5116000 }, "tpe": 0, "dom": 0, "scp": 1920, "exnb": true } ], "itms": [ { "ref": "1.05.wild.nba", "chg": 100, "line": 0, "sale": 1, "incl": false, "tran": 13, "serv": 6, "dbt": false, "adj": false } ], "invm": true, "dtl": true, "summ": false } ]}All taxes are exempt, including the non-billable tax (bill is false).
{ "inv": [ { "itms": [ { "ref": "1.05.wild.nba", "txs": [ { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "E-911 CHARGES", "cid": 7, "name": "E911 (Business)", "exm": 0, "lns": 0, "min": 0, "pcd": 5115900, "rate": 1, "sur": false, "tax": 0, "lvl": 1, "tid": 35 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "State Universal Service Fund", "exm": 100, "lns": 0, "min": 0, "pcd": 5115900, "rate": 0.0139, "sur": false, "tax": 0, "lvl": 1, "tid": 13 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.01, "sur": false, "tax": 0, "lvl": 3, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.105, "sur": false, "tax": 0, "lvl": 1, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Fed USF Cellular", "exm": 100, "lns": 0, "min": 0, "pcd": 0, "rate": 0.195, "sur": false, "tax": 0, "lvl": 0, "tid": 55 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "REGULATORY CHARGES", "cid": 6, "name": "FCC Regulatory Fee (Wireless)", "exm": 100, "lns": 0, "min": 0, "pcd": 0, "rate": 0.0175, "sur": false, "tax": 0, "lvl": 0, "tid": 170 }, { "bill": false, "cmpl": true, "tm": 0, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Telecommunications Relay Surcharge (Cellular)", "exm": 100, "lns": 0, "min": 0, "pcd": 0, "rate": 0.02289, "sur": false, "tax": 0, "lvl": 0, "tid": 232 } ] } ] } ]}This example sets the wildcard tax type (tpe and dom both 0) to exempt all tax types at all levels (scp is 1920), with the additional Exclude Non-Billable flag (exnb) set to true. In addition, the Force Level Exemptible flag (frc) is set to false. Update the scope (scp) to limit where the wildcard tax type is applied.
{ "cmpn": { "bscl": 1, "svcl": 0, "fclt": true, "frch": true, "reg": false }, "inv": [ { "bill": { "ctry": "USA", "st": "PR", "city": "Adjuntas", "zip": "00601", "int": true }, "cust": 1, "lfln": false, "date": "2018-02-01T12:00:00Z", "exms": [ { "frc": false, "loc": { "pcd": 5116000 }, "tpe": 0, "dom": 0, "scp": 1920, "exnb": true } ], "itms": [ { "ref": "1.06.wild.nba.nofrc", "chg": 100, "line": 0, "sale": 1, "incl": false, "tran": 13, "serv": 6, "dbt": false, "adj": false } ], "invm": true, "dtl": true, "summ": false } ]}All taxes are exempt with the exception of the taxes that are not level exemptible (in this example, all of the Federal level taxes (lvl is 0)).
{ "inv": [ { "itms": [ { "ref": "1.06.wild.nba.nofrc", "txs": [ { "bill": true, "cmpl": true, "tm": 0, "calc": 2, "cat": "E-911 CHARGES", "cid": 7, "name": "E911 (Business)", "exm": 0, "lns": 0, "min": 0, "pcd": 5115900, "rate": 1, "sur": false, "tax": 0, "lvl": 1, "tid": 35 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "State Universal Service Fund", "exm": 100, "lns": 0, "min": 0, "pcd": 5115900, "rate": 0.0139, "sur": false, "tax": 0, "lvl": 1, "tid": 13 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.01, "sur": false, "tax": 0, "lvl": 3, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 0, "calc": 1, "cat": "SALES AND USE TAXES", "cid": 1, "name": "Sales Tax", "exm": 100, "lns": 0, "min": 0, "pcd": 5116000, "rate": 0.105, "sur": false, "tax": 0, "lvl": 1, "tid": 1 }, { "bill": true, "cmpl": true, "tm": 37.1, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Fed USF Cellular", "exm": 62.9, "lns": 0, "min": 0, "pcd": 0, "rate": 0.195, "sur": false, "tax": 7.234500000000001, "lvl": 0, "tid": 55 }, { "bill": true, "cmpl": true, "tm": 100, "calc": 2, "cat": "REGULATORY CHARGES", "cid": 6, "name": "FCC Regulatory Fee (Wireless)", "exm": 0, "lns": 0, "min": 0, "pcd": 0, "rate": 0.0175, "sur": false, "tax": 0.0175, "lvl": 0, "tid": 170 }, { "bill": false, "cmpl": true, "tm": 37.1, "calc": 1, "cat": "CONNECTIVITY CHARGES", "cid": 5, "name": "Telecommunications Relay Surcharge (Cellular)", "exm": 62.9, "lns": 0, "min": 0, "pcd": 0, "rate": 0.02289, "sur": false, "tax": 0.8492190000000001, "lvl": 0, "tid": 232 } ] } ] } ]}