ドキュメント

はじめに

プレースホルダーの入力

まずテンプレートを読んでください。テンプレートのエンドポイントのプレースホルダーとグループが 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" }
  ]
}