1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum); #can't import first, it conflicts with cust_main.first
13 use Time::Local qw( timelocal );
14 use Text::Template 1.20;
16 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
21 use FS::Misc qw( send_email );
22 use FS::Record qw( qsearch qsearchs );
24 use FS::Misc qw( generate_ps generate_pdf );
31 $me = '[FS::Template_Mixin]';
32 FS::UID->install_callback( sub {
33 my $conf = new FS::Conf; #global
34 $money_char = $conf->config('money_char') || '$';
35 $date_format = $conf->config('date_format') || '%x'; #/YY
40 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
42 If the "mode" pseudo-field is set on the object, the configuration handle
43 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
50 my $mode = $self->get('mode');
51 if ($self->{_conf} and !defined($mode)) {
52 return $self->{_conf};
55 my $cust_main = $self->cust_main;
56 my $locale = $cust_main ? $cust_main->locale : '';
59 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
60 $mode = $mode->modenum;
61 } elsif ( $mode =~ /\D/ ) {
62 die "invalid invoice mode $mode";
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
66 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
67 # it doesn't have a locale, but system conf still might
68 $conf->set('locale' => $locale) if $conf;
71 # if $mode is unspecified, or if there is no invoice_conf matching this mode
72 # and locale, then use the system config only (but with the locale)
73 $conf ||= FS::Conf->new({ 'locale' => $locale });
75 return $self->{_conf} = $conf;
78 =item print_text OPTIONS
80 Returns an text invoice, as a list of lines.
82 Options can be passed as a hash.
84 I<time>, if specified, is used to control the printing of overdue messages. The
85 default is now. It isn't the date of the invoice; that's the `_date' field.
86 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 I<template>, if specified, is the name of a suffix for alternate invoices.
91 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
99 %params = %{ shift() };
104 $params{'format'} = 'template'; # for some reason
106 $self->print_generic( %params );
109 =item print_latex HASHREF
111 Internal method - returns a filename of a filled-in LaTeX template for this
112 invoice (Note: add ".tex" to get the actual filename), and a filename of
113 an associated logo (with the .eps extension included).
115 See print_ps and print_pdf for methods that return PostScript and PDF output.
117 Options can be passed as a hash.
119 I<time>, if specified, is used to control the printing of overdue messages. The
120 default is now. It isn't the date of the invoice; that's the `_date' field.
121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
122 L<Time::Local> and L<Date::Parse> for conversion functions.
124 I<template>, if specified, is the name of a suffix for alternate invoices.
125 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
126 customize invoice templates for different purposes.
128 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
137 %params = %{ shift() };
142 $params{'format'} = 'latex';
143 my $conf = $self->conf;
145 # this needs to go away
146 my $template = $params{'template'};
147 # and this especially
148 $template ||= $self->_agent_template
149 if $self->can('_agent_template');
152 $self->set('mode', $params{mode})
155 my $pkey = $self->primary_key;
156 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
159 my $lh = new File::Temp(
160 TEMPLATE => $tmp_template,
164 ) or die "can't open temp file: $!\n";
166 my $agentnum = $self->agentnum;
168 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
169 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
170 or die "can't write temp file: $!\n";
172 print $lh $conf->config_binary('logo.eps', $agentnum)
173 or die "can't write temp file: $!\n";
176 $params{'logo_file'} = $lh->filename;
178 if( $conf->exists('invoice-barcode')
179 && $self->can('invoice_barcode')
180 && $self->invnum ) { # don't try to barcode statements
181 my $png_file = $self->invoice_barcode($dir);
182 my $eps_file = $png_file;
183 $eps_file =~ s/\.png$/.eps/g;
184 $png_file =~ /(barcode.*png)/;
186 $eps_file =~ /(barcode.*eps)/;
189 my $curr_dir = cwd();
191 # after painfuly long experimentation, it was determined that sam2p won't
192 # accept : and other chars in the path, no matter how hard I tried to
193 # escape them, hence the chdir (and chdir back, just to be safe)
194 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
195 or die "sam2p failed: $!\n";
199 $params{'barcode_file'} = $eps_file;
202 my @filled_in = $self->print_generic( %params );
204 my $fh = new File::Temp( TEMPLATE => $tmp_template,
208 ) or die "can't open temp file: $!\n";
209 binmode($fh, ':utf8'); # language support
210 print $fh join('', @filled_in );
213 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
214 return ($1, $params{'logo_file'}, $params{'barcode_file'});
220 my $cust_main = $self->cust_main;
221 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
224 =item print_generic OPTION => VALUE ...
226 Internal method - returns a filled-in template for this invoice as a scalar.
228 See print_ps and print_pdf for methods that return PostScript and PDF output.
236 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
246 Overrides "Invoice" as the name of the sent document.
250 Used to control the printing of overdue messages. The
251 default is now. It isn't the date of the invoice; that's the `_date' field.
252 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
253 L<Time::Local> and L<Date::Parse> for conversion functions.
257 Logo file (path to temporary EPS file on the local filesystem)
261 CID for inline (emailed) images (logo)
265 Override customer's locale
269 Overrides any per customer cdr squelching when true
273 Supress the (invoice, quotation, statement, etc.) number
281 Supress the payment coupon
285 Barcode file (path to temporary EPS file on the local filesystem)
289 Flag indicating the barcode image should be a link (normal HTML dipaly)
293 Barcode CID for inline (emailed) images
295 =item preref_callback
297 Coderef run for each line item, code should return HTML to be displayed
298 before that line item (quotations only)
302 Dprecated. Used as a suffix for a configuration template. Please
303 don't use this, it deprecated in favor of more flexible alternatives.
309 #what's with all the sprintf('%10.2f')'s in here? will it cause any
310 # (alignment in text invoice?) problems to change them all to '%.2f' ?
311 # yes: fixed width/plain text printing will be borked
313 my( $self, %params ) = @_;
314 my $conf = $self->conf;
316 my $today = $params{today} ? $params{today} : time;
317 warn "$me print_generic called on $self with suffix $params{template}\n"
320 my $format = $params{format};
321 die "Unknown format: $format"
322 unless $format =~ /^(latex|html|template)$/;
324 my $cust_main = $self->cust_main || $self->prospect_main;
325 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
326 unless $cust_main->payname
327 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
329 my $locale = $params{'locale'} || $cust_main->locale;
331 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
332 'html' => [ '<%=', '%>' ],
333 'template' => [ '{', '}' ],
336 warn "$me print_generic creating template\n"
339 # set the notice name here, and nowhere else.
340 my $notice_name = $params{notice_name}
341 || $conf->config('notice_name')
342 || $self->notice_name;
345 my $template = $params{template} ? $params{template} : $self->_agent_template;
346 my $templatefile = $self->template_conf. $format;
347 $templatefile .= "_$template"
348 if length($template) && $conf->exists($templatefile."_$template");
351 my @invoice_template = map "$_\n", $conf->config($templatefile)
352 or die "cannot load config data $templatefile";
354 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
355 #change this to a die when the old code is removed
356 # it's been almost ten years, changing it to a die on the next release.
357 warn "old-style invoice template $templatefile; ".
358 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
359 #$old_latex = 'true';
360 #@invoice_template = _translate_old_latex_format(@invoice_template);
363 warn "$me print_generic creating T:T object\n"
366 my $text_template = new Text::Template(
368 SOURCE => \@invoice_template,
369 DELIMITERS => $delimiters{$format},
372 warn "$me print_generic compiling T:T object\n"
375 $text_template->compile()
376 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
379 # additional substitution could possibly cause breakage in existing templates
382 'notes' => sub { map "$_", @_ },
383 'footer' => sub { map "$_", @_ },
384 'smallfooter' => sub { map "$_", @_ },
385 'returnaddress' => sub { map "$_", @_ },
386 'coupon' => sub { map "$_", @_ },
387 'summary' => sub { map "$_", @_ },
393 s/%%(.*)$/<!-- $1 -->/g;
394 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
395 s/\\begin\{enumerate\}/<ol>/g;
397 s/\\end\{enumerate\}/<\/ol>/g;
398 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
407 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
409 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
415 s/\\hyphenation\{[\w\s\-]+}//;
420 'coupon' => sub { "" },
421 'summary' => sub { "" },
428 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
429 s/\\begin\{enumerate\}//g;
431 s/\\end\{enumerate\}//g;
432 s/\\textbf\{(.*)\}/$1/g;
439 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
441 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
446 s/\\\\\*?\s*$/\n/; # dubious
447 s/\\hyphenation\{[\w\s\-]+}//;
451 'coupon' => sub { "" },
452 'summary' => sub { "" },
457 # hashes for differing output formats
458 my %nbsps = ( 'latex' => '~',
459 'html' => '', # '&nbps;' would be nice
460 'template' => '', # not used
462 my $nbsp = $nbsps{$format};
464 my %escape_functions = ( 'latex' => \&_latex_escape,
465 'html' => \&_html_escape_nbsp,#\&encode_entities,
466 'template' => sub { shift },
468 my $escape_function = $escape_functions{$format};
469 my $escape_function_nonbsp = ($format eq 'html')
470 ? \&_html_escape : $escape_function;
472 my %newline_tokens = ( 'latex' => '\\\\',
476 my $newline_token = $newline_tokens{$format};
478 warn "$me generating template variables\n"
481 # generate template variables
485 defined( $conf->config_orbase( "invoice_${format}returnaddress",
489 && length( $conf->config_orbase( "invoice_${format}returnaddress",
495 $returnaddress = join("\n",
496 $conf->config_orbase("invoice_${format}returnaddress", $template)
500 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
502 my $convert_map = $convert_maps{$format}{'returnaddress'};
505 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
510 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
512 my $convert_map = $convert_maps{$format}{'returnaddress'};
513 $returnaddress = join( "\n", &$convert_map(
514 map { s/( {2,})/'~' x length($1)/eg;
518 ( $conf->config('company_name', $cust_main->agentnum),
519 $conf->config('company_address', $cust_main->agentnum),
526 my $warning = "Couldn't find a return address; ".
527 "do you need to set the company_address configuration value?";
529 $returnaddress = $nbsp;
530 #$returnaddress = $warning;
534 warn "$me generating invoice data\n"
537 my $agentnum = $cust_main->agentnum;
542 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
543 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
544 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
545 'returnaddress' => $returnaddress,
546 'agent' => &$escape_function($cust_main->agent->agent),
548 #invoice/quotation info
549 'no_number' => $params{'no_number'},
550 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
551 'quotationnum' => $self->quotationnum,
552 'no_date' => $params{'no_date'},
553 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
554 # workaround for inconsistent behavior in the early plain text
555 # templates; see RT#28271
556 'date' => ( $params{'no_date'}
558 : ($format eq 'template'
560 : $self->time2str_local('long', $self->_date, $format)
563 'today' => $self->time2str_local('long', $today, $format),
564 'terms' => $self->terms,
565 'template' => $template, #params{'template'},
566 'notice_name' => $notice_name, # escape?
567 'current_charges' => sprintf("%.2f", $self->charged),
568 'duedate' => $self->due_date2str('rdate'), #date_format?
571 'custnum' => $cust_main->display_custnum,
572 'prospectnum' => $cust_main->prospectnum,
573 'agent_custid' => &$escape_function($cust_main->agent_custid),
574 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
575 payname company address1 address2 city state zip fax
579 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
580 'unitprices' => $conf->exists('invoice-unitprice'),
581 'smallernotes' => $conf->exists('invoice-smallernotes'),
582 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
583 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
585 #layout info -- would be fancy to calc some of this and bury the template
587 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
588 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
589 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
590 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
591 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
592 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
593 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
594 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
595 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
596 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
598 # better hang on to conf_dir for a while (for old templates)
599 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
601 #these are only used when doing paged plaintext
608 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
609 # prototype here to silence warnings
610 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
612 my $min_sdate = 999999999999;
614 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
615 next unless $cust_bill_pkg->pkgnum > 0;
616 $min_sdate = $cust_bill_pkg->sdate
617 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
618 $max_edate = $cust_bill_pkg->edate
619 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
622 $invoice_data{'bill_period'} = '';
623 $invoice_data{'bill_period'} =
624 $self->time2str_local('%e %h', $min_sdate, $format)
626 $self->time2str_local('%e %h', $max_edate, $format)
627 if ($max_edate != 0 && $min_sdate != 999999999999);
629 $invoice_data{finance_section} = '';
630 if ( $conf->config('finance_pkgclass') ) {
632 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
633 $invoice_data{finance_section} = $pkg_class->categoryname;
635 $invoice_data{finance_amount} = '0.00';
636 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
638 my $countrydefault = $conf->config('countrydefault') || 'US';
639 foreach ( qw( address1 address2 city state zip country fax) ){
640 my $method = 'ship_'.$_;
641 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
643 if ( length($cust_main->ship_company) ) {
644 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
646 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
648 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
649 $invoice_data{'ship_country'} = ''
650 if ( $invoice_data{'ship_country'} eq $countrydefault );
652 $invoice_data{'cid'} = $params{'cid'}
655 if ( $cust_main->country eq $countrydefault ) {
656 $invoice_data{'country'} = '';
658 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
662 $invoice_data{'address'} = \@address;
665 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
666 ? " (P.O. #". $cust_main->payinfo. ")"
670 push @address, $cust_main->company
671 if $cust_main->company;
672 push @address, $cust_main->address1;
673 push @address, $cust_main->address2
674 if $cust_main->address2;
676 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
677 push @address, $invoice_data{'country'}
678 if $invoice_data{'country'};
680 while (scalar(@address) < 5);
682 $invoice_data{'logo_file'} = $params{'logo_file'}
683 if $params{'logo_file'};
684 $invoice_data{'barcode_file'} = $params{'barcode_file'}
685 if $params{'barcode_file'};
686 $invoice_data{'barcode_img'} = $params{'barcode_img'}
687 if $params{'barcode_img'};
688 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
689 if $params{'barcode_cid'};
691 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
692 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
693 #my $balance_due = $self->owed + $pr_total - $cr_total;
694 my $balance_due = $self->owed;
695 if ( $self->enable_previous ) {
696 $balance_due += $pr_total;
698 # otherwise the previous balance is not shown, so including it in the
699 # balance due is just confusing
701 # the sum of amount owed on all invoices
702 # (this is used in the summary & on the payment coupon)
703 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
705 # flag telling this invoice to have a first-page summary
706 my $summarypage = '';
708 if ( $self->custnum && $self->invnum ) {
709 # XXX should be an FS::cust_bill method to set the defaults, instead
710 # of checking the type here
712 # info from customer's last invoice before this one, for some
714 $invoice_data{'last_bill'} = {};
716 my $last_bill = $self->previous_bill;
719 # "balance_date_range" unfortunately is unsuitable for this, since it
720 # cares about application dates. We want to know the sum of all
721 # _top-level transactions_ dated before the last invoice.
723 # still do this for the "Previous Balance" line of the summary block
725 map "$_ WHERE _date <= ? AND custnum = ?", (
726 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
727 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
728 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
729 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
732 # the customer's current balance immediately after generating the last
735 my $last_bill_balance = $last_bill->charged;
737 my $delta = FS::Record->scalar_sql(
739 $last_bill->_date - 1,
742 $last_bill_balance += $delta;
745 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
747 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
749 $self->time2str_local('%D', $last_bill->_date),
752 # ("true_previous_balance" is a terrible name, but at least it's no
753 # longer stored in the database)
754 $invoice_data{'true_previous_balance'} = $last_bill_balance;
756 # Now, get all applications of credits/payments dated on or after the
757 # previous bill, to invoices before the current bill. (The
758 # credit/payment date restriction prevents these from intersecting
759 # the "Previous Balance" set.)
760 # These are "adjustments". The past due balance will be shown as
761 # Previous Balance - Adjustments.
764 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
765 WHERE cust_bill._date < ?
767 AND cust_bill.custnum = ?"
768 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
769 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
772 my $delta = FS::Record->scalar_sql(
778 $adjustments += $delta;
780 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
782 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
783 $invoice_data{'balance_adjustments'}
786 # the sum of amount owed on all previous invoices
787 # ($pr_total is used elsewhere but not as $previous_balance)
788 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
790 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
791 my (@payments, @credits);
792 # for formats that itemize previous payments
793 foreach my $cust_pay ( qsearch('cust_pay', {
794 'custnum' => $self->custnum,
795 '_date' => { op => '>=',
796 value => $last_bill->_date }
799 next if $cust_pay->_date > $self->_date;
801 '_date' => $cust_pay->_date,
802 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
803 'payinfo' => $cust_pay->payby_payinfo_pretty,
804 'amount' => sprintf('%.2f', $cust_pay->paid),
806 # not concerned about applications
808 foreach my $cust_credit ( qsearch('cust_credit', {
809 'custnum' => $self->custnum,
810 '_date' => { op => '>=',
811 value => $last_bill->_date }
814 next if $cust_credit->_date > $self->_date;
816 '_date' => $cust_credit->_date,
817 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
818 'creditreason'=> $cust_credit->reason,
819 'amount' => sprintf('%.2f', $cust_credit->amount),
822 $invoice_data{'previous_payments'} = \@payments;
823 $invoice_data{'previous_credits'} = \@credits;
825 # there is no $last_bill
826 $invoice_data{'true_previous_balance'} =
827 $invoice_data{'balance_adjustments'} =
828 $invoice_data{'previous_balance'} = '0.00';
829 $invoice_data{'previous_payments'} = [];
830 $invoice_data{'previous_credits'} = [];
833 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
834 $invoice_data{'summarypage'} = $summarypage = 1;
837 } # if this is an invoice
839 warn "$me substituting variables in notes, footer, smallfooter\n"
842 my $tc = $self->template_conf;
843 my @include = ( [ $tc, 'notes' ],
844 [ 'invoice_', 'footer' ],
845 [ 'invoice_', 'smallfooter', ],
846 [ 'invoice_', 'watermark' ],
848 push @include, [ $tc, 'coupon', ]
849 unless $params{'no_coupon'};
851 foreach my $i (@include) {
853 # load the configuration for this sub-template
855 my($base, $include) = @$i;
857 my $inc_file = $conf->key_orbase("$base$format$include", $template);
859 my @inc_src = $conf->config($inc_file, $agentnum);
861 my $converter = $convert_maps{$format}{$include};
863 # then attempt to convert LaTeX to the requested format
864 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
865 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
867 # this isn't included in the convert_maps
868 my ($open, $close) = @{ $delimiters{$format} };
873 } # else @inc_src is empty and that's fine
875 # make a Text::Template out of it
877 my $inc_tt = new Text::Template (
879 SOURCE => [ map "$_\n", @inc_src ],
880 DELIMITERS => $delimiters{$format},
881 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
883 unless ( $inc_tt->compile() ) {
884 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
885 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
891 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
893 $invoice_data{$include} =~ s/\n+$//
894 if ($format eq 'latex');
897 # let invoices use either of these as needed
898 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
899 ? $cust_main->payinfo : '';
900 $invoice_data{'po_line'} =
901 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
902 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
905 my %money_chars = ( 'latex' => '',
906 'html' => $conf->config('money_char') || '$',
909 my $money_char = $money_chars{$format};
912 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
913 'html' => $conf->config('money_char') || '$',
916 my $other_money_char = $other_money_chars{$format};
917 $invoice_data{'dollar'} = $other_money_char;
919 my %minus_signs = ( 'latex' => '$-$',
921 'template' => '- ' );
922 my $minus = $minus_signs{$format};
924 my @detail_items = ();
925 my @total_items = ();
929 $invoice_data{'detail_items'} = \@detail_items;
930 $invoice_data{'total_items'} = \@total_items;
931 $invoice_data{'buf'} = \@buf;
932 $invoice_data{'sections'} = \@sections;
934 warn "$me generating sections\n"
937 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
938 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
939 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
940 $invoice_data{'multisection'} = $multisection;
942 my $extra_sections = [];
943 my $extra_lines = ();
945 # default section ('Charges')
946 my $default_section = { 'description' => '',
951 # Previous Charges section
952 # subtotal is the first return value from $self->previous
953 my $previous_section;
954 # if the invoice has major sections, or if we're summarizing previous
955 # charges with a single line, or if we've been specifically told to put them
956 # in a section, create a section for previous charges:
957 if ( $multisection or
958 $conf->exists('previous_balance-summary_only') or
959 $conf->exists('previous_balance-section') ) {
961 $previous_section = { 'description' => $self->mt('Previous Charges'),
962 'subtotal' => $other_money_char.
963 sprintf('%.2f', $pr_total),
964 'summarized' => '', #why? $summarypage ? 'Y' : '',
966 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
967 join(' / ', map { $cust_main->balance_date_range(@$_) }
968 $self->_prior_month30s
970 if $conf->exists('invoice_include_aging');
973 # otherwise put them in the main section
974 $previous_section = $default_section;
977 my $adjust_section = {
978 'description' => $self->mt('Credits, Payments, and Adjustments'),
979 'adjust_section' => 1,
980 'subtotal' => 0, # adjusted below
982 my $adjust_weight = _pkg_category($adjust_section->{description})
983 ? _pkg_category($adjust_section->{description})->weight
985 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
986 # Note: 'sort_weight' here is actually a flag telling whether there is an
987 # explicit package category for the adjust section. If so, certain behavior
989 $adjust_section->{'sort_weight'} = $adjust_weight;
992 if ( $multisection ) {
993 ($extra_sections, $extra_lines) =
994 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
995 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
996 && $self->can('_items_extra_usage_sections');
998 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1000 push @detail_items, @$extra_lines if $extra_lines;
1002 # the code is written so that both methods can be used together, but
1003 # we haven't yet changed the template to take advantage of that, so for
1004 # now, treat them as mutually exclusive.
1005 my %section_method = ( by_category => 1 );
1006 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1007 %section_method = ( by_location => 1 );
1009 my ($early, $late) =
1010 $self->_items_sections( 'summary' => $summarypage,
1011 'escape' => $escape_function_nonbsp,
1012 'extra_sections' => $extra_sections,
1013 'format' => $format,
1016 push @sections, @$early;
1017 $late_sections = $late;
1019 if ( $conf->exists('svc_phone_sections')
1020 && $self->can('_items_svc_phone_sections')
1023 my ($phone_sections, $phone_lines) =
1024 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1025 push @{$late_sections}, @$phone_sections;
1026 push @detail_items, @$phone_lines;
1028 if ( $conf->exists('voip-cust_accountcode_cdr')
1029 && $cust_main->accountcode_cdr
1030 && $self->can('_items_accountcode_cdr')
1033 my ($accountcode_section, $accountcode_lines) =
1034 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1035 if ( scalar(@$accountcode_lines) ) {
1036 push @{$late_sections}, $accountcode_section;
1037 push @detail_items, @$accountcode_lines;
1040 } else {# not multisection
1041 # make a default section
1042 push @sections, $default_section;
1043 # and calculate the finance charge total, since it won't get done otherwise.
1044 # and the default section total
1045 # XXX possibly finance_pkgclass should not be used in this manner?
1046 my @finance_charges;
1048 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1049 if ( $invoice_data{finance_section} and
1050 grep { $_->section eq $invoice_data{finance_section} }
1051 $cust_bill_pkg->cust_bill_pkg_display ) {
1052 # I think these are always setup fees, but just to be sure...
1053 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1055 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1058 $invoice_data{finance_amount} =
1059 sprintf('%.2f', sum( @finance_charges ) || 0);
1060 $default_section->{subtotal} = $other_money_char.
1061 sprintf('%.2f', sum( @charges ) || 0);
1064 # start setting up summary subtotals
1065 my @summary_subtotals;
1066 my $method = $conf->config('summary_subtotals_method');
1067 if ( ( ref($self) ne 'FS::quotation' ) and $method and $method ne $conf->config($tc.'sections_method') ) {
1068 # then re-section them by the correct method
1069 my %section_method = ( by_category => 1 );
1070 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1071 %section_method = ( by_location => 1 );
1073 my ($early, $late) =
1074 $self->_items_sections( 'summary' => $summarypage,
1075 'escape' => $escape_function_nonbsp,
1076 'extra_sections' => $extra_sections,
1077 'format' => $format,
1080 foreach ( @$early ) {
1081 next if $_->{subtotal} == 0;
1082 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1083 push @summary_subtotals, $_;
1086 # subtotal sectioning is the same as for the actual invoice sections
1087 @summary_subtotals = @sections;
1090 # Hereafter, push sections to both @sections and @summary_subtotals
1091 # if they belong in both places (e.g. tax section). Late sections are
1092 # never in @summary_subtotals.
1094 # previous invoice balances in the Previous Charges section if there
1095 # is one, otherwise in the main detail section
1096 # (except if summary_only is enabled, don't show them at all)
1097 if ( $self->can('_items_previous') &&
1098 $self->enable_previous &&
1099 ! $conf->exists('previous_balance-summary_only') ) {
1101 warn "$me adding previous balances\n"
1104 foreach my $line_item ( $self->_items_previous ) {
1107 ref => $line_item->{'pkgnum'},
1108 pkgpart => $line_item->{'pkgpart'},
1109 #quantity => 1, # not really correct
1110 section => $previous_section, # which might be $default_section
1111 description => &$escape_function($line_item->{'description'}),
1112 ext_description => [ map { &$escape_function($_) }
1113 @{ $line_item->{'ext_description'} || [] }
1115 amount => $money_char . $line_item->{'amount'},
1116 product_code => $line_item->{'pkgpart'} || 'N/A',
1119 push @detail_items, $detail;
1120 push @buf, [ $detail->{'description'},
1121 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1127 if ( @pr_cust_bill && $self->enable_previous ) {
1128 push @buf, ['','-----------'];
1129 push @buf, [ $self->mt('Total Previous Balance'),
1130 $money_char. sprintf("%10.2f", $pr_total) ];
1134 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1135 warn "$me adding DID summary\n"
1138 my ($didsummary,$minutes) = $self->_did_summary;
1139 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1141 { 'description' => $didsummary_desc,
1142 'ext_description' => [ $didsummary, $minutes ],
1146 foreach my $section (@sections, @$late_sections) {
1148 # begin some normalization
1149 $section->{'subtotal'} = $section->{'amount'}
1151 && !exists($section->{subtotal})
1152 && exists($section->{amount});
1154 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1155 if ( $invoice_data{finance_section} &&
1156 $section->{'description'} eq $invoice_data{finance_section} );
1158 $section->{'subtotal'} = $other_money_char.
1159 sprintf('%.2f', $section->{'subtotal'})
1162 # continue some normalization
1163 $section->{'amount'} = $section->{'subtotal'}
1167 if ( $section->{'description'} ) {
1168 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1173 warn "$me setting options\n"
1177 $options{'section'} = $section if $multisection;
1178 $options{'format'} = $format;
1179 $options{'escape_function'} = $escape_function;
1180 $options{'no_usage'} = 1 unless $unsquelched;
1181 $options{'unsquelched'} = $unsquelched;
1182 $options{'summary_page'} = $summarypage;
1183 $options{'skip_usage'} =
1184 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1185 $options{'preref_callback'} = $params{'preref_callback'};
1187 warn "$me searching for line items\n"
1190 foreach my $line_item ( $self->_items_pkg(%options),
1191 $self->_items_fee(%options) ) {
1193 warn "$me adding line item ".
1194 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1197 push @buf, ( [ $line_item->{'description'},
1198 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1200 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1203 $line_item->{'ref'} = $line_item->{'pkgnum'};
1204 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1205 $line_item->{'section'} = $section;
1206 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1207 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1209 if ( length($line_item->{'unit_amount'}) ) {
1210 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1212 $line_item->{'ext_description'} ||= [];
1214 push @detail_items, $line_item;
1217 if ( $section->{'description'} ) {
1218 push @buf, ( ['','-----------'],
1219 [ $section->{'description'}. ' sub-total',
1220 $section->{'subtotal'} # already formatted this
1229 $invoice_data{current_less_finance} =
1230 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1232 # if there's anything in the Previous Charges section, prepend it to the list
1233 if ( $pr_total and $previous_section ne $default_section ) {
1234 unshift @sections, $previous_section;
1235 # but not @summary_subtotals
1238 warn "$me adding taxes\n"
1241 # create a tax section if we don't yet have one
1242 my $tax_description = 'Taxes, Surcharges, and Fees';
1244 List::Util::first { $_->{description} eq $tax_description } @sections;
1245 if (!$tax_section) {
1246 $tax_section = { 'description' => $tax_description };
1247 push @sections, $tax_section if $multisection;
1249 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1250 # if this is an existing tax section, we're merging the tax items into it.
1251 # grab the taxtotal that's already there, strip the money symbol if any
1252 my $taxtotal = $tax_section->{'subtotal'} || 0;
1253 $taxtotal =~ s/^\Q$other_money_char\E//;
1256 #my $tax_weight = _pkg_category($tax_section->{description})
1257 # ? _pkg_category($tax_section->{description})->weight
1259 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1260 #$tax_section->{'sort_weight'} = $tax_weight;
1262 my @items_tax = $self->_items_tax;
1263 foreach my $tax ( @items_tax ) {
1265 $taxtotal += $tax->{'amount'};
1267 my $description = &$escape_function( $tax->{'description'} );
1268 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1270 if ( $multisection ) {
1272 push @detail_items, {
1273 ext_description => [],
1276 description => $description,
1277 amount => $money_char. $amount,
1279 section => $tax_section,
1284 push @total_items, {
1285 'total_item' => $description,
1286 'total_amount' => $other_money_char. $amount,
1291 push @buf,[ $description,
1292 $money_char. $amount,
1299 $total->{'total_item'} = $self->mt('Sub-total');
1300 $total->{'total_amount'} =
1301 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1303 if ( $multisection ) {
1304 if ( $taxtotal > 0 ) {
1305 # there are taxes, so prepare the section to be displayed.
1306 # $taxtotal already includes any line items that were already in the
1307 # section (fees, taxes that are charged as packages for some reason).
1308 # also set 'summarized' to false so that this isn't a summary-only
1310 $tax_section->{'subtotal'} = $other_money_char.
1311 sprintf('%.2f', $taxtotal);
1312 $tax_section->{'pretotal'} = 'New charges sub-total '.
1313 $total->{'total_amount'};
1314 $tax_section->{'description'} = $self->mt($tax_description);
1315 $tax_section->{'summarized'} = '';
1317 # append it if it's not already there
1318 if ( !grep $tax_section, @sections ) {
1319 push @sections, $tax_section;
1320 push @summary_subtotals, $tax_section;
1325 unshift @total_items, $total;
1328 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1334 my %embolden_functions = (
1335 'latex' => sub { return '\textbf{'. shift(). '}' },
1336 'html' => sub { return '<b>'. shift(). '</b>' },
1337 'template' => sub { shift },
1339 my $embolden_function = $embolden_functions{$format};
1341 if ( $multisection ) {
1343 if ( $adjust_section->{'sort_weight'} ) {
1344 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1345 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1347 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1348 $other_money_char. sprintf('%.2f', $self->charged );
1353 if ( $self->can('_items_total') ) { # should always be true now
1355 # even for multisection, need plain text version
1357 my @new_total_items = $self->_items_total;
1359 push @buf,['','-----------'];
1361 foreach ( @new_total_items ) {
1362 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1363 $_->{'total_item'} = &$embolden_function( $item );
1364 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1365 # but if it's multisection, don't append to @total_items. the adjust
1366 # section has all this stuff
1367 push @total_items, $_ if !$multisection;
1368 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1371 push @buf, [ '', '' ];
1373 # if we're showing previous invoices, also show previous
1374 # credits and payments
1375 if ( $self->enable_previous
1376 and $self->can('_items_credits')
1377 and $self->can('_items_payments') )
1381 my $credittotal = 0;
1382 foreach my $credit (
1383 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1387 $total->{'total_item'} = &$escape_function($credit->{'description'});
1388 $credittotal += $credit->{'amount'};
1389 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1390 if ( $multisection ) {
1391 push @detail_items, {
1392 ext_description => [],
1395 description => &$escape_function($credit->{'description'}),
1396 amount => $money_char . $credit->{'amount'},
1398 section => $adjust_section,
1401 push @total_items, $total;
1405 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1408 foreach my $credit (
1409 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1411 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1415 my $paymenttotal = 0;
1416 foreach my $payment (
1417 $self->_items_payments( 'template' => $template )
1420 $total->{'total_item'} = &$escape_function($payment->{'description'});
1421 $paymenttotal += $payment->{'amount'};
1422 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1423 if ( $multisection ) {
1424 push @detail_items, {
1425 ext_description => [],
1428 description => &$escape_function($payment->{'description'}),
1429 amount => $money_char . $payment->{'amount'},
1431 section => $adjust_section,
1434 push @total_items, $total;
1436 push @buf, [ $payment->{'description'},
1437 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1440 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1442 if ( $multisection ) {
1443 $adjust_section->{'subtotal'} = $other_money_char.
1444 sprintf('%.2f', $credittotal + $paymenttotal);
1446 #why this? because {sort_weight} forces the adjust_section to appear
1447 #in @extra_sections instead of @sections. obviously.
1448 push @sections, $adjust_section
1449 unless $adjust_section->{sort_weight};
1450 # do not summarize; adjustments there are shown according to
1454 # create Balance Due message
1457 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1458 $total->{'total_amount'} =
1459 &$embolden_function(
1460 $other_money_char. sprintf('%.2f', #why? $summarypage
1461 # ? $self->charged +
1462 # $self->billing_balance
1464 $self->owed + $pr_total
1467 if ( $multisection && !$adjust_section->{sort_weight} ) {
1468 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1469 $total->{'total_amount'};
1471 push @total_items, $total;
1473 push @buf,['','-----------'];
1474 push @buf,[$self->balance_due_msg, $money_char.
1475 sprintf("%10.2f", $balance_due ) ];
1478 if ( $conf->exists('previous_balance-show_credit')
1479 and $cust_main->balance < 0 ) {
1480 my $credit_total = {
1481 'total_item' => &$embolden_function($self->credit_balance_msg),
1482 'total_amount' => &$embolden_function(
1483 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1486 if ( $multisection ) {
1487 $adjust_section->{'posttotal'} .= $newline_token .
1488 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1491 push @total_items, $credit_total;
1493 push @buf,['','-----------'];
1494 push @buf,[$self->credit_balance_msg, $money_char.
1495 sprintf("%10.2f", -$cust_main->balance ) ];
1499 } #end of default total adding ! can('_items_total')
1501 if ( $multisection ) {
1502 if ( $conf->exists('svc_phone_sections')
1503 && $self->can('_items_svc_phone_sections')
1507 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1508 $total->{'total_amount'} =
1509 &$embolden_function(
1510 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1512 my $last_section = pop @sections;
1513 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1514 $total->{'total_amount'};
1515 push @sections, $last_section;
1517 push @sections, @$late_sections
1521 # make a discounts-available section, even without multisection
1522 if ( $conf->exists('discount-show_available')
1523 and my @discounts_avail = $self->_items_discounts_avail ) {
1524 my $discount_section = {
1525 'description' => $self->mt('Discounts Available'),
1530 push @sections, $discount_section; # do not summarize
1531 push @detail_items, map { +{
1532 'ref' => '', #should this be something else?
1533 'section' => $discount_section,
1534 'description' => &$escape_function( $_->{description} ),
1535 'amount' => $money_char . &$escape_function( $_->{amount} ),
1536 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1537 } } @discounts_avail;
1540 # not adding any more sections after this
1541 $invoice_data{summary_subtotals} = \@summary_subtotals;
1544 if ( $conf->exists('usage_class_summary')
1545 and $self->can('_items_usage_class_summary') ) {
1546 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1547 if ( @usage_subtotals ) {
1548 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1549 unshift @detail_items, @usage_subtotals;
1553 # invoice history "section" (not really a section)
1554 # not to be included in any subtotals, completely independent of
1556 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1559 foreach my $cust_bill ( $cust_main->cust_bill ) {
1560 # XXX hardcoded format, and currently only 'charged'; add other fields
1561 # if they become necessary
1562 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1563 $history{$date} ||= 0;
1564 $history{$date} += $cust_bill->charged;
1565 # just so we have a numeric sort key
1566 $monthorder{$date} ||= $cust_bill->_date;
1568 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1570 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1571 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1574 # service locations: another option for template customization
1576 foreach my $item (@detail_items) {
1577 if ( $item->{locationnum} ) {
1578 $location_info{ $item->{locationnum} } ||= {
1579 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1583 $invoice_data{location_info} = \%location_info;
1585 # debugging hook: call this with 'diag' => 1 to just get a hash of
1586 # the invoice variables
1587 return \%invoice_data if ( $params{'diag'} );
1589 # All sections and items are built; now fill in templates.
1590 my @includelist = ();
1591 push @includelist, 'summary' if $summarypage;
1592 foreach my $include ( @includelist ) {
1594 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1597 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1599 @inc_src = $conf->config($inc_file, $agentnum);
1603 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1605 my $convert_map = $convert_maps{$format}{$include};
1607 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1608 s/--\@\]/$delimiters{$format}[1]/g;
1611 &$convert_map( $conf->config($inc_file, $agentnum) );
1615 my $inc_tt = new Text::Template (
1617 SOURCE => [ map "$_\n", @inc_src ],
1618 DELIMITERS => $delimiters{$format},
1619 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1621 unless ( $inc_tt->compile() ) {
1622 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1623 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1627 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1629 $invoice_data{$include} =~ s/\n+$//
1630 if ($format eq 'latex');
1635 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1636 /invoice_lines\((\d*)\)/;
1637 $invoice_lines += $1 || scalar(@buf);
1640 die "no invoice_lines() functions in template?"
1641 if ( $format eq 'template' && !$wasfunc );
1643 if ($format eq 'template') {
1645 if ( $invoice_lines ) {
1646 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1647 $invoice_data{'total_pages'}++
1648 if scalar(@buf) % $invoice_lines;
1651 #setup subroutine for the template
1652 $invoice_data{invoice_lines} = sub {
1653 my $lines = shift || scalar(@buf);
1665 push @collect, split("\n",
1666 $text_template->fill_in( HASH => \%invoice_data )
1668 $invoice_data{'page'}++;
1670 map "$_\n", @collect;
1672 } else { # this is where we actually create the invoice
1674 if ( $params{no_addresses} ) {
1675 delete $invoice_data{$_} foreach qw(
1676 payname company address1 address2 city state zip country
1678 $invoice_data{returnaddress} = '~';
1681 warn "filling in template for invoice ". $self->invnum. "\n"
1683 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1686 $text_template->fill_in(HASH => \%invoice_data);
1690 sub notice_name { '('.shift->table.')'; }
1692 sub template_conf { 'invoice_'; }
1694 # helper routine for generating date ranges
1695 sub _prior_month30s {
1698 [ 1, 2592000 ], # 0-30 days ago
1699 [ 2592000, 5184000 ], # 30-60 days ago
1700 [ 5184000, 7776000 ], # 60-90 days ago
1701 [ 7776000, 0 ], # 90+ days ago
1704 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1705 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1710 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1712 Returns an postscript invoice, as a scalar.
1714 Options can be passed as a hashref (recommended) or as a list of time, template
1715 and then any key/value pairs for any other options.
1717 I<time> an optional value used to control the printing of overdue messages. The
1718 default is now. It isn't the date of the invoice; that's the `_date' field.
1719 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1720 L<Time::Local> and L<Date::Parse> for conversion functions.
1722 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1729 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1730 my $ps = generate_ps($file);
1732 unlink($barcodefile) if $barcodefile;
1737 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1739 Returns an PDF invoice, as a scalar.
1741 Options can be passed as a hashref (recommended) or as a list of time, template
1742 and then any key/value pairs for any other options.
1744 I<time> an optional value used to control the printing of overdue messages. The
1745 default is now. It isn't the date of the invoice; that's the `_date' field.
1746 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1747 L<Time::Local> and L<Date::Parse> for conversion functions.
1749 I<template>, if specified, is the name of a suffix for alternate invoices.
1751 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1758 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1759 my $pdf = generate_pdf($file);
1761 unlink($barcodefile) if $barcodefile;
1766 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1768 Returns an HTML invoice, as a scalar.
1770 I<time> an optional value used to control the printing of overdue messages. The
1771 default is now. It isn't the date of the invoice; that's the `_date' field.
1772 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1773 L<Time::Local> and L<Date::Parse> for conversion functions.
1775 I<template>, if specified, is the name of a suffix for alternate invoices.
1777 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1779 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1780 when emailing the invoice as part of a multipart/related MIME email.
1788 %params = %{ shift() };
1792 $params{'format'} = 'html';
1794 $self->print_generic( %params );
1797 # quick subroutine for print_latex
1799 # There are ten characters that LaTeX treats as special characters, which
1800 # means that they do not simply typeset themselves:
1801 # # $ % & ~ _ ^ \ { }
1803 # TeX ignores blanks following an escaped character; if you want a blank (as
1804 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1808 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1809 $value =~ s/([<>])/\$$1\$/g;
1815 encode_entities($value);
1819 sub _html_escape_nbsp {
1820 my $value = _html_escape(shift);
1821 $value =~ s/ +/ /g;
1825 #utility methods for print_*
1827 sub _translate_old_latex_format {
1828 warn "_translate_old_latex_format called\n"
1835 if ( $line =~ /^%%Detail\s*$/ ) {
1837 push @template, q![@--!,
1838 q! foreach my $_tr_line (@detail_items) {!,
1839 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1840 q! $_tr_line->{'description'} .= !,
1841 q! "\\tabularnewline\n~~".!,
1842 q! join( "\\tabularnewline\n~~",!,
1843 q! @{$_tr_line->{'ext_description'}}!,
1847 while ( ( my $line_item_line = shift )
1848 !~ /^%%EndDetail\s*$/ ) {
1849 $line_item_line =~ s/'/\\'/g; # nice LTS
1850 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1851 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1852 push @template, " \$OUT .= '$line_item_line';";
1855 push @template, '}',
1858 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1860 push @template, '[@--',
1861 ' foreach my $_tr_line (@total_items) {';
1863 while ( ( my $total_item_line = shift )
1864 !~ /^%%EndTotalDetails\s*$/ ) {
1865 $total_item_line =~ s/'/\\'/g; # nice LTS
1866 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1867 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1868 push @template, " \$OUT .= '$total_item_line';";
1871 push @template, '}',
1875 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1876 push @template, $line;
1882 warn "$_\n" foreach @template;
1894 my $conf = $self->conf;
1896 #check for an invoice-specific override
1897 return $self->invoice_terms if $self->invoice_terms;
1899 #check for a customer- specific override
1900 my $cust_main = $self->cust_main;
1901 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1905 $agentnum = $cust_main->agentnum;
1906 } elsif ( my $prospect_main = $self->prospect_main ) {
1907 $agentnum = $prospect_main->agentnum;
1910 #use configured default
1911 $conf->config('invoice_default_terms', $agentnum) || '';
1921 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1922 $duedate = $self->_date() + ( $1 * 86400 );
1923 } elsif ( $self->terms =~ /^End of Month$/ ) {
1924 my ($mon,$year) = (localtime($self->_date) )[4,5];
1926 until ( $mon < 12 ) { $mon -= 12; $year++; }
1927 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
1928 $duedate = $nextmonth_first - 86400;
1939 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1942 =item balance_due_msg
1946 sub balance_due_msg {
1948 my $msg = $self->mt('Balance Due');
1949 return $msg unless $self->terms; # huh?
1950 if ( !$self->conf->exists('invoice_show_prior_due_date')
1951 or $self->conf->exists('invoice_sections') ) {
1952 # if enabled, the due date is shown with Total New Charges (see
1953 # _items_total) and not here
1954 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1955 if ( $self->due_date ) {
1956 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1957 $self->due_date2str('short')
1958 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
1959 } elsif ( $self->terms ) {
1960 $msg .= ' - '. $self->mt($self->terms);
1966 =item balance_due_date
1970 sub balance_due_date {
1972 my $conf = $self->conf;
1974 my $terms = $self->terms;
1975 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1976 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1981 sub credit_balance_msg {
1983 $self->mt('Credit Balance Remaining')
1988 Returns a string with the date, for example: "3/20/2008", localized for the
1989 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1995 $self->time2str_local('short', $self->_date);
1998 =item _date_pretty_unlocalized
2000 Returns a string with the date, for example: "3/20/2008", in the format
2001 configured for the back-office. Use _date_pretty for end-customer display use.
2005 sub _date_pretty_unlocalized {
2007 time2str($date_format, $self->_date);
2012 Emails this template.
2014 Options are passed as a hashref. Available options:
2020 If specified, overrides the default From: address.
2024 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2028 (Deprecated) If specified, is the name of a suffix for alternate template files.
2032 Options accepted by generate_email can also be used.
2038 my $opt = shift || {};
2039 if ($opt and !ref($opt)) {
2040 die ref($self). '->email called with positional parameters';
2043 return if $self->hide;
2045 my $error = send_email(
2046 $self->generate_email(
2047 'subject' => $self->email_subject($opt->{template}),
2048 %$opt, # template, etc.
2052 die "can't email: $error\n" if $error;
2055 =item generate_email OPTION => VALUE ...
2063 sender address, required
2067 alternate template name, optional
2071 email subject, optional
2075 notice name instead of "Invoice", optional
2079 Returns an argument list to be passed to L<FS::Misc::send_email>.
2085 sub generate_email {
2089 my $conf = $self->conf;
2091 my $me = '[FS::Template_Mixin::generate_email]';
2094 'from' => $args{'from'},
2095 'subject' => ($args{'subject'} || $self->email_subject),
2096 'custnum' => $self->custnum,
2097 'msgtype' => 'invoice',
2100 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2102 my $cust_main = $self->cust_main;
2104 if (ref($args{'to'}) eq 'ARRAY') {
2105 $return{'to'} = $args{'to'};
2106 } elsif ( $cust_main ) {
2107 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2110 my $tc = $self->template_conf;
2112 my @text; # array of lines
2113 my $html; # a big string
2114 my @related_parts; # will contain the text/HTML alternative, and images
2115 my $related; # will contain the multipart/related object
2117 if ( $conf->exists($tc. 'email_pdf') ) {
2118 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2120 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2123 my $msg_template = FS::msg_template->by_key($msgnum)
2124 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2125 my %prepared = $msg_template->prepare(
2126 cust_main => $self->cust_main,
2130 @text = split(/(?=\n)/, $prepared{'text_body'});
2131 $html = $prepared{'html_body'};
2133 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2135 warn "$me using '${tc}email_pdf_note' in multipart message"
2137 @text = $conf->config($tc.'email_pdf_note');
2138 $html = join('<BR>', @text);
2140 } # else use the plain text invoice
2145 if ( $conf->config($tc.'template') ) {
2147 warn "$me generating plain text invoice"
2150 # 'print_text' argument is no longer used
2151 @text = $self->print_text(\%args);
2155 warn "$me no plain text version exists; sending empty message body"
2162 my $text_part = build MIME::Entity (
2163 'Type' => 'text/plain',
2164 'Encoding' => 'quoted-printable',
2165 'Charset' => 'UTF-8',
2166 #'Encoding' => '7bit',
2168 'Disposition' => 'inline',
2173 if ( $conf->exists($tc.'html') ) {
2174 warn "$me generating HTML invoice"
2177 $args{'from'} =~ /\@([\w\.\-]+)/;
2178 my $from = $1 || 'example.com';
2179 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2182 my $agentnum = $cust_main ? $cust_main->agentnum
2183 : $self->prospect_main->agentnum;
2184 if ( defined($args{'template'}) && length($args{'template'})
2185 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2188 $logo = 'logo_'. $args{'template'}. '.png';
2192 my $image_data = $conf->config_binary( $logo, $agentnum);
2194 push @related_parts, build MIME::Entity
2195 'Type' => 'image/png',
2196 'Encoding' => 'base64',
2197 'Data' => $image_data,
2198 'Filename' => 'logo.png',
2199 'Content-ID' => "<$content_id>",
2202 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2203 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2204 push @related_parts, build MIME::Entity
2205 'Type' => 'image/png',
2206 'Encoding' => 'base64',
2207 'Data' => $self->invoice_barcode(0),
2208 'Filename' => 'barcode.png',
2209 'Content-ID' => "<$barcode_content_id>",
2211 $args{'barcode_cid'} = $barcode_content_id;
2214 $html = $self->print_html({ 'cid'=>$content_id, %args });
2221 warn "$me creating HTML/text multipart message"
2224 $return{'nobody'} = 1;
2226 my $alternative = build MIME::Entity
2227 'Type' => 'multipart/alternative',
2228 #'Encoding' => '7bit',
2229 'Disposition' => 'inline'
2233 $alternative->add_part($text_part);
2236 $alternative->attach(
2237 'Type' => 'text/html',
2238 'Encoding' => 'quoted-printable',
2239 'Data' => [ '<html>',
2242 ' '. encode_entities($return{'subject'}),
2245 ' <body bgcolor="#e8e8e8">',
2250 'Disposition' => 'inline',
2251 #'Filename' => 'invoice.pdf',
2254 unshift @related_parts, $alternative;
2256 $related = build MIME::Entity 'Type' => 'multipart/related',
2257 'Encoding' => '7bit';
2259 #false laziness w/Misc::send_email
2260 $related->head->replace('Content-type',
2261 $related->mime_type.
2262 '; boundary="'. $related->head->multipart_boundary. '"'.
2263 '; type=multipart/alternative'
2266 $related->add_part($_) foreach @related_parts;
2270 my @otherparts = ();
2271 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2273 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2275 my $data = join('', map "$_\n",
2276 $self->call_details(prepend_billed_number=>1)
2279 my $zip = new Archive::Zip;
2280 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2281 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2284 my $SH = IO::Scalar->new(\$zipdata);
2285 my $status = $zip->writeToFileHandle($SH);
2286 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2288 push @otherparts, build MIME::Entity
2289 'Type' => 'application/zip',
2290 'Encoding' => 'base64',
2292 'Disposition' => 'attachment',
2293 'Filename' => 'usage-'. $self->invnum. '.zip',
2296 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2298 push @otherparts, build MIME::Entity
2299 'Type' => 'text/csv',
2300 'Encoding' => '7bit',
2301 'Data' => [ map { "$_\n" }
2302 $self->call_details('prepend_billed_number' => 1)
2304 'Disposition' => 'attachment',
2305 'Filename' => 'usage-'. $self->invnum. '.csv',
2312 if ( $conf->exists($tc.'email_pdf') ) {
2317 # multipart/alternative
2323 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2324 push @otherparts, $pdf;
2328 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2330 $return{'mimeparts'} = [ $related, @otherparts ];
2331 $return{'type'} = 'multipart/related'; # of the first part
2333 $return{'mimeparts'} = [ $text_part, @otherparts ];
2334 $return{'type'} = 'text/plain';
2336 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2337 $return{'mimeparts'} = \@related_parts;
2338 $return{'content-type'} = 'multipart/related';
2339 $return{'type'} = 'multipart/alternative';
2340 } else { # no HTML either
2341 $return{'body'} = \@text;
2342 $return{'content-type'} = 'text/plain';
2351 Returns a list suitable for passing to MIME::Entity->build(), representing
2352 this invoice as PDF attachment.
2359 'Type' => 'application/pdf',
2360 'Encoding' => 'base64',
2361 'Data' => [ $self->print_pdf(@_) ],
2362 'Disposition' => 'attachment',
2363 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2367 =item postal_mail_fsinc
2369 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2375 use IO::Socket::SSL;
2377 use HTTP::Request::Common qw( POST );
2380 sub postal_mail_fsinc {
2381 my ( $self, %opt ) = @_;
2383 my $url = 'https://ws.freeside.biz/print';
2385 my $cust_main = $self->cust_main;
2386 my $agentnum = $cust_main->agentnum;
2387 my $bill_location = $cust_main->bill_location;
2389 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2390 if $bill_location->country ne 'US';
2392 my $conf = new FS::Conf;
2394 my @company_address = $conf->config('company_address', $agentnum);
2395 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2396 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2397 $company_address1 = $company_address[0];
2398 $company_address2 = $company_address[1];
2400 $company_state = $2;
2402 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2403 $company_address1 = $company_address[0];
2404 $company_address2 = '';
2406 $company_state = $2;
2409 die "Unparsable company_address; contact support\@freeside.biz\n";
2411 $company_city =~ s/,$//;
2413 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2414 my $pages = CAM::PDF->new($file)->numPages;
2416 my $ua = LWP::UserAgent->new(
2418 verify_hostname => 0,
2419 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2420 SSL_version => 'SSLv3',
2423 my $response = $ua->request( POST $url, [
2424 'support-key' => scalar($conf->config('support-key')),
2425 'file' => encode_base64($file),
2429 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2430 'company_address1' => $company_address1,
2431 'company_address2' => $company_address2,
2432 'company_city' => $company_city,
2433 'company_state' => $company_state,
2434 'company_zip' => $company_zip,
2435 'company_country' => 'US',
2436 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2437 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2440 'name' => ( $cust_main->payname
2441 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/
2442 ? $cust_main->payname
2443 : $cust_main->contact_firstlast
2445 'company' => $cust_main->company,
2446 'address1' => $bill_location->address1,
2447 'address2' => $bill_location->address2,
2448 'city' => $bill_location->city,
2449 'state' => $bill_location->state,
2450 'zip' => $bill_location->zip,
2451 'country' => $bill_location->country,
2454 die "Print connection error: ". $response->message.
2455 ' ('. $response->as_string. ")\n"
2456 unless $response->is_success;
2459 my $content = eval { decode_json($response->content) };
2460 die "Print JSON error : $@\n" if $@;
2462 die $content->{error}."\n"
2463 if $content->{error};
2465 #TODO: store this so we can query for a status later
2466 warn "Invoice printed, ID ". $content->{id}. "\n";
2471 =item _items_sections OPTIONS
2473 Generate section information for all items appearing on this invoice.
2474 This will only be called for multi-section invoices.
2476 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2477 related display records (L<FS::cust_bill_pkg_display>) and organize
2478 them into two groups ("early" and "late" according to whether they come
2479 before or after the total), then into sections. A subtotal is calculated
2482 Section descriptions are returned in sort weight order. Each consists
2483 of a hash containing:
2485 description: the package category name, escaped
2486 subtotal: the total charges in that section
2487 tax_section: a flag indicating that the section contains only tax charges
2488 summarized: same as tax_section, for some reason
2489 sort_weight: the package category's sort weight
2491 If 'condense' is set on the display record, it also contains everything
2492 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2493 coderefs to generate parts of the invoice. This is not advised.
2495 The method returns two arrayrefs, one of "early" sections and one of "late"
2498 OPTIONS may include:
2500 by_location: a flag to divide the invoice into sections by location.
2501 Each section hash will have a 'location' element containing a hashref of
2502 the location fields (see L<FS::cust_location>). The section description
2503 will be the location label, but the template can use any of the location
2504 fields to create a suitable label.
2506 by_category: a flag to divide the invoice into sections using display
2507 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2508 behavior. Each section hash will have a 'category' element containing
2509 the section name from the display record (which probably equals the
2510 category name of the package, but may not in some cases).
2512 summary: a flag indicating that this is a summary-format invoice.
2513 Turning this on has the following effects:
2514 - Ignores display items with the 'summary' flag.
2515 - Places all sections in the "early" group even if they have post_total.
2516 - Creates sections for all non-disabled package categories, even if they
2517 have no charges on this invoice, as well as a section with no name.
2519 escape: an escape function to use for section titles.
2521 extra_sections: an arrayref of additional sections to return after the
2522 sorted list. If there are any of these, section subtotals exclude
2525 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2526 passed through to C<_condense_section()>.
2530 use vars qw(%pkg_category_cache);
2531 sub _items_sections {
2535 my $escape = $opt{escape};
2536 my @extra_sections = @{ $opt{extra_sections} || [] };
2538 # $subtotal{$locationnum}{$categoryname} = amount.
2539 # if we're not using by_location, $locationnum is undef.
2540 # if we're not using by_category, you guessed it, $categoryname is undef.
2541 # if we're not using either one, we shouldn't be here in the first place...
2543 my %late_subtotal = ();
2546 # About tax items + multisection invoices:
2547 # If either invoice_*summary option is enabled, AND there is a
2548 # package category with the name of the tax, then there will be
2549 # a display record assigning the tax item to that category.
2551 # However, the taxes are always placed in the "Taxes, Surcharges,
2552 # and Fees" section regardless of that. The only effect of the
2553 # display record is to create a subtotal for the summary page.
2556 my $pkg_hash = $self->cust_pkg_hash;
2558 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2561 my $usage = $cust_bill_pkg->usage;
2564 if ( $opt{by_location} ) {
2565 if ( $cust_bill_pkg->pkgnum ) {
2566 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2571 $locationnum = undef;
2574 # as in _items_cust_pkg, if a line item has no display records,
2575 # cust_bill_pkg_display() returns a default record for it
2577 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2578 next if ( $display->summary && $opt{summary} );
2580 my $section = $display->section;
2581 my $type = $display->type;
2582 # Set $section = undef if we're sectioning by location and this
2583 # line item _has_ a location (i.e. isn't a fee).
2584 $section = undef if $locationnum;
2586 # set this flag if the section is not tax-only
2587 $not_tax{$locationnum}{$section} = 1
2588 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2590 # there's actually a very important piece of logic buried in here:
2591 # incrementing $late_subtotal{$section} CREATES
2592 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2593 # to define the list of late sections, and likewise keys(%subtotal).
2594 # When _items_cust_bill_pkg is called to generate line items for
2595 # real, it will be called with 'section' => $section for each
2597 if ( $display->post_total && !$opt{summary} ) {
2598 if (! $type || $type eq 'S') {
2599 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2600 if $cust_bill_pkg->setup != 0
2601 || $cust_bill_pkg->setup_show_zero;
2605 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2606 if $cust_bill_pkg->recur != 0
2607 || $cust_bill_pkg->recur_show_zero;
2610 if ($type && $type eq 'R') {
2611 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2612 if $cust_bill_pkg->recur != 0
2613 || $cust_bill_pkg->recur_show_zero;
2616 if ($type && $type eq 'U') {
2617 $late_subtotal{$locationnum}{$section} += $usage
2618 unless scalar(@extra_sections);
2621 } else { # it's a pre-total (normal) section
2623 # skip tax items unless they're explicitly included in a section
2624 next if $cust_bill_pkg->pkgnum == 0 and
2625 ! $cust_bill_pkg->feepart and
2628 if ( $type eq 'S' ) {
2629 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2630 if $cust_bill_pkg->setup != 0
2631 || $cust_bill_pkg->setup_show_zero;
2632 } elsif ( $type eq 'R' ) {
2633 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2634 if $cust_bill_pkg->recur != 0
2635 || $cust_bill_pkg->recur_show_zero;
2636 } elsif ( $type eq 'U' ) {
2637 $subtotal{$locationnum}{$section} += $usage
2638 unless scalar(@extra_sections);
2639 } elsif ( !$type ) {
2640 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2641 + $cust_bill_pkg->recur;
2650 %pkg_category_cache = ();
2652 # summary invoices need subtotals for all non-disabled package categories,
2653 # even if they're zero
2654 # but currently assume that there are no location sections, or at least
2655 # that the summary page doesn't care about them
2656 if ( $opt{summary} ) {
2657 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2658 $subtotal{''}{$category->categoryname} ||= 0;
2660 $subtotal{''}{''} ||= 0;
2664 foreach my $post_total (0,1) {
2666 my $s = $post_total ? \%late_subtotal : \%subtotal;
2667 foreach my $locationnum (keys %$s) {
2668 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2670 'subtotal' => $s->{$locationnum}{$sectionname},
2673 if ( $locationnum ) {
2674 $section->{'locationnum'} = $locationnum;
2675 my $location = FS::cust_location->by_key($locationnum);
2676 $section->{'description'} = &{ $escape }($location->location_label);
2677 # Better ideas? This will roughly group them by proximity,
2678 # which alpha sorting on any of the address fields won't.
2679 # Sorting by locationnum is meaningless.
2680 # We have to sort on _something_ or the order may change
2681 # randomly from one invoice to the next, which will confuse
2683 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2685 $section->{'location'} = {
2686 label_prefix => &{ $escape }($location->label_prefix),
2687 map { $_ => &{ $escape }($location->get($_)) }
2691 $section->{'category'} = $sectionname;
2692 $section->{'description'} = &{ $escape }($sectionname);
2693 if ( _pkg_category($sectionname) ) {
2694 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2695 if ( _pkg_category($sectionname)->condense ) {
2696 $section = { %$section, $self->_condense_section($opt{format}) };
2700 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2701 # then it's a tax-only section
2702 $section->{'summarized'} = 'Y';
2703 $section->{'tax_section'} = 'Y';
2705 push @these, $section;
2706 } # foreach $sectionname
2707 } #foreach $locationnum
2708 push @these, @extra_sections if $post_total == 0;
2709 # need an alpha sort for location sections, because postal codes can
2711 $sections[ $post_total ] = [ sort {
2712 $opt{'by_location'} ?
2713 ($a->{sort_weight} cmp $b->{sort_weight}) :
2714 ($a->{sort_weight} <=> $b->{sort_weight})
2716 } #foreach $post_total
2718 return @sections; # early, late
2721 #helper subs for above
2725 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2729 my $categoryname = shift;
2730 $pkg_category_cache{$categoryname} ||=
2731 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2734 my %condensed_format = (
2735 'label' => [ qw( Description Qty Amount ) ],
2737 sub { shift->{description} },
2738 sub { shift->{quantity} },
2739 sub { my($href, %opt) = @_;
2740 ($opt{dollar} || ''). $href->{amount};
2743 'align' => [ qw( l r r ) ],
2744 'span' => [ qw( 5 1 1 ) ], # unitprices?
2745 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2748 sub _condense_section {
2749 my ( $self, $format ) = ( shift, shift );
2751 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2752 qw( description_generator
2755 total_line_generator
2760 sub _condensed_generator_defaults {
2761 my ( $self, $format ) = ( shift, shift );
2762 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2771 sub _condensed_header_generator {
2772 my ( $self, $format ) = ( shift, shift );
2774 my ( $f, $prefix, $suffix, $separator, $column ) =
2775 _condensed_generator_defaults($format);
2777 if ($format eq 'latex') {
2778 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2779 $suffix = "\\\\\n\\hline";
2782 sub { my ($d,$a,$s,$w) = @_;
2783 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2785 } elsif ( $format eq 'html' ) {
2786 $prefix = '<th></th>';
2790 sub { my ($d,$a,$s,$w) = @_;
2791 return qq!<th align="$html_align{$a}">$d</th>!;
2799 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2801 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2804 $prefix. join($separator, @result). $suffix;
2809 sub _condensed_description_generator {
2810 my ( $self, $format ) = ( shift, shift );
2812 my ( $f, $prefix, $suffix, $separator, $column ) =
2813 _condensed_generator_defaults($format);
2815 my $money_char = '$';
2816 if ($format eq 'latex') {
2817 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2819 $separator = " & \n";
2821 sub { my ($d,$a,$s,$w) = @_;
2822 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2824 $money_char = '\\dollar';
2825 }elsif ( $format eq 'html' ) {
2826 $prefix = '"><td align="center"></td>';
2830 sub { my ($d,$a,$s,$w) = @_;
2831 return qq!<td align="$html_align{$a}">$d</td>!;
2833 #$money_char = $conf->config('money_char') || '$';
2834 $money_char = ''; # this is madness
2842 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2844 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2846 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2847 map { $f->{$_}->[$i] } qw(align span width)
2851 $prefix. join( $separator, @result ). $suffix;
2856 sub _condensed_total_generator {
2857 my ( $self, $format ) = ( shift, shift );
2859 my ( $f, $prefix, $suffix, $separator, $column ) =
2860 _condensed_generator_defaults($format);
2863 if ($format eq 'latex') {
2866 $separator = " & \n";
2868 sub { my ($d,$a,$s,$w) = @_;
2869 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2871 }elsif ( $format eq 'html' ) {
2875 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2877 sub { my ($d,$a,$s,$w) = @_;
2878 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2887 # my $r = &{$f->{fields}->[$i]}(@args);
2888 # $r .= ' Total' unless $i;
2890 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2892 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2893 map { $f->{$_}->[$i] } qw(align span width)
2897 $prefix. join( $separator, @result ). $suffix;
2902 =item total_line_generator FORMAT
2904 Returns a coderef used for generation of invoice total line items for this
2905 usage_class. FORMAT is either html or latex
2909 # should not be used: will have issues with hash element names (description vs
2910 # total_item and amount vs total_amount -- another array of functions?
2912 sub _condensed_total_line_generator {
2913 my ( $self, $format ) = ( shift, shift );
2915 my ( $f, $prefix, $suffix, $separator, $column ) =
2916 _condensed_generator_defaults($format);
2919 if ($format eq 'latex') {
2922 $separator = " & \n";
2924 sub { my ($d,$a,$s,$w) = @_;
2925 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2927 }elsif ( $format eq 'html' ) {
2931 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2933 sub { my ($d,$a,$s,$w) = @_;
2934 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2943 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2945 &{$column}( &{$f->{fields}->[$i]}(@args),
2946 map { $f->{$_}->[$i] } qw(align span width)
2950 $prefix. join( $separator, @result ). $suffix;
2955 =item _items_pkg [ OPTIONS ]
2957 Return line item hashes for each package item on this invoice. Nearly
2960 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2962 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2963 'format' and 'escape_function' at minimum.
2965 To produce items for a specific invoice section, OPTIONS should include
2966 'section', a hashref containing 'category' and/or 'locationnum' keys.
2968 'section' may also contain a key named 'condensed'. If this is present
2969 and has a true value, _items_pkg will try to merge identical items into items
2970 with 'quantity' equal to the number of items (not the sum of their separate
2971 quantities, for some reason).
2977 # The order of these is important. Bundled line items will be merged into
2978 # the most recent non-hidden item, so it needs to be the one with:
2980 # - the same start date
2981 # - no pkgpart_override
2983 # So: sort by pkgnum,
2985 # then sort the base line item before any overrides
2986 # then sort hidden before non-hidden add-ons
2987 # then sort by override pkgpart (for consistency)
2988 sort { $a->pkgnum <=> $b->pkgnum or
2989 $a->sdate <=> $b->sdate or
2990 ($a->pkgpart_override ? 0 : -1) or
2991 ($b->pkgpart_override ? 0 : 1) or
2992 $b->hidden cmp $a->hidden or
2993 $a->pkgpart_override <=> $b->pkgpart_override
2995 # and of course exclude taxes and fees
2996 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3002 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3003 my $escape_function = $options{escape_function};
3006 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3007 # cache this, so we don't look it up again in every section
3008 my $part_fee = $cust_bill_pkg->get('part_fee')
3009 || $cust_bill_pkg->part_fee;
3010 $cust_bill_pkg->set('part_fee', $part_fee);
3012 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3013 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3016 if ( exists($options{section}) and exists($options{section}{category}) )
3018 my $categoryname = $options{section}{category};
3019 # then filter for items that have that section
3020 if ( $part_fee->categoryname ne $categoryname ) {
3021 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3024 } # otherwise include them all in the main section
3025 # XXX what to do when sectioning by location?
3028 my %base_invnums; # invnum => invoice date
3029 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3030 if ($_->base_invnum) {
3031 # XXX what if base_bill has been voided?
3032 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3033 my $base_date = $self->time2str_local('short', $base_bill->_date)
3035 $base_invnums{$_->base_invnum} = $base_date || '';
3038 foreach (sort keys(%base_invnums)) {
3039 next if $_ == $self->invnum;
3040 # per convention, we must escape ext_description lines
3042 &{$escape_function}(
3043 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3046 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3047 # but not escape the base description line
3050 { feepart => $cust_bill_pkg->feepart,
3051 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3052 description => $desc,
3053 ext_description => \@ext_desc
3064 warn "$me _items_pkg searching for all package line items\n"
3067 my @cust_bill_pkg = $self->_items_nontax;
3069 warn "$me _items_pkg filtering line items\n"
3071 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3073 if ($options{section} && $options{section}->{condensed}) {
3075 warn "$me _items_pkg condensing section\n"
3079 local $Storable::canonical = 1;
3080 foreach ( @items ) {
3082 delete $item->{ref};
3083 delete $item->{ext_description};
3084 my $key = freeze($item);
3085 $itemshash{$key} ||= 0;
3086 $itemshash{$key} ++; # += $item->{quantity};
3088 @items = sort { $a->{description} cmp $b->{description} }
3089 map { my $i = thaw($_);
3090 $i->{quantity} = $itemshash{$_};
3092 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3098 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3105 return 0 unless $a->itemdesc cmp $b->itemdesc;
3106 return -1 if $b->itemdesc eq 'Tax';
3107 return 1 if $a->itemdesc eq 'Tax';
3108 return -1 if $b->itemdesc eq 'Other surcharges';
3109 return 1 if $a->itemdesc eq 'Other surcharges';
3110 $a->itemdesc cmp $b->itemdesc;
3115 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3116 $self->cust_bill_pkg;
3117 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3119 if ( $self->conf->exists('always_show_tax') ) {
3120 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3121 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3123 { 'description' => $itemdesc,
3130 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3132 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3133 list of hashrefs describing the line items they generate on the invoice.
3135 OPTIONS may include:
3137 format: the invoice format.
3139 escape_function: the function used to escape strings.
3141 DEPRECATED? (expensive, mostly unused?)
3142 format_function: the function used to format CDRs.
3144 section: a hashref containing 'category' and/or 'locationnum'; if this
3145 is present, only returns line items that belong to that category and/or
3146 location (whichever is defined).
3148 multisection: a flag indicating that this is a multisection invoice,
3149 which does something complicated.
3151 preref_callback: coderef run for each line item, code should return HTML to be
3152 displayed before that line item (quotations only)
3154 Returns a list of hashrefs, each of which may contain:
3156 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3157 ext_description, which is an arrayref of detail lines to show below
3162 sub _items_cust_bill_pkg {
3164 my $conf = $self->conf;
3165 my $cust_bill_pkgs = shift;
3168 my $format = $opt{format} || '';
3169 my $escape_function = $opt{escape_function} || sub { shift };
3170 my $format_function = $opt{format_function} || '';
3171 my $no_usage = $opt{no_usage} || '';
3172 my $unsquelched = $opt{unsquelched} || ''; #unused
3173 my ($section, $locationnum, $category);
3174 if ( $opt{section} ) {
3175 $category = $opt{section}->{category};
3176 $locationnum = $opt{section}->{locationnum};
3178 my $summary_page = $opt{summary_page} || ''; #unused
3179 my $multisection = defined($category) || defined($locationnum);
3180 # this variable is the value of the config setting, not whether it applies
3181 # to this particular line item.
3182 my $discount_show_always = $conf->exists('discount-show-always');
3184 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3186 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3188 # for location labels: use default location on the invoice date
3189 my $default_locationnum;
3190 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3191 $default_locationnum = 0; # treat them all as non-default
3192 } elsif ( $self->custnum ) {
3194 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3195 $h_cust_main = qsearchs({
3196 'table' => 'h_cust_main',
3197 'hashref' => { custnum => $self->custnum },
3198 'extra_sql' => $h_search[1],
3199 'addl_from' => $h_search[3],
3201 $default_locationnum = $h_cust_main->ship_locationnum;
3202 } elsif ( $self->prospectnum ) {
3203 my $cust_location = qsearchs('cust_location',
3204 { prospectnum => $self->prospectnum,
3206 $default_locationnum = $cust_location->locationnum if $cust_location;
3209 my @b = (); # accumulator for the line item hashes that we'll return
3210 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3211 # the 'current' line item hashes for setup, recur, usage, discount
3212 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3214 # if the current line item is waiting to go out, and the one we're about
3215 # to start is not bundled, then push out the current one and start a new
3217 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3218 if ( $_ && !$cust_bill_pkg->hidden ) {
3219 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3220 $_->{amount} =~ s/^\-0\.00$/0.00/;
3221 if (exists($_->{unit_amount})) {
3222 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3225 # we already decided to create this display line; don't reconsider it
3227 # if $_->{amount} != 0
3228 # || $discount_show_always
3229 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3230 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3236 if ( $locationnum ) {
3237 # this is a location section; skip packages that aren't at this
3239 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3240 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3244 # Consider display records for this item to determine if it belongs
3245 # in this section. Note that if there are no display records, there
3246 # will be a default pseudo-record that includes all charge types
3247 # and has no section name.
3248 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3249 ? $cust_bill_pkg->cust_bill_pkg_display
3250 : ( $cust_bill_pkg );
3252 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3253 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3256 if ( defined($category) ) {
3257 # then this is a package category section; process all display records
3258 # that belong to this section.
3259 @cust_bill_pkg_display = grep { $_->section eq $category }
3260 @cust_bill_pkg_display;
3262 # otherwise, process all display records that aren't usage summaries
3263 # (I don't think there should be usage summaries if you aren't using
3264 # category sections, but this is the historical behavior)
3265 @cust_bill_pkg_display = grep { !$_->summary }
3266 @cust_bill_pkg_display;
3269 my $classname = ''; # package class name, will fill in later
3271 foreach my $display (@cust_bill_pkg_display) {
3273 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3274 $display->billpkgdisplaynum. "\n"
3277 my $type = $display->type;
3279 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3280 $desc = substr($desc, 0, $maxlength). '...'
3281 if $format eq 'latex' && length($desc) > $maxlength;
3283 my %details_opt = ( 'format' => $format,
3284 'escape_function' => $escape_function,
3285 'format_function' => $format_function,
3286 'no_usage' => $opt{'no_usage'},
3289 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3290 # XXX this should be pulled out into quotation_pkg
3292 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3294 # quotation_pkgs are never fees, so don't worry about the case where
3295 # part_pkg is undefined
3297 my @details = $cust_bill_pkg->details;
3299 # and I guess they're never bundled either?
3300 if (( $cust_bill_pkg->setup != 0 ) || ( $cust_bill_pkg->setup_show_zero )) {
3301 my $description = $desc;
3302 $description .= ' Setup'
3303 if $cust_bill_pkg->recur != 0
3304 || $discount_show_always
3305 || $cust_bill_pkg->recur_show_zero;
3307 # keep it consistent, please
3309 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3310 'description' => $description,
3311 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3312 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3313 'quantity' => $cust_bill_pkg->quantity,
3314 'ext_description' => \@details,
3315 'preref_html' => ( $opt{preref_callback}
3316 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3321 if (( $cust_bill_pkg->recur != 0 ) || ( $cust_bill_pkg->recur_show_zero )) {
3324 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3325 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3326 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3327 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3328 'quantity' => $cust_bill_pkg->quantity,
3329 'ext_description' => \@details,
3330 'preref_html' => ( $opt{preref_callback}
3331 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3337 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3338 # a "normal" package line item (not a quotation, not a fee, not a tax)
3340 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3343 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3344 my $part_pkg = $cust_pkg->part_pkg;
3346 # which pkgpart to show for display purposes?
3347 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3349 # start/end dates for invoice formats that do nonstandard
3351 my %item_dates = ();
3352 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3353 unless $part_pkg->option('disable_line_item_date_ranges',1);
3355 # not normally used, but pass this to the template anyway
3356 $classname = $part_pkg->classname;
3358 if ( (!$type || $type eq 'S')
3359 && ( $cust_bill_pkg->setup != 0
3360 || $cust_bill_pkg->setup_show_zero
3361 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3366 warn "$me _items_cust_bill_pkg adding setup\n"
3369 # append the word 'Setup' to the setup line if there's going to be
3370 # a recur line for the same package (i.e. not a one-time charge)
3372 my $description = $desc;
3373 $description .= ' Setup'
3374 if $cust_bill_pkg->recur != 0
3375 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3376 || $cust_bill_pkg->recur_show_zero;
3378 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3380 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3381 # triggered by the recurring charge freq
3383 && $cust_bill_pkg->recur == 0
3384 && ! $cust_bill_pkg->recur_show_zero;
3389 # always pass the svc_label through to the template, even if
3390 # not displaying it as an ext_description
3391 my @svc_labels = map &{$escape_function}($_),
3392 $cust_pkg->h_labels_short($self->_date,
3395 $self->conf->{locale},
3397 $svc_label = $svc_labels[0];
3399 unless ( $cust_pkg->part_pkg->hide_svc_detail
3400 || $cust_bill_pkg->hidden )
3403 push @d, @svc_labels
3404 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3405 # show the location label if it's not the customer's default
3406 # location, and we're not grouping items by location already
3407 if ( $cust_pkg->locationnum != $default_locationnum
3408 and !defined($locationnum) ) {
3409 my $loc = $cust_pkg->location_label;
3410 $loc = substr($loc, 0, $maxlength). '...'
3411 if $format eq 'latex' && length($loc) > $maxlength;
3412 push @d, &{$escape_function}($loc);
3415 } #unless hiding service details
3417 push @d, $cust_bill_pkg->details(%details_opt)
3418 if $cust_bill_pkg->recur == 0;
3420 if ( $cust_bill_pkg->hidden ) {
3421 $s->{amount} += $cust_bill_pkg->setup;
3422 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3423 push @{ $s->{ext_description} }, @d;
3427 description => $description,
3428 pkgpart => $pkgpart,
3429 pkgnum => $cust_bill_pkg->pkgnum,
3430 amount => $cust_bill_pkg->setup,
3431 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3432 unit_amount => $cust_bill_pkg->unitsetup,
3433 quantity => $cust_bill_pkg->quantity,
3434 ext_description => \@d,
3435 svc_label => ($svc_label || ''),
3436 locationnum => $cust_pkg->locationnum, # sure, why not?
3442 # should we show a recur line?
3443 # if type eq 'S', then NO, because we've been told not to.
3444 # otherwise, show the recur line if:
3445 # - there's a recurring charge
3446 # - or recur_show_zero is on
3447 # - or there's a positive unitrecur (so it's been discounted to zero)
3448 # and discount-show-always is on
3449 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3451 $cust_bill_pkg->recur != 0
3453 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3454 || $cust_bill_pkg->recur_show_zero
3459 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3462 my $is_summary = $display->summary;
3463 my $description = $desc;
3464 if ( $type eq 'U' and defined($r) ) {
3465 # don't just show the same description as the recur line
3466 $description = $self->mt('Usage charges');
3469 my $part_pkg = $cust_pkg->part_pkg;
3471 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3475 my @seconds = (); # for display of usage info
3478 #at least until cust_bill_pkg has "past" ranges in addition to
3479 #the "future" sdate/edate ones... see #3032
3480 my @dates = ( $self->_date );
3481 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3482 push @dates, $prev->sdate if $prev;
3483 push @dates, undef if !$prev;
3485 my @svc_labels = map &{$escape_function}($_),
3486 $cust_pkg->h_labels_short(@dates,
3488 $self->conf->{locale});
3489 $svc_label = $svc_labels[0];
3491 # show service labels, unless...
3492 # the package is set not to display them
3493 unless ( $part_pkg->hide_svc_detail
3494 # or this is a tax-like line item
3495 || $cust_bill_pkg->itemdesc
3496 # or this is a hidden (bundled) line item
3497 || $cust_bill_pkg->hidden
3498 # or this is a usage summary line
3499 || $is_summary && $type && $type eq 'U'
3500 # or this is a usage line and there's a recurring line
3501 # for the package in the same section (which will
3502 # have service labels already)
3503 || ($type eq 'U' and defined($r))
3507 warn "$me _items_cust_bill_pkg adding service details\n"
3510 push @d, @svc_labels
3511 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3512 warn "$me _items_cust_bill_pkg done adding service details\n"
3515 # show the location label if it's not the customer's default
3516 # location, and we're not grouping items by location already
3517 if ( $cust_pkg->locationnum != $default_locationnum
3518 and !defined($locationnum) ) {
3519 my $loc = $cust_pkg->location_label;
3520 $loc = substr($loc, 0, $maxlength). '...'
3521 if $format eq 'latex' && length($loc) > $maxlength;
3522 push @d, &{$escape_function}($loc);
3525 # Display of seconds_since_sqlradacct:
3526 # On the invoice, when processing @detail_items, look for a field
3527 # named 'seconds'. This will contain total seconds for each
3528 # service, in the same order as @ext_description. For services
3529 # that don't support this it will show undef.
3530 if ( $conf->exists('svc_acct-usage_seconds')
3531 and ! $cust_bill_pkg->pkgpart_override ) {
3532 foreach my $cust_svc (
3533 $cust_pkg->h_cust_svc(@dates, 'I')
3536 # eval because not having any part_export_usage exports
3537 # is a fatal error, last_bill/_date because that's how
3538 # sqlradius_hour billing does it
3540 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3542 push @seconds, $sec;
3544 } #if svc_acct-usage_seconds
3546 } # if we are showing service labels
3548 unless ( $is_summary ) {
3549 warn "$me _items_cust_bill_pkg adding details\n"
3552 #instead of omitting details entirely in this case (unwanted side
3553 # effects), just omit CDRs
3554 $details_opt{'no_usage'} = 1
3555 if $type && $type eq 'R';
3557 push @d, $cust_bill_pkg->details(%details_opt);
3560 warn "$me _items_cust_bill_pkg calculating amount\n"
3565 $amount = $cust_bill_pkg->recur;
3566 } elsif ($type eq 'R') {
3567 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3568 } elsif ($type eq 'U') {
3569 $amount = $cust_bill_pkg->usage;
3572 if ( !$type || $type eq 'R' ) {
3574 warn "$me _items_cust_bill_pkg adding recur\n"
3578 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3581 if ( $cust_bill_pkg->hidden ) {
3582 $r->{amount} += $amount;
3583 $r->{unit_amount} += $unit_amount;
3584 push @{ $r->{ext_description} }, @d;
3587 description => $description,
3588 pkgpart => $pkgpart,
3589 pkgnum => $cust_bill_pkg->pkgnum,
3591 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3592 unit_amount => $unit_amount,
3593 quantity => $cust_bill_pkg->quantity,
3595 ext_description => \@d,
3596 svc_label => ($svc_label || ''),
3597 locationnum => $cust_pkg->locationnum,
3599 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3602 } else { # $type eq 'U'
3604 warn "$me _items_cust_bill_pkg adding usage\n"
3607 if ( $cust_bill_pkg->hidden and defined($u) ) {
3608 # if this is a hidden package and there's already a usage
3609 # line for the bundle, add this package's total amount and
3610 # usage details to it
3611 $u->{amount} += $amount;
3612 push @{ $u->{ext_description} }, @d;
3613 } elsif ( $amount ) {
3614 # create a new usage line
3616 description => $description,
3617 pkgpart => $pkgpart,
3618 pkgnum => $cust_bill_pkg->pkgnum,
3621 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3623 ext_description => \@d,
3624 locationnum => $cust_pkg->locationnum,
3626 } # else this has no usage, so don't create a usage section
3629 } # recurring or usage with recurring charge
3631 } else { # taxes and fees
3633 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3636 # items of this kind should normally not have sdate/edate.
3638 'description' => $desc,
3639 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3640 + $cust_bill_pkg->recur)
3643 } # if quotation / package line item / other line item
3645 # decide whether to show active discounts here
3647 # case 1: we are showing a single line for the package
3649 # case 2: we are showing a setup line for a package that has
3650 # no base recurring fee
3651 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3652 # case 3: we are showing a recur line for a package that has
3653 # a base recurring fee
3654 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3657 my $item_discount = $cust_bill_pkg->_item_discount;
3658 if ( $item_discount ) {
3659 # $item_discount->{amount} is negative
3661 if ( $d and $cust_bill_pkg->hidden ) {
3662 $d->{amount} += $item_discount->{amount};
3664 $d = $item_discount;
3665 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3668 # update the active line (before the discount) to show the
3669 # original price (whether this is a hidden line or not)
3671 # quotation discounts keep track of setup and recur; invoice
3672 # discounts currently don't
3673 if ( exists $item_discount->{setup_amount} ) {
3675 $s->{amount} -= $item_discount->{setup_amount} if $s;
3676 $r->{amount} -= $item_discount->{recur_amount} if $r;
3680 # $active_line is the line item hashref for the line that will
3681 # show the original price
3682 # (use the recur or single line for the package, unless we're
3683 # showing a setup line for a package with no recurring fee)
3684 my $active_line = $r;
3685 if ( $type eq 'S' ) {
3688 $active_line->{amount} -= $item_discount->{amount};
3692 } # if there are any discounts
3693 } # if this is an appropriate place to show discounts
3695 } # foreach $display
3699 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3701 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3702 if exists($_->{amount});
3703 $_->{amount} =~ s/^\-0\.00$/0.00/;
3704 if (exists($_->{unit_amount})) {
3705 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3709 #if $_->{amount} != 0
3710 # || $discount_show_always
3711 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3712 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3716 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3723 =item _items_discounts_avail
3725 Returns an array of line item hashrefs representing available term discounts
3726 for this invoice. This makes the same assumptions that apply to term
3727 discounts in general: that the package is billed monthly, at a flat rate,
3728 with no usage charges. A prorated first month will be handled, as will
3729 a setup fee if the discount is allowed to apply to setup fees.
3733 sub _items_discounts_avail {
3736 #maybe move this method from cust_bill when quotations support discount_plans
3737 return () unless $self->can('discount_plans');
3738 my %plans = $self->discount_plans;
3740 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3741 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3745 my $plan = $plans{$months};
3747 my $term_total = sprintf('%.2f', $plan->discounted_total);
3748 my $percent = sprintf('%.0f',
3749 100 * (1 - $term_total / $plan->base_total) );
3750 my $permonth = sprintf('%.2f', $term_total / $months);
3751 my $detail = $self->mt('discount on item'). ' '.
3752 join(', ', map { "#$_" } $plan->pkgnums)
3755 # discounts for non-integer months don't work anyway
3756 $months = sprintf("%d", $months);
3759 description => $self->mt('Save [_1]% by paying for [_2] months',
3761 amount => $self->mt('[_1] ([_2] per month)',
3762 $term_total, $money_char.$permonth),
3763 ext_description => ($detail || ''),
3766 sort { $b <=> $a } keys %plans;