configuration.i

<?php
/* File: configuration.php
 * Purpose: contains arrays of literals for labels and for defining automatic adds.
 */

/**
 * function GetWorkflowOptions()
 * Gets the options for the workflow dropdownlist.
 * Instead of numbers, use strings for clarity.
 * If workflow is not appropriate for the product/line item, then the value is "none."
 */
function GetWorkflowOptions() {

    return array (
        array("text" => "Create Job", "value" => "create"),
        array("text" => "Associate Existing Job...", "value" => "associate"),
        array("text" => "Bill Without Job", "value" => "without")
    );
}

/**
 * function GetMonthOptions()
 * Gets a list of months for the frequency dropdownlist.
 * Value corresponds to the bit to set in the bills on field.
 */
function GetMonthOptions() {
    return array(
        array("value" => 0,  "text" => "January"),
        array("value" => 1,  "text" => "February"),
        array("value" => 2,  "text" => "March"),
        array("value" => 3,  "text" => "April"),
        array("value" => 4,  "text" => "May"),
        array("value" => 5,  "text" => "June"),
        array("value" => 6,  "text" => "July"),
        array("value" => 7,  "text" => "August"),
        array("value" => 8,  "text" => "September"),
        array("value" => 9,  "text" => "October"),
        array("value" => 10, "text" => "November"),
        array("value" => 11, "text" => "December")
    );
}

/**
 * function GetFrequencyOptions()
 * Gets the options for the frequency dropdownlist.
 */
function GetFrequencyOptions() {
    return array(
        array("value" => 0, "text" => "Monthly"),
        array("value" => 1, "text" => "Semiyearly"),
        array("value" => 2, "text" => "Yearly")
    );
}

/**
 * function GetBillingItems()
 * This list is the sales items from the Accounting system and a description that could make more sense.
 * ***** NOTE: "Timetrack" doesn't actually refer to a billing item in QB.
 * During processing, there will be items for Elaine, Jayme, etc. for the billing and rush hours.
 */
function GetBillingItems() {
    return array(  "Android" => "Android App Monthly Fee",
                    "AndroidSetup" => "Android App Setup Fee",
                    "CkImaging" => "Check Imaging Monthly Fee",
                    "CkSetup" => "Check Imaging Setup Fee",
                    "E2stmnt" => "E-Statements Tier Two",
                    "E3stmnt" => "E-Statements Tier Three",
                    "Email" => "Email Account",
                    "Estmnt" => "E-Statements Tier One",
                    "HBBatch" => "Home Banking Batch Monthly Fee",
                    "HBBatchSetup" => "Home Banking Batch Setup Fee",
                    "HBLive" => "Home Banking Live Monthly Fee",
                    "HBLiveSetup" => "Home Banking Live Setup Fee",
                    "HBUpgrade" => "Home Banking Desktop Upgrade",
                    "iPhone" => "iPhone App Monthly Fee",
                    "iPhoneSetup" => "iPhone App Setup Fee",
                    "IVR" => "IVR Monthly Fee",
                    "IVRSetup" => "IVR Setup",
                    "IVRUsage" => "IVR Monthly Usage - Per Minute",
                    "MWeb" => "Mobile Web Banking Monthly Fee",
                    "MWebSetup" => "Mobile Web Banking Setup Fee",
                    "PEmail" => "Premium Email Account",
                    "RDC" => "RDC Base Monthly Fee",
                    "RDCSetup" => "RDC Setup Fee",
                    "Secure" => "Secure Forms Monthly Hosting",
                    "SecureSetup" => "Secure Forms Setup Fee",
                    "SSL" => "SSL Certificate Monthly Hosting",
                    "SSLSetup" => "SSL Certificate Setup",
                    "SunsetWEB" => "HB Sunset Monthly Service Fee",
                    "TXT" => "TXT Banking Monthly Fee",
                    "TXTSetup" => "TXT Banking Setup Fee",
                    "WEB" => "Home Banking Monthly Service Fee",
                    "WebSetup" => "Website Development Setup",
                    "Timetrack" => "HTML/Support",
                    "EstmntSetup" => "E-Statement Setup",
                    "BillPaySetup" => "Bill-Pay Setup",
                    "Loan" => "Member Loan Approval",
                    "LoanSetup" => "Member Loan Approval Setup",
                    "SSLCert" => "SSL Certificate Purchase",
                    "Gold" => "Gold Monthly",
                    "GoldSetup" => "Gold Setup",
                    "Silver" => "Silver Monthly",
                    "SilverSetup" => "Silver Setup",
                    "Platinum" => "Platinum Monthly",
                    "PlatinumSetup" => "Platinum Setup",
                    "Intuit" => "Intuit Monthly",
                    "IntuitSetup" => "Intuit Setup",
                    "BillPay" => "Bill-Pay Monthly"
                );
}

/**
 * function GetTimetrackBillingItems()
 * For matching case sensitivity and adding hours label on the count.
 */
function GetTimetrackBillingItems() {
    return array("cerise" => "HTML/Support",
                 "elaine" => "HTML/Support",
                 "gary" => "Gary Peters Programming Services",
                 "jayme" => "HTML/Graphics Design",
                 "joe" => "Joe Pearson Consulting Services",
                 "kim" => "Kim Langdon Programming Services",
                 "mark" => "Mark Stevens Programming Services",
                 "miki" => "Miki Hall Programming Services",
                 "test" => "TEST HTML/Support",
                 "tyler" => "HTML/Support",
                 "buddy" => "HTML/Support",
                 "nick" => "HTML/Support",
                 "lisa" => "HTML/Support",
                 "matt" => "HTML/Support");
}

// GetSetupRecurring() ... getFixedVariableLabels(): configuration options for feature details (salesOrderDetail bottom level).

/**
 * GetSetupRecurring()
 * "setup" --
 *   End date, Variable, qty1, and qty2 fields will be hidden.
 *   Any changes to the start date will set the end date to the same value.
 * "recurring" --
 *  End date is visible.  Variable, qty1, and qty2's visibility can be restricted on a different configuration.
 * "triggered" --
 *  Functions like a setup.  However, feature is active when a workflow task is completed.
 *  Only real example of this is the SSL certificate.
 */
