AccountingIntegrations
Defined in: src/accounting/client.gen.ts:8
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AccountingIntegrations(
_core):AccountingIntegrations
Defined in: src/accounting/client.gen.ts:9
Parameters
Section titled “Parameters”Returns
Section titled “Returns”AccountingIntegrations
Methods
Section titled “Methods”create()
Section titled “create()”create(
body,options?):Promise<{created_at:string;integration_id:string;status:"ACTIVE"|"DISABLED";vendor:string;vendor_account_id:string; }>
Defined in: src/accounting/client.gen.ts:25
Create accounting integration
Create a new accounting integration. The behavior depends on the existing active integration:
- If no active integration exists: Creates and returns new integration
- If active integration exists with same vendor and vendor_account_id: Returns the existing active integration
- If active integration exists with same vendor but different vendor_account_id: Returns 409 error
- If active integration exists with different vendor: Returns 409 error
This ensures only one active integration exists per account.
POST /v3/accounting/integration — requires OAuth scope: accounting.integration.write
Parameters
Section titled “Parameters”vendor
Section titled “vendor”string
Description
The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field.
Example
ERP_Avendor_account_id
Section titled “vendor_account_id”string
Description
The vendor account ID to tie this integration to
Example
vendor_account_idoptions?
Section titled “options?”Returns
Section titled “Returns”Promise<{ created_at: string; integration_id: string; status: "ACTIVE" | "DISABLED"; vendor: string; vendor_account_id: string; }>
disconnect()
Section titled “disconnect()”disconnect(
integrationId,options?):Promise<{created_at:string;integration_id:string;status:"ACTIVE"|"DISABLED";vendor:string;vendor_account_id:string; }>
Defined in: src/accounting/client.gen.ts:49
Disconnect accounting integration
Disconnect an active accounting integration.
- If integration is ACTIVE: Disconnects and returns success
- If integration ID doesn’t exist: Returns 404 error
- If integration is not currently active: Returns 409 error
POST /v3/accounting/integration/{integration_id}/disconnect — requires OAuth scope: accounting.integration.write
Parameters
Section titled “Parameters”integrationId
Section titled “integrationId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ created_at: string; integration_id: string; status: "ACTIVE" | "DISABLED"; vendor: string; vendor_account_id: string; }>
reactivate()
Section titled “reactivate()”reactivate(
integrationId,options?):Promise<{created_at:string;integration_id:string;status:"ACTIVE"|"DISABLED";vendor:string;vendor_account_id:string; }>
Defined in: src/accounting/client.gen.ts:73
Reactivate accounting integration
Reactivate a disconnected accounting integration.
- If integration is DISABLED: Reactivates and returns success
- If integration ID doesn’t exist: Returns 404 error
- If an active integration already exists: Returns 409 error
POST /v3/accounting/integration/{integration_id}/reactivate — requires OAuth scope: accounting.integration.write
Parameters
Section titled “Parameters”integrationId
Section titled “integrationId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ created_at: string; integration_id: string; status: "ACTIVE" | "DISABLED"; vendor: string; vendor_account_id: string; }>