Accounting VAT

List tax groups

Changed on

List tax groups for the active integration. Each group includes its member tax codes and per-subsidiary enablement.

get/v3/accounting/integration/{integration_id}/tax-groups

Request

Path parameters

integration_idstring required

Query parameters

cursorstring

Cursor to start from. Omit to fetch the first page.

limitnumber

Items per page

status'ENABLED' | 'DISABLED'

Filter by enablement status

subsidiary_idstring
Example:sub_ca_inc

Only return groups that have a setting for this subsidiary

Response

Tax groups listed successfully

next_cursorstring nullable required

The next cursor

Example response

{
  "items": [
    {
      "brex_id": "tc_grp1",
      "name": "QC Combined",
      "subsidiaries": [
        {
          "status": "ENABLED",
          "subsidiary_id": "sub_uk_ltd",
          "subsidiary_name": "UK Ltd"
        }
      ],
      "tax_codes": [
        {
          "brex_id": "tc_gst",
          "name": "GST",
          "rate": 5,
          "updated_at": "2025-01-01T00:00:00Z"
        }
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Changes