Tax Group
A tax group can be used to combine several tax codes, even if the taxes are paid to different jurisdictions. For example, a tax group in the US might include a state tax, a city tax, and a transit tax. The advantage of using a tax group is that, when you create a sales invoice, you can apply one tax group to the transaction, instead of several separate tax codes.
In the UI, you can access this record by going to Setup > Accounting > Taxes > Tax Groups (Administrator).
For more information about working with tax groups in the UI, see Tax Groups Overview.
For information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for the tax group REST record is taxGroup.
Subrecord
This record has the taxGroupTaxItem subrecord.
Prerequisites
The Legacy Tax feature must be enabled.
Actions
The tax group record has the following actions through REST web services:
-
Save new
-
Save
-
Reset
-
Delete
Usage Notes
Review these usage notes on working with the tax group record:
-
The set of returned fields is different for Canadian, US, and non-US nexuses.
Canada
US
Non-US
description
city
description
externalid
county
externalid
id
description
id
includechildren
externalid
includechildren
isinactive
id
isinactive
itemid
includechildren
itemid
nexuscountry
isdefault
message
piggyback
isinactive
nexuscountry
state
itemid
rate
subsidiary
message
subsidiary
taxitem1
nexuscountry
taxitem
taxitem2
piggyback
taxtype
unitprice1
rate
-
unitprice2
state
-
-
subsidiary
-
-
taxitem
-
-
taxitem1
-
-
taxitem2
-
-
unitprice1
-
-
unitprice2
-
-
zip
-
Code Samples
This code sample shows how to post the tax group record:
POST /services/rest/record/v1/taxGroup{
"city": "AmericanCity1",
"county": "NAPA CO",
"description": "TaxGroupLegacyFieldsRestExposureTest description",
"includeChildren": false,
"isDefault": true,
"itemId": "TaxGroup | 17489397623825",
"nexusCountry": "US",
"state": {
"id": "CA"
},
"subsidiary": {
"items": [
{
"id": "1"
}
]
},
"taxItem": {
"items": [
{
"rate": 1.0,
"taxName": "-138", // this is an ID
"taxType": "County"
},
{
"rate": 1.0,
"taxName": "-73", // this is an ID
"taxType": "City"
}
]
},
"zip": "1111"
}
This code sample shows how to get the tax group record:
GET /services/rest/record/v1/taxgroup/{{taxgroupId}}
This code sample shows how to update the tax group record:
PATCH /services/rest/record/v1/taxgroup/{{taxgroupId}}
{
"city": "AmericanCity2",
"county": "NAPA CO edit",
"description": "TaxGroupLegacyFieldsRestExposureTest description update",
"includeChildren": true,
"isDefault": false,
"itemId": "TaxGroup edit | 1748939762382"
}
This code sample shows how to delete the tax group record:
DELETE /services/rest/record/v1/taxgroup/{{taxgroupId}}