Reports and tax

tax.checks.update

Record tax-preparation review evidence against the current workpaper snapshot, with revision checks. Later ledger changes invalidate completed checks.

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

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

Not offered over MCP: Accountants' corrections grant isn't offered over MCP yet: phase 1 is read and comment only.

Fields

  • 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 9007199254740991

  • 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

  • periodobjectRequired

    The period to cover.

    No other fields

  • checkenumRequired
    bank_coverageopening_balancesfinancial_statementsgifi_mappingcapital_assetsshareholder_loanspayrollcontractor_slipsgst_adjustmentsinstalmentsprior_returns
  • statusenumRequired

    Only include records with this status.

    todocompletenot_applicable
  • reasonstringRequired

    A short note saying why, kept in the record's history.

    3–2000 characters

  • snapshotHashstringRequired

    SHA-256 hash as 64 lowercase hex characters

  • evidenceIdsarray of strings (ID)

    A list of record IDs.

    at most 20 items · Default []

Example

curl https://app.getoatmilk.com/api/v1/accounting/tax.checks.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "expectedRevision": 3,
  "period": {
    "from": "2026-09-01",
    "to": "2026-09-30",
    "kind": "corporate"
  },
  "check": "bank_coverage",
  "status": "todo",
  "reason": "Synthetic example from the docs",
  "snapshotHash": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
}'
Response
{
  "data": { … }
}

Try it

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.

POST/api/v1/accounting/tax.checks.update
curl https://app.getoatmilk.com/api/v1/accounting/tax.checks.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "expectedRevision": 3,
  "period": {
    "from": "2026-09-01",
    "to": "2026-09-30",
    "kind": "corporate"
  },
  "check": "bank_coverage",
  "status": "todo",
  "reason": "Synthetic example from the docs",
  "snapshotHash": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
}'

More in Reports and tax.