Search



3) Field Names to Use in DocuSign

SUPPORT

Integrations Guide

By creating fields on your DocuSign contract templates with specific Field Names, SecurityTrax will fill the eContract with the applicable data for you. Listed below are available Field Names, their Definitions and a Sample (where applicable) of what would actually display on a contract if a particular Field Name were used.






SecurityTrax 'Field Names' For Use in DocuSign

Instructions on how to use these Field Names on your DocuSign templates can be found in the steps on the next page. It's not necessary to use all of the Field Names below. (The 'ITEM' is only for reference and isn't used on your templates.)

Note that while in DocuSign you don't have to create custom fields, simply use the 'text' field found in DocuSign. Additionally, if you need a specific Field Name that isn't available below, please create a SecurityTrax Ticket and provide details.






Customer Contact Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1a

ST_CustomerName

Customer's first and last name (will be combined on one line)

2a

ST_CustomerFirstName

Customer's first name only

3a

ST_CustomerLastName

Customer's last name only

4a

ST_Birthdate

Main Customer's birthdate

MM/DD/YYYY

5a

ST_Spouse

Spouse's name of the main Customer

6a

ST_BusinessName

Used when the Customer account is a business

7a

ST_CustomerStreetAddress

Customer's street address (will be combined on one line)

8a

ST_CustomerCity

City in which Customer is located

9a

ST_CustomerState

State in which Customer is located

10a

ST_CustomerZip

Customer's zip code

11a

ST_CustomerFullAddress

Customer's full street address, city, state, zip code (will be placed on one line).

12a

ST_HomePhone

Customer's home phone number

13a

ST_BusinessPhone

Customer's business phone number

14a

ST_CustomerPhone1

Customer's main phone number

15a

ST_CustomerPhone2

Customer's cell phone number

16a

ST_CustomerEmailAddress

Customer's email address

17a

ST_LeadHomeOwnership

Does the lead own their home

Own, Rent, Lease, Other



Customer Account Details Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1b

ST_MonitoringAccountNumber

The Customer account number for the Central Station

2b

ST_ADCCustomerID

The Alarm.com ID for the Customer

3b

ST_ContractType

Type of contract

Residential or Commercial

4b

ST_IsCommercial

Used on a commercial job

Yes or No

5b

ST_IsResidential

Used on a residential job

Yes or No

6b

ST_TimeZone

Time zone of installation

7b

ST_MonthlyPayment

Total amount owed by the Customer per month

8b

ST_ContractTerm

Duration of contract period in months

9b

ST_TermTotal

Monthly payment multiplied by the total number of months of the contract

10b

ST_WarrantyName

The warranty term selected for the Customer

11b

ST_SaleDate

The Sales Date found on the Customer Record under Sale Information.

12b

ST_SalesRepNumber

A number associated with the SecurityTrax User who is the Sales Rep for the Customer

13b

ST_SalesRepName

The name of the SecurityTrax User who is the Sales Rep for the Customer

14b

ST_InstallTechName

The name of the SecurityTrax User who is the Technician that will be installing the equipment for the Customer

15b

ST_IsPrewire

Used if the job is a prewire

Yes or No

16b

ST_IsWireless

Used if the job is wireless

Yes or No

17b

ST_ConfirmationCode

Confirmation number provided by the Central Station when the panel first communicates with the Central Station

18b

ST_CrossStreet

The cross street for the Customer

19b

ST_EstimatedStartDate

Estimated start date for installation

20b

ST_EstimatedCompletionDate

Estimated installation completion date

21b

ST_DiscountAffiliateName

The discount affiliate name

AAA, AARP, & Farm Bureau

22b

ST_DiscountAffiliateMemberNumber

The member number of the discount affiliate

23b

ST_CustomerID

The ID given to a Customer by your copy of SecurityTrax

24b

ST_MonitoringPlan

