Vorlagen

Alle Vor­la­gen auflisten

GET /api/templates
<?xml version="1.0" encoding="UTF-8"?>
<templates type="array">
    <template>
        ...
    </template>
    <template>
        ...
    </template>
</templates>

Über Para­me­ter kann gefil­tert werden:

GET /api/template?type=INVOICE

Lis­tet alle Rech­nungs­vor­la­gen auf. Groß– und Klein­schrei­bung wird igno­riert.
Fol­gende Para­me­ter ste­hen zur Verfügung:

Para­me­ter Beschrei­bung
type Art der Vor­lage (INVOICE, OFFER, CONFIRMATION, REMINDER, DELIVERY_NOTE, CREDIT_NOTE)

Ein­zelne Vor­lage 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>

Vor­lage erstellen

POST /api/templates
XML-Element Beschrei­bung Typ Default-Wert Pflicht­feld
name Bezeich­nung der Vorlage ALNUM ja
type Typ (INVOICE, OFFER, CONFIRMATION, REMINDER, DELIVERY_NOTE, CREDIT_NOTE) Vor­la­gen­typ ja
for­mat For­mat (doc, docx oder rtf) Datei­for­mat ja
base64file base64-kodierte Vor­la­gen­da­tei 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>

Vor­lage bearbeiten

PUT /api/templates/{id}
<template>
    <name>Spezialvorlage</name>
</template>

Vor­la­gen löschen

DELETE /api/templates/{id}

Löscht eine Vorlage.


Vor­schau einer Vor­lage aufrufen

GET /api/templates/{id}/thumb

Es wird immer nur die erste Seite der Vor­lage zurück­ge­ge­ben.
Das gewünschte Bild-Format kann über den Para­me­ter for­mat ange­ge­ben werden.

Para­me­ter Beschrei­bung
for­mat Bild-Format. Kann png, gif oder jpg sein. Standard-Format ist png.