Variables available for scripts

Available Lookup Variables

Tags:

  • localized : this tag symbolizes the content depends on the call language

  • editable : this tag symbolizes that this information is not read only

  • multi-fuel : this tag symbolizes that the information can represent one of the fuel types and must be postfixed with the fuel name like rate.amount.electric. Please note that this option is ONLY available during a disclosure loop with a dual fuel product.

TPV Agent Information
  • agent.name - First and Last name combined
  • agent.first_name
  • agent.last_name
  • agent.tpv_id
Account Information
  • account.type
  • account.bill_name - the complete bill name
  • account.bill_is_service boolean - is the billing address the same as the service address
  • account.bill_address editable
  • account.company_name
  • account.service_address editable
  • account.state
  • account.number_location
  • account.address_table
  • account.number editable

Also supports directly referencing specific identifiers AND determining if they are relevant for this account. This feature will only work during an Product typed loop as it requires direct access to the product information. This supports any identifier type supported by the platform as long as the names don't conflict.

To get the identifier labelled "Meter Number" you would use account.number.meter_number. The name conversion rules are simple: discard anything that isn't the letters a to z or a space, replace all spaces with underscores and make all letters lowercase. So ESI ID would become account.number.esi_id.

To test if a given identifier is relevant to the account simply check if the value returned is FALSE. If the returned value is false then it is not required or available for the current account. Any other value is the prior entry or indicates a value is needed.

Call Information

Only accessible during a live call.

  • call.from - the (formatted) phone number the caller called from
  • call.from_raw - the (unformatted) phone number the caller called from
  • call.to - the (formatted) phone number the caller called into
  • call.to_raw - the (unformatted) phone number the caller called into
Client Information
  • client.name
  • client.legal_name
  • client.service_phone
  • client.vendor - Vendor Name
  • client.vendor_label
  • client.vendor_code
  • client.grp_id
Date and Time - Localized to call language
  • date localized
  • time localized

  • Defaults to Eastern Time, also supports timezone selection by specifying the desired defined timezone, ex: Central US would be time.America/Chicago, Mountain Time would be time.America/Denver and Pacific Time would be time.America/Los_Angeles Full List of Timezones

  • day - the day number of the month

  • next-month - the next month in the format YYYY-MM-DD
Event Information
  • event.confirmation - the confirmation code
  • event.channel
  • event.market
  • event.is_ez - returns "y" or "n"
  • event.is_eztpv - returns true or false
  • event.contract_delivery
  • event.id_provided - returns true or false
  • event.id_type
  • event.id_name
  • event.id_number
  • event.id_state
  • event.lead_type
  • event.enrollment_intent
  • event.deposit_required
