Merge branch 'master' of https://github.com/jgoodman/Freeside
[freeside.git] / FS / FS / Schema.pm
1 package FS::Schema;
2
3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
4 use subs qw(reload_dbdef);
5 use Exporter;
6 use DBIx::DBSchema 0.44; #for foreign keys with MATCH / ON DELETE/UPDATE
7 use DBIx::DBSchema::Table;
8 use DBIx::DBSchema::Column;
9 use DBIx::DBSchema::Index;
10 use DBIx::DBSchema::ForeignKey;
11 #can't use this yet, dependency bs #use FS::Conf;
12
13 @ISA = qw(Exporter);
14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
15
16 $DEBUG = 0;
17 $me = '[FS::Schema]';
18
19 =head1 NAME
20
21 FS::Schema - Freeside database schema
22
23 =head1 SYNOPSYS
24
25     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
26
27     $dbdef = reload_dbdef;
28     $dbdef = reload_dbdef "/non/standard/filename";
29     $dbdef = dbdef;
30     $dbdef_dist = dbdef_dist;
31
32 =head1 DESCRIPTION
33
34 This class represents the database schema.
35
36 =head1 METHODS
37
38 =over 4
39
40 =item reload_dbdef([FILENAME])
41
42 Load a database definition (see L<DBIx::DBSchema>), optionally from a
43 non-default filename.  This command is executed at startup unless
44 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
45
46 =cut
47
48 sub reload_dbdef {
49   my $file = shift;
50
51   unless ( exists $dbdef_cache{$file} ) {
52     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
53     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
54       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
55   } else {
56     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
57   }
58   $dbdef = $dbdef_cache{$file};
59 }
60
61 =item dbdef
62
63 Returns the current database definition (represents the current database,
64 assuming it is up-to-date).  See L<DBIx::DBSchema>.
65
66 =cut
67
68 sub dbdef { $dbdef; }
69
70 =item dbdef_dist [ DATASRC ]
71
72 Returns the current canoical database definition as defined in this file.
73
74 Optionally, pass a DBI data source to enable syntax specific to that database.
75 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
76
77 =cut
78
79 sub dbdef_dist {
80   my $datasrc = @_ && !ref($_[0]) ? shift : '';
81   my $opt = @_ ? shift : {};
82   
83   my $local_options = '';
84   if ( $datasrc =~ /^dbi:mysql/i ) {
85     $local_options = 'ENGINE=InnoDB';
86   }
87
88   ###
89   # create a dbdef object from the old data structure
90   ###
91
92   my $tables_hashref = tables_hashref();
93
94   #turn it into objects
95   my $dbdef = new DBIx::DBSchema map {  
96
97     my $tablename = $_;
98     my $indexnum = 1;
99
100     my @columns;
101     while (@{$tables_hashref->{$tablename}{'columns'}}) {
102       #my($name, $type, $null, $length, $default, $local) =
103       my @coldef = 
104         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
105       my %hash = map { $_ => shift @coldef }
106                      qw( name type null length default local );
107
108       #can be removed once we depend on DBIx::DBSchema 0.39;
109       $hash{'type'} = 'LONGTEXT'
110         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
111
112       unless ( defined $hash{'default'} ) {
113         warn "$tablename:\n".
114              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
115       }
116
117       push @columns, new DBIx::DBSchema::Column ( \%hash );
118     }
119
120     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
121     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
122     my $unique = $tables_hashref->{$tablename}{'unique'};
123     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
124     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
125
126     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
127     #  specification without a key length".
128     # better solution: teach DBIx::DBSchema to specify a default length for
129     #  MySQL indices on text columns, or just to support an index length at all
130     #  so we can pass something in.
131     # best solution: eliminate need for this index in cust_main::retry_realtime
132     @index = grep { @{$_}[0] ne 'statustext' } @index
133       if $datasrc =~ /^dbi:mysql/i;
134
135     my @indices = ();
136     push @indices, map {
137                          DBIx::DBSchema::Index->new({
138                            'name'    => $tablename. $indexnum++,
139                            'unique'  => 1,
140                            'columns' => $_,
141                          });
142                        }
143                        @$unique;
144     push @indices, map {
145                          DBIx::DBSchema::Index->new({
146                            'name'    => $tablename. $indexnum++,
147                            'unique'  => 0,
148                            'columns' => $_,
149                          });
150                        }
151                        @index;
152
153     my @foreign_keys =
154       map DBIx::DBSchema::ForeignKey->new($_),
155         @{ $tables_hashref->{$tablename}{'foreign_keys'} || [] };
156
157     DBIx::DBSchema::Table->new({
158       name          => $tablename,
159       primary_key   => $tables_hashref->{$tablename}{'primary_key'},
160       columns       => \@columns,
161       indices       => \@indices,
162       foreign_keys  => \@foreign_keys,
163       local_options => $local_options,
164     });
165
166   } keys %$tables_hashref;
167
168   if ( $DEBUG ) {
169     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
170     warn "[debug]$me   $_\n" foreach $dbdef->tables;
171   }
172   
173   #add radius attributes to svc_acct
174   #
175   #my($svc_acct)=$dbdef->table('svc_acct');
176   # 
177   #my($attribute);
178   #foreach $attribute (@attributes) {
179   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
180   #    'radius_'. $attribute,
181   #    'varchar',
182   #    'NULL',
183   #    $char_d,
184   #  ));
185   #}
186   # 
187   #foreach $attribute (@check_attributes) {
188   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
189   #    'rc_'. $attribute,
190   #    'varchar',
191   #    'NULL',
192   #    $char_d,
193   #  ));
194   #}
195
196   my $tables_hashref_torrus = tables_hashref_torrus();
197
198   #create history tables
199   foreach my $table (
200     grep {    ! /^(clientapi|access_user)_session/
201            && ! /^h_/
202            && ! /^log(_context)?$/
203            && ( ! /^queue(_arg)?$/ || ! $opt->{'queue-no_history'} )
204            && ! $tables_hashref_torrus->{$_}
205          }
206       $dbdef->tables
207   ) {
208     my $tableobj = $dbdef->table($table)
209       or die "unknown table $table";
210
211     my %h_indices = ();
212
213     unless ( $table eq 'cust_event' || $table eq 'cdr' ) { #others?
214
215       my %indices = $tableobj->indices;
216     
217       %h_indices = map { 
218                          ( "h_$_" =>
219                              DBIx::DBSchema::Index->new({
220                                'name'    => 'h_'. $indices{$_}->name,
221                                'unique'  => 0,
222                                'columns' => [ @{$indices{$_}->columns} ],
223                              })
224                          );
225                        }
226                        keys %indices;
227
228       $h_indices{"h_${table}_srckey"} =
229         DBIx::DBSchema::Index->new({
230           'name'    => "h_${table}_srckey",
231           'unique'  => 0,
232           'columns' => [ 'history_action', #right?
233                          $tableobj->primary_key,
234                        ],
235         });
236
237       $h_indices{"h_${table}_srckey2"} =
238          DBIx::DBSchema::Index->new({
239            'name'    => "h_${table}_srckey2",
240            'unique'  => 0,
241            'columns' => [ 'history_date',
242                           $tableobj->primary_key,
243                         ],
244          });
245
246     }
247
248     my $primary_key_col = $tableobj->column($tableobj->primary_key)
249       or die "$table: primary key declared as ". $tableobj->primary_key.
250              ", but no column of that name\n";
251
252     my $historynum_type = ( $tableobj->column($tableobj->primary_key)->type
253                               =~ /^(bigserial|bigint|int8)$/i
254                                 ? 'bigserial'
255                                 : 'serial'
256                           );
257
258     my $h_tableobj = DBIx::DBSchema::Table->new( {
259       'name'          => "h_$table",
260       'primary_key'   => 'historynum',
261       'indices'       => \%h_indices,
262       'local_options' => $local_options,
263       'columns'       => [
264           DBIx::DBSchema::Column->new( {
265             'name'    => 'historynum',
266             'type'    => $historynum_type,
267             'null'    => 'NOT NULL',
268             'length'  => '',
269             'default' => '',
270             'local'   => '',
271           } ),
272           DBIx::DBSchema::Column->new( {
273             'name'    => 'history_date',
274             'type'    => 'int',
275             'null'    => 'NULL',
276             'length'  => '',
277             'default' => '',
278             'local'   => '',
279           } ),
280           DBIx::DBSchema::Column->new( {
281             'name'    => 'history_user',
282             'type'    => 'varchar',
283             'null'    => 'NULL',
284             'length'  => '80',
285             'default' => '',
286             'local'   => '',
287           } ),
288           DBIx::DBSchema::Column->new( {
289             'name'    => 'history_usernum',
290             'type'    => 'int',
291             'null'    => 'NULL',
292             'length'  => '',
293             'default' => '',
294             'local'   => '',
295           } ),
296           DBIx::DBSchema::Column->new( {
297             'name'    => 'history_action',
298             'type'    => 'varchar',
299             'null'    => 'NOT NULL',
300             'length'  => '80',
301             'default' => '',
302             'local'   => '',
303           } ),
304           map {
305             my $column = $tableobj->column($_);
306     
307             #clone so as to not disturb the original
308             $column = DBIx::DBSchema::Column->new( {
309               map { $_ => $column->$_() }
310                 qw( name type null length default local )
311             } );
312     
313             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
314               $column->type(uc($1).'INT');
315               $column->null('NULL');
316             }
317             #$column->default('')
318             #  if $column->default =~ /^nextval\(/i;
319             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
320             #$column->local($local);
321             $column;
322           } $tableobj->columns
323       ],
324     } );
325     $dbdef->addtable($h_tableobj);
326   }
327
328   if ( $datasrc =~ /^dbi:mysql/i ) {
329
330     my $dup_lock_table = DBIx::DBSchema::Table->new( {
331       'name'          => 'duplicate_lock',
332       'primary_key'   => 'duplocknum',
333       'local_options' => $local_options,
334       'columns'       => [
335         DBIx::DBSchema::Column->new( {
336           'name'    => 'duplocknum',
337           'type'    => 'serial',
338           'null'    => 'NOT NULL',
339           'length'  => '',
340           'default' => '',
341           'local'   => '',
342         } ),
343         DBIx::DBSchema::Column->new( {
344           'name'    => 'lockname',
345           'type'    => 'varchar',
346           'null'    => 'NOT NULL',
347           'length'  => '80',
348           'default' => '',
349           'local'   => '',
350         } ),
351       ],
352       'indices' => { 'duplicate_lock1' =>
353                        DBIx::DBSchema::Index->new({
354                          'name'    => 'duplicate_lock1',
355                          'unique'  => 1,
356                          'columns' => [ 'lockname' ],
357                        })
358                    },
359     } );
360
361     $dbdef->addtable($dup_lock_table);
362
363   }
364
365   $dbdef;
366
367 }
368
369 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
370 sub tables_hashref_torrus {
371
372   return {
373
374     # Collector export table. It usually grows at several megabytes
375     # per month, and is updated every 5 minutes
376     'srvexport' => {
377       'columns' => [
378         'id',         'serial', '', '', '', '',
379         'srv_date',     'date', '', '', '', '',#date and time of the data sample
380         'srv_time',     'time', '', '', '', '',
381         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
382         'value',     'double precision', '', '', '', '',#collected rate or gauge value
383         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
384       ],
385       'primary_key' => 'id',
386       'unique' => [],
387       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
388     },
389
390     #Tables for (currently monthly only) report contents.
391     #These are updated usually once per month, and read at the moment of
392     #rendering the report output (HTML now, PDF or XML or Excel or whatever
393     #in the future)
394
395     #DBIx::Sequence backend, theplatform-independent inplementation
396     #of sequences
397     'dbix_sequence_state' => {
398       'columns' => [
399         'id',       'serial', '', '', '', '',
400         'dataset', 'varchar', '', 50, '', '',
401         'state_id',    'int', '', '', '', '',
402       ],
403       'primary_key' => 'id',
404       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
405       'unique' => [ [ 'dataset', 'state_id' ], ],
406       'index'  => [],
407     },
408
409     'dbix_sequence_release' => {
410       'columns' => [
411         'id',       'serial', '', '', '', '',
412         'dataset', 'varchar', '', 50, '', '',
413         'released_id', 'int', '', '', '', '',
414       ],
415       'primary_key' => 'id',
416       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
417       'unique' => [ [ 'dataset', 'released_id', ] ],
418       'index'  => [],
419     },
420
421     #Each report is characterized by name, date and time.
422     #Monthly reports are automatically assigned 00:00 of the 1st day
423     #in the month. The report contains fields for every service ID
424     #defined across all datasource trees.
425     'reports' => {
426       'columns' => [
427         'id',          'serial', '', '', '', '',
428         'rep_date',      'date', '', '', '', '',#Start date of the report
429         'rep_time',      'time', '', '', '', '',#Start time of the report
430         'reportname', 'varchar', '', 64, '', '',#Report name, such as
431                                                 # MonthlyUsage
432         'iscomplete',     'int', '', '', '', '',#0 when the report is in
433                                                 # progress, 1 when it is ready
434       ],
435       'primary_key' => 'id',
436       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
437       'index'  => [ [ 'rep_date' ] ],
438     },
439
440     #Each report contains fields. For each service ID,
441     #the report may contain several fields for various statistics.
442     #Each field contains information about the units of the value it
443     #contains
444     'reportfields' => {
445       'columns' => [
446         'id',              'serial',     '', '',    '', '',
447         'rep_id',             'int', 'NULL', '',    '', '',
448         'name',           'varchar',     '', 64,    '', '',#name of the field,
449                                                            # such as AVG or MAX
450         'serviceid',      'varchar',     '', 64,    '', '',#service ID
451         'value', 'double precision',     '', '',    '', '',#Numeric value
452         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
453                                                            # or Mbps
454       ],
455       'primary_key', => 'id',
456       'unique' => [ [ qw(rep_id name serviceid) ] ],
457       'index'  => [],
458     },
459
460   };
461
462 }
463
464 sub tables_hashref {
465
466   my $char_d = 80; #default maxlength for text fields
467
468   #my(@date_type)  = ( 'timestamp', '', ''     );
469   my @date_type  = ( 'int', 'NULL', ''     );
470   my @perl_type = ( 'text', 'NULL', ''  ); 
471   my @money_type = ( 'decimal',   '', '10,2' );
472   my @money_typen = ( 'decimal',   'NULL', '10,2' );
473   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for 
474   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
475
476   my $username_len = 64; #usernamemax config file
477
478     # name type nullability length default local
479
480   return {
481
482     'agent' => {
483       'columns' => [
484         'agentnum',          'serial',    '',       '', '', '', 
485         'agent',            'varchar',    '',  $char_d, '', '', 
486         'typenum',              'int',    '',       '', '', '', 
487         'ticketing_queueid',    'int', 'NULL',      '', '', '', 
488         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
489         'agent_custnum',        'int', 'NULL',      '', '', '',
490         'disabled',            'char', 'NULL',       1, '', '', 
491         'username',         'varchar', 'NULL', $char_d, '', '',
492         '_password',        'varchar', 'NULL', $char_d, '', '',
493         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
494         'prog',                     @perl_type, '', '', #deprecated (never used)
495       ],
496       'primary_key'  => 'agentnum',
497       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
498                                             #insert is giving it a value, tho..
499       #'index' => [ ['typenum'], ['disabled'] ],
500       'unique'       => [],
501       'index'        => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
502       'foreign_keys' => [
503                           { columns    => [ 'typenum' ],
504                             table      => 'agent_type',
505                           },
506                           # 1. RT tables aren't part of our data structure, so
507                           #     we can't make sure Queue is created already
508                           # 2. Future ability to plug in other ticketing systems
509                           #{ columns    => [ 'ticketing_queueid' ],
510                           #  table      => 'Queue',
511                           #  references => [ 'id' ],
512                           #},
513                           { columns    => [ 'agent_custnum' ],
514                             table      => 'cust_main',
515                             references => [ 'custnum' ],
516                           },
517                         ],
518     },
519
520     'agent_pkg_class' => {
521       'columns' => [
522         'agentpkgclassnum',    'serial',     '',    '', '', '',
523         'agentnum',               'int',     '',    '', '', '',
524         'classnum',               'int', 'NULL',    '', '', '',
525         'commission_percent', 'decimal',     '', '7,4', '', '',
526       ],
527       'primary_key'  => 'agentpkgclassnum',
528       'unique'       => [ [ 'agentnum', 'classnum' ], ],
529       'index'        => [],
530       'foreign_keys' => [
531                           { columns    => [ 'agentnum' ],
532                             table      => 'agent',
533                           },
534                           { columns    => [ 'classnum' ],
535                             table      => 'pkg_class',
536                           },
537                         ],
538     },
539
540     'agent_type' => {
541       'columns' => [
542         'typenum',   'serial',  '', '', '', '', 
543         'atype',     'varchar', '', $char_d, '', '', 
544       ],
545       'primary_key' => 'typenum',
546       'unique' => [],
547       'index' => [],
548     },
549
550     'type_pkgs' => {
551       'columns' => [
552         'typepkgnum', 'serial', '', '', '', '', 
553         'typenum',   'int',  '', '', '', '', 
554         'pkgpart',   'int',  '', '', '', '', 
555       ],
556       'primary_key'  => 'typepkgnum',
557       'unique'       => [ ['typenum', 'pkgpart'] ],
558       'index'        => [ ['typenum'] ],
559       'foreign_keys' => [
560                           { columns    => [ 'typenum' ],
561                             table      => 'agent_type',
562                           },
563                           { columns    => [ 'pkgpart' ],
564                             table      => 'part_pkg',
565                           },
566                         ],
567     },
568
569     'agent_currency' => {
570       'columns' => [
571         'agentcurrencynum', 'serial', '', '', '', '',
572         'agentnum',            'int', '', '', '', '',
573         'currency',           'char', '',  3, '', '',
574       ],
575       'primary_key'  => 'agentcurrencynum',
576       'unique'       => [],
577       'index'        => [ ['agentnum'] ],
578       'foreign_keys' => [
579                           { columns    => [ 'agentnum' ],
580                             table      => 'agent',
581                           },
582                         ],
583     },
584
585     'sales' => {
586       'columns' => [
587         'salesnum',          'serial',    '',       '', '', '', 
588         'salesperson',      'varchar',    '',  $char_d, '', '', 
589         'agentnum',             'int', 'NULL',      '', '', '', 
590         'sales_custnum',        'int', 'NULL',      '', '', '',
591         'disabled',            'char', 'NULL',       1, '', '', 
592       ],
593       'primary_key'  => 'salesnum',
594       'unique'       => [],
595       'index'        => [ ['salesnum'], ['disabled'] ],
596       'foreign_keys' => [
597                           { columns    => [ 'agentnum' ],
598                             table      => 'agent',
599                           },
600                           { columns    => [ 'sales_custnum' ],
601                             table      => 'cust_main',
602                             references => [ 'custnum' ],
603                           },
604                         ],
605     },
606
607     'sales_pkg_class' => {
608       'columns' => [
609         'salespkgclassnum',    'serial',     '',    '', '', '',
610         'salesnum',               'int',     '',    '', '', '',
611         'classnum',               'int', 'NULL',    '', '', '',
612         'commission_percent', 'decimal',     '', '7,4', '', '',
613         'commission_duration',    'int', 'NULL',    '', '', '',
614       ],
615       'primary_key'  => 'salespkgclassnum',
616       'unique'       => [ [ 'salesnum', 'classnum' ], ],
617       'index'        => [],
618       'foreign_keys' => [
619                           { columns    => [ 'salesnum' ],
620                             table      => 'sales',
621                           },
622                           { columns    => [ 'classnum' ],
623                             table      => 'pkg_class',
624                           },
625                         ],
626     },
627
628     'cust_attachment' => {
629       'columns' => [
630         'attachnum', 'serial', '', '', '', '',
631         'custnum',   'int', '', '', '', '',
632         '_date',     @date_type, '', '',
633         'otaker',    'varchar', 'NULL', 32, '', '',
634         'usernum',   'int', 'NULL', '', '', '',
635         'filename',  'varchar', '', 255, '', '',
636         'mime_type', 'varchar', '', $char_d, '', '',
637         'title',     'varchar', 'NULL', $char_d, '', '',
638         'body',      'blob', 'NULL', '', '', '',
639         'disabled',  @date_type, '', '',
640       ],
641       'primary_key'  => 'attachnum',
642       'unique'       => [],
643       'index'        => [ ['custnum'], ['usernum'], ],
644       'foreign_keys' => [
645                           { columns    => [ 'custnum' ],
646                             table      => 'cust_main',
647                           },
648                           { columns    => [ 'usernum' ],
649                             table      => 'access_user',
650                           },
651                         ],
652    },
653
654     'cust_bill' => {
655       'columns' => [
656         #regular fields
657         'invnum',         'serial',     '',      '', '', '', 
658         'custnum',           'int',     '',      '', '', '', 
659         '_date',        @date_type,                  '', '', 
660         'charged',     @money_type,                  '', '', 
661         'currency',         'char', 'NULL',       3, '', '',
662         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
663
664         #customer balance info at invoice generation time
665         'previous_balance',   @money_typen, '', '',  #eventually not nullable
666         'billing_balance',    @money_typen, '', '',  #eventually not nullable
667
668         #deprecated (unused by now, right?)
669         'printed',      'int',     '', '', '', '', 
670
671         #specific use cases
672         'closed',      'char', 'NULL',  1, '', '', #not yet used much
673         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
674         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
675         'promised_date', @date_type,       '', '',
676       ],
677       'primary_key'  => 'invnum',
678       'unique'       => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
679       'index'        => [ ['custnum'], ['_date'], ['statementnum'],
680                           ['agent_invid'],
681                         ],
682       'foreign_keys' => [
683                           { columns    => [ 'custnum' ],
684                             table      => 'cust_main',
685                           },
686                           { columns    => [ 'statementnum' ],
687                             table      => 'cust_statement',
688                           },
689                         ],
690     },
691
692     'cust_bill_void' => {
693       'columns' => [
694         #regular fields
695         'invnum',            'int',     '',      '', '', '', 
696         'custnum',           'int',     '',      '', '', '', 
697         '_date',        @date_type,                  '', '', 
698         'charged',     @money_type,                  '', '', 
699         'currency',         'char', 'NULL',       3, '', '',
700         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
701
702         #customer balance info at invoice generation time
703         'previous_balance',   @money_typen, '', '',  #eventually not nullable
704         'billing_balance',    @money_typen, '', '',  #eventually not nullable
705
706         #specific use cases
707         'closed',      'char', 'NULL',  1, '', '', #not yet used much
708         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
709         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
710         'promised_date', @date_type,       '', '',
711
712         #void fields
713         'void_date', @date_type, '', '', 
714         'reason',    'varchar',   'NULL', $char_d, '', '', 
715         'void_usernum',   'int', 'NULL', '', '', '',
716       ],
717       'primary_key'  => 'invnum',
718       'unique'       => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
719       'index'        => [ ['custnum'], ['_date'], ['statementnum'],
720                           ['agent_invid'], [ 'void_usernum' ],
721                         ],
722       'foreign_keys' => [
723                           { columns    => [ 'custnum' ],
724                             table      => 'cust_main',
725                           },
726                           { columns    => [ 'statementnum' ],
727                             table      => 'cust_statement', #_void? both?
728                           },
729                           { columns    => [ 'void_usernum' ],
730                             table      => 'access_user',
731                             references => [ 'usernum' ],
732                           },
733                         ],
734     },
735
736     #for importing invoices from a legacy system for display purposes only
737     # no effect upon balance
738     'legacy_cust_bill' => {
739       'columns' => [
740         'legacyinvnum',  'serial',     '',      '', '', '',
741         'legacyid',     'varchar', 'NULL', $char_d, '', '',
742         'custnum',          'int',     '',      '', '', '', 
743         '_date',       @date_type,                  '', '', 
744         'charged',    @money_type,                  '', '', 
745         'currency',        'char', 'NULL',       3, '', '',
746         'content_pdf',     'blob', 'NULL',      '', '', '',
747         'content_html',    'text', 'NULL',      '', '', '',
748         'locale',       'varchar', 'NULL',      16, '', '', 
749       ],
750       'primary_key'  => 'legacyinvnum',
751       'unique'       => [],
752       'index'        => [ ['legacyid', 'custnum', 'locale' ], ],
753       'foreign_keys' => [
754                           { columns    => [ 'custnum' ],
755                             table      => 'cust_main',
756                           },
757                         ],
758     },
759
760     'cust_statement' => {
761       'columns' => [
762         'statementnum', 'serial', '', '', '', '',
763         'custnum',         'int', '', '', '', '',
764         '_date',           @date_type,    '', '',
765       ],
766       'primary_key'  => 'statementnum',
767       'unique'       => [],
768       'index'        => [ ['custnum'], ['_date'], ],
769       'foreign_keys' => [
770                           { columns    => [ 'custnum' ],
771                             table      => 'cust_main',
772                           },
773                         ],
774     },
775
776     #old "invoice" events, deprecated
777     'cust_bill_event' => {
778       'columns' => [
779         'eventnum',    'serial',  '', '', '', '', 
780         'invnum',   'int',  '', '', '', '', 
781         'eventpart',   'int',  '', '', '', '', 
782         '_date',     @date_type, '', '', 
783         'status', 'varchar', '', $char_d, '', '', 
784         'statustext', 'text', 'NULL', '', '', '', 
785       ],
786       'primary_key'  => 'eventnum',
787       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
788       'unique'       => [],
789       'index'        => [ ['invnum'], ['status'], ['eventpart'],
790                           ['statustext'], ['_date'],
791                         ],
792       'foreign_keys' => [
793                           { columns    => [ 'invnum' ],
794                             table      => 'cust_bill',
795                           },
796                           { columns    => [ 'eventpart' ],
797                             table      => 'part_bill_event',
798                           },
799                         ],
800     },
801
802     #old "invoice" events, deprecated
803     'part_bill_event' => {
804       'columns' => [
805         'eventpart',    'serial',  '', '', '', '', 
806         'freq',        'varchar',       'NULL',     $char_d, '', '', 
807         'payby',       'char',  '', 4, '', '', 
808         'event',       'varchar',           '',     $char_d, '', '', 
809         'eventcode',    @perl_type, '', '', 
810         'seconds',     'int', 'NULL', '', '', '', 
811         'weight',      'int', '', '', '', '', 
812         'plan',       'varchar', 'NULL', $char_d, '', '', 
813         'plandata',   'text', 'NULL', '', '', '', 
814         'reason',     'int', 'NULL', '', '', '', 
815         'disabled',     'char', 'NULL', 1, '', '', 
816       ],
817       'primary_key'  => 'eventpart',
818       'unique'       => [],
819       'index'        => [ ['payby'], ['disabled'], ],
820       'foreign_keys' => [
821                           { columns    => [ 'reason' ],
822                             table      => 'reason',
823                             references => [ 'reasonnum' ],
824                           },
825                         ],
826     },
827
828     'part_event' => {
829       'columns' => [
830         'eventpart',   'serial',      '',      '', '', '', 
831         'agentnum',    'int',     'NULL',      '', '', '', 
832         'event',       'varchar',     '', $char_d, '', '', 
833         'eventtable',  'varchar',     '', $char_d, '', '',
834         'check_freq',  'varchar', 'NULL', $char_d, '', '', 
835         'weight',      'int',         '',      '', '', '', 
836         'action',      'varchar',     '', $char_d, '', '',
837         'disabled',     'char',   'NULL',       1, '', '', 
838       ],
839       'primary_key'  => 'eventpart',
840       'unique'       => [],
841       'index'        => [ ['agentnum'], ['eventtable'], ['check_freq'],
842                           ['disabled'],
843                         ],
844       'foreign_keys' => [
845                           { columns    => [ 'agentnum' ],
846                             table      => 'agent',
847                           },
848                         ],
849     },
850
851     'part_event_option' => {
852       'columns' => [
853         'optionnum', 'serial', '', '', '', '', 
854         'eventpart', 'int', '', '', '', '', 
855         'optionname', 'varchar', '', $char_d, '', '', 
856         'optionvalue', 'text', 'NULL', '', '', '', 
857       ],
858       'primary_key'  => 'optionnum',
859       'unique'       => [],
860       'index'        => [ [ 'eventpart' ], [ 'optionname' ] ],
861       'foreign_keys' => [
862                           { columns    => [ 'eventpart' ],
863                             table      => 'part_event',
864                           },
865                         ],
866     },
867
868     'part_event_condition' => {
869       'columns' => [
870         'eventconditionnum', 'serial', '', '', '', '', 
871         'eventpart', 'int', '', '', '', '', 
872         'conditionname', 'varchar', '', $char_d, '', '', 
873       ],
874       'primary_key'  => 'eventconditionnum',
875       'unique'       => [],
876       'index'        => [ [ 'eventpart' ], [ 'conditionname' ] ],
877       'foreign_keys' => [
878                           { columns    => [ 'eventpart' ],
879                             table      => 'part_event',
880                           },
881                         ],
882     },
883
884     'part_event_condition_option' => {
885       'columns' => [
886         'optionnum', 'serial', '', '', '', '', 
887         'eventconditionnum', 'int', '', '', '', '', 
888         'optionname', 'varchar', '', $char_d, '', '', 
889         'optionvalue', 'text', 'NULL', '', '', '', 
890       ],
891       'primary_key'  => 'optionnum',
892       'unique'       => [],
893       'index'        => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
894       'foreign_keys' => [
895                           { columns    => [ 'eventconditionnum' ],
896                             table      => 'part_event_condition',
897                           },
898                         ],
899     },
900
901     'part_event_condition_option_option' => {
902       'columns' => [
903         'optionoptionnum', 'serial', '', '', '', '', 
904         'optionnum', 'int', '', '', '', '', 
905         'optionname', 'varchar', '', $char_d, '', '', 
906         'optionvalue', 'text', 'NULL', '', '', '', 
907       ],
908       'primary_key'  => 'optionoptionnum',
909       'unique'       => [],
910       'index'        => [ [ 'optionnum' ], [ 'optionname' ] ],
911       'foreign_keys' => [
912                           { columns    => [ 'optionnum' ],
913                             table      => 'part_event_condition_option',
914                           },
915                         ],
916     },
917
918     'cust_event' => {
919       'columns' => [
920         'eventnum',    'serial',  '', '', '', '', 
921         'eventpart',   'int',  '', '', '', '', 
922         'tablenum',   'int',  '', '', '', '', 
923         '_date',     @date_type, '', '', 
924         'status', 'varchar', '', $char_d, '', '', 
925         'statustext', 'text', 'NULL', '', '', '', 
926       ],
927       'primary_key'  => 'eventnum',
928       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
929       'unique'       => [],
930       'index'        => [ ['eventpart'], ['tablenum'], ['status'],
931                           ['statustext'], ['_date'],
932                         ],
933       'foreign_keys' => [
934                           { columns    => [ 'eventpart' ],
935                             table      => 'part_event',
936                           },
937                         ],
938     },
939
940     'cust_event_fee' => {
941       'columns' => [
942         'eventfeenum', 'serial', '', '', '', '',
943         'eventnum',       'int', '', '', '', '',
944         'billpkgnum',     'int', 'NULL', '', '', '',
945         'feepart',        'int', '', '', '', '',
946         'nextbill',      'char', 'NULL',  1, '', '',
947       ],
948       'primary_key'  => 'eventfeenum', # I'd rather just use eventnum
949       'unique' => [ [ 'billpkgnum' ], [ 'eventnum' ] ], # one-to-one link
950       'index'  => [ [ 'feepart' ] ],
951       'foreign_keys' => [
952                           { columns => [ 'eventnum' ],
953                             table   => 'cust_event',
954                           },
955                           { columns => [ 'billpkgnum' ],
956                             table   => 'cust_bill_pkg',
957                           },
958                           { columns => [ 'feepart' ],
959                             table   => 'part_fee',
960                           },
961                         ],
962     },
963
964     'cust_bill_pkg' => {
965       'columns' => [
966         'billpkgnum',          'serial',     '',      '', '', '', 
967         'invnum',                 'int',     '',      '', '', '', 
968         'pkgnum',                 'int',     '',      '', '', '', 
969         'pkgpart_override',       'int', 'NULL',      '', '', '', 
970         'setup',                 @money_type,             '', '', 
971         'unitsetup',             @money_typen,            '', '', 
972         'setup_billed_currency', 'char', 'NULL',       3, '', '',
973         'setup_billed_amount',   @money_typen,            '', '',
974         'recur',                 @money_type,             '', '', 
975         'unitrecur',             @money_typen,            '', '', 
976         'recur_billed_currency', 'char', 'NULL',       3, '', '',
977         'recur_billed_amount',   @money_typen,            '', '',
978         'sdate',                 @date_type,              '', '', 
979         'edate',                 @date_type,              '', '', 
980         'itemdesc',           'varchar', 'NULL', $char_d, '', '', 
981         'itemcomment',        'varchar', 'NULL', $char_d, '', '', 
982         'section',            'varchar', 'NULL', $char_d, '', '', 
983         'freq',               'varchar', 'NULL', $char_d, '', '',
984         'quantity',               'int', 'NULL',      '', '', '',
985         'hidden',                'char', 'NULL',       1, '', '',
986         'feepart',                'int', 'NULL',      '', '', '',
987       ],
988       'primary_key'  => 'billpkgnum',
989       'unique'       => [],
990       'index'        => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
991       'foreign_keys' => [
992                           { columns    => [ 'invnum' ],
993                             table      => 'cust_bill',
994                           },
995                           #pkgnum 0 and -1 are used for special things
996                           #{ columns    => [ 'pkgnum' ],
997                           #  table      => 'cust_pkg',
998                           #},
999                           { columns    => [ 'pkgpart_override' ],
1000                             table      => 'part_pkg',
1001                             references => [ 'pkgpart' ],
1002                           },
1003                           { columns    => [ 'feepart' ],
1004                             table      => 'part_fee',
1005                           },
1006                         ],
1007     },
1008
1009     'cust_bill_pkg_detail' => {
1010       'columns' => [
1011         'detailnum', 'serial', '', '', '', '', 
1012         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
1013         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
1014         'invnum',  'int', 'NULL', '', '', '',           # deprecated
1015         'amount',  'decimal', 'NULL', '10,4', '', '',
1016         'format',  'char', 'NULL', 1, '', '',
1017         'classnum', 'int', 'NULL', '', '', '',
1018         'duration', 'int', 'NULL', '',  0, '',
1019         'phonenum', 'varchar', 'NULL', 255, '', '', # has to hold a service label
1020         'accountcode', 'varchar',  'NULL',      20, '', '',
1021         'startdate',  @date_type, '', '', 
1022         'regionname', 'varchar', 'NULL', $char_d, '', '',
1023         'detail',  'varchar', '', 255, '', '', 
1024       ],
1025       'primary_key'  => 'detailnum',
1026       'unique'       => [],
1027       'index'        => [ [ 'billpkgnum' ], [ 'classnum' ],
1028                           [ 'pkgnum', 'invnum' ],
1029                         ],
1030       'foreign_keys' => [
1031                           { columns    => [ 'billpkgnum' ],
1032                             table      => 'cust_bill_pkg',
1033                           },
1034                           #{ columns    => [ 'pkgnum' ],
1035                           #  table      => 'cust_pkg',
1036                           #},
1037                           #{ columns    => [ 'invnum' ],
1038                           #  table      => 'cust_bill',
1039                           #},
1040                           { columns    => [ 'classnum' ],
1041                             table      => 'usage_class',
1042                           },
1043                         ],
1044     },
1045
1046     'cust_bill_pkg_display' => {
1047       'columns' => [
1048         'billpkgdisplaynum', 'serial', '', '', '', '',
1049         'billpkgnum', 'int', '', '', '', '', 
1050         'section',  'varchar', 'NULL', $char_d, '', '', 
1051         #'unitsetup', @money_typen, '', '',     #override the linked real one?
1052         #'unitrecur', @money_typen, '', '',     #this too?
1053         'post_total', 'char', 'NULL', 1, '', '',
1054         'type',       'char', 'NULL', 1, '', '',
1055         'summary',    'char', 'NULL', 1, '', '',
1056       ],
1057       'primary_key'  => 'billpkgdisplaynum',
1058       'unique'       => [],
1059       'index'        => [ ['billpkgnum'], ],
1060       'foreign_keys' => [
1061                           { columns    => [ 'billpkgnum' ],
1062                             table      => 'cust_bill_pkg',
1063                           },
1064                         ],
1065     },
1066
1067     'cust_bill_pkg_fee' => {
1068       'columns' => [
1069         'billpkgfeenum',    'serial', '', '', '', '',
1070         'billpkgnum',          'int', '', '', '', '',
1071         'base_invnum',       'int', '', '', '', '',
1072         'base_billpkgnum',   'int', 'NULL', '', '', '',
1073         'amount',        @money_type,         '', '',
1074       ],
1075       'primary_key' => 'billpkgfeenum',
1076       'unique'      => [],
1077       'index'       => [ ['billpkgnum'],
1078                          ['base_invnum'],
1079                          ['base_billpkgnum'],
1080                        ],
1081       'foreign_keys' => [
1082                           { columns     => [ 'billpkgnum' ],
1083                             table       => 'cust_bill_pkg',
1084                           },
1085                           { columns     => [ 'base_billpkgnum' ],
1086                             table       => 'cust_bill_pkg',
1087                             references  => [ 'billpkgnum' ],
1088                           },
1089                           { columns     => [ 'base_invnum' ],
1090                             table       => 'cust_bill',
1091                             references  => [ 'invnum' ],
1092                           },
1093                         ],
1094     },
1095
1096     'cust_bill_pkg_tax_location' => {
1097       'columns' => [
1098         'billpkgtaxlocationnum', 'serial',     '',      '', '', '',
1099         'billpkgnum',               'int',     '',      '', '', '',
1100         'taxnum',                   'int',     '',      '', '', '',
1101         'taxtype',              'varchar',     '', $char_d, '', '',
1102         'pkgnum',                   'int',     '',      '', '', '', #redundant
1103         'locationnum',              'int',     '',      '', '', '', #redundant
1104         'amount',             @money_type,                  '', '',
1105         'currency',                'char', 'NULL',       3, '', '',
1106         'taxable_billpkgnum',       'int', 'NULL',      '', '', '',
1107       ],
1108       'primary_key'  => 'billpkgtaxlocationnum',
1109       'unique'       => [],
1110       'index'        => [ [ 'billpkgnum' ], 
1111                           [ 'taxnum' ],
1112                           [ 'pkgnum' ],
1113                           [ 'locationnum' ],
1114                           [ 'taxable_billpkgnum' ],
1115                         ],
1116       'foreign_keys' => [
1117                           { columns    => [ 'billpkgnum' ],
1118                             table      => 'cust_bill_pkg',
1119                           },
1120                           #{ columns    => [ 'pkgnum' ],
1121                           #  table      => 'cust_pkg',
1122                           #}, # taxes can apply to fees
1123                           { columns    => [ 'locationnum' ],
1124                             table      => 'cust_location',
1125                           },
1126                           { columns    => [ 'taxable_billpkgnum' ],
1127                             table      => 'cust_bill_pkg',
1128                             references => [ 'billpkgnum' ],
1129                           },
1130                         ],
1131     },
1132
1133     'cust_bill_pkg_tax_rate_location' => {
1134       'columns' => [
1135         'billpkgtaxratelocationnum', 'serial',      '',      '', '', '',
1136         'billpkgnum',                   'int',      '',      '', '', '',
1137         'taxnum',                       'int',      '',      '', '', '',
1138         'taxtype',                  'varchar',      '', $char_d, '', '',
1139         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
1140         'taxratelocationnum',           'int',      '',      '', '', '',
1141         'amount',                 @money_type,                   '', '',
1142         'currency',                    'char', 'NULL',        3, '', '',
1143         'taxable_billpkgnum',           'int', 'NULL',       '', '', '',
1144       ],
1145       'primary_key'  => 'billpkgtaxratelocationnum',
1146       'unique'       => [],
1147       'index'        => [ ['billpkgnum'], ['taxnum'], ['taxratelocationnum'],
1148                           ['taxable_billpkgnum'],
1149                         ],
1150       'foreign_keys' => [
1151                           { columns    => [ 'billpkgnum' ],
1152                             table      => 'cust_bill_pkg',
1153                           },
1154                           { columns    => [ 'taxratelocationnum' ],
1155                             table      => 'tax_rate_location',
1156                           },
1157                           { columns    => [ 'taxable_billpkgnum' ],
1158                             table      => 'cust_bill_pkg',
1159                             references => [ 'billpkgnum' ],
1160                           },
1161                         ],
1162     },
1163
1164     'cust_bill_pkg_void' => {
1165       'columns' => [
1166         'billpkgnum',           'int',     '',      '', '', '', 
1167         'invnum',               'int',     '',      '', '', '', 
1168         'pkgnum',               'int',     '',      '', '', '', 
1169         'pkgpart_override',     'int', 'NULL',      '', '', '', 
1170         'setup',               @money_type,             '', '', 
1171         'recur',               @money_type,             '', '', 
1172         #XXX a currency for a line item?  or just one for the entire invoice
1173         #'currency',            'char', 'NULL',       3, '', '',
1174         'sdate',               @date_type,              '', '', 
1175         'edate',               @date_type,              '', '', 
1176         'itemdesc',         'varchar', 'NULL', $char_d, '', '', 
1177         'itemcomment',      'varchar', 'NULL', $char_d, '', '', 
1178         'section',          'varchar', 'NULL', $char_d, '', '', 
1179         'freq',             'varchar', 'NULL', $char_d, '', '',
1180         'quantity',             'int', 'NULL',      '', '', '',
1181         'unitsetup',           @money_typen,            '', '', 
1182         'unitrecur',           @money_typen,            '', '', 
1183         'hidden',              'char', 'NULL',       1, '', '',
1184         #void fields
1185         'void_date', @date_type, '', '', 
1186         'reason',    'varchar',   'NULL', $char_d, '', '', 
1187         'void_usernum',   'int', 'NULL', '', '', '',
1188       ],
1189       'primary_key'  => 'billpkgnum',
1190       'unique'       => [],
1191       'index'        => [ ['invnum'], ['pkgnum'], ['itemdesc'],
1192                           ['void_usernum'],
1193                         ],
1194       'foreign_keys' => [
1195                           { columns    => [ 'invnum' ],
1196                             table      => 'cust_bill_void',
1197                           },
1198                           #pkgnum 0 and -1 are used for special things
1199                           #{ columns    => [ 'pkgnum' ],
1200                           #  table      => 'cust_pkg',
1201                           #},
1202                           { columns    => [ 'pkgpart_override' ],
1203                             table      => 'part_pkg',
1204                             references => [ 'pkgpart' ],
1205                           },
1206                           { columns    => [ 'void_usernum' ],
1207                             table      => 'access_user',
1208                             references => [ 'usernum' ],
1209                           },
1210                         ],
1211     },
1212
1213     'cust_bill_pkg_detail_void' => {
1214       'columns' => [
1215         'detailnum',  'int', '', '', '', '', 
1216         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
1217         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
1218         'invnum',  'int', 'NULL', '', '', '',           # deprecated
1219         'amount',  'decimal', 'NULL', '10,4', '', '',
1220         'format',  'char', 'NULL', 1, '', '',
1221         'classnum', 'int', 'NULL', '', '', '',
1222         'duration', 'int', 'NULL', '',  0, '',
1223         'phonenum', 'varchar', 'NULL', 255, '', '',
1224         'accountcode', 'varchar',  'NULL',      20, '', '',
1225         'startdate',  @date_type, '', '', 
1226         'regionname', 'varchar', 'NULL', $char_d, '', '',
1227         'detail',  'varchar', '', 255, '', '', 
1228       ],
1229       'primary_key'  => 'detailnum',
1230       'unique'       => [],
1231       'index'        => [ ['billpkgnum'], ['classnum'], ['pkgnum', 'invnum'] ],
1232       'foreign_keys' => [
1233                           { columns    => [ 'billpkgnum' ],
1234                             table      => 'cust_bill_pkg_void',
1235                           },
1236                           #{ columns    => [ 'pkgnum' ],
1237                           #  table      => 'cust_pkg',
1238                           #},
1239                           #{ columns    => [ 'invnum' ],
1240                           #  table      => 'cust_bill',
1241                           #},
1242                           { columns    => [ 'classnum' ],
1243                             table      => 'usage_class',
1244                           },
1245                         ],
1246     },
1247
1248     'cust_bill_pkg_display_void' => {
1249       'columns' => [
1250         'billpkgdisplaynum',    'int', '', '', '', '', 
1251         'billpkgnum', 'int', '', '', '', '', 
1252         'section',  'varchar', 'NULL', $char_d, '', '', 
1253         #'unitsetup', @money_typen, '', '',     #override the linked real one?
1254         #'unitrecur', @money_typen, '', '',     #this too?
1255         'post_total', 'char', 'NULL', 1, '', '',
1256         'type',       'char', 'NULL', 1, '', '',
1257         'summary',    'char', 'NULL', 1, '', '',
1258       ],
1259       'primary_key'  => 'billpkgdisplaynum',
1260       'unique'       => [],
1261       'index'        => [ ['billpkgnum'], ],
1262       'foreign_keys' => [
1263                           { columns    => [ 'billpkgnum' ],
1264                             table      => 'cust_bill_pkg_void',
1265                           },
1266                         ],
1267     },
1268
1269     'cust_bill_pkg_tax_location_void' => {
1270       'columns' => [
1271         'billpkgtaxlocationnum',    'int',     '',      '', '', '',
1272         'billpkgnum',               'int',     '',      '', '', '',
1273         'taxnum',                   'int',     '',      '', '', '',
1274         'taxtype',              'varchar',     '', $char_d, '', '',
1275         'pkgnum',                   'int',     '',      '', '', '',
1276         'locationnum',              'int',     '',      '', '', '', #redundant?
1277         'amount',             @money_type,                  '', '',
1278         'currency',                'char', 'NULL',       3, '', '',
1279         'taxable_billpkgnum',       'int', 'NULL',      '', '', '',
1280       ],
1281       'primary_key'  => 'billpkgtaxlocationnum',
1282       'unique'       => [],
1283       'index'        => [ ['billpkgnum'], ['taxnum'], ['pkgnum'],
1284                           ['locationnum'],
1285                         ],
1286       'foreign_keys' => [
1287                           { columns    => [ 'billpkgnum' ],
1288                             table      => 'cust_bill_pkg_void',
1289                           },
1290                           { columns    => [ 'pkgnum' ],
1291                             table      => 'cust_pkg',
1292                           },
1293                           { columns    => [ 'locationnum' ],
1294                             table      => 'cust_location',
1295                           },
1296                           { columns    => [ 'taxable_billpkgnum' ],
1297                             table      => 'cust_bill_pkg_void',
1298                             references => [ 'billpkgnum' ],
1299                           },
1300                         ],
1301     },
1302
1303     'cust_bill_pkg_tax_rate_location_void' => {
1304       'columns' => [
1305         'billpkgtaxratelocationnum',    'int',     '',      '', '', '',
1306         'billpkgnum',                   'int',     '',      '', '', '',
1307         'taxnum',                       'int',     '',      '', '', '',
1308         'taxtype',                  'varchar',     '', $char_d, '', '',
1309         'locationtaxid',            'varchar', 'NULL', $char_d, '', '',
1310         'taxratelocationnum',           'int',     '',      '', '', '',
1311         'amount',                 @money_type,                  '', '',
1312         'currency',                    'char', 'NULL',       3, '', '',
1313       ],
1314       'primary_key'  => 'billpkgtaxratelocationnum',
1315       'unique'       => [],
1316       'index'        => [ ['billpkgnum'], ['taxnum'], ['taxratelocationnum'] ],
1317       'foreign_keys' => [
1318                           { columns    => [ 'billpkgnum' ],
1319                             table      => 'cust_bill_pkg_void',
1320                           },
1321                           { columns    => [ 'taxratelocationnum' ],
1322                             table      => 'tax_rate_location',
1323                           },
1324                         ],
1325     },
1326
1327     'cust_credit' => {
1328       'columns' => [
1329         'crednum',  'serial',     '', '', '', '', 
1330         'custnum',     'int',     '', '', '', '', 
1331         '_date',  @date_type,             '', '', 
1332         'amount',@money_type,             '', '', 
1333         'currency',   'char', 'NULL',  3, '', '',
1334         'otaker',  'varchar', 'NULL', 32, '', '', 
1335         'usernum',     'int', 'NULL', '', '', '',
1336         'reason',     'text', 'NULL', '', '', '', 
1337         'reasonnum',   'int', 'NULL', '', '', '', 
1338         'addlinfo',   'text', 'NULL', '', '', '',
1339         'closed',     'char', 'NULL',  1, '', '', 
1340         'pkgnum',      'int', 'NULL', '', '','',#desired pkgnum for pkg-balances
1341         'eventnum',    'int', 'NULL', '', '','',#triggering event for commission
1342         'commission_agentnum', 'int', 'NULL', '', '', '', #
1343         'commission_salesnum', 'int', 'NULL', '', '', '', #
1344         'commission_pkgnum',   'int', 'NULL', '', '', '', #
1345         'credbatch',    'varchar', 'NULL', $char_d, '', '',
1346       ],
1347       'primary_key'  => 'crednum',
1348       'unique'       => [],
1349       'index'        => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1350                           ['commission_salesnum'], ['credbatch'],
1351                         ],
1352       'foreign_keys' => [
1353                           { columns    => [ 'custnum' ],
1354                             table      => 'cust_main',
1355                           },
1356                           { columns    => [ 'usernum' ],
1357                             table      => 'access_user',
1358                           },
1359                           { columns    => [ 'reasonnum' ],
1360                             table      => 'reason',
1361                           },
1362                           { columns    => [ 'pkgnum' ],
1363                             table      => 'cust_pkg',
1364                           },
1365                           { columns    => [ 'eventnum' ],
1366                             table      => 'cust_event',
1367                           },
1368                           { columns    => [ 'commission_agentnum' ],
1369                             table      => 'agent',
1370                             references => [ 'agentnum' ],
1371                           },
1372                           { columns    => [ 'commission_salesnum' ],
1373                             table      => 'sales',
1374                             references => [ 'salesnum' ],
1375                           },
1376                           { columns    => [ 'commission_pkgnum' ],
1377                             table      => 'cust_pkg',
1378                             references => [ 'pkgnum' ],
1379                           },
1380                         ],
1381     },
1382
1383     'cust_credit_void' => {
1384       'columns' => [
1385         'crednum',  'serial',     '', '', '', '', 
1386         'custnum',     'int',     '', '', '', '', 
1387         '_date',  @date_type,             '', '', 
1388         'amount',@money_type,             '', '', 
1389         'currency',   'char', 'NULL',  3, '', '',
1390         'otaker',  'varchar', 'NULL', 32, '', '', 
1391         'usernum',     'int', 'NULL', '', '', '',
1392         'reason',     'text', 'NULL', '', '', '', 
1393         'reasonnum',   'int', 'NULL', '', '', '', 
1394         'addlinfo',   'text', 'NULL', '', '', '',
1395         'closed',     'char', 'NULL',  1, '', '', 
1396         'pkgnum',      'int', 'NULL', '', '','',
1397         'eventnum',    'int', 'NULL', '', '','',
1398         'commission_agentnum', 'int', 'NULL', '', '', '',
1399         'commission_salesnum', 'int', 'NULL', '', '', '',
1400         'commission_pkgnum',   'int', 'NULL', '', '', '',
1401         #void fields
1402         'void_date',  @date_type,                  '', '', 
1403         'void_reason', 'varchar', 'NULL', $char_d, '', '', 
1404         'void_usernum',    'int', 'NULL',      '', '', '',
1405       ],
1406       'primary_key'  => 'crednum',
1407       'unique'       => [],
1408       'index'        => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1409                           ['commission_salesnum'],
1410                         ],
1411       'foreign_keys' => [
1412                           { columns    => [ 'custnum' ],
1413                             table      => 'cust_main',
1414                           },
1415                           { columns    => [ 'usernum' ],
1416                             table      => 'access_user',
1417                           },
1418                           { columns    => [ 'reasonnum' ],
1419                             table      => 'reason',
1420                           },
1421                           { columns    => [ 'pkgnum' ],
1422                             table      => 'cust_pkg',
1423                           },
1424                           { columns    => [ 'eventnum' ],
1425                             table      => 'cust_event',
1426                           },
1427                           { columns    => [ 'commission_agentnum' ],
1428                             table      => 'agent',
1429                             references => [ 'agentnum' ],
1430                           },
1431                           { columns    => [ 'commission_salesnum' ],
1432                             table      => 'sales',
1433                             references => [ 'salesnum' ],
1434                           },
1435                           { columns    => [ 'commission_pkgnum' ],
1436                             table      => 'cust_pkg',
1437                             references => [ 'pkgnum' ],
1438                           },
1439                           { columns    => [ 'void_usernum' ],
1440                             table      => 'access_user',
1441                             references => [ 'usernum' ],
1442                           },
1443                         ],
1444     },
1445
1446
1447     'cust_credit_bill' => {
1448       'columns' => [
1449         'creditbillnum', 'serial', '', '', '', '', 
1450         'crednum',  'int', '', '', '', '', 
1451         'invnum',  'int', '', '', '', '', 
1452         '_date',    @date_type, '', '', 
1453         'amount',   @money_type, '', '', 
1454         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1455       ],
1456       'primary_key'  => 'creditbillnum',
1457       'unique'       => [],
1458       'index'        => [ ['crednum'], ['invnum'] ],
1459       'foreign_keys' => [
1460                           { columns    => [ 'crednum' ],
1461                             table      => 'cust_credit',
1462                           },
1463                           { columns    => [ 'invnum' ],
1464                             table      => 'cust_bill',
1465                           },
1466                           { columns    => [ 'pkgnum' ],
1467                             table      => 'cust_pkg',
1468                           },
1469                         ],
1470     },
1471
1472     'cust_credit_bill_pkg' => {
1473       'columns' => [
1474         'creditbillpkgnum', 'serial', '',      '', '', '',
1475         'creditbillnum',       'int', '',      '', '', '',
1476         'billpkgnum',          'int', '',      '', '', '',
1477         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1478         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1479         'amount',            @money_type,          '', '',
1480         'setuprecur',      'varchar', '', $char_d, '', '',
1481         'sdate',   @date_type, '', '', 
1482         'edate',   @date_type, '', '', 
1483       ],
1484       'primary_key'  => 'creditbillpkgnum',
1485       'unique'       => [],
1486       'index'        => [ [ 'creditbillnum' ],
1487                           [ 'billpkgnum' ], 
1488                           [ 'billpkgtaxlocationnum' ],
1489                           [ 'billpkgtaxratelocationnum' ],
1490                         ],
1491       'foreign_keys' => [
1492                           { columns    => [ 'creditbillnum' ],
1493                             table      => 'cust_credit_bill',
1494                           },
1495                           { columns    => [ 'billpkgnum' ],
1496                             table      => 'cust_bill_pkg',
1497                           },
1498                           { columns    => [ 'billpkgtaxlocationnum' ],
1499                             table      => 'cust_bill_pkg_tax_location',
1500                           },
1501                           { columns    => [ 'billpkgtaxratelocationnum' ],
1502                             table      => 'cust_bill_pkg_tax_rate_location',
1503                           },
1504                         ],
1505     },
1506
1507     'cust_main' => {
1508       'columns' => [
1509         'custnum',  'serial',  '',     '', '', '', 
1510         'agentnum', 'int',  '',     '', '', '', 
1511         'salesnum', 'int',  'NULL', '', '', '', 
1512         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1513         'classnum', 'int', 'NULL', '', '', '',
1514         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1515 #        'titlenum', 'int',  'NULL',   '', '', '', 
1516         'last',     'varchar', '',   2*$char_d, '', '', 
1517 #        'middle',   'varchar', 'NULL', $char_d, '', '', 
1518         'first',    'varchar', '',     $char_d, '', '', 
1519         'ss',       'varchar', 'NULL', 11, '', '', 
1520         'stateid', 'varchar', 'NULL', $char_d, '', '', 
1521         'stateid_state', 'varchar', 'NULL', $char_d, '', '', 
1522         'national_id', 'varchar', 'NULL', $char_d, '', '',
1523         'birthdate' ,@date_type, '', '', 
1524         'spouse_birthdate' ,@date_type, '', '', 
1525         'anniversary_date' ,@date_type, '', '', 
1526         'signupdate',@date_type, '', '', 
1527         'dundate',   @date_type, '', '', 
1528         'company',  'varchar', 'NULL', $char_d, '', '', 
1529         'address1', 'varchar', 'NULL', $char_d, '', '', 
1530         'address2', 'varchar', 'NULL', $char_d, '', '', 
1531         'city',     'varchar', 'NULL', $char_d, '', '', 
1532         'county',   'varchar', 'NULL', $char_d, '', '', 
1533         'state',    'varchar', 'NULL', $char_d, '', '', 
1534         'zip',      'varchar', 'NULL', 10, '', '', 
1535         'country',  'char',    'NULL',  2, '', '', 
1536         'latitude', 'decimal', 'NULL', '10,7', '', '', 
1537         'longitude','decimal', 'NULL', '10,7', '', '', 
1538         'coord_auto',  'char', 'NULL',  1, '', '',
1539         'addr_clean',  'char', 'NULL',  1, '', '',
1540         'daytime',  'varchar', 'NULL', 20, '', '', 
1541         'night',    'varchar', 'NULL', 20, '', '', 
1542         'fax',      'varchar', 'NULL', 12, '', '', 
1543         'mobile',   'varchar', 'NULL', 12, '', '', 
1544         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '', 
1545 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '', 
1546         'ship_first',    'varchar', 'NULL', $char_d, '', '', 
1547         'ship_company',  'varchar', 'NULL', $char_d, '', '', 
1548         'ship_address1', 'varchar', 'NULL', $char_d, '', '', 
1549         'ship_address2', 'varchar', 'NULL', $char_d, '', '', 
1550         'ship_city',     'varchar', 'NULL', $char_d, '', '', 
1551         'ship_county',   'varchar', 'NULL', $char_d, '', '', 
1552         'ship_state',    'varchar', 'NULL', $char_d, '', '', 
1553         'ship_zip',      'varchar', 'NULL', 10, '', '', 
1554         'ship_country',  'char', 'NULL', 2, '', '', 
1555         'ship_latitude', 'decimal', 'NULL', '10,7', '', '', 
1556         'ship_longitude','decimal', 'NULL', '10,7', '', '', 
1557         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1558         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1559         'ship_daytime',  'varchar', 'NULL', 20, '', '', 
1560         'ship_night',    'varchar', 'NULL', 20, '', '', 
1561         'ship_fax',      'varchar', 'NULL', 12, '', '', 
1562         'ship_mobile',   'varchar', 'NULL', 12, '', '', 
1563         'currency',         'char', 'NULL',  3, '', '',
1564
1565         #deprecated, info moved to cust_payby
1566         'payby',    'char', 'NULL',     4, '', '', 
1567         'payinfo',  'varchar', 'NULL', 512, '', '', 
1568         'paycvv',   'varchar', 'NULL', 512, '', '', 
1569         'paymask', 'varchar', 'NULL', $char_d, '', '', 
1570         #'paydate',  @date_type, '', '', 
1571         'paydate',  'varchar', 'NULL', 10, '', '', 
1572         'paystart_month', 'int', 'NULL', '', '', '', 
1573         'paystart_year',  'int', 'NULL', '', '', '', 
1574         'payissue', 'varchar', 'NULL', 2, '', '', 
1575         'payname',  'varchar', 'NULL', 2*$char_d, '', '', 
1576         'paystate', 'varchar', 'NULL', $char_d, '', '', 
1577         'paytype',  'varchar', 'NULL', $char_d, '', '', 
1578         'payip',    'varchar', 'NULL', 15, '', '', 
1579
1580         'geocode',  'varchar', 'NULL', 20,  '', '',
1581         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1582         'censusyear', 'char', 'NULL', 4, '', '',
1583         'district', 'varchar', 'NULL', 20, '', '',
1584         'tax',      'char', 'NULL', 1, '', '', 
1585         'otaker',   'varchar', 'NULL',    32, '', '', 
1586         'usernum',   'int', 'NULL', '', '', '',
1587         'refnum',   'int',  '',     '', '', '', 
1588         'referral_custnum', 'int',  'NULL', '', '', '', 
1589         'comments', 'text', 'NULL', '', '', '', 
1590         'spool_cdr','char', 'NULL', 1, '', '', 
1591         'squelch_cdr','char', 'NULL', 1, '', '', 
1592         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1593         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1594         'credit_limit', @money_typen, '', '',
1595         'credit_limit_currency', 'char', 'NULL',  3, '', '',
1596         'archived', 'char', 'NULL', 1, '', '',
1597         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1598         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1599         'billday',   'int', 'NULL', '', '', '',
1600         'prorate_day',   'int', 'NULL', '', '', '',
1601         'edit_subject', 'char', 'NULL', 1, '', '',
1602         'locale', 'varchar', 'NULL', 16, '', '', 
1603         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1604         'invoice_noemail', 'char', 'NULL', 1, '', '',
1605         'message_noemail', 'char', 'NULL', 1, '', '',
1606         'bill_locationnum', 'int', 'NULL', '', '', '',
1607         'ship_locationnum', 'int', 'NULL', '', '', '',
1608       ],
1609       'primary_key'  => 'custnum',
1610       'unique'       => [ [ 'agentnum', 'agent_custid' ] ],
1611       #'index'        => [ ['last'], ['company'] ],
1612       'index'        => [
1613                           ['agentnum'], ['refnum'], ['classnum'], ['usernum'],
1614                           [ 'custbatch' ],
1615                           [ 'referral_custnum' ],
1616                           [ 'payby' ], [ 'paydate' ],
1617                           [ 'archived' ],
1618                         ],
1619       'foreign_keys' => [
1620                           { columns    => [ 'agentnum' ],
1621                             table      => 'agent',
1622                           },
1623                           { columns    => [ 'salesnum' ],
1624                             table      => 'sales',
1625                           },
1626                           { columns    => [ 'refnum' ],
1627                             table      => 'part_referral',
1628                           },
1629                           { columns    => [ 'classnum' ],
1630                             table      => 'cust_class',
1631                           },
1632                           { columns    => [ 'usernum' ],
1633                             table      => 'access_user',
1634                           },
1635                           { columns    => [ 'referral_custnum' ],
1636                             table      => 'cust_main',
1637                             references => [ 'custnum' ],
1638                           },
1639                           { columns    => [ 'bill_locationnum' ],
1640                             table      => 'cust_location',
1641                             references => [ 'locationnum' ],
1642                           },
1643                           { columns    => [ 'ship_locationnum' ],
1644                             table      => 'cust_location',
1645                             references => [ 'locationnum' ],
1646                           },
1647                         ],
1648     },
1649
1650     'cust_payby' => {
1651       'columns' => [
1652         'custpaybynum', 'serial',     '',        '', '', '', 
1653         'custnum',         'int',     '',        '', '', '',
1654         'weight',          'int',     '',        '', '', '', 
1655         'payby',          'char',     '',         4, '', '', 
1656         'payinfo',     'varchar', 'NULL',       512, '', '', 
1657         'paycvv',      'varchar', 'NULL',       512, '', '', 
1658         'paymask',     'varchar', 'NULL',   $char_d, '', '', 
1659         #'paydate',   @date_type, '', '', 
1660         'paydate',     'varchar', 'NULL',        10, '', '', 
1661         'paystart_month',  'int', 'NULL',        '', '', '', 
1662         'paystart_year',   'int', 'NULL',        '', '', '', 
1663         'payissue',    'varchar', 'NULL',         2, '', '', 
1664         'payname',     'varchar', 'NULL', 2*$char_d, '', '', 
1665         'paystate',    'varchar', 'NULL',   $char_d, '', '', 
1666         'paytype',     'varchar', 'NULL',   $char_d, '', '', 
1667         'payip',       'varchar', 'NULL',        15, '', '', 
1668         'locationnum',     'int', 'NULL',        '', '', '',
1669       ],
1670       'primary_key'  => 'custpaybynum',
1671       'unique'       => [],
1672       'index'        => [ [ 'custnum' ] ],
1673       'foreign_keys' => [
1674                           { columns    => [ 'custnum' ],
1675                             table      => 'cust_main',
1676                           },
1677                           { columns    => [ 'locationnum' ],
1678                             table      => 'cust_location',
1679                           },
1680                         ],
1681     },
1682
1683     'contact_class' => {
1684       'columns' => [
1685         'classnum',    'serial',   '',      '', '', '', 
1686         'classname',   'varchar',  '', $char_d, '', '', 
1687         'disabled',    'char', 'NULL',       1, '', '', 
1688       ],
1689       'primary_key' => 'classnum',
1690       'unique' => [],
1691       'index' => [ ['disabled'] ],
1692     },
1693
1694     'contact' => {
1695       'columns' => [
1696         'contactnum', 'serial',     '',      '', '', '',
1697         'prospectnum',   'int', 'NULL',      '', '', '',
1698         'custnum',       'int', 'NULL',      '', '', '',
1699         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1700         'classnum',      'int', 'NULL',      '', '', '',
1701 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1702         'last',      'varchar',     '', $char_d, '', '', 
1703 #        'middle',    'varchar', 'NULL', $char_d, '', '', 
1704         'first',     'varchar',     '', $char_d, '', '', 
1705         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1706         'comment',   'varchar', 'NULL',     255, '', '', 
1707         'selfservice_access',    'char', 'NULL',       1, '', '',
1708         '_password',          'varchar', 'NULL', $char_d, '', '',
1709         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1710         'disabled',              'char', 'NULL',       1, '', '', 
1711       ],
1712       'primary_key'  => 'contactnum',
1713       'unique'       => [],
1714       'index'        => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1715                           [ 'last' ], [ 'first' ],
1716                         ],
1717       'foreign_keys' => [
1718                           { columns    => [ 'prospectnum' ],
1719                             table      => 'prospect_main',
1720                           },
1721                           { columns    => [ 'custnum' ],
1722                             table      => 'cust_main',
1723                           },
1724                           { columns    => [ 'locationnum' ],
1725                             table      => 'cust_location',
1726                           },
1727                           { columns    => [ 'classnum' ],
1728                             table      => 'contact_class',
1729                           },
1730                         ],
1731     },
1732
1733     'contact_phone' => {
1734       'columns' => [
1735         'contactphonenum', 'serial',     '', '', '', '',
1736         'contactnum',         'int',     '', '', '', '',
1737         'phonetypenum',       'int',     '', '', '', '',
1738         'countrycode',    'varchar',     '',  3, '', '', 
1739         'phonenum',       'varchar',     '', 14, '', '', 
1740         'extension',      'varchar', 'NULL',  7, '', '',
1741         #?#'comment',        'varchar',     '', $char_d, '', '', 
1742       ],
1743       'primary_key'  => 'contactphonenum',
1744       'unique'       => [],
1745       'index'        => [],
1746       'foreign_keys' => [
1747                           { columns    => [ 'contactnum' ],
1748                             table      => 'contact',
1749                           },
1750                           { columns    => [ 'phonetypenum' ],
1751                             table      => 'phone_type',
1752                           },
1753                         ],
1754     },
1755
1756     'phone_type' => {
1757       'columns' => [
1758         'phonetypenum',  'serial', '',      '', '', '',
1759         'typename',     'varchar', '', $char_d, '', '',
1760         'weight',           'int', '',      '', '', '', 
1761       ],
1762       'primary_key' => 'phonetypenum',
1763       'unique'      => [ [ 'typename' ], ],
1764       'index'       => [],
1765     },
1766
1767     'contact_email' => {
1768       'columns' => [
1769         'contactemailnum', 'serial', '',      '', '', '',
1770         'contactnum',         'int', '',      '', '', '',
1771         'emailaddress',   'varchar', '', $char_d, '', '',
1772       ],
1773       'primary_key'  => 'contactemailnum',
1774       #'unique'       => [ [ 'contactnum', 'emailaddress' ], ],
1775       'unique'       => [ [ 'emailaddress' ], ],
1776       'index'        => [],
1777       'foreign_keys' => [
1778                           { columns    => [ 'contactnum' ],
1779                             table      => 'contact',
1780                           },
1781                         ],
1782     },
1783
1784     'prospect_main' => {
1785       'columns' => [
1786         'prospectnum',  'serial',     '',      '', '', '',
1787         'agentnum',        'int',     '',      '', '', '',
1788         'company',     'varchar', 'NULL', $char_d, '', '',
1789         'add_date',   @date_type,                  '', '', 
1790         'disabled',       'char', 'NULL',       1, '', '', 
1791         'custnum',         'int', 'NULL',      '', '', '',
1792       ],
1793       'primary_key'  => 'prospectnum',
1794       'unique'       => [],
1795       'index'        => [ [ 'company' ], [ 'agentnum' ], [ 'disabled' ] ],
1796       'foreign_keys' => [
1797                           { columns    => [ 'agentnum' ],
1798                             table      => 'agent',
1799                           },
1800                           { columns    => [ 'custnum' ],
1801                             table      => 'cust_main',
1802                           },
1803                         ],
1804     },
1805
1806     'quotation' => {
1807       'columns' => [
1808         #regular fields
1809         'quotationnum',   'serial',     '', '', '', '', 
1810         'prospectnum',       'int', 'NULL', '', '', '',
1811         'custnum',           'int', 'NULL', '', '', '',
1812         '_date',        @date_type,             '', '', 
1813         'disabled',         'char', 'NULL',  1, '', '', 
1814         'usernum',           'int', 'NULL', '', '', '',
1815         #'total',      @money_type,       '', '', 
1816         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1817       ],
1818       'primary_key'  => 'quotationnum',
1819       'unique'       => [],
1820       'index'        => [ [ 'prospectnum' ], ['custnum'], ],
1821       'foreign_keys' => [
1822                           { columns    => [ 'prospectnum' ],
1823                             table      => 'prospect_main',
1824                           },
1825                           { columns    => [ 'custnum' ],
1826                             table      => 'cust_main',
1827                           },
1828                           { columns    => [ 'usernum' ],
1829                             table      => 'access_user',
1830                           },
1831                         ],
1832     },
1833
1834     'quotation_pkg' => {
1835       'columns' => [
1836         'quotationpkgnum',   'serial',     '', '', '', '', 
1837         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1838                                                            # but history...
1839         'pkgpart',              'int',     '', '', '', '', 
1840         'locationnum',          'int', 'NULL', '', '', '',
1841         'start_date',      @date_type,             '', '', 
1842         'contract_end',    @date_type,             '', '',
1843         'quantity',             'int', 'NULL', '', '', '',
1844         'waive_setup',         'char', 'NULL',  1, '', '', 
1845       ],
1846       'primary_key'  => 'quotationpkgnum',
1847       'unique'       => [],
1848       'index'        => [ ['pkgpart'], ],
1849       'foreign_keys' => [
1850                           { columns    => [ 'quotationnum' ],
1851                             table      => 'quotation',
1852                           },
1853                           { columns    => [ 'pkgpart' ],
1854                             table      => 'part_pkg',
1855                           },
1856                           { columns    => [ 'locationnum' ],
1857                             table      => 'cust_location',
1858                           },
1859                         ],
1860     },
1861
1862     'quotation_pkg_discount' => {
1863       'columns' => [
1864         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1865         'quotationpkgnum',            'int', '', '', '', '', 
1866         'discountnum',                'int', '', '', '', '',
1867         #'end_date',              @date_type,         '', '',
1868       ],
1869       'primary_key'  => 'quotationpkgdiscountnum',
1870       'unique'       => [],
1871       'index'        => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1872       'foreign_keys' => [
1873                           { columns    => [ 'quotationpkgnum' ],
1874                             table      => 'quotation_pkg',
1875                           },
1876                           { columns    => [ 'discountnum' ],
1877                             table      => 'discount',
1878                           },
1879                         ],
1880     },
1881
1882     'cust_location' => { #'location' now that its prospects too, but...
1883       'columns' => [
1884         'locationnum',      'serial',     '',      '', '', '',
1885         'prospectnum',         'int', 'NULL',      '', '', '',
1886         'custnum',             'int', 'NULL',      '', '', '',
1887         'address1',        'varchar',     '', $char_d, '', '', 
1888         'address2',        'varchar', 'NULL', $char_d, '', '', 
1889         'city',            'varchar',     '', $char_d, '', '', 
1890         'county',          'varchar', 'NULL', $char_d, '', '', 
1891         'state',           'varchar', 'NULL', $char_d, '', '', 
1892         'zip',             'varchar', 'NULL',      10, '', '', 
1893         'latitude',        'decimal', 'NULL',  '10,7', '', '', 
1894         'longitude',       'decimal', 'NULL',  '10,7', '', '', 
1895         'coord_auto',         'char', 'NULL',       1, '', '',
1896         'addr_clean',         'char', 'NULL',       1, '', '',
1897         'country',            'char',     '',       2, '', '', 
1898         'geocode',         'varchar', 'NULL',      20, '', '',
1899         'district',        'varchar', 'NULL',      20, '', '',
1900         'censustract',     'varchar', 'NULL',      20, '', '',
1901         'censusyear',         'char', 'NULL',       4, '', '',
1902         'location_type',   'varchar', 'NULL',      20, '', '',
1903         'location_number', 'varchar', 'NULL',      20, '', '',
1904         'location_kind',      'char', 'NULL',       1, '', '',
1905         'disabled',           'char', 'NULL',       1, '', '', 
1906       ],
1907       'primary_key'  => 'locationnum',
1908       'unique'       => [],
1909       'index'        => [ [ 'prospectnum' ], [ 'custnum' ],
1910                           [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1911                           [ 'city' ], [ 'district' ]
1912                         ],
1913       'foreign_keys' => [
1914                           { columns    => [ 'prospectnum' ],
1915                             table      => 'prospect_main',
1916                           },
1917                           { columns    => [ 'custnum' ],
1918                             table      => 'cust_main',
1919                           },
1920                         ],
1921     },
1922
1923     'cust_main_invoice' => {
1924       'columns' => [
1925         'destnum',  'serial',  '',     '', '', '', 
1926         'custnum',  'int',  '',     '', '', '', 
1927         'dest',     'varchar', '',  $char_d, '', '', 
1928       ],
1929       'primary_key'  => 'destnum',
1930       'unique'       => [],
1931       'index'        => [ ['custnum'], ],
1932       'foreign_keys' => [
1933                           { columns    => [ 'custnum' ],
1934                             table      => 'cust_main',
1935                           },
1936                         ],
1937     },
1938
1939     'cust_main_credit_limit' => {
1940       'columns' => [
1941         'creditlimitnum',   'serial', '', '', '', '',
1942         'custnum',             'int', '', '', '', '', 
1943         '_date',          @date_type,         '', '', 
1944         'amount',       @money_typen,         '', '',
1945         #'amount_currency', 'char', 'NULL',  3, '', '',
1946         'credit_limit', @money_typen,         '', '',
1947         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
1948       ],
1949       'primary_key'  => 'creditlimitnum',
1950       'unique'       => [],
1951       'index'        => [ ['custnum'], ],
1952       'foreign_keys' => [
1953                           { columns    => [ 'custnum' ],
1954                             table      => 'cust_main',
1955                           },
1956                         ],
1957     },
1958
1959     'cust_main_note' => {
1960       'columns' => [
1961         'notenum',  'serial',  '',     '', '', '', 
1962         'custnum',  'int',  '',     '', '', '', 
1963         'classnum',      'int',     'NULL', '', '', '', 
1964         '_date',    @date_type, '', '', 
1965         'otaker',   'varchar', 'NULL',    32, '', '', 
1966         'usernum',   'int', 'NULL', '', '', '',
1967         'comments', 'text', 'NULL', '', '', '', 
1968       ],
1969       'primary_key'  => 'notenum',
1970       'unique'       => [],
1971       'index'        => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1972       'foreign_keys' => [
1973                           { columns    => [ 'custnum' ],
1974                             table      => 'cust_main',
1975                           },
1976                           { columns    => [ 'classnum' ],
1977                             table      => 'cust_note_class',
1978                           },
1979                           { columns    => [ 'usernum' ],
1980                             table      => 'access_user',
1981                           },
1982                         ],
1983     },
1984
1985     'cust_note_class' => {
1986       'columns' => [
1987         'classnum',    'serial',   '',      '', '', '', 
1988         'classname',   'varchar',  '', $char_d, '', '', 
1989         'disabled',    'char', 'NULL',       1, '', '', 
1990       ],
1991       'primary_key' => 'classnum',
1992       'unique' => [],
1993       'index' => [ ['disabled'] ],
1994     },
1995
1996     'cust_category' => {
1997       'columns' => [
1998         'categorynum',   'serial',  '', '', '', '', 
1999         'categoryname',  'varchar', '', $char_d, '', '', 
2000         'weight',         'int', 'NULL',  '', '', '',
2001         'disabled',      'char', 'NULL',   1, '', '', 
2002       ],
2003       'primary_key' => 'categorynum',
2004       'unique' => [],
2005       'index' => [ ['disabled'] ],
2006     },
2007
2008     'cust_class' => {
2009       'columns' => [
2010         'classnum',     'serial',     '',      '', '', '', 
2011         'classname',   'varchar',     '', $char_d, '', '', 
2012         'categorynum',     'int', 'NULL',      '', '', '', 
2013         'tax',            'char', 'NULL',       1, '', '', 
2014         'disabled',       'char', 'NULL',       1, '', '', 
2015       ],
2016       'primary_key'  => 'classnum',
2017       'unique'       => [],
2018       'index'        => [ ['disabled'] ],
2019       'foreign_keys' => [
2020                           { columns    => [ 'categorynum' ],
2021                             table      => 'cust_category',
2022                           },
2023                         ],
2024     },
2025  
2026     'cust_tag' => {
2027       'columns' => [
2028         'custtagnum', 'serial', '', '', '', '',
2029         'custnum',       'int', '', '', '', '',
2030         'tagnum',        'int', '', '', '', '',
2031       ],
2032       'primary_key'  => 'custtagnum',
2033       'unique'       => [ [ 'custnum', 'tagnum' ] ],
2034       'index'        => [ [ 'custnum' ] ],
2035       'foreign_keys' => [
2036                           { columns    => [ 'custnum' ],
2037                             table      => 'cust_main',
2038                           },
2039                           { columns    => [ 'tagnum' ],
2040                             table      => 'part_tag',
2041                           },
2042                         ],
2043     },
2044
2045     'part_tag' => {
2046       'columns' => [
2047         'tagnum',    'serial',     '',      '', '', '',
2048         'tagname',  'varchar',     '', $char_d, '', '',
2049         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
2050         'tagcolor', 'varchar', 'NULL',       6, '', '',
2051         'by_default',  'char', 'NULL',       1, '', '',
2052         'disabled',    'char', 'NULL',       1, '', '', 
2053       ],
2054       'primary_key' => 'tagnum',
2055       'unique'      => [], #[ [ 'tagname' ] ], #?
2056       'index'       => [ [ 'disabled' ] ],
2057     },
2058
2059     'cust_main_exemption' => {
2060       'columns' => [
2061         'exemptionnum',   'serial',     '',      '', '', '',
2062         'custnum',           'int',     '',      '', '', '', 
2063         'taxname',       'varchar',     '', $char_d, '', '',
2064         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
2065         #start/end dates?  for reporting?
2066       ],
2067       'primary_key'  => 'exemptionnum',
2068       'unique'       => [],
2069       'index'        => [ [ 'custnum' ] ],
2070       'foreign_keys' => [
2071                           { columns    => [ 'custnum' ],
2072                             table      => 'cust_main',
2073                           },
2074                         ],
2075     },
2076
2077     'cust_tax_adjustment' => {
2078       'columns' => [
2079         'adjustmentnum', 'serial',     '',      '', '', '',
2080         'custnum',          'int',     '',      '', '', '',
2081         'taxname',      'varchar',     '', $char_d, '', '',
2082         'amount',     @money_type,                  '', '', 
2083         'currency',        'char', 'NULL',       3, '', '',
2084         'comment',      'varchar', 'NULL', $char_d, '', '', 
2085         'billpkgnum',       'int', 'NULL',      '', '', '',
2086         #more?  no cust_bill_pkg_tax_location?
2087       ],
2088       'primary_key'  => 'adjustmentnum',
2089       'unique'       => [],
2090       'index'        => [ [ 'custnum' ], [ 'billpkgnum' ] ],
2091       'foreign_keys' => [
2092                           { columns    => [ 'custnum' ],
2093                             table      => 'cust_main',
2094                           },
2095                           { columns    => [ 'billpkgnum' ],
2096                             table      => 'cust_bill_pkg',
2097                           },
2098                         ],
2099     },
2100
2101     'cust_main_county' => { #district+city+county+state+country are checked 
2102                             #off the cust_main_county for validation and to 
2103                             #provide a tax rate.
2104       'columns' => [
2105         'taxnum',    'serial',     '',      '', '', '', 
2106         'district', 'varchar', 'NULL',      20, '', '',
2107         'city',     'varchar', 'NULL', $char_d, '', '',
2108         'county',   'varchar', 'NULL', $char_d, '', '', 
2109         'state',    'varchar', 'NULL', $char_d, '', '', 
2110         'country',     'char',     '',       2, '', '', 
2111         'taxclass', 'varchar', 'NULL', $char_d, '', '', 
2112         'exempt_amount', @money_type,            '', '', 
2113         'exempt_amount_currency', 'char', 'NULL', 3, '', '',
2114         'tax',         'real',     '',      '', '', '', #tax %
2115         'taxname',  'varchar', 'NULL', $char_d, '', '', 
2116         'setuptax',    'char', 'NULL',       1, '', '', # Y = setup tax exempt
2117         'recurtax',    'char', 'NULL',       1, '', '', # Y = recur tax exempt
2118       ],
2119       'primary_key' => 'taxnum',
2120       'unique' => [],
2121   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
2122       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ], 
2123                    [ 'country' ],
2124                    [ 'taxclass' ],
2125                  ],
2126     },
2127
2128     'tax_rate'    => {
2129       'columns' => [
2130         'taxnum',       'serial',     '',      '', '', '', 
2131         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
2132         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
2133         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
2134         'taxclassnum', 'int',      '',      '', '', '', 
2135         'effective_date', @date_type, '', '', 
2136         'tax',        @taxrate_type,      '', '',        # tax %
2137         'excessrate', @taxrate_typen,     '', '',        # second tax %
2138         'taxbase',    @money_typen, '', '',              # amount at first tax rate
2139         'taxmax',     @money_typen, '', '',              # maximum about at both rates
2140         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
2141         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
2142         'unittype',    'int',  'NULL', '', '', '',      # for fee
2143         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
2144         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
2145         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
2146         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
2147         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
2148         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
2149         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
2150         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
2151         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
2152         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
2153         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
2154         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
2155         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
2156         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
2157         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
2158         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
2159       ],
2160       'primary_key'  => 'taxnum',
2161       'unique'       => [],
2162       'index'        => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
2163       'foreign_keys' => [
2164                           { columns    => [ 'taxclassnum' ],
2165                             table      => 'tax_class',
2166                           },
2167                         ],
2168     },
2169
2170     'tax_rate_location' => { 
2171       'columns' => [
2172         'taxratelocationnum', 'serial',  '',     '', '', '', 
2173         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
2174         'geocode',            'varchar', '',     20,      '', '', 
2175         'city',               'varchar', 'NULL', $char_d, '', '',
2176         'county',             'varchar', 'NULL', $char_d, '', '',
2177         'state',              'char',    'NULL',       2, '', '', 
2178         'disabled',           'char',    'NULL', 1, '', '',
2179       ],
2180       'primary_key' => 'taxratelocationnum',
2181       'unique' => [],
2182       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
2183     },
2184
2185     'cust_tax_location' => { 
2186       'columns' => [
2187         'custlocationnum', 'serial',  '',     '', '', '', 
2188         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
2189         'city',            'varchar', 'NULL', $char_d, '', '',
2190         'postalcity',      'varchar', 'NULL', $char_d, '', '',
2191         'county',          'varchar', 'NULL', $char_d, '', '',
2192         'zip',             'char',    '',     5,  '', '', 
2193         'state',           'char',    '',     2,  '', '', 
2194         'plus4hi',         'char',    'NULL', 4,  '', '', 
2195         'plus4lo',         'char',    'NULL', 4,  '', '', 
2196         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
2197         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
2198         'geocode',         'varchar', '',    20,  '', '', 
2199       ],
2200       'primary_key' => 'custlocationnum',
2201       'unique' => [],
2202       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
2203     },
2204
2205     'tax_class' => { 
2206       'columns' => [
2207         'taxclassnum',  'serial',  '',            '', '', '',
2208         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
2209         'taxclass',     'varchar', '',       $char_d, '', '',          
2210         'description',  'varchar', '',     2*$char_d, '', '',          
2211       ],
2212       'primary_key' => 'taxclassnum',
2213       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
2214       'index' => [],
2215     },
2216
2217     'cust_pay_pending' => {
2218       'columns' => [
2219         'paypendingnum',      'serial',     '',      '', '', '',
2220         'custnum',               'int',     '',      '', '', '', 
2221         'paid',            @money_type,                  '', '', 
2222         'currency',             'char', 'NULL',       3, '', '',
2223         '_date',            @date_type,                  '', '', 
2224         'payby',                'char',     '',       4, '', '',
2225         'payinfo',           'varchar', 'NULL',     512, '', '',
2226         'paymask',           'varchar', 'NULL', $char_d, '', '', 
2227         'paydate',           'varchar', 'NULL',     10, '', '', 
2228         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
2229         'payunique',         'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
2230
2231         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2232         'status',       'varchar',     '', $char_d, '', '', 
2233         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
2234         'statustext',   'text',    'NULL',  '', '', '', 
2235         'gatewaynum',   'int',     'NULL',  '', '', '',
2236         #'cust_balance', @money_type,            '', '',
2237         'paynum',       'int',     'NULL',  '', '', '',
2238         'void_paynum',  'int',     'NULL',  '', '', '',
2239         'jobnum',    'bigint',     'NULL',  '', '', '', 
2240         'invnum',       'int',     'NULL',  '', '', '',
2241         'manual',       'char',    'NULL',   1, '', '',
2242         'discount_term','int',     'NULL',  '', '', '',
2243         'failure_status','varchar','NULL',  16, '', '',
2244       ],
2245       'primary_key'  => 'paypendingnum',
2246       'unique'       => [ [ 'payunique' ] ],
2247       'index'        => [ [ 'custnum' ], [ 'status' ], ],
2248       'foreign_keys' => [
2249                           { columns    => [ 'custnum' ],
2250                             table      => 'cust_main',
2251                           },
2252                           { columns    => [ 'pkgnum' ],
2253                             table      => 'cust_pkg',
2254                           },
2255                           { columns    => [ 'gatewaynum' ],
2256                             table      => 'payment_gateway',
2257                           },
2258                           { columns    => [ 'paynum' ],
2259                             table      => 'cust_pay',
2260                           },
2261                           { columns    => [ 'void_paynum' ],
2262                             table      => 'cust_pay_void',
2263                             references => [ 'paynum' ],
2264                           },
2265                           { columns    => [ 'jobnum' ],
2266                             table      => 'queue',
2267                           },
2268                           { columns    => [ 'invnum' ],
2269                             table      => 'cust_bill',
2270                           },
2271                         ],
2272     },
2273
2274     'cust_pay' => {
2275       'columns' => [
2276         'paynum',       'serial',    '',       '', '', '',
2277         'custnum',         'int',    '',       '', '', '', 
2278         '_date',     @date_type,                   '', '', 
2279         'paid',      @money_type,                  '', '', 
2280         'currency',       'char', 'NULL',       3, '', '',
2281         'otaker',      'varchar', 'NULL',      32, '', '',
2282         'usernum',         'int', 'NULL',      '', '', '',
2283         'payby',          'char',     '',       4, '', '',
2284         'payinfo',     'varchar', 'NULL',     512, '', '',
2285         'paymask',     'varchar', 'NULL', $char_d, '', '', 
2286         'paydate',     'varchar', 'NULL',      10, '', '', 
2287         'paybatch',    'varchar', 'NULL', $char_d, '', '',#for auditing purposes
2288         'payunique',   'varchar', 'NULL', $char_d, '', '',#separate paybatch "unique" functions from current usage
2289         'closed',         'char', 'NULL',       1, '', '', 
2290         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2291
2292         # cash/check deposit info fields
2293         'bank',        'varchar', 'NULL', $char_d, '', '',
2294         'depositor',   'varchar', 'NULL', $char_d, '', '',
2295         'account',     'varchar', 'NULL',      20, '', '',
2296         'teller',      'varchar', 'NULL',      20, '', '',
2297
2298         'batchnum',        'int', 'NULL',      '', '', '',#pay_batch foreign key
2299
2300         # credit card/EFT fields (formerly in paybatch)
2301         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
2302         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
2303         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
2304         'order_number','varchar', 'NULL', $char_d, '', '', # transaction number
2305       ],
2306       'primary_key'  => 'paynum',
2307       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
2308       'index'        => [ ['custnum'], ['paybatch'], ['payby'], ['_date'],
2309                           ['usernum'],
2310                         ],
2311       'foreign_keys' => [
2312                           { columns    => [ 'custnum' ],
2313                             table      => 'cust_main',
2314                           },
2315                           { columns    => [ 'usernum' ],
2316                             table      => 'access_user',
2317                           },
2318                           { columns    => [ 'pkgnum' ],
2319                             table      => 'cust_pkg',
2320                           },
2321                           { columns    => [ 'batchnum' ],
2322                             table      => 'pay_batch',
2323                           },
2324                           { columns    => [ 'gatewaynum' ],
2325                             table      => 'payment_gateway',
2326                           },
2327                         ],
2328     },
2329
2330     'cust_pay_void' => {
2331       'columns' => [
2332         'paynum',          'int',    '',       '', '', '', 
2333         'custnum',         'int',    '',       '', '', '', 
2334         '_date',      @date_type,                  '', '', 
2335         'paid',      @money_type,                  '', '', 
2336         'currency',       'char', 'NULL',       3, '', '',
2337         'otaker',      'varchar', 'NULL',      32, '', '', 
2338         'usernum',         'int', 'NULL',      '', '', '',
2339         'payby',          'char',     '',       4, '', '',
2340         'payinfo',     'varchar', 'NULL',     512, '', '',
2341         'paymask',     'varchar', 'NULL', $char_d, '', '', 
2342         #'paydate' ?
2343         'paybatch',    'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
2344         'closed',        'char',  'NULL',       1, '', '', 
2345         'pkgnum', 'int',   'NULL', '', '', '', #desired pkgnum for pkg-balances
2346
2347         # cash/check deposit info fields
2348         'bank',       'varchar', 'NULL', $char_d, '', '',
2349         'depositor',  'varchar', 'NULL', $char_d, '', '',
2350         'account',    'varchar', 'NULL',      20, '', '',
2351         'teller',     'varchar', 'NULL',      20, '', '',
2352         'batchnum',       'int', 'NULL',      '', '', '', #pay_batch foreign key
2353
2354         # credit card/EFT fields (formerly in paybatch)
2355         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
2356         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
2357         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
2358         'order_number','varchar', 'NULL', $char_d, '', '', # transaction number
2359
2360         #void fields
2361         'void_date',  @date_type,                  '', '', 
2362         'reason',      'varchar', 'NULL', $char_d, '', '', 
2363         'void_usernum',    'int', 'NULL',      '', '', '',
2364       ],
2365       'primary_key'  => 'paynum',
2366       'unique'       => [],
2367       'index'        => [ ['custnum'], ['usernum'], ['void_usernum'] ],
2368       'foreign_keys' => [
2369                           { columns    => [ 'custnum' ],
2370                             table      => 'cust_main',
2371                           },
2372                           { columns    => [ 'usernum' ],
2373                             table      => 'access_user',
2374                           },
2375                           { columns    => [ 'pkgnum' ],
2376                             table      => 'cust_pkg',
2377                           },
2378                           { columns    => [ 'batchnum' ],
2379                             table      => 'pay_batch',
2380                           },
2381                           { columns    => [ 'gatewaynum' ],
2382                             table      => 'payment_gateway',
2383                           },
2384                           { columns    => [ 'void_usernum' ],
2385                             table      => 'access_user',
2386                             references => [ 'usernum' ],
2387                           },
2388                         ],
2389     },
2390
2391     'cust_bill_pay' => {
2392       'columns' => [
2393         'billpaynum', 'serial',     '',   '', '', '', 
2394         'invnum',  'int',     '',   '', '', '', 
2395         'paynum',  'int',     '',   '', '', '', 
2396         'amount',  @money_type, '', '', 
2397         '_date',   @date_type, '', '', 
2398         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2399       ],
2400       'primary_key'  => 'billpaynum',
2401       'unique'       => [],
2402       'index'        => [ [ 'paynum' ], [ 'invnum' ] ],
2403       'foreign_keys' => [
2404                           { columns    => [ 'invnum' ],
2405                             table      => 'cust_bill',
2406                           },
2407                           { columns    => [ 'paynum' ],
2408                             table      => 'cust_pay',
2409                           },
2410                           { columns    => [ 'pkgnum' ],
2411                             table      => 'cust_pkg',
2412                           },
2413                         ],
2414     },
2415
2416     'cust_bill_pay_batch' => {
2417       'columns' => [
2418         'billpaynum', 'serial',     '',   '', '', '', 
2419         'invnum',  'int',     '',   '', '', '', 
2420         'paybatchnum',  'int',     '',   '', '', '', 
2421         'amount',  @money_type, '', '', 
2422         '_date',   @date_type, '', '', 
2423       ],
2424       'primary_key'  => 'billpaynum',
2425       'unique'       => [],
2426       'index'        => [ [ 'paybatchnum' ], [ 'invnum' ] ],
2427       'foreign_keys' => [
2428                           { columns    => [ 'invnum' ],
2429                             table      => 'cust_bill',
2430                           },
2431                           { columns    => [ 'paybatchnum' ],
2432                             table      => 'cust_pay_batch',
2433                           },
2434                         ],
2435     },
2436
2437     'cust_bill_pay_pkg' => {
2438       'columns' => [
2439         'billpaypkgnum', 'serial', '', '', '', '',
2440         'billpaynum',       'int', '', '', '', '',
2441         'billpkgnum',       'int', '', '', '', '',
2442         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
2443         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
2444         'amount',         @money_type,     '', '',
2445         'setuprecur',      'varchar', '', $char_d, '', '',
2446         'sdate',   @date_type, '', '', 
2447         'edate',   @date_type, '', '', 
2448       ],
2449       'primary_key'  => 'billpaypkgnum',
2450       'unique'       => [],
2451       'index'        => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
2452       'foreign_keys' => [
2453                           { columns    => [ 'billpaynum' ],
2454                             table      => 'cust_bill_pay',
2455                           },
2456                           { columns    => [ 'billpkgnum' ],
2457                             table      => 'cust_bill_pkg',
2458                           },
2459                           { columns    => [ 'billpkgtaxlocationnum' ],
2460                             table      => 'cust_bill_pkg_tax_location',
2461                           },
2462                           { columns    => [ 'billpkgtaxratelocationnum' ],
2463                             table      => 'cust_bill_pkg_tax_rate_location',
2464                           },
2465                         ],
2466     },
2467
2468     'pay_batch' => { #batches of payments to an external processor
2469       'columns' => [
2470         'batchnum', 'serial',     '', '', '', '', 
2471         'agentnum',    'int', 'NULL', '', '', '', 
2472         'payby',      'char',     '',  4, '', '', # CARD/CHEK
2473         'status',     'char', 'NULL',  1, '', '', 
2474         'download',       @date_type,     '', '', 
2475         'upload',         @date_type,     '', '', 
2476         'title',   'varchar', 'NULL',255, '', '',
2477       ],
2478       'primary_key'  => 'batchnum',
2479       'unique'       => [],
2480       'index'        => [],
2481       'foreign_keys' => [
2482                           { columns    => [ 'agentnum' ],
2483                             table      => 'agent',
2484                           },
2485                         ],
2486     },
2487
2488     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
2489       'columns' => [
2490         'paybatchnum',    'serial',     '',      '', '', '', 
2491         'batchnum',          'int',     '',      '', '', '', 
2492         'invnum',            'int',     '',      '', '', '', 
2493         'custnum',           'int',     '',      '', '', '', 
2494         'last',          'varchar',     '', $char_d, '', '', 
2495         'first',         'varchar',     '', $char_d, '', '', 
2496         'address1',      'varchar',     '', $char_d, '', '', 
2497         'address2',      'varchar', 'NULL', $char_d, '', '', 
2498         'city',          'varchar',     '', $char_d, '', '', 
2499         'state',         'varchar', 'NULL', $char_d, '', '', 
2500         'zip',           'varchar', 'NULL',      10, '', '', 
2501         'country',          'char',     '',       2, '', '', 
2502         'payby',            'char',     '',       4, '', '',
2503         'payinfo',       'varchar', 'NULL',     512, '', '', 
2504         #'exp',          @date_type,                  '', '',
2505         'exp',           'varchar', 'NULL',      11, '', '', 
2506         'payname',       'varchar', 'NULL', $char_d, '', '', 
2507         'amount',      @money_type,                  '', '', 
2508         'currency',         'char', 'NULL',       3, '', '',
2509         'status',        'varchar', 'NULL', $char_d, '', '', 
2510         'failure_status','varchar', 'NULL',      16, '', '',
2511         'error_message', 'varchar', 'NULL', $char_d, '', '',
2512       ],
2513       'primary_key'  => 'paybatchnum',
2514       'unique'       => [],
2515       'index'        => [ ['batchnum'], ['invnum'], ['custnum'] ],
2516       'foreign_keys' => [
2517                           { columns    => [ 'batchnum' ],
2518                             table      => 'pay_batch',
2519                           },
2520                           { columns    => [ 'invnum' ],
2521                             table      => 'cust_bill',
2522                           },
2523                           { columns    => [ 'custnum' ],
2524                             table      => 'cust_main',
2525                           },
2526                         ],
2527     },
2528
2529     'fcc477map' => {
2530       'columns' => [
2531         'formkey',   'varchar',     '', 255, '', '',
2532         'formvalue',    'text', 'NULL',  '', '', '',
2533       ],
2534       'primary_key' => 'formkey',
2535       'unique'      => [],
2536       'index'       => [],
2537     },
2538
2539     'cust_pkg' => {
2540       'columns' => [
2541         'pkgnum',           'serial',     '', '', '', '', 
2542         'custnum',             'int',     '', '', '', '', 
2543         'pkgpart',             'int',     '', '', '', '', 
2544         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
2545         'contactnum',          'int', 'NULL', '', '', '', 
2546         'locationnum',         'int', 'NULL', '', '', '',
2547         'otaker',          'varchar', 'NULL', 32, '', '', 
2548         'usernum',             'int', 'NULL', '', '', '',
2549         'salesnum',            'int', 'NULL', '', '', '', 
2550         'order_date',     @date_type,             '', '', 
2551         'start_date',     @date_type,             '', '', 
2552         'setup',          @date_type,             '', '', 
2553         'bill',           @date_type,             '', '', 
2554         'last_bill',      @date_type,             '', '', 
2555         'susp',           @date_type,             '', '', 
2556         'adjourn',        @date_type,             '', '', 
2557         'resume',         @date_type,             '', '', 
2558         'cancel',         @date_type,             '', '', 
2559         'uncancel',       @date_type,             '', '', 
2560         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
2561         'expire',         @date_type,             '', '', 
2562         'contract_end',   @date_type,             '', '',
2563         'dundate',        @date_type,             '', '',
2564         'change_date',    @date_type,             '', '',
2565         'change_pkgnum',       'int', 'NULL', '', '', '',
2566         'change_pkgpart',      'int', 'NULL', '', '', '',
2567         'change_locationnum',  'int', 'NULL', '', '', '',
2568         'change_custnum',      'int', 'NULL', '', '', '',
2569         'main_pkgnum',         'int', 'NULL', '', '', '',
2570         'pkglinknum',          'int', 'NULL', '', '', '',
2571         'manual_flag',        'char', 'NULL',  1, '', '', 
2572         'no_auto',            'char', 'NULL',  1, '', '', 
2573         'quantity',            'int', 'NULL', '', '', '',
2574         'agent_pkgid',         'int', 'NULL', '', '', '',
2575         'waive_setup',        'char', 'NULL',  1, '', '', 
2576         'recur_show_zero',    'char', 'NULL',  1, '', '',
2577         'setup_show_zero',    'char', 'NULL',  1, '', '',
2578         'change_to_pkgnum',    'int', 'NULL', '', '', '',
2579       ],
2580       'primary_key'  => 'pkgnum',
2581       'unique'       => [],
2582       'index'        => [ ['custnum'], ['pkgpart'], ['pkgbatch'],
2583                           ['locationnum'], ['usernum'], ['agent_pkgid'],
2584                           ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
2585                           ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
2586                           ['expire'], ['contract_end'], ['change_date'],
2587                           ['no_auto'],
2588                         ],
2589       'foreign_keys' => [
2590                           { columns    => [ 'custnum' ],
2591                             table      => 'cust_main',
2592                           },
2593                           { columns    => [ 'pkgpart' ],
2594                             table      => 'part_pkg',
2595                           },
2596                           { columns    => [ 'contactnum' ],
2597                             table      => 'contact',
2598                           },
2599                           { columns    => [ 'locationnum' ],
2600                             table      => 'cust_location',
2601                           },
2602                           { columns    => [ 'usernum' ],
2603                             table      => 'access_user',
2604                           },
2605                           { columns    => [ 'salesnum' ],
2606                             table      => 'sales',
2607                           },
2608                           { columns    => [ 'uncancel_pkgnum' ],
2609                             table      => 'cust_pkg',
2610                             references => [ 'pkgnum' ],
2611                           },
2612                           { columns    => [ 'change_pkgnum' ],
2613                             table      => 'cust_pkg',
2614                             references => [ 'pkgnum' ],
2615                           },
2616                           { columns    => [ 'change_pkgpart' ],
2617                             table      => 'part_pkg',
2618                             references => [ 'pkgpart' ],
2619                           },
2620                           { columns    => [ 'change_locationnum' ],
2621                             table      => 'cust_location',
2622                             references => [ 'locationnum' ],
2623                           },
2624                           { columns    => [ 'change_custnum' ],
2625                             table      => 'cust_main',
2626                             references => [ 'custnum' ],
2627                           },
2628                           { columns    => [ 'main_pkgnum' ],
2629                             table      => 'cust_pkg',
2630                             references => [ 'pkgnum' ],
2631                           },
2632                           { columns    => [ 'pkglinknum' ],
2633                             table      => 'part_pkg_link',
2634                           },
2635                           { columns    => [ 'change_to_pkgnum' ],
2636                             table      => 'cust_pkg',
2637                             references => [ 'pkgnum' ],
2638                           },
2639                         ],
2640    },
2641
2642     'cust_pkg_option' => {
2643       'columns' => [
2644         'optionnum', 'serial', '', '', '', '', 
2645         'pkgnum', 'int', '', '', '', '', 
2646         'optionname', 'varchar', '', $char_d, '', '', 
2647         'optionvalue', 'text', 'NULL', '', '', '', 
2648       ],
2649       'primary_key'  => 'optionnum',
2650       'unique'       => [],
2651       'index'        => [ [ 'pkgnum' ], [ 'optionname' ] ],
2652       'foreign_keys' => [
2653                           { columns    => [ 'pkgnum' ],
2654                             table      => 'cust_pkg',
2655                           },
2656                         ],
2657     },
2658
2659     'cust_pkg_detail' => {
2660       'columns' => [
2661         'pkgdetailnum', 'serial', '',      '', '', '',
2662         'pkgnum',          'int', '',      '', '', '',
2663         'detail',      'varchar', '', $char_d, '', '', 
2664         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
2665         'weight',          'int', '',      '', '', '',
2666       ],
2667       'primary_key'  => 'pkgdetailnum',
2668       'unique'       => [],
2669       'index'        => [ [ 'pkgnum', 'detailtype' ] ],
2670       'foreign_keys' => [
2671                           { columns    => [ 'pkgnum' ],
2672                             table      => 'cust_pkg',
2673                           },
2674                         ],
2675     },
2676
2677     'cust_pkg_reason' => {
2678       'columns' => [
2679         'num',      'serial',    '',   '', '', '', 
2680         'pkgnum',   'int',    '',   '', '', '', 
2681         'reasonnum','int',    '',   '', '', '', 
2682         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
2683         'otaker',   'varchar', 'NULL', 32, '', '', 
2684         'usernum',   'int', 'NULL', '', '', '',
2685         'date',     @date_type, '', '', 
2686       ],
2687       'primary_key'  => 'num',
2688       'unique'       => [],
2689       'index'        => [ ['pkgnum'], ['reasonnum'], ['action'], ['usernum'], ],
2690       'foreign_keys' => [
2691                           { columns    => [ 'pkgnum' ],
2692                             table      => 'cust_pkg',
2693                           },
2694                           { columns    => [ 'reasonnum' ],
2695                             table      => 'reason',
2696                           },
2697                           { columns    => [ 'usernum' ],
2698                             table      => 'access_user',
2699                           },
2700                         ],
2701     },
2702
2703     'cust_pkg_discount' => {
2704       'columns' => [
2705         'pkgdiscountnum', 'serial', '',        '', '', '',
2706         'pkgnum',            'int', '',        '', '', '', 
2707         'discountnum',       'int', '',        '', '', '',
2708         'months_used',   'decimal', 'NULL', '7,4', '', '',
2709         'end_date',     @date_type,                '', '',
2710         'otaker',        'varchar', 'NULL',    32, '', '', 
2711         'usernum',           'int', 'NULL',    '', '', '',
2712         'disabled',         'char', 'NULL',     1, '', '', 
2713       ],
2714       'primary_key'  => 'pkgdiscountnum',
2715       'unique'       => [],
2716       'index'        => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2717       'foreign_keys' => [
2718                           { columns    => [ 'pkgnum' ],
2719                             table      => 'cust_pkg',
2720                           },
2721                           { columns    => [ 'discountnum' ],
2722                             table      => 'discount',
2723                           },
2724                           { columns    => [ 'usernum' ],
2725                             table      => 'access_user',
2726                           },
2727                         ],
2728     },
2729
2730     'cust_pkg_usage' => {
2731       'columns' => [
2732         'pkgusagenum', 'serial', '', '', '', '',
2733         'pkgnum',         'int', '', '', '', '',
2734         'minutes',        'int', '', '', '', '',
2735         'pkgusagepart',   'int', '', '', '', '',
2736       ],
2737       'primary_key'  => 'pkgusagenum',
2738       'unique'       => [],
2739       'index'        => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2740       'foreign_keys' => [
2741                           { columns    => [ 'pkgnum' ],
2742                             table      => 'cust_pkg',
2743                           },
2744                           { columns    => [ 'pkgusagepart' ],
2745                             table      => 'part_pkg_usage',
2746                           },
2747                         ],
2748     },
2749
2750     'cdr_cust_pkg_usage' => {
2751       'columns' => [
2752         'cdrusagenum', 'bigserial', '', '', '', '',
2753         'acctid',      'bigint',    '', '', '', '',
2754         'pkgusagenum', 'int',       '', '', '', '',
2755         'minutes',     'int',       '', '', '', '',
2756       ],
2757       'primary_key'  => 'cdrusagenum',
2758       'unique'       => [],
2759       'index'        => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2760       'foreign_keys' => [
2761                           { columns    => [ 'acctid' ],
2762                             table      => 'cdr',
2763                           },
2764                           { columns    => [ 'pkgusagenum' ],
2765                             table      => 'cust_pkg_usage',
2766                           },
2767                         ],
2768     },
2769
2770     'cust_bill_pkg_discount' => {
2771       'columns' => [
2772         'billpkgdiscountnum', 'serial',        '', '', '', '',
2773         'billpkgnum',            'int',        '', '', '', '', 
2774         'pkgdiscountnum',        'int',        '', '', '', '', 
2775         'amount',          @money_type,                '', '', 
2776         'months',            'decimal', 'NULL', '7,4', '', '',
2777       ],
2778       'primary_key'  => 'billpkgdiscountnum',
2779       'unique'       => [],
2780       'index'        => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2781       'foreign_keys' => [
2782                           { columns    => [ 'billpkgnum' ],
2783                             table      => 'cust_bill_pkg',
2784                           },
2785                           { columns    => [ 'pkgdiscountnum' ],
2786                             table      => 'cust_pkg_discount',
2787                           },
2788                         ],
2789     },
2790
2791     'cust_bill_pkg_discount_void' => {
2792       'columns' => [
2793         'billpkgdiscountnum',    'int',        '', '', '', '',
2794         'billpkgnum',            'int',        '', '', '', '', 
2795         'pkgdiscountnum',        'int',        '', '', '', '', 
2796         'amount',          @money_type,                '', '', 
2797         'months',            'decimal', 'NULL', '7,4', '', '',
2798       ],
2799       'primary_key'  => 'billpkgdiscountnum',
2800       'unique'       => [],
2801       'index'        => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2802       'foreign_keys' => [
2803                           { columns    => [ 'billpkgnum' ],
2804                             table      => 'cust_bill_pkg_void',
2805                           },
2806                           { columns    => [ 'pkgdiscountnum' ],
2807                             table      => 'cust_pkg_discount',
2808                           },
2809                         ],
2810     },
2811
2812     'discount' => {
2813       'columns' => [
2814         'discountnum', 'serial',     '',      '', '', '',
2815         #'agentnum',       'int', 'NULL',      '', '', '', 
2816         'classnum',       'int', 'NULL',      '', '', '',
2817         'name',       'varchar', 'NULL', $char_d, '', '',
2818         'amount',   @money_type,                  '', '', 
2819         'percent',    'decimal',     '',   '7,4', '', '',
2820         'months',     'decimal', 'NULL',   '7,4', '', '',
2821         'disabled',      'char', 'NULL',       1, '', '', 
2822         'setup',         'char', 'NULL',       1, '', '', 
2823         #'linked',        'char', 'NULL',       1, '', '',
2824       ],
2825       'primary_key'  => 'discountnum',
2826       'unique'       => [],
2827       'index'        => [], # [ 'agentnum' ], ],
2828       'foreign_keys' => [
2829                           { columns    => [ 'classnum' ],
2830                             table      => 'discount_class',
2831                           },
2832                         ],
2833     },
2834
2835     'discount_class' => {
2836       'columns' => [
2837         'classnum',    'serial',   '',      '', '', '', 
2838         'classname',   'varchar',  '', $char_d, '', '', 
2839         #'categorynum', 'int',  'NULL',      '', '', '', 
2840         'disabled',    'char', 'NULL',       1, '', '', 
2841       ],
2842       'primary_key' => 'classnum',
2843       'unique' => [],
2844       'index' => [ ['disabled'] ],
2845     },
2846
2847     'cust_refund' => {
2848       'columns' => [
2849         'refundnum',    'serial',    '',   '', '', '', 
2850         'custnum',  'int',    '',   '', '', '', 
2851         '_date',        @date_type, '', '', 
2852         'refund',       @money_type, '', '', 
2853         'currency',       'char', 'NULL',       3, '', '',
2854         'otaker',       'varchar',   'NULL',   32, '', '', 
2855         'usernum',   'int', 'NULL', '', '', '',
2856         'reason',       'varchar',   'NULL',   $char_d, '', '', 
2857         'reasonnum',   'int', 'NULL', '', '', '',
2858         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
2859                                                      # be index into payby
2860                                                      # table eventually
2861         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
2862         'paymask', 'varchar', 'NULL', $char_d, '', '', 
2863         'paybatch',     'varchar',   'NULL', $char_d, '', '', 
2864         'closed',    'char', 'NULL', 1, '', '', 
2865         # credit card/EFT fields (formerly in paybatch)
2866         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
2867         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
2868         'auth',       'varchar','NULL',16, '', '', # CC auth number
2869         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
2870       ],
2871       'primary_key'  => 'refundnum',
2872       'unique'       => [],
2873       'index'        => [ ['custnum'], ['_date'], [ 'usernum' ], ],
2874       'foreign_keys' => [
2875                           { columns    => [ 'custnum' ],
2876                             table      => 'cust_main',
2877                           },
2878                           { columns    => [ 'usernum' ],
2879                             table      => 'access_user',
2880                           },
2881                           { columns    => [ 'reasonnum' ],
2882                             table      => 'reason',
2883                           },
2884                           { columns    => [ 'gatewaynum' ],