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 Text::Template 1.20;
15 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
20 use FS::Misc qw( send_email );
21 use FS::Record qw( qsearch qsearchs );
23 use FS::Misc qw( generate_ps generate_pdf );
30 $me = '[FS::Template_Mixin]';
31 FS::UID->install_callback( sub {
32 my $conf = new FS::Conf; #global
33 $money_char = $conf->config('money_char') || '$';
34 $date_format = $conf->config('date_format') || '%x'; #/YY
39 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
41 If the "mode" pseudo-field is set on the object, the configuration handle
42 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
49 my $mode = $self->get('mode');
50 if ($self->{_conf} and !defined($mode)) {
51 return $self->{_conf};
54 my $cust_main = $self->cust_main;
55 my $locale = $cust_main ? $cust_main->locale : '';
58 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
59 $mode = $mode->modenum;
60 } elsif ( $mode =~ /\D/ ) {
61 die "invalid invoice mode $mode";
63 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
65 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
66 # it doesn't have a locale, but system conf still might
67 $conf->set('locale' => $locale) if $conf;
70 # if $mode is unspecified, or if there is no invoice_conf matching this mode
71 # and locale, then use the system config only (but with the locale)
72 $conf ||= FS::Conf->new({ 'locale' => $locale });
74 return $self->{_conf} = $conf;
77 =item print_text OPTIONS
79 Returns an text invoice, as a list of lines.
81 Options can be passed as a hash.
83 I<time>, if specified, is used to control the printing of overdue messages. The
84 default is now. It isn't the date of the invoice; that's the `_date' field.
85 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
86 L<Time::Local> and L<Date::Parse> for conversion functions.
88 I<template>, if specified, is the name of a suffix for alternate invoices.
90 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
98 %params = %{ shift() };
103 $params{'format'} = 'template'; # for some reason
105 $self->print_generic( %params );
108 =item print_latex HASHREF
110 Internal method - returns a filename of a filled-in LaTeX template for this
111 invoice (Note: add ".tex" to get the actual filename), and a filename of
112 an associated logo (with the .eps extension included).
114 See print_ps and print_pdf for methods that return PostScript and PDF output.
116 Options can be passed as a hash.
118 I<time>, if specified, is used to control the printing of overdue messages. The
119 default is now. It isn't the date of the invoice; that's the `_date' field.
120 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
121 L<Time::Local> and L<Date::Parse> for conversion functions.
123 I<template>, if specified, is the name of a suffix for alternate invoices.
124 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
125 customize invoice templates for different purposes.
127 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
136 %params = %{ shift() };
141 $params{'format'} = 'latex';
142 my $conf = $self->conf;
144 # this needs to go away
145 my $template = $params{'template'};
146 # and this especially
147 $template ||= $self->_agent_template
148 if $self->can('_agent_template');
151 $self->set('mode', $params{mode})
154 my $pkey = $self->primary_key;
155 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
157 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
158 my $lh = new File::Temp(
159 TEMPLATE => $tmp_template,
163 ) or die "can't open temp file: $!\n";
165 my $agentnum = $self->agentnum;
167 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
168 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
169 or die "can't write temp file: $!\n";
171 print $lh $conf->config_binary('logo.eps', $agentnum)
172 or die "can't write temp file: $!\n";
175 $params{'logo_file'} = $lh->filename;
177 if( $conf->exists('invoice-barcode')
178 && $self->can('invoice_barcode')
179 && $self->invnum ) { # don't try to barcode statements
180 my $png_file = $self->invoice_barcode($dir);
181 my $eps_file = $png_file;
182 $eps_file =~ s/\.png$/.eps/g;
183 $png_file =~ /(barcode.*png)/;
185 $eps_file =~ /(barcode.*eps)/;
188 my $curr_dir = cwd();
190 # after painfuly long experimentation, it was determined that sam2p won't
191 # accept : and other chars in the path, no matter how hard I tried to
192 # escape them, hence the chdir (and chdir back, just to be safe)
193 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
194 or die "sam2p failed: $!\n";
198 $params{'barcode_file'} = $eps_file;
201 my @filled_in = $self->print_generic( %params );
203 my $fh = new File::Temp( TEMPLATE => $tmp_template,
207 ) or die "can't open temp file: $!\n";
208 binmode($fh, ':utf8'); # language support
209 print $fh join('', @filled_in );
212 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
213 return ($1, $params{'logo_file'}, $params{'barcode_file'});
219 my $cust_main = $self->cust_main;
220 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
223 =item print_generic OPTION => VALUE ...
225 Internal method - returns a filled-in template for this invoice as a scalar.
227 See print_ps and print_pdf for methods that return PostScript and PDF output.
235 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
245 Overrides "Invoice" as the name of the sent document.
249 Used to control the printing of overdue messages. The
250 default is now. It isn't the date of the invoice; that's the `_date' field.
251 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
252 L<Time::Local> and L<Date::Parse> for conversion functions.
256 Logo file (path to temporary EPS file on the local filesystem)
260 CID for inline (emailed) images (logo)
264 Override customer's locale
268 Overrides any per customer cdr squelching when true
272 Supress the (invoice, quotation, statement, etc.) number
280 Supress the payment coupon
284 Barcode file (path to temporary EPS file on the local filesystem)
288 Flag indicating the barcode image should be a link (normal HTML dipaly)
292 Barcode CID for inline (emailed) images
294 =item preref_callback
296 Coderef run for each line item, code should return HTML to be displayed
297 before that line item (quotations only)
301 Dprecated. Used as a suffix for a configuration template. Please
302 don't use this, it deprecated in favor of more flexible alternatives.
308 #what's with all the sprintf('%10.2f')'s in here? will it cause any
309 # (alignment in text invoice?) problems to change them all to '%.2f' ?
310 # yes: fixed width/plain text printing will be borked
312 my( $self, %params ) = @_;
313 my $conf = $self->conf;
315 my $today = $params{today} ? $params{today} : time;
316 warn "$me print_generic called on $self with suffix $params{template}\n"
319 my $format = $params{format};
320 die "Unknown format: $format"
321 unless $format =~ /^(latex|html|template)$/;
323 my $cust_main = $self->cust_main || $self->prospect_main;
324 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
325 unless $cust_main->payname
326 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
328 my $locale = $params{'locale'} || $cust_main->locale;
330 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
331 'html' => [ '<%=', '%>' ],
332 'template' => [ '{', '}' ],
335 warn "$me print_generic creating template\n"
338 # set the notice name here, and nowhere else.
339 my $notice_name = $params{notice_name}
340 || $conf->config('notice_name')
341 || $self->notice_name;
344 my $template = $params{template} ? $params{template} : $self->_agent_template;
345 my $templatefile = $self->template_conf. $format;
346 $templatefile .= "_$template"
347 if length($template) && $conf->exists($templatefile."_$template");
350 my @invoice_template = map "$_\n", $conf->config($templatefile)
351 or die "cannot load config data $templatefile";
353 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
354 #change this to a die when the old code is removed
355 # it's been almost ten years, changing it to a die on the next release.
356 warn "old-style invoice template $templatefile; ".
357 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
358 #$old_latex = 'true';
359 #@invoice_template = _translate_old_latex_format(@invoice_template);
362 warn "$me print_generic creating T:T object\n"
365 my $text_template = new Text::Template(
367 SOURCE => \@invoice_template,
368 DELIMITERS => $delimiters{$format},
371 warn "$me print_generic compiling T:T object\n"
374 $text_template->compile()
375 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
378 # additional substitution could possibly cause breakage in existing templates
381 'notes' => sub { map "$_", @_ },
382 'footer' => sub { map "$_", @_ },
383 'smallfooter' => sub { map "$_", @_ },
384 'returnaddress' => sub { map "$_", @_ },
385 'coupon' => sub { map "$_", @_ },
386 'summary' => sub { map "$_", @_ },
392 s/%%(.*)$/<!-- $1 -->/g;
393 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
394 s/\\begin\{enumerate\}/<ol>/g;
396 s/\\end\{enumerate\}/<\/ol>/g;
397 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
408 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
414 s/\\hyphenation\{[\w\s\-]+}//;
419 'coupon' => sub { "" },
420 'summary' => sub { "" },
427 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
428 s/\\begin\{enumerate\}//g;
430 s/\\end\{enumerate\}//g;
431 s/\\textbf\{(.*)\}/$1/g;
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
445 s/\\\\\*?\s*$/\n/; # dubious
446 s/\\hyphenation\{[\w\s\-]+}//;
450 'coupon' => sub { "" },
451 'summary' => sub { "" },
456 # hashes for differing output formats
457 my %nbsps = ( 'latex' => '~',
458 'html' => '', # '&nbps;' would be nice
459 'template' => '', # not used
461 my $nbsp = $nbsps{$format};
463 my %escape_functions = ( 'latex' => \&_latex_escape,
464 'html' => \&_html_escape_nbsp,#\&encode_entities,
465 'template' => sub { shift },
467 my $escape_function = $escape_functions{$format};
468 my $escape_function_nonbsp = ($format eq 'html')
469 ? \&_html_escape : $escape_function;
471 my %newline_tokens = ( 'latex' => '\\\\',
475 my $newline_token = $newline_tokens{$format};
477 warn "$me generating template variables\n"
480 # generate template variables
484 defined( $conf->config_orbase( "invoice_${format}returnaddress",
488 && length( $conf->config_orbase( "invoice_${format}returnaddress",
494 $returnaddress = join("\n",
495 $conf->config_orbase("invoice_${format}returnaddress", $template)
499 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
501 my $convert_map = $convert_maps{$format}{'returnaddress'};
504 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
509 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
511 my $convert_map = $convert_maps{$format}{'returnaddress'};
512 $returnaddress = join( "\n", &$convert_map(
513 map { s/( {2,})/'~' x length($1)/eg;
517 ( $conf->config('company_name', $cust_main->agentnum),
518 $conf->config('company_address', $cust_main->agentnum),
525 my $warning = "Couldn't find a return address; ".
526 "do you need to set the company_address configuration value?";
528 $returnaddress = $nbsp;
529 #$returnaddress = $warning;
533 warn "$me generating invoice data\n"
536 my $agentnum = $cust_main->agentnum;
541 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
542 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
543 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
544 'returnaddress' => $returnaddress,
545 'agent' => &$escape_function($cust_main->agent->agent),
547 #invoice/quotation info
548 'no_number' => $params{'no_number'},
549 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
550 'quotationnum' => $self->quotationnum,
551 'no_date' => $params{'no_date'},
552 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
553 # workaround for inconsistent behavior in the early plain text
554 # templates; see RT#28271
555 'date' => ( $params{'no_date'}
557 : ($format eq 'template'
559 : $self->time2str_local('long', $self->_date, $format)
562 'today' => $self->time2str_local('long', $today, $format),
563 'terms' => $self->terms,
564 'template' => $template, #params{'template'},
565 'notice_name' => $notice_name, # escape?
566 'current_charges' => sprintf("%.2f", $self->charged),
567 'duedate' => $self->due_date2str('rdate'), #date_format?
570 'custnum' => $cust_main->display_custnum,
571 'prospectnum' => $cust_main->prospectnum,
572 'agent_custid' => &$escape_function($cust_main->agent_custid),
573 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
574 payname company address1 address2 city state zip fax
578 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
579 'unitprices' => $conf->exists('invoice-unitprice'),
580 'smallernotes' => $conf->exists('invoice-smallernotes'),
581 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
582 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
584 #layout info -- would be fancy to calc some of this and bury the template
586 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
587 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
588 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
589 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
590 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
591 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
592 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
593 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
594 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
595 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
597 # better hang on to conf_dir for a while (for old templates)
598 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
600 #these are only used when doing paged plaintext
607 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
608 # prototype here to silence warnings
609 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
611 my $min_sdate = 999999999999;
613 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
614 next unless $cust_bill_pkg->pkgnum > 0;
615 $min_sdate = $cust_bill_pkg->sdate
616 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
617 $max_edate = $cust_bill_pkg->edate
618 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
621 $invoice_data{'bill_period'} = '';
622 $invoice_data{'bill_period'} =
623 $self->time2str_local('%e %h', $min_sdate, $format)
625 $self->time2str_local('%e %h', $max_edate, $format)
626 if ($max_edate != 0 && $min_sdate != 999999999999);
628 $invoice_data{finance_section} = '';
629 if ( $conf->config('finance_pkgclass') ) {
631 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
632 $invoice_data{finance_section} = $pkg_class->categoryname;
634 $invoice_data{finance_amount} = '0.00';
635 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
637 my $countrydefault = $conf->config('countrydefault') || 'US';
638 foreach ( qw( address1 address2 city state zip country fax) ){
639 my $method = 'ship_'.$_;
640 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
642 if ( length($cust_main->ship_company) ) {
643 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
645 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
647 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
648 $invoice_data{'ship_country'} = ''
649 if ( $invoice_data{'ship_country'} eq $countrydefault );
651 $invoice_data{'cid'} = $params{'cid'}
654 if ( $cust_main->country eq $countrydefault ) {
655 $invoice_data{'country'} = '';
657 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
661 $invoice_data{'address'} = \@address;
664 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
665 ? " (P.O. #". $cust_main->payinfo. ")"
669 push @address, $cust_main->company
670 if $cust_main->company;
671 push @address, $cust_main->address1;
672 push @address, $cust_main->address2
673 if $cust_main->address2;
675 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
676 push @address, $invoice_data{'country'}
677 if $invoice_data{'country'};
679 while (scalar(@address) < 5);
681 $invoice_data{'logo_file'} = $params{'logo_file'}
682 if $params{'logo_file'};
683 $invoice_data{'barcode_file'} = $params{'barcode_file'}
684 if $params{'barcode_file'};
685 $invoice_data{'barcode_img'} = $params{'barcode_img'}
686 if $params{'barcode_img'};
687 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
688 if $params{'barcode_cid'};
690 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
691 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
692 #my $balance_due = $self->owed + $pr_total - $cr_total;
693 my $balance_due = $self->owed;
694 if ( $self->enable_previous ) {
695 $balance_due += $pr_total;
697 # otherwise the previous balance is not shown, so including it in the
698 # balance due is just confusing
700 # the sum of amount owed on all invoices
701 # (this is used in the summary & on the payment coupon)
702 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
704 # flag telling this invoice to have a first-page summary
705 my $summarypage = '';
707 if ( $self->custnum && $self->invnum ) {
708 # XXX should be an FS::cust_bill method to set the defaults, instead
709 # of checking the type here
711 # info from customer's last invoice before this one, for some
713 $invoice_data{'last_bill'} = {};
715 my $last_bill = $self->previous_bill;
718 # "balance_date_range" unfortunately is unsuitable for this, since it
719 # cares about application dates. We want to know the sum of all
720 # _top-level transactions_ dated before the last invoice.
722 # still do this for the "Previous Balance" line of the summary block
724 map "$_ WHERE _date <= ? AND custnum = ?", (
725 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
726 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
727 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
728 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
731 # the customer's current balance immediately after generating the last
734 my $last_bill_balance = $last_bill->charged;
736 my $delta = FS::Record->scalar_sql(
738 $last_bill->_date - 1,
741 $last_bill_balance += $delta;
744 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
746 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
748 $self->time2str_local('%D', $last_bill->_date),
751 # ("true_previous_balance" is a terrible name, but at least it's no
752 # longer stored in the database)
753 $invoice_data{'true_previous_balance'} = $last_bill_balance;
755 # Now, get all applications of credits/payments dated on or after the
756 # previous bill, to invoices before the current bill. (The
757 # credit/payment date restriction prevents these from intersecting
758 # the "Previous Balance" set.)
759 # These are "adjustments". The past due balance will be shown as
760 # Previous Balance - Adjustments.
763 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
764 WHERE cust_bill._date < ?
766 AND cust_bill.custnum = ?"
767 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
768 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
771 my $delta = FS::Record->scalar_sql(
777 $adjustments += $delta;
779 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
781 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
782 $invoice_data{'balance_adjustments'}
785 # the sum of amount owed on all previous invoices
786 # ($pr_total is used elsewhere but not as $previous_balance)
787 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
789 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
790 my (@payments, @credits);
791 # for formats that itemize previous payments
792 foreach my $cust_pay ( qsearch('cust_pay', {
793 'custnum' => $self->custnum,
794 '_date' => { op => '>=',
795 value => $last_bill->_date }
798 next if $cust_pay->_date > $self->_date;
800 '_date' => $cust_pay->_date,
801 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
802 'payinfo' => $cust_pay->payby_payinfo_pretty,
803 'amount' => sprintf('%.2f', $cust_pay->paid),
805 # not concerned about applications
807 foreach my $cust_credit ( qsearch('cust_credit', {
808 'custnum' => $self->custnum,
809 '_date' => { op => '>=',
810 value => $last_bill->_date }
813 next if $cust_credit->_date > $self->_date;
815 '_date' => $cust_credit->_date,
816 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
817 'creditreason'=> $cust_credit->reason,
818 'amount' => sprintf('%.2f', $cust_credit->amount),
821 $invoice_data{'previous_payments'} = \@payments;
822 $invoice_data{'previous_credits'} = \@credits;
824 # there is no $last_bill
825 $invoice_data{'true_previous_balance'} =
826 $invoice_data{'balance_adjustments'} =
827 $invoice_data{'previous_balance'} = '0.00';
828 $invoice_data{'previous_payments'} = [];
829 $invoice_data{'previous_credits'} = [];
832 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
833 $invoice_data{'summarypage'} = $summarypage = 1;
836 } # if this is an invoice
838 warn "$me substituting variables in notes, footer, smallfooter\n"
841 my $tc = $self->template_conf;
842 my @include = ( [ $tc, 'notes' ],
843 [ 'invoice_', 'footer' ],
844 [ 'invoice_', 'smallfooter', ],
845 [ 'invoice_', 'watermark' ],
847 push @include, [ $tc, 'coupon', ]
848 unless $params{'no_coupon'};
850 foreach my $i (@include) {
852 # load the configuration for this sub-template
854 my($base, $include) = @$i;
856 my $inc_file = $conf->key_orbase("$base$format$include", $template);
858 my @inc_src = $conf->config($inc_file, $agentnum);
860 my $converter = $convert_maps{$format}{$include};
862 # then attempt to convert LaTeX to the requested format
863 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
864 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
866 # this isn't included in the convert_maps
867 my ($open, $close) = @{ $delimiters{$format} };
872 } # else @inc_src is empty and that's fine
874 # make a Text::Template out of it
876 my $inc_tt = new Text::Template (
878 SOURCE => [ map "$_\n", @inc_src ],
879 DELIMITERS => $delimiters{$format},
880 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
882 unless ( $inc_tt->compile() ) {
883 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
884 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
890 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
892 $invoice_data{$include} =~ s/\n+$//
893 if ($format eq 'latex');
896 # let invoices use either of these as needed
897 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
898 ? $cust_main->payinfo : '';
899 $invoice_data{'po_line'} =
900 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
901 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
904 my %money_chars = ( 'latex' => '',
905 'html' => $conf->config('money_char') || '$',
908 my $money_char = $money_chars{$format};
911 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
912 'html' => $conf->config('money_char') || '$',
915 my $other_money_char = $other_money_chars{$format};
916 $invoice_data{'dollar'} = $other_money_char;
918 my %minus_signs = ( 'latex' => '$-$',
920 'template' => '- ' );
921 my $minus = $minus_signs{$format};
923 my @detail_items = ();
924 my @total_items = ();
928 $invoice_data{'detail_items'} = \@detail_items;
929 $invoice_data{'total_items'} = \@total_items;
930 $invoice_data{'buf'} = \@buf;
931 $invoice_data{'sections'} = \@sections;
933 warn "$me generating sections\n"
936 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
937 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
938 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
939 $invoice_data{'multisection'} = $multisection;
941 my $extra_sections = [];
942 my $extra_lines = ();
944 # default section ('Charges')
945 my $default_section = { 'description' => '',
950 # Previous Charges section
951 # subtotal is the first return value from $self->previous
952 my $previous_section;
953 # if the invoice has major sections, or if we're summarizing previous
954 # charges with a single line, or if we've been specifically told to put them
955 # in a section, create a section for previous charges:
956 if ( $multisection or
957 $conf->exists('previous_balance-summary_only') or
958 $conf->exists('previous_balance-section') ) {
960 $previous_section = { 'description' => $self->mt('Previous Charges'),
961 'subtotal' => $other_money_char.
962 sprintf('%.2f', $pr_total),
963 'summarized' => '', #why? $summarypage ? 'Y' : '',
965 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
966 join(' / ', map { $cust_main->balance_date_range(@$_) }
967 $self->_prior_month30s
969 if $conf->exists('invoice_include_aging');
972 # otherwise put them in the main section
973 $previous_section = $default_section;
976 my $adjust_section = {
977 'description' => $self->mt('Credits, Payments, and Adjustments'),
978 'adjust_section' => 1,
979 'subtotal' => 0, # adjusted below
981 my $adjust_weight = _pkg_category($adjust_section->{description})
982 ? _pkg_category($adjust_section->{description})->weight
984 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
985 # Note: 'sort_weight' here is actually a flag telling whether there is an
986 # explicit package category for the adjust section. If so, certain behavior
988 $adjust_section->{'sort_weight'} = $adjust_weight;
991 if ( $multisection ) {
992 ($extra_sections, $extra_lines) =
993 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
994 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
995 && $self->can('_items_extra_usage_sections');
997 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
999 push @detail_items, @$extra_lines if $extra_lines;
1001 # the code is written so that both methods can be used together, but
1002 # we haven't yet changed the template to take advantage of that, so for
1003 # now, treat them as mutually exclusive.
1004 my %section_method = ( by_category => 1 );
1005 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1006 %section_method = ( by_location => 1 );
1008 my ($early, $late) =
1009 $self->_items_sections( 'summary' => $summarypage,
1010 'escape' => $escape_function_nonbsp,
1011 'extra_sections' => $extra_sections,
1012 'format' => $format,
1015 push @sections, @$early;
1016 $late_sections = $late;
1018 if ( $conf->exists('svc_phone_sections')
1019 && $self->can('_items_svc_phone_sections')
1022 my ($phone_sections, $phone_lines) =
1023 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1024 push @{$late_sections}, @$phone_sections;
1025 push @detail_items, @$phone_lines;
1027 if ( $conf->exists('voip-cust_accountcode_cdr')
1028 && $cust_main->accountcode_cdr
1029 && $self->can('_items_accountcode_cdr')
1032 my ($accountcode_section, $accountcode_lines) =
1033 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1034 if ( scalar(@$accountcode_lines) ) {
1035 push @{$late_sections}, $accountcode_section;
1036 push @detail_items, @$accountcode_lines;
1039 } else {# not multisection
1040 # make a default section
1041 push @sections, $default_section;
1042 # and calculate the finance charge total, since it won't get done otherwise.
1043 # and the default section total
1044 # XXX possibly finance_pkgclass should not be used in this manner?
1045 my @finance_charges;
1047 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1048 if ( $invoice_data{finance_section} and
1049 grep { $_->section eq $invoice_data{finance_section} }
1050 $cust_bill_pkg->cust_bill_pkg_display ) {
1051 # I think these are always setup fees, but just to be sure...
1052 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1054 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1057 $invoice_data{finance_amount} =
1058 sprintf('%.2f', sum( @finance_charges ) || 0);
1059 $default_section->{subtotal} = $other_money_char.
1060 sprintf('%.2f', sum( @charges ) || 0);
1063 # start setting up summary subtotals
1064 my @summary_subtotals;
1065 my $method = $conf->config('summary_subtotals_method');
1066 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1067 # then re-section them by the correct method
1068 my %section_method = ( by_category => 1 );
1069 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1070 %section_method = ( by_location => 1 );
1072 my ($early, $late) =
1073 $self->_items_sections( 'summary' => $summarypage,
1074 'escape' => $escape_function_nonbsp,
1075 'extra_sections' => $extra_sections,
1076 'format' => $format,
1079 foreach ( @$early ) {
1080 next if $_->{subtotal} == 0;
1081 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1082 push @summary_subtotals, $_;
1085 # subtotal sectioning is the same as for the actual invoice sections
1086 @summary_subtotals = @sections;
1089 # Hereafter, push sections to both @sections and @summary_subtotals
1090 # if they belong in both places (e.g. tax section). Late sections are
1091 # never in @summary_subtotals.
1093 # previous invoice balances in the Previous Charges section if there
1094 # is one, otherwise in the main detail section
1095 # (except if summary_only is enabled, don't show them at all)
1096 if ( $self->can('_items_previous') &&
1097 $self->enable_previous &&
1098 ! $conf->exists('previous_balance-summary_only') ) {
1100 warn "$me adding previous balances\n"
1103 foreach my $line_item ( $self->_items_previous ) {
1106 ref => $line_item->{'pkgnum'},
1107 pkgpart => $line_item->{'pkgpart'},
1108 #quantity => 1, # not really correct
1109 section => $previous_section, # which might be $default_section
1110 description => &$escape_function($line_item->{'description'}),
1111 ext_description => [ map { &$escape_function($_) }
1112 @{ $line_item->{'ext_description'} || [] }
1114 amount => $money_char . $line_item->{'amount'},
1115 product_code => $line_item->{'pkgpart'} || 'N/A',
1118 push @detail_items, $detail;
1119 push @buf, [ $detail->{'description'},
1120 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1126 if ( @pr_cust_bill && $self->enable_previous ) {
1127 push @buf, ['','-----------'];
1128 push @buf, [ $self->mt('Total Previous Balance'),
1129 $money_char. sprintf("%10.2f", $pr_total) ];
1133 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1134 warn "$me adding DID summary\n"
1137 my ($didsummary,$minutes) = $self->_did_summary;
1138 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1140 { 'description' => $didsummary_desc,
1141 'ext_description' => [ $didsummary, $minutes ],
1145 foreach my $section (@sections, @$late_sections) {
1147 # begin some normalization
1148 $section->{'subtotal'} = $section->{'amount'}
1150 && !exists($section->{subtotal})
1151 && exists($section->{amount});
1153 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1154 if ( $invoice_data{finance_section} &&
1155 $section->{'description'} eq $invoice_data{finance_section} );
1157 $section->{'subtotal'} = $other_money_char.
1158 sprintf('%.2f', $section->{'subtotal'})
1161 # continue some normalization
1162 $section->{'amount'} = $section->{'subtotal'}
1166 if ( $section->{'description'} ) {
1167 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1172 warn "$me setting options\n"
1176 $options{'section'} = $section if $multisection;
1177 $options{'format'} = $format;
1178 $options{'escape_function'} = $escape_function;
1179 $options{'no_usage'} = 1 unless $unsquelched;
1180 $options{'unsquelched'} = $unsquelched;
1181 $options{'summary_page'} = $summarypage;
1182 $options{'skip_usage'} =
1183 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1184 $options{'preref_callback'} = $params{'preref_callback'};
1186 warn "$me searching for line items\n"
1189 foreach my $line_item ( $self->_items_pkg(%options),
1190 $self->_items_fee(%options) ) {
1192 warn "$me adding line item ".
1193 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1196 push @buf, ( [ $line_item->{'description'},
1197 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1199 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1202 $line_item->{'ref'} = $line_item->{'pkgnum'};
1203 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1204 $line_item->{'section'} = $section;
1205 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1206 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1208 if ( length($line_item->{'unit_amount'}) ) {
1209 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1211 $line_item->{'ext_description'} ||= [];
1213 push @detail_items, $line_item;
1216 if ( $section->{'description'} ) {
1217 push @buf, ( ['','-----------'],
1218 [ $section->{'description'}. ' sub-total',
1219 $section->{'subtotal'} # already formatted this
1228 $invoice_data{current_less_finance} =
1229 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1231 # if there's anything in the Previous Charges section, prepend it to the list
1232 if ( $pr_total and $previous_section ne $default_section ) {
1233 unshift @sections, $previous_section;
1234 # but not @summary_subtotals
1237 warn "$me adding taxes\n"
1240 # create a tax section if we don't yet have one
1241 my $tax_description = 'Taxes, Surcharges, and Fees';
1243 List::Util::first { $_->{description} eq $tax_description } @sections;
1244 if (!$tax_section) {
1245 $tax_section = { 'description' => $tax_description };
1246 push @sections, $tax_section if $multisection;
1248 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1249 # if this is an existing tax section, we're merging the tax items into it.
1250 # grab the taxtotal that's already there, strip the money symbol if any
1251 my $taxtotal = $tax_section->{'subtotal'} || 0;
1252 $taxtotal =~ s/^\Q$other_money_char\E//;
1255 #my $tax_weight = _pkg_category($tax_section->{description})
1256 # ? _pkg_category($tax_section->{description})->weight
1258 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1259 #$tax_section->{'sort_weight'} = $tax_weight;
1261 my @items_tax = $self->_items_tax;
1262 foreach my $tax ( @items_tax ) {
1264 $taxtotal += $tax->{'amount'};
1266 my $description = &$escape_function( $tax->{'description'} );
1267 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1269 if ( $multisection ) {
1271 push @detail_items, {
1272 ext_description => [],
1275 description => $description,
1276 amount => $money_char. $amount,
1278 section => $tax_section,
1283 push @total_items, {
1284 'total_item' => $description,
1285 'total_amount' => $other_money_char. $amount,
1290 push @buf,[ $description,
1291 $money_char. $amount,
1298 $total->{'total_item'} = $self->mt('Sub-total');
1299 $total->{'total_amount'} =
1300 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1302 if ( $multisection ) {
1303 if ( $taxtotal > 0 ) {
1304 # there are taxes, so prepare the section to be displayed.
1305 # $taxtotal already includes any line items that were already in the
1306 # section (fees, taxes that are charged as packages for some reason).
1307 # also set 'summarized' to false so that this isn't a summary-only
1309 $tax_section->{'subtotal'} = $other_money_char.
1310 sprintf('%.2f', $taxtotal);
1311 $tax_section->{'pretotal'} = 'New charges sub-total '.
1312 $total->{'total_amount'};
1313 $tax_section->{'description'} = $self->mt($tax_description);
1314 $tax_section->{'summarized'} = '';
1316 # append it if it's not already there
1317 if ( !grep $tax_section, @sections ) {
1318 push @sections, $tax_section;
1319 push @summary_subtotals, $tax_section;
1324 unshift @total_items, $total;
1327 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1333 my %embolden_functions = (
1334 'latex' => sub { return '\textbf{'. shift(). '}' },
1335 'html' => sub { return '<b>'. shift(). '</b>' },
1336 'template' => sub { shift },
1338 my $embolden_function = $embolden_functions{$format};
1340 if ( $multisection ) {
1342 if ( $adjust_section->{'sort_weight'} ) {
1343 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1344 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1346 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1347 $other_money_char. sprintf('%.2f', $self->charged );
1352 if ( $self->can('_items_total') ) { # should always be true now
1354 # even for multisection, need plain text version
1356 my @new_total_items = $self->_items_total;
1358 push @buf,['','-----------'];
1360 foreach ( @new_total_items ) {
1361 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1362 $_->{'total_item'} = &$embolden_function( $item );
1363 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1364 # but if it's multisection, don't append to @total_items. the adjust
1365 # section has all this stuff
1366 push @total_items, $_ if !$multisection;
1367 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1370 push @buf, [ '', '' ];
1372 # if we're showing previous invoices, also show previous
1373 # credits and payments
1374 if ( $self->enable_previous
1375 and $self->can('_items_credits')
1376 and $self->can('_items_payments') )
1380 my $credittotal = 0;
1381 foreach my $credit (
1382 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1386 $total->{'total_item'} = &$escape_function($credit->{'description'});
1387 $credittotal += $credit->{'amount'};
1388 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1389 if ( $multisection ) {
1390 push @detail_items, {
1391 ext_description => [],
1394 description => &$escape_function($credit->{'description'}),
1395 amount => $money_char . $credit->{'amount'},
1397 section => $adjust_section,
1400 push @total_items, $total;
1404 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1407 foreach my $credit (
1408 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1410 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1414 my $paymenttotal = 0;
1415 foreach my $payment (
1416 $self->_items_payments( 'template' => $template )
1419 $total->{'total_item'} = &$escape_function($payment->{'description'});
1420 $paymenttotal += $payment->{'amount'};
1421 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1422 if ( $multisection ) {
1423 push @detail_items, {
1424 ext_description => [],
1427 description => &$escape_function($payment->{'description'}),
1428 amount => $money_char . $payment->{'amount'},
1430 section => $adjust_section,
1433 push @total_items, $total;
1435 push @buf, [ $payment->{'description'},
1436 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1439 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1441 if ( $multisection ) {
1442 $adjust_section->{'subtotal'} = $other_money_char.
1443 sprintf('%.2f', $credittotal + $paymenttotal);
1445 #why this? because {sort_weight} forces the adjust_section to appear
1446 #in @extra_sections instead of @sections. obviously.
1447 push @sections, $adjust_section
1448 unless $adjust_section->{sort_weight};
1449 # do not summarize; adjustments there are shown according to
1453 # create Balance Due message
1456 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1457 $total->{'total_amount'} =
1458 &$embolden_function(
1459 $other_money_char. sprintf('%.2f', #why? $summarypage
1460 # ? $self->charged +
1461 # $self->billing_balance
1463 $self->owed + $pr_total
1466 if ( $multisection && !$adjust_section->{sort_weight} ) {
1467 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1468 $total->{'total_amount'};
1470 push @total_items, $total;
1472 push @buf,['','-----------'];
1473 push @buf,[$self->balance_due_msg, $money_char.
1474 sprintf("%10.2f", $balance_due ) ];
1477 if ( $conf->exists('previous_balance-show_credit')
1478 and $cust_main->balance < 0 ) {
1479 my $credit_total = {
1480 'total_item' => &$embolden_function($self->credit_balance_msg),
1481 'total_amount' => &$embolden_function(
1482 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1485 if ( $multisection ) {
1486 $adjust_section->{'posttotal'} .= $newline_token .
1487 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1490 push @total_items, $credit_total;
1492 push @buf,['','-----------'];
1493 push @buf,[$self->credit_balance_msg, $money_char.
1494 sprintf("%10.2f", -$cust_main->balance ) ];
1498 } #end of default total adding ! can('_items_total')
1500 if ( $multisection ) {
1501 if ( $conf->exists('svc_phone_sections')
1502 && $self->can('_items_svc_phone_sections')
1506 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1507 $total->{'total_amount'} =
1508 &$embolden_function(
1509 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1511 my $last_section = pop @sections;
1512 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1513 $total->{'total_amount'};
1514 push @sections, $last_section;
1516 push @sections, @$late_sections
1520 # make a discounts-available section, even without multisection
1521 if ( $conf->exists('discount-show_available')
1522 and my @discounts_avail = $self->_items_discounts_avail ) {
1523 my $discount_section = {
1524 'description' => $self->mt('Discounts Available'),
1529 push @sections, $discount_section; # do not summarize
1530 push @detail_items, map { +{
1531 'ref' => '', #should this be something else?
1532 'section' => $discount_section,
1533 'description' => &$escape_function( $_->{description} ),
1534 'amount' => $money_char . &$escape_function( $_->{amount} ),
1535 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1536 } } @discounts_avail;
1539 # not adding any more sections after this
1540 $invoice_data{summary_subtotals} = \@summary_subtotals;
1543 if ( $conf->exists('usage_class_summary')
1544 and $self->can('_items_usage_class_summary') ) {
1545 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1546 if ( @usage_subtotals ) {
1547 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1548 unshift @detail_items, @usage_subtotals;
1552 # invoice history "section" (not really a section)
1553 # not to be included in any subtotals, completely independent of
1555 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1558 foreach my $cust_bill ( $cust_main->cust_bill ) {
1559 # XXX hardcoded format, and currently only 'charged'; add other fields
1560 # if they become necessary
1561 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1562 $history{$date} ||= 0;
1563 $history{$date} += $cust_bill->charged;
1564 # just so we have a numeric sort key
1565 $monthorder{$date} ||= $cust_bill->_date;
1567 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1569 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1570 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1573 # service locations: another option for template customization
1575 foreach my $item (@detail_items) {
1576 if ( $item->{locationnum} ) {
1577 $location_info{ $item->{locationnum} } ||= {
1578 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1582 $invoice_data{location_info} = \%location_info;
1584 # debugging hook: call this with 'diag' => 1 to just get a hash of
1585 # the invoice variables
1586 return \%invoice_data if ( $params{'diag'} );
1588 # All sections and items are built; now fill in templates.
1589 my @includelist = ();
1590 push @includelist, 'summary' if $summarypage;
1591 foreach my $include ( @includelist ) {
1593 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1596 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1598 @inc_src = $conf->config($inc_file, $agentnum);
1602 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1604 my $convert_map = $convert_maps{$format}{$include};
1606 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1607 s/--\@\]/$delimiters{$format}[1]/g;
1610 &$convert_map( $conf->config($inc_file, $agentnum) );
1614 my $inc_tt = new Text::Template (
1616 SOURCE => [ map "$_\n", @inc_src ],
1617 DELIMITERS => $delimiters{$format},
1618 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1620 unless ( $inc_tt->compile() ) {
1621 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1622 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1626 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1628 $invoice_data{$include} =~ s/\n+$//
1629 if ($format eq 'latex');
1634 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1635 /invoice_lines\((\d*)\)/;
1636 $invoice_lines += $1 || scalar(@buf);
1639 die "no invoice_lines() functions in template?"
1640 if ( $format eq 'template' && !$wasfunc );
1642 if ($format eq 'template') {
1644 if ( $invoice_lines ) {
1645 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1646 $invoice_data{'total_pages'}++
1647 if scalar(@buf) % $invoice_lines;
1650 #setup subroutine for the template
1651 $invoice_data{invoice_lines} = sub {
1652 my $lines = shift || scalar(@buf);
1664 push @collect, split("\n",
1665 $text_template->fill_in( HASH => \%invoice_data )
1667 $invoice_data{'page'}++;
1669 map "$_\n", @collect;
1671 } else { # this is where we actually create the invoice
1673 if ( $params{no_addresses} ) {
1674 delete $invoice_data{$_} foreach qw(
1675 payname company address1 address2 city state zip country
1677 $invoice_data{returnaddress} = '~';
1680 warn "filling in template for invoice ". $self->invnum. "\n"
1682 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1685 $text_template->fill_in(HASH => \%invoice_data);
1689 sub notice_name { '('.shift->table.')'; }
1691 sub template_conf { 'invoice_'; }
1693 # helper routine for generating date ranges
1694 sub _prior_month30s {
1697 [ 1, 2592000 ], # 0-30 days ago
1698 [ 2592000, 5184000 ], # 30-60 days ago
1699 [ 5184000, 7776000 ], # 60-90 days ago
1700 [ 7776000, 0 ], # 90+ days ago
1703 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1704 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1709 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1711 Returns an postscript invoice, as a scalar.
1713 Options can be passed as a hashref (recommended) or as a list of time, template
1714 and then any key/value pairs for any other options.
1716 I<time> an optional value used to control the printing of overdue messages. The
1717 default is now. It isn't the date of the invoice; that's the `_date' field.
1718 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1719 L<Time::Local> and L<Date::Parse> for conversion functions.
1721 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1728 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1729 my $ps = generate_ps($file);
1731 unlink($barcodefile) if $barcodefile;
1736 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1738 Returns an PDF invoice, as a scalar.
1740 Options can be passed as a hashref (recommended) or as a list of time, template
1741 and then any key/value pairs for any other options.
1743 I<time> an optional value used to control the printing of overdue messages. The
1744 default is now. It isn't the date of the invoice; that's the `_date' field.
1745 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1746 L<Time::Local> and L<Date::Parse> for conversion functions.
1748 I<template>, if specified, is the name of a suffix for alternate invoices.
1750 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1757 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1758 my $pdf = generate_pdf($file);
1760 unlink($barcodefile) if $barcodefile;
1765 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1767 Returns an HTML invoice, as a scalar.
1769 I<time> an optional value used to control the printing of overdue messages. The
1770 default is now. It isn't the date of the invoice; that's the `_date' field.
1771 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1772 L<Time::Local> and L<Date::Parse> for conversion functions.
1774 I<template>, if specified, is the name of a suffix for alternate invoices.
1776 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1778 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1779 when emailing the invoice as part of a multipart/related MIME email.
1787 %params = %{ shift() };
1791 $params{'format'} = 'html';
1793 $self->print_generic( %params );
1796 # quick subroutine for print_latex
1798 # There are ten characters that LaTeX treats as special characters, which
1799 # means that they do not simply typeset themselves:
1800 # # $ % & ~ _ ^ \ { }
1802 # TeX ignores blanks following an escaped character; if you want a blank (as
1803 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1807 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1808 $value =~ s/([<>])/\$$1\$/g;
1814 encode_entities($value);
1818 sub _html_escape_nbsp {
1819 my $value = _html_escape(shift);
1820 $value =~ s/ +/ /g;
1824 #utility methods for print_*
1826 sub _translate_old_latex_format {
1827 warn "_translate_old_latex_format called\n"
1834 if ( $line =~ /^%%Detail\s*$/ ) {
1836 push @template, q![@--!,
1837 q! foreach my $_tr_line (@detail_items) {!,
1838 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1839 q! $_tr_line->{'description'} .= !,
1840 q! "\\tabularnewline\n~~".!,
1841 q! join( "\\tabularnewline\n~~",!,
1842 q! @{$_tr_line->{'ext_description'}}!,
1846 while ( ( my $line_item_line = shift )
1847 !~ /^%%EndDetail\s*$/ ) {
1848 $line_item_line =~ s/'/\\'/g; # nice LTS
1849 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1850 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1851 push @template, " \$OUT .= '$line_item_line';";
1854 push @template, '}',
1857 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1859 push @template, '[@--',
1860 ' foreach my $_tr_line (@total_items) {';
1862 while ( ( my $total_item_line = shift )
1863 !~ /^%%EndTotalDetails\s*$/ ) {
1864 $total_item_line =~ s/'/\\'/g; # nice LTS
1865 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1866 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1867 push @template, " \$OUT .= '$total_item_line';";
1870 push @template, '}',
1874 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1875 push @template, $line;
1881 warn "$_\n" foreach @template;
1893 my $conf = $self->conf;
1895 #check for an invoice-specific override
1896 return $self->invoice_terms if $self->invoice_terms;
1898 #check for a customer- specific override
1899 my $cust_main = $self->cust_main;
1900 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1904 $agentnum = $cust_main->agentnum;
1905 } elsif ( my $prospect_main = $self->prospect_main ) {
1906 $agentnum = $prospect_main->agentnum;
1909 #use configured default
1910 $conf->config('invoice_default_terms', $agentnum) || '';
1920 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1921 $duedate = $self->_date() + ( $1 * 86400 );
1932 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1935 =item balance_due_msg
1939 sub balance_due_msg {
1941 my $msg = $self->mt('Balance Due');
1942 return $msg unless $self->terms; # huh?
1943 if ( !$self->conf->exists('invoice_show_prior_due_date')
1944 or $self->conf->exists('invoice_sections') ) {
1945 # if enabled, the due date is shown with Total New Charges (see
1946 # _items_total) and not here
1947 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1948 if ( $self->due_date ) {
1949 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1950 $self->due_date2str('short');
1951 } elsif ( $self->terms ) {
1952 $msg .= ' - '. $self->mt($self->terms);
1958 =item balance_due_date
1962 sub balance_due_date {
1964 my $conf = $self->conf;
1966 my $terms = $self->terms;
1967 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1968 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1973 sub credit_balance_msg {
1975 $self->mt('Credit Balance Remaining')
1980 Returns a string with the date, for example: "3/20/2008", localized for the
1981 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1987 $self->time2str_local('short', $self->_date);
1990 =item _date_pretty_unlocalized
1992 Returns a string with the date, for example: "3/20/2008", in the format
1993 configured for the back-office. Use _date_pretty for end-customer display use.
1997 sub _date_pretty_unlocalized {
1999 time2str($date_format, $self->_date);
2004 Emails this template.
2006 Options are passed as a hashref. Available options:
2012 If specified, overrides the default From: address.
2016 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2020 (Deprecated) If specified, is the name of a suffix for alternate template files.
2024 Options accepted by generate_email can also be used.
2030 my $opt = shift || {};
2031 if ($opt and !ref($opt)) {
2032 die ref($self). '->email called with positional parameters';
2035 return if $self->hide;
2037 my $error = send_email(
2038 $self->generate_email(
2039 'subject' => $self->email_subject($opt->{template}),
2040 %$opt, # template, etc.
2044 die "can't email: $error\n" if $error;
2047 =item generate_email OPTION => VALUE ...
2055 sender address, required
2059 alternate template name, optional
2063 email subject, optional
2067 notice name instead of "Invoice", optional
2071 Returns an argument list to be passed to L<FS::Misc::send_email>.
2077 sub generate_email {
2081 my $conf = $self->conf;
2083 my $me = '[FS::Template_Mixin::generate_email]';
2086 'from' => $args{'from'},
2087 'subject' => ($args{'subject'} || $self->email_subject),
2088 'custnum' => $self->custnum,
2089 'msgtype' => 'invoice',
2092 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2094 my $cust_main = $self->cust_main;
2096 if (ref($args{'to'}) eq 'ARRAY') {
2097 $return{'to'} = $args{'to'};
2098 } elsif ( $cust_main ) {
2099 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2102 my $tc = $self->template_conf;
2104 my @text; # array of lines
2105 my $html; # a big string
2106 my @related_parts; # will contain the text/HTML alternative, and images
2107 my $related; # will contain the multipart/related object
2109 if ( $conf->exists($tc. 'email_pdf') ) {
2110 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2112 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2115 my $msg_template = FS::msg_template->by_key($msgnum)
2116 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2117 my %prepared = $msg_template->prepare(
2118 cust_main => $self->cust_main,
2122 @text = split(/(?=\n)/, $prepared{'text_body'});
2123 $html = $prepared{'html_body'};
2125 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2127 warn "$me using '${tc}email_pdf_note' in multipart message"
2129 @text = $conf->config($tc.'email_pdf_note');
2130 $html = join('<BR>', @text);
2132 } # else use the plain text invoice
2137 if ( $conf->config($tc.'template') ) {
2139 warn "$me generating plain text invoice"
2142 # 'print_text' argument is no longer used
2143 @text = $self->print_text(\%args);
2147 warn "$me no plain text version exists; sending empty message body"
2154 my $text_part = build MIME::Entity (
2155 'Type' => 'text/plain',
2156 'Encoding' => 'quoted-printable',
2157 'Charset' => 'UTF-8',
2158 #'Encoding' => '7bit',
2160 'Disposition' => 'inline',
2165 if ( $conf->exists($tc.'html') ) {
2166 warn "$me generating HTML invoice"
2169 $args{'from'} =~ /\@([\w\.\-]+)/;
2170 my $from = $1 || 'example.com';
2171 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2174 my $agentnum = $cust_main ? $cust_main->agentnum
2175 : $self->prospect_main->agentnum;
2176 if ( defined($args{'template'}) && length($args{'template'})
2177 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2180 $logo = 'logo_'. $args{'template'}. '.png';
2184 my $image_data = $conf->config_binary( $logo, $agentnum);
2186 push @related_parts, build MIME::Entity
2187 'Type' => 'image/png',
2188 'Encoding' => 'base64',
2189 'Data' => $image_data,
2190 'Filename' => 'logo.png',
2191 'Content-ID' => "<$content_id>",
2194 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2195 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2196 push @related_parts, build MIME::Entity
2197 'Type' => 'image/png',
2198 'Encoding' => 'base64',
2199 'Data' => $self->invoice_barcode(0),
2200 'Filename' => 'barcode.png',
2201 'Content-ID' => "<$barcode_content_id>",
2203 $args{'barcode_cid'} = $barcode_content_id;
2206 $html = $self->print_html({ 'cid'=>$content_id, %args });
2213 warn "$me creating HTML/text multipart message"
2216 $return{'nobody'} = 1;
2218 my $alternative = build MIME::Entity
2219 'Type' => 'multipart/alternative',
2220 #'Encoding' => '7bit',
2221 'Disposition' => 'inline'
2225 $alternative->add_part($text_part);
2228 $alternative->attach(
2229 'Type' => 'text/html',
2230 'Encoding' => 'quoted-printable',
2231 'Data' => [ '<html>',
2234 ' '. encode_entities($return{'subject'}),
2237 ' <body bgcolor="#e8e8e8">',
2242 'Disposition' => 'inline',
2243 #'Filename' => 'invoice.pdf',
2246 unshift @related_parts, $alternative;
2248 $related = build MIME::Entity 'Type' => 'multipart/related',
2249 'Encoding' => '7bit';
2251 #false laziness w/Misc::send_email
2252 $related->head->replace('Content-type',
2253 $related->mime_type.
2254 '; boundary="'. $related->head->multipart_boundary. '"'.
2255 '; type=multipart/alternative'
2258 $related->add_part($_) foreach @related_parts;
2262 my @otherparts = ();
2263 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2265 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2267 my $data = join('', map "$_\n",
2268 $self->call_details(prepend_billed_number=>1)
2271 my $zip = new Archive::Zip;
2272 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2273 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2276 my $SH = IO::Scalar->new(\$zipdata);
2277 my $status = $zip->writeToFileHandle($SH);
2278 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2280 push @otherparts, build MIME::Entity
2281 'Type' => 'application/zip',
2282 'Encoding' => 'base64',
2284 'Disposition' => 'attachment',
2285 'Filename' => 'usage-'. $self->invnum. '.zip',
2288 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2290 push @otherparts, build MIME::Entity
2291 'Type' => 'text/csv',
2292 'Encoding' => '7bit',
2293 'Data' => [ map { "$_\n" }
2294 $self->call_details('prepend_billed_number' => 1)
2296 'Disposition' => 'attachment',
2297 'Filename' => 'usage-'. $self->invnum. '.csv',
2304 if ( $conf->exists($tc.'email_pdf') ) {
2309 # multipart/alternative
2315 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2316 push @otherparts, $pdf;
2320 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2322 $return{'mimeparts'} = [ $related, @otherparts ];
2323 $return{'type'} = 'multipart/related'; # of the first part
2325 $return{'mimeparts'} = [ $text_part, @otherparts ];
2326 $return{'type'} = 'text/plain';
2328 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2329 $return{'mimeparts'} = \@related_parts;
2330 $return{'content-type'} = 'multipart/related';
2331 $return{'type'} = 'multipart/alternative';
2332 } else { # no HTML either
2333 $return{'body'} = \@text;
2334 $return{'content-type'} = 'text/plain';
2343 Returns a list suitable for passing to MIME::Entity->build(), representing
2344 this invoice as PDF attachment.
2351 'Type' => 'application/pdf',
2352 'Encoding' => 'base64',
2353 'Data' => [ $self->print_pdf(@_) ],
2354 'Disposition' => 'attachment',
2355 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2359 =item postal_mail_fsinc
2361 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2367 use IO::Socket::SSL;
2369 use HTTP::Request::Common qw( POST );
2372 sub postal_mail_fsinc {
2373 my ( $self, %opt ) = @_;
2375 my $url = 'https://ws.freeside.biz/print';
2377 my $cust_main = $self->cust_main;
2378 my $agentnum = $cust_main->agentnum;
2379 my $bill_location = $cust_main->bill_location;
2381 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2382 if $bill_location->country ne 'US';
2384 my $conf = new FS::Conf;
2386 my @company_address = $conf->config('company_address', $agentnum);
2387 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2388 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2389 $company_address1 = $company_address[0];
2390 $company_address2 = $company_address[1];
2392 $company_state = $2;
2394 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2395 $company_address1 = $company_address[0];
2396 $company_address2 = '';
2398 $company_state = $2;
2401 die "Unparsable company_address; contact support\@freeside.biz\n";
2403 $company_city =~ s/,$//;
2405 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2406 my $pages = CAM::PDF->new($file)->numPages;
2408 my $ua = LWP::UserAgent->new(
2410 verify_hostname => 0,
2411 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2414 my $response = $ua->request( POST $url, [
2415 'support-key' => scalar($conf->config('support-key')),
2416 'file' => encode_base64($file),
2420 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2421 'company_address1' => $company_address1,
2422 'company_address2' => $company_address2,
2423 'company_city' => $company_city,
2424 'company_state' => $company_state,
2425 'company_zip' => $company_zip,
2426 'company_country' => 'US',
2427 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2428 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2431 'name' => ( $cust_main->payname
2432 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/
2433 ? $cust_main->payname
2434 : $cust_main->contact_firstlast
2436 'company' => $cust_main->company,
2437 'address1' => $bill_location->address1,
2438 'address2' => $bill_location->address2,
2439 'city' => $bill_location->city,
2440 'state' => $bill_location->state,
2441 'zip' => $bill_location->zip,
2442 'country' => $bill_location->country,
2445 die "Print connection error: ". $response->message. "\n"
2446 unless $response->is_success;
2449 my $content = eval { decode_json($response->content) };
2450 die "Print JSON error : $@\n" if $@;
2452 die $content->{error}."\n"
2453 if $content->{error};
2455 #TODO: store this so we can query for a status later
2456 warn "Invoice printed, ID ". $content->{id}. "\n";
2461 =item _items_sections OPTIONS
2463 Generate section information for all items appearing on this invoice.
2464 This will only be called for multi-section invoices.
2466 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2467 related display records (L<FS::cust_bill_pkg_display>) and organize
2468 them into two groups ("early" and "late" according to whether they come
2469 before or after the total), then into sections. A subtotal is calculated
2472 Section descriptions are returned in sort weight order. Each consists
2473 of a hash containing:
2475 description: the package category name, escaped
2476 subtotal: the total charges in that section
2477 tax_section: a flag indicating that the section contains only tax charges
2478 summarized: same as tax_section, for some reason
2479 sort_weight: the package category's sort weight
2481 If 'condense' is set on the display record, it also contains everything
2482 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2483 coderefs to generate parts of the invoice. This is not advised.
2485 The method returns two arrayrefs, one of "early" sections and one of "late"
2488 OPTIONS may include:
2490 by_location: a flag to divide the invoice into sections by location.
2491 Each section hash will have a 'location' element containing a hashref of
2492 the location fields (see L<FS::cust_location>). The section description
2493 will be the location label, but the template can use any of the location
2494 fields to create a suitable label.
2496 by_category: a flag to divide the invoice into sections using display
2497 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2498 behavior. Each section hash will have a 'category' element containing
2499 the section name from the display record (which probably equals the
2500 category name of the package, but may not in some cases).
2502 summary: a flag indicating that this is a summary-format invoice.
2503 Turning this on has the following effects:
2504 - Ignores display items with the 'summary' flag.
2505 - Places all sections in the "early" group even if they have post_total.
2506 - Creates sections for all non-disabled package categories, even if they
2507 have no charges on this invoice, as well as a section with no name.
2509 escape: an escape function to use for section titles.
2511 extra_sections: an arrayref of additional sections to return after the
2512 sorted list. If there are any of these, section subtotals exclude
2515 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2516 passed through to C<_condense_section()>.
2520 use vars qw(%pkg_category_cache);
2521 sub _items_sections {
2525 my $escape = $opt{escape};
2526 my @extra_sections = @{ $opt{extra_sections} || [] };
2528 # $subtotal{$locationnum}{$categoryname} = amount.
2529 # if we're not using by_location, $locationnum is undef.
2530 # if we're not using by_category, you guessed it, $categoryname is undef.
2531 # if we're not using either one, we shouldn't be here in the first place...
2533 my %late_subtotal = ();
2536 # About tax items + multisection invoices:
2537 # If either invoice_*summary option is enabled, AND there is a
2538 # package category with the name of the tax, then there will be
2539 # a display record assigning the tax item to that category.
2541 # However, the taxes are always placed in the "Taxes, Surcharges,
2542 # and Fees" section regardless of that. The only effect of the
2543 # display record is to create a subtotal for the summary page.
2546 my $pkg_hash = $self->cust_pkg_hash;
2548 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2551 my $usage = $cust_bill_pkg->usage;
2554 if ( $opt{by_location} ) {
2555 if ( $cust_bill_pkg->pkgnum ) {
2556 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2561 $locationnum = undef;
2564 # as in _items_cust_pkg, if a line item has no display records,
2565 # cust_bill_pkg_display() returns a default record for it
2567 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2568 next if ( $display->summary && $opt{summary} );
2570 my $section = $display->section;
2571 my $type = $display->type;
2572 # Set $section = undef if we're sectioning by location and this
2573 # line item _has_ a location (i.e. isn't a fee).
2574 $section = undef if $locationnum;
2576 # set this flag if the section is not tax-only
2577 $not_tax{$locationnum}{$section} = 1
2578 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2580 # there's actually a very important piece of logic buried in here:
2581 # incrementing $late_subtotal{$section} CREATES
2582 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2583 # to define the list of late sections, and likewise keys(%subtotal).
2584 # When _items_cust_bill_pkg is called to generate line items for
2585 # real, it will be called with 'section' => $section for each
2587 if ( $display->post_total && !$opt{summary} ) {
2588 if (! $type || $type eq 'S') {
2589 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2590 if $cust_bill_pkg->setup != 0
2591 || $cust_bill_pkg->setup_show_zero;
2595 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2596 if $cust_bill_pkg->recur != 0
2597 || $cust_bill_pkg->recur_show_zero;
2600 if ($type && $type eq 'R') {
2601 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2602 if $cust_bill_pkg->recur != 0
2603 || $cust_bill_pkg->recur_show_zero;
2606 if ($type && $type eq 'U') {
2607 $late_subtotal{$locationnum}{$section} += $usage
2608 unless scalar(@extra_sections);
2611 } else { # it's a pre-total (normal) section
2613 # skip tax items unless they're explicitly included in a section
2614 next if $cust_bill_pkg->pkgnum == 0 and
2615 ! $cust_bill_pkg->feepart and
2618 if ( $type eq 'S' ) {
2619 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2620 if $cust_bill_pkg->setup != 0
2621 || $cust_bill_pkg->setup_show_zero;
2622 } elsif ( $type eq 'R' ) {
2623 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2624 if $cust_bill_pkg->recur != 0
2625 || $cust_bill_pkg->recur_show_zero;
2626 } elsif ( $type eq 'U' ) {
2627 $subtotal{$locationnum}{$section} += $usage
2628 unless scalar(@extra_sections);
2629 } elsif ( !$type ) {
2630 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2631 + $cust_bill_pkg->recur;
2640 %pkg_category_cache = ();
2642 # summary invoices need subtotals for all non-disabled package categories,
2643 # even if they're zero
2644 # but currently assume that there are no location sections, or at least
2645 # that the summary page doesn't care about them
2646 if ( $opt{summary} ) {
2647 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2648 $subtotal{''}{$category->categoryname} ||= 0;
2650 $subtotal{''}{''} ||= 0;
2654 foreach my $post_total (0,1) {
2656 my $s = $post_total ? \%late_subtotal : \%subtotal;
2657 foreach my $locationnum (keys %$s) {
2658 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2660 'subtotal' => $s->{$locationnum}{$sectionname},
2663 if ( $locationnum ) {
2664 $section->{'locationnum'} = $locationnum;
2665 my $location = FS::cust_location->by_key($locationnum);
2666 $section->{'description'} = &{ $escape }($location->location_label);
2667 # Better ideas? This will roughly group them by proximity,
2668 # which alpha sorting on any of the address fields won't.
2669 # Sorting by locationnum is meaningless.
2670 # We have to sort on _something_ or the order may change
2671 # randomly from one invoice to the next, which will confuse
2673 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2675 $section->{'location'} = {
2676 label_prefix => &{ $escape }($location->label_prefix),
2677 map { $_ => &{ $escape }($location->get($_)) }
2681 $section->{'category'} = $sectionname;
2682 $section->{'description'} = &{ $escape }($sectionname);
2683 if ( _pkg_category($sectionname) ) {
2684 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2685 if ( _pkg_category($sectionname)->condense ) {
2686 $section = { %$section, $self->_condense_section($opt{format}) };
2690 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2691 # then it's a tax-only section
2692 $section->{'summarized'} = 'Y';
2693 $section->{'tax_section'} = 'Y';
2695 push @these, $section;
2696 } # foreach $sectionname
2697 } #foreach $locationnum
2698 push @these, @extra_sections if $post_total == 0;
2699 # need an alpha sort for location sections, because postal codes can
2701 $sections[ $post_total ] = [ sort {
2702 $opt{'by_location'} ?
2703 ($a->{sort_weight} cmp $b->{sort_weight}) :
2704 ($a->{sort_weight} <=> $b->{sort_weight})
2706 } #foreach $post_total
2708 return @sections; # early, late
2711 #helper subs for above
2715 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2719 my $categoryname = shift;
2720 $pkg_category_cache{$categoryname} ||=
2721 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2724 my %condensed_format = (
2725 'label' => [ qw( Description Qty Amount ) ],
2727 sub { shift->{description} },
2728 sub { shift->{quantity} },
2729 sub { my($href, %opt) = @_;
2730 ($opt{dollar} || ''). $href->{amount};
2733 'align' => [ qw( l r r ) ],
2734 'span' => [ qw( 5 1 1 ) ], # unitprices?
2735 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2738 sub _condense_section {
2739 my ( $self, $format ) = ( shift, shift );
2741 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2742 qw( description_generator
2745 total_line_generator
2750 sub _condensed_generator_defaults {
2751 my ( $self, $format ) = ( shift, shift );
2752 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2761 sub _condensed_header_generator {
2762 my ( $self, $format ) = ( shift, shift );
2764 my ( $f, $prefix, $suffix, $separator, $column ) =
2765 _condensed_generator_defaults($format);
2767 if ($format eq 'latex') {
2768 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2769 $suffix = "\\\\\n\\hline";
2772 sub { my ($d,$a,$s,$w) = @_;
2773 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2775 } elsif ( $format eq 'html' ) {
2776 $prefix = '<th></th>';
2780 sub { my ($d,$a,$s,$w) = @_;
2781 return qq!<th align="$html_align{$a}">$d</th>!;
2789 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2791 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2794 $prefix. join($separator, @result). $suffix;
2799 sub _condensed_description_generator {
2800 my ( $self, $format ) = ( shift, shift );
2802 my ( $f, $prefix, $suffix, $separator, $column ) =
2803 _condensed_generator_defaults($format);
2805 my $money_char = '$';
2806 if ($format eq 'latex') {
2807 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2809 $separator = " & \n";
2811 sub { my ($d,$a,$s,$w) = @_;
2812 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2814 $money_char = '\\dollar';
2815 }elsif ( $format eq 'html' ) {
2816 $prefix = '"><td align="center"></td>';
2820 sub { my ($d,$a,$s,$w) = @_;
2821 return qq!<td align="$html_align{$a}">$d</td>!;
2823 #$money_char = $conf->config('money_char') || '$';
2824 $money_char = ''; # this is madness
2832 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2834 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2836 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2837 map { $f->{$_}->[$i] } qw(align span width)
2841 $prefix. join( $separator, @result ). $suffix;
2846 sub _condensed_total_generator {
2847 my ( $self, $format ) = ( shift, shift );
2849 my ( $f, $prefix, $suffix, $separator, $column ) =
2850 _condensed_generator_defaults($format);
2853 if ($format eq 'latex') {
2856 $separator = " & \n";
2858 sub { my ($d,$a,$s,$w) = @_;
2859 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2861 }elsif ( $format eq 'html' ) {
2865 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2867 sub { my ($d,$a,$s,$w) = @_;
2868 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2877 # my $r = &{$f->{fields}->[$i]}(@args);
2878 # $r .= ' Total' unless $i;
2880 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2882 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2883 map { $f->{$_}->[$i] } qw(align span width)
2887 $prefix. join( $separator, @result ). $suffix;
2892 =item total_line_generator FORMAT
2894 Returns a coderef used for generation of invoice total line items for this
2895 usage_class. FORMAT is either html or latex
2899 # should not be used: will have issues with hash element names (description vs
2900 # total_item and amount vs total_amount -- another array of functions?
2902 sub _condensed_total_line_generator {
2903 my ( $self, $format ) = ( shift, shift );
2905 my ( $f, $prefix, $suffix, $separator, $column ) =
2906 _condensed_generator_defaults($format);
2909 if ($format eq 'latex') {
2912 $separator = " & \n";
2914 sub { my ($d,$a,$s,$w) = @_;
2915 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2917 }elsif ( $format eq 'html' ) {
2921 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2923 sub { my ($d,$a,$s,$w) = @_;
2924 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2933 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2935 &{$column}( &{$f->{fields}->[$i]}(@args),
2936 map { $f->{$_}->[$i] } qw(align span width)
2940 $prefix. join( $separator, @result ). $suffix;
2945 =item _items_pkg [ OPTIONS ]
2947 Return line item hashes for each package item on this invoice. Nearly
2950 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2952 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2953 'format' and 'escape_function' at minimum.
2955 To produce items for a specific invoice section, OPTIONS should include
2956 'section', a hashref containing 'category' and/or 'locationnum' keys.
2958 'section' may also contain a key named 'condensed'. If this is present
2959 and has a true value, _items_pkg will try to merge identical items into items
2960 with 'quantity' equal to the number of items (not the sum of their separate
2961 quantities, for some reason).
2967 # The order of these is important. Bundled line items will be merged into
2968 # the most recent non-hidden item, so it needs to be the one with:
2970 # - the same start date
2971 # - no pkgpart_override
2973 # So: sort by pkgnum,
2975 # then sort the base line item before any overrides
2976 # then sort hidden before non-hidden add-ons
2977 # then sort by override pkgpart (for consistency)
2978 sort { $a->pkgnum <=> $b->pkgnum or
2979 $a->sdate <=> $b->sdate or
2980 ($a->pkgpart_override ? 0 : -1) or
2981 ($b->pkgpart_override ? 0 : 1) or
2982 $b->hidden cmp $a->hidden or
2983 $a->pkgpart_override <=> $b->pkgpart_override
2985 # and of course exclude taxes and fees
2986 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2992 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2993 my $escape_function = $options{escape_function};
2996 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2997 # cache this, so we don't look it up again in every section
2998 my $part_fee = $cust_bill_pkg->get('part_fee')
2999 || $cust_bill_pkg->part_fee;
3000 $cust_bill_pkg->set('part_fee', $part_fee);
3002 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3003 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3006 if ( exists($options{section}) and exists($options{section}{category}) )
3008 my $categoryname = $options{section}{category};
3009 # then filter for items that have that section
3010 if ( $part_fee->categoryname ne $categoryname ) {
3011 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3014 } # otherwise include them all in the main section
3015 # XXX what to do when sectioning by location?
3018 my %base_invnums; # invnum => invoice date
3019 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3020 if ($_->base_invnum) {
3021 # XXX what if base_bill has been voided?
3022 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3023 my $base_date = $self->time2str_local('short', $base_bill->_date)
3025 $base_invnums{$_->base_invnum} = $base_date || '';
3028 foreach (sort keys(%base_invnums)) {
3029 next if $_ == $self->invnum;
3030 # per convention, we must escape ext_description lines
3032 &{$escape_function}(
3033 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3036 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3037 # but not escape the base description line
3040 { feepart => $cust_bill_pkg->feepart,
3041 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3042 description => $desc,
3043 ext_description => \@ext_desc
3054 warn "$me _items_pkg searching for all package line items\n"
3057 my @cust_bill_pkg = $self->_items_nontax;
3059 warn "$me _items_pkg filtering line items\n"
3061 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3063 if ($options{section} && $options{section}->{condensed}) {
3065 warn "$me _items_pkg condensing section\n"
3069 local $Storable::canonical = 1;
3070 foreach ( @items ) {
3072 delete $item->{ref};
3073 delete $item->{ext_description};
3074 my $key = freeze($item);
3075 $itemshash{$key} ||= 0;
3076 $itemshash{$key} ++; # += $item->{quantity};
3078 @items = sort { $a->{description} cmp $b->{description} }
3079 map { my $i = thaw($_);
3080 $i->{quantity} = $itemshash{$_};
3082 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3088 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3095 return 0 unless $a->itemdesc cmp $b->itemdesc;
3096 return -1 if $b->itemdesc eq 'Tax';
3097 return 1 if $a->itemdesc eq 'Tax';
3098 return -1 if $b->itemdesc eq 'Other surcharges';
3099 return 1 if $a->itemdesc eq 'Other surcharges';
3100 $a->itemdesc cmp $b->itemdesc;
3105 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3106 $self->cust_bill_pkg;
3107 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3109 if ( $self->conf->exists('always_show_tax') ) {
3110 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3111 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3113 { 'description' => $itemdesc,
3120 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3122 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3123 list of hashrefs describing the line items they generate on the invoice.
3125 OPTIONS may include:
3127 format: the invoice format.
3129 escape_function: the function used to escape strings.
3131 DEPRECATED? (expensive, mostly unused?)
3132 format_function: the function used to format CDRs.
3134 section: a hashref containing 'category' and/or 'locationnum'; if this
3135 is present, only returns line items that belong to that category and/or
3136 location (whichever is defined).
3138 multisection: a flag indicating that this is a multisection invoice,
3139 which does something complicated.
3141 preref_callback: coderef run for each line item, code should return HTML to be
3142 displayed before that line item (quotations only)
3144 Returns a list of hashrefs, each of which may contain:
3146 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3147 ext_description, which is an arrayref of detail lines to show below
3152 sub _items_cust_bill_pkg {
3154 my $conf = $self->conf;
3155 my $cust_bill_pkgs = shift;
3158 my $format = $opt{format} || '';
3159 my $escape_function = $opt{escape_function} || sub { shift };
3160 my $format_function = $opt{format_function} || '';
3161 my $no_usage = $opt{no_usage} || '';
3162 my $unsquelched = $opt{unsquelched} || ''; #unused
3163 my ($section, $locationnum, $category);
3164 if ( $opt{section} ) {
3165 $category = $opt{section}->{category};
3166 $locationnum = $opt{section}->{locationnum};
3168 my $summary_page = $opt{summary_page} || ''; #unused
3169 my $multisection = defined($category) || defined($locationnum);
3170 # this variable is the value of the config setting, not whether it applies
3171 # to this particular line item.
3172 my $discount_show_always = $conf->exists('discount-show-always');
3174 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3176 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3178 # for location labels: use default location on the invoice date
3179 my $default_locationnum;
3180 if ( $self->custnum ) {
3182 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3183 $h_cust_main = qsearchs({
3184 'table' => 'h_cust_main',
3185 'hashref' => { custnum => $self->custnum },
3186 'extra_sql' => $h_search[1],
3187 'addl_from' => $h_search[3],
3189 $default_locationnum = $h_cust_main->ship_locationnum;
3190 } elsif ( $self->prospectnum ) {
3191 my $cust_location = qsearchs('cust_location',
3192 { prospectnum => $self->prospectnum,
3194 $default_locationnum = $cust_location->locationnum if $cust_location;
3197 my @b = (); # accumulator for the line item hashes that we'll return
3198 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3199 # the 'current' line item hashes for setup, recur, usage, discount
3200 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3202 # if the current line item is waiting to go out, and the one we're about
3203 # to start is not bundled, then push out the current one and start a new
3205 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3206 if ( $_ && !$cust_bill_pkg->hidden ) {
3207 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3208 $_->{amount} =~ s/^\-0\.00$/0.00/;
3209 if (exists($_->{unit_amount})) {
3210 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3213 # we already decided to create this display line; don't reconsider it
3215 # if $_->{amount} != 0
3216 # || $discount_show_always
3217 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3218 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3224 if ( $locationnum ) {
3225 # this is a location section; skip packages that aren't at this
3227 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3228 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3232 # Consider display records for this item to determine if it belongs
3233 # in this section. Note that if there are no display records, there
3234 # will be a default pseudo-record that includes all charge types
3235 # and has no section name.
3236 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3237 ? $cust_bill_pkg->cust_bill_pkg_display
3238 : ( $cust_bill_pkg );
3240 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3241 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3244 if ( defined($category) ) {
3245 # then this is a package category section; process all display records
3246 # that belong to this section.
3247 @cust_bill_pkg_display = grep { $_->section eq $category }
3248 @cust_bill_pkg_display;
3250 # otherwise, process all display records that aren't usage summaries
3251 # (I don't think there should be usage summaries if you aren't using
3252 # category sections, but this is the historical behavior)
3253 @cust_bill_pkg_display = grep { !$_->summary }
3254 @cust_bill_pkg_display;
3257 my $classname = ''; # package class name, will fill in later
3259 foreach my $display (@cust_bill_pkg_display) {
3261 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3262 $display->billpkgdisplaynum. "\n"
3265 my $type = $display->type;
3267 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3268 $desc = substr($desc, 0, $maxlength). '...'
3269 if $format eq 'latex' && length($desc) > $maxlength;
3271 my %details_opt = ( 'format' => $format,
3272 'escape_function' => $escape_function,
3273 'format_function' => $format_function,
3274 'no_usage' => $opt{'no_usage'},
3277 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3278 # XXX this should be pulled out into quotation_pkg
3280 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3282 # quotation_pkgs are never fees, so don't worry about the case where
3283 # part_pkg is undefined
3285 my @details = $cust_bill_pkg->details;
3287 # and I guess they're never bundled either?
3288 if ( $cust_bill_pkg->setup != 0 ) {
3289 my $description = $desc;
3290 $description .= ' Setup'
3291 if $cust_bill_pkg->recur != 0
3292 || $discount_show_always
3293 || $cust_bill_pkg->recur_show_zero;
3295 # keep it consistent, please
3297 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3298 'description' => $description,
3299 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3300 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3301 'quantity' => $cust_bill_pkg->quantity,
3302 'ext_description' => \@details,
3303 'preref_html' => ( $opt{preref_callback}
3304 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3309 if ( $cust_bill_pkg->recur != 0 ) {
3312 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3313 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3314 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3315 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3316 'quantity' => $cust_bill_pkg->quantity,
3317 'ext_description' => \@details,
3318 'preref_html' => ( $opt{preref_callback}
3319 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3325 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3326 # a "normal" package line item (not a quotation, not a fee, not a tax)
3328 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3331 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3332 my $part_pkg = $cust_pkg->part_pkg;
3334 # which pkgpart to show for display purposes?
3335 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3337 # start/end dates for invoice formats that do nonstandard
3339 my %item_dates = ();
3340 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3341 unless $part_pkg->option('disable_line_item_date_ranges',1);
3343 # not normally used, but pass this to the template anyway
3344 $classname = $part_pkg->classname;
3346 if ( (!$type || $type eq 'S')
3347 && ( $cust_bill_pkg->setup != 0
3348 || $cust_bill_pkg->setup_show_zero
3349 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3354 warn "$me _items_cust_bill_pkg adding setup\n"
3357 # append the word 'Setup' to the setup line if there's going to be
3358 # a recur line for the same package (i.e. not a one-time charge)
3359 my $description = $desc;
3360 $description .= ' Setup'
3361 if $cust_bill_pkg->recur != 0
3362 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3363 || $cust_bill_pkg->recur_show_zero;
3365 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3367 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3368 # triggered by the recurring charge freq
3370 && $cust_bill_pkg->recur == 0
3371 && ! $cust_bill_pkg->recur_show_zero;
3376 # always pass the svc_label through to the template, even if
3377 # not displaying it as an ext_description
3378 my @svc_labels = map &{$escape_function}($_),
3379 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3381 $svc_label = $svc_labels[0];
3383 unless ( $cust_pkg->part_pkg->hide_svc_detail
3384 || $cust_bill_pkg->hidden )
3387 push @d, @svc_labels
3388 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3389 # show the location label if it's not the customer's default
3390 # location, and we're not grouping items by location already
3391 if ( $cust_pkg->locationnum != $default_locationnum
3392 and !defined($locationnum) ) {
3393 my $loc = $cust_pkg->location_label;
3394 $loc = substr($loc, 0, $maxlength). '...'
3395 if $format eq 'latex' && length($loc) > $maxlength;
3396 push @d, &{$escape_function}($loc);
3399 } #unless hiding service details
3401 push @d, $cust_bill_pkg->details(%details_opt)
3402 if $cust_bill_pkg->recur == 0;
3404 if ( $cust_bill_pkg->hidden ) {
3405 $s->{amount} += $cust_bill_pkg->setup;
3406 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3407 push @{ $s->{ext_description} }, @d;
3411 description => $description,
3412 pkgpart => $pkgpart,
3413 pkgnum => $cust_bill_pkg->pkgnum,
3414 amount => $cust_bill_pkg->setup,
3415 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3416 unit_amount => $cust_bill_pkg->unitsetup,
3417 quantity => $cust_bill_pkg->quantity,
3418 ext_description => \@d,
3419 svc_label => ($svc_label || ''),
3420 locationnum => $cust_pkg->locationnum, # sure, why not?
3426 # should we show a recur line?
3427 # if type eq 'S', then NO, because we've been told not to.
3428 # otherwise, show the recur line if:
3429 # - there's a recurring charge
3430 # - or recur_show_zero is on
3431 # - or there's a positive unitrecur (so it's been discounted to zero)
3432 # and discount-show-always is on
3433 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3435 $cust_bill_pkg->recur != 0
3437 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3438 || $cust_bill_pkg->recur_show_zero
3443 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3446 my $is_summary = $display->summary;
3447 my $description = $desc;
3448 if ( $type eq 'U' and defined($r) ) {
3449 # don't just show the same description as the recur line
3450 $description = $self->mt('Usage charges');
3453 my $part_pkg = $cust_pkg->part_pkg;
3455 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3459 my @seconds = (); # for display of usage info
3462 #at least until cust_bill_pkg has "past" ranges in addition to
3463 #the "future" sdate/edate ones... see #3032
3464 my @dates = ( $self->_date );
3465 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3466 push @dates, $prev->sdate if $prev;
3467 push @dates, undef if !$prev;
3469 my @svc_labels = map &{$escape_function}($_),
3470 $cust_pkg->h_labels_short(@dates, 'I');
3471 $svc_label = $svc_labels[0];
3473 # show service labels, unless...
3474 # the package is set not to display them
3475 unless ( $part_pkg->hide_svc_detail
3476 # or this is a tax-like line item
3477 || $cust_bill_pkg->itemdesc
3478 # or this is a hidden (bundled) line item
3479 || $cust_bill_pkg->hidden
3480 # or this is a usage summary line
3481 || $is_summary && $type && $type eq 'U'
3482 # or this is a usage line and there's a recurring line
3483 # for the package in the same section (which will
3484 # have service labels already)
3485 || ($type eq 'U' and defined($r))
3489 warn "$me _items_cust_bill_pkg adding service details\n"
3492 push @d, @svc_labels
3493 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3494 warn "$me _items_cust_bill_pkg done adding service details\n"
3497 # show the location label if it's not the customer's default
3498 # location, and we're not grouping items by location already
3499 if ( $cust_pkg->locationnum != $default_locationnum
3500 and !defined($locationnum) ) {
3501 my $loc = $cust_pkg->location_label;
3502 $loc = substr($loc, 0, $maxlength). '...'
3503 if $format eq 'latex' && length($loc) > $maxlength;
3504 push @d, &{$escape_function}($loc);
3507 # Display of seconds_since_sqlradacct:
3508 # On the invoice, when processing @detail_items, look for a field
3509 # named 'seconds'. This will contain total seconds for each
3510 # service, in the same order as @ext_description. For services
3511 # that don't support this it will show undef.
3512 if ( $conf->exists('svc_acct-usage_seconds')
3513 and ! $cust_bill_pkg->pkgpart_override ) {
3514 foreach my $cust_svc (
3515 $cust_pkg->h_cust_svc(@dates, 'I')
3518 # eval because not having any part_export_usage exports
3519 # is a fatal error, last_bill/_date because that's how
3520 # sqlradius_hour billing does it
3522 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3524 push @seconds, $sec;
3526 } #if svc_acct-usage_seconds
3528 } # if we are showing service labels
3530 unless ( $is_summary ) {
3531 warn "$me _items_cust_bill_pkg adding details\n"
3534 #instead of omitting details entirely in this case (unwanted side
3535 # effects), just omit CDRs
3536 $details_opt{'no_usage'} = 1
3537 if $type && $type eq 'R';
3539 push @d, $cust_bill_pkg->details(%details_opt);
3542 warn "$me _items_cust_bill_pkg calculating amount\n"
3547 $amount = $cust_bill_pkg->recur;
3548 } elsif ($type eq 'R') {
3549 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3550 } elsif ($type eq 'U') {
3551 $amount = $cust_bill_pkg->usage;
3554 if ( !$type || $type eq 'R' ) {
3556 warn "$me _items_cust_bill_pkg adding recur\n"
3560 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3563 if ( $cust_bill_pkg->hidden ) {
3564 $r->{amount} += $amount;
3565 $r->{unit_amount} += $unit_amount;
3566 push @{ $r->{ext_description} }, @d;
3569 description => $description,
3570 pkgpart => $pkgpart,
3571 pkgnum => $cust_bill_pkg->pkgnum,
3573 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3574 unit_amount => $unit_amount,
3575 quantity => $cust_bill_pkg->quantity,
3577 ext_description => \@d,
3578 svc_label => ($svc_label || ''),
3579 locationnum => $cust_pkg->locationnum,
3581 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3584 } else { # $type eq 'U'
3586 warn "$me _items_cust_bill_pkg adding usage\n"
3589 if ( $cust_bill_pkg->hidden and defined($u) ) {
3590 # if this is a hidden package and there's already a usage
3591 # line for the bundle, add this package's total amount and
3592 # usage details to it
3593 $u->{amount} += $amount;
3594 push @{ $u->{ext_description} }, @d;
3595 } elsif ( $amount ) {
3596 # create a new usage line
3598 description => $description,
3599 pkgpart => $pkgpart,
3600 pkgnum => $cust_bill_pkg->pkgnum,
3603 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3605 ext_description => \@d,
3606 locationnum => $cust_pkg->locationnum,
3608 } # else this has no usage, so don't create a usage section
3611 } # recurring or usage with recurring charge
3613 } else { # taxes and fees
3615 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3618 # items of this kind should normally not have sdate/edate.
3620 'description' => $desc,
3621 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3622 + $cust_bill_pkg->recur)
3625 } # if quotation / package line item / other line item
3627 # decide whether to show active discounts here
3629 # case 1: we are showing a single line for the package
3631 # case 2: we are showing a setup line for a package that has
3632 # no base recurring fee
3633 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3634 # case 3: we are showing a recur line for a package that has
3635 # a base recurring fee
3636 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3639 my $item_discount = $cust_bill_pkg->_item_discount;
3640 if ( $item_discount ) {
3641 # $item_discount->{amount} is negative
3643 if ( $d and $cust_bill_pkg->hidden ) {
3644 $d->{amount} += $item_discount->{amount};
3646 $d = $item_discount;
3647 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3650 # update the active line (before the discount) to show the
3651 # original price (whether this is a hidden line or not)
3653 # quotation discounts keep track of setup and recur; invoice
3654 # discounts currently don't
3655 if ( exists $item_discount->{setup_amount} ) {
3657 $s->{amount} -= $item_discount->{setup_amount} if $s;
3658 $r->{amount} -= $item_discount->{recur_amount} if $r;
3662 # $active_line is the line item hashref for the line that will
3663 # show the original price
3664 # (use the recur or single line for the package, unless we're
3665 # showing a setup line for a package with no recurring fee)
3666 my $active_line = $r;
3667 if ( $type eq 'S' ) {
3670 $active_line->{amount} -= $item_discount->{amount};
3674 } # if there are any discounts
3675 } # if this is an appropriate place to show discounts
3677 } # foreach $display
3681 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3683 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3684 if exists($_->{amount});
3685 $_->{amount} =~ s/^\-0\.00$/0.00/;
3686 if (exists($_->{unit_amount})) {
3687 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3691 #if $_->{amount} != 0
3692 # || $discount_show_always
3693 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3694 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3698 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3705 =item _items_discounts_avail
3707 Returns an array of line item hashrefs representing available term discounts
3708 for this invoice. This makes the same assumptions that apply to term
3709 discounts in general: that the package is billed monthly, at a flat rate,
3710 with no usage charges. A prorated first month will be handled, as will
3711 a setup fee if the discount is allowed to apply to setup fees.
3715 sub _items_discounts_avail {
3718 #maybe move this method from cust_bill when quotations support discount_plans
3719 return () unless $self->can('discount_plans');
3720 my %plans = $self->discount_plans;
3722 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3723 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3727 my $plan = $plans{$months};
3729 my $term_total = sprintf('%.2f', $plan->discounted_total);
3730 my $percent = sprintf('%.0f',
3731 100 * (1 - $term_total / $plan->base_total) );
3732 my $permonth = sprintf('%.2f', $term_total / $months);
3733 my $detail = $self->mt('discount on item'). ' '.
3734 join(', ', map { "#$_" } $plan->pkgnums)
3737 # discounts for non-integer months don't work anyway
3738 $months = sprintf("%d", $months);
3741 description => $self->mt('Save [_1]% by paying for [_2] months',
3743 amount => $self->mt('[_1] ([_2] per month)',
3744 $term_total, $money_char.$permonth),
3745 ext_description => ($detail || ''),
3748 sort { $b <=> $a } keys %plans;