1 package FS::cust_pay_void;
4 use base qw( FS::otaker_Mixin FS::payinfo_transaction_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 sub nohistory_fields { ('payinfo'); }
22 $otaker_upgrade_kludge = 0;
26 FS::cust_pay_void - Object methods for cust_pay_void objects
30 use FS::cust_pay_void;
32 $record = new FS::cust_pay_void \%hash;
33 $record = new FS::cust_pay_void { 'column' => 'value' };
35 $error = $record->insert;
37 $error = $new_record->replace($old_record);
39 $error = $record->delete;
41 $error = $record->check;
45 An FS::cust_pay_void object represents a voided payment. The following fields
46 are currently supported:
52 primary key (assigned automatically for new payments)
56 customer (see L<FS::cust_main>)
60 Amount of this payment
64 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
65 L<Time::Local> and L<Date::Parse> for conversion functions.
69 order taker (see L<FS::access_user>)
73 Payment Type (See L<FS::payinfo_Mixin> for valid values)
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 my $cust_pay_pending =
140 qsearchs('cust_pay_pending', { void_paynum => $self->paynum });
141 if ( $cust_pay_pending ) {
142 $cust_pay_pending->set('paynum', $cust_pay->paynum);
143 $cust_pay_pending->set('void_paynum', '');
144 $error ||= $cust_pay_pending->replace;
147 $error ||= $self->delete;
149 $dbh->rollback if $oldAutoCommit;
153 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
161 Deletes this voided payment. You probably don't want to use this directly; see
162 the B<unvoid> method to add the original payment back.
164 =item replace [ OLD_RECORD ]
166 You can, but probably shouldn't modify voided payments...
168 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
169 supplied, replaces this record. If there is an error, returns the error,
170 otherwise returns false.
174 Checks all fields to make sure this is a valid voided payment. If there is an
175 error, returns the error, otherwise returns false. Called by the insert
184 $self->ut_numbern('paynum')
185 || $self->ut_numbern('custnum')
186 || $self->ut_money('paid')
187 || $self->ut_number('_date')
188 || $self->ut_textn('paybatch')
189 || $self->ut_enum('closed', [ '', 'Y' ])
190 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
191 || $self->ut_numbern('void_date')
192 || $self->ut_textn('reason')
193 || $self->payinfo_check
195 return $error if $error;
197 return "paid must be > 0 " if $self->paid <= 0;
199 return "unknown cust_main.custnum: ". $self->custnum
201 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
203 $self->void_date(time) unless $self->void_date;
205 $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
206 unless $self->void_usernum;
213 Returns the parent customer object (see L<FS::cust_main>).
219 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
222 =item void_access_user
224 Returns the voiding employee object (see L<FS::access_user>).
228 sub void_access_user {
230 qsearchs('access_user', { 'usernum' => $self->void_usernum } );
233 # Used by FS::Upgrade to migrate to a new database.
234 sub _upgrade_data { # class method
235 my ($class, %opts) = @_;
237 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 ) ";
238 my $sth = dbh->prepare($sql) or die dbh->errstr;
240 foreach my $cust_pay_void (qsearch('cust_pay_void', {'void_usernum' => ''})) {
241 $sth->execute($cust_pay_void->paynum) or die $sth->errstr;
242 my $row = $sth->fetchrow_arrayref;
243 my $usernum = $row ? $row->[0] : '';
245 $cust_pay_void->void_usernum($usernum);
246 my $error = $cust_pay_void->replace;
247 die $error if $error;
249 warn "cust_pay_void upgrade: can't find access_user record for ". $cust_pay_void->paynum. "\n";
253 local($otaker_upgrade_kludge) = 1;
254 $class->_upgrade_otaker(%opts);
256 #XXX look for the h_cust_pay delete records and when that's a different
257 # usernum, set usernum
264 Delete and replace methods.
268 L<FS::cust_pay>, L<FS::Record>, schema.html from the base documentation.