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