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