diff options
Diffstat (limited to 'FS/FS/cust_pay_void.pm')
-rw-r--r-- | FS/FS/cust_pay_void.pm | 236 |
1 files changed, 0 insertions, 236 deletions
diff --git a/FS/FS/cust_pay_void.pm b/FS/FS/cust_pay_void.pm deleted file mode 100644 index 946d69f..0000000 --- a/FS/FS/cust_pay_void.pm +++ /dev/null @@ -1,236 +0,0 @@ -package FS::cust_pay_void; -use strict; -use vars qw( @ISA ); -use Business::CreditCard; -use FS::UID qw(getotaker); -use FS::Record qw(qsearchs dbh fields); # qsearch ); -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 ); - -=head1 NAME - -FS::cust_pay_void - Object methods for cust_pay_void objects - -=head1 SYNOPSIS - - use FS::cust_pay_void; - - $record = new FS::cust_pay_void \%hash; - $record = new FS::cust_pay_void { 'column' => 'value' }; - - $error = $record->insert; - - $error = $new_record->replace($old_record); - - $error = $record->delete; - - $error = $record->check; - -=head1 DESCRIPTION - -An FS::cust_pay_void object represents a voided payment. The following fields -are currently supported: - -=over 4 - -=item paynum - primary key (assigned automatically for new payments) - -=item custnum - customer (see L<FS::cust_main>) - -=item paid - Amount of this payment - -=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 payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively - -=item paybatch - text field for tracking card processing - -=item closed - books closed flag, empty or `Y' - -=item void_date - -=item reason - -=back - -=head1 METHODS - -=over 4 - -=item new HASHREF - -Creates a new payment. To add the payment to the databse, see L<"insert">. - -=cut - -sub table { 'cust_pay_void'; } - -=item insert - -Adds this voided payment to the database. - -=item unvoid - -"Un-void"s this payment: Deletes the voided payment from the database and adds -back a normal payment. - -=cut - -sub unvoid { - my $self = shift; - - local $SIG{HUP} = 'IGNORE'; - local $SIG{INT} = 'IGNORE'; - local $SIG{QUIT} = 'IGNORE'; - local $SIG{TERM} = 'IGNORE'; - local $SIG{TSTP} = 'IGNORE'; - local $SIG{PIPE} = 'IGNORE'; - - my $oldAutoCommit = $FS::UID::AutoCommit; - local $FS::UID::AutoCommit = 0; - my $dbh = dbh; - - my $cust_pay = new FS::cust_pay ( { - map { $_ => $self->get($_) } fields('cust_pay') - } ); - my $error = $cust_pay->insert; - if ( $error ) { - $dbh->rollback if $oldAutoCommit; - return $error; - } - - $error = $self->delete; - if ( $error ) { - $dbh->rollback if $oldAutoCommit; - return $error; - } - - $dbh->commit or die $dbh->errstr if $oldAutoCommit; - - ''; - -} - -=item delete - -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 - -Currently unimplemented. - -=cut - -sub replace { - return "Can't modify voided payments!"; -} - -=item check - -Checks all fields to make sure this is a valid voided payment. If there is an -error, returns the error, otherwise returns false. Called by the insert -method. - -=cut - -sub check { - my $self = shift; - - my $error = - $self->ut_numbern('paynum') - || $self->ut_numbern('custnum') - || $self->ut_money('paid') - || $self->ut_number('_date') - || $self->ut_textn('paybatch') - || $self->ut_enum('closed', [ '', 'Y' ]) - || $self->ut_numbern('void_date') - || $self->ut_textn('reason') - ; - return $error if $error; - - return "paid must be > 0 " if $self->paid <= 0; - - return "unknown cust_main.custnum: ". $self->custnum - unless $self->invnum - || qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); - - $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->SUPER::check; -} - -=item cust_main - -Returns the parent customer object (see L<FS::cust_main>). - -=cut - -sub cust_main { - my $self = shift; - qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); -} - -=item payinfo_masked - -Returns a "masked" payinfo field with all but the last four characters replaced -by 'x'es. Useful for displaying credit cards. - -=cut - -sub payinfo_masked { - my $self = shift; - my $payinfo = $self->payinfo; - 'x'x(length($payinfo)-4). substr($payinfo,(length($payinfo)-4)); -} - -=back - -=head1 BUGS - -Delete and replace methods. - -=head1 SEE ALSO - -L<FS::cust_pay>, L<FS::Record>, schema.html from the base documentation. - -=cut - -1; - |