function GetSetupRecurring() {
    return array (  "Android" => "recurring",
                    "AndroidSetup" => "setup",
                    "CkImaging" => "recurring",
                    "CkSetup" => "setup",
                    "E2stmnt" => "recurring",
                    "E3stmnt" => "recurring",
                    "Email" => "recurring",
                    "Estmnt" => "recurring",
                    "HBBatch" => "recurring",
                    "HBBatchSetup" => "setup",
                    "HBLive" => "recurring",
                    "HBLiveSetup" => "setup",
                    "HBUpgrade" => "recurring",
                    "iPhone" => "recurring",
                    "iPhoneSetup" => "setup",
                    "IVR" => "recurring",
                    "IVRSetup" => "setup",
                    "IVRUsage" => "recurring",
                    "MWeb" => "recurring",
                    "MWebSetup" => "setup",
                    "PEmail" => "recurring",
                    "RDC" => "recurring",
                    "RDCSetup" => "setup",
                    "Secure" => "recurring",
                    "SecureSetup" => "setup",
                    "SSL" => "recurring",
                    "SSLSetup" => "setup",
                    "SunsetWEB" => "recurring",
                    "TXT" => "recurring",
                    "TXTSetup" => "setup",
                    "WEB" => "recurring",
                    "WebSetup" => "setup",
                    "Timetrack" => "recurring",
                    "HBUpgrade" => "setup",
                    "EstmntSetup" => "setup",
                    "BillPaySetup" => "setup",
                    "LoanSetup" => "setup",
                    "Loan" => "recurring",
                    "SSLCert" => "triggered",
                    "TestSetup" => "setup",
                    "Test" => "recurring",
                    "TestCert" => "triggered",
                    "Gold" => "recurring",
                    "Platinum" => "recurring",
                    "Silver" => "recurring",
                    "GoldSetup" => "setup",
                    "PlatinumSetup" => "setup",
                    "SilverSetup" => "setup",
                    "Intuit" => "recurring",
                    "IntuitSetup" => "setup",
                    "BillPay" => "recurring"
        );
}

/**
 * function GetFullLabelTypes()
 * This is a list of options that a line item can have for quantity labels.
 */
function GetFullLabelTypes() {
    return array ("regular", "range", "left", "left and right", "none", "no qty1", "no qty2");
}

/**
 * function GetQuantityLabelTypeVariance()
 * List of billing system ids that change by the sales item id.
 */
function GetQuantityLabelTypeVariance() {
    return array ( "SunsetWEB" => array("37" => "no qty2", "67" => "left and right", "69" => "left and right"),
                   "Estmnt" => array("107" => "none"),
                   "IVRUsage" => array("108" => "no qty2", "109" => "no qty2"),
                   "SSL" => array("123" => "none", "128" => "no qty2"),
                   "Secure" => array("129" => "no qty2"),
                   "RDC" => array("124" => "left and right")
                 );
}

/**
 * function GetQuantityLabelType()
 * List of billing system ids and the label type.
 */
function GetQuantityLabelType() {
    return array (  "Android" => "left and right",
                    "E2stmnt" => "range",
                    "E3stmnt" => "range",
                    "Email" => "none",
                    "Estmnt" => "range",
                    "HBLive" => "left and right",
                    "iPhone" => "left and right",
                    "PEmail" => "none",
                    "Timetrack" => "none",
                    "SSL" => "range",
                    "IVRUsage" => "none",
                    "HBBatch" => "left and right",
                    "MWeb" => "left and right",
                    "CkImaging" => "none",
                    "IVR" => "none",
                    "RDC" => "none",
                    "Secure" => "none",
                    "TXT" => "none",
                    "WEB" => "none",
                    "Loan" => "left and right",
                    "Gold" => "none",
                    "Silver" => "none",
                    "Platinum" => "none",
                    "Intuit" => "none",
                    "BillPay" => "none"
                );
}

/**
 * function GetQuantityLabelsVariance()
 * The labels by sales item id for the billing system ids.
 */
function GetQuantityLabelsVariance() {
    return array ( "SunsetWEB" => array("37" => array("If less than:", "Members")),
                   "IVRUsage" => array("108" => array("Up to:", "Minutes"), "109" => array("After:", "Minutes")),
                   "SSL" => array("128" => array("", "Members")),
                   "Secure" => array("129" => array("", "Members")));
}

/**
 * function GetQuantityLabels()
 * The labels by billing system id.
 */
function GetQuantityLabels() {
    return array (  "Android" => array("For each", "Members", "Over", ""),
                    "RDC" => array("For each", "Members", "Over", ""),
                    "E2stmnt" => array("Estatements:"),
                    "E3stmnt" => array("Estatements:"),
                    "Estmnt" => array("Estatements:"),
                    "HBBatch" => array("For each", "Members", "Over", ""),
                    "HBLive" => array("For each", "Members", "Over", ""),
                    "iPhone" => array("For each", "Members", "Over", ""),
                    "MWeb" => array("For each", "Members", "Over", ""),
                    "Loan" => array("For each", "Members", "Over", ""),
                    "SSL" => array("Assets:"),
                    "SunsetWEB" => array("For each", "Members", "Over", "")
        );
}

/**
 * function GetFixedVariableLabelTypeVariance()
 * The fixed, variable label types by sales item id for billing system ids.
 */
function GetFixedVariableLabelTypeVariance() {
    return array("Email" => array("11" => "none", "84" => "no variable"),
                 "SunsetWEB" => array("37" => "no fixed"),
                 "Estmnt" => array("107" => "no variable"),
                 "IVRUsage" => array("109" => "no fixed"),
                 "CkImaging" => array("7" => "no variable", "125" => "no fixed"),
                 "RDC" => array("47" => "no variable", "124" => "regular"),
                 "Secure" => array("63" => "no variable", "127" => "no fixed", "129" => "regular"),
                 "WEB" => array("51" => "no variable", "126" => "no fixed"),
                 "SSL" => array("123" => "no fixed", "128" => "regular"),
                 "Gold" => array("113" => "no fixed", "120" => "no variable"),
                 "Platinum" => array("117" => "no fixed", "121" => "no variable"),
                 "Silver" => array("115" => "no fixed", "122" => "no variable"),
                 "BillPay" => array("135" => "no variable", "136" => "no variable"));
}

