`reimbursements.completePayment`

Complete an awaiting-receipts bank reimbursement only with approved original receipt purchases for the same member, currency and exact total, using current payment, bank and entry revisions.

POST/api/v1/accounting/reimbursements.completePayment

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required

MCP

accounting_reimbursements_complete_payment

Fields

paymentIdstring (ID)Required
The ID of the related record.
expectedPaymentRevisionintegerRequired
The related record's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0
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
expectedBankEntryIdstring (ID)Required
The ID of the related record.
expectedBankEntryRevisionintegerRequired
The related record's current revision, from the last time you read it.
at most 9007199254740991 · greater than 0
claimIdsarray of strings (ID)Required
A list of record IDs.
1–100 items
payeeConfirmedtrueRequired
reasonstringRequired
A short note saying why, kept in the record's history.
10–1000 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

curl https://app.getoatmilk.com/api/v1/accounting/reimbursements.completePayment \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedPaymentRevision": 3,
  "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedTransactionRevision": 3,
  "expectedBankEntryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedBankEntryRevision": 3,
  "claimIds": [
    "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
  ],
  "payeeConfirmed": true,
  "reason": "Synthetic example from the docs"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/reimbursements.completePayment", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedPaymentRevision": 3,
    "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedTransactionRevision": 3,
    "expectedBankEntryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedBankEntryRevision": 3,
    "claimIds": [
      "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
    ],
    "payeeConfirmed": true,
    "reason": "Synthetic example from the docs"
  }),
});
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/reimbursements.completePayment",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedPaymentRevision": 3,
        "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedTransactionRevision": 3,
        "expectedBankEntryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedBankEntryRevision": 3,
        "claimIds": [
            "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        ],
        "payeeConfirmed": True,
        "reason": "Synthetic example from the docs",
    },
    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/reimbursements.completePayment

curl https://app.getoatmilk.com/api/v1/accounting/reimbursements.completePayment \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedPaymentRevision": 3,
  "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedTransactionRevision": 3,
  "expectedBankEntryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "expectedBankEntryRevision": 3,
  "claimIds": [
    "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
  ],
  "payeeConfirmed": true,
  "reason": "Synthetic example from the docs"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/reimbursements.completePayment", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedPaymentRevision": 3,
    "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedTransactionRevision": 3,
    "expectedBankEntryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "expectedBankEntryRevision": 3,
    "claimIds": [
      "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
    ],
    "payeeConfirmed": true,
    "reason": "Synthetic example from the docs"
  }),
});
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/reimbursements.completePayment",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedPaymentRevision": 3,
        "transactionId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedTransactionRevision": 3,
        "expectedBankEntryId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "expectedBankEntryRevision": 3,
        "claimIds": [
            "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        ],
        "payeeConfirmed": True,
        "reason": "Synthetic example from the docs",
    },
    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