`contractorOps.terms.get`

Read a contractor's agreement terms: the version in effect today (role, rate, pay schedule, hour limits per day, week, month or in total, dates, notice, where the work is done, notable clauses), versions starting later, an update waiting for signature or confirmation, the full history with what each version changed, how many of today's, this week's, month's and the agreement's hours are used, the agreement that ended with no decision yet and what happened since (ended), what happened to each filed agreement's terms (reads: reading, read, queued behind an update out for signature, kept as history, or failed, with the reason), and the renewal to suggest (renewal: the same terms for another stretch, from the day after the end, or from the day after it ended when they kept working, with effectiveFrom, the new dates in terms, its length, endsIn days, and due when it ends within 45 days or already has; null with no end date, when later terms are set, or while an update is waiting). Send it with contractorOps.terms.propose, changing anything first.

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

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_terms_get

Fields

contractorIdstring (ID)Required
The ID of a contractor, from contractors.list.

curl -G https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.get \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'contractorId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.get?contractorId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a", {
  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.terms.get",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    },
    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.terms.get

curl -G https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.get \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'contractorId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.get?contractorId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a", {
  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.terms.get",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    },
    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