1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum); #can't import first, it conflicts with cust_main.first
13 use Time::Local qw( timelocal );
14 use Text::Template 1.20;
16 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
21 use FS::Misc qw( send_email );
22 use FS::Record qw( qsearch qsearchs dbh );
24 use FS::Misc qw( generate_ps generate_pdf );
31 $me = '[FS::Template_Mixin]';
32 FS::UID->install_callback( sub {
33 my $conf = new FS::Conf; #global
34 $money_char = $conf->config('money_char') || '$';
35 $date_format = $conf->config('date_format') || '%x'; #/YY
40 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
42 If the "mode" pseudo-field is set on the object, the configuration handle
43 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
50 my $mode = $self->get('mode');
51 if ($self->{_conf} and !defined($mode)) {
52 return $self->{_conf};
55 my $cust_main = $self->cust_main;
56 my $locale = $cust_main ? $cust_main->locale : '';
59 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
60 $mode = $mode->modenum;
61 } elsif ( $mode =~ /\D/ ) {
62 die "invalid invoice mode $mode";
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
66 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
67 # it doesn't have a locale, but system conf still might
68 $conf->set('locale' => $locale) if $conf;
71 # if $mode is unspecified, or if there is no invoice_conf matching this mode
72 # and locale, then use the system config only (but with the locale)
73 $conf ||= FS::Conf->new({ 'locale' => $locale });
75 return $self->{_conf} = $conf;
78 =item print_text OPTIONS
80 Returns an text invoice, as a list of lines.
82 Options can be passed as a hash.
84 I<time>, if specified, is used to control the printing of overdue messages. The
85 default is now. It isn't the date of the invoice; that's the `_date' field.
86 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 I<template>, if specified, is the name of a suffix for alternate invoices.
91 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
99 %params = %{ shift() };
104 $params{'format'} = 'template'; # for some reason
106 $self->print_generic( %params );
109 =item print_latex HASHREF
111 Internal method - returns a filename of a filled-in LaTeX template for this
112 invoice (Note: add ".tex" to get the actual filename), and a filename of
113 an associated logo (with the .eps extension included).
115 See print_ps and print_pdf for methods that return PostScript and PDF output.
117 Options can be passed as a hash.
119 I<time>, if specified, is used to control the printing of overdue messages. The
120 default is now. It isn't the date of the invoice; that's the `_date' field.
121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
122 L<Time::Local> and L<Date::Parse> for conversion functions.
124 I<template>, if specified, is the name of a suffix for alternate invoices.
125 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
126 customize invoice templates for different purposes.
128 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
137 %params = %{ shift() };
142 $params{'format'} = 'latex';
143 my $conf = $self->conf;
145 # this needs to go away
146 my $template = $params{'template'};
147 # and this especially
148 $template ||= $self->_agent_template
149 if $self->can('_agent_template');
152 $self->set('mode', $params{mode})
155 my $pkey = $self->primary_key;
156 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
159 my $lh = new File::Temp(
160 TEMPLATE => $tmp_template,
164 ) or die "can't open temp file: $!\n";
166 my $agentnum = $self->agentnum;
168 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
169 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
170 or die "can't write temp file: $!\n";
172 print $lh $conf->config_binary('logo.eps', $agentnum)
173 or die "can't write temp file: $!\n";
176 $params{'logo_file'} = $lh->filename;
178 if( $conf->exists('invoice-barcode')
179 && $self->can('invoice_barcode')
180 && $self->invnum ) { # don't try to barcode statements
181 my $png_file = $self->invoice_barcode($dir);
182 my $eps_file = $png_file;
183 $eps_file =~ s/\.png$/.eps/g;
184 $png_file =~ /(barcode.*png)/;
186 $eps_file =~ /(barcode.*eps)/;
189 my $curr_dir = cwd();
191 # after painfuly long experimentation, it was determined that sam2p won't
192 # accept : and other chars in the path, no matter how hard I tried to
193 # escape them, hence the chdir (and chdir back, just to be safe)
194 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
195 or die "sam2p failed: $!\n";
199 $params{'barcode_file'} = $eps_file;
202 my @filled_in = $self->print_generic( %params );
204 my $fh = new File::Temp( TEMPLATE => $tmp_template,
208 ) or die "can't open temp file: $!\n";
209 binmode($fh, ':utf8'); # language support
210 print $fh join('', @filled_in );
213 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
214 return ($1, $params{'logo_file'}, $params{'barcode_file'});
220 my $cust_main = $self->cust_main;
221 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
224 =item print_generic OPTION => VALUE ...
226 Internal method - returns a filled-in template for this invoice as a scalar.
228 See print_ps and print_pdf for methods that return PostScript and PDF output.
236 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
246 Overrides "Invoice" as the name of the sent document.
250 Used to control the printing of overdue messages. The
251 default is now. It isn't the date of the invoice; that's the `_date' field.
252 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
253 L<Time::Local> and L<Date::Parse> for conversion functions.
257 Logo file (path to temporary EPS file on the local filesystem)
261 CID for inline (emailed) images (logo)
265 Override customer's locale
269 Overrides any per customer cdr squelching when true
273 Supress the (invoice, quotation, statement, etc.) number
281 Supress the payment coupon
285 Barcode file (path to temporary EPS file on the local filesystem)
289 Flag indicating the barcode image should be a link (normal HTML dipaly)
293 Barcode CID for inline (emailed) images
295 =item preref_callback
297 Coderef run for each line item, code should return HTML to be displayed
298 before that line item (quotations only)
302 Deprecated. Used as a suffix for a configuration template. Please
303 don't use this, it deprecated in favor of more flexible alternatives.
309 #what's with all the sprintf('%10.2f')'s in here? will it cause any
310 # (alignment in text invoice?) problems to change them all to '%.2f' ?
311 # yes: fixed width/plain text printing will be borked
313 my( $self, %params ) = @_;
314 my $conf = $self->conf;
316 my $today = $params{today} ? $params{today} : time;
317 warn "$me print_generic called on $self with suffix $params{template}\n"
320 my $format = $params{format};
321 die "Unknown format: $format"
322 unless $format =~ /^(latex|html|template)$/;
324 my $cust_main = $self->cust_main || $self->prospect_main;
326 my $locale = $params{'locale'} || $cust_main->locale;
328 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
329 'html' => [ '<%=', '%>' ],
330 'template' => [ '{', '}' ],
333 warn "$me print_generic creating template\n"
336 # set the notice name here, and nowhere else.
337 my $notice_name = $params{notice_name}
338 || $conf->config('notice_name')
339 || $self->notice_name;
342 my $template = $params{template} ? $params{template} : $self->_agent_template;
343 my $templatefile = $self->template_conf. $format;
344 $templatefile .= "_$template"
345 if length($template) && $conf->exists($templatefile."_$template");
348 my @invoice_template = map "$_\n", $conf->config($templatefile)
349 or die "cannot load config data $templatefile";
351 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
352 #change this to a die when the old code is removed
353 # it's been almost ten years, changing it to a die
354 die "old-style invoice template $templatefile; ".
355 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
356 #$old_latex = 'true';
357 #@invoice_template = _translate_old_latex_format(@invoice_template);
360 warn "$me print_generic creating T:T object\n"
363 my $text_template = new Text::Template(
365 SOURCE => \@invoice_template,
366 DELIMITERS => $delimiters{$format},
369 warn "$me print_generic compiling T:T object\n"
372 $text_template->compile()
373 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
376 # additional substitution could possibly cause breakage in existing templates
379 'notes' => sub { map "$_", @_ },
380 'footer' => sub { map "$_", @_ },
381 'smallfooter' => sub { map "$_", @_ },
382 'returnaddress' => sub { map "$_", @_ },
383 'coupon' => sub { map "$_", @_ },
384 'summary' => sub { map "$_", @_ },
390 s/%%(.*)$/<!-- $1 -->/g;
391 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
392 s/\\begin\{enumerate\}/<ol>/g;
394 s/\\end\{enumerate\}/<\/ol>/g;
395 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
404 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
412 s/\\hyphenation\{[\w\s\-]+}//;
417 'coupon' => sub { "" },
418 'summary' => sub { "" },
425 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
426 s/\\begin\{enumerate\}//g;
428 s/\\end\{enumerate\}//g;
429 s/\\textbf\{(.*)\}/$1/g;
436 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
443 s/\\\\\*?\s*$/\n/; # dubious
444 s/\\hyphenation\{[\w\s\-]+}//;
448 'coupon' => sub { "" },
449 'summary' => sub { "" },
454 # hashes for differing output formats
455 my %nbsps = ( 'latex' => '~',
456 'html' => '', # '&nbps;' would be nice
457 'template' => '', # not used
459 my $nbsp = $nbsps{$format};
461 my %escape_functions = ( 'latex' => \&_latex_escape,
462 'html' => \&_html_escape_nbsp,#\&encode_entities,
463 'template' => sub { shift },
465 my $escape_function = $escape_functions{$format};
466 my $escape_function_nonbsp = ($format eq 'html')
467 ? \&_html_escape : $escape_function;
469 my %newline_tokens = ( 'latex' => '\\\\',
473 my $newline_token = $newline_tokens{$format};
475 warn "$me generating template variables\n"
478 # generate template variables
482 defined( $conf->config_orbase( "invoice_${format}returnaddress",
486 && length( $conf->config_orbase( "invoice_${format}returnaddress",
492 $returnaddress = join("\n",
493 $conf->config_orbase("invoice_${format}returnaddress", $template)
497 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
499 my $convert_map = $convert_maps{$format}{'returnaddress'};
502 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
507 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
509 my $convert_map = $convert_maps{$format}{'returnaddress'};
510 $returnaddress = join( "\n", &$convert_map(
511 map { s/( {2,})/'~' x length($1)/eg;
515 ( $conf->config('company_name', $cust_main->agentnum),
516 $conf->config('company_address', $cust_main->agentnum),
523 my $warning = "Couldn't find a return address; ".
524 "do you need to set the company_address configuration value?";
526 $returnaddress = $nbsp;
527 #$returnaddress = $warning;
531 warn "$me generating invoice data\n"
534 my $agentnum = $cust_main->agentnum;
539 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
540 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
541 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
542 'returnaddress' => $returnaddress,
543 'agent' => &$escape_function($cust_main->agent->agent),
545 #invoice/quotation info
546 'no_number' => $params{'no_number'},
547 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
548 'quotationnum' => $self->quotationnum,
549 'no_date' => $params{'no_date'},
550 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
551 # workaround for inconsistent behavior in the early plain text
552 # templates; see RT#28271
553 'date' => ( $params{'no_date'}
555 : ($format eq 'template'
557 : $self->time2str_local('long', $self->_date, $format)
560 'today' => $self->time2str_local('long', $today, $format),
561 'terms' => $self->terms,
562 'template' => $template, #params{'template'},
563 'notice_name' => $notice_name, # escape?
564 'current_charges' => sprintf("%.2f", $self->charged),
565 'duedate' => $self->due_date2str('rdate'), #date_format?
566 'duedate_long' => $self->due_date2str('long'),
569 'custnum' => $cust_main->display_custnum,
570 'prospectnum' => $cust_main->prospectnum,
571 'agent_custid' => &$escape_function($cust_main->agent_custid),
572 ( map { $_ => &$escape_function($cust_main->$_()) }
573 qw( company address1 address2 city state zip fax )
575 'payname' => &$escape_function( $cust_main->invoice_attn
576 || $cust_main->contact_firstlast ),
579 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
580 'unitprices' => $conf->exists('invoice-unitprice'),
581 'smallernotes' => $conf->exists('invoice-smallernotes'),
582 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
583 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
585 #layout info -- would be fancy to calc some of this and bury the template
587 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
588 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
589 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
590 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
591 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
592 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
593 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
594 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
595 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
596 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
598 # better hang on to conf_dir for a while (for old templates)
599 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
601 #these are only used when doing paged plaintext
607 #quotations have $name
608 $invoice_data{'name'} = $invoice_data{'payname'};
611 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
612 # prototype here to silence warnings
613 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
615 my $min_sdate = 999999999999;
617 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
618 next unless $cust_bill_pkg->pkgnum > 0;
619 $min_sdate = $cust_bill_pkg->sdate
620 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
621 $max_edate = $cust_bill_pkg->edate
622 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
625 $invoice_data{'bill_period'} = '';
626 $invoice_data{'bill_period'} =
627 $self->time2str_local('%e %h', $min_sdate, $format)
629 $self->time2str_local('%e %h', $max_edate, $format)
630 if ($max_edate != 0 && $min_sdate != 999999999999);
632 $invoice_data{finance_section} = '';
633 if ( $conf->config('finance_pkgclass') ) {
635 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
636 $invoice_data{finance_section} = $pkg_class->categoryname;
638 $invoice_data{finance_amount} = '0.00';
639 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
641 my $countrydefault = $conf->config('countrydefault') || 'US';
642 foreach ( qw( address1 address2 city state zip country fax) ){
643 my $method = 'ship_'.$_;
644 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
646 if ( length($cust_main->ship_company) ) {
647 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
649 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
651 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
652 $invoice_data{'ship_country'} = ''
653 if ( $invoice_data{'ship_country'} eq $countrydefault );
655 $invoice_data{'cid'} = $params{'cid'}
658 if ( $cust_main->bill_locationnum
659 && $cust_main->bill_location->country ne $countrydefault ) {
660 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
662 $invoice_data{'country'} = '';
666 $invoice_data{'address'} = \@address;
668 $invoice_data{'payname'}.
669 ( $cust_main->po_number
670 ? " (P.O. #". $cust_main->po_number. ")"
674 push @address, $cust_main->company
675 if $cust_main->company;
676 push @address, $cust_main->address1;
677 push @address, $cust_main->address2
678 if $cust_main->address2;
680 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
681 push @address, $invoice_data{'country'}
682 if $invoice_data{'country'};
684 while (scalar(@address) < 5);
686 $invoice_data{'logo_file'} = $params{'logo_file'}
687 if $params{'logo_file'};
688 $invoice_data{'barcode_file'} = $params{'barcode_file'}
689 if $params{'barcode_file'};
690 $invoice_data{'barcode_img'} = $params{'barcode_img'}
691 if $params{'barcode_img'};
692 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
693 if $params{'barcode_cid'};
695 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
696 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
697 #my $balance_due = $self->owed + $pr_total - $cr_total;
698 my $balance_due = $self->owed;
699 if ( $self->enable_previous ) {
700 $balance_due += $pr_total;
702 # otherwise the previous balance is not shown, so including it in the
703 # balance due is just confusing
705 # the sum of amount owed on all invoices
706 # (this is used in the summary & on the payment coupon)
707 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
709 # flag telling this invoice to have a first-page summary
710 my $summarypage = '';
712 if ( $self->custnum && $self->invnum ) {
713 # XXX should be an FS::cust_bill method to set the defaults, instead
714 # of checking the type here
716 # info from customer's last invoice before this one, for some
718 $invoice_data{'last_bill'} = {};
720 my $last_bill = $self->previous_bill;
723 # "balance_date_range" unfortunately is unsuitable for this, since it
724 # cares about application dates. We want to know the sum of all
725 # _top-level transactions_ dated before the last invoice.
727 # still do this for the "Previous Balance" line of the summary block
729 map "$_ WHERE _date <= ? AND custnum = ?", (
730 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
731 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
732 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
733 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
736 # the customer's current balance immediately after generating the last
739 my $last_bill_balance = $last_bill->charged;
741 my $delta = FS::Record->scalar_sql(
743 $last_bill->_date - 1,
746 $last_bill_balance += $delta;
749 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
751 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
753 $self->time2str_local('%D', $last_bill->_date),
756 # ("true_previous_balance" is a terrible name, but at least it's no
757 # longer stored in the database)
758 $invoice_data{'true_previous_balance'} = $last_bill_balance;
760 # Now, get all applications of credits/payments dated on or after the
761 # previous bill, to invoices before the current bill. (The
762 # credit/payment date restriction prevents these from intersecting
763 # the "Previous Balance" set.)
764 # These are "adjustments". The past due balance will be shown as
765 # Previous Balance - Adjustments.
768 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
769 WHERE cust_bill._date < ?
771 AND cust_bill.custnum = ?"
772 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
773 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
776 my $delta = FS::Record->scalar_sql(
782 $adjustments += $delta;
784 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
786 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
787 $invoice_data{'balance_adjustments'}
790 # the sum of amount owed on all previous invoices
791 # ($pr_total is used elsewhere but not as $previous_balance)
792 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
794 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
795 my (@payments, @credits);
796 # for formats that itemize previous payments
797 foreach my $cust_pay ( qsearch('cust_pay', {
798 'custnum' => $self->custnum,
799 '_date' => { op => '>=',
800 value => $last_bill->_date }
803 next if $cust_pay->_date > $self->_date;
805 '_date' => $cust_pay->_date,
806 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
807 'payinfo' => $cust_pay->payby_payinfo_pretty,
808 'amount' => sprintf('%.2f', $cust_pay->paid),
810 # not concerned about applications
812 foreach my $cust_credit ( qsearch('cust_credit', {
813 'custnum' => $self->custnum,
814 '_date' => { op => '>=',
815 value => $last_bill->_date }
818 next if $cust_credit->_date > $self->_date;
820 '_date' => $cust_credit->_date,
821 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
822 'creditreason'=> $cust_credit->reason,
823 'amount' => sprintf('%.2f', $cust_credit->amount),
826 $invoice_data{'previous_payments'} = \@payments;
827 $invoice_data{'previous_credits'} = \@credits;
829 # there is no $last_bill
830 $invoice_data{'true_previous_balance'} =
831 $invoice_data{'balance_adjustments'} =
832 $invoice_data{'previous_balance'} = '0.00';
833 $invoice_data{'previous_payments'} = [];
834 $invoice_data{'previous_credits'} = [];
837 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
838 $invoice_data{'summarypage'} = $summarypage = 1;
841 } # if this is an invoice
843 warn "$me substituting variables in notes, footer, smallfooter\n"
846 my $tc = $self->template_conf;
847 my @include = ( [ $tc, 'notes' ],
848 [ 'invoice_', 'footer' ],
849 [ 'invoice_', 'smallfooter', ],
850 [ 'invoice_', 'watermark' ],
852 push @include, [ $tc, 'coupon', ]
853 unless $params{'no_coupon'};
855 foreach my $i (@include) {
857 # load the configuration for this sub-template
859 my($base, $include) = @$i;
861 my $inc_file = $conf->key_orbase("$base$format$include", $template);
863 my @inc_src = $conf->config($inc_file, $agentnum);
865 my $converter = $convert_maps{$format}{$include};
867 # then attempt to convert LaTeX to the requested format
868 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
869 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
871 # this isn't included in the convert_maps
872 my ($open, $close) = @{ $delimiters{$format} };
877 } # else @inc_src is empty and that's fine
879 # make a Text::Template out of it
881 my $inc_tt = new Text::Template (
883 SOURCE => [ map "$_\n", @inc_src ],
884 DELIMITERS => $delimiters{$format},
885 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
887 unless ( $inc_tt->compile() ) {
888 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
889 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
895 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
897 $invoice_data{$include} =~ s/\n+$//
898 if ($format eq 'latex');
901 # if (well, probably when) we still need PO numbers in the brave new world of
902 # 4.x, then we'll have to add them back as their own customer fields
903 # # let invoices use either of these as needed
904 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
905 # ? $cust_main->payinfo : '';
906 # $invoice_data{'po_line'} =
907 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
908 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
911 my %money_chars = ( 'latex' => '',
912 'html' => $conf->config('money_char') || '$',
915 my $money_char = $money_chars{$format};
918 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
919 'html' => $conf->config('money_char') || '$',
922 my $other_money_char = $other_money_chars{$format};
923 $invoice_data{'dollar'} = $other_money_char;
925 my %minus_signs = ( 'latex' => '$-$',
927 'template' => '- ' );
928 my $minus = $minus_signs{$format};
930 my @detail_items = ();
931 my @total_items = ();
935 $invoice_data{'detail_items'} = \@detail_items;
936 $invoice_data{'total_items'} = \@total_items;
937 $invoice_data{'buf'} = \@buf;
938 $invoice_data{'sections'} = \@sections;
940 warn "$me generating sections\n"
943 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
944 my $multisection = $self->has_sections;
945 $invoice_data{'multisection'} = $multisection;
947 my $extra_sections = [];
948 my $extra_lines = ();
950 # default section ('Charges')
951 my $default_section = { 'description' => '',
956 # Previous Charges section
957 # subtotal is the first return value from $self->previous
958 my $previous_section;
959 # if the invoice has major sections, or if we're summarizing previous
960 # charges with a single line, or if we've been specifically told to put them
961 # in a section, create a section for previous charges:
962 if ( $multisection or
963 $conf->exists('previous_balance-summary_only') or
964 $conf->exists('previous_balance-section') ) {
966 $previous_section = { 'description' => $self->mt('Previous Charges'),
967 'subtotal' => $other_money_char.
968 sprintf('%.2f', $pr_total),
969 'summarized' => '', #why? $summarypage ? 'Y' : '',
971 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
972 join(' / ', map { $cust_main->balance_date_range(@$_) }
973 $self->_prior_month30s
975 if $conf->exists('invoice_include_aging');
978 # otherwise put them in the main section
979 $previous_section = $default_section;
982 my $adjust_section = {
983 'description' => $self->mt('Credits, Payments, and Adjustments'),
984 'adjust_section' => 1,
985 'subtotal' => 0, # adjusted below
987 my $adjust_weight = _pkg_category($adjust_section->{description})
988 ? _pkg_category($adjust_section->{description})->weight
990 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
991 # Note: 'sort_weight' here is actually a flag telling whether there is an
992 # explicit package category for the adjust section. If so, certain behavior
994 $adjust_section->{'sort_weight'} = $adjust_weight;
997 if ( $multisection ) {
998 ($extra_sections, $extra_lines) =
999 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
1000 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
1001 && $self->can('_items_extra_usage_sections');
1003 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1005 push @detail_items, @$extra_lines if $extra_lines;
1007 # the code is written so that both methods can be used together, but
1008 # we haven't yet changed the template to take advantage of that, so for
1009 # now, treat them as mutually exclusive.
1010 my %section_method = ( by_category => 1 );
1011 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1012 %section_method = ( by_location => 1 );
1014 my ($early, $late) =
1015 $self->_items_sections( 'summary' => $summarypage,
1016 'escape' => $escape_function_nonbsp,
1017 'extra_sections' => $extra_sections,
1018 'format' => $format,
1021 push @sections, @$early;
1022 $late_sections = $late;
1024 if ( $conf->exists('svc_phone_sections')
1025 && $self->can('_items_svc_phone_sections')
1028 my ($phone_sections, $phone_lines) =
1029 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1030 push @{$late_sections}, @$phone_sections;
1031 push @detail_items, @$phone_lines;
1033 if ( $conf->exists('voip-cust_accountcode_cdr')
1034 && $cust_main->accountcode_cdr
1035 && $self->can('_items_accountcode_cdr')
1038 my ($accountcode_section, $accountcode_lines) =
1039 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1040 if ( scalar(@$accountcode_lines) ) {
1041 push @{$late_sections}, $accountcode_section;
1042 push @detail_items, @$accountcode_lines;
1045 } else {# not multisection
1046 # make a default section
1047 push @sections, $default_section;
1048 # and calculate the finance charge total, since it won't get done otherwise.
1049 # and the default section total
1050 # XXX possibly finance_pkgclass should not be used in this manner?
1051 my @finance_charges;
1053 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1054 if ( $invoice_data{finance_section} and
1055 grep { $_->section eq $invoice_data{finance_section} }
1056 $cust_bill_pkg->cust_bill_pkg_display ) {
1057 # I think these are always setup fees, but just to be sure...
1058 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1060 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1063 $invoice_data{finance_amount} =
1064 sprintf('%.2f', sum( @finance_charges ) || 0);
1065 $default_section->{subtotal} = $other_money_char.
1066 sprintf('%.2f', sum( @charges ) || 0);
1069 # start setting up summary subtotals
1070 my @summary_subtotals;
1071 my $method = $conf->config('summary_subtotals_method');
1072 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1073 # then re-section them by the correct method
1074 my %section_method = ( by_category => 1 );
1075 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1076 %section_method = ( by_location => 1 );
1078 my ($early, $late) =
1079 $self->_items_sections( 'summary' => $summarypage,
1080 'escape' => $escape_function_nonbsp,
1081 'extra_sections' => $extra_sections,
1082 'format' => $format,
1085 foreach ( @$early ) {
1086 next if $_->{subtotal} == 0;
1087 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1088 push @summary_subtotals, $_;
1091 # subtotal sectioning is the same as for the actual invoice sections
1092 @summary_subtotals = @sections;
1095 # Hereafter, push sections to both @sections and @summary_subtotals
1096 # if they belong in both places (e.g. tax section). Late sections are
1097 # never in @summary_subtotals.
1099 # previous invoice balances in the Previous Charges section if there
1100 # is one, otherwise in the main detail section
1101 # (except if summary_only is enabled, don't show them at all)
1102 if ( $self->can('_items_previous') &&
1103 $self->enable_previous &&
1104 ! $conf->exists('previous_balance-summary_only') ) {
1106 warn "$me adding previous balances\n"
1109 foreach my $line_item ( $self->_items_previous ) {
1112 ref => $line_item->{'pkgnum'},
1113 pkgpart => $line_item->{'pkgpart'},
1114 #quantity => 1, # not really correct
1115 section => $previous_section, # which might be $default_section
1116 description => &$escape_function($line_item->{'description'}),
1117 ext_description => [ map { &$escape_function($_) }
1118 @{ $line_item->{'ext_description'} || [] }
1120 amount => $money_char . $line_item->{'amount'},
1121 product_code => $line_item->{'pkgpart'} || 'N/A',
1124 push @detail_items, $detail;
1125 push @buf, [ $detail->{'description'},
1126 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1132 if ( @pr_cust_bill && $self->enable_previous ) {
1133 push @buf, ['','-----------'];
1134 push @buf, [ $self->mt('Total Previous Balance'),
1135 $money_char. sprintf("%10.2f", $pr_total) ];
1139 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1140 warn "$me adding DID summary\n"
1143 my ($didsummary,$minutes) = $self->_did_summary;
1144 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1146 { 'description' => $didsummary_desc,
1147 'ext_description' => [ $didsummary, $minutes ],
1151 foreach my $section (@sections, @$late_sections) {
1153 # begin some normalization
1154 $section->{'subtotal'} = $section->{'amount'}
1156 && !exists($section->{subtotal})
1157 && exists($section->{amount});
1159 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1160 if ( $invoice_data{finance_section} &&
1161 $section->{'description'} eq $invoice_data{finance_section} );
1163 if ( $multisection ) {
1165 if ( ref($section->{'subtotal'}) ) {
1167 $section->{'subtotal'} =
1168 sprintf("$other_money_char%.2f to $other_money_char%.2f",
1169 $section->{'subtotal'}[0],
1170 $section->{'subtotal'}[1]
1175 $section->{'subtotal'} = $other_money_char.
1176 sprintf('%.2f', $section->{'subtotal'})
1180 # continue some normalization
1181 $section->{'amount'} = $section->{'subtotal'}
1185 if ( $section->{'description'} ) {
1186 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1191 warn "$me setting options\n"
1195 $options{'section'} = $section if $multisection;
1196 $options{'section_with_taxes'} = 1
1197 if $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
1198 $options{'format'} = $format;
1199 $options{'escape_function'} = $escape_function;
1200 $options{'no_usage'} = 1 unless $unsquelched;
1201 $options{'unsquelched'} = $unsquelched;
1202 $options{'summary_page'} = $summarypage;
1203 $options{'skip_usage'} =
1204 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1205 $options{'preref_callback'} = $params{'preref_callback'};
1207 warn "$me searching for line items\n"
1210 my %section_tax_lines;
1213 foreach my $line_item ( $self->_items_pkg(%options),
1214 $self->_items_fee(%options) ) {
1216 warn "$me adding line item ".
1217 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1220 push @buf, ( [ $line_item->{'description'},
1221 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1223 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1226 $line_item->{'ref'} = $line_item->{'pkgnum'};
1227 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1228 $line_item->{'section'} = $section;
1229 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1230 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1232 if ( length($line_item->{'unit_amount'}) ) {
1233 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1235 $line_item->{'ext_description'} ||= [];
1237 if ( $options{section_with_taxes} && ref $line_item->{pkg_tax} ) {
1238 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1240 # It is rarely possible for the same tax record to be presented here
1241 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1242 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1243 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1245 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1249 push @detail_items, $line_item;
1252 # If conf flag invoice_sections_with_taxes:
1253 # - Add @detail_items for taxes into each section
1254 # - Update section subtotal to include taxes
1255 if ( $options{section_with_taxes} && %section_tax_lines ) {
1256 for my $taxname ( keys %section_tax_lines ) {
1258 push @detail_items, {
1259 section => $section,
1260 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1261 description => &$escape_function($taxname),
1264 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1265 # append to the second value.
1267 if ($section->{subtotal} =~ /to/) {
1268 my @subtotal = split /\s/, $section->{subtotal};
1269 $subtotal[2] =~ s/[^\d\.]//g;
1270 $subtotal[2] = sprintf(
1272 ( $subtotal[2] + $section_tax_lines{$taxname} )
1274 $section->{subtotal} = join ' ', @subtotal;
1276 $section->{subtotal} =~ s/[^\d\.]//g;
1277 $section->{subtotal} = sprintf(
1278 $money_char . "%.2f",
1279 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1286 if ( $section->{'description'} ) {
1287 push @buf, ( ['','-----------'],
1288 [ $section->{'description'}. ' sub-total',
1289 $section->{'subtotal'} # already formatted this
1298 $invoice_data{current_less_finance} =
1299 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1301 # if there's anything in the Previous Charges section, prepend it to the list
1302 if ( $pr_total and $previous_section ne $default_section ) {
1303 unshift @sections, $previous_section;
1304 # but not @summary_subtotals
1307 warn "$me adding taxes\n"
1310 # create a tax section if we don't yet have one
1311 my @items_tax = $self->_items_tax;
1312 my $tax_description = 'Taxes, Surcharges, and Fees';
1314 List::Util::first { $_->{description} eq $tax_description } @sections;
1315 if (!$tax_section) {
1316 $tax_section = { 'description' => $tax_description };
1317 push @sections, $tax_section if $multisection and @items_tax > 0;
1319 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1320 # if this is an existing tax section, we're merging the tax items into it.
1321 # grab the taxtotal that's already there, strip the money symbol if any
1322 my $taxtotal = $tax_section->{'subtotal'} || 0;
1323 $taxtotal =~ s/^\Q$other_money_char\E//;
1326 #my $tax_weight = _pkg_category($tax_section->{description})
1327 # ? _pkg_category($tax_section->{description})->weight
1329 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1330 #$tax_section->{'sort_weight'} = $tax_weight;
1332 foreach my $tax ( @items_tax ) {
1334 $taxtotal += $tax->{'amount'};
1336 my $description = &$escape_function( $tax->{'description'} );
1337 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1339 if ( $multisection ) {
1341 push @detail_items, {
1342 ext_description => [],
1345 description => $description,
1346 amount => $money_char. $amount,
1348 section => $tax_section,
1353 push @total_items, {
1354 'total_item' => $description,
1355 'total_amount' => $other_money_char. $amount,
1360 push @buf,[ $description,
1361 $money_char. $amount,
1368 $total->{'total_item'} = $self->mt('Sub-total');
1369 $total->{'total_amount'} =
1370 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1372 if ( $multisection ) {
1373 if ( $taxtotal > 0 ) {
1374 # there are taxes, so prepare the section to be displayed.
1375 # $taxtotal already includes any line items that were already in the
1376 # section (fees, taxes that are charged as packages for some reason).
1377 # also set 'summarized' to false so that this isn't a summary-only
1379 $tax_section->{'subtotal'} = $other_money_char.
1380 sprintf('%.2f', $taxtotal);
1381 $tax_section->{'pretotal'} = 'New charges sub-total '.
1382 $total->{'total_amount'};
1383 $tax_section->{'description'} = $self->mt($tax_description);
1384 $tax_section->{'summarized'} = '';
1386 if ( $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum) ) {
1388 # remove tax section if taxes are itemized within other sections
1389 @sections = grep{ $_ ne $tax_section } @sections;
1391 } elsif ( !grep $tax_section, @sections ) {
1393 # append it if it's not already there
1394 push @sections, $tax_section;
1395 push @summary_subtotals, $tax_section;
1402 unshift @total_items, $total;
1405 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1411 my %embolden_functions = (
1412 'latex' => sub { return '\textbf{'. shift(). '}' },
1413 'html' => sub { return '<b>'. shift(). '</b>' },
1414 'template' => sub { shift },
1416 my $embolden_function = $embolden_functions{$format};
1418 if ( $multisection ) {
1420 if ( $adjust_section->{'sort_weight'} ) {
1421 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1422 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1424 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1425 $other_money_char. sprintf('%.2f', $self->charged );
1430 if ( $self->can('_items_total') ) { # should always be true now
1432 # even for multisection, need plain text version
1434 my @new_total_items = $self->_items_total;
1436 push @buf,['','-----------'];
1438 foreach ( @new_total_items ) {
1439 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1440 $_->{'total_item'} = &$embolden_function( $item );
1442 if ( ref($amount) ) {
1443 $_->{'total_amount'} = &$embolden_function(
1444 $other_money_char.$amount->[0]. ' to '.
1445 $other_money_char.$amount->[1]
1448 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1451 # but if it's multisection, don't append to @total_items. the adjust
1452 # section has all this stuff
1453 push @total_items, $_ if !$multisection;
1454 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1457 push @buf, [ '', '' ];
1459 # if we're showing previous invoices, also show previous
1460 # credits and payments
1461 if ( $self->enable_previous
1462 and $self->can('_items_credits')
1463 and $self->can('_items_payments') )
1467 my $credittotal = 0;
1468 foreach my $credit (
1469 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1473 $total->{'total_item'} = &$escape_function($credit->{'description'});
1474 $credittotal += $credit->{'amount'};
1475 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1476 if ( $multisection ) {
1477 push @detail_items, {
1478 ext_description => [],
1481 description => &$escape_function($credit->{'description'}),
1482 amount => $money_char . $credit->{'amount'},
1484 section => $adjust_section,
1487 push @total_items, $total;
1491 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1494 foreach my $credit (
1495 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1497 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1501 my $paymenttotal = 0;
1502 foreach my $payment (
1503 $self->_items_payments( 'template' => $template )
1506 $total->{'total_item'} = &$escape_function($payment->{'description'});
1507 $paymenttotal += $payment->{'amount'};
1508 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1509 if ( $multisection ) {
1510 push @detail_items, {
1511 ext_description => [],
1514 description => &$escape_function($payment->{'description'}),
1515 amount => $money_char . $payment->{'amount'},
1517 section => $adjust_section,
1520 push @total_items, $total;
1522 push @buf, [ $payment->{'description'},
1523 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1526 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1528 if ( $multisection ) {
1529 $adjust_section->{'subtotal'} = $other_money_char.
1530 sprintf('%.2f', $credittotal + $paymenttotal);
1532 #why this? because {sort_weight} forces the adjust_section to appear
1533 #in @extra_sections instead of @sections. obviously.
1534 push @sections, $adjust_section
1535 unless $adjust_section->{sort_weight};
1536 # do not summarize; adjustments there are shown according to
1540 # create Balance Due message
1543 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1544 $total->{'total_amount'} =
1545 &$embolden_function(
1546 $other_money_char. sprintf('%.2f', #why? $summarypage
1547 # ? $self->charged +
1548 # $self->billing_balance
1550 $self->owed + $pr_total
1553 if ( $multisection && !$adjust_section->{sort_weight} ) {
1554 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1555 $total->{'total_amount'};
1557 push @total_items, $total;
1559 push @buf,['','-----------'];
1560 push @buf,[$self->balance_due_msg, $money_char.
1561 sprintf("%10.2f", $balance_due ) ];
1564 if ( $conf->exists('previous_balance-show_credit')
1565 and $cust_main->balance < 0 ) {
1566 my $credit_total = {
1567 'total_item' => &$embolden_function($self->credit_balance_msg),
1568 'total_amount' => &$embolden_function(
1569 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1572 if ( $multisection ) {
1573 $adjust_section->{'posttotal'} .= $newline_token .
1574 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1577 push @total_items, $credit_total;
1579 push @buf,['','-----------'];
1580 push @buf,[$self->credit_balance_msg, $money_char.
1581 sprintf("%10.2f", -$cust_main->balance ) ];
1585 } #end of default total adding ! can('_items_total')
1587 if ( $multisection ) {
1588 if ( $conf->exists('svc_phone_sections')
1589 && $self->can('_items_svc_phone_sections')
1593 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1594 $total->{'total_amount'} =
1595 &$embolden_function(
1596 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1598 my $last_section = pop @sections;
1599 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1600 $total->{'total_amount'};
1601 push @sections, $last_section;
1603 push @sections, @$late_sections
1607 # make a discounts-available section, even without multisection
1608 if ( $conf->exists('discount-show_available')
1609 and my @discounts_avail = $self->_items_discounts_avail ) {
1610 my $discount_section = {
1611 'description' => $self->mt('Discounts Available'),
1616 push @sections, $discount_section; # do not summarize
1617 push @detail_items, map { +{
1618 'ref' => '', #should this be something else?
1619 'section' => $discount_section,
1620 'description' => &$escape_function( $_->{description} ),
1621 'amount' => $money_char . &$escape_function( $_->{amount} ),
1622 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1623 } } @discounts_avail;
1626 # not adding any more sections after this
1627 $invoice_data{summary_subtotals} = \@summary_subtotals;
1630 if ( $conf->exists('usage_class_summary')
1631 and $self->can('_items_usage_class_summary') ) {
1632 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1633 if ( @usage_subtotals ) {
1634 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1635 unshift @detail_items, @usage_subtotals;
1639 # invoice history "section" (not really a section)
1640 # not to be included in any subtotals, completely independent of
1642 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1645 foreach my $cust_bill ( $cust_main->cust_bill ) {
1646 # XXX hardcoded format, and currently only 'charged'; add other fields
1647 # if they become necessary
1648 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1649 $history{$date} ||= 0;
1650 $history{$date} += $cust_bill->charged;
1651 # just so we have a numeric sort key
1652 $monthorder{$date} ||= $cust_bill->_date;
1654 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1656 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1657 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1660 # service locations: another option for template customization
1662 foreach my $item (@detail_items) {
1663 if ( $item->{locationnum} ) {
1664 $location_info{ $item->{locationnum} } ||= {
1665 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1669 $invoice_data{location_info} = \%location_info;
1671 # debugging hook: call this with 'diag' => 1 to just get a hash of
1672 # the invoice variables
1673 return \%invoice_data if ( $params{'diag'} );
1675 # All sections and items are built; now fill in templates.
1676 my @includelist = ();
1677 push @includelist, 'summary' if $summarypage;
1678 foreach my $include ( @includelist ) {
1680 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1683 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1685 @inc_src = $conf->config($inc_file, $agentnum);
1689 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1691 my $convert_map = $convert_maps{$format}{$include};
1693 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1694 s/--\@\]/$delimiters{$format}[1]/g;
1697 &$convert_map( $conf->config($inc_file, $agentnum) );
1701 my $inc_tt = new Text::Template (
1703 SOURCE => [ map "$_\n", @inc_src ],
1704 DELIMITERS => $delimiters{$format},
1705 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1707 unless ( $inc_tt->compile() ) {
1708 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1709 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1713 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1715 $invoice_data{$include} =~ s/\n+$//
1716 if ($format eq 'latex');
1721 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1722 /invoice_lines\((\d*)\)/;
1723 $invoice_lines += $1 || scalar(@buf);
1726 die "no invoice_lines() functions in template?"
1727 if ( $format eq 'template' && !$wasfunc );
1729 if ( $invoice_lines ) {
1730 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1731 $invoice_data{'total_pages'}++
1732 if scalar(@buf) % $invoice_lines;
1735 #setup subroutine for the template
1736 $invoice_data{invoice_lines} = sub {
1737 my $lines = shift || scalar(@buf);
1746 if ($format eq 'template') {
1751 push @collect, split("\n",
1752 $text_template->fill_in( HASH => \%invoice_data )
1754 $invoice_data{'page'}++;
1756 map "$_\n", @collect;
1758 } else { # this is where we actually create the invoice
1760 if ( $params{no_addresses} ) {
1761 delete $invoice_data{$_} foreach qw(
1762 payname company address1 address2 city state zip country
1764 $invoice_data{returnaddress} = '~';
1767 warn "filling in template for invoice ". $self->invnum. "\n"
1769 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1772 $text_template->fill_in(HASH => \%invoice_data);
1776 sub notice_name { '('.shift->table.')'; }
1778 # this is not supposed to happen
1779 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1783 # helper routine for generating date ranges
1784 sub _prior_month30s {
1787 [ 1, 2592000 ], # 0-30 days ago
1788 [ 2592000, 5184000 ], # 30-60 days ago
1789 [ 5184000, 7776000 ], # 60-90 days ago
1790 [ 7776000, 0 ], # 90+ days ago
1793 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1794 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1799 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1801 Returns an postscript invoice, as a scalar.
1803 Options can be passed as a hashref (recommended) or as a list of time, template
1804 and then any key/value pairs for any other options.
1806 I<time> an optional value used to control the printing of overdue messages. The
1807 default is now. It isn't the date of the invoice; that's the `_date' field.
1808 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1809 L<Time::Local> and L<Date::Parse> for conversion functions.
1811 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1818 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1819 my $ps = generate_ps($file);
1821 unlink($barcodefile) if $barcodefile;
1826 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1828 Returns an PDF invoice, as a scalar.
1830 Options can be passed as a hashref (recommended) or as a list of time, template
1831 and then any key/value pairs for any other options.
1833 I<time> an optional value used to control the printing of overdue messages. The
1834 default is now. It isn't the date of the invoice; that's the `_date' field.
1835 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1836 L<Time::Local> and L<Date::Parse> for conversion functions.
1838 I<template>, if specified, is the name of a suffix for alternate invoices.
1840 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1847 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1848 my $pdf = generate_pdf($file);
1850 unlink($barcodefile) if $barcodefile;
1855 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1857 Returns an HTML invoice, as a scalar.
1859 I<time> an optional value used to control the printing of overdue messages. The
1860 default is now. It isn't the date of the invoice; that's the `_date' field.
1861 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1862 L<Time::Local> and L<Date::Parse> for conversion functions.
1864 I<template>, if specified, is the name of a suffix for alternate invoices.
1866 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1868 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1869 when emailing the invoice as part of a multipart/related MIME email.
1877 %params = %{ shift() };
1881 $params{'format'} = 'html';
1883 $self->print_generic( %params );
1886 # quick subroutine for print_latex
1888 # There are ten characters that LaTeX treats as special characters, which
1889 # means that they do not simply typeset themselves:
1890 # # $ % & ~ _ ^ \ { }
1892 # TeX ignores blanks following an escaped character; if you want a blank (as
1893 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1897 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1898 $value =~ s/([<>])/\$$1\$/g;
1904 encode_entities($value);
1908 sub _html_escape_nbsp {
1909 my $value = _html_escape(shift);
1910 $value =~ s/ +/ /g;
1914 #utility methods for print_*
1916 sub _translate_old_latex_format {
1917 warn "_translate_old_latex_format called\n"
1924 if ( $line =~ /^%%Detail\s*$/ ) {
1926 push @template, q![@--!,
1927 q! foreach my $_tr_line (@detail_items) {!,
1928 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1929 q! $_tr_line->{'description'} .= !,
1930 q! "\\tabularnewline\n~~".!,
1931 q! join( "\\tabularnewline\n~~",!,
1932 q! @{$_tr_line->{'ext_description'}}!,
1936 while ( ( my $line_item_line = shift )
1937 !~ /^%%EndDetail\s*$/ ) {
1938 $line_item_line =~ s/'/\\'/g; # nice LTS
1939 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1940 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1941 push @template, " \$OUT .= '$line_item_line';";
1944 push @template, '}',
1947 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1949 push @template, '[@--',
1950 ' foreach my $_tr_line (@total_items) {';
1952 while ( ( my $total_item_line = shift )
1953 !~ /^%%EndTotalDetails\s*$/ ) {
1954 $total_item_line =~ s/'/\\'/g; # nice LTS
1955 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1956 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1957 push @template, " \$OUT .= '$total_item_line';";
1960 push @template, '}',
1964 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1965 push @template, $line;
1971 warn "$_\n" foreach @template;
1983 my $conf = $self->conf;
1985 #check for an invoice-specific override
1986 return $self->invoice_terms if $self->invoice_terms;
1988 #check for a customer- specific override
1989 my $cust_main = $self->cust_main;
1990 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1994 $agentnum = $cust_main->agentnum;
1995 } elsif ( my $prospect_main = $self->prospect_main ) {
1996 $agentnum = $prospect_main->agentnum;
1999 #use configured default
2000 $conf->config('invoice_default_terms', $agentnum) || '';
2010 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2011 $duedate = $self->_date() + ( $1 * 86400 );
2012 } elsif ( $self->terms =~ /^End of Month$/ ) {
2013 my ($mon,$year) = (localtime($self->_date) )[4,5];
2015 until ( $mon < 12 ) { $mon -= 12; $year++; }
2016 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2017 $duedate = $nextmonth_first - 86400;
2028 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2031 =item balance_due_msg
2035 sub balance_due_msg {
2037 my $msg = $self->mt('Balance Due');
2038 return $msg unless $self->terms; # huh?
2039 if ( !$self->conf->exists('invoice_show_prior_due_date')
2040 || $self->has_sections ) {
2041 # if enabled, the due date is shown with Total New Charges (see
2042 # _items_total) and not here
2043 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2044 if ( $self->due_date ) {
2046 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2047 || 'Please pay by [_1]';
2048 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')).
2050 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2051 } elsif ( $self->terms ) {
2052 $msg .= ' - '. $self->mt($self->terms);
2058 =item balance_due_date
2062 sub balance_due_date {
2064 my $conf = $self->conf;
2066 my $terms = $self->terms;
2067 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2068 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2073 sub credit_balance_msg {
2075 $self->mt('Credit Balance Remaining')
2080 Returns a string with the date, for example: "3/20/2008", localized for the
2081 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2087 $self->time2str_local('short', $self->_date);
2090 =item _date_pretty_unlocalized
2092 Returns a string with the date, for example: "3/20/2008", in the format
2093 configured for the back-office. Use _date_pretty for end-customer display use.
2097 sub _date_pretty_unlocalized {
2099 time2str($date_format, $self->_date);
2104 Emails this template.
2106 Options are passed as a hashref. Available options:
2112 If specified, overrides the default From: address.
2116 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2120 (Deprecated) If specified, is the name of a suffix for alternate template files.
2124 Options accepted by generate_email can also be used.
2130 my $opt = shift || {};
2131 if ($opt and !ref($opt)) {
2132 die ref($self). '->email called with positional parameters';
2135 return if $self->hide;
2137 my $error = send_email(
2138 $self->generate_email(
2139 'subject' => $self->email_subject($opt->{template}),
2140 %$opt, # template, etc.
2144 die "can't email: $error\n" if $error;
2147 =item generate_email OPTION => VALUE ...
2155 sender address, required
2159 alternate template name, optional
2163 email subject, optional
2167 notice name instead of "Invoice", optional
2171 Returns an argument list to be passed to L<FS::Misc::send_email>.
2178 sub generate_email {
2182 my $conf = $self->conf;
2184 my $me = '[FS::Template_Mixin::generate_email]';
2187 'from' => $args{'from'},
2188 'subject' => ($args{'subject'} || $self->email_subject),
2189 'custnum' => $self->custnum,
2190 'msgtype' => 'invoice',
2193 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2195 my $cust_main = $self->cust_main;
2197 if (ref($args{'to'}) eq 'ARRAY') {
2198 $return{'to'} = $args{'to'};
2199 } elsif ( $cust_main ) {
2200 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2203 my $tc = $self->template_conf;
2205 my @text; # array of lines
2206 my $html; # a big string
2207 my @related_parts; # will contain the text/HTML alternative, and images
2208 my $related; # will contain the multipart/related object
2210 if ( $conf->exists($tc. 'email_pdf') ) {
2211 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2213 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2216 my $msg_template = FS::msg_template->by_key($msgnum)
2217 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2218 my $cust_msg = $msg_template->prepare(
2219 cust_main => $self->cust_main,
2221 msgtype => 'invoice',
2224 # XXX hack to make this work in the new cust_msg era; consider replacing
2225 # with cust_bill_send_with_notice events.
2226 my @parts = $cust_msg->parts;
2227 foreach my $part (@parts) { # will only have two parts, normally
2228 if ( $part->mime_type eq 'text/plain' ) {
2229 @text = @{ $part->body };
2230 } elsif ( $part->mime_type eq 'text/html' ) {
2231 $html = $part->bodyhandle->as_string;
2235 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2237 warn "$me using '${tc}email_pdf_note' in multipart message"
2239 @text = $conf->config($tc.'email_pdf_note');
2240 $html = join('<BR>', @text);
2242 } # else use the plain text invoice
2247 if ( $conf->config($tc.'template') ) {
2249 warn "$me generating plain text invoice"
2252 # 'print_text' argument is no longer used
2253 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2257 warn "$me no plain text version exists; sending empty message body"
2264 my $text_part = build MIME::Entity (
2265 'Type' => 'text/plain',
2266 'Encoding' => 'quoted-printable',
2267 'Charset' => 'UTF-8',
2268 #'Encoding' => '7bit',
2270 'Disposition' => 'inline',
2275 if ( $conf->exists($tc.'html') ) {
2276 warn "$me generating HTML invoice"
2279 $args{'from'} =~ /\@([\w\.\-]+)/;
2280 my $from = $1 || 'example.com';
2281 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2284 my $agentnum = $cust_main ? $cust_main->agentnum
2285 : $self->prospect_main->agentnum;
2286 if ( defined($args{'template'}) && length($args{'template'})
2287 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2290 $logo = 'logo_'. $args{'template'}. '.png';
2294 my $image_data = $conf->config_binary( $logo, $agentnum);
2296 push @related_parts, build MIME::Entity
2297 'Type' => 'image/png',
2298 'Encoding' => 'base64',
2299 'Data' => $image_data,
2300 'Filename' => 'logo.png',
2301 'Content-ID' => "<$content_id>",
2304 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2305 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2306 push @related_parts, build MIME::Entity
2307 'Type' => 'image/png',
2308 'Encoding' => 'base64',
2309 'Data' => $self->invoice_barcode(0),
2310 'Filename' => 'barcode.png',
2311 'Content-ID' => "<$barcode_content_id>",
2313 $args{'barcode_cid'} = $barcode_content_id;
2316 $html = $self->print_html({ 'cid'=>$content_id, %args });
2323 warn "$me creating HTML/text multipart message"
2326 $return{'nobody'} = 1;
2328 my $alternative = build MIME::Entity
2329 'Type' => 'multipart/alternative',
2330 #'Encoding' => '7bit',
2331 'Disposition' => 'inline'
2335 $alternative->add_part($text_part);
2338 $alternative->attach(
2339 'Type' => 'text/html',
2340 'Encoding' => 'quoted-printable',
2341 'Data' => [ '<html>',
2344 ' '. encode_entities($return{'subject'}),
2347 ' <body bgcolor="#e8e8e8">',
2348 Encode::encode_utf8($html),
2352 'Disposition' => 'inline',
2353 #'Filename' => 'invoice.pdf',
2356 unshift @related_parts, $alternative;
2358 $related = build MIME::Entity 'Type' => 'multipart/related',
2359 'Encoding' => '7bit';
2361 #false laziness w/Misc::send_email
2362 $related->head->replace('Content-type',
2363 $related->mime_type.
2364 '; boundary="'. $related->head->multipart_boundary. '"'.
2365 '; type=multipart/alternative'
2368 $related->add_part($_) foreach @related_parts;
2372 my @otherparts = ();
2373 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2375 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2377 my $data = join('', map "$_\n",
2378 $self->call_details(prepend_billed_number=>1)
2381 my $zip = new Archive::Zip;
2382 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2383 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2386 my $SH = IO::Scalar->new(\$zipdata);
2387 my $status = $zip->writeToFileHandle($SH);
2388 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2390 push @otherparts, build MIME::Entity
2391 'Type' => 'application/zip',
2392 'Encoding' => 'base64',
2394 'Disposition' => 'attachment',
2395 'Filename' => 'usage-'. $self->invnum. '.zip',
2398 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2400 push @otherparts, build MIME::Entity
2401 'Type' => 'text/csv',
2402 'Encoding' => '7bit',
2403 'Data' => [ map { "$_\n" }
2404 $self->call_details('prepend_billed_number' => 1)
2406 'Disposition' => 'attachment',
2407 'Filename' => 'usage-'. $self->invnum. '.csv',
2414 if ( $conf->exists($tc.'email_pdf') ) {
2419 # multipart/alternative
2425 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2426 push @otherparts, $pdf;
2430 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2432 $return{'mimeparts'} = [ $related, @otherparts ];
2433 $return{'type'} = 'multipart/related'; # of the first part
2435 $return{'mimeparts'} = [ $text_part, @otherparts ];
2436 $return{'type'} = 'text/plain';
2438 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2439 $return{'mimeparts'} = \@related_parts;
2440 $return{'content-type'} = 'multipart/related';
2441 $return{'type'} = 'multipart/alternative';
2442 } else { # no HTML either
2443 $return{'body'} = \@text;
2444 $return{'content-type'} = 'text/plain';
2453 Returns a list suitable for passing to MIME::Entity->build(), representing
2454 this quotation or invoice as PDF attachment.
2461 'Type' => 'application/pdf',
2462 'Encoding' => 'base64',
2463 'Data' => [ $self->print_pdf(@_) ],
2464 'Disposition' => 'attachment',
2465 'Filename' => $self->pdf_filename,
2469 =item postal_mail_fsinc
2471 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2477 use IO::Socket::SSL;
2479 use HTTP::Request::Common qw( POST );
2480 use Cpanel::JSON::XS;
2482 sub postal_mail_fsinc {
2483 my ( $self, %opt ) = @_;
2485 my $url = 'https://ws.freeside.biz/print';
2487 my $cust_main = $self->cust_main;
2488 my $agentnum = $cust_main->agentnum;
2489 my $bill_location = $cust_main->bill_location;
2491 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2492 if $bill_location->country ne 'US';
2494 my $conf = new FS::Conf;
2496 my @company_address = $conf->config('company_address', $agentnum);
2497 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2498 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2499 $company_address1 = $company_address[0];
2500 $company_address2 = $company_address[1];
2502 $company_state = $2;
2504 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2505 $company_address1 = $company_address[0];
2506 $company_address2 = '';
2508 $company_state = $2;
2511 die "Unparsable company_address; contact support\@freeside.biz\n";
2513 $company_city =~ s/,$//;
2515 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2516 my $pages = CAM::PDF->new($file)->numPages;
2518 my $ua = LWP::UserAgent->new(
2520 verify_hostname => 0,
2521 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2522 SSL_version => 'SSLv3',
2525 my $response = $ua->request( POST $url, [
2526 'support-key' => scalar($conf->config('support-key')),
2527 'file' => encode_base64($file),
2531 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2532 'company_address1' => $company_address1,
2533 'company_address2' => $company_address2,
2534 'company_city' => $company_city,
2535 'company_state' => $company_state,
2536 'company_zip' => $company_zip,
2537 'company_country' => 'US',
2538 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2539 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2542 'name' => $cust_main->invoice_attn
2543 || $cust_main->contact_firstlast,
2544 'company' => $cust_main->company,
2545 'address1' => $bill_location->address1,
2546 'address2' => $bill_location->address2,
2547 'city' => $bill_location->city,
2548 'state' => $bill_location->state,
2549 'zip' => $bill_location->zip,
2550 'country' => $bill_location->country,
2553 die "Print connection error: ". $response->message.
2554 ' ('. $response->as_string. ")\n"
2555 unless $response->is_success;
2558 my $content = eval { decode_json($response->content) };
2559 die "Print JSON error : $@\n" if $@;
2561 die $content->{error}."\n"
2562 if $content->{error};
2564 #TODO: store this so we can query for a status later
2565 warn "Invoice printed, ID ". $content->{id}. "\n";
2571 =item _items_sections OPTIONS
2573 Generate section information for all items appearing on this invoice.
2574 This will only be called for multi-section invoices.
2576 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2577 related display records (L<FS::cust_bill_pkg_display>) and organize
2578 them into two groups ("early" and "late" according to whether they come
2579 before or after the total), then into sections. A subtotal is calculated
2582 Section descriptions are returned in sort weight order. Each consists
2583 of a hash containing:
2585 description: the package category name, escaped
2586 subtotal: the total charges in that section
2587 tax_section: a flag indicating that the section contains only tax charges
2588 summarized: same as tax_section, for some reason
2589 sort_weight: the package category's sort weight
2591 If 'condense' is set on the display record, it also contains everything
2592 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2593 coderefs to generate parts of the invoice. This is not advised.
2595 The method returns two arrayrefs, one of "early" sections and one of "late"
2598 OPTIONS may include:
2600 by_location: a flag to divide the invoice into sections by location.
2601 Each section hash will have a 'location' element containing a hashref of
2602 the location fields (see L<FS::cust_location>). The section description
2603 will be the location label, but the template can use any of the location
2604 fields to create a suitable label.
2606 by_category: a flag to divide the invoice into sections using display
2607 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2608 behavior. Each section hash will have a 'category' element containing
2609 the section name from the display record (which probably equals the
2610 category name of the package, but may not in some cases).
2612 summary: a flag indicating that this is a summary-format invoice.
2613 Turning this on has the following effects:
2614 - Ignores display items with the 'summary' flag.
2615 - Places all sections in the "early" group even if they have post_total.
2616 - Creates sections for all non-disabled package categories, even if they
2617 have no charges on this invoice, as well as a section with no name.
2619 escape: an escape function to use for section titles.
2621 extra_sections: an arrayref of additional sections to return after the
2622 sorted list. If there are any of these, section subtotals exclude
2625 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2626 passed through to C<_condense_section()>.
2630 use vars qw(%pkg_category_cache);
2631 sub _items_sections {
2635 my $escape = $opt{escape};
2636 my @extra_sections = @{ $opt{extra_sections} || [] };
2638 # $subtotal{$locationnum}{$categoryname} = amount.
2639 # if we're not using by_location, $locationnum is undef.
2640 # if we're not using by_category, you guessed it, $categoryname is undef.
2641 # if we're not using either one, we shouldn't be here in the first place...
2643 my %late_subtotal = ();
2646 # About tax items + multisection invoices:
2647 # If either invoice_*summary option is enabled, AND there is a
2648 # package category with the name of the tax, then there will be
2649 # a display record assigning the tax item to that category.
2651 # However, the taxes are always placed in the "Taxes, Surcharges,
2652 # and Fees" section regardless of that. The only effect of the
2653 # display record is to create a subtotal for the summary page.
2656 my $pkg_hash = $self->cust_pkg_hash;
2658 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2661 my $usage = $cust_bill_pkg->usage;
2664 if ( $opt{by_location} ) {
2665 if ( $cust_bill_pkg->pkgnum ) {
2666 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2671 $locationnum = undef;
2674 # as in _items_cust_pkg, if a line item has no display records,
2675 # cust_bill_pkg_display() returns a default record for it
2677 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2678 next if ( $display->summary && $opt{summary} );
2680 my $section = $display->section;
2681 my $type = $display->type;
2682 # Set $section = undef if we're sectioning by location and this
2683 # line item _has_ a location (i.e. isn't a fee).
2684 $section = undef if $locationnum;
2686 # set this flag if the section is not tax-only
2687 $not_tax{$locationnum}{$section} = 1
2688 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2690 # there's actually a very important piece of logic buried in here:
2691 # incrementing $late_subtotal{$section} CREATES
2692 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2693 # to define the list of late sections, and likewise keys(%subtotal).
2694 # When _items_cust_bill_pkg is called to generate line items for
2695 # real, it will be called with 'section' => $section for each
2697 if ( $display->post_total && !$opt{summary} ) {
2698 if (! $type || $type eq 'S') {
2699 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2700 if $cust_bill_pkg->setup != 0
2701 || $cust_bill_pkg->setup_show_zero;
2705 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2706 if $cust_bill_pkg->recur != 0
2707 || $cust_bill_pkg->recur_show_zero;
2710 if ($type && $type eq 'R') {
2711 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2712 if $cust_bill_pkg->recur != 0
2713 || $cust_bill_pkg->recur_show_zero;
2716 if ($type && $type eq 'U') {
2717 $late_subtotal{$locationnum}{$section} += $usage
2718 unless scalar(@extra_sections);
2721 } else { # it's a pre-total (normal) section
2723 # skip tax items unless they're explicitly included in a section
2724 next if $cust_bill_pkg->pkgnum == 0 and
2725 ! $cust_bill_pkg->feepart and
2728 if ( $type eq 'S' ) {
2729 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2730 if $cust_bill_pkg->setup != 0
2731 || $cust_bill_pkg->setup_show_zero;
2732 } elsif ( $type eq 'R' ) {
2733 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2734 if $cust_bill_pkg->recur != 0
2735 || $cust_bill_pkg->recur_show_zero;
2736 } elsif ( $type eq 'U' ) {
2737 $subtotal{$locationnum}{$section} += $usage
2738 unless scalar(@extra_sections);
2739 } elsif ( !$type ) {
2740 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2741 + $cust_bill_pkg->recur;
2750 %pkg_category_cache = ();
2752 # summary invoices need subtotals for all non-disabled package categories,
2753 # even if they're zero
2754 # but currently assume that there are no location sections, or at least
2755 # that the summary page doesn't care about them
2756 if ( $opt{summary} ) {
2757 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2758 $subtotal{''}{$category->categoryname} ||= 0;
2760 $subtotal{''}{''} ||= 0;
2764 foreach my $post_total (0,1) {
2766 my $s = $post_total ? \%late_subtotal : \%subtotal;
2767 foreach my $locationnum (keys %$s) {
2768 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2770 'subtotal' => $s->{$locationnum}{$sectionname},
2773 if ( $locationnum ) {
2774 $section->{'locationnum'} = $locationnum;
2775 my $location = FS::cust_location->by_key($locationnum);
2776 $section->{'description'} = &{ $escape }($location->location_label);
2777 # Better ideas? This will roughly group them by proximity,
2778 # which alpha sorting on any of the address fields won't.
2779 # Sorting by locationnum is meaningless.
2780 # We have to sort on _something_ or the order may change
2781 # randomly from one invoice to the next, which will confuse
2783 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2785 $section->{'location'} = {
2786 label_prefix => &{ $escape }($location->label_prefix),
2787 map { $_ => &{ $escape }($location->get($_)) }
2791 $section->{'category'} = $sectionname;
2792 $section->{'description'} = &{ $escape }($sectionname);
2793 if ( _pkg_category($sectionname) ) {
2794 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2795 if ( _pkg_category($sectionname)->condense ) {
2796 $section = { %$section, $self->_condense_section($opt{format}) };
2800 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2801 # then it's a tax-only section
2802 $section->{'summarized'} = 'Y';
2803 $section->{'tax_section'} = 'Y';
2805 push @these, $section;
2806 } # foreach $sectionname
2807 } #foreach $locationnum
2808 push @these, @extra_sections if $post_total == 0;
2809 # need an alpha sort for location sections, because postal codes can
2811 $sections[ $post_total ] = [ sort {
2812 $opt{'by_location'} ?
2813 ($a->{sort_weight} cmp $b->{sort_weight}) :
2814 ($a->{sort_weight} <=> $b->{sort_weight})
2816 } #foreach $post_total
2818 return @sections; # early, late
2821 #helper subs for above
2825 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2829 my $categoryname = shift;
2830 $pkg_category_cache{$categoryname} ||=
2831 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2834 my %condensed_format = (
2835 'label' => [ qw( Description Qty Amount ) ],
2837 sub { shift->{description} },
2838 sub { shift->{quantity} },
2839 sub { my($href, %opt) = @_;
2840 ($opt{dollar} || ''). $href->{amount};
2843 'align' => [ qw( l r r ) ],
2844 'span' => [ qw( 5 1 1 ) ], # unitprices?
2845 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2848 sub _condense_section {
2849 my ( $self, $format ) = ( shift, shift );
2851 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2852 qw( description_generator
2855 total_line_generator
2860 sub _condensed_generator_defaults {
2861 my ( $self, $format ) = ( shift, shift );
2862 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2871 sub _condensed_header_generator {
2872 my ( $self, $format ) = ( shift, shift );
2874 my ( $f, $prefix, $suffix, $separator, $column ) =
2875 _condensed_generator_defaults($format);
2877 if ($format eq 'latex') {
2878 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2879 $suffix = "\\\\\n\\hline";
2882 sub { my ($d,$a,$s,$w) = @_;
2883 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2885 } elsif ( $format eq 'html' ) {
2886 $prefix = '<th></th>';
2890 sub { my ($d,$a,$s,$w) = @_;
2891 return qq!<th align="$html_align{$a}">$d</th>!;
2899 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2901 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2904 $prefix. join($separator, @result). $suffix;
2909 sub _condensed_description_generator {
2910 my ( $self, $format ) = ( shift, shift );
2912 my ( $f, $prefix, $suffix, $separator, $column ) =
2913 _condensed_generator_defaults($format);
2915 my $money_char = '$';
2916 if ($format eq 'latex') {
2917 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2919 $separator = " & \n";
2921 sub { my ($d,$a,$s,$w) = @_;
2922 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2924 $money_char = '\\dollar';
2925 }elsif ( $format eq 'html' ) {
2926 $prefix = '"><td align="center"></td>';
2930 sub { my ($d,$a,$s,$w) = @_;
2931 return qq!<td align="$html_align{$a}">$d</td>!;
2933 #$money_char = $conf->config('money_char') || '$';
2934 $money_char = ''; # this is madness
2942 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2944 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2946 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2947 map { $f->{$_}->[$i] } qw(align span width)
2951 $prefix. join( $separator, @result ). $suffix;
2956 sub _condensed_total_generator {
2957 my ( $self, $format ) = ( shift, shift );
2959 my ( $f, $prefix, $suffix, $separator, $column ) =
2960 _condensed_generator_defaults($format);
2963 if ($format eq 'latex') {
2966 $separator = " & \n";
2968 sub { my ($d,$a,$s,$w) = @_;
2969 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2971 }elsif ( $format eq 'html' ) {
2975 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2977 sub { my ($d,$a,$s,$w) = @_;
2978 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2987 # my $r = &{$f->{fields}->[$i]}(@args);
2988 # $r .= ' Total' unless $i;
2990 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2992 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2993 map { $f->{$_}->[$i] } qw(align span width)
2997 $prefix. join( $separator, @result ). $suffix;
3002 =item total_line_generator FORMAT
3004 Returns a coderef used for generation of invoice total line items for this
3005 usage_class. FORMAT is either html or latex
3009 # should not be used: will have issues with hash element names (description vs
3010 # total_item and amount vs total_amount -- another array of functions?
3012 sub _condensed_total_line_generator {
3013 my ( $self, $format ) = ( shift, shift );
3015 my ( $f, $prefix, $suffix, $separator, $column ) =
3016 _condensed_generator_defaults($format);
3019 if ($format eq 'latex') {
3022 $separator = " & \n";
3024 sub { my ($d,$a,$s,$w) = @_;
3025 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3027 }elsif ( $format eq 'html' ) {
3031 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3033 sub { my ($d,$a,$s,$w) = @_;
3034 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3043 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3045 &{$column}( &{$f->{fields}->[$i]}(@args),
3046 map { $f->{$_}->[$i] } qw(align span width)
3050 $prefix. join( $separator, @result ). $suffix;
3055 =item _items_pkg [ OPTIONS ]
3057 Return line item hashes for each package item on this invoice. Nearly
3060 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3062 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3063 'format' and 'escape_function' at minimum.
3065 To produce items for a specific invoice section, OPTIONS should include
3066 'section', a hashref containing 'category' and/or 'locationnum' keys.
3068 'section' may also contain a key named 'condensed'. If this is present
3069 and has a true value, _items_pkg will try to merge identical items into items
3070 with 'quantity' equal to the number of items (not the sum of their separate
3071 quantities, for some reason).
3077 # The order of these is important. Bundled line items will be merged into
3078 # the most recent non-hidden item, so it needs to be the one with:
3080 # - the same start date
3081 # - no pkgpart_override
3083 # So: sort by pkgnum,
3085 # then sort the base line item before any overrides
3086 # then sort hidden before non-hidden add-ons
3087 # then sort by override pkgpart (for consistency)
3088 sort { $a->pkgnum <=> $b->pkgnum or
3089 $a->sdate <=> $b->sdate or
3090 ($a->pkgpart_override ? 0 : -1) or
3091 ($b->pkgpart_override ? 0 : 1) or
3092 $b->hidden cmp $a->hidden or
3093 $a->pkgpart_override <=> $b->pkgpart_override
3095 # and of course exclude taxes and fees
3096 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3102 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3103 my $escape_function = $options{escape_function};
3106 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3107 # cache this, so we don't look it up again in every section
3108 my $part_fee = $cust_bill_pkg->get('part_fee')
3109 || $cust_bill_pkg->part_fee;
3110 $cust_bill_pkg->set('part_fee', $part_fee);
3112 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3113 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3116 if ( exists($options{section}) and exists($options{section}{category}) )
3118 my $categoryname = $options{section}{category};
3119 # then filter for items that have that section
3120 if ( $part_fee->categoryname ne $categoryname ) {
3121 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3124 } # otherwise include them all in the main section
3125 # XXX what to do when sectioning by location?
3128 my %base_invnums; # invnum => invoice date
3129 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3130 if ($_->base_invnum) {
3131 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3132 my $base_date = $self->time2str_local('short', $base_bill->_date)
3134 $base_invnums{$_->base_invnum} = $base_date || '';
3137 foreach (sort keys(%base_invnums)) {
3138 next if $_ == $self->invnum;
3139 # per convention, we must escape ext_description lines
3141 &{$escape_function}(
3142 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3145 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3146 # but not escape the base description line
3148 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3149 if $options{section_with_taxes};
3152 { feepart => $cust_bill_pkg->feepart,
3153 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3154 description => $desc,
3155 pkg_tax => \@pkg_tax,
3156 ext_description => \@ext_desc
3167 warn "$me _items_pkg searching for all package line items\n"
3170 my @cust_bill_pkg = $self->_items_nontax;
3172 warn "$me _items_pkg filtering line items\n"
3174 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3176 if ($options{section} && $options{section}->{condensed}) {
3178 warn "$me _items_pkg condensing section\n"
3182 local $Storable::canonical = 1;
3183 foreach ( @items ) {
3185 delete $item->{ref};
3186 delete $item->{ext_description};
3187 my $key = freeze($item);
3188 $itemshash{$key} ||= 0;
3189 $itemshash{$key} ++; # += $item->{quantity};
3191 @items = sort { $a->{description} cmp $b->{description} }
3192 map { my $i = thaw($_);
3193 $i->{quantity} = $itemshash{$_};
3195 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3201 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3208 return 0 unless $a->itemdesc cmp $b->itemdesc;
3209 return -1 if $b->itemdesc eq 'Tax';
3210 return 1 if $a->itemdesc eq 'Tax';
3211 return -1 if $b->itemdesc eq 'Other surcharges';
3212 return 1 if $a->itemdesc eq 'Other surcharges';
3213 $a->itemdesc cmp $b->itemdesc;
3218 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3219 $self->cust_bill_pkg;
3220 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3222 if ( $self->conf->exists('always_show_tax') ) {
3223 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3224 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3226 { 'description' => $itemdesc,
3233 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3235 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3236 list of hashrefs describing the line items they generate on the invoice.
3238 OPTIONS may include:
3240 format: the invoice format.
3242 escape_function: the function used to escape strings.
3244 DEPRECATED? (expensive, mostly unused?)
3245 format_function: the function used to format CDRs.
3247 section: a hashref containing 'category' and/or 'locationnum'; if this
3248 is present, only returns line items that belong to that category and/or
3249 location (whichever is defined).
3251 multisection: a flag indicating that this is a multisection invoice,
3252 which does something complicated.
3254 section_with_taxes: Look up and include applied taxes for each record
3256 Returns a list of hashrefs, each of which may contain:
3258 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3259 ext_description, which is an arrayref of detail lines to show below
3264 sub _items_cust_bill_pkg {
3266 my $conf = $self->conf;
3267 my $cust_bill_pkgs = shift;
3270 my $format = $opt{format} || '';
3271 my $escape_function = $opt{escape_function} || sub { shift };
3272 my $format_function = $opt{format_function} || '';
3273 my $no_usage = $opt{no_usage} || '';
3274 my $unsquelched = $opt{unsquelched} || ''; #unused
3275 my ($section, $locationnum, $category);
3276 if ( $opt{section} ) {
3277 $category = $opt{section}->{category};
3278 $locationnum = $opt{section}->{locationnum};
3280 my $summary_page = $opt{summary_page} || ''; #unused
3281 my $multisection = defined($category) || defined($locationnum);
3282 # this variable is the value of the config setting, not whether it applies
3283 # to this particular line item.
3284 my $discount_show_always = $conf->exists('discount-show-always');
3286 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3288 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3290 # for location labels: use default location on the invoice date
3291 my $default_locationnum;
3292 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3293 $default_locationnum = 0; # treat them all as non-default
3294 } elsif ( $self->custnum ) {
3296 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3297 $h_cust_main = qsearchs({
3298 'table' => 'h_cust_main',
3299 'hashref' => { custnum => $self->custnum },
3300 'extra_sql' => $h_search[1],
3301 'addl_from' => $h_search[3],
3303 $default_locationnum = $h_cust_main->ship_locationnum;
3304 } elsif ( $self->prospectnum ) {
3305 my $cust_location = qsearchs('cust_location',
3306 { prospectnum => $self->prospectnum,
3308 $default_locationnum = $cust_location->locationnum if $cust_location;
3311 my @b = (); # accumulator for the line item hashes that we'll return
3312 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3313 # the 'current' line item hashes for setup, recur, usage, discount
3314 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3316 # if the current line item is waiting to go out, and the one we're about
3317 # to start is not bundled, then push out the current one and start a new
3320 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3322 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3323 if ( $_ && !$cust_bill_pkg->hidden ) {
3324 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3325 $_->{amount} =~ s/^\-0\.00$/0.00/;
3326 if (exists($_->{unit_amount})) {
3327 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3330 # we already decided to create this display line; don't reconsider it
3332 # if $_->{amount} != 0
3333 # || $discount_show_always
3334 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3335 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3341 if ( $locationnum ) {
3342 # this is a location section; skip packages that aren't at this
3344 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3345 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3349 # Consider display records for this item to determine if it belongs
3350 # in this section. Note that if there are no display records, there
3351 # will be a default pseudo-record that includes all charge types
3352 # and has no section name.
3353 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3354 ? $cust_bill_pkg->cust_bill_pkg_display
3355 : ( $cust_bill_pkg );
3357 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3358 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3361 if ( defined($category) ) {
3362 # then this is a package category section; process all display records
3363 # that belong to this section.
3364 @cust_bill_pkg_display = grep { $_->section eq $category }
3365 @cust_bill_pkg_display;
3367 # otherwise, process all display records that aren't usage summaries
3368 # (I don't think there should be usage summaries if you aren't using
3369 # category sections, but this is the historical behavior)
3370 @cust_bill_pkg_display = grep { !$_->summary }
3371 @cust_bill_pkg_display;
3374 my $classname = ''; # package class name, will fill in later
3376 foreach my $display (@cust_bill_pkg_display) {
3378 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3379 $display->billpkgdisplaynum. "\n"
3382 my $type = $display->type;
3384 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3385 $desc = substr($desc, 0, $maxlength). '...'
3386 if $format eq 'latex' && length($desc) > $maxlength;
3388 my %details_opt = ( 'format' => $format,
3389 'escape_function' => $escape_function,
3390 'format_function' => $format_function,
3391 'no_usage' => $opt{'no_usage'},
3394 if ( $cust_bill_pkg->pkgnum > 0 ) {
3395 # a "normal" package line item (not a quotation, not a fee, not a tax)
3397 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3400 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3401 my $part_pkg = $cust_pkg->part_pkg;
3403 # which pkgpart to show for display purposes?
3404 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3406 # start/end dates for invoice formats that do nonstandard
3408 my %item_dates = ();
3409 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3410 unless $part_pkg->option('disable_line_item_date_ranges',1);
3412 # not normally used, but pass this to the template anyway
3413 $classname = $part_pkg->classname;
3415 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3416 if $self->conf->exists('invoice_sections_with_taxes');
3418 if ( (!$type || $type eq 'S')
3419 && ( $cust_bill_pkg->setup != 0
3420 || $cust_bill_pkg->setup_show_zero
3421 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3426 warn "$me _items_cust_bill_pkg adding setup\n"
3429 # append the word 'Setup' to the setup line if there's going to be
3430 # a recur line for the same package (i.e. not a one-time charge)
3432 my $description = $desc;
3433 $description .= ' Setup'
3434 if $cust_bill_pkg->recur != 0
3435 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3436 || $cust_bill_pkg->recur_show_zero;
3438 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3440 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3441 # triggered by the recurring charge freq
3443 && $cust_bill_pkg->recur == 0
3444 && ! $cust_bill_pkg->recur_show_zero;
3449 # always pass the svc_label through to the template, even if
3450 # not displaying it as an ext_description
3451 my @svc_labels = map &{$escape_function}($_),
3452 $cust_pkg->h_labels_short($self->_date,
3455 $self->conf->{locale},
3457 $svc_label = $svc_labels[0];
3459 unless ( $cust_pkg->part_pkg->hide_svc_detail
3460 || $cust_bill_pkg->hidden )
3463 push @d, @svc_labels
3464 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3465 # show the location label if it's not the customer's default
3466 # location, and we're not grouping items by location already
3467 if ( $cust_pkg->locationnum != $default_locationnum
3468 and !defined($locationnum) ) {
3469 my $loc = $cust_pkg->location_label;
3470 $loc = substr($loc, 0, $maxlength). '...'
3471 if $format eq 'latex' && length($loc) > $maxlength;
3472 push @d, &{$escape_function}($loc);
3475 } #unless hiding service details
3477 push @d, $cust_bill_pkg->details(%details_opt)
3478 if $cust_bill_pkg->recur == 0;
3480 if ( $cust_bill_pkg->hidden ) {
3481 $s->{amount} += $cust_bill_pkg->setup;
3482 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3483 push @{ $s->{ext_description} }, @d;
3486 billpkgnum => $cust_bill_pkg->billpkgnum,
3488 description => $description,
3489 pkgpart => $pkgpart,
3490 pkgnum => $cust_bill_pkg->pkgnum,
3491 amount => $cust_bill_pkg->setup,
3492 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3493 unit_amount => $cust_bill_pkg->unitsetup,
3494 quantity => $cust_bill_pkg->quantity,
3495 ext_description => \@d,
3496 svc_label => ($svc_label || ''),
3497 locationnum => $cust_pkg->locationnum, # sure, why not?
3498 pkg_tax => \@pkg_tax,
3504 # should we show a recur line?
3505 # if type eq 'S', then NO, because we've been told not to.
3506 # otherwise, show the recur line if:
3507 # - there's a recurring charge
3508 # - or recur_show_zero is on
3509 # - or there's a positive unitrecur (so it's been discounted to zero)
3510 # and discount-show-always is on
3511 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3513 $cust_bill_pkg->recur != 0
3515 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3516 || $cust_bill_pkg->recur_show_zero
3521 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3524 my $is_summary = $display->summary;
3525 my $description = $desc;
3526 if ( $type eq 'U' and defined($r) ) {
3527 # don't just show the same description as the recur line
3528 $description = $self->mt('Usage charges');
3531 my $part_pkg = $cust_pkg->part_pkg;
3533 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3537 my @seconds = (); # for display of usage info
3540 #at least until cust_bill_pkg has "past" ranges in addition to
3541 #the "future" sdate/edate ones... see #3032
3542 my @dates = ( $self->_date );
3543 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3544 push @dates, $prev->sdate if $prev;
3545 push @dates, undef if !$prev;
3547 my @svc_labels = map &{$escape_function}($_),
3548 $cust_pkg->h_labels_short(@dates,
3550 $self->conf->{locale});
3551 $svc_label = $svc_labels[0];
3553 # show service labels, unless...
3554 # the package is set not to display them
3555 unless ( $part_pkg->hide_svc_detail
3556 # or this is a tax-like line item
3557 || $cust_bill_pkg->itemdesc
3558 # or this is a hidden (bundled) line item
3559 || $cust_bill_pkg->hidden
3560 # or this is a usage summary line
3561 || $is_summary && $type && $type eq 'U'
3562 # or this is a usage line and there's a recurring line
3563 # for the package in the same section (which will
3564 # have service labels already)
3565 || ($type eq 'U' and defined($r))
3569 warn "$me _items_cust_bill_pkg adding service details\n"
3572 push @d, @svc_labels
3573 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3574 warn "$me _items_cust_bill_pkg done adding service details\n"
3577 # show the location label if it's not the customer's default
3578 # location, and we're not grouping items by location already
3579 if ( $cust_pkg->locationnum != $default_locationnum
3580 and !defined($locationnum) ) {
3581 my $loc = $cust_pkg->location_label;
3582 $loc = substr($loc, 0, $maxlength). '...'
3583 if $format eq 'latex' && length($loc) > $maxlength;
3584 push @d, &{$escape_function}($loc);
3587 # Display of seconds_since_sqlradacct:
3588 # On the invoice, when processing @detail_items, look for a field
3589 # named 'seconds'. This will contain total seconds for each
3590 # service, in the same order as @ext_description. For services
3591 # that don't support this it will show undef.
3592 if ( $conf->exists('svc_acct-usage_seconds')
3593 and ! $cust_bill_pkg->pkgpart_override ) {
3594 foreach my $cust_svc (
3595 $cust_pkg->h_cust_svc(@dates, 'I')
3598 # eval because not having any part_export_usage exports
3599 # is a fatal error, last_bill/_date because that's how
3600 # sqlradius_hour billing does it
3602 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3604 push @seconds, $sec;
3606 } #if svc_acct-usage_seconds
3608 } # if we are showing service labels
3610 unless ( $is_summary ) {
3611 warn "$me _items_cust_bill_pkg adding details\n"
3614 #instead of omitting details entirely in this case (unwanted side
3615 # effects), just omit CDRs
3616 $details_opt{'no_usage'} = 1
3617 if $type && $type eq 'R';
3619 push @d, $cust_bill_pkg->details(%details_opt);
3622 warn "$me _items_cust_bill_pkg calculating amount\n"
3627 $amount = $cust_bill_pkg->recur;
3628 } elsif ($type eq 'R') {
3629 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3630 } elsif ($type eq 'U') {
3631 $amount = $cust_bill_pkg->usage;
3634 if ( !$type || $type eq 'R' ) {
3636 warn "$me _items_cust_bill_pkg adding recur\n"
3640 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3643 if ( $cust_bill_pkg->hidden ) {
3644 $r->{amount} += $amount;
3645 $r->{unit_amount} += $unit_amount;
3646 push @{ $r->{ext_description} }, @d;
3649 billpkgnum => $cust_bill_pkg->billpkgnum,
3650 description => $description,
3651 pkgpart => $pkgpart,
3652 pkgnum => $cust_bill_pkg->pkgnum,
3654 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3655 unit_amount => $unit_amount,
3656 quantity => $cust_bill_pkg->quantity,
3658 ext_description => \@d,
3659 svc_label => ($svc_label || ''),
3660 locationnum => $cust_pkg->locationnum,
3661 pkg_tax => \@pkg_tax,
3663 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3666 } else { # $type eq 'U'
3668 warn "$me _items_cust_bill_pkg adding usage\n"
3671 if ( $cust_bill_pkg->hidden and defined($u) ) {
3672 # if this is a hidden package and there's already a usage
3673 # line for the bundle, add this package's total amount and
3674 # usage details to it
3675 $u->{amount} += $amount;
3676 push @{ $u->{ext_description} }, @d;
3677 } elsif ( $amount ) {
3678 # create a new usage line
3680 billpkgnum => $cust_bill_pkg->billpkgnum,
3681 description => $description,
3682 pkgpart => $pkgpart,
3683 pkgnum => $cust_bill_pkg->pkgnum,
3686 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3688 ext_description => \@d,
3689 locationnum => $cust_pkg->locationnum,
3690 pkg_tax => \@pkg_tax,
3692 } # else this has no usage, so don't create a usage section
3695 } # recurring or usage with recurring charge
3697 } else { # taxes and fees
3699 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3702 # items of this kind should normally not have sdate/edate.
3704 'description' => $desc,
3705 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3706 + $cust_bill_pkg->recur)
3709 } # if package line item / other line item
3711 # decide whether to show active discounts here
3713 # case 1: we are showing a single line for the package
3715 # case 2: we are showing a setup line for a package that has
3716 # no base recurring fee
3717 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3718 # case 3: we are showing a recur line for a package that has
3719 # a base recurring fee
3720 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3723 my $item_discount = $cust_bill_pkg->_item_discount;
3724 if ( $item_discount ) {
3725 # $item_discount->{amount} is negative
3727 if ( $d and $cust_bill_pkg->hidden ) {
3728 $d->{setup_amount} += $item_discount->{setup_amount};
3729 $d->{recur_amount} += $item_discount->{recur_amount};
3731 $d = $item_discount;
3732 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3735 # update the active line (before the discount) to show the
3736 # original price (whether this is a hidden line or not)
3738 $s->{amount} -= $item_discount->{setup_amount} if $s;
3739 $r->{amount} -= $item_discount->{recur_amount} if $r;
3741 } # if there are any discounts
3742 } # if this is an appropriate place to show discounts
3744 } # foreach $display
3748 # discount amount is internally split up
3750 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3753 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3755 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3756 if exists($_->{amount});
3757 $_->{amount} =~ s/^\-0\.00$/0.00/;
3758 if (exists($_->{unit_amount})) {
3759 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3763 #if $_->{amount} != 0
3764 # || $discount_show_always
3765 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3766 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3770 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3777 =item _items_discounts_avail
3779 Returns an array of line item hashrefs representing available term discounts
3780 for this invoice. This makes the same assumptions that apply to term
3781 discounts in general: that the package is billed monthly, at a flat rate,
3782 with no usage charges. A prorated first month will be handled, as will
3783 a setup fee if the discount is allowed to apply to setup fees.
3787 sub _items_discounts_avail {
3790 #maybe move this method from cust_bill when quotations support discount_plans
3791 return () unless $self->can('discount_plans');
3792 my %plans = $self->discount_plans;
3794 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3795 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3799 my $plan = $plans{$months};
3801 my $term_total = sprintf('%.2f', $plan->discounted_total);
3802 my $percent = sprintf('%.0f',
3803 100 * (1 - $term_total / $plan->base_total) );
3804 my $permonth = sprintf('%.2f', $term_total / $months);
3805 my $detail = $self->mt('discount on item'). ' '.
3806 join(', ', map { "#$_" } $plan->pkgnums)
3809 # discounts for non-integer months don't work anyway
3810 $months = sprintf("%d", $months);
3813 description => $self->mt('Save [_1]% by paying for [_2] months',
3815 amount => $self->mt('[_1] ([_2] per month)',
3816 $term_total, $money_char.$permonth),
3817 ext_description => ($detail || ''),
3820 sort { $b <=> $a } keys %plans;
3824 =item has_sections AGENTNUM
3826 Return true if invoice_sections should be enabled for this bill.
3827 (Inherited by both cust_bill and cust_bill_void)
3830 * False if not an invoice
3831 * True always if conf invoice_sections is enabled
3832 * True always if sections_by_location is enabled
3833 * True if conf invoice_sections_multilocation > 1,
3834 and location_count >= invoice_sections_multilocation
3840 my ($self, $agentnum) = @_;
3842 return 0 unless $self->invnum > 0;
3844 $agentnum ||= $self->agentnum;
3845 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3846 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3848 my $location_min = $self->conf->config(
3849 'invoice_sections_multilocation', $agentnum,
3854 && $self->location_count >= $location_min;
3860 =item location_count
3862 Return the number of locations billed on this invoice
3866 sub location_count {
3868 return 0 unless $self->invnum;
3870 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3871 # FROM cust_bill_pkg
3872 # LEFT JOIN cust_pkg USING (pkgnum)
3873 # WHERE invnum = 278
3874 # AND cust_bill_pkg.pkgnum > 0
3876 my $result = qsearchs({
3877 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3878 table => 'cust_bill_pkg',
3879 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3880 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3881 . ' AND cust_bill_pkg.pkgnum > 0'
3883 ref $result ? $result->location_count : 0;