Available Event Tokens

Last verified with: 10.8.6.0

As part of events being triggered inside LogiSense Billing, different data tokens are available around that event. These tokens can be inserted into an email template or a webhook payload so the notification includes useful business data about the event that occurred.

Use tokens in your template or payload with standard token formatting, for example:

{account.name}
{invoice.id}
{payment.paymentAmount}

Not every token is available for every event. The available token groups depend on the token context assigned to the event that triggered the notification.

Token Context Group Mapping #

The following token contexts are supported by the current product runtime.

Token Context	Available Token Groups
Account	Core, Account, Contact
Account Package	Core, Account, Account Package
Account Service	Core, Account, Account Package, Account Service
Account Service Usage Bucket	Core, Account, Contact, Account Package, Account Service, Account Service Usage Bucket
Account Contract	Core, Account, Account Contract
Bill Run	Core, Bill Run
Credit Note	Core, Account, Credit Note
Invoice	Core, Account, Contact, Invoice
Payment	Account, Payment
Payment Error	Account, Payment Error
Payment Update	Account, Payment, Payment Error
Report	Report
Portal User	Core, Portal User
Usage File	Core, Usage File
User	Core, User
Dunning	Core, Account, Contact, Invoice, Dunning

Common Event To Token Context Examples #

These are common examples of how the external event subscriptions map to token contexts.

Event	Token Context
Account Service State Transition	Account Service
Account Status Change	Account
Bill Run Started	Bill Run
Bill Run Completion	Bill Run
Invoice Posted	Invoice
Invoice Delivery	Invoice
Account Package Status Change	Account Package
Credit Note Rendered	Credit Note
Bucket Threshold Percentage Exceeded	Account Service Usage Bucket
Scheduled Report Generated	Report
Payment Processed Successfully	Payment
Payment Processed with Errors	Payment Error
Usage File Processed	Usage File
Payment Status Updated	Payment Update

Supported Tokens By Token Group #

Core #

These tokens provide general information about the notification itself.

{currentTime}: The current time when the notification is generated.
{currentDate}: The current date when the notification is generated.
{currentDateTime}: The current date and time when the notification is generated.
{ownerName}: The owner name for the LogiSense Billing environment generating the notification.
{eventName}: The event name that triggered the notification.

Account #

These tokens provide details about the account associated with the event.

{account.id}: The internal account identifier.
{account.name}: The unique account name.
{account.displayName}: The account display name, if one is configured.
{account.currentStatus}: The current account status at the time the notification is generated.
{account.billDay}: The account bill day.
{account.balance}: The current account balance.
{account.balanceDue}: The amount currently due on the account.
{account.vatNumber}: The VAT or tax registration number stored on the account.
{account.eInvoiceEndpointId}: The electronic invoicing endpoint identifier on the account, when used.
{account.eInvoiceSchemeId}: The electronic invoicing scheme identifier on the account, when used.

Contact #

These tokens use the configured contact type and contact point name. Replace {contactType} and {contactPoint} with the values used in your environment, such as Billing, Technical, Email, or Phone.

{contact.{contactType}.id}: The internal contact identifier for the selected contact type.
{contact.{contactType}.firstName}: The first name for the selected contact type.
{contact.{contactType}.lastName}: The last name for the selected contact type.
{contact.{contactType}.title}: The title for the selected contact type.
{contact.{contactType}.address1}: The first address line for the selected contact type.
{contact.{contactType}.address2}: The second address line for the selected contact type.
{contact.{contactType}.city}: The city for the selected contact type.
{contact.{contactType}.state}: The state or province for the selected contact type.
{contact.{contactType}.country}: The country for the selected contact type.
{contact.{contactType}.zipCode}: The postal or ZIP code for the selected contact type.
{contact.{contactType}.{contactPoint}}: The value for the requested contact point, such as email address, phone number, or other configured contact point.

Account Package #

These tokens provide details about the account package associated with the event.

{account.package.id}: The internal account package identifier.
{account.package.name}: The account package name.
{account.package.packageFrequency.name}: The package frequency name associated with the account package.
{account.package.currentStatus}: The current account package status.
{account.package.previousStatus}: The previous account package status.
{account.package.effectiveDate}: The effective date of the account package.

Account Service #

These tokens provide details about the account service associated with the event.

{account.service.id}: The internal account service identifier.
{account.service.name}: The account service name.
{account.service.currentStatus}: The current service status.
{account.service.previousStatus}: The previous service status.
{account.service.usageIdentifier}: The usage identifier associated with the service.

Account Service Usage Bucket #

These tokens provide details about the usage bucket associated with the event.

