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::Record qw(qsearch qsearchs dbh fields);
13 #use FS::cust_bill_pay;
14 #use FS::cust_pay_refund;
18 @encrypted_fields = ('payinfo');
19 $otaker_upgrade_kludge = 0;
23 FS::cust_pay_void - Object methods for cust_pay_void objects
27 use FS::cust_pay_void;
29 $record = new FS::cust_pay_void \%hash;
30 $record = new FS::cust_pay_void { 'column' => 'value' };
32 $error = $record->insert;
34 $error = $new_record->replace($old_record);
36 $error = $record->delete;
38 $error = $record->check;
42 An FS::cust_pay_void object represents a voided payment. The following fields
43 are currently supported:
49 primary key (assigned automatically for new payments)
53 customer (see L<FS::cust_main>)
57 Amount of this payment
61 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
62 L<Time::Local> and L<Date::Parse> for conversion functions.
66 order taker (see L<FS::access_user>)
70 Payment Type (See L<FS::payinfo_Mixin> for valid values)
74 card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
78 text field for tracking card processing
82 books closed flag, empty or `Y'
86 Desired pkgnum when using experimental package balances.
100 Creates a new payment. To add the payment to the databse, see L<"insert">.
104 sub table { 'cust_pay_void'; }
108 Adds this voided payment to the database.
112 "Un-void"s this payment: Deletes the voided payment from the database and adds
113 back a normal payment.
120 local $SIG{HUP} = 'IGNORE';
121 local $SIG{INT} = 'IGNORE';
122 local $SIG{QUIT} = 'IGNORE';
123 local $SIG{TERM} = 'IGNORE';
124 local $SIG{TSTP} = 'IGNORE';
125 local $SIG{PIPE} = 'IGNORE';
127 my $oldAutoCommit = $FS::UID::AutoCommit;
128 local $FS::UID::AutoCommit = 0;
131 my $cust_pay = new FS::cust_pay ( {
132 map { $_ => $self->get($_) } fields('cust_pay')
134 my $error = $cust_pay->insert;
136 $dbh->rollback if $oldAutoCommit;
140 $error = $self->delete;
142 $dbh->rollback if $oldAutoCommit;
146 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
154 Deletes this voided payment. You probably don't want to use this directly; see
155 the B<unvoid> method to add the original payment back.
157 =item replace [ OLD_RECORD ]
159 You can, but probably shouldn't modify voided payments...
161 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
162 supplied, replaces this record. If there is an error, returns the error,
163 otherwise returns false.
167 Checks all fields to make sure this is a valid voided payment. If there is an
168 error, returns the error, otherwise returns false. Called by the insert
177 $self->ut_numbern('paynum')
178 || $self->ut_numbern('custnum')
179 || $self->ut_money('paid')
180 || $self->ut_number('_date')
181 || $self->ut_textn('paybatch')
182 || $self->ut_enum('closed', [ '', 'Y' ])
183 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
184 || $self->ut_numbern('void_date')
185 || $self->ut_textn('reason')
186 || $self->payinfo_check
188 return $error if $error;
190 return "paid must be > 0 " if $self->paid <= 0;
192 return "unknown cust_main.custnum: ". $self->custnum
194 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
196 $self->void_date(time) unless $self->void_date;
198 $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
199 unless $self->void_usernum;
206 Returns the parent customer object (see L<FS::cust_main>).
212 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
215 =item void_access_user
217 Returns the voiding employee object (see L<FS::access_user>).
221 sub void_access_user {
223 qsearchs('access_user', { 'usernum' => $self->void_usernum } );
226 # Used by FS::Upgrade to migrate to a new database.
227 sub _upgrade_data { # class method
228 my ($class, %opts) = @_;
230 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 ) ";
231 my $sth = dbh->prepare($sql) or die dbh->errstr;
233 foreach my $cust_pay_void (qsearch('cust_pay_void', {'void_usernum' => ''})) {
234 $sth->execute($cust_pay_void->paynum) or die $sth->errstr;
235 my $row = $sth->fetchrow_arrayref;
236 my $usernum = $row ? $row->[0] : '';
238 $cust_pay_void->void_usernum($usernum);
239 my $error = $cust_pay_void->replace;
240 die $error if $error;
242 warn "cust_pay_void upgrade: can't find access_user record for ". $cust_pay_void->paynum. "\n";
246 local($otaker_upgrade_kludge) = 1;
247 $class->_upgrade_otaker(%opts);
249 #XXX look for the h_cust_pay delete records and when that's a different
250 # usernum, set usernum
257 Delete and replace methods.
261 L<FS::cust_pay>, L<FS::Record>, schema.html from the base documentation.