Mercury: Create a new category
Mercury categories.createCategory: arguments, response, policy and SDK examples.
← Categories operations · Get started
Operation mercury.createcategory
Provider route: POST /categories. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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["categories"]["createCategory"]>[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.categories.createCategory(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.categories.create_category(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a new category — request body — body |
Referenced models: Create a new category — request body — body
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 Edit a category — response body |
Referenced models: Edit a category — response body
Schemas
Section titled “Schemas”Edit a category — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an expense category for transaction classification. |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the category Format: uuid |
id (allOf 2) | JSON | All variants apply | The ID of the category |
name | string | Required within parent | The name of the category |
visibleForCardSpend | boolean | Required within parent | Whether this category is applicable to card transactions |
visibleForOther | boolean | Required within parent | Whether this category is applicable to all other transaction kinds |
visibleForReimbursements | boolean | Required within parent | Whether this category is applicable to expense reimbursement transactions |
Create a new category — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for creating a new expense category Additional keys: not allowed |
name | JSON | Required within parent | |
name (allOf 1) | string | All variants apply | |
name (allOf 2) | JSON | All variants apply | Name of the category |
visibleForCardSpend | boolean | Required within parent | Whether this category is applicable to card transactions |
visibleForOther | boolean | Required within parent | Whether this category is applicable to all other transaction kinds |
visibleForReimbursements | boolean | Required within parent | Whether this category is applicable to expense reimbursement transactions |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.createcategory. Catalog operation: mercury:createCategory. 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.