`contractorOps.terms.propose`

Send new agreement terms for signature, with contractorId, terms, effectiveFrom, optional jobRoleId, send, an optional company signer (an administrator or finance member who signs in Oatmilk) and idempotencyKey. A titled first agreement must link to a matching active job role; a unique match is resolved when jobRoleId is omitted. With no agreement in effect it sends the full contractor agreement; otherwise a one-page amendment listing changes to pay, hours or other terms. Use contractorOps.titleChange.propose to change a current title. The terms take effect once everyone has signed. Only one update can wait at a time. A blank rate keeps the rate already agreed, and basisTermsId (the version in effect when you read it, or null for none) refuses the change when someone else changed the agreement since.

POST/api/v1/accounting/contractorOps.terms.propose

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required

MCP

accounting_contractor_ops_terms_propose

Fields

contractorIdstring (ID)Required
The ID of a contractor, from contractors.list.
termsanyRequired
effectiveFromstring (date)Required
jobRoleIdstring (ID)
The ID of the related record.
notestring
A short note, kept with the record.
at most 2000 characters
basisTermsIdstring (ID) or null
sendboolean
Default true
companySignerobject or null
messagestring or null
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

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.propose \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "terms": null,
  "effectiveFrom": "2026-09-01"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.propose", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "terms": null,
    "effectiveFrom": "2026-09-01"
  }),
});
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.terms.propose",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "terms": None,
        "effectiveFrom": "2026-09-01",
    },
    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.propose

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.propose \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "terms": null,
  "effectiveFrom": "2026-09-01"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.terms.propose", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "terms": null,
    "effectiveFrom": "2026-09-01"
  }),
});
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.terms.propose",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "terms": None,
        "effectiveFrom": "2026-09-01",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside companySigner

Example

Try it