Vorlagen

Variablen (Rechnungen)

Die folgenden Variablen sind in den template.ejs Dateien der Rechnungsvorlagen verfügbar:

#Variablen

invoiceInvoiceDie 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.

#Rechnung

type 'INVOICE' | 'CREDIT_NOTE' Der Typ der Rechnung.
invoiceId string

Die benutzerseitige Rechnungsnummer.
Beispiel: "2"

language string

Die Sprache der Rechnung.
Beispiel: "en"

invoiceDate string

Das Datum der Rechnung.
Beispiel: "2022-09-13"

hasVat boolean Enthält die Rechnung Mehrwertsteuer?
hasQuantities boolean Enthält die Rechnung Mengenangaben für jeden einzelnen Artikel?
invoiceTextRichTextEin Textstück, das mit der Rechnung einhergeht.
buyerInvoiceBuyerDer Kunde.
sellerInvoiceSellerDu.
itemsInvoiceItem[]Die einzelnen Artikel, aus denen sich die Rechnung zusammensetzt.
taxSubtotalsTaxSubtotal[]

Ein Array von Steuer-Zwischensummen. Nur relevant, wenn hasVat true ist. Wenn deine Rechnungsartikel mehrere Mehrwertsteuersätze enthalten, wird dieses Feld auch mehrere Mehrwertsteuersätze enthalten.

totalTaxesMoneyValueDer Gesamtbetrag der Steuern, die in dieser Rechnung enthalten sind. Die Summe aller Mehrwertsteuern.
subtotalMoneyValueDer Gesamtbetrag ohne Steuern.
totalMoneyValueDer Gesamtbetrag einschließlich Steuern.

#InvoiceBuyer

id string

Die benutzerseitige Kundennummer.
Beispiel: "1643505266"

name string

Der volle Name des Kunden.
Beispiel: "Restful Ltd."

vatId string

Die USt-ID des Kunden.
Beispiel: "DE123456789"

taxId string

Die Steuernummer des Kunden.
Nur verfügbar für deutsche Nutzer.

addressAddressDie Adresse des Kunden.
email

string

Die E-Mail-Adresse des Kunden.

#InvoiceSeller

name string

Dein Firmenname.
Beispiel: "Restful Ltd."

vatId string

Deine USt-ID
Beispiel: "DE123456789"

taxId string

Deine Steuernummer.
Nur verfügbar für deutsche Nutzer.

addressAddressDeine Adresse.
email string

Deine E-Mail.
Beispiel: "mail@example.com"

website string

Deine Webseite.
Beispiel: "https://example.com"

addressAddressDeine Adresse.
iban

string

Deine IBAN, die du unter Einstellungen > Rechnungen eingerichtet hast.
bic

string

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').
Beispiel: "Weichselstraße 65"

zipCode string

Die Postleitzahl der Adresse.
Beispiel: "54747"

city string

Die Stadt.
Beispiel: "Berlin"

countryCode string

Der Ländercode.
Beispiel: "DE"

#InvoiceItem

title string Der Titel des Artikels.
descriptionRichTextEine optionale Beschreibung für den Artikel. Kann ein leerer String sein.
unitPriceMoneyValueDer 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.
unitUnit | null

Der Einheitstyp für diesen Artikel oder null, wenn der Artikel keine Einheit hat. Nur relevant, wenn invoice.hasQuantities true ist.

amountMoneyValueDer Gesamtpreis dieses Artikels (ohne Mehrwertsteuer).
totalMoneyValueDer Gesamtpreis dieses Artikels, einschließlich Unterartikeln (ohne Mehrwertsteuer).
itemsInvoiceItem[]Nur die obersten Rechnungsposten können Unterartikel haben.
vatPercentage number | null

Wie viel Mehrwertsteuer für diesen Artikel gilt. Nur relevant, wenn invoice.hasVat true ist.
Beispiel: 19 oder null

#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.pluralMultiLangStringDas Label für diese Einheit, wenn quantity 0 oder größer als 1 ist.
label.singularMultiLangStringDas Label für diese Einheit, wenn quantity 1 ist.

#Beispiel

{
	"unitId": "hours",
	"label": {
		"plural": {
			"en": "Hours",
			"de": "Stunden"
		},
		"singular": {
			"en": "Hour",
			"de": "Stunde"
		}
	}
}

#TaxSubtotal

vatPercentage number

Der Mehrwertsteuersatz dieser Steuer-Zwischensumme.
Beispiel: 19

subtotalMoneyValueDer Betrag dieser Steuer-Zwischensumme.

#MoneyValue

currency string

Die Währung dieses bestimmten Wertes.
Beispiel: "EUR"

amount number

Der Betrag für diesen bestimmten Wert, in Cent.
Beispiel: 450000

#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" }