Skip to content

Brex: Report accounting export results

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

← Accounting operations · Get started

Operation brex.accounting_reportaccountingexportresults

Provider route: POST /v3/accounting/records/export-results. 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"]["accountingReportAccountingExportResults"]>[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.accountingReportAccountingExportResults(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_report_accounting_export_results(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Report accounting export results — request body — body

Referenced models: Report accounting export results — 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 Report accounting export results — response body

Referenced models: Report accounting export results — response body

Report accounting export results — response body
FieldTypePresenceDescription and constraints
$objectRoot
updated_accounting_record_idsarrayRequired within parentAccounting record ids that were updated by the request
updated_accounting_record_ids[]stringEach item
Report accounting export results — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayRequired within parentArray of export results (must contain at least one result)
Minimum items: 1
results[]JSONEach item
results[] (oneOf 1)ModelAlternativeExpand Report accounting export results — request body — body results item accounting record id, success
results[] (oneOf 2)ModelAlternativeExpand Report accounting export results — request body — body results item accounting record id, failure

Referenced models: Report accounting export results — request body — body results item accounting record id, failure, Report accounting export results — request body — body results item accounting record id, success

Report accounting export results — request body — body results item accounting record id, failure
FieldTypePresenceDescription and constraints
$objectRoot
accounting_record_idstringRequired within parentID of the accounting record the export outcome applies to
failureJSONRequired within parentDetails for a failed export
failure (allOf 1)ModelAll variants applyExpand Report accounting export results — request body — body results item accounting record id, failure failure error message

Referenced models: Report accounting export results — request body — body results item accounting record id, failure failure error message

Report accounting export results — request body — body results item accounting record id, success
FieldTypePresenceDescription and constraints
$objectRoot
accounting_record_idstringRequired within parentID of the accounting record the export outcome applies to
successJSONRequired within parentDetails for a successful export
success (allOf 1)ModelAll variants applyExpand Report accounting export results — request body — body results item accounting record id, success success deep link url, reference id

Referenced models: Report accounting export results — request body — body results item accounting record id, success success deep link url, reference id

Report accounting export results — request body — body results item accounting record id, failure failure error message
FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parentHuman-readable explanation of the failure
Report accounting export results — request body — body results item accounting record id, success success deep link url, reference id
FieldTypePresenceDescription and constraints
$objectRoot
deep_link_urlstringOptionalURL pointing to the record in the external system
reference_idJSONOptional
reference_id (anyOf 1)stringAlternativeExternal system identifier assigned to the exported record
reference_id (anyOf 2)nullAlternative

SDK function policy ID: brex.accounting_reportaccountingexportresults. Catalog operation: accounting:reportAccountingExportResults. 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.record.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.