/**
 * function GetFixedVariableLabelType()
 * The fixed, variable label types by billing system id.
 */
function GetFixedVariableLabelType() {
    return array("Timetrack" => "left",
                 "PEmail" => "none",
                 "SSL" => "no variable",
                 "Estmnt" => "no fixed",
                 "E2stmnt" => "no fixed",
                 "E3stmnt" => "no fixed",
                 "IVR" => "no variable",
                 "TXT" => "no variable",
                 "IVRUsage" => "left",
                 "Intuit" => "no variable",
                 "BillPay" => "no fixed",
                 "RDC" => "regular"
                 );
}

/**
 * function GetFixedVariableLabelsVariance()
 * The fixed, variable labels by sales item id for billing system ids.
 */
function GetFixedVariableLabelsVariance() {
    return array("IVRUsage" => array("21" => array("Base:", "Per Call:"), "109" => array("Per Minute:")),
      "Estmnt" => array("3" => array("Per Statement:"), "83" => array("Per Statement:"), "82" => array("Per Statement:")),
      "CkImaging" => array("125" => array("If less than or equal to:", "If greater than:")),
      "Secure" => array("127" => array("Per Member:"), "129" => array("If less than or equal to:", "If greater than:")),
      "SSL" => array("123" => array("Per Member:")),
      "Gold" => array("113" => array("Per Member:")),
      "Silver" => array("115" => array("Per Member:")),
      "Platinum" => array("117" => array("Per Member:")),
      "SSL" => array("128" => array("If less than or equal to:", "If greater than:")),
      "BillPay" => array("137" => array("Per Transaction Fee:"), "138" => array("Per stop and reissue fee:"), "139" => array("Per letter mailed express mail:"),
                         "140" => array("Per NSF fee:"), "141" => array("Per proof of payment:"))
    );
}

/**
 * function GetFixedVariableLabels()
 * The fixed, variable labels by billing system id.
 */
function GetFixedVariableLabels() {
    return array("Timetrack" => array("Bill Rate:", "Rush Rate:"),
                 "E2stmnt" => array("Per Statement:"),
                 "E3stmnt" => array("Per Statement:"),
                 "IVRUsage" => array("Base:", "Per Minute:"),
                 "RDC" => array("Fixed:", "Variable:")
                 );
}

/**
 * function GetAutomaticProductAddConfigOptions()
 * controls dropdown menus on salesOrderDetail adds (top level).
 * If there isn't one for the product, it will be added immediately.
 */
function GetAutomaticProductAddConfigOptions() {
    return array( "HBLive" => array("HBLive1" => "Regular", "HBLive2" => "With Sunset"),
                  "HBBatch" => array("HBBatch1" => "Regular", "HBBatch2" => "With Sunset"),
                  "IVR VOIP" => array("IVR VOIP1" => "Per Minute", "IVR VOIP2" => "Per Call", "IVR VOIP3" => "Tiered Minutes"),
                  "ESP" => array("ESP1" => "Tiered", "ESP2" => "Fixed per count", "ESP4" => "Fixed Rate", "ESP3" => "Free"),
                  "Gold" => array("Gold1" => "Regular Pricing", "Gold2" => "Small Credit Unions"),
                  "Platinum" => array("Platinum1" => "Regular Pricing", "Platinum2" => "Small Credit Unions"),
                  "Silver" => array("Silver1" => "Regular Pricing", "Silver2" => "Small Credit Unions"),
                  "WEBS" => array("WEBS1" => "Fixed Rate", "WEBS2" => "Based on membership"),
                  "SSL" => array("SSL1" => "Per Member", "SSL2" => "Flat on membership size"),
                  "SecForm" => array("SecForm1" => "Per Member", "SecForm2" => "Flat on membership size"),
                  "BP" => array("BP1" => "Setup only", "BP2" => "iPay"),
                  "RDC" => array("RDC1" => "Flat Fee", "RDC2" => "Based on membership"));
}

/**
 * function GetUseDNID()
 * @return list of billing system ids that use the long code.
 */
function GetUseDNID() {
  return array("IVRUsage" => true);
}

/**
 * function GetUseDNIDProduct()
 * @return list of product ids that use the long code.
 */
function GetUseDNIDProduct() {
  return array("IVR VOIP" => true);
}

/**
 * function GetSaveDigits()
 * This controls how many digits can be saved for fixed and variable values.
 * If not set, digits default to 2.
 */
function GetSaveDigits() {
    return array("IVRUsage" => 3, "Gold" => 3, "Platinum" => 3, "Silver" => 3);
}

/**
 * function GetAutomaticProductAdds()
 * @return list of product features whether chosen from the ddl or directly added.
 */
