Skip to main content

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 is 10000. To show an amount to a reader, use the localized placeholders ({{localizedAmount}}) or the formatCurrency helper. See Formatting amounts in the right currency.
  • Dates are stored as YYYY-MM-DD. Use a localized placeholder or the date helper to show them in another format, for example {{date dueDate "DD.MM.YYYY"}}.
  • A placeholder with no value renders as empty. Use {{#if}} or the optional helper to show something else in its place.

Claim​

The claim the message is about.

PlaceholderDescriptionExample
externalClaimRefYour unique reference for the claimEXT-REF-123
amountAmount of the claim without fees, in cents10000
totalAmountAmount of the claim including fees, in cents10200
totalFeesTotal fees, in cents200
feesList of fees, each with a name and an amount in cents[{"name":"Interest","amount":1230}]
currencyCurrency of the claim (ISO 4217)EUR
dueDateDue date of the claim2019-05-10
externalDueDateDue date you sent for the claim2019-01-01
claimAgeDays since the claim's due date4
paymentReferenceReference to use when paying201021231
productReferenceReference of the product the claim belongs toPRODUCT-1
externalPortfolioRefYour portfolio referencePORTFOLIO-123
landingPageURLLink to the customer's landing pagehttps://example.com/c/bBomT0B5fG
metaCustom 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.

PlaceholderDescriptionExample
localizedAmountAmount of the claim without fees€ 100.00
localizedTotalAmountAmount of the claim including fees€ 102.00
localizedTotalFeesTotal fees€ 2.00
localizedDueDateDue date of the claim10.05.2019
localizedExternalDueDateDue date you sent for the claim01.01.2019
localizedCurrentDateToday's date22.01.2020

Promise to pay​

The customer's current promise to pay on the claim, if there is one.

PlaceholderDescriptionExample
ptpAmountPromised amount, in cents10200
ptpCurrencyCurrency of the promiseEUR
ptpStartDateDate the promise was made2019-05-10
ptpDueDateDate the promised payment is due2019-06-10
localizedPtpAmountPromised amount, formatted€ 102.00
localizedPtpStartDateDate the promise was made, formatted10.05.2019
localizedPtpDueDateDate the promised payment is due, formatted10.06.2019
promiseToPay.amountPromised amount, formatted€ 102.00
promiseToPay.startDateDate the promise was made, formatted10.05.2019
promiseToPay.dueDateDate the promised payment is due, formatted10.06.2019
promiseToPay.localizedAmountPromised amount, formatted€ 102.00
promiseToPay.localizedStartDateDate the promise was made, formatted10.05.2019
promiseToPay.localizedDueDateDate the promised payment is due, formatted10.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"}}.

PlaceholderDescriptionExample
lastLetterSentAtDate the last letter was handed to the print provider2023-05-17
previousLetterSentAtDate of the last letter handed to the print provider before the current letter step started2023-05-03
lastLetterProcessedAtDate a strategy last started a letter step2023-05-17
lastEmailSentAtDate the last email was handed to the email provider2023-05-17
previousEmailSentAtDate of the last email handed to the email provider before the current email step started2023-05-03
lastSMSSentAtDate the last SMS was sent2023-05-17
previousSMSSentAtDate of the last SMS sent before the current SMS step started2023-05-03
lastEmailDeliveredAtTime the last email was delivered, as a timestamp in milliseconds. Use localizedLastEmailDeliveredAt to show it1684332000000
lastCommunicationSentLatest of the letter, email and SMS dates above2023-05-17
localizedLastEmailSentAtDate the last email was sent, formatted01.01.2019
localizedLastEmailDeliveredAtDate the last email was delivered, formatted01.01.2019
Referring to the previous message

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..

PlaceholderDescriptionExample
externalDebtorRefYour reference for the debtorREF-12344565
titleTitleDr
firstNameFirst nameJane
middleNameMiddle nameMarie
lastNameLast nameDoe
companyNameCompany name, if the debtor is a businessExample Ltd
birthdayDate of birth1980-11-02
placeOfBirthPlace of birthBerlin
IBANBank account number (IBAN)DE89370400440532013000
contactInformation.emailEmail addressjane@example.com
contactInformation.mobileNumberMobile number+495555555555
contactInformation.landLineLandline number+495555555555
contactInformation.workPhoneNumberWork phone number+495555555555
contactInformation.addressLine1First address lineExample Street 24
contactInformation.addressLine2Second address linec/o Example Ltd
contactInformation.addressLine3Third address lineBuilding B
contactInformation.houseNumberHouse number24A
contactInformation.postalCodePostal code33129
contactInformation.cityCityBerlin
contactInformation.stateState or regionBerlin
contactInformation.countryCountry code (ISO 3166-1 alpha-2)DE

Account​

The account the claim belongs to, which can hold several claims.

PlaceholderDescriptionExample
account.currencyCurrency of the account's claimsEUR
account.amountAmount of all the account's claims without fees, in cents10000
account.totalAmountAmount of all the account's claims including fees, in cents12000
account.localizedAmountAmount of all the account's claims without fees, formatted€ 100.00
account.localizedTotalAmountAmount of all the account's claims including fees, formatted€ 120.00
account.localizedTotalFeesFees on all the account's claims, formatted€ 20.00
account.expensesAmountTotal expenses declared by the account's debtors, in cents8000
account.incomesAmountTotal income declared by the account's debtors, in cents20000
account.localizedExpensesAmountTotal expenses, formatted€ 80.00
account.localizedIncomesAmountTotal income, formatted€ 200.00
account.scores.internalInternal account scoreHighRisk
account.scores.externalExternal account scoreHighRisk
account.scores.collectionCollection account scoreHighRisk
account.debtor.…The account's debtor. Same fields as Debtor{{account.debtor.lastName}}
accountClaimsList of the account's claims, for use with {{#each}}
accountClaimsGroupedByProductThe account's claims grouped by product reference, each with product and claims
productClaimsList of the claims on the same product, for use with {{#each}}
customBodyFree text passed with the messageWelcome

Instalment plan​

The account's active instalment plan, if there is one.

PlaceholderDescriptionExample
account.numberOfInstalmentsNumber of instalments in the plan5
account.instalmentAmountAmount of each instalment, in cents10200
account.instalmentPlan.currencyCurrency of the planEUR
account.instalmentPlan.totalAmountTotal amount of the plan, in cents51000
account.instalmentPlan.paidAmountAmount paid so far, in cents200
account.instalmentPlan.statusStatus of the planACTIVE
account.instalmentPlan.createdAtDate the plan was created2019-05-01
account.instalmentPlan.instalmentsList 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.

PlaceholderDescriptionExample
product.productReferenceProduct referencePRODUCT-1
product.paymentReferencePayment reference for the product201021231
product.typeType of productmobile
product.nameName of the productMobile contract
product.codeProduct codeMOBILE-24
product.metaCustom fields sent with the product, for example {{product.meta.contractNumber}}
product.localizedAmountAmount of the product's claims without fees, formatted€ 100.00
product.localizedTotalAmountAmount of the product's claims including fees, formatted€ 120.00
product.localizedTotalFeesFees 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.

PlaceholderDescriptionExample
disclosuresLegally 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:

PlaceholderDescription
customRecipient.formattedTitleThe 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.

HelperWhat it doesExample
dateFormats a date. With no arguments, today's date{{date dueDate "DD.MM.YYYY"}}
dateAddAdds days, weeks, months or years to a date and formats it{{dateAdd dueDate 15 "days" "DD.MM.YYYY"}}
formatCurrencyFormats an amount in cents in the message currency, or in a currency and language you choose{{formatCurrency 4000 "EUR" "de-DE"}}
numberFormatFormats a number with a pattern{{numberFormat meta.balance "0.0,00"}}
optionalShows the first of its arguments that has a value{{optional firstName companyName}}
isEqualCompares two values, for use in {{#if}}{{#if (isEqual currency "EUR")}}…{{/if}}
boldMakes text bold{{bold lastName}}
breaklinesTurns line breaks in a text into line breaks in the message{{breaklines meta.note}}
lpQRCodeLink for a QR code that opens the landing page{{lpQRCode landingPageURL}}
sctQRCodeV2Link for a SEPA credit transfer QR code (EPC){{sctQRCodeV2 landingPageURL 'BIC' 'IBAN' 'Recipient name' '1' totalAmount 'Payment reference'}}
czkQRCodeLink for a Czech payment QR code (SPD){{czkQRCode landingPageURL 'IBAN' totalAmount 'Message' paymentReference ''}}
sqrcQRCodeLink 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.