1 package FS::cust_pay_void;
4 use base qw( FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
6 use vars qw( @encrypted_fields $otaker_upgrade_kludge );
7 use Business::CreditCard;
8 use FS::UID qw(getotaker);
9 use FS::Record qw(qsearch qsearchs dbh fields);
14 #use FS::cust_bill_pay;
15 #use FS::cust_pay_refund;
19 @encrypted_fields = ('payinfo');
20 $otaker_upgrade_kludge = 0;
24 FS::cust_pay_void - Object methods for cust_pay_void objects
28 use FS::cust_pay_void;
30 $record = new FS::cust_pay_void \%hash;
31 $record = new FS::cust_pay_void { 'column' => 'value' };
33 $error = $record->insert;
35 $error = $new_record->replace($old_record);
37 $error = $record->delete;
39 $error = $record->check;
43 An FS::cust_pay_void object represents a voided payment. The following fields
44 are currently supported:
50 primary key (assigned automatically for new payments)
54 customer (see L<FS::cust_main>)
58 Amount of this payment
62 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
63 L<Time::Local> and L<Date::Parse> for conversion functions.
67 order taker (see L<FS::access_user>)
71 `CARD' (credit cards), `CHEK' (electronic check/ACH),
72 `LECB' (phone bill billing), `BILL' (billing), `CASH' (cash),
73 `WEST' (Western Union), `MCRD' (Manual credit card), or `COMP' (free)
77 card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
81 text field for tracking card processing
85 books closed flag, empty or `Y'
89 Desired pkgnum when using experimental package balances.
103 Creates a new payment. To add the payment to the databse, see L<"insert">.
107 sub table { 'cust_pay_void'; }
111 Adds this voided payment to the database.
115 "Un-void"s this payment: Deletes the voided payment from the database and adds
116 back a normal payment.
123 local $SIG{HUP} = 'IGNORE';
124 local $SIG{INT} = 'IGNORE';
125 local $SIG{QUIT} = 'IGNORE';
126 local $SIG{TERM} = 'IGNORE';
127 local $SIG{TSTP} = 'IGNORE';
128 local $SIG{PIPE} = 'IGNORE';
130 my $oldAutoCommit = $FS::UID::AutoCommit;
131 local $FS::UID::AutoCommit = 0;
134 my $cust_pay = new FS::cust_pay ( {
135 map { $_ => $self->get($_) } fields('cust_pay')
137 my $error = $cust_pay->insert;
139 $dbh->rollback if $oldAutoCommit;
143 $error = $self->delete;
145 $dbh->rollback if $oldAutoCommit;
149 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
157 Deletes this voided payment. You probably don't want to use this directly; see
158 the B<unvoid> method to add the original payment back.
160 =item replace [ OLD_RECORD ]
162 You can, but probably shouldn't modify voided payments...
164 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
165 supplied, replaces this record. If there is an error, returns the error,
166 otherwise returns false.
170 Checks all fields to make sure this is a valid voided payment. If there is an
171 error, returns the error, otherwise returns false. Called by the insert
180 $self->ut_numbern('paynum')
181 || $self->ut_numbern('custnum')
182 || $self->ut_money('paid')
183 || $self->ut_number('_date')
184 || $self->ut_textn('paybatch')
185 || $self->ut_enum('closed', [ '', 'Y' ])
186 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
187 || $self->ut_numbern('void_date')
188 || $self->ut_textn('reason')
190 return $error if $error;
192 return "paid must be > 0 " if $self->paid <= 0;
194 return "unknown cust_main.custnum: ". $self->custnum
196 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
198 $self->void_date(time) unless $self->void_date;
200 $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP|PREP|CASH|WEST|MCRD)$/
201 or return "Illegal payby";
204 #false laziness with cust_refund::check
205 if ( $self->payby eq 'CARD' ) {
206 my $payinfo = $self->payinfo;
208 $self->payinfo($payinfo);
209 if ( $self->payinfo ) {
210 $self->payinfo =~ /^(\d{13,16})$/
211 or return "Illegal (mistyped?) credit card number (payinfo)";
213 validate($self->payinfo) or return "Illegal credit card number";
214 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
216 $self->payinfo('N/A');
220 $error = $self->ut_textn('payinfo');
221 return $error if $error;
224 $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
225 unless $self->void_usernum;
232 Returns the parent customer object (see L<FS::cust_main>).
238 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
241 =item void_access_user
243 Returns the voiding employee object (see L<FS::access_user>).
247 sub void_access_user {
249 qsearchs('access_user', { 'usernum' => $self->void_usernum } );
252 # Used by FS::Upgrade to migrate to a new database.
253 sub _upgrade_data { # class method
254 my ($class, %opts) = @_;
256 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 ) ";
257 my $sth = dbh->prepare($sql) or die dbh->errstr;
259 foreach my $cust_pay_void (qsearch('cust_pay_void', {'void_usernum' => ''})) {
260 $sth->execute($cust_pay_void->paynum) or die $sth->errstr;
261 my $row = $sth->fetchrow_arrayref;
262 my $usernum = $row ? $row->[0] : '';
264 $cust_pay_void->void_usernum($usernum);
265 my $error = $cust_pay_void->replace;
266 die $error if $error;
268 warn "cust_pay_void upgrade: can't find access_user record for ". $cust_pay_void->paynum. "\n";
272 local($otaker_upgrade_kludge) = 1;
273 $class->_upgrade_otaker(%opts);
275 #XXX look for the h_cust_pay delete records and when that's a different
276 # usernum, set usernum
283 Delete and replace methods.
287 L<FS::cust_pay>, L<FS::Record>, schema.html from the base documentation.