4 use vars qw( @ISA $conf $money_char );
5 use vars qw( $lpr $invoice_from $smtpmachine );
6 use vars qw( $processor );
7 use vars qw( $xaction $E_NoErr );
8 use vars qw( $bop_processor $bop_login $bop_password $bop_action @bop_options );
9 use vars qw( $invoice_lines @buf ); #yuck
14 use FS::Record qw( qsearch qsearchs );
16 use FS::cust_bill_pkg;
20 use FS::cust_credit_bill;
21 use FS::cust_pay_batch;
22 use FS::cust_bill_event;
24 @ISA = qw( FS::Record );
26 #ask FS::UID to run this stuff for us later
27 $FS::UID::callback{'FS::cust_bill'} = sub {
31 $money_char = $conf->config('money_char') || '$';
33 $lpr = $conf->config('lpr');
34 $invoice_from = $conf->config('invoice_from');
35 $smtpmachine = $conf->config('smtpmachine');
37 if ( $conf->exists('cybercash3.2') ) {
39 #qw($MCKversion %Config InitConfig CCError CCDebug CCDebug2);
40 require CCMckDirectLib3_2;
42 require CCMckErrno3_2;
43 #qw(MCKGetErrorMessage $E_NoErr);
44 import CCMckErrno3_2 qw($E_NoErr);
47 ($merchant_conf,$xaction)= $conf->config('cybercash3.2');
48 my $status = &CCMckLib3_2::InitConfig($merchant_conf);
49 if ( $status != $E_NoErr ) {
50 warn "CCMckLib3_2::InitConfig error:\n";
51 foreach my $key (keys %CCMckLib3_2::Config) {
52 warn " $key => $CCMckLib3_2::Config{$key}\n"
54 my($errmsg) = &CCMckErrno3_2::MCKGetErrorMessage($status);
55 die "CCMckLib3_2::InitConfig fatal error: $errmsg\n";
57 $processor='cybercash3.2';
58 } elsif ( $conf->exists('business-onlinepayment') ) {
64 ) = $conf->config('business-onlinepayment');
65 $bop_action ||= 'normal authorization';
66 eval "use Business::OnlinePayment";
67 $processor="Business::OnlinePayment::$bop_processor";
74 FS::cust_bill - Object methods for cust_bill records
80 $record = new FS::cust_bill \%hash;
81 $record = new FS::cust_bill { 'column' => 'value' };
83 $error = $record->insert;
85 $error = $new_record->replace($old_record);
87 $error = $record->delete;
89 $error = $record->check;
91 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
93 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
95 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
97 @cust_pay_objects = $cust_bill->cust_pay;
99 $tax_amount = $record->tax;
101 @lines = $cust_bill->print_text;
102 @lines = $cust_bill->print_text $time;
106 An FS::cust_bill object represents an invoice; a declaration that a customer
107 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
108 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
109 following fields are currently supported:
113 =item invnum - primary key (assigned automatically for new invoices)
115 =item custnum - customer (see L<FS::cust_main>)
117 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
118 L<Time::Local> and L<Date::Parse> for conversion functions.
120 =item charged - amount of this invoice
122 =item printed - deprecated
124 =item closed - books closed flag, empty or `Y'
134 Creates a new invoice. To add the invoice to the database, see L<"insert">.
135 Invoices are normally created by calling the bill method of a customer object
136 (see L<FS::cust_main>).
140 sub table { 'cust_bill'; }
144 Adds this invoice to the database ("Posts" the invoice). If there is an error,
145 returns the error, otherwise returns false.
149 Currently unimplemented. I don't remove invoices because there would then be
150 no record you ever posted this invoice (which is bad, no?)
156 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
157 $self->SUPER::delete(@_);
160 =item replace OLD_RECORD
162 Replaces the OLD_RECORD with this one in the database. If there is an error,
163 returns the error, otherwise returns false.
165 Only printed may be changed. printed is normally updated by calling the
166 collect method of a customer object (see L<FS::cust_main>).
171 my( $new, $old ) = ( shift, shift );
172 return "Can't change custnum!" unless $old->custnum == $new->custnum;
173 #return "Can't change _date!" unless $old->_date eq $new->_date;
174 return "Can't change _date!" unless $old->_date == $new->_date;
175 return "Can't change charged!" unless $old->charged == $new->charged;
177 $new->SUPER::replace($old);
182 Checks all fields to make sure this is a valid invoice. If there is an error,
183 returns the error, otherwise returns false. Called by the insert and replace
192 $self->ut_numbern('invnum')
193 || $self->ut_number('custnum')
194 || $self->ut_numbern('_date')
195 || $self->ut_money('charged')
196 || $self->ut_numbern('printed')
197 || $self->ut_enum('closed', [ '', 'Y' ])
199 return $error if $error;
201 return "Unknown customer"
202 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
204 $self->_date(time) unless $self->_date;
206 $self->printed(0) if $self->printed eq '';
213 Returns a list consisting of the total previous balance for this customer,
214 followed by the previous outstanding invoices (as FS::cust_bill objects also).
221 my @cust_bill = sort { $a->_date <=> $b->_date }
222 grep { $_->owed != 0 && $_->_date < $self->_date }
223 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
225 foreach ( @cust_bill ) { $total += $_->owed; }
231 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
237 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
240 =item cust_bill_event
242 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
247 sub cust_bill_event {
249 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
255 Returns the customer (see L<FS::cust_main>) for this invoice.
261 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
266 Depreciated. See the cust_credited method.
268 #Returns a list consisting of the total previous credited (see
269 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
270 #outstanding credits (FS::cust_credit objects).
276 croak "FS::cust_bill->cust_credit depreciated; see ".
277 "FS::cust_bill->cust_credit_bill";
280 #my @cust_credit = sort { $a->_date <=> $b->_date }
281 # grep { $_->credited != 0 && $_->_date < $self->_date }
282 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
284 #foreach (@cust_credit) { $total += $_->credited; }
285 #$total, @cust_credit;
290 Depreciated. See the cust_bill_pay method.
292 #Returns all payments (see L<FS::cust_pay>) for this invoice.
298 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
300 #sort { $a->_date <=> $b->_date }
301 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
307 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
313 sort { $a->_date <=> $b->_date }
314 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
319 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
325 sort { $a->_date <=> $b->_date }
326 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
332 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
339 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
341 foreach (@taxlines) { $total += $_->setup; }
347 Returns the amount owed (still outstanding) on this invoice, which is charged
348 minus all payment applications (see L<FS::cust_bill_pay>) and credit
349 applications (see L<FS::cust_credit_bill>).
355 my $balance = $self->charged;
356 $balance -= $_->amount foreach ( $self->cust_bill_pay );
357 $balance -= $_->amount foreach ( $self->cust_credited );
358 $balance = sprintf( "%.2f", $balance);
359 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
365 Sends this invoice to the destinations configured for this customer: send
366 emails or print. See L<FS::cust_main_invoice>.
371 my($self,$template) = @_;
373 #my @print_text = $cust_bill->print_text; #( date )
374 my @invoicing_list = $self->cust_main->invoicing_list;
375 if ( grep { $_ ne 'POST' } @invoicing_list ) { #email invoice
376 #false laziness w/FS::cust_pay::delete & fs_signup_server
377 #$ENV{SMTPHOSTS} = $smtpmachine;
378 $ENV{MAILADDRESS} = $invoice_from;
379 my $header = new Mail::Header ( [
380 "From: $invoice_from",
381 "To: ". join(', ', grep { $_ ne 'POST' } @invoicing_list ),
382 "Sender: $invoice_from",
383 "Reply-To: $invoice_from",
384 "Date: ". time2str("%a, %d %b %Y %X %z", time),
387 my $message = new Mail::Internet (
389 'Body' => [ $self->print_text('', $template) ], #( date)
392 $message->smtpsend( Host => $smtpmachine )
393 or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
394 or return "(customer # ". $self->custnum. ") can't send invoice email".
395 " to ". join(', ', grep { $_ ne 'POST' } @invoicing_list ).
396 " via server $smtpmachine with SMTP: $!";
398 #} elsif ( grep { $_ eq 'POST' } @invoicing_list ) {
399 } elsif ( ! @invoicing_list || grep { $_ eq 'POST' } @invoicing_list ) {
401 or return "Can't open pipe to $lpr: $!";
402 print LPR $self->print_text; #( date )
404 or return $! ? "Error closing $lpr: $!"
405 : "Exit status $? from $lpr";
414 Pays this invoice with a compliemntary payment. If there is an error,
415 returns the error, otherwise returns false.
421 my $cust_pay = new FS::cust_pay ( {
422 'invnum' => $self->invnum,
423 'paid' => $self->owed,
426 'payinfo' => $self->cust_main->payinfo,
434 Attempts to pay this invoice with a Business::OnlinePayment realtime gateway.
435 See http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
436 for supproted processors.
442 my $cust_main = $self->cust_main;
443 my $amount = $self->owed;
445 unless ( $processor =~ /^Business::OnlinePayment::(.*)$/ ) {
446 return "Real-time card processing not enabled (processor $processor)";
448 my $bop_processor = $1; #hmm?
450 my $address = $cust_main->address1;
451 $address .= ", ". $cust_main->address2 if $cust_main->address2;
454 #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
455 $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
458 my($payname, $payfirst, $paylast);
459 if ( $cust_main->payname ) {
460 $payname = $cust_main->payname;
461 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)$/
463 #$dbh->rollback if $oldAutoCommit;
464 return "Illegal payname $payname";
466 ($payfirst, $paylast) = ($1, $2);
468 $payfirst = $cust_main->getfield('first');
469 $paylast = $cust_main->getfield('first');
470 $payname = "$payfirst $paylast";
473 my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
474 if ( $conf->exists('emailinvoiceauto')
475 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
476 push @invoicing_list, $cust_main->default_invoicing_list;
478 my $email = $invoicing_list[0];
480 my( $action1, $action2 ) = split(/\s*\,\s*/, $bop_action );
482 my $description = 'Internet Services';
483 if ( $conf->exists('business-onlinepayment-description') ) {
484 my $dtempl = $conf->config('business-onlinepayment-description');
486 my $agent = $self->cust_main->agent->agent;
487 my $pkgs = join(', ',
488 map { $_->cust_pkg->part_pkg->pkg }
489 grep { $_->pkgnum } $self->cust_bill_pkg
491 $description = eval qq("$dtempl");
496 new Business::OnlinePayment( $bop_processor, @bop_options );
497 $transaction->content(
499 'login' => $bop_login,
500 'password' => $bop_password,
501 'action' => $action1,
502 'description' => $description,
504 'invoice_number' => $self->invnum,
505 'customer_id' => $self->custnum,
506 'last_name' => $paylast,
507 'first_name' => $payfirst,
509 'address' => $address,
510 'city' => $cust_main->city,
511 'state' => $cust_main->state,
512 'zip' => $cust_main->zip,
513 'country' => $cust_main->country,
514 'card_number' => $cust_main->payinfo,
515 'expiration' => $exp,
516 'referer' => 'http://cleanwhisker.420.am/',
519 $transaction->submit();
521 if ( $transaction->is_success() && $action2 ) {
522 my $auth = $transaction->authorization;
523 my $ordernum = $transaction->order_number;
524 #warn "********* $auth ***********\n";
525 #warn "********* $ordernum ***********\n";
527 new Business::OnlinePayment( $bop_processor, @bop_options );
532 password => $bop_password,
533 order_number => $ordernum,
535 authorization => $auth,
536 description => $description,
541 unless ( $capture->is_success ) {
542 my $e = "Authorization sucessful but capture failed, invnum #".
543 $self->invnum. ': '. $capture->result_code.
544 ": ". $capture->error_message;
551 if ( $transaction->is_success() ) {
553 my $cust_pay = new FS::cust_pay ( {
554 'invnum' => $self->invnum,
558 'payinfo' => $cust_main->payinfo,
559 'paybatch' => "$processor:". $transaction->authorization,
561 my $error = $cust_pay->insert;
563 # gah, even with transactions.
564 my $e = 'WARNING: Card debited but database not updated - '.
565 'error applying payment, invnum #' . $self->invnum.
566 " ($processor): $error";
572 #} elsif ( $options{'report_badcard'} ) {
574 return "$processor error, invnum #". $self->invnum. ': '.
575 $transaction->result_code. ": ". $transaction->error_message;
580 =item realtime_card_cybercash
582 Attempts to pay this invoice with the CyberCash CashRegister realtime gateway.
586 sub realtime_card_cybercash {
588 my $cust_main = $self->cust_main;
589 my $amount = $self->owed;
591 return "CyberCash CashRegister real-time card processing not enabled!"
592 unless $processor eq 'cybercash3.2';
594 my $address = $cust_main->address1;
595 $address .= ", ". $cust_main->address2 if $cust_main->address2;
598 #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
599 $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
604 my $paybatch = $self->invnum.
605 '-' . time2str("%y%m%d%H%M%S", time);
607 my $payname = $cust_main->payname ||
608 $cust_main->getfield('first').' '.$cust_main->getfield('last');
610 my $country = $cust_main->country eq 'US' ? 'USA' : $cust_main->country;
612 my @full_xaction = ( $xaction,
613 'Order-ID' => $paybatch,
614 'Amount' => "usd $amount",
615 'Card-Number' => $cust_main->getfield('payinfo'),
616 'Card-Name' => $payname,
617 'Card-Address' => $address,
618 'Card-City' => $cust_main->getfield('city'),
619 'Card-State' => $cust_main->getfield('state'),
620 'Card-Zip' => $cust_main->getfield('zip'),
621 'Card-Country' => $country,
626 %result = &CCMckDirectLib3_2::SendCC2_1Server(@full_xaction);
628 if ( $result{'MStatus'} eq 'success' ) { #cybercash smps v.2 or 3
629 my $cust_pay = new FS::cust_pay ( {
630 'invnum' => $self->invnum,
634 'payinfo' => $cust_main->payinfo,
635 'paybatch' => "$processor:$paybatch",
637 my $error = $cust_pay->insert;
639 # gah, even with transactions.
640 my $e = 'WARNING: Card debited but database not updated - '.
641 'error applying payment, invnum #' . $self->invnum.
642 " (CyberCash Order-ID $paybatch): $error";
648 # } elsif ( $result{'Mstatus'} ne 'failure-bad-money'
649 # || $options{'report_badcard'}
652 return 'Cybercash error, invnum #' .
653 $self->invnum. ':'. $result{'MErrMsg'};
660 Adds a payment for this invoice to the pending credit card batch (see
661 L<FS::cust_pay_batch>).
667 my $cust_main = $self->cust_main;
669 my $cust_pay_batch = new FS::cust_pay_batch ( {
670 'invnum' => $self->getfield('invnum'),
671 'custnum' => $cust_main->getfield('custnum'),
672 'last' => $cust_main->getfield('last'),
673 'first' => $cust_main->getfield('first'),
674 'address1' => $cust_main->getfield('address1'),
675 'address2' => $cust_main->getfield('address2'),
676 'city' => $cust_main->getfield('city'),
677 'state' => $cust_main->getfield('state'),
678 'zip' => $cust_main->getfield('zip'),
679 'country' => $cust_main->getfield('country'),
681 'cardnum' => $cust_main->getfield('payinfo'),
682 'exp' => $cust_main->getfield('paydate'),
683 'payname' => $cust_main->getfield('payname'),
684 'amount' => $self->owed,
686 $cust_pay_batch->insert;
690 =item print_text [TIME];
692 Returns an text invoice, as a list of lines.
694 TIME an optional value used to control the printing of overdue messages. The
695 default is now. It isn't the date of the invoice; that's the `_date' field.
696 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
697 L<Time::Local> and L<Date::Parse> for conversion functions.
703 my( $self, $today, $template ) = @_;
705 # my $invnum = $self->invnum;
706 my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
707 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
708 unless $cust_main->payname;
710 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
711 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
712 #my $balance_due = $self->owed + $pr_total - $cr_total;
713 my $balance_due = $self->owed + $pr_total;
716 #my($description,$amount);
720 foreach ( @pr_cust_bill ) {
722 "Previous Balance, Invoice #". $_->invnum.
723 " (". time2str("%x",$_->_date). ")",
724 $money_char. sprintf("%10.2f",$_->owed)
728 push @buf,['','-----------'];
729 push @buf,[ 'Total Previous Balance',
730 $money_char. sprintf("%10.2f",$pr_total ) ];
735 foreach ( $self->cust_bill_pkg ) {
739 my($cust_pkg)=qsearchs('cust_pkg', { 'pkgnum', $_->pkgnum } );
740 my($part_pkg)=qsearchs('part_pkg',{'pkgpart'=>$cust_pkg->pkgpart});
741 my($pkg)=$part_pkg->pkg;
743 if ( $_->setup != 0 ) {
744 push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ];
746 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
749 if ( $_->recur != 0 ) {
751 "$pkg (" . time2str("%x",$_->sdate) . " - " .
752 time2str("%x",$_->edate) . ")",
753 $money_char. sprintf("%10.2f",$_->recur)
756 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
760 push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ]
765 push @buf,['','-----------'];
766 push @buf,['Total New Charges',
767 $money_char. sprintf("%10.2f",$self->charged) ];
770 push @buf,['','-----------'];
771 push @buf,['Total Charges',
772 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
776 foreach ( $self->cust_credited ) {
778 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
780 my $reason = substr($_->cust_credit->reason,0,32);
781 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
782 $reason = " ($reason) " if $reason;
784 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
786 $money_char. sprintf("%10.2f",$_->amount)
789 #foreach ( @cr_cust_credit ) {
791 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
792 # $money_char. sprintf("%10.2f",$_->credited)
796 #get & print payments
797 foreach ( $self->cust_bill_pay ) {
799 #something more elaborate if $_->amount ne ->cust_pay->paid ?
802 "Payment received ". time2str("%x",$_->cust_pay->_date ),
803 $money_char. sprintf("%10.2f",$_->amount )
808 push @buf,['','-----------'];
809 push @buf,['Balance Due', $money_char.
810 sprintf("%10.2f", $balance_due ) ];
813 my $templatefile = 'invoice_template';
814 $templatefile .= "_$template" if $template;
815 my @invoice_template = $conf->config($templatefile)
816 or die "cannot load config file $templatefile";
818 foreach ( grep /invoice_lines\(\d+\)/, @invoice_template ) { #kludgy
819 /invoice_lines\((\d+)\)/;
820 $invoice_lines += $1;
822 die "no invoice_lines() functions in template?" unless $invoice_lines;
823 my $invoice_template = new Text::Template (
825 SOURCE => [ map "$_\n", @invoice_template ],
826 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
827 $invoice_template->compile()
828 or die "can't compile template: $Text::Template::ERROR";
830 #setup template variables
831 package FS::cust_bill::_template; #!
832 use vars qw( $invnum $date $page $total_pages @address $overdue @buf );
834 $invnum = $self->invnum;
835 $date = $self->_date;
839 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
841 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
844 #format address (variable for the template)
846 @address = ( '', '', '', '', '', '' );
847 package FS::cust_bill; #!
848 $FS::cust_bill::_template::address[$l++] =
850 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
851 ? " (P.O. #". $cust_main->payinfo. ")"
855 $FS::cust_bill::_template::address[$l++] = $cust_main->company
856 if $cust_main->company;
857 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
858 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
859 if $cust_main->address2;
860 $FS::cust_bill::_template::address[$l++] =
861 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
862 $FS::cust_bill::_template::address[$l++] = $cust_main->country
863 unless $cust_main->country eq 'US';
865 # #overdue? (variable for the template)
866 # $FS::cust_bill::_template::overdue = (
868 # && $today > $self->_date
869 ## && $self->printed > 1
870 # && $self->printed > 0
873 #and subroutine for the template
875 sub FS::cust_bill::_template::invoice_lines {
878 scalar(@buf) ? shift @buf : [ '', '' ];
885 $FS::cust_bill::_template::page = 1;
889 push @collect, split("\n",
890 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
892 $FS::cust_bill::_template::page++;
895 map "$_\n", @collect;
903 $Id: cust_bill.pm,v 1.26 2002-04-07 06:23:29 ivan Exp $
909 print_text formatting (and some logic :/) is in source, but needs to be
910 slurped in from a file. Also number of lines ($=).
912 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
913 or something similar so the look can be completely customized?)
917 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
918 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base