Placeholder reference
This page lists every standard placeholder the platform fills in for emails, SMS, letters and landing pages, and the helpers you can use to format them. The Placeholders panel in the template editor shows the same list for the template you have open.
Placeholders use Handlebars syntax. Write the name between double braces, for example {{firstName}}.
A few things apply to all of them:
- Amounts are in cents.
{{amount}}for a claim of 100.00 EUR is10000. To show an amount to a reader, use the localized placeholders ({{localizedAmount}}) or theformatCurrencyhelper. See Formatting amounts in the right currency. - Dates are stored as
YYYY-MM-DD. Use a localized placeholder or thedatehelper to show them in another format, for example{{date dueDate "DD.MM.YYYY"}}. - A placeholder with no value renders as empty. Use
{{#if}}or theoptionalhelper to show something else in its place.
Claim
The claim the message is about.
| Placeholder | Description | Example |
|---|---|---|
externalClaimRef | Your unique reference for the claim | EXT-REF-123 |
amount | Amount of the claim without fees, in cents | 10000 |
totalAmount | Amount of the claim including fees, in cents | 10200 |
totalFees | Total fees, in cents | 200 |
fees | List of fees, each with a name and an amount in cents | [{"name":"Interest","amount":1230}] |
currency | Currency of the claim (ISO 4217) | EUR |
dueDate | Due date of the claim | 2019-05-10 |
externalDueDate | Due date you sent for the claim | 2019-01-01 |
claimAge | Days since the claim's due date | 4 |
paymentReference | Reference to use when paying | 201021231 |
productReference | Reference of the product the claim belongs to | PRODUCT-1 |
externalPortfolioRef | Your portfolio reference | PORTFOLIO-123 |
landingPageURL | Link to the customer's landing page | https://example.com/c/bBomT0B5fG |
meta | Custom fields sent with the claim. See Meta fields | {{meta.invoiceNumber}} |
Localized claim amounts and dates
Formatted for the template's language and the claim's currency.
| Placeholder | Description | Example |
|---|---|---|
localizedAmount | Amount of the claim without fees | € 100.00 |
localizedTotalAmount | Amount of the claim including fees | € 102.00 |
localizedTotalFees | Total fees | € 2.00 |
localizedDueDate | Due date of the claim | 10.05.2019 |
localizedExternalDueDate | Due date you sent for the claim | 01.01.2019 |
localizedCurrentDate | Today's date | 22.01.2020 |
Promise to pay
The customer's current promise to pay on the claim, if there is one.
| Placeholder | Description | Example |
|---|---|---|
ptpAmount | Promised amount, in cents | 10200 |
ptpCurrency | Currency of the promise | EUR |
ptpStartDate | Date the promise was made | 2019-05-10 |
ptpDueDate | Date the promised payment is due | 2019-06-10 |
localizedPtpAmount | Promised amount, formatted | € 102.00 |
localizedPtpStartDate | Date the promise was made, formatted | 10.05.2019 |
localizedPtpDueDate | Date the promised payment is due, formatted | 10.06.2019 |
promiseToPay.amount | Promised amount, formatted | € 102.00 |
promiseToPay.startDate | Date the promise was made, formatted | 10.05.2019 |
promiseToPay.dueDate | Date the promised payment is due, formatted | 10.06.2019 |
promiseToPay.localizedAmount | Promised amount, formatted | € 102.00 |
promiseToPay.localizedStartDate | Date the promise was made, formatted | 10.05.2019 |
promiseToPay.localizedDueDate | Date the promised payment is due, formatted | 10.06.2019 |
All examples on this table describe the same promise.
Communication history
Dates of earlier messages on the same claim. Each one is stored as YYYY-MM-DD, so format it with the date helper, for example {{date lastLetterSentAt "DD.MM.YYYY"}}.
| Placeholder | Description | Example |
|---|---|---|
lastLetterSentAt | Date the last letter was handed to the print provider | 2023-05-17 |
previousLetterSentAt | Date of the last letter handed to the print provider before the current letter step started | 2023-05-03 |
lastLetterProcessedAt | Date a strategy last started a letter step | 2023-05-17 |
lastEmailSentAt | Date the last email was handed to the email provider | 2023-05-17 |
previousEmailSentAt | Date of the last email handed to the email provider before the current email step started | 2023-05-03 |
lastSMSSentAt | Date the last SMS was sent | 2023-05-17 |
previousSMSSentAt | Date of the last SMS sent before the current SMS step started | 2023-05-03 |
lastEmailDeliveredAt | Time the last email was delivered, as a timestamp in milliseconds. Use localizedLastEmailDeliveredAt to show it | 1684332000000 |
lastCommunicationSent | Latest of the letter, email and SMS dates above | 2023-05-17 |
localizedLastEmailSentAt | Date the last email was sent, formatted | 01.01.2019 |
localizedLastEmailDeliveredAt | Date the last email was delivered, formatted | 01.01.2019 |
The last…SentAt dates change as soon as a message is handed to its provider. A message generated later in the same strategy step, such as an email sent alongside a letter or one held until the send window opens, sees the date of the message going out in that step. To refer to the message before it, for example "our reminder of 14.10.2026", use previousLetterSentAt, previousEmailSentAt or previousSMSSentAt. They are set when a step for that channel starts and keep the same value for every message in the step.
Debtor
The customer the message is addressed to. The same fields are also available under debtor., for example {{debtor.firstName}}, and inside the account as account.debtor..
| Placeholder | Description | Example |
|---|---|---|
externalDebtorRef | Your reference for the debtor | REF-12344565 |
title | Title | Dr |
firstName | First name | Jane |
middleName | Middle name | Marie |
lastName | Last name | Doe |
companyName | Company name, if the debtor is a business | Example Ltd |
birthday | Date of birth | 1980-11-02 |
placeOfBirth | Place of birth | Berlin |
IBAN | Bank account number (IBAN) | DE89370400440532013000 |
contactInformation.email | Email address | jane@example.com |
contactInformation.mobileNumber | Mobile number | +495555555555 |
contactInformation.landLine | Landline number | +495555555555 |
contactInformation.workPhoneNumber | Work phone number | +495555555555 |
contactInformation.addressLine1 | First address line | Example Street 24 |
contactInformation.addressLine2 | Second address line | c/o Example Ltd |
contactInformation.addressLine3 | Third address line | Building B |
contactInformation.houseNumber | House number | 24A |
contactInformation.postalCode | Postal code | 33129 |
contactInformation.city | City | Berlin |
contactInformation.state | State or region | Berlin |
contactInformation.country | Country code (ISO 3166-1 alpha-2) | DE |
Account
The account the claim belongs to, which can hold several claims.
| Placeholder | Description | Example |
|---|---|---|
account.currency | Currency of the account's claims | EUR |
account.amount | Amount of all the account's claims without fees, in cents | 10000 |
account.totalAmount | Amount of all the account's claims including fees, in cents | 12000 |
account.localizedAmount | Amount of all the account's claims without fees, formatted | € 100.00 |
account.localizedTotalAmount | Amount of all the account's claims including fees, formatted | € 120.00 |
account.localizedTotalFees | Fees on all the account's claims, formatted | € 20.00 |
account.expensesAmount | Total expenses declared by the account's debtors, in cents | 8000 |
account.incomesAmount | Total income declared by the account's debtors, in cents | 20000 |
account.localizedExpensesAmount | Total expenses, formatted | € 80.00 |
account.localizedIncomesAmount | Total income, formatted | € 200.00 |
account.scores.internal | Internal account score | HighRisk |
account.scores.external | External account score | HighRisk |
account.scores.collection | Collection account score | HighRisk |
account.debtor.… | The account's debtor. Same fields as Debtor | {{account.debtor.lastName}} |
accountClaims | List of the account's claims, for use with {{#each}} | |
accountClaimsGroupedByProduct | The account's claims grouped by product reference, each with product and claims | |
productClaims | List of the claims on the same product, for use with {{#each}} | |
customBody | Free text passed with the message | Welcome |
Instalment plan
The account's active instalment plan, if there is one.
| Placeholder | Description | Example |
|---|---|---|
account.numberOfInstalments | Number of instalments in the plan | 5 |
account.instalmentAmount | Amount of each instalment, in cents | 10200 |
account.instalmentPlan.currency | Currency of the plan | EUR |
account.instalmentPlan.totalAmount | Total amount of the plan, in cents | 51000 |
account.instalmentPlan.paidAmount | Amount paid so far, in cents | 200 |
account.instalmentPlan.status | Status of the plan | ACTIVE |
account.instalmentPlan.createdAt | Date the plan was created | 2019-05-01 |
account.instalmentPlan.instalments | List of instalments, each with amount, dueDate, paidAmount and status |
Product
The product the claim belongs to. Under product. in claim messages, and without the prefix inside an accountClaimsGroupedByProduct entry.
| Placeholder | Description | Example |
|---|---|---|
product.productReference | Product reference | PRODUCT-1 |
product.paymentReference | Payment reference for the product | 201021231 |
product.type | Type of product | mobile |
product.name | Name of the product | Mobile contract |
product.code | Product code | MOBILE-24 |
product.meta | Custom fields sent with the product, for example {{product.meta.contractNumber}} | |
product.localizedAmount | Amount of the product's claims without fees, formatted | € 100.00 |
product.localizedTotalAmount | Amount of the product's claims including fees, formatted | € 120.00 |
product.localizedTotalFees | Fees on the product's claims, formatted | € 20.00 |
General
Values that do not depend on the claim or account.
For today's date, use localizedCurrentDate under Claim.
| Placeholder | Description | Example |
|---|---|---|
disclosures | Legally required disclosure text for the debtor's jurisdiction. Takes the country, the state and the communication type (all_comms or noa). It renders every disclosure that applies, in the order it must appear, exactly as published, and cannot be edited. Wrap it in optional to set what appears where no disclosure applies, for example {{#with debtor.contactInformation}}{{optional (disclosures country state 'noa') 'No disclosures apply.'}}{{/with}} | {{#with debtor.contactInformation}}{{disclosures country state 'noa'}}{{/with}} |
Strategy: custom recipient
Available in strategy templates that address a recipient other than the debtor. The fields match Debtor under customRecipient., for example {{customRecipient.lastName}}, plus:
| Placeholder | Description |
|---|---|
customRecipient.formattedTitle | The recipient's name formatted for a letter's address block |
Meta fields
Custom fields you send on a claim are available under meta., for example {{meta.invoiceNumber}}. Custom fields on a product are under product.meta.. Which fields exist depends on your own data; the editor's Placeholders panel lists the ones it knows about. A field written without meta. is treated as an unknown placeholder.
Global placeholders
Values you define once for your whole organisation are available under global., for example {{global.supportEmail}}. See Global placeholders.
Helpers
Helpers format or combine values. Write the helper name first, then its arguments.
| Helper | What it does | Example |
|---|---|---|
date | Formats a date. With no arguments, today's date | {{date dueDate "DD.MM.YYYY"}} |
dateAdd | Adds days, weeks, months or years to a date and formats it | {{dateAdd dueDate 15 "days" "DD.MM.YYYY"}} |
formatCurrency | Formats an amount in cents in the message currency, or in a currency and language you choose | {{formatCurrency 4000 "EUR" "de-DE"}} |
numberFormat | Formats a number with a pattern | {{numberFormat meta.balance "0.0,00"}} |
optional | Shows the first of its arguments that has a value | {{optional firstName companyName}} |
isEqual | Compares two values, for use in {{#if}} | {{#if (isEqual currency "EUR")}}…{{/if}} |
bold | Makes text bold | {{bold lastName}} |
breaklines | Turns line breaks in a text into line breaks in the message | {{breaklines meta.note}} |
lpQRCode | Link for a QR code that opens the landing page | {{lpQRCode landingPageURL}} |
sctQRCodeV2 | Link for a SEPA credit transfer QR code (EPC) | {{sctQRCodeV2 landingPageURL 'BIC' 'IBAN' 'Recipient name' '1' totalAmount 'Payment reference'}} |
czkQRCode | Link for a Czech payment QR code (SPD) | {{czkQRCode landingPageURL 'IBAN' totalAmount 'Message' paymentReference ''}} |
sqrcQRCode | Link for a Swedish bankgiro QR code | {{sqrcQRCode landingPageURL acc='123-4567' due=totalAmount}} |
The standard Handlebars blocks {{#if}}, {{#unless}}, {{#each}} and {{#with}} are also available, along with common comparison and text helpers.