`company.shareholders.update`

Replace the shareholder register with { register: { classes, holders, holdings, officers }, expectedRevision, idempotencyKey } (from company.shareholders.get, changed). Ids are 8 to 40 lowercase letters, digits and hyphens; shares are whole numbers; every holding names a holder and class in the register. Removing a shareholder removes their saved tax number. Audited with counts only.

POST/api/v1/accounting/company.shareholders.update

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin

Retries

Idempotency key required, with expectedRevision

MCP

accounting_company_shareholders_update

Fields

registerobjectRequired
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 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–200 characters

curl https://app.getoatmilk.com/api/v1/accounting/company.shareholders.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "register": {
    "classes": [
      {
        "id": "aaaaaaaa",
        "name": "Synthetic Ventures Inc.",
        "kind": "common"
      }
    ],
    "holders": [
      {
        "id": "aaaaaaaa",
        "legalName": "Synthetic Ventures Inc."
      }
    ],
    "holdings": [
      {
        "id": "aaaaaaaa",
        "holderId": "aaaaaaaa",
        "classId": "aaaaaaaa",
        "shares": "1"
      }
    ],
    "officers": [
      {
        "id": "aaaaaaaa",
        "name": "Synthetic Ventures Inc.",
        "roles": [
          "director"
        ]
      }
    ]
  },
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/company.shareholders.update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "register": {
      "classes": [
        {
          "id": "aaaaaaaa",
          "name": "Synthetic Ventures Inc.",
          "kind": "common"
        }
      ],
      "holders": [
        {
          "id": "aaaaaaaa",
          "legalName": "Synthetic Ventures Inc."
        }
      ],
      "holdings": [
        {
          "id": "aaaaaaaa",
          "holderId": "aaaaaaaa",
          "classId": "aaaaaaaa",
          "shares": "1"
        }
      ],
      "officers": [
        {
          "id": "aaaaaaaa",
          "name": "Synthetic Ventures Inc.",
          "roles": [
            "director"
          ]
        }
      ]
    },
    "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.shareholders.update",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "register": {
            "classes": [
                {
                    "id": "aaaaaaaa",
                    "name": "Synthetic Ventures Inc.",
                    "kind": "common",
                },
            ],
            "holders": [
                {
                    "id": "aaaaaaaa",
                    "legalName": "Synthetic Ventures Inc.",
                },
            ],
            "holdings": [
                {
                    "id": "aaaaaaaa",
                    "holderId": "aaaaaaaa",
                    "classId": "aaaaaaaa",
                    "shares": "1",
                },
            ],
            "officers": [
                {
                    "id": "aaaaaaaa",
                    "name": "Synthetic Ventures Inc.",
                    "roles": [
                        "director",
                    ],
                },
            ],
        },
        "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": { … }
}

This action checks your data too, so replace the example values with your own before sending 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.

Input

POST/api/v1/accounting/company.shareholders.update

curl https://app.getoatmilk.com/api/v1/accounting/company.shareholders.update \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "register": {
    "classes": [
      {
        "id": "aaaaaaaa",
        "name": "Synthetic Ventures Inc.",
        "kind": "common"
      }
    ],
    "holders": [
      {
        "id": "aaaaaaaa",
        "legalName": "Synthetic Ventures Inc."
      }
    ],
    "holdings": [
      {
        "id": "aaaaaaaa",
        "holderId": "aaaaaaaa",
        "classId": "aaaaaaaa",
        "shares": "1"
      }
    ],
    "officers": [
      {
        "id": "aaaaaaaa",
        "name": "Synthetic Ventures Inc.",
        "roles": [
          "director"
        ]
      }
    ]
  },
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/company.shareholders.update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "register": {
      "classes": [
        {
          "id": "aaaaaaaa",
          "name": "Synthetic Ventures Inc.",
          "kind": "common"
        }
      ],
      "holders": [
        {
          "id": "aaaaaaaa",
          "legalName": "Synthetic Ventures Inc."
        }
      ],
      "holdings": [
        {
          "id": "aaaaaaaa",
          "holderId": "aaaaaaaa",
          "classId": "aaaaaaaa",
          "shares": "1"
        }
      ],
      "officers": [
        {
          "id": "aaaaaaaa",
          "name": "Synthetic Ventures Inc.",
          "roles": [
            "director"
          ]
        }
      ]
    },
    "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.shareholders.update",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "register": {
            "classes": [
                {
                    "id": "aaaaaaaa",
                    "name": "Synthetic Ventures Inc.",
                    "kind": "common",
                },
            ],
            "holders": [
                {
                    "id": "aaaaaaaa",
                    "legalName": "Synthetic Ventures Inc.",
                },
            ],
            "holdings": [
                {
                    "id": "aaaaaaaa",
                    "holderId": "aaaaaaaa",
                    "classId": "aaaaaaaa",
                    "shares": "1",
                },
            ],
            "officers": [
                {
                    "id": "aaaaaaaa",
                    "name": "Synthetic Ventures Inc.",
                    "roles": [
                        "director",
                    ],
                },
            ],
        },
        "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 register

Example

Try it