Enrollment File

An enrollment file is a file that is generated on a schedule and delivered to the client via their chosen method.

Variables

Field	Description
account_number1	Account Number 1
account_number2	Account Number 2
auth_first_name	Authorizing First Name
auth_last_name	Authorizing Last Name
auth_middle_name	Authorizing Middle Name
auth_relationship	Authorizing Relationship
bill_first_name	Billing First Name
bill_last_name	Billing Last Name
bill_middle_name	Billing Middle Name
billing_address1	Billing Address 1
billing_address2	Billing Address 2
billing_city	Billing City
billing_country	Billing Country
billing_county	Billing County
billing_state	Billing State/Province
billing_zip	Billing Zip/Postal Code
brand_name	Brand Name
btn	Billing Telephone Number
channel	Channel
commodity	Commodity
company_name	Billing/Service Company (if commercial)
confirmation_code	Record Identifier
contracts	All generated contracts seperated by a | character
photos	All generated photos seperated by a | character
signature_page	Signature Page link
disposition_label	Brand specified disposition ID/Label
disposition_reason	Disposition Reason
dnis	Dialed Number
email_address	Customer Email Address
event_created_at	Record Creation Date
external_rate_id	Internal rate identifier provided by Brand
eztpv_initiated	Originated from EZTPV (1 = Y, 0 = N)
fail_reason	Fail Reason (optional)
interaction_time	Record time to complete
interaction_type	Interaction type (ie: call_inbound, call_outbound, eztpv, etc.)
language	Language the interaction was performed
market	Residential or Commercial
name_key	Utility specific identifier (optional)
office_label	Office label provided by Brand
office_name	Office Name
pass_fail	Record was pass or fail (1 = Pass, 0 = Fail)
product_admin_fee	Product Admin Fee
product_cancellation_fee	Product Cancellation Fee
product_daily_fee	Product Daily Fee
product_green_percentage	Product Green Percentage
product_intro_term	Product Intro Term
product_monthly_fee	Product Monthly Fee
product_name	Product Name
product_rate_amount	Rate Amount
product_rate_amount_currency	Rate Amount Currency
product_rate_type	Rate Type (fixed, variable, tiered, etc.)
product_service_fee	Product Service Fee
product_term	Product Term
product_term_type	Product Term Type (day, week, month, year)
product_time	If multiple products during a single interaction, interaction_time / total products
product_utility_external_id	Utility identifier provided by Brand
product_utility_name	Utility Name
rate_channel_source	Channel Source (optional)
rate_external_id	Rate identifier provided by Brand
rate_program_code	Rate identifier
rate_promo_code	Rate Promotion Code (optional)
rate_renewal_plan	Renewal Plan (optional)
rate_source_code	Rate Source Code (optional)
rate_uom	Rate UOM (therm, kwh, ccf, mwhs, gj, etc.)
recording	Recording(s) associated with the TPV record
result	Result of the interaction (Good Sale, No Sale, or Closed)
sales_agent_name	Sales Agent Name
sales_agent_rep_id	Sales Agent Identifier
service_address1	Service Address 1
service_address2	Service Address 2
service_city	Service City
service_country	Service Country
service_county	Service County
service_state	Service State/Province
service_zip	Service Zip/Postal Code
source	Originating interaction (ie: call_inbound, call_outbound, eztpv, etc.)
structure_type	Structure Type (Single, Multi-Family, Apartment, etc.)
tpv_agent_name	TPV Agent Name
utility_commodity_external_id	Commodity identifier provided by brand
utility_commodity_ldc_code	Utility LDC identifier provided by brand
vendor_label	Vendor identifier
vendor_name	Vendor Name
dob	Date of Birth
ani	ANI/Caller ID
promo_code	Promotion Code
promo_name	Promotion Name
promo_text	Promotion Description
promo_type	Promotion Type
promo_key	Promotion Key
promo_reward	Promotion Reward

Standard Enrollment File

