Variablen (Angebote)
Die folgenden Variablen sind in den template.ejs-Dateien der Angebotsvorlagen verfügbar:
#Variablen
proposal | Proposal | Das Angebot, das gerendert wird. |
showCakedeskBranding |
boolean |
Ob das Cakedesk-Branding im Angebot angezeigt wird oder nicht. |
#Proposal
proposalId |
string | Die benutzerseitige Angebotsnummer.
|
language |
string | Die Sprache des Angebots.
|
proposalDate |
string | Das Datum des Angebots.
|
hasVat |
boolean |
Enthält das Angebot Umsatzsteuer? |
hasQuantities |
boolean |
Beinhaltet das Angebot Mengenangaben für jeden einzelnen Artikel? |
proposalText | RichText | Ein Begleittext zum Angebot. |
buyer | ProposalBuyer | Der Kunde. |
seller | ProposalSeller | Du. |
items | ProposalItem[] | Die einzelnen Artikel, die das Angebot ausmachen. |
discounts | Discount[] | Die Rabatte, die auf dieses Angebot 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 im Angebot enthaltenen Rabatte. |
totalTaxes | MoneyValue | Der Gesamtbetrag der im Angebot enthaltenen Steuern. Die Summe aller Umsatzsteuern. |
subtotal | MoneyValue | Der Gesamtbetrag ohne Steuern. |
subtotalAfterDiscounts | MoneyValue | Der Gesamtbetrag ohne Steuern, nach Anwendung evtl. Rabatte. |
total | MoneyValue | Der Gesamtbetrag inklusive Steuern. |
#ProposalBuyer
id |
string | Die benutzerseitige Kundennummer.
|
name |
string | Der vollständige Name des Kunden.
|
vatId |
string | Die USt-ID oder GST-ID des Kunden, je nach Land des Kunden.
|
taxId |
string | Die Steuernummer des Kunden.
|
address | Address | Die Adresse des Kunden. |
email |
| Die E-Mail-Adresse des Kunden. |
#ProposalSeller
name |
string | Dein Firmenname.
|
vatId |
string | Deine USt-ID oder GST-ID, je nach deinem Land.
|
taxId |
string | Deine Steuernummer.
|
phone |
string | Deine Telefonnummer.
|
email |
string | Deine E-Mail-Adresse.
|
website |
string | Deine Webseite.
|
address | Address | Deine 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').
|
addressLine2 |
string | Der zweite Teil der Adresse.
|
zipCode |
string | Die Postleitzahl der Adresse
|
city |
string | Die Stadt.
|
countryCode |
string | Der Ländercode.
|
#ProposalItem
title |
string |
Der Titel des Artikels. |
description | RichText | Eine optionale Beschreibung des Artikels. Kann ein leerer String sein. |
unitPrice | MoneyValue | Der 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. |
unit | Unit | null | Der Einheitstyp für diesen Artikel oder |
amount | MoneyValue | Der Gesamtpreis dieses Artikels (ohne MwSt.). |
vatPercentage |
number | null | Wie viel Umsatzsteuer auf diesen Artikel angewendet wird. Nur relevant, wenn |
items | ProposalItem[] | Nur die obersten Ebene der Angebotsartikel können Unterartikel haben. |
total | MoneyValue | Der 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.plural | MultiLangString | Die Bezeichnung für diese Einheit, wenn quantity 0 oder größer als 1 ist. |
label.singular | MultiLangString | Die Bezeichnung 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 Umsatzsteuersatz dieser Steuer-Zwischensumme.
|
baseAmount | MoneyValue | Der Basisbetrag vor Anwendung von Rabatten. Enthält Mehrwertsteuer, wenn hasVat true ist. |
baseAmountAfterDiscounts | MoneyValue | Der Basisbetrag nach Anwendung von Rabatten. Enthält Mehrwertsteuer, wenn hasVat true ist. |
discountAmount | MoneyValue | Der Gesamtbetrag aller angewendeten Rabatte. |
subtotal | MoneyValue | Der Betrag dieser Steuer-Zwischensumme. |
#MoneyValue
currency |
string | Die Währung dieses Wertes.
|
amount |
number | Der Betrag dieses Wertes in Cent.
|
#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" }