# 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.

`GET | POST /api/v1/accounting/tax.hst.overview`

Permissions: `accounting:read` · Roles: admin, finance

MCP tool: `accounting_tax_hst_overview`

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `period` | object |  | The period to cover. No other fields. |
| `period.from` | string | Yes | The first date to include, as YYYY-MM-DD. |
| `period.to` | string | Yes | The last date to include, as YYYY-MM-DD. |
| `period.kind` | enum | Yes | Which kind of record or job this is. One of: `corporate`, `gst_hst`. |
| `accountIds` | array of strings (ID) |  | A list of record IDs. 1–50 items. |

## Example request

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

Reference page: https://app.getoatmilk.com/docs/api/tax.hst.overview