Skip to content

Mercury: Assign a transaction to a budget

Mercury budgets.assignTransactionToBudget: arguments, response, policy and SDK examples.

← Budgets operations · Get started

Operation mercury.assigntransactiontobudget

Provider route: POST /spend/budgets/{budgetId}/assign-transaction. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["budgets"]["assignTransactionToBudget"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.budgets.assignTransactionToBudget(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.budgets.assign_transaction_to_budget(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.budgetIdstringRequired within parentID for the budget
Format: uuid
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptional
bodyModelOptionalExpand Assign a transaction to a budget — request body — body

Referenced models: Assign a transaction to a budget — 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
$nullRoot
Assign a transaction to a budget — request body — body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
allowOverspendJSONOptional
allowOverspend (anyOf 1)booleanAlternativeWhether to allow this assignment to exceed the budget. Defaults to false.
allowOverspend (anyOf 2)nullAlternative
transactionIdJSONRequired within parent
transactionId (allOf 1)stringAll variants applyID for this transaction
Format: uuid

SDK function policy ID: mercury.assigntransactiontobudget. Catalog operation: mercury:assignTransactionToBudget. 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.

No-content response statuses: [204]

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.