Vorlagen
Alle Vorlagen auflisten
GET /api/templates
<!--?xml version="1.0" encoding="UTF-8"?--> <templates type="array" page="1" per_page="100" total="2"> <template> ... </template> <template> ... </template> </templates>
Über Parameter kann gefiltert werden:
GET /api/templates?type=INVOICE
Listet alle Rechnungsvorlagen auf. Groß- und Kleinschreibung wird ignoriert.
Folgende Parameter stehen zur Verfügung:
| Parameter | Beschreibung |
|---|---|
| type | Dokumenttyp, auf die sich die Vorlage bezieht (INVOICE, OFFER, CONFIRMATION, REMINDER, DELIVERY_NOTE, CREDIT_NOTE, LETTER). Mehrere Typbezeichnungen können per Komma getrennt werden und werden ODER-Verknüpft. |
| template_type | Typ der Vorlage (DEFINED = über den Editor konfigurierte Vorlage, UPLOADED = hochgeladene Vorlage). |
| is_default | Standardvorlage (1 = ja, 0 = nein) |
Einzelne Vorlage aufrufen
GET /api/templates/{id}
<!--?xml version="1.0" encoding="UTF-8"?-->
<template>
<id type="integer">1</id>
<created type="datetime">2007-12-13T12:12:00+01:00</created>
<type>INVOICE</type>
<template_type>UPLOADED</template_type>
<name>Meine Vorlage</name>
<format>doc</format>
<base64file>{base64-kodierte Vorlagendatei}</base64file>
<is_default>1</is_default>
</template>
Hinweis: format und base64file stehen aus Performanzgründen nur zur Verfügung, wenn die Vorlage einzeln aufgerufen wird. Zudem werden diese Attribute nur zurückgegeben, wenn es sich um eine hochgeladene Vorlage handelt.
Vorlage erstellen
POST /api/templates
| XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
| name | Bezeichnung der Vorlage | ALNUM | ||
| type | Dokumenttyp (INVOICE, OFFER, CONFIRMATION, REMINDER, DELIVERY_NOTE, CREDIT_NOTE, LETTER) | ENUM | ja | |
| format | Format (doc, docx oder rtf) | ENUM | ||
| base64file | base64-kodierte Vorlagendatei | ENUM | ||
| is_default | Gibt an, ob es sich um die Standardvorlage handelt (1 = ja, 0 = nein) | BOOL | 0 |
Hinweis: template_type wird automatisch vergeben. Wird format und base64file übermittelt, bekommt template_type den Wert UPLOADED, ansonsten ist der Wert DEFINED.
<template>
<name>Meine Vorlage</name>
<type>INVOICE</type>
<format>doc</format>
<base64file>{base64-kodierte Vorlagendatei}</base64file>
</template>
<!--?xml version="1.0" encoding="UTF-8"?-->
<template>
<id type="integer">1234</id>
<created type="datetime">2007-12-13T12:12:00+01:00</created>
<type>INVOICE</type>
<template_type>UPLOADED</template_type>
<name>Meine Vorlage</name>
<format>doc</format>
<base64file>{base64-kodierte Vorlagendatei}</base64file>
<is_default>0</is_default>
</template>
Vorlage bearbeiten
PUT /api/templates/{id}<template> <name>Spezialvorlage</name> </template>
Vorlagen löschen
DELETE /api/templates/{id}Löscht eine Vorlage.
Vorschau einer Vorlage aufrufen
GET /api/templates/{id}/thumbEs wird immer nur die erste Seite der Vorlage zurückgegeben.
Das gewünschte Bild-Format kann über den Parameter format angegeben werden.
| Parameter | Beschreibung |
|---|---|
| format | Bild-Format. Kann png, gif oder jpg sein. Standard-Format ist png. |