`budgets.accounts.designate`

Designate a bank account for operating cash, GST/HST, income tax, accountant fees or another reserve, optionally capping the reserved amount. The account must belong to this company. Requires its purposeRevision as expectedRevision, or zero when no designation exists. Does not move funds, change a Wise account or make a payment.

POST/api/v1/accounting/budgets.accounts.designate

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_budgets_accounts_designate

Fields

accountIdstring (ID)Required
The ID of a bank, card or payment account, from accounts.list.
expectedRevisionintegerRequired
The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again.
0 to 9007199254740991
purposeenumRequired
operatinggst_hstincome_taxaccountantother
reserveLimitMinorstring or nullRequired
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
notestringRequired
A short note, kept with the record.
at most 2000 characters
idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters

curl https://app.getoatmilk.com/api/v1/accounting/budgets.accounts.designate \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "purpose": "operating",
  "reserveLimitMinor": "1250",
  "note": "Synthetic example from the docs"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/budgets.accounts.designate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "expectedRevision": 3,
    "purpose": "operating",
    "reserveLimitMinor": "1250",
    "note": "Synthetic example from the docs"
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/budgets.accounts.designate",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "purpose": "operating",
        "reserveLimitMinor": "1250",
        "note": "Synthetic example from the docs",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/accounting/budgets.accounts.designate

curl https://app.getoatmilk.com/api/v1/accounting/budgets.accounts.designate \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "purpose": "operating",
  "reserveLimitMinor": "1250",
  "note": "Synthetic example from the docs"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/budgets.accounts.designate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "expectedRevision": 3,
    "purpose": "operating",
    "reserveLimitMinor": "1250",
    "note": "Synthetic example from the docs"
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/budgets.accounts.designate",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "purpose": "operating",
        "reserveLimitMinor": "1250",
        "note": "Synthetic example from the docs",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it