[
    {
        "field": "event_created_at",
        "type": "date",
        "format": "m/d/Y",
        "required": true,
        "header": "Created Date"
    },
    {
        "field": "eztpv_initiated",
        "header": "EZTPV"
    },
    {
        "field": "language",
        "header": "Language"
    },
    {
        "field": "channel",
        "header": "Channel"
    },
    {
        "field": "confirmation_code",
        "header": "Confirmation Code"
    },
    {
        "field": "result",
        "header": "Result"
    },
    {
        "field": "interaction_type",
        "header": "Interaction Type"
    },
    {
        "field": "disposition_label",
        "header": "Disposition ID"
    },
    {
        "field": "disposition_reason",
        "header": "Disposition"
    },
    {
        "field": "source",
        "header": "Source"
    },
    {
        "field": "brand_name",
        "header": "Brand"
    },
    {
        "field": "vendor_label",
        "header": "Vendor Label"
    },
    {
        "field": "vendor_name",
        "header": "Vendor"
    },
    {
        "field": "office_label",
        "header": "Office Label"
    },
    {
        "field": "office_name",
        "header": "Office Name"
    },
    {
        "field": "market",
        "header": "Market"
    },
    {
        "field": "commodity",
        "header": "Commodity"
    },
    {
        "field": "utility_commodity_ldc_code",
        "header": "Utility Commodity LDC Code"
    },
    {
        "field": "utility_commodity_external_id",
        "header": "Utility Commodity External ID"
    },
    {
        "field": "sales_agent_name",
        "header": "Sales Agent Name"
    },
    {
        "field": "sales_agent_rep_id",
        "header": "Sales Agent Rep ID"
    },
    {
        "field": "tpv_agent_name",
        "header": "TPV Agent Name"
    },
    {
        "field": "dnis",
        "header": "DNIS"
    },
    {
        "field": "structure_type",
        "header": "Structure Type"
    },
    {
        "field": "company_name",
        "header": "Company"
    },
    {
        "field": "bill_first_name",
        "header": "Billing First Name"
    },
    {
        "field": "bill_middle_name",
        "header": "Billing Middle Name"
    },
    {
        "field": "bill_last_name",
        "header": "Billing Last Name"
    },
    {
        "field": "auth_first_name",
        "header": "Auth First Name"
    },
    {
        "field": "auth_middle_name",
        "header": "Auth Middle Name"
    },
    {
        "field": "auth_last_name",
        "header": "Auth Last Name"
    },
    {
        "field": "auth_relationship",
        "header": "Auth Relationship"
    },
    {
        "field": "btn",
        "header": "Billing Telephone Number"
    },
    {
        "field": "email_address",
        "header": "Email Address"
    },
    {
        "field": "billing_address1",
        "header": "Billing Address"
    },
    {
        "field": "billing_address2",
        "header": "Billing Address 2"
    },
    {
        "field": "billing_city",
        "header": "Billing City"
    },
    {
        "field": "billing_state",
        "header": "Billing State"
    },
    {
        "field": "billing_zip",
        "header": "Billing Zip"
    },
    {
        "field": "billing_county",
        "header": "Billing County"
    },
    {
        "field": "billing_country",
        "header": "Billing Country"
    },
    {
        "field": "service_address1",
        "header": "Service Address"
    },
    {
        "field": "service_address2",
        "header": "Service Address 2"
    },
    {
        "field": "service_city",
        "header": "Service City"
    },
    {
        "field": "service_state",
        "header": "Service State"
    },
    {
        "field": "service_zip",
        "header": "Service Zip"
    },
    {
        "field": "service_county",
        "header": "Service County"
    },
    {
        "field": "service_country",
        "header": "Service Country"
    },
    {
        "field": "rate_program_code",
        "header": "Rate Program Code"
    },
    {
        "field": "rate_uom",
        "header": "Rate UOM"
    },
    {
        "field": "rate_source_code",
        "header": "Rate Source Code"
    },
    {
        "field": "rate_promo_code",
        "header": "Rate Promo Code"
    },
    {
        "field": "rate_external_id",
        "header": "Rate External ID"
    },
    {
        "field": "rate_renewal_plan",
        "header": "Rate Renewal Plan"
    },
    {
        "field": "rate_channel_source",
        "header": "Rate Channel Source"
    },
    {
        "field": "product_name",
        "header": "Product Name"
    },
    {
        "field": "product_rate_type",
        "header": "Product Rate Type"
    },
    {
        "field": "external_rate_id",
        "header": "External Rate ID"
    },
    {
        "field": "product_term",
        "header": "Product Term"
    },
    {
        "field": "product_term_type",
        "header": "Product Term Type"
    },
    {
        "field": "product_intro_term",
        "header": "Product Intro Term"
    },
    {
        "field": "product_daily_fee",
        "header": "Product Daily Fee"
    },
    {
        "field": "product_service_fee",
        "header": "Product Service Fee"
    },
    {
        "field": "product_rate_amount",
        "header": "Product Rate Amount"
    },
    {
        "field": "product_rate_amount_currency",
        "header": "Product Rate Amount Currency"
    },
    {
        "field": "product_green_percentage",
        "header": "Product Green Percentage"
    },
    {
        "field": "product_cancellation_fee",
        "header": "Product Cancellation Fee"
    },
    {
        "field": "product_admin_fee",
        "header": "Product Admin Fee"
    },
    {
        "field": "transaction_fee",
        "header": "Product Transaction Fee"
    },
    {
        "field": "product_utility_name",
        "header": "Product Utility Name"
    },
    {
        "field": "product_utility_external_id",
        "header": "Product Utility External ID"
    },
    {
        "field": "account_number1",
        "header": "Account Number 1"
    },
    {
        "field": "account_number2",
        "header": "Account Number 2"
    },
    {
        "field": "name_key",
        "header": "Name Key"
    },
    {
        "field": "pass_fail",
        "header": "Pass/Fail"
    },
    {
        "field": "recording",
        "header": "Recording"
    },
    {
        "field": "contracts",
        "header": "Contracts"
    },
    {
        "field": "photos",
        "header": "Photos"
    },
    {
        "field": "signature_page",
        "header": "Signature Page"
    },
    {
        "field": "fail_reason",
        "header": "Fail Reason"
    },
    {
        "field": "interaction_time",
        "header": "Interaction Time"
    },
    {
        "field": "product_time",
        "header": "Product Time"
    },
    {
        "field": "product_monthly_fee",
        "header": "Product Monthly Fee"
    }
]

