Dokumentation

Erste Schritte

Platzhalter ausfüllen

Lesen Sie zuerst die Vorlage: Platzhalter und Gruppen am Vorlagen-Endpunkt sind der gesamte Vertrag für values. Senden Sie values dann als Objekt, das nach Platzhalter-Schlüssel indiziert ist.

  • Schlüssel sind die Schlüssel der Platzhalter genau wie zurückgegeben, nie der Wortlaut ihrer Bezeichnungen und nie der aktuell eingetragene Text (eine Bezeichnung wird weiterhin akzeptiert, für Aufrufer, die vor den Schlüsseln geschrieben wurden). Ein Platzhalter, der an mehreren Stellen des Dokuments vorkommt, wird überall zugleich gefüllt.
  • Ausgelassene Schlüssel behalten die Standardwerte der Vorlage. Eine leere Zeichenkette leert einen Platzhalter.
  • Ein Auswahl-Platzhalter akzeptiert genau eine seiner Optionen oder eine leere Zeichenkette.
  • Ein Zahlen-Platzhalter akzeptiert eine numerische Zeichenkette wie 1234.56 in beiden Dezimalkonventionen; der Server schreibt sie in das von der Vorlage deklarierte Format um, sodass aus 1234.56 dort 1,234.56 wird, wo das Format es vorsieht.
  • Ein Datums-Platzhalter wird nicht umgeschrieben: Senden Sie das Datum bereits so geschrieben, wie sein Format es zeigt. Das Format ist das Referenzdatum 27. August 2026 in der erwarteten Schreibweise; ein Format 08/27/2026 erwartet also 10/15/2026.
  • Als auto markierte Platzhalter füllt PaperClerk bei der Erzeugung (das heutige Datum oder die nächste automatische Nummer); alles, was Sie dafür senden, wird ignoriert.
  • Eine wiederholbare Gruppe nimmt ein Array von Instanzobjekten, die nach den Feldschlüsseln der Gruppe indiziert sind; die Zeile der Vorlage wird pro Eintrag einmal geklont. Eine ausgelassene Gruppe behält die einzelne verfasste Zeile; ein leeres Array entfernt den Abschnitt. Feldwerte werden genau wie Platzhalter auf oberster Ebene geprüft.
  • Trägt ein Platzhalter eine description, ist das ein Hilfetext des Vorlagenautors zum erwarteten Wert, etwa zum gewünschten Format oder Inhalt. Er wird nicht im Dokument gedruckt.

Ein values-Objekt für eine Rechnungsvorlage

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" }
  ]
}