Item tax group item maps

An item tax group item map associates a tax schedule with items and item tax groups, which drive the taxes that are applied to a line item.

Applicable when using Advanced Tax without the Taxes module. For more information see Tax Schedule Maps.

List item tax group item maps

get/objects/tax/item-tax-group-item-map

Returns a collection with a key, ID, and link for each item tax group item map. 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": "8",
      • "id": "8",
      • "href": "/objects/tax/item-tax-group-item-map/8"
      },
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/tax/item-tax-group-item-map/9"
      },
    • {
      • "key": "10",
      • "id": "10",
      • "href": "/objects/tax/item-tax-group-item-map/10"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a item tax group item map
get/objects/tax/item-tax-group-item-map/{key}
Returns detailed information for a specified item tax group item map.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia-result": {
    • "id": "2",
    • "key": "2",
    • "item": {
      • "id": "1",
      • "key": "1",
      • "href": "/objects/inventory-control/item/1"
      },
    • "taxGroup": {
      • "id": "Goods Exempt Rate - CA",
      • "key": "61",
      • "href": "/objects/tax/item-tax-group/61"
      },
    • "taxSolution": {
      • "id": "Canadian Sales Tax - SYS",
      • "key": "4",
      • "href": "/objects/tax/tax-solution/4"
      },
    • "href": "/objects/tax/item-tax-group-item-map/2"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}