Eigene Templates für Stornierungen aktualisieren

Cakedesk unterstützt jetzt mit Version 1.34.0 Stornorechnungen und Stornogutschriften.

Die integrierten Templates unterstützen diese neuen Dokumenttypen bereits. Wenn du ein eigenes Template verwendest, solltest du prüfen, ob dein Template Rechnungstitel oder Dokumenttypen fest verdrahtet.

#Zusammenfassung

So machst du dein eigenes Template bereit für Stornierungen:

1. Verwende getDocumentTitle() für den Haupttitel des Dokuments
2. Behandle document.type === 'CANCELLATION', falls du eigene Bedingungen verwendest
3. Verwende document.canceledInvoice, wenn du anzeigen möchtest, welches Dokument storniert wird

#'getDocumentTitle()' für den Titel verwenden

Vor Stornierungen haben viele Templates eine Bedingung wie diese verwendet:

<h1>
    <%= document.type === 'PROPOSAL'
        ? t('proposal')
        : document.type === 'CREDIT_NOTE'
        ? t('creditNote')
        : t('invoice') %>
</h1>

Das funktioniert für Rechnungen, Gutschriften und Angebote, würde Stornierungsbelege aber als normale Rechnungen bezeichnen.

Die empfohlene Änderung ist, stattdessen die Hilfsfunktion zu verwenden:

<h1><%= getDocumentTitle() %></h1>

getDocumentTitle() gibt den passenden Titel zurück für:

• Rechnungen
• Gutschriften
• Stornorechnungen
• Stornogutschriften
• Angebote

Für deutsche Dokumente kann die Funktion zum Beispiel "Rechnung", "Gutschrift", "Stornorechnung", "Stornogutschrift" oder "Angebot: Mein Angebotstitel" zurückgeben.

#Das stornierte Dokument anzeigen

Stornierungsbelege enthalten ein neues Objekt document.canceledInvoice. Es enthält Informationen über das Dokument, das direkt storniert wurde:

<% if (document.canceledInvoice) { %>
    <p>
        Storniert Dokument <%= document.canceledInvoice.invoiceId %>
        vom <%= formatDate(document.canceledInvoice.invoiceDate) %>.
    </p>
<% } %>

Die folgenden Felder sind verfügbar:

• document.canceledInvoice.invoiceId
• document.canceledInvoice.invoiceDate
• document.canceledInvoice.type
• document.canceledInvoice.rootType

rootType ist hilfreich, wenn eine Stornierung erneut storniert wird. Das Feld sagt dir, ob die Stornokette ursprünglich mit einer Rechnung oder mit einer Gutschrift begonnen hat.

#Summen und Beträge

Cakedesk erstellt Stornierungsbelege, indem die ursprünglichen Positions- und Rabattbeträge umgekehrt werden. Wenn dein Template Summen bereits mit getSummaryItems() rendert, musst du nichts ändern.

Wenn du Summen manuell renderst, teste dein Template mit einer Stornorechnung und achte darauf, dass negative Werte sauber dargestellt werden.

#Neue eingebaute Template-Strings

Cakedesk fügt außerdem zwei eingebaute Template-Strings für Stornierungen hinzu:

• cancellationInvoice
• cancellationCreditNote

Du musst diese Strings normalerweise nicht direkt verwenden, wenn du getDocumentTitle() nutzt. Die Hilfsfunktion verwendet sie bereits intern.

#Ältere Rechnungstemplates

Ältere reine Rechnungstemplates können weiterhin die Variable invoice verwenden. Der neue Stornotyp ist dort ebenfalls verfügbar:

<% if (invoice.type === 'CANCELLATION') { %>
    <h1><%= getDocumentTitle() %></h1>
<% } %>

Für neue Templates wird die einheitliche document-Variable empfohlen.

#Weiterführende Links

• Stornierungen
• Template-Variablen
• Hilfsfunktionen