taxGroupSummary

Requires permission products:tax:read.

Returns tax-group counts for the whole organization. Needs the tax read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query TaxGroupSummary {
  taxGroupSummary {
    activeTaxGroups
    averageGroupRate
    recentlyUpdated
    totalAssignedRates
    totalTaxGroups
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TaxGroupSummary {\n  taxGroupSummary {\n    activeTaxGroups\n    averageGroupRate\n    recentlyUpdated\n    totalAssignedRates\n    totalTaxGroups\n  }\n}"
}
EOF

Response:

{
  "data": {
    "taxGroupSummary": {
      "activeTaxGroups": 0,
      "averageGroupRate": 0,
      "recentlyUpdated": 0,
      "totalAssignedRates": 0,
      "totalTaxGroups": 0
    }
  }
}

taxGroupSummary: TaxGroupSummary!

Type

TaxGroupSummary object

Totals for the tax group list, over the whole set.