Skip to content

Brex: Create tax group

Brex accounting.accountingCreateTaxGroup: arguments, response, policy and SDK examples.

← Accounting operations · Get started

Operation brex.accounting_createtaxgroup

Provider route: POST /v3/accounting/integration/{integration_id}/tax-groups. Alter supplies the connection’s credentials and routing.

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"]["accountingCreateTaxGroup"]>[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.accountingCreateTaxGroup(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_create_tax_group(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.integration_idstringRequired within parent
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptional
bodyModelRequired within parentExpand Create tax group — request body — body

Referenced models: Create tax group — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get tax group — response body

Referenced models: Get tax group — response body

Get tax group — response body
FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the tax group
namestringRequired within parentHuman-readable name of the tax group
subsidiariesarrayRequired within parentPer-subsidiary enablement, one entry per subsidiary with a setting for this group
subsidiaries[]ModelEach itemExpand Get tax code — response body — subsidiaries item
tax_codesarrayRequired within parentThe member tax codes contained in this group
tax_codes[]ModelEach itemExpand Get tax group — response body — tax codes item
updated_atstringRequired within parentThe 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

Create tax group — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentName of the tax group. Reserved names ("Not Eligible", "Custom") are rejected
subsidiary_idsarrayRequired within parentSubsidiaries to enable this group for on creation
subsidiary_ids[]stringEach item
tax_code_idsarrayRequired within parentThe Brex IDs of the existing tax codes to include in this group
tax_code_ids[]stringEach item
Get tax group — response body — tax codes item
FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the member tax code
namestringRequired within parentHuman-readable name of the member tax code
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeTax rate as a percentage (e.g. 20 for 20%). 0 is zero-rated; null is exempt
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the member tax code
Format: date-time
Get tax code — response body — subsidiaries item
FieldTypePresenceDescription and constraints
$objectRoot
statusstringRequired within parentWhether the code/group is enabled for this subsidiary
Known values: ENABLED, DISABLED
subsidiary_idstringRequired within parentThe internal Brex ID of the subsidiary
subsidiary_namestringRequired within parentHuman-readable name of the subsidiary

SDK function policy ID: brex.accounting_createtaxgroup. Catalog operation: accounting:createTaxGroup. 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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.