Všechny sbírky
Dokumentace REST API
Přizpůsobení aplikace
Uživatelské emailové šablony v REST API
Uživatelské emailové šablony v REST API

Tvorba a načtení uživatelských emailových šablon v REST API

Ota Rádl avatar
Autor: Ota Rádl
Aktualizováno před více než týdnem

Přes REST API (i webové rozhraní) lze vytvořit a získat mailové šablony pro posílání dokladů a Aktualizaci mezd. Tato evidence je dostupná pouze pro licenci Premium.

Chceme-li získat šablonu, použijeme standardně URL

/c/{firma}/sablona-mail/{id}.

Lze samozřejmě použít i úroveň detailu.

Pro vytvoření šablony pošleme XML/JSON na URL /c/{firma}/sablona-mail.

Chceme-li šablonu připojit k typu dokladu (zde konkrétně typ faktury vydané), na výše zmíněné URL pošleme například takovéto XML:

<?xml version="1.0"?>
<winstrom version="1.0">
  <typ-faktury-vydane>
    <kod>{kod}</kod>
    <nazev>FAV se &#x161;ablonou</nazev>
    <modul>FAV</modul>
    <radaPrijem>code:FAKTURA-STANDARD</radaPrijem>
    <typDoklK>typDokladu.faktura</typDoklK>
    <sablonaMail> {text-sablony} </sablonaMail>
    <poznam>&#x160;ablona pro faktury vydan&#xE9;</poznam>
  </typ-faktury-vydane>
</winstrom>

Příklad šablony a Freemarker proměnné

Využívá se šablonovací systém FreeMarker.

Před uložením šablony program zkontroluje, zda šablona neobsahuje nepovolené výrazy.

V šablonách je možné použít následující proměnné:

  • ${application} – Název aplikace, tedy „ABRA Flexi“

  • ${user} – Objekt uživatele, se kterým můžeme dále pracovat

  • ${company} – Nastavení firmy

  • ${uzivatelJmeno} – Vaše křestní jméno

  • ${uzivatelPrijmeni} – Vaše příjmení

  • ${titulJmenoPrijmeni} – Vaše celé jméno, včetně dosažených titulů

  • ${nazevFirmy} – Název firmy

  • ${object} – Obecný přístup na předávaný objekt

  • ${doklad} – Doklad určený k odeslání

Příklad použití těchto proměnných v šabloně

Dobrý den, zasílám Vám doklad ${doklad}, jehož interní číslo je ${doklad.kod}. Jmenuji se ${uzivatelJmeno} ${uzivatelPrijmeni}, včetně mého titulu ${titulJmenoPrijmeni}, pracuji pro ${nazevFirmy}. Mé telefonní číslo je ${user.mobil}, DIČ firmy je ${company.dic}.
Dostali jste odpověď na svou otázku?