Contact tax groups

Contact tax groups enable taxes to be applied to customers, vendors, and their contacts, according to their jurisdictions. Applicable only with Advanced Tax, for more information see Contact Tax Groups-Advanced Tax.

List contact tax groups

get/objects/tax/contact-tax-group

Returns a collection with a key, ID, and link for each contact 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 Contact Tax",
      • "href": "/objects/tax/contact-tax-group/1"
      },
    • {
      • "key": "2",
      • "id": "Electronic Contact Tax",
      • "href": "/objects/tax/contact-tax-group/2"
      },
    • {
      • "key": "3",
      • "id": "Gardening Contact Tax",
      • "href": "/objects/tax/contact-tax-group/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a contact tax group
post/objects/tax/contact-tax-group
Creates a new contact tax group.


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


 
 Example:  "Australian Export Customers"
name
string
Unique identifier for the contact tax group. This field is the same as id for this object.


 
 Example:  "Australian Export Customers"
object
Tax solution associated with this contact 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
Unique ID for the tax solution.


 
 Example:  "Australia - GST"
Responses 
201
Created


400
Bad Request


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


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "126",
    • "id": "Australian Export Customers",
    • "isVATEnabled": true,
    • "href": "/objects/tax/contact-tax-group/126"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a contact tax group
patch/objects/tax/contact-tax-group/{key}
Updates an existing contact 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 contact tax group.


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


 
 Example:  "Australian Export Customers"
object
Tax solution associated with this contact 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
Unique 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 Contact Tax",
    • "href": "/objects/tax/contact-tax-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a contact tax group
delete/objects/tax/contact-tax-group/{key}
Deletes a contact tax group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the contact 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
    }
}