`tax.filings.update`

Record progress on a return or slips the company files itself: { kind, periodKey (from tax.filings.get), expectedRevision, idempotencyKey, steps? ({ stepKey: true|false }), filedOn?, confirmation? (the CRA confirmation number), paidOn?, amountPaidMinor?, copiesSentOn?, note? }. Once filed (and paid, or the copies given), the matching compliance checklist items are marked done. It only records what the person did on the CRA's site; nothing is sent to the CRA.

POST/api/v1/accounting/tax.filings.update

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_tax_filings_update

Fields

kindenumRequired
Which kind of record or job this is.
gst_hstt4at2
periodKeystringRequired
4–21 characters
expectedRevisionintegerRequired
The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again.
0 to 1000000000
idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters
stepsmap
filedOnstring or null
confirmationstring or null
paidOnstring or null
amountPaidMinorstring or null
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
copiesSentOnstring or null
notestring
A short note, kept with the record.
at most 2000 characters

curl https://app.getoatmilk.com/api/v1/accounting/tax.filings.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "kind": "gst_hst",
  "periodKey": "example",
  "expectedRevision": 3,
  "steps": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.filings.update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "kind": "gst_hst",
    "periodKey": "example",
    "expectedRevision": 3,
    "steps": {}
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/tax.filings.update",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "kind": "gst_hst",
        "periodKey": "example",
        "expectedRevision": 3,
        "steps": {},
    },
    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.filings.update

curl https://app.getoatmilk.com/api/v1/accounting/tax.filings.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "kind": "gst_hst",
  "periodKey": "example",
  "expectedRevision": 3,
  "steps": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.filings.update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "kind": "gst_hst",
    "periodKey": "example",
    "expectedRevision": 3,
    "steps": {}
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/tax.filings.update",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "kind": "gst_hst",
        "periodKey": "example",
        "expectedRevision": 3,
        "steps": {},
    },
    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