Skip to content

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.

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 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_integration(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptional
bodyModelRequired within parentExpand Create accounting integration — request body — body

Referenced models: Create accounting integration — 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 accounting integration — response body

Referenced models: Get accounting integration — response body

Get accounting integration — response body
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the integration was created
Format: date-time
integration_idstringRequired within parentUnique identifier for the integration
statusstringRequired within parentCurrent status of the integration
Known values: ACTIVE, DISABLED
vendorstringRequired within parentThe accounting vendor/system
Known values: CAMPFIRE, DUALENTRY, HANOVER_PARK, INKLE, RILLET
vendor_account_idstringRequired within parentThe vendor account ID this integration is tied to
Create accounting integration — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
amortizationbooleanOptionalWhen 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.
vendorstringRequired within parentThe accounting vendor/system
One of: CAMPFIRE, DUALENTRY, HANOVER_PARK, INKLE, RILLET
vendor_account_idstringRequired within parentThe vendor account ID to tie this integration to

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"]

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.