`company.recordChanges`

Read what a kept company record (documentId of a company_document: articles, a certificate, an Ownr or registry package, an annual return) says about the company compared with the company profile: describesCompany (true when its name or corporation or business number matches, null when the profile has none yet) and changes, each { key, label, current, value, kind }: fill for an empty profile field, conflict for a different value. Oatmilk never saves them on its own: an admin chooses which to use (company.applyRecord, or company.facts.review and company.facts.apply for every record at once).

GETPOST/api/v1/accounting/company.recordChanges

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_company_record_changes

Fields

documentIdstring (ID)Required
The ID of the related record.

curl -G https://app.getoatmilk.com/api/v1/accounting/company.recordChanges \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/company.recordChanges?documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/company.recordChanges",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    },
    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

GET/api/v1/accounting/company.recordChanges

curl -G https://app.getoatmilk.com/api/v1/accounting/company.recordChanges \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/company.recordChanges?documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/company.recordChanges",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    },
    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