function GetAutomaticProductAdds() {
    $returnArray =  array (  "ESP1" => array(array("billingId" => "EstmntSetup", "salesItemId" => 101),
                                   array( "billingId" => "Estmnt", "salesItemId" => 3),
                                   array( "billingId" => "E2stmnt", "salesItemId" => 5),
                                   array( "billingId" => "E3stmnt", "salesItemId" => 23)),
                    "ESP2" => array(array("billingId" => "EstmntSetup", "salesItemId" => 101),
                                    array("billingId" => "Estmnt", "salesItemId" => 82)),
                    "ESP3" => array(array("billingId" => "EstmntSetup", "salesItemId" => 101),
                                    array("billingId" => "Estmnt", "salesItemId" => 83)),
                    "ESP4" => array(array("billingId" => "EstmntSetup", "salesItemId" => 101),
                                    array("billingId" => "Estmnt", "salesItemId" => 107)),
                    "HBBatch1" => array(array("billingId" => "HBBatchSetup", "salesItemId" => 31),
                                    array("billingId" => "HBBatch", "salesItemId" => 2)),
                    "HBLive1" => array(array("billingId" => "HBLiveSetup", "salesItemId" => 35),
                                    array("billingId" => "HBLive", "salesItemId" => 33)),
                    "HBBatch2" => array(array("billingId" => "HBBatchSetup", "salesItemId" => 31),
                                    array("billingId" => "SunsetWEB", "salesItemId" => 37),
                                    array("billingId" => "SunsetWEB", "salesItemId" => 67)),
                    "HBLive2" => array(array("billingId" => "HBLiveSetup", "salesItemId" => 35),
                                    array("billingId" => "SunsetWEB", "salesItemId" => 69)),
                    "UpgradeBL" => array(array("billingId" => "HBUpgrade", "salesItemId" => 91)),
                    "IMG" => array(array( "billingId" => "CkSetup", "salesItemId" => 41),
                                   array( "billingId" => "CkImaging", "salesItemId" => 7)),
                    "IVR" => array(array( "billingId" => "IVRSetup", "salesItemId" => 39),
                                   array( "billingId" => "IVR", "salesItemId" => 17)),
                    "MBLADA" => array(array("billingId" => "AndroidSetup", "salesItemId" => 1),
                                      array("billingId" => "Android", "salesItemId" => 4)),
                    "MBLAPP" => array(array("billingId" => "iPhoneSetup", "salesItemId" => 15),
                                      array("billingId" => "iPhone", "salesItemId" => 13)),
                    "MBLTXT" => array(array("billingId" => "TXTSetup", "salesItemId" => 29),
                                      array("billingId" => "TXT", "salesItemId" => 27)),
                    "MBLWEB" => array(array("billingId" => "MWebSetup", "salesItemId" => 45),
                                      array("billingId" => "MWeb", "salesItemId" => 43)),
                    "RDC1" => array(array( "billingId" => "RDCSetup", "salesItemId" => 49),
                                   array( "billingId" => "RDC", "salesItemId" => 47)),
                    "RDC2" => array(array( "billingId" => "RDCSetup", "salesItemId" => 49),
                                   array( "billingId" => "RDC", "salesItemId" => 124)),
                    "SSL1" => array(array( "billingId" => "SSLSetup", "salesItemId" => 59),
                                   array( "billingId" => "SSL", "salesItemId" => 123),
                                   array( "billingId" => "SSL", "salesItemId" => 106)),
                    "SSL2" => array(array( "billingId" => "SSLSetup", "salesItemId" => 59),
                                   array( "billingId" => "SSL", "salesItemId" => 128),
                                   array( "billingId" => "SSL", "salesItemId" => 106)),
                    "SecForm1" => array(array("billingId" => "SecureSetup", "salesItemId" => 61),
                                       array("billingId" => "Secure", "salesItemId" => 127)),
                    "SecForm2" => array(array("billingId" => "SecureSetup", "salesItemId" => 61),
                                       array("billingId" => "Secure", "salesItemId" => 129)),
                    "WEBS1" => array(array( "billingId" => "WebSetup", "salesItemId" => 53),
                                    array( "billingId" => "WEB", "salesItemId" => 51)),
                    "WEBS2" => array(array( "billingId" => "WebSetup", "salesItemId" => 53),
                                    array( "billingId" => "WEB", "salesItemId" => 126)),
                    "IVR VOIP1" => array(array("billingId" => "IVRSetup", "salesItemId" => 70),
                                         array("billingId" => "IVRUsage", "salesItemId" => 19)),
                    "IVR VOIP2" => array(array("billingId" => "IVRSetup", "salesItemId" => 70),
                                         array("billingId" => "IVRUsage", "salesItemId" => 21)),
                    "IVR VOIP3" => array(array("billingId" => "IVRSetup", "salesItemId" => 70),
                                         array("billingId" => "IVRUsage", "salesItemId" => 108),
                                         array("billingId" => "IVRUsage", "salesItemId" => 109)),
                    "Email" => array(array("billingId" => "Email", "salesItemId" => 11),
                                     array("billingId" => "PEmail", "salesItemId" => 55)),
                    "BP1" => array(array("billingId" => "BillPaySetup", "salesItemId" => 99)),
                    "BP2" => array(array("billingId" => "BillPaySetup", "salesItemId" => 134), // Consumer Bill Pay
                                   array("billingId" => "BillPay", "salesItemId" => 135), // Minimum Monthly Volume
                                   array("billingId" => "BillPay", "salesItemId" => 136), // Annual Compliance Package
                                   array("billingId" => "BillPay", "salesItemId" => 137), // Per Transaction Fee
                                   array("billingId" => "BillPay", "salesItemId" => 138), // Per stop and reissue fee
                                   array("billingId" => "BillPay", "salesItemId" => 139), // Per letter mailed express mail
                                   array("billingId" => "BillPay", "salesItemId" => 140), // per NSF fee
                                   array("billingId" => "BillPay", "salesItemId" => 141)), // standard proof of payment request
                    "MBLLNAPP" => array(array("billingId" => "LoanSetup", "salesItemId" => 105),
                                        array("billingId" => "Loan", "salesItemId" => 104)),
                    "Gold1" => array(array("billingId" => "GoldSetup", "salesItemId" => 114),
                                    array("billingId" => "Gold", "salesItemId" => 113)),
                    "Silver1" => array(array("billingId" => "SilverSetup", "salesItemId" => 116),
                                    array("billingId" => "Silver", "salesItemId" => 115)),
                    "Platinum1" => array(array("billingId" => "PlatinumSetup", "salesItemId" => 118),
                                    array("billingId" => "Platinum", "salesItemId" => 117)),
                    "Gold2" => array(array("billingId" => "GoldSetup", "salesItemId" => 114),
                                    array("billingId" => "Gold", "salesItemId" => 120)),
                    "Silver2" => array(array("billingId" => "SilverSetup", "salesItemId" => 116),
                                    array("billingId" => "Silver", "salesItemId" => 122)),
                    "Platinum2" => array(array("billingId" => "PlatinumSetup", "salesItemId" => 118),
                                    array("billingId" => "Platinum", "salesItemId" => 121)),
                    "Intuit" => array(array("billingId" => "IntuitSetup", "salesItemId" => 132),
                                    array("billingId" => "Intuit", "salesItemId" => 133))
                    );
    return $returnArray;
}

