Brex: List amortization templates
Brex accounting.accountingListAmortizationTemplates: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation brex.accounting_listamortizationtemplates
Provider route: GET /v3/accounting/integration/{integration_id}/amortization. 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"]["accountingListAmortizationTemplates"]>[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.accountingListAmortizationTemplates(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_list_amortization_templates(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.integration_id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | |
query.include_disabled | boolean | Optional | |
query.limit | number | Optional | Default: 10 Maximum: 100 Minimum: 1 |
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 List amortization templates — response body |
Referenced models: List amortization templates — response body
Schemas
Section titled “Schemas”List amortization templates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | The items in the response |
items[] | Model | Each item | Expand Get amortization template — response body |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | The next cursor |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get amortization template — response body
Get amortization template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brex_id | string | Required within parent | The internal Brex ID of the amortization template |
is_disabled | boolean | Required within parent | Whether the template is hidden from selection on new expenses. Existing expenses keep a disabled template. |
name | string | Required within parent | Human-readable name of the template |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | The template's identifier in the ERP, if the ERP supplied one |
remote_id (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The last updated timestamp of the template Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.accounting_listamortizationtemplates. Catalog operation: accounting:listAmortizationTemplates. 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.read", "accounting.integration.write"]