1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum); #can't import first, it conflicts with cust_main.first
13 use Time::Local qw( timelocal );
14 use Text::Template 1.20;
16 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
21 use FS::Misc qw( send_email );
22 use FS::Record qw( qsearch qsearchs dbh );
24 use FS::Misc qw( generate_ps generate_pdf );
31 $me = '[FS::Template_Mixin]';
32 FS::UID->install_callback( sub {
33 my $conf = new FS::Conf; #global
34 $money_char = $conf->config('money_char') || '$';
35 $date_format = $conf->config('date_format') || '%x'; #/YY
40 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
42 If the "mode" pseudo-field is set on the object, the configuration handle
43 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
50 my $mode = $self->get('mode');
51 if ($self->{_conf} and !defined($mode)) {
52 return $self->{_conf};
55 my $cust_main = $self->cust_main;
56 my $locale = $cust_main ? $cust_main->locale : '';
59 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
60 $mode = $mode->modenum;
61 } elsif ( $mode =~ /\D/ ) {
62 die "invalid invoice mode $mode";
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
66 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
67 # it doesn't have a locale, but system conf still might
68 $conf->set('locale' => $locale) if $conf;
71 # if $mode is unspecified, or if there is no invoice_conf matching this mode
72 # and locale, then use the system config only (but with the locale)
73 $conf ||= FS::Conf->new({ 'locale' => $locale });
75 return $self->{_conf} = $conf;
78 =item print_text OPTIONS
80 Returns an text invoice, as a list of lines.
82 Options can be passed as a hash.
84 I<time>, if specified, is used to control the printing of overdue messages. The
85 default is now. It isn't the date of the invoice; that's the `_date' field.
86 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 I<template>, if specified, is the name of a suffix for alternate invoices.
91 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
99 %params = %{ shift() };
104 $params{'format'} = 'template'; # for some reason
106 $self->print_generic( %params );
109 =item print_latex HASHREF
111 Internal method - returns a filename of a filled-in LaTeX template for this
112 invoice (Note: add ".tex" to get the actual filename), and a filename of
113 an associated logo (with the .eps extension included).
115 See print_ps and print_pdf for methods that return PostScript and PDF output.
117 Options can be passed as a hash.
119 I<time>, if specified, is used to control the printing of overdue messages. The
120 default is now. It isn't the date of the invoice; that's the `_date' field.
121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
122 L<Time::Local> and L<Date::Parse> for conversion functions.
124 I<template>, if specified, is the name of a suffix for alternate invoices.
125 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
126 customize invoice templates for different purposes.
128 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
137 %params = %{ shift() };
142 $params{'format'} = 'latex';
143 my $conf = $self->conf;
145 # this needs to go away
146 my $template = $params{'template'};
147 # and this especially
148 $template ||= $self->_agent_template
149 if $self->can('_agent_template');
152 $self->set('mode', $params{mode})
155 my $pkey = $self->primary_key;
156 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
159 my $lh = new File::Temp(
160 TEMPLATE => $tmp_template,
164 ) or die "can't open temp file: $!\n";
166 my $agentnum = $self->agentnum;
168 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
169 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
170 or die "can't write temp file: $!\n";
172 print $lh $conf->config_binary('logo.eps', $agentnum)
173 or die "can't write temp file: $!\n";
176 $params{'logo_file'} = $lh->filename;
178 if( $conf->exists('invoice-barcode')
179 && $self->can('invoice_barcode')
180 && $self->invnum ) { # don't try to barcode statements
181 my $png_file = $self->invoice_barcode($dir);
182 my $eps_file = $png_file;
183 $eps_file =~ s/\.png$/.eps/g;
184 $png_file =~ /(barcode.*png)/;
186 $eps_file =~ /(barcode.*eps)/;
189 my $curr_dir = cwd();
191 # after painfuly long experimentation, it was determined that sam2p won't
192 # accept : and other chars in the path, no matter how hard I tried to
193 # escape them, hence the chdir (and chdir back, just to be safe)
194 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
195 or die "sam2p failed: $!\n";
199 $params{'barcode_file'} = $eps_file;
202 my @filled_in = $self->print_generic( %params );
204 my $fh = new File::Temp( TEMPLATE => $tmp_template,
208 ) or die "can't open temp file: $!\n";
209 binmode($fh, ':utf8'); # language support
210 print $fh join('', @filled_in );
213 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
214 return ($1, $params{'logo_file'}, $params{'barcode_file'});
220 my $cust_main = $self->cust_main;
221 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
224 =item print_generic OPTION => VALUE ...
226 Internal method - returns a filled-in template for this invoice as a scalar.
228 See print_ps and print_pdf for methods that return PostScript and PDF output.
236 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
246 Overrides "Invoice" as the name of the sent document.
250 Used to control the printing of overdue messages. The
251 default is now. It isn't the date of the invoice; that's the `_date' field.
252 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
253 L<Time::Local> and L<Date::Parse> for conversion functions.
257 Logo file (path to temporary EPS file on the local filesystem)
261 CID for inline (emailed) images (logo)
265 Override customer's locale
269 Overrides any per customer cdr squelching when true
273 Supress the (invoice, quotation, statement, etc.) number
281 Supress the payment coupon
285 Barcode file (path to temporary EPS file on the local filesystem)
289 Flag indicating the barcode image should be a link (normal HTML dipaly)
293 Barcode CID for inline (emailed) images
295 =item preref_callback
297 Coderef run for each line item, code should return HTML to be displayed
298 before that line item (quotations only)
302 Deprecated. Used as a suffix for a configuration template. Please
303 don't use this, it deprecated in favor of more flexible alternatives.
309 #what's with all the sprintf('%10.2f')'s in here? will it cause any
310 # (alignment in text invoice?) problems to change them all to '%.2f' ?
311 # yes: fixed width/plain text printing will be borked
313 my( $self, %params ) = @_;
314 my $conf = $self->conf;
316 my $today = $params{today} ? $params{today} : time;
317 warn "$me print_generic called on $self with suffix $params{template}\n"
320 my $format = $params{format};
321 die "Unknown format: $format"
322 unless $format =~ /^(latex|html|template)$/;
324 my $cust_main = $self->cust_main || $self->prospect_main;
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?
569 'duedate_long' => $self->due_date2str('long'),
572 'custnum' => $cust_main->display_custnum,
573 'prospectnum' => $cust_main->prospectnum,
574 'agent_custid' => &$escape_function($cust_main->agent_custid),
575 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
576 payname company address1 address2 city state zip fax
580 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
581 'unitprices' => $conf->exists('invoice-unitprice'),
582 'smallernotes' => $conf->exists('invoice-smallernotes'),
583 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
584 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
586 #layout info -- would be fancy to calc some of this and bury the template
588 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
589 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
590 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
591 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
592 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
593 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
594 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
595 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
596 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
597 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
599 # better hang on to conf_dir for a while (for old templates)
600 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
602 #these are only used when doing paged plaintext
609 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
610 # prototype here to silence warnings
611 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
613 my $min_sdate = 999999999999;
615 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
616 next unless $cust_bill_pkg->pkgnum > 0;
617 $min_sdate = $cust_bill_pkg->sdate
618 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
619 $max_edate = $cust_bill_pkg->edate
620 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
623 $invoice_data{'bill_period'} = '';
624 $invoice_data{'bill_period'} =
625 $self->time2str_local('%e %h', $min_sdate, $format)
627 $self->time2str_local('%e %h', $max_edate, $format)
628 if ($max_edate != 0 && $min_sdate != 999999999999);
630 $invoice_data{finance_section} = '';
631 if ( $conf->config('finance_pkgclass') ) {
633 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
634 $invoice_data{finance_section} = $pkg_class->categoryname;
636 $invoice_data{finance_amount} = '0.00';
637 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
639 my $countrydefault = $conf->config('countrydefault') || 'US';
640 foreach ( qw( address1 address2 city state zip country fax) ){
641 my $method = 'ship_'.$_;
642 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
644 if ( length($cust_main->ship_company) ) {
645 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
647 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
649 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
650 $invoice_data{'ship_country'} = ''
651 if ( $invoice_data{'ship_country'} eq $countrydefault );
653 $invoice_data{'cid'} = $params{'cid'}
656 if ( $cust_main->country eq $countrydefault ) {
657 $invoice_data{'country'} = '';
659 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
663 $invoice_data{'address'} = \@address;
666 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
667 ? " (P.O. #". $cust_main->payinfo. ")"
671 push @address, $cust_main->company
672 if $cust_main->company;
673 push @address, $cust_main->address1;
674 push @address, $cust_main->address2
675 if $cust_main->address2;
677 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
678 push @address, $invoice_data{'country'}
679 if $invoice_data{'country'};
681 while (scalar(@address) < 5);
683 $invoice_data{'logo_file'} = $params{'logo_file'}
684 if $params{'logo_file'};
685 $invoice_data{'barcode_file'} = $params{'barcode_file'}
686 if $params{'barcode_file'};
687 $invoice_data{'barcode_img'} = $params{'barcode_img'}
688 if $params{'barcode_img'};
689 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
690 if $params{'barcode_cid'};
692 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
693 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
694 #my $balance_due = $self->owed + $pr_total - $cr_total;
695 my $balance_due = $self->owed;
696 if ( $self->enable_previous ) {
697 $balance_due += $pr_total;
699 # otherwise the previous balance is not shown, so including it in the
700 # balance due is just confusing
702 # the sum of amount owed on all invoices
703 # (this is used in the summary & on the payment coupon)
704 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
706 # flag telling this invoice to have a first-page summary
707 my $summarypage = '';
709 if ( $self->custnum && $self->invnum ) {
710 # XXX should be an FS::cust_bill method to set the defaults, instead
711 # of checking the type here
713 # info from customer's last invoice before this one, for some
715 $invoice_data{'last_bill'} = {};
717 my $last_bill = $self->previous_bill;
720 # "balance_date_range" unfortunately is unsuitable for this, since it
721 # cares about application dates. We want to know the sum of all
722 # _top-level transactions_ dated before the last invoice.
724 # still do this for the "Previous Balance" line of the summary block
726 map "$_ WHERE _date <= ? AND custnum = ?", (
727 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
728 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
729 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
730 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
733 # the customer's current balance immediately after generating the last
736 my $last_bill_balance = $last_bill->charged;
738 my $delta = FS::Record->scalar_sql(
740 $last_bill->_date - 1,
743 $last_bill_balance += $delta;
746 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
748 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
750 $self->time2str_local('%D', $last_bill->_date),
753 # ("true_previous_balance" is a terrible name, but at least it's no
754 # longer stored in the database)
755 $invoice_data{'true_previous_balance'} = $last_bill_balance;
757 # Now, get all applications of credits/payments dated on or after the
758 # previous bill, to invoices before the current bill. (The
759 # credit/payment date restriction prevents these from intersecting
760 # the "Previous Balance" set.)
761 # These are "adjustments". The past due balance will be shown as
762 # Previous Balance - Adjustments.
765 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
766 WHERE cust_bill._date < ?
768 AND cust_bill.custnum = ?"
769 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
770 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
773 my $delta = FS::Record->scalar_sql(
779 $adjustments += $delta;
781 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
783 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
784 $invoice_data{'balance_adjustments'}
787 # the sum of amount owed on all previous invoices
788 # ($pr_total is used elsewhere but not as $previous_balance)
789 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
791 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
792 my (@payments, @credits);
793 # for formats that itemize previous payments
794 foreach my $cust_pay ( qsearch('cust_pay', {
795 'custnum' => $self->custnum,
796 '_date' => { op => '>=',
797 value => $last_bill->_date }
800 next if $cust_pay->_date > $self->_date;
802 '_date' => $cust_pay->_date,
803 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
804 'payinfo' => $cust_pay->payby_payinfo_pretty,
805 'amount' => sprintf('%.2f', $cust_pay->paid),
807 # not concerned about applications
809 foreach my $cust_credit ( qsearch('cust_credit', {
810 'custnum' => $self->custnum,
811 '_date' => { op => '>=',
812 value => $last_bill->_date }
815 next if $cust_credit->_date > $self->_date;
817 '_date' => $cust_credit->_date,
818 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
819 'creditreason'=> $cust_credit->reason,
820 'amount' => sprintf('%.2f', $cust_credit->amount),
823 $invoice_data{'previous_payments'} = \@payments;
824 $invoice_data{'previous_credits'} = \@credits;
826 # there is no $last_bill
827 $invoice_data{'true_previous_balance'} =
828 $invoice_data{'balance_adjustments'} =
829 $invoice_data{'previous_balance'} = '0.00';
830 $invoice_data{'previous_payments'} = [];
831 $invoice_data{'previous_credits'} = [];
834 if ( $conf->config_bool('invoice_usesummary', $agentnum) ) {
835 $invoice_data{'summarypage'} = $summarypage = 1;
838 } # if this is an invoice
840 warn "$me substituting variables in notes, footer, smallfooter\n"
843 my $tc = $self->template_conf;
844 my @include = ( [ $tc, 'notes' ],
845 [ 'invoice_', 'footer' ],
846 [ 'invoice_', 'smallfooter', ],
847 [ 'invoice_', 'watermark' ],
849 push @include, [ $tc, 'coupon', ]
850 unless $params{'no_coupon'};
852 foreach my $i (@include) {
854 # load the configuration for this sub-template
856 my($base, $include) = @$i;
858 my $inc_file = $conf->key_orbase("$base$format$include", $template);
860 my @inc_src = $conf->config($inc_file, $agentnum);
862 my $converter = $convert_maps{$format}{$include};
864 # then attempt to convert LaTeX to the requested format
865 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
866 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
868 # this isn't included in the convert_maps
869 my ($open, $close) = @{ $delimiters{$format} };
874 } # else @inc_src is empty and that's fine
876 # make a Text::Template out of it
878 my $inc_tt = new Text::Template (
880 SOURCE => [ map "$_\n", @inc_src ],
881 DELIMITERS => $delimiters{$format},
882 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
884 unless ( $inc_tt->compile() ) {
885 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
886 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
892 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
894 $invoice_data{$include} =~ s/\n+$//
895 if ($format eq 'latex');
898 # let invoices use either of these as needed
899 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
900 ? $cust_main->payinfo : '';
901 $invoice_data{'po_line'} =
902 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
903 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
906 my %money_chars = ( 'latex' => '',
907 'html' => $conf->config('money_char') || '$',
910 my $money_char = $money_chars{$format};
913 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
914 'html' => $conf->config('money_char') || '$',
917 my $other_money_char = $other_money_chars{$format};
918 $invoice_data{'dollar'} = $other_money_char;
920 my %minus_signs = ( 'latex' => '$-$',
922 'template' => '- ' );
923 my $minus = $minus_signs{$format};
925 my @detail_items = ();
926 my @total_items = ();
930 $invoice_data{'detail_items'} = \@detail_items;
931 $invoice_data{'total_items'} = \@total_items;
932 $invoice_data{'buf'} = \@buf;
933 $invoice_data{'sections'} = \@sections;
935 warn "$me generating sections\n"
938 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
939 my $multisection = $self->has_sections;
940 $invoice_data{'multisection'} = $multisection;
941 my $section_with_taxes = 1
942 if $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
944 my $extra_sections = [];
945 my $extra_lines = ();
947 # default section ('Charges')
948 my $default_section = { 'description' => '',
953 # Previous Charges section
954 # subtotal is the first return value from $self->previous
955 my $previous_section;
956 # if the invoice has major sections, or if we're summarizing previous
957 # charges with a single line, or if we've been specifically told to put them
958 # in a section, create a section for previous charges:
959 if ( $multisection or
960 $conf->exists('previous_balance-summary_only') or
961 $conf->exists('previous_balance-section') ) {
963 $previous_section = { 'description' => $self->mt('Previous Charges'),
964 'subtotal' => $other_money_char.
965 sprintf('%.2f', $pr_total),
966 'summarized' => '', #why? $summarypage ? 'Y' : '',
968 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
969 join(' / ', map { $cust_main->balance_date_range(@$_) }
970 $self->_prior_month30s
972 if $conf->exists('invoice_include_aging');
975 # otherwise put them in the main section
976 $previous_section = $default_section;
979 my $adjust_section = {
980 'description' => $self->mt('Credits, Payments, and Adjustments'),
981 'adjust_section' => 1,
982 'subtotal' => 0, # adjusted below
984 my $adjust_weight = _pkg_category($adjust_section->{description})
985 ? _pkg_category($adjust_section->{description})->weight
987 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
988 # Note: 'sort_weight' here is actually a flag telling whether there is an
989 # explicit package category for the adjust section. If so, certain behavior
991 $adjust_section->{'sort_weight'} = $adjust_weight;
994 if ( $multisection ) {
995 ($extra_sections, $extra_lines) =
996 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
997 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
998 && $self->can('_items_extra_usage_sections');
1000 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1002 push @detail_items, @$extra_lines if $extra_lines;
1004 # the code is written so that both methods can be used together, but
1005 # we haven't yet changed the template to take advantage of that, so for
1006 # now, treat them as mutually exclusive.
1007 my %section_method = ( by_category => 1 );
1008 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1009 %section_method = ( by_location => 1 );
1011 my ($early, $late) =
1012 $self->_items_sections( 'summary' => $summarypage,
1013 'escape' => $escape_function_nonbsp,
1014 'extra_sections' => $extra_sections,
1015 'format' => $format,
1018 push @sections, @$early;
1019 $late_sections = $late;
1021 if ( $conf->exists('svc_phone_sections')
1022 && $self->can('_items_svc_phone_sections')
1025 my ($phone_sections, $phone_lines) =
1026 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1027 push @{$late_sections}, @$phone_sections;
1028 push @detail_items, @$phone_lines;
1030 if ( $conf->exists('voip-cust_accountcode_cdr')
1031 && $cust_main->accountcode_cdr
1032 && $self->can('_items_accountcode_cdr')
1035 my ($accountcode_section, $accountcode_lines) =
1036 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1037 if ( scalar(@$accountcode_lines) ) {
1038 push @{$late_sections}, $accountcode_section;
1039 push @detail_items, @$accountcode_lines;
1042 } else {# not multisection
1043 # make a default section
1044 push @sections, $default_section;
1045 # and calculate the finance charge total, since it won't get done otherwise.
1046 # and the default section total
1047 # XXX possibly finance_pkgclass should not be used in this manner?
1048 my @finance_charges;
1050 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1051 if ( $invoice_data{finance_section} and
1052 grep { $_->section eq $invoice_data{finance_section} }
1053 $cust_bill_pkg->cust_bill_pkg_display ) {
1054 # I think these are always setup fees, but just to be sure...
1055 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1057 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1060 $invoice_data{finance_amount} =
1061 sprintf('%.2f', sum( @finance_charges ) || 0);
1062 $default_section->{subtotal} = $other_money_char.
1063 sprintf('%.2f', sum( @charges ) || 0);
1066 # start setting up summary subtotals
1067 my @summary_subtotals;
1068 my $method = $conf->config('summary_subtotals_method');
1069 if ( ( ref($self) ne 'FS::quotation' ) and $method and $method ne $conf->config($tc.'sections_method') ) {
1070 # then re-section them by the correct method
1071 my %section_method = ( by_category => 1 );
1072 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1073 %section_method = ( by_location => 1 );
1075 my ($early, $late) =
1076 $self->_items_sections( 'summary' => $summarypage,
1077 'escape' => $escape_function_nonbsp,
1078 'extra_sections' => $extra_sections,
1079 'format' => $format,
1082 foreach ( @$early ) {
1083 next if $_->{subtotal} == 0;
1084 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1085 push @summary_subtotals, $_;
1088 # subtotal sectioning is the same as for the actual invoice sections
1089 @summary_subtotals = @sections;
1092 # Hereafter, push sections to both @sections and @summary_subtotals
1093 # if they belong in both places (e.g. tax section). Late sections are
1094 # never in @summary_subtotals.
1096 # previous invoice balances in the Previous Charges section if there
1097 # is one, otherwise in the main detail section
1098 # (except if summary_only is enabled, don't show them at all)
1099 if ( $self->can('_items_previous') &&
1100 $self->enable_previous &&
1101 ! $conf->exists('previous_balance-summary_only') ) {
1103 warn "$me adding previous balances\n"
1106 foreach my $line_item ( $self->_items_previous ) {
1109 ref => $line_item->{'pkgnum'},
1110 pkgpart => $line_item->{'pkgpart'},
1111 #quantity => 1, # not really correct
1112 section => $previous_section, # which might be $default_section
1113 description => &$escape_function($line_item->{'description'}),
1114 ext_description => [ map { &$escape_function($_) }
1115 @{ $line_item->{'ext_description'} || [] }
1117 amount => $money_char . $line_item->{'amount'},
1118 product_code => $line_item->{'pkgpart'} || 'N/A',
1121 push @detail_items, $detail;
1122 push @buf, [ $detail->{'description'},
1123 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1129 if ( @pr_cust_bill && $self->enable_previous ) {
1130 push @buf, ['','-----------'];
1131 push @buf, [ $self->mt('Total Previous Balance'),
1132 $money_char. sprintf("%10.2f", $pr_total) ];
1136 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1137 warn "$me adding DID summary\n"
1140 my ($didsummary,$minutes) = $self->_did_summary;
1141 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1143 { 'description' => $didsummary_desc,
1144 'ext_description' => [ $didsummary, $minutes ],
1148 foreach my $section (@sections, @$late_sections) {
1150 # begin some normalization
1151 $section->{'subtotal'} = $section->{'amount'}
1153 && !exists($section->{subtotal})
1154 && exists($section->{amount});
1156 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1157 if ( $invoice_data{finance_section} &&
1158 $section->{'description'} eq $invoice_data{finance_section} );
1160 if ( $multisection ) {
1162 if ( ref($section->{'subtotal'}) ) {
1164 $section->{'subtotal'} =
1165 sprintf("$other_money_char%.2f to $other_money_char%.2f",
1166 $section->{'subtotal'}[0],
1167 $section->{'subtotal'}[1]
1172 $section->{'subtotal'} = $other_money_char.
1173 sprintf('%.2f', $section->{'subtotal'})
1177 # continue some normalization
1178 $section->{'amount'} = $section->{'subtotal'}
1182 if ( $section->{'description'} ) {
1183 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1188 warn "$me setting options\n"
1192 $options{'section'} = $section if $multisection;
1193 $options{'section_with_taxes'} = 1
1194 if $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
1195 $options{'format'} = $format;
1196 $options{'escape_function'} = $escape_function;
1197 $options{'no_usage'} = 1 unless $unsquelched;
1198 $options{'unsquelched'} = $unsquelched;
1199 $options{'summary_page'} = $summarypage;
1200 $options{'skip_usage'} =
1201 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1202 $options{'preref_callback'} = $params{'preref_callback'};
1203 $options{'disable_line_item_date_ranges'} =
1204 $conf->exists('disable_line_item_date_ranges');
1206 warn "$me searching for line items\n"
1209 my %section_tax_lines;
1212 foreach my $line_item ( $self->_items_pkg(%options),
1213 $self->_items_fee(%options) ) {
1215 warn "$me adding line item ".
1216 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1219 push @buf, ( [ $line_item->{'description'},
1220 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1222 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1225 $line_item->{'ref'} = $line_item->{'pkgnum'};
1226 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1227 $line_item->{'section'} = $section;
1228 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1229 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1231 if ( length($line_item->{'unit_amount'}) ) {
1232 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1234 $line_item->{'ext_description'} ||= [];
1236 if ( $section_with_taxes && ref $line_item->{pkg_tax} ) {
1237 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1239 # It is rarely possible for the same tax record to be presented here
1240 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1241 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1242 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1244 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1248 push @detail_items, $line_item;
1251 # If conf flag invoice_sections_with_taxes:
1252 # - Add @detail_items for taxes into each section
1253 # - Update section subtotal to include taxes
1254 if ( $section_with_taxes && %section_tax_lines ) {
1255 for my $taxname ( keys %section_tax_lines ) {
1257 push @detail_items, {
1258 section => $section,
1259 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1260 description => &$escape_function($taxname),
1263 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1264 # append to the second value.
1265 if ($section->{subtotal} =~ /to/) {
1266 my @subtotal = split /\s/, $section->{subtotal};
1267 $subtotal[2] =~ s/[^\d\.]//g;
1268 $subtotal[2] = sprintf(
1270 ( $subtotal[2] + $section_tax_lines{$taxname} )
1272 $section->{subtotal} = join ' ', @subtotal;
1274 $section->{subtotal} =~ s/[^\d\.]//g;
1275 $section->{subtotal} = sprintf(
1276 $money_char . "%.2f",
1277 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1284 if ( $section->{'description'} ) {
1285 push @buf, ( ['','-----------'],
1286 [ $section->{'description'}. ' sub-total',
1287 $section->{'subtotal'} # already formatted this
1296 $invoice_data{current_less_finance} =
1297 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1299 # if there's anything in the Previous Charges section, prepend it to the list
1300 if ( $pr_total and $previous_section ne $default_section ) {
1301 unshift @sections, $previous_section;
1302 # but not @summary_subtotals
1305 warn "$me adding taxes\n"
1308 # create a tax section if we don't yet have one
1309 my $tax_description = 'Taxes, Surcharges, and Fees';
1311 List::Util::first { $_->{description} eq $tax_description } @sections;
1312 if (!$tax_section) {
1313 $tax_section = { 'description' => $tax_description };
1314 push @sections, $tax_section if $multisection;
1316 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1317 # if this is an existing tax section, we're merging the tax items into it.
1318 # grab the taxtotal that's already there, strip the money symbol if any
1319 my $taxtotal = $tax_section->{'subtotal'} || 0;
1320 $taxtotal =~ s/^\Q$other_money_char\E//;
1323 #my $tax_weight = _pkg_category($tax_section->{description})
1324 # ? _pkg_category($tax_section->{description})->weight
1326 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1327 #$tax_section->{'sort_weight'} = $tax_weight;
1329 my @items_tax = $self->_items_tax;
1330 foreach my $tax ( @items_tax ) {
1332 $taxtotal += $tax->{'amount'};
1334 my $description = &$escape_function( $tax->{'description'} );
1335 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1337 if ( $multisection ) {
1339 push @detail_items, {
1340 ext_description => [],
1343 description => $description,
1344 amount => $money_char. $amount,
1346 section => $tax_section,
1351 push @total_items, {
1352 'total_item' => $description,
1353 'total_amount' => $other_money_char. $amount,
1358 push @buf,[ $description,
1359 $money_char. $amount,
1366 $total->{'total_item'} = $self->mt('Sub-total');
1367 $total->{'total_amount'} =
1368 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1370 if ( $multisection ) {
1371 if ( $taxtotal > 0 ) {
1372 # there are taxes, so prepare the section to be displayed.
1373 # $taxtotal already includes any line items that were already in the
1374 # section (fees, taxes that are charged as packages for some reason).
1375 # also set 'summarized' to false so that this isn't a summary-only
1377 $tax_section->{'subtotal'} = $other_money_char.
1378 sprintf('%.2f', $taxtotal);
1379 $tax_section->{'pretotal'} = 'New charges sub-total '.
1380 $total->{'total_amount'};
1381 $tax_section->{'description'} = $self->mt($tax_description);
1382 $tax_section->{'summarized'} = '';
1384 if ( $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum) ) {
1386 # remove tax section if taxes are itemized within other sections
1387 @sections = grep{ $_ ne $tax_section } @sections;
1389 } elsif ( !grep $tax_section, @sections ) {
1391 # append it if it's not already there
1392 push @sections, $tax_section;
1393 push @summary_subtotals, $tax_section;
1400 unshift @total_items, $total;
1403 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1409 my %embolden_functions = (
1410 'latex' => sub { return '\textbf{'. shift(). '}' },
1411 'html' => sub { return '<b>'. shift(). '</b>' },
1412 'template' => sub { shift },
1414 my $embolden_function = $embolden_functions{$format};
1416 if ( $multisection ) {
1418 if ( $adjust_section->{'sort_weight'} ) {
1419 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1420 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1422 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1423 $other_money_char. sprintf('%.2f', $self->charged );
1428 if ( $self->can('_items_total') ) { # should always be true now
1430 # even for multisection, need plain text version
1432 my @new_total_items = $self->_items_total;
1434 push @buf,['','-----------'];
1436 foreach ( @new_total_items ) {
1437 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1438 $_->{'total_item'} = &$embolden_function( $item );
1440 if ( ref($amount) ) {
1441 $_->{'total_amount'} = &$embolden_function(
1442 $other_money_char.$amount->[0]. ' to '.
1443 $other_money_char.$amount->[1]
1446 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1449 # but if it's multisection, don't append to @total_items. the adjust
1450 # section has all this stuff
1451 push @total_items, $_ if !$multisection;
1452 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1455 push @buf, [ '', '' ];
1457 # if we're showing previous invoices, also show previous
1458 # credits and payments
1459 if ( $self->enable_previous
1460 and $self->can('_items_credits')
1461 and $self->can('_items_payments') )
1465 my $credittotal = 0;
1466 foreach my $credit (
1467 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1471 $total->{'total_item'} = &$escape_function($credit->{'description'});
1472 $credittotal += $credit->{'amount'};
1473 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1474 if ( $multisection ) {
1475 push @detail_items, {
1476 ext_description => [],
1479 description => &$escape_function($credit->{'description'}),
1480 amount => $money_char . $credit->{'amount'},
1482 section => $adjust_section,
1485 push @total_items, $total;
1489 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1492 foreach my $credit (
1493 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1495 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1499 my $paymenttotal = 0;
1500 foreach my $payment (
1501 $self->_items_payments( 'template' => $template )
1504 $total->{'total_item'} = &$escape_function($payment->{'description'});
1505 $paymenttotal += $payment->{'amount'};
1506 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1507 if ( $multisection ) {
1508 push @detail_items, {
1509 ext_description => [],
1512 description => &$escape_function($payment->{'description'}),
1513 amount => $money_char . $payment->{'amount'},
1515 section => $adjust_section,
1518 push @total_items, $total;
1520 push @buf, [ $payment->{'description'},
1521 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1524 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1526 if ( $multisection ) {
1527 $adjust_section->{'subtotal'} = $other_money_char.
1528 sprintf('%.2f', $credittotal + $paymenttotal);
1530 #why this? because {sort_weight} forces the adjust_section to appear
1531 #in @extra_sections instead of @sections. obviously.
1532 push @sections, $adjust_section
1533 unless $adjust_section->{sort_weight};
1534 # do not summarize; adjustments there are shown according to
1538 # create Balance Due message
1541 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1542 $total->{'total_amount'} =
1543 &$embolden_function(
1544 $other_money_char. sprintf('%.2f', #why? $summarypage
1545 # ? $self->charged +
1546 # $self->billing_balance
1548 $self->owed + $pr_total
1551 if ( $multisection && !$adjust_section->{sort_weight} ) {
1552 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1553 $total->{'total_amount'};
1555 push @total_items, $total;
1557 push @buf,['','-----------'];
1558 push @buf,[$self->balance_due_msg, $money_char.
1559 sprintf("%10.2f", $balance_due ) ];
1562 if ( $conf->exists('previous_balance-show_credit')
1563 and $cust_main->balance < 0 ) {
1564 my $credit_total = {
1565 'total_item' => &$embolden_function($self->credit_balance_msg),
1566 'total_amount' => &$embolden_function(
1567 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1570 if ( $multisection ) {
1571 $adjust_section->{'posttotal'} .= $newline_token .
1572 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1575 push @total_items, $credit_total;
1577 push @buf,['','-----------'];
1578 push @buf,[$self->credit_balance_msg, $money_char.
1579 sprintf("%10.2f", -$cust_main->balance ) ];
1583 } #end of default total adding ! can('_items_total')
1585 if ( $multisection ) {
1586 if ( $conf->exists('svc_phone_sections')
1587 && $self->can('_items_svc_phone_sections')
1591 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1592 $total->{'total_amount'} =
1593 &$embolden_function(
1594 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1596 my $last_section = pop @sections;
1597 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1598 $total->{'total_amount'};
1599 push @sections, $last_section;
1601 push @sections, @$late_sections
1605 # make a discounts-available section, even without multisection
1606 if ( $conf->exists('discount-show_available')
1607 and my @discounts_avail = $self->_items_discounts_avail ) {
1608 my $discount_section = {
1609 'description' => $self->mt('Discounts Available'),
1614 push @sections, $discount_section; # do not summarize
1615 push @detail_items, map { +{
1616 'ref' => '', #should this be something else?
1617 'section' => $discount_section,
1618 'description' => &$escape_function( $_->{description} ),
1619 'amount' => $money_char . &$escape_function( $_->{amount} ),
1620 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1621 } } @discounts_avail;
1624 # not adding any more sections after this
1625 $invoice_data{summary_subtotals} = \@summary_subtotals;
1628 if ( $conf->exists('usage_class_summary')
1629 and $self->can('_items_usage_class_summary') ) {
1630 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1631 if ( @usage_subtotals ) {
1632 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1633 unshift @detail_items, @usage_subtotals;
1637 # invoice history "section" (not really a section)
1638 # not to be included in any subtotals, completely independent of
1640 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1643 foreach my $cust_bill ( $cust_main->cust_bill ) {
1644 # XXX hardcoded format, and currently only 'charged'; add other fields
1645 # if they become necessary
1646 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1647 $history{$date} ||= 0;
1648 $history{$date} += $cust_bill->charged;
1649 # just so we have a numeric sort key
1650 $monthorder{$date} ||= $cust_bill->_date;
1652 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1654 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1655 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1658 # service locations: another option for template customization
1660 foreach my $item (@detail_items) {
1661 if ( $item->{locationnum} ) {
1662 $location_info{ $item->{locationnum} } ||= {
1663 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1667 $invoice_data{location_info} = \%location_info;
1669 # debugging hook: call this with 'diag' => 1 to just get a hash of
1670 # the invoice variables
1671 return \%invoice_data if ( $params{'diag'} );
1673 # All sections and items are built; now fill in templates.
1674 my @includelist = ();
1675 push @includelist, 'summary' if $summarypage;
1676 foreach my $include ( @includelist ) {
1678 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1681 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1683 @inc_src = $conf->config($inc_file, $agentnum);
1687 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1689 my $convert_map = $convert_maps{$format}{$include};
1691 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1692 s/--\@\]/$delimiters{$format}[1]/g;
1695 &$convert_map( $conf->config($inc_file, $agentnum) );
1699 my $inc_tt = new Text::Template (
1701 SOURCE => [ map "$_\n", @inc_src ],
1702 DELIMITERS => $delimiters{$format},
1703 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1705 unless ( $inc_tt->compile() ) {
1706 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1707 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1711 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1713 $invoice_data{$include} =~ s/\n+$//
1714 if ($format eq 'latex');
1719 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1720 /invoice_lines\((\d*)\)/;
1721 $invoice_lines += $1 || scalar(@buf);
1724 die "no invoice_lines() functions in template?"
1725 if ( $format eq 'template' && !$wasfunc );
1727 if ( $invoice_lines ) {
1728 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1729 $invoice_data{'total_pages'}++
1730 if scalar(@buf) % $invoice_lines;
1733 #setup subroutine for the template
1734 $invoice_data{invoice_lines} = sub {
1735 my $lines = shift || scalar(@buf);
1744 if ($format eq 'template') {
1749 push @collect, split("\n",
1750 $text_template->fill_in( HASH => \%invoice_data )
1752 $invoice_data{'page'}++;
1754 map "$_\n", @collect;
1756 } else { # this is where we actually create the invoice
1758 if ( $params{no_addresses} ) {
1759 delete $invoice_data{$_} foreach qw(
1760 payname company address1 address2 city state zip country
1762 $invoice_data{returnaddress} = '~';
1765 warn "filling in template for invoice ". $self->invnum. "\n"
1767 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1770 $text_template->fill_in(HASH => \%invoice_data);
1774 sub notice_name { '('.shift->table.')'; }
1776 sub template_conf { 'invoice_'; }
1778 # helper routine for generating date ranges
1779 sub _prior_month30s {
1782 [ 1, 2592000 ], # 0-30 days ago
1783 [ 2592000, 5184000 ], # 30-60 days ago
1784 [ 5184000, 7776000 ], # 60-90 days ago
1785 [ 7776000, 0 ], # 90+ days ago
1788 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1789 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1794 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1796 Returns an postscript invoice, as a scalar.
1798 Options can be passed as a hashref (recommended) or as a list of time, template
1799 and then any key/value pairs for any other options.
1801 I<time> an optional value used to control the printing of overdue messages. The
1802 default is now. It isn't the date of the invoice; that's the `_date' field.
1803 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1804 L<Time::Local> and L<Date::Parse> for conversion functions.
1806 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1813 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1814 my $ps = generate_ps($file);
1816 unlink($barcodefile) if $barcodefile;
1821 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1823 Returns an PDF invoice, as a scalar.
1825 Options can be passed as a hashref (recommended) or as a list of time, template
1826 and then any key/value pairs for any other options.
1828 I<time> an optional value used to control the printing of overdue messages. The
1829 default is now. It isn't the date of the invoice; that's the `_date' field.
1830 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1831 L<Time::Local> and L<Date::Parse> for conversion functions.
1833 I<template>, if specified, is the name of a suffix for alternate invoices.
1835 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1842 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1843 my $pdf = generate_pdf($file);
1845 unlink($barcodefile) if $barcodefile;
1850 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1852 Returns an HTML invoice, as a scalar.
1854 I<time> an optional value used to control the printing of overdue messages. The
1855 default is now. It isn't the date of the invoice; that's the `_date' field.
1856 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1857 L<Time::Local> and L<Date::Parse> for conversion functions.
1859 I<template>, if specified, is the name of a suffix for alternate invoices.
1861 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1863 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1864 when emailing the invoice as part of a multipart/related MIME email.
1872 %params = %{ shift() };
1876 $params{'format'} = 'html';
1878 $self->print_generic( %params );
1881 # quick subroutine for print_latex
1883 # There are ten characters that LaTeX treats as special characters, which
1884 # means that they do not simply typeset themselves:
1885 # # $ % & ~ _ ^ \ { }
1887 # TeX ignores blanks following an escaped character; if you want a blank (as
1888 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1892 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1893 $value =~ s/([<>])/\$$1\$/g;
1899 encode_entities($value);
1903 sub _html_escape_nbsp {
1904 my $value = _html_escape(shift);
1905 $value =~ s/ +/ /g;
1909 #utility methods for print_*
1911 sub _translate_old_latex_format {
1912 warn "_translate_old_latex_format called\n"
1919 if ( $line =~ /^%%Detail\s*$/ ) {
1921 push @template, q![@--!,
1922 q! foreach my $_tr_line (@detail_items) {!,
1923 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1924 q! $_tr_line->{'description'} .= !,
1925 q! "\\tabularnewline\n~~".!,
1926 q! join( "\\tabularnewline\n~~",!,
1927 q! @{$_tr_line->{'ext_description'}}!,
1931 while ( ( my $line_item_line = shift )
1932 !~ /^%%EndDetail\s*$/ ) {
1933 $line_item_line =~ s/'/\\'/g; # nice LTS
1934 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1935 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1936 push @template, " \$OUT .= '$line_item_line';";
1939 push @template, '}',
1942 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1944 push @template, '[@--',
1945 ' foreach my $_tr_line (@total_items) {';
1947 while ( ( my $total_item_line = shift )
1948 !~ /^%%EndTotalDetails\s*$/ ) {
1949 $total_item_line =~ s/'/\\'/g; # nice LTS
1950 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1951 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1952 push @template, " \$OUT .= '$total_item_line';";
1955 push @template, '}',
1959 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1960 push @template, $line;
1966 warn "$_\n" foreach @template;
1978 my $conf = $self->conf;
1980 #check for an invoice-specific override
1981 return $self->invoice_terms if $self->invoice_terms;
1983 #check for a customer- specific override
1984 my $cust_main = $self->cust_main;
1985 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1989 $agentnum = $cust_main->agentnum;
1990 } elsif ( my $prospect_main = $self->prospect_main ) {
1991 $agentnum = $prospect_main->agentnum;
1994 #use configured default
1995 $conf->config('invoice_default_terms', $agentnum) || '';
2005 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2006 $duedate = $self->_date() + ( $1 * 86400 );
2007 } elsif ( $self->terms =~ /^End of Month$/ ) {
2008 my ($mon,$year) = (localtime($self->_date) )[4,5];
2010 until ( $mon < 12 ) { $mon -= 12; $year++; }
2011 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2012 $duedate = $nextmonth_first - 86400;
2023 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2026 =item balance_due_msg
2030 sub balance_due_msg {
2032 my $msg = $self->mt('Balance Due');
2033 return $msg unless $self->terms; # huh?
2034 if ( !$self->conf->exists('invoice_show_prior_due_date')
2035 || $self->has_sections ) {
2036 # if enabled, the due date is shown with Total New Charges (see
2037 # _items_total) and not here
2038 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2039 if ( $self->due_date ) {
2041 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2042 || 'Please pay by [_1]';
2043 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')).
2045 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2046 } elsif ( $self->terms ) {
2047 $msg .= ' - '. $self->mt($self->terms);
2053 =item balance_due_date
2057 sub balance_due_date {
2059 my $conf = $self->conf;
2061 my $terms = $self->terms;
2062 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2063 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2068 sub credit_balance_msg {
2070 $self->mt('Credit Balance Remaining')
2075 Returns a string with the date, for example: "3/20/2008", localized for the
2076 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2082 $self->time2str_local('short', $self->_date);
2085 =item _date_pretty_unlocalized
2087 Returns a string with the date, for example: "3/20/2008", in the format
2088 configured for the back-office. Use _date_pretty for end-customer display use.
2092 sub _date_pretty_unlocalized {
2094 time2str($date_format, $self->_date);
2099 Emails this template.
2101 Options are passed as a hashref. Available options:
2107 If specified, overrides the default From: address.
2111 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2115 (Deprecated) If specified, is the name of a suffix for alternate template files.
2119 Options accepted by generate_email can also be used.
2125 my $opt = shift || {};
2126 if ($opt and !ref($opt)) {
2127 die ref($self). '->email called with positional parameters';
2130 return if $self->hide;
2132 my $error = send_email(
2133 $self->generate_email(
2134 'subject' => $self->email_subject($opt->{template}),
2135 %$opt, # template, etc.
2139 die "can't email: $error\n" if $error;
2142 =item generate_email OPTION => VALUE ...
2150 sender address, required
2154 alternate template name, optional
2158 email subject, optional
2162 notice name instead of "Invoice", optional
2166 Returns an argument list to be passed to L<FS::Misc::send_email>.
2173 sub generate_email {
2177 my $conf = $self->conf;
2179 my $me = '[FS::Template_Mixin::generate_email]';
2182 'from' => $args{'from'},
2183 'subject' => ($args{'subject'} || $self->email_subject),
2184 'custnum' => $self->custnum,
2185 'msgtype' => 'invoice',
2188 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2190 my $cust_main = $self->cust_main;
2192 if (ref($args{'to'}) eq 'ARRAY') {
2193 $return{'to'} = $args{'to'};
2194 } elsif ( $cust_main ) {
2195 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2198 my $tc = $self->template_conf;
2200 my @text; # array of lines
2201 my $html; # a big string
2202 my @related_parts; # will contain the text/HTML alternative, and images
2203 my $related; # will contain the multipart/related object
2205 if ( $conf->exists($tc. 'email_pdf') ) {
2206 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2208 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2211 my $msg_template = FS::msg_template->by_key($msgnum)
2212 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2213 my %prepared = $msg_template->prepare(
2214 cust_main => $self->cust_main,
2218 @text = split(/(?=\n)/, $prepared{'text_body'});
2219 $html = $prepared{'html_body'};
2221 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2223 warn "$me using '${tc}email_pdf_note' in multipart message"
2225 @text = $conf->config($tc.'email_pdf_note');
2226 $html = join('<BR>', @text);
2228 } # else use the plain text invoice
2233 if ( $conf->config($tc.'template') ) {
2235 warn "$me generating plain text invoice"
2238 # 'print_text' argument is no longer used
2239 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2243 warn "$me no plain text version exists; sending empty message body"
2250 my $text_part = build MIME::Entity (
2251 'Type' => 'text/plain',
2252 'Encoding' => 'quoted-printable',
2253 'Charset' => 'UTF-8',
2254 #'Encoding' => '7bit',
2256 'Disposition' => 'inline',
2261 if ( $conf->exists($tc.'html') ) {
2262 warn "$me generating HTML invoice"
2265 $args{'from'} =~ /\@([\w\.\-]+)/;
2266 my $from = $1 || 'example.com';
2267 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2270 my $agentnum = $cust_main ? $cust_main->agentnum
2271 : $self->prospect_main->agentnum;
2272 if ( defined($args{'template'}) && length($args{'template'})
2273 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2276 $logo = 'logo_'. $args{'template'}. '.png';
2280 my $image_data = $conf->config_binary( $logo, $agentnum);
2282 push @related_parts, build MIME::Entity
2283 'Type' => 'image/png',
2284 'Encoding' => 'base64',
2285 'Data' => $image_data,
2286 'Filename' => 'logo.png',
2287 'Content-ID' => "<$content_id>",
2290 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2291 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2292 push @related_parts, build MIME::Entity
2293 'Type' => 'image/png',
2294 'Encoding' => 'base64',
2295 'Data' => $self->invoice_barcode(0),
2296 'Filename' => 'barcode.png',
2297 'Content-ID' => "<$barcode_content_id>",
2299 $args{'barcode_cid'} = $barcode_content_id;
2302 $html = $self->print_html({ 'cid'=>$content_id, %args });
2309 warn "$me creating HTML/text multipart message"
2312 $return{'nobody'} = 1;
2314 my $alternative = build MIME::Entity
2315 'Type' => 'multipart/alternative',
2316 #'Encoding' => '7bit',
2317 'Disposition' => 'inline'
2321 $alternative->add_part($text_part);
2324 $alternative->attach(
2325 'Type' => 'text/html',
2326 'Encoding' => 'quoted-printable',
2327 'Data' => [ '<html>',
2330 ' '. encode_entities($return{'subject'}),
2333 ' <body bgcolor="#e8e8e8">',
2334 Encode::encode_utf8($html),
2338 'Disposition' => 'inline',
2339 #'Filename' => 'invoice.pdf',
2342 unshift @related_parts, $alternative;
2344 $related = build MIME::Entity 'Type' => 'multipart/related',
2345 'Encoding' => '7bit';
2347 #false laziness w/Misc::send_email
2348 $related->head->replace('Content-type',
2349 $related->mime_type.
2350 '; boundary="'. $related->head->multipart_boundary. '"'.
2351 '; type=multipart/alternative'
2354 $related->add_part($_) foreach @related_parts;
2358 my @otherparts = ();
2359 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2361 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2363 my $data = join('', map "$_\n",
2364 $self->call_details(prepend_billed_number=>1)
2367 my $zip = new Archive::Zip;
2368 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2369 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2372 my $SH = IO::Scalar->new(\$zipdata);
2373 my $status = $zip->writeToFileHandle($SH);
2374 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2376 push @otherparts, build MIME::Entity
2377 'Type' => 'application/zip',
2378 'Encoding' => 'base64',
2380 'Disposition' => 'attachment',
2381 'Filename' => 'usage-'. $self->invnum. '.zip',
2384 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2386 push @otherparts, build MIME::Entity
2387 'Type' => 'text/csv',
2388 'Encoding' => '7bit',
2389 'Data' => [ map { "$_\n" }
2390 $self->call_details('prepend_billed_number' => 1)
2392 'Disposition' => 'attachment',
2393 'Filename' => 'usage-'. $self->invnum. '.csv',
2400 if ( $conf->exists($tc.'email_pdf') ) {
2405 # multipart/alternative
2411 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2412 push @otherparts, $pdf;
2416 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2418 $return{'mimeparts'} = [ $related, @otherparts ];
2419 $return{'type'} = 'multipart/related'; # of the first part
2421 $return{'mimeparts'} = [ $text_part, @otherparts ];
2422 $return{'type'} = 'text/plain';
2424 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2425 $return{'mimeparts'} = \@related_parts;
2426 $return{'content-type'} = 'multipart/related';
2427 $return{'type'} = 'multipart/alternative';
2428 } else { # no HTML either
2429 $return{'body'} = \@text;
2430 $return{'content-type'} = 'text/plain';
2439 Returns a list suitable for passing to MIME::Entity->build(), representing
2440 this invoice as PDF attachment.
2447 'Type' => 'application/pdf',
2448 'Encoding' => 'base64',
2449 'Data' => [ $self->print_pdf(@_) ],
2450 'Disposition' => 'attachment',
2451 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2455 =item postal_mail_fsinc
2457 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2463 use IO::Socket::SSL;
2465 use HTTP::Request::Common qw( POST );
2468 sub postal_mail_fsinc {
2469 my ( $self, %opt ) = @_;
2471 my $url = 'https://ws.freeside.biz/print';
2473 my $cust_main = $self->cust_main;
2474 my $agentnum = $cust_main->agentnum;
2475 my $bill_location = $cust_main->bill_location;
2477 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2478 if $bill_location->country ne 'US';
2480 my $conf = new FS::Conf;
2482 my @company_address = $conf->config('company_address', $agentnum);
2483 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2484 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2485 $company_address1 = $company_address[0];
2486 $company_address2 = $company_address[1];
2488 $company_state = $2;
2490 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2491 $company_address1 = $company_address[0];
2492 $company_address2 = '';
2494 $company_state = $2;
2497 die "Unparsable company_address; contact support\@freeside.biz\n";
2499 $company_city =~ s/,$//;
2501 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2502 my $pages = CAM::PDF->new($file)->numPages;
2504 my $ua = LWP::UserAgent->new(
2506 verify_hostname => 0,
2507 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2508 SSL_version => 'SSLv3',
2511 my $response = $ua->request( POST $url, [
2512 'support-key' => scalar($conf->config('support-key')),
2513 'file' => encode_base64($file),
2517 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2518 'company_address1' => $company_address1,
2519 'company_address2' => $company_address2,
2520 'company_city' => $company_city,
2521 'company_state' => $company_state,
2522 'company_zip' => $company_zip,
2523 'company_country' => 'US',
2524 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2525 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2528 'name' => ( $cust_main->payname
2529 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/
2530 ? $cust_main->payname
2531 : $cust_main->contact_firstlast
2533 'company' => $cust_main->company,
2534 'address1' => $bill_location->address1,
2535 'address2' => $bill_location->address2,
2536 'city' => $bill_location->city,
2537 'state' => $bill_location->state,
2538 'zip' => $bill_location->zip,
2539 'country' => $bill_location->country,
2542 die "Print connection error: ". $response->message.
2543 ' ('. $response->as_string. ")\n"
2544 unless $response->is_success;
2547 my $content = eval { decode_json($response->content) };
2548 die "Print JSON error : $@\n" if $@;
2550 die $content->{error}."\n"
2551 if $content->{error};
2553 #TODO: store this so we can query for a status later
2554 warn "Invoice printed, ID ". $content->{id}. "\n";
2559 =item _items_sections OPTIONS
2561 Generate section information for all items appearing on this invoice.
2562 This will only be called for multi-section invoices.
2564 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2565 related display records (L<FS::cust_bill_pkg_display>) and organize
2566 them into two groups ("early" and "late" according to whether they come
2567 before or after the total), then into sections. A subtotal is calculated
2570 Section descriptions are returned in sort weight order. Each consists
2571 of a hash containing:
2573 description: the package category name, escaped
2574 subtotal: the total charges in that section
2575 tax_section: a flag indicating that the section contains only tax charges
2576 summarized: same as tax_section, for some reason
2577 sort_weight: the package category's sort weight
2579 If 'condense' is set on the display record, it also contains everything
2580 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2581 coderefs to generate parts of the invoice. This is not advised.
2583 The method returns two arrayrefs, one of "early" sections and one of "late"
2586 OPTIONS may include:
2588 by_location: a flag to divide the invoice into sections by location.
2589 Each section hash will have a 'location' element containing a hashref of
2590 the location fields (see L<FS::cust_location>). The section description
2591 will be the location label, but the template can use any of the location
2592 fields to create a suitable label.
2594 by_category: a flag to divide the invoice into sections using display
2595 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2596 behavior. Each section hash will have a 'category' element containing
2597 the section name from the display record (which probably equals the
2598 category name of the package, but may not in some cases).
2600 summary: a flag indicating that this is a summary-format invoice.
2601 Turning this on has the following effects:
2602 - Ignores display items with the 'summary' flag.
2603 - Places all sections in the "early" group even if they have post_total.
2604 - Creates sections for all non-disabled package categories, even if they
2605 have no charges on this invoice, as well as a section with no name.
2607 escape: an escape function to use for section titles.
2609 extra_sections: an arrayref of additional sections to return after the
2610 sorted list. If there are any of these, section subtotals exclude
2613 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2614 passed through to C<_condense_section()>.
2618 use vars qw(%pkg_category_cache);
2619 sub _items_sections {
2623 my $escape = $opt{escape};
2624 my @extra_sections = @{ $opt{extra_sections} || [] };
2626 # $subtotal{$locationnum}{$categoryname} = amount.
2627 # if we're not using by_location, $locationnum is undef.
2628 # if we're not using by_category, you guessed it, $categoryname is undef.
2629 # if we're not using either one, we shouldn't be here in the first place...
2631 my %late_subtotal = ();
2634 # About tax items + multisection invoices:
2635 # If either invoice_*summary option is enabled, AND there is a
2636 # package category with the name of the tax, then there will be
2637 # a display record assigning the tax item to that category.
2639 # However, the taxes are always placed in the "Taxes, Surcharges,
2640 # and Fees" section regardless of that. The only effect of the
2641 # display record is to create a subtotal for the summary page.
2644 my $pkg_hash = $self->cust_pkg_hash;
2646 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2649 my $usage = $cust_bill_pkg->usage;
2652 if ( $opt{by_location} ) {
2653 if ( $cust_bill_pkg->pkgnum ) {
2654 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2659 $locationnum = undef;
2662 # as in _items_cust_pkg, if a line item has no display records,
2663 # cust_bill_pkg_display() returns a default record for it
2665 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2666 next if ( $display->summary && $opt{summary} );
2668 my $section = $display->section;
2669 my $type = $display->type;
2670 # Set $section = undef if we're sectioning by location and this
2671 # line item _has_ a location (i.e. isn't a fee).
2672 $section = undef if $locationnum;
2674 # set this flag if the section is not tax-only
2675 $not_tax{$locationnum}{$section} = 1
2676 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2678 # there's actually a very important piece of logic buried in here:
2679 # incrementing $late_subtotal{$section} CREATES
2680 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2681 # to define the list of late sections, and likewise keys(%subtotal).
2682 # When _items_cust_bill_pkg is called to generate line items for
2683 # real, it will be called with 'section' => $section for each
2685 if ( $display->post_total && !$opt{summary} ) {
2686 if (! $type || $type eq 'S') {
2687 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2688 if $cust_bill_pkg->setup != 0
2689 || $cust_bill_pkg->setup_show_zero;
2693 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2694 if $cust_bill_pkg->recur != 0
2695 || $cust_bill_pkg->recur_show_zero;
2698 if ($type && $type eq 'R') {
2699 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2700 if $cust_bill_pkg->recur != 0
2701 || $cust_bill_pkg->recur_show_zero;
2704 if ($type && $type eq 'U') {
2705 $late_subtotal{$locationnum}{$section} += $usage
2706 unless scalar(@extra_sections);
2709 } else { # it's a pre-total (normal) section
2711 # skip tax items unless they're explicitly included in a section
2712 next if $cust_bill_pkg->pkgnum == 0 and
2713 ! $cust_bill_pkg->feepart and
2716 if ( $type eq 'S' ) {
2717 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2718 if $cust_bill_pkg->setup != 0
2719 || $cust_bill_pkg->setup_show_zero;
2720 } elsif ( $type eq 'R' ) {
2721 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2722 if $cust_bill_pkg->recur != 0
2723 || $cust_bill_pkg->recur_show_zero;
2724 } elsif ( $type eq 'U' ) {
2725 $subtotal{$locationnum}{$section} += $usage
2726 unless scalar(@extra_sections);
2727 } elsif ( !$type ) {
2728 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2729 + $cust_bill_pkg->recur;
2738 %pkg_category_cache = ();
2740 # summary invoices need subtotals for all non-disabled package categories,
2741 # even if they're zero
2742 # but currently assume that there are no location sections, or at least
2743 # that the summary page doesn't care about them
2744 if ( $opt{summary} ) {
2745 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2746 $subtotal{''}{$category->categoryname} ||= 0;
2748 $subtotal{''}{''} ||= 0;
2752 foreach my $post_total (0,1) {
2754 my $s = $post_total ? \%late_subtotal : \%subtotal;
2755 foreach my $locationnum (keys %$s) {
2756 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2758 'subtotal' => $s->{$locationnum}{$sectionname},
2761 if ( $locationnum ) {
2762 $section->{'locationnum'} = $locationnum;
2763 my $location = FS::cust_location->by_key($locationnum);
2764 $section->{'description'} = &{ $escape }($location->location_label);
2765 # Better ideas? This will roughly group them by proximity,
2766 # which alpha sorting on any of the address fields won't.
2767 # Sorting by locationnum is meaningless.
2768 # We have to sort on _something_ or the order may change
2769 # randomly from one invoice to the next, which will confuse
2771 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2773 $section->{'location'} = {
2774 label_prefix => &{ $escape }($location->label_prefix),
2775 map { $_ => &{ $escape }($location->get($_)) }
2779 $section->{'category'} = $sectionname;
2780 $section->{'description'} = &{ $escape }($sectionname);
2781 if ( _pkg_category($sectionname) ) {
2782 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2783 if ( _pkg_category($sectionname)->condense ) {
2784 $section = { %$section, $self->_condense_section($opt{format}) };
2788 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2789 # then it's a tax-only section
2790 $section->{'summarized'} = 'Y';
2791 $section->{'tax_section'} = 'Y';
2793 push @these, $section;
2794 } # foreach $sectionname
2795 } #foreach $locationnum
2796 push @these, @extra_sections if $post_total == 0;
2797 # need an alpha sort for location sections, because postal codes can
2799 $sections[ $post_total ] = [ sort {
2800 $opt{'by_location'} ?
2801 ($a->{sort_weight} cmp $b->{sort_weight}) :
2802 ($a->{sort_weight} <=> $b->{sort_weight})
2804 } #foreach $post_total
2806 return @sections; # early, late
2809 #helper subs for above
2813 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2817 my $categoryname = shift;
2818 $pkg_category_cache{$categoryname} ||=
2819 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2822 my %condensed_format = (
2823 'label' => [ qw( Description Qty Amount ) ],
2825 sub { shift->{description} },
2826 sub { shift->{quantity} },
2827 sub { my($href, %opt) = @_;
2828 ($opt{dollar} || ''). $href->{amount};
2831 'align' => [ qw( l r r ) ],
2832 'span' => [ qw( 5 1 1 ) ], # unitprices?
2833 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2836 sub _condense_section {
2837 my ( $self, $format ) = ( shift, shift );
2839 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2840 qw( description_generator
2843 total_line_generator
2848 sub _condensed_generator_defaults {
2849 my ( $self, $format ) = ( shift, shift );
2850 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2859 sub _condensed_header_generator {
2860 my ( $self, $format ) = ( shift, shift );
2862 my ( $f, $prefix, $suffix, $separator, $column ) =
2863 _condensed_generator_defaults($format);
2865 if ($format eq 'latex') {
2866 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2867 $suffix = "\\\\\n\\hline";
2870 sub { my ($d,$a,$s,$w) = @_;
2871 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2873 } elsif ( $format eq 'html' ) {
2874 $prefix = '<th></th>';
2878 sub { my ($d,$a,$s,$w) = @_;
2879 return qq!<th align="$html_align{$a}">$d</th>!;
2887 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2889 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2892 $prefix. join($separator, @result). $suffix;
2897 sub _condensed_description_generator {
2898 my ( $self, $format ) = ( shift, shift );
2900 my ( $f, $prefix, $suffix, $separator, $column ) =
2901 _condensed_generator_defaults($format);
2903 my $money_char = '$';
2904 if ($format eq 'latex') {
2905 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2907 $separator = " & \n";
2909 sub { my ($d,$a,$s,$w) = @_;
2910 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2912 $money_char = '\\dollar';
2913 }elsif ( $format eq 'html' ) {
2914 $prefix = '"><td align="center"></td>';
2918 sub { my ($d,$a,$s,$w) = @_;
2919 return qq!<td align="$html_align{$a}">$d</td>!;
2921 #$money_char = $conf->config('money_char') || '$';
2922 $money_char = ''; # this is madness
2930 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2932 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2934 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2935 map { $f->{$_}->[$i] } qw(align span width)
2939 $prefix. join( $separator, @result ). $suffix;
2944 sub _condensed_total_generator {
2945 my ( $self, $format ) = ( shift, shift );
2947 my ( $f, $prefix, $suffix, $separator, $column ) =
2948 _condensed_generator_defaults($format);
2951 if ($format eq 'latex') {
2954 $separator = " & \n";
2956 sub { my ($d,$a,$s,$w) = @_;
2957 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2959 }elsif ( $format eq 'html' ) {
2963 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2965 sub { my ($d,$a,$s,$w) = @_;
2966 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2975 # my $r = &{$f->{fields}->[$i]}(@args);
2976 # $r .= ' Total' unless $i;
2978 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2980 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2981 map { $f->{$_}->[$i] } qw(align span width)
2985 $prefix. join( $separator, @result ). $suffix;
2990 =item total_line_generator FORMAT
2992 Returns a coderef used for generation of invoice total line items for this
2993 usage_class. FORMAT is either html or latex
2997 # should not be used: will have issues with hash element names (description vs
2998 # total_item and amount vs total_amount -- another array of functions?
3000 sub _condensed_total_line_generator {
3001 my ( $self, $format ) = ( shift, shift );
3003 my ( $f, $prefix, $suffix, $separator, $column ) =
3004 _condensed_generator_defaults($format);
3007 if ($format eq 'latex') {
3010 $separator = " & \n";
3012 sub { my ($d,$a,$s,$w) = @_;
3013 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3015 }elsif ( $format eq 'html' ) {
3019 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3021 sub { my ($d,$a,$s,$w) = @_;
3022 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3031 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3033 &{$column}( &{$f->{fields}->[$i]}(@args),
3034 map { $f->{$_}->[$i] } qw(align span width)
3038 $prefix. join( $separator, @result ). $suffix;
3043 =item _items_pkg [ OPTIONS ]
3045 Return line item hashes for each package item on this invoice. Nearly
3048 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3050 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3051 'format' and 'escape_function' at minimum.
3053 To produce items for a specific invoice section, OPTIONS should include
3054 'section', a hashref containing 'category' and/or 'locationnum' keys.
3056 'section' may also contain a key named 'condensed'. If this is present
3057 and has a true value, _items_pkg will try to merge identical items into items
3058 with 'quantity' equal to the number of items (not the sum of their separate
3059 quantities, for some reason).
3065 # The order of these is important. Bundled line items will be merged into
3066 # the most recent non-hidden item, so it needs to be the one with:
3068 # - the same start date
3069 # - no pkgpart_override
3071 # So: sort by pkgnum,
3073 # then sort the base line item before any overrides
3074 # then sort hidden before non-hidden add-ons
3075 # then sort by override pkgpart (for consistency)
3076 sort { $a->pkgnum <=> $b->pkgnum or
3077 $a->sdate <=> $b->sdate or
3078 ($a->pkgpart_override ? 0 : -1) or
3079 ($b->pkgpart_override ? 0 : 1) or
3080 $b->hidden cmp $a->hidden or
3081 $a->pkgpart_override <=> $b->pkgpart_override
3083 # and of course exclude taxes and fees
3084 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3090 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3091 my $escape_function = $options{escape_function};
3094 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3095 # cache this, so we don't look it up again in every section
3096 my $part_fee = $cust_bill_pkg->get('part_fee')
3097 || $cust_bill_pkg->part_fee;
3098 $cust_bill_pkg->set('part_fee', $part_fee);
3100 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3101 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3104 if ( exists($options{section}) and exists($options{section}{category}) )
3106 my $categoryname = $options{section}{category};
3107 # then filter for items that have that section
3108 if ( $part_fee->categoryname ne $categoryname ) {
3109 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3112 } # otherwise include them all in the main section
3113 # XXX what to do when sectioning by location?
3116 my %base_invnums; # invnum => invoice date
3117 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3118 if ($_->base_invnum) {
3119 # XXX what if base_bill has been voided?
3120 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3121 my $base_date = $self->time2str_local('short', $base_bill->_date)
3123 $base_invnums{$_->base_invnum} = $base_date || '';
3126 foreach (sort keys(%base_invnums)) {
3127 next if $_ == $self->invnum;
3128 # per convention, we must escape ext_description lines
3130 &{$escape_function}(
3131 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3134 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3135 # but not escape the base description line
3137 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3138 if $options{section_with_taxes};
3141 { feepart => $cust_bill_pkg->feepart,
3142 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3143 description => $desc,
3144 pkg_tax => \@pkg_tax,
3145 ext_description => \@ext_desc,
3156 warn "$me _items_pkg searching for all package line items\n"
3159 my @cust_bill_pkg = $self->_items_nontax;
3161 warn "$me _items_pkg filtering line items\n"
3163 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3165 if ($options{section} && $options{section}->{condensed}) {
3167 warn "$me _items_pkg condensing section\n"
3171 local $Storable::canonical = 1;
3172 foreach ( @items ) {
3174 delete $item->{ref};
3175 delete $item->{ext_description};
3176 my $key = freeze($item);
3177 $itemshash{$key} ||= 0;
3178 $itemshash{$key} ++; # += $item->{quantity};
3180 @items = sort { $a->{description} cmp $b->{description} }
3181 map { my $i = thaw($_);
3182 $i->{quantity} = $itemshash{$_};
3184 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3190 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3197 return 0 unless $a->itemdesc cmp $b->itemdesc;
3198 return -1 if $b->itemdesc eq 'Tax';
3199 return 1 if $a->itemdesc eq 'Tax';
3200 return -1 if $b->itemdesc eq 'Other surcharges';
3201 return 1 if $a->itemdesc eq 'Other surcharges';
3202 $a->itemdesc cmp $b->itemdesc;
3207 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3208 $self->cust_bill_pkg;
3209 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3211 if ( $self->conf->exists('always_show_tax') ) {
3212 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3213 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3215 { 'description' => $itemdesc,
3222 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3224 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3225 list of hashrefs describing the line items they generate on the invoice.
3227 OPTIONS may include:
3229 format: the invoice format.
3231 escape_function: the function used to escape strings.
3233 DEPRECATED? (expensive, mostly unused?)
3234 format_function: the function used to format CDRs.
3236 section: a hashref containing 'category' and/or 'locationnum'; if this
3237 is present, only returns line items that belong to that category and/or
3238 location (whichever is defined).
3240 multisection: a flag indicating that this is a multisection invoice,
3241 which does something complicated.
3243 preref_callback: coderef run for each line item, code should return HTML to be
3244 displayed before that line item (quotations only)
3246 section_with_taxes: Look up and include applied taxes for each record
3248 Returns a list of hashrefs, each of which may contain:
3250 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3251 ext_description, which is an arrayref of detail lines to show below
3256 sub _items_cust_bill_pkg {
3258 my $conf = $self->conf;
3259 my $cust_bill_pkgs = shift;
3262 my $format = $opt{format} || '';
3263 my $escape_function = $opt{escape_function} || sub { shift };
3264 my $format_function = $opt{format_function} || '';
3265 my $no_usage = $opt{no_usage} || '';
3266 my $unsquelched = $opt{unsquelched} || ''; #unused
3267 my ($section, $locationnum, $category);
3268 if ( $opt{section} ) {
3269 $category = $opt{section}->{category};
3270 $locationnum = $opt{section}->{locationnum};
3272 my $summary_page = $opt{summary_page} || ''; #unused
3273 my $multisection = defined($category) || defined($locationnum);
3274 # this variable is the value of the config setting, not whether it applies
3275 # to this particular line item.
3276 my $discount_show_always = $conf->exists('discount-show-always');
3278 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3280 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3282 my $agentnum = $self->agentnum;
3284 # for location labels: use default location on the invoice date
3285 my $default_locationnum;
3286 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3287 $default_locationnum = 0; # treat them all as non-default
3288 } elsif ( $self->custnum ) {
3290 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3291 $h_cust_main = qsearchs({
3292 'table' => 'h_cust_main',
3293 'hashref' => { custnum => $self->custnum },
3294 'extra_sql' => $h_search[1],
3295 'addl_from' => $h_search[3],
3297 $default_locationnum = $h_cust_main->ship_locationnum;
3298 } elsif ( $self->prospectnum ) {
3299 my $cust_location = qsearchs('cust_location',
3300 { prospectnum => $self->prospectnum,
3302 $default_locationnum = $cust_location->locationnum if $cust_location;
3305 my @b = (); # accumulator for the line item hashes that we'll return
3306 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3307 # the 'current' line item hashes for setup, recur, usage, discount
3308 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3310 # if the current line item is waiting to go out, and the one we're about
3311 # to start is not bundled, then push out the current one and start a new
3313 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3314 if ( $_ && !$cust_bill_pkg->hidden ) {
3315 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3316 $_->{amount} =~ s/^\-0\.00$/0.00/;
3317 if (exists($_->{unit_amount})) {
3318 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3321 # we already decided to create this display line; don't reconsider it
3323 # if $_->{amount} != 0
3324 # || $discount_show_always
3325 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3326 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3332 if ( $locationnum ) {
3333 # this is a location section; skip packages that aren't at this
3335 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3336 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3340 # Consider display records for this item to determine if it belongs
3341 # in this section. Note that if there are no display records, there
3342 # will be a default pseudo-record that includes all charge types
3343 # and has no section name.
3344 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3345 ? $cust_bill_pkg->cust_bill_pkg_display
3346 : ( $cust_bill_pkg );
3348 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3349 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3352 if ( defined($category) ) {
3353 # then this is a package category section; process all display records
3354 # that belong to this section.
3355 @cust_bill_pkg_display = grep { $_->section eq $category }
3356 @cust_bill_pkg_display;
3358 # otherwise, process all display records that aren't usage summaries
3359 # (I don't think there should be usage summaries if you aren't using
3360 # category sections, but this is the historical behavior)
3361 @cust_bill_pkg_display = grep { !$_->summary }
3362 @cust_bill_pkg_display;
3365 my $classname = ''; # package class name, will fill in later
3367 foreach my $display (@cust_bill_pkg_display) {
3369 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3370 $display->billpkgdisplaynum. "\n"
3373 my $type = $display->type;
3375 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3376 $desc = substr($desc, 0, $maxlength). '...'
3377 if $format eq 'latex' && length($desc) > $maxlength;
3379 my %details_opt = ( 'format' => $format,
3380 'escape_function' => $escape_function,
3381 'format_function' => $format_function,
3382 'no_usage' => $opt{'no_usage'},
3385 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3386 if $opt{section_with_taxes};
3388 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3389 # XXX this should be pulled out into quotation_pkg
3391 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3393 # quotation_pkgs are never fees, so don't worry about the case where
3394 # part_pkg is undefined
3396 my @details = $cust_bill_pkg->details;
3398 # and I guess they're never bundled either?
3399 if (( $cust_bill_pkg->setup != 0 ) || ( $cust_bill_pkg->setup_show_zero )) {
3400 my $description = $desc;
3401 $description .= ' Setup'
3402 if $cust_bill_pkg->recur != 0
3403 || $discount_show_always
3404 || $cust_bill_pkg->recur_show_zero;
3406 # keep it consistent, please
3408 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3409 'description' => $description,
3410 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3411 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3412 'quantity' => $cust_bill_pkg->quantity,
3413 'pkg_tax' => \@pkg_tax,
3414 'ext_description' => \@details,
3415 'preref_html' => ( $opt{preref_callback}
3416 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3421 if (( $cust_bill_pkg->recur != 0 ) || ( $cust_bill_pkg->recur_show_zero )) {
3424 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3425 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3426 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3427 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3428 'quantity' => $cust_bill_pkg->quantity,
3429 'pkg_tax' => \@pkg_tax,
3430 'ext_description' => \@details,
3431 'preref_html' => ( $opt{preref_callback}
3432 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3438 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3439 # a "normal" package line item (not a quotation, not a fee, not a tax)
3441 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3444 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3445 my $part_pkg = $cust_pkg->part_pkg;
3447 # which pkgpart to show for display purposes?
3448 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3450 # start/end dates for invoice formats that do nonstandard
3452 my %item_dates = ();
3453 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3454 unless $part_pkg->option('disable_line_item_date_ranges',1);
3456 # not normally used, but pass this to the template anyway
3457 $classname = $part_pkg->classname;
3459 if ( (!$type || $type eq 'S')
3460 && ( $cust_bill_pkg->setup != 0
3461 || $cust_bill_pkg->setup_show_zero
3462 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3467 warn "$me _items_cust_bill_pkg adding setup\n"
3470 # append the word 'Setup' to the setup line if there's going to be
3471 # a recur line for the same package (i.e. not a one-time charge)
3473 my $description = $desc;
3474 $description .= ' Setup'
3475 if $cust_bill_pkg->recur != 0
3476 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3477 || $cust_bill_pkg->recur_show_zero;
3479 my $disable_date_ranges =
3480 $opt{disable_line_item_date_ranges}
3481 || $part_pkg->option('disable_line_item_date_ranges', 1);
3483 $description .= $cust_bill_pkg->time_period_pretty(
3486 disable_date_ranges => $disable_date_ranges,
3488 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3489 # triggered by the recurring charge freq
3491 && $cust_bill_pkg->recur == 0
3492 && ! $cust_bill_pkg->recur_show_zero;
3497 # always pass the svc_label through to the template, even if
3498 # not displaying it as an ext_description
3499 my @svc_labels = map &{$escape_function}($_),
3500 $cust_pkg->h_labels_short($self->_date,
3503 $self->conf->{locale},
3505 $svc_label = $svc_labels[0];
3507 unless ( $cust_pkg->part_pkg->hide_svc_detail
3508 || $cust_bill_pkg->hidden )
3511 push @d, @svc_labels
3512 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3513 # show the location label if it's not the customer's default
3514 # location, and we're not grouping items by location already
3515 if ( $cust_pkg->locationnum != $default_locationnum
3516 and !defined($locationnum) ) {
3517 my $loc = $cust_pkg->location_label;
3518 $loc = substr($loc, 0, $maxlength). '...'
3519 if $format eq 'latex' && length($loc) > $maxlength;
3520 push @d, &{$escape_function}($loc);
3523 } #unless hiding service details
3525 push @d, $cust_bill_pkg->details(%details_opt)
3526 if $cust_bill_pkg->recur == 0;
3528 if ( $cust_bill_pkg->hidden ) {
3529 $s->{amount} += $cust_bill_pkg->setup;
3530 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3531 push @{ $s->{ext_description} }, @d;
3535 description => $description,
3536 pkgpart => $pkgpart,
3537 pkgnum => $cust_bill_pkg->pkgnum,
3538 amount => $cust_bill_pkg->setup,
3539 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3540 unit_amount => $cust_bill_pkg->unitsetup,
3541 quantity => $cust_bill_pkg->quantity,
3542 pkg_tax => \@pkg_tax,
3543 ext_description => \@d,
3544 svc_label => ($svc_label || ''),
3545 locationnum => $cust_pkg->locationnum, # sure, why not?
3551 # should we show a recur line?
3552 # if type eq 'S', then NO, because we've been told not to.
3553 # otherwise, show the recur line if:
3554 # - there's a recurring charge
3555 # - or recur_show_zero is on
3556 # - or there's a positive unitrecur (so it's been discounted to zero)
3557 # and discount-show-always is on
3558 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3560 $cust_bill_pkg->recur != 0
3562 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3563 || $cust_bill_pkg->recur_show_zero
3568 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3571 my $is_summary = $display->summary;
3572 my $description = $desc;
3573 if ( $type eq 'U' and defined($r) ) {
3574 # don't just show the same description as the recur line
3575 $description = $self->mt('Usage charges');
3578 my $disable_date_ranges =
3579 $opt{disable_line_item_date_ranges}
3580 || $part_pkg->option('disable_line_item_date_ranges', 1);
3582 $description .= $cust_bill_pkg->time_period_pretty(
3585 disable_date_ranges => $disable_date_ranges,
3589 my @seconds = (); # for display of usage info
3592 #at least until cust_bill_pkg has "past" ranges in addition to
3593 #the "future" sdate/edate ones... see #3032
3594 my @dates = ( $self->_date );
3595 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3596 push @dates, $prev->sdate if $prev;
3597 push @dates, undef if !$prev;
3599 my @svc_labels = map &{$escape_function}($_),
3600 $cust_pkg->h_labels_short(@dates,
3602 $self->conf->{locale});
3603 $svc_label = $svc_labels[0];
3605 # show service labels, unless...
3606 # the package is set not to display them
3607 unless ( $part_pkg->hide_svc_detail
3608 # or this is a tax-like line item
3609 || $cust_bill_pkg->itemdesc
3610 # or this is a hidden (bundled) line item
3611 || $cust_bill_pkg->hidden
3612 # or this is a usage summary line
3613 || $is_summary && $type && $type eq 'U'
3614 # or this is a usage line and there's a recurring line
3615 # for the package in the same section (which will
3616 # have service labels already)
3617 || ($type eq 'U' and defined($r))
3621 warn "$me _items_cust_bill_pkg adding service details\n"
3624 push @d, @svc_labels
3625 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3626 warn "$me _items_cust_bill_pkg done adding service details\n"
3629 # show the location label if it's not the customer's default
3630 # location, and we're not grouping items by location already
3631 if ( $cust_pkg->locationnum != $default_locationnum
3632 and !defined($locationnum) ) {
3633 my $loc = $cust_pkg->location_label;
3634 $loc = substr($loc, 0, $maxlength). '...'
3635 if $format eq 'latex' && length($loc) > $maxlength;
3636 push @d, &{$escape_function}($loc);
3639 # Display of seconds_since_sqlradacct:
3640 # On the invoice, when processing @detail_items, look for a field
3641 # named 'seconds'. This will contain total seconds for each
3642 # service, in the same order as @ext_description. For services
3643 # that don't support this it will show undef.
3644 if ( $conf->exists('svc_acct-usage_seconds')
3645 and ! $cust_bill_pkg->pkgpart_override ) {
3646 foreach my $cust_svc (
3647 $cust_pkg->h_cust_svc(@dates, 'I')
3650 # eval because not having any part_export_usage exports
3651 # is a fatal error, last_bill/_date because that's how
3652 # sqlradius_hour billing does it
3654 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3656 push @seconds, $sec;
3658 } #if svc_acct-usage_seconds
3660 } # if we are showing service labels
3662 unless ( $is_summary ) {
3663 warn "$me _items_cust_bill_pkg adding details\n"
3666 #instead of omitting details entirely in this case (unwanted side
3667 # effects), just omit CDRs
3668 $details_opt{'no_usage'} = 1
3669 if $type && $type eq 'R';
3671 push @d, $cust_bill_pkg->details(%details_opt);
3674 warn "$me _items_cust_bill_pkg calculating amount\n"
3679 $amount = $cust_bill_pkg->recur;
3680 } elsif ($type eq 'R') {
3681 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3682 } elsif ($type eq 'U') {
3683 $amount = $cust_bill_pkg->usage;
3686 if ( !$type || $type eq 'R' ) {
3688 warn "$me _items_cust_bill_pkg adding recur\n"
3692 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3695 if ( $cust_bill_pkg->hidden ) {
3696 $r->{amount} += $amount;
3697 $r->{unit_amount} += $unit_amount;
3698 push @{ $r->{ext_description} }, @d;
3701 description => $description,
3702 pkgpart => $pkgpart,
3703 pkgnum => $cust_bill_pkg->pkgnum,
3705 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3706 unit_amount => $unit_amount,
3707 quantity => $cust_bill_pkg->quantity,
3708 pkg_tax => \@pkg_tax,
3710 ext_description => \@d,
3711 svc_label => ($svc_label || ''),
3712 locationnum => $cust_pkg->locationnum,
3714 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3717 } else { # $type eq 'U'
3719 warn "$me _items_cust_bill_pkg adding usage\n"
3722 if ( $cust_bill_pkg->hidden and defined($u) ) {
3723 # if this is a hidden package and there's already a usage
3724 # line for the bundle, add this package's total amount and
3725 # usage details to it
3726 $u->{amount} += $amount;
3727 push @{ $u->{ext_description} }, @d;
3728 } elsif ( $amount ) {
3729 # create a new usage line
3731 description => $description,
3732 pkgpart => $pkgpart,
3733 pkgnum => $cust_bill_pkg->pkgnum,
3736 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3737 pkg_tax => \@pkg_tax,
3739 ext_description => \@d,
3740 locationnum => $cust_pkg->locationnum,
3742 } # else this has no usage, so don't create a usage section
3745 } # recurring or usage with recurring charge
3747 } else { # taxes and fees
3749 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3752 # items of this kind should normally not have sdate/edate.
3754 'description' => $desc,
3755 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3756 + $cust_bill_pkg->recur)
3759 } # if quotation / package line item / other line item
3761 # decide whether to show active discounts here
3763 # case 1: we are showing a single line for the package
3765 # case 2: we are showing a setup line for a package that has
3766 # no base recurring fee
3767 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3768 # case 3: we are showing a recur line for a package that has
3769 # a base recurring fee
3770 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3773 my $item_discount = $cust_bill_pkg->_item_discount;
3774 if ( $item_discount ) {
3775 # $item_discount->{amount} is negative
3777 if ( $d and $cust_bill_pkg->hidden ) {
3778 $d->{amount} += $item_discount->{amount};
3780 $d = $item_discount;
3781 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3784 # update the active line (before the discount) to show the
3785 # original price (whether this is a hidden line or not)
3787 # quotation discounts keep track of setup and recur; invoice
3788 # discounts currently don't
3789 if ( exists $item_discount->{setup_amount} ) {
3791 $s->{amount} -= $item_discount->{setup_amount} if $s;
3792 $r->{amount} -= $item_discount->{recur_amount} if $r;
3796 # $active_line is the line item hashref for the line that will
3797 # show the original price
3798 # (use the recur or single line for the package, unless we're
3799 # showing a setup line for a package with no recurring fee)
3800 my $active_line = $r;
3801 if ( $type eq 'S' ) {
3804 $active_line->{amount} -= $item_discount->{amount};
3808 } # if there are any discounts
3809 } # if this is an appropriate place to show discounts
3811 } # foreach $display
3815 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3817 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3818 if exists($_->{amount});
3819 $_->{amount} =~ s/^\-0\.00$/0.00/;
3820 if (exists($_->{unit_amount})) {
3821 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3825 #if $_->{amount} != 0
3826 # || $discount_show_always
3827 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3828 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3832 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3839 =item _items_discounts_avail
3841 Returns an array of line item hashrefs representing available term discounts
3842 for this invoice. This makes the same assumptions that apply to term
3843 discounts in general: that the package is billed monthly, at a flat rate,
3844 with no usage charges. A prorated first month will be handled, as will
3845 a setup fee if the discount is allowed to apply to setup fees.
3849 sub _items_discounts_avail {
3852 #maybe move this method from cust_bill when quotations support discount_plans
3853 return () unless $self->can('discount_plans');
3854 my %plans = $self->discount_plans;
3856 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3857 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3861 my $plan = $plans{$months};
3863 my $term_total = sprintf('%.2f', $plan->discounted_total);
3864 my $percent = sprintf('%.0f',
3865 100 * (1 - $term_total / $plan->base_total) );
3866 my $permonth = sprintf('%.2f', $term_total / $months);
3867 my $detail = $self->mt('discount on item'). ' '.
3868 join(', ', map { "#$_" } $plan->pkgnums)
3871 # discounts for non-integer months don't work anyway
3872 $months = sprintf("%d", $months);
3875 description => $self->mt('Save [_1]% by paying for [_2] months',
3877 amount => $self->mt('[_1] ([_2] per month)',
3878 $term_total, $money_char.$permonth),
3879 ext_description => ($detail || ''),
3882 sort { $b <=> $a } keys %plans;
3886 =item has_sections AGENTNUM
3888 Return true if invoice_sections should be enabled for this bill.
3889 (Inherited by both cust_bill and cust_bill_void)
3892 * False if not an invoice
3893 * True always if conf invoice_sections is enabled
3894 * True always if sections_by_location is enabled
3895 * True if conf invoice_sections_multilocation > 1,
3896 and location_count >= invoice_sections_multilocation
3902 my ($self, $agentnum) = @_;
3904 return 0 unless $self->invnum > 0;
3906 $agentnum ||= $self->agentnum;
3907 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3908 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3910 my $location_min = $self->conf->config(
3911 'invoice_sections_multilocation', $agentnum,
3916 && $self->location_count >= $location_min;
3922 =item location_count
3924 Return the number of locations billed on this invoice
3928 sub location_count {
3930 return 0 unless $self->invnum;
3932 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3933 # FROM cust_bill_pkg
3934 # LEFT JOIN cust_pkg USING (pkgnum)
3935 # WHERE invnum = 278
3936 # AND cust_bill_pkg.pkgnum > 0
3938 my $result = qsearchs({
3939 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3940 table => 'cust_bill_pkg',
3941 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3942 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3943 . ' AND cust_bill_pkg.pkgnum > 0'
3945 ref $result ? $result->location_count : 0;