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 if ( $multisection ) {
941 $invoice_data{multisection} = $conf->config($tc.'sections_method') || 1;
943 my $section_with_taxes = 1
944 if $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
946 my $extra_sections = [];
947 my $extra_lines = ();
949 # default section ('Charges')
950 my $default_section = { 'description' => '',
955 # Previous Charges section
956 # subtotal is the first return value from $self->previous
957 my $previous_section;
958 # if the invoice has major sections, or if we're summarizing previous
959 # charges with a single line, or if we've been specifically told to put them
960 # in a section, create a section for previous charges:
961 if ( $multisection or
962 $conf->exists('previous_balance-summary_only') or
963 $conf->exists('previous_balance-section') ) {
965 $previous_section = { 'description' => $self->mt('Previous Charges'),
966 'subtotal' => $other_money_char.
967 sprintf('%.2f', $pr_total),
968 'summarized' => '', #why? $summarypage ? 'Y' : '',
970 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
971 join(' / ', map { $cust_main->balance_date_range(@$_) }
972 $self->_prior_month30s
974 if $conf->exists('invoice_include_aging');
977 # otherwise put them in the main section
978 $previous_section = $default_section;
981 my $adjust_section = {
982 'description' => $self->mt('Credits, Payments, and Adjustments'),
983 'adjust_section' => 1,
984 'subtotal' => 0, # adjusted below
986 my $adjust_weight = _pkg_category($adjust_section->{description})
987 ? _pkg_category($adjust_section->{description})->weight
989 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
990 # Note: 'sort_weight' here is actually a flag telling whether there is an
991 # explicit package category for the adjust section. If so, certain behavior
993 $adjust_section->{'sort_weight'} = $adjust_weight;
996 if ( $multisection ) {
997 ($extra_sections, $extra_lines) =
998 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
999 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
1000 && $self->can('_items_extra_usage_sections');
1002 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1004 push @detail_items, @$extra_lines if $extra_lines;
1006 # the code is written so that both methods can be used together, but
1007 # we haven't yet changed the template to take advantage of that, so for
1008 # now, treat them as mutually exclusive.
1009 my %section_method = ( by_category => 1 );
1010 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1011 %section_method = ( by_location => 1 );
1013 my ($early, $late) =
1014 $self->_items_sections( 'summary' => $summarypage,
1015 'escape' => $escape_function_nonbsp,
1016 'extra_sections' => $extra_sections,
1017 'format' => $format,
1020 push @sections, @$early;
1021 $late_sections = $late;
1023 if ( $conf->exists('svc_phone_sections')
1024 && $self->can('_items_svc_phone_sections')
1027 my ($phone_sections, $phone_lines) =
1028 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1029 push @{$late_sections}, @$phone_sections;
1030 push @detail_items, @$phone_lines;
1032 if ( $conf->exists('voip-cust_accountcode_cdr')
1033 && $cust_main->accountcode_cdr
1034 && $self->can('_items_accountcode_cdr')
1037 my ($accountcode_section, $accountcode_lines) =
1038 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1039 if ( scalar(@$accountcode_lines) ) {
1040 push @{$late_sections}, $accountcode_section;
1041 push @detail_items, @$accountcode_lines;
1044 } else {# not multisection
1045 # make a default section
1046 push @sections, $default_section;
1047 # and calculate the finance charge total, since it won't get done otherwise.
1048 # and the default section total
1049 # XXX possibly finance_pkgclass should not be used in this manner?
1050 my @finance_charges;
1052 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1053 if ( $invoice_data{finance_section} and
1054 grep { $_->section eq $invoice_data{finance_section} }
1055 $cust_bill_pkg->cust_bill_pkg_display ) {
1056 # I think these are always setup fees, but just to be sure...
1057 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1059 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1062 $invoice_data{finance_amount} =
1063 sprintf('%.2f', sum( @finance_charges ) || 0);
1064 $default_section->{subtotal} = $other_money_char.
1065 sprintf('%.2f', sum( @charges ) || 0);
1068 # start setting up summary subtotals
1069 my @summary_subtotals;
1070 my $method = $conf->config('summary_subtotals_method');
1071 if ( ( ref($self) ne 'FS::quotation' ) and $method and $method ne $conf->config($tc.'sections_method') ) {
1072 # then re-section them by the correct method
1073 my %section_method = ( by_category => 1 );
1074 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1075 %section_method = ( by_location => 1 );
1077 my ($early, $late) =
1078 $self->_items_sections( 'summary' => $summarypage,
1079 'escape' => $escape_function_nonbsp,
1080 'extra_sections' => $extra_sections,
1081 'format' => $format,
1084 foreach ( @$early ) {
1085 next if $_->{subtotal} == 0;
1086 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1087 push @summary_subtotals, $_;
1090 # subtotal sectioning is the same as for the actual invoice sections
1091 @summary_subtotals = grep $_->{subtotal}, @sections;
1094 # Hereafter, push sections to both @sections and @summary_subtotals
1095 # if they belong in both places (e.g. tax section). Late sections are
1096 # never in @summary_subtotals.
1098 # previous invoice balances in the Previous Charges section if there
1099 # is one, otherwise in the main detail section
1100 # (except if summary_only is enabled, don't show them at all)
1101 if ( $self->can('_items_previous') &&
1102 $self->enable_previous &&
1103 ! $conf->exists('previous_balance-summary_only') ) {
1105 warn "$me adding previous balances\n"
1108 foreach my $line_item ( $self->_items_previous ) {
1111 ref => $line_item->{'pkgnum'},
1112 pkgpart => $line_item->{'pkgpart'},
1113 #quantity => 1, # not really correct
1114 section => $previous_section, # which might be $default_section
1115 description => &$escape_function($line_item->{'description'}),
1116 ext_description => [ map { &$escape_function($_) }
1117 @{ $line_item->{'ext_description'} || [] }
1119 amount => $money_char . $line_item->{'amount'},
1120 product_code => $line_item->{'pkgpart'} || 'N/A',
1123 push @detail_items, $detail;
1124 push @buf, [ $detail->{'description'},
1125 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1131 if ( @pr_cust_bill && $self->enable_previous ) {
1132 push @buf, ['','-----------'];
1133 push @buf, [ $self->mt('Total Previous Balance'),
1134 $money_char. sprintf("%10.2f", $pr_total) ];
1138 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1139 warn "$me adding DID summary\n"
1142 my ($didsummary,$minutes) = $self->_did_summary;
1143 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1145 { 'description' => $didsummary_desc,
1146 'ext_description' => [ $didsummary, $minutes ],
1150 foreach my $section (@sections, @$late_sections) {
1152 # begin some normalization
1153 $section->{'subtotal'} = $section->{'amount'}
1155 && !exists($section->{subtotal})
1156 && exists($section->{amount});
1158 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1159 if ( $invoice_data{finance_section} &&
1160 $section->{'description'} eq $invoice_data{finance_section} );
1162 if ( $multisection ) {
1164 if ( ref($section->{'subtotal'}) ) {
1166 $section->{'subtotal'} =
1167 sprintf("$other_money_char%.2f to $other_money_char%.2f",
1168 $section->{'subtotal'}[0],
1169 $section->{'subtotal'}[1]
1174 $section->{'subtotal'} = $other_money_char.
1175 sprintf('%.2f', $section->{'subtotal'})
1179 # continue some normalization
1180 $section->{'amount'} = $section->{'subtotal'}
1184 if ( $section->{'description'} ) {
1185 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1190 warn "$me setting options\n"
1194 $options{'section'} = $section if $multisection;
1195 $options{'section_with_taxes'} = 1
1197 && $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
1198 $options{'format'} = $format;
1199 $options{'escape_function'} = $escape_function;
1200 $options{'no_usage'} = 1 unless $unsquelched;
1201 $options{'unsquelched'} = $unsquelched;
1202 $options{'summary_page'} = $summarypage;
1203 $options{'skip_usage'} =
1204 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1205 $options{'preref_callback'} = $params{'preref_callback'};
1206 $options{'disable_line_item_date_ranges'} =
1207 $conf->exists('disable_line_item_date_ranges');
1209 warn "$me searching for line items\n"
1212 my %section_tax_lines;
1215 foreach my $line_item ( $self->_items_pkg(%options),
1216 $self->_items_fee(%options) ) {
1218 warn "$me adding line item ".
1219 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1222 push @buf, ( [ $line_item->{'description'},
1223 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1225 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1228 $line_item->{'ref'} = $line_item->{'pkgnum'};
1229 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1230 $line_item->{'section'} = $section;
1231 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1232 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1234 if ( length($line_item->{'unit_amount'}) ) {
1235 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1237 $line_item->{'ext_description'} ||= [];
1239 if ( $section_with_taxes && ref $line_item->{pkg_tax} ) {
1240 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1242 # It is rarely possible for the same tax record to be presented here
1243 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1244 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1245 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1247 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1251 push @detail_items, $line_item;
1254 # If conf flag invoice_sections_with_taxes:
1255 # - Add @detail_items for taxes into each section
1256 # - Update section subtotal to include taxes
1257 if ( $section_with_taxes && %section_tax_lines ) {
1258 for my $taxname ( keys %section_tax_lines ) {
1260 push @detail_items, {
1261 section => $section,
1262 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1263 description => &$escape_function($taxname),
1266 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1267 # append to the second value.
1268 if ($section->{subtotal} =~ /to/) {
1269 my @subtotal = split /\s/, $section->{subtotal};
1270 $subtotal[2] =~ s/[^\d\.]//g;
1271 $subtotal[2] = sprintf(
1273 ( $subtotal[2] + $section_tax_lines{$taxname} )
1275 $section->{subtotal} = join ' ', @subtotal;
1277 $section->{subtotal} =~ s/[^\d\.]//g;
1278 $section->{subtotal} = sprintf(
1279 $money_char . "%.2f",
1280 ( $section->{subtotal} + $section_tax_lines{$taxname} )
1287 if ( $section->{'description'} ) {
1288 push @buf, ( ['','-----------'],
1289 [ $section->{'description'}. ' sub-total',
1290 $section->{'subtotal'} # already formatted this
1299 $invoice_data{current_less_finance} =
1300 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1302 # if there's anything in the Previous Charges section, prepend it to the list
1303 if ( $pr_total and $previous_section ne $default_section ) {
1304 unshift @sections, $previous_section;
1305 # but not @summary_subtotals
1308 warn "$me adding taxes\n"
1311 # create a tax section if we don't yet have one
1312 my $tax_description = 'Taxes, Surcharges, and Fees';
1314 List::Util::first { $_->{description} eq $tax_description } @sections;
1315 if (!$tax_section) {
1316 $tax_section = { 'description' => $tax_description };
1317 push @sections, $tax_section if $multisection;
1319 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1320 # if this is an existing tax section, we're merging the tax items into it.
1321 # grab the taxtotal that's already there, strip the money symbol if any
1322 my $taxtotal = $tax_section->{'subtotal'} || 0;
1323 $taxtotal =~ s/^\Q$other_money_char\E//;
1326 #my $tax_weight = _pkg_category($tax_section->{description})
1327 # ? _pkg_category($tax_section->{description})->weight
1329 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1330 #$tax_section->{'sort_weight'} = $tax_weight;
1332 my @items_tax = $self->_items_tax;
1333 foreach my $tax ( @items_tax ) {
1335 $taxtotal += $tax->{'amount'};
1337 my $description = &$escape_function( $tax->{'description'} );
1338 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1340 if ( $multisection ) {
1342 push @detail_items, {
1343 ext_description => [],
1346 description => $description,
1347 amount => $money_char. $amount,
1349 section => $tax_section,
1354 push @total_items, {
1355 'total_item' => $description,
1356 'total_amount' => $other_money_char. $amount,
1361 push @buf,[ $description,
1362 $money_char. $amount,
1369 $total->{'total_item'} = $self->mt('Sub-total');
1370 $total->{'total_amount'} =
1371 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1373 if ( $multisection ) {
1374 if ( $taxtotal > 0 ) {
1375 # there are taxes, so prepare the section to be displayed.
1376 # $taxtotal already includes any line items that were already in the
1377 # section (fees, taxes that are charged as packages for some reason).
1378 # also set 'summarized' to false so that this isn't a summary-only
1380 $tax_section->{'subtotal'} = $other_money_char.
1381 sprintf('%.2f', $taxtotal);
1382 $tax_section->{'pretotal'} = 'New charges sub-total '.
1383 $total->{'total_amount'};
1384 $tax_section->{'description'} = $self->mt($tax_description);
1385 $tax_section->{'summarized'} = '';
1387 if ( $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum) ) {
1389 # remove tax section if taxes are itemized within other sections
1390 @sections = grep{ $_ ne $tax_section } @sections;
1392 } elsif ( !grep $tax_section, @sections ) {
1394 # append it if it's not already there
1395 push @sections, $tax_section;
1396 push @summary_subtotals, $tax_section;
1403 unshift @total_items, $total;
1406 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1412 my %embolden_functions = (
1413 'latex' => sub { return '\textbf{'. shift(). '}' },
1414 'html' => sub { return '<b>'. shift(). '</b>' },
1415 'template' => sub { shift },
1417 my $embolden_function = $embolden_functions{$format};
1419 if ( $multisection ) {
1421 if ( $adjust_section->{'sort_weight'} ) {
1422 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1423 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1425 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1426 $other_money_char. sprintf('%.2f', $self->charged );
1431 if ( $self->can('_items_total') ) { # should always be true now
1433 # even for multisection, need plain text version
1435 my @new_total_items = $self->_items_total;
1437 push @buf,['','-----------'];
1439 foreach ( @new_total_items ) {
1440 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1441 $_->{'total_item'} = &$embolden_function( $item );
1443 if ( ref($amount) ) {
1444 $_->{'total_amount'} = &$embolden_function(
1445 $other_money_char.$amount->[0]. ' to '.
1446 $other_money_char.$amount->[1]
1449 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1452 # but if it's multisection, don't append to @total_items. the adjust
1453 # section has all this stuff
1454 push @total_items, $_ if !$multisection;
1455 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1458 push @buf, [ '', '' ];
1460 # if we're showing previous invoices, also show previous
1461 # credits and payments
1462 if ( $self->enable_previous
1463 and $self->can('_items_credits')
1464 and $self->can('_items_payments') )
1468 my $credittotal = 0;
1469 foreach my $credit (
1470 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1474 $total->{'total_item'} = &$escape_function($credit->{'description'});
1475 $credittotal += $credit->{'amount'};
1476 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1477 if ( $multisection ) {
1478 push @detail_items, {
1479 ext_description => [],
1482 description => &$escape_function($credit->{'description'}),
1483 amount => $money_char . $credit->{'amount'},
1485 section => $adjust_section,
1488 push @total_items, $total;
1492 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1495 foreach my $credit (
1496 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1498 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1502 my $paymenttotal = 0;
1503 foreach my $payment (
1504 $self->_items_payments( 'template' => $template )
1507 $total->{'total_item'} = &$escape_function($payment->{'description'});
1508 $paymenttotal += $payment->{'amount'};
1509 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1510 if ( $multisection ) {
1511 push @detail_items, {
1512 ext_description => [],
1515 description => &$escape_function($payment->{'description'}),
1516 amount => $money_char . $payment->{'amount'},
1518 section => $adjust_section,
1521 push @total_items, $total;
1523 push @buf, [ $payment->{'description'},
1524 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1527 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1529 if ( $multisection ) {
1530 $adjust_section->{'subtotal'} = $other_money_char.
1531 sprintf('%.2f', $credittotal + $paymenttotal);
1533 #why this? because {sort_weight} forces the adjust_section to appear
1534 #in @extra_sections instead of @sections. obviously.
1535 push @sections, $adjust_section
1536 unless $adjust_section->{sort_weight};
1537 # do not summarize; adjustments there are shown according to
1541 # create Balance Due message
1544 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1545 $total->{'total_amount'} =
1546 &$embolden_function(
1547 $other_money_char. sprintf('%.2f', #why? $summarypage
1548 # ? $self->charged +
1549 # $self->billing_balance
1551 $self->owed + $pr_total
1554 if ( $multisection && !$adjust_section->{sort_weight} ) {
1555 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1556 $total->{'total_amount'};
1558 push @total_items, $total;
1560 push @buf,['','-----------'];
1561 push @buf,[$self->balance_due_msg, $money_char.
1562 sprintf("%10.2f", $balance_due ) ];
1565 if ( $conf->exists('previous_balance-show_credit')
1566 and $cust_main->balance < 0 ) {
1567 my $credit_total = {
1568 'total_item' => &$embolden_function($self->credit_balance_msg),
1569 'total_amount' => &$embolden_function(
1570 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1573 if ( $multisection ) {
1574 $adjust_section->{'posttotal'} .= $newline_token .
1575 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1578 push @total_items, $credit_total;
1580 push @buf,['','-----------'];
1581 push @buf,[$self->credit_balance_msg, $money_char.
1582 sprintf("%10.2f", -$cust_main->balance ) ];
1586 } #end of default total adding ! can('_items_total')
1588 if ( $multisection ) {
1589 if ( $conf->exists('svc_phone_sections')
1590 && $self->can('_items_svc_phone_sections')
1594 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1595 $total->{'total_amount'} =
1596 &$embolden_function(
1597 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1599 my $last_section = pop @sections;
1600 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1601 $total->{'total_amount'};
1602 push @sections, $last_section;
1604 push @sections, @$late_sections
1608 # make a discounts-available section, even without multisection
1609 if ( $conf->exists('discount-show_available')
1610 and my @discounts_avail = $self->_items_discounts_avail ) {
1611 my $discount_section = {
1612 'description' => $self->mt('Discounts Available'),
1617 push @sections, $discount_section; # do not summarize
1618 push @detail_items, map { +{
1619 'ref' => '', #should this be something else?
1620 'section' => $discount_section,
1621 'description' => &$escape_function( $_->{description} ),
1622 'amount' => $money_char . &$escape_function( $_->{amount} ),
1623 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1624 } } @discounts_avail;
1627 # not adding any more sections after this
1628 $invoice_data{summary_subtotals} = \@summary_subtotals;
1631 if ( $conf->exists('usage_class_summary')
1632 and $self->can('_items_usage_class_summary') ) {
1633 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1634 if ( @usage_subtotals ) {
1635 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1636 unshift @detail_items, @usage_subtotals;
1640 # invoice history "section" (not really a section)
1641 # not to be included in any subtotals, completely independent of
1643 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1646 foreach my $cust_bill ( $cust_main->cust_bill ) {
1647 # XXX hardcoded format, and currently only 'charged'; add other fields
1648 # if they become necessary
1649 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1650 $history{$date} ||= 0;
1651 $history{$date} += $cust_bill->charged;
1652 # just so we have a numeric sort key
1653 $monthorder{$date} ||= $cust_bill->_date;
1655 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1657 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1658 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1661 # service locations: another option for template customization
1663 foreach my $item (@detail_items) {
1664 if ( $item->{locationnum} ) {
1665 $location_info{ $item->{locationnum} } ||= {
1666 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1670 $invoice_data{location_info} = \%location_info;
1672 # debugging hook: call this with 'diag' => 1 to just get a hash of
1673 # the invoice variables
1674 return \%invoice_data if ( $params{'diag'} );
1676 # All sections and items are built; now fill in templates.
1677 my @includelist = ();
1678 push @includelist, 'summary' if $summarypage;
1679 foreach my $include ( @includelist ) {
1681 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1684 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1686 @inc_src = $conf->config($inc_file, $agentnum);
1690 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1692 my $convert_map = $convert_maps{$format}{$include};
1694 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1695 s/--\@\]/$delimiters{$format}[1]/g;
1698 &$convert_map( $conf->config($inc_file, $agentnum) );
1702 my $inc_tt = new Text::Template (
1704 SOURCE => [ map "$_\n", @inc_src ],
1705 DELIMITERS => $delimiters{$format},
1706 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1708 unless ( $inc_tt->compile() ) {
1709 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1710 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1714 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1716 $invoice_data{$include} =~ s/\n+$//
1717 if ($format eq 'latex');
1722 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1723 /invoice_lines\((\d*)\)/;
1724 $invoice_lines += $1 || scalar(@buf);
1727 die "no invoice_lines() functions in template?"
1728 if ( $format eq 'template' && !$wasfunc );
1730 if ( $invoice_lines ) {
1731 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1732 $invoice_data{'total_pages'}++
1733 if scalar(@buf) % $invoice_lines;
1736 #setup subroutine for the template
1737 $invoice_data{invoice_lines} = sub {
1738 my $lines = shift || scalar(@buf);
1747 if ($format eq 'template') {
1752 push @collect, split("\n",
1753 $text_template->fill_in( HASH => \%invoice_data )
1755 $invoice_data{'page'}++;
1757 map "$_\n", @collect;
1759 } else { # this is where we actually create the invoice
1761 if ( $params{no_addresses} ) {
1762 delete $invoice_data{$_} foreach qw(
1763 payname company address1 address2 city state zip country
1765 $invoice_data{returnaddress} = '~';
1768 warn "filling in template for invoice ". $self->invnum. "\n"
1770 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1773 $text_template->fill_in(HASH => \%invoice_data);
1777 sub notice_name { '('.shift->table.')'; }
1779 sub template_conf { 'invoice_'; }
1781 # helper routine for generating date ranges
1782 sub _prior_month30s {
1785 [ 1, 2592000 ], # 0-30 days ago
1786 [ 2592000, 5184000 ], # 30-60 days ago
1787 [ 5184000, 7776000 ], # 60-90 days ago
1788 [ 7776000, 0 ], # 90+ days ago
1791 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1792 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1797 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1799 Returns an postscript invoice, as a scalar.
1801 Options can be passed as a hashref (recommended) or as a list of time, template
1802 and then any key/value pairs for any other options.
1804 I<time> an optional value used to control the printing of overdue messages. The
1805 default is now. It isn't the date of the invoice; that's the `_date' field.
1806 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1807 L<Time::Local> and L<Date::Parse> for conversion functions.
1809 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1816 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1817 my $ps = generate_ps($file);
1819 unlink($barcodefile) if $barcodefile;
1824 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1826 Returns an PDF invoice, as a scalar.
1828 Options can be passed as a hashref (recommended) or as a list of time, template
1829 and then any key/value pairs for any other options.
1831 I<time> an optional value used to control the printing of overdue messages. The
1832 default is now. It isn't the date of the invoice; that's the `_date' field.
1833 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1834 L<Time::Local> and L<Date::Parse> for conversion functions.
1836 I<template>, if specified, is the name of a suffix for alternate invoices.
1838 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1845 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1846 my $pdf = generate_pdf($file);
1848 unlink($barcodefile) if $barcodefile;
1853 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1855 Returns an HTML invoice, as a scalar.
1857 I<time> an optional value used to control the printing of overdue messages. The
1858 default is now. It isn't the date of the invoice; that's the `_date' field.
1859 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1860 L<Time::Local> and L<Date::Parse> for conversion functions.
1862 I<template>, if specified, is the name of a suffix for alternate invoices.
1864 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1866 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1867 when emailing the invoice as part of a multipart/related MIME email.
1875 %params = %{ shift() };
1879 $params{'format'} = 'html';
1881 $self->print_generic( %params );
1884 # quick subroutine for print_latex
1886 # There are ten characters that LaTeX treats as special characters, which
1887 # means that they do not simply typeset themselves:
1888 # # $ % & ~ _ ^ \ { }
1890 # TeX ignores blanks following an escaped character; if you want a blank (as
1891 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1895 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1896 $value =~ s/([<>])/\$$1\$/g;
1902 encode_entities($value);
1906 sub _html_escape_nbsp {
1907 my $value = _html_escape(shift);
1908 $value =~ s/ +/ /g;
1912 #utility methods for print_*
1914 sub _translate_old_latex_format {
1915 warn "_translate_old_latex_format called\n"
1922 if ( $line =~ /^%%Detail\s*$/ ) {
1924 push @template, q![@--!,
1925 q! foreach my $_tr_line (@detail_items) {!,
1926 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1927 q! $_tr_line->{'description'} .= !,
1928 q! "\\tabularnewline\n~~".!,
1929 q! join( "\\tabularnewline\n~~",!,
1930 q! @{$_tr_line->{'ext_description'}}!,
1934 while ( ( my $line_item_line = shift )
1935 !~ /^%%EndDetail\s*$/ ) {
1936 $line_item_line =~ s/'/\\'/g; # nice LTS
1937 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1938 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1939 push @template, " \$OUT .= '$line_item_line';";
1942 push @template, '}',
1945 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1947 push @template, '[@--',
1948 ' foreach my $_tr_line (@total_items) {';
1950 while ( ( my $total_item_line = shift )
1951 !~ /^%%EndTotalDetails\s*$/ ) {
1952 $total_item_line =~ s/'/\\'/g; # nice LTS
1953 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1954 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1955 push @template, " \$OUT .= '$total_item_line';";
1958 push @template, '}',
1962 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1963 push @template, $line;
1969 warn "$_\n" foreach @template;
1981 my $conf = $self->conf;
1983 #check for an invoice-specific override
1984 return $self->invoice_terms if $self->invoice_terms;
1986 #check for a customer- specific override
1987 my $cust_main = $self->cust_main;
1988 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1992 $agentnum = $cust_main->agentnum;
1993 } elsif ( my $prospect_main = $self->prospect_main ) {
1994 $agentnum = $prospect_main->agentnum;
1997 #use configured default
1998 $conf->config('invoice_default_terms', $agentnum) || '';
2008 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2009 $duedate = $self->_date() + ( $1 * 86400 );
2010 } elsif ( $self->terms =~ /^End of Month$/ ) {
2011 my ($mon,$year) = (localtime($self->_date) )[4,5];
2013 until ( $mon < 12 ) { $mon -= 12; $year++; }
2014 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2015 $duedate = $nextmonth_first - 86400;
2026 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2029 =item balance_due_msg
2033 sub balance_due_msg {
2035 my $msg = $self->mt('Balance Due');
2036 return $msg unless $self->terms; # huh?
2037 if ( !$self->conf->exists('invoice_show_prior_due_date')
2038 || $self->has_sections ) {
2039 # if enabled, the due date is shown with Total New Charges (see
2040 # _items_total) and not here
2041 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2042 if ( $self->due_date ) {
2044 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2045 || 'Please pay by [_1]';
2046 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')).
2048 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2049 } elsif ( $self->terms ) {
2050 $msg .= ' - '. $self->mt($self->terms);
2056 =item balance_due_date
2060 sub balance_due_date {
2062 my $conf = $self->conf;
2064 my $terms = $self->terms;
2065 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2066 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2071 sub credit_balance_msg {
2073 $self->mt('Credit Balance Remaining')
2078 Returns a string with the date, for example: "3/20/2008", localized for the
2079 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2085 $self->time2str_local('short', $self->_date);
2088 =item _date_pretty_unlocalized
2090 Returns a string with the date, for example: "3/20/2008", in the format
2091 configured for the back-office. Use _date_pretty for end-customer display use.
2095 sub _date_pretty_unlocalized {
2097 time2str($date_format, $self->_date);
2102 Emails this template.
2104 Options are passed as a hashref. Available options:
2110 If specified, overrides the default From: address.
2114 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2118 (Deprecated) If specified, is the name of a suffix for alternate template files.
2122 Options accepted by generate_email can also be used.
2128 my $opt = shift || {};
2129 if ($opt and !ref($opt)) {
2130 die ref($self). '->email called with positional parameters';
2133 return if $self->hide;
2135 my $error = send_email(
2136 $self->generate_email(
2137 'subject' => $self->email_subject($opt->{template}),
2138 %$opt, # template, etc.
2142 die "can't email: $error\n" if $error;
2145 =item generate_email OPTION => VALUE ...
2153 sender address, required
2157 alternate template name, optional
2161 email subject, optional
2165 notice name instead of "Invoice", optional
2169 Returns an argument list to be passed to L<FS::Misc::send_email>.
2176 sub generate_email {
2180 my $conf = $self->conf;
2182 my $me = '[FS::Template_Mixin::generate_email]';
2185 'from' => $args{'from'},
2186 'subject' => ($args{'subject'} || $self->email_subject),
2187 'custnum' => $self->custnum,
2188 'msgtype' => 'invoice',
2191 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2193 my $cust_main = $self->cust_main;
2195 if (ref($args{'to'}) eq 'ARRAY') {
2196 $return{'to'} = $args{'to'};
2197 } elsif ( $cust_main ) {
2198 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2201 my $tc = $self->template_conf;
2203 my @text; # array of lines
2204 my $html; # a big string
2205 my @related_parts; # will contain the text/HTML alternative, and images
2206 my $related; # will contain the multipart/related object
2208 if ( $conf->exists($tc. 'email_pdf') ) {
2209 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2211 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2214 my $msg_template = FS::msg_template->by_key($msgnum)
2215 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2216 my %prepared = $msg_template->prepare(
2217 cust_main => $self->cust_main,
2221 @text = split(/(?=\n)/, $prepared{'text_body'});
2222 $html = $prepared{'html_body'};
2224 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2226 warn "$me using '${tc}email_pdf_note' in multipart message"
2228 @text = $conf->config($tc.'email_pdf_note');
2229 $html = join('<BR>', @text);
2231 } # else use the plain text invoice
2236 if ( $conf->config($tc.'template') ) {
2238 warn "$me generating plain text invoice"
2241 # 'print_text' argument is no longer used
2242 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2246 warn "$me no plain text version exists; sending empty message body"
2253 my $text_part = build MIME::Entity (
2254 'Type' => 'text/plain',
2255 'Encoding' => 'quoted-printable',
2256 'Charset' => 'UTF-8',
2257 #'Encoding' => '7bit',
2259 'Disposition' => 'inline',
2264 if ( $conf->exists($tc.'html') ) {
2265 warn "$me generating HTML invoice"
2268 $args{'from'} =~ /\@([\w\.\-]+)/;
2269 my $from = $1 || 'example.com';
2270 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2273 my $agentnum = $cust_main ? $cust_main->agentnum
2274 : $self->prospect_main->agentnum;
2275 if ( defined($args{'template'}) && length($args{'template'})
2276 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2279 $logo = 'logo_'. $args{'template'}. '.png';
2283 my $image_data = $conf->config_binary( $logo, $agentnum);
2285 push @related_parts, build MIME::Entity
2286 'Type' => 'image/png',
2287 'Encoding' => 'base64',
2288 'Data' => $image_data,
2289 'Filename' => 'logo.png',
2290 'Content-ID' => "<$content_id>",
2293 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2294 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2295 push @related_parts, build MIME::Entity
2296 'Type' => 'image/png',
2297 'Encoding' => 'base64',
2298 'Data' => $self->invoice_barcode(0),
2299 'Filename' => 'barcode.png',
2300 'Content-ID' => "<$barcode_content_id>",
2302 $args{'barcode_cid'} = $barcode_content_id;
2305 $html = $self->print_html({ 'cid'=>$content_id, %args });
2312 warn "$me creating HTML/text multipart message"
2315 $return{'nobody'} = 1;
2317 my $alternative = build MIME::Entity
2318 'Type' => 'multipart/alternative',
2319 #'Encoding' => '7bit',
2320 'Disposition' => 'inline'
2324 $alternative->add_part($text_part);
2327 $alternative->attach(
2328 'Type' => 'text/html',
2329 'Encoding' => 'quoted-printable',
2330 'Data' => [ '<html>',
2333 ' '. encode_entities($return{'subject'}),
2336 ' <body bgcolor="#e8e8e8">',
2337 Encode::encode_utf8($html),
2341 'Disposition' => 'inline',
2342 #'Filename' => 'invoice.pdf',
2345 unshift @related_parts, $alternative;
2347 $related = build MIME::Entity 'Type' => 'multipart/related',
2348 'Encoding' => '7bit';
2350 #false laziness w/Misc::send_email
2351 $related->head->replace('Content-type',
2352 $related->mime_type.
2353 '; boundary="'. $related->head->multipart_boundary. '"'.
2354 '; type=multipart/alternative'
2357 $related->add_part($_) foreach @related_parts;
2361 my @otherparts = ();
2362 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2364 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2366 my $data = join('', map "$_\n",
2367 $self->call_details(prepend_billed_number=>1)
2370 my $zip = new Archive::Zip;
2371 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2372 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2375 my $SH = IO::Scalar->new(\$zipdata);
2376 my $status = $zip->writeToFileHandle($SH);
2377 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2379 push @otherparts, build MIME::Entity
2380 'Type' => 'application/zip',
2381 'Encoding' => 'base64',
2383 'Disposition' => 'attachment',
2384 'Filename' => 'usage-'. $self->invnum. '.zip',
2387 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2389 push @otherparts, build MIME::Entity
2390 'Type' => 'text/csv',
2391 'Encoding' => '7bit',
2392 'Data' => [ map { "$_\n" }
2393 $self->call_details('prepend_billed_number' => 1)
2395 'Disposition' => 'attachment',
2396 'Filename' => 'usage-'. $self->invnum. '.csv',
2403 if ( $conf->exists($tc.'email_pdf') ) {
2408 # multipart/alternative
2414 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2415 push @otherparts, $pdf;
2419 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2421 $return{'mimeparts'} = [ $related, @otherparts ];
2422 $return{'type'} = 'multipart/related'; # of the first part
2424 $return{'mimeparts'} = [ $text_part, @otherparts ];
2425 $return{'type'} = 'text/plain';
2427 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2428 $return{'mimeparts'} = \@related_parts;
2429 $return{'content-type'} = 'multipart/related';
2430 $return{'type'} = 'multipart/alternative';
2431 } else { # no HTML either
2432 $return{'body'} = \@text;
2433 $return{'content-type'} = 'text/plain';
2442 Returns a list suitable for passing to MIME::Entity->build(), representing
2443 this quotation or invoice as PDF attachment.
2450 'Type' => 'application/pdf',
2451 'Encoding' => 'base64',
2452 'Data' => [ $self->print_pdf(@_) ],
2453 'Disposition' => 'attachment',
2454 'Filename' => $self->pdf_filename,
2458 =item postal_mail_fsinc
2460 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2466 use IO::Socket::SSL;
2468 use HTTP::Request::Common qw( POST );
2471 sub postal_mail_fsinc {
2472 my ( $self, %opt ) = @_;
2474 my $url = 'https://ws.freeside.biz/print';
2476 my $cust_main = $self->cust_main;
2477 my $agentnum = $cust_main->agentnum;
2478 my $bill_location = $cust_main->bill_location;
2480 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2481 if $bill_location->country ne 'US';
2483 my $conf = new FS::Conf;
2485 my @company_address = $conf->config('company_address', $agentnum);
2486 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2487 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2488 $company_address1 = $company_address[0];
2489 $company_address2 = $company_address[1];
2491 $company_state = $2;
2493 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2494 $company_address1 = $company_address[0];
2495 $company_address2 = '';
2497 $company_state = $2;
2500 die "Unparsable company_address; contact support\@freeside.biz\n";
2502 $company_city =~ s/,$//;
2504 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2505 my $pages = CAM::PDF->new($file)->numPages;
2507 my $ua = LWP::UserAgent->new(
2509 verify_hostname => 0,
2510 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2511 SSL_version => 'SSLv3',
2514 my $response = $ua->request( POST $url, [
2515 'support-key' => scalar($conf->config('support-key')),
2516 'file' => encode_base64($file),
2520 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2521 'company_address1' => $company_address1,
2522 'company_address2' => $company_address2,
2523 'company_city' => $company_city,
2524 'company_state' => $company_state,
2525 'company_zip' => $company_zip,
2526 'company_country' => 'US',
2527 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2528 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2531 'name' => ( $cust_main->payname
2532 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/
2533 ? $cust_main->payname
2534 : $cust_main->contact_firstlast
2536 'company' => $cust_main->company,
2537 'address1' => $bill_location->address1,
2538 'address2' => $bill_location->address2,
2539 'city' => $bill_location->city,
2540 'state' => $bill_location->state,
2541 'zip' => $bill_location->zip,
2542 'country' => $bill_location->country,
2545 die "Print connection error: ". $response->message.
2546 ' ('. $response->as_string. ")\n"
2547 unless $response->is_success;
2550 my $content = eval { decode_json($response->content) };
2551 die "Print JSON error : $@\n" if $@;
2553 die $content->{error}."\n"
2554 if $content->{error};
2556 #TODO: store this so we can query for a status later
2557 warn "Invoice printed, ID ". $content->{id}. "\n";
2562 =item _items_sections OPTIONS
2564 Generate section information for all items appearing on this invoice.
2565 This will only be called for multi-section invoices.
2567 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2568 related display records (L<FS::cust_bill_pkg_display>) and organize
2569 them into two groups ("early" and "late" according to whether they come
2570 before or after the total), then into sections. A subtotal is calculated
2573 Section descriptions are returned in sort weight order. Each consists
2574 of a hash containing:
2576 description: the package category name, escaped
2577 subtotal: the total charges in that section
2578 tax_section: a flag indicating that the section contains only tax charges
2579 summarized: same as tax_section, for some reason
2580 sort_weight: the package category's sort weight
2582 If 'condense' is set on the display record, it also contains everything
2583 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2584 coderefs to generate parts of the invoice. This is not advised.
2586 The method returns two arrayrefs, one of "early" sections and one of "late"
2589 OPTIONS may include:
2591 by_location: a flag to divide the invoice into sections by location.
2592 Each section hash will have a 'location' element containing a hashref of
2593 the location fields (see L<FS::cust_location>). The section description
2594 will be the location label, but the template can use any of the location
2595 fields to create a suitable label.
2597 by_category: a flag to divide the invoice into sections using display
2598 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2599 behavior. Each section hash will have a 'category' element containing
2600 the section name from the display record (which probably equals the
2601 category name of the package, but may not in some cases).
2603 summary: a flag indicating that this is a summary-format invoice.
2604 Turning this on has the following effects:
2605 - Ignores display items with the 'summary' flag.
2606 - Places all sections in the "early" group even if they have post_total.
2607 - Creates sections for all non-disabled package categories, even if they
2608 have no charges on this invoice, as well as a section with no name.
2610 escape: an escape function to use for section titles.
2612 extra_sections: an arrayref of additional sections to return after the
2613 sorted list. If there are any of these, section subtotals exclude
2616 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2617 passed through to C<_condense_section()>.
2621 use vars qw(%pkg_category_cache);
2622 sub _items_sections {
2626 my $escape = $opt{escape};
2627 my @extra_sections = @{ $opt{extra_sections} || [] };
2629 # $subtotal{$locationnum}{$categoryname} = amount.
2630 # if we're not using by_location, $locationnum is undef.
2631 # if we're not using by_category, you guessed it, $categoryname is undef.
2632 # if we're not using either one, we shouldn't be here in the first place...
2634 my %late_subtotal = ();
2637 # About tax items + multisection invoices:
2638 # If either invoice_*summary option is enabled, AND there is a
2639 # package category with the name of the tax, then there will be
2640 # a display record assigning the tax item to that category.
2642 # However, the taxes are always placed in the "Taxes, Surcharges,
2643 # and Fees" section regardless of that. The only effect of the
2644 # display record is to create a subtotal for the summary page.
2647 my $pkg_hash = $self->cust_pkg_hash;
2649 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2652 my $usage = $cust_bill_pkg->usage;
2655 if ( $opt{by_location} ) {
2656 if ( $cust_bill_pkg->pkgnum ) {
2657 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2662 $locationnum = undef;
2665 # as in _items_cust_pkg, if a line item has no display records,
2666 # cust_bill_pkg_display() returns a default record for it
2668 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2669 next if ( $display->summary && $opt{summary} );
2671 #my $section = $display->section;
2672 #false laziness with the method, but for efficiency inside this loop
2673 my $section = $display->get('section');
2674 if ( !$section && !$cust_bill_pkg->hidden ) {
2675 $section = $cust_bill_pkg->get('categoryname'); #cust_bill->cust_bill_pkg added it (XXX quotations / quotation_section)
2678 my $type = $display->type;
2679 # Set $section = undef if we're sectioning by location and this
2680 # line item _has_ a location (i.e. isn't a fee).
2681 $section = undef if $locationnum;
2683 # set this flag if the section is not tax-only
2684 $not_tax{$locationnum}{$section} = 1
2685 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2687 # there's actually a very important piece of logic buried in here:
2688 # incrementing $late_subtotal{$section} CREATES
2689 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2690 # to define the list of late sections, and likewise keys(%subtotal).
2691 # When _items_cust_bill_pkg is called to generate line items for
2692 # real, it will be called with 'section' => $section for each
2694 if ( $display->post_total && !$opt{summary} ) {
2695 if (! $type || $type eq 'S') {
2696 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2697 if $cust_bill_pkg->setup != 0
2698 || $cust_bill_pkg->setup_show_zero;
2702 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2703 if $cust_bill_pkg->recur != 0
2704 || $cust_bill_pkg->recur_show_zero;
2707 if ($type && $type eq 'R') {
2708 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2709 if $cust_bill_pkg->recur != 0
2710 || $cust_bill_pkg->recur_show_zero;
2713 if ($type && $type eq 'U') {
2714 $late_subtotal{$locationnum}{$section} += $usage
2715 unless scalar(@extra_sections);
2718 } else { # it's a pre-total (normal) section
2720 # skip tax items unless they're explicitly included in a section
2721 next if $cust_bill_pkg->pkgnum == 0 and
2722 ! $cust_bill_pkg->feepart and
2725 if ( $type eq 'S' ) {
2726 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2727 if $cust_bill_pkg->setup != 0
2728 || $cust_bill_pkg->setup_show_zero;
2729 } elsif ( $type eq 'R' ) {
2730 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2731 if $cust_bill_pkg->recur != 0
2732 || $cust_bill_pkg->recur_show_zero;
2733 } elsif ( $type eq 'U' ) {
2734 $subtotal{$locationnum}{$section} += $usage
2735 unless scalar(@extra_sections);
2736 } elsif ( !$type ) {
2737 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2738 + $cust_bill_pkg->recur;
2747 %pkg_category_cache = ();
2749 # summary invoices need subtotals for all non-disabled package categories,
2750 # even if they're zero
2751 # but currently assume that there are no location sections, or at least
2752 # that the summary page doesn't care about them
2753 if ( $opt{summary} ) {
2754 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2755 $subtotal{''}{$category->categoryname} ||= 0;
2757 $subtotal{''}{''} ||= 0;
2761 foreach my $post_total (0,1) {
2763 my $s = $post_total ? \%late_subtotal : \%subtotal;
2764 foreach my $locationnum (keys %$s) {
2765 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2767 'subtotal' => $s->{$locationnum}{$sectionname},
2770 if ( $locationnum ) {
2771 $section->{'locationnum'} = $locationnum;
2772 my $location = FS::cust_location->by_key($locationnum);
2773 $section->{'description'} = &{ $escape }($location->location_label);
2774 # Better ideas? This will roughly group them by proximity,
2775 # which alpha sorting on any of the address fields won't.
2776 # Sorting by locationnum is meaningless.
2777 # We have to sort on _something_ or the order may change
2778 # randomly from one invoice to the next, which will confuse
2780 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2782 $section->{'location'} = {
2783 label_prefix => &{ $escape }($location->label_prefix),
2784 map { $_ => &{ $escape }($location->get($_)) }
2788 $section->{'category'} = $sectionname;
2789 $section->{'description'} = &{ $escape }($sectionname);
2790 if ( _pkg_category($sectionname) ) {
2791 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2792 if ( _pkg_category($sectionname)->condense ) {
2793 $section = { %$section, $self->_condense_section($opt{format}) };
2797 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2798 # then it's a tax-only section
2799 $section->{'summarized'} = 'Y';
2800 $section->{'tax_section'} = 'Y';
2802 push @these, $section;
2803 } # foreach $sectionname
2804 } #foreach $locationnum
2805 push @these, @extra_sections if $post_total == 0;
2806 # need an alpha sort for location sections, because postal codes can
2808 $sections[ $post_total ] = [ sort {
2809 $opt{'by_location'} ?
2810 ($a->{sort_weight} cmp $b->{sort_weight}) :
2811 ($a->{sort_weight} <=> $b->{sort_weight})
2813 } #foreach $post_total
2815 return @sections; # early, late
2818 #helper subs for above
2822 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2826 my $categoryname = shift;
2827 $pkg_category_cache{$categoryname} ||=
2828 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2831 my %condensed_format = (
2832 'label' => [ qw( Description Qty Amount ) ],
2834 sub { shift->{description} },
2835 sub { shift->{quantity} },
2836 sub { my($href, %opt) = @_;
2837 ($opt{dollar} || ''). $href->{amount};
2840 'align' => [ qw( l r r ) ],
2841 'span' => [ qw( 5 1 1 ) ], # unitprices?
2842 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2845 sub _condense_section {
2846 my ( $self, $format ) = ( shift, shift );
2848 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2849 qw( description_generator
2852 total_line_generator
2857 sub _condensed_generator_defaults {
2858 my ( $self, $format ) = ( shift, shift );
2859 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2868 sub _condensed_header_generator {
2869 my ( $self, $format ) = ( shift, shift );
2871 my ( $f, $prefix, $suffix, $separator, $column ) =
2872 _condensed_generator_defaults($format);
2874 if ($format eq 'latex') {
2875 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2876 $suffix = "\\\\\n\\hline";
2879 sub { my ($d,$a,$s,$w) = @_;
2880 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2882 } elsif ( $format eq 'html' ) {
2883 $prefix = '<th></th>';
2887 sub { my ($d,$a,$s,$w) = @_;
2888 return qq!<th align="$html_align{$a}">$d</th>!;
2896 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2898 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2901 $prefix. join($separator, @result). $suffix;
2906 sub _condensed_description_generator {
2907 my ( $self, $format ) = ( shift, shift );
2909 my ( $f, $prefix, $suffix, $separator, $column ) =
2910 _condensed_generator_defaults($format);
2912 my $money_char = '$';
2913 if ($format eq 'latex') {
2914 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2916 $separator = " & \n";
2918 sub { my ($d,$a,$s,$w) = @_;
2919 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2921 $money_char = '\\dollar';
2922 }elsif ( $format eq 'html' ) {
2923 $prefix = '"><td align="center"></td>';
2927 sub { my ($d,$a,$s,$w) = @_;
2928 return qq!<td align="$html_align{$a}">$d</td>!;
2930 #$money_char = $conf->config('money_char') || '$';
2931 $money_char = ''; # this is madness
2939 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2941 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2943 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2944 map { $f->{$_}->[$i] } qw(align span width)
2948 $prefix. join( $separator, @result ). $suffix;
2953 sub _condensed_total_generator {
2954 my ( $self, $format ) = ( shift, shift );
2956 my ( $f, $prefix, $suffix, $separator, $column ) =
2957 _condensed_generator_defaults($format);
2960 if ($format eq 'latex') {
2963 $separator = " & \n";
2965 sub { my ($d,$a,$s,$w) = @_;
2966 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2968 }elsif ( $format eq 'html' ) {
2972 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2974 sub { my ($d,$a,$s,$w) = @_;
2975 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2984 # my $r = &{$f->{fields}->[$i]}(@args);
2985 # $r .= ' Total' unless $i;
2987 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2989 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2990 map { $f->{$_}->[$i] } qw(align span width)
2994 $prefix. join( $separator, @result ). $suffix;
2999 =item total_line_generator FORMAT
3001 Returns a coderef used for generation of invoice total line items for this
3002 usage_class. FORMAT is either html or latex
3006 # should not be used: will have issues with hash element names (description vs
3007 # total_item and amount vs total_amount -- another array of functions?
3009 sub _condensed_total_line_generator {
3010 my ( $self, $format ) = ( shift, shift );
3012 my ( $f, $prefix, $suffix, $separator, $column ) =
3013 _condensed_generator_defaults($format);
3016 if ($format eq 'latex') {
3019 $separator = " & \n";
3021 sub { my ($d,$a,$s,$w) = @_;
3022 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3024 }elsif ( $format eq 'html' ) {
3028 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3030 sub { my ($d,$a,$s,$w) = @_;
3031 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3040 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3042 &{$column}( &{$f->{fields}->[$i]}(@args),
3043 map { $f->{$_}->[$i] } qw(align span width)
3047 $prefix. join( $separator, @result ). $suffix;
3052 =item _items_pkg [ OPTIONS ]
3054 Return line item hashes for each package item on this invoice. Nearly
3057 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3059 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3060 'format' and 'escape_function' at minimum.
3062 To produce items for a specific invoice section, OPTIONS should include
3063 'section', a hashref containing 'category' and/or 'locationnum' keys.
3065 'section' may also contain a key named 'condensed'. If this is present
3066 and has a true value, _items_pkg will try to merge identical items into items
3067 with 'quantity' equal to the number of items (not the sum of their separate
3068 quantities, for some reason).
3074 # The order of these is important. Bundled line items will be merged into
3075 # the most recent non-hidden item, so it needs to be the one with:
3077 # - the same start date
3078 # - no pkgpart_override
3080 # So: sort by pkgnum,
3082 # then sort the base line item before any overrides
3083 # then sort hidden before non-hidden add-ons
3084 # then sort by override pkgpart (for consistency)
3085 sort { $a->pkgnum <=> $b->pkgnum or
3086 $a->sdate <=> $b->sdate or
3087 ($a->pkgpart_override ? 0 : -1) or
3088 ($b->pkgpart_override ? 0 : 1) or
3089 $b->hidden cmp $a->hidden or
3090 $a->pkgpart_override <=> $b->pkgpart_override
3092 # and of course exclude taxes and fees
3093 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3099 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3100 my $escape_function = $options{escape_function};
3102 my $locale = $self->quotationnum
3103 ? $self->prospect_main->locale
3104 : $self->cust_main->locale;
3107 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3108 # cache this, so we don't look it up again in every section
3109 my $part_fee = $cust_bill_pkg->get('part_fee')
3110 || $cust_bill_pkg->part_fee;
3111 $cust_bill_pkg->set('part_fee', $part_fee);
3113 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3114 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3117 if ( exists($options{section}) and exists($options{section}{category}) )
3119 my $categoryname = $options{section}{category};
3120 # then filter for items that have that section
3121 if ( $part_fee->categoryname ne $categoryname ) {
3122 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3125 } # otherwise include them all in the main section
3126 # XXX what to do when sectioning by location?
3129 my %base_invnums; # invnum => invoice date
3130 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3131 if ($_->base_invnum) {
3132 # XXX what if base_bill has been voided?
3133 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3134 my $base_date = $self->time2str_local('short', $base_bill->_date)
3136 $base_invnums{$_->base_invnum} = $base_date || '';
3139 foreach (sort keys(%base_invnums)) {
3140 next if $_ == $self->invnum;
3141 # per convention, we must escape ext_description lines
3143 &{$escape_function}(
3144 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3147 my $desc = $part_fee->itemdesc_locale($locale);
3148 # but not escape the base description line
3150 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3151 if $options{section_with_taxes};
3154 { feepart => $cust_bill_pkg->feepart,
3155 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3156 description => $desc,
3157 pkg_tax => \@pkg_tax,
3158 ext_description => \@ext_desc,
3169 warn "$me _items_pkg searching for all package line items\n"
3172 my @cust_bill_pkg = $self->_items_nontax;
3174 warn "$me _items_pkg filtering line items\n"
3176 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3178 if ($options{section} && $options{section}->{condensed}) {
3180 warn "$me _items_pkg condensing section\n"
3184 local $Storable::canonical = 1;
3185 foreach ( @items ) {
3187 delete $item->{ref};
3188 delete $item->{ext_description};
3189 my $key = freeze($item);
3190 $itemshash{$key} ||= 0;
3191 $itemshash{$key} ++; # += $item->{quantity};
3193 @items = sort { $a->{description} cmp $b->{description} }
3194 map { my $i = thaw($_);
3195 $i->{quantity} = $itemshash{$_};
3197 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3203 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3210 return 0 unless $a->itemdesc cmp $b->itemdesc;
3211 return -1 if $b->itemdesc eq 'Tax';
3212 return 1 if $a->itemdesc eq 'Tax';
3213 return -1 if $b->itemdesc eq 'Other surcharges';
3214 return 1 if $a->itemdesc eq 'Other surcharges';
3215 $a->itemdesc cmp $b->itemdesc;
3220 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3221 $self->cust_bill_pkg;
3222 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3224 if ( $self->conf->exists('always_show_tax') ) {
3225 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3226 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3228 { 'description' => $itemdesc,
3235 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3237 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3238 list of hashrefs describing the line items they generate on the invoice.
3240 OPTIONS may include:
3242 format: the invoice format.
3244 escape_function: the function used to escape strings.
3246 DEPRECATED? (expensive, mostly unused?)
3247 format_function: the function used to format CDRs.
3249 section: a hashref containing 'category' and/or 'locationnum'; if this
3250 is present, only returns line items that belong to that category and/or
3251 location (whichever is defined).
3253 multisection: a flag indicating that this is a multisection invoice,
3254 which does something complicated.
3256 preref_callback: coderef run for each line item, code should return HTML to be
3257 displayed before that line item (quotations only)
3259 section_with_taxes: Look up and include applied taxes for each record
3261 Returns a list of hashrefs, each of which may contain:
3263 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3264 ext_description, which is an arrayref of detail lines to show below
3269 sub _items_cust_bill_pkg {
3271 my $conf = $self->conf;
3272 my $cust_bill_pkgs = shift;
3275 my $format = $opt{format} || '';
3276 my $escape_function = $opt{escape_function} || sub { shift };
3277 my $format_function = $opt{format_function} || '';
3278 my $no_usage = $opt{no_usage} || '';
3279 my $unsquelched = $opt{unsquelched} || ''; #unused
3280 my ($section, $locationnum, $category);
3281 if ( $opt{section} ) {
3282 $category = $opt{section}->{category};
3283 $locationnum = $opt{section}->{locationnum};
3285 my $summary_page = $opt{summary_page} || ''; #unused
3286 my $multisection = defined($category) || defined($locationnum);
3287 # this variable is the value of the config setting, not whether it applies
3288 # to this particular line item.
3289 my $discount_show_always = $conf->exists('discount-show-always');
3291 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3293 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3295 my $agentnum = $self->agentnum;
3297 # for location labels: use default location on the invoice date
3298 my $default_locationnum;
3299 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3300 $default_locationnum = 0; # treat them all as non-default
3301 } elsif ( $self->custnum ) {
3303 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3304 $h_cust_main = qsearchs({
3305 'table' => 'h_cust_main',
3306 'hashref' => { custnum => $self->custnum },
3307 'extra_sql' => $h_search[1],
3308 'addl_from' => $h_search[3],
3310 $default_locationnum = $h_cust_main->ship_locationnum;
3311 } elsif ( $self->prospectnum ) {
3312 my $cust_location = qsearchs('cust_location',
3313 { prospectnum => $self->prospectnum,
3315 $default_locationnum = $cust_location->locationnum if $cust_location;
3318 my @b = (); # accumulator for the line item hashes that we'll return
3319 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3320 # the 'current' line item hashes for setup, recur, usage, discount
3321 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3323 # if the current line item is waiting to go out, and the one we're about
3324 # to start is not bundled, then push out the current one and start a new
3326 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3327 if ( $_ && !$cust_bill_pkg->hidden ) {
3328 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3329 $_->{amount} =~ s/^\-0\.00$/0.00/;
3330 if (exists($_->{unit_amount})) {
3331 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3334 # we already decided to create this display line; don't reconsider it
3336 # if $_->{amount} != 0
3337 # || $discount_show_always
3338 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3339 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3345 if ( $locationnum ) {
3346 # this is a location section; skip packages that aren't at this
3348 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3349 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3353 # Consider display records for this item to determine if it belongs
3354 # in this section. Note that if there are no display records, there
3355 # will be a default pseudo-record that includes all charge types
3356 # and has no section name.
3357 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3358 ? $cust_bill_pkg->cust_bill_pkg_display
3359 : ( $cust_bill_pkg );
3361 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3362 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3365 if ( defined($category) ) {
3366 # then this is a package category section; process all display records
3367 # that belong to this section.
3368 @cust_bill_pkg_display = grep { $_->section eq $category }
3369 @cust_bill_pkg_display;
3371 # otherwise, process all display records that aren't usage summaries
3372 # (I don't think there should be usage summaries if you aren't using
3373 # category sections, but this is the historical behavior)
3374 @cust_bill_pkg_display = grep { !$_->summary }
3375 @cust_bill_pkg_display;
3378 my $classname = ''; # package class name, will fill in later
3380 foreach my $display (@cust_bill_pkg_display) {
3382 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3383 $display->billpkgdisplaynum. "\n"
3386 my $type = $display->type;
3388 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3389 $desc = substr($desc, 0, $maxlength). '...'
3390 if $format eq 'latex' && length($desc) > $maxlength;
3392 my %details_opt = ( 'format' => $format,
3393 'escape_function' => $escape_function,
3394 'format_function' => $format_function,
3395 'no_usage' => $opt{'no_usage'},
3398 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3399 if $opt{section_with_taxes};
3401 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3402 # XXX this should be pulled out into quotation_pkg
3404 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3406 # quotation_pkgs are never fees, so don't worry about the case where
3407 # part_pkg is undefined
3409 my @details = $cust_bill_pkg->details;
3411 # and I guess they're never bundled either?
3412 if (( $cust_bill_pkg->setup != 0 ) || ( $cust_bill_pkg->setup_show_zero )) {
3413 my $description = $desc;
3414 $description .= ' Setup'
3415 if $cust_bill_pkg->recur != 0
3416 || $discount_show_always
3417 || $cust_bill_pkg->recur_show_zero;
3419 # keep it consistent, please
3421 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3422 'description' => $description,
3423 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3424 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3425 'quantity' => $cust_bill_pkg->quantity,
3426 'pkg_tax' => \@pkg_tax,
3427 'ext_description' => \@details,
3428 'preref_html' => ( $opt{preref_callback}
3429 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3434 if (( $cust_bill_pkg->recur != 0 ) || ( $cust_bill_pkg->recur_show_zero )) {
3437 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3438 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3439 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3440 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3441 'quantity' => $cust_bill_pkg->quantity,
3442 'pkg_tax' => \@pkg_tax,
3443 'ext_description' => \@details,
3444 'preref_html' => ( $opt{preref_callback}
3445 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3451 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3452 # a "normal" package line item (not a quotation, not a fee, not a tax)
3454 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3457 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3458 my $part_pkg = $cust_pkg->part_pkg;
3460 # which pkgpart to show for display purposes?
3461 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3463 # start/end dates for invoice formats that do nonstandard
3465 my %item_dates = ();
3466 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3467 unless $part_pkg->option('disable_line_item_date_ranges',1);
3469 # not normally used, but pass this to the template anyway
3470 $classname = $part_pkg->classname;
3472 if ( (!$type || $type eq 'S')
3473 && ( $cust_bill_pkg->setup != 0
3474 || $cust_bill_pkg->setup_show_zero
3475 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3480 warn "$me _items_cust_bill_pkg adding setup\n"
3483 # append the word 'Setup' to the setup line if there's going to be
3484 # a recur line for the same package (i.e. not a one-time charge)
3486 my $description = $desc;
3487 $description .= ' Setup'
3488 if $cust_bill_pkg->recur != 0
3489 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3490 || $cust_bill_pkg->recur_show_zero;
3492 my $disable_date_ranges =
3493 $opt{disable_line_item_date_ranges}
3494 || $part_pkg->option('disable_line_item_date_ranges', 1);
3496 $description .= $cust_bill_pkg->time_period_pretty(
3499 disable_date_ranges => $disable_date_ranges,
3501 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3502 # triggered by the recurring charge freq
3504 && $cust_bill_pkg->recur == 0
3505 && ! $cust_bill_pkg->recur_show_zero;
3510 # always pass the svc_label through to the template, even if
3511 # not displaying it as an ext_description
3512 my @svc_labels = map &{$escape_function}($_),
3513 $cust_pkg->h_labels_short($self->_date,
3516 $self->conf->{locale},
3518 $svc_label = $svc_labels[0];
3520 unless ( $cust_pkg->part_pkg->hide_svc_detail
3521 || $cust_bill_pkg->hidden )
3524 push @d, @svc_labels
3525 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3526 # show the location label if it's not the customer's default
3527 # location, and we're not grouping items by location already
3528 if ( $cust_pkg->locationnum != $default_locationnum
3529 and !defined($locationnum) ) {
3530 my $loc = $cust_pkg->location_label;
3531 $loc = substr($loc, 0, $maxlength). '...'
3532 if $format eq 'latex' && length($loc) > $maxlength;
3533 push @d, &{$escape_function}($loc);
3536 } #unless hiding service details
3538 push @d, $cust_bill_pkg->details(%details_opt)
3539 if $cust_bill_pkg->recur == 0;
3541 if ( $cust_bill_pkg->hidden ) {
3542 $s->{amount} += $cust_bill_pkg->setup;
3543 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3544 push @{ $s->{ext_description} }, @d;
3548 description => $description,
3549 pkgpart => $pkgpart,
3550 pkgnum => $cust_bill_pkg->pkgnum,
3551 amount => $cust_bill_pkg->setup,
3552 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3553 unit_amount => $cust_bill_pkg->unitsetup,
3554 quantity => $cust_bill_pkg->quantity,
3555 pkg_tax => \@pkg_tax,
3556 ext_description => \@d,
3557 svc_label => ($svc_label || ''),
3558 locationnum => $cust_pkg->locationnum, # sure, why not?
3564 # should we show a recur line?
3565 # if type eq 'S', then NO, because we've been told not to.
3566 # otherwise, show the recur line if:
3567 # - there's a recurring charge
3568 # - or recur_show_zero is on
3569 # - or there's a positive unitrecur (so it's been discounted to zero)
3570 # and discount-show-always is on
3571 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3573 $cust_bill_pkg->recur != 0
3575 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3576 || $cust_bill_pkg->recur_show_zero
3581 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3584 my $is_summary = $display->summary;
3585 my $description = $desc;
3586 if ( $type eq 'U' and defined($r) ) {
3587 # don't just show the same description as the recur line
3588 $description = $self->mt('Usage charges');
3591 my $disable_date_ranges =
3592 $opt{disable_line_item_date_ranges}
3593 || $part_pkg->option('disable_line_item_date_ranges', 1);
3595 $description .= $cust_bill_pkg->time_period_pretty(
3598 disable_date_ranges => $disable_date_ranges,
3602 my @seconds = (); # for display of usage info
3605 #at least until cust_bill_pkg has "past" ranges in addition to
3606 #the "future" sdate/edate ones... see #3032
3607 my @dates = ( $self->_date );
3608 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3609 push @dates, $prev->sdate if $prev;
3610 push @dates, undef if !$prev;
3612 my @svc_labels = map &{$escape_function}($_),
3613 $cust_pkg->h_labels_short(@dates,
3615 $self->conf->{locale});
3616 $svc_label = $svc_labels[0];
3618 # show service labels, unless...
3619 # the package is set not to display them
3620 unless ( $part_pkg->hide_svc_detail
3621 # or this is a tax-like line item
3622 || $cust_bill_pkg->itemdesc
3623 # or this is a hidden (bundled) line item
3624 || $cust_bill_pkg->hidden
3625 # or this is a usage summary line
3626 || $is_summary && $type && $type eq 'U'
3627 # or this is a usage line and there's a recurring line
3628 # for the package in the same section (which will
3629 # have service labels already)
3630 || ($type eq 'U' and defined($r))
3634 warn "$me _items_cust_bill_pkg adding service details\n"
3637 push @d, @svc_labels
3638 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3639 warn "$me _items_cust_bill_pkg done adding service details\n"
3642 # show the location label if it's not the customer's default
3643 # location, and we're not grouping items by location already
3644 if ( $cust_pkg->locationnum != $default_locationnum
3645 and !defined($locationnum) ) {
3646 my $loc = $cust_pkg->location_label;
3647 $loc = substr($loc, 0, $maxlength). '...'
3648 if $format eq 'latex' && length($loc) > $maxlength;
3649 push @d, &{$escape_function}($loc);
3652 # Display of seconds_since_sqlradacct:
3653 # On the invoice, when processing @detail_items, look for a field
3654 # named 'seconds'. This will contain total seconds for each
3655 # service, in the same order as @ext_description. For services
3656 # that don't support this it will show undef.
3657 if ( $conf->exists('svc_acct-usage_seconds')
3658 and ! $cust_bill_pkg->pkgpart_override ) {
3659 foreach my $cust_svc (
3660 $cust_pkg->h_cust_svc(@dates, 'I')
3663 # eval because not having any part_export_usage exports
3664 # is a fatal error, last_bill/_date because that's how
3665 # sqlradius_hour billing does it
3667 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3669 push @seconds, $sec;
3671 } #if svc_acct-usage_seconds
3673 } # if we are showing service labels
3675 unless ( $is_summary ) {
3676 warn "$me _items_cust_bill_pkg adding details\n"
3679 #instead of omitting details entirely in this case (unwanted side
3680 # effects), just omit CDRs
3681 $details_opt{'no_usage'} = 1
3682 if $type && $type eq 'R';
3684 push @d, $cust_bill_pkg->details(%details_opt);
3687 warn "$me _items_cust_bill_pkg calculating amount\n"
3692 $amount = $cust_bill_pkg->recur;
3693 } elsif ($type eq 'R') {
3694 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3695 } elsif ($type eq 'U') {
3696 $amount = $cust_bill_pkg->usage;
3699 if ( !$type || $type eq 'R' ) {
3701 warn "$me _items_cust_bill_pkg adding recur\n"
3705 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3708 if ( $cust_bill_pkg->hidden ) {
3709 $r->{amount} += $amount;
3710 $r->{unit_amount} += $unit_amount;
3711 push @{ $r->{ext_description} }, @d;
3714 description => $description,
3715 pkgpart => $pkgpart,
3716 pkgnum => $cust_bill_pkg->pkgnum,
3718 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3719 unit_amount => $unit_amount,
3720 quantity => $cust_bill_pkg->quantity,
3721 pkg_tax => \@pkg_tax,
3723 ext_description => \@d,
3724 svc_label => ($svc_label || ''),
3725 locationnum => $cust_pkg->locationnum,
3727 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3730 } else { # $type eq 'U'
3732 warn "$me _items_cust_bill_pkg adding usage\n"
3735 if ( $cust_bill_pkg->hidden and defined($u) ) {
3736 # if this is a hidden package and there's already a usage
3737 # line for the bundle, add this package's total amount and
3738 # usage details to it
3739 $u->{amount} += $amount;
3740 push @{ $u->{ext_description} }, @d;
3741 } elsif ( $amount ) {
3742 # create a new usage line
3744 description => $description,
3745 pkgpart => $pkgpart,
3746 pkgnum => $cust_bill_pkg->pkgnum,
3749 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3750 pkg_tax => \@pkg_tax,
3752 ext_description => \@d,
3753 locationnum => $cust_pkg->locationnum,
3755 } # else this has no usage, so don't create a usage section
3758 } # recurring or usage with recurring charge
3760 } else { # taxes and fees
3762 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3765 # items of this kind should normally not have sdate/edate.
3767 'description' => $desc,
3768 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3769 + $cust_bill_pkg->recur)
3772 } # if quotation / package line item / other line item
3774 # decide whether to show active discounts here
3776 # case 1: we are showing a single line for the package
3778 # case 2: we are showing a setup line for a package that has
3779 # no base recurring fee
3780 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3781 # case 3: we are showing a recur line for a package that has
3782 # a base recurring fee
3783 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3786 my $item_discount = $cust_bill_pkg->_item_discount;
3787 if ( $item_discount ) {
3788 # $item_discount->{amount} is negative
3790 if ( $d and $cust_bill_pkg->hidden ) {
3791 $d->{amount} += $item_discount->{amount};
3793 $d = $item_discount;
3794 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3797 # update the active line (before the discount) to show the
3798 # original price (whether this is a hidden line or not)
3800 # quotation discounts keep track of setup and recur; invoice
3801 # discounts currently don't
3802 if ( exists $item_discount->{setup_amount} ) {
3804 $s->{amount} -= $item_discount->{setup_amount} if $s;
3805 $r->{amount} -= $item_discount->{recur_amount} if $r;
3809 # $active_line is the line item hashref for the line that will
3810 # show the original price
3811 # (use the recur or single line for the package, unless we're
3812 # showing a setup line for a package with no recurring fee)
3813 my $active_line = $r;
3814 if ( $type eq 'S' ) {
3817 $active_line->{amount} -= $item_discount->{amount};
3821 } # if there are any discounts
3822 } # if this is an appropriate place to show discounts
3824 } # foreach $display
3828 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3830 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3831 if exists($_->{amount});
3832 $_->{amount} =~ s/^\-0\.00$/0.00/;
3833 if (exists($_->{unit_amount})) {
3834 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3838 #if $_->{amount} != 0
3839 # || $discount_show_always
3840 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3841 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3845 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3852 =item _items_discounts_avail
3854 Returns an array of line item hashrefs representing available term discounts
3855 for this invoice. This makes the same assumptions that apply to term
3856 discounts in general: that the package is billed monthly, at a flat rate,
3857 with no usage charges. A prorated first month will be handled, as will
3858 a setup fee if the discount is allowed to apply to setup fees.
3862 sub _items_discounts_avail {
3865 #maybe move this method from cust_bill when quotations support discount_plans
3866 return () unless $self->can('discount_plans');
3867 my %plans = $self->discount_plans;
3869 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3870 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3874 my $plan = $plans{$months};
3876 my $term_total = sprintf('%.2f', $plan->discounted_total);
3877 my $percent = sprintf('%.0f',
3878 100 * (1 - $term_total / $plan->base_total) );
3879 my $permonth = sprintf('%.2f', $term_total / $months);
3880 my $detail = $self->mt('discount on item'). ' '.
3881 join(', ', map { "#$_" } $plan->pkgnums)
3884 # discounts for non-integer months don't work anyway
3885 $months = sprintf("%d", $months);
3888 description => $self->mt('Save [_1]% by paying for [_2] months',
3890 amount => $self->mt('[_1] ([_2] per month)',
3891 $term_total, $money_char.$permonth),
3892 ext_description => ($detail || ''),
3895 sort { $b <=> $a } keys %plans;
3899 =item has_sections AGENTNUM
3901 Return true if invoice_sections should be enabled for this bill.
3902 (Inherited by both cust_bill and cust_bill_void)
3905 * False if not an invoice
3906 * True always if conf invoice_sections is enabled
3907 * True always if sections_by_location is enabled
3908 * True if conf invoice_sections_multilocation > 1,
3909 and location_count >= invoice_sections_multilocation
3915 my ($self, $agentnum) = @_;
3917 return 0 unless $self->invnum > 0;
3919 $agentnum ||= $self->agentnum;
3920 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3921 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3923 my $location_min = $self->conf->config(
3924 'invoice_sections_multilocation', $agentnum,
3929 && $self->location_count >= $location_min;
3935 =item location_count
3937 Return the number of locations billed on this invoice
3941 sub location_count {
3943 return 0 unless $self->invnum;
3945 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3946 # FROM cust_bill_pkg
3947 # LEFT JOIN cust_pkg USING (pkgnum)
3948 # WHERE invnum = 278
3949 # AND cust_bill_pkg.pkgnum > 0
3951 my $result = qsearchs({
3952 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3953 table => 'cust_bill_pkg',
3954 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3955 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3956 . ' AND cust_bill_pkg.pkgnum > 0'
3958 ref $result ? $result->location_count : 0;