1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
7 use vars qw( $invoice_lines @buf ); #yuck
8 use List::Util qw(sum);
11 use Text::Template 1.20;
17 use FS::Record qw( qsearch qsearchs );
19 use FS::Misc qw( generate_ps generate_pdf );
26 $me = '[FS::Template_Mixin]';
27 FS::UID->install_callback( sub {
28 my $conf = new FS::Conf; #global
29 $money_char = $conf->config('money_char') || '$';
34 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
36 If the "mode" pseudo-field is set on the object, the configuration handle
37 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
44 my $mode = $self->get('mode');
45 if ($self->{_conf} and !defined($mode)) {
46 return $self->{_conf};
49 my $cust_main = $self->cust_main;
50 my $locale = $cust_main ? $cust_main->locale : '';
53 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
54 $mode = $mode->modenum;
55 } elsif ( $mode =~ /\D/ ) {
56 die "invalid invoice mode $mode";
58 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
60 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
61 # it doesn't have a locale, but system conf still might
62 $conf->set('locale' => $locale) if $conf;
65 # if $mode is unspecified, or if there is no invoice_conf matching this mode
66 # and locale, then use the system config only (but with the locale)
67 $conf ||= FS::Conf->new({ 'locale' => $locale });
69 return $self->{_conf} = $conf;
72 =item print_text OPTIONS
74 Returns an text invoice, as a list of lines.
76 Options can be passed as a hash.
78 I<time>, if specified, is used to control the printing of overdue messages. The
79 default is now. It isn't the date of the invoice; that's the `_date' field.
80 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
81 L<Time::Local> and L<Date::Parse> for conversion functions.
83 I<template>, if specified, is the name of a suffix for alternate invoices.
85 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
93 %params = %{ shift() };
98 $params{'format'} = 'template'; # for some reason
100 $self->print_generic( %params );
103 =item print_latex HASHREF
105 Internal method - returns a filename of a filled-in LaTeX template for this
106 invoice (Note: add ".tex" to get the actual filename), and a filename of
107 an associated logo (with the .eps extension included).
109 See print_ps and print_pdf for methods that return PostScript and PDF output.
111 Options can be passed as a hash.
113 I<time>, if specified, is used to control the printing of overdue messages. The
114 default is now. It isn't the date of the invoice; that's the `_date' field.
115 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
116 L<Time::Local> and L<Date::Parse> for conversion functions.
118 I<template>, if specified, is the name of a suffix for alternate invoices.
119 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
120 customize invoice templates for different purposes.
122 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
131 %params = %{ shift() };
136 $params{'format'} = 'latex';
137 my $conf = $self->conf;
139 # this needs to go away
140 my $template = $params{'template'};
141 # and this especially
142 $template ||= $self->_agent_template
143 if $self->can('_agent_template');
145 my $pkey = $self->primary_key;
146 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
148 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
149 my $lh = new File::Temp(
150 TEMPLATE => $tmp_template,
154 ) or die "can't open temp file: $!\n";
156 my $agentnum = $self->agentnum;
158 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
159 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
160 or die "can't write temp file: $!\n";
162 print $lh $conf->config_binary('logo.eps', $agentnum)
163 or die "can't write temp file: $!\n";
166 $params{'logo_file'} = $lh->filename;
168 if( $conf->exists('invoice-barcode')
169 && $self->can('invoice_barcode')
170 && $self->invnum ) { # don't try to barcode statements
171 my $png_file = $self->invoice_barcode($dir);
172 my $eps_file = $png_file;
173 $eps_file =~ s/\.png$/.eps/g;
174 $png_file =~ /(barcode.*png)/;
176 $eps_file =~ /(barcode.*eps)/;
179 my $curr_dir = cwd();
181 # after painfuly long experimentation, it was determined that sam2p won't
182 # accept : and other chars in the path, no matter how hard I tried to
183 # escape them, hence the chdir (and chdir back, just to be safe)
184 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
185 or die "sam2p failed: $!\n";
189 $params{'barcode_file'} = $eps_file;
192 my @filled_in = $self->print_generic( %params );
194 my $fh = new File::Temp( TEMPLATE => $tmp_template,
198 ) or die "can't open temp file: $!\n";
199 binmode($fh, ':utf8'); # language support
200 print $fh join('', @filled_in );
203 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
204 return ($1, $params{'logo_file'}, $params{'barcode_file'});
210 my $cust_main = $self->cust_main;
211 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
214 =item print_generic OPTION => VALUE ...
216 Internal method - returns a filled-in template for this invoice as a scalar.
218 See print_ps and print_pdf for methods that return PostScript and PDF output.
220 Non optional options include
221 format - latex, html, template
223 Optional options include
225 template - a value used as a suffix for a configuration template. Please
228 time - a value used to control the printing of overdue messages. The
229 default is now. It isn't the date of the invoice; that's the `_date' field.
230 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
231 L<Time::Local> and L<Date::Parse> for conversion functions.
235 unsquelch_cdr - overrides any per customer cdr squelching when true
237 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
239 locale - override customer's locale
243 #what's with all the sprintf('%10.2f')'s in here? will it cause any
244 # (alignment in text invoice?) problems to change them all to '%.2f' ?
245 # yes: fixed width/plain text printing will be borked
247 my( $self, %params ) = @_;
248 my $conf = $self->conf;
250 my $today = $params{today} ? $params{today} : time;
251 warn "$me print_generic called on $self with suffix $params{template}\n"
254 my $format = $params{format};
255 die "Unknown format: $format"
256 unless $format =~ /^(latex|html|template)$/;
258 my $cust_main = $self->cust_main || $self->prospect_main;
259 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
260 unless $cust_main->payname
261 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
263 my $locale = $params{'locale'} || $cust_main->locale;
265 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
266 'html' => [ '<%=', '%>' ],
267 'template' => [ '{', '}' ],
270 warn "$me print_generic creating template\n"
273 # set the notice name here, and nowhere else.
274 my $notice_name = $params{notice_name}
275 || $conf->config('notice_name')
276 || $self->notice_name;
279 my $template = $params{template} ? $params{template} : $self->_agent_template;
280 my $templatefile = $self->template_conf. $format;
281 $templatefile .= "_$template"
282 if length($template) && $conf->exists($templatefile."_$template");
285 my @invoice_template = map "$_\n", $conf->config($templatefile)
286 or die "cannot load config data $templatefile";
289 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
290 #change this to a die when the old code is removed
291 warn "old-style invoice template $templatefile; ".
292 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
294 @invoice_template = _translate_old_latex_format(@invoice_template);
297 warn "$me print_generic creating T:T object\n"
300 my $text_template = new Text::Template(
302 SOURCE => \@invoice_template,
303 DELIMITERS => $delimiters{$format},
306 warn "$me print_generic compiling T:T object\n"
309 $text_template->compile()
310 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
313 # additional substitution could possibly cause breakage in existing templates
316 'notes' => sub { map "$_", @_ },
317 'footer' => sub { map "$_", @_ },
318 'smallfooter' => sub { map "$_", @_ },
319 'returnaddress' => sub { map "$_", @_ },
320 'coupon' => sub { map "$_", @_ },
321 'summary' => sub { map "$_", @_ },
327 s/%%(.*)$/<!-- $1 -->/g;
328 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
329 s/\\begin\{enumerate\}/<ol>/g;
331 s/\\end\{enumerate\}/<\/ol>/g;
332 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
341 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
343 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
349 s/\\hyphenation\{[\w\s\-]+}//;
354 'coupon' => sub { "" },
355 'summary' => sub { "" },
362 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
363 s/\\begin\{enumerate\}//g;
365 s/\\end\{enumerate\}//g;
366 s/\\textbf\{(.*)\}/$1/g;
373 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
375 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
380 s/\\\\\*?\s*$/\n/; # dubious
381 s/\\hyphenation\{[\w\s\-]+}//;
385 'coupon' => sub { "" },
386 'summary' => sub { "" },
391 # hashes for differing output formats
392 my %nbsps = ( 'latex' => '~',
393 'html' => '', # '&nbps;' would be nice
394 'template' => '', # not used
396 my $nbsp = $nbsps{$format};
398 my %escape_functions = ( 'latex' => \&_latex_escape,
399 'html' => \&_html_escape_nbsp,#\&encode_entities,
400 'template' => sub { shift },
402 my $escape_function = $escape_functions{$format};
403 my $escape_function_nonbsp = ($format eq 'html')
404 ? \&_html_escape : $escape_function;
406 my %newline_tokens = ( 'latex' => '\\\\',
410 my $newline_token = $newline_tokens{$format};
412 warn "$me generating template variables\n"
415 # generate template variables
419 defined( $conf->config_orbase( "invoice_${format}returnaddress",
423 && length( $conf->config_orbase( "invoice_${format}returnaddress",
429 $returnaddress = join("\n",
430 $conf->config_orbase("invoice_${format}returnaddress", $template)
434 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
436 my $convert_map = $convert_maps{$format}{'returnaddress'};
439 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
444 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
446 my $convert_map = $convert_maps{$format}{'returnaddress'};
447 $returnaddress = join( "\n", &$convert_map(
448 map { s/( {2,})/'~' x length($1)/eg;
452 ( $conf->config('company_name', $cust_main->agentnum),
453 $conf->config('company_address', $cust_main->agentnum),
460 my $warning = "Couldn't find a return address; ".
461 "do you need to set the company_address configuration value?";
463 $returnaddress = $nbsp;
464 #$returnaddress = $warning;
468 warn "$me generating invoice data\n"
471 my $agentnum = $cust_main->agentnum;
476 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
477 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
478 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
479 'returnaddress' => $returnaddress,
480 'agent' => &$escape_function($cust_main->agent->agent),
482 #invoice/quotation info
483 'no_number' => $params{'no_number'},
484 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
485 'quotationnum' => $self->quotationnum,
486 'no_date' => $params{'no_date'},
487 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
488 # workaround for inconsistent behavior in the early plain text
489 # templates; see RT#28271
490 'date' => ( $params{'no_date'}
492 : ($format eq 'template'
494 : $self->time2str_local('long', $self->_date, $format)
497 'today' => $self->time2str_local('long', $today, $format),
498 'terms' => $self->terms,
499 'template' => $template, #params{'template'},
500 'notice_name' => $notice_name, # escape?
501 'current_charges' => sprintf("%.2f", $self->charged),
502 'duedate' => $self->due_date2str('rdate'), #date_format?
505 'custnum' => $cust_main->display_custnum,
506 'prospectnum' => $cust_main->prospectnum,
507 'agent_custid' => &$escape_function($cust_main->agent_custid),
508 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
509 payname company address1 address2 city state zip fax
513 'ship_enable' => $conf->exists('invoice-ship_address'),
514 'unitprices' => $conf->exists('invoice-unitprice'),
515 'smallernotes' => $conf->exists('invoice-smallernotes'),
516 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
517 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
519 #layout info -- would be fancy to calc some of this and bury the template
521 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
522 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
523 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
524 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
525 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
526 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
527 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
528 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
529 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
530 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
532 # better hang on to conf_dir for a while (for old templates)
533 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
535 #these are only used when doing paged plaintext
542 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
543 # prototype here to silence warnings
544 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
546 my $min_sdate = 999999999999;
548 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
549 next unless $cust_bill_pkg->pkgnum > 0;
550 $min_sdate = $cust_bill_pkg->sdate
551 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
552 $max_edate = $cust_bill_pkg->edate
553 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
556 $invoice_data{'bill_period'} = '';
557 $invoice_data{'bill_period'} =
558 $self->time2str_local('%e %h', $min_sdate, $format)
560 $self->time2str_local('%e %h', $max_edate, $format)
561 if ($max_edate != 0 && $min_sdate != 999999999999);
563 $invoice_data{finance_section} = '';
564 if ( $conf->config('finance_pkgclass') ) {
566 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
567 $invoice_data{finance_section} = $pkg_class->categoryname;
569 $invoice_data{finance_amount} = '0.00';
570 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
572 my $countrydefault = $conf->config('countrydefault') || 'US';
573 foreach ( qw( address1 address2 city state zip country fax) ){
574 my $method = 'ship_'.$_;
575 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
577 if ( length($cust_main->ship_company) ) {
578 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
580 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
582 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
583 $invoice_data{'ship_country'} = ''
584 if ( $invoice_data{'ship_country'} eq $countrydefault );
586 $invoice_data{'cid'} = $params{'cid'}
589 if ( $cust_main->country eq $countrydefault ) {
590 $invoice_data{'country'} = '';
592 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
596 $invoice_data{'address'} = \@address;
599 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
600 ? " (P.O. #". $cust_main->payinfo. ")"
604 push @address, $cust_main->company
605 if $cust_main->company;
606 push @address, $cust_main->address1;
607 push @address, $cust_main->address2
608 if $cust_main->address2;
610 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
611 push @address, $invoice_data{'country'}
612 if $invoice_data{'country'};
614 while (scalar(@address) < 5);
616 $invoice_data{'logo_file'} = $params{'logo_file'}
617 if $params{'logo_file'};
618 $invoice_data{'barcode_file'} = $params{'barcode_file'}
619 if $params{'barcode_file'};
620 $invoice_data{'barcode_img'} = $params{'barcode_img'}
621 if $params{'barcode_img'};
622 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
623 if $params{'barcode_cid'};
625 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
626 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
627 #my $balance_due = $self->owed + $pr_total - $cr_total;
628 my $balance_due = $self->owed + $pr_total;
630 #these are used on the summary page only
632 # the customer's current balance as shown on the invoice before this one
633 $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
635 # the change in balance from that invoice to this one
636 $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
638 # the sum of amount owed on all previous invoices
639 # ($pr_total is used elsewhere but not as $previous_balance)
640 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
642 # the sum of amount owed on all invoices
643 # (this is used in the summary & on the payment coupon)
644 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
646 # info from customer's last invoice before this one, for some
648 $invoice_data{'last_bill'} = {};
650 if ( $self->custnum && $self->invnum ) {
652 if ( $self->previous_bill ) {
653 my $last_bill = $self->previous_bill;
654 $invoice_data{'last_bill'} = {
655 '_date' => $last_bill->_date, #unformatted
657 my (@payments, @credits);
658 # for formats that itemize previous payments
659 foreach my $cust_pay ( qsearch('cust_pay', {
660 'custnum' => $self->custnum,
661 '_date' => { op => '>=',
662 value => $last_bill->_date }
665 next if $cust_pay->_date > $self->_date;
667 '_date' => $cust_pay->_date,
668 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
669 'payinfo' => $cust_pay->payby_payinfo_pretty,
670 'amount' => sprintf('%.2f', $cust_pay->paid),
672 # not concerned about applications
674 foreach my $cust_credit ( qsearch('cust_credit', {
675 'custnum' => $self->custnum,
676 '_date' => { op => '>=',
677 value => $last_bill->_date }
680 next if $cust_credit->_date > $self->_date;
682 '_date' => $cust_credit->_date,
683 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
684 'creditreason'=> $cust_credit->reason,
685 'amount' => sprintf('%.2f', $cust_credit->amount),
688 $invoice_data{'previous_payments'} = \@payments;
689 $invoice_data{'previous_credits'} = \@credits;
694 my $summarypage = '';
695 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
698 $invoice_data{'summarypage'} = $summarypage;
700 warn "$me substituting variables in notes, footer, smallfooter\n"
703 my $tc = $self->template_conf;
704 my @include = ( [ $tc, 'notes' ],
705 [ 'invoice_', 'footer' ],
706 [ 'invoice_', 'smallfooter', ],
708 push @include, [ $tc, 'coupon', ]
709 unless $params{'no_coupon'};
711 foreach my $i (@include) {
713 my($base, $include) = @$i;
715 my $inc_file = $conf->key_orbase("$base$format$include", $template);
718 if ( $conf->exists($inc_file, $agentnum)
719 && length( $conf->config($inc_file, $agentnum) ) ) {
721 @inc_src = $conf->config($inc_file, $agentnum);
725 $inc_file = $conf->key_orbase("${base}latex$include", $template);
727 my $convert_map = $convert_maps{$format}{$include};
729 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
730 s/--\@\]/$delimiters{$format}[1]/g;
733 &$convert_map( $conf->config($inc_file, $agentnum) );
737 my $inc_tt = new Text::Template (
739 SOURCE => [ map "$_\n", @inc_src ],
740 DELIMITERS => $delimiters{$format},
741 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
743 unless ( $inc_tt->compile() ) {
744 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
745 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
749 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
751 $invoice_data{$include} =~ s/\n+$//
752 if ($format eq 'latex');
755 # let invoices use either of these as needed
756 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
757 ? $cust_main->payinfo : '';
758 $invoice_data{'po_line'} =
759 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
760 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
763 my %money_chars = ( 'latex' => '',
764 'html' => $conf->config('money_char') || '$',
767 my $money_char = $money_chars{$format};
769 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
770 'html' => $conf->config('money_char') || '$',
773 my $other_money_char = $other_money_chars{$format};
774 $invoice_data{'dollar'} = $other_money_char;
776 my %minus_signs = ( 'latex' => '$-$',
778 'template' => '- ' );
779 my $minus = $minus_signs{$format};
781 my @detail_items = ();
782 my @total_items = ();
786 $invoice_data{'detail_items'} = \@detail_items;
787 $invoice_data{'total_items'} = \@total_items;
788 $invoice_data{'buf'} = \@buf;
789 $invoice_data{'sections'} = \@sections;
791 warn "$me generating sections\n"
795 my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
796 'subtotal' => $taxtotal, # adjusted below
799 my $tax_weight = _pkg_category($tax_section->{description})
800 ? _pkg_category($tax_section->{description})->weight
802 $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
803 $tax_section->{'sort_weight'} = $tax_weight;
806 my $adjust_section = {
807 'description' => $self->mt('Credits, Payments, and Adjustments'),
808 'adjust_section' => 1,
809 'subtotal' => 0, # adjusted below
811 my $adjust_weight = _pkg_category($adjust_section->{description})
812 ? _pkg_category($adjust_section->{description})->weight
814 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
815 $adjust_section->{'sort_weight'} = $adjust_weight;
817 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
818 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
819 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
820 $invoice_data{'multisection'} = $multisection;
822 my $extra_sections = [];
823 my $extra_lines = ();
825 # default section ('Charges')
826 my $default_section = { 'description' => '',
831 # Previous Charges section
832 # subtotal is the first return value from $self->previous
833 my $previous_section;
834 # if the invoice has major sections, or if we're summarizing previous
835 # charges with a single line, or if we've been specifically told to put them
836 # in a section, create a section for previous charges:
837 if ( $multisection or
838 $conf->exists('previous_balance-summary_only') or
839 $conf->exists('previous_balance-section') ) {
841 $previous_section = { 'description' => $self->mt('Previous Charges'),
842 'subtotal' => $other_money_char.
843 sprintf('%.2f', $pr_total),
844 'summarized' => '', #why? $summarypage ? 'Y' : '',
846 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
847 join(' / ', map { $cust_main->balance_date_range(@$_) }
848 $self->_prior_month30s
850 if $conf->exists('invoice_include_aging');
853 # otherwise put them in the main section
854 $previous_section = $default_section;
857 if ( $multisection ) {
858 ($extra_sections, $extra_lines) =
859 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
860 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
861 && $self->can('_items_extra_usage_sections');
863 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
865 push @detail_items, @$extra_lines if $extra_lines;
867 # the code is written so that both methods can be used together, but
868 # we haven't yet changed the template to take advantage of that, so for
869 # now, treat them as mutually exclusive.
870 my %section_method = ( by_category => 1 );
871 if ( $conf->exists($tc.'sections_by_location') ) {
872 %section_method = ( by_location => 1 );
875 $self->_items_sections( 'summary' => $summarypage,
876 'escape' => $escape_function_nonbsp,
877 'extra_sections' => $extra_sections,
881 push @sections, @$early;
882 $late_sections = $late;
884 if ( $conf->exists('svc_phone_sections')
885 && $self->can('_items_svc_phone_sections')
888 my ($phone_sections, $phone_lines) =
889 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
890 push @{$late_sections}, @$phone_sections;
891 push @detail_items, @$phone_lines;
893 if ( $conf->exists('voip-cust_accountcode_cdr')
894 && $cust_main->accountcode_cdr
895 && $self->can('_items_accountcode_cdr')
898 my ($accountcode_section, $accountcode_lines) =
899 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
900 if ( scalar(@$accountcode_lines) ) {
901 push @{$late_sections}, $accountcode_section;
902 push @detail_items, @$accountcode_lines;
905 } else {# not multisection
906 # make a default section
907 push @sections, $default_section;
908 # and calculate the finance charge total, since it won't get done otherwise.
909 # and the default section total
910 # XXX possibly finance_pkgclass should not be used in this manner?
913 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
914 if ( $invoice_data{finance_section} and
915 grep { $_->section eq $invoice_data{finance_section} }
916 $cust_bill_pkg->cust_bill_pkg_display ) {
917 # I think these are always setup fees, but just to be sure...
918 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
920 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
923 $invoice_data{finance_amount} =
924 sprintf('%.2f', sum( @finance_charges ) || 0);
925 $default_section->{subtotal} = $other_money_char.
926 sprintf('%.2f', sum( @charges ) || 0);
929 # previous invoice balances in the Previous Charges section if there
930 # is one, otherwise in the main detail section
931 # (except if summary_only is enabled, don't show them at all)
932 if ( $self->can('_items_previous') &&
933 $self->enable_previous &&
934 ! $conf->exists('previous_balance-summary_only') ) {
936 warn "$me adding previous balances\n"
939 foreach my $line_item ( $self->_items_previous ) {
942 ref => $line_item->{'pkgnum'},
943 pkgpart => $line_item->{'pkgpart'},
944 #quantity => 1, # not really correct
945 section => $previous_section, # which might be $default_section
946 description => &$escape_function($line_item->{'description'}),
947 ext_description => [ map { &$escape_function($_) }
948 @{ $line_item->{'ext_description'} || [] }
950 amount => ( $old_latex ? '' : $money_char).
951 $line_item->{'amount'},
952 product_code => $line_item->{'pkgpart'} || 'N/A',
955 push @detail_items, $detail;
956 push @buf, [ $detail->{'description'},
957 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
963 if ( @pr_cust_bill && $self->enable_previous ) {
964 push @buf, ['','-----------'];
965 push @buf, [ $self->mt('Total Previous Balance'),
966 $money_char. sprintf("%10.2f", $pr_total) ];
970 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
971 warn "$me adding DID summary\n"
974 my ($didsummary,$minutes) = $self->_did_summary;
975 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
977 { 'description' => $didsummary_desc,
978 'ext_description' => [ $didsummary, $minutes ],
982 foreach my $section (@sections, @$late_sections) {
984 # begin some normalization
985 $section->{'subtotal'} = $section->{'amount'}
987 && !exists($section->{subtotal})
988 && exists($section->{amount});
990 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
991 if ( $invoice_data{finance_section} &&
992 $section->{'description'} eq $invoice_data{finance_section} );
994 $section->{'subtotal'} = $other_money_char.
995 sprintf('%.2f', $section->{'subtotal'})
998 # continue some normalization
999 $section->{'amount'} = $section->{'subtotal'}
1003 if ( $section->{'description'} ) {
1004 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1009 warn "$me setting options\n"
1013 $options{'section'} = $section if $multisection;
1014 $options{'format'} = $format;
1015 $options{'escape_function'} = $escape_function;
1016 $options{'no_usage'} = 1 unless $unsquelched;
1017 $options{'unsquelched'} = $unsquelched;
1018 $options{'summary_page'} = $summarypage;
1019 $options{'skip_usage'} =
1020 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1022 warn "$me searching for line items\n"
1025 foreach my $line_item ( $self->_items_pkg(%options),
1026 $self->_items_fee(%options) ) {
1028 warn "$me adding line item $line_item\n"
1033 # ext_description => [],
1035 #$detail->{'ref'} = $line_item->{'pkgnum'};
1036 #$detail->{'pkgpart'} = $line_item->{'pkgpart'};
1037 #$detail->{'quantity'} = $line_item->{'quantity'};
1038 #$detail->{'section'} = $section;
1039 #$detail->{'description'} = &$escape_function($line_item->{'description'});
1040 #if ( exists $line_item->{'ext_description'} ) {
1041 # @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
1043 #$detail->{'amount'} = ( $old_latex ? '' : $money_char ).
1044 # $line_item->{'amount'};
1045 #if ( exists $line_item->{'unit_amount'} ) {
1046 # $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
1047 # $line_item->{'unit_amount'};
1049 #$detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1051 #$detail->{'sdate'} = $line_item->{'sdate'};
1052 #$detail->{'edate'} = $line_item->{'edate'};
1053 #$detail->{'seconds'} = $line_item->{'seconds'};
1054 #$detail->{'svc_label'} = $line_item->{'svc_label'};
1055 #$detail->{'usage_item'} = $line_item->{'usage_item'};
1056 $line_item->{'ref'} = $line_item->{'pkgnum'};
1057 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1058 $line_item->{'section'} = $section;
1059 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1060 if (!$old_latex) { # dubious; templates should provide this
1061 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1062 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1064 $line_item->{'ext_description'} ||= [];
1066 push @detail_items, $line_item;
1067 push @buf, ( [ $line_item->{'description'},
1068 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1070 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1074 if ( $section->{'description'} ) {
1075 push @buf, ( ['','-----------'],
1076 [ $section->{'description'}. ' sub-total',
1077 $section->{'subtotal'} # already formatted this
1086 $invoice_data{current_less_finance} =
1087 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1089 # if there's anything in the Previous Charges section, prepend it to the list
1090 if ( $pr_total and $previous_section ne $default_section ) {
1091 unshift @sections, $previous_section;
1094 warn "$me adding taxes\n"
1097 my @items_tax = $self->_items_tax;
1098 foreach my $tax ( @items_tax ) {
1100 $taxtotal += $tax->{'amount'};
1102 my $description = &$escape_function( $tax->{'description'} );
1103 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1105 if ( $multisection ) {
1107 my $money = $old_latex ? '' : $money_char;
1108 push @detail_items, {
1109 ext_description => [],
1112 description => $description,
1113 amount => $money. $amount,
1115 section => $tax_section,
1120 push @total_items, {
1121 'total_item' => $description,
1122 'total_amount' => $other_money_char. $amount,
1127 push @buf,[ $description,
1128 $money_char. $amount,
1135 $total->{'total_item'} = $self->mt('Sub-total');
1136 $total->{'total_amount'} =
1137 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1139 if ( $multisection ) {
1140 $tax_section->{'subtotal'} = $other_money_char.
1141 sprintf('%.2f', $taxtotal);
1142 $tax_section->{'pretotal'} = 'New charges sub-total '.
1143 $total->{'total_amount'};
1144 push @sections, $tax_section if $taxtotal;
1146 unshift @total_items, $total;
1149 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1151 push @buf,['','-----------'];
1152 push @buf,[$self->mt(
1153 (!$self->enable_previous)
1155 : 'Total New Charges'
1157 $money_char. sprintf("%10.2f",$self->charged) ];
1165 my %embolden_functions = (
1166 'latex' => sub { return '\textbf{'. shift(). '}' },
1167 'html' => sub { return '<b>'. shift(). '</b>' },
1168 'template' => sub { shift },
1170 my $embolden_function = $embolden_functions{$format};
1172 if ( $self->can('_items_total') ) { # quotations
1174 $self->_items_total(\@total_items);
1176 foreach ( @total_items ) {
1177 $_->{'total_item'} = &$embolden_function( $_->{'total_item'} );
1178 $_->{'total_amount'} = &$embolden_function( $other_money_char.
1179 $_->{'total_amount'}
1183 } else { #normal invoice case
1185 # calculate total, possibly including total owed on previous
1189 $item = $conf->config('previous_balance-exclude_from_total')
1190 || 'Total New Charges'
1191 if $conf->exists('previous_balance-exclude_from_total');
1192 my $amount = $self->charged;
1193 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1194 $amount += $pr_total;
1197 $total->{'total_item'} = &$embolden_function($self->mt($item));
1198 $total->{'total_amount'} =
1199 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
1200 if ( $multisection ) {
1201 if ( $adjust_section->{'sort_weight'} ) {
1202 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1203 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1205 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1206 $other_money_char. sprintf('%.2f', $self->charged );
1209 push @total_items, $total;
1211 push @buf,['','-----------'];
1214 sprintf( '%10.2f', $amount )
1218 # if we're showing previous invoices, also show previous
1219 # credits and payments
1220 if ( $self->enable_previous
1221 and $self->can('_items_credits')
1222 and $self->can('_items_payments') )
1224 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1227 my $credittotal = 0;
1228 foreach my $credit (
1229 $self->_items_credits( 'template' => $template, 'trim_len' => 60 )
1233 $total->{'total_item'} = &$escape_function($credit->{'description'});
1234 $credittotal += $credit->{'amount'};
1235 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1236 $adjusttotal += $credit->{'amount'};
1237 if ( $multisection ) {
1238 my $money = $old_latex ? '' : $money_char;
1239 push @detail_items, {
1240 ext_description => [],
1243 description => &$escape_function($credit->{'description'}),
1244 amount => $money. $credit->{'amount'},
1246 section => $adjust_section,
1249 push @total_items, $total;
1253 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1256 foreach my $credit (
1257 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1259 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1263 my $paymenttotal = 0;
1264 foreach my $payment (
1265 $self->_items_payments( 'template' => $template )
1268 $total->{'total_item'} = &$escape_function($payment->{'description'});
1269 $paymenttotal += $payment->{'amount'};
1270 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1271 $adjusttotal += $payment->{'amount'};
1272 if ( $multisection ) {
1273 my $money = $old_latex ? '' : $money_char;
1274 push @detail_items, {
1275 ext_description => [],
1278 description => &$escape_function($payment->{'description'}),
1279 amount => $money. $payment->{'amount'},
1281 section => $adjust_section,
1284 push @total_items, $total;
1286 push @buf, [ $payment->{'description'},
1287 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1290 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1292 if ( $multisection ) {
1293 $adjust_section->{'subtotal'} = $other_money_char.
1294 sprintf('%.2f', $adjusttotal);
1295 push @sections, $adjust_section
1296 unless $adjust_section->{sort_weight};
1299 # create Balance Due message
1302 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1303 $total->{'total_amount'} =
1304 &$embolden_function(
1305 $other_money_char. sprintf('%.2f', #why? $summarypage
1306 # ? $self->charged +
1307 # $self->billing_balance
1309 $self->owed + $pr_total
1312 if ( $multisection && !$adjust_section->{sort_weight} ) {
1313 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1314 $total->{'total_amount'};
1316 push @total_items, $total;
1318 push @buf,['','-----------'];
1319 push @buf,[$self->balance_due_msg, $money_char.
1320 sprintf("%10.2f", $balance_due ) ];
1323 if ( $conf->exists('previous_balance-show_credit')
1324 and $cust_main->balance < 0 ) {
1325 my $credit_total = {
1326 'total_item' => &$embolden_function($self->credit_balance_msg),
1327 'total_amount' => &$embolden_function(
1328 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1331 if ( $multisection ) {
1332 $adjust_section->{'posttotal'} .= $newline_token .
1333 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1336 push @total_items, $credit_total;
1338 push @buf,['','-----------'];
1339 push @buf,[$self->credit_balance_msg, $money_char.
1340 sprintf("%10.2f", -$cust_main->balance ) ];
1344 } #end of default total adding ! can('_items_total')
1346 if ( $multisection ) {
1347 if ( $conf->exists('svc_phone_sections')
1348 && $self->can('_items_svc_phone_sections')
1352 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1353 $total->{'total_amount'} =
1354 &$embolden_function(
1355 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1357 my $last_section = pop @sections;
1358 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1359 $total->{'total_amount'};
1360 push @sections, $last_section;
1362 push @sections, @$late_sections
1366 # make a discounts-available section, even without multisection
1367 if ( $conf->exists('discount-show_available')
1368 and my @discounts_avail = $self->_items_discounts_avail ) {
1369 my $discount_section = {
1370 'description' => $self->mt('Discounts Available'),
1375 push @sections, $discount_section;
1376 push @detail_items, map { +{
1377 'ref' => '', #should this be something else?
1378 'section' => $discount_section,
1379 'description' => &$escape_function( $_->{description} ),
1380 'amount' => $money_char . &$escape_function( $_->{amount} ),
1381 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1382 } } @discounts_avail;
1385 my @summary_subtotals;
1386 # the templates say "$_->{tax_section} || !$_->{summarized}"
1387 # except 'summarized' is only true when tax_section is true, so this
1388 # is always true, so what's the deal?
1389 foreach my $s (@sections) {
1390 # not to include in the "summary of new charges" block:
1391 # finance charges, adjustments, previous charges,
1392 # and itemized phone usage sections
1393 if ( $s eq $adjust_section or
1394 ($s eq $previous_section and $s ne $default_section) or
1395 ($invoice_data{'finance_section'} and
1396 $invoice_data{'finance_section'} eq $s->{description}) or
1397 $s->{'description'} =~ /^\d+ $/ ) {
1400 push @summary_subtotals, $s;
1402 $invoice_data{summary_subtotals} = \@summary_subtotals;
1405 if ( $conf->exists('usage_class_summary')
1406 and $self->can('_items_usage_class_summary') ) {
1407 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1408 if ( @usage_subtotals ) {
1409 unshift @sections, $usage_subtotals[0]->{section};
1410 unshift @detail_items, @usage_subtotals;
1414 # invoice history "section" (not really a section)
1415 # not to be included in any subtotals, completely independent of
1417 if ( $conf->exists('previous_invoice_history') ) {
1420 foreach my $cust_bill ( $cust_main->cust_bill ) {
1421 # XXX hardcoded format, and currently only 'charged'; add other fields
1422 # if they become necessary
1423 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1424 $history{$date} ||= 0;
1425 $history{$date} += $cust_bill->charged;
1426 # just so we have a numeric sort key
1427 $monthorder{$date} ||= $cust_bill->_date;
1429 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1431 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1432 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1435 # service locations: another option for template customization
1437 foreach my $item (@detail_items) {
1438 if ( $item->{locationnum} ) {
1439 $location_info{ $item->{locationnum} } ||= {
1440 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1444 $invoice_data{location_info} = \%location_info;
1446 # debugging hook: call this with 'diag' => 1 to just get a hash of
1447 # the invoice variables
1448 return \%invoice_data if ( $params{'diag'} );
1450 # All sections and items are built; now fill in templates.
1451 my @includelist = ();
1452 push @includelist, 'summary' if $summarypage;
1453 foreach my $include ( @includelist ) {
1455 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1458 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1460 @inc_src = $conf->config($inc_file, $agentnum);
1464 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1466 my $convert_map = $convert_maps{$format}{$include};
1468 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1469 s/--\@\]/$delimiters{$format}[1]/g;
1472 &$convert_map( $conf->config($inc_file, $agentnum) );
1476 my $inc_tt = new Text::Template (
1478 SOURCE => [ map "$_\n", @inc_src ],
1479 DELIMITERS => $delimiters{$format},
1480 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1482 unless ( $inc_tt->compile() ) {
1483 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1484 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1488 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1490 $invoice_data{$include} =~ s/\n+$//
1491 if ($format eq 'latex');
1496 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1497 /invoice_lines\((\d*)\)/;
1498 $invoice_lines += $1 || scalar(@buf);
1501 die "no invoice_lines() functions in template?"
1502 if ( $format eq 'template' && !$wasfunc );
1504 if ($format eq 'template') {
1506 if ( $invoice_lines ) {
1507 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1508 $invoice_data{'total_pages'}++
1509 if scalar(@buf) % $invoice_lines;
1512 #setup subroutine for the template
1513 $invoice_data{invoice_lines} = sub {
1514 my $lines = shift || scalar(@buf);
1526 push @collect, split("\n",
1527 $text_template->fill_in( HASH => \%invoice_data )
1529 $invoice_data{'page'}++;
1531 map "$_\n", @collect;
1533 } else { # this is where we actually create the invoice
1535 warn "filling in template for invoice ". $self->invnum. "\n"
1537 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1540 $text_template->fill_in(HASH => \%invoice_data);
1544 sub notice_name { '('.shift->table.')'; }
1546 sub template_conf { 'invoice_'; }
1548 # helper routine for generating date ranges
1549 sub _prior_month30s {
1552 [ 1, 2592000 ], # 0-30 days ago
1553 [ 2592000, 5184000 ], # 30-60 days ago
1554 [ 5184000, 7776000 ], # 60-90 days ago
1555 [ 7776000, 0 ], # 90+ days ago
1558 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1559 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1564 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1566 Returns an postscript invoice, as a scalar.
1568 Options can be passed as a hashref (recommended) or as a list of time, template
1569 and then any key/value pairs for any other options.
1571 I<time> an optional value used to control the printing of overdue messages. The
1572 default is now. It isn't the date of the invoice; that's the `_date' field.
1573 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1574 L<Time::Local> and L<Date::Parse> for conversion functions.
1576 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1583 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1584 my $ps = generate_ps($file);
1586 unlink($barcodefile) if $barcodefile;
1591 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1593 Returns an PDF invoice, as a scalar.
1595 Options can be passed as a hashref (recommended) or as a list of time, template
1596 and then any key/value pairs for any other options.
1598 I<time> an optional value used to control the printing of overdue messages. The
1599 default is now. It isn't the date of the invoice; that's the `_date' field.
1600 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1601 L<Time::Local> and L<Date::Parse> for conversion functions.
1603 I<template>, if specified, is the name of a suffix for alternate invoices.
1605 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1612 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1613 my $pdf = generate_pdf($file);
1615 unlink($barcodefile) if $barcodefile;
1620 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1622 Returns an HTML invoice, as a scalar.
1624 I<time> an optional value used to control the printing of overdue messages. The
1625 default is now. It isn't the date of the invoice; that's the `_date' field.
1626 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1627 L<Time::Local> and L<Date::Parse> for conversion functions.
1629 I<template>, if specified, is the name of a suffix for alternate invoices.
1631 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1633 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1634 when emailing the invoice as part of a multipart/related MIME email.
1642 %params = %{ shift() };
1646 $params{'format'} = 'html';
1648 $self->print_generic( %params );
1651 # quick subroutine for print_latex
1653 # There are ten characters that LaTeX treats as special characters, which
1654 # means that they do not simply typeset themselves:
1655 # # $ % & ~ _ ^ \ { }
1657 # TeX ignores blanks following an escaped character; if you want a blank (as
1658 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1662 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1663 $value =~ s/([<>])/\$$1\$/g;
1669 encode_entities($value);
1673 sub _html_escape_nbsp {
1674 my $value = _html_escape(shift);
1675 $value =~ s/ +/ /g;
1679 #utility methods for print_*
1681 sub _translate_old_latex_format {
1682 warn "_translate_old_latex_format called\n"
1689 if ( $line =~ /^%%Detail\s*$/ ) {
1691 push @template, q![@--!,
1692 q! foreach my $_tr_line (@detail_items) {!,
1693 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1694 q! $_tr_line->{'description'} .= !,
1695 q! "\\tabularnewline\n~~".!,
1696 q! join( "\\tabularnewline\n~~",!,
1697 q! @{$_tr_line->{'ext_description'}}!,
1701 while ( ( my $line_item_line = shift )
1702 !~ /^%%EndDetail\s*$/ ) {
1703 $line_item_line =~ s/'/\\'/g; # nice LTS
1704 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1705 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1706 push @template, " \$OUT .= '$line_item_line';";
1709 push @template, '}',
1712 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1714 push @template, '[@--',
1715 ' foreach my $_tr_line (@total_items) {';
1717 while ( ( my $total_item_line = shift )
1718 !~ /^%%EndTotalDetails\s*$/ ) {
1719 $total_item_line =~ s/'/\\'/g; # nice LTS
1720 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1721 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1722 push @template, " \$OUT .= '$total_item_line';";
1725 push @template, '}',
1729 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1730 push @template, $line;
1736 warn "$_\n" foreach @template;
1744 my $conf = $self->conf;
1746 #check for an invoice-specific override
1747 return $self->invoice_terms if $self->invoice_terms;
1749 #check for a customer- specific override
1750 my $cust_main = $self->cust_main;
1751 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1753 #use configured default
1754 $conf->config('invoice_default_terms') || '';
1760 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1761 $duedate = $self->_date() + ( $1 * 86400 );
1768 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1771 sub balance_due_msg {
1773 my $msg = $self->mt('Balance Due');
1774 return $msg unless $self->terms;
1775 if ( $self->due_date ) {
1776 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1777 $self->due_date2str('short');
1778 } elsif ( $self->terms ) {
1779 $msg .= ' - '. $self->terms;
1784 sub balance_due_date {
1786 my $conf = $self->conf;
1788 if ( $conf->exists('invoice_default_terms')
1789 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
1790 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1795 sub credit_balance_msg {
1797 $self->mt('Credit Balance Remaining')
1802 Returns a string with the date, for example: "3/20/2008"
1808 $self->time2str_local('short', $self->_date);
1811 =item _items_sections OPTIONS
1813 Generate section information for all items appearing on this invoice.
1814 This will only be called for multi-section invoices.
1816 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
1817 related display records (L<FS::cust_bill_pkg_display>) and organize
1818 them into two groups ("early" and "late" according to whether they come
1819 before or after the total), then into sections. A subtotal is calculated
1822 Section descriptions are returned in sort weight order. Each consists
1823 of a hash containing:
1825 description: the package category name, escaped
1826 subtotal: the total charges in that section
1827 tax_section: a flag indicating that the section contains only tax charges
1828 summarized: same as tax_section, for some reason
1829 sort_weight: the package category's sort weight
1831 If 'condense' is set on the display record, it also contains everything
1832 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
1833 coderefs to generate parts of the invoice. This is not advised.
1835 The method returns two arrayrefs, one of "early" sections and one of "late"
1838 OPTIONS may include:
1840 by_location: a flag to divide the invoice into sections by location.
1841 Each section hash will have a 'location' element containing a hashref of
1842 the location fields (see L<FS::cust_location>). The section description
1843 will be the location label, but the template can use any of the location
1844 fields to create a suitable label.
1846 by_category: a flag to divide the invoice into sections using display
1847 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
1848 behavior. Each section hash will have a 'category' element containing
1849 the section name from the display record (which probably equals the
1850 category name of the package, but may not in some cases).
1852 summary: a flag indicating that this is a summary-format invoice.
1853 Turning this on has the following effects:
1854 - Ignores display items with the 'summary' flag.
1855 - Places all sections in the "early" group even if they have post_total.
1856 - Creates sections for all non-disabled package categories, even if they
1857 have no charges on this invoice, as well as a section with no name.
1859 escape: an escape function to use for section titles.
1861 extra_sections: an arrayref of additional sections to return after the
1862 sorted list. If there are any of these, section subtotals exclude
1865 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
1866 passed through to C<_condense_section()>.
1870 use vars qw(%pkg_category_cache);
1871 sub _items_sections {
1875 my $escape = $opt{escape};
1876 my @extra_sections = @{ $opt{extra_sections} || [] };
1878 # $subtotal{$locationnum}{$categoryname} = amount.
1879 # if we're not using by_location, $locationnum is undef.
1880 # if we're not using by_category, you guessed it, $categoryname is undef.
1881 # if we're not using either one, we shouldn't be here in the first place...
1883 my %late_subtotal = ();
1886 # About tax items + multisection invoices:
1887 # If either invoice_*summary option is enabled, AND there is a
1888 # package category with the name of the tax, then there will be
1889 # a display record assigning the tax item to that category.
1891 # However, the taxes are always placed in the "Taxes, Surcharges,
1892 # and Fees" section regardless of that. The only effect of the
1893 # display record is to create a subtotal for the summary page.
1896 my $pkg_hash = $self->cust_pkg_hash;
1898 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
1901 my $usage = $cust_bill_pkg->usage;
1904 if ( $opt{by_location} ) {
1905 if ( $cust_bill_pkg->pkgnum ) {
1906 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
1911 $locationnum = undef;
1914 # as in _items_cust_pkg, if a line item has no display records,
1915 # cust_bill_pkg_display() returns a default record for it
1917 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
1918 next if ( $display->summary && $opt{summary} );
1920 my $section = $display->section;
1921 my $type = $display->type;
1922 # Set $section = undef if we're sectioning by location and this
1923 # line item _has_ a location (i.e. isn't a fee).
1924 $section = undef if $locationnum;
1926 # set this flag if the section is not tax-only
1927 $not_tax{$locationnum}{$section} = 1
1928 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
1930 # there's actually a very important piece of logic buried in here:
1931 # incrementing $late_subtotal{$section} CREATES
1932 # $late_subtotal{$section}. keys(%late_subtotal) is later used
1933 # to define the list of late sections, and likewise keys(%subtotal).
1934 # When _items_cust_bill_pkg is called to generate line items for
1935 # real, it will be called with 'section' => $section for each
1937 if ( $display->post_total && !$opt{summary} ) {
1938 if (! $type || $type eq 'S') {
1939 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
1940 if $cust_bill_pkg->setup != 0
1941 || $cust_bill_pkg->setup_show_zero;
1945 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
1946 if $cust_bill_pkg->recur != 0
1947 || $cust_bill_pkg->recur_show_zero;
1950 if ($type && $type eq 'R') {
1951 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
1952 if $cust_bill_pkg->recur != 0
1953 || $cust_bill_pkg->recur_show_zero;
1956 if ($type && $type eq 'U') {
1957 $late_subtotal{$locationnum}{$section} += $usage
1958 unless scalar(@extra_sections);
1961 } else { # it's a pre-total (normal) section
1963 # skip tax items unless they're explicitly included in a section
1964 next if $cust_bill_pkg->pkgnum == 0 and
1965 ! $cust_bill_pkg->feepart and
1968 if (! $type || $type eq 'S') {
1969 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
1970 if $cust_bill_pkg->setup != 0
1971 || $cust_bill_pkg->setup_show_zero;
1975 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
1976 if $cust_bill_pkg->recur != 0
1977 || $cust_bill_pkg->recur_show_zero;
1980 if ($type && $type eq 'R') {
1981 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
1982 if $cust_bill_pkg->recur != 0
1983 || $cust_bill_pkg->recur_show_zero;
1986 if ($type && $type eq 'U') {
1987 $subtotal{$locationnum}{$section} += $usage
1988 unless scalar(@extra_sections);
1997 %pkg_category_cache = ();
1999 # summary invoices need subtotals for all non-disabled package categories,
2000 # even if they're zero
2001 # but currently assume that there are no location sections, or at least
2002 # that the summary page doesn't care about them
2003 if ( $opt{summary} ) {
2004 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2005 $subtotal{''}{$category->categoryname} ||= 0;
2007 $subtotal{''}{''} ||= 0;
2011 foreach my $post_total (0,1) {
2013 my $s = $post_total ? \%late_subtotal : \%subtotal;
2014 foreach my $locationnum (keys %$s) {
2015 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2017 'subtotal' => $s->{$locationnum}{$sectionname},
2018 'post_total' => $post_total,
2021 if ( $locationnum ) {
2022 $section->{'locationnum'} = $locationnum;
2023 my $location = FS::cust_location->by_key($locationnum);
2024 $section->{'description'} = &{ $escape }($location->location_label);
2025 # Better ideas? This will roughly group them by proximity,
2026 # which alpha sorting on any of the address fields won't.
2027 # Sorting by locationnum is meaningless.
2028 # We have to sort on _something_ or the order may change
2029 # randomly from one invoice to the next, which will confuse
2031 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2033 $section->{'location'} = {
2034 map { $_ => &{ $escape }($location->get($_)) }
2038 $section->{'category'} = $sectionname;
2039 $section->{'description'} = &{ $escape }($sectionname);
2040 if ( _pkg_category($_) ) {
2041 $section->{'sort_weight'} = _pkg_category($_)->weight;
2042 if ( _pkg_category($_)->condense ) {
2043 $section = { %$section, $self->_condense_section($opt{format}) };
2047 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2048 # then it's a tax-only section
2049 $section->{'summarized'} = 'Y';
2050 $section->{'tax_section'} = 'Y';
2052 push @these, $section;
2053 } # foreach $sectionname
2054 } #foreach $locationnum
2055 push @these, @extra_sections if $post_total == 0;
2056 # need an alpha sort for location sections, because postal codes can
2058 $sections[ $post_total ] = [ sort {
2059 $opt{'by_location'} ?
2060 ($a->{sort_weight} cmp $b->{sort_weight}) :
2061 ($a->{sort_weight} <=> $b->{sort_weight})
2063 } #foreach $post_total
2065 return @sections; # early, late
2068 #helper subs for above
2072 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2076 my $categoryname = shift;
2077 $pkg_category_cache{$categoryname} ||=
2078 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2081 my %condensed_format = (
2082 'label' => [ qw( Description Qty Amount ) ],
2084 sub { shift->{description} },
2085 sub { shift->{quantity} },
2086 sub { my($href, %opt) = @_;
2087 ($opt{dollar} || ''). $href->{amount};
2090 'align' => [ qw( l r r ) ],
2091 'span' => [ qw( 5 1 1 ) ], # unitprices?
2092 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2095 sub _condense_section {
2096 my ( $self, $format ) = ( shift, shift );
2098 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2099 qw( description_generator
2102 total_line_generator
2107 sub _condensed_generator_defaults {
2108 my ( $self, $format ) = ( shift, shift );
2109 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2118 sub _condensed_header_generator {
2119 my ( $self, $format ) = ( shift, shift );
2121 my ( $f, $prefix, $suffix, $separator, $column ) =
2122 _condensed_generator_defaults($format);
2124 if ($format eq 'latex') {
2125 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2126 $suffix = "\\\\\n\\hline";
2129 sub { my ($d,$a,$s,$w) = @_;
2130 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2132 } elsif ( $format eq 'html' ) {
2133 $prefix = '<th></th>';
2137 sub { my ($d,$a,$s,$w) = @_;
2138 return qq!<th align="$html_align{$a}">$d</th>!;
2146 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2148 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2151 $prefix. join($separator, @result). $suffix;
2156 sub _condensed_description_generator {
2157 my ( $self, $format ) = ( shift, shift );
2159 my ( $f, $prefix, $suffix, $separator, $column ) =
2160 _condensed_generator_defaults($format);
2162 my $money_char = '$';
2163 if ($format eq 'latex') {
2164 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2166 $separator = " & \n";
2168 sub { my ($d,$a,$s,$w) = @_;
2169 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2171 $money_char = '\\dollar';
2172 }elsif ( $format eq 'html' ) {
2173 $prefix = '"><td align="center"></td>';
2177 sub { my ($d,$a,$s,$w) = @_;
2178 return qq!<td align="$html_align{$a}">$d</td>!;
2180 #$money_char = $conf->config('money_char') || '$';
2181 $money_char = ''; # this is madness
2189 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2191 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2193 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2194 map { $f->{$_}->[$i] } qw(align span width)
2198 $prefix. join( $separator, @result ). $suffix;
2203 sub _condensed_total_generator {
2204 my ( $self, $format ) = ( shift, shift );
2206 my ( $f, $prefix, $suffix, $separator, $column ) =
2207 _condensed_generator_defaults($format);
2210 if ($format eq 'latex') {
2213 $separator = " & \n";
2215 sub { my ($d,$a,$s,$w) = @_;
2216 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2218 }elsif ( $format eq 'html' ) {
2222 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2224 sub { my ($d,$a,$s,$w) = @_;
2225 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2234 # my $r = &{$f->{fields}->[$i]}(@args);
2235 # $r .= ' Total' unless $i;
2237 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2239 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2240 map { $f->{$_}->[$i] } qw(align span width)
2244 $prefix. join( $separator, @result ). $suffix;
2249 =item total_line_generator FORMAT
2251 Returns a coderef used for generation of invoice total line items for this
2252 usage_class. FORMAT is either html or latex
2256 # should not be used: will have issues with hash element names (description vs
2257 # total_item and amount vs total_amount -- another array of functions?
2259 sub _condensed_total_line_generator {
2260 my ( $self, $format ) = ( shift, shift );
2262 my ( $f, $prefix, $suffix, $separator, $column ) =
2263 _condensed_generator_defaults($format);
2266 if ($format eq 'latex') {
2269 $separator = " & \n";
2271 sub { my ($d,$a,$s,$w) = @_;
2272 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2274 }elsif ( $format eq 'html' ) {
2278 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2280 sub { my ($d,$a,$s,$w) = @_;
2281 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2290 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2292 &{$column}( &{$f->{fields}->[$i]}(@args),
2293 map { $f->{$_}->[$i] } qw(align span width)
2297 $prefix. join( $separator, @result ). $suffix;
2302 =item _items_pkg [ OPTIONS ]
2304 Return line item hashes for each package item on this invoice. Nearly
2307 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2309 The only OPTIONS accepted is 'section', which may point to a hashref
2310 with a key named 'condensed', which may have a true value. If it
2311 does, this method tries to merge identical items into items with
2312 'quantity' equal to the number of items (not the sum of their
2313 separate quantities, for some reason).
2319 # The order of these is important. Bundled line items will be merged into
2320 # the most recent non-hidden item, so it needs to be the one with:
2322 # - the same start date
2323 # - no pkgpart_override
2325 # So: sort by pkgnum,
2327 # then sort the base line item before any overrides
2328 # then sort hidden before non-hidden add-ons
2329 # then sort by override pkgpart (for consistency)
2330 sort { $a->pkgnum <=> $b->pkgnum or
2331 $a->sdate <=> $b->sdate or
2332 ($a->pkgpart_override ? 0 : -1) or
2333 ($b->pkgpart_override ? 0 : 1) or
2334 $b->hidden cmp $a->hidden or
2335 $a->pkgpart_override <=> $b->pkgpart_override
2337 # and of course exclude taxes and fees
2338 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2344 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2346 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2347 # cache this, so we don't look it up again in every section
2348 my $part_fee = $cust_bill_pkg->get('part_fee')
2349 || $cust_bill_pkg->part_fee;
2350 $cust_bill_pkg->set('part_fee', $part_fee);
2352 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2353 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2356 if ( exists($options{section}) and exists($options{section}{category}) )
2358 my $categoryname = $options{section}{category};
2359 # then filter for items that have that section
2360 if ( $part_fee->categoryname ne $categoryname ) {
2361 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2364 } # otherwise include them all in the main section
2365 # XXX what to do when sectioning by location?
2368 my %base_invnums; # invnum => invoice date
2369 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2370 if ($_->base_invnum) {
2371 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2372 my $base_date = $self->time2str_local('short', $base_bill->_date)
2374 $base_invnums{$_->base_invnum} = $base_date || '';
2377 foreach (sort keys(%base_invnums)) {
2378 next if $_ == $self->invnum;
2380 $self->mt('from invoice \\#[_1] on [_2]', $_, $base_invnums{$_});
2383 { feepart => $cust_bill_pkg->feepart,
2384 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2385 description => $part_fee->itemdesc_locale($self->cust_main->locale),
2386 ext_description => \@ext_desc
2397 warn "$me _items_pkg searching for all package line items\n"
2400 my @cust_bill_pkg = $self->_items_nontax;
2402 warn "$me _items_pkg filtering line items\n"
2404 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2406 if ($options{section} && $options{section}->{condensed}) {
2408 warn "$me _items_pkg condensing section\n"
2412 local $Storable::canonical = 1;
2413 foreach ( @items ) {
2415 delete $item->{ref};
2416 delete $item->{ext_description};
2417 my $key = freeze($item);
2418 $itemshash{$key} ||= 0;
2419 $itemshash{$key} ++; # += $item->{quantity};
2421 @items = sort { $a->{description} cmp $b->{description} }
2422 map { my $i = thaw($_);
2423 $i->{quantity} = $itemshash{$_};
2425 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2431 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2438 return 0 unless $a->itemdesc cmp $b->itemdesc;
2439 return -1 if $b->itemdesc eq 'Tax';
2440 return 1 if $a->itemdesc eq 'Tax';
2441 return -1 if $b->itemdesc eq 'Other surcharges';
2442 return 1 if $a->itemdesc eq 'Other surcharges';
2443 $a->itemdesc cmp $b->itemdesc;
2448 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2449 $self->cust_bill_pkg;
2450 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2452 if ( $self->conf->exists('always_show_tax') ) {
2453 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2454 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2456 { 'description' => $itemdesc,
2463 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2465 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2466 list of hashrefs describing the line items they generate on the invoice.
2468 OPTIONS may include:
2470 format: the invoice format.
2472 escape_function: the function used to escape strings.
2474 DEPRECATED? (expensive, mostly unused?)
2475 format_function: the function used to format CDRs.
2477 section: a hashref containing 'category' and/or 'locationnum'; if this
2478 is present, only returns line items that belong to that category and/or
2479 location (whichever is defined).
2481 multisection: a flag indicating that this is a multisection invoice,
2482 which does something complicated.
2484 Returns a list of hashrefs, each of which may contain:
2486 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2487 ext_description, which is an arrayref of detail lines to show below
2492 sub _items_cust_bill_pkg {
2494 my $conf = $self->conf;
2495 my $cust_bill_pkgs = shift;
2498 my $format = $opt{format} || '';
2499 my $escape_function = $opt{escape_function} || sub { shift };
2500 my $format_function = $opt{format_function} || '';
2501 my $no_usage = $opt{no_usage} || '';
2502 my $unsquelched = $opt{unsquelched} || ''; #unused
2503 my ($section, $locationnum, $category);
2504 if ( $opt{section} ) {
2505 $category = $opt{section}->{category};
2506 $locationnum = $opt{section}->{locationnum};
2508 my $summary_page = $opt{summary_page} || ''; #unused
2509 my $multisection = defined($category) || defined($locationnum);
2510 my $discount_show_always = 0;
2512 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2514 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
2515 # and location labels
2518 my ($s, $r, $u) = ( undef, undef, undef );
2519 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
2522 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
2523 if ( $_ && !$cust_bill_pkg->hidden ) {
2524 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
2525 $_->{amount} =~ s/^\-0\.00$/0.00/;
2526 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
2528 if $_->{amount} != 0
2529 || $discount_show_always
2530 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
2531 || ( $_->{_is_setup} && $_->{setup_show_zero} )
2537 if ( $locationnum ) {
2538 # this is a location section; skip packages that aren't at this
2540 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
2541 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
2545 # Consider display records for this item to determine if it belongs
2546 # in this section. Note that if there are no display records, there
2547 # will be a default pseudo-record that includes all charge types
2548 # and has no section name.
2549 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
2550 ? $cust_bill_pkg->cust_bill_pkg_display
2551 : ( $cust_bill_pkg );
2553 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
2554 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
2557 if ( defined($category) ) {
2558 # then this is a package category section; process all display records
2559 # that belong to this section.
2560 @cust_bill_pkg_display = grep { $_->section eq $category }
2561 @cust_bill_pkg_display;
2563 # otherwise, process all display records that aren't usage summaries
2564 # (I don't think there should be usage summaries if you aren't using
2565 # category sections, but this is the historical behavior)
2566 @cust_bill_pkg_display = grep { !$_->summary }
2567 @cust_bill_pkg_display;
2570 my $classname = ''; # package class name, will fill in later
2572 foreach my $display (@cust_bill_pkg_display) {
2574 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
2575 $display->billpkgdisplaynum. "\n"
2578 my $type = $display->type;
2580 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
2581 $desc = substr($desc, 0, $maxlength). '...'
2582 if $format eq 'latex' && length($desc) > $maxlength;
2584 my %details_opt = ( 'format' => $format,
2585 'escape_function' => $escape_function,
2586 'format_function' => $format_function,
2587 'no_usage' => $opt{'no_usage'},
2590 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
2592 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
2594 # quotation_pkgs are never fees, so don't worry about the case where
2595 # part_pkg is undefined
2597 if ( $cust_bill_pkg->setup != 0 ) {
2598 my $description = $desc;
2599 $description .= ' Setup'
2600 if $cust_bill_pkg->recur != 0
2601 || $discount_show_always
2602 || $cust_bill_pkg->recur_show_zero;
2604 'description' => $description,
2605 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2608 if ( $cust_bill_pkg->recur != 0 ) {
2610 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
2611 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2615 } elsif ( $cust_bill_pkg->pkgnum > 0 ) { # and it's not a quotation_pkg
2617 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
2620 my $cust_pkg = $cust_bill_pkg->cust_pkg;
2621 my $part_pkg = $cust_pkg->part_pkg;
2623 # which pkgpart to show for display purposes?
2624 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
2626 # start/end dates for invoice formats that do nonstandard
2628 my %item_dates = ();
2629 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
2630 unless $part_pkg->option('disable_line_item_date_ranges',1);
2632 # not normally used, but pass this to the template anyway
2633 $classname = $part_pkg->classname;
2635 if ( (!$type || $type eq 'S')
2636 && ( $cust_bill_pkg->setup != 0
2637 || $cust_bill_pkg->setup_show_zero
2642 warn "$me _items_cust_bill_pkg adding setup\n"
2645 my $description = $desc;
2646 $description .= ' Setup'
2647 if $cust_bill_pkg->recur != 0
2648 || $discount_show_always
2649 || $cust_bill_pkg->recur_show_zero;
2651 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
2653 if $part_pkg->is_prepaid #for prepaid, "display the validity period
2654 # triggered by the recurring charge freq
2656 && $cust_bill_pkg->recur == 0
2657 && ! $cust_bill_pkg->recur_show_zero;
2662 # always pass the svc_label through to the template, even if
2663 # not displaying it as an ext_description
2664 my @svc_labels = map &{$escape_function}($_),
2665 $cust_pkg->h_labels_short($self->_date, undef, 'I');
2667 $svc_label = $svc_labels[0];
2669 unless ( $cust_pkg->part_pkg->hide_svc_detail
2670 || $cust_bill_pkg->hidden )
2673 push @d, @svc_labels
2674 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
2675 my $lnum = $cust_main ? $cust_main->ship_locationnum
2676 : $self->prospect_main->locationnum;
2677 # show the location label if it's not the customer's default
2678 # location, and we're not grouping items by location already
2679 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
2680 my $loc = $cust_pkg->location_label;
2681 $loc = substr($loc, 0, $maxlength). '...'
2682 if $format eq 'latex' && length($loc) > $maxlength;
2683 push @d, &{$escape_function}($loc);
2686 } #unless hiding service details
2688 push @d, $cust_bill_pkg->details(%details_opt)
2689 if $cust_bill_pkg->recur == 0;
2691 if ( $cust_bill_pkg->hidden ) {
2692 $s->{amount} += $cust_bill_pkg->setup;
2693 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
2694 push @{ $s->{ext_description} }, @d;
2698 description => $description,
2699 pkgpart => $pkgpart,
2700 pkgnum => $cust_bill_pkg->pkgnum,
2701 amount => $cust_bill_pkg->setup,
2702 setup_show_zero => $cust_bill_pkg->setup_show_zero,
2703 unit_amount => $cust_bill_pkg->unitsetup,
2704 quantity => $cust_bill_pkg->quantity,
2705 ext_description => \@d,
2706 svc_label => ($svc_label || ''),
2707 locationnum => $cust_pkg->locationnum, # sure, why not?
2713 if ( ( !$type || $type eq 'R' || $type eq 'U' )
2715 $cust_bill_pkg->recur != 0
2716 || $cust_bill_pkg->setup == 0
2717 || $discount_show_always
2718 || $cust_bill_pkg->recur_show_zero
2723 warn "$me _items_cust_bill_pkg adding recur/usage\n"
2726 my $is_summary = $display->summary;
2727 my $description = $desc;
2728 if ( $type eq 'U' and defined($r) ) {
2729 # don't just show the same description as the recur line
2730 $description = $self->mt('Usage charges');
2733 my $part_pkg = $cust_pkg->part_pkg;
2735 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
2739 my @seconds = (); # for display of usage info
2742 #at least until cust_bill_pkg has "past" ranges in addition to
2743 #the "future" sdate/edate ones... see #3032
2744 my @dates = ( $self->_date );
2745 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
2746 push @dates, $prev->sdate if $prev;
2747 push @dates, undef if !$prev;
2749 my @svc_labels = map &{$escape_function}($_),
2750 $cust_pkg->h_labels_short(@dates, 'I');
2751 $svc_label = $svc_labels[0];
2753 # show service labels, unless...
2754 # the package is set not to display them
2755 unless ( $part_pkg->hide_svc_detail
2756 # or this is a tax-like line item
2757 || $cust_bill_pkg->itemdesc
2758 # or this is a hidden (bundled) line item
2759 || $cust_bill_pkg->hidden
2760 # or this is a usage summary line
2761 || $is_summary && $type && $type eq 'U'
2762 # or this is a usage line and there's a recurring line
2763 # for the package in the same section (which will
2764 # have service labels already)
2765 || ($type eq 'U' and defined($r))
2769 warn "$me _items_cust_bill_pkg adding service details\n"
2772 push @d, @svc_labels
2773 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
2774 warn "$me _items_cust_bill_pkg done adding service details\n"
2777 my $lnum = $cust_main ? $cust_main->ship_locationnum
2778 : $self->prospect_main->locationnum;
2779 # show the location label if it's not the customer's default
2780 # location, and we're not grouping items by location already
2781 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
2782 my $loc = $cust_pkg->location_label;
2783 $loc = substr($loc, 0, $maxlength). '...'
2784 if $format eq 'latex' && length($loc) > $maxlength;
2785 push @d, &{$escape_function}($loc);
2788 # Display of seconds_since_sqlradacct:
2789 # On the invoice, when processing @detail_items, look for a field
2790 # named 'seconds'. This will contain total seconds for each
2791 # service, in the same order as @ext_description. For services
2792 # that don't support this it will show undef.
2793 if ( $conf->exists('svc_acct-usage_seconds')
2794 and ! $cust_bill_pkg->pkgpart_override ) {
2795 foreach my $cust_svc (
2796 $cust_pkg->h_cust_svc(@dates, 'I')
2799 # eval because not having any part_export_usage exports
2800 # is a fatal error, last_bill/_date because that's how
2801 # sqlradius_hour billing does it
2803 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
2805 push @seconds, $sec;
2807 } #if svc_acct-usage_seconds
2809 } # if we are showing service labels
2811 unless ( $is_summary ) {
2812 warn "$me _items_cust_bill_pkg adding details\n"
2815 #instead of omitting details entirely in this case (unwanted side
2816 # effects), just omit CDRs
2817 $details_opt{'no_usage'} = 1
2818 if $type && $type eq 'R';
2820 push @d, $cust_bill_pkg->details(%details_opt);
2823 warn "$me _items_cust_bill_pkg calculating amount\n"
2828 $amount = $cust_bill_pkg->recur;
2829 } elsif ($type eq 'R') {
2830 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
2831 } elsif ($type eq 'U') {
2832 $amount = $cust_bill_pkg->usage;
2835 if ( !$type || $type eq 'R' ) {
2837 warn "$me _items_cust_bill_pkg adding recur\n"
2841 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
2844 if ( $cust_bill_pkg->hidden ) {
2845 $r->{amount} += $amount;
2846 $r->{unit_amount} += $unit_amount;
2847 push @{ $r->{ext_description} }, @d;
2850 description => $description,
2851 pkgpart => $pkgpart,
2852 pkgnum => $cust_bill_pkg->pkgnum,
2854 recur_show_zero => $cust_bill_pkg->recur_show_zero,
2855 unit_amount => $unit_amount,
2856 quantity => $cust_bill_pkg->quantity,
2858 ext_description => \@d,
2859 svc_label => ($svc_label || ''),
2860 locationnum => $cust_pkg->locationnum,
2862 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
2865 } else { # $type eq 'U'
2867 warn "$me _items_cust_bill_pkg adding usage\n"
2870 if ( $cust_bill_pkg->hidden and defined($u) ) {
2871 # if this is a hidden package and there's already a usage
2872 # line for the bundle, add this package's total amount and
2873 # usage details to it
2874 $u->{amount} += $amount;
2875 push @{ $u->{ext_description} }, @d;
2876 } elsif ( $amount ) {
2877 # create a new usage line
2879 description => $description,
2880 pkgpart => $pkgpart,
2881 pkgnum => $cust_bill_pkg->pkgnum,
2884 recur_show_zero => $cust_bill_pkg->recur_show_zero,
2886 ext_description => \@d,
2887 locationnum => $cust_pkg->locationnum,
2889 } # else this has no usage, so don't create a usage section
2892 } # recurring or usage with recurring charge
2894 } else { # taxes and fees
2896 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
2899 # items of this kind should normally not have sdate/edate.
2901 'description' => $desc,
2902 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
2903 + $cust_bill_pkg->recur)
2906 } # if quotation / package line item / other line item
2908 } # foreach $display
2910 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
2911 && $conf->exists('discount-show-always'));
2915 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
2917 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
2918 if exists($_->{amount});
2919 $_->{amount} =~ s/^\-0\.00$/0.00/;
2920 $_->{unit_amount} = sprintf('%.2f', $_->{unit_amount})
2921 if exists($_->{unit_amount});
2924 if $_->{amount} != 0
2925 || $discount_show_always
2926 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
2927 || ( $_->{_is_setup} && $_->{setup_show_zero} )
2931 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
2938 =item _items_discounts_avail
2940 Returns an array of line item hashrefs representing available term discounts
2941 for this invoice. This makes the same assumptions that apply to term
2942 discounts in general: that the package is billed monthly, at a flat rate,
2943 with no usage charges. A prorated first month will be handled, as will
2944 a setup fee if the discount is allowed to apply to setup fees.
2948 sub _items_discounts_avail {
2951 #maybe move this method from cust_bill when quotations support discount_plans
2952 return () unless $self->can('discount_plans');
2953 my %plans = $self->discount_plans;
2955 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
2956 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
2960 my $plan = $plans{$months};
2962 my $term_total = sprintf('%.2f', $plan->discounted_total);
2963 my $percent = sprintf('%.0f',
2964 100 * (1 - $term_total / $plan->base_total) );
2965 my $permonth = sprintf('%.2f', $term_total / $months);
2966 my $detail = $self->mt('discount on item'). ' '.
2967 join(', ', map { "#$_" } $plan->pkgnums)
2970 # discounts for non-integer months don't work anyway
2971 $months = sprintf("%d", $months);
2974 description => $self->mt('Save [_1]% by paying for [_2] months',
2976 amount => $self->mt('[_1] ([_2] per month)',
2977 $term_total, $money_char.$permonth),
2978 ext_description => ($detail || ''),
2981 sort { $b <=> $a } keys %plans;