Zum Inhalt springen

Variablen- und Platzhalter-Referenz

Das tebio Business-Portal übergibt bei jedem ausgelösten Ereignis (z. B. einer neuen Rechnung oder einer Subscription-Änderung) spezifische Daten an die Nachrichtenengine. Diese Daten können Sie in Ihren E-Mail- und Briefvorlagen als Platzhalter (Variablen) nutzen, um den Text zu personalisieren.

Um einen Platzhalter in den Texteditor Ihrer Vorlage einzufügen, verwenden Sie doppelte geschweifte Klammern und einen führenden Punkt vor dem Variablennamen.

Beispiel:

Hallo {{ .firstName }} {{ .lastName }}, Ihre Rechnung {{ .invoiceNo }} ist da!


Wird gesendet, um den Rechnungsempfänger über eine neue Rechnung, einen Rechnungsabschluss oder eine Rechnungskorrektur oder Gutschrift zu informieren (je nach invoice.type). Unterstützt Konfiguration pro TENANT.

NameBeschreibungDatentypBeispiel
buyerTitleTitel des Käufers (aus Rechnungsadresse)stringDr.
buyerFirstNameVorname des Käufers (aus Rechnungsadresse)stringMaximilian
buyerLastNameNachname des Käufers (aus Rechnungsadresse)stringSchneider
buyerCompanyNameFirmenname des Käufers (aus Rechnungsadresse)stringACME GmbH
invoiceNoRechnungsnummerstringINV-0215-2025-DE
invoiceTypeRechnungstyp (COMMERCIAL_INVOICE, CREDIT_NOTE, INVOICE_STATEMENT)stringCOMMERCIAL_INVOICE
currencyWährung der Rechnung (ISO 4217)stringEUR
totalAmountInclTaxGesamtbetrag inkl. Steuerndecimal199.99
dueDateFälligkeitsdatumtimestamp2025-05-30T12:00:00Z
paymentMethodServiceNameName des Zahlungsmittels (nur falls Zahlung erwartet)stringSEPA Direct Debit
productTenantCompanyNameName des Produkt-MandantenstringACME GmbH
timezoneZeitzone (aus Mandanten-Konfiguration)stringEurope/Berlin
piCreditTransferIBANIBAN für Überweisungen (aus Payment Instructions)stringDE89370400440532013000
piCreditTransferBICBIC für ÜberweisungenstringDEUTDEFFXXX
piCreditTransferAccountNameKontoinhaber für ÜberweisungenstringTebio GmbH
piCreditTransferRemittanceInformationVerwendungszweck für ÜberweisungstringINV-0215-2025-DE / ACME GmbH
piCreditTransferMachineReadableCodeEPC QR-Code Inhalt (z.B. für Banking-Apps)stringBCD\n001\n1\nSCT\n…

1.2. Zahlungserinnerung 1 (finance.dunningEmailLevel1)

Abschnitt betitelt „1.2. Zahlungserinnerung 1 (finance.dunningEmailLevel1)“

Wird gesendet, wenn eine fällige Rechnung nach einer bestimmten Anzahl von Tagen nicht bezahlt wurde. Unterstützt Konfiguration pro TENANT.

NameBeschreibungDatentypBeispiel
firstNameVorname des SchuldnersstringMaximilian
lastNameNachname des SchuldnersstringSchneider
invoiceNoRechnungsnummerstringINV-0215-2025-DE
currencyWährung der RechnungstringEUR
totalAmountInclTaxGesamtforderung inkl. Steuerndecimal199.99
productTenantCompanyNameFirmenname des Produkt-MandantenstringACME GmbH
piCreditTransfer...Überweisungsdaten (IBAN, BIC, Verwendungszweck etc. identisch zu Rechnung)string-

1.3. Zahlungserinnerung 2 (finance.dunningEmailLevel2)

Abschnitt betitelt „1.3. Zahlungserinnerung 2 (finance.dunningEmailLevel2)“

Wird gesendet, wenn die Rechnung nach weiteren Tagen weiterhin unbezahlt ist (Eskalation). Unterstützt Konfiguration pro TENANT.

