1 package FS::cust_pay_void;
4 use base qw( FS::otaker_Mixin FS::payinfo_Mixin FS::Record );
5 use vars qw( @encrypted_fields $otaker_upgrade_kludge );
6 use Business::CreditCard;
7 use FS::UID qw(getotaker);
8 use FS::Record qw(qsearchs dbh fields); # qsearch );
12 #use FS::cust_bill_pay;
13 #use FS::cust_pay_refund;
17 @encrypted_fields = ('payinfo');
18 $otaker_upgrade_kludge = 0;
22 FS::cust_pay_void - Object methods for cust_pay_void objects
26 use FS::cust_pay_void;
28 $record = new FS::cust_pay_void \%hash;
29 $record = new FS::cust_pay_void { 'column' => 'value' };
31 $error = $record->insert;
33 $error = $new_record->replace($old_record);
35 $error = $record->delete;
37 $error = $record->check;
41 An FS::cust_pay_void object represents a voided payment. The following fields
42 are currently supported:
48 primary key (assigned automatically for new payments)
52 customer (see L<FS::cust_main>)
56 Amount of this payment
60 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
61 L<Time::Local> and L<Date::Parse> for conversion functions.
65 order taker (see L<FS::access_user>)
69 `CARD' (credit cards), `CHEK' (electronic check/ACH),
70 `LECB' (phone bill billing), `BILL' (billing), `CASH' (cash),
71 `WEST' (Western Union), `MCRD' (Manual credit card), or `COMP' (free)
75 card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
79 text field for tracking card processing
83 books closed flag, empty or `Y'
87 Desired pkgnum when using experimental package balances.
101 Creates a new payment. To add the payment to the databse, see L<"insert">.
105 sub table { 'cust_pay_void'; }
109 Adds this voided payment to the database.
113 "Un-void"s this payment: Deletes the voided payment from the database and adds
114 back a normal payment.
121 local $SIG{HUP} = 'IGNORE';
122 local $SIG{INT} = 'IGNORE';
123 local $SIG{QUIT} = 'IGNORE';
124 local $SIG{TERM} = 'IGNORE';
125 local $SIG{TSTP} = 'IGNORE';
126 local $SIG{PIPE} = 'IGNORE';
128 my $oldAutoCommit = $FS::UID::AutoCommit;
129 local $FS::UID::AutoCommit = 0;
132 my $cust_pay = new FS::cust_pay ( {
133 map { $_ => $self->get($_) } fields('cust_pay')
135 my $error = $cust_pay->insert;
137 $dbh->rollback if $oldAutoCommit;
141 $error = $self->delete;
143 $dbh->rollback if $oldAutoCommit;
147 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
155 Deletes this voided payment. You probably don't want to use this directly; see
156 the B<unvoid> method to add the original payment back.
158 =item replace OLD_RECORD
160 Currently unimplemented.
165 return "Can't modify voided payments!" unless $otaker_upgrade_kludge;
166 shift->SUPER::replace(@_);
171 Checks all fields to make sure this is a valid voided payment. If there is an
172 error, returns the error, otherwise returns false. Called by the insert
181 $self->ut_numbern('paynum')
182 || $self->ut_numbern('custnum')
183 || $self->ut_money('paid')
184 || $self->ut_number('_date')
185 || $self->ut_textn('paybatch')
186 || $self->ut_enum('closed', [ '', 'Y' ])
187 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
188 || $self->ut_numbern('void_date')
189 || $self->ut_textn('reason')
191 return $error if $error;
193 return "paid must be > 0 " if $self->paid <= 0;
195 return "unknown cust_main.custnum: ". $self->custnum
197 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
199 $self->void_date(time) unless $self->void_date;
201 $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP|PREP|CASH|WEST|MCRD)$/
202 or return "Illegal payby";
205 #false laziness with cust_refund::check
206 if ( $self->payby eq 'CARD' ) {
207 my $payinfo = $self->payinfo;
209 $self->payinfo($payinfo);
210 if ( $self->payinfo ) {
211 $self->payinfo =~ /^(\d{13,16})$/
212 or return "Illegal (mistyped?) credit card number (payinfo)";
214 validate($self->payinfo) or return "Illegal credit card number";
215 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
217 $self->payinfo('N/A');
221 $error = $self->ut_textn('payinfo');
222 return $error if $error;
225 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
232 Returns the parent customer object (see L<FS::cust_main>).
238 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
241 # Used by FS::Upgrade to migrate to a new database.
242 sub _upgrade_data { # class method
243 my ($class, %opts) = @_;
244 local($otaker_upgrade_kludge) = 1;
245 $class->_upgrade_otaker(%opts);
252 Delete and replace methods.
256 L<FS::cust_pay>, L<FS::Record>, schema.html from the base documentation.