`reconciliation.refund.preview`

Review one CAD bank credit split between a reversal of an exact original transfer and its fee. Supply the original entry IDs, exact amounts and current revisions, plus creditEntryId/revision if a bank-only record already uses the credit. Returns preserved bank evidence, source fingerprint, and before/after postings. No money moves.

GETPOST/api/v1/accounting/reconciliation.refund.preview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_reconciliation_refund_preview

Fields

transactionIdstring (ID)Required
The ID of a bank or card transaction, from transactions.list.
expectedTransactionRevisionintegerRequired
The bank transaction's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0
transferEntryIdstring (ID)Required
The ID of the related record.
expectedTransferRevisionintegerRequired
The related record's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0
feeEntryIdstring (ID)Required
The ID of the related record.
expectedFeeRevisionintegerRequired
The related record's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0
transferAmountMinorstringRequired
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
Matches ^[1-9]\d{0,18}$
feeAmountMinorstringRequired
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
Matches ^[1-9]\d{0,18}$
creditEntryIdstring (ID)
The ID of the related record.
expectedCreditRevisioninteger
The related record's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0

curl -G https://app.getoatmilk.com/api/v1/accounting/reconciliation.refund.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'transactionId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10' \
  --data-urlencode 'expectedTransactionRevision=3' \
  --data-urlencode 'transferEntryId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
  --data-urlencode 'expectedTransferRevision=3' \
  --data-urlencode 'feeEntryId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d' \
  --data-urlencode 'expectedFeeRevision=3' \
  --data-urlencode 'transferAmountMinor=1' \
  --data-urlencode 'feeAmountMinor=1'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/reconciliation.refund.preview?transactionId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10&expectedTransactionRevision=3&transferEntryId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d&expectedTransferRevision=3&feeEntryId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d&expectedFeeRevision=3&transferAmountMinor=1&feeAmountMinor=1", {
  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/reconciliation.refund.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedTransactionRevision": "3",
        "transferEntryId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "expectedTransferRevision": "3",
        "feeEntryId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedFeeRevision": "3",
        "transferAmountMinor": "1",
        "feeAmountMinor": "1",
    },
    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/reconciliation.refund.preview

curl -G https://app.getoatmilk.com/api/v1/accounting/reconciliation.refund.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'transactionId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10' \
  --data-urlencode 'expectedTransactionRevision=3' \
  --data-urlencode 'transferEntryId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
  --data-urlencode 'expectedTransferRevision=3' \
  --data-urlencode 'feeEntryId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d' \
  --data-urlencode 'expectedFeeRevision=3' \
  --data-urlencode 'transferAmountMinor=1' \
  --data-urlencode 'feeAmountMinor=1'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/reconciliation.refund.preview?transactionId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10&expectedTransactionRevision=3&transferEntryId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d&expectedTransferRevision=3&feeEntryId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d&expectedFeeRevision=3&transferAmountMinor=1&feeAmountMinor=1", {
  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/reconciliation.refund.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedTransactionRevision": "3",
        "transferEntryId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "expectedTransferRevision": "3",
        "feeEntryId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedFeeRevision": "3",
        "transferAmountMinor": "1",
        "feeAmountMinor": "1",
    },
    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