Values found in the Monitoring Plan drop down menu on the Customer Record. Note: The values found in this drop down must be added by a SecurityTrax developer.

25b

ST_InteractiveServicesProviders

Values found in the Interactive Services Providers drop down menu on the Customer Record



Customer Account Features Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1c

ST_IsTwoWayVoice

Found at the bottom of the Customer Record screen as a checkbox in the Service section

true or false

2c

ST_IsCellularBackup

Found at the bottom of the Customer Record screen as a checkbox in the Service section

true or false

3c

ST_IsInvestigatorResponse

Found at the bottom of the Customer Record screen as a checkbox in the Service section (Guard Service)

true or false

4c

ST_InvestigatorResponsePrice

The dollar amount from the Guard Fee under the Emergency Contacts on a Customer Record

5c

ST_IsMonthlyProcessingFee

Found at the bottom of the Customer Record screen as a checkbox in the Service section (Invoicing)

true or false



Customer Credit Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1d

ST_SocialSecurityNumber

Masked version of the Customer's SSN

XXX-XX-1111

2d

ST_CustomerLast4SSN

Last four digits of Customer's SSN

1111

3d

ST_CustomerCreditScore

Customer's credit score



Dealer Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1e

ST_DealerNumber

Dealer number

1234567

2e

ST_DealerLicenseNumber

Your dealer license number

3e

ST_DealerInfo

The Dealer company name,
street address,
city, state, and zip code

4e

ST_DealerName

Company name of your dealership

AAA Security

5e

ST_DealerPhone

Main phone number for your dealership

6e

ST_DealerStreetAddress1

Address line 1 of your dealership

7e

ST_DealerStreetAddress2

Address line 2 of your dealership

8e

ST_DealerCity

The city where your dealership is located

9e

ST_DealerState

The state where your dealership is located

10e

ST_DealerZip

The zip code for your dealership

11e

ST_DealerBranchAddress

Dealer city, state, and zip code

12e

ST_SubContractorName1

Company name of the dealership

13e

ST_SubContractor1Address1

Street address of the dealership

14e

ST_SubContractor1Address2

City, state, and zip code of the dealership

15e

ST_SubContractor1Phone

Main phone number for your dealership



Emergency Contact Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1f

ST_PoliceNameAndLocation

Customer's Police station name associated with Police in the Emergency Contacts on a Customer Record

2f

ST_PolicePhone

Phone number for Customer's Police station associated with Police in the Emergency Contacts on a Customer Record

3f

ST_PermitNumber

The permit number associated with Police in the Emergency Contacts on a Customer Record

4f

ST_FireNameAndLocation

Customer's Firestaion name and address in the Emergency Contacts on a Customer Record

5f

ST_FirePhone

Phone number for Customer's Firestation in the Emergency Contacts on a Customer Record

6f

ST_FirePermitNumber

The permit number associated with Fire in the Emergency Contacts on a Customer Record

7f

ST_MedicalAmbulanceName

Customer's hospital name in the Emergency Contacts on a Customer Record

8f

ST_MedicalAmbulancePhone

Customer's hospital phone number in the Emergency Contacts on a Customer Record

9f

ST_InvestigatorResponseName

Customer's Guard name in the Emergency Contacts on a Customer Record

10f

ST_InvestigatorResponsePhone

Customer's Guard phone in the Emergency Contacts on a Customer Record

11f

ST_Password

Customer's abort code for their Central Station

12f

ST_EmergencyContact1

Customer's first emergency contact

13f

ST_EmergencyContact1Phone

Phone number for Customer's first emergency contact

14f

ST_ECP1

Main phone number type for Customer's first emergency contact

15f

ST_EmergencyContact1Email

Email address for Customer's first emergency contact

16f

ST_EmergencyContact2

Customer's second emergency contact

17f

ST_EmergencyContact2Phone

Phone number for Customer's second emergency contact

18f

ST_ECP2

Main phone number type for Customer's second emergency contact

19f

