Vorlagen & Felder

Eine Vorlage ist eine gespeicherte, wiederverwendbare Liste von Feldern, die aus einem Dokument extrahiert werden sollen – ein Feld pro Ausgabespalte. Übergeben Sie die id einer Vorlage an Starten der Batch-Verarbeitung, anstatt Ihre Felder bei jedem Aufruf erneut aufzulisten. Sie können eine Vorlage auch aus einem integrierten Preset erstellen oder Vorlagen ganz überspringen und Ad-hoc-fields direkt an process für einen einmaligen Durchlauf übergeben.

Vorlagen auflisten

Gibt Ihre gespeicherten Vorlagen zurück, jede mit ihrer vollständigen, geordneten Feldliste.

GET /api/v1/templates

Parameter

Name	Ort	Typ	Beschreibung
`limit`	Abfrage, optional	integer	1–100. Standard 50.
`page_token`	Abfrage, optional	string	Undurchsichtiger Cursor aus dem `next_page_token` einer vorherigen Antwort. Siehe Paginierung.

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
invalid_parameter — ungültiges limit oder page_token.

Vorlage erstellen

Zwei Wege, eine Vorlage in einem Endpunkt zu erstellen: von Grund auf (optional durch Klonen der Felder einer anderen Vorlage via base_template_id) oder aus einer integrierten Voreinstellung via preset_id.

POST /api/v1/templates

Parameter

Name	Ort	Typ	Beschreibung
`name`	body (JSON)	string	Erforderlich, sofern `preset_id` nicht angegeben ist (in diesem Fall wird auf den Namen der Voreinstellung zurückgegriffen, ggf. mit einem Zeitstempel-Suffix, falls bereits eine Vorlage mit diesem Namen existiert).
`preset_id`	body (JSON)	string, optional	Erstellt die Vorlage (und ihre Felder) aus einer integrierten Voreinstellung — gültige IDs siehe Voreinstellungen auflisten.
`base_template_id`	body (JSON)	integer, optional	Nur verwendet, wenn `preset_id` nicht angegeben ist — klont die Felder dieser bestehenden Vorlage in die neue.

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
missing_parameter (param: "name") — kein name und kein preset_id.
invalid_parameter (param: "name") — eine Vorlage mit diesem Namen existiert bereits (nur bei Erstellung ohne Voreinstellung).
invalid_parameter (param: "preset_id") — unbekannte Voreinstellungs-ID.
internal_error

Vorlage löschen

Löscht eine Vorlage und alle zugehörigen Felder (Kaskade – kein separater Bereinigungsaufruf nötig). Bereits mit dieser Vorlage in einem früheren process-Aufruf verarbeitete Dokumente bleiben unberührt; deren extrahierte Ergebnisse sind nicht betroffen.

DELETE /api/v1/templates/{id}

Parameter

Name	Ort	Typ	Beschreibung
`id`	Pfad	integer	Die zu löschende Vorlage.

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
template_not_found
internal_error

Voreinstellungen auflisten

Integrierte Feldlisten für gängige Dokumenttypen (Rechnungen, Quittungen, Kontoauszüge und mehr) – übergeben Sie die id einer Voreinstellung als preset_id an Vorlage erstellen, um eine funktionsfähige Vorlage zu erhalten, ohne Felder manuell auflisten zu müssen. Voreinstellungen sind statische Konfigurationen, keine Datenbankeinträge – es gibt keine Möglichkeit, eine über die API zu erstellen, zu bearbeiten oder zu löschen.

GET /api/v1/presets

Parameter

Name	Ort	Typ	Beschreibung
`category`	Abfrage, optional	string	Filter auf eine Kategorie (z. B. `"Finanzen & Buchhaltung"`). Ohne Angabe werden alle Kategorien aufgelistet.
`limit`	Abfrage, optional	integer	1–100. Standard 50.
`page_token`	Abfrage, optional	string	Undurchsichtiger Cursor aus dem `next_page_token` einer vorherigen Antwort.

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
invalid_parameter — ungültiges limit oder page_token.

Felder auflisten und erstellen

fields ist der v1-public-Name für das, was die Produkt-UI als „Match-Regeln“ bezeichnet – ein Feld pro Ausgabespalte, in der Reihenfolge, in der die Extraktion sie ausgibt. GET gibt jedes Feld der Vorlage zurück, bereits nach sort_order sortiert. POST fügt am Ende ein neues Feld hinzu.

GET POST /api/v1/templates/{id}/fields

Parameter

Name	Ort	Typ	Beschreibung
`id`	Pfad	integer	Die Vorlage, zu der diese Felder gehören.
`name`	Body (JSON), nur POST	string	Erforderlich. Muss innerhalb dieser Vorlage eindeutig sein – siehe Fehler unten.
`format_requirement`	Body (JSON), nur POST	string, optional	Freitext-Hinweis zum erwarteten Werteformat (z. B. `"YYYY-MM-DD"`, `"Zahl"`).

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
template_not_found
missing_parameter (param: "name") — nur POST.
duplicate_field_name — ein Feld mit diesem name existiert bereits in dieser Vorlage.
internal_error

Feld aktualisieren und löschen

PUT benennt ein Feld um (und ersetzt dessen format_requirement) – es handelt sich um eine vollständige Ersetzung, kein partielles Update, daher beide Werte angeben, auch wenn nur einer geändert wurde. DELETE entfernt es.

PUT DELETE /api/v1/templates/{id}/fields/{field_id}

Parameter

Name	Ort	Typ	Beschreibung
`id`	Pfad	integer	Die Vorlage, zu der dieses Feld gehört.
`field_id`	Pfad	integer	Das zu aktualisierende oder zu löschende Feld.
`name`	Body (JSON), nur PUT	string	Erforderlich. Neuer Name.
`format_requirement`	Body (JSON), nur PUT	string, optional	Neuer Format-Hinweis – weglassen setzt ihn auf einen leeren String, nicht unverändert lassen.

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required – siehe Fehlerbehandlung.
template_not_found – die Vorlage existiert nicht/gehört nicht Ihnen, oder (mit entsprechender Meldung) die field_id ist nicht in dieser Vorlage.
missing_parameter (param: "name") – nur PUT.
duplicate_field_name – nur PUT, wenn der neue Name bereits von einem anderen Feld dieser Vorlage verwendet wird.
internal_error

Felder neu anordnen

Legt die Feldreihenfolge explizit fest, die die Ausgabespaltenreihenfolge in line_items und in Excel/Word-Exporten bestimmt. IDs in der Liste, die nicht zu dieser Vorlage gehören, werden stillschweigend ignoriert, anstatt die gesamte Anfrage abzulehnen.

PATCH /api/v1/templates/{id}/fields/order

Parameter

Name	Ort	Typ	Beschreibung
`id`	Pfad	integer	Die umzuordnende Vorlage.
`field_ids`	Body (JSON)	Array von Integern	Jede Feld-ID dieser Vorlage in der gewünschten Reihenfolge. Erforderlich.

Mögliche Fehler

missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
template_not_found
invalid_parameter (param: "field_ids") — keine Liste von Integern.
internal_error