4 use vars qw( @ISA $conf $money_char );
5 use vars qw( $lpr $invoice_from $smtpmachine );
6 use vars qw( $cybercash );
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( $ach_processor $ach_login $ach_password $ach_action @ach_options );
10 use vars qw( $invoice_lines @buf ); #yuck
12 use Mail::Internet 1.44;
15 use FS::UID qw( datasrc );
16 use FS::Record qw( qsearch qsearchs );
18 use FS::cust_bill_pkg;
22 use FS::cust_credit_bill;
23 use FS::cust_pay_batch;
24 use FS::cust_bill_event;
26 @ISA = qw( FS::Record );
28 #ask FS::UID to run this stuff for us later
29 $FS::UID::callback{'FS::cust_bill'} = sub {
33 $money_char = $conf->config('money_char') || '$';
35 $lpr = $conf->config('lpr');
36 $invoice_from = $conf->config('invoice_from');
37 $smtpmachine = $conf->config('smtpmachine');
39 if ( $conf->exists('cybercash3.2') ) {
41 #qw($MCKversion %Config InitConfig CCError CCDebug CCDebug2);
42 require CCMckDirectLib3_2;
44 require CCMckErrno3_2;
45 #qw(MCKGetErrorMessage $E_NoErr);
46 import CCMckErrno3_2 qw($E_NoErr);
49 ($merchant_conf,$xaction)= $conf->config('cybercash3.2');
50 my $status = &CCMckLib3_2::InitConfig($merchant_conf);
51 if ( $status != $E_NoErr ) {
52 warn "CCMckLib3_2::InitConfig error:\n";
53 foreach my $key (keys %CCMckLib3_2::Config) {
54 warn " $key => $CCMckLib3_2::Config{$key}\n"
56 my($errmsg) = &CCMckErrno3_2::MCKGetErrorMessage($status);
57 die "CCMckLib3_2::InitConfig fatal error: $errmsg\n";
59 $cybercash='cybercash3.2';
60 } elsif ( $conf->exists('business-onlinepayment') ) {
66 ) = $conf->config('business-onlinepayment');
67 $bop_action ||= 'normal authorization';
68 ( $ach_processor, $ach_login, $ach_password, $ach_action, @ach_options ) =
69 ( $bop_processor, $bop_login, $bop_password, $bop_action, @bop_options );
70 eval "use Business::OnlinePayment";
73 if ( $conf->exists('business-onlinepayment-ach') ) {
79 ) = $conf->config('business-onlinepayment-ach');
80 $ach_action ||= 'normal authorization';
81 eval "use Business::OnlinePayment";
88 FS::cust_bill - Object methods for cust_bill records
94 $record = new FS::cust_bill \%hash;
95 $record = new FS::cust_bill { 'column' => 'value' };
97 $error = $record->insert;
99 $error = $new_record->replace($old_record);
101 $error = $record->delete;
103 $error = $record->check;
105 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
107 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
109 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
111 @cust_pay_objects = $cust_bill->cust_pay;
113 $tax_amount = $record->tax;
115 @lines = $cust_bill->print_text;
116 @lines = $cust_bill->print_text $time;
120 An FS::cust_bill object represents an invoice; a declaration that a customer
121 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
122 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
123 following fields are currently supported:
127 =item invnum - primary key (assigned automatically for new invoices)
129 =item custnum - customer (see L<FS::cust_main>)
131 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
132 L<Time::Local> and L<Date::Parse> for conversion functions.
134 =item charged - amount of this invoice
136 =item printed - deprecated
138 =item closed - books closed flag, empty or `Y'
148 Creates a new invoice. To add the invoice to the database, see L<"insert">.
149 Invoices are normally created by calling the bill method of a customer object
150 (see L<FS::cust_main>).
154 sub table { 'cust_bill'; }
158 Adds this invoice to the database ("Posts" the invoice). If there is an error,
159 returns the error, otherwise returns false.
163 Currently unimplemented. I don't remove invoices because there would then be
164 no record you ever posted this invoice (which is bad, no?)
170 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
171 $self->SUPER::delete(@_);
174 =item replace OLD_RECORD
176 Replaces the OLD_RECORD with this one in the database. If there is an error,
177 returns the error, otherwise returns false.
179 Only printed may be changed. printed is normally updated by calling the
180 collect method of a customer object (see L<FS::cust_main>).
185 my( $new, $old ) = ( shift, shift );
186 return "Can't change custnum!" unless $old->custnum == $new->custnum;
187 #return "Can't change _date!" unless $old->_date eq $new->_date;
188 return "Can't change _date!" unless $old->_date == $new->_date;
189 return "Can't change charged!" unless $old->charged == $new->charged;
191 $new->SUPER::replace($old);
196 Checks all fields to make sure this is a valid invoice. If there is an error,
197 returns the error, otherwise returns false. Called by the insert and replace
206 $self->ut_numbern('invnum')
207 || $self->ut_number('custnum')
208 || $self->ut_numbern('_date')
209 || $self->ut_money('charged')
210 || $self->ut_numbern('printed')
211 || $self->ut_enum('closed', [ '', 'Y' ])
213 return $error if $error;
215 return "Unknown customer"
216 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
218 $self->_date(time) unless $self->_date;
220 $self->printed(0) if $self->printed eq '';
227 Returns a list consisting of the total previous balance for this customer,
228 followed by the previous outstanding invoices (as FS::cust_bill objects also).
235 my @cust_bill = sort { $a->_date <=> $b->_date }
236 grep { $_->owed != 0 && $_->_date < $self->_date }
237 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
239 foreach ( @cust_bill ) { $total += $_->owed; }
245 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
251 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
254 =item cust_bill_event
256 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
261 sub cust_bill_event {
263 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
269 Returns the customer (see L<FS::cust_main>) for this invoice.
275 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
280 Depreciated. See the cust_credited method.
282 #Returns a list consisting of the total previous credited (see
283 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
284 #outstanding credits (FS::cust_credit objects).
290 croak "FS::cust_bill->cust_credit depreciated; see ".
291 "FS::cust_bill->cust_credit_bill";
294 #my @cust_credit = sort { $a->_date <=> $b->_date }
295 # grep { $_->credited != 0 && $_->_date < $self->_date }
296 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
298 #foreach (@cust_credit) { $total += $_->credited; }
299 #$total, @cust_credit;
304 Depreciated. See the cust_bill_pay method.
306 #Returns all payments (see L<FS::cust_pay>) for this invoice.
312 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
314 #sort { $a->_date <=> $b->_date }
315 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
321 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
327 sort { $a->_date <=> $b->_date }
328 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
333 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
339 sort { $a->_date <=> $b->_date }
340 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
346 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
353 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
355 foreach (@taxlines) { $total += $_->setup; }
361 Returns the amount owed (still outstanding) on this invoice, which is charged
362 minus all payment applications (see L<FS::cust_bill_pay>) and credit
363 applications (see L<FS::cust_credit_bill>).
369 my $balance = $self->charged;
370 $balance -= $_->amount foreach ( $self->cust_bill_pay );
371 $balance -= $_->amount foreach ( $self->cust_credited );
372 $balance = sprintf( "%.2f", $balance);
373 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
379 Sends this invoice to the destinations configured for this customer: send
380 emails or print. See L<FS::cust_main_invoice>.
385 my($self,$template) = @_;
386 my @print_text = $self->print_text('', $template);
387 my @invoicing_list = $self->cust_main->invoicing_list;
389 if ( grep { $_ ne 'POST' } @invoicing_list or !@invoicing_list ) { #email
391 #better to notify this person than silence
392 @invoicing_list = ($invoice_from) unless @invoicing_list;
394 #false laziness w/FS::cust_pay::delete & fs_signup_server && ::realtime_card
395 #$ENV{SMTPHOSTS} = $smtpmachine;
396 $ENV{MAILADDRESS} = $invoice_from;
397 my $header = new Mail::Header ( [
398 "From: $invoice_from",
399 "To: ". join(', ', grep { $_ ne 'POST' } @invoicing_list ),
400 "Sender: $invoice_from",
401 "Reply-To: $invoice_from",
402 "Date: ". time2str("%a, %d %b %Y %X %z", time),
405 my $message = new Mail::Internet (
407 'Body' => [ @print_text ], #( date)
410 $message->smtpsend( Host => $smtpmachine )
411 or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
412 or return "(customer # ". $self->custnum. ") can't send invoice email".
413 " to ". join(', ', grep { $_ ne 'POST' } @invoicing_list ).
414 " via server $smtpmachine with SMTP: $!";
418 if ( grep { $_ eq 'POST' } @invoicing_list ) { #postal
420 or return "Can't open pipe to $lpr: $!";
421 print LPR @print_text;
423 or return $! ? "Error closing $lpr: $!"
424 : "Exit status $? from $lpr";
431 =item send_csv OPTIONS
433 Sends invoice as a CSV data-file to a remote host with the specified protocol.
437 protocol - currently only "ftp"
443 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
444 and YYMMDDHHMMSS is a timestamp.
446 The fields of the CSV file is as follows:
448 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
452 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
454 If B<record_type> is C<cust_bill>, this is a primary invoice record. The
455 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
456 fields are filled in.
458 If B<record_type> is C<cust_bill_pkg>, this is a line item record. Only the
459 first two fields (B<record_type> and B<invnum>) and the last five fields
460 (B<pkg> through B<edate>) are filled in.
462 =item invnum - invoice number
464 =item custnum - customer number
466 =item _date - invoice date
468 =item charged - total invoice amount
470 =item first - customer first name
472 =item last - customer first name
474 =item company - company name
476 =item address1 - address line 1
478 =item address2 - address line 1
488 =item pkg - line item description
490 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
492 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
494 =item sdate - start date for recurring fee
496 =item edate - end date for recurring fee
503 my($self, %opt) = @_;
505 #part one: create file
507 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
508 mkdir $spooldir, 0700 unless -d $spooldir;
510 my $file = $spooldir. '/'. $self->invnum. time2str('-%Y%m%d%H%M%S.csv', time);
512 open(CSV, ">$file") or die "can't open $file: $!";
514 eval "use Text::CSV_XS";
517 my $csv = Text::CSV_XS->new({'always_quote'=>1});
519 my $cust_main = $self->cust_main;
525 time2str("%x", $self->_date),
526 sprintf("%.2f", $self->charged),
527 ( map { $cust_main->getfield($_) }
528 qw( first last company address1 address2 city state zip country ) ),
530 ) or die "can't create csv";
531 print CSV $csv->string. "\n";
533 #new charges (false laziness w/print_text)
534 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
536 my($pkg, $setup, $recur, $sdate, $edate);
537 if ( $cust_bill_pkg->pkgnum ) {
539 ($pkg, $setup, $recur, $sdate, $edate) = (
540 $cust_bill_pkg->cust_pkg->part_pkg->pkg,
541 ( $cust_bill_pkg->setup != 0
542 ? sprintf("%.2f", $cust_bill_pkg->setup )
544 ( $cust_bill_pkg->recur != 0
545 ? sprintf("%.2f", $cust_bill_pkg->recur )
547 time2str("%x", $cust_bill_pkg->sdate),
548 time2str("%x", $cust_bill_pkg->edate),
552 next unless $cust_bill_pkg->setup != 0;
553 ($pkg, $setup, $recur, $sdate, $edate) =
554 ( 'Tax', sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
560 ( map { '' } (1..11) ),
561 ($pkg, $setup, $recur, $sdate, $edate)
562 ) or die "can't create csv";
563 print CSV $csv->string. "\n";
567 close CSV or die "can't close CSV: $!";
572 if ( $opt{protocol} eq 'ftp' ) {
573 eval "use Net::FTP;";
575 $net = Net::FTP->new($opt{server}) or die @$;
577 die "unknown protocol: $opt{protocol}";
580 $net->login( $opt{username}, $opt{password} )
581 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
583 $net->binary or die "can't set binary mode";
585 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
587 $net->put($file) or die "can't put $file: $!";
597 Pays this invoice with a compliemntary payment. If there is an error,
598 returns the error, otherwise returns false.
604 my $cust_pay = new FS::cust_pay ( {
605 'invnum' => $self->invnum,
606 'paid' => $self->owed,
609 'payinfo' => $self->cust_main->payinfo,
617 Attempts to pay this invoice with a credit card payment via a
618 Business::OnlinePayment realtime gateway. See
619 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
620 for supported processors.
639 Attempts to pay this invoice with an electronic check (ACH) payment via a
640 Business::OnlinePayment realtime gateway. See
641 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
642 for supported processors.
660 my( $self, $method, $processor, $login, $password, $action, $options ) = @_;
661 my $cust_main = $self->cust_main;
662 my $amount = $self->owed;
664 my $address = $cust_main->address1;
665 $address .= ", ". $cust_main->address2 if $cust_main->address2;
667 my($payname, $payfirst, $paylast);
668 if ( $cust_main->payname && $method ne 'CHECK' ) {
669 $payname = $cust_main->payname;
670 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
672 #$dbh->rollback if $oldAutoCommit;
673 return "Illegal payname $payname";
675 ($payfirst, $paylast) = ($1, $2);
677 $payfirst = $cust_main->getfield('first');
678 $paylast = $cust_main->getfield('last');
679 $payname = "$payfirst $paylast";
682 my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
683 if ( $conf->exists('emailinvoiceauto')
684 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
685 push @invoicing_list, $cust_main->all_emails;
687 my $email = $invoicing_list[0];
689 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
691 my $description = 'Internet Services';
692 if ( $conf->exists('business-onlinepayment-description') ) {
693 my $dtempl = $conf->config('business-onlinepayment-description');
695 my $agent_obj = $cust_main->agent
696 or die "can't retreive agent for $cust_main (agentnum ".
697 $cust_main->agentnum. ")";
698 my $agent = $agent_obj->agent;
699 my $pkgs = join(', ',
700 map { $_->cust_pkg->part_pkg->pkg }
701 grep { $_->pkgnum } $self->cust_bill_pkg
703 $description = eval qq("$dtempl");
708 if ( $method eq 'CC' ) {
709 $content{card_number} = $cust_main->payinfo;
710 $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
711 $content{expiration} = "$2/$1";
712 } elsif ( $method eq 'CHECK' ) {
713 my($account_number,$routing_code) = $cust_main->payinfo;
714 ( $content{account_number}, $content{routing_code} ) =
715 split('@', $cust_main->payinfo);
716 $content{bank_name} = $cust_main->payname;
720 new Business::OnlinePayment( $processor, @$options );
721 $transaction->content(
725 'password' => $password,
726 'action' => $action1,
727 'description' => $description,
729 'invoice_number' => $self->invnum,
730 'customer_id' => $self->custnum,
731 'last_name' => $paylast,
732 'first_name' => $payfirst,
734 'address' => $address,
735 'city' => $cust_main->city,
736 'state' => $cust_main->state,
737 'zip' => $cust_main->zip,
738 'country' => $cust_main->country,
739 'referer' => 'http://cleanwhisker.420.am/',
741 'phone' => $cust_main->daytime || $cust_main->night,
743 $transaction->submit();
745 if ( $transaction->is_success() && $action2 ) {
746 my $auth = $transaction->authorization;
747 my $ordernum = $transaction->can('order_number')
748 ? $transaction->order_number
751 #warn "********* $auth ***********\n";
752 #warn "********* $ordernum ***********\n";
754 new Business::OnlinePayment( $processor, @$options );
761 password => $password,
762 order_number => $ordernum,
764 authorization => $auth,
765 description => $description,
768 foreach my $field (qw( authorization_source_code returned_ACI transaction_identifier validation_code
769 transaction_sequence_num local_transaction_date
770 local_transaction_time AVS_result_code )) {
771 $capture{$field} = $transaction->$field() if $transaction->can($field);
774 $capture->content( %capture );
778 unless ( $capture->is_success ) {
779 my $e = "Authorization sucessful but capture failed, invnum #".
780 $self->invnum. ': '. $capture->result_code.
781 ": ". $capture->error_message;
788 if ( $transaction->is_success() ) {
795 my $cust_pay = new FS::cust_pay ( {
796 'invnum' => $self->invnum,
799 'payby' => $method2payby{$method},
800 'payinfo' => $cust_main->payinfo,
801 'paybatch' => "$processor:". $transaction->authorization,
803 my $error = $cust_pay->insert;
805 # gah, even with transactions.
806 my $e = 'WARNING: Card/ACH debited but database not updated - '.
807 'error applying payment, invnum #' . $self->invnum.
808 " ($processor): $error";
814 #} elsif ( $options{'report_badcard'} ) {
817 my $perror = "$processor error, invnum #". $self->invnum. ': '.
818 $transaction->result_code. ": ". $transaction->error_message;
820 if ( $conf->exists('emaildecline')
821 && grep { $_ ne 'POST' } $cust_main->invoicing_list
823 my @templ = $conf->config('declinetemplate');
824 my $template = new Text::Template (
826 SOURCE => [ map "$_\n", @templ ],
827 ) or return "($perror) can't create template: $Text::Template::ERROR";
829 or return "($perror) can't compile template: $Text::Template::ERROR";
831 my $templ_hash = { error => $transaction->error_message };
833 #false laziness w/FS::cust_pay::delete & fs_signup_server && ::send
834 $ENV{MAILADDRESS} = $invoice_from;
835 my $header = new Mail::Header ( [
836 "From: $invoice_from",
837 "To: ". join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ),
838 "Sender: $invoice_from",
839 "Reply-To: $invoice_from",
840 "Date: ". time2str("%a, %d %b %Y %X %z", time),
841 "Subject: Your payment could not be processed",
843 my $message = new Mail::Internet (
845 'Body' => [ $template->fill_in(HASH => $templ_hash) ],
848 $message->smtpsend( Host => $smtpmachine )
849 or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
850 or return "($perror) (customer # ". $self->custnum.
851 ") can't send card decline email to ".
852 join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ).
853 " via server $smtpmachine with SMTP: $!";
861 =item realtime_card_cybercash
863 Attempts to pay this invoice with the CyberCash CashRegister realtime gateway.
867 sub realtime_card_cybercash {
869 my $cust_main = $self->cust_main;
870 my $amount = $self->owed;
872 return "CyberCash CashRegister real-time card processing not enabled!"
873 unless $cybercash eq 'cybercash3.2';
875 my $address = $cust_main->address1;
876 $address .= ", ". $cust_main->address2 if $cust_main->address2;
879 #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
880 $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
885 my $paybatch = $self->invnum.
886 '-' . time2str("%y%m%d%H%M%S", time);
888 my $payname = $cust_main->payname ||
889 $cust_main->getfield('first').' '.$cust_main->getfield('last');
891 my $country = $cust_main->country eq 'US' ? 'USA' : $cust_main->country;
893 my @full_xaction = ( $xaction,
894 'Order-ID' => $paybatch,
895 'Amount' => "usd $amount",
896 'Card-Number' => $cust_main->getfield('payinfo'),
897 'Card-Name' => $payname,
898 'Card-Address' => $address,
899 'Card-City' => $cust_main->getfield('city'),
900 'Card-State' => $cust_main->getfield('state'),
901 'Card-Zip' => $cust_main->getfield('zip'),
902 'Card-Country' => $country,
907 %result = &CCMckDirectLib3_2::SendCC2_1Server(@full_xaction);
909 if ( $result{'MStatus'} eq 'success' ) { #cybercash smps v.2 or 3
910 my $cust_pay = new FS::cust_pay ( {
911 'invnum' => $self->invnum,
915 'payinfo' => $cust_main->payinfo,
916 'paybatch' => "$cybercash:$paybatch",
918 my $error = $cust_pay->insert;
920 # gah, even with transactions.
921 my $e = 'WARNING: Card debited but database not updated - '.
922 'error applying payment, invnum #' . $self->invnum.
923 " (CyberCash Order-ID $paybatch): $error";
929 # } elsif ( $result{'Mstatus'} ne 'failure-bad-money'
930 # || $options{'report_badcard'}
933 return 'Cybercash error, invnum #' .
934 $self->invnum. ':'. $result{'MErrMsg'};
941 Adds a payment for this invoice to the pending credit card batch (see
942 L<FS::cust_pay_batch>).
948 my $cust_main = $self->cust_main;
950 my $cust_pay_batch = new FS::cust_pay_batch ( {
951 'invnum' => $self->getfield('invnum'),
952 'custnum' => $cust_main->getfield('custnum'),
953 'last' => $cust_main->getfield('last'),
954 'first' => $cust_main->getfield('first'),
955 'address1' => $cust_main->getfield('address1'),
956 'address2' => $cust_main->getfield('address2'),
957 'city' => $cust_main->getfield('city'),
958 'state' => $cust_main->getfield('state'),
959 'zip' => $cust_main->getfield('zip'),
960 'country' => $cust_main->getfield('country'),
962 'cardnum' => $cust_main->getfield('payinfo'),
963 'exp' => $cust_main->getfield('paydate'),
964 'payname' => $cust_main->getfield('payname'),
965 'amount' => $self->owed,
967 my $error = $cust_pay_batch->insert;
968 die $error if $error;
973 =item print_text [TIME];
975 Returns an text invoice, as a list of lines.
977 TIME an optional value used to control the printing of overdue messages. The
978 default is now. It isn't the date of the invoice; that's the `_date' field.
979 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
980 L<Time::Local> and L<Date::Parse> for conversion functions.
986 my( $self, $today, $template ) = @_;
988 # my $invnum = $self->invnum;
989 my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
990 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
991 unless $cust_main->payname && $cust_main->payby ne 'CHEK';
993 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
994 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
995 #my $balance_due = $self->owed + $pr_total - $cr_total;
996 my $balance_due = $self->owed + $pr_total;
999 #my($description,$amount);
1003 foreach ( @pr_cust_bill ) {
1005 "Previous Balance, Invoice #". $_->invnum.
1006 " (". time2str("%x",$_->_date). ")",
1007 $money_char. sprintf("%10.2f",$_->owed)
1010 if (@pr_cust_bill) {
1011 push @buf,['','-----------'];
1012 push @buf,[ 'Total Previous Balance',
1013 $money_char. sprintf("%10.2f",$pr_total ) ];
1018 foreach ( $self->cust_bill_pkg ) {
1022 my($cust_pkg)=qsearchs('cust_pkg', { 'pkgnum', $_->pkgnum } );
1023 my($part_pkg)=qsearchs('part_pkg',{'pkgpart'=>$cust_pkg->pkgpart});
1024 my($pkg)=$part_pkg->pkg;
1026 if ( $_->setup != 0 ) {
1027 push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ];
1029 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1032 if ( $_->recur != 0 ) {
1034 "$pkg (" . time2str("%x",$_->sdate) . " - " .
1035 time2str("%x",$_->edate) . ")",
1036 $money_char. sprintf("%10.2f",$_->recur)
1039 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1042 } else { #pkgnum Tax
1043 push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ]
1048 push @buf,['','-----------'];
1049 push @buf,['Total New Charges',
1050 $money_char. sprintf("%10.2f",$self->charged) ];
1053 push @buf,['','-----------'];
1054 push @buf,['Total Charges',
1055 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1059 foreach ( $self->cust_credited ) {
1061 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1063 my $reason = substr($_->cust_credit->reason,0,32);
1064 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1065 $reason = " ($reason) " if $reason;
1067 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1069 $money_char. sprintf("%10.2f",$_->amount)
1072 #foreach ( @cr_cust_credit ) {
1074 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1075 # $money_char. sprintf("%10.2f",$_->credited)
1079 #get & print payments
1080 foreach ( $self->cust_bill_pay ) {
1082 #something more elaborate if $_->amount ne ->cust_pay->paid ?
1085 "Payment received ". time2str("%x",$_->cust_pay->_date ),
1086 $money_char. sprintf("%10.2f",$_->amount )
1091 push @buf,['','-----------'];
1092 push @buf,['Balance Due', $money_char.
1093 sprintf("%10.2f", $balance_due ) ];
1095 #create the template
1096 my $templatefile = 'invoice_template';
1097 $templatefile .= "_$template" if $template;
1098 my @invoice_template = $conf->config($templatefile)
1099 or die "cannot load config file $templatefile";
1102 foreach ( grep /invoice_lines\(\d+\)/, @invoice_template ) { #kludgy
1103 /invoice_lines\((\d+)\)/;
1104 $invoice_lines += $1;
1107 die "no invoice_lines() functions in template?" unless $wasfunc;
1108 my $invoice_template = new Text::Template (
1110 SOURCE => [ map "$_\n", @invoice_template ],
1111 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1112 $invoice_template->compile()
1113 or die "can't compile template: $Text::Template::ERROR";
1115 #setup template variables
1116 package FS::cust_bill::_template; #!
1117 use vars qw( $invnum $date $page $total_pages @address $overdue @buf );
1119 $invnum = $self->invnum;
1120 $date = $self->_date;
1123 if ( $FS::cust_bill::invoice_lines ) {
1125 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1127 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1132 #format address (variable for the template)
1134 @address = ( '', '', '', '', '', '' );
1135 package FS::cust_bill; #!
1136 $FS::cust_bill::_template::address[$l++] =
1137 $cust_main->payname.
1138 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1139 ? " (P.O. #". $cust_main->payinfo. ")"
1143 $FS::cust_bill::_template::address[$l++] = $cust_main->company
1144 if $cust_main->company;
1145 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1146 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1147 if $cust_main->address2;
1148 $FS::cust_bill::_template::address[$l++] =
1149 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1150 $FS::cust_bill::_template::address[$l++] = $cust_main->country
1151 unless $cust_main->country eq 'US';
1153 # #overdue? (variable for the template)
1154 # $FS::cust_bill::_template::overdue = (
1156 # && $today > $self->_date
1157 ## && $self->printed > 1
1158 # && $self->printed > 0
1161 #and subroutine for the template
1163 sub FS::cust_bill::_template::invoice_lines {
1164 my $lines = shift or return @buf;
1166 scalar(@buf) ? shift @buf : [ '', '' ];
1173 $FS::cust_bill::_template::page = 1;
1177 push @collect, split("\n",
1178 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1180 $FS::cust_bill::_template::page++;
1183 map "$_\n", @collect;
1191 $Id: cust_bill.pm,v 1.41.2.8 2002-11-16 10:33:17 ivan Exp $
1197 print_text formatting (and some logic :/) is in source, but needs to be
1198 slurped in from a file. Also number of lines ($=).
1200 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
1201 or something similar so the look can be completely customized?)
1205 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
1206 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base