Mẫu

Lấy một mẫu

GET/templates/{id}

Một mẫu: phiên bản đã lưu dưới dạng Markdown, với token {{Nhãn}} ở mọi chỗ trường còn trống, và danh mục trường để dựng biểu mẫu hay ánh xạ trường, mỗi mục kèm khóa để gửi và nhãn để hiển thị.

Tham số

Tên	Kiểu	Mô tả
`id`bắt buộc	uuid	Id của mẫu.

Yêu cầu

curl https://usepaperclerk.com/api/v1/templates/4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f \
  -H "Authorization: Bearer pc_YOUR_TOKEN"

Phản hồi

JSON

{
  "id": "4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f",
  "title": "Consulting invoice",
  "markdown": "# Consulting invoice\n\nInvoice {{Invoice number}} for {{Client name}} …",
  "html": "<div class=\"doc-page\" …>…</div>",
  "html_truncated": false,
  "placeholders": [
    {
      "label": "Client name",
      "key": "client_name",
      "count": 2,
      "value": "",
      "type": "text",
      "description": "The client's legal name, not the contact person."
    },
    {
      "label": "Payment terms",
      "key": "payment_terms",
      "count": 1,
      "value": "Net 30",
      "type": "select",
      "options": [
        "Net 15",
        "Net 30",
        "Due on receipt"
      ]
    },
    {
      "label": "Due date",
      "key": "due_date",
      "count": 1,
      "value": "",
      "type": "date",
      "format": "08/27/2026"
    },
    {
      "label": "Invoice number",
      "key": "invoice_number",
      "count": 1,
      "value": "",
      "type": "counter",
      "auto": true,
      "format": "INV-0001",
      "start": 1
    },
    {
      "label": "Issue date",
      "key": "issue_date",
      "count": 1,
      "value": "",
      "type": "today",
      "auto": true,
      "format": "August 27, 2026"
    }
  ],
  "groups": [
    {
      "label": "Line items",
      "key": "line_items",
      "fields": [
        {
          "label": "Item",
          "key": "item",
          "type": "text"
        },
        {
          "label": "Quantity",
          "key": "quantity",
          "type": "number",
          "format": "1,234"
        },
        {
          "label": "Amount",
          "key": "amount",
          "type": "number",
          "format": "1,234.56"
        }
      ]
    }
  ],
  "generation_count": 12,
  "updated_at": "2026-09-10T09:14:03.201Z"
}

markdown — Phiên bản đã lưu. Trường trống hiện dưới dạng {{Nhãn}}.
html — Bản xem trước HTML đúng như trên giấy của phiên bản đã lưu; html_truncated cho biết nó có bị cắt vì kích thước hay không.
placeholders — Các trường cấp cao nhất, mỗi trường một mục: key (values được đánh khóa theo đó), label (tên dễ đọc), count (số vị trí nó điền), value (giá trị mặc định), type (text, select, number, date, today hoặc counter), và khi được đặt: options, format, description, auto và start.
groups — Nhóm lặp: key, label và fields, trong đó fields liệt kê chính xác các khóa mà một đối tượng bản ghi có thể mang, mỗi khóa có cùng hình dạng như một trường cộng thêm giá trị mặc định.
generation_count — Số tài liệu đã được tạo từ mẫu này.