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