Brex: Update tax group
Brex accounting.accountingUpdateTaxGroup: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation brex.accounting_updatetaxgroup
Provider route: PATCH /v3/accounting/integration/{integration_id}/tax-groups/{brex_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["accounting"]["accountingUpdateTaxGroup"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.accounting.accountingUpdateTaxGroup(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_brex import BrexIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.accounting.accounting_update_tax_group(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.brex_id | string | Required within parent | |
path.integration_id | string | Required within parent | |
headers | object | Optional | Additional keys: not allowed |
headers.Idempotency-Key | string | Optional | |
body | Model | Required within parent | Expand Update tax code — request body — body |
Referenced models: Update tax code — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get tax group — response body |
Referenced models: Get tax group — response body
Schemas
Section titled “Schemas”Get tax group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brex_id | string | Required within parent | The internal Brex ID of the tax group |
name | string | Required within parent | Human-readable name of the tax group |
subsidiaries | array | Required within parent | Per-subsidiary enablement, one entry per subsidiary with a setting for this group |
subsidiaries[] | Model | Each item | Expand Get tax code — response body — subsidiaries item |
tax_codes | array | Required within parent | The member tax codes contained in this group |
tax_codes[] | Model | Each item | Expand Get tax group — response body — tax codes item |
updated_at | string | Required within parent | The last updated timestamp of the tax group Format: date-time |
Referenced models: Get tax group — response body — tax codes item, Get tax code — response body — subsidiaries item
Update tax code — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
subsidiaries | array | Required within parent | Per-subsidiary status changes to apply |
subsidiaries[] | Model | Each item | Expand Update tax code — request body — body subsidiaries item |
Referenced models: Update tax code — request body — body subsidiaries item
Get tax group — response body — tax codes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brex_id | string | Required within parent | The internal Brex ID of the member tax code |
name | string | Required within parent | Human-readable name of the member tax code |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Tax rate as a percentage (e.g. 20 for 20%). 0 is zero-rated; null is exempt |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The last updated timestamp of the member tax code Format: date-time |
Get tax code — response body — subsidiaries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Whether the code/group is enabled for this subsidiary Known values: ENABLED, DISABLED |
subsidiary_id | string | Required within parent | The internal Brex ID of the subsidiary |
subsidiary_name | string | Required within parent | Human-readable name of the subsidiary |
Update tax code — request body — body subsidiaries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Whether the tax code is enabled for this subsidiary One of: ENABLED, DISABLED |
subsidiary_id | string | Required within parent | The subsidiary this status applies to |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.accounting_updatetaxgroup. Catalog operation: accounting:updateTaxGroup. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["accounting.integration.write"]