`contractorOps.terms.hours.preview`

Preview a focused hour-limit update, preserving every other current agreement term. hours is a patch in minutes; null removes a cap. For 5 hours weekly with flexible days, use dailyMaxMinutes:null, weeklyMaxMinutes:300. mode record_existing corrects terms already agreed; send_amendment changes the agreement through signatures. Returns current and proposed terms, guidance, basisTermsId, expectedBasisRevision, basisDate, effectiveFrom, blockers and next action. Weekly caps run Monday–Sunday, never pool across pay periods. No records change.

GETPOST/api/v1/accounting/contractorOps.terms.hours.preview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_terms_hours_preview

Fields

contractorIdstring (ID)Required
The ID of a contractor, from contractors.list.
hoursobjectRequired
No other fields
effectiveFromstring (date)
modeenumRequired
record_existingsend_amendment
companySignerobject
No other fields

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.hours.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "hours": {
    "dailyMaxMinutes": 90
  },
  "mode": "record_existing"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.hours.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "hours": {
      "dailyMaxMinutes": 90
    },
    "mode": "record_existing"
  }),
});
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/contractorOps.terms.hours.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "hours": {
            "dailyMaxMinutes": 90,
        },
        "mode": "record_existing",
    },
    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.terms.hours.preview

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.hours.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "hours": {
    "dailyMaxMinutes": 90
  },
  "mode": "record_existing"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.hours.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "hours": {
      "dailyMaxMinutes": 90
    },
    "mode": "record_existing"
  }),
});
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/contractorOps.terms.hours.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "hours": {
            "dailyMaxMinutes": 90,
        },
        "mode": "record_existing",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside hours

Fields inside companySigner

Example

Try it