`reimbursements.candidates`

For one outgoing bank transfer, list each active member with their approved unpaid claims in the transfer's currency and the exact set of claims that adds up to the transfer, when there is exactly one. Read only; linking still uses reimbursements.link.

GETPOST/api/v1/accounting/reimbursements.candidates

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_reimbursements_candidates

Fields

transactionIdstring (ID)Required
The ID of a bank or card transaction, from transactions.list.

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/reimbursements.candidates?transactionId=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/reimbursements.candidates",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "transactionId": "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/reimbursements.candidates

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/reimbursements.candidates?transactionId=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/reimbursements.candidates",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "transactionId": "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