package FS::cust_pay_void;
+use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
+ FS::reason_Mixin FS::Record );
+
use strict;
-use vars qw( @ISA @encrypted_fields );
+use vars qw( @encrypted_fields $otaker_upgrade_kludge );
use Business::CreditCard;
-use FS::UID qw(getotaker);
-use FS::Record qw(qsearchs dbh fields); # qsearch );
+use FS::Record qw(qsearch qsearchs dbh fields);
+use FS::CurrentUser;
+use FS::access_user;
use FS::cust_pay;
#use FS::cust_bill;
#use FS::cust_bill_pay;
#use FS::cust_pay_refund;
-#use FS::cust_main;
-
-@ISA = qw( FS::Record FS::payinfo_Mixin );
+use FS::cust_pkg;
@encrypted_fields = ('payinfo');
+sub nohistory_fields { ('payinfo'); }
+
+$otaker_upgrade_kludge = 0;
=head1 NAME
=over 4
-=item paynum - primary key (assigned automatically for new payments)
+=item paynum
+
+primary key (assigned automatically for new payments)
+
+=item custnum
+
+customer (see L<FS::cust_main>)
-=item custnum - customer (see L<FS::cust_main>)
+=item paid
-=item paid - Amount of this payment
+Amount of this payment
-=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
+=item _date
+
+specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
L<Time::Local> and L<Date::Parse> for conversion functions.
-=item payby - `CARD' (credit cards), `CHEK' (electronic check/ACH),
-`LECB' (phone bill billing), `BILL' (billing), `CASH' (cash),
-`WEST' (Western Union), `MCRD' (Manual credit card), or `COMP' (free)
+=item otaker
+
+order taker (see L<FS::access_user>)
+
+=item payby
+
+Payment Type (See L<FS::payinfo_Mixin> for valid values)
+
+=item payinfo
+
+card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
-=item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
+=item cardtype
-=item paybatch - text field for tracking card processing
+Credit card type, if appropriate.
-=item closed - books closed flag, empty or `Y'
+=item paybatch
+
+text field for tracking card processing
+
+=item closed
+
+books closed flag, empty or `Y'
+
+=item pkgnum
+
+Desired pkgnum when using experimental package balances.
=item void_date
-=item reason
+=item reason - a freeform string (deprecated)
+
+=item reasonnum - Reason for voiding the payment (see L<FS::reason>)
=back
map { $_ => $self->get($_) } fields('cust_pay')
} );
my $error = $cust_pay->insert;
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return $error;
+
+ my $cust_pay_pending =
+ qsearchs('cust_pay_pending', { void_paynum => $self->paynum });
+ if ( $cust_pay_pending ) {
+ $cust_pay_pending->set('paynum', $cust_pay->paynum);
+ $cust_pay_pending->set('void_paynum', '');
+ $error ||= $cust_pay_pending->replace;
}
- $error = $self->delete;
+ $error ||= $self->delete;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
Deletes this voided payment. You probably don't want to use this directly; see
the B<unvoid> method to add the original payment back.
-=item replace OLD_RECORD
+=item replace [ OLD_RECORD ]
-Currently unimplemented.
+You can, but probably shouldn't modify voided payments...
-=cut
-
-sub replace {
- return "Can't modify voided payments!";
-}
+Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
+supplied, replaces this record. If there is an error, returns the error,
+otherwise returns false.
=item check
|| $self->ut_number('_date')
|| $self->ut_textn('paybatch')
|| $self->ut_enum('closed', [ '', 'Y' ])
+ || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
|| $self->ut_numbern('void_date')
|| $self->ut_textn('reason')
+ # || $self->payinfo_check #we'd rather void what we have than fail on this
+ || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
;
return $error if $error;
$self->void_date(time) unless $self->void_date;
- $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP|PREP|CASH|WEST|MCRD)$/
- or return "Illegal payby";
- $self->payby($1);
-
- #false laziness with cust_refund::check
- if ( $self->payby eq 'CARD' ) {
- my $payinfo = $self->payinfo;
- $payinfo =~ s/\D//g;
- $self->payinfo($payinfo);
- if ( $self->payinfo ) {
- $self->payinfo =~ /^(\d{13,16})$/
- or return "Illegal (mistyped?) credit card number (payinfo)";
- $self->payinfo($1);
- validate($self->payinfo) or return "Illegal credit card number";
- return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
- } else {
- $self->payinfo('N/A');
- }
-
- } else {
- $error = $self->ut_textn('payinfo');
- return $error if $error;
- }
-
- $self->otaker(getotaker);
+ $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
+ unless $self->void_usernum;
$self->SUPER::check;
}
Returns the parent customer object (see L<FS::cust_main>).
+=item void_access_user
+
+Returns the voiding employee object (see L<FS::access_user>).
+
=cut
-sub cust_main {
+sub void_access_user {
my $self = shift;
- qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
+ qsearchs('access_user', { 'usernum' => $self->void_usernum } );
}
-=item payinfo_masked
-
-< DEPRICATED > Use $self->paymask
+=item reason
-Returns a "masked" payinfo field with all but the last four characters replaced
-by 'x'es. Useful for displaying credit cards.
+Returns the text of the associated void reason (see L<FS::reason>) for this.
=cut
-sub payinfo_masked {
- my $self = shift;
- return $self->paymask;
+# Used by FS::Upgrade to migrate to a new database.
+sub _upgrade_data { # class method
+ my ($class, %opts) = @_;
+
+ local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
+
+ $class->_upgrade_reasonnum(%opts);
+
+ 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 ) ";
+ my $sth = dbh->prepare($sql) or die dbh->errstr;
+
+ foreach my $cust_pay_void (qsearch('cust_pay_void', {'void_usernum' => ''})) {
+ $sth->execute($cust_pay_void->paynum) or die $sth->errstr;
+ my $row = $sth->fetchrow_arrayref;
+ my $usernum = $row ? $row->[0] : '';
+ if ( $usernum ) {
+ $cust_pay_void->void_usernum($usernum);
+ my $error = $cust_pay_void->replace;
+ die $error if $error;
+ } else {
+ warn "cust_pay_void upgrade: can't find access_user record for ". $cust_pay_void->paynum. "\n";
+ }
+ }
+
+ local($otaker_upgrade_kludge) = 1;
+ $class->_upgrade_otaker(%opts);
+
+ #XXX look for the h_cust_pay delete records and when that's a different
+ # usernum, set usernum
}
=back
projects / freeside.git / blobdiff