Hinweis: Die Parameter sind identisch zur Zahlungserinnerung 1 (finance.dunningEmailLevel1).


2.1. SEPA-Vorabankündigung Initial (payment.initialSepaPreNotification)

Abschnitt betitelt „2.1. SEPA-Vorabankündigung Initial (payment.initialSepaPreNotification)“

Wird an den Zahler gesendet, wenn ein SEPA-Mandat erfolgreich bestätigt wurde. Unterstützt Konfiguration pro TENANT.

NameBeschreibungDatentypBeispiel
firstNameVorname des EmpfängersstringMaximilian
lastNameNachname des EmpfängersstringSchneider
bankIBANLetzte 4 Ziffern der Bank-IBANstring3000
bankCIGläubiger-IDstringDE98ZZZ09999999999
arrangementReferenceReferenz des MandatsstringK10050DE67M10F1R23BL00D7KP
productTenantCompanyNameFirmenname des Produkt-MandantenstringACME GmbH
reasonForPaymentVerwendungszweck / ZahlungsgrundstringPayment for order 12345
initiatingPartyNameInitiierende ParteistringTebio GmbH

2.2. SEPA-Vorabankündigung Wiederkehrend (payment.recurringSepaPreNotification)

Abschnitt betitelt „2.2. SEPA-Vorabankündigung Wiederkehrend (payment.recurringSepaPreNotification)“

Wird für jede folgende Abbuchung via SEPA versendet. Unterstützt Konfiguration pro TENANT.

NameBeschreibungDatentypBeispiel
(Identisch zu 2.1 plus:)
amountBetrag der Abbuchungdecimal199.99
currencyWährung der AbbuchungstringEUR
requestedCollectionDateGeplantes Abbuchungsdatumtimestamp2023-01-10T10:00:00+02:00
timezoneZeitzone (aus Mandanten-Konfiguration)stringEurope/Berlin

Die Parameter vieler Subscription-Events ähneln sich stark. Alle unterstützen die Konfiguration pro PRODUCT.

Standard-ParameterBeschreibungDatentypBeispiel
titleTitel des KundenstringDr.
firstNameVorname des KundenstringMaximilian
lastNameNachname des KundenstringSchneider
productNameName des abonnierten ProduktsstringAcmeCRM
productExtProductRefExterne Referenz des ProduktsstringPROD-DE-CRM-001
productClientNameFirmenname des Produkt-ClientsstringACME GmbH
subscriptionOwnerClientNameFirmenname des Abo-InhabersstringACME GmbH
timezoneZeitzonestringEurope/Berlin

3.1. Neue Subscription aktiviert (subscription.subCreateConfirmation)

Abschnitt betitelt „3.1. Neue Subscription aktiviert (subscription.subCreateConfirmation)“

Wird ausgelöst, wenn ein Abo aktiv wird. Zusätzliche Parameter:

NameBeschreibungDatentypBeispiel
productSetupChargeOptionale Einrichtungsgebührdecimal16.79
productRecurringChargeOptionale wiederkehrende Gebührdecimal16.79
currencyWährungstringEUR
pricesIncludeTaxEnthalten die Preise Steuern?boolfalse
prolongationPeriodJSON: Verlängerungsperiode {"unit":"DAY","value":2}stringSiehe JSON
productMinDurationJSON: Mindestlaufzeit {"unit":"DAY","value":14}stringSiehe JSON
subscriptionValidFromGültig ab (Datum)timestamp2023-01-01T00:00:00Z
subscriptionNextProlongationNächste Verlängerung (Datum)timestamp2025-08-01T00:00:00Z
paymentMethodServiceNameName des ZahlungsmittelsstringSEPA Direct Debit
bookedOptionsJSON-Array der gebuchten OptionenstringSiehe JSON

3.2. Optionen geändert (subscription.subChangeOption)

Abschnitt betitelt „3.2. Optionen geändert (subscription.subChangeOption)“

