Table of Contents

Email Variables & Conditions

Jennifer Trower Updated by Jennifer Trower

Read Time: 4 mins

Using Variables in Sonar

Use the table of contents on the right to quickly jump to the section you need.

Below is a list of available variables you can use to display data in different areas of Sonar or in conditional statements. The variables available to you depend on where you are using them. For example, the variables available in an agreement template may be different from those available in a trigger email.

The Variables menu will not appear in the Create Email Message Content window until the Email Triggers field is filled in.

Once an email trigger is selected, the menu will appear and show the variables available to use in the email body.



There is currently an issue where variable formatting may not be preserved when copying and pasting into the text editor, which can prevent the variables from working correctly.

See the section below for the available workaround and step-by-step instructions.
Temporary Workaround for Preserving Variables When Pasting into the Editor
Workaround: Until this issue is fixed, follow the steps below to keep variable formatting intact when pasting into the text editor.

This workaround uses the { } button shown here.



Temporary Workaround:
1. Click the { } button within the text editor



2. Paste the content that contains variables



3. Click the { } button again


A

Variable

What It Displays

Where It's Accessible

*|ACCOUNT_ADDRESS|*

 Account address

Agreement Templates

*|ACCOUNT_NAME|*

 Account name

Canned Replies, Agreement Templates, Email Messages

*|ACCOUNT_NUMBER|*

 Account number

Canned Replies, Agreement Templates, Email Messages, Mass Email

*|AMOUNT|*

 Amount

Email Messages

*|AMOUNT_DUE|*

Amount due

Canned Replies, Email Messages, Mass Email

*|AMOUNT_DUE_ON_INVOICE|*

Amount due on invoice

Email Messages

*|AMOUNT_DUE_ON_INVOICE_RAW|*

Unformatted total amount due on this invoice

Email Messages

*|AMOUNT_DUE_RAW|*

Unformatted amount due

Email Messages

*|AUTO_PAY_DATE|*

 Autopay date

Email Messages

*|IF:AUTOPAY_ENABLED|*

CONDITION: Whether autopay is enabled or not

Email Messages, Mass Email

*|IF:AUTOPAY_RUNS_ENTIRE_AMOUNT_DUE|*

CONDITION: Whether or not autopay runs the entire amount due

Email Messages

B

Variable

What It Displays

Where It's Accessible

*|BAD_ITEMS|*

Inventory items that are in a "Down" or "Warning" state

Email Messages

C

CONTACT_XXX variables refer to a contact linked to an account in your Sonar instance. In other words, this means a customer.

Variable

What It Displays

Where It's Accessible

*|COMPANY_NAME|*

 Company name

Email Messages, Mass Email

*|CONTACT_EMAIL_ADDRESS|*

 Contact email address

Email Messages

*|CONTACT_NAME|*

 Contact name

Agreement Templates, Email Messages, Mass Email

*|CONTACT_ROLE|*

 Contact role

Email Messages

*|AGREEMENT_SIGNING_URL|*

URL to sign agreement

Email Messages

*|CUSTOM_MESSAGE|*

Custom message (for example, agreements, invoices)

Email Messages

*|CUSTOMER_PORTAL_URL|*

 Customer portal URL

Email Messages

*|IF:CUSTOMER_PORTAL_URL|*

CONDITION: If the customer portal is enabled in the instance

Email Messages

D

Variable

What It Displays

Where It's Accessible

*|DATE|*

 Date

Agreement Templates

E

Variable

What It Displays

Where It's Accessible

*|EXPIRING_SERVICE_LIST|*

Expiring service list

Agreement Templates

*|EXPIRING_SERVICE_LIST_WITH_PRICES|*

Expiring service list with prices

Agreement Templates

F

Variable

What It Displays

Where It's Accessible

*|FLAPPING|*

Inventory items that are flapping

Email Messages

*|FNAME|*

 First name

Agreement Templates, Mass Email

G

Variable

What It Displays

Where It's Accessible

*|GOOD_ITEMS|*

Inventory items that are healthy (in a "Good" state)

Email Messages

I

Variable

What It Displays

Where It's Accessible

*|INSTANCE_URL|*

 Instance URL

Email Messages

*|INVOICE_DUE_DATE|*

 Invoice due date

Email Messages

*|INVOICE_NUMBER|*

 Invoice number

Email Messages

J

Variable

What It Displays

Where It's Accessible

*|JOB_SCHEDULED_DATETIME|*

 Job scheduled date and time

Email Messages

*|JOB_TYPE|*

 Job type

Email Messages

L

Variable

What It Displays

Where It's Accessible

*|LAST_4_DIGITS|*

 Last 4 digits of payment method

Email Messages

*|LATE_FEE_AMOUNT|*

 Late fee amount

Email Messages

*|LATE_FEE_AMOUNT_RAW|*

 Unformatted late fee amount

Email Messages

*|LNAME|*

 Last name

Agreement Templates, Mass Email

N

Variable

What It Displays

Where It's Accessible

*|NEXT_BILL_DATE|*

 Next bill date

Email Messages

P

Variable

What It Displays

Where It's Accessible

*|PASSWORD_CREATION_TOKEN|*

 Password creation token

Email Messages

*|PASSWORD_RESET_TOKEN|*

 Password reset token

Email Messages

*|PHYSICAL_ADDRESS|*

 Physical address

Canned Replies

R

Variable

What It Displays

Where It's Accessible

*|RECURRING_SERVICE_LIST|*

 Recurring service list

Agreement Templates

*|RECURRING_SERVICE_LIST_WITH_PRICES|*

 Recurring service list with prices

Agreement Templates

S

Variable

What It Displays

Where It's Accessible

*|STILL_FLAPPING|*

Inventory items that are still flapping

Email Messages

T

Variable

What It Displays

Where It's Accessible

*|TOTAL_AMOUNT_DUE_PRIOR_INCLUDING_THIS_INVOICE|*

 Total amount due prior to and including this invoice

Email Messages

*|TOTAL_AMOUNT_DUE_PRIOR_INCLUDING_THIS_INVOICE_RAW|*

 Unformatted total amount due prior to and including this invoice

Email Messages

U

USER_XXX variables refer to a user in your Sonar instance found under Settings > Security > Users. In other words, this means an employee user.

Variable

What It Displays

Where It's Accessible

*|USAGE_CAP_IN_GIGABYTES|*

 Usage cap in gigabytes

Canned Replies

*|USAGE_IN_GIGABYTES|*

 Usage in gigabytes

Canned Replies

*|USER_EMAIL_ADDRESS|*

 User email address

Email Messages

*|USER_IS_SUPER_ADMIN|*

 User is a super admin

Email Messages

*|USER_LANGUAGE|*

 User language

Email Messages

*|USER_MOBILE_NUMBER|*

 User mobile phone number

Email Messages

*|USER_REAL_NAME|*

 User real name

Email Messages

*|USER_ROLE_ID|*

 User role ID

Email Messages

*|USER_USERNAME|*

 User username

Email Messages

How did we do?

Communications: Messages Overview

Message Categories: Overview & Use Cases

Contact