`documents.suggestions.create`

Suggest changes to an agreement template for a person to review instead of making them: the same operations as documents.content.edit, with a one-line summary of what they do and why, and an idempotencyKey. Nothing changes until a person accepts it in the agreement writer; they can reject it instead. The operations must apply to the template as it is now. Use this when the person asks for suggestions or reviews changes first.

POST/api/v1/accounting/documents.suggestions.create

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required

MCP

accounting_documents_suggestions_create

Fields

documentType"agreement_template"Required
documentIdstring (ID)Required
The ID of the related record.
summarystringRequired
1–500 characters
operationsarray of objectsRequired
1–50 items
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/documents.suggestions.create \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "documentType": "agreement_template",
  "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "summary": "Synthetic example from the docs",
  "operations": [
    {
      "type": "replace_text",
      "find": "example",
      "replace": "example"
    }
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.create", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "documentType": "agreement_template",
    "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "summary": "Synthetic example from the docs",
    "operations": [
      {
        "type": "replace_text",
        "find": "example",
        "replace": "example"
      }
    ]
  }),
});
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/documents.suggestions.create",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "documentType": "agreement_template",
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "summary": "Synthetic example from the docs",
        "operations": [
            {
                "type": "replace_text",
                "find": "example",
                "replace": "example",
            },
        ],
    },
    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/documents.suggestions.create

curl https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.create \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "documentType": "agreement_template",
  "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "summary": "Synthetic example from the docs",
  "operations": [
    {
      "type": "replace_text",
      "find": "example",
      "replace": "example"
    }
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.create", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "documentType": "agreement_template",
    "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "summary": "Synthetic example from the docs",
    "operations": [
      {
        "type": "replace_text",
        "find": "example",
        "replace": "example"
      }
    ]
  }),
});
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/documents.suggestions.create",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "documentType": "agreement_template",
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "summary": "Synthetic example from the docs",
        "operations": [
            {
                "type": "replace_text",
                "find": "example",
                "replace": "example",
            },
        ],
    },
    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