`insights.forecast.get`

Read a 12-month finance projection for one currency from reviewed ledger history, with recurring item labels, seasonal assumptions and indicative ranges. No books are changed.

GETPOST/api/v1/accounting/insights.forecast.get

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_insights_forecast_get

Fields

currencystringRequired
Three-letter currency code, such as CAD or USD.

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/insights.forecast.get?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/insights.forecast.get",
    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/insights.forecast.get

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/insights.forecast.get?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/insights.forecast.get",
    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