ST_EmergencyContact2Email

Email address for Customer's second emergency contact

20f

ST_EmergencyContact3

Customer's third emergency contact

21f

ST_EmergencyContact3Phone

Phone number for Customer's third emergency contact

22f

ST_ECP3

Main phone number type for Customer's third emergency contact

23f

ST_EmergencyContact3Email

Email address for Customer's third emergency contact

24f

ST_EmergencyContact4

Customer's forth emergency contact

25f

ST_EmergencyContact4Phone

Phone number for Customer's forth emergency contact

26f

ST_ECP4

Main phone number type for Customer's forth emergency contact

27f

ST_EmergencyContact4Email

Email address for Customer's forth emergency contact



Bank Information Field Names

The bank account marked as the default payment will be the one used to populate the fields on your contract.

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1g

ST_BillingBankAccountType

The type of bank account the Customer is using

Checking, Savings, Other

2g

ST_BankAccountBillingFrequency

The billing cycle for the Customer

Monthly, Quarterly, Annually, Semi-Annually

3g

ST_DefaultBillingDayBank

Day of the month the Customer's bank account will be charged

1 thru 31

4g

ST_BankName

Name of the Customer's bank

5g

ST_BankRoutingNumber

Customer's bank routing number

6g

ST_BankAccountNumber

Customer's bank account number

7g

ST_NameOnBankAccount

Name on Customer's bank account

8g

ST_BankCustomerStreetAddress

Street address for Customer's bank

9g

ST_BankCustomerCity

City in which Customer's bank is located

10g

ST_BankCustomerState

State in which Customer's bank is located

11g

ST_BankCustomerZip

Zip code for Customer's bank

12g

ST_IsTotalMonthlyServiceCharges_BankAccount

If Bank Account is the method of payment

true

13g

ST_BankActivationUse

One-time payment thru ACH transfer for the Activation (installation) fee

true or false

14g

ST_BankMonitoringUse

One-time payment thru ACH transfer for Monthly Monitoring fee

true or false

15g

ST_BankServiceUse

One-time payment thru ACH transfer for a Service fee

true or false



Credit Card Field Names

The credit card marked as the default payment will be the one used to populate the fields on your contract.

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1h

ST_CreditCardBillingFrequency

The billing cycle for the Customer

Monthly, Quarterly, Annually, Semi-Annually

2h

ST_DefaultBillingDayCC

Day of the month the Customer's credit card will be charged

3h

ST_CreditCardType

Type of credit card used by Customer

Visa, MasterCard, American Express, Discover, Other

4h

ST_CreditCardNumber

Customer's credit card number

5h

ST_CreditCardExpiration

Expiration date of Customer's credit card

6h

ST_CreditCardHolderName

Customer name on credit card

7h

ST_CreditCardCustomerStreetAddress

Street address for Customer's credit card

8h

ST_CreditCardCustomerCity

City in which Customer's credit card company is located

9h

ST_CreditCardCustomerState

State in which Customer's credit card company is located

10h

ST_CreditCardCustomerZip

Zip code for Customer's credit card company

11h

ST_IsTotalMonthlyServiceCharges_CreditCard

If Credit Card is the method of payment

true

12h

ST_CreditCardActivationUse

One-time payment with a credit card for the Activation (installation) fee

true or false

13h

ST_CreditCardMonitoringUse

One-time payment with a credit card for a Monthly Monitoring

true or false

14h

ST_CreditCardServiceUse

One-time payment with a credit card for a Service fee

true or false



Payment Detail Field Names

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1i

ST_PaymentType

How Customer will be paying on a monthly basis

Credit Card, Bank Account, or Invoicing

2i

ST_PaymentWithdrawlDate

Monthly date payment will be withdrawn from Customer's bank account

3i

ST_InvoiceBillingFrequency

The billing cycle for the Customer

Monthly, Quarterly, Annually, Semi-Annually

4i

