`personalTax.shareholder.request`

Ask an explicitly selected verified company administrator to set up your individual shareholder record for a shareholder tax purpose. Requires current reviewed register and association fingerprints. Fixed server text creates a tracked task and truthful notification state. Only the actual verified-email matching register person completes setup; generic Done cannot. Notifies the chosen administrator and sends the person a verified completion notice when real setup is saved. Does not approve ownership or tax sharing.

POST/api/v1/accounting/personalTax.shareholder.request

Permissions

accounting:readaccounting:write

Who can call it

admin, finance, contributor, accountant

Retries

Idempotency key required

MCP

accounting_personal_tax_shareholder_request

Reaches outside Oatmilk

It emails people or calls another service.

Fields

organizationIdstringRequired
The company to work in, for people who belong to more than one. API keys belong to one company.
1–200 characters
assigneeUserIdstringRequired
1–200 characters
expectedRegisterRevisionintegerRequired
The related record's current revision, from the last time you read it.
0 to 1000000000
expectedAssociationFingerprintstringRequired
SHA-256 hash as 64 lowercase hex characters
periodobject
The period to cover.
No other fields
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/personalTax.shareholder.request \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "organizationId": "example",
  "assigneeUserId": "example",
  "expectedRegisterRevision": 3,
  "expectedAssociationFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "organizationId": "example",
    "assigneeUserId": "example",
    "expectedRegisterRevision": 3,
    "expectedAssociationFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
  }),
});
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/personalTax.shareholder.request",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "organizationId": "example",
        "assigneeUserId": "example",
        "expectedRegisterRevision": 3,
        "expectedAssociationFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
    },
    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/personalTax.shareholder.request

curl https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "organizationId": "example",
  "assigneeUserId": "example",
  "expectedRegisterRevision": 3,
  "expectedAssociationFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "organizationId": "example",
    "assigneeUserId": "example",
    "expectedRegisterRevision": 3,
    "expectedAssociationFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
  }),
});
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/personalTax.shareholder.request",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "organizationId": "example",
        "assigneeUserId": "example",
        "expectedRegisterRevision": 3,
        "expectedAssociationFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside period

Example

Try it