Alle Vorlagen auflisten
GET /api/templates
<?xml version="1.0" encoding="UTF-8"?>
<templates type="array">
<template>
...
</template>
<template>
...
</template>
</templates>
Über Parameter kann gefiltert werden:
GET /api/template?type=INVOICE
Listet alle Rechnungsvorlagen auf. Groß– und Kleinschreibung wird ignoriert.
Folgende Parameter stehen zur Verfügung:
| Parameter | Beschreibung |
|---|---|
| type | Art der Vorlage (INVOICE, OFFER, CONFIRMATION, REMINDER, DELIVERY_NOTE, CREDIT_NOTE) |
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>
<name>Meine Vorlage</name>
<format>doc</format>
<base64file>{base64-kodierte Vorlagendatei}</base64file>
</template>
Vorlage erstellen
POST /api/templates
| XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
| name | Bezeichnung der Vorlage | ALNUM | ja | |
| type | Typ (INVOICE, OFFER, CONFIRMATION, REMINDER, DELIVERY_NOTE, CREDIT_NOTE) | Vorlagentyp | ja | |
| format | Format (doc, docx oder rtf) | Dateiformat | ja | |
| base64file | base64-kodierte Vorlagendatei | ja |
<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>
<name>Meine Vorlage</name>
<format>doc</format>
<base64file>{base64-kodierte Vorlagendatei}</base64file>
</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}/thumb
Es 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. |
Deutsch »
English