`contractorOps.pay.status`

Whether contractors will be paid the right amount on time, worked out the same way the dashboard, emails and the terminal show it. Returns tab counts and rows for a view (current, review, unpaid, scheduled, paid, issues, upcoming or all), one pay period (periodId), one payout (payoutId) or one contractor (contractorId). Each row has readiness: status (hours submitted, approved, payout prepared, approved, payment scheduled, sending, sent, paid, failed), every step, blockers with their owner (contractor, finance, an admin, Oatmilk or Wise) and next action, the planned payday, the last safe send day, the expected arrival, and whether it happens automatically. Also returns the company's payout mode and each contractor's effective mode with its reason, and capabilities: which steps the caller can take here and which only an administrator can do in Oatmilk in a browser (with the link).

GETPOST/api/v1/accounting/contractorOps.pay.status

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_pay_status

Fields

limitinteger
How many results to return at most.
1 to 100 · Default 30
offsetinteger
How many results to skip, for the next page of a list.
0 to 100000 · Default 0
contractorIdstring (ID)
The ID of a contractor, from contractors.list.
periodIdstring (ID)
The ID of a contractor pay period.
payoutIdstring (ID)
The ID of the related record.
viewenum
currentreviewunpaidscheduledpaidissuesupcomingall
Default "current"

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.pay.status \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.pay.status", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
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.get(
    "https://app.getoatmilk.com/api/v1/accounting/contractorOps.pay.status",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    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

GET/api/v1/accounting/contractorOps.pay.status

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.pay.status \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.pay.status", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
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.get(
    "https://app.getoatmilk.com/api/v1/accounting/contractorOps.pay.status",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    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