Formatting

Basic

Additional options:

* uppercase - boolean true or false (default: false)

    {
        "field": "product_monthly_fee",
        "header": "Field Header"
    }

Dates

Format a date in their preferred manner. A date must be categorized with a "type": "date".

Additional options:

* format - the format of the date (default is Y-m-d h:i:s A)
* add_days - the number of days to add to the `field` date.

    {
        "field": "event_created_at",
        "type": "date",
        "format": "m/d/Y",
        "add_days": 7,
        "header": "Field Header"
    }

Conditional

In cases where the value should be presented differently than our standard.

    {
        "field": "conditional",
        "header": {
            "case": "source",
            "when": "live",
            "then": "V",
            "when2": "EZTPV",
            "then2": "V2",
            "when3": "Telesales",
            "then3": "V3",
            "else": "eztpv",
            "as": "N"
        }
    }

Blank/Empty field

In some cases, the brand may have a blank/optional field/column.

    {
        "field": "blank",
        "header": "Field Header"
    }

Static Content

In some cases, the brand may want something to be the same every time in a field/column.

Additional options:

* htmlentities - Convert special characters to their html entity equivalent

    {
        "field": "static",
        "value": "N",
        "htmlentities": true,
        "header": "Field Header"
    }

Contracts

In the case where multiple contracts are available, they will be separated with a pipe (|).

Additional options:

* with_cdn: true|false - whether to include a full url (default is file only)

    {
        "field": "contracts",
        "with_cdn": true,
        "header": "Field Header"
    }

Recordings

In the case where multiple recordings are available, they will be separated with a pipe (|).

Additional options:

* with_cdn: true|false - whether to include a full url (default is file only)

    {
        "field": "recording",
        "with_cdn": true,
        "header": "Field Header"
    }

Phone / BTN

In some cases, the phone/btn may need to strip the initial +1.

    {
        "field": "btn",
        "tendigit": true,
        "header": "Field Header"
    }

Custom Fields

If the brand utilizes custom fields/questions, the value can be retrieved by specifying the custom field name (from the editor/UI) into "custom_field": "shirt_size".

    {
        "field": "custom_fields",
        "header": "Field Header",
        "custom_field": "shirt_size"
    }

Parse (Advanced)

In special cases, we may need to parse a value out of a specified field. The specified parse_field will be matched based upon parse_regex. In the below case, "parse_success": 2 was meant to grab the 2nd match vs. "parse_failure": 1 the 1st match.

    {
        "field": "parse",
        "parse_field": "rate_source_code",
        "parse_regex": "w*_BR",
        "parse_success": 2,
        "parse_failure": 1,
        "header": "Field Header"
    }