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
11 use vars qw( $realtime_bop_decline_quiet );
13 use Mail::Internet 1.44;
16 use FS::UID qw( datasrc );
17 use FS::Record qw( qsearch qsearchs );
19 use FS::cust_bill_pkg;
23 use FS::cust_credit_bill;
24 use FS::cust_pay_batch;
25 use FS::cust_bill_event;
27 @ISA = qw( FS::Record );
29 $realtime_bop_decline_quiet = 0;
31 #ask FS::UID to run this stuff for us later
32 $FS::UID::callback{'FS::cust_bill'} = sub {
36 $money_char = $conf->config('money_char') || '$';
38 $lpr = $conf->config('lpr');
39 $invoice_from = $conf->config('invoice_from');
40 $smtpmachine = $conf->config('smtpmachine');
42 ( $bop_processor,$bop_login, $bop_password, $bop_action ) = ( '', '', '', '');
44 ( $ach_processor,$ach_login, $ach_password, $ach_action ) = ( '', '', '', '');
47 if ( $conf->exists('cybercash3.2') ) {
49 #qw($MCKversion %Config InitConfig CCError CCDebug CCDebug2);
50 require CCMckDirectLib3_2;
52 require CCMckErrno3_2;
53 #qw(MCKGetErrorMessage $E_NoErr);
54 import CCMckErrno3_2 qw($E_NoErr);
57 ($merchant_conf,$xaction)= $conf->config('cybercash3.2');
58 my $status = &CCMckLib3_2::InitConfig($merchant_conf);
59 if ( $status != $E_NoErr ) {
60 warn "CCMckLib3_2::InitConfig error:\n";
61 foreach my $key (keys %CCMckLib3_2::Config) {
62 warn " $key => $CCMckLib3_2::Config{$key}\n"
64 my($errmsg) = &CCMckErrno3_2::MCKGetErrorMessage($status);
65 die "CCMckLib3_2::InitConfig fatal error: $errmsg\n";
67 $cybercash='cybercash3.2';
68 } elsif ( $conf->exists('business-onlinepayment') ) {
74 ) = $conf->config('business-onlinepayment');
75 $bop_action ||= 'normal authorization';
76 ( $ach_processor, $ach_login, $ach_password, $ach_action, @ach_options ) =
77 ( $bop_processor, $bop_login, $bop_password, $bop_action, @bop_options );
78 eval "use Business::OnlinePayment";
81 if ( $conf->exists('business-onlinepayment-ach') ) {
87 ) = $conf->config('business-onlinepayment-ach');
88 $ach_action ||= 'normal authorization';
89 eval "use Business::OnlinePayment";
96 FS::cust_bill - Object methods for cust_bill records
102 $record = new FS::cust_bill \%hash;
103 $record = new FS::cust_bill { 'column' => 'value' };
105 $error = $record->insert;
107 $error = $new_record->replace($old_record);
109 $error = $record->delete;
111 $error = $record->check;
113 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
115 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
117 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
119 @cust_pay_objects = $cust_bill->cust_pay;
121 $tax_amount = $record->tax;
123 @lines = $cust_bill->print_text;
124 @lines = $cust_bill->print_text $time;
128 An FS::cust_bill object represents an invoice; a declaration that a customer
129 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
130 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
131 following fields are currently supported:
135 =item invnum - primary key (assigned automatically for new invoices)
137 =item custnum - customer (see L<FS::cust_main>)
139 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
140 L<Time::Local> and L<Date::Parse> for conversion functions.
142 =item charged - amount of this invoice
144 =item printed - deprecated
146 =item closed - books closed flag, empty or `Y'
156 Creates a new invoice. To add the invoice to the database, see L<"insert">.
157 Invoices are normally created by calling the bill method of a customer object
158 (see L<FS::cust_main>).
162 sub table { 'cust_bill'; }
166 Adds this invoice to the database ("Posts" the invoice). If there is an error,
167 returns the error, otherwise returns false.
171 Currently unimplemented. I don't remove invoices because there would then be
172 no record you ever posted this invoice (which is bad, no?)
178 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
179 $self->SUPER::delete(@_);
182 =item replace OLD_RECORD
184 Replaces the OLD_RECORD with this one in the database. If there is an error,
185 returns the error, otherwise returns false.
187 Only printed may be changed. printed is normally updated by calling the
188 collect method of a customer object (see L<FS::cust_main>).
193 my( $new, $old ) = ( shift, shift );
194 return "Can't change custnum!" unless $old->custnum == $new->custnum;
195 #return "Can't change _date!" unless $old->_date eq $new->_date;
196 return "Can't change _date!" unless $old->_date == $new->_date;
197 return "Can't change charged!" unless $old->charged == $new->charged;
199 $new->SUPER::replace($old);
204 Checks all fields to make sure this is a valid invoice. If there is an error,
205 returns the error, otherwise returns false. Called by the insert and replace
214 $self->ut_numbern('invnum')
215 || $self->ut_number('custnum')
216 || $self->ut_numbern('_date')
217 || $self->ut_money('charged')
218 || $self->ut_numbern('printed')
219 || $self->ut_enum('closed', [ '', 'Y' ])
221 return $error if $error;
223 return "Unknown customer"
224 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
226 $self->_date(time) unless $self->_date;
228 $self->printed(0) if $self->printed eq '';
235 Returns a list consisting of the total previous balance for this customer,
236 followed by the previous outstanding invoices (as FS::cust_bill objects also).
243 my @cust_bill = sort { $a->_date <=> $b->_date }
244 grep { $_->owed != 0 && $_->_date < $self->_date }
245 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
247 foreach ( @cust_bill ) { $total += $_->owed; }
253 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
259 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
262 =item cust_bill_event
264 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
269 sub cust_bill_event {
271 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
277 Returns the customer (see L<FS::cust_main>) for this invoice.
283 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
288 Depreciated. See the cust_credited method.
290 #Returns a list consisting of the total previous credited (see
291 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
292 #outstanding credits (FS::cust_credit objects).
298 croak "FS::cust_bill->cust_credit depreciated; see ".
299 "FS::cust_bill->cust_credit_bill";
302 #my @cust_credit = sort { $a->_date <=> $b->_date }
303 # grep { $_->credited != 0 && $_->_date < $self->_date }
304 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
306 #foreach (@cust_credit) { $total += $_->credited; }
307 #$total, @cust_credit;
312 Depreciated. See the cust_bill_pay method.
314 #Returns all payments (see L<FS::cust_pay>) for this invoice.
320 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
322 #sort { $a->_date <=> $b->_date }
323 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
329 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
335 sort { $a->_date <=> $b->_date }
336 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
341 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
347 sort { $a->_date <=> $b->_date }
348 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
354 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
361 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
363 foreach (@taxlines) { $total += $_->setup; }
369 Returns the amount owed (still outstanding) on this invoice, which is charged
370 minus all payment applications (see L<FS::cust_bill_pay>) and credit
371 applications (see L<FS::cust_credit_bill>).
377 my $balance = $self->charged;
378 $balance -= $_->amount foreach ( $self->cust_bill_pay );
379 $balance -= $_->amount foreach ( $self->cust_credited );
380 $balance = sprintf( "%.2f", $balance);
381 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
387 Sends this invoice to the destinations configured for this customer: send
388 emails or print. See L<FS::cust_main_invoice>.
393 my($self,$template) = @_;
394 my @print_text = $self->print_text('', $template);
395 my @invoicing_list = $self->cust_main->invoicing_list;
397 if ( grep { $_ ne 'POST' } @invoicing_list or !@invoicing_list ) { #email
399 #better to notify this person than silence
400 @invoicing_list = ($invoice_from) unless @invoicing_list;
402 #false laziness w/FS::cust_pay::delete & fs_signup_server && ::realtime_card
403 #$ENV{SMTPHOSTS} = $smtpmachine;
404 $ENV{MAILADDRESS} = $invoice_from;
405 my $header = new Mail::Header ( [
406 "From: $invoice_from",
407 "To: ". join(', ', grep { $_ ne 'POST' } @invoicing_list ),
408 "Sender: $invoice_from",
409 "Reply-To: $invoice_from",
410 "Date: ". time2str("%a, %d %b %Y %X %z", time),
413 my $message = new Mail::Internet (
415 'Body' => [ @print_text ], #( date)
418 $message->smtpsend( Host => $smtpmachine )
419 or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
420 or return "(customer # ". $self->custnum. ") can't send invoice email".
421 " to ". join(', ', grep { $_ ne 'POST' } @invoicing_list ).
422 " via server $smtpmachine with SMTP: $!";
426 if ( grep { $_ eq 'POST' } @invoicing_list ) { #postal
428 or return "Can't open pipe to $lpr: $!";
429 print LPR @print_text;
431 or return $! ? "Error closing $lpr: $!"
432 : "Exit status $? from $lpr";
439 =item send_csv OPTIONS
441 Sends invoice as a CSV data-file to a remote host with the specified protocol.
445 protocol - currently only "ftp"
451 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
452 and YYMMDDHHMMSS is a timestamp.
454 The fields of the CSV file is as follows:
456 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
460 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
462 If B<record_type> is C<cust_bill>, this is a primary invoice record. The
463 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
464 fields are filled in.
466 If B<record_type> is C<cust_bill_pkg>, this is a line item record. Only the
467 first two fields (B<record_type> and B<invnum>) and the last five fields
468 (B<pkg> through B<edate>) are filled in.
470 =item invnum - invoice number
472 =item custnum - customer number
474 =item _date - invoice date
476 =item charged - total invoice amount
478 =item first - customer first name
480 =item last - customer first name
482 =item company - company name
484 =item address1 - address line 1
486 =item address2 - address line 1
496 =item pkg - line item description
498 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
500 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
502 =item sdate - start date for recurring fee
504 =item edate - end date for recurring fee
511 my($self, %opt) = @_;
513 #part one: create file
515 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
516 mkdir $spooldir, 0700 unless -d $spooldir;
518 my $file = $spooldir. '/'. $self->invnum. time2str('-%Y%m%d%H%M%S.csv', time);
520 open(CSV, ">$file") or die "can't open $file: $!";
522 eval "use Text::CSV_XS";
525 my $csv = Text::CSV_XS->new({'always_quote'=>1});
527 my $cust_main = $self->cust_main;
533 time2str("%x", $self->_date),
534 sprintf("%.2f", $self->charged),
535 ( map { $cust_main->getfield($_) }
536 qw( first last company address1 address2 city state zip country ) ),
538 ) or die "can't create csv";
539 print CSV $csv->string. "\n";
541 #new charges (false laziness w/print_text)
542 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
544 my($pkg, $setup, $recur, $sdate, $edate);
545 if ( $cust_bill_pkg->pkgnum ) {
547 ($pkg, $setup, $recur, $sdate, $edate) = (
548 $cust_bill_pkg->cust_pkg->part_pkg->pkg,
549 ( $cust_bill_pkg->setup != 0
550 ? sprintf("%.2f", $cust_bill_pkg->setup )
552 ( $cust_bill_pkg->recur != 0
553 ? sprintf("%.2f", $cust_bill_pkg->recur )
555 time2str("%x", $cust_bill_pkg->sdate),
556 time2str("%x", $cust_bill_pkg->edate),
560 next unless $cust_bill_pkg->setup != 0;
561 ($pkg, $setup, $recur, $sdate, $edate) =
562 ( 'Tax', sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
568 ( map { '' } (1..11) ),
569 ($pkg, $setup, $recur, $sdate, $edate)
570 ) or die "can't create csv";
571 print CSV $csv->string. "\n";
575 close CSV or die "can't close CSV: $!";
580 if ( $opt{protocol} eq 'ftp' ) {
581 eval "use Net::FTP;";
583 $net = Net::FTP->new($opt{server}) or die @$;
585 die "unknown protocol: $opt{protocol}";
588 $net->login( $opt{username}, $opt{password} )
589 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
591 $net->binary or die "can't set binary mode";
593 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
595 $net->put($file) or die "can't put $file: $!";
605 Pays this invoice with a compliemntary payment. If there is an error,
606 returns the error, otherwise returns false.
612 my $cust_pay = new FS::cust_pay ( {
613 'invnum' => $self->invnum,
614 'paid' => $self->owed,
617 'payinfo' => $self->cust_main->payinfo,
625 Attempts to pay this invoice with a credit card payment via a
626 Business::OnlinePayment realtime gateway. See
627 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
628 for supported processors.
647 Attempts to pay this invoice with an electronic check (ACH) payment via a
648 Business::OnlinePayment realtime gateway. See
649 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
650 for supported processors.
669 Attempts to pay this invoice with phone bill (LEC) payment via a
670 Business::OnlinePayment realtime gateway. See
671 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
672 for supported processors.
690 my( $self, $method, $processor, $login, $password, $action, $options ) = @_;
692 #trim an extraneous blank line
693 pop @$options if scalar(@$options) % 2 && $options->[-1] =~ /^\s*$/;
695 my $cust_main = $self->cust_main;
696 my $amount = $self->owed;
698 my $address = $cust_main->address1;
699 $address .= ", ". $cust_main->address2 if $cust_main->address2;
701 my($payname, $payfirst, $paylast);
702 if ( $cust_main->payname && $method ne 'ECHECK' ) {
703 $payname = $cust_main->payname;
704 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
706 #$dbh->rollback if $oldAutoCommit;
707 return "Illegal payname $payname";
709 ($payfirst, $paylast) = ($1, $2);
711 $payfirst = $cust_main->getfield('first');
712 $paylast = $cust_main->getfield('last');
713 $payname = "$payfirst $paylast";
716 my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
717 if ( $conf->exists('emailinvoiceauto')
718 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
719 push @invoicing_list, $cust_main->all_emails;
721 my $email = $invoicing_list[0];
723 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
725 my $description = 'Internet Services';
726 if ( $conf->exists('business-onlinepayment-description') ) {
727 my $dtempl = $conf->config('business-onlinepayment-description');
729 my $agent_obj = $cust_main->agent
730 or die "can't retreive agent for $cust_main (agentnum ".
731 $cust_main->agentnum. ")";
732 my $agent = $agent_obj->agent;
733 my $pkgs = join(', ',
734 map { $_->cust_pkg->part_pkg->pkg }
735 grep { $_->pkgnum } $self->cust_bill_pkg
737 $description = eval qq("$dtempl");
742 if ( $method eq 'CC' ) {
743 $content{card_number} = $cust_main->payinfo;
744 $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
745 $content{expiration} = "$2/$1";
746 } elsif ( $method eq 'ECHECK' ) {
747 my($account_number,$routing_code) = $cust_main->payinfo;
748 ( $content{account_number}, $content{routing_code} ) =
749 split('@', $cust_main->payinfo);
750 $content{bank_name} = $cust_main->payname;
751 $content{account_type} = 'CHECKING';
752 $content{account_name} = $payname;
753 $content{customer_org} = $self->company ? 'B' : 'I';
754 $content{customer_ssn} = $self->ss;
755 } elsif ( $method eq 'LEC' ) {
756 $content{phone} = $cust_main->payinfo;
760 new Business::OnlinePayment( $processor, @$options );
761 $transaction->content(
764 'password' => $password,
765 'action' => $action1,
766 'description' => $description,
768 'invoice_number' => $self->invnum,
769 'customer_id' => $self->custnum,
770 'last_name' => $paylast,
771 'first_name' => $payfirst,
773 'address' => $address,
774 'city' => $cust_main->city,
775 'state' => $cust_main->state,
776 'zip' => $cust_main->zip,
777 'country' => $cust_main->country,
778 'referer' => 'http://cleanwhisker.420.am/',
780 'phone' => $cust_main->daytime || $cust_main->night,
783 $transaction->submit();
785 if ( $transaction->is_success() && $action2 ) {
786 my $auth = $transaction->authorization;
787 my $ordernum = $transaction->can('order_number')
788 ? $transaction->order_number
791 #warn "********* $auth ***********\n";
792 #warn "********* $ordernum ***********\n";
794 new Business::OnlinePayment( $processor, @$options );
801 password => $password,
802 order_number => $ordernum,
804 authorization => $auth,
805 description => $description,
808 foreach my $field (qw( authorization_source_code returned_ACI transaction_identifier validation_code
809 transaction_sequence_num local_transaction_date
810 local_transaction_time AVS_result_code )) {
811 $capture{$field} = $transaction->$field() if $transaction->can($field);
814 $capture->content( %capture );
818 unless ( $capture->is_success ) {
819 my $e = "Authorization sucessful but capture failed, invnum #".
820 $self->invnum. ': '. $capture->result_code.
821 ": ". $capture->error_message;
828 if ( $transaction->is_success() ) {
836 my $cust_pay = new FS::cust_pay ( {
837 'invnum' => $self->invnum,
840 'payby' => $method2payby{$method},
841 'payinfo' => $cust_main->payinfo,
842 'paybatch' => "$processor:". $transaction->authorization,
844 my $error = $cust_pay->insert;
846 # gah, even with transactions.
847 my $e = 'WARNING: Card/ACH debited but database not updated - '.
848 'error applying payment, invnum #' . $self->invnum.
849 " ($processor): $error";
855 #} elsif ( $options{'report_badcard'} ) {
858 my $perror = "$processor error, invnum #". $self->invnum. ': '.
859 $transaction->result_code. ": ". $transaction->error_message;
861 if ( !$realtime_bop_decline_quiet && $conf->exists('emaildecline')
862 && grep { $_ ne 'POST' } $cust_main->invoicing_list
864 my @templ = $conf->config('declinetemplate');
865 my $template = new Text::Template (
867 SOURCE => [ map "$_\n", @templ ],
868 ) or return "($perror) can't create template: $Text::Template::ERROR";
870 or return "($perror) can't compile template: $Text::Template::ERROR";
872 my $templ_hash = { error => $transaction->error_message };
874 #false laziness w/FS::cust_pay::delete & fs_signup_server && ::send
875 $ENV{MAILADDRESS} = $invoice_from;
876 my $header = new Mail::Header ( [
877 "From: $invoice_from",
878 "To: ". join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ),
879 "Sender: $invoice_from",
880 "Reply-To: $invoice_from",
881 "Date: ". time2str("%a, %d %b %Y %X %z", time),
882 "Subject: Your payment could not be processed",
884 my $message = new Mail::Internet (
886 'Body' => [ $template->fill_in(HASH => $templ_hash) ],
889 $message->smtpsend( Host => $smtpmachine )
890 or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
891 or return "($perror) (customer # ". $self->custnum.
892 ") can't send card decline email to ".
893 join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ).
894 " via server $smtpmachine with SMTP: $!";
902 =item realtime_card_cybercash
904 Attempts to pay this invoice with the CyberCash CashRegister realtime gateway.
908 sub realtime_card_cybercash {
910 my $cust_main = $self->cust_main;
911 my $amount = $self->owed;
913 return "CyberCash CashRegister real-time card processing not enabled!"
914 unless $cybercash eq 'cybercash3.2';
916 my $address = $cust_main->address1;
917 $address .= ", ". $cust_main->address2 if $cust_main->address2;
920 #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
921 $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
926 my $paybatch = $self->invnum.
927 '-' . time2str("%y%m%d%H%M%S", time);
929 my $payname = $cust_main->payname ||
930 $cust_main->getfield('first').' '.$cust_main->getfield('last');
932 my $country = $cust_main->country eq 'US' ? 'USA' : $cust_main->country;
934 my @full_xaction = ( $xaction,
935 'Order-ID' => $paybatch,
936 'Amount' => "usd $amount",
937 'Card-Number' => $cust_main->getfield('payinfo'),
938 'Card-Name' => $payname,
939 'Card-Address' => $address,
940 'Card-City' => $cust_main->getfield('city'),
941 'Card-State' => $cust_main->getfield('state'),
942 'Card-Zip' => $cust_main->getfield('zip'),
943 'Card-Country' => $country,
948 %result = &CCMckDirectLib3_2::SendCC2_1Server(@full_xaction);
950 if ( $result{'MStatus'} eq 'success' ) { #cybercash smps v.2 or 3
951 my $cust_pay = new FS::cust_pay ( {
952 'invnum' => $self->invnum,
956 'payinfo' => $cust_main->payinfo,
957 'paybatch' => "$cybercash:$paybatch",
959 my $error = $cust_pay->insert;
961 # gah, even with transactions.
962 my $e = 'WARNING: Card debited but database not updated - '.
963 'error applying payment, invnum #' . $self->invnum.
964 " (CyberCash Order-ID $paybatch): $error";
970 # } elsif ( $result{'Mstatus'} ne 'failure-bad-money'
971 # || $options{'report_badcard'}
974 return 'Cybercash error, invnum #' .
975 $self->invnum. ':'. $result{'MErrMsg'};
982 Adds a payment for this invoice to the pending credit card batch (see
983 L<FS::cust_pay_batch>).
989 my $cust_main = $self->cust_main;
991 my $cust_pay_batch = new FS::cust_pay_batch ( {
992 'invnum' => $self->getfield('invnum'),
993 'custnum' => $cust_main->getfield('custnum'),
994 'last' => $cust_main->getfield('last'),
995 'first' => $cust_main->getfield('first'),
996 'address1' => $cust_main->getfield('address1'),
997 'address2' => $cust_main->getfield('address2'),
998 'city' => $cust_main->getfield('city'),
999 'state' => $cust_main->getfield('state'),
1000 'zip' => $cust_main->getfield('zip'),
1001 'country' => $cust_main->getfield('country'),
1003 'cardnum' => $cust_main->getfield('payinfo'),
1004 'exp' => $cust_main->getfield('paydate'),
1005 'payname' => $cust_main->getfield('payname'),
1006 'amount' => $self->owed,
1008 my $error = $cust_pay_batch->insert;
1009 die $error if $error;
1014 =item print_text [TIME];
1016 Returns an text invoice, as a list of lines.
1018 TIME an optional value used to control the printing of overdue messages. The
1019 default is now. It isn't the date of the invoice; that's the `_date' field.
1020 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1021 L<Time::Local> and L<Date::Parse> for conversion functions.
1027 my( $self, $today, $template ) = @_;
1029 # my $invnum = $self->invnum;
1030 my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
1031 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1032 unless $cust_main->payname && $cust_main->payby ne 'CHEK';
1034 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1035 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1036 #my $balance_due = $self->owed + $pr_total - $cr_total;
1037 my $balance_due = $self->owed + $pr_total;
1040 #my($description,$amount);
1044 foreach ( @pr_cust_bill ) {
1046 "Previous Balance, Invoice #". $_->invnum.
1047 " (". time2str("%x",$_->_date). ")",
1048 $money_char. sprintf("%10.2f",$_->owed)
1051 if (@pr_cust_bill) {
1052 push @buf,['','-----------'];
1053 push @buf,[ 'Total Previous Balance',
1054 $money_char. sprintf("%10.2f",$pr_total ) ];
1059 foreach ( $self->cust_bill_pkg ) {
1063 my($cust_pkg)=qsearchs('cust_pkg', { 'pkgnum', $_->pkgnum } );
1064 my($part_pkg)=qsearchs('part_pkg',{'pkgpart'=>$cust_pkg->pkgpart});
1065 my($pkg)=$part_pkg->pkg;
1067 if ( $_->setup != 0 ) {
1068 push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ];
1070 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1073 if ( $_->recur != 0 ) {
1075 "$pkg (" . time2str("%x",$_->sdate) . " - " .
1076 time2str("%x",$_->edate) . ")",
1077 $money_char. sprintf("%10.2f",$_->recur)
1080 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1083 } else { #pkgnum Tax
1084 push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ]
1089 push @buf,['','-----------'];
1090 push @buf,['Total New Charges',
1091 $money_char. sprintf("%10.2f",$self->charged) ];
1094 push @buf,['','-----------'];
1095 push @buf,['Total Charges',
1096 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1100 foreach ( $self->cust_credited ) {
1102 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1104 my $reason = substr($_->cust_credit->reason,0,32);
1105 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1106 $reason = " ($reason) " if $reason;
1108 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1110 $money_char. sprintf("%10.2f",$_->amount)
1113 #foreach ( @cr_cust_credit ) {
1115 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1116 # $money_char. sprintf("%10.2f",$_->credited)
1120 #get & print payments
1121 foreach ( $self->cust_bill_pay ) {
1123 #something more elaborate if $_->amount ne ->cust_pay->paid ?
1126 "Payment received ". time2str("%x",$_->cust_pay->_date ),
1127 $money_char. sprintf("%10.2f",$_->amount )
1132 push @buf,['','-----------'];
1133 push @buf,['Balance Due', $money_char.
1134 sprintf("%10.2f", $balance_due ) ];
1136 #create the template
1137 my $templatefile = 'invoice_template';
1138 $templatefile .= "_$template" if $template;
1139 my @invoice_template = $conf->config($templatefile)
1140 or die "cannot load config file $templatefile";
1143 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1144 /invoice_lines\((\d*)\)/;
1145 $invoice_lines += $1 || scalar(@buf);
1148 die "no invoice_lines() functions in template?" unless $wasfunc;
1149 my $invoice_template = new Text::Template (
1151 SOURCE => [ map "$_\n", @invoice_template ],
1152 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1153 $invoice_template->compile()
1154 or die "can't compile template: $Text::Template::ERROR";
1156 #setup template variables
1157 package FS::cust_bill::_template; #!
1158 use vars qw( $invnum $date $page $total_pages @address $overdue @buf $agent );
1160 $invnum = $self->invnum;
1161 $date = $self->_date;
1163 $agent = $self->cust_main->agent->agent;
1165 if ( $FS::cust_bill::invoice_lines ) {
1167 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1169 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1174 #format address (variable for the template)
1176 @address = ( '', '', '', '', '', '' );
1177 package FS::cust_bill; #!
1178 $FS::cust_bill::_template::address[$l++] =
1179 $cust_main->payname.
1180 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1181 ? " (P.O. #". $cust_main->payinfo. ")"
1185 $FS::cust_bill::_template::address[$l++] = $cust_main->company
1186 if $cust_main->company;
1187 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1188 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1189 if $cust_main->address2;
1190 $FS::cust_bill::_template::address[$l++] =
1191 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
1192 $FS::cust_bill::_template::address[$l++] = $cust_main->country
1193 unless $cust_main->country eq 'US';
1195 # #overdue? (variable for the template)
1196 # $FS::cust_bill::_template::overdue = (
1198 # && $today > $self->_date
1199 ## && $self->printed > 1
1200 # && $self->printed > 0
1203 #and subroutine for the template
1204 sub FS::cust_bill::_template::invoice_lines {
1205 my $lines = shift || scalar(@buf);
1207 scalar(@buf) ? shift @buf : [ '', '' ];
1213 $FS::cust_bill::_template::page = 1;
1217 push @collect, split("\n",
1218 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1220 $FS::cust_bill::_template::page++;
1223 map "$_\n", @collect;
1231 $Id: cust_bill.pm,v 1.41.2.22 2003-09-19 04:25:33 ivan Exp $
1237 print_text formatting (and some logic :/) is in source, but needs to be
1238 slurped in from a file. Also number of lines ($=).
1240 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
1241 or something similar so the look can be completely customized?)
1245 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
1246 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base