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'};
1204 warn "$me searching for line items\n"
1207 my %section_tax_lines;
1210 foreach my $line_item ( $self->_items_pkg(%options),
1211 $self->_items_fee(%options) ) {
1213 warn "$me adding line item ".
1214 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1217 push @buf, ( [ $line_item->{'description'},
1218 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1220 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1223 $line_item->{'ref'} = $line_item->{'pkgnum'};
1224 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1225 $line_item->{'section'} = $section;
1226 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1227 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1229 if ( length($line_item->{'unit_amount'}) ) {
1230 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1232 $line_item->{'ext_description'} ||= [];
1234 if ( $section_with_taxes && ref $line_item->{pkg_tax} ) {
1235 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1237 # It is rarely possible for the same tax record to be presented here
1238 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1239 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1240 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1242 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1246 push @detail_items, $line_item;
1249 # If conf flag invoice_sections_with_taxes:
1250 # - Add @detail_items for taxes into each section
1251 # - Update section subtotal to include taxes
1252 if ( $section_with_taxes && %section_tax_lines ) {
1253 for my $taxname ( keys %section_tax_lines ) {
1255 push @detail_items, {
1256 section => $section,
1257 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1258 description => &$escape_function($taxname),
1261 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1262 # append to the second value.
1263 if ($section->{subtotal} =~ /to/) {
1264 my @subtotal = split /\s/, $section->{subtotal};
1265 $subtotal[2] =~ s/[^\d\.]//g;
1266 $subtotal[2] = sprintf(
1268 ( $subtotal[2] + $section_tax_lines{$taxname} )
1270 $section->{subtotal} = join ' ', @subtotal;
1272 $section->{subtotal} =~ s/[^\d\.]//g;
1273 $section->{subtotal} = sprintf(
1274 $money_char . "%.2f",
1275 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1282 if ( $section->{'description'} ) {
1283 push @buf, ( ['','-----------'],
1284 [ $section->{'description'}. ' sub-total',
1285 $section->{'subtotal'} # already formatted this
1294 $invoice_data{current_less_finance} =
1295 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1297 # if there's anything in the Previous Charges section, prepend it to the list
1298 if ( $pr_total and $previous_section ne $default_section ) {
1299 unshift @sections, $previous_section;
1300 # but not @summary_subtotals
1303 warn "$me adding taxes\n"
1306 # create a tax section if we don't yet have one
1307 my $tax_description = 'Taxes, Surcharges, and Fees';
1309 List::Util::first { $_->{description} eq $tax_description } @sections;
1310 if (!$tax_section) {
1311 $tax_section = { 'description' => $tax_description };
1312 push @sections, $tax_section if $multisection;
1314 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1315 # if this is an existing tax section, we're merging the tax items into it.
1316 # grab the taxtotal that's already there, strip the money symbol if any
1317 my $taxtotal = $tax_section->{'subtotal'} || 0;
1318 $taxtotal =~ s/^\Q$other_money_char\E//;
1321 #my $tax_weight = _pkg_category($tax_section->{description})
1322 # ? _pkg_category($tax_section->{description})->weight
1324 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1325 #$tax_section->{'sort_weight'} = $tax_weight;
1327 my @items_tax = $self->_items_tax;
1328 foreach my $tax ( @items_tax ) {
1330 $taxtotal += $tax->{'amount'};
1332 my $description = &$escape_function( $tax->{'description'} );
1333 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1335 if ( $multisection ) {
1337 push @detail_items, {
1338 ext_description => [],
1341 description => $description,
1342 amount => $money_char. $amount,
1344 section => $tax_section,
1349 push @total_items, {
1350 'total_item' => $description,
1351 'total_amount' => $other_money_char. $amount,
1356 push @buf,[ $description,
1357 $money_char. $amount,
1364 $total->{'total_item'} = $self->mt('Sub-total');
1365 $total->{'total_amount'} =
1366 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1368 if ( $multisection ) {
1369 if ( $taxtotal > 0 ) {
1370 # there are taxes, so prepare the section to be displayed.
1371 # $taxtotal already includes any line items that were already in the
1372 # section (fees, taxes that are charged as packages for some reason).
1373 # also set 'summarized' to false so that this isn't a summary-only
1375 $tax_section->{'subtotal'} = $other_money_char.
1376 sprintf('%.2f', $taxtotal);
1377 $tax_section->{'pretotal'} = 'New charges sub-total '.
1378 $total->{'total_amount'};
1379 $tax_section->{'description'} = $self->mt($tax_description);
1380 $tax_section->{'summarized'} = '';
1382 if ( $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum) ) {
1384 # remove tax section if taxes are itemized within other sections
1385 @sections = grep{ $_ ne $tax_section } @sections;
1387 } elsif ( !grep $tax_section, @sections ) {
1389 # append it if it's not already there
1390 push @sections, $tax_section;
1391 push @summary_subtotals, $tax_section;
1398 unshift @total_items, $total;
1401 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1407 my %embolden_functions = (
1408 'latex' => sub { return '\textbf{'. shift(). '}' },
1409 'html' => sub { return '<b>'. shift(). '</b>' },
1410 'template' => sub { shift },
1412 my $embolden_function = $embolden_functions{$format};
1414 if ( $multisection ) {
1416 if ( $adjust_section->{'sort_weight'} ) {
1417 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1418 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1420 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1421 $other_money_char. sprintf('%.2f', $self->charged );
1426 if ( $self->can('_items_total') ) { # should always be true now
1428 # even for multisection, need plain text version
1430 my @new_total_items = $self->_items_total;
1432 push @buf,['','-----------'];
1434 foreach ( @new_total_items ) {
1435 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1436 $_->{'total_item'} = &$embolden_function( $item );
1438 if ( ref($amount) ) {
1439 $_->{'total_amount'} = &$embolden_function(
1440 $other_money_char.$amount->[0]. ' to '.
1441 $other_money_char.$amount->[1]
1444 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1447 # but if it's multisection, don't append to @total_items. the adjust
1448 # section has all this stuff
1449 push @total_items, $_ if !$multisection;
1450 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1453 push @buf, [ '', '' ];
1455 # if we're showing previous invoices, also show previous
1456 # credits and payments
1457 if ( $self->enable_previous
1458 and $self->can('_items_credits')
1459 and $self->can('_items_payments') )
1463 my $credittotal = 0;
1464 foreach my $credit (
1465 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1469 $total->{'total_item'} = &$escape_function($credit->{'description'});
1470 $credittotal += $credit->{'amount'};
1471 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1472 if ( $multisection ) {
1473 push @detail_items, {
1474 ext_description => [],
1477 description => &$escape_function($credit->{'description'}),
1478 amount => $money_char . $credit->{'amount'},
1480 section => $adjust_section,
1483 push @total_items, $total;
1487 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1490 foreach my $credit (
1491 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1493 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1497 my $paymenttotal = 0;
1498 foreach my $payment (
1499 $self->_items_payments( 'template' => $template )
1502 $total->{'total_item'} = &$escape_function($payment->{'description'});
1503 $paymenttotal += $payment->{'amount'};
1504 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1505 if ( $multisection ) {
1506 push @detail_items, {
1507 ext_description => [],
1510 description => &$escape_function($payment->{'description'}),
1511 amount => $money_char . $payment->{'amount'},
1513 section => $adjust_section,
1516 push @total_items, $total;
1518 push @buf, [ $payment->{'description'},
1519 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1522 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1524 if ( $multisection ) {
1525 $adjust_section->{'subtotal'} = $other_money_char.
1526 sprintf('%.2f', $credittotal + $paymenttotal);
1528 #why this? because {sort_weight} forces the adjust_section to appear
1529 #in @extra_sections instead of @sections. obviously.
1530 push @sections, $adjust_section
1531 unless $adjust_section->{sort_weight};
1532 # do not summarize; adjustments there are shown according to
1536 # create Balance Due message
1539 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1540 $total->{'total_amount'} =
1541 &$embolden_function(
1542 $other_money_char. sprintf('%.2f', #why? $summarypage
1543 # ? $self->charged +
1544 # $self->billing_balance
1546 $self->owed + $pr_total
1549 if ( $multisection && !$adjust_section->{sort_weight} ) {
1550 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1551 $total->{'total_amount'};
1553 push @total_items, $total;
1555 push @buf,['','-----------'];
1556 push @buf,[$self->balance_due_msg, $money_char.
1557 sprintf("%10.2f", $balance_due ) ];
1560 if ( $conf->exists('previous_balance-show_credit')
1561 and $cust_main->balance < 0 ) {
1562 my $credit_total = {
1563 'total_item' => &$embolden_function($self->credit_balance_msg),
1564 'total_amount' => &$embolden_function(
1565 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1568 if ( $multisection ) {
1569 $adjust_section->{'posttotal'} .= $newline_token .
1570 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1573 push @total_items, $credit_total;
1575 push @buf,['','-----------'];
1576 push @buf,[$self->credit_balance_msg, $money_char.
1577 sprintf("%10.2f", -$cust_main->balance ) ];
1581 } #end of default total adding ! can('_items_total')
1583 if ( $multisection ) {
1584 if ( $conf->exists('svc_phone_sections')
1585 && $self->can('_items_svc_phone_sections')
1589 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1590 $total->{'total_amount'} =
1591 &$embolden_function(
1592 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1594 my $last_section = pop @sections;
1595 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1596 $total->{'total_amount'};
1597 push @sections, $last_section;
1599 push @sections, @$late_sections
1603 # make a discounts-available section, even without multisection
1604 if ( $conf->exists('discount-show_available')
1605 and my @discounts_avail = $self->_items_discounts_avail ) {
1606 my $discount_section = {
1607 'description' => $self->mt('Discounts Available'),
1612 push @sections, $discount_section; # do not summarize
1613 push @detail_items, map { +{
1614 'ref' => '', #should this be something else?
1615 'section' => $discount_section,
1616 'description' => &$escape_function( $_->{description} ),
1617 'amount' => $money_char . &$escape_function( $_->{amount} ),
1618 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1619 } } @discounts_avail;
1622 # not adding any more sections after this
1623 $invoice_data{summary_subtotals} = \@summary_subtotals;
1626 if ( $conf->exists('usage_class_summary')
1627 and $self->can('_items_usage_class_summary') ) {
1628 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1629 if ( @usage_subtotals ) {
1630 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1631 unshift @detail_items, @usage_subtotals;
1635 # invoice history "section" (not really a section)
1636 # not to be included in any subtotals, completely independent of
1638 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1641 foreach my $cust_bill ( $cust_main->cust_bill ) {
1642 # XXX hardcoded format, and currently only 'charged'; add other fields
1643 # if they become necessary
1644 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1645 $history{$date} ||= 0;
1646 $history{$date} += $cust_bill->charged;
1647 # just so we have a numeric sort key
1648 $monthorder{$date} ||= $cust_bill->_date;
1650 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1652 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1653 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1656 # service locations: another option for template customization
1658 foreach my $item (@detail_items) {
1659 if ( $item->{locationnum} ) {
1660 $location_info{ $item->{locationnum} } ||= {
1661 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1665 $invoice_data{location_info} = \%location_info;
1667 # debugging hook: call this with 'diag' => 1 to just get a hash of
1668 # the invoice variables
1669 return \%invoice_data if ( $params{'diag'} );
1671 # All sections and items are built; now fill in templates.
1672 my @includelist = ();
1673 push @includelist, 'summary' if $summarypage;
1674 foreach my $include ( @includelist ) {
1676 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1679 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1681 @inc_src = $conf->config($inc_file, $agentnum);
1685 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1687 my $convert_map = $convert_maps{$format}{$include};
1689 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1690 s/--\@\]/$delimiters{$format}[1]/g;
1693 &$convert_map( $conf->config($inc_file, $agentnum) );
1697 my $inc_tt = new Text::Template (
1699 SOURCE => [ map "$_\n", @inc_src ],
1700 DELIMITERS => $delimiters{$format},
1701 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1703 unless ( $inc_tt->compile() ) {
1704 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1705 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1709 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1711 $invoice_data{$include} =~ s/\n+$//
1712 if ($format eq 'latex');
1717 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1718 /invoice_lines\((\d*)\)/;
1719 $invoice_lines += $1 || scalar(@buf);
1722 die "no invoice_lines() functions in template?"
1723 if ( $format eq 'template' && !$wasfunc );
1725 if ( $invoice_lines ) {
1726 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1727 $invoice_data{'total_pages'}++
1728 if scalar(@buf) % $invoice_lines;
1731 #setup subroutine for the template
1732 $invoice_data{invoice_lines} = sub {
1733 my $lines = shift || scalar(@buf);
1742 if ($format eq 'template') {
1747 push @collect, split("\n",
1748 $text_template->fill_in( HASH => \%invoice_data )
1750 $invoice_data{'page'}++;
1752 map "$_\n", @collect;
1754 } else { # this is where we actually create the invoice
1756 if ( $params{no_addresses} ) {
1757 delete $invoice_data{$_} foreach qw(
1758 payname company address1 address2 city state zip country
1760 $invoice_data{returnaddress} = '~';
1763 warn "filling in template for invoice ". $self->invnum. "\n"
1765 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1768 $text_template->fill_in(HASH => \%invoice_data);
1772 sub notice_name { '('.shift->table.')'; }
1774 sub template_conf { 'invoice_'; }
1776 # helper routine for generating date ranges
1777 sub _prior_month30s {
1780 [ 1, 2592000 ], # 0-30 days ago
1781 [ 2592000, 5184000 ], # 30-60 days ago
1782 [ 5184000, 7776000 ], # 60-90 days ago
1783 [ 7776000, 0 ], # 90+ days ago
1786 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1787 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1792 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1794 Returns an postscript invoice, as a scalar.
1796 Options can be passed as a hashref (recommended) or as a list of time, template
1797 and then any key/value pairs for any other options.
1799 I<time> an optional value used to control the printing of overdue messages. The
1800 default is now. It isn't the date of the invoice; that's the `_date' field.
1801 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1802 L<Time::Local> and L<Date::Parse> for conversion functions.
1804 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1811 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1812 my $ps = generate_ps($file);
1814 unlink($barcodefile) if $barcodefile;
1819 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1821 Returns an PDF invoice, as a scalar.
1823 Options can be passed as a hashref (recommended) or as a list of time, template
1824 and then any key/value pairs for any other options.
1826 I<time> an optional value used to control the printing of overdue messages. The
1827 default is now. It isn't the date of the invoice; that's the `_date' field.
1828 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1829 L<Time::Local> and L<Date::Parse> for conversion functions.
1831 I<template>, if specified, is the name of a suffix for alternate invoices.
1833 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1840 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1841 my $pdf = generate_pdf($file);
1843 unlink($barcodefile) if $barcodefile;
1848 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1850 Returns an HTML invoice, as a scalar.
1852 I<time> an optional value used to control the printing of overdue messages. The
1853 default is now. It isn't the date of the invoice; that's the `_date' field.
1854 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1855 L<Time::Local> and L<Date::Parse> for conversion functions.
1857 I<template>, if specified, is the name of a suffix for alternate invoices.
1859 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1861 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1862 when emailing the invoice as part of a multipart/related MIME email.
1870 %params = %{ shift() };
1874 $params{'format'} = 'html';
1876 $self->print_generic( %params );
1879 # quick subroutine for print_latex
1881 # There are ten characters that LaTeX treats as special characters, which
1882 # means that they do not simply typeset themselves:
1883 # # $ % & ~ _ ^ \ { }
1885 # TeX ignores blanks following an escaped character; if you want a blank (as
1886 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1890 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1891 $value =~ s/([<>])/\$$1\$/g;
1897 encode_entities($value);
1901 sub _html_escape_nbsp {
1902 my $value = _html_escape(shift);
1903 $value =~ s/ +/ /g;
1907 #utility methods for print_*
1909 sub _translate_old_latex_format {
1910 warn "_translate_old_latex_format called\n"
1917 if ( $line =~ /^%%Detail\s*$/ ) {
1919 push @template, q![@--!,
1920 q! foreach my $_tr_line (@detail_items) {!,
1921 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1922 q! $_tr_line->{'description'} .= !,
1923 q! "\\tabularnewline\n~~".!,
1924 q! join( "\\tabularnewline\n~~",!,
1925 q! @{$_tr_line->{'ext_description'}}!,
1929 while ( ( my $line_item_line = shift )
1930 !~ /^%%EndDetail\s*$/ ) {
1931 $line_item_line =~ s/'/\\'/g; # nice LTS
1932 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1933 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1934 push @template, " \$OUT .= '$line_item_line';";
1937 push @template, '}',
1940 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1942 push @template, '[@--',
1943 ' foreach my $_tr_line (@total_items) {';
1945 while ( ( my $total_item_line = shift )
1946 !~ /^%%EndTotalDetails\s*$/ ) {
1947 $total_item_line =~ s/'/\\'/g; # nice LTS
1948 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1949 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1950 push @template, " \$OUT .= '$total_item_line';";
1953 push @template, '}',
1957 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1958 push @template, $line;
1964 warn "$_\n" foreach @template;
1976 my $conf = $self->conf;
1978 #check for an invoice-specific override
1979 return $self->invoice_terms if $self->invoice_terms;
1981 #check for a customer- specific override
1982 my $cust_main = $self->cust_main;
1983 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1987 $agentnum = $cust_main->agentnum;
1988 } elsif ( my $prospect_main = $self->prospect_main ) {
1989 $agentnum = $prospect_main->agentnum;
1992 #use configured default
1993 $conf->config('invoice_default_terms', $agentnum) || '';
2003 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2004 $duedate = $self->_date() + ( $1 * 86400 );
2005 } elsif ( $self->terms =~ /^End of Month$/ ) {
2006 my ($mon,$year) = (localtime($self->_date) )[4,5];
2008 until ( $mon < 12 ) { $mon -= 12; $year++; }
2009 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2010 $duedate = $nextmonth_first - 86400;
2021 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2024 =item balance_due_msg
2028 sub balance_due_msg {
2030 my $msg = $self->mt('Balance Due');
2031 return $msg unless $self->terms; # huh?
2032 if ( !$self->conf->exists('invoice_show_prior_due_date')
2033 || $self->has_sections ) {
2034 # if enabled, the due date is shown with Total New Charges (see
2035 # _items_total) and not here
2036 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2037 if ( $self->due_date ) {
2039 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2040 || 'Please pay by [_1]';
2041 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')).
2043 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2044 } elsif ( $self->terms ) {
2045 $msg .= ' - '. $self->mt($self->terms);
2051 =item balance_due_date
2055 sub balance_due_date {
2057 my $conf = $self->conf;
2059 my $terms = $self->terms;
2060 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2061 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2066 sub credit_balance_msg {
2068 $self->mt('Credit Balance Remaining')
2073 Returns a string with the date, for example: "3/20/2008", localized for the
2074 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2080 $self->time2str_local('short', $self->_date);
2083 =item _date_pretty_unlocalized
2085 Returns a string with the date, for example: "3/20/2008", in the format
2086 configured for the back-office. Use _date_pretty for end-customer display use.
2090 sub _date_pretty_unlocalized {
2092 time2str($date_format, $self->_date);
2097 Emails this template.
2099 Options are passed as a hashref. Available options:
2105 If specified, overrides the default From: address.
2109 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2113 (Deprecated) If specified, is the name of a suffix for alternate template files.
2117 Options accepted by generate_email can also be used.
2123 my $opt = shift || {};
2124 if ($opt and !ref($opt)) {
2125 die ref($self). '->email called with positional parameters';
2128 return if $self->hide;
2130 my $error = send_email(
2131 $self->generate_email(
2132 'subject' => $self->email_subject($opt->{template}),
2133 %$opt, # template, etc.
2137 die "can't email: $error\n" if $error;
2140 =item generate_email OPTION => VALUE ...
2148 sender address, required
2152 alternate template name, optional
2156 email subject, optional
2160 notice name instead of "Invoice", optional
2164 Returns an argument list to be passed to L<FS::Misc::send_email>.
2171 sub generate_email {
2175 my $conf = $self->conf;
2177 my $me = '[FS::Template_Mixin::generate_email]';
2180 'from' => $args{'from'},
2181 'subject' => ($args{'subject'} || $self->email_subject),
2182 'custnum' => $self->custnum,
2183 'msgtype' => 'invoice',
2186 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2188 my $cust_main = $self->cust_main;
2190 if (ref($args{'to'}) eq 'ARRAY') {
2191 $return{'to'} = $args{'to'};
2192 } elsif ( $cust_main ) {
2193 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2196 my $tc = $self->template_conf;
2198 my @text; # array of lines
2199 my $html; # a big string
2200 my @related_parts; # will contain the text/HTML alternative, and images
2201 my $related; # will contain the multipart/related object
2203 if ( $conf->exists($tc. 'email_pdf') ) {
2204 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2206 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2209 my $msg_template = FS::msg_template->by_key($msgnum)
2210 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2211 my %prepared = $msg_template->prepare(
2212 cust_main => $self->cust_main,
2216 @text = split(/(?=\n)/, $prepared{'text_body'});
2217 $html = $prepared{'html_body'};
2219 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2221 warn "$me using '${tc}email_pdf_note' in multipart message"
2223 @text = $conf->config($tc.'email_pdf_note');
2224 $html = join('<BR>', @text);
2226 } # else use the plain text invoice
2231 if ( $conf->config($tc.'template') ) {
2233 warn "$me generating plain text invoice"
2236 # 'print_text' argument is no longer used
2237 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2241 warn "$me no plain text version exists; sending empty message body"
2248 my $text_part = build MIME::Entity (
2249 'Type' => 'text/plain',
2250 'Encoding' => 'quoted-printable',
2251 'Charset' => 'UTF-8',
2252 #'Encoding' => '7bit',
2254 'Disposition' => 'inline',
2259 if ( $conf->exists($tc.'html') ) {
2260 warn "$me generating HTML invoice"
2263 $args{'from'} =~ /\@([\w\.\-]+)/;
2264 my $from = $1 || 'example.com';
2265 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2268 my $agentnum = $cust_main ? $cust_main->agentnum
2269 : $self->prospect_main->agentnum;
2270 if ( defined($args{'template'}) && length($args{'template'})
2271 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2274 $logo = 'logo_'. $args{'template'}. '.png';
2278 my $image_data = $conf->config_binary( $logo, $agentnum);
2280 push @related_parts, build MIME::Entity
2281 'Type' => 'image/png',
2282 'Encoding' => 'base64',
2283 'Data' => $image_data,
2284 'Filename' => 'logo.png',
2285 'Content-ID' => "<$content_id>",
2288 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2289 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2290 push @related_parts, build MIME::Entity
2291 'Type' => 'image/png',
2292 'Encoding' => 'base64',
2293 'Data' => $self->invoice_barcode(0),
2294 'Filename' => 'barcode.png',
2295 'Content-ID' => "<$barcode_content_id>",
2297 $args{'barcode_cid'} = $barcode_content_id;
2300 $html = $self->print_html({ 'cid'=>$content_id, %args });
2307 warn "$me creating HTML/text multipart message"
2310 $return{'nobody'} = 1;
2312 my $alternative = build MIME::Entity
2313 'Type' => 'multipart/alternative',
2314 #'Encoding' => '7bit',
2315 'Disposition' => 'inline'
2319 $alternative->add_part($text_part);
2322 $alternative->attach(
2323 'Type' => 'text/html',
2324 'Encoding' => 'quoted-printable',
2325 'Data' => [ '<html>',
2328 ' '. encode_entities($return{'subject'}),
2331 ' <body bgcolor="#e8e8e8">',
2332 Encode::encode_utf8($html),
2336 'Disposition' => 'inline',
2337 #'Filename' => 'invoice.pdf',
2340 unshift @related_parts, $alternative;
2342 $related = build MIME::Entity 'Type' => 'multipart/related',
2343 'Encoding' => '7bit';
2345 #false laziness w/Misc::send_email
2346 $related->head->replace('Content-type',
2347 $related->mime_type.
2348 '; boundary="'. $related->head->multipart_boundary. '"'.
2349 '; type=multipart/alternative'
2352 $related->add_part($_) foreach @related_parts;
2356 my @otherparts = ();
2357 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2359 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2361 my $data = join('', map "$_\n",
2362 $self->call_details(prepend_billed_number=>1)
2365 my $zip = new Archive::Zip;
2366 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2367 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2370 my $SH = IO::Scalar->new(\$zipdata);
2371 my $status = $zip->writeToFileHandle($SH);
2372 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2374 push @otherparts, build MIME::Entity
2375 'Type' => 'application/zip',
2376 'Encoding' => 'base64',
2378 'Disposition' => 'attachment',
2379 'Filename' => 'usage-'. $self->invnum. '.zip',
2382 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2384 push @otherparts, build MIME::Entity
2385 'Type' => 'text/csv',
2386 'Encoding' => '7bit',
2387 'Data' => [ map { "$_\n" }
2388 $self->call_details('prepend_billed_number' => 1)
2390 'Disposition' => 'attachment',
2391 'Filename' => 'usage-'. $self->invnum. '.csv',
2398 if ( $conf->exists($tc.'email_pdf') ) {
2403 # multipart/alternative
2409 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2410 push @otherparts, $pdf;
2414 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2416 $return{'mimeparts'} = [ $related, @otherparts ];
2417 $return{'type'} = 'multipart/related'; # of the first part
2419 $return{'mimeparts'} = [ $text_part, @otherparts ];
2420 $return{'type'} = 'text/plain';
2422 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2423 $return{'mimeparts'} = \@related_parts;
2424 $return{'content-type'} = 'multipart/related';
2425 $return{'type'} = 'multipart/alternative';
2426 } else { # no HTML either
2427 $return{'body'} = \@text;
2428 $return{'content-type'} = 'text/plain';
2437 Returns a list suitable for passing to MIME::Entity->build(), representing
2438 this invoice as PDF attachment.
2445 'Type' => 'application/pdf',
2446 'Encoding' => 'base64',
2447 'Data' => [ $self->print_pdf(@_) ],
2448 'Disposition' => 'attachment',
2449 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2453 =item postal_mail_fsinc
2455 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2461 use IO::Socket::SSL;
2463 use HTTP::Request::Common qw( POST );
2466 sub postal_mail_fsinc {
2467 my ( $self, %opt ) = @_;
2469 my $url = 'https://ws.freeside.biz/print';
2471 my $cust_main = $self->cust_main;
2472 my $agentnum = $cust_main->agentnum;
2473 my $bill_location = $cust_main->bill_location;
2475 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2476 if $bill_location->country ne 'US';
2478 my $conf = new FS::Conf;
2480 my @company_address = $conf->config('company_address', $agentnum);
2481 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2482 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2483 $company_address1 = $company_address[0];
2484 $company_address2 = $company_address[1];
2486 $company_state = $2;
2488 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2489 $company_address1 = $company_address[0];
2490 $company_address2 = '';
2492 $company_state = $2;
2495 die "Unparsable company_address; contact support\@freeside.biz\n";
2497 $company_city =~ s/,$//;
2499 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2500 my $pages = CAM::PDF->new($file)->numPages;
2502 my $ua = LWP::UserAgent->new(
2504 verify_hostname => 0,
2505 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2506 SSL_version => 'SSLv3',
2509 my $response = $ua->request( POST $url, [
2510 'support-key' => scalar($conf->config('support-key')),
2511 'file' => encode_base64($file),
2515 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2516 'company_address1' => $company_address1,
2517 'company_address2' => $company_address2,
2518 'company_city' => $company_city,
2519 'company_state' => $company_state,
2520 'company_zip' => $company_zip,
2521 'company_country' => 'US',
2522 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2523 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2526 'name' => ( $cust_main->payname
2527 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/
2528 ? $cust_main->payname
2529 : $cust_main->contact_firstlast
2531 'company' => $cust_main->company,
2532 'address1' => $bill_location->address1,
2533 'address2' => $bill_location->address2,
2534 'city' => $bill_location->city,
2535 'state' => $bill_location->state,
2536 'zip' => $bill_location->zip,
2537 'country' => $bill_location->country,
2540 die "Print connection error: ". $response->message.
2541 ' ('. $response->as_string. ")\n"
2542 unless $response->is_success;
2545 my $content = eval { decode_json($response->content) };
2546 die "Print JSON error : $@\n" if $@;
2548 die $content->{error}."\n"
2549 if $content->{error};
2551 #TODO: store this so we can query for a status later
2552 warn "Invoice printed, ID ". $content->{id}. "\n";
2557 =item _items_sections OPTIONS
2559 Generate section information for all items appearing on this invoice.
2560 This will only be called for multi-section invoices.
2562 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2563 related display records (L<FS::cust_bill_pkg_display>) and organize
2564 them into two groups ("early" and "late" according to whether they come
2565 before or after the total), then into sections. A subtotal is calculated
2568 Section descriptions are returned in sort weight order. Each consists
2569 of a hash containing:
2571 description: the package category name, escaped
2572 subtotal: the total charges in that section
2573 tax_section: a flag indicating that the section contains only tax charges
2574 summarized: same as tax_section, for some reason
2575 sort_weight: the package category's sort weight
2577 If 'condense' is set on the display record, it also contains everything
2578 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2579 coderefs to generate parts of the invoice. This is not advised.
2581 The method returns two arrayrefs, one of "early" sections and one of "late"
2584 OPTIONS may include:
2586 by_location: a flag to divide the invoice into sections by location.
2587 Each section hash will have a 'location' element containing a hashref of
2588 the location fields (see L<FS::cust_location>). The section description
2589 will be the location label, but the template can use any of the location
2590 fields to create a suitable label.
2592 by_category: a flag to divide the invoice into sections using display
2593 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2594 behavior. Each section hash will have a 'category' element containing
2595 the section name from the display record (which probably equals the
2596 category name of the package, but may not in some cases).
2598 summary: a flag indicating that this is a summary-format invoice.
2599 Turning this on has the following effects:
2600 - Ignores display items with the 'summary' flag.
2601 - Places all sections in the "early" group even if they have post_total.
2602 - Creates sections for all non-disabled package categories, even if they
2603 have no charges on this invoice, as well as a section with no name.
2605 escape: an escape function to use for section titles.
2607 extra_sections: an arrayref of additional sections to return after the
2608 sorted list. If there are any of these, section subtotals exclude
2611 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2612 passed through to C<_condense_section()>.
2616 use vars qw(%pkg_category_cache);
2617 sub _items_sections {
2621 my $escape = $opt{escape};
2622 my @extra_sections = @{ $opt{extra_sections} || [] };
2624 # $subtotal{$locationnum}{$categoryname} = amount.
2625 # if we're not using by_location, $locationnum is undef.
2626 # if we're not using by_category, you guessed it, $categoryname is undef.
2627 # if we're not using either one, we shouldn't be here in the first place...
2629 my %late_subtotal = ();
2632 # About tax items + multisection invoices:
2633 # If either invoice_*summary option is enabled, AND there is a
2634 # package category with the name of the tax, then there will be
2635 # a display record assigning the tax item to that category.
2637 # However, the taxes are always placed in the "Taxes, Surcharges,
2638 # and Fees" section regardless of that. The only effect of the
2639 # display record is to create a subtotal for the summary page.
2642 my $pkg_hash = $self->cust_pkg_hash;
2644 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2647 my $usage = $cust_bill_pkg->usage;
2650 if ( $opt{by_location} ) {
2651 if ( $cust_bill_pkg->pkgnum ) {
2652 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2657 $locationnum = undef;
2660 # as in _items_cust_pkg, if a line item has no display records,
2661 # cust_bill_pkg_display() returns a default record for it
2663 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2664 next if ( $display->summary && $opt{summary} );
2666 my $section = $display->section;
2667 my $type = $display->type;
2668 # Set $section = undef if we're sectioning by location and this
2669 # line item _has_ a location (i.e. isn't a fee).
2670 $section = undef if $locationnum;
2672 # set this flag if the section is not tax-only
2673 $not_tax{$locationnum}{$section} = 1
2674 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2676 # there's actually a very important piece of logic buried in here:
2677 # incrementing $late_subtotal{$section} CREATES
2678 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2679 # to define the list of late sections, and likewise keys(%subtotal).
2680 # When _items_cust_bill_pkg is called to generate line items for
2681 # real, it will be called with 'section' => $section for each
2683 if ( $display->post_total && !$opt{summary} ) {
2684 if (! $type || $type eq 'S') {
2685 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2686 if $cust_bill_pkg->setup != 0
2687 || $cust_bill_pkg->setup_show_zero;
2691 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2692 if $cust_bill_pkg->recur != 0
2693 || $cust_bill_pkg->recur_show_zero;
2696 if ($type && $type eq 'R') {
2697 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2698 if $cust_bill_pkg->recur != 0
2699 || $cust_bill_pkg->recur_show_zero;
2702 if ($type && $type eq 'U') {
2703 $late_subtotal{$locationnum}{$section} += $usage
2704 unless scalar(@extra_sections);
2707 } else { # it's a pre-total (normal) section
2709 # skip tax items unless they're explicitly included in a section
2710 next if $cust_bill_pkg->pkgnum == 0 and
2711 ! $cust_bill_pkg->feepart and
2714 if ( $type eq 'S' ) {
2715 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2716 if $cust_bill_pkg->setup != 0
2717 || $cust_bill_pkg->setup_show_zero;
2718 } elsif ( $type eq 'R' ) {
2719 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2720 if $cust_bill_pkg->recur != 0
2721 || $cust_bill_pkg->recur_show_zero;
2722 } elsif ( $type eq 'U' ) {
2723 $subtotal{$locationnum}{$section} += $usage
2724 unless scalar(@extra_sections);
2725 } elsif ( !$type ) {
2726 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2727 + $cust_bill_pkg->recur;
2736 %pkg_category_cache = ();
2738 # summary invoices need subtotals for all non-disabled package categories,
2739 # even if they're zero
2740 # but currently assume that there are no location sections, or at least
2741 # that the summary page doesn't care about them
2742 if ( $opt{summary} ) {
2743 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2744 $subtotal{''}{$category->categoryname} ||= 0;
2746 $subtotal{''}{''} ||= 0;
2750 foreach my $post_total (0,1) {
2752 my $s = $post_total ? \%late_subtotal : \%subtotal;
2753 foreach my $locationnum (keys %$s) {
2754 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2756 'subtotal' => $s->{$locationnum}{$sectionname},
2759 if ( $locationnum ) {
2760 $section->{'locationnum'} = $locationnum;
2761 my $location = FS::cust_location->by_key($locationnum);
2762 $section->{'description'} = &{ $escape }($location->location_label);
2763 # Better ideas? This will roughly group them by proximity,
2764 # which alpha sorting on any of the address fields won't.
2765 # Sorting by locationnum is meaningless.
2766 # We have to sort on _something_ or the order may change
2767 # randomly from one invoice to the next, which will confuse
2769 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2771 $section->{'location'} = {
2772 label_prefix => &{ $escape }($location->label_prefix),
2773 map { $_ => &{ $escape }($location->get($_)) }
2777 $section->{'category'} = $sectionname;
2778 $section->{'description'} = &{ $escape }($sectionname);
2779 if ( _pkg_category($sectionname) ) {
2780 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2781 if ( _pkg_category($sectionname)->condense ) {
2782 $section = { %$section, $self->_condense_section($opt{format}) };
2786 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2787 # then it's a tax-only section
2788 $section->{'summarized'} = 'Y';
2789 $section->{'tax_section'} = 'Y';
2791 push @these, $section;
2792 } # foreach $sectionname
2793 } #foreach $locationnum
2794 push @these, @extra_sections if $post_total == 0;
2795 # need an alpha sort for location sections, because postal codes can
2797 $sections[ $post_total ] = [ sort {
2798 $opt{'by_location'} ?
2799 ($a->{sort_weight} cmp $b->{sort_weight}) :
2800 ($a->{sort_weight} <=> $b->{sort_weight})
2802 } #foreach $post_total
2804 return @sections; # early, late
2807 #helper subs for above
2811 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2815 my $categoryname = shift;
2816 $pkg_category_cache{$categoryname} ||=
2817 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2820 my %condensed_format = (
2821 'label' => [ qw( Description Qty Amount ) ],
2823 sub { shift->{description} },
2824 sub { shift->{quantity} },
2825 sub { my($href, %opt) = @_;
2826 ($opt{dollar} || ''). $href->{amount};
2829 'align' => [ qw( l r r ) ],
2830 'span' => [ qw( 5 1 1 ) ], # unitprices?
2831 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2834 sub _condense_section {
2835 my ( $self, $format ) = ( shift, shift );
2837 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2838 qw( description_generator
2841 total_line_generator
2846 sub _condensed_generator_defaults {
2847 my ( $self, $format ) = ( shift, shift );
2848 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2857 sub _condensed_header_generator {
2858 my ( $self, $format ) = ( shift, shift );
2860 my ( $f, $prefix, $suffix, $separator, $column ) =
2861 _condensed_generator_defaults($format);
2863 if ($format eq 'latex') {
2864 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2865 $suffix = "\\\\\n\\hline";
2868 sub { my ($d,$a,$s,$w) = @_;
2869 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2871 } elsif ( $format eq 'html' ) {
2872 $prefix = '<th></th>';
2876 sub { my ($d,$a,$s,$w) = @_;
2877 return qq!<th align="$html_align{$a}">$d</th>!;
2885 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2887 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2890 $prefix. join($separator, @result). $suffix;
2895 sub _condensed_description_generator {
2896 my ( $self, $format ) = ( shift, shift );
2898 my ( $f, $prefix, $suffix, $separator, $column ) =
2899 _condensed_generator_defaults($format);
2901 my $money_char = '$';
2902 if ($format eq 'latex') {
2903 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2905 $separator = " & \n";
2907 sub { my ($d,$a,$s,$w) = @_;
2908 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2910 $money_char = '\\dollar';
2911 }elsif ( $format eq 'html' ) {
2912 $prefix = '"><td align="center"></td>';
2916 sub { my ($d,$a,$s,$w) = @_;
2917 return qq!<td align="$html_align{$a}">$d</td>!;
2919 #$money_char = $conf->config('money_char') || '$';
2920 $money_char = ''; # this is madness
2928 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2930 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2932 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2933 map { $f->{$_}->[$i] } qw(align span width)
2937 $prefix. join( $separator, @result ). $suffix;
2942 sub _condensed_total_generator {
2943 my ( $self, $format ) = ( shift, shift );
2945 my ( $f, $prefix, $suffix, $separator, $column ) =
2946 _condensed_generator_defaults($format);
2949 if ($format eq 'latex') {
2952 $separator = " & \n";
2954 sub { my ($d,$a,$s,$w) = @_;
2955 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2957 }elsif ( $format eq 'html' ) {
2961 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2963 sub { my ($d,$a,$s,$w) = @_;
2964 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2973 # my $r = &{$f->{fields}->[$i]}(@args);
2974 # $r .= ' Total' unless $i;
2976 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2978 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2979 map { $f->{$_}->[$i] } qw(align span width)
2983 $prefix. join( $separator, @result ). $suffix;
2988 =item total_line_generator FORMAT
2990 Returns a coderef used for generation of invoice total line items for this
2991 usage_class. FORMAT is either html or latex
2995 # should not be used: will have issues with hash element names (description vs
2996 # total_item and amount vs total_amount -- another array of functions?
2998 sub _condensed_total_line_generator {
2999 my ( $self, $format ) = ( shift, shift );
3001 my ( $f, $prefix, $suffix, $separator, $column ) =
3002 _condensed_generator_defaults($format);
3005 if ($format eq 'latex') {
3008 $separator = " & \n";
3010 sub { my ($d,$a,$s,$w) = @_;
3011 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3013 }elsif ( $format eq 'html' ) {
3017 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3019 sub { my ($d,$a,$s,$w) = @_;
3020 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3029 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3031 &{$column}( &{$f->{fields}->[$i]}(@args),
3032 map { $f->{$_}->[$i] } qw(align span width)
3036 $prefix. join( $separator, @result ). $suffix;
3041 =item _items_pkg [ OPTIONS ]
3043 Return line item hashes for each package item on this invoice. Nearly
3046 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3048 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3049 'format' and 'escape_function' at minimum.
3051 To produce items for a specific invoice section, OPTIONS should include
3052 'section', a hashref containing 'category' and/or 'locationnum' keys.
3054 'section' may also contain a key named 'condensed'. If this is present
3055 and has a true value, _items_pkg will try to merge identical items into items
3056 with 'quantity' equal to the number of items (not the sum of their separate
3057 quantities, for some reason).
3063 # The order of these is important. Bundled line items will be merged into
3064 # the most recent non-hidden item, so it needs to be the one with:
3066 # - the same start date
3067 # - no pkgpart_override
3069 # So: sort by pkgnum,
3071 # then sort the base line item before any overrides
3072 # then sort hidden before non-hidden add-ons
3073 # then sort by override pkgpart (for consistency)
3074 sort { $a->pkgnum <=> $b->pkgnum or
3075 $a->sdate <=> $b->sdate or
3076 ($a->pkgpart_override ? 0 : -1) or
3077 ($b->pkgpart_override ? 0 : 1) or
3078 $b->hidden cmp $a->hidden or
3079 $a->pkgpart_override <=> $b->pkgpart_override
3081 # and of course exclude taxes and fees
3082 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3088 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3089 my $escape_function = $options{escape_function};
3092 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3093 # cache this, so we don't look it up again in every section
3094 my $part_fee = $cust_bill_pkg->get('part_fee')
3095 || $cust_bill_pkg->part_fee;
3096 $cust_bill_pkg->set('part_fee', $part_fee);
3098 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3099 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3102 if ( exists($options{section}) and exists($options{section}{category}) )
3104 my $categoryname = $options{section}{category};
3105 # then filter for items that have that section
3106 if ( $part_fee->categoryname ne $categoryname ) {
3107 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3110 } # otherwise include them all in the main section
3111 # XXX what to do when sectioning by location?
3114 my %base_invnums; # invnum => invoice date
3115 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3116 if ($_->base_invnum) {
3117 # XXX what if base_bill has been voided?
3118 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3119 my $base_date = $self->time2str_local('short', $base_bill->_date)
3121 $base_invnums{$_->base_invnum} = $base_date || '';
3124 foreach (sort keys(%base_invnums)) {
3125 next if $_ == $self->invnum;
3126 # per convention, we must escape ext_description lines
3128 &{$escape_function}(
3129 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3132 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3133 # but not escape the base description line
3135 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3136 if $options{section_with_taxes};
3139 { feepart => $cust_bill_pkg->feepart,
3140 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3141 description => $desc,
3142 pkg_tax => \@pkg_tax,
3143 ext_description => \@ext_desc,
3154 warn "$me _items_pkg searching for all package line items\n"
3157 my @cust_bill_pkg = $self->_items_nontax;
3159 warn "$me _items_pkg filtering line items\n"
3161 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3163 if ($options{section} && $options{section}->{condensed}) {
3165 warn "$me _items_pkg condensing section\n"
3169 local $Storable::canonical = 1;
3170 foreach ( @items ) {
3172 delete $item->{ref};
3173 delete $item->{ext_description};
3174 my $key = freeze($item);
3175 $itemshash{$key} ||= 0;
3176 $itemshash{$key} ++; # += $item->{quantity};
3178 @items = sort { $a->{description} cmp $b->{description} }
3179 map { my $i = thaw($_);
3180 $i->{quantity} = $itemshash{$_};
3182 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3188 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3195 return 0 unless $a->itemdesc cmp $b->itemdesc;
3196 return -1 if $b->itemdesc eq 'Tax';
3197 return 1 if $a->itemdesc eq 'Tax';
3198 return -1 if $b->itemdesc eq 'Other surcharges';
3199 return 1 if $a->itemdesc eq 'Other surcharges';
3200 $a->itemdesc cmp $b->itemdesc;
3205 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3206 $self->cust_bill_pkg;
3207 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3209 if ( $self->conf->exists('always_show_tax') ) {
3210 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3211 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3213 { 'description' => $itemdesc,
3220 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3222 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3223 list of hashrefs describing the line items they generate on the invoice.
3225 OPTIONS may include:
3227 format: the invoice format.
3229 escape_function: the function used to escape strings.
3231 DEPRECATED? (expensive, mostly unused?)
3232 format_function: the function used to format CDRs.
3234 section: a hashref containing 'category' and/or 'locationnum'; if this
3235 is present, only returns line items that belong to that category and/or
3236 location (whichever is defined).
3238 multisection: a flag indicating that this is a multisection invoice,
3239 which does something complicated.
3241 preref_callback: coderef run for each line item, code should return HTML to be
3242 displayed before that line item (quotations only)
3244 section_with_taxes: Look up and include applied taxes for each record
3246 Returns a list of hashrefs, each of which may contain:
3248 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3249 ext_description, which is an arrayref of detail lines to show below
3254 sub _items_cust_bill_pkg {
3256 my $conf = $self->conf;
3257 my $cust_bill_pkgs = shift;
3260 my $format = $opt{format} || '';
3261 my $escape_function = $opt{escape_function} || sub { shift };
3262 my $format_function = $opt{format_function} || '';
3263 my $no_usage = $opt{no_usage} || '';
3264 my $unsquelched = $opt{unsquelched} || ''; #unused
3265 my ($section, $locationnum, $category);
3266 if ( $opt{section} ) {
3267 $category = $opt{section}->{category};
3268 $locationnum = $opt{section}->{locationnum};
3270 my $summary_page = $opt{summary_page} || ''; #unused
3271 my $multisection = defined($category) || defined($locationnum);
3272 # this variable is the value of the config setting, not whether it applies
3273 # to this particular line item.
3274 my $discount_show_always = $conf->exists('discount-show-always');
3276 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3278 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3280 my $agentnum = $self->agentnum;
3282 # for location labels: use default location on the invoice date
3283 my $default_locationnum;
3284 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3285 $default_locationnum = 0; # treat them all as non-default
3286 } elsif ( $self->custnum ) {
3288 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3289 $h_cust_main = qsearchs({
3290 'table' => 'h_cust_main',
3291 'hashref' => { custnum => $self->custnum },
3292 'extra_sql' => $h_search[1],
3293 'addl_from' => $h_search[3],
3295 $default_locationnum = $h_cust_main->ship_locationnum;
3296 } elsif ( $self->prospectnum ) {
3297 my $cust_location = qsearchs('cust_location',
3298 { prospectnum => $self->prospectnum,
3300 $default_locationnum = $cust_location->locationnum if $cust_location;
3303 my @b = (); # accumulator for the line item hashes that we'll return
3304 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3305 # the 'current' line item hashes for setup, recur, usage, discount
3306 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3308 # if the current line item is waiting to go out, and the one we're about
3309 # to start is not bundled, then push out the current one and start a new
3311 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3312 if ( $_ && !$cust_bill_pkg->hidden ) {
3313 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3314 $_->{amount} =~ s/^\-0\.00$/0.00/;
3315 if (exists($_->{unit_amount})) {
3316 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3319 # we already decided to create this display line; don't reconsider it
3321 # if $_->{amount} != 0
3322 # || $discount_show_always
3323 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3324 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3330 if ( $locationnum ) {
3331 # this is a location section; skip packages that aren't at this
3333 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3334 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3338 # Consider display records for this item to determine if it belongs
3339 # in this section. Note that if there are no display records, there
3340 # will be a default pseudo-record that includes all charge types
3341 # and has no section name.
3342 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3343 ? $cust_bill_pkg->cust_bill_pkg_display
3344 : ( $cust_bill_pkg );
3346 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3347 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3350 if ( defined($category) ) {
3351 # then this is a package category section; process all display records
3352 # that belong to this section.
3353 @cust_bill_pkg_display = grep { $_->section eq $category }
3354 @cust_bill_pkg_display;
3356 # otherwise, process all display records that aren't usage summaries
3357 # (I don't think there should be usage summaries if you aren't using
3358 # category sections, but this is the historical behavior)
3359 @cust_bill_pkg_display = grep { !$_->summary }
3360 @cust_bill_pkg_display;
3363 my $classname = ''; # package class name, will fill in later
3365 foreach my $display (@cust_bill_pkg_display) {
3367 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3368 $display->billpkgdisplaynum. "\n"
3371 my $type = $display->type;
3373 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3374 $desc = substr($desc, 0, $maxlength). '...'
3375 if $format eq 'latex' && length($desc) > $maxlength;
3377 my %details_opt = ( 'format' => $format,
3378 'escape_function' => $escape_function,
3379 'format_function' => $format_function,
3380 'no_usage' => $opt{'no_usage'},
3383 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3384 if $opt{section_with_taxes};
3386 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3387 # XXX this should be pulled out into quotation_pkg
3389 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3391 # quotation_pkgs are never fees, so don't worry about the case where
3392 # part_pkg is undefined
3394 my @details = $cust_bill_pkg->details;
3396 # and I guess they're never bundled either?
3397 if (( $cust_bill_pkg->setup != 0 ) || ( $cust_bill_pkg->setup_show_zero )) {
3398 my $description = $desc;
3399 $description .= ' Setup'
3400 if $cust_bill_pkg->recur != 0
3401 || $discount_show_always
3402 || $cust_bill_pkg->recur_show_zero;
3404 # keep it consistent, please
3406 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3407 'description' => $description,
3408 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3409 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3410 'quantity' => $cust_bill_pkg->quantity,
3411 'pkg_tax' => \@pkg_tax,
3412 'ext_description' => \@details,
3413 'preref_html' => ( $opt{preref_callback}
3414 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3419 if (( $cust_bill_pkg->recur != 0 ) || ( $cust_bill_pkg->recur_show_zero )) {
3422 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3423 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3424 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3425 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3426 'quantity' => $cust_bill_pkg->quantity,
3427 'pkg_tax' => \@pkg_tax,
3428 'ext_description' => \@details,
3429 'preref_html' => ( $opt{preref_callback}
3430 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3436 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3437 # a "normal" package line item (not a quotation, not a fee, not a tax)
3439 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3442 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3443 my $part_pkg = $cust_pkg->part_pkg;
3445 # which pkgpart to show for display purposes?
3446 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3448 # start/end dates for invoice formats that do nonstandard
3450 my %item_dates = ();
3451 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3452 unless $part_pkg->option('disable_line_item_date_ranges',1);
3454 # not normally used, but pass this to the template anyway
3455 $classname = $part_pkg->classname;
3457 if ( (!$type || $type eq 'S')
3458 && ( $cust_bill_pkg->setup != 0
3459 || $cust_bill_pkg->setup_show_zero
3460 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3465 warn "$me _items_cust_bill_pkg adding setup\n"
3468 # append the word 'Setup' to the setup line if there's going to be
3469 # a recur line for the same package (i.e. not a one-time charge)
3471 my $description = $desc;
3472 $description .= ' Setup'
3473 if $cust_bill_pkg->recur != 0
3474 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3475 || $cust_bill_pkg->recur_show_zero;
3477 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3479 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3480 # triggered by the recurring charge freq
3482 && $cust_bill_pkg->recur == 0
3483 && ! $cust_bill_pkg->recur_show_zero;
3488 # always pass the svc_label through to the template, even if
3489 # not displaying it as an ext_description
3490 my @svc_labels = map &{$escape_function}($_),
3491 $cust_pkg->h_labels_short($self->_date,
3494 $self->conf->{locale},
3496 $svc_label = $svc_labels[0];
3498 unless ( $cust_pkg->part_pkg->hide_svc_detail
3499 || $cust_bill_pkg->hidden )
3502 push @d, @svc_labels
3503 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3504 # show the location label if it's not the customer's default
3505 # location, and we're not grouping items by location already
3506 if ( $cust_pkg->locationnum != $default_locationnum
3507 and !defined($locationnum) ) {
3508 my $loc = $cust_pkg->location_label;
3509 $loc = substr($loc, 0, $maxlength). '...'
3510 if $format eq 'latex' && length($loc) > $maxlength;
3511 push @d, &{$escape_function}($loc);
3514 } #unless hiding service details
3516 push @d, $cust_bill_pkg->details(%details_opt)
3517 if $cust_bill_pkg->recur == 0;
3519 if ( $cust_bill_pkg->hidden ) {
3520 $s->{amount} += $cust_bill_pkg->setup;
3521 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3522 push @{ $s->{ext_description} }, @d;
3526 description => $description,
3527 pkgpart => $pkgpart,
3528 pkgnum => $cust_bill_pkg->pkgnum,
3529 amount => $cust_bill_pkg->setup,
3530 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3531 unit_amount => $cust_bill_pkg->unitsetup,
3532 quantity => $cust_bill_pkg->quantity,
3533 pkg_tax => \@pkg_tax,
3534 ext_description => \@d,
3535 svc_label => ($svc_label || ''),
3536 locationnum => $cust_pkg->locationnum, # sure, why not?
3542 # should we show a recur line?
3543 # if type eq 'S', then NO, because we've been told not to.
3544 # otherwise, show the recur line if:
3545 # - there's a recurring charge
3546 # - or recur_show_zero is on
3547 # - or there's a positive unitrecur (so it's been discounted to zero)
3548 # and discount-show-always is on
3549 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3551 $cust_bill_pkg->recur != 0
3553 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3554 || $cust_bill_pkg->recur_show_zero
3559 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3562 my $is_summary = $display->summary;
3563 my $description = $desc;
3564 if ( $type eq 'U' and defined($r) ) {
3565 # don't just show the same description as the recur line
3566 $description = $self->mt('Usage charges');
3569 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3573 my @seconds = (); # for display of usage info
3576 #at least until cust_bill_pkg has "past" ranges in addition to
3577 #the "future" sdate/edate ones... see #3032
3578 my @dates = ( $self->_date );
3579 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3580 push @dates, $prev->sdate if $prev;
3581 push @dates, undef if !$prev;
3583 my @svc_labels = map &{$escape_function}($_),
3584 $cust_pkg->h_labels_short(@dates,
3586 $self->conf->{locale});
3587 $svc_label = $svc_labels[0];
3589 # show service labels, unless...
3590 # the package is set not to display them
3591 unless ( $part_pkg->hide_svc_detail
3592 # or this is a tax-like line item
3593 || $cust_bill_pkg->itemdesc
3594 # or this is a hidden (bundled) line item
3595 || $cust_bill_pkg->hidden
3596 # or this is a usage summary line
3597 || $is_summary && $type && $type eq 'U'
3598 # or this is a usage line and there's a recurring line
3599 # for the package in the same section (which will
3600 # have service labels already)
3601 || ($type eq 'U' and defined($r))
3605 warn "$me _items_cust_bill_pkg adding service details\n"
3608 push @d, @svc_labels
3609 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3610 warn "$me _items_cust_bill_pkg done adding service details\n"
3613 # show the location label if it's not the customer's default
3614 # location, and we're not grouping items by location already
3615 if ( $cust_pkg->locationnum != $default_locationnum
3616 and !defined($locationnum) ) {
3617 my $loc = $cust_pkg->location_label;
3618 $loc = substr($loc, 0, $maxlength). '...'
3619 if $format eq 'latex' && length($loc) > $maxlength;
3620 push @d, &{$escape_function}($loc);
3623 # Display of seconds_since_sqlradacct:
3624 # On the invoice, when processing @detail_items, look for a field
3625 # named 'seconds'. This will contain total seconds for each
3626 # service, in the same order as @ext_description. For services
3627 # that don't support this it will show undef.
3628 if ( $conf->exists('svc_acct-usage_seconds')
3629 and ! $cust_bill_pkg->pkgpart_override ) {
3630 foreach my $cust_svc (
3631 $cust_pkg->h_cust_svc(@dates, 'I')
3634 # eval because not having any part_export_usage exports
3635 # is a fatal error, last_bill/_date because that's how
3636 # sqlradius_hour billing does it
3638 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3640 push @seconds, $sec;
3642 } #if svc_acct-usage_seconds
3644 } # if we are showing service labels
3646 unless ( $is_summary ) {
3647 warn "$me _items_cust_bill_pkg adding details\n"
3650 #instead of omitting details entirely in this case (unwanted side
3651 # effects), just omit CDRs
3652 $details_opt{'no_usage'} = 1
3653 if $type && $type eq 'R';
3655 push @d, $cust_bill_pkg->details(%details_opt);
3658 warn "$me _items_cust_bill_pkg calculating amount\n"
3663 $amount = $cust_bill_pkg->recur;
3664 } elsif ($type eq 'R') {
3665 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3666 } elsif ($type eq 'U') {
3667 $amount = $cust_bill_pkg->usage;
3670 if ( !$type || $type eq 'R' ) {
3672 warn "$me _items_cust_bill_pkg adding recur\n"
3676 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3679 if ( $cust_bill_pkg->hidden ) {
3680 $r->{amount} += $amount;
3681 $r->{unit_amount} += $unit_amount;
3682 push @{ $r->{ext_description} }, @d;
3685 description => $description,
3686 pkgpart => $pkgpart,
3687 pkgnum => $cust_bill_pkg->pkgnum,
3689 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3690 unit_amount => $unit_amount,
3691 quantity => $cust_bill_pkg->quantity,
3692 pkg_tax => \@pkg_tax,
3694 ext_description => \@d,
3695 svc_label => ($svc_label || ''),
3696 locationnum => $cust_pkg->locationnum,
3698 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3701 } else { # $type eq 'U'
3703 warn "$me _items_cust_bill_pkg adding usage\n"
3706 if ( $cust_bill_pkg->hidden and defined($u) ) {
3707 # if this is a hidden package and there's already a usage
3708 # line for the bundle, add this package's total amount and
3709 # usage details to it
3710 $u->{amount} += $amount;
3711 push @{ $u->{ext_description} }, @d;
3712 } elsif ( $amount ) {
3713 # create a new usage line
3715 description => $description,
3716 pkgpart => $pkgpart,
3717 pkgnum => $cust_bill_pkg->pkgnum,
3720 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3721 pkg_tax => \@pkg_tax,
3723 ext_description => \@d,
3724 locationnum => $cust_pkg->locationnum,
3726 } # else this has no usage, so don't create a usage section
3729 } # recurring or usage with recurring charge
3731 } else { # taxes and fees
3733 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3736 # items of this kind should normally not have sdate/edate.
3738 'description' => $desc,
3739 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3740 + $cust_bill_pkg->recur)
3743 } # if quotation / package line item / other line item
3745 # decide whether to show active discounts here
3747 # case 1: we are showing a single line for the package
3749 # case 2: we are showing a setup line for a package that has
3750 # no base recurring fee
3751 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3752 # case 3: we are showing a recur line for a package that has
3753 # a base recurring fee
3754 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3757 my $item_discount = $cust_bill_pkg->_item_discount;
3758 if ( $item_discount ) {
3759 # $item_discount->{amount} is negative
3761 if ( $d and $cust_bill_pkg->hidden ) {
3762 $d->{amount} += $item_discount->{amount};
3764 $d = $item_discount;
3765 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3768 # update the active line (before the discount) to show the
3769 # original price (whether this is a hidden line or not)
3771 # quotation discounts keep track of setup and recur; invoice
3772 # discounts currently don't
3773 if ( exists $item_discount->{setup_amount} ) {
3775 $s->{amount} -= $item_discount->{setup_amount} if $s;
3776 $r->{amount} -= $item_discount->{recur_amount} if $r;
3780 # $active_line is the line item hashref for the line that will
3781 # show the original price
3782 # (use the recur or single line for the package, unless we're
3783 # showing a setup line for a package with no recurring fee)
3784 my $active_line = $r;
3785 if ( $type eq 'S' ) {
3788 $active_line->{amount} -= $item_discount->{amount};
3792 } # if there are any discounts
3793 } # if this is an appropriate place to show discounts
3795 } # foreach $display
3799 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3801 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3802 if exists($_->{amount});
3803 $_->{amount} =~ s/^\-0\.00$/0.00/;
3804 if (exists($_->{unit_amount})) {
3805 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3809 #if $_->{amount} != 0
3810 # || $discount_show_always
3811 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3812 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3816 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3823 =item _items_discounts_avail
3825 Returns an array of line item hashrefs representing available term discounts
3826 for this invoice. This makes the same assumptions that apply to term
3827 discounts in general: that the package is billed monthly, at a flat rate,
3828 with no usage charges. A prorated first month will be handled, as will
3829 a setup fee if the discount is allowed to apply to setup fees.
3833 sub _items_discounts_avail {
3836 #maybe move this method from cust_bill when quotations support discount_plans
3837 return () unless $self->can('discount_plans');
3838 my %plans = $self->discount_plans;
3840 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3841 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3845 my $plan = $plans{$months};
3847 my $term_total = sprintf('%.2f', $plan->discounted_total);
3848 my $percent = sprintf('%.0f',
3849 100 * (1 - $term_total / $plan->base_total) );
3850 my $permonth = sprintf('%.2f', $term_total / $months);
3851 my $detail = $self->mt('discount on item'). ' '.
3852 join(', ', map { "#$_" } $plan->pkgnums)
3855 # discounts for non-integer months don't work anyway
3856 $months = sprintf("%d", $months);
3859 description => $self->mt('Save [_1]% by paying for [_2] months',
3861 amount => $self->mt('[_1] ([_2] per month)',
3862 $term_total, $money_char.$permonth),
3863 ext_description => ($detail || ''),
3866 sort { $b <=> $a } keys %plans;
3870 =item has_sections AGENTNUM
3872 Return true if invoice_sections should be enabled for this bill.
3873 (Inherited by both cust_bill and cust_bill_void)
3876 * False if not an invoice
3877 * True always if conf invoice_sections is enabled
3878 * True always if sections_by_location is enabled
3879 * True if conf invoice_sections_multilocation > 1,
3880 and location_count >= invoice_sections_multilocation
3886 my ($self, $agentnum) = @_;
3888 return 0 unless $self->invnum > 0;
3890 $agentnum ||= $self->agentnum;
3891 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3892 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3894 my $location_min = $self->conf->config(
3895 'invoice_sections_multilocation', $agentnum,
3900 && $self->location_count >= $location_min;
3906 =item location_count
3908 Return the number of locations billed on this invoice
3912 sub location_count {
3914 return 0 unless $self->invnum;
3916 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3917 # FROM cust_bill_pkg
3918 # LEFT JOIN cust_pkg USING (pkgnum)
3919 # WHERE invnum = 278
3920 # AND cust_bill_pkg.pkgnum > 0
3922 my $result = qsearchs({
3923 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3924 table => 'cust_bill_pkg',
3925 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3926 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3927 . ' AND cust_bill_pkg.pkgnum > 0'
3929 ref $result ? $result->location_count : 0;