Variablen (Rechnungen)
Die folgenden Variablen sind in den template.ejs Dateien der Rechnungsvorlagen verfügbar:
#Variablen
invoice | Invoice | Die Rechnung, die gerade angezeigt wird. |
showCakedeskBranding |
boolean |
Ob das Cakedesk-Branding auf der Rechnung angezeigt werden soll. |
paymentQrCodeSvg |
string |
Der HTML-Code für das Zahlungs-QR-Code-SVG. |
#Invoice
type |
'INVOICE' | 'CREDIT_NOTE' |
Der Typ der Rechnung. |
invoiceId |
string | Die benutzerseitige Rechnungsnummer.
|
language |
string | Die Sprache der Rechnung.
|
invoiceDate |
string | Das Datum der Rechnung.
|
hasDeliveryDate |
| Enthält die Rechnung ein Lieferdatum? |
deliveryDateType |
| Die Art des Lieferdatums. |
deliveryDate |
| Das Lieferdatum der Rechnung.
|
hasVat |
boolean |
Enthält die Rechnung Mehrwertsteuer? |
hasQuantities |
boolean |
Enthält die Rechnung Mengenangaben für jeden einzelnen Artikel? |
invoiceText | RichText | Ein Textstück, das mit der Rechnung einhergeht. |
buyer | InvoiceBuyer | Der Kunde. |
seller | InvoiceSeller | Du. |
items | InvoiceItem[] | Die einzelnen Artikel, aus denen sich die Rechnung zusammensetzt. |
discounts | Discount[] | Die Rabatte, die auf diese Rechnung angewendet werden. |
taxSubtotalsV2 | TaxSubtotal[] | Ein Array von Steuer-Zwischensummen. Nur relevant, wenn Enthält im Gegensatz zu |
taxSubtotals | TaxSubtotal[] | Veraltet.
Ein Array von Steuer-Zwischensummen. Nur relevant, wenn |
totalDiscounts | MoneyValue | Der Gesamtbetrag der Rabatte, die in dieser Rechnung enthaltenen sind. |
totalTaxes | MoneyValue | Der Gesamtbetrag der Steuern, die in dieser Rechnung enthalten sind. Die Summe aller Mehrwertsteuern. |
subtotal | MoneyValue | Der Gesamtbetrag ohne Steuern. |
subtotalAfterDiscounts | MoneyValue | Der Gesamtbetrag ohne Steuern, nach Anwendung evtl. Rabatte. |
total | MoneyValue | Der Gesamtbetrag einschließlich Steuern. |
#InvoiceBuyer
id |
string | Die benutzerseitige Kundennummer.
|
name |
string | Der volle Name des Kunden.
|
vatId |
string | Die USt-ID des Kunden.
|
taxId |
string | Die Steuernummer des Kunden.
|
address | Address | Die Adresse des Kunden. |
email |
| Die E-Mail-Adresse des Kunden. |
#InvoiceSeller
name |
string | Dein Firmenname.
|
vatId |
string | Deine USt-ID
|
taxId |
string | Deine Steuernummer.
|
address | Address | Deine Adresse. |
email |
string | Deine E-Mail.
|
website |
string | Deine Webseite.
|
address | Address | Deine Adresse. |
iban |
| Deine IBAN, die du unter Einstellungen > Rechnungen eingerichtet hast. |
bic |
| Deine BIC, die du unter Einstellungen > Rechnungen eingerichtet hast. |
#Address
Um eine Adresse korrekt für das jeweilige Land zu formatieren, wird empfohlen, den joinAddress Helper zu verwenden.
address |
string | Der Adressteil der Adresse. Enthält üblicherweise Straße und Hausnummer kann aber auch andere
Informationen enthalten und mehrere Zeilen umfassen. Für Länder, deren Adressformat unbekannt ist,
wird die gesamte Adresse in diesem Feld eingegeben, getrennt durch Zeilenumbrüche ('\n').
|
zipCode |
string | Die Postleitzahl der Adresse.
|
city |
string | Die Stadt.
|
countryCode |
string | Der Ländercode.
|
#InvoiceItem
title |
string |
Der Titel des Artikels. |
description | RichText | Eine optionale Beschreibung für den Artikel. Kann ein leerer String sein. |
unitPrice | MoneyValue | Der Preis einer einzelnen Einheit dieses Artikels. Nur relevant, wenn invoice.hasQuantities true ist. |
quantity |
number |
Wie viele von diesem Artikel verkauft wurden. Nur relevant, wenn invoice.hasQuantities true ist. |
unit | Unit | null | Der Einheitstyp für diesen Artikel oder |
amount | MoneyValue | Der Gesamtpreis dieses Artikels (ohne Mehrwertsteuer). |
total | MoneyValue | Der Gesamtpreis dieses Artikels, einschließlich Unterartikeln (ohne Mehrwertsteuer). |
items | InvoiceItem[] | Nur die obersten Rechnungsposten können Unterartikel haben. |
vatPercentage |
number | null | Wie viel Mehrwertsteuer für diesen Artikel gilt. Nur relevant, wenn |
#Unit
Ein Objekt, das eine Einheit beschreibt, z.B. "Stunden" oder "Tage" oder "kg". Um eine Einheit in einer Vorlage anzuzeigen, wird empfohlen, den formatQuantity oder den formatUnit Helper zu verwenden.
unitId |
string | Eine eindeutige, slughafte Kennzeichnung der Einheit. Kann in Vorlagen verwendet werden, um zu prüfen, ob ein bestimmter Einheitstyp für einen Artikel bereitgestellt wird. |
label.plural | MultiLangString | Das Label für diese Einheit, wenn quantity 0 oder größer als 1 ist. |
label.singular | MultiLangString | Das Label für diese Einheit, wenn quantity 1 ist. |
#Beispiel
{
"unitId": "hours",
"label": {
"plural": {
"en": "Hours",
"de": "Stunden"
},
"singular": {
"en": "Hour",
"de": "Stunde"
}
}
}
#Discount
kind |
'percentage' | 'fixed' |
Welche Art von Rabatt angewendet wird. |
title |
string | Optionaler Titel für den Rabatt.
|
percentage |
number | Der Prozentsatz des Rabatts. Nur relevant, wenn |
fixedAmount | MoneyValue | Der feste Betrag des Rabatts. Nur relevant, wenn kind fixed ist. |
#TaxSubtotal
vatPercentage |
number | Der Mehrwertsteuersatz dieser Steuer-Zwischensumme.
|
baseAmount | MoneyValue | Der Grundbetrag aus dem sich die Zwischensumme berechnet. |
baseAmountAfterDiscounts | MoneyValue | Der Grundbetrag nach Anwendung evtl. Rabatte. |
discountAmount | MoneyValue | Der Betrag, um den der Grundbetrag reduziert wurde. |
subtotal | MoneyValue | Der Betrag dieser Steuer-Zwischensumme. |
#MoneyValue
currency |
string | Die Währung dieses bestimmten Wertes.
|
amount |
number | Der Betrag für diesen bestimmten Wert, in Cent.
|
#RichText
Variablen mit dem Typ RichText sind Zeichenketten von HTML-Markup. Es kann die folgenden Tags enthalten:
<p><ul><ol><li><strong>
#MultiLangString
Ein Objekt, das eine oder mehrere Sprachen als Schlüssel und strings als Werte enthält.
Es ist nicht garantiert, dass jede Sprache als Schlüssel vorhanden ist oder dass jeder Schlüssel einen Wert hat.
#Beispiel
{ "en": "Hello", "de": "Hallo" }