`tax.prep.overview`

Read the guided year-end checklist for a corporate (T2) fiscal year or a GST/HST period: steps with status, counts and the next action, progress, the periods to choose from and deadlines. Input { kind, year? | from and to?, summary?, includeWorkpaper? }; without a year it opens the newest ended period, even when it is done. summary: true leaves out the record lists (for a period's steps left). includeWorkpaper: true returns the same period's full workpaper alongside the checklist, or null when unsupported. Read-only; nothing is filed or paid.

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

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_tax_prep_overview

Fields

kindenumRequired
Which kind of record or job this is.
corporategst_hst
yearinteger
1900 to 2200
fromstring
The first date to include, as YYYY-MM-DD.
tostring
The last date to include, as YYYY-MM-DD.
latestboolean
summaryboolean
includeWorkpaperboolean
Also include workpaper.

curl -G https://app.getoatmilk.com/api/v1/accounting/tax.prep.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'kind=corporate'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.prep.overview?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.prep.overview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "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.prep.overview

curl -G https://app.getoatmilk.com/api/v1/accounting/tax.prep.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'kind=corporate'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.prep.overview?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.prep.overview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "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