List tax groups

Every tax group on the tenant, unpaginated — a tenant has a handful, not a page of them.

totalRate is precomputed from the lines and the calculation method, so a caller pricing a quote can use it directly rather than re-implementing the compounding rule. Reach for this to resolve a taxGroupId before writing a price list.

GET/api/v1/tax-groups

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Query parameters

fieldsstring

Comma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.

Responses

200OK

itemsTaxGroup[]required

Show properties

Array of TaxGroup

taxGroupIdstringrequired

namestringrequired

calculationMethodstringrequired

- `combined` — tax lines are summed (`0.05 + 0.07 = 0.12`). - `compounding` — each line is applied on top of the previous (`(1.05 × 1.07) - 1 = 0.1235`). Use for tax-on-tax regimes.

Allowed:combinedcompounding

taxLinesTaxLine[]required

Show properties

Array of TaxLine

labelstringrequired

ratenumber<float>required

Decimal rate. e.g. 0.2 = 20%.

totalRatenumber<float>required

Precomputed total — sum (combined) or compounded across lines.

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

fieldsqueryComma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.

Request

curl -X GET "https://app.bloomcount.com/api/v1/tax-groups" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://app.bloomcount.com/api/v1/tax-groups", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://app.bloomcount.com/api/v1/tax-groups",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "items": [
    {
      "taxGroupId": "tax_x7c4d8m2k9n1q5r6t3v8w2y4z",
      "name": "VAT 20%",
      "calculationMethod": "combined",
      "taxLines": [
        {
          "label": "VAT",
          "rate": 0.2
        }
      ],
      "totalRate": 0.2
    },
    {
      "taxGroupId": "tax_m3n8p2q7r4s9t1v6w0x5y8z2a",
      "name": "GST + QST",
      "calculationMethod": "compounding",
      "taxLines": [
        {
          "label": "GST",
          "rate": 0.05
        },
        {
          "label": "QST",
          "rate": 0.09975
        }
      ],
      "totalRate": 0.14975
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}