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