`handoff.update`

Record one handoff item with its owner, source, state, original documents and current revision. Filing acceptance requires retained confirmation. Stores no full payroll identity numbers and creates no postings.

POST/api/v1/accounting/handoff.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

fromstring (date)Required
The first date to include, as YYYY-MM-DD.
tostring (date)Required
The last date to include, as YYYY-MM-DD.
keyenumRequired
engagementprior_returnsprior_balancesworkpaperscra_incomecra_gstcra_payrollpayroll_providert2_filinggst_filingpayrollcontractor_identity
itemobjectRequired
No other 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

curl https://app.getoatmilk.com/api/v1/accounting/handoff.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "from": "2026-09-01",
  "to": "2026-09-30",
  "key": "engagement",
  "item": {
    "status": "not_started",
    "owner": "example",
    "source": "example",
    "note": "Synthetic example from the docs",
    "documentIds": [
      "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
    ],
    "confirmation": "example",
    "authorizationEndsOn": "2026-09-01",
    "calendarYear": 2026,
    "payrollChecks": [
      "employee_identity"
    ]
  },
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/handoff.update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "from": "2026-09-01",
    "to": "2026-09-30",
    "key": "engagement",
    "item": {
      "status": "not_started",
      "owner": "example",
      "source": "example",
      "note": "Synthetic example from the docs",
      "documentIds": [
        "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
      ],
      "confirmation": "example",
      "authorizationEndsOn": "2026-09-01",
      "calendarYear": 2026,
      "payrollChecks": [
        "employee_identity"
      ]
    },
    "expectedRevision": 3
  }),
});
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/handoff.update",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "from": "2026-09-01",
        "to": "2026-09-30",
        "key": "engagement",
        "item": {
            "status": "not_started",
            "owner": "example",
            "source": "example",
            "note": "Synthetic example from the docs",
            "documentIds": [
                "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
            ],
            "confirmation": "example",
            "authorizationEndsOn": "2026-09-01",
            "calendarYear": 2026,
            "payrollChecks": [
                "employee_identity",
            ],
        },
        "expectedRevision": 3,
    },
    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/handoff.update

curl https://app.getoatmilk.com/api/v1/accounting/handoff.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "from": "2026-09-01",
  "to": "2026-09-30",
  "key": "engagement",
  "item": {
    "status": "not_started",
    "owner": "example",
    "source": "example",
    "note": "Synthetic example from the docs",
    "documentIds": [
      "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
    ],
    "confirmation": "example",
    "authorizationEndsOn": "2026-09-01",
    "calendarYear": 2026,
    "payrollChecks": [
      "employee_identity"
    ]
  },
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/handoff.update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "from": "2026-09-01",
    "to": "2026-09-30",
    "key": "engagement",
    "item": {
      "status": "not_started",
      "owner": "example",
      "source": "example",
      "note": "Synthetic example from the docs",
      "documentIds": [
        "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
      ],
      "confirmation": "example",
      "authorizationEndsOn": "2026-09-01",
      "calendarYear": 2026,
      "payrollChecks": [
        "employee_identity"
      ]
    },
    "expectedRevision": 3
  }),
});
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/handoff.update",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "from": "2026-09-01",
        "to": "2026-09-30",
        "key": "engagement",
        "item": {
            "status": "not_started",
            "owner": "example",
            "source": "example",
            "note": "Synthetic example from the docs",
            "documentIds": [
                "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
            ],
            "confirmation": "example",
            "authorizationEndsOn": "2026-09-01",
            "calendarYear": 2026,
            "payrollChecks": [
                "employee_identity",
            ],
        },
        "expectedRevision": 3,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside item

Example

Try it