communigate pro provisioning, RT#7083
[freeside.git] / FS / FS / Schema.pm
index 4af026c..6a25fab 100644 (file)
@@ -256,7 +256,7 @@ sub dbdef_dist {
             } );
     
             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
-              $column->type('int');
+              $column->type(uc($1).'INT');
               $column->null('NULL');
             }
             #$column->default('')
@@ -378,8 +378,9 @@ sub tables_hashref {
         'custnum',   'int', '', '', '', '',
         '_date',     @date_type, '', '',
         'otaker',    'varchar', '', 32, '', '',
-        'filename',  'varchar', '', 32, '', '',
-        'mime_type', 'varchar', '', 32, '', '',
+        'filename',  'varchar', '', 255, '', '',
+        'mime_type', 'varchar', '', $char_d, '', '',
+        'title',     'varchar', 'NULL', $char_d, '', '',
         'body',      'blob', 'NULL', '', '', '',
         'disabled',  @date_type, '', '',
       ],
@@ -390,17 +391,28 @@ sub tables_hashref {
 
     'cust_bill' => {
       'columns' => [
+        #regular fields
         'invnum',    'serial',     '', '', '', '', 
         'custnum',      'int',     '', '', '', '', 
         '_date',        @date_type,        '', '', 
         'charged',      @money_type,       '', '', 
+        'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
+
+        #customer balance info at invoice generation time
+        'previous_balance',   @money_typen, '', '',  #eventually not nullable
+        'billing_balance',    @money_typen, '', '',  #eventually not nullable
+
+        #deprecated (unused by now, right?)
         'printed',      'int',     '', '', '', '', 
-        'closed',      'char', 'NULL',  1, '', '', 
-        'statementnum', 'int', 'NULL', '', '', '',
+
+        #specific use cases
+        'closed',      'char', 'NULL',  1, '', '', #not yet used much
+        'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
+        'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
       ],
       'primary_key' => 'invnum',
-      'unique' => [],
-      'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
+      'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
+      'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
     },
 
     'cust_statement' => {
@@ -562,7 +574,9 @@ sub tables_hashref {
         'amount',  'decimal', 'NULL', '10,4', '', '',
         'format',  'char', 'NULL', 1, '', '',
         'classnum', 'int', 'NULL', '', '', '',
+        'duration', 'int', 'NULL', '',  0, '',
         'phonenum', 'varchar', 'NULL', 15, '', '',
+        'regionname', 'varchar', 'NULL', $char_d, '', '',
         'detail',  'varchar', '', 255, '', '', 
       ],
       'primary_key' => 'detailnum',
@@ -653,6 +667,8 @@ sub tables_hashref {
         'creditbillpkgnum', 'serial', '',      '', '', '',
         'creditbillnum',       'int', '',      '', '', '',
         'billpkgnum',          'int', '',      '', '', '',
+        'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
+        'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
         'amount',            @money_type,          '', '',
         'setuprecur',      'varchar', '', $char_d, '', '',
         'sdate',   @date_type, '', '', 
@@ -660,7 +676,11 @@ sub tables_hashref {
       ],
       'primary_key' => 'creditbillpkgnum',
       'unique'      => [],
-      'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
+      'index'       => [ [ 'creditbillnum' ],
+                         [ 'billpkgnum' ], 
+                         [ 'billpkgtaxlocationnum' ],
+                         [ 'billpkgtaxratelocationnum' ],
+                       ],
     },
 
     'cust_main' => {
@@ -668,6 +688,7 @@ sub tables_hashref {
         'custnum',  'serial',  '',     '', '', '', 
         'agentnum', 'int',  '',     '', '', '', 
         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
+        'classnum', 'int', 'NULL', '', '', '',
         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 #        'titlenum', 'int',  'NULL',   '', '', '', 
         'last',     'varchar', '',     $char_d, '', '', 
@@ -735,7 +756,8 @@ sub tables_hashref {
       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
       #'index' => [ ['last'], ['company'] ],
       'index' => [
-                   [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
+                   [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ],
+                   [ 'custbatch' ],
                    [ 'referral_custnum' ],
                    [ 'payby' ], [ 'paydate' ],
                    [ 'archived' ],
@@ -778,12 +800,84 @@ sub tables_hashref {
       'index' => [],
     },
 
+    #eventually for cust_main too
+    'contact' => {
+      'columns' => [
+        'contactnum', 'serial',     '',      '', '', '',
+        'prospectnum',   'int', 'NULL',      '', '', '',
+        'custnum',       'int', 'NULL',      '', '', '',
+        'locationnum',   'int', 'NULL',      '', '', '', #not yet
+#        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
+        'last',      'varchar',     '', $char_d, '', '', 
+#        'middle',    'varchar', 'NULL', $char_d, '', '', 
+        'first',     'varchar',     '', $char_d, '', '', 
+        'title',     'varchar',     '', $char_d, '', '', #eg Head Bottle Washer
+        'comment',   'varchar',     '', $char_d, '', '', 
+        'disabled',     'char', 'NULL',       1, '', '', 
+      ],
+      'primary_key' => 'contactnum',
+      'unique'      => [],
+      'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
+                         [ 'last' ], [ 'first' ],
+                       ],
+    },
+
+    'contact_phone' => {
+      'columns' => [
+        'contactphonenum', 'serial', '', '', '', '',
+        'contactnum',         'int', '', '', '', '',
+        'phonetypenum',       'int', '', '', '', '',
+        'countrycode',    'varchar', '',  3, '', '', 
+        'phonenum',       'varchar', '', 14, '', '', 
+        'extension',      'varchar', '',  7, '', '',
+        #?#'comment',   'varchar',     '', $char_d, '', '', 
+      ],
+      'primary_key' => 'contactphonenum',
+      'unique'      => [],
+      'index'       => [],
+    },
+
+    'phone_type' => {
+      'columns' => [
+        'phonetypenum',  'serial', '',      '', '', '',
+        'typename',     'varchar', '', $char_d, '', '',
+        'weight',           'int', '',      '', '', '', 
+      ],
+      'primary_key' => 'phonetypenum',
+      'unique'      => [ [ 'typename' ], ],
+      'index'       => [],
+    },
+
+    'contact_email' => {
+      'columns' => [
+        'contactemailnum', 'serial', '',      '', '', '',
+        'contactnum',         'int', '',      '', '', '',
+        'emailaddress',   'varchar', '', $char_d, '', '',
+      ],
+      'primary_key' => 'contactemailnum',
+      'unique'      => [ [ 'emailaddress' ], ],
+      'index'       => [],
+    },
+
+    'prospect_main' => {
+      'columns' => [
+        'prospectnum',  'serial',     '',      '', '', '',
+        'agentnum',        'int',     '',      '', '', '',
+        'company',     'varchar',     '', $char_d, '', '',
+        #'disabled',     'char', 'NULL',       1, '', '', 
+      ],
+      'primary_key' => 'prospectnum',
+      'unique'      => [],
+      'index'       => [ [ 'company' ], [ 'agentnum' ], ],
+    },
+
     #eventually use for billing & ship from cust_main too
     #for now, just cust_pkg locations
-    'cust_location' => {
+    'cust_location' => { #'location' now that its prospects too, but...
       'columns' => [
         'locationnum',  'serial',     '',      '', '', '',
-        'custnum',         'int',     '',      '', '', '',
+        'prospectnum',     'int', 'NULL',      '', '', '',
+        'custnum',         'int', 'NULL',      '', '', '',
         'address1',    'varchar',     '', $char_d, '', '', 
         'address2',    'varchar', 'NULL', $char_d, '', '', 
         'city',        'varchar',     '', $char_d, '', '', 
@@ -795,7 +889,7 @@ sub tables_hashref {
       ],
       'primary_key' => 'locationnum',
       'unique'      => [],
-      'index'       => [ [ 'custnum' ],
+      'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
                        ],
     },
@@ -824,6 +918,30 @@ sub tables_hashref {
       'index' => [ [ 'custnum' ], [ '_date' ], ],
     },
 
+    'cust_category' => {
+      'columns' => [
+        'categorynum',   'serial',  '', '', '', '', 
+        'categoryname',  'varchar', '', $char_d, '', '', 
+        'weight',         'int', 'NULL',  '', '', '',
+        'disabled',      'char', 'NULL',   1, '', '', 
+      ],
+      'primary_key' => 'categorynum',
+      'unique' => [],
+      'index' => [ ['disabled'] ],
+    },
+
+    'cust_class' => {
+      'columns' => [
+        'classnum',    'serial',   '',      '', '', '', 
+        'classname',   'varchar',  '', $char_d, '', '', 
+        'categorynum', 'int',  'NULL',      '', '', '', 
+        'disabled',    'char', 'NULL',       1, '', '', 
+      ],
+      'primary_key' => 'classnum',
+      'unique' => [],
+      'index' => [ ['disabled'] ],
+    },
+
     'cust_main_exemption' => {
       'columns' => [
         'exemptionnum', 'serial', '',      '', '', '',
@@ -856,8 +974,9 @@ sub tables_hashref {
                             # a tax rate.
       'columns' => [
         'taxnum',   'serial',   '',    '', '', '', 
-        'state',    'varchar',  'NULL',    $char_d, '', '', 
+        'city',     'varchar',  'NULL',    $char_d, '', '',
         'county',   'varchar',  'NULL',    $char_d, '', '', 
+        'state',    'varchar',  'NULL',    $char_d, '', '', 
         'country',  'char',  '', 2, '', '', 
         'taxclass',   'varchar', 'NULL', $char_d, '', '', 
         'exempt_amount', @money_type, '', '', 
@@ -869,7 +988,7 @@ sub tables_hashref {
       'primary_key' => 'taxnum',
       'unique' => [],
   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
-      'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
+      'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
                    [ 'taxclass' ],
                  ],
     },
@@ -901,6 +1020,8 @@ sub tables_hashref {
         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
+        'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
+        'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
       ],
@@ -1064,6 +1185,8 @@ sub tables_hashref {
         'billpaypkgnum', 'serial', '', '', '', '',
         'billpaynum',       'int', '', '', '', '',
         'billpkgnum',       'int', '', '', '', '',
+        'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
+        'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
         'amount',         @money_type,     '', '',
         'setuprecur',      'varchar', '', $char_d, '', '',
        'sdate',   @date_type, '', '', 
@@ -1186,6 +1309,49 @@ sub tables_hashref {
       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
     },
 
+    'cust_pkg_discount' => {
+      'columns' => [
+        'pkgdiscountnum', 'serial', '',     '', '', '',
+        'pkgnum',            'int', '',     '', '', '', 
+        'discountnum',       'int', '',     '', '', '',
+        'months_used',   'decimal', 'NULL', '', '', '',
+        'end_date',     @date_type,             '', '',
+        'otaker',        'varchar', '',     32, '', '', 
+        'disabled',         'char', 'NULL',  1, '', '', 
+      ],
+      'primary_key' => 'pkgdiscountnum',
+      'unique' => [],
+      'index'  => [ [ 'pkgnum' ], [ 'discountnum' ] ],
+    },
+
+    'cust_bill_pkg_discount' => {
+      'columns' => [
+        'billpkgdiscountnum', 'serial',     '', '', '', '',
+        'billpkgnum',            'int',     '', '', '', '', 
+        'pkgdiscountnum',        'int',     '', '', '', '', 
+        'amount',          @money_type,             '', '', 
+        'months',            'decimal', 'NULL', '', '', '',
+      ],
+      'primary_key' => 'billpkgdiscountnum',
+      'unique' => [],
+      'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
+    },
+
+    'discount' => {
+      'columns' => [
+        'discountnum', 'serial',     '',      '', '', '',
+        #'agentnum',       'int', 'NULL',      '', '', '', 
+        'name',       'varchar', 'NULL', $char_d, '', '',
+        'amount',   @money_type,                  '', '', 
+        'percent',    'decimal',     '',      '', '', '',
+        'months',     'decimal', 'NULL',      '', '', '',
+        'disabled',      'char', 'NULL',       1, '', '', 
+      ],
+      'primary_key' => 'discountnum',
+      'unique' => [],
+      'index'  => [], # [ 'agentnum' ], ],
+    },
+
     'cust_refund' => {
       'columns' => [
         'refundnum',    'serial',    '',   '', '', '', 
@@ -1262,6 +1428,7 @@ sub tables_hashref {
         'custom',        'char', 'NULL', 1, '', '', 
         'taxclass',      'varchar', 'NULL', $char_d, '', '', 
         'classnum',      'int',     'NULL', '', '', '', 
+        'addon_classnum','int',     'NULL', '', '', '', 
         'taxproductnum', 'int',     'NULL', '', '', '', 
         'setup_cost',    @money_typen,          '', '',
         'recur_cost',    @money_typen,          '', '',
@@ -1272,7 +1439,9 @@ sub tables_hashref {
       ],
       'primary_key' => 'pkgpart',
       'unique' => [],
-      'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
+      'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
+                   [ 'agentnum' ],
+                 ],
     },
 
     'part_pkg_link' => {
@@ -1460,14 +1629,15 @@ sub tables_hashref {
         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
         'totalbytes','bigint', 'NULL',   '', '', '',
         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
-        'domsvc',    'int', '',   '', '', '', 
+        'domsvc',    'int',     '', '', '', '', 
+        'pbxsvc',    'int', 'NULL', '', '', '',
         'last_login',  @date_type, '', '', 
         'last_logout', @date_type, '', '', 
       ],
       'primary_key' => 'svcnum',
       #'unique' => [ [ 'username', 'domsvc' ] ],
       'unique' => [],
-      'index' => [ ['username'], ['domsvc'] ],
+      'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
     },
 
     'acct_rt_transaction' => {
@@ -1503,9 +1673,10 @@ sub tables_hashref {
        'parent_svcnum',    'int', 'NULL',       '', '', '',
        'registrarnum',     'int', 'NULL',       '', '', '',
        'registrarkey', 'varchar', 'NULL',      512, '', '',
-       'setup_date',  @date_type, '', '',
+       'setup_date',      @date_type, '', '',
        'renewal_interval', 'int', 'NULL',       '', '', '',
        'expiration_date', @date_type, '', '',
+        'max_accounts',     'int', 'NULL',       '', '', '',
       ],
       'primary_key' => 'svcnum',
       'unique' => [ ],
@@ -1631,7 +1802,7 @@ sub tables_hashref {
     'queue' => {
       'columns' => [
         'jobnum',      'serial',     '',      '', '', '', 
-        'job',           'text',     '',      '', '', '', 
+        'job',        'varchar',     '',     512, '', '', 
         '_date',          'int',     '',      '', '', '', 
         'status',     'varchar',     '', $char_d, '', '', 
         'statustext',    'text', 'NULL',      '', '', '', 
@@ -1681,6 +1852,17 @@ sub tables_hashref {
       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
     },
 
+    'export_device' => {
+      'columns' => [
+        'exportdevicenum' => 'serial', '', '', '', '', 
+        'exportnum'    => 'int', '', '', '', '', 
+        'devicepart'      => 'int', '', '', '', '', 
+      ],
+      'primary_key' => 'exportdevicenum',
+      'unique'      => [ [ 'exportnum', 'devicepart' ] ],
+      'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
+    },
+
     'part_export' => {
       'columns' => [
         'exportnum', 'serial', '', '', '', '', 
@@ -1750,13 +1932,15 @@ sub tables_hashref {
         'taxnum',       'int', '', '', '', '', 
         'year',         'int', '', '', '', '', 
         'month',        'int', '', '', '', '', 
+        'creditbillpkgnum', 'int', 'NULL', '', '', '',
         'amount',       @money_type, '', '', 
       ],
       'primary_key' => 'exemptpkgnum',
       'unique' => [],
       'index'  => [ [ 'taxnum', 'year', 'month' ],
                     [ 'billpkgnum' ],
-                    [ 'taxnum' ]
+                    [ 'taxnum' ],
+                    [ 'creditbillpkgnum' ],
                   ],
     },
 
@@ -1954,14 +2138,16 @@ sub tables_hashref {
       ],
       'primary_key' => 'prefixnum',
       'unique'      => [],
-      'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
+      'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
     },
 
     'usage_class' => {
       'columns' => [
-        'classnum',    'serial',   '',      '', '', '', 
-        'classname',   'varchar',  '', $char_d, '', '', 
-        'disabled',    'char', 'NULL',       1, '', '', 
+        'classnum',    'serial',      '',      '', '', '', 
+        'weight',      'int',     'NULL',      '', '', '',
+        'classname',   'varchar',     '', $char_d, '', '', 
+        'format',      'varchar', 'NULL', $char_d, '', '', 
+        'disabled',    'char',    'NULL',       1, '', '', 
       ],
       'primary_key' => 'classnum',
       'unique' => [],
@@ -2073,6 +2259,8 @@ sub tables_hashref {
       'columns' => [
         'categorynum',   'serial',  '', '', '', '', 
         'categoryname',  'varchar', '', $char_d, '', '', 
+        'weight',         'int', 'NULL',  '', '', '',
+        'condense',      'char', 'NULL',   1, '', '', 
         'disabled',      'char', 'NULL',   1, '', '', 
       ],
       'primary_key' => 'categorynum',
@@ -2136,6 +2324,8 @@ sub tables_hashref {
         ###
         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
         # defaults
+        # though these are now used elsewhere:
+        # charged_party, upstream_price, rated_price, carrierid
         ###
 
         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
@@ -2178,19 +2368,36 @@ sub tables_hashref {
         #NULL, done (or something)
         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '', 
 
+        #an indexed place to put big numbers
+        'cdrid',         'bigint',     'NULL',     '',  '', '', 
+
+        #old
         'cdrbatch', 'varchar', 'NULL', 255, '', '',
+        #new
+        'cdrbatchnum', 'int', 'NULL', '', '', '',
 
       ],
       'primary_key' => 'acctid',
       'unique' => [],
       'index' => [ [ 'calldate' ],
                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
-                   [ 'accountcode' ], [ 'carrierid' ],
+                   [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
-                   [ 'cdrbatch' ],
+                   [ 'cdrbatch' ], [ 'cdrbatchnum' ],
                  ],
     },
 
+    'cdr_batch' => {
+      'columns' => [
+        'cdrbatchnum',   'serial',    '',   '', '', '', 
+        'cdrbatch', 'varchar', 'NULL', 255, '', '',
+        '_date',     @date_type, '', '', 
+      ],
+      'primary_key' => 'cdrbatchnum',
+      'unique' => [ [ 'cdrbatch' ] ],
+      'index' => [],
+    },
+
     'cdr_termination' => {
       'columns' => [
         'cdrtermnum', 'bigserial',     '',      '', '', '',
@@ -2363,10 +2570,11 @@ sub tables_hashref {
         'pin',          'varchar', 'NULL', $char_d, '', '',
         'sip_password', 'varchar', 'NULL', $char_d, '', '',
         'phone_name',   'varchar', 'NULL', $char_d, '', '',
+        'pbxsvc',           'int', 'NULL',      '', '', '',
       ],
       'primary_key' => 'svcnum',
       'unique' => [],
-      'index'  => [ [ 'countrycode', 'phonenum' ] ],
+      'index'  => [ [ 'countrycode', 'phonenum' ], ['pbxsvc'] ],
     },
 
     'phone_device' => {
@@ -2461,6 +2669,20 @@ sub tables_hashref {
       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
     },
+
+    'svc_pbx' => {
+      'columns' => [
+        'svcnum',         'int',     '',      '', '', '', 
+        'id',             'int', 'NULL',      '', '', '', 
+        'title',      'varchar', 'NULL', $char_d, '', '', 
+        'max_extensions', 'int', 'NULL',      '', '', '',
+      ],
+      'primary_key' => 'svcnum',
+      'unique' => [],
+      'index'  => [ [ 'id' ] ],
+    },
+
+
     # name type nullability length default local
 
     #'new_table' => {