ST_TaxRate

Tax rate charged to the Customer

5i

ST_DefaultBillingNickname

Information placed in the Nickname field of the Customer or entity being billed for the Default Billing Method

6i

ST_DefaultBillingNote

Information placed in the Note field of the Customer or entity being billed for the Default Billing Method

7i

ST_DefaultBillingAddress

Street Address of the Customer or entity being billed for the Default Billing Method

8i

ST_DefaultBillingCity

City of the Customer or entity being billed for the Default Billing Method

9i

ST_DefaultBillingState

State in which the Customer or entity being billed is located for the Default Billing Method

10i

ST_DefaultBillingZip

Zip Code in which the Customer or entity being billed is locagted for the Default Billing Method



Invoice Line Item Field Names

Invoice Line Items can be pushed directly to your DocuSign contract templates using Field Names in this section. SecurityTrax will use the latest invoice. Meaning, the latest invoice should represent what is wanted on the contract. However, customizations are available. Please submit details of your use case in a SecurityTrax Ticket.

Items 1j through 8j would typically be used for one Invoice Line Item, though it's not required.

Change '01' in the Field Name to '02','03' and so on for each invoice line item. SecurityTrax will search for these Field Names and consolidate the line items into one. (For example, if the latest invoice shows six door sensors, all six sensors will be consolidated onto one line item as opposed to being listed six diffent times on the contract). There is a limit of 20 total line items which are used for consolidation.

DocuSign provides formulas in their templates for all calculations.

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1j

ST_InvoiceLineItemProdCode01

Value from the Item column on the invoice

2j

ST_InvoiceLineItemQty01

Quantity of Equipment selected

3j

ST_InvoiceLineItemDescription01

Value from the Description column on the invoice

4j

ST_InvoiceLineItemCost01

Price the Customer will pay for the line item

5j

ST_InvoiceLineItemUnitCost01

Price the Customer will pay per piece of Equipment

6j

ST_InvoiceLineItemSalesTaxRate01

Sales tax percentage

7j

ST_InvoiceLineItemSalesTaxAmount01

Amount charged to the Customer for sales tax for the line item

8j

ST_InvoiceLineItemTotalAmount01

Total price for a line item including Equipment and sales tax

9j

ST_InvoiceTotalTaxAmount

Calculates the total of all sales tax

10j

ST_InvoiceTotalAmount

Calculates the total of all equipment and sales tax



Equipment Field Names

Items 1k through 9k would typically be used for one piece of equipment, though it's not required.

Change '02' in the Field Name to '03','04' and so on for each piece of equipment. SecurityTrax will search for these Field Names and consolidate your equipment into them. (For example, if a Customer purchases six door sensors all six sensors will be consolidated onto one line item as opposed to being listed six different times on the contract).

DocuSign provides formulas in their templates for all calculations.

NOTE: '02' in the Field Name signifies the first piece of equipment. 'ST_EqCost01' is reserved for the Activation Fee so that it can be listed as a piece of equipment if desired.

ITEM

SECURITYTRAX FIELD NAME

DEFINITION

SAMPLE (where applicable)

1k

ST_EqProdCode02

Model field from the equipment screen

2k

ST_EqQty02

Quantity of equipment selected

3k

ST_EqDescription02

Name field from the equipment screen

4k

ST_EqCost02

Charge to the Customer for the piece of equipment. This will include the total for like pieces of equipment when combined on the DocuSign template.

5k

ST_EqUnitCost02

Charge to the Customer for the individual piece of equipment.

6k

ST_TotalEquipmentCharge

Total retail price that the customer will be paying for the equipment.

7k

ST_EqZone02

This pulls in the zone name for a given piece of equipment.

8k

ST_EqZoneNumber02

This pulls in the zone number for a given piece of equipment.

9k

ST_EqWireType02

This provides the wire type for a given piece of equipment (existing, hardwire, pre-wired, wireless)