Product Information
  • product.green_percentage multi-fuel
  • product.name multi-fuel
  • product.service_fee multi-fuel
  • product.intro_service_fee multi-fuel
  • product.amount multi-fuel (use amount_raw for the unformmated version)
  • product.amount_in_cents multi-fuel (should use product.amount in most cases)
  • product.intro_amount multi-fuel (use intro_amount_raw for the unformmated version)
  • product.fuel multi-fuel localized
  • product.currency multi-fuel localized
  • product.uom multi-fuel localized
  • product.product_promo_code multi-fuel
  • product.rate_promo_code multi-fuel
  • product.term multi-fuel
  • product.term_type localized (use term_type_raw for comparisons)
  • product.intro_term multi-fuel
  • product.intro_term_type localized (use intro_term_type_raw for comparisons)
  • product.type multi-fuel
  • product.cancellation_fee multi-fuel
  • product.cancellation_fee_type multi-fuel one of: daily, weekly, monthly, yearly or one-time
  • product.intro_cancellation_fee multi-fuel
  • product.daily_fee multi-fuel
  • product.intro_daily_fee multi-fuel
  • product.has_promo multi-fuel (returns true or false)
  • product.has_rate_scripting multi-fuel (returns true or false)
  • product.has_rescission_scripting multi-fuel (returns true or false)
  • product.promo_code multi-fuel
  • product.promo_name multi-fuel
  • product.promo_text multi-fuel
  • product.promo_type multi-fuel
  • product.promo_key multi-fuel
  • product.promo_reward multi-fuel
  • product.start_month multi-fuel
  • product.custom_data_1 multi-fuel
  • product.custom_data_2 multi-fuel
  • product.custom_data_3 multi-fuel
  • product.custom_data_4 multi-fuel
  • product.custom_data_5 multi-fuel
  • product.program_code multi-fuel
  • product.currency localized multi-fuel
  • product.remaining_term multi-fuel
  • product.admin_fee multi-fuel
  • product.monthly_fee multi-fuel
  • product.transaction_fee multi-fuel
  • product.transaction_fee_currency multi-fuel
  • product.prepaid multi-fuel
  • product.enroll_date multi-fuel
  • product.end_date multi-fuel
  • product.time_of_use multi-fuel (returns true or false) Does the rate vary based on the time of day
  • product.has_time_of_use_rates multi-fuel (return true or false) Are rates available for the times of day
  • product.time_of_use_rates multi-fuel returns all time of use rates defined in the format: {period}: {rate}, {period}: {rate} etc
  • product.estimated_total_cost multi-fuel default estimate is 500 units, to specify units use form product.estimated_total_cost.1000, when specifying gas or electric they must be in the form: product.estimated_total_cost.gas.1000 for 1000 units. The formula for the calculation is: ((rateAmount * level) + monthlyFee)
  • product.estimated_total_cost_x100 exactly the same as estimated_total_cost but multiplies the final value by 100
  • product.intro_estimated_total_cost multi-fuel default estimate is 500 units, to specify units use form product.intro_estimated_total_cost.1000, when specifying gas or electric they must be in the form: product.introestimated_total_cost.gas.1000 for 1000 units. The formula for the calculation is: ((introRateAmount * level) + monthlyFee)
  • product.intro_estimated_total_cost_x100 exactly the same as intro_estimated_total_cost but multiplies the final value by 100
  • product.estimated_cost multi-fuel default estimate is 500 units, to specify units use form product.estimated_cost.1000, when specifying gas or electric they must be in the form: product.estimated_cost.gas.1000 for 1000 units. The formula for the calculation is: (((rateAmount * level) + monthlyFee) / level)
  • product.estimated_cost_x100 exactly the same as estimated_cost but multiplies the final value by 100
User Information
  • user . name - All three parts of the name combined. editable
  • user.first_name editable
  • user.last_name editable
  • user.relationship editable
  • user.phone editable
  • user.email editable
  • user.birthdate editable
  • user.request_dob -- Is true if the client has requested DOB collection in this state
  • user.credit_prequalified -- Only in Agents Is true if the client uses Leads and this account has been prequalified
  • user.lead_id -- Only in Agents Is set if a lead was used
  • user.lead_campaign -- Only in Agents Is set if a lead was used
  • user.lead_type -- Only in Agents Is set if a lead was used, one of: blacklist, onlist or offlist (value if lead was not used is offlist)
Utility Information
  • utility . name multi-fuel
  • utility.customer_service multi-fuel
  • utility.discount_program multi-fuel
  • utility.disclosure_document multi-fuel
  • utility.monthly_fee multi-fuel
  • utility.rate_addendum multi-fuel
Sales Agent Information (only editable for HRTPV)
  • sales_agent.name
  • sales_agent.first_name editable
  • sales_agent.last_name editable
  • sales_agent.phone editable
  • sales_agent.email editable
  • sales_agent.employer
  • sales_agent.employer_id
  • sales_agent.tsr_id editable
  • sales_agent.dob editable
  • sales_agent.ssn editable
  • sales_agent.address editable
  • sales_agent.city editable
  • sales_agent.state editable
  • sales_agent.zip editable