FS/FS/cust_tax_adjustment.pm

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