Variable and placeholder reference
The tebio Business Portal transfers specific data to the message engine for every triggered event (e.g. a new invoice or a subscription change). You can use this data in your email and letter templates as placeholders (variables) to personalize the text.
Syntax of placeholders
Section titled “Syntax of placeholders”To insert a placeholder into your template’s text editor, use double curly brackets and a leading period before the variable name.
Example:
Hallo {{ .firstName }} {{ .lastName }}, Ihre Rechnung {{ .invoiceNo }} ist da!
[!TIP] Tip for complex data structures: Some events pass lists or arrays (e.g. a list of booked options). These can be iterated using loop constructs (if the template engine supports this).
1. Finances and Bills
Section titled “1. Finances and Bills”1.1. New invoice (invoicing.createInvoice)
Section titled “1.1. New invoice (invoicing.createInvoice)”Sent to inform the invoice recipient of a new invoice, invoice settlement, or invoice correction or credit note (depending on invoice.type). Supports configuration per TENANT.
| name | Description | Data type | Example |
|---|---|---|---|
buyerTitle | Buyer’s title (from billing address) | string | Dr. |
buyerFirstName | Buyer’s first name (from billing address) | string | Maximilian |
buyerLastName | Buyer’s last name (from billing address) | string | Tailor |
buyerCompanyName | Buyer’s company name (from billing address) | string | ACME GmbH |
invoiceNo | Invoice number | string | INV-0215-2025-DE |
invoiceType | Invoice type (COMMERCIAL_INVOICE, CREDIT_NOTE, INVOICE_STATEMENT) | string | COMMERCIAL_INVOICE |
currency | Invoice currency (ISO 4217) | string | EUR |
totalAmountInclTax | Total amount including taxes | decimal | 199.99 |
dueDate | Due date | timestamp | 2025-05-30T12:00:00Z |
paymentMethodServiceName | Name of payment method (only if payment is expected) | string | SEPA Direct Debit |
productTenantCompanyName | Name of the product tenant | string | ACME GmbH |
timezone | Time zone (from client configuration) | string | Europe/Berlin |
piCreditTransferIBAN | IBAN for transfers (from payment instructions) | string | DE89370400440532013000 |
piCreditTransferBIC | BIC for transfers | string | DEUTDEFFXXX |
piCreditTransferAccountName | Account holder for transfers | string | Tebio GmbH |
piCreditTransferRemittanceInformation | Purpose for transfer | string | INV-0215-2025-DE / ACME GmbH |
piCreditTransferMachineReadableCode | EPC QR code content (e.g. for banking apps) | string | BCD\n001\n1\nSCT\n… |
1.2. Payment reminder 1 (finance.dunningEmailLevel1)
Section titled “1.2. Payment reminder 1 (finance.dunningEmailLevel1)”Sent when an invoice that is due has not been paid after a certain number of days. Supports configuration per TENANT.
| name | Description | Data type | Example |
|---|---|---|---|
firstName | First name of the debtor | string | Maximilian |
lastName | Debtor’s last name | string | Tailor |
invoiceNo | Invoice number | string | INV-0215-2025-DE |
currency | Currency of the invoice | string | EUR |
totalAmountInclTax | Total claim including taxes | decimal | 199.99 |
productTenantCompanyName | Company name of the product client | string | ACME GmbH |
piCreditTransfer... | Transfer details (IBAN, BIC, purpose etc. identical to invoice) | string | - |
1.3. Payment reminder 2 (finance.dunningEmailLevel2)
Section titled “1.3. Payment reminder 2 (finance.dunningEmailLevel2)”Sent if the invoice remains unpaid after additional days (escalation). Supports configuration per TENANT.
Note: The parameters are identical to payment reminder 1 (finance.dunningEmailLevel1).
2. Payment processing (SEPA)
Section titled “2. Payment processing (SEPA)”2.1. SEPA advance notice Initial (payment.initialSepaPreNotification)
Section titled “2.1. SEPA advance notice Initial (payment.initialSepaPreNotification)”Sent to the payer when a SEPA mandate is successfully confirmed. Supports configuration per TENANT.
| name | Description | Data type | Example |
|---|---|---|---|
firstName | Recipient’s first name | string | Maximilian |
lastName | Recipient’s last name | string | Tailor |
bankIBAN | Last 4 digits of the bank IBAN | string | 3000 |
bankCI | Creditor ID | string | DE98ZZZ09999999999 |
arrangementReference | Reference of the mandate | string | K10050DE67M10F1R23BL00D7KP |
productTenantCompanyName | Company name of the product client | string | ACME GmbH |
reasonForPayment | Purpose/reason for payment | string | Payment for order 12345 |
initiatingPartyName | Initiating party | string | Tebio GmbH |
2.2. SEPA Advance Notice Recurring (payment.recurringSepaPreNotification)
Section titled “2.2. SEPA Advance Notice Recurring (payment.recurringSepaPreNotification)”Will be sent via SEPA for each subsequent debit. Supports configuration per TENANT.
| name | Description | Data type | Example |
|---|---|---|---|
| (Identical to 2.1 plus:) | |||
amount | Amount of the debit | decimal | 199.99 |
currency | Currency of the debit | string | EUR |
requestedCollectionDate | Scheduled withdrawal date | timestamp | 2023-01-10T10:00:00+02:00 |
timezone | Time zone (from client configuration) | string | Europe/Berlin |
3. Subscriptions
Section titled “3. Subscriptions”The parameters of many subscription events are very similar. All support configuration per PRODUCT.
| Standard parameters | Description | Data type | Example |
|---|---|---|---|
title | Customer title | string | Dr. |
firstName | Customer’s first name | string | Maximilian |
lastName | Customer last name | string | Tailor |
productName | Name of the subscribed product | string | Acme CRM |
productExtProductRef | External reference of the product | string | PROD-DE-CRM-001 |
productClientName | Product client company name | string | ACME GmbH |
subscriptionOwnerClientName | Company name of the subscription owner | string | ACME GmbH |
timezone | Time zone | string | Europe/Berlin |
3.1. New subscription activated (subscription.subCreateConfirmation)
Section titled “3.1. New subscription activated (subscription.subCreateConfirmation)”Triggered when a subscription becomes active. Additional parameters:
| name | Description | Data type | Example |
|---|---|---|---|
productSetupCharge | Optional setup fee | decimal | 16.79 |
productRecurringCharge | Optional recurring fee | decimal | 16.79 |
currency | Currency | string | EUR |
pricesIncludeTax | Do the prices include taxes? | bool | false.false |
prolongationPeriod | JSON: Renewal Period {"unit":"DAY","value":2} | string | See JSON |
productMinDuration | JSON: Minimum term {"unit":"DAY","value":14} | string | See JSON |
subscriptionValidFrom | Valid from (date) | timestamp | 2023-01-01T00:00:00Z |
subscriptionNextProlongation | Next extension (date) | timestamp | 2025-08-01T00:00:00Z |
paymentMethodServiceName | Name of the payment method | string | SEPA Direct Debit |
bookedOptions | JSON array of booked options | string | See JSON |
[!NOTE] The
bookedOptionsarray contains detailed JSON objects for each booked option (including name, duration, quantity, etc.).
3.2. Options changed (subscription.subChangeOption)
Section titled “3.2. Options changed (subscription.subChangeOption)”If subscription options change. In addition to the standard parameters, the JSON array bookedChanges is passed here instead of bookedOptions. The bookedChanges array contains the fields action (ADD, REMOVE, UPDATE), quantity and, for updates, also oldQuantity for each option.
3.3. Product change ordered (subscription.productChangeOrderEntry) & confirmed (subscription.productChangeConfirmation)
Section titled “3.3. Product change ordered (subscription.productChangeOrderEntry) & confirmed (subscription.productChangeConfirmation)”If a customer e.g. B. an upgrade or downgrade to another product is ordered or confirmed.
| Specific parameters | Description | Data type | Example |
|---|---|---|---|
sourceProductName | Name of the old product | string | Acme CRM |
targetProductName | Name of the new product | string | Acme CRM Plus |
sourceSubValidFrom | Start of the old subscription | timestamp | 2023-01-01T00:00:00Z |
targetSubValidFrom | Start of the new subscription | timestamp | 2023-01-01T00:00:00Z |
productChangeFee | Exchange fee | decimal | 5.99 |
bookedOptions | JSON array of target product options | string | See JSON |
3.4. Subscription canceled due to failed renewal (subscription.prolongCancelled)
Section titled “3.4. Subscription canceled due to failed renewal (subscription.prolongCancelled)”| name | Description | Data type | Example |
|---|---|---|---|
productOptionNameList | Comma separated list of disabled options | string | Priority Support, Storage |
totalAmountOfFailedPayment | Amount of the failed payment | decimal | 14.99 |
prolongationDate | Date of failure | timestamp | 2025-07-01T00:00:00Z |
3.5. Subscription paused (subscription.subPause) / Subscription pause ended (subscription.subUnpause)
Section titled “3.5. Subscription paused (subscription.subPause) / Subscription pause ended (subscription.subUnpause)”Additional parameters: pausedFrom (start of pause) and pausedUntil (end of pause).
3.6. Subscription cancellation received (Deactivation.OrderEntry) & confirmed (Deactivation.Confirmation)
Section titled “3.6. Subscription cancellation received (Deactivation.OrderEntry) & confirmed (Deactivation.Confirmation)”Additional parameters: scheduledForDeactivation (Planned Termination Date), actualCancellationDate or deactivationDate (Actual Execution Date).
4. Helpdesk and support
Section titled “4. Helpdesk and support”Support configuration per TENANT.
4.1. Messages to the customer (Created / Updated)
Section titled “4.1. Messages to the customer (Created / Updated)”helpdesk.ticket.create.notificationhelpdesk.ticket.update.notification
| name | Description | Data type | Example |
|---|---|---|---|
firstName | First name of the customer/contact | string | Maximilian |
lastName | Customer/contact last name | string | Tailor |
extTicketRef | Ticket reference number | string | HLT-719323 |
ticketTitle | Title/subject of the ticket | string | Server is down |
ticketDescription | Description of the ticket | string | We cannot reach the web… |
tenantCompanyName | Client name of the ticket | string | ACME GmbH |
4.2. Internal messages to the processor (assigneeName)
Section titled “4.2. Internal messages to the processor (assigneeName)”helpdesk.ticket.create.notification.assigneehelpdesk.ticket.update.notification.assigneehelpdesk.ticket.dueDate.notification(Reminder)
| name | Description | Data type | Example |
|---|---|---|---|
assigneeName | Name of the processor or support group | string | Support Team Berlin |
ticketTitle | Title of the ticket | string | Server is down |
extTicketRef | Ticket reference number | string | HLT-719323 |
affectedEntityName | Name of the affected entity (e.g. customer) | string | ACME GmbH |
5. Distributors
Section titled “5. Distributors”5.1. Status change to active (salespartner.StatusChange.ValidationToActive)
Section titled “5.1. Status change to active (salespartner.StatusChange.ValidationToActive)”Sent to the reseller contact when the partner is successfully activated. Configuration per TENANT.
| name | Description | Data type | Example |
|---|---|---|---|
contactFirstName | Recipient’s first name | string | Maximilian |
contactLastName | Recipient’s last name | string | Tailor |
companyName | Company of the sales partner | string | ACME GmbH |
newStatus | New status | string | ACTIVE |
6. Orders
Section titled “6. Orders”These events cover the eCommerce and shopping cart process. Configuration per PRODUCT.
6.1. New subscription ordered (order.newSubscription.*)
Section titled “6.1. New subscription ordered (order.newSubscription.*)”Status events: .ordered, .approved, .fulfilled, .unsuccessful
| name | Description | Data type | Example |
|---|---|---|---|
firstName / lastName | Customer name | string | Maximilian Schneider |
productName | Name of the subscription ordered | string | Acme CRM |
extOrderRef | Order number | string | ORD-202506 |
productSetupCharge | Setup fee | decimal | 16.79 |
productRecurringCharge | Recurring fee | decimal | 16.79 |
shippingMethod | Shipping method (if physical) | string | REGULAR_SHIPPING |
shippingTrackingUrls | JSON array of tracking links | string | ["https://dhl..."] |
bookedOptions | JSON array of subscription options | string | See JSON |
discounts | JSON array of applied discounts | string | [{"name": {"de":"3%"},...}] |
shippingAddress | JSON object of the delivery address | string | See JSON |
billingAddress | Billing address JSON object | string | See JSON |
cancellationReason | (Only for .unsuccessful) Reason for cancellation | string | Upon customer request |
6.2. Subscription change ordered (order.changeSubscription.*)
Section titled “6.2. Subscription change ordered (order.changeSubscription.*)”Status events: .ordered, .approved, .fulfilled, .unsuccessful Parameters are identical to the new subscription order, but also contain targetProductName, targetProductDescription and the array bookedChanges (which options were added, removed or changed, including oldQuantity vs. quantity).
6.3. Goods ordered (order.goods.*)
Section titled “6.3. Goods ordered (order.goods.*)”Status events: .ordered, .fulfilled, .unsuccessful
| name | Description | Data type | Example |
|---|---|---|---|
sumOneTimeCharge | Total amount of the order | decimal | 13.99 |
requestForPayment | JSON object with transfer data (IBAN, BIC) for advance payment | string | See JSON |
orderContent | JSON object of the entire shopping cart | string | See JSON |
modifiedTotalOrderCharges | JSON object of total amounts including and excluding taxes | string | See JSON |
shippingCharges | Shipping cost JSON object | string | {"amountInclTax":"5.99"} |
[!IMPORTANT] The
orderContentJSON contains the complete shopping cart including allgoodsVariants(items), prices, discounts and images (media). This object is suitable for building invoice/order lines in the template using a loop.
7. Logistics (Shipping)
Section titled “7. Logistics (Shipping)”7.1. Packaging notification for external logistics (order.shipping.external.notify.logistics)
Section titled “7.1. Packaging notification for external logistics (order.shipping.external.notify.logistics)”Sent when a shipping order is created for an external logistics partner. Configuration per TENANT.
| name | Description | Data type | Example |
|---|---|---|---|
shippingMethod | Shipping method | string | REGULAR_SHIPPING |
shippingId | Shipping ID | string | SHIP-12345 |
extOrderRef | Order number | string | 10000002 |
recipient | JSON object of the recipient | string | {"firstName":"John",...} |
shippingAddress | JSON object of the delivery address | string | See JSON |
items | JSON array of items to package | string | [{"name":"Pullover","quantity":2}] |
[!TIP] The
itemsarray provides a compact list of physical items that the logistician must place in the package. Ideal for creating a delivery note.