`contractorOps.payouts.schedule`

Authorize and schedule an approved payout to be sent on a day so it lands by payday (sendOn defaults to the last safe day), with the confirmed total and currency, expectedRevision and idempotencyKey; replaceScheduleId reschedules. The authorization is bound to the contractor, their verified payment details revision, the payout's amount, currency, hours and approval, the Wise environment, the balance it is paid from and a fee limit; any change ends it. Only an administrator in Oatmilk in a browser can authorize a payment; API keys, MCP clients and Ask AI get INTERACTIVE_ADMIN_REQUIRED with a link to do it there.

POST/api/v1/accounting/contractorOps.payouts.schedule

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin

Retries

Idempotency key required, with expectedRevision

MCP

Not offered over MCP: Authorizes money to move on a day without anyone pressing Send, so an administrator does it in Oatmilk in a browser; an agent reads where pay stands and hands over the payout's link.

Reaches outside Oatmilk

It emails people or calls another service.

Fields

idstring (ID)Required
The record's ID.
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
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
confirmTotalMinorstringRequired
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
Matches ^\d{1,15}$
confirmCurrencystringRequired
Three-letter currency code, such as CAD
sendOnstring (date)
A date, as YYYY-MM-DD.
replaceScheduleIdstring (ID)
The ID of the related record.
notestring
A short note, kept with the record.
at most 500 characters

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.payouts.schedule \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "expectedRevision": 3,
  "confirmTotalMinor": "1250",
  "confirmCurrency": "CAD"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.payouts.schedule", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "expectedRevision": 3,
    "confirmTotalMinor": "1250",
    "confirmCurrency": "CAD"
  }),
});
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/contractorOps.payouts.schedule",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedRevision": 3,
        "confirmTotalMinor": "1250",
        "confirmCurrency": "CAD",
    },
    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/contractorOps.payouts.schedule

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.payouts.schedule \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "expectedRevision": 3,
  "confirmTotalMinor": "1250",
  "confirmCurrency": "CAD"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.payouts.schedule", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "expectedRevision": 3,
    "confirmTotalMinor": "1250",
    "confirmCurrency": "CAD"
  }),
});
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/contractorOps.payouts.schedule",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedRevision": 3,
        "confirmTotalMinor": "1250",
        "confirmCurrency": "CAD",
    },
    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