`invoices.actionReview`

Review an exact invoice action before confirming it. Pass action and its input fields, including the current expectedRevision. Returns complete invoice lines, taxes and currency totals, exact delivery recipients and message, dates, masked receiving methods, proposed payment or tax changes, effects and blockers. Show these records and consequences to the person. For issue, send, remind, approve, schedule, void, write-off, payment recording/removal and tax correction, MCP and Ask AI must pass the returned reviewHash with the same action/input after explicit human approval. A changed invoice, company, customer or payment source requires a fresh review. This read does not issue, send, schedule or record anything.

GETPOST/api/v1/accounting/invoices.actionReview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_invoices_action_review

Fields

actionenumRequired
invoices.issueinvoices.sendinvoices.remindinvoices.approveinvoices.scheduleinvoices.voidinvoices.markUncollectibleinvoices.recordPaymentinvoices.removePaymentinvoices.correctTax
inputmapRequired

curl https://app.getoatmilk.com/api/v1/accounting/invoices.actionReview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "invoices.issue",
  "input": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.actionReview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "action": "invoices.issue",
    "input": {}
  }),
});
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.post(
    "https://app.getoatmilk.com/api/v1/accounting/invoices.actionReview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "action": "invoices.issue",
        "input": {},
    },
    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.actionReview

curl https://app.getoatmilk.com/api/v1/accounting/invoices.actionReview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "invoices.issue",
  "input": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.actionReview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "action": "invoices.issue",
    "input": {}
  }),
});
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.post(
    "https://app.getoatmilk.com/api/v1/accounting/invoices.actionReview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "action": "invoices.issue",
        "input": {},
    },
    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