Wenn sich Optionen eines Abos ändern. Neben den Standard-Parametern wird hier das JSON-Array bookedChanges anstelle von bookedOptions übergeben. Das bookedChanges Array enthält zu jeder Option die Felder action (ADD, REMOVE, UPDATE), quantity und bei Updates auch oldQuantity.

3.3. Produktwechsel bestellt (subscription.productChangeOrderEntry) & Bestätigt (subscription.productChangeConfirmation)

Abschnitt betitelt „3.3. Produktwechsel bestellt (subscription.productChangeOrderEntry) & Bestätigt (subscription.productChangeConfirmation)“

Wenn ein Kunde z. B. ein Upgrade oder Downgrade auf ein anderes Produkt bestellt oder dieses bestätigt wird.

Spezifische ParameterBeschreibungDatentypBeispiel
sourceProductNameName des alten ProduktsstringAcmeCRM
targetProductNameName des neuen ProduktsstringAcmeCRM Plus
sourceSubValidFromStart der alten Subscriptiontimestamp2023-01-01T00:00:00Z
targetSubValidFromStart der neuen Subscriptiontimestamp2023-01-01T00:00:00Z
productChangeFeeWechselgebührdecimal5.99
bookedOptionsJSON-Array der Optionen des Ziel-ProduktsstringSiehe JSON

3.4. Subscription wegen fehlgeschlagener Verlängerung gekündigt (subscription.prolongCancelled)

Abschnitt betitelt „3.4. Subscription wegen fehlgeschlagener Verlängerung gekündigt (subscription.prolongCancelled)“
NameBeschreibungDatentypBeispiel
productOptionNameListKommaseparierte Liste der deaktivierten OptionenstringPriority Support, Storage
totalAmountOfFailedPaymentBetrag der fehlgeschlagenen Zahlungdecimal14.99
prolongationDateDatum des Fehlschlagstimestamp2025-07-01T00:00:00Z

3.5. Subscription pausiert (subscription.subPause) / Subscription-Pause beendet (subscription.subUnpause)

Abschnitt betitelt „3.5. Subscription pausiert (subscription.subPause) / Subscription-Pause beendet (subscription.subUnpause)“

Zusätzliche Parameter: pausedFrom (Beginn der Pause) und pausedUntil (Ende der Pause).

3.6. Kündigung der Subscription eingegangen (Deactivation.OrderEntry) & Bestätigt (Deactivation.Confirmation)

Abschnitt betitelt „3.6. Kündigung der Subscription eingegangen (Deactivation.OrderEntry) & Bestätigt (Deactivation.Confirmation)“

Zusätzliche Parameter: scheduledForDeactivation (Geplantes Kündigungsdatum), actualCancellationDate bzw. deactivationDate (Tatsächliches Ausführungsdatum).


Unterstützen Konfiguration pro TENANT.

4.1. Nachrichten an den Kunden (Erstellt / Aktualisiert)

Abschnitt betitelt „4.1. Nachrichten an den Kunden (Erstellt / Aktualisiert)“
  • helpdesk.ticket.create.notification
  • helpdesk.ticket.update.notification
NameBeschreibungDatentypBeispiel
firstNameVorname des Kunden / KontaktsstringMaximilian
lastNameNachname des Kunden / KontaktsstringSchneider
extTicketRefTicket-ReferenznummerstringHLT-719323
ticketTitleTitel / Betreff des TicketsstringServer is down
ticketDescriptionBeschreibung des TicketsstringWe cannot reach the web…
tenantCompanyNameMandanten-Name des TicketsstringACME GmbH

4.2. Interne Nachrichten an den Bearbeiter (assigneeName)

Abschnitt betitelt „4.2. Interne Nachrichten an den Bearbeiter (assigneeName)“
  • helpdesk.ticket.create.notification.assignee
  • helpdesk.ticket.update.notification.assignee
  • helpdesk.ticket.dueDate.notification (Reminder)
NameBeschreibungDatentypBeispiel
assigneeNameName des Bearbeiters oder der Support-GruppestringSupport Team Berlin
ticketTitleTitel des TicketsstringServer is down
extTicketRefTicket-ReferenznummerstringHLT-719323
affectedEntityNameName der betroffenen Entität (z.B. Kunde)stringACME GmbH

