Alle Kollektionen
REST-API-Dokumentation
Anpassen der App
Benutzer-E-Mail-Vorlagen in der REST-API
Benutzer-E-Mail-Vorlagen in der REST-API

Erstellen und Laden von Benutzer-E-Mail-Vorlagen in der REST-API

Ota Rádl avatar
Verfasst von Ota Rádl
Vor über einer Woche aktualisiert

Über die REST-API (und die Weboberfläche) können Sie Mailvorlagen für den Versand von Dokumenten und Payroll Update erstellen und abrufen. Diese Datensätze sind nur für die Premium-Lizenz verfügbar.

Um eine Vorlage abzurufen, verwenden wir die Standard-URL

/c/{Unternehmen}/template-mail/{id}.

Natürlich kann auch der Detaillierungsgrad verwendet werden.

Um eine Vorlage zu erstellen, senden wir XML/JSON an die URL /c/{firma}/stemplate-mail.

Wenn wir die Vorlage an einen Dokumententyp (hier speziell den Typ "Rechnung ausgestellt") anhängen wollen, senden wir XML wie dieses an die obige URL:

<?xml version="1.0"?>

Beispielvorlage und Freemarker-Variablen

Es wird das FreeMarker-Vorlagensystem verwendet.

Vor dem Speichern der Vorlage prüft das Programm die Vorlage auf unzulässige Ausdrücke.

Die folgenden Variablen können in Vorlagen verwendet werden:

  • ${application} - Anwendungsname, z. B. "ABRA Flexi"

  • ${user} - Benutzerobjekt, mit dem wir weiter arbeiten können

  • ${Firma} - Firmeneinstellungen

  • ${Benutzername} - Ihr Vorname

  • ${userFirstName} - Ihr Nachname

  • ${titleFirstNameFirstName} - Ihr vollständiger Name, einschließlich erworbener Abschlüsse

  • ${Firmenname} - Firmenname

  • ${object} - Allgemeiner Zugriff auf das übergebene Objekt

  • ${document} - Zu sendendes Dokument

Beispiel für die Verwendung dieser Variablen in einer Vorlage

Hallo, ich sende Ihnen ein Dokument ${Dokument}, dessen interne Nummer ${Dokument.code} ist. Mein Name ist ${BenutzerVorname} ${BenutzerVorname}, einschließlich meines Titels ${TitelVorname}, ich arbeite für ${FirmaVorname}. Meine Telefonnummer ist ${Benutzer.mobil}, meine Firmensteuer-ID ist ${Firma.dic}.
Hat dies Ihre Frage beantwortet?