`signing.templates.preview`

Render a PDF preview of a template (templateId) or unsaved template text (body, fields, signerRoles) with merge values and recipients on the organization letterhead. Returns pdfBase64, the page count, and the labels of required fields that are still empty. Nothing is stored.

GETPOST/api/v1/accounting/signing.templates.preview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_signing_templates_preview

Fields

templateIdstring (ID)
The ID of the related record.
titlestring
A short title.
1–200 characters
bodystring
1–200000 characters
fieldsarray of objects
at most 100 items
signerRolesarray of objects
at most 10 items
letterheadboolean
footerstring or null
logoAssetIdstring (ID) or null
valuesmap
Default {}
recipientsarray of objects
at most 20 items
subjectTypeenum
The kind of record this is about, such as entry, invoice or mail.
contractorpartyinvoice
subjectIdstring
The ID of the record this is about.
1–200 characters
jobRoleIdstring (ID)
The ID of the related record.
jobRoleVersioninteger
1 to 100000
engagementobject
No other fields

curl -G https://app.getoatmilk.com/api/v1/accounting/signing.templates.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'templateId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/signing.templates.preview?templateId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10", {
  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/signing.templates.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "templateId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    },
    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/signing.templates.preview

curl -G https://app.getoatmilk.com/api/v1/accounting/signing.templates.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'templateId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/signing.templates.preview?templateId=7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10", {
  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/signing.templates.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "templateId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside fields

Fields inside signerRoles

Fields inside recipients

Fields inside engagement

Example

Try it