/**
 * function GetNeedsOverlapCheck()
 * @return $check -- list of products to check if there is an overlap.
 * @return $not -- don't include these sales item ids when checking.
 */
function GetNeedsOverlapCheck() {
  return array("check" => array("ESP"), "not" => array(123, 107, 82, 83));
}

/**
 * function GetCountLabelVariance()
 * Labels on the monthly billing page for the count column (by sales item id for billing system ids)
 */
function GetCountLabelVariance() {
    return array(   "SunsetWEB" => array("67" => "Members", "37" => "Members", "69" => "Fee(s)"),
                    "Estmnt" => array("83" => "Fee(s)", "82" => "E-Statements", "3" => "E-Statements", "107" => "Fee(s)"),
                    "IVRUsage" => array("21" => "Calls"),
                    "Email" => array("11" => "Accounts", "84" => "Credit"),
                    "CkImaging" => array("125" => "Fee (s)"),
                    "RDC" => array("124" => "Fee (s)"),
                    "Secure" => array("127" => "Members", "129" => "Flat Fee"),
                    "WEB" => array("126" => "Members"),
                    "SSL" => array("123" => "Members", "128" => "Flat Fee"),
                    "Gold" => array("120" => "Flat Fee", "113" => "Members"),
                    "Silver" => array("122" => "Flat Fee", "115" => "Members"),
                    "Platinum" => array("121" => "Flat Fee", "117" => "Members"),
                    "SecForm" => array("129" => "Flat Fee"),
                    "BillPay" => array("135" => "Flat Fee", "136" => "Flat Fee (annual)", "137" => "Transactions",
                                       "138" => "Stop and reissues", "139" => "Express mail", "140" => "NSFs",
                                       "141" => "Proof of payments")
                );
}

/**
 * function GetCountLabels()
 * Labels on the monthly billing page for the count column (by billing system id)
 *
 * **NOTE**: Timetrack will show as "Hours (<name>)".  Controlled by the getTimetrackBillingItems() array.
 */
function GetCountLabels() {
    return array(   "Android" => "Fee(s)",
                    "AndroidSetup" => "Setup",
                    "CkImaging" => "Flat Fee",
                    "CkSetup" => "Setup",
                    "E2stmnt" => "E-Statements",
                    "E3stmnt" => "E-Statements",
                    "HBBatch" => "Fee(s)",
                    "HBBatchSetup" => "Setup",
                    "HBLive" => "Fee(s)",
                    "HBLiveSetup" => "Setup",
                    "HBUpgrade" => "Fee(s)",
                    "iPhone" => "Fee(s)",
                    "iPhoneSetup" => "Setup",
                    "IVR" => "Fee(s)",
                    "IVRSetup" => "Setup",
                    "MWeb" => "Fee(s)",
                    "MWebSetup" => "Setup",
                    "PEmail" => "Accounts",
                    "RDC" => "Flat Fee",
                    "RDCSetup" => "Setup",
                    "Secure" => "Flat Fee",
                    "SecureSetup" => "Setup",
                    "SSL" => "Conditional Fee(s)",
                    "SSLSetup" => "Setup",
                    "TXT" => "Fee(s)",
                    "TXTSetup" => "Setup",
                    "WEB" => "Flat Fee",
                    "WebSetup" => "Setup",
                    "BillPaySetup" => "Setup",
                    "EstmntSetup" => "Setup",
                    "LoanSetup" => "Setup",
                    "Loan" => "Fee(s)",
                    "SSLCert" => "Fee",
                    "IVRUsage" => "Minutes",
                    "GoldSetup" => "Setup",
                    "SilverSetup" => "Setup",
                    "PlatinumSetup" => "Setup",
                    "IntuitSetup" => "Setup",
                    "Intuit" => "Flat Fee"
                );
}

/**
 * function GetTextDescription($salesItemId, $billingId, $fixed, $variable, $qty1, $qty2, $aDNID)
 * This gives a concise description of the line item.
 * The current values in the line item will be used in the description.
 *
 * @param $salesItemId -- Number of the sales item the line item corresponds to.
 * @param $billingId -- String of the particular billingId.
 * @param $fixed -- Number of the fixed amount.
 * @param $variable -- Number of the variable amount.
 * @param $qty1 -- Number of the first quantity.
 * @param $qty2 -- Number of the second quantity.
 * @param $aDNID -- The long code number.
 *
 * @return String -- the full English description.
 */
