Account label tax groups

Account label tax groups organize account labels under one tax category. Along with tax schedule maps, they associate tax schedules with one or more combinations of contact tax groups and account label tax groups.

Applicable when using Advanced Tax with the Accounts Receivable application without the Taxes application. For more information see Item Tax Groups-Advanced Tax.

List account label tax groups

get/objects/tax/account-label-tax-group

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


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


 
 Example:  "Acme Company Customers"
name
string
Name or other unique identifier for the account label tax group.


 
 Example:  "Acme Company Customers"
object
Tax solution associated with the account label tax group.


 
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 Account Label Tax",
  • "taxSolution": {
    • "id": "1"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Auto Account Label Tax",
    • "href": "/objects/tax/account-label-tax-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an account label tax group
get/objects/tax/account-label-tax-group/{key}
Returns detailed information for a specified account label tax group.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Auto Account Label Tax",
    • "href": "/objects/tax/account-label-tax-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an account label tax group
patch/objects/tax/account-label-tax-group/{key}
Updates an existing account label 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 account label tax group.


 
 Example:  99
Request Body schema: application/json
name
string
Name or other unique identifier for the account label tax group.


 
 Example:  "Acme Company Customers"
object
Tax solution associated with the account label tax group.


 
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 Account Label Tax",
    • "href": "/objects/tax/account-label-tax-group/1"
    },
  • "ia-meta": {
    • "totalCount": 1
    }
}
Delete an account label tax group
delete/objects/tax/account-label-tax-group/{key}
Deletes an account label tax group.


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