`invoices.recordPayment`

Record a full or partial payment on an issued invoice with amountMinor in the invoice currency, paid date, method, reference, and an optional bank transaction. Optionally write off a small remaining balance such as wire fees. Updates the balance and paid status.

POST/api/v1/accounting/invoices.recordPayment

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_invoices_record_payment

Fields

invoiceIdstring (ID)Required
The ID of the related record.
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.
at most 9007199254740991 · greater than 0
amountMinorstringRequired
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
Matches ^\d{1,18}$
paidOnstringRequired
methodenum
bank_transferwireinteraccardchequecashpay_linkother
Default "bank_transfer"
referencestring
at most 300 characters
notestring
A short note, kept with the record.
at most 1000 characters
transactionIdstring (ID)
The ID of a bank or card transaction, from transactions.list.
writeOffRemainderboolean
Default false
writeOffReasonstring
at most 300 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/invoices.recordPayment \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "amountMinor": "1250",
  "paidOn": "2026-09-30"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.recordPayment", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "expectedRevision": 3,
    "amountMinor": "1250",
    "paidOn": "2026-09-30"
  }),
});
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/invoices.recordPayment",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "amountMinor": "1250",
        "paidOn": "2026-09-30",
    },
    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/invoices.recordPayment

curl https://app.getoatmilk.com/api/v1/accounting/invoices.recordPayment \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "amountMinor": "1250",
  "paidOn": "2026-09-30"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.recordPayment", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "expectedRevision": 3,
    "amountMinor": "1250",
    "paidOn": "2026-09-30"
  }),
});
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/invoices.recordPayment",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "amountMinor": "1250",
        "paidOn": "2026-09-30",
    },
    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