5.1. Statuswechsel auf Aktiv (salespartner.StatusChange.ValidationToActive)

Abschnitt betitelt „5.1. Statuswechsel auf Aktiv (salespartner.StatusChange.ValidationToActive)“

Wird an den Vertriebspartner-Kontakt gesendet, wenn der Partner erfolgreich aktiviert wurde. Konfiguration pro TENANT.

NameBeschreibungDatentypBeispiel
contactFirstNameVorname des EmpfängersstringMaximilian
contactLastNameNachname des EmpfängersstringSchneider
companyNameFirma des VertriebspartnersstringACME GmbH
newStatusNeuer StatusstringACTIVE

Diese Ereignisse decken den E-Commerce- und Warenkorbprozess ab. Konfiguration pro PRODUCT.

6.1. Neue Subscription bestellt (order.newSubscription.*)

Abschnitt betitelt „6.1. Neue Subscription bestellt (order.newSubscription.*)“

Status-Events: .ordered, .approved, .fulfilled, .unsuccessful

NameBeschreibungDatentypBeispiel
firstName / lastNameBesteller-NamestringMaximilian Schneider
productNameName der bestellten SubscriptionstringAcmeCRM
extOrderRefBestellnummerstringORD-202506
productSetupChargeEinrichtungsgebührdecimal16.79
productRecurringChargeWiederkehrende Gebührdecimal16.79
shippingMethodVersandmethode (falls physisch)stringREGULAR_SHIPPING
shippingTrackingUrlsJSON-Array der Tracking-Linksstring["https://dhl..."]
bookedOptionsJSON-Array der Abo-OptionenstringSiehe JSON
discountsJSON-Array der angewendeten Rabattestring[{"name": {"de":"3%"},...}]
shippingAddressJSON-Objekt der LieferadressestringSiehe JSON
billingAddressJSON-Objekt der RechnungsadressestringSiehe JSON
cancellationReason(Nur bei .unsuccessful) StornierungsgrundstringAuf Kundenwunsch

6.2. Subscription-Änderung bestellt (order.changeSubscription.*)

Abschnitt betitelt „6.2. Subscription-Änderung bestellt (order.changeSubscription.*)“

Status-Events: .ordered, .approved, .fulfilled, .unsuccessful Parameter sind identisch zur neuen Abo-Bestellung, enthalten aber zusätzlich targetProductName, targetProductDescription sowie das Array bookedChanges (welche Optionen hinzugefügt, entfernt oder geändert wurden, inkl. oldQuantity vs. quantity).

Status-Events: .ordered, .fulfilled, .unsuccessful

NameBeschreibungDatentypBeispiel
sumOneTimeChargeGesamtbetrag der Bestellungdecimal13.99
requestForPaymentJSON-Objekt mit Überweisungsdaten (IBAN, BIC) bei VorkassestringSiehe JSON
orderContentJSON-Objekt des gesamten WarenkorbsstringSiehe JSON
modifiedTotalOrderChargesJSON-Objekt der Gesamtbeträge inklusive und exklusive SteuernstringSiehe JSON
shippingChargesJSON-Objekt der Versandkostenstring{"amountInclTax":"5.99"}

7.1. Verpackungs-Benachrichtigung für externe Logistik (order.shipping.external.notify.logistics)

Abschnitt betitelt „7.1. Verpackungs-Benachrichtigung für externe Logistik (order.shipping.external.notify.logistics)“

Wird gesendet, wenn ein Versandauftrag für einen externen Logistikpartner erstellt wurde. Konfiguration pro TENANT.

NameBeschreibungDatentypBeispiel
shippingMethodVersandartstringREGULAR_SHIPPING
shippingIdID des VersandsstringSHIP-12345
extOrderRefBestellnummerstring10000002
recipientJSON-Objekt des Empfängersstring{"firstName":"John",...}
shippingAddressJSON-Objekt der LieferadressestringSiehe JSON
itemsJSON-Array der zu verpackenden Artikelstring[{"name":"Pullover","quantity":2}]