Vorlagen

Variablen (Angebote)

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

#Variablen

proposalProposalDas Angebot, das gerendert wird.
showCakedeskBranding boolean Ob das Cakedesk-Branding im Angebot angezeigt wird oder nicht.

#Proposal

proposalId string

Die benutzerseitige Angebotsnummer.
Beispiel: "2"

language string

Die Sprache des Angebots.
Beispiel: "en"

proposalDate string

Das Datum des Angebots.
Beispiel: "2022-09-13"

hasVat boolean Enthält das Angebot Umsatzsteuer?
hasQuantities boolean Beinhaltet das Angebot Mengenangaben für jeden einzelnen Artikel?
proposalTextRichTextEin Begleittext zum Angebot.
buyerProposalBuyerDer Kunde.
sellerProposalSellerDu.
itemsProposalItem[]Die einzelnen Artikel, die das Angebot ausmachen.
taxSubtotalsTaxSubtotal[]

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

totalTaxesMoneyValueDer Gesamtbetrag der im Angebot enthaltenen Steuern. Die Summe aller Umsatzsteuern.
subtotalMoneyValueDer Gesamtbetrag ohne Steuern.
totalMoneyValueDer Gesamtbetrag inklusive Steuern.

#ProposalBuyer

id string

Die benutzerseitige Kundennummer.
Beispiel: "1643505266"

name string

Der vollständige Name des Kunden.
Beispiel: "Restful Ltd."

vatId string

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

addressAddressDie Adresse des Kunden.
email

string

Die E-Mail-Adresse des Kunden.

#ProposalSeller

name string

Dein Firmenname.
Beispiel: "Restful Ltd."

vatId string

Deine USt-ID.
Beispiel: "DE123456789"

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"

addressAddressDeine Adresse.

#Address

Um eine Adresse anzuzeigen, die korrekt für ihr jeweiliges Land formatiert ist, wird empfohlen, den joinAddress Helper zu verwenden.

address string

Der Adressteil der Adresse. Enthält normalerweise 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 dieses Feld eingegeben, getrennt durch Zeilenumbrüche ('\n').
Beispiel: "Weichselstraße 65"

addressLine2 string

Der zweite Teil der Adresse.
Beispiel: "Gebäude 2"

zipCode string

Die Postleitzahl der Adresse
Beispiel: "54747"

city string

Die Stadt.
Beispiel: "Berlin"

countryCode string

Der Ländercode.
Beispiel: "DE"

#ProposalItem

title string Der Titel des Artikels.
descriptionRichTextEine optionale Beschreibung des Artikels. Kann ein leerer String sein.
unitPriceMoneyValueDer Preis einer Einzelmenge dieses Artikels. Nur relevant, wenn proposal.hasQuantities true ist.
quantity number Wie viele von diesem Artikel verkauft wurden. Nur relevant, wenn proposal.hasQuantities true ist.
unitUnit | null

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

amountMoneyValueDer Gesamtpreis dieses Artikels (ohne MwSt.).
vatPercentage number | null

Wie viel Umsatzsteuer auf diesen Artikel angewendet wird. Nur relevant, wenn proposal.hasVat true ist.
Beispiel: 19 oder null

itemsProposalItem[]Nur die obersten Ebene der Angebotsartikel können Unterartikel haben.
totalMoneyValueDer Gesamtpreis dieses Artikels, einschließlich Unterartikeln (ohne MwSt.).

#Unit

Ein Objekt, das eine Einheit beschreibt, z. B. "Stunden" oder "Tage" oder "kg". Um eine Einheit in einer Vorlage anzuzeigen, wird empfohlen, die formatQuantity oder formatUnit Helfer zu verwenden.

unitId string

Ein eindeutiger slug-artiger Bezeichner der Einheit. Kann in Vorlagen verwendet werden, um zu prüfen, ob eine bestimmte Art von Einheit für einen Artikel angegeben ist.

label.pluralMultiLangStringDie Bezeichnung für diese Einheit, wenn quantity 0 oder größer als 1 ist.
label.singularMultiLangStringDie Bezeichnung 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 Umsatzsteuersatz dieser Steuer-Zwischensumme.
Beispiel: 19

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