`matching.candidates`

List what an entry could be matched with, best first. For a receipt: unmatched bank or card lines in the same direction across available history, ranked by amount (including a charge in another currency that names the receipt amount), vendor name, what people matched before, and how usual the date gap is. For a bank entry: unlinked receipts with the same amount across available history. Each candidate has its amount, date, a name and why it was suggested. Confirm with accounting_match_transaction or accounting_attach_receipt.

GETPOST/api/v1/accounting/matching.candidates

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_matching_candidates

Fields

entryIdstring (ID)Required
The ID of an accounting entry, from entries.list or attention.mine.
limitinteger
How many results to return at most.
1 to 20 · Default 10

curl -G https://app.getoatmilk.com/api/v1/accounting/matching.candidates \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'entryId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/matching.candidates?entryId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10", {
  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/matching.candidates",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    },
    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/matching.candidates

curl -G https://app.getoatmilk.com/api/v1/accounting/matching.candidates \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'entryId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/matching.candidates?entryId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10", {
  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/matching.candidates",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "entryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    },
    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