`tax.statements.overview`

Read every bank, card and payment account's statement bundle for a period { period }: opening and closing balance as of the period end, transaction counts and totals, the original statement files kept, and a plain-words completeness check per account (no statements, a late start, an early end, a missing month, or balances that don't agree with the imported lines). Read-only.

GETPOST/api/v1/accounting/tax.statements.overview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_tax_statements_overview

Fields

periodobjectRequired
The period to cover.
No other fields

curl https://app.getoatmilk.com/api/v1/accounting/tax.statements.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "period": {
    "from": "2026-09-01",
    "to": "2026-09-30",
    "kind": "corporate"
  }
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.statements.overview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "period": {
      "from": "2026-09-01",
      "to": "2026-09-30",
      "kind": "corporate"
    }
  }),
});
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.post(
    "https://app.getoatmilk.com/api/v1/accounting/tax.statements.overview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "period": {
            "from": "2026-09-01",
            "to": "2026-09-30",
            "kind": "corporate",
        },
    },
    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/tax.statements.overview

curl https://app.getoatmilk.com/api/v1/accounting/tax.statements.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "period": {
    "from": "2026-09-01",
    "to": "2026-09-30",
    "kind": "corporate"
  }
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.statements.overview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "period": {
      "from": "2026-09-01",
      "to": "2026-09-30",
      "kind": "corporate"
    }
  }),
});
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.post(
    "https://app.getoatmilk.com/api/v1/accounting/tax.statements.overview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "period": {
            "from": "2026-09-01",
            "to": "2026-09-30",
            "kind": "corporate",
        },
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside period

Example

Try it