function GetTextDescription($salesItemId, $billingId, $fixed, $variable, $qty1, $qty2, $aDNID) {
    $formattedQty1 = number_format($qty1);
    $formattedQty2 = number_format($qty2);

    $saveDigits = GetSaveDigits();
    $digits = HCU_array_key_value($billingId, $saveDigits);
    $digits = $digits === false ? 2 : intval($digits);

    $formattedFixed = $fixed < 0 ? "$(" . number_format(abs($fixed), $digits) . ")" : "$" . number_format($fixed, $digits);
    $formattedVariable = $variable < 0 ? "$(" . number_format(abs($variable), $digits) . ")" : "$" . number_format($variable, $digits);

    $flatSunsetRate = $fixed == 0 ? "" : "a flat fee of $formattedFixed per month then";
    $flatRate = $fixed == 0 ? "" : "$formattedFixed per mo. plus";
    $over = $qty2 == 0 ? "" : " over $formattedQty2";
    $variableSunsetText = "$formattedQty1 to $formattedQty2 total membership $flatRate $formattedVariable per mo. "
                        . "for each $formattedQty1 members (or portion thereof)${over}.";
    $variableText = "$flatRate $formattedVariable per mo. for each $formattedQty1 members (or portion thereof)${over}.";
    $fixedText = "Fixed fee of $formattedFixed.";

    switch ($billingId) {
      case "E2stmnt": return "E-Statements $formattedVariable each $formattedQty1 to $formattedQty2 members.";
      case "E3stmnt": return "E-Statements $formattedVariable after $formattedQty1 members.";
      case "Estmnt":
        if ($salesItemId == 3) {
          return "E-Statements $formattedVariable per the first $formattedQty2 members.";
        } else if ($salesItemId == 82) {
          return "$formattedVariable per E-Statement.";
        } else if ($salesItemId == 83) {
          return "Free E-Statements.";
        } else if ($salesItemId == 107) {
          return "Monthly fee of $formattedFixed";
        } else {
          return "";
        }
      case "SunsetWEB":
        if ($salesItemId == 37) {
          return "Fewer than $formattedQty1 total membership $formattedVariable per member per month.";
        } else if ($salesItemId == 67) {
          return $variableSunsetText;
        } else if ($salesItemId == 69) {
          return $variableText;
        } else {
          return "";
        }
      case "AndroidSetup":
      case "CkSetup":
      case "HBBatchSetup":
      case "HBLiveSetup":
      case "HBUpgrade":
      case "iPhoneSetup":
      case "IVRSetup":
      case "MWebSetup":
      case "RDCSetup":
      case "SecureSetup":
      case "SSLSetup":
      case "TXTSetup":
      case "WebSetup":
      case "BillPaySetup":
      case "EstmntSetup":
      case "LoanSetup":
      case "GoldSetup":
      case "SilverSetup":
      case "PlatinumSetup":
      case "IntuitSetup":
        return $fixedText;
      // Monthly rates that are fixed.  Divided them out of the setups in case these labels need to change.
      case "IVR":
        return $fixedText;
      case "TXT":
      case "Intuit":
        return $fixedText;
      case "Email":
        return '$1 per email account.';
      case "PEmail":
        return '$1-$3 bump per premium email account (based on premium type).';
      case "SSL":
        if ($salesItemId == 123) {
          return "$formattedVariable per member.";
        } else if ($salesItemId == 128) {
          return "$formattedFixed is less than or equal to $formattedQty1 members.  $formattedVariable if more members than $formattedQty1.";
        }

        $text = "Monthly fee of $formattedFixed";
        if ($qty1 == 0) {
          $text = $qty2 == -1 ? "$text." : "$text where number of assets is less than $formattedQty2.";
        } else {
          $text = $qty2 == -1 ? "$text where number of assets is more than $formattedQty1."
                              : "$text where number of assets is between $formattedQty1 and $formattedQty2.";
        }
        return $text;

      case "Secure":
        if ($salesItemId == 129) {
          return "$formattedFixed is less than or equal to $formattedQty1 members.  $formattedVariable if more members than $formattedQty1.";
        } else if ($salesItemId == 127) {
          return "$formattedVariable per member.";
        } else {
          return $fixedText;
        }
      case "RDC":
          return $salesItemId >= 123 ? $variableText : $fixedText;
      case "CkImaging":
          return $fixedText;
      case "WEB":
        if ($salesItemId >= 123) {
          return "$formattedVariable per member.";
        } else {
          return $fixedText;
        }
      case "Timetrack":
        return "HTML Support.  $formattedFixed per billable hours.  $formattedVariable per rush hours.";
      case "Android":
      case "HBBatch":
      case "HBLive":
      case "iPhone":
      case "MWeb":
      case "Loan":
        return $variableText;
      case "IVRUsage":
        $textDNID = $aDNID != "" ? "for number $aDNID." : "for all numbers.";
        $text = "$flatSunsetRate $formattedVariable";
        if ($salesItemId == 19) {
          return "$text per minute $textDNID";
        } else if ($salesItemId == 21) {
          return "$text per call $textDNID";
        } else if ($salesItemId == 108) {
          return "$text per minute up to $formattedQty1 minutes $textDNID";
        } else if ($salesItemId == 109) {
          return "$formattedVariable per minute after $formattedQty1 minutes $textDNID";
        } else {
          return "";
        }
      case "SSLCert":
        return "$formattedFixed when completed in workflow.";
      case "Gold":
      case "Platinum":
      case "Silver":
        if ($salesItemId >= 120) {
          return $fixedText;
        } else {
          return "$formattedVariable per member.";
        }
      case "BillPay":
        if (in_array($salesItemId, array(134, 135, 136))) {
          return $fixedText;
        } else if ($salesItemId == 137) {
          return "$formattedVariable per transaction fee";
        } else if ($salesItemId == 138) {
          return "$formattedVariable per stop and reissue fee";
        } else if ($salesItemId == 139) {
          return "$formattedVariable per letter mailed express mail";
        } else if ($salesItemId == 140) {
          return "$formattedVariable per NSF fee";
        } else if ($salesItemId == 141) {
          return "$formattedVariable per standard proof of payment";
        } else {
          return "";
        }
      default:
        return "";
    }
}

/**
 * function GetInitialRecurringCosts($salesItemId, $billingId, $fixed, $variable, $qty1, $qty2)
 * @param $salesItemId -- the sales item id of the line item.
 * @param $billingId -- the billing system id of the line item.
 * @param $fixed -- the fixed value of the line item.
 * @param $variable -- the variable value of the line item.
 * @param $qty1 -- the first quantity of the line item.
 * @param $qty2 -- the second quantity of the line item.
 *
 * @return array of two strings
 * [0] is initial, [1] is recurring.
 */
