`tax.financialCounterparts.review`

Classify a supported CAD transfer with an explicit incoming advance, outgoing advance, incoming repayment or outgoing repayment. Uses current source/review/obligation revisions, original evidence, owner attestations, a posting preview and a retry key. Repayments allocate existing obligations and cannot overpay. Atomically saves the separate counterpart, balances and audit without duplicating imported cash or touching other companies. Legacy shareholder and share-capital purposes require dashboard confirmation.

POST/api/v1/accounting/tax.financialCounterparts.review

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

Not offered over MCP: Legacy untyped loans and share capital still require a person in Oatmilk. Explicit intercompany advances and repayments use the same authorized posting service through MCP, API and the dashboard.

Fields

entryIdstring (ID)Required
The ID of an accounting entry, from entries.list or attention.mine.
expectedEntryRevisionintegerRequired
The related record's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0
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
sourceFingerprintstringRequired
SHA-256 hash as 64 lowercase hex characters
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
purposeenumRequired
incoming_advanceoutgoing_advanceincoming_repaymentoutgoing_repaymentdue_to_otherdue_from_otherdue_to_shareholderdue_from_shareholdercommon_shares
labelstringRequired
1–100 characters
reasonstringRequired
A short note saying why, kept in the record's history.
10–500 characters
evidencearray of objectsRequired
1–20 items
expectedSupportingSourceFingerprintstring
SHA-256 hash as 64 lowercase hex characters
counterpartyIdstring (ID)
The ID of the related record.
allocationsarray of objects
at most 20 items
attestationsarray of objects
at most 20 items
instructionstring
10–2000 characters
confirmedtrueRequired

curl https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.review \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedEntryRevision": 3,
  "expectedRevision": 3,
  "sourceFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
  "purpose": "incoming_advance",
  "label": "example",
  "reason": "Synthetic example from the docs",
  "evidence": [
    {
      "kind": "bank_original",
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
    }
  ],
  "confirmed": true
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.review", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedEntryRevision": 3,
    "expectedRevision": 3,
    "sourceFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
    "purpose": "incoming_advance",
    "label": "example",
    "reason": "Synthetic example from the docs",
    "evidence": [
      {
        "kind": "bank_original",
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
      }
    ],
    "confirmed": true
  }),
});
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/tax.financialCounterparts.review",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedEntryRevision": 3,
        "expectedRevision": 3,
        "sourceFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
        "purpose": "incoming_advance",
        "label": "example",
        "reason": "Synthetic example from the docs",
        "evidence": [
            {
                "kind": "bank_original",
                "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
                "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
            },
        ],
        "confirmed": True,
    },
    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/tax.financialCounterparts.review

curl https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.review \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedEntryRevision": 3,
  "expectedRevision": 3,
  "sourceFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
  "purpose": "incoming_advance",
  "label": "example",
  "reason": "Synthetic example from the docs",
  "evidence": [
    {
      "kind": "bank_original",
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
    }
  ],
  "confirmed": true
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.review", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedEntryRevision": 3,
    "expectedRevision": 3,
    "sourceFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
    "purpose": "incoming_advance",
    "label": "example",
    "reason": "Synthetic example from the docs",
    "evidence": [
      {
        "kind": "bank_original",
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
      }
    ],
    "confirmed": true
  }),
});
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/tax.financialCounterparts.review",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedEntryRevision": 3,
        "expectedRevision": 3,
        "sourceFingerprint": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
        "purpose": "incoming_advance",
        "label": "example",
        "reason": "Synthetic example from the docs",
        "evidence": [
            {
                "kind": "bank_original",
                "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
                "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
            },
        ],
        "confirmed": True,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside evidence

Fields inside allocations

Fields inside attestations

Example

Try it