FS/FS/cust_pay_void.pm

   1 package FS::cust_pay_void;
   2 use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
   3              FS::reason_Mixin FS::Record );
   4
   5 use strict;
   6 use vars qw( @encrypted_fields $otaker_upgrade_kludge );
   7 use Business::CreditCard;
   8 use FS::Record qw(qsearch qsearchs dbh fields);
   9 use FS::CurrentUser;
  10 use FS::access_user;
  11 use FS::cust_pay;
  12 #use FS::cust_bill;
  13 #use FS::cust_bill_pay;
  14 #use FS::cust_pay_refund;
  15 use FS::cust_pkg;
  16
  17 @encrypted_fields = ('payinfo');
  18 sub nohistory_fields { ('payinfo'); }
  19
  20 $otaker_upgrade_kludge = 0;
  21
  22 =head1 NAME
  23
  24 FS::cust_pay_void - Object methods for cust_pay_void objects
  25
  26 =head1 SYNOPSIS
  27
  28   use FS::cust_pay_void;
  29
  30   $record = new FS::cust_pay_void \%hash;
  31   $record = new FS::cust_pay_void { 'column' => 'value' };
  32
  33   $error = $record->insert;
  34
  35   $error = $new_record->replace($old_record);
  36
  37   $error = $record->delete;
  38
  39   $error = $record->check;
  40
  41 =head1 DESCRIPTION
  42
  43 An FS::cust_pay_void object represents a voided payment.  The following fields
  44 are currently supported:
  45
  46 =over 4
  47
  48 =item paynum
  49
  50 primary key (assigned automatically for new payments)
  51
  52 =item custnum
  53
  54 customer (see L<FS::cust_main>)
  55
  56 =item paid
  57
  58 Amount of this payment
  59
  60 =item _date
  61
  62 specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  63 L<Time::Local> and L<Date::Parse> for conversion functions.
  64
  65 =item otaker
  66
  67 order taker (see L<FS::access_user>)
  68
  69 =item payby
  70
  71 Payment Type (See L<FS::payinfo_Mixin> for valid values)
  72
  73 =item payinfo
  74
  75 card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
  76
  77 =item cardtype
  78
  79 Credit card type, if appropriate.
  80
  81 =item paybatch
  82
  83 text field for tracking card processing
  84
  85 =item closed
  86
  87 books closed flag, empty or `Y'
  88
  89 =item pkgnum
  90
  91 Desired pkgnum when using experimental package balances.
  92
  93 =item void_date
  94
  95 =item reason - a freeform string (deprecated)
  96
  97 =item reasonnum - Reason for voiding the payment (see L<FS::reson>)
  98
  99 =back
 100
 101 =head1 METHODS
 102
 103 =over 4
 104
 105 =item new HASHREF
 106
 107 Creates a new payment.  To add the payment to the databse, see L<"insert">.
 108
 109 =cut
 110
 111 sub table { 'cust_pay_void'; }
 112
 113 =item insert
 114
 115 Adds this voided payment to the database.
 116
 117 =item unvoid
 118
 119 "Un-void"s this payment: Deletes the voided payment from the database and adds
 120 back a normal payment.
 121
 122 =cut
 123
 124 sub unvoid {
 125   my $self = shift;
 126
 127   local $SIG{HUP} = 'IGNORE';
 128   local $SIG{INT} = 'IGNORE';
 129   local $SIG{QUIT} = 'IGNORE';
 130   local $SIG{TERM} = 'IGNORE';
 131   local $SIG{TSTP} = 'IGNORE';
 132   local $SIG{PIPE} = 'IGNORE';
 133
 134   my $oldAutoCommit = $FS::UID::AutoCommit;
 135   local $FS::UID::AutoCommit = 0;
 136   my $dbh = dbh;
 137
 138   my $cust_pay = new FS::cust_pay ( {
 139     map { $_ => $self->get($_) } fields('cust_pay')
 140   } );
 141   my $error = $cust_pay->insert;
 142
 143   my $cust_pay_pending =
 144     qsearchs('cust_pay_pending', { void_paynum => $self->paynum });
 145   if ( $cust_pay_pending ) {
 146     $cust_pay_pending->set('paynum', $cust_pay->paynum);
 147     $cust_pay_pending->set('void_paynum', '');
 148     $error ||= $cust_pay_pending->replace;
 149   }
 150
 151   $error ||= $self->delete;
 152   if ( $error ) {
 153     $dbh->rollback if $oldAutoCommit;
 154     return $error;
 155   }
 156
 157   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 158
 159   '';
 160
 161 }
 162
 163 =item delete
 164
 165 Deletes this voided payment.  You probably don't want to use this directly; see
 166 the B<unvoid> method to add the original payment back.
 167
 168 =item replace [ OLD_RECORD ]
 169
 170 You can, but probably shouldn't modify voided payments...
 171
 172 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
 173 supplied, replaces this record.  If there is an error, returns the error,
 174 otherwise returns false.
 175
 176 =item check
 177
 178 Checks all fields to make sure this is a valid voided payment.  If there is an
 179 error, returns the error, otherwise returns false.  Called by the insert
 180 method.
 181
 182 =cut
 183
 184 sub check {
 185   my $self = shift;
 186
 187   my $error =
 188     $self->ut_numbern('paynum')
 189     || $self->ut_numbern('custnum')
 190     || $self->ut_money('paid')
 191     || $self->ut_number('_date')
 192     || $self->ut_textn('paybatch')
 193     || $self->ut_enum('closed', [ '', 'Y' ])
 194     || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
 195     || $self->ut_numbern('void_date')
 196     || $self->ut_textn('reason')
 197     # || $self->payinfo_check #we'd rather void what we have than fail on this
 198     || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
 199   ;
 200   return $error if $error;
 201
 202   return "paid must be > 0 " if $self->paid <= 0;
 203
 204   return "unknown cust_main.custnum: ". $self->custnum
 205     unless $self->invnum
 206            || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 207
 208   $self->void_date(time) unless $self->void_date;
 209
 210   $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
 211     unless $self->void_usernum;
 212
 213   $self->SUPER::check;
 214 }
 215
 216 =item cust_main
 217
 218 Returns the parent customer object (see L<FS::cust_main>).
 219
 220 =item void_access_user
 221
 222 Returns the voiding employee object (see L<FS::access_user>).
 223
 224 =cut
 225
 226 sub void_access_user {
 227   my $self = shift;
 228   qsearchs('access_user', { 'usernum' => $self->void_usernum } );
 229 }
 230
 231 =item reason
 232
 233 Returns the text of the associated void reason (see L<FS::reason>) for this.
 234
 235 =cut
 236
 237 # Used by FS::Upgrade to migrate to a new database.
 238 sub _upgrade_data {  # class method
 239   my ($class, %opts) = @_;
 240
 241   local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
 242
 243   $class->_upgrade_reasonnum(%opts);
 244
 245   my $sql = "SELECT usernum FROM access_user WHERE username = ( SELECT history_user FROM h_cust_pay_void WHERE paynum = ? AND history_action = 'insert' ORDER BY history_date LIMIT 1 ) ";
 246   my $sth = dbh->prepare($sql) or die dbh->errstr;
 247
 248   foreach my $cust_pay_void (qsearch('cust_pay_void', {'void_usernum' => ''})) {
 249     $sth->execute($cust_pay_void->paynum) or die $sth->errstr;
 250     my $row = $sth->fetchrow_arrayref;
 251     my $usernum = $row ? $row->[0] : '';
 252     if ( $usernum ) {
 253       $cust_pay_void->void_usernum($usernum);
 254       my $error = $cust_pay_void->replace;
 255       die $error if $error;
 256     } else {
 257       warn "cust_pay_void upgrade: can't find access_user record for ". $cust_pay_void->paynum. "\n";
 258     }
 259   }
 260
 261   local($otaker_upgrade_kludge) = 1;
 262   $class->_upgrade_otaker(%opts);
 263
 264   #XXX look for the h_cust_pay delete records and when that's a different
 265   # usernum, set usernum
 266 }
 267
 268 =back
 269
 270 =head1 BUGS
 271
 272 Delete and replace methods.
 273
 274 =head1 SEE ALSO
 275
 276 L<FS::cust_pay>, L<FS::Record>, schema.html from the base documentation.
 277
 278 =cut
 279
 280 1;
 281