`invoices.removePayment`

Remove a recorded payment with a reason. The payment stays in history as reversed and the invoice balance and status are recalculated.

POST/api/v1/accounting/invoices.removePayment

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_invoices_remove_payment

Can't be undone

It deletes, voids, revokes or discards something. Confirm with a person first.

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
paymentIdstring (ID)Required
The ID of the related record.
reasonstringRequired
A short note saying why, kept in the record's history.
3–500 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.removePayment \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "reason": "Synthetic example from the docs"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.removePayment", {
  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,
    "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "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/invoices.removePayment",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "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/invoices.removePayment

curl https://app.getoatmilk.com/api/v1/accounting/invoices.removePayment \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "reason": "Synthetic example from the docs"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.removePayment", {
  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,
    "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    "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/invoices.removePayment",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "invoiceId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "paymentId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
        "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