`company.applyRecord`

Save chosen facts of a kept company record into the company profile, replacing what is there, with documentId, fields (legalName, operatingName, businessNumber, corporationNumber, incorporationDate, jurisdiction, registration, gstHstAccount, gstHstEffectiveDate, gstHstFrequency, fiscalYearEnd, registeredOffice, directors, officers, shareholders), the profile's expectedRevision and idempotencyKey. Each saved fact notes the record as its source.

POST/api/v1/accounting/company.applyRecord

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin

Retries

Idempotency key required, with expectedRevision

MCP

accounting_company_apply_record

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
documentIdstring (ID)Required
The ID of the related record.
fieldsarray of enum valuesRequired
legalNameoperatingNamebusinessNumbercorporationNumberincorporationDatejurisdictionentityCountryformationJurisdictionlegalFormusFederalTaxClassificationregistrationgstHstAccountgstHstEffectiveDategstHstFrequencyfiscalYearEndregisteredOfficedirectorsofficersshareholders
1–19 items

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

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

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

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