`company.facts.apply`

Save the details a person chose from company.facts.review into the company profile, in one change: picks ([{ documentId, key }], one record per detail, from the options shown), checked (the ids of the records whose findings the person saw, so the ones they left aren't asked about again), expectedRevision (the review's revision) and idempotencyKey. Only call it after the person confirmed the values. Each saved detail notes its record as the source. A GST/HST number, registration date or filing frequency also marks the company as registered for GST/HST; a GST/HST number has to start with the business number. A changed profile is refused with CONFLICT: read the review again. Returns the saved profile and revision, applied and checked. Run accounting_compliance_refresh afterwards to rebuild the tax deadlines from the new details.

POST/api/v1/accounting/company.facts.apply

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin

Retries

Idempotency key required, with expectedRevision

MCP

accounting_company_facts_apply

Fields

picksarray of objectsRequired
at most 60 items
checkedarray of strings (ID)
at most 50 items · Default []
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–180 characters

curl https://app.getoatmilk.com/api/v1/accounting/company.facts.apply \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "picks": [
    {
      "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "key": "legalName"
    }
  ],
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/company.facts.apply", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "picks": [
      {
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "key": "legalName"
      }
    ],
    "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/company.facts.apply",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "picks": [
            {
                "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
                "key": "legalName",
            },
        ],
        "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/company.facts.apply

curl https://app.getoatmilk.com/api/v1/accounting/company.facts.apply \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "picks": [
    {
      "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "key": "legalName"
    }
  ],
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/company.facts.apply", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "picks": [
      {
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "key": "legalName"
      }
    ],
    "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/company.facts.apply",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "picks": [
            {
                "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
                "key": "legalName",
            },
        ],
        "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 picks

Example

Try it