`tax.financialCounterparts.preview`

Preview an explicit incoming or outgoing intercompany advance or repayment against its imported cash movement. Validates current source/review/obligation revisions, counterparties, original evidence, accounting dates, partial repayment allocations and remaining balances. No writes.

GETPOST/api/v1/accounting/tax.financialCounterparts.preview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads, with expectedRevision

MCP

accounting_tax_financial_counterparts_preview

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
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

curl https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -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"
    }
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  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"
      }
    ]
  }),
});
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.post(
    "https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    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",
            },
        ],
    },
    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.preview

curl https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -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"
    }
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  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"
      }
    ]
  }),
});
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.post(
    "https://app.getoatmilk.com/api/v1/accounting/tax.financialCounterparts.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    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",
            },
        ],
    },
    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