function GetInitialRecurringCosts($salesItemId, $billingId, $fixed, $variable, $qty1, $qty2) {
    $formattedQty1 = number_format($qty1);
    $formattedQty2 = number_format($qty2);

    $saveDigits = GetSaveDigits();
    $digits = HCU_array_key_value($billingId, $saveDigits);
    $digits = $digits === false ? 2 : intval($digits);

    $formattedFixed = $fixed < 0 ? "$(" . number_format(abs($fixed), $digits) . ")" : "$" . number_format($fixed, $digits);
    $formattedVariable = $variable < 0 ? "$(" . number_format(abs($variable), $digits) . ")" : "$" . number_format($variable, $digits);

    switch ($billingId) {
      case "Estmnt":
        if ($salesItemId == 3) {
          return array("", "(Variable)");
        } else if ($salesItemId == 82) {
          return array("", "$formattedVariable per mo. per E-Statement");
        } else if ($salesItemId == 83) {
          return array("", "Free");
        }
      case "AndroidSetup":
      case "CkSetup":
      case "HBBatchSetup":
      case "HBLiveSetup":
      case "HBUpgrade":
      case "iPhoneSetup":
      case "IVRSetup":
      case "MWebSetup":
      case "RDCSetup":
      case "SecureSetup":
      case "SSLSetup":
      case "TXTSetup":
      case "WebSetup":
      case "BillPaySetup":
      case "EstmntSetup":
        return array($formattedFixed, "");
      case "CkImaging":
      case "IVR":
      case "RDC":
      case "Secure":
      case "TXT":
      case "WEB":
      case "SSL":
        return array("", "$formattedFixed per mo.");
      case "Email":
      case "PEmail":
      case "Timetrack":
      case "IVRUsage":
      case "E2stmnt":
      case "E3stmnt":
      case "SunsetWEB":
        return array("", "(Variable)");
      case "Android":
      case "HBBatch":
      case "HBLive":
      case "iPhone":
      case "MWeb":
        return array("", "$formattedVariable per member per mo.");
      default:
        return array("", "");
    }
}

/**
 * function GetBillingStatuses()
 * @return list of billing statuses.
 */
function GetBillingStatuses() {
  return array("Ready to Bill Half", "Pending", "Active", "Completed");
}

/**
 * function GetSetupBillingOptions()
 * @return list of options for the bill half dropdownlist.
 */
function GetSetupBillingOptions() {
  return array(array("text" => "Bill Full", "value" => "full"),
    array("text" => "Bill Full Upfront", "value" => "upfront"),
    array("text" => "Check Received", "value" => "partial"),
    array("text" => "Bill Half", "value" => "future"),
    array("text" => "No Setup Record", "value" => "nosetup"));
}

/**
 * function GetBillingStatusLabel ($billingStatus, $startDate, $endDate, $setupLabel, $gridType = "")
 * Gets the status label shown on the pending detail, active, and completed grids.
 *
 * @param $billingStatus -- the raw status value in the database {0,1,2,3,4,5}
 * @param $startDate -- the start date of the line item.
 * @param $endDate -- the end date of the line item.
 * @param $setupLabel -- "setup", "recurring", or "triggered" @see GetSetupRecurring()
 * @param $gridType -- "pending", "active", or "completed."  This is context to get the "undo" status.
 *
 * @return $status -- "000" if successful, nonzero otherwise.
 * @return $error -- "" if successful, nonempty otherwise.
 * @return $data.statusLabel -- The label to show.
 * @return $data.billingStatusGroup -- the number to put line item in the correct grid.
 */
function GetBillingStatusLabel ($billingStatus, $startDate, $endDate, $setupLabel, $gridType = "") {
    try {
        $statusLabel = "";
        $billingStatusGroup = -1;
        if ($setupLabel == "triggered" && $billingStatus == 1) {
          $billingStatusGroup = 1;
          $statusLabel = "Not triggered";
        } else {
            $billingStatusLabels = GetBillingStatuses();
            $statusLabel = HCU_array_key_value($billingStatus, $billingStatusLabels);

            if ($billingStatus == 2 || $billingStatus == 3) {
                $startDateTime = new DateTime($startDate);
                $formattedStartDate = $startDateTime->format("m/Y");
                $now = new DateTime();
                $nextMonth = new DateTime();
                $m = $now->format("m");
                $Y = $now->format("Y");
                $now->setDate($Y, $m, 1);
                $nextMonth->setDate($Y, $m + 1, 1);
                $beforeStartDate = $now < $startDateTime;
                $startingThisMonth = $now->format("m/Y") == $startDateTime->format("m/Y");

                if ($endDate != "") {
                    $endDateTime = new DateTime($endDate);
                    $afterEndDate = $now > $endDateTime;
                    $endingThisMonth = $now->format("m/Y") == $endDateTime->format("m/Y");
                    $endingNextMonth = $nextMonth->format("m/Y") == $endDateTime->format("m/Y");
                } else {
                    $afterEndDate = false;
                    $endingThisMonth = false;
                    $endingNextMonth = false;
                }

                if ($gridType == "completed" && !$afterEndDate) {
                  $statusLabel = "Reactivated";
                } else if ($setupLabel == "triggered") {
                  $billingStatusGroup = 0;
                  $statusLabel = "Triggered $formattedStartDate";
                } else if ($beforeStartDate || $startingThisMonth || $gridType == "pending") {
                    if ($setupLabel == "recurring") {
                        $statusLabel = "Starting $formattedStartDate";
                    } else {
                        $statusLabel = "On $formattedStartDate";
                    }

                    $billingStatusGroup = 1;
                } else if ($endingThisMonth) {
                    $statusLabel = "Ending this month";
                    $billingStatusGroup = 0;
                } else if ($endingNextMonth) {
                    $statusLabel = "Ending next month";
                    $billingStatusGroup = 0;
                } else if ($afterEndDate) {
                    $statusLabel = "Completed";
                    $billingStatusGroup = 2;
                } else {
                    $statusLabel = "Active";
                    $billingStatusGroup = 0;
                }
            } else {
                $billingStatusGroup = 1;
                if ($billingStatus == 0) {
                    $statusLabel = "Pending Workflow, Billing Half";
                } else if ($billingStatus == 1) {
                  switch($setupLabel) {
                    case "setup":
                      $statusLabel = "Pending Workflow";
                      break;
                    case "recurring":
                      $statusLabel = "Pending";
                      break;
                  }
                } else if ($billingStatus == 4 || $billingStatus == 5) {
                  $statusLabel = "No Workflow";
                } else {
                    $statusLabel = "Unknown Status";
                }
            }
        }

        $returnArray = array("status" => "000", "error" => "", "data" => array("statusLabel" => $statusLabel, "billingStatusGroup" => $billingStatusGroup));
    } catch (exception $e) {
        $returnArray = array("status" => $e->getCode(), "error" => $e->getMessage());
    }
    return $returnArray;
}

