Variablen

Die folgenden Variablen stehen in der template.ejs-Datei aller Templates zur Verfügung. Sie bieten eine einheitliche Möglichkeit auf Daten von Rechnungen und Angeboten zuzugreifen, unabhängig vom Dokumenttyp.

#Variablen

`document`	`Document`	Das Dokument, das gerade gerendert wird (Rechnung oder Angebot).
`documentType`	`'INVOICE' \| 'PROPOSAL'`	Der Typ des zu rendernden Dokuments.
`showCakedeskBranding`	`boolean`	Ob das Cakedesk-Branding auf dem Dokument angezeigt werden soll.
`paymentQrCodeSvg`	`string`	Der HTML-Code für das Zahlungs-QR-Code-SVG. Leerer String, wenn kein QR-Code verfügbar ist (einschließlich aller Angebote).

#Document

`type`	`'INVOICE' \| 'CREDIT_NOTE' \| 'PROPOSAL'`	Der spezifische Typ des Dokuments.
`id`	`string`	Rechnungsnummer oder Angebotsnummer. Beispiel: `"2"`
`language`	`string`	Die Sprache des Dokuments. Beispiel: `"en"`
`date`	`string`	Das Datum des Dokuments. Beispiel: `"2022-09-13"`
`title`	`string`	Der Angebotstitel. Leerer String für Rechnungen.
`hasDeliveryDate`	`boolean`	Enthält das Dokument ein Lieferdatum? Nur relevant für Rechnungen.
`deliveryDateType`	`'deliveryDate' \| 'serviceDate'`	Die Art des Lieferdatums.
`deliveryDate`	`string`	Das Lieferdatum des Dokuments.
`introText`	`RichText`	Text, der vor den Positionen angezeigt wird. Wird bei Angeboten aus dem Angebotstext gesetzt. Leerer String für Rechnungen.
`outroText`	`RichText`	Text, der nach den Positionen angezeigt wird. Wird bei Rechnungen aus dem Rechnungstext gesetzt. Leerer String für Angebote.
`buyer`	`Buyer`	Der Kunde.
`seller`	`Seller`	Du.
`items`	`Item[]`	Die einzelnen Positionen, aus denen sich das Dokument zusammensetzt.
`discounts`	`Discount[]`	Die Rabatte, die auf dieses Dokument angewendet werden.
`taxSubtotals`	`TaxSubtotal[]`	Ein Array von Steuer-Zwischensummen, einschließlich Einträgen für `0%`. Nur relevant, wenn `hasVat` `true` ist. Wenn die Posten verschiedene Steuersätze enthalten, enthält dieses Feld auch mehrere Einträge.
`totalDiscounts`	`MoneyValue`	Der Gesamtbetrag der Rabatte.
`totalTaxes`	`MoneyValue`	Der Gesamtbetrag der Steuern.
`subtotal`	`MoneyValue`	Der Gesamtbetrag ohne Steuern.
`subtotalAfterDiscounts`	`MoneyValue`	Der Gesamtbetrag ohne Steuern, nach Anwendung evtl. Rabatte.
`total`	`MoneyValue`	Der Gesamtbetrag einschließlich Steuern.
`hasVat`	`boolean`	Enthält das Dokument Mehrwertsteuer?
`hasQuantities`	`boolean`	Enthält das Dokument Mengenangaben für jeden einzelnen Artikel?

#E-Rechnungs-Felder

Die folgenden Felder sind nur für E-Rechnungen verfügbar. Sie werden von den integrierten Vorlagen nicht angezeigt.

`projectReferenceId`	`string \| undefined`	Die Projektnummer (BT-11).
`projectReferenceName`	`string \| undefined`	Der Projektname (BT-11-0).
`contractReferenceId`	`string \| undefined`	Die Vertragsnummer (BT-12).
`buyerOrderReferenceId`	`string \| undefined`	Die Bestellnummer des Käufers (BT-13).
`sellerOrderReferenceId`	`string \| undefined`	Die Auftragsnummer des Verkäufers (BT-14).

