`contractorOps.insights.get`

Contractor spending and timesheet insights from imported timesheets and Oatmilk pay periods and payouts: money sent (linked bank payments, payouts paid outside Wise, and bank payments recorded when past timesheets were marked paid), money still owed (unpaid imported timesheets and payouts not yet paid), paid plus owed, what the work cost by the month it was done (payouts including GST/HST) next to money sent by payment month, GST/HST, hours, monthly and weekly (Monday) series with empty ones as zero, monthly and weekly averages, each contractor's totals, cost in each of the last twelve months, hours a week over the last four weeks against the four before, on-time and late timesheets with average days late, the most and least punctual (at least three timesheets), and a few plain observations and trends. Amounts are in minor units of one currency (CAD unless currency is given); other currencies are listed.

GETPOST/api/v1/accounting/contractorOps.insights.get

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_insights_get

Fields

currencystring
Three-letter currency code, such as CAD or USD.

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.insights.get", {
  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.insights.get",
    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.insights.get

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.insights.get", {
  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.insights.get",
    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