`documents.suggestions.list`

List suggested changes to an agreement template (open ones by default, or all with status all). Each open suggestion includes a preview of what accepting it would do to the template as it is now: the blocks before and after and a line per change, or why it no longer applies.

GETPOST/api/v1/accounting/documents.suggestions.list

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_documents_suggestions_list

Fields

documentType"agreement_template"Required
documentIdstring (ID)Required
The ID of the related record.
statusenum
Only include records with this status.
openall
Default "open"
limitinteger
How many results to return at most.
1 to 100 · Default 50

curl -G https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.list \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'documentType=agreement_template' \
  --data-urlencode 'documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.list?documentType=agreement_template&documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", {
  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/documents.suggestions.list",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "documentType": "agreement_template",
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    },
    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/documents.suggestions.list

curl -G https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.list \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'documentType=agreement_template' \
  --data-urlencode 'documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.suggestions.list?documentType=agreement_template&documentId=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", {
  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/documents.suggestions.list",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "documentType": "agreement_template",
        "documentId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    },
    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