Brex: Create accounting integration
Brex accounting.accountingCreateIntegration: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation brex.accounting_createintegration
Provider route: POST /v3/accounting/integration. 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"]["accountingCreateIntegration"]>[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.accountingCreateIntegration(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_create_integration(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Idempotency-Key | string | Optional | |
body | Model | Required within parent | Expand Create accounting integration — request body — body |
Referenced models: Create accounting integration — 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 accounting integration — response body |
Referenced models: Get accounting integration — response body
Schemas
Section titled “Schemas”Get accounting integration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when the integration was created Format: date-time |
integration_id | string | Required within parent | Unique identifier for the integration |
status | string | Required within parent | Current status of the integration Known values: ACTIVE, DISABLED |
vendor | string | Required within parent | The accounting vendor/system Known values: CAMPFIRE, DUALENTRY, HANOVER_PARK, INKLE, RILLET |
vendor_account_id | string | Required within parent | The vendor account ID this integration is tied to |
Create accounting integration — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amortization | boolean | Optional | When true, provisions the amortization fields (amortization template, template start/end dates, and amortize toggle) and enables the AMORTIZATION capability for the integration. Returns 403 when amortization is not available to the account. The ERP opts into amortization by having these fields provisioned, so this works for any accounting integration created through this endpoint. Omitting the field, or passing false, leaves the integration unchanged — the same provisioning also happens on the first POST /accounting/integration/{integration_id}/amortization, so this field only decides whether it happens up front. |
vendor | string | Required within parent | The accounting vendor/system One of: CAMPFIRE, DUALENTRY, HANOVER_PARK, INKLE, RILLET |
vendor_account_id | string | Required within parent | The vendor account ID to tie this integration to |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.accounting_createintegration. Catalog operation: accounting:createIntegration. 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"]