FS/FS/cust_bill_pkg_tax_rate_location.pm

   1 package FS::cust_bill_pkg_tax_rate_location;
   2
   3 use strict;
   4 use base qw( FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::cust_bill_pkg;
   7 use FS::cust_pkg;
   8 use FS::cust_location;
   9
  10 =head1 NAME
  11
  12 FS::cust_bill_pkg_tax_rate_location - Object methods for cust_bill_pkg_tax_rate_location records
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::cust_bill_pkg_tax_rate_location;
  17
  18   $record = new FS::cust_bill_pkg_tax_rate_location \%hash;
  19   $record = new FS::cust_bill_pkg_tax_rate_location { 'column' => 'value' };
  20
  21   $error = $record->insert;
  22
  23   $error = $new_record->replace($old_record);
  24
  25   $error = $record->delete;
  26
  27   $error = $record->check;
  28
  29 =head1 DESCRIPTION
  30
  31 An FS::cust_bill_pkg_tax_rate_location object represents an record of taxation
  32 based on package location.  FS::cust_bill_pkg_tax_rate_location inherits from
  33 FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item billpkgtaxratelocationnum
  38
  39 billpkgtaxratelocationnum
  40
  41 =item billpkgnum
  42
  43 billpkgnum
  44
  45 =item taxnum
  46
  47 taxnum
  48
  49 =item taxtype
  50
  51 taxtype
  52
  53 =item locationtaxid
  54
  55 locationtaxid
  56
  57 =item taxratelocationnum
  58
  59 taxratelocationnum
  60
  61 =item amount
  62
  63 amount
  64
  65
  66 =back
  67
  68 =head1 METHODS
  69
  70 =over 4
  71
  72 =item new HASHREF
  73
  74 Creates a new record.  To add the record to the database, see L<"insert">.
  75
  76 Note that this stores the hash reference, not a distinct copy of the hash it
  77 points to.  You can ask the object for a copy with the I<hash> method.
  78
  79 =cut
  80
  81 sub table { 'cust_bill_pkg_tax_rate_location'; }
  82
  83 =item insert
  84
  85 Adds this record to the database.  If there is an error, returns the error,
  86 otherwise returns false.
  87
  88 =item delete
  89
  90 Delete this record from the database.
  91
  92 =item replace OLD_RECORD
  93
  94 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  95 returns the error, otherwise returns false.
  96
  97 =item check
  98
  99 Checks all fields to make sure this is a valid record.  If there is
 100 an error, returns the error, otherwise returns false.  Called by the insert
 101 and replace methods.
 102
 103 =cut
 104
 105 # the check method should currently be supplied - FS::Record contains some
 106 # data checking routines
 107
 108 sub check {
 109   my $self = shift;
 110
 111   my $error =
 112     $self->ut_numbern('billpkgtaxratelocationnum')
 113     || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' )
 114     || $self->ut_number('taxnum') #cust_bill_pkg/tax_rate key, based on taxtype
 115     || $self->ut_enum('taxtype', [ qw( FS::cust_main_county FS::tax_rate ) ] )
 116     || $self->ut_textn('locationtaxid')
 117     || $self->ut_foreign_key('taxratelocationnum', 'tax_rate_location', 'taxratelocationnum' )
 118     || $self->ut_money('amount')
 119   ;
 120   return $error if $error;
 121
 122   $self->SUPER::check;
 123 }
 124
 125 =back
 126
 127 =head1 BUGS
 128
 129 =head1 SEE ALSO
 130
 131 L<FS::Record>, schema.html from the base documentation.
 132
 133 =cut
 134
 135 1;
 136