Table of Contents

Email Variables & Conditions

Morgan Wynnes Updated by Morgan Wynnes

Read Time: 5 mins

Use the Table of Contents (to the right) to quickly navigate to the section you are looking for.

Below are all of the available variables that can be used to display data within various areas of Sonar, or that can be used as part of a conditional statement. It is important to note that the variables that will be available to you will depend on where in Sonar you are accessing them from. For example, the variables available when creating a contract template will differ from the ones available when creating an email message for a particular trigger.

The Variables menu (highlighted below) will not be visible from within the Create Email Message Content window until the "Email Triggers" field has been filled out. Once an email trigger has been defined, the menu will appear and contain any variables available for use in the email body.
There is currently an issue with the formatting of variables not being preserved when copying/pasting variables into the text editor, causing them to not trigger properly. Expand the section below for detailed steps on the workaround available.
Temporary Workaround for Preserving Variables When Pasting into the Editor
Until the abovementioned issue is resolved, steps are provided below to preserve variable formatting when pasting content into the text editor; the workaround involves using 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

Contract Templates

*|ACCOUNT_NAME|*

 Account name

Canned Replies, Contract Templates, Email Messages

*|ACCOUNT_NUMBER|*

 Account number

Canned Replies, Contract 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 are referring to a contact attached to an account within your Sonar instance (i.e. 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

Contract Templates, Email Messages, Mass Email

*|CONTACT_ROLE|*

 Contact role

Email Messages

*|CONTRACT_SIGNING_URL|*

URL to sign contract

Email Messages

*|CUSTOM_MESSAGE|*

Custom message (i.e. contracts, 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

Contract Templates

E

Variable

What It Displays

Where It's Accessible

*|EXPIRING_SERVICE_LIST|*

Expiring service list

Contract Templates

*|EXPIRING_SERVICE_LIST_WITH_PRICES|*

Expiring service list with prices

Contract Templates

F

Variable

What It Displays

Where It's Accessible

*|FLAPPING|*

Inventory items that are flapping

Email Messages

*|FNAME|*

 First name

Contract 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

Contract 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

Contract Templates

*|RECURRING_SERVICE_LIST_WITH_PRICES|*

 Recurring service list with prices

Contract 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 are referring to a Sonar instance user, who would be located under Settings > Security > Users within your instance (i.e. an employee).

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?

Email Categories: Overview & Use Cases

Trigger Explanations

Contact