`tax.readiness`

Read draft corporate or GST/HST tax workpapers, reviewed totals, unresolved records and preparation tasks. This does not file a return or calculate final T2 liability.

GETPOST/api/v1/accounting/tax.readiness

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_tax_readiness

Fields

fromstringRequired
The first date to include, as YYYY-MM-DD.
tostringRequired
The last date to include, as YYYY-MM-DD.
kindenumRequired
Which kind of record or job this is.
corporategst_hst

curl -G https://app.getoatmilk.com/api/v1/accounting/tax.readiness \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'from=2026-09-01' \
  --data-urlencode 'to=2026-09-30' \
  --data-urlencode 'kind=corporate'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.readiness?from=2026-09-01&to=2026-09-30&kind=corporate", {
  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/tax.readiness",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "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

GET/api/v1/accounting/tax.readiness

curl -G https://app.getoatmilk.com/api/v1/accounting/tax.readiness \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'from=2026-09-01' \
  --data-urlencode 'to=2026-09-30' \
  --data-urlencode 'kind=corporate'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.readiness?from=2026-09-01&to=2026-09-30&kind=corporate", {
  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/tax.readiness",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "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

Example

Try it