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;
326 my $locale = $params{'locale'} || $cust_main->locale;
328 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
329 'html' => [ '<%=', '%>' ],
330 'template' => [ '{', '}' ],
333 warn "$me print_generic creating template\n"
336 # set the notice name here, and nowhere else.
337 my $notice_name = $params{notice_name}
338 || $conf->config('notice_name')
339 || $self->notice_name;
342 my $template = $params{template} ? $params{template} : $self->_agent_template;
343 my $templatefile = $self->template_conf. $format;
344 $templatefile .= "_$template"
345 if length($template) && $conf->exists($templatefile."_$template");
347 $self->set('_template',$template);
350 my @invoice_template = map "$_\n", $conf->config($templatefile)
351 or die "cannot load config data $templatefile";
353 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
354 #change this to a die when the old code is removed
355 # it's been almost ten years, changing it to a die
356 die "old-style invoice template $templatefile; ".
357 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
358 #$old_latex = 'true';
359 #@invoice_template = _translate_old_latex_format(@invoice_template);
362 warn "$me print_generic creating T:T object\n"
365 my $text_template = new Text::Template(
367 SOURCE => \@invoice_template,
368 DELIMITERS => $delimiters{$format},
371 warn "$me print_generic compiling T:T object\n"
374 $text_template->compile()
375 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
378 # additional substitution could possibly cause breakage in existing templates
381 'notes' => sub { map "$_", @_ },
382 'footer' => sub { map "$_", @_ },
383 'smallfooter' => sub { map "$_", @_ },
384 'returnaddress' => sub { map "$_", @_ },
385 'coupon' => sub { map "$_", @_ },
386 'summary' => sub { map "$_", @_ },
392 s/%%(.*)$/<!-- $1 -->/g;
393 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
394 s/\\begin\{enumerate\}/<ol>/g;
396 s/\\end\{enumerate\}/<\/ol>/g;
397 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
408 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
414 s/\\hyphenation\{[\w\s\-]+}//;
419 'coupon' => sub { "" },
420 'summary' => sub { "" },
427 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
428 s/\\begin\{enumerate\}//g;
430 s/\\end\{enumerate\}//g;
431 s/\\textbf\{(.*)\}/$1/g;
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
445 s/\\\\\*?\s*$/\n/; # dubious
446 s/\\hyphenation\{[\w\s\-]+}//;
450 'coupon' => sub { "" },
451 'summary' => sub { "" },
456 # hashes for differing output formats
457 my %nbsps = ( 'latex' => '~',
458 'html' => '', # '&nbps;' would be nice
459 'template' => '', # not used
461 my $nbsp = $nbsps{$format};
463 my %escape_functions = ( 'latex' => \&_latex_escape,
464 'html' => \&_html_escape_nbsp,#\&encode_entities,
465 'template' => sub { shift },
467 my $escape_function = $escape_functions{$format};
468 my $escape_function_nonbsp = ($format eq 'html')
469 ? \&_html_escape : $escape_function;
471 my %newline_tokens = ( 'latex' => '\\\\',
475 my $newline_token = $newline_tokens{$format};
477 warn "$me generating template variables\n"
480 # generate template variables
484 defined( $conf->config_orbase( "invoice_${format}returnaddress",
488 && length( $conf->config_orbase( "invoice_${format}returnaddress",
494 $returnaddress = join("\n",
495 $conf->config_orbase("invoice_${format}returnaddress", $template)
499 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
501 my $convert_map = $convert_maps{$format}{'returnaddress'};
504 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
509 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
511 my $convert_map = $convert_maps{$format}{'returnaddress'};
512 $returnaddress = join( "\n", &$convert_map(
513 map { s/( {2,})/'~' x length($1)/eg;
517 ( $conf->config('company_name', $cust_main->agentnum),
518 $conf->config('company_address', $cust_main->agentnum),
525 my $warning = "Couldn't find a return address; ".
526 "do you need to set the company_address configuration value?";
528 $returnaddress = $nbsp;
529 #$returnaddress = $warning;
533 warn "$me generating invoice data\n"
536 my $agentnum = $cust_main->agentnum;
541 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
542 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
543 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
544 'returnaddress' => $returnaddress,
545 'agent' => &$escape_function($cust_main->agent->agent),
547 #invoice/quotation info
548 'no_number' => $params{'no_number'},
549 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
550 'quotationnum' => $self->quotationnum,
551 'no_date' => $params{'no_date'},
552 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
553 # workaround for inconsistent behavior in the early plain text
554 # templates; see RT#28271
555 'date' => ( $params{'no_date'}
557 : ($format eq 'template'
559 : $self->time2str_local('long', $self->_date, $format)
562 'today' => $self->time2str_local('long', $today, $format),
563 'terms' => $self->terms,
564 'template' => $template, #params{'template'},
565 'notice_name' => $notice_name, # escape?
566 'current_charges' => sprintf("%.2f", $self->charged),
567 'duedate' => $self->due_date2str('rdate'), #date_format?
568 'duedate_long' => $self->due_date2str('long'),
571 'custnum' => $cust_main->display_custnum,
572 'prospectnum' => $cust_main->prospectnum,
573 'agent_custid' => &$escape_function($cust_main->agent_custid),
574 ( map { $_ => &$escape_function($cust_main->$_()) }
575 qw( company address1 address2 city state zip fax )
577 'payname' => &$escape_function( $cust_main->invoice_attn
578 || $cust_main->contact_firstlast ),
581 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
582 'unitprices' => $conf->exists('invoice-unitprice'),
583 'smallernotes' => $conf->exists('invoice-smallernotes'),
584 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
585 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
587 #layout info -- would be fancy to calc some of this and bury the template
589 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
590 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
591 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
592 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
593 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
594 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
595 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
596 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
597 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
598 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
600 # better hang on to conf_dir for a while (for old templates)
601 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
603 #these are only used when doing paged plaintext
609 #quotations have $name
610 $invoice_data{'name'} = $invoice_data{'payname'};
613 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
614 # prototype here to silence warnings
615 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
617 my $min_sdate = 999999999999;
619 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
620 next unless $cust_bill_pkg->pkgnum > 0;
621 $min_sdate = $cust_bill_pkg->sdate
622 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
623 $max_edate = $cust_bill_pkg->edate
624 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
627 $invoice_data{'bill_period'} = '';
628 $invoice_data{'bill_period'} =
629 $self->time2str_local('%e %h', $min_sdate, $format)
631 $self->time2str_local('%e %h', $max_edate, $format)
632 if ($max_edate != 0 && $min_sdate != 999999999999);
634 $invoice_data{finance_section} = '';
635 if ( $conf->config('finance_pkgclass') ) {
637 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
638 $invoice_data{finance_section} = $pkg_class->categoryname;
640 $invoice_data{finance_amount} = '0.00';
641 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
643 my $countrydefault = $conf->config('countrydefault') || 'US';
644 foreach ( qw( address1 address2 city state zip country fax) ){
645 my $method = 'ship_'.$_;
646 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
648 if ( length($cust_main->ship_company) ) {
649 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
651 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
653 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
654 $invoice_data{'ship_country'} = ''
655 if ( $invoice_data{'ship_country'} eq $countrydefault );
657 $invoice_data{'cid'} = $params{'cid'}
660 if ( $cust_main->bill_locationnum
661 && $cust_main->bill_location->country ne $countrydefault ) {
662 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
664 $invoice_data{'country'} = '';
668 $invoice_data{'address'} = \@address;
670 $invoice_data{'payname'}.
671 ( $cust_main->po_number
672 ? " (P.O. #". $cust_main->po_number. ")"
676 push @address, $cust_main->company
677 if $cust_main->company;
678 push @address, $cust_main->address1;
679 push @address, $cust_main->address2
680 if $cust_main->address2;
682 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
683 push @address, $invoice_data{'country'}
684 if $invoice_data{'country'};
686 while (scalar(@address) < 5);
688 $invoice_data{'logo_file'} = $params{'logo_file'}
689 if $params{'logo_file'};
690 $invoice_data{'barcode_file'} = $params{'barcode_file'}
691 if $params{'barcode_file'};
692 $invoice_data{'barcode_img'} = $params{'barcode_img'}
693 if $params{'barcode_img'};
694 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
695 if $params{'barcode_cid'};
699 # using owed_on_invoice() instead of owed() here for $balance_due
700 # using _items_previous_total() instead of ->previous() for $pr_total
702 # owed_on_invoice() is aware of configuration flags that affect how an
703 # invoice is rendered. May not return actual current balance. Will
704 # return balance appropriate for the invoice being rendered, based
705 # on which past due items, current charges, and future payments are
708 # Going forward, usage of owed(), or bypassing cust_bill helper methods
709 # when generating invoice lines may lead to incorrect or misleading
712 # Helper methods that are aware of invoicing conf flags:
713 # - owed_on_invoice # use instead of owed()
714 # - _items_previous() # use instead of previous()
715 # - _items_credits() # use instead of cust_credit()
716 # - _items_payments()
718 # - _items_previous_total() # use instead of previous()
719 # - _items_payments_total()
720 # - _items_credits_total() # use instead of cust_credit()
722 my $pr_total = $self->_items_previous_total();
724 my $balance_due = $self->owed_on_invoice();
725 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
727 # flag telling this invoice to have a first-page summary
728 my $summarypage = '';
730 if ( $self->custnum && $self->invnum ) {
731 # XXX should be an FS::cust_bill method to set the defaults, instead
732 # of checking the type here
734 # info from customer's last invoice before this one, for some
736 $invoice_data{'last_bill'} = {};
738 # my $last_bill = $self->previous_bill;
739 # if ( $last_bill ) {
741 # Populate template stash for previous balance and payments
743 # Used on summary page as "Previous Balance"
744 $invoice_data{'true_previous_balance'} = sprintf("%.2f", $pr_total);
746 # Used on summary page as "Payments"
747 $invoice_data{'balance_adjustments'} = sprintf("%.2f",
748 $self->_items_payments_total() + $self->_items_credits_total()
751 # Used in invoice template as "Previous Balance"
752 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
754 # $invoice_data{last_bill}{_date}:
755 # Not used in default templates, but may be in use by someone
757 # ! May be a problem field if they are using it... this field
758 # stores the date of the previous invoice... it is possible to
759 # carry a balance, but have the immediately previous invoice paid off.
760 # In this case, this field might be presenting bad data? Not
761 # altering the problematic behavior, because someone might be
762 # expecting this bad behavior in their templates for some other
763 # purpose, such as a "your last bill was dated %_date%"
764 my $last_bill = $self->previous_bill;
765 $invoice_data{'last_bill'}{'_date'}
767 ? $last_bill->_date()
770 # $invoice_data{previous_payments}
771 # Not used in default templates, but may be in use by someone
773 # Returns an array of hrefs representing payments, each with keys:
774 # - _date: epoch timestamp
775 # - date: text formatted date
776 # - amount: money formatted amount string
777 # - payinfo: string from payby_payinfo_pretty()
778 # - paynum: id for cust_pay
779 # - description: Text description for bill line item
781 my @payments = $self->_items_payments();
782 $invoice_data{previous_payments} = \@payments;
784 # $invoice_data{previous_credits}
785 # Not used in default templates, but may be in use by someone
787 # Returns an array of hrefs representing credits, each with keys:
788 # - _date: epoch timestamp
789 # - date: text formatted date
790 # - amount: money formatted amount string
791 # - crednum: id for cust_credit
792 # - description: Text description for bill line item
793 # - creditreason: reason() from cust_credit
795 my @credits = $self->_items_credits();
796 $invoice_data{previous_credits} = \@credits;
798 # Populate formatted date field
799 for my $pmt_href (@payments, @credits) {
800 $pmt_href->{date} = $self->time2str_local(
808 # There are no outstanding invoices = YAPH
809 $invoice_data{'true_previous_balance'} =
810 $invoice_data{'balance_adjustments'} =
811 $invoice_data{'previous_balance'} = '0.00';
812 $invoice_data{'previous_payments'} =
813 $invoice_data{'previous_credits'} = [];
816 # Condencing a lot of debug staements here
818 warn "\$invoice_data{$_}: $invoice_data{$_}"
820 true_previous_balance
828 if ( $conf->config_bool('invoice_usesummary', $agentnum) ) {
829 $invoice_data{'summarypage'} = $summarypage = 1;
832 } # if this is an invoice
834 warn "$me substituting variables in notes, footer, smallfooter\n"
837 my $tc = $self->template_conf;
838 my @include = ( [ $tc, 'notes' ],
839 [ 'invoice_', 'footer' ],
840 [ 'invoice_', 'smallfooter', ],
841 [ 'invoice_', 'watermark' ],
843 push @include, [ $tc, 'coupon', ]
844 unless $params{'no_coupon'};
846 foreach my $i (@include) {
848 # load the configuration for this sub-template
850 my($base, $include) = @$i;
852 my $inc_file = $conf->key_orbase("$base$format$include", $template);
854 my @inc_src = $conf->config($inc_file, $agentnum);
856 my $converter = $convert_maps{$format}{$include};
858 # then attempt to convert LaTeX to the requested format
859 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
860 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
862 # this isn't included in the convert_maps
863 my ($open, $close) = @{ $delimiters{$format} };
868 } # else @inc_src is empty and that's fine
870 # make a Text::Template out of it
872 my $inc_tt = new Text::Template (
874 SOURCE => [ map "$_\n", @inc_src ],
875 DELIMITERS => $delimiters{$format},
876 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
878 unless ( $inc_tt->compile() ) {
879 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
880 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
886 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
888 $invoice_data{$include} =~ s/\n+$//
889 if ($format eq 'latex');
892 # if (well, probably when) we still need PO numbers in the brave new world of
893 # 4.x, then we'll have to add them back as their own customer fields
894 # # let invoices use either of these as needed
895 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
896 # ? $cust_main->payinfo : '';
897 # $invoice_data{'po_line'} =
898 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
899 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
902 my %money_chars = ( 'latex' => '',
903 'html' => $conf->config('money_char') || '$',
906 my $money_char = $money_chars{$format};
909 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
910 'html' => $conf->config('money_char') || '$',
913 my $other_money_char = $other_money_chars{$format};
914 $invoice_data{'dollar'} = $other_money_char;
916 my %minus_signs = ( 'latex' => '$-$',
918 'template' => '- ' );
919 my $minus = $minus_signs{$format};
921 my @detail_items = ();
922 my @total_items = ();
926 $invoice_data{'detail_items'} = \@detail_items;
927 $invoice_data{'total_items'} = \@total_items;
928 $invoice_data{'buf'} = \@buf;
929 $invoice_data{'sections'} = \@sections;
931 warn "$me generating sections\n"
934 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
935 my $multisection = $self->has_sections;
936 $invoice_data{'multisection'} = $multisection;
938 my $extra_sections = [];
939 my $extra_lines = ();
941 # default section ('Charges')
942 my $default_section = { 'description' => '',
947 # Previous Charges section
948 # subtotal is the first return value from $self->previous
949 my $previous_section;
950 # if the invoice has major sections, or if we're summarizing previous
951 # charges with a single line, or if we've been specifically told to put them
952 # in a section, create a section for previous charges:
953 if ( $multisection or
954 $conf->exists('previous_balance-summary_only') or
955 $conf->exists('previous_balance-section') ) {
957 $previous_section = { 'description' => $self->mt('Previous Charges'),
958 'subtotal' => $other_money_char.
959 sprintf('%.2f', $pr_total),
960 'summarized' => '', #why? $summarypage ? 'Y' : '',
963 # Include balance aging line and template variables
964 my @aged_balances = $self->_items_aging_balances();
965 ( $invoice_data{aged_balance_current},
966 $invoice_data{aged_balance_30d},
967 $invoice_data{aged_balance_60d},
968 $invoice_data{aged_balance_90d}
971 if ($conf->exists('invoice_include_aging')) {
972 $previous_section->{posttotal} = sprintf(
973 '0 / 30 / 60 / 90 days overdue %.2f / %.2f / %.2f / %.2f',
979 # otherwise put them in the main section
980 $previous_section = $default_section;
983 my $adjust_section = {
984 'description' => $self->mt('Credits, Payments, and Adjustments'),
985 'adjust_section' => 1,
986 'subtotal' => 0, # adjusted below
988 my $adjust_weight = _pkg_category($adjust_section->{description})
989 ? _pkg_category($adjust_section->{description})->weight
991 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
992 # Note: 'sort_weight' here is actually a flag telling whether there is an
993 # explicit package category for the adjust section. If so, certain behavior
995 $adjust_section->{'sort_weight'} = $adjust_weight;
998 if ( $multisection ) {
999 ($extra_sections, $extra_lines) =
1000 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
1001 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
1002 && $self->can('_items_extra_usage_sections');
1004 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1006 push @detail_items, @$extra_lines if $extra_lines;
1008 # the code is written so that both methods can be used together, but
1009 # we haven't yet changed the template to take advantage of that, so for
1010 # now, treat them as mutually exclusive.
1011 my %section_method = ( by_category => 1 );
1012 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1013 %section_method = ( by_location => 1 );
1015 my ($early, $late) =
1016 $self->_items_sections( 'summary' => $summarypage,
1017 'escape' => $escape_function_nonbsp,
1018 'extra_sections' => $extra_sections,
1019 'format' => $format,
1022 push @sections, @$early;
1023 $late_sections = $late;
1025 if ( $conf->exists('svc_phone_sections')
1026 && $self->can('_items_svc_phone_sections')
1029 my ($phone_sections, $phone_lines) =
1030 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1031 push @{$late_sections}, @$phone_sections;
1032 push @detail_items, @$phone_lines;
1034 if ( $conf->exists('voip-cust_accountcode_cdr')
1035 && $cust_main->accountcode_cdr
1036 && $self->can('_items_accountcode_cdr')
1039 my ($accountcode_section, $accountcode_lines) =
1040 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1041 if ( scalar(@$accountcode_lines) ) {
1042 push @{$late_sections}, $accountcode_section;
1043 push @detail_items, @$accountcode_lines;
1046 } else {# not multisection
1047 # make a default section
1048 push @sections, $default_section;
1049 # and calculate the finance charge total, since it won't get done otherwise.
1050 # and the default section total
1051 # XXX possibly finance_pkgclass should not be used in this manner?
1052 my @finance_charges;
1054 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1055 if ( $invoice_data{finance_section} and
1056 grep { $_->section eq $invoice_data{finance_section} }
1057 $cust_bill_pkg->cust_bill_pkg_display ) {
1058 # I think these are always setup fees, but just to be sure...
1059 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1061 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1064 $invoice_data{finance_amount} =
1065 sprintf('%.2f', sum( @finance_charges ) || 0);
1066 $default_section->{subtotal} = $other_money_char.
1067 sprintf('%.2f', sum( @charges ) || 0);
1070 # start setting up summary subtotals
1071 my @summary_subtotals;
1072 my $method = $conf->config('summary_subtotals_method');
1073 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1074 # then re-section them by the correct method
1075 my %section_method = ( by_category => 1 );
1076 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1077 %section_method = ( by_location => 1 );
1079 my ($early, $late) =
1080 $self->_items_sections( 'summary' => $summarypage,
1081 'escape' => $escape_function_nonbsp,
1082 'extra_sections' => $extra_sections,
1083 'format' => $format,
1086 foreach ( @$early ) {
1087 next if $_->{subtotal} == 0;
1088 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1089 push @summary_subtotals, $_;
1092 # subtotal sectioning is the same as for the actual invoice sections
1093 @summary_subtotals = @sections;
1096 # Hereafter, push sections to both @sections and @summary_subtotals
1097 # if they belong in both places (e.g. tax section). Late sections are
1098 # never in @summary_subtotals.
1100 # previous invoice balances in the Previous Charges section if there
1101 # is one, otherwise in the main detail section
1102 # (except if summary_only is enabled, don't show them at all)
1103 if ( $self->can('_items_previous') &&
1104 $self->enable_previous &&
1105 ! $conf->exists('previous_balance-summary_only') ) {
1107 warn "$me adding previous balances\n"
1110 foreach my $line_item ( $self->_items_previous ) {
1113 ref => $line_item->{'pkgnum'},
1114 pkgpart => $line_item->{'pkgpart'},
1115 #quantity => 1, # not really correct
1116 section => $previous_section, # which might be $default_section
1117 description => &$escape_function($line_item->{'description'}),
1118 ext_description => [ map { &$escape_function($_) }
1119 @{ $line_item->{'ext_description'} || [] }
1121 amount => $money_char . $line_item->{'amount'},
1122 product_code => $line_item->{'pkgpart'} || 'N/A',
1125 push @detail_items, $detail;
1126 push @buf, [ $detail->{'description'},
1127 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1133 if ( $pr_total && $self->enable_previous ) {
1134 push @buf, ['','-----------'];
1135 push @buf, [ $self->mt('Total Previous Balance'),
1136 $money_char. sprintf("%10.2f", $pr_total) ];
1140 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1141 warn "$me adding DID summary\n"
1144 my ($didsummary,$minutes) = $self->_did_summary;
1145 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1147 { 'description' => $didsummary_desc,
1148 'ext_description' => [ $didsummary, $minutes ],
1152 foreach my $section (@sections, @$late_sections) {
1154 # begin some normalization
1155 $section->{'subtotal'} = $section->{'amount'}
1157 && !exists($section->{subtotal})
1158 && exists($section->{amount});
1160 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1161 if ( $invoice_data{finance_section} &&
1162 $section->{'description'} eq $invoice_data{finance_section} );
1164 if ( $multisection ) {
1166 if ( ref($section->{'subtotal'}) ) {
1168 $section->{'subtotal'} =
1169 sprintf("$other_money_char%.2f to $other_money_char%.2f",
1170 $section->{'subtotal'}[0],
1171 $section->{'subtotal'}[1]
1176 $section->{'subtotal'} = $other_money_char.
1177 sprintf('%.2f', $section->{'subtotal'})
1181 # continue some normalization
1182 $section->{'amount'} = $section->{'subtotal'}
1186 if ( $section->{'description'} ) {
1187 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1192 warn "$me setting options\n"
1196 $options{'section'} = $section if $multisection;
1197 $options{'section_with_taxes'} = 1
1198 if $conf->config_bool('invoice_sections_with_taxes', $cust_main->agentnum);
1199 $options{'format'} = $format;
1200 $options{'escape_function'} = $escape_function;
1201 $options{'no_usage'} = 1 unless $unsquelched;
1202 $options{'unsquelched'} = $unsquelched;
1203 $options{'summary_page'} = $summarypage;
1204 $options{'skip_usage'} =
1205 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1206 $options{'preref_callback'} = $params{'preref_callback'};
1208 warn "$me searching for line items\n"
1211 my %section_tax_lines;
1213 foreach my $line_item ( $self->_items_pkg(%options),
1214 $self->_items_fee(%options) ) {
1216 warn "$me adding line item ".
1217 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1220 push @buf, ( [ $line_item->{'description'},
1221 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1223 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1226 $line_item->{'ref'} = $line_item->{'pkgnum'};
1227 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1228 $line_item->{'section'} = $section;
1229 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1230 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1232 if ( length($line_item->{'unit_amount'}) ) {
1233 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1235 $line_item->{'ext_description'} ||= [];
1237 if ( $options{section_with_taxes} && ref $line_item->{pkg_tax} ) {
1238 for my $line_tax ( @{$ line_item->{pkg_tax} } ) {
1240 # It is rarely possible for the same tax record to be presented here
1241 # multiple times. See cust_bill_pkg::_pkg_tax_list for more info
1242 next if $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} };
1243 $seen_tax_lines{ $line_tax->{billpkgtaxlocationnum} } = 1;
1245 $section_tax_lines{ $line_tax->{taxname} } += $line_tax->{amount};
1249 push @detail_items, $line_item;
1252 # If conf flag invoice_sections_with_taxes:
1253 # - Add @detail_items for taxes into each section
1254 # - Update section subtotal to include taxes
1255 if ( $options{section_with_taxes} && %section_tax_lines ) {
1256 for my $taxname ( keys %section_tax_lines ) {
1258 push @detail_items, {
1259 section => $section,
1260 amount => sprintf($money_char."%.2f",$section_tax_lines{$taxname}),
1261 description => &$escape_function($taxname),
1264 # Append taxes to total. If line format resembles "$5.00 to $12.00"
1265 # append to the second value.
1267 # $section->{subtotal} = '$5.00 to 12.00'; # for testing:
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 @items_tax = $self->_items_tax;
1313 my $tax_description = 'Taxes, Surcharges, and Fees';
1315 List::Util::first { $_->{description} eq $tax_description } @sections;
1316 if (!$tax_section) {
1317 $tax_section = { 'description' => $tax_description };
1318 push @sections, $tax_section if $multisection and @items_tax > 0;
1320 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1321 # if this is an existing tax section, we're merging the tax items into it.
1322 # grab the taxtotal that's already there, strip the money symbol if any
1323 my $taxtotal = $tax_section->{'subtotal'} || 0;
1324 $taxtotal =~ s/^\Q$other_money_char\E//;
1327 #my $tax_weight = _pkg_category($tax_section->{description})
1328 # ? _pkg_category($tax_section->{description})->weight
1330 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1331 #$tax_section->{'sort_weight'} = $tax_weight;
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;
1402 unshift @total_items, $total;
1405 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1411 my %embolden_functions = (
1412 'latex' => sub { return '\textbf{'. shift(). '}' },
1413 'html' => sub { return '<b>'. shift(). '</b>' },
1414 'template' => sub { shift },
1416 my $embolden_function = $embolden_functions{$format};
1418 if ( $multisection ) {
1420 if ( $adjust_section->{'sort_weight'} ) {
1421 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1422 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1424 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1425 $other_money_char. sprintf('%.2f', $self->charged );
1430 if ( $self->can('_items_total') ) { # should always be true now
1432 # even for multisection, need plain text version
1434 my @new_total_items = $self->_items_total;
1436 push @buf,['','-----------'];
1438 foreach ( @new_total_items ) {
1439 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1440 $_->{'total_item'} = &$embolden_function( $item );
1442 if ( ref($amount) ) {
1443 $_->{'total_amount'} = &$embolden_function(
1444 $other_money_char.$amount->[0]. ' to '.
1445 $other_money_char.$amount->[1]
1448 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1451 # but if it's multisection, don't append to @total_items. the adjust
1452 # section has all this stuff
1453 push @total_items, $_ if !$multisection;
1454 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1457 push @buf, [ '', '' ];
1459 # if we're showing previous invoices, also show previous
1460 # credits and payments
1461 if ( $self->enable_previous
1462 and $self->can('_items_credits')
1463 and $self->can('_items_payments') )
1467 my $credittotal = 0;
1468 foreach my $credit (
1469 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1473 $total->{'total_item'} = &$escape_function($credit->{'description'});
1474 $credittotal += $credit->{'amount'};
1475 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1476 if ( $multisection ) {
1477 push @detail_items, {
1478 ext_description => [],
1481 description => &$escape_function($credit->{'description'}),
1482 amount => $money_char . $credit->{'amount'},
1484 section => $adjust_section,
1487 push @total_items, $total;
1491 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1494 foreach my $credit (
1495 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1497 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1501 my $paymenttotal = 0;
1502 foreach my $payment (
1503 $self->_items_payments( 'template' => $template )
1506 $total->{'total_item'} = &$escape_function($payment->{'description'});
1507 $paymenttotal += $payment->{'amount'};
1508 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1509 if ( $multisection ) {
1510 push @detail_items, {
1511 ext_description => [],
1514 description => &$escape_function($payment->{'description'}),
1515 amount => $money_char . $payment->{'amount'},
1517 section => $adjust_section,
1520 push @total_items, $total;
1522 push @buf, [ $payment->{'description'},
1523 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1526 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1528 if ( $multisection ) {
1529 $adjust_section->{'subtotal'} = $other_money_char.
1530 sprintf('%.2f', $credittotal + $paymenttotal);
1532 #why this? because {sort_weight} forces the adjust_section to appear
1533 #in @extra_sections instead of @sections. obviously.
1534 push @sections, $adjust_section
1535 unless $adjust_section->{sort_weight};
1536 # do not summarize; adjustments there are shown according to
1540 # create Balance Due message
1543 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1544 $total->{'total_amount'} =
1545 &$embolden_function(
1546 $other_money_char. sprintf('%.2f', #why? $summarypage
1547 # ? $self->charged +
1548 # $self->billing_balance
1553 if ( $multisection && !$adjust_section->{sort_weight} ) {
1554 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1555 $total->{'total_amount'};
1557 push @total_items, $total;
1559 push @buf,['','-----------'];
1560 push @buf,[$self->balance_due_msg, $money_char.
1561 sprintf("%10.2f", $balance_due ) ];
1564 if ( $conf->exists('previous_balance-show_credit')
1565 and $cust_main->balance < 0 ) {
1566 my $credit_total = {
1567 'total_item' => &$embolden_function($self->credit_balance_msg),
1568 'total_amount' => &$embolden_function(
1569 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1572 if ( $multisection ) {
1573 $adjust_section->{'posttotal'} .= $newline_token .
1574 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1577 push @total_items, $credit_total;
1579 push @buf,['','-----------'];
1580 push @buf,[$self->credit_balance_msg, $money_char.
1581 sprintf("%10.2f", -$cust_main->balance ) ];
1585 } #end of default total adding ! can('_items_total')
1587 if ( $multisection ) {
1588 if ( $conf->exists('svc_phone_sections')
1589 && $self->can('_items_svc_phone_sections')
1593 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1594 $total->{'total_amount'} =
1595 &$embolden_function(
1596 $other_money_char. sprintf('%.2f', $balance_due)
1598 my $last_section = pop @sections;
1599 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1600 $total->{'total_amount'};
1601 push @sections, $last_section;
1603 push @sections, @$late_sections
1607 # make a discounts-available section, even without multisection
1608 if ( $conf->exists('discount-show_available')
1609 and my @discounts_avail = $self->_items_discounts_avail ) {
1610 my $discount_section = {
1611 'description' => $self->mt('Discounts Available'),
1616 push @sections, $discount_section; # do not summarize
1617 push @detail_items, map { +{
1618 'ref' => '', #should this be something else?
1619 'section' => $discount_section,
1620 'description' => &$escape_function( $_->{description} ),
1621 'amount' => $money_char . &$escape_function( $_->{amount} ),
1622 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1623 } } @discounts_avail;
1626 # not adding any more sections after this
1627 $invoice_data{summary_subtotals} = \@summary_subtotals;
1630 if ( $conf->exists('usage_class_summary')
1631 and $self->can('_items_usage_class_summary') ) {
1632 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1633 if ( @usage_subtotals ) {
1634 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1635 unshift @detail_items, @usage_subtotals;
1639 # invoice history "section" (not really a section)
1640 # not to be included in any subtotals, completely independent of
1642 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1645 foreach my $cust_bill ( $cust_main->cust_bill ) {
1646 # XXX hardcoded format, and currently only 'charged'; add other fields
1647 # if they become necessary
1648 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1649 $history{$date} ||= 0;
1650 $history{$date} += $cust_bill->charged;
1651 # just so we have a numeric sort key
1652 $monthorder{$date} ||= $cust_bill->_date;
1654 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1656 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1657 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1660 # service locations: another option for template customization
1662 foreach my $item (@detail_items) {
1663 if ( $item->{locationnum} ) {
1664 $location_info{ $item->{locationnum} } ||= {
1665 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1669 $invoice_data{location_info} = \%location_info;
1671 # debugging hook: call this with 'diag' => 1 to just get a hash of
1672 # the invoice variables
1673 return \%invoice_data if ( $params{'diag'} );
1675 # All sections and items are built; now fill in templates.
1676 my @includelist = ();
1677 push @includelist, 'summary' if $summarypage;
1678 foreach my $include ( @includelist ) {
1680 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1683 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1685 @inc_src = $conf->config($inc_file, $agentnum);
1689 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1691 my $convert_map = $convert_maps{$format}{$include};
1693 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1694 s/--\@\]/$delimiters{$format}[1]/g;
1697 &$convert_map( $conf->config($inc_file, $agentnum) );
1701 my $inc_tt = new Text::Template (
1703 SOURCE => [ map "$_\n", @inc_src ],
1704 DELIMITERS => $delimiters{$format},
1705 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1707 unless ( $inc_tt->compile() ) {
1708 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1709 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1713 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1715 $invoice_data{$include} =~ s/\n+$//
1716 if ($format eq 'latex');
1721 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1722 /invoice_lines\((\d*)\)/;
1723 $invoice_lines += $1 || scalar(@buf);
1726 die "no invoice_lines() functions in template?"
1727 if ( $format eq 'template' && !$wasfunc );
1729 if ( $invoice_lines ) {
1730 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1731 $invoice_data{'total_pages'}++
1732 if scalar(@buf) % $invoice_lines;
1735 #setup subroutine for the template
1736 $invoice_data{invoice_lines} = sub {
1737 my $lines = shift || scalar(@buf);
1746 if ($format eq 'template') {
1751 push @collect, split("\n",
1752 $text_template->fill_in( HASH => \%invoice_data )
1754 $invoice_data{'page'}++;
1756 map "$_\n", @collect;
1758 } else { # this is where we actually create the invoice
1760 if ( $params{no_addresses} ) {
1761 delete $invoice_data{$_} foreach qw(
1762 payname company address1 address2 city state zip country
1764 $invoice_data{returnaddress} = '~';
1767 warn "filling in template for invoice ". $self->invnum. "\n"
1769 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1772 $text_template->fill_in(HASH => \%invoice_data);
1776 sub notice_name { '('.shift->table.')'; }
1778 # this is not supposed to happen
1779 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1783 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1785 Returns an postscript invoice, as a scalar.
1787 Options can be passed as a hashref (recommended) or as a list of time, template
1788 and then any key/value pairs for any other options.
1790 I<time> an optional value used to control the printing of overdue messages. The
1791 default is now. It isn't the date of the invoice; that's the `_date' field.
1792 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1793 L<Time::Local> and L<Date::Parse> for conversion functions.
1795 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1802 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1803 my $ps = generate_ps($file);
1805 unlink($barcodefile) if $barcodefile;
1810 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1812 Returns an PDF invoice, as a scalar.
1814 Options can be passed as a hashref (recommended) or as a list of time, template
1815 and then any key/value pairs for any other options.
1817 I<time> an optional value used to control the printing of overdue messages. The
1818 default is now. It isn't the date of the invoice; that's the `_date' field.
1819 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1820 L<Time::Local> and L<Date::Parse> for conversion functions.
1822 I<template>, if specified, is the name of a suffix for alternate invoices.
1824 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1831 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1832 my $pdf = generate_pdf($file);
1834 unlink($barcodefile) if $barcodefile;
1839 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1841 Returns an HTML invoice, as a scalar.
1843 I<time> an optional value used to control the printing of overdue messages. The
1844 default is now. It isn't the date of the invoice; that's the `_date' field.
1845 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1846 L<Time::Local> and L<Date::Parse> for conversion functions.
1848 I<template>, if specified, is the name of a suffix for alternate invoices.
1850 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1852 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1853 when emailing the invoice as part of a multipart/related MIME email.
1861 %params = %{ shift() };
1865 $params{'format'} = 'html';
1867 $self->print_generic( %params );
1870 # quick subroutine for print_latex
1872 # There are ten characters that LaTeX treats as special characters, which
1873 # means that they do not simply typeset themselves:
1874 # # $ % & ~ _ ^ \ { }
1876 # TeX ignores blanks following an escaped character; if you want a blank (as
1877 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1881 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1882 $value =~ s/([<>])/\$$1\$/g;
1888 encode_entities($value);
1892 sub _html_escape_nbsp {
1893 my $value = _html_escape(shift);
1894 $value =~ s/ +/ /g;
1898 #utility methods for print_*
1900 sub _translate_old_latex_format {
1901 warn "_translate_old_latex_format called\n"
1908 if ( $line =~ /^%%Detail\s*$/ ) {
1910 push @template, q![@--!,
1911 q! foreach my $_tr_line (@detail_items) {!,
1912 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1913 q! $_tr_line->{'description'} .= !,
1914 q! "\\tabularnewline\n~~".!,
1915 q! join( "\\tabularnewline\n~~",!,
1916 q! @{$_tr_line->{'ext_description'}}!,
1920 while ( ( my $line_item_line = shift )
1921 !~ /^%%EndDetail\s*$/ ) {
1922 $line_item_line =~ s/'/\\'/g; # nice LTS
1923 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1924 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1925 push @template, " \$OUT .= '$line_item_line';";
1928 push @template, '}',
1931 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1933 push @template, '[@--',
1934 ' foreach my $_tr_line (@total_items) {';
1936 while ( ( my $total_item_line = shift )
1937 !~ /^%%EndTotalDetails\s*$/ ) {
1938 $total_item_line =~ s/'/\\'/g; # nice LTS
1939 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1940 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1941 push @template, " \$OUT .= '$total_item_line';";
1944 push @template, '}',
1948 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1949 push @template, $line;
1955 warn "$_\n" foreach @template;
1967 my $conf = $self->conf;
1969 #check for an invoice-specific override
1970 return $self->invoice_terms if $self->invoice_terms;
1972 #check for a customer- specific override
1973 my $cust_main = $self->cust_main;
1974 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1978 $agentnum = $cust_main->agentnum;
1979 } elsif ( my $prospect_main = $self->prospect_main ) {
1980 $agentnum = $prospect_main->agentnum;
1983 #use configured default
1984 $conf->config('invoice_default_terms', $agentnum) || '';
1994 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1995 $duedate = $self->_date() + ( $1 * 86400 );
1996 } elsif ( $self->terms =~ /^End of Month$/ ) {
1997 my ($mon,$year) = (localtime($self->_date) )[4,5];
1999 until ( $mon < 12 ) { $mon -= 12; $year++; }
2000 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
2001 $duedate = $nextmonth_first - 86400;
2012 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
2015 =item invoice_pay_by_msg
2017 displays the invoice_pay_by_msg or default Please pay by [_1] if empty.
2021 sub invoice_pay_by_msg {
2025 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
2026 || 'Please pay by [_1]';
2027 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')) . ' ';
2032 =item balance_due_msg
2036 sub balance_due_msg {
2038 my $msg = $self->mt('Balance Due');
2039 return $msg unless $self->terms; # huh?
2040 if ( !$self->conf->exists('invoice_show_prior_due_date')
2041 || $self->has_sections ) {
2042 # if enabled, the due date is shown with Total New Charges (see
2043 # _items_total) and not here
2044 # (yes, or if invoice_sections is enabled; this is just for compatibility)
2045 if ( $self->due_date ) {
2046 $msg .= $self->invoice_pay_by_msg
2047 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
2048 } elsif ( $self->terms ) {
2049 $msg .= ' - '. $self->mt($self->terms);
2055 =item balance_due_date
2059 sub balance_due_date {
2061 my $conf = $self->conf;
2063 my $terms = $self->terms;
2064 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2065 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2070 sub credit_balance_msg {
2072 $self->mt('Credit Balance Remaining')
2077 Returns a string with the date, for example: "3/20/2008", localized for the
2078 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2084 $self->time2str_local('short', $self->_date);
2087 =item _date_pretty_unlocalized
2089 Returns a string with the date, for example: "3/20/2008", in the format
2090 configured for the back-office. Use _date_pretty for end-customer display use.
2094 sub _date_pretty_unlocalized {
2096 time2str($date_format, $self->_date);
2101 Emails this template.
2103 Options are passed as a hashref. Available options:
2109 If specified, overrides the default From: address.
2113 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2117 (Deprecated) If specified, is the name of a suffix for alternate template files.
2121 Options accepted by generate_email can also be used.
2127 my $opt = shift || {};
2128 if ($opt and !ref($opt)) {
2129 die ref($self). '->email called with positional parameters';
2132 return if $self->hide;
2134 my $error = send_email(
2135 $self->generate_email(
2136 'subject' => $self->email_subject($opt->{template}),
2137 %$opt, # template, etc.
2141 die "can't email: $error\n" if $error;
2144 =item generate_email OPTION => VALUE ...
2152 sender address, required
2156 alternate template name, optional
2160 email subject, optional
2164 notice name instead of "Invoice", optional
2168 Returns an argument list to be passed to L<FS::Misc::send_email>.
2175 sub generate_email {
2179 my $conf = $self->conf;
2181 my $me = '[FS::Template_Mixin::generate_email]';
2184 'from' => $args{'from'},
2185 'subject' => ($args{'subject'} || $self->email_subject),
2186 'custnum' => $self->custnum,
2187 'msgtype' => 'invoice',
2190 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2192 my $cust_main = $self->cust_main;
2194 if (ref($args{'to'}) eq 'ARRAY') {
2195 $return{'to'} = $args{'to'};
2196 } elsif ( $cust_main ) {
2197 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2200 my $tc = $self->template_conf;
2202 my @text; # array of lines
2203 my $html; # a big string
2204 my @related_parts; # will contain the text/HTML alternative, and images
2205 my $related; # will contain the multipart/related object
2207 if ( $conf->exists($tc. 'email_pdf') ) {
2208 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2210 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2213 my $msg_template = FS::msg_template->by_key($msgnum)
2214 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2215 my $cust_msg = $msg_template->prepare(
2216 cust_main => $self->cust_main,
2218 msgtype => 'invoice',
2221 # XXX hack to make this work in the new cust_msg era; consider replacing
2222 # with cust_bill_send_with_notice events.
2223 my @parts = $cust_msg->parts;
2224 foreach my $part (@parts) { # will only have two parts, normally
2225 if ( $part->mime_type eq 'text/plain' ) {
2226 @text = @{ $part->body };
2227 } elsif ( $part->mime_type eq 'text/html' ) {
2228 $html = $part->bodyhandle->as_string;
2232 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2234 warn "$me using '${tc}email_pdf_note' in multipart message"
2236 @text = $conf->config($tc.'email_pdf_note');
2237 $html = join('<BR>', @text);
2239 } # else use the plain text invoice
2244 if ( $conf->config($tc.'template') ) {
2246 warn "$me generating plain text invoice"
2249 # 'print_text' argument is no longer used
2250 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2254 warn "$me no plain text version exists; sending empty message body"
2261 my $text_part = build MIME::Entity (
2262 'Type' => 'text/plain',
2263 'Encoding' => 'quoted-printable',
2264 'Charset' => 'UTF-8',
2265 #'Encoding' => '7bit',
2267 'Disposition' => 'inline',
2272 if ( $conf->exists($tc.'html') ) {
2273 warn "$me generating HTML invoice"
2276 $args{'from'} =~ /\@([\w\.\-]+)/;
2277 my $from = $1 || 'example.com';
2278 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2281 my $agentnum = $cust_main ? $cust_main->agentnum
2282 : $self->prospect_main->agentnum;
2283 if ( defined($args{'template'}) && length($args{'template'})
2284 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2287 $logo = 'logo_'. $args{'template'}. '.png';
2291 my $image_data = $conf->config_binary( $logo, $agentnum);
2293 push @related_parts, build MIME::Entity
2294 'Type' => 'image/png',
2295 'Encoding' => 'base64',
2296 'Data' => $image_data,
2297 'Filename' => 'logo.png',
2298 'Content-ID' => "<$content_id>",
2301 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2302 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2303 push @related_parts, build MIME::Entity
2304 'Type' => 'image/png',
2305 'Encoding' => 'base64',
2306 'Data' => $self->invoice_barcode(0),
2307 'Filename' => 'barcode.png',
2308 'Content-ID' => "<$barcode_content_id>",
2310 $args{'barcode_cid'} = $barcode_content_id;
2313 $html = $self->print_html({ 'cid'=>$content_id, %args });
2320 warn "$me creating HTML/text multipart message"
2323 $return{'nobody'} = 1;
2325 my $alternative = build MIME::Entity
2326 'Type' => 'multipart/alternative',
2327 #'Encoding' => '7bit',
2328 'Disposition' => 'inline'
2332 $alternative->add_part($text_part);
2335 $alternative->attach(
2336 'Type' => 'text/html',
2337 'Encoding' => 'quoted-printable',
2338 'Data' => [ '<html>',
2341 ' '. encode_entities($return{'subject'}),
2344 ' <body bgcolor="#e8e8e8">',
2345 Encode::encode_utf8($html),
2349 'Disposition' => 'inline',
2350 #'Filename' => 'invoice.pdf',
2353 unshift @related_parts, $alternative;
2355 $related = build MIME::Entity 'Type' => 'multipart/related',
2356 'Encoding' => '7bit';
2358 #false laziness w/Misc::send_email
2359 $related->head->replace('Content-type',
2360 $related->mime_type.
2361 '; boundary="'. $related->head->multipart_boundary. '"'.
2362 '; type=multipart/alternative'
2365 $related->add_part($_) foreach @related_parts;
2369 my @otherparts = ();
2370 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2372 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2374 my $data = join('', map "$_\n",
2375 $self->call_details(prepend_billed_number=>1)
2378 my $zip = new Archive::Zip;
2379 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2380 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2383 my $SH = IO::Scalar->new(\$zipdata);
2384 my $status = $zip->writeToFileHandle($SH);
2385 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2387 push @otherparts, build MIME::Entity
2388 'Type' => 'application/zip',
2389 'Encoding' => 'base64',
2391 'Disposition' => 'attachment',
2392 'Filename' => 'usage-'. $self->invnum. '.zip',
2395 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2397 push @otherparts, build MIME::Entity
2398 'Type' => 'text/csv',
2399 'Encoding' => '7bit',
2400 'Data' => [ map { "$_\n" }
2401 $self->call_details('prepend_billed_number' => 1)
2403 'Disposition' => 'attachment',
2404 'Filename' => 'usage-'. $self->invnum. '.csv',
2411 if ( $conf->exists($tc.'email_pdf') ) {
2416 # multipart/alternative
2422 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2423 push @otherparts, $pdf;
2427 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2429 $return{'mimeparts'} = [ $related, @otherparts ];
2430 $return{'type'} = 'multipart/related'; # of the first part
2432 $return{'mimeparts'} = [ $text_part, @otherparts ];
2433 $return{'type'} = 'text/plain';
2435 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2436 $return{'mimeparts'} = \@related_parts;
2437 $return{'content-type'} = 'multipart/related';
2438 $return{'type'} = 'multipart/alternative';
2439 } else { # no HTML either
2440 $return{'body'} = \@text;
2441 $return{'content-type'} = 'text/plain';
2450 Returns a list suitable for passing to MIME::Entity->build(), representing
2451 this quotation or invoice as PDF attachment.
2458 'Type' => 'application/pdf',
2459 'Encoding' => 'base64',
2460 'Data' => [ $self->print_pdf(@_) ],
2461 'Disposition' => 'attachment',
2462 'Filename' => $self->pdf_filename,
2466 =item postal_mail_fsinc
2468 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2474 use IO::Socket::SSL;
2476 use HTTP::Request::Common qw( POST );
2477 use Cpanel::JSON::XS;
2479 sub postal_mail_fsinc {
2480 my ( $self, %opt ) = @_;
2482 my $url = 'https://ws.freeside.biz/print';
2484 my $cust_main = $self->cust_main;
2485 my $agentnum = $cust_main->agentnum;
2486 my $bill_location = $cust_main->bill_location;
2488 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2489 if $bill_location->country ne 'US';
2491 my $conf = new FS::Conf;
2493 my @company_address = $conf->config('company_address', $agentnum);
2494 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2495 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2496 $company_address1 = $company_address[0];
2497 $company_address2 = $company_address[1];
2499 $company_state = $2;
2501 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2502 $company_address1 = $company_address[0];
2503 $company_address2 = '';
2505 $company_state = $2;
2508 die "Unparsable company_address; contact support\@freeside.biz\n";
2510 $company_city =~ s/,$//;
2512 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2513 my $pages = CAM::PDF->new($file)->numPages;
2515 my $ua = LWP::UserAgent->new(
2517 verify_hostname => 0,
2518 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2519 SSL_version => 'SSLv3',
2522 my $response = $ua->request( POST $url, [
2523 'support-key' => scalar($conf->config('support-key')),
2524 'file' => encode_base64($file),
2528 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2529 'company_address1' => $company_address1,
2530 'company_address2' => $company_address2,
2531 'company_city' => $company_city,
2532 'company_state' => $company_state,
2533 'company_zip' => $company_zip,
2534 'company_country' => 'US',
2535 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2536 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2539 'name' => $cust_main->invoice_attn
2540 || $cust_main->contact_firstlast,
2541 'company' => $cust_main->company,
2542 'address1' => $bill_location->address1,
2543 'address2' => $bill_location->address2,
2544 'city' => $bill_location->city,
2545 'state' => $bill_location->state,
2546 'zip' => $bill_location->zip,
2547 'country' => $bill_location->country,
2550 die "Print connection error: ". $response->message.
2551 ' ('. $response->as_string. ")\n"
2552 unless $response->is_success;
2555 my $content = eval { decode_json($response->content) };
2556 die "Print JSON error : $@\n" if $@;
2558 die $content->{error}."\n"
2559 if $content->{error};
2561 #TODO: store this so we can query for a status later
2562 warn "Invoice printed, ID ". $content->{id}. "\n";
2568 =item _items_sections OPTIONS
2570 Generate section information for all items appearing on this invoice.
2571 This will only be called for multi-section invoices.
2573 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2574 related display records (L<FS::cust_bill_pkg_display>) and organize
2575 them into two groups ("early" and "late" according to whether they come
2576 before or after the total), then into sections. A subtotal is calculated
2579 Section descriptions are returned in sort weight order. Each consists
2580 of a hash containing:
2582 description: the package category name, escaped
2583 subtotal: the total charges in that section
2584 tax_section: a flag indicating that the section contains only tax charges
2585 summarized: same as tax_section, for some reason
2586 sort_weight: the package category's sort weight
2588 If 'condense' is set on the display record, it also contains everything
2589 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2590 coderefs to generate parts of the invoice. This is not advised.
2592 The method returns two arrayrefs, one of "early" sections and one of "late"
2595 OPTIONS may include:
2597 by_location: a flag to divide the invoice into sections by location.
2598 Each section hash will have a 'location' element containing a hashref of
2599 the location fields (see L<FS::cust_location>). The section description
2600 will be the location label, but the template can use any of the location
2601 fields to create a suitable label.
2603 by_category: a flag to divide the invoice into sections using display
2604 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2605 behavior. Each section hash will have a 'category' element containing
2606 the section name from the display record (which probably equals the
2607 category name of the package, but may not in some cases).
2609 summary: a flag indicating that this is a summary-format invoice.
2610 Turning this on has the following effects:
2611 - Ignores display items with the 'summary' flag.
2612 - Places all sections in the "early" group even if they have post_total.
2613 - Creates sections for all non-disabled package categories, even if they
2614 have no charges on this invoice, as well as a section with no name.
2616 escape: an escape function to use for section titles.
2618 extra_sections: an arrayref of additional sections to return after the
2619 sorted list. If there are any of these, section subtotals exclude
2622 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2623 passed through to C<_condense_section()>.
2627 use vars qw(%pkg_category_cache);
2628 sub _items_sections {
2632 my $escape = $opt{escape};
2633 my @extra_sections = @{ $opt{extra_sections} || [] };
2635 # $subtotal{$locationnum}{$categoryname} = amount.
2636 # if we're not using by_location, $locationnum is undef.
2637 # if we're not using by_category, you guessed it, $categoryname is undef.
2638 # if we're not using either one, we shouldn't be here in the first place...
2640 my %late_subtotal = ();
2643 # About tax items + multisection invoices:
2644 # If either invoice_*summary option is enabled, AND there is a
2645 # package category with the name of the tax, then there will be
2646 # a display record assigning the tax item to that category.
2648 # However, the taxes are always placed in the "Taxes, Surcharges,
2649 # and Fees" section regardless of that. The only effect of the
2650 # display record is to create a subtotal for the summary page.
2653 my $pkg_hash = $self->cust_pkg_hash;
2655 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2658 my $usage = $cust_bill_pkg->usage;
2661 if ( $opt{by_location} ) {
2662 if ( $cust_bill_pkg->pkgnum ) {
2663 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2668 $locationnum = undef;
2671 # as in _items_cust_pkg, if a line item has no display records,
2672 # cust_bill_pkg_display() returns a default record for it
2674 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2675 next if ( $display->summary && $opt{summary} );
2677 my $section = $display->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};
3103 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3104 # cache this, so we don't look it up again in every section
3105 my $part_fee = $cust_bill_pkg->get('part_fee')
3106 || $cust_bill_pkg->part_fee;
3107 $cust_bill_pkg->set('part_fee', $part_fee);
3109 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3110 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3113 if ( exists($options{section}) and exists($options{section}{category}) )
3115 my $categoryname = $options{section}{category};
3116 # then filter for items that have that section
3117 if ( $part_fee->categoryname ne $categoryname ) {
3118 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3121 } # otherwise include them all in the main section
3122 # XXX what to do when sectioning by location?
3125 my %base_invnums; # invnum => invoice date
3126 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3127 if ($_->base_invnum) {
3128 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3129 my $base_date = $self->time2str_local('short', $base_bill->_date)
3131 $base_invnums{$_->base_invnum} = $base_date || '';
3134 foreach (sort keys(%base_invnums)) {
3135 next if $_ == $self->invnum;
3136 # per convention, we must escape ext_description lines
3138 &{$escape_function}(
3139 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3142 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3143 # but not escape the base description line
3145 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3146 if $options{section_with_taxes};
3149 { feepart => $cust_bill_pkg->feepart,
3150 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3151 description => $desc,
3152 pkg_tax => \@pkg_tax,
3153 ext_description => \@ext_desc,
3164 warn "$me _items_pkg searching for all package line items\n"
3167 my @cust_bill_pkg = $self->_items_nontax;
3169 warn "$me _items_pkg filtering line items\n"
3171 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3173 if ($options{section} && $options{section}->{condensed}) {
3175 warn "$me _items_pkg condensing section\n"
3179 local $Storable::canonical = 1;
3180 foreach ( @items ) {
3182 delete $item->{ref};
3183 delete $item->{ext_description};
3184 my $key = freeze($item);
3185 $itemshash{$key} ||= 0;
3186 $itemshash{$key} ++; # += $item->{quantity};
3188 @items = sort { $a->{description} cmp $b->{description} }
3189 map { my $i = thaw($_);
3190 $i->{quantity} = $itemshash{$_};
3192 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3198 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3205 return 0 unless $a->itemdesc cmp $b->itemdesc;
3206 return -1 if $b->itemdesc eq 'Tax';
3207 return 1 if $a->itemdesc eq 'Tax';
3208 return -1 if $b->itemdesc eq 'Other surcharges';
3209 return 1 if $a->itemdesc eq 'Other surcharges';
3210 $a->itemdesc cmp $b->itemdesc;
3215 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3216 $self->cust_bill_pkg;
3217 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3219 if ( $self->conf->exists('always_show_tax') ) {
3220 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3221 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3223 { 'description' => $itemdesc,
3230 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3232 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3233 list of hashrefs describing the line items they generate on the invoice.
3235 OPTIONS may include:
3237 format: the invoice format.
3239 escape_function: the function used to escape strings.
3241 DEPRECATED? (expensive, mostly unused?)
3242 format_function: the function used to format CDRs.
3244 section: a hashref containing 'category' and/or 'locationnum'; if this
3245 is present, only returns line items that belong to that category and/or
3246 location (whichever is defined).
3248 multisection: a flag indicating that this is a multisection invoice,
3249 which does something complicated.
3251 section_with_taxes: Look up and include applied taxes for each record
3253 Returns a list of hashrefs, each of which may contain:
3255 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3256 ext_description, which is an arrayref of detail lines to show below
3261 sub _items_cust_bill_pkg {
3263 my $conf = $self->conf;
3264 my $cust_bill_pkgs = shift;
3267 my $format = $opt{format} || '';
3268 my $escape_function = $opt{escape_function} || sub { shift };
3269 my $format_function = $opt{format_function} || '';
3270 my $no_usage = $opt{no_usage} || '';
3271 my $unsquelched = $opt{unsquelched} || ''; #unused
3272 my ($section, $locationnum, $category);
3273 if ( $opt{section} ) {
3274 $category = $opt{section}->{category};
3275 $locationnum = $opt{section}->{locationnum};
3277 my $summary_page = $opt{summary_page} || ''; #unused
3278 my $multisection = defined($category) || defined($locationnum);
3279 # this variable is the value of the config setting, not whether it applies
3280 # to this particular line item.
3281 my $discount_show_always = $conf->exists('discount-show-always');
3283 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3285 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3287 # for location labels: use default location on the invoice date
3288 my $default_locationnum;
3289 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3290 $default_locationnum = 0; # treat them all as non-default
3291 } elsif ( $self->custnum ) {
3293 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3294 $h_cust_main = qsearchs({
3295 'table' => 'h_cust_main',
3296 'hashref' => { custnum => $self->custnum },
3297 'extra_sql' => $h_search[1],
3298 'addl_from' => $h_search[3],
3300 $default_locationnum = $h_cust_main->ship_locationnum;
3301 } elsif ( $self->prospectnum ) {
3302 my $cust_location = qsearchs('cust_location',
3303 { prospectnum => $self->prospectnum,
3305 $default_locationnum = $cust_location->locationnum if $cust_location;
3308 my @b = (); # accumulator for the line item hashes that we'll return
3309 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3310 # the 'current' line item hashes for setup, recur, usage, discount
3311 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3313 # if the current line item is waiting to go out, and the one we're about
3314 # to start is not bundled, then push out the current one and start a new
3317 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3319 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3320 if ( $_ && !$cust_bill_pkg->hidden ) {
3321 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3322 $_->{amount} =~ s/^\-0\.00$/0.00/;
3323 if (exists($_->{unit_amount})) {
3324 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3327 # we already decided to create this display line; don't reconsider it
3329 # if $_->{amount} != 0
3330 # || $discount_show_always
3331 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3332 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3338 if ( $locationnum ) {
3339 # this is a location section; skip packages that aren't at this
3341 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3342 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3346 # Consider display records for this item to determine if it belongs
3347 # in this section. Note that if there are no display records, there
3348 # will be a default pseudo-record that includes all charge types
3349 # and has no section name.
3350 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3351 ? $cust_bill_pkg->cust_bill_pkg_display
3352 : ( $cust_bill_pkg );
3354 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3355 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3358 if ( defined($category) ) {
3359 # then this is a package category section; process all display records
3360 # that belong to this section.
3361 @cust_bill_pkg_display = grep { $_->section eq $category }
3362 @cust_bill_pkg_display;
3364 # otherwise, process all display records that aren't usage summaries
3365 # (I don't think there should be usage summaries if you aren't using
3366 # category sections, but this is the historical behavior)
3367 @cust_bill_pkg_display = grep { !$_->summary }
3368 @cust_bill_pkg_display;
3371 my $classname = ''; # package class name, will fill in later
3373 foreach my $display (@cust_bill_pkg_display) {
3375 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3376 $display->billpkgdisplaynum. "\n"
3379 my $type = $display->type;
3381 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3382 $desc = substr($desc, 0, $maxlength). '...'
3383 if $format eq 'latex' && length($desc) > $maxlength;
3385 my %details_opt = ( 'format' => $format,
3386 'escape_function' => $escape_function,
3387 'format_function' => $format_function,
3388 'no_usage' => $opt{'no_usage'},
3391 if ( $cust_bill_pkg->pkgnum > 0 ) {
3392 # a "normal" package line item (not a quotation, not a fee, not a tax)
3394 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3397 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3398 my $part_pkg = $cust_pkg->part_pkg;
3400 # which pkgpart to show for display purposes?
3401 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3403 # start/end dates for invoice formats that do nonstandard
3405 my %item_dates = ();
3406 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3407 unless $part_pkg->option('disable_line_item_date_ranges',1);
3409 # not normally used, but pass this to the template anyway
3410 $classname = $part_pkg->classname;
3412 my @pkg_tax = $cust_bill_pkg->_pkg_tax_list
3413 if $opt{section_with_taxes};
3415 if ( (!$type || $type eq 'S')
3416 && ( $cust_bill_pkg->setup != 0
3417 || $cust_bill_pkg->setup_show_zero
3418 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3423 warn "$me _items_cust_bill_pkg adding setup\n"
3426 # append the word 'Setup' to the setup line if there's going to be
3427 # a recur line for the same package (i.e. not a one-time charge)
3429 my $description = $desc;
3430 $description .= ' Setup'
3431 if $cust_bill_pkg->recur != 0
3432 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3433 || $cust_bill_pkg->recur_show_zero;
3435 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3437 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3438 # triggered by the recurring charge freq
3440 && $cust_bill_pkg->recur == 0
3441 && ! $cust_bill_pkg->recur_show_zero;
3444 my @svc_labels = ();
3447 unless ( $part_pkg->hide_svc_detail ) {
3449 # still pass the svc_label through to the template, even if
3450 # not displaying it as an ext_description
3451 @svc_labels = map &{$escape_function}($_),
3452 $cust_pkg->h_labels_short($self->_date,
3455 $self->conf->{locale},
3457 $svc_label = $svc_labels[0];
3461 unless ( $part_pkg->hide_svc_detail
3462 || $cust_bill_pkg->hidden )
3465 push @d, @svc_labels
3466 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3467 # show the location label if it's not the customer's default
3468 # location, and we're not grouping items by location already
3469 if ( $cust_pkg->locationnum != $default_locationnum
3470 and !defined($locationnum) ) {
3471 my $loc = $cust_pkg->location_label;
3472 $loc = substr($loc, 0, $maxlength). '...'
3473 if $format eq 'latex' && length($loc) > $maxlength;
3474 push @d, &{$escape_function}($loc);
3477 } #unless hiding service details
3479 push @d, $cust_bill_pkg->details(%details_opt)
3480 if $cust_bill_pkg->recur == 0;
3482 if ( $cust_bill_pkg->hidden ) {
3483 $s->{amount} += $cust_bill_pkg->setup;
3484 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3485 push @{ $s->{ext_description} }, @d;
3488 billpkgnum => $cust_bill_pkg->billpkgnum,
3490 description => $description,
3491 pkgpart => $pkgpart,
3492 pkgnum => $cust_bill_pkg->pkgnum,
3493 amount => $cust_bill_pkg->setup,
3494 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3495 unit_amount => $cust_bill_pkg->unitsetup,
3496 quantity => $cust_bill_pkg->quantity,
3497 ext_description => \@d,
3498 svc_label => ($svc_label || ''),
3499 locationnum => $cust_pkg->locationnum, # sure, why not?
3500 pkg_tax => \@pkg_tax,
3506 # should we show a recur line?
3507 # if type eq 'S', then NO, because we've been told not to.
3508 # otherwise, show the recur line if:
3509 # - there's a recurring charge
3510 # - or recur_show_zero is on
3511 # - or there's a positive unitrecur (so it's been discounted to zero)
3512 # and discount-show-always is on
3513 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3515 $cust_bill_pkg->recur != 0
3517 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3518 || $cust_bill_pkg->recur_show_zero
3523 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3526 my $is_summary = $display->summary;
3527 my $description = $desc;
3528 if ( $type eq 'U' and defined($r) ) {
3529 # don't just show the same description as the recur line
3530 $description = $self->mt('Usage charges');
3533 my $part_pkg = $cust_pkg->part_pkg;
3535 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3539 my @seconds = (); # for display of usage info
3540 my @svc_labels = ();
3543 #at least until cust_bill_pkg has "past" ranges in addition to
3544 #the "future" sdate/edate ones... see #3032
3545 my @dates = ( $self->_date );
3546 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3547 push @dates, $prev->sdate if $prev;
3548 push @dates, undef if !$prev;
3550 unless ( $part_pkg->hide_svc_detail ) {
3551 @svc_labels = map &{$escape_function}($_),
3552 $cust_pkg->h_labels_short(@dates,
3554 $self->conf->{locale});
3555 $svc_label = $svc_labels[0];
3558 # show service labels, unless...
3559 # the package is set not to display them
3560 unless ( $part_pkg->hide_svc_detail
3561 # or this is a tax-like line item
3562 || $cust_bill_pkg->itemdesc
3563 # or this is a hidden (bundled) line item
3564 || $cust_bill_pkg->hidden
3565 # or this is a usage summary line
3566 || $is_summary && $type && $type eq 'U'
3567 # or this is a usage line and there's a recurring line
3568 # for the package in the same section (which will
3569 # have service labels already)
3570 || ($type eq 'U' and defined($r))
3574 warn "$me _items_cust_bill_pkg adding service details\n"
3577 push @d, @svc_labels
3578 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3579 warn "$me _items_cust_bill_pkg done adding service details\n"
3582 # show the location label if it's not the customer's default
3583 # location, and we're not grouping items by location already
3584 if ( $cust_pkg->locationnum != $default_locationnum
3585 and !defined($locationnum) ) {
3586 my $loc = $cust_pkg->location_label;
3587 $loc = substr($loc, 0, $maxlength). '...'
3588 if $format eq 'latex' && length($loc) > $maxlength;
3589 push @d, &{$escape_function}($loc);
3592 # Display of seconds_since_sqlradacct:
3593 # On the invoice, when processing @detail_items, look for a field
3594 # named 'seconds'. This will contain total seconds for each
3595 # service, in the same order as @ext_description. For services
3596 # that don't support this it will show undef.
3597 if ( $conf->exists('svc_acct-usage_seconds')
3598 and ! $cust_bill_pkg->pkgpart_override ) {
3599 foreach my $cust_svc (
3600 $cust_pkg->h_cust_svc(@dates, 'I')
3603 # eval because not having any part_export_usage exports
3604 # is a fatal error, last_bill/_date because that's how
3605 # sqlradius_hour billing does it
3607 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3609 push @seconds, $sec;
3611 } #if svc_acct-usage_seconds
3613 } # if we are showing service labels
3615 unless ( $is_summary ) {
3616 warn "$me _items_cust_bill_pkg adding details\n"
3619 #instead of omitting details entirely in this case (unwanted side
3620 # effects), just omit CDRs
3621 $details_opt{'no_usage'} = 1
3622 if $type && $type eq 'R';
3624 push @d, $cust_bill_pkg->details(%details_opt);
3627 warn "$me _items_cust_bill_pkg calculating amount\n"
3632 $amount = $cust_bill_pkg->recur;
3633 } elsif ($type eq 'R') {
3634 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3635 } elsif ($type eq 'U') {
3636 $amount = $cust_bill_pkg->usage;
3639 if ( !$type || $type eq 'R' ) {
3641 warn "$me _items_cust_bill_pkg adding recur\n"
3645 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3648 if ( $cust_bill_pkg->hidden ) {
3649 $r->{amount} += $amount;
3650 $r->{unit_amount} += $unit_amount;
3651 push @{ $r->{ext_description} }, @d;
3654 billpkgnum => $cust_bill_pkg->billpkgnum,
3655 description => $description,
3656 pkgpart => $pkgpart,
3657 pkgnum => $cust_bill_pkg->pkgnum,
3659 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3660 unit_amount => $unit_amount,
3661 quantity => $cust_bill_pkg->quantity,
3663 ext_description => \@d,
3664 svc_label => ($svc_label || ''),
3665 locationnum => $cust_pkg->locationnum,
3666 pkg_tax => \@pkg_tax,
3668 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3671 } else { # $type eq 'U'
3673 warn "$me _items_cust_bill_pkg adding usage\n"
3676 if ( $cust_bill_pkg->hidden and defined($u) ) {
3677 # if this is a hidden package and there's already a usage
3678 # line for the bundle, add this package's total amount and
3679 # usage details to it
3680 $u->{amount} += $amount;
3681 push @{ $u->{ext_description} }, @d;
3682 } elsif ( $amount ) {
3683 # create a new usage line
3685 billpkgnum => $cust_bill_pkg->billpkgnum,
3686 description => $description,
3687 pkgpart => $pkgpart,
3688 pkgnum => $cust_bill_pkg->pkgnum,
3691 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3693 ext_description => \@d,
3694 locationnum => $cust_pkg->locationnum,
3695 pkg_tax => \@pkg_tax,
3697 } # else this has no usage, so don't create a usage section
3700 } # recurring or usage with recurring charge
3702 } else { # taxes and fees
3704 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3707 # items of this kind should normally not have sdate/edate.
3709 'description' => $desc,
3710 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3711 + $cust_bill_pkg->recur)
3714 } # if package line item / other line item
3716 # decide whether to show active discounts here
3718 # case 1: we are showing a single line for the package
3720 # case 2: we are showing a setup line for a package that has
3721 # no base recurring fee
3722 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3723 # case 3: we are showing a recur line for a package that has
3724 # a base recurring fee
3725 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3728 my $item_discount = $cust_bill_pkg->_item_discount;
3729 if ( $item_discount ) {
3730 # $item_discount->{amount} is negative
3732 if ( $d and $cust_bill_pkg->hidden ) {
3733 $d->{setup_amount} += $item_discount->{setup_amount};
3734 $d->{recur_amount} += $item_discount->{recur_amount};
3736 $d = $item_discount;
3737 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3740 # update the active line (before the discount) to show the
3741 # original price (whether this is a hidden line or not)
3743 $s->{amount} -= $item_discount->{setup_amount} if $s;
3744 $r->{amount} -= $item_discount->{recur_amount} if $r;
3746 } # if there are any discounts
3747 } # if this is an appropriate place to show discounts
3749 } # foreach $display
3753 # discount amount is internally split up
3755 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3758 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3760 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3761 if exists($_->{amount});
3762 $_->{amount} =~ s/^\-0\.00$/0.00/;
3763 if (exists($_->{unit_amount})) {
3764 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3768 #if $_->{amount} != 0
3769 # || $discount_show_always
3770 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3771 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3775 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3782 =item _items_discounts_avail
3784 Returns an array of line item hashrefs representing available term discounts
3785 for this invoice. This makes the same assumptions that apply to term
3786 discounts in general: that the package is billed monthly, at a flat rate,
3787 with no usage charges. A prorated first month will be handled, as will
3788 a setup fee if the discount is allowed to apply to setup fees.
3792 sub _items_discounts_avail {
3795 #maybe move this method from cust_bill when quotations support discount_plans
3796 return () unless $self->can('discount_plans');
3797 my %plans = $self->discount_plans;
3799 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3800 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3804 my $plan = $plans{$months};
3806 my $term_total = sprintf('%.2f', $plan->discounted_total);
3807 my $percent = sprintf('%.0f',
3808 100 * (1 - $term_total / $plan->base_total) );
3809 my $permonth = sprintf('%.2f', $term_total / $months);
3810 my $detail = $self->mt('discount on item'). ' '.
3811 join(', ', map { "#$_" } $plan->pkgnums)
3814 # discounts for non-integer months don't work anyway
3815 $months = sprintf("%d", $months);
3818 description => $self->mt('Save [_1]% by paying for [_2] months',
3820 amount => $self->mt('[_1] ([_2] per month)',
3821 $term_total, $money_char.$permonth),
3822 ext_description => ($detail || ''),
3825 sort { $b <=> $a } keys %plans;
3829 =item has_sections AGENTNUM
3831 Return true if invoice_sections should be enabled for this bill.
3832 (Inherited by both cust_bill and cust_bill_void)
3835 * False if not an invoice
3836 * True always if conf invoice_sections is enabled
3837 * True always if sections_by_location is enabled
3838 * True if conf invoice_sections_multilocation > 1,
3839 and location_count >= invoice_sections_multilocation
3845 my ($self, $agentnum) = @_;
3847 return 0 unless $self->invnum > 0;
3849 $agentnum ||= $self->agentnum;
3850 return 1 if $self->conf->config_bool('invoice_sections', $agentnum);
3851 return 1 if $self->conf->exists('sections_by_location', $agentnum);
3853 my $location_min = $self->conf->config(
3854 'invoice_sections_multilocation', $agentnum,
3859 && $self->location_count >= $location_min;
3865 =item location_count
3867 Return the number of locations billed on this invoice
3871 sub location_count {
3873 return 0 unless $self->invnum;
3875 # SELECT COUNT( DISTINCT cust_pkg.locationnum )
3876 # FROM cust_bill_pkg
3877 # LEFT JOIN cust_pkg USING (pkgnum)
3878 # WHERE invnum = 278
3879 # AND cust_bill_pkg.pkgnum > 0
3881 my $result = qsearchs({
3882 select => 'COUNT(DISTINCT cust_pkg.locationnum) as location_count',
3883 table => 'cust_bill_pkg',
3884 addl_from => 'LEFT JOIN cust_pkg USING (pkgnum)',
3885 extra_sql => 'WHERE invnum = '.dbh->quote( $self->invnum )
3886 . ' AND cust_bill_pkg.pkgnum > 0'
3888 ref $result ? $result->location_count : 0;