`tax.hst.overview`

Read the GST/HST reporting period, registration source, recorded versus reviewed tax, input tax credits, reviewed remittances, unresolved supply classifications and linked evidence. Shows dedicated reserve accounts separately from tax liability, with statement source, as-of date and carried-forward status. Optional period and accountIds must stay inside the accountant's current account/date grant; omitted input opens that grant or the latest configured ended GST/HST period. A partial view never claims company-wide completeness or a final tax liability. No tax identifiers, filing, remittance or notifications.

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

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_tax_hst_overview

Fields

periodobject
The period to cover.
No other fields
accountIdsarray of strings (ID)
A list of record IDs.
1–50 items

curl https://app.getoatmilk.com/api/v1/accounting/tax.hst.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY"

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

curl https://app.getoatmilk.com/api/v1/accounting/tax.hst.overview \
  -H "Authorization: Bearer $OATMILK_API_KEY"

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