文档

快速入门

填写占位符

先读取模板:模板端点上的占位符和组就是 values 的全部约定。然后以按占位符键索引的对象形式发送 values。

  • 键是占位符的键,与返回的完全一致,绝不是其标签的措辞,也不是当前已填入的文本(为兼容键出现之前编写的调用方,标签仍被接受)。在文档中多处使用的占位符会同时全部填入。
  • 省略的键保留模板的默认值。空字符串会清空占位符。
  • select 占位符只接受其选项之一,或空字符串。
  • 数字占位符接受如 1234.56 的数字字符串,两种小数约定均可;服务器会按模板声明的格式重写,因此在格式要求处 1234.56 会变成 1,234.56。
  • 日期占位符不会被重写:请按其格式所示的写法直接发送日期。格式是以预期写法书写的参考日期 2026 年 8 月 27 日,因此格式 08/27/2026 需要 10/15/2026。
  • 标记为 auto 的占位符由 PaperClerk 在生成时填写(当天日期或下一个自动编号),你为它们发送的任何值都会被忽略。
  • 重复组接受一个按该组字段键索引的实例对象数组;模板的行会按条目逐一克隆。省略的组保留唯一的原始行;空数组会移除该部分。字段值的验证方式与顶层占位符完全相同。
  • 当占位符带有 description 时,那是模板作者关于期望值的帮助文本,例如所需的格式或内容。它不会打印到文档中。

发票模板的 values 对象示例

JSON
{
  "client_name": "Maple & Fern Ltd.",
  "payment_terms": "Net 15",
  "due_date": "10/15/2026",
  "line_items": [
    { "item": "Brand identity system", "quantity": "1", "amount": "4800" },
    { "item": "Brand guidelines document", "quantity": "1", "amount": "1200" }
  ]
}