Item tax groups

Item tax groups enable taxes to be applied to items. Applicable only with Advanced Tax, for more information see Item Tax Groups-Advanced Tax.

List item tax groups

get/objects/tax/item-tax-group

Returns a collection with a key, ID, and link for each item tax group. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Auto Item Tax",
      • "href": "/objects/tax/item-tax-group/1"
      },
    • {
      • "key": "2",
      • "id": "Electronic Item Tax",
      • "href": "/objects/tax/item-tax-group/2"
      },
    • {
      • "key": "3",
      • "id": "Gardening Item Tax",
      • "href": "/objects/tax/item-tax-group/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an item tax group
post/objects/tax/item-tax-group
Creates a new item tax group.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique identifier of the item tax group.


 
 Example:  "Acme Company Customers"
name
string
Unique identifier for the item tax group. This field is the same as id for this object.


 
 Example:  "Acme Company Customers"
object
Tax solution associated with this item tax group. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. See Tax solutions for details.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "23"
id
string
ID for the tax solution.


 
 Example:  "Australia - GST"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Auto Item Tax",
  • "taxSolution": {
    • "id": "1"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Auto Item Tax",
    • "href": "/objects/tax/item-tax-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an item tax group
get/objects/tax/item-tax-group/{key}
Returns detailed information for a specified item tax group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item tax group.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Auto Item Tax",
    • "isVATEnabled": true,
    • "href": "/objects/tax/item-tax-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an item tax group
patch/objects/tax/item-tax-group/{key}
Updates an existing item tax group by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item tax group.


 
 Example:  99
Request Body schema: application/json
name
string
Unique identifier for the item tax group. This field is the same as id for this object.


 
 Example:  "Acme Company Customers"
object
Tax solution associated with this item tax group. Different tax solutions are available for different countries, for example, Australia GST, South Africa VAT, UK Vat. See Tax solutions for details.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "23"
id
string
ID for the tax solution.


 
 Example:  "Australia - GST"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "taxSolution": {
    • "id": "1"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Auto Item Tax",
    • "href": "/objects/tax/item-tax-group/1"
    },
  • "ia-meta": {
    • "totalCount": 1
    }
}
Delete an item tax group
delete/objects/tax/item-tax-group/{key}
Deletes an item tax group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item tax group.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}