`budgets.scenarios.context`

Read the company's founder or staff pay scenario starting point in one currency: bank cash with freshness, recurring costs, upcoming obligations and existing corporate income-tax and GST/HST planning estimates. Returns dated sources, protected tax reserves, assumptions and missing information. Optional through is bounded to 36 months. No future income is assumed. Does not save a budget or move money.

GETPOST/api/v1/accounting/budgets.scenarios.context

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_budgets_scenarios_context

Fields

currencystringRequired
Three-letter currency code, such as CAD or USD.
throughstring (date)

curl -G https://app.getoatmilk.com/api/v1/accounting/budgets.scenarios.context \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'currency=CAD'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/budgets.scenarios.context?currency=CAD", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/budgets.scenarios.context",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "currency": "CAD",
    },
    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

GET/api/v1/accounting/budgets.scenarios.context

curl -G https://app.getoatmilk.com/api/v1/accounting/budgets.scenarios.context \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'currency=CAD'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/budgets.scenarios.context?currency=CAD", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/budgets.scenarios.context",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "currency": "CAD",
    },
    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