5 use Business::CreditCard;
6 use FS::Record qw( dbh );
11 @ISA = qw( FS::Record );
15 FS::cust_pay - Object methods for cust_pay objects
21 $record = new FS::cust_pay \%hash;
22 $record = new FS::cust_pay { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::cust_pay object represents a payment; the transfer of money from a
35 customer. FS::cust_pay inherits from FS::Record. The following fields are
40 =item paynum - primary key (assigned automatically for new payments)
42 =item custnum - customer (see L<FS::cust_main>)
44 =item paid - Amount of this payment
46 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
47 L<Time::Local> and L<Date::Parse> for conversion functions.
49 =item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
51 =item payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
53 =item paybatch - text field for tracking card processing
63 Creates a new payment. To add the payment to the databse, see L<"insert">.
67 sub table { 'cust_pay'; }
71 Adds this payment to the database.
73 For backwards-compatibility and convenience, if the additional field invnum
74 is defined, an FS::cust_bill_pay record for the full amount of the payment
75 will be created. In this case, custnum is optional.
82 local $SIG{HUP} = 'IGNORE';
83 local $SIG{INT} = 'IGNORE';
84 local $SIG{QUIT} = 'IGNORE';
85 local $SIG{TERM} = 'IGNORE';
86 local $SIG{TSTP} = 'IGNORE';
87 local $SIG{PIPE} = 'IGNORE';
89 my $oldAutoCommit = $FS::UID::AutoCommit;
90 local $FS::UID::AutoCommit = 0;
93 my $error = $self->check;
94 return $error if $error;
96 if ( $self->invnum ) {
97 my $cust_bill_pay = new FS::cust_bill_pay {
98 'invnum' => $self->invnum,
99 'paynum' => $self->paynum,
100 'amount' => $self->paid,
101 '_date' => $self->_date,
103 $error = $cust_bill_pay->insert;
105 $dbh->rollback if $oldAutoCommit;
109 warn $cust_bill_pay->cust_bill;
110 warn $cust_bill_pay->cust_bill->custnum;
111 $self->custnum($cust_bill_pay->cust_bill->custnum);
114 $error = $self->SUPER::insert;
116 $dbh->rollback if $oldAutoCommit;
120 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
126 sub upgrade_replace { #1.3.x->1.4.x
129 local $SIG{HUP} = 'IGNORE';
130 local $SIG{INT} = 'IGNORE';
131 local $SIG{QUIT} = 'IGNORE';
132 local $SIG{TERM} = 'IGNORE';
133 local $SIG{TSTP} = 'IGNORE';
134 local $SIG{PIPE} = 'IGNORE';
136 my $oldAutoCommit = $FS::UID::AutoCommit;
137 local $FS::UID::AutoCommit = 0;
140 my $error = $self->check;
141 return $error if $error;
143 my %new = $self->hash;
144 my $new = FS::cust_pay->new(\%new);
146 if ( $self->invnum ) {
147 my $cust_bill_pay = new FS::cust_bill_pay {
148 'invnum' => $self->invnum,
149 'paynum' => $self->paynum,
150 'amount' => $self->paid,
151 '_date' => $self->_date,
153 $error = $cust_bill_pay->insert;
155 $dbh->rollback if $oldAutoCommit;
158 $new->custnum($cust_bill_pay->cust_bill->custnum);
163 $error = $new->SUPER::replace($self);
165 $dbh->rollback if $oldAutoCommit;
169 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
178 Currently unimplemented (accounting reasons).
183 return "Can't (yet?) delete cust_pay records!";
186 =item replace OLD_RECORD
188 Currently unimplemented (accounting reasons).
193 return "Can't (yet?) modify cust_pay records!";
198 Checks all fields to make sure this is a valid payment. If there is an error,
199 returns the error, otherwise returns false. Called by the insert method.
207 $self->ut_numbern('paynum')
208 || $self->ut_numbern('custnum')
209 || $self->ut_money('paid')
210 || $self->ut_numbern('_date')
211 || $self->ut_textn('paybatch')
213 return $error if $error;
215 return "unknown cust_main.custnum: ". $self->custnum
217 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
219 $self->_date(time) unless $self->_date;
221 $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby";
224 if ( $self->payby eq 'CARD' ) {
225 my $payinfo = $self->payinfo;
227 $self->payinfo($payinfo);
228 if ( $self->payinfo ) {
229 $self->payinfo =~ /^(\d{13,16})$/
230 or return "Illegal (mistyped?) credit card number (payinfo)";
232 validate($self->payinfo) or return "Illegal credit card number";
233 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
235 $self->payinfo('N/A');
239 $error = $self->ut_textn('payinfo');
240 return $error if $error;
249 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
256 sort { $a->_date <=> $b->_date }
257 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
263 Returns the amount of this payment that is still unapplied; which is
264 paid minus all payment applications (see L<FS::cust_bill_pay>).
270 my $amount = $self->paid;
271 $amount -= $_->amount foreach ( $self->cust_bill_pay );
272 sprintf("%.2f", $amount );
279 $Id: cust_pay.pm,v 1.6 2001-09-02 05:38:13 ivan Exp $
283 Delete and replace methods.
287 L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the