Creates an expense box on a budget (max 30 boxes per budget).
POST
/v1/create_boxBody
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| idempotencyKey | string | Yes | — | Client-generated key (1–128 chars: letters, digits, . _ : -). Same key + same body replays; different body returns 409. Prefer Idempotency-Key HTTP header when calling the Tools API. |
| budgetId | string | Yes | — | Budget that will own the new box. |
| name | string | Yes | — | Display name for the box (max 100 characters). |
| type | string | No | — | Box category such as needs, wants, or savings. |
| amount | number | No | — | Optional allocated amount for the box (0–1000000). |
| currency | string | No | — | ISO 4217 currency code; defaults to the budget baseCurrency. |
Response data
| Field | Type | Description |
|---|---|---|
| id | string | New box id. |
| budgetId | string | Id of the budget this resource belongs to. |
| name | string | Human-readable name shown in the app. |