/**
 * function GetHalfBillingStatus($setup, $billHalf, $partiallyBilledDate, $startDate)
 * Gets the label for if the line item is to be billed half.
 *
 * @param $setup -- true if line item is a setup.  False otherwise.
 * @param $billHalf -- the value of the billHalf column in the database.
 * @param $partiallyBilledDate -- the value of the partiallyBilledDate column in the database.
 * @param $startDate -- the value of the startDate column in the database.
 *
 * @return $status -- "000" if successful, nonzero otherwise.
 * @return $error -- "" if successful, nonempty otherwise.
 * @return $data.statusLabel -- the label to display.
 */
function GetHalfBillingStatus($setup, $billHalf, $partiallyBilledDate, $startDate) {
    try {
        $statusLabel = "";
        if (!$setup) {
            $statusLabel = "N/A";
        } else if ($billHalf == "Y") {
            if ($partiallyBilledDate == null || $partiallyBilledDate == "") {
                throw new exception ("Partially Billed Date is required.", 1);
            }
            $dateTime = new DateTime($partiallyBilledDate);
            $dateFormat = $dateTime->format("m/Y");
            $statusLabel = $dateFormat;
        } else if ($partiallyBilledDate != null && $partiallyBilledDate != "") {
            $dateTime = new DateTime($startDate);
            $dateFormat = $dateTime->format("m/Y");
            $statusLabel = "Credited";
        } else {
            $statusLabel = "N/A";
        }

        $returnArray = array("status" => "000", "error" => "", "data" => array("statusLabel" => $statusLabel));
    } catch (exception $e) {
        $returnArray = array("status" => $e->getCode(), "error" => $e->getMessage());
    }
    return $returnArray;
}

/**
 * function GetFrequencyLabel($billsOnInt, $setup)
 * Gets the frequency label of the line item.
 *
 * @param $billsOnInt -- the value of the bills on column in the database.
 * @param $setup -- "triggered", "setup", or "recurring."
 *
 * @return $data.frequencyLabel -- the label to display.
 * @return $data.billsOnKendo -- the values to show in the dropdownlists.
 */
function GetFrequencyLabel($billsOnInt, $setup) {
    $frequencyLabel = "";
    $billsOnKendo = "";
    if ($setup == "triggered") {
        $frequencyLabel = "Triggered";
    } else if ($setup != "setup") {
        $billsOnInt &= 4095; // 4095 is the value with the first 12 bits set.  If higher bits are set, they are ignored.
        if ($billsOnInt == 4095) {
            $frequencyLabel = "Monthly";
        } else {
            $months = array("January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December");
            $digit = 1;
            $usedMonths = array();
            $usedIs = array();
            for($i = 0, $count = count($months); $i != $count; $i++) {
                if (($billsOnInt & $digit) != 0) {
                    $usedMonths[] = $months[$i];
                    $usedIs[] = $i;
                    $billsOnInt &= ~$digit;
                }
                if ($billsOnInt == 0) {
                    break;
                }
                $digit <<= 1;
            }
            $count = count($usedMonths);
            if ($count == 0 || $count == 12) {
                $frequencyLabel = "Monthly";
            } else if ($count <= 2) {
                $frequencyLabel = "Bills on " . implode($usedMonths, " and ") . ".";
                $billsOnKendo = implode($usedIs, ",");
            } else {
                $usedMonths [$count - 1] = "and " . $usedMonths [$count - 1];
                $frequencyLabel = "Bills on " . implode($usedMonths, ", ") . ".";
                $billsOnKendo = implode($usedIs, ",");
            }
        }
    }

    return array("data" => array("frequencyLabel" => $frequencyLabel, "billsOnKendo" => $billsOnKendo));
}

/**
 * function getFrequencyBillsOn($billsOn, &$frequency, &$billsOnInt)
 * Get the frequency bills on text (from a bit column)
 *
 * @param $billsOn -- the value of the bills on column in the database.
 *
 * @return $status -- "000" if successful, nonzero otherwise.
 * @return $error -- "" if successful, nonempty otherwise.
 * @return integer $data.frequency -- returns the frequency here: (0 -- monthly apparently, 1 -- semiyearly apparently, 2 -- yearly apparently)
 * @return integer $data.billsOnInt -- returns the corresponding bills on number for saving into the database.
 */
function GetFrequencyBillsOn($billsOn) {
    try {
        $frequency = 0;
        $billsOnInt = -1;

        if ($billsOn != "") {
            $billsOnDecoded = HCU_JsonDecode($billsOn);
            $number = count($billsOnDecoded);
            switch($number) {
                case 0:
                    $frequency = 0;
                    $billsOnInt = -1;
                    break;
                case 1: // Yearly
                    $frequency = 2;
                    $billsOnInt = 0;
                    break;
                case 2: // semiyearly
                    $frequency = 1;
                    $billsOnInt = 0;
                    break;
            }
            foreach($billsOnDecoded as $num) {
                if (!is_numeric($num)) {
                    throw new exception("Bills on array needs to be all integers.", 1);
                }
                if (intval($num) < 0 || intval($num) > 11) {
                    throw new exception("Bills on array needs to correspond to the months.", 2);
                }

                $digit = 1 << $num;
                $billsOnInt |= $digit;
            }
        } else {
            $frequency = 0;
            $billsOnInt = -1;
        }

        $returnArray = array("status" => "000", "error" => "", "data" => array("frequency" => $frequency, "billsOnInt" => $billsOnInt));
    } catch (exception $e) {
        $returnArray = array("status" => $e->getCode(), "error" => $e->getMessage());
    }
    return $returnArray;
}