{account.service.bucket.id}: The internal usage bucket identifier.
{account.service.bucket.name}: The usage bucket name.
{account.service.bucket.unit}: The unit type for the bucket, such as minutes, messages, or data volume.
{account.service.bucket.size}: The configured size of the bucket.
{account.service.bucket.currentUsage}: The amount of the bucket that has been consumed.
{account.service.bucket.effectiveDate}: The start date of the current bucket period.
{account.service.bucket.endDate}: The end date of the current bucket period.
{account.service.bucket.sharePlan.name}: The related share plan name, when the bucket participates in a share plan.
{account.service.bucket.sharePlan.id}: The related share plan identifier, when the bucket participates in a share plan.

Account Contract #

These tokens provide details about the account contract associated with the event.

{account.contract.name}: The account contract name.
{account.contract.status}: The current contract status.
{account.contract.commitmentType}: The commitment type used by the contract.
{account.contract.minimumCommitTier}: The minimum commitment tier used for the contract.
{account.contract.underCommitCharge}: The under-commit charge associated with the contract.
{account.contract.commitUnit}: The unit used by the contract commitment, such as charge or count.

Bill Run #

These tokens provide details about the bill run associated with the event.

{billRun.id}: The bill run identifier.
{billRun.historyId}: The specific bill run occurrence identifier.
{billRun.name}: The bill run name.
{billRun.start}: The bill run start date and time.
{billRun.end}: The bill run end date and time.
{billRun.status}: The current bill run status.
{billRun.historyName}: The bill run history name for the specific occurrence.

Credit Note #

These tokens provide details about the credit note associated with the event.

{creditNote.id}: The credit note identifier.
{creditNote.total}: The total credit note amount.

Invoice #

These tokens provide details about the invoice associated with the event.

{invoice.id}: The invoice identifier.
{invoice.name}: The invoice name or display identifier.
{invoice.date}: The invoice date.
{invoice.dueDate}: The invoice due date.
{invoice.deliveryDate}: The invoice delivery date.
{invoice.invoiceTotal}: The full invoice total.
{invoice.totalCharge}: The charge total before tax.
{invoice.totalTax}: The total tax amount on the invoice.
{invoice.paymentDue}: The amount currently due on the invoice.
{invoice.balance}: The unpaid balance on the invoice.
{invoice.documentIdentifier}: The document identifier associated with the invoice, when one exists.

Report #

These tokens provide details about a generated report notification.

{report.identifier}: The report storage identifier used to identify the generated report.
{report.name}: The report name.
{report.scheduleName}: The name of the schedule that generated the report.

Payment #

These tokens provide details about a payment associated with the event.

{payment.paymentType}: The payment type, such as credit card or ACH.
{payment.cardType}: The card type used for the payment, when applicable.
{payment.paymentProvider}: The payment provider used to process the payment.
{payment.paymentAmount}: The payment amount.
{payment.currency}: The payment currency.
{payment.transactionId}: The payment transaction identifier.
{payment.paymentGateway}: The payment gateway associated with the payment.
{payment.paymentStatus}: The payment status.
{payment.paymentMethodName}: The payment method name used for the transaction.

Payment Error #

These tokens provide error details for payment-related failure notifications.

{payment.error}: The payment error message returned for the failed payment activity.

Portal User #

These tokens provide details about a Customer Portal user notification.

{portalUser.firstName}: The portal user first name.
{portalUser.lastName}: The portal user last name.
{portalUser.userName}: The portal user login name.
{portalUser.portalBaseUrl}: The Customer Portal base URL used for the notification.
{portalUser.resetLinkKey}: The reset link key associated with the password setup or reset flow.

Usage File #

These tokens provide details about a processed usage file.

{usageFile.usageFeed}: The usage feed associated with the file.
{usageFile.fileName}: The processed file name.
{usageFile.totalRecords}: The total number of records received in the file.
{usageFile.totalProcessed}: The number of records processed successfully.
{usageFile.totalDuplicate}: The number of duplicate records identified.
{usageFile.totalSkipped}: The number of records skipped during processing.
{usageFile.totalException}: The number of records that resulted in exceptions.

User #

These tokens provide details about an Admin Portal user notification.

{user.firstName}: The user first name.
{user.lastName}: The user last name.
{user.displayName}: The user display name.
{user.userName}: The user login name.
{user.resetPasswordLink}: The password reset link for the user, when the notification is part of a password reset flow.

Dunning #

These tokens provide details about the dunning rule associated with a dunning notification.

{dunning.dunningRuleId}: The dunning rule identifier.
{dunning.dunningRuleName}: The dunning rule name.
{dunning.dunningEvent}: The dunning event stage, such as Prior Due Date, On Due Date, or Post Due Date.

Notes #

Token availability depends on the event context. If a token group is not part of the event’s token context, those tokens will not be available for that notification.
Contact tokens are dynamic and depend on the contact types and contact points configured in your environment.
Payment-related notifications use different token contexts depending on the event. For example, Payment Processed Successfully uses payment tokens, while Payment Status Updated can also include payment error information.

Still stuck? How can we help?