Skip to content

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.

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 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_list_amortization_templates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.integration_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.include_disabledbooleanOptional
query.limitnumberOptionalDefault: 10
Maximum: 100
Minimum: 1

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List amortization templates — response body

Referenced models: List amortization templates — response body

List amortization templates — response body
FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parentThe items in the response
items[]ModelEach itemExpand Get amortization template — response body
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe next cursor
next_cursor (anyOf 2)nullAlternative

Referenced models: Get amortization template — response body

Get amortization template — response body
FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the amortization template
is_disabledbooleanRequired within parentWhether the template is hidden from selection on new expenses. Existing expenses keep a disabled template.
namestringRequired within parentHuman-readable name of the template
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeThe template's identifier in the ERP, if the ERP supplied one
remote_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the template
Format: date-time

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

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.