#Buyer

`id`	`string`	Die benutzerseitige Kundennummer. Beispiel: `"1643505266"`
`name`	`string`	Der vollständige Name des Kunden. Beispiel: `"Restful Ltd."`
`vatId`	`string`	Die USt-ID oder GST-ID des Kunden, je nach Land des Kunden. Beispiel: `"DE123456789"` oder `"AU123456789"`
`taxId`	`string`	Die Steuernummer des Kunden. Nur verfügbar für deutsche Nutzer.
`address`	`Address`	Die Adresse des Kunden.
`email`	`string`	Die E-Mail-Adresse des Kunden.

#Seller

`name`	`string`	Dein Firmenname. Beispiel: `"Restful Ltd."`
`vatId`	`string`	Deine USt-ID oder GST-ID, je nach deinem Land. Beispiel: `"DE123456789"` oder `"AU123456789"`
`taxId`	`string`	Deine Steuernummer. Nur verfügbar für deutsche Nutzer.
`phone`	`string`	Deine Telefonnummer. Beispiel: `"+49 (0) 170 123 456"`
`email`	`string`	Deine E-Mail-Adresse. Beispiel: `"mail@example.com"`
`website`	`string`	Deine Webseite. Beispiel: `"https://example.com"`
`address`	`Address`	Deine Adresse.
`accountHolderName`	`string`	Dein Kontoinhaber-Name, den du unter `Einstellungen > Rechnungen` eingerichtet hast.
`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"`

#Item

`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 `document.hasQuantities` `true` ist.
`quantity`	`number`	Wie viele von diesem Artikel verkauft wurden. Nur relevant, wenn `document.hasQuantities` `true` ist.
`unit`	`Unit \| null`	Der Einheitstyp für diesen Artikel oder `null`, wenn der Artikel keine Einheit hat. Nur relevant, wenn `document.hasQuantities` `true` ist.
`amount`	`MoneyValue`	Der Gesamtpreis dieses Artikels (ohne MwSt.).
`total`	`MoneyValue`	Der Gesamtpreis dieses Artikels, einschließlich Unterartikeln (ohne MwSt.).
`items`	`Item[]`	Nur die obersten Posten können Unterartikel haben.
`vatPercentage`	`number \| null`	Wie viel Mehrwertsteuer für diesen Artikel gilt. Nur relevant, wenn `document.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.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. Beispiel: `'Frühbucherrabatt'`
`percentage`	`number`	Der Prozentsatz des Rabatts. Nur relevant, wenn `kind` `percentage` ist. Beispiel: `20` (20%)
`fixedAmount`	`MoneyValue`	Der feste Betrag des Rabatts. Nur relevant, wenn `kind` `fixed` ist.

#TaxSubtotal

`vatPercentage`	`number`	Der Mehrwertsteuersatz dieser Steuer-Zwischensumme. Beispiel: `19`
`baseAmount`	`MoneyValue`	Der Grundbetrag vor Anwendung von Rabatten.
`baseAmountAfterDiscounts`	`MoneyValue`	Der Grundbetrag nach Anwendung von evtl. Rabatten.
`discountAmount`	`MoneyValue`	Der Gesamtbetrag aller angewendeten Rabatte.
`subtotal`	`MoneyValue`	Der Betrag dieser Steuer-Zwischensumme.

#MoneyValue

`currency`	`string`	Die Währung dieses Wertes. Beispiel: `"EUR"`
`amount`	`number`	Der Betrag dieses Wertes in Cent. Beispiel: `450000`

#RichText

Variablen vom Typ RichText sind HTML-Markup-Strings. Es können folgende Tags enthalten sein:

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

Allgemein

Vorlagen

Vorlagen erstellen

Hilfe

Variablen

#Variablen

#Document

#E-Rechnungs-Felder

#Buyer

#Seller

#Address

#Item

#Unit

#Beispiel

#Discount

#TaxSubtotal

#MoneyValue

#RichText

#MultiLangString

#Beispiel