4 use vars qw( @ISA $DEBUG $me
5 $money_char $date_format $rdate_format $date_format_long );
7 use vars qw( $invoice_lines @buf ); #yuck
8 use Fcntl qw(:flock); #for spool_csv
10 use List::Util qw(min max sum);
13 use Text::Template 1.20;
15 use String::ShellQuote;
18 use Storable qw( freeze thaw );
20 use FS::UID qw( datasrc );
21 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
22 use FS::Record qw( qsearch qsearchs dbh );
23 use FS::cust_main_Mixin;
25 use FS::cust_statement;
26 use FS::cust_bill_pkg;
27 use FS::cust_bill_pkg_display;
28 use FS::cust_bill_pkg_detail;
32 use FS::cust_credit_bill;
34 use FS::cust_pay_batch;
35 use FS::cust_bill_event;
38 use FS::cust_bill_pay;
39 use FS::cust_bill_pay_batch;
40 use FS::part_bill_event;
43 use FS::cust_bill_batch;
44 use FS::cust_bill_pay_pkg;
45 use FS::cust_credit_bill_pkg;
46 use FS::discount_plan;
49 @ISA = qw( FS::cust_main_Mixin FS::Record );
52 $me = '[FS::cust_bill]';
54 #ask FS::UID to run this stuff for us later
55 FS::UID->install_callback( sub {
56 my $conf = new FS::Conf; #global
57 $money_char = $conf->config('money_char') || '$';
58 $date_format = $conf->config('date_format') || '%x'; #/YY
59 $rdate_format = $conf->config('date_format') || '%m/%d/%Y'; #/YYYY
60 $date_format_long = $conf->config('date_format_long') || '%b %o, %Y';
65 FS::cust_bill - Object methods for cust_bill records
71 $record = new FS::cust_bill \%hash;
72 $record = new FS::cust_bill { 'column' => 'value' };
74 $error = $record->insert;
76 $error = $new_record->replace($old_record);
78 $error = $record->delete;
80 $error = $record->check;
82 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
84 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
86 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
88 @cust_pay_objects = $cust_bill->cust_pay;
90 $tax_amount = $record->tax;
92 @lines = $cust_bill->print_text;
93 @lines = $cust_bill->print_text $time;
97 An FS::cust_bill object represents an invoice; a declaration that a customer
98 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
99 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
100 following fields are currently supported:
106 =item invnum - primary key (assigned automatically for new invoices)
108 =item custnum - customer (see L<FS::cust_main>)
110 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
111 L<Time::Local> and L<Date::Parse> for conversion functions.
113 =item charged - amount of this invoice
115 =item invoice_terms - optional terms override for this specific invoice
119 Customer info at invoice generation time
123 =item previous_balance
125 =item billing_balance
133 =item printed - deprecated
141 =item closed - books closed flag, empty or `Y'
143 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
145 =item agent_invid - legacy invoice number
147 =item promised_date - customer promised payment date, for collection
157 Creates a new invoice. To add the invoice to the database, see L<"insert">.
158 Invoices are normally created by calling the bill method of a customer object
159 (see L<FS::cust_main>).
163 sub table { 'cust_bill'; }
165 sub cust_linked { $_[0]->cust_main_custnum; }
166 sub cust_unlinked_msg {
168 "WARNING: can't find cust_main.custnum ". $self->custnum.
169 ' (cust_bill.invnum '. $self->invnum. ')';
174 Adds this invoice to the database ("Posts" the invoice). If there is an error,
175 returns the error, otherwise returns false.
181 warn "$me insert called\n" if $DEBUG;
183 local $SIG{HUP} = 'IGNORE';
184 local $SIG{INT} = 'IGNORE';
185 local $SIG{QUIT} = 'IGNORE';
186 local $SIG{TERM} = 'IGNORE';
187 local $SIG{TSTP} = 'IGNORE';
188 local $SIG{PIPE} = 'IGNORE';
190 my $oldAutoCommit = $FS::UID::AutoCommit;
191 local $FS::UID::AutoCommit = 0;
194 my $error = $self->SUPER::insert;
196 $dbh->rollback if $oldAutoCommit;
200 if ( $self->get('cust_bill_pkg') ) {
201 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
202 $cust_bill_pkg->invnum($self->invnum);
203 my $error = $cust_bill_pkg->insert;
205 $dbh->rollback if $oldAutoCommit;
206 return "can't create invoice line item: $error";
211 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
218 This method now works but you probably shouldn't use it. Instead, apply a
219 credit against the invoice.
221 Using this method to delete invoices outright is really, really bad. There
222 would be no record you ever posted this invoice, and there are no check to
223 make sure charged = 0 or that there are no associated cust_bill_pkg records.
225 Really, don't use it.
231 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
233 local $SIG{HUP} = 'IGNORE';
234 local $SIG{INT} = 'IGNORE';
235 local $SIG{QUIT} = 'IGNORE';
236 local $SIG{TERM} = 'IGNORE';
237 local $SIG{TSTP} = 'IGNORE';
238 local $SIG{PIPE} = 'IGNORE';
240 my $oldAutoCommit = $FS::UID::AutoCommit;
241 local $FS::UID::AutoCommit = 0;
244 foreach my $table (qw(
256 foreach my $linked ( $self->$table() ) {
257 my $error = $linked->delete;
259 $dbh->rollback if $oldAutoCommit;
266 my $error = $self->SUPER::delete(@_);
268 $dbh->rollback if $oldAutoCommit;
272 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
278 =item replace [ OLD_RECORD ]
280 You can, but probably shouldn't modify invoices...
282 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
283 supplied, replaces this record. If there is an error, returns the error,
284 otherwise returns false.
288 #replace can be inherited from Record.pm
290 # replace_check is now the preferred way to #implement replace data checks
291 # (so $object->replace() works without an argument)
294 my( $new, $old ) = ( shift, shift );
295 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
296 #return "Can't change _date!" unless $old->_date eq $new->_date;
297 return "Can't change _date" unless $old->_date == $new->_date;
298 return "Can't change charged" unless $old->charged == $new->charged
299 || $old->charged == 0
300 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
306 =item add_cc_surcharge
312 sub add_cc_surcharge {
313 my ($self, $pkgnum, $amount) = (shift, shift, shift);
316 my $cust_bill_pkg = new FS::cust_bill_pkg({
317 'invnum' => $self->invnum,
321 $error = $cust_bill_pkg->insert;
322 return $error if $error;
324 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
325 $self->charged($self->charged+$amount);
326 $error = $self->replace;
327 return $error if $error;
329 $self->apply_payments_and_credits;
335 Checks all fields to make sure this is a valid invoice. If there is an error,
336 returns the error, otherwise returns false. Called by the insert and replace
345 $self->ut_numbern('invnum')
346 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
347 || $self->ut_numbern('_date')
348 || $self->ut_money('charged')
349 || $self->ut_numbern('printed')
350 || $self->ut_enum('closed', [ '', 'Y' ])
351 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
352 || $self->ut_numbern('agent_invid') #varchar?
354 return $error if $error;
356 $self->_date(time) unless $self->_date;
358 $self->printed(0) if $self->printed eq '';
365 Returns the displayed invoice number for this invoice: agent_invid if
366 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
372 my $conf = $self->conf;
373 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
374 return $self->agent_invid;
376 return $self->invnum;
382 Returns a list consisting of the total previous balance for this customer,
383 followed by the previous outstanding invoices (as FS::cust_bill objects also).
390 my @cust_bill = sort { $a->_date <=> $b->_date }
391 grep { $_->owed != 0 }
392 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
393 #'_date' => { op=>'<', value=>$self->_date },
394 'invnum' => { op=>'<', value=>$self->invnum },
397 foreach ( @cust_bill ) { $total += $_->owed; }
401 =item enable_previous
403 Whether to show the 'Previous Charges' section when printing this invoice.
404 The negation of the 'disable_previous_balance' config setting.
408 sub enable_previous {
410 my $agentnum = $self->cust_main->agentnum;
411 !$self->conf->exists('disable_previous_balance', $agentnum);
416 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
423 { 'table' => 'cust_bill_pkg',
424 'hashref' => { 'invnum' => $self->invnum },
425 'order_by' => 'ORDER BY billpkgnum',
430 =item cust_bill_pkg_pkgnum PKGNUM
432 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
437 sub cust_bill_pkg_pkgnum {
438 my( $self, $pkgnum ) = @_;
440 { 'table' => 'cust_bill_pkg',
441 'hashref' => { 'invnum' => $self->invnum,
444 'order_by' => 'ORDER BY billpkgnum',
451 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
458 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
459 $self->cust_bill_pkg;
461 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
466 Returns true if any of the packages (or their definitions) corresponding to the
467 line items for this invoice have the no_auto flag set.
473 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
476 =item open_cust_bill_pkg
478 Returns the open line items for this invoice.
480 Note that cust_bill_pkg with both setup and recur fees are returned as two
481 separate line items, each with only one fee.
485 # modeled after cust_main::open_cust_bill
486 sub open_cust_bill_pkg {
489 # grep { $_->owed > 0 } $self->cust_bill_pkg
491 my %other = ( 'recur' => 'setup',
492 'setup' => 'recur', );
494 foreach my $field ( qw( recur setup )) {
495 push @open, map { $_->set( $other{$field}, 0 ); $_; }
496 grep { $_->owed($field) > 0 }
497 $self->cust_bill_pkg;
503 =item cust_bill_event
505 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
509 sub cust_bill_event {
511 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
514 =item num_cust_bill_event
516 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
520 sub num_cust_bill_event {
523 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
524 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
525 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
526 $sth->fetchrow_arrayref->[0];
531 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
535 #false laziness w/cust_pkg.pm
539 'table' => 'cust_event',
540 'addl_from' => 'JOIN part_event USING ( eventpart )',
541 'hashref' => { 'tablenum' => $self->invnum },
542 'extra_sql' => " AND eventtable = 'cust_bill' ",
548 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
552 #false laziness w/cust_pkg.pm
556 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
557 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
558 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
559 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
560 $sth->fetchrow_arrayref->[0];
565 Returns the customer (see L<FS::cust_main>) for this invoice.
571 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
574 =item cust_suspend_if_balance_over AMOUNT
576 Suspends the customer associated with this invoice if the total amount owed on
577 this invoice and all older invoices is greater than the specified amount.
579 Returns a list: an empty list on success or a list of errors.
583 sub cust_suspend_if_balance_over {
584 my( $self, $amount ) = ( shift, shift );
585 my $cust_main = $self->cust_main;
586 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
589 $cust_main->suspend(@_);
595 Depreciated. See the cust_credited method.
597 #Returns a list consisting of the total previous credited (see
598 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
599 #outstanding credits (FS::cust_credit objects).
605 croak "FS::cust_bill->cust_credit depreciated; see ".
606 "FS::cust_bill->cust_credit_bill";
609 #my @cust_credit = sort { $a->_date <=> $b->_date }
610 # grep { $_->credited != 0 && $_->_date < $self->_date }
611 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
613 #foreach (@cust_credit) { $total += $_->credited; }
614 #$total, @cust_credit;
619 Depreciated. See the cust_bill_pay method.
621 #Returns all payments (see L<FS::cust_pay>) for this invoice.
627 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
629 #sort { $a->_date <=> $b->_date }
630 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
636 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
639 sub cust_bill_pay_batch {
641 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
646 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
652 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
653 sort { $a->_date <=> $b->_date }
654 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
659 =item cust_credit_bill
661 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
667 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
668 sort { $a->_date <=> $b->_date }
669 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
673 sub cust_credit_bill {
674 shift->cust_credited(@_);
677 #=item cust_bill_pay_pkgnum PKGNUM
679 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
680 #with matching pkgnum.
684 #sub cust_bill_pay_pkgnum {
685 # my( $self, $pkgnum ) = @_;
686 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
687 # sort { $a->_date <=> $b->_date }
688 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
689 # 'pkgnum' => $pkgnum,
694 =item cust_bill_pay_pkg PKGNUM
696 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
697 applied against the matching pkgnum.
701 sub cust_bill_pay_pkg {
702 my( $self, $pkgnum ) = @_;
705 'select' => 'cust_bill_pay_pkg.*',
706 'table' => 'cust_bill_pay_pkg',
707 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
708 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
709 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
710 " AND cust_bill_pkg.pkgnum = $pkgnum",
715 #=item cust_credited_pkgnum PKGNUM
717 #=item cust_credit_bill_pkgnum PKGNUM
719 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
720 #with matching pkgnum.
724 #sub cust_credited_pkgnum {
725 # my( $self, $pkgnum ) = @_;
726 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
727 # sort { $a->_date <=> $b->_date }
728 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
729 # 'pkgnum' => $pkgnum,
734 #sub cust_credit_bill_pkgnum {
735 # shift->cust_credited_pkgnum(@_);
738 =item cust_credit_bill_pkg PKGNUM
740 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
741 applied against the matching pkgnum.
745 sub cust_credit_bill_pkg {
746 my( $self, $pkgnum ) = @_;
749 'select' => 'cust_credit_bill_pkg.*',
750 'table' => 'cust_credit_bill_pkg',
751 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
752 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
753 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
754 " AND cust_bill_pkg.pkgnum = $pkgnum",
759 =item cust_bill_batch
761 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
765 sub cust_bill_batch {
767 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
772 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
773 hash keyed by term length.
779 FS::discount_plan->all($self);
784 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
791 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
793 foreach (@taxlines) { $total += $_->setup; }
799 Returns the amount owed (still outstanding) on this invoice, which is charged
800 minus all payment applications (see L<FS::cust_bill_pay>) and credit
801 applications (see L<FS::cust_credit_bill>).
807 my $balance = $self->charged;
808 $balance -= $_->amount foreach ( $self->cust_bill_pay );
809 $balance -= $_->amount foreach ( $self->cust_credited );
810 $balance = sprintf( "%.2f", $balance);
811 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
816 my( $self, $pkgnum ) = @_;
818 #my $balance = $self->charged;
820 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
822 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
823 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
825 $balance = sprintf( "%.2f", $balance);
826 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
832 Returns true if this invoice should be hidden. See the
833 selfservice-hide_invoices-taxclass configuraiton setting.
839 my $conf = $self->conf;
840 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
842 my @cust_bill_pkg = $self->cust_bill_pkg;
843 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
844 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
847 =item apply_payments_and_credits [ OPTION => VALUE ... ]
849 Applies unapplied payments and credits to this invoice.
851 A hash of optional arguments may be passed. Currently "manual" is supported.
852 If true, a payment receipt is sent instead of a statement when
853 'payment_receipt_email' configuration option is set.
855 If there is an error, returns the error, otherwise returns false.
859 sub apply_payments_and_credits {
860 my( $self, %options ) = @_;
861 my $conf = $self->conf;
863 local $SIG{HUP} = 'IGNORE';
864 local $SIG{INT} = 'IGNORE';
865 local $SIG{QUIT} = 'IGNORE';
866 local $SIG{TERM} = 'IGNORE';
867 local $SIG{TSTP} = 'IGNORE';
868 local $SIG{PIPE} = 'IGNORE';
870 my $oldAutoCommit = $FS::UID::AutoCommit;
871 local $FS::UID::AutoCommit = 0;
874 $self->select_for_update; #mutex
876 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
877 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
879 if ( $conf->exists('pkg-balances') ) {
880 # limit @payments & @credits to those w/ a pkgnum grepped from $self
881 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
882 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
883 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
886 while ( $self->owed > 0 and ( @payments || @credits ) ) {
889 if ( @payments && @credits ) {
891 #decide which goes first by weight of top (unapplied) line item
893 my @open_lineitems = $self->open_cust_bill_pkg;
896 max( map { $_->part_pkg->pay_weight || 0 }
901 my $max_credit_weight =
902 max( map { $_->part_pkg->credit_weight || 0 }
908 #if both are the same... payments first? it has to be something
909 if ( $max_pay_weight >= $max_credit_weight ) {
915 } elsif ( @payments ) {
917 } elsif ( @credits ) {
920 die "guru meditation #12 and 35";
924 if ( $app eq 'pay' ) {
926 my $payment = shift @payments;
927 $unapp_amount = $payment->unapplied;
928 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
929 $app->pkgnum( $payment->pkgnum )
930 if $conf->exists('pkg-balances') && $payment->pkgnum;
932 } elsif ( $app eq 'credit' ) {
934 my $credit = shift @credits;
935 $unapp_amount = $credit->credited;
936 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
937 $app->pkgnum( $credit->pkgnum )
938 if $conf->exists('pkg-balances') && $credit->pkgnum;
941 die "guru meditation #12 and 35";
945 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
946 warn "owed_pkgnum ". $app->pkgnum;
947 $owed = $self->owed_pkgnum($app->pkgnum);
951 next unless $owed > 0;
953 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
954 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
956 $app->invnum( $self->invnum );
958 my $error = $app->insert(%options);
960 $dbh->rollback if $oldAutoCommit;
961 return "Error inserting ". $app->table. " record: $error";
963 die $error if $error;
967 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
972 =item generate_email OPTION => VALUE ...
980 sender address, required
984 alternate template name, optional
988 text attachment arrayref, optional
992 email subject, optional
996 notice name instead of "Invoice", optional
1000 Returns an argument list to be passed to L<FS::Misc::send_email>.
1006 sub generate_email {
1010 my $conf = $self->conf;
1012 my $me = '[FS::cust_bill::generate_email]';
1015 'from' => $args{'from'},
1016 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
1020 'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
1021 'template' => $args{'template'},
1022 'notice_name' => ( $args{'notice_name'} || 'Invoice' ),
1023 'no_coupon' => $args{'no_coupon'},
1026 my $cust_main = $self->cust_main;
1028 if (ref($args{'to'}) eq 'ARRAY') {
1029 $return{'to'} = $args{'to'};
1031 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1032 $cust_main->invoicing_list
1036 if ( $conf->exists('invoice_html') ) {
1038 warn "$me creating HTML/text multipart message"
1041 $return{'nobody'} = 1;
1043 my $alternative = build MIME::Entity
1044 'Type' => 'multipart/alternative',
1045 #'Encoding' => '7bit',
1046 'Disposition' => 'inline'
1050 if ( $conf->exists('invoice_email_pdf')
1051 and scalar($conf->config('invoice_email_pdf_note')) ) {
1053 warn "$me using 'invoice_email_pdf_note' in multipart message"
1055 $data = [ map { $_ . "\n" }
1056 $conf->config('invoice_email_pdf_note')
1061 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1063 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1064 $data = $args{'print_text'};
1066 $data = [ $self->print_text(\%opt) ];
1071 $alternative->attach(
1072 'Type' => 'text/plain',
1073 'Encoding' => 'quoted-printable',
1074 #'Encoding' => '7bit',
1076 'Disposition' => 'inline',
1083 if ( $conf->exists('invoice_email_pdf')
1084 and scalar($conf->config('invoice_email_pdf_note')) ) {
1086 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1090 $args{'from'} =~ /\@([\w\.\-]+)/;
1091 my $from = $1 || 'example.com';
1092 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1095 my $agentnum = $cust_main->agentnum;
1096 if ( defined($args{'template'}) && length($args{'template'})
1097 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1100 $logo = 'logo_'. $args{'template'}. '.png';
1104 my $image_data = $conf->config_binary( $logo, $agentnum);
1106 $image = build MIME::Entity
1107 'Type' => 'image/png',
1108 'Encoding' => 'base64',
1109 'Data' => $image_data,
1110 'Filename' => 'logo.png',
1111 'Content-ID' => "<$content_id>",
1114 if ($conf->exists('invoice-barcode')) {
1115 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1116 $barcode = build MIME::Entity
1117 'Type' => 'image/png',
1118 'Encoding' => 'base64',
1119 'Data' => $self->invoice_barcode(0),
1120 'Filename' => 'barcode.png',
1121 'Content-ID' => "<$barcode_content_id>",
1123 $opt{'barcode_cid'} = $barcode_content_id;
1126 $htmldata = $self->print_html({ 'cid'=>$content_id, %opt });
1129 $alternative->attach(
1130 'Type' => 'text/html',
1131 'Encoding' => 'quoted-printable',
1132 'Data' => [ '<html>',
1135 ' '. encode_entities($return{'subject'}),
1138 ' <body bgcolor="#e8e8e8">',
1143 'Disposition' => 'inline',
1144 #'Filename' => 'invoice.pdf',
1148 my @otherparts = ();
1149 if ( $cust_main->email_csv_cdr ) {
1151 push @otherparts, build MIME::Entity
1152 'Type' => 'text/csv',
1153 'Encoding' => '7bit',
1154 'Data' => [ map { "$_\n" }
1155 $self->call_details('prepend_billed_number' => 1)
1157 'Disposition' => 'attachment',
1158 'Filename' => 'usage-'. $self->invnum. '.csv',
1163 if ( $conf->exists('invoice_email_pdf') ) {
1168 # multipart/alternative
1174 my $related = build MIME::Entity 'Type' => 'multipart/related',
1175 'Encoding' => '7bit';
1177 #false laziness w/Misc::send_email
1178 $related->head->replace('Content-type',
1179 $related->mime_type.
1180 '; boundary="'. $related->head->multipart_boundary. '"'.
1181 '; type=multipart/alternative'
1184 $related->add_part($alternative);
1186 $related->add_part($image) if $image;
1188 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1190 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1194 #no other attachment:
1196 # multipart/alternative
1201 $return{'content-type'} = 'multipart/related';
1202 if ($conf->exists('invoice-barcode') && $barcode) {
1203 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1205 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1207 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1208 #$return{'disposition'} = 'inline';
1214 if ( $conf->exists('invoice_email_pdf') ) {
1215 warn "$me creating PDF attachment"
1218 #mime parts arguments a la MIME::Entity->build().
1219 $return{'mimeparts'} = [
1220 { $self->mimebuild_pdf(\%opt) }
1224 if ( $conf->exists('invoice_email_pdf')
1225 and scalar($conf->config('invoice_email_pdf_note')) ) {
1227 warn "$me using 'invoice_email_pdf_note'"
1229 $return{'body'} = [ map { $_ . "\n" }
1230 $conf->config('invoice_email_pdf_note')
1235 warn "$me not using 'invoice_email_pdf_note'"
1237 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1238 $return{'body'} = $args{'print_text'};
1240 $return{'body'} = [ $self->print_text(\%opt) ];
1253 Returns a list suitable for passing to MIME::Entity->build(), representing
1254 this invoice as PDF attachment.
1261 'Type' => 'application/pdf',
1262 'Encoding' => 'base64',
1263 'Data' => [ $self->print_pdf(@_) ],
1264 'Disposition' => 'attachment',
1265 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1269 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1271 Sends this invoice to the destinations configured for this customer: sends
1272 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1274 Options can be passed as a hashref (recommended) or as a list of up to
1275 four values for templatename, agentnum, invoice_from and amount.
1277 I<template>, if specified, is the name of a suffix for alternate invoices.
1279 I<agentnum>, if specified, means that this invoice will only be sent for customers
1280 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
1281 single agent) or an arrayref of agentnums.
1283 I<invoice_from>, if specified, overrides the default email invoice From: address.
1285 I<amount>, if specified, only sends the invoice if the total amount owed on this
1286 invoice and all older invoices is greater than the specified amount.
1288 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1292 sub queueable_send {
1295 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1296 or die "invalid invoice number: " . $opt{invnum};
1298 my @args = ( $opt{template}, $opt{agentnum} );
1299 push @args, $opt{invoice_from}
1300 if exists($opt{invoice_from}) && $opt{invoice_from};
1302 my $error = $self->send( @args );
1303 die $error if $error;
1309 my $conf = $self->conf;
1311 my( $template, $invoice_from, $notice_name );
1313 my $balance_over = 0;
1317 $template = $opt->{'template'} || '';
1318 if ( $agentnums = $opt->{'agentnum'} ) {
1319 $agentnums = [ $agentnums ] unless ref($agentnums);
1321 $invoice_from = $opt->{'invoice_from'};
1322 $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1323 $notice_name = $opt->{'notice_name'};
1325 $template = scalar(@_) ? shift : '';
1326 if ( scalar(@_) && $_[0] ) {
1327 $agentnums = ref($_[0]) ? shift : [ shift ];
1329 $invoice_from = shift if scalar(@_);
1330 $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1333 my $cust_main = $self->cust_main;
1335 return 'N/A' unless ! $agentnums
1336 or grep { $_ == $cust_main->agentnum } @$agentnums;
1339 unless $cust_main->total_owed_date($self->_date) > $balance_over;
1341 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1342 $conf->config('invoice_from', $cust_main->agentnum );
1345 'template' => $template,
1346 'invoice_from' => $invoice_from,
1347 'notice_name' => ( $notice_name || 'Invoice' ),
1350 my @invoicing_list = $cust_main->invoicing_list;
1352 #$self->email_invoice(\%opt)
1354 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1355 && ! $self->invoice_noemail;
1357 #$self->print_invoice(\%opt)
1359 if grep { $_ eq 'POST' } @invoicing_list; #postal
1361 $self->fax_invoice(\%opt)
1362 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1368 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1370 Emails this invoice.
1372 Options can be passed as a hashref (recommended) or as a list of up to
1373 two values for templatename and invoice_from.
1375 I<template>, if specified, is the name of a suffix for alternate invoices.
1377 I<invoice_from>, if specified, overrides the default email invoice From: address.
1379 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1383 sub queueable_email {
1386 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1387 or die "invalid invoice number: " . $opt{invnum};
1389 my %args = ( 'template' => $opt{template} );
1390 $args{$_} = $opt{$_}
1391 foreach grep { exists($opt{$_}) && $opt{$_} }
1392 qw( invoice_from notice_name no_coupon );
1394 my $error = $self->email( \%args );
1395 die $error if $error;
1399 #sub email_invoice {
1402 return if $self->hide;
1403 my $conf = $self->conf;
1405 my( $template, $invoice_from, $notice_name, $no_coupon );
1408 $template = $opt->{'template'} || '';
1409 $invoice_from = $opt->{'invoice_from'};
1410 $notice_name = $opt->{'notice_name'} || 'Invoice';
1411 $no_coupon = $opt->{'no_coupon'} || 0;
1413 $template = scalar(@_) ? shift : '';
1414 $invoice_from = shift if scalar(@_);
1415 $notice_name = 'Invoice';
1419 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1420 $conf->config('invoice_from', $self->cust_main->agentnum );
1422 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1423 $self->cust_main->invoicing_list;
1425 if ( ! @invoicing_list ) { #no recipients
1426 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1427 die 'No recipients for customer #'. $self->custnum;
1429 #default: better to notify this person than silence
1430 @invoicing_list = ($invoice_from);
1434 my $subject = $self->email_subject($template);
1436 my $error = send_email(
1437 $self->generate_email(
1438 'from' => $invoice_from,
1439 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1440 'subject' => $subject,
1441 'template' => $template,
1442 'notice_name' => $notice_name,
1443 'no_coupon' => $no_coupon,
1446 die "can't email invoice: $error\n" if $error;
1447 #die "$error\n" if $error;
1453 my $conf = $self->conf;
1455 #my $template = scalar(@_) ? shift : '';
1458 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1461 my $cust_main = $self->cust_main;
1462 my $name = $cust_main->name;
1463 my $name_short = $cust_main->name_short;
1464 my $invoice_number = $self->invnum;
1465 my $invoice_date = $self->_date_pretty;
1467 eval qq("$subject");
1470 =item lpr_data HASHREF | [ TEMPLATE ]
1472 Returns the postscript or plaintext for this invoice as an arrayref.
1474 Options can be passed as a hashref (recommended) or as a single optional value
1477 I<template>, if specified, is the name of a suffix for alternate invoices.
1479 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1485 my $conf = $self->conf;
1486 my( $template, $notice_name );
1489 $template = $opt->{'template'} || '';
1490 $notice_name = $opt->{'notice_name'} || 'Invoice';
1492 $template = scalar(@_) ? shift : '';
1493 $notice_name = 'Invoice';
1497 'template' => $template,
1498 'notice_name' => $notice_name,
1501 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1502 [ $self->$method( \%opt ) ];
1505 =item print HASHREF | [ TEMPLATE ]
1507 Prints this invoice.
1509 Options can be passed as a hashref (recommended) or as a single optional
1512 I<template>, if specified, is the name of a suffix for alternate invoices.
1514 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1518 #sub print_invoice {
1521 return if $self->hide;
1522 my $conf = $self->conf;
1524 my( $template, $notice_name );
1527 $template = $opt->{'template'} || '';
1528 $notice_name = $opt->{'notice_name'} || 'Invoice';
1530 $template = scalar(@_) ? shift : '';
1531 $notice_name = 'Invoice';
1535 'template' => $template,
1536 'notice_name' => $notice_name,
1539 if($conf->exists('invoice_print_pdf')) {
1540 # Add the invoice to the current batch.
1541 $self->batch_invoice(\%opt);
1545 $self->lpr_data(\%opt),
1546 'agentnum' => $self->cust_main->agentnum,
1551 =item fax_invoice HASHREF | [ TEMPLATE ]
1555 Options can be passed as a hashref (recommended) or as a single optional
1558 I<template>, if specified, is the name of a suffix for alternate invoices.
1560 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1566 return if $self->hide;
1567 my $conf = $self->conf;
1569 my( $template, $notice_name );
1572 $template = $opt->{'template'} || '';
1573 $notice_name = $opt->{'notice_name'} || 'Invoice';
1575 $template = scalar(@_) ? shift : '';
1576 $notice_name = 'Invoice';
1579 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1580 unless $conf->exists('invoice_latex');
1582 my $dialstring = $self->cust_main->getfield('fax');
1586 'template' => $template,
1587 'notice_name' => $notice_name,
1590 my $error = send_fax( 'docdata' => $self->lpr_data(\%opt),
1591 'dialstring' => $dialstring,
1593 die $error if $error;
1597 =item batch_invoice [ HASHREF ]
1599 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1600 isn't an open batch, one will be created.
1605 my ($self, $opt) = @_;
1606 my $bill_batch = $self->get_open_bill_batch;
1607 my $cust_bill_batch = FS::cust_bill_batch->new({
1608 batchnum => $bill_batch->batchnum,
1609 invnum => $self->invnum,
1611 return $cust_bill_batch->insert($opt);
1614 =item get_open_batch
1616 Returns the currently open batch as an FS::bill_batch object, creating a new
1617 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1622 sub get_open_bill_batch {
1624 my $conf = $self->conf;
1625 my $hashref = { status => 'O' };
1626 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1627 ? $self->cust_main->agentnum
1629 my $batch = qsearchs('bill_batch', $hashref);
1630 return $batch if $batch;
1631 $batch = FS::bill_batch->new($hashref);
1632 my $error = $batch->insert;
1633 die $error if $error;
1637 =item ftp_invoice [ TEMPLATENAME ]
1639 Sends this invoice data via FTP.
1641 TEMPLATENAME is unused?
1647 my $conf = $self->conf;
1648 my $template = scalar(@_) ? shift : '';
1651 'protocol' => 'ftp',
1652 'server' => $conf->config('cust_bill-ftpserver'),
1653 'username' => $conf->config('cust_bill-ftpusername'),
1654 'password' => $conf->config('cust_bill-ftppassword'),
1655 'dir' => $conf->config('cust_bill-ftpdir'),
1656 'format' => $conf->config('cust_bill-ftpformat'),
1660 =item spool_invoice [ TEMPLATENAME ]
1662 Spools this invoice data (see L<FS::spool_csv>)
1664 TEMPLATENAME is unused?
1670 my $conf = $self->conf;
1671 my $template = scalar(@_) ? shift : '';
1674 'format' => $conf->config('cust_bill-spoolformat'),
1675 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1679 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1681 Like B<send>, but only sends the invoice if it is the newest open invoice for
1686 sub send_if_newest {
1691 grep { $_->owed > 0 }
1692 qsearch('cust_bill', {
1693 'custnum' => $self->custnum,
1694 #'_date' => { op=>'>', value=>$self->_date },
1695 'invnum' => { op=>'>', value=>$self->invnum },
1702 =item send_csv OPTION => VALUE, ...
1704 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1708 protocol - currently only "ftp"
1714 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1715 and YYMMDDHHMMSS is a timestamp.
1717 See L</print_csv> for a description of the output format.
1722 my($self, %opt) = @_;
1726 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1727 mkdir $spooldir, 0700 unless -d $spooldir;
1729 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1730 my $file = "$spooldir/$tracctnum.csv";
1732 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1734 open(CSV, ">$file") or die "can't open $file: $!";
1742 if ( $opt{protocol} eq 'ftp' ) {
1743 eval "use Net::FTP;";
1745 $net = Net::FTP->new($opt{server}) or die @$;
1747 die "unknown protocol: $opt{protocol}";
1750 $net->login( $opt{username}, $opt{password} )
1751 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1753 $net->binary or die "can't set binary mode";
1755 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1757 $net->put($file) or die "can't put $file: $!";
1767 Spools CSV invoice data.
1773 =item format - 'default' or 'billco'
1775 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the customer has the corresponding invoice destinations set (see L<FS::cust_main_invoice>).
1777 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1779 =item balanceover - if set, only spools the invoice if the total amount owed on this invoice and all older invoices is greater than the specified amount.
1786 my($self, %opt) = @_;
1788 my $cust_main = $self->cust_main;
1790 if ( $opt{'dest'} ) {
1791 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1792 $cust_main->invoicing_list;
1793 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1794 || ! keys %invoicing_list;
1797 if ( $opt{'balanceover'} ) {
1799 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1802 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1803 mkdir $spooldir, 0700 unless -d $spooldir;
1805 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1809 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1810 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1813 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1815 open(CSV, ">>$file") or die "can't open $file: $!";
1816 flock(CSV, LOCK_EX);
1821 if ( lc($opt{'format'}) eq 'billco' ) {
1823 flock(CSV, LOCK_UN);
1828 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1831 open(CSV,">>$file") or die "can't open $file: $!";
1832 flock(CSV, LOCK_EX);
1838 flock(CSV, LOCK_UN);
1845 =item print_csv OPTION => VALUE, ...
1847 Returns CSV data for this invoice.
1851 format - 'default' or 'billco'
1853 Returns a list consisting of two scalars. The first is a single line of CSV
1854 header information for this invoice. The second is one or more lines of CSV
1855 detail information for this invoice.
1857 If I<format> is not specified or "default", the fields of the CSV file are as
1860 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1864 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1866 B<record_type> is C<cust_bill> for the initial header line only. The
1867 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1868 fields are filled in.
1870 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1871 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1874 =item invnum - invoice number
1876 =item custnum - customer number
1878 =item _date - invoice date
1880 =item charged - total invoice amount
1882 =item first - customer first name
1884 =item last - customer first name
1886 =item company - company name
1888 =item address1 - address line 1
1890 =item address2 - address line 1
1900 =item pkg - line item description
1902 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1904 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1906 =item sdate - start date for recurring fee
1908 =item edate - end date for recurring fee
1912 If I<format> is "billco", the fields of the header CSV file are as follows:
1914 +-------------------------------------------------------------------+
1915 | FORMAT HEADER FILE |
1916 |-------------------------------------------------------------------|
1917 | Field | Description | Name | Type | Width |
1918 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1919 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1920 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1921 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1922 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1923 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1924 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1925 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1926 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1927 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1928 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1929 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1930 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1931 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1932 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1933 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1934 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1935 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1936 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1937 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1938 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1939 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1940 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1941 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1942 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1943 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1944 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1945 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1946 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1947 +-------+-------------------------------+------------+------+-------+
1949 If I<format> is "billco", the fields of the detail CSV file are as follows:
1951 FORMAT FOR DETAIL FILE
1953 Field | Description | Name | Type | Width
1954 1 | N/A-Leave Empty | RC | CHAR | 2
1955 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1956 3 | Account Number | TRACCTNUM | CHAR | 15
1957 4 | Invoice Number | TRINVOICE | CHAR | 15
1958 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1959 6 | Transaction Detail | DETAILS | CHAR | 100
1960 7 | Amount | AMT | NUM* | 9
1961 8 | Line Format Control** | LNCTRL | CHAR | 2
1962 9 | Grouping Code | GROUP | CHAR | 2
1963 10 | User Defined | ACCT CODE | CHAR | 15
1968 my($self, %opt) = @_;
1970 eval "use Text::CSV_XS";
1973 my $cust_main = $self->cust_main;
1975 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1977 if ( lc($opt{'format'}) eq 'billco' ) {
1980 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1982 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1984 my( $previous_balance, @unused ) = $self->previous; #previous balance
1986 my $pmt_cr_applied = 0;
1987 $pmt_cr_applied += $_->{'amount'}
1988 foreach ( $self->_items_payments, $self->_items_credits ) ;
1990 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1993 '', # 1 | N/A-Leave Empty CHAR 2
1994 '', # 2 | N/A-Leave Empty CHAR 15
1995 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1996 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1997 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1998 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1999 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
2000 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
2001 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
2002 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
2003 '', # 10 | Ancillary Billing Information CHAR 30
2004 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
2005 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
2008 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
2011 $duedate, # 14 | Bill Due Date CHAR 10
2013 $previous_balance, # 15 | Previous Balance NUM* 9
2014 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
2015 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
2016 $totaldue, # 18 | Total Amt Due NUM* 9
2017 $totaldue, # 19 | Total Amt Due NUM* 9
2018 '', # 20 | 30 Day Aging NUM* 9
2019 '', # 21 | 60 Day Aging NUM* 9
2020 '', # 22 | 90 Day Aging NUM* 9
2021 'N', # 23 | Y/N CHAR 1
2022 '', # 24 | Remittance automation CHAR 100
2023 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
2024 $self->custnum, # 26 | Customer Reference Number CHAR 15
2025 '0', # 27 | Federal Tax*** NUM* 9
2026 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
2027 '0', # 29 | Other Taxes & Fees*** NUM* 9
2030 } elsif ( lc($opt{'format'}) eq 'oneline' ) { #name?
2032 my ($previous_balance) = $self->previous;
2033 $previous_balance = sprintf('%.2f', $previous_balance);
2034 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2036 ($_->{pkgnum} || ''),
2039 } $self->_items_pkg;
2042 $cust_main->agentnum,
2043 $cust_main->agent->agent,
2047 $cust_main->address1,
2048 $cust_main->address2,
2054 time2str("%x", $self->_date),
2059 $self->due_date2str("%x"),
2070 time2str("%x", $self->_date),
2071 sprintf("%.2f", $self->charged),
2072 ( map { $cust_main->getfield($_) }
2073 qw( first last company address1 address2 city state zip country ) ),
2075 ) or die "can't create csv";
2078 my $header = $csv->string. "\n";
2081 if ( lc($opt{'format'}) eq 'billco' ) {
2084 foreach my $item ( $self->_items_pkg ) {
2087 '', # 1 | N/A-Leave Empty CHAR 2
2088 '', # 2 | N/A-Leave Empty CHAR 15
2089 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
2090 $self->invnum, # 4 | Invoice Number CHAR 15
2091 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2092 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2093 $item->{'amount'}, # 7 | Amount NUM* 9
2094 '', # 8 | Line Format Control** CHAR 2
2095 '', # 9 | Grouping Code CHAR 2
2096 '', # 10 | User Defined CHAR 15
2099 $detail .= $csv->string. "\n";
2103 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2109 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2111 my($pkg, $setup, $recur, $sdate, $edate);
2112 if ( $cust_bill_pkg->pkgnum ) {
2114 ($pkg, $setup, $recur, $sdate, $edate) = (
2115 $cust_bill_pkg->part_pkg->pkg,
2116 ( $cust_bill_pkg->setup != 0
2117 ? sprintf("%.2f", $cust_bill_pkg->setup )
2119 ( $cust_bill_pkg->recur != 0
2120 ? sprintf("%.2f", $cust_bill_pkg->recur )
2122 ( $cust_bill_pkg->sdate
2123 ? time2str("%x", $cust_bill_pkg->sdate)
2125 ($cust_bill_pkg->edate
2126 ?time2str("%x", $cust_bill_pkg->edate)
2130 } else { #pkgnum tax
2131 next unless $cust_bill_pkg->setup != 0;
2132 $pkg = $cust_bill_pkg->desc;
2133 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2134 ( $sdate, $edate ) = ( '', '' );
2140 ( map { '' } (1..11) ),
2141 ($pkg, $setup, $recur, $sdate, $edate)
2142 ) or die "can't create csv";
2144 $detail .= $csv->string. "\n";
2150 ( $header, $detail );
2156 Pays this invoice with a compliemntary payment. If there is an error,
2157 returns the error, otherwise returns false.
2163 my $cust_pay = new FS::cust_pay ( {
2164 'invnum' => $self->invnum,
2165 'paid' => $self->owed,
2168 'payinfo' => $self->cust_main->payinfo,
2176 Attempts to pay this invoice with a credit card payment via a
2177 Business::OnlinePayment realtime gateway. See
2178 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2179 for supported processors.
2185 $self->realtime_bop( 'CC', @_ );
2190 Attempts to pay this invoice with an electronic check (ACH) payment via a
2191 Business::OnlinePayment realtime gateway. See
2192 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2193 for supported processors.
2199 $self->realtime_bop( 'ECHECK', @_ );
2204 Attempts to pay this invoice with phone bill (LEC) payment via a
2205 Business::OnlinePayment realtime gateway. See
2206 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2207 for supported processors.
2213 $self->realtime_bop( 'LEC', @_ );
2217 my( $self, $method ) = (shift,shift);
2218 my $conf = $self->conf;
2221 my $cust_main = $self->cust_main;
2222 my $balance = $cust_main->balance;
2223 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2224 $amount = sprintf("%.2f", $amount);
2225 return "not run (balance $balance)" unless $amount > 0;
2227 my $description = 'Internet Services';
2228 if ( $conf->exists('business-onlinepayment-description') ) {
2229 my $dtempl = $conf->config('business-onlinepayment-description');
2231 my $agent_obj = $cust_main->agent
2232 or die "can't retreive agent for $cust_main (agentnum ".
2233 $cust_main->agentnum. ")";
2234 my $agent = $agent_obj->agent;
2235 my $pkgs = join(', ',
2236 map { $_->part_pkg->pkg }
2237 grep { $_->pkgnum } $self->cust_bill_pkg
2239 $description = eval qq("$dtempl");
2242 $cust_main->realtime_bop($method, $amount,
2243 'description' => $description,
2244 'invnum' => $self->invnum,
2245 #this didn't do what we want, it just calls apply_payments_and_credits
2247 'apply_to_invoice' => 1,
2250 #this changes application behavior: auto payments
2251 #triggered against a specific invoice are now applied
2252 #to that invoice instead of oldest open.
2258 =item batch_card OPTION => VALUE...
2260 Adds a payment for this invoice to the pending credit card batch (see
2261 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2262 runs the payment using a realtime gateway.
2267 my ($self, %options) = @_;
2268 my $cust_main = $self->cust_main;
2270 $options{invnum} = $self->invnum;
2272 $cust_main->batch_card(%options);
2275 sub _agent_template {
2277 $self->cust_main->agent_template;
2280 sub _agent_invoice_from {
2282 $self->cust_main->agent_invoice_from;
2285 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2287 Returns an text invoice, as a list of lines.
2289 Options can be passed as a hashref (recommended) or as a list of time, template
2290 and then any key/value pairs for any other options.
2292 I<time>, if specified, is used to control the printing of overdue messages. The
2293 default is now. It isn't the date of the invoice; that's the `_date' field.
2294 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2295 L<Time::Local> and L<Date::Parse> for conversion functions.
2297 I<template>, if specified, is the name of a suffix for alternate invoices.
2299 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2305 my( $today, $template, %opt );
2307 %opt = %{ shift() };
2308 $today = delete($opt{'time'}) || '';
2309 $template = delete($opt{template}) || '';
2311 ( $today, $template, %opt ) = @_;
2314 my %params = ( 'format' => 'template' );
2315 $params{'time'} = $today if $today;
2316 $params{'template'} = $template if $template;
2317 $params{$_} = $opt{$_}
2318 foreach grep $opt{$_}, qw( unsquelch_cdr notice_name );
2320 $self->print_generic( %params );
2323 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2325 Internal method - returns a filename of a filled-in LaTeX template for this
2326 invoice (Note: add ".tex" to get the actual filename), and a filename of
2327 an associated logo (with the .eps extension included).
2329 See print_ps and print_pdf for methods that return PostScript and PDF output.
2331 Options can be passed as a hashref (recommended) or as a list of time, template
2332 and then any key/value pairs for any other options.
2334 I<time>, if specified, is used to control the printing of overdue messages. The
2335 default is now. It isn't the date of the invoice; that's the `_date' field.
2336 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2337 L<Time::Local> and L<Date::Parse> for conversion functions.
2339 I<template>, if specified, is the name of a suffix for alternate invoices.
2341 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2347 my $conf = $self->conf;
2348 my( $today, $template, %opt );
2350 %opt = %{ shift() };
2351 $today = delete($opt{'time'}) || '';
2352 $template = delete($opt{template}) || '';
2354 ( $today, $template, %opt ) = @_;
2357 my %params = ( 'format' => 'latex' );
2358 $params{'time'} = $today if $today;
2359 $params{'template'} = $template if $template;
2360 $params{$_} = $opt{$_}
2361 foreach grep $opt{$_}, qw( unsquelch_cdr notice_name );
2363 $template ||= $self->_agent_template;
2365 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2366 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2370 ) or die "can't open temp file: $!\n";
2372 my $agentnum = $self->cust_main->agentnum;
2374 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2375 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2376 or die "can't write temp file: $!\n";
2378 print $lh $conf->config_binary('logo.eps', $agentnum)
2379 or die "can't write temp file: $!\n";
2382 $params{'logo_file'} = $lh->filename;
2384 if($conf->exists('invoice-barcode')){
2385 my $png_file = $self->invoice_barcode($dir);
2386 my $eps_file = $png_file;
2387 $eps_file =~ s/\.png$/.eps/g;
2388 $png_file =~ /(barcode.*png)/;
2390 $eps_file =~ /(barcode.*eps)/;
2393 my $curr_dir = cwd();
2395 # after painfuly long experimentation, it was determined that sam2p won't
2396 # accept : and other chars in the path, no matter how hard I tried to
2397 # escape them, hence the chdir (and chdir back, just to be safe)
2398 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
2399 or die "sam2p failed: $!\n";
2403 $params{'barcode_file'} = $eps_file;
2406 my @filled_in = $self->print_generic( %params );
2408 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2412 ) or die "can't open temp file: $!\n";
2413 binmode($fh, ':utf8'); # language support
2414 print $fh join('', @filled_in );
2417 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2418 return ($1, $params{'logo_file'}, $params{'barcode_file'});
2422 =item invoice_barcode DIR_OR_FALSE
2424 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2425 it is taken as the temp directory where the PNG file will be generated and the
2426 PNG file name is returned. Otherwise, the PNG image itself is returned.
2430 sub invoice_barcode {
2431 my ($self, $dir) = (shift,shift);
2433 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2434 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2435 my $gd = $gdbar->plot(Height => 30);
2438 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2442 ) or die "can't open temp file: $!\n";
2443 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2444 my $png_file = $bh->filename;
2451 =item print_generic OPTION => VALUE ...
2453 Internal method - returns a filled-in template for this invoice as a scalar.
2455 See print_ps and print_pdf for methods that return PostScript and PDF output.
2457 Non optional options include
2458 format - latex, html, template
2460 Optional options include
2462 template - a value used as a suffix for a configuration template
2464 time - a value used to control the printing of overdue messages. The
2465 default is now. It isn't the date of the invoice; that's the `_date' field.
2466 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2467 L<Time::Local> and L<Date::Parse> for conversion functions.
2471 unsquelch_cdr - overrides any per customer cdr squelching when true
2473 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2475 locale - override customer's locale
2479 #what's with all the sprintf('%10.2f')'s in here? will it cause any
2480 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2481 # yes: fixed width/plain text printing will be borked
2483 my( $self, %params ) = @_;
2484 my $conf = $self->conf;
2485 my $today = $params{today} ? $params{today} : time;
2486 warn "$me print_generic called on $self with suffix $params{template}\n"
2489 my $format = $params{format};
2490 die "Unknown format: $format"
2491 unless $format =~ /^(latex|html|template)$/;
2493 my $cust_main = $self->cust_main;
2494 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2495 unless $cust_main->payname
2496 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2498 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
2499 'html' => [ '<%=', '%>' ],
2500 'template' => [ '{', '}' ],
2503 warn "$me print_generic creating template\n"
2506 #create the template
2507 my $template = $params{template} ? $params{template} : $self->_agent_template;
2508 my $templatefile = "invoice_$format";
2509 $templatefile .= "_$template"
2510 if length($template) && $conf->exists($templatefile."_$template");
2511 my @invoice_template = map "$_\n", $conf->config($templatefile)
2512 or die "cannot load config data $templatefile";
2515 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2516 #change this to a die when the old code is removed
2517 warn "old-style invoice template $templatefile; ".
2518 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2519 $old_latex = 'true';
2520 @invoice_template = _translate_old_latex_format(@invoice_template);
2523 warn "$me print_generic creating T:T object\n"
2526 my $text_template = new Text::Template(
2528 SOURCE => \@invoice_template,
2529 DELIMITERS => $delimiters{$format},
2532 warn "$me print_generic compiling T:T object\n"
2535 $text_template->compile()
2536 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2539 # additional substitution could possibly cause breakage in existing templates
2540 my %convert_maps = (
2542 'notes' => sub { map "$_", @_ },
2543 'footer' => sub { map "$_", @_ },
2544 'smallfooter' => sub { map "$_", @_ },
2545 'returnaddress' => sub { map "$_", @_ },
2546 'coupon' => sub { map "$_", @_ },
2547 'summary' => sub { map "$_", @_ },
2553 s/%%(.*)$/<!-- $1 -->/g;
2554 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2555 s/\\begin\{enumerate\}/<ol>/g;
2557 s/\\end\{enumerate\}/<\/ol>/g;
2558 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2567 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2569 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2574 s/\\\\\*?\s*$/<BR>/;
2575 s/\\hyphenation\{[\w\s\-]+}//;
2580 'coupon' => sub { "" },
2581 'summary' => sub { "" },
2588 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2589 s/\\begin\{enumerate\}//g;
2591 s/\\end\{enumerate\}//g;
2592 s/\\textbf\{(.*)\}/$1/g;
2599 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2601 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2606 s/\\\\\*?\s*$/\n/; # dubious
2607 s/\\hyphenation\{[\w\s\-]+}//;
2611 'coupon' => sub { "" },
2612 'summary' => sub { "" },
2617 # hashes for differing output formats
2618 my %nbsps = ( 'latex' => '~',
2619 'html' => '', # '&nbps;' would be nice
2620 'template' => '', # not used
2622 my $nbsp = $nbsps{$format};
2624 my %escape_functions = ( 'latex' => \&_latex_escape,
2625 'html' => \&_html_escape_nbsp,#\&encode_entities,
2626 'template' => sub { shift },
2628 my $escape_function = $escape_functions{$format};
2629 my $escape_function_nonbsp = ($format eq 'html')
2630 ? \&_html_escape : $escape_function;
2632 my %date_formats = ( 'latex' => $date_format_long,
2633 'html' => $date_format_long,
2636 $date_formats{'html'} =~ s/ / /g;
2638 my $date_format = $date_formats{$format};
2640 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
2642 'html' => sub { return '<b>'. shift(). '</b>'
2644 'template' => sub { shift },
2646 my $embolden_function = $embolden_functions{$format};
2648 my %newline_tokens = ( 'latex' => '\\\\',
2652 my $newline_token = $newline_tokens{$format};
2654 warn "$me generating template variables\n"
2657 # generate template variables
2660 defined( $conf->config_orbase( "invoice_${format}returnaddress",
2664 && length( $conf->config_orbase( "invoice_${format}returnaddress",
2670 $returnaddress = join("\n",
2671 $conf->config_orbase("invoice_${format}returnaddress", $template)
2674 } elsif ( grep /\S/,
2675 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2677 my $convert_map = $convert_maps{$format}{'returnaddress'};
2680 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2685 } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2687 my $convert_map = $convert_maps{$format}{'returnaddress'};
2688 $returnaddress = join( "\n", &$convert_map(
2689 map { s/( {2,})/'~' x length($1)/eg;
2693 ( $conf->config('company_name', $self->cust_main->agentnum),
2694 $conf->config('company_address', $self->cust_main->agentnum),
2701 my $warning = "Couldn't find a return address; ".
2702 "do you need to set the company_address configuration value?";
2704 $returnaddress = $nbsp;
2705 #$returnaddress = $warning;
2709 warn "$me generating invoice data\n"
2712 my $agentnum = $self->cust_main->agentnum;
2714 my %invoice_data = (
2717 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2718 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
2719 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
2720 'returnaddress' => $returnaddress,
2721 'agent' => &$escape_function($cust_main->agent->agent),
2724 'invnum' => $self->invnum,
2725 'date' => time2str($date_format, $self->_date),
2726 'today' => time2str($date_format_long, $today),
2727 'terms' => $self->terms,
2728 'template' => $template, #params{'template'},
2729 'notice_name' => ($params{'notice_name'} || 'Invoice'),#escape_function?
2730 'current_charges' => sprintf("%.2f", $self->charged),
2731 'duedate' => $self->due_date2str($rdate_format), #date_format?
2734 'custnum' => $cust_main->display_custnum,
2735 'agent_custid' => &$escape_function($cust_main->agent_custid),
2736 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2737 payname company address1 address2 city state zip fax
2741 'ship_enable' => $conf->exists('invoice-ship_address'),
2742 'unitprices' => $conf->exists('invoice-unitprice'),
2743 'smallernotes' => $conf->exists('invoice-smallernotes'),
2744 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
2745 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
2747 #layout info -- would be fancy to calc some of this and bury the template
2749 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
2750 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
2751 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
2752 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
2753 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
2754 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
2755 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
2756 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
2757 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
2758 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
2760 # better hang on to conf_dir for a while (for old templates)
2761 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2763 #these are only used when doing paged plaintext
2770 my $lh = FS::L10N->get_handle( $params{'locale'} || $cust_main->locale );
2771 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
2772 my %info = FS::Locales->locale_info($cust_main->locale || 'en_US');
2773 # eval to avoid death for unimplemented languages
2774 my $dh = eval { Date::Language->new($info{'name'}) } ||
2775 Date::Language->new(); # fall back to English
2776 # prototype here to silence warnings
2777 $invoice_data{'time2str'} = sub ($;$$) { $dh->time2str(@_) };
2778 # eventually use this date handle everywhere in here, too
2780 my $min_sdate = 999999999999;
2782 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2783 next unless $cust_bill_pkg->pkgnum > 0;
2784 $min_sdate = $cust_bill_pkg->sdate
2785 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
2786 $max_edate = $cust_bill_pkg->edate
2787 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
2790 $invoice_data{'bill_period'} = '';
2791 $invoice_data{'bill_period'} = time2str('%e %h', $min_sdate)
2792 . " to " . time2str('%e %h', $max_edate)
2793 if ($max_edate != 0 && $min_sdate != 999999999999);
2795 $invoice_data{finance_section} = '';
2796 if ( $conf->config('finance_pkgclass') ) {
2798 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2799 $invoice_data{finance_section} = $pkg_class->categoryname;
2801 $invoice_data{finance_amount} = '0.00';
2802 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
2804 my $countrydefault = $conf->config('countrydefault') || 'US';
2805 my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
2806 foreach ( qw( contact company address1 address2 city state zip country fax) ){
2807 my $method = $prefix.$_;
2808 $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2810 $invoice_data{'ship_country'} = ''
2811 if ( $invoice_data{'ship_country'} eq $countrydefault );
2813 $invoice_data{'cid'} = $params{'cid'}
2816 if ( $cust_main->country eq $countrydefault ) {
2817 $invoice_data{'country'} = '';
2819 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2823 $invoice_data{'address'} = \@address;
2825 $cust_main->payname.
2826 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2827 ? " (P.O. #". $cust_main->payinfo. ")"
2831 push @address, $cust_main->company
2832 if $cust_main->company;
2833 push @address, $cust_main->address1;
2834 push @address, $cust_main->address2
2835 if $cust_main->address2;
2837 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
2838 push @address, $invoice_data{'country'}
2839 if $invoice_data{'country'};
2841 while (scalar(@address) < 5);
2843 $invoice_data{'logo_file'} = $params{'logo_file'}
2844 if $params{'logo_file'};
2845 $invoice_data{'barcode_file'} = $params{'barcode_file'}
2846 if $params{'barcode_file'};
2847 $invoice_data{'barcode_img'} = $params{'barcode_img'}
2848 if $params{'barcode_img'};
2849 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
2850 if $params{'barcode_cid'};
2852 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2853 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2854 #my $balance_due = $self->owed + $pr_total - $cr_total;
2855 my $balance_due = $self->owed + $pr_total;
2857 # the customer's current balance as shown on the invoice before this one
2858 $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2860 # the change in balance from that invoice to this one
2861 $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2863 # the sum of amount owed on all previous invoices
2864 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2866 # the sum of amount owed on all invoices
2867 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2869 # info from customer's last invoice before this one, for some
2871 $invoice_data{'last_bill'} = {};
2872 my $last_bill = $pr_cust_bill[-1];
2874 $invoice_data{'last_bill'} = {
2875 '_date' => $last_bill->_date, #unformatted
2876 # all we need for now
2880 my $summarypage = '';
2881 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2884 $invoice_data{'summarypage'} = $summarypage;
2886 warn "$me substituting variables in notes, footer, smallfooter\n"
2889 my @include = (qw( notes footer smallfooter ));
2890 push @include, 'coupon' unless $params{'no_coupon'};
2891 foreach my $include (@include) {
2893 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2896 if ( $conf->exists($inc_file, $agentnum)
2897 && length( $conf->config($inc_file, $agentnum) ) ) {
2899 @inc_src = $conf->config($inc_file, $agentnum);
2903 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2905 my $convert_map = $convert_maps{$format}{$include};
2907 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2908 s/--\@\]/$delimiters{$format}[1]/g;
2911 &$convert_map( $conf->config($inc_file, $agentnum) );
2915 my $inc_tt = new Text::Template (
2917 SOURCE => [ map "$_\n", @inc_src ],
2918 DELIMITERS => $delimiters{$format},
2919 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2921 unless ( $inc_tt->compile() ) {
2922 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2923 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2927 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2929 $invoice_data{$include} =~ s/\n+$//
2930 if ($format eq 'latex');
2933 # let invoices use either of these as needed
2934 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
2935 ? $cust_main->payinfo : '';
2936 $invoice_data{'po_line'} =
2937 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2938 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
2941 my %money_chars = ( 'latex' => '',
2942 'html' => $conf->config('money_char') || '$',
2945 my $money_char = $money_chars{$format};
2947 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
2948 'html' => $conf->config('money_char') || '$',
2951 my $other_money_char = $other_money_chars{$format};
2952 $invoice_data{'dollar'} = $other_money_char;
2954 my @detail_items = ();
2955 my @total_items = ();
2959 $invoice_data{'detail_items'} = \@detail_items;
2960 $invoice_data{'total_items'} = \@total_items;
2961 $invoice_data{'buf'} = \@buf;
2962 $invoice_data{'sections'} = \@sections;
2964 warn "$me generating sections\n"
2967 my $previous_section = { 'description' => $self->mt('Previous Charges'),
2968 'subtotal' => $other_money_char.
2969 sprintf('%.2f', $pr_total),
2970 'summarized' => '', #why? $summarypage ? 'Y' : '',
2972 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
2973 join(' / ', map { $cust_main->balance_date_range(@$_) }
2974 $self->_prior_month30s
2976 if $conf->exists('invoice_include_aging');
2979 my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
2980 'subtotal' => $taxtotal, # adjusted below
2982 my $tax_weight = _pkg_category($tax_section->{description})
2983 ? _pkg_category($tax_section->{description})->weight
2985 $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
2986 $tax_section->{'sort_weight'} = $tax_weight;
2989 my $adjusttotal = 0;
2990 my $adjust_section = { 'description' =>
2991 $self->mt('Credits, Payments, and Adjustments'),
2992 'subtotal' => 0, # adjusted below
2994 my $adjust_weight = _pkg_category($adjust_section->{description})
2995 ? _pkg_category($adjust_section->{description})->weight
2997 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
2998 $adjust_section->{'sort_weight'} = $adjust_weight;
3000 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
3001 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
3002 $invoice_data{'multisection'} = $multisection;
3003 my $late_sections = [];
3004 my $extra_sections = [];
3005 my $extra_lines = ();
3007 my $default_section = { 'description' => '',
3012 if ( $multisection ) {
3013 ($extra_sections, $extra_lines) =
3014 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
3015 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
3017 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
3019 push @detail_items, @$extra_lines if $extra_lines;
3021 $self->_items_sections( $late_sections, # this could stand a refactor
3023 $escape_function_nonbsp,
3027 if ($conf->exists('svc_phone_sections')) {
3028 my ($phone_sections, $phone_lines) =
3029 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
3030 push @{$late_sections}, @$phone_sections;
3031 push @detail_items, @$phone_lines;
3033 if ($conf->exists('voip-cust_accountcode_cdr') && $cust_main->accountcode_cdr) {
3034 my ($accountcode_section, $accountcode_lines) =
3035 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
3036 if ( scalar(@$accountcode_lines) ) {
3037 push @{$late_sections}, $accountcode_section;
3038 push @detail_items, @$accountcode_lines;
3041 } else {# not multisection
3042 # make a default section
3043 push @sections, $default_section;
3044 # and calculate the finance charge total, since it won't get done otherwise.
3045 # XXX possibly other totals?
3046 # XXX possibly finance_pkgclass should not be used in this manner?
3047 if ( $conf->exists('finance_pkgclass') ) {
3048 my @finance_charges;
3049 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3050 if ( grep { $_->section eq $invoice_data{finance_section} }
3051 $cust_bill_pkg->cust_bill_pkg_display ) {
3052 # I think these are always setup fees, but just to be sure...
3053 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
3056 $invoice_data{finance_amount} =
3057 sprintf('%.2f', sum( @finance_charges ) || 0);
3061 # previous invoice balances in the Previous Charges section if there
3062 # is one, otherwise in the main detail section
3063 if ( $self->can('_items_previous') &&
3064 $self->enable_previous &&
3065 ! $conf->exists('previous_balance-summary_only') ) {
3067 warn "$me adding previous balances\n"
3070 foreach my $line_item ( $self->_items_previous ) {
3073 ext_description => [],
3075 $detail->{'ref'} = $line_item->{'pkgnum'};
3076 $detail->{'pkgpart'} = $line_item->{'pkgpart'};
3077 $detail->{'quantity'} = 1;
3078 $detail->{'section'} = $multisection ? $previous_section
3080 $detail->{'description'} = &$escape_function($line_item->{'description'});
3081 if ( exists $line_item->{'ext_description'} ) {
3082 @{$detail->{'ext_description'}} = map {
3083 &$escape_function($_);
3084 } @{$line_item->{'ext_description'}};
3086 $detail->{'amount'} = ( $old_latex ? '' : $money_char).
3087 $line_item->{'amount'};
3088 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
3090 push @detail_items, $detail;
3091 push @buf, [ $detail->{'description'},
3092 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
3098 if ( @pr_cust_bill && $self->enable_previous ) {
3099 push @buf, ['','-----------'];
3100 push @buf, [ $self->mt('Total Previous Balance'),
3101 $money_char. sprintf("%10.2f", $pr_total) ];
3105 if ( $conf->exists('svc_phone-did-summary') ) {
3106 warn "$me adding DID summary\n"
3109 my ($didsummary,$minutes) = $self->_did_summary;
3110 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
3112 { 'description' => $didsummary_desc,
3113 'ext_description' => [ $didsummary, $minutes ],
3117 foreach my $section (@sections, @$late_sections) {
3119 warn "$me adding section \n". Dumper($section)
3122 # begin some normalization
3123 $section->{'subtotal'} = $section->{'amount'}
3125 && !exists($section->{subtotal})
3126 && exists($section->{amount});
3128 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
3129 if ( $invoice_data{finance_section} &&
3130 $section->{'description'} eq $invoice_data{finance_section} );
3132 $section->{'subtotal'} = $other_money_char.
3133 sprintf('%.2f', $section->{'subtotal'})
3136 # continue some normalization
3137 $section->{'amount'} = $section->{'subtotal'}
3141 if ( $section->{'description'} ) {
3142 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
3147 warn "$me setting options\n"
3150 my $multilocation = scalar($cust_main->cust_location); #too expensive?
3152 $options{'section'} = $section if $multisection;
3153 $options{'format'} = $format;
3154 $options{'escape_function'} = $escape_function;
3155 $options{'no_usage'} = 1 unless $unsquelched;
3156 $options{'unsquelched'} = $unsquelched;
3157 $options{'summary_page'} = $summarypage;
3158 $options{'skip_usage'} =
3159 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
3160 $options{'multilocation'} = $multilocation;
3161 $options{'multisection'} = $multisection;
3163 warn "$me searching for line items\n"
3166 foreach my $line_item ( $self->_items_pkg(%options) ) {
3168 warn "$me adding line item $line_item\n"
3172 ext_description => [],
3174 $detail->{'ref'} = $line_item->{'pkgnum'};
3175 $detail->{'pkgpart'} = $line_item->{'pkgpart'};
3176 $detail->{'quantity'} = $line_item->{'quantity'};
3177 $detail->{'section'} = $section;
3178 $detail->{'description'} = &$escape_function($line_item->{'description'});
3179 if ( exists $line_item->{'ext_description'} ) {
3180 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
3182 $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
3183 $line_item->{'amount'};
3184 $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
3185 $line_item->{'unit_amount'};
3186 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
3188 $detail->{'sdate'} = $line_item->{'sdate'};
3189 $detail->{'edate'} = $line_item->{'edate'};
3190 $detail->{'seconds'} = $line_item->{'seconds'};
3192 push @detail_items, $detail;
3193 push @buf, ( [ $detail->{'description'},
3194 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
3196 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
3200 if ( $section->{'description'} ) {
3201 push @buf, ( ['','-----------'],
3202 [ $section->{'description'}. ' sub-total',
3203 $section->{'subtotal'} # already formatted this
3212 $invoice_data{current_less_finance} =
3213 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
3215 # create a major section for previous balance if we have major sections,
3216 # or if previous_section is in summary form
3217 if ( ( $multisection && $self->enable_previous )
3218 || $conf->exists('previous_balance-summary_only') )
3220 unshift @sections, $previous_section if $pr_total;
3223 warn "$me adding taxes\n"
3226 foreach my $tax ( $self->_items_tax ) {
3228 $taxtotal += $tax->{'amount'};
3230 my $description = &$escape_function( $tax->{'description'} );
3231 my $amount = sprintf( '%.2f', $tax->{'amount'} );
3233 if ( $multisection ) {
3235 my $money = $old_latex ? '' : $money_char;
3236 push @detail_items, {
3237 ext_description => [],
3240 description => $description,
3241 amount => $money. $amount,
3243 section => $tax_section,
3248 push @total_items, {
3249 'total_item' => $description,
3250 'total_amount' => $other_money_char. $amount,
3255 push @buf,[ $description,
3256 $money_char. $amount,
3263 $total->{'total_item'} = $self->mt('Sub-total');
3264 $total->{'total_amount'} =
3265 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
3267 if ( $multisection ) {
3268 $tax_section->{'subtotal'} = $other_money_char.
3269 sprintf('%.2f', $taxtotal);
3270 $tax_section->{'pretotal'} = 'New charges sub-total '.
3271 $total->{'total_amount'};
3272 push @sections, $tax_section if $taxtotal;
3274 unshift @total_items, $total;
3277 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
3279 push @buf,['','-----------'];
3280 push @buf,[$self->mt(
3281 (!$self->enable_previous)
3283 : 'Total New Charges'
3285 $money_char. sprintf("%10.2f",$self->charged) ];
3288 # calculate total, possibly including total owed on previous
3293 $item = $conf->config('previous_balance-exclude_from_total')
3294 || 'Total New Charges'
3295 if $conf->exists('previous_balance-exclude_from_total');
3296 my $amount = $self->charged;
3297 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
3298 $amount += $pr_total;
3301 $total->{'total_item'} = &$embolden_function($self->mt($item));
3302 $total->{'total_amount'} =
3303 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
3304 if ( $multisection ) {
3305 if ( $adjust_section->{'sort_weight'} ) {
3306 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
3307 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
3309 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
3310 $other_money_char. sprintf('%.2f', $self->charged );
3313 push @total_items, $total;
3315 push @buf,['','-----------'];
3318 sprintf( '%10.2f', $amount )
3323 # if we're showing previous invoices, also show previous
3324 # credits and payments
3325 if ( $self->enable_previous
3326 and $self->can('_items_credits')
3327 and $self->can('_items_payments') )
3329 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
3332 my $credittotal = 0;
3333 foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
3336 $total->{'total_item'} = &$escape_function($credit->{'description'});
3337 $credittotal += $credit->{'amount'};
3338 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
3339 $adjusttotal += $credit->{'amount'};
3340 if ( $multisection ) {
3341 my $money = $old_latex ? '' : $money_char;
3342 push @detail_items, {
3343 ext_description => [],
3346 description => &$escape_function($credit->{'description'}),
3347 amount => $money. $credit->{'amount'},
3349 section => $adjust_section,
3352 push @total_items, $total;
3356 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
3359 foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
3360 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
3364 my $paymenttotal = 0;
3365 foreach my $payment ( $self->_items_payments ) {
3367 $total->{'total_item'} = &$escape_function($payment->{'description'});
3368 $paymenttotal += $payment->{'amount'};
3369 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
3370 $adjusttotal += $payment->{'amount'};
3371 if ( $multisection ) {
3372 my $money = $old_latex ? '' : $money_char;
3373 push @detail_items, {
3374 ext_description => [],
3377 description => &$escape_function($payment->{'description'}),
3378 amount => $money. $payment->{'amount'},
3380 section => $adjust_section,
3383 push @total_items, $total;
3385 push @buf, [ $payment->{'description'},
3386 $money_char. sprintf("%10.2f", $payment->{'amount'}),
3389 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
3391 if ( $multisection ) {
3392 $adjust_section->{'subtotal'} = $other_money_char.
3393 sprintf('%.2f', $adjusttotal);
3394 push @sections, $adjust_section
3395 unless $adjust_section->{sort_weight};
3398 # create Balance Due message
3401 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
3402 $total->{'total_amount'} =
3403 &$embolden_function(
3404 $other_money_char. sprintf('%.2f', $summarypage
3406 $self->billing_balance
3407 : $self->owed + $pr_total
3410 if ( $multisection && !$adjust_section->{sort_weight} ) {
3411 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
3412 $total->{'total_amount'};
3414 push @total_items, $total;
3416 push @buf,['','-----------'];
3417 push @buf,[$self->balance_due_msg, $money_char.
3418 sprintf("%10.2f", $balance_due ) ];
3421 if ( $conf->exists('previous_balance-show_credit')
3422 and $cust_main->balance < 0 ) {
3423 my $credit_total = {
3424 'total_item' => &$embolden_function($self->credit_balance_msg),
3425 'total_amount' => &$embolden_function(
3426 $other_money_char. sprintf('%.2f', -$cust_main->balance)
3429 if ( $multisection ) {
3430 $adjust_section->{'posttotal'} .= $newline_token .
3431 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
3434 push @total_items, $credit_total;
3436 push @buf,['','-----------'];
3437 push @buf,[$self->credit_balance_msg, $money_char.
3438 sprintf("%10.2f", -$cust_main->balance ) ];
3442 if ( $multisection ) {
3443 if ($conf->exists('svc_phone_sections')) {
3445 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
3446 $total->{'total_amount'} =
3447 &$embolden_function(
3448 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
3450 my $last_section = pop @sections;
3451 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
3452 $total->{'total_amount'};
3453 push @sections, $last_section;
3455 push @sections, @$late_sections
3459 # make a discounts-available section, even without multisection
3460 if ( $conf->exists('discount-show_available')
3461 and my @discounts_avail = $self->_items_discounts_avail ) {
3462 my $discount_section = {
3463 'description' => $self->mt('Discounts Available'),
3468 push @sections, $discount_section;
3469 push @detail_items, map { +{
3470 'ref' => '', #should this be something else?
3471 'section' => $discount_section,
3472 'description' => &$escape_function( $_->{description} ),
3473 'amount' => $money_char . &$escape_function( $_->{amount} ),
3474 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
3475 } } @discounts_avail;
3478 # All sections and items are built; now fill in templates.
3479 my @includelist = ();
3480 push @includelist, 'summary' if $summarypage;
3481 foreach my $include ( @includelist ) {
3483 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
3486 if ( length( $conf->config($inc_file, $agentnum) ) ) {
3488 @inc_src = $conf->config($inc_file, $agentnum);
3492 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
3494 my $convert_map = $convert_maps{$format}{$include};
3496 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
3497 s/--\@\]/$delimiters{$format}[1]/g;
3500 &$convert_map( $conf->config($inc_file, $agentnum) );
3504 my $inc_tt = new Text::Template (
3506 SOURCE => [ map "$_\n", @inc_src ],
3507 DELIMITERS => $delimiters{$format},
3508 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
3510 unless ( $inc_tt->compile() ) {
3511 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
3512 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
3516 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
3518 $invoice_data{$include} =~ s/\n+$//
3519 if ($format eq 'latex');
3524 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
3525 /invoice_lines\((\d*)\)/;
3526 $invoice_lines += $1 || scalar(@buf);
3529 die "no invoice_lines() functions in template?"
3530 if ( $format eq 'template' && !$wasfunc );
3532 if ($format eq 'template') {
3534 if ( $invoice_lines ) {
3535 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
3536 $invoice_data{'total_pages'}++
3537 if scalar(@buf) % $invoice_lines;
3540 #setup subroutine for the template
3541 $invoice_data{invoice_lines} = sub {
3542 my $lines = shift || scalar(@buf);
3554 push @collect, split("\n",
3555 $text_template->fill_in( HASH => \%invoice_data )
3557 $invoice_data{'page'}++;
3559 map "$_\n", @collect;
3561 # this is where we actually create the invoice
3562 warn "filling in template for invoice ". $self->invnum. "\n"
3564 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
3567 $text_template->fill_in(HASH => \%invoice_data);
3571 # helper routine for generating date ranges
3572 sub _prior_month30s {
3575 [ 1, 2592000 ], # 0-30 days ago
3576 [ 2592000, 5184000 ], # 30-60 days ago
3577 [ 5184000, 7776000 ], # 60-90 days ago
3578 [ 7776000, 0 ], # 90+ days ago
3581 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
3582 $_->[1] ? $self->_date - $_->[1] - 1 : '',
3587 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
3589 Returns an postscript invoice, as a scalar.
3591 Options can be passed as a hashref (recommended) or as a list of time, template
3592 and then any key/value pairs for any other options.
3594 I<time> an optional value used to control the printing of overdue messages. The
3595 default is now. It isn't the date of the invoice; that's the `_date' field.
3596 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3597 L<Time::Local> and L<Date::Parse> for conversion functions.
3599 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3606 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
3607 my $ps = generate_ps($file);
3609 unlink($barcodefile) if $barcodefile;
3614 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
3616 Returns an PDF invoice, as a scalar.
3618 Options can be passed as a hashref (recommended) or as a list of time, template
3619 and then any key/value pairs for any other options.
3621 I<time> an optional value used to control the printing of overdue messages. The
3622 default is now. It isn't the date of the invoice; that's the `_date' field.
3623 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3624 L<Time::Local> and L<Date::Parse> for conversion functions.
3626 I<template>, if specified, is the name of a suffix for alternate invoices.
3628 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3635 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
3636 my $pdf = generate_pdf($file);
3638 unlink($barcodefile) if $barcodefile;
3643 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3645 Returns an HTML invoice, as a scalar.
3647 I<time> an optional value used to control the printing of overdue messages. The
3648 default is now. It isn't the date of the invoice; that's the `_date' field.
3649 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3650 L<Time::Local> and L<Date::Parse> for conversion functions.
3652 I<template>, if specified, is the name of a suffix for alternate invoices.
3654 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3656 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3657 when emailing the invoice as part of a multipart/related MIME email.
3665 %params = %{ shift() };
3667 $params{'time'} = shift;
3668 $params{'template'} = shift;
3669 $params{'cid'} = shift;
3672 $params{'format'} = 'html';
3674 $self->print_generic( %params );
3677 # quick subroutine for print_latex
3679 # There are ten characters that LaTeX treats as special characters, which
3680 # means that they do not simply typeset themselves:
3681 # # $ % & ~ _ ^ \ { }
3683 # TeX ignores blanks following an escaped character; if you want a blank (as
3684 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
3688 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3689 $value =~ s/([<>])/\$$1\$/g;
3695 encode_entities($value);
3699 sub _html_escape_nbsp {
3700 my $value = _html_escape(shift);
3701 $value =~ s/ +/ /g;
3705 #utility methods for print_*
3707 sub _translate_old_latex_format {
3708 warn "_translate_old_latex_format called\n"
3715 if ( $line =~ /^%%Detail\s*$/ ) {
3717 push @template, q![@--!,
3718 q! foreach my $_tr_line (@detail_items) {!,
3719 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3720 q! $_tr_line->{'description'} .= !,
3721 q! "\\tabularnewline\n~~".!,
3722 q! join( "\\tabularnewline\n~~",!,
3723 q! @{$_tr_line->{'ext_description'}}!,
3727 while ( ( my $line_item_line = shift )
3728 !~ /^%%EndDetail\s*$/ ) {
3729 $line_item_line =~ s/'/\\'/g; # nice LTS
3730 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3731 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3732 push @template, " \$OUT .= '$line_item_line';";
3735 push @template, '}',
3738 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3740 push @template, '[@--',
3741 ' foreach my $_tr_line (@total_items) {';
3743 while ( ( my $total_item_line = shift )
3744 !~ /^%%EndTotalDetails\s*$/ ) {
3745 $total_item_line =~ s/'/\\'/g; # nice LTS
3746 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3747 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3748 push @template, " \$OUT .= '$total_item_line';";
3751 push @template, '}',
3755 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3756 push @template, $line;
3762 warn "$_\n" foreach @template;
3770 my $conf = $self->conf;
3772 #check for an invoice-specific override
3773 return $self->invoice_terms if $self->invoice_terms;
3775 #check for a customer- specific override
3776 my $cust_main = $self->cust_main;
3777 return $cust_main->invoice_terms if $cust_main->invoice_terms;
3779 #use configured default
3780 $conf->config('invoice_default_terms') || '';
3786 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3787 $duedate = $self->_date() + ( $1 * 86400 );
3794 $self->due_date ? time2str(shift, $self->due_date) : '';
3797 sub balance_due_msg {
3799 my $msg = $self->mt('Balance Due');
3800 return $msg unless $self->terms;
3801 if ( $self->due_date ) {
3802 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
3803 $self->due_date2str($date_format);
3804 } elsif ( $self->terms ) {
3805 $msg .= ' - '. $self->terms;
3810 sub balance_due_date {
3812 my $conf = $self->conf;
3814 if ( $conf->exists('invoice_default_terms')
3815 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3816 $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3821 sub credit_balance_msg {
3823 $self->mt('Credit Balance Remaining')
3826 =item invnum_date_pretty
3828 Returns a string with the invoice number and date, for example:
3829 "Invoice #54 (3/20/2008)"
3833 sub invnum_date_pretty {
3835 $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
3840 Returns a string with the date, for example: "3/20/2008"
3846 time2str($date_format, $self->_date);
3849 =item _items_sections LATE SUMMARYPAGE ESCAPE EXTRA_SECTIONS FORMAT
3851 Generate section information for all items appearing on this invoice.
3852 This will only be called for multi-section invoices.
3854 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
3855 related display records (L<FS::cust_bill_pkg_display>) and organize
3856 them into two groups ("early" and "late" according to whether they come
3857 before or after the total), then into sections. A subtotal is calculated
3860 Section descriptions are returned in sort weight order. Each consists
3861 of a hash containing:
3863 description: the package category name, escaped
3864 subtotal: the total charges in that section
3865 tax_section: a flag indicating that the section contains only tax charges
3866 summarized: same as tax_section, for some reason
3867 sort_weight: the package category's sort weight
3869 If 'condense' is set on the display record, it also contains everything
3870 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
3871 coderefs to generate parts of the invoice. This is not advised.
3875 LATE: an arrayref to push the "late" section hashes onto. The "early"
3876 group is simply returned from the method.
3878 SUMMARYPAGE: a flag indicating whether this is a summary-format invoice.
3879 Turning this on has the following effects:
3880 - Ignores display items with the 'summary' flag.
3881 - Combines all items into the "early" group.
3882 - Creates sections for all non-disabled package categories, even if they
3883 have no charges on this invoice, as well as a section with no name.
3885 ESCAPE: an escape function to use for section titles.
3887 EXTRA_SECTIONS: an arrayref of additional sections to return after the
3888 sorted list. If there are any of these, section subtotals exclude
3891 FORMAT: 'latex', 'html', or 'template' (i.e. text). Not used, but
3892 passed through to C<_condense_section()>.
3896 use vars qw(%pkg_category_cache);
3897 sub _items_sections {
3900 my $summarypage = shift;
3902 my $extra_sections = shift;
3906 my %late_subtotal = ();
3909 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3912 my $usage = $cust_bill_pkg->usage;
3914 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3915 next if ( $display->summary && $summarypage );
3917 my $section = $display->section;
3918 my $type = $display->type;
3920 $not_tax{$section} = 1
3921 unless $cust_bill_pkg->pkgnum == 0;
3923 if ( $display->post_total && !$summarypage ) {
3924 if (! $type || $type eq 'S') {
3925 $late_subtotal{$section} += $cust_bill_pkg->setup
3926 if $cust_bill_pkg->setup != 0
3927 || $cust_bill_pkg->setup_show_zero;
3931 $late_subtotal{$section} += $cust_bill_pkg->recur
3932 if $cust_bill_pkg->recur != 0
3933 || $cust_bill_pkg->recur_show_zero;
3936 if ($type && $type eq 'R') {
3937 $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3938 if $cust_bill_pkg->recur != 0
3939 || $cust_bill_pkg->recur_show_zero;
3942 if ($type && $type eq 'U') {
3943 $late_subtotal{$section} += $usage
3944 unless scalar(@$extra_sections);
3949 next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3951 if (! $type || $type eq 'S') {
3952 $subtotal{$section} += $cust_bill_pkg->setup
3953 if $cust_bill_pkg->setup != 0
3954 || $cust_bill_pkg->setup_show_zero;
3958 $subtotal{$section} += $cust_bill_pkg->recur
3959 if $cust_bill_pkg->recur != 0
3960 || $cust_bill_pkg->recur_show_zero;
3963 if ($type && $type eq 'R') {
3964 $subtotal{$section} += $cust_bill_pkg->recur - $usage
3965 if $cust_bill_pkg->recur != 0
3966 || $cust_bill_pkg->recur_show_zero;
3969 if ($type && $type eq 'U') {
3970 $subtotal{$section} += $usage
3971 unless scalar(@$extra_sections);
3980 %pkg_category_cache = ();
3982 push @$late, map { { 'description' => &{$escape}($_),
3983 'subtotal' => $late_subtotal{$_},
3985 'sort_weight' => ( _pkg_category($_)
3986 ? _pkg_category($_)->weight
3989 ((_pkg_category($_) && _pkg_category($_)->condense)
3990 ? $self->_condense_section($format)
3994 sort _sectionsort keys %late_subtotal;
3997 if ( $summarypage ) {
3998 @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3999 map { $_->categoryname } qsearch('pkg_category', {});
4000 push @sections, '' if exists($subtotal{''});
4002 @sections = keys %subtotal;
4005 my @early = map { { 'description' => &{$escape}($_),
4006 'subtotal' => $subtotal{$_},
4007 'summarized' => $not_tax{$_} ? '' : 'Y',
4008 'tax_section' => $not_tax{$_} ? '' : 'Y',
4009 'sort_weight' => ( _pkg_category($_)
4010 ? _pkg_category($_)->weight
4013 ((_pkg_category($_) && _pkg_category($_)->condense)
4014 ? $self->_condense_section($format)
4019 push @early, @$extra_sections if $extra_sections;
4021 sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
4025 #helper subs for above
4028 _pkg_category($a)->weight <=> _pkg_category($b)->weight;
4032 my $categoryname = shift;
4033 $pkg_category_cache{$categoryname} ||=
4034 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
4037 my %condensed_format = (
4038 'label' => [ qw( Description Qty Amount ) ],
4040 sub { shift->{description} },
4041 sub { shift->{quantity} },
4042 sub { my($href, %opt) = @_;
4043 ($opt{dollar} || ''). $href->{amount};
4046 'align' => [ qw( l r r ) ],
4047 'span' => [ qw( 5 1 1 ) ], # unitprices?
4048 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
4051 sub _condense_section {
4052 my ( $self, $format ) = ( shift, shift );
4054 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
4055 qw( description_generator
4058 total_line_generator
4063 sub _condensed_generator_defaults {
4064 my ( $self, $format ) = ( shift, shift );
4065 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
4074 sub _condensed_header_generator {
4075 my ( $self, $format ) = ( shift, shift );
4077 my ( $f, $prefix, $suffix, $separator, $column ) =
4078 _condensed_generator_defaults($format);
4080 if ($format eq 'latex') {
4081 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
4082 $suffix = "\\\\\n\\hline";
4085 sub { my ($d,$a,$s,$w) = @_;
4086 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
4088 } elsif ( $format eq 'html' ) {
4089 $prefix = '<th></th>';
4093 sub { my ($d,$a,$s,$w) = @_;
4094 return qq!<th align="$html_align{$a}">$d</th>!;
4102 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4104 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
4107 $prefix. join($separator, @result). $suffix;
4112 sub _condensed_description_generator {
4113 my ( $self, $format ) = ( shift, shift );
4115 my ( $f, $prefix, $suffix, $separator, $column ) =
4116 _condensed_generator_defaults($format);
4118 my $money_char = '$';
4119 if ($format eq 'latex') {
4120 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
4122 $separator = " & \n";
4124 sub { my ($d,$a,$s,$w) = @_;
4125 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
4127 $money_char = '\\dollar';
4128 }elsif ( $format eq 'html' ) {
4129 $prefix = '"><td align="center"></td>';
4133 sub { my ($d,$a,$s,$w) = @_;
4134 return qq!<td align="$html_align{$a}">$d</td>!;
4136 #$money_char = $conf->config('money_char') || '$';
4137 $money_char = ''; # this is madness
4145 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4147 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
4149 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
4150 map { $f->{$_}->[$i] } qw(align span width)
4154 $prefix. join( $separator, @result ). $suffix;
4159 sub _condensed_total_generator {
4160 my ( $self, $format ) = ( shift, shift );
4162 my ( $f, $prefix, $suffix, $separator, $column ) =
4163 _condensed_generator_defaults($format);
4166 if ($format eq 'latex') {
4169 $separator = " & \n";
4171 sub { my ($d,$a,$s,$w) = @_;
4172 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
4174 }elsif ( $format eq 'html' ) {
4178 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
4180 sub { my ($d,$a,$s,$w) = @_;
4181 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
4190 # my $r = &{$f->{fields}->[$i]}(@args);
4191 # $r .= ' Total' unless $i;
4193 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4195 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
4196 map { $f->{$_}->[$i] } qw(align span width)
4200 $prefix. join( $separator, @result ). $suffix;
4205 =item total_line_generator FORMAT
4207 Returns a coderef used for generation of invoice total line items for this
4208 usage_class. FORMAT is either html or latex
4212 # should not be used: will have issues with hash element names (description vs
4213 # total_item and amount vs total_amount -- another array of functions?
4215 sub _condensed_total_line_generator {
4216 my ( $self, $format ) = ( shift, shift );
4218 my ( $f, $prefix, $suffix, $separator, $column ) =
4219 _condensed_generator_defaults($format);
4222 if ($format eq 'latex') {
4225 $separator = " & \n";
4227 sub { my ($d,$a,$s,$w) = @_;
4228 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
4230 }elsif ( $format eq 'html' ) {
4234 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
4236 sub { my ($d,$a,$s,$w) = @_;
4237 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
4246 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
4248 &{$column}( &{$f->{fields}->[$i]}(@args),
4249 map { $f->{$_}->[$i] } qw(align span width)
4253 $prefix. join( $separator, @result ). $suffix;
4258 #sub _items_extra_usage_sections {
4260 # my $escape = shift;
4262 # my %sections = ();
4264 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
4265 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
4267 # next unless $cust_bill_pkg->pkgnum > 0;
4269 # foreach my $section ( keys %usage_class ) {
4271 # my $usage = $cust_bill_pkg->usage($section);
4273 # next unless $usage && $usage > 0;
4275 # $sections{$section} ||= 0;
4276 # $sections{$section} += $usage;
4282 # map { { 'description' => &{$escape}($_),
4283 # 'subtotal' => $sections{$_},
4284 # 'summarized' => '',
4285 # 'tax_section' => '',
4288 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
4292 sub _items_extra_usage_sections {
4294 my $conf = $self->conf;
4302 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4304 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
4305 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4306 next unless $cust_bill_pkg->pkgnum > 0;
4308 foreach my $classnum ( keys %usage_class ) {
4309 my $section = $usage_class{$classnum}->classname;
4310 $classnums{$section} = $classnum;
4312 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
4313 my $amount = $detail->amount;
4314 next unless $amount && $amount > 0;
4316 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
4317 $sections{$section}{amount} += $amount; #subtotal
4318 $sections{$section}{calls}++;
4319 $sections{$section}{duration} += $detail->duration;
4321 my $desc = $detail->regionname;
4322 my $description = $desc;
4323 $description = substr($desc, 0, $maxlength). '...'
4324 if $format eq 'latex' && length($desc) > $maxlength;
4326 $lines{$section}{$desc} ||= {
4327 description => &{$escape}($description),
4328 #pkgpart => $part_pkg->pkgpart,
4329 pkgnum => $cust_bill_pkg->pkgnum,
4334 #unit_amount => $cust_bill_pkg->unitrecur,
4335 quantity => $cust_bill_pkg->quantity,
4336 product_code => 'N/A',
4337 ext_description => [],
4340 $lines{$section}{$desc}{amount} += $amount;
4341 $lines{$section}{$desc}{calls}++;
4342 $lines{$section}{$desc}{duration} += $detail->duration;
4348 my %sectionmap = ();
4349 foreach (keys %sections) {
4350 my $usage_class = $usage_class{$classnums{$_}};
4351 $sectionmap{$_} = { 'description' => &{$escape}($_),
4352 'amount' => $sections{$_}{amount}, #subtotal
4353 'calls' => $sections{$_}{calls},
4354 'duration' => $sections{$_}{duration},
4356 'tax_section' => '',
4357 'sort_weight' => $usage_class->weight,
4358 ( $usage_class->format
4359 ? ( map { $_ => $usage_class->$_($format) }
4360 qw( description_generator header_generator total_generator total_line_generator )
4367 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
4371 foreach my $section ( keys %lines ) {
4372 foreach my $line ( keys %{$lines{$section}} ) {
4373 my $l = $lines{$section}{$line};
4374 $l->{section} = $sectionmap{$section};
4375 $l->{amount} = sprintf( "%.2f", $l->{amount} );
4376 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4381 return(\@sections, \@lines);
4387 my $end = $self->_date;
4389 # start at date of previous invoice + 1 second or 0 if no previous invoice
4390 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
4391 $start = 0 if !$start;
4394 my $cust_main = $self->cust_main;
4395 my @pkgs = $cust_main->all_pkgs;
4396 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
4399 foreach my $pkg ( @pkgs ) {
4400 my @h_cust_svc = $pkg->h_cust_svc($end);
4401 foreach my $h_cust_svc ( @h_cust_svc ) {
4402 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
4403 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
4405 my $inserted = $h_cust_svc->date_inserted;
4406 my $deleted = $h_cust_svc->date_deleted;
4407 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
4409 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
4411 # DID either activated or ported in; cannot be both for same DID simultaneously
4412 if ($inserted >= $start && $inserted <= $end && $phone_inserted
4413 && (!$phone_inserted->lnp_status
4414 || $phone_inserted->lnp_status eq ''
4415 || $phone_inserted->lnp_status eq 'native')) {
4418 else { # this one not so clean, should probably move to (h_)svc_phone
4419 my $phone_portedin = qsearchs( 'h_svc_phone',
4420 { 'svcnum' => $h_cust_svc->svcnum,
4421 'lnp_status' => 'portedin' },
4422 FS::h_svc_phone->sql_h_searchs($end),
4424 $num_portedin++ if $phone_portedin;
4427 # DID either deactivated or ported out; cannot be both for same DID simultaneously
4428 if($deleted >= $start && $deleted <= $end && $phone_deleted
4429 && (!$phone_deleted->lnp_status
4430 || $phone_deleted->lnp_status ne 'portingout')) {
4433 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
4434 && $phone_deleted->lnp_status
4435 && $phone_deleted->lnp_status eq 'portingout') {
4439 # increment usage minutes
4440 if ( $phone_inserted ) {
4441 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
4442 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
4445 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
4448 # don't look at this service again
4449 push @seen, $h_cust_svc->svcnum;
4453 $minutes = sprintf("%d", $minutes);
4454 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
4455 . "$num_deactivated Ported-Out: $num_portedout ",
4456 "Total Minutes: $minutes");
4459 sub _items_accountcode_cdr {
4464 my $section = { 'amount' => 0,
4467 'sort_weight' => '',
4469 'description' => 'Usage by Account Code',
4475 my %accountcodes = ();
4477 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4478 next unless $cust_bill_pkg->pkgnum > 0;
4480 my @header = $cust_bill_pkg->details_header;
4481 next unless scalar(@header);
4482 $section->{'header'} = join(',',@header);
4484 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
4486 $section->{'header'} = $detail->formatted('format' => $format)
4487 if($detail->detail eq $section->{'header'});
4489 my $accountcode = $detail->accountcode;
4490 next unless $accountcode;
4492 my $amount = $detail->amount;
4493 next unless $amount && $amount > 0;
4495 $accountcodes{$accountcode} ||= {
4496 description => $accountcode,
4503 product_code => 'N/A',
4504 section => $section,
4505 ext_description => [ $section->{'header'} ],
4509 $section->{'amount'} += $amount;
4510 $accountcodes{$accountcode}{'amount'} += $amount;
4511 $accountcodes{$accountcode}{calls}++;
4512 $accountcodes{$accountcode}{duration} += $detail->duration;
4513 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
4517 foreach my $l ( values %accountcodes ) {
4518 $l->{amount} = sprintf( "%.2f", $l->{amount} );
4519 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
4520 foreach my $sorted_detail ( @sorted_detail ) {
4521 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
4523 delete $l->{detail_temp};
4527 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
4529 return ($section,\@sorted_lines);
4532 sub _items_svc_phone_sections {
4534 my $conf = $self->conf;
4542 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4544 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
4545 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
4547 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4548 next unless $cust_bill_pkg->pkgnum > 0;
4550 my @header = $cust_bill_pkg->details_header;
4551 next unless scalar(@header);
4553 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
4555 my $phonenum = $detail->phonenum;
4556 next unless $phonenum;
4558 my $amount = $detail->amount;
4559 next unless $amount && $amount > 0;
4561 $sections{$phonenum} ||= { 'amount' => 0,
4564 'sort_weight' => -1,
4565 'phonenum' => $phonenum,
4567 $sections{$phonenum}{amount} += $amount; #subtotal
4568 $sections{$phonenum}{calls}++;
4569 $sections{$phonenum}{duration} += $detail->duration;
4571 my $desc = $detail->regionname;
4572 my $description = $desc;
4573 $description = substr($desc, 0, $maxlength). '...'
4574 if $format eq 'latex' && length($desc) > $maxlength;
4576 $lines{$phonenum}{$desc} ||= {
4577 description => &{$escape}($description),
4578 #pkgpart => $part_pkg->pkgpart,
4586 product_code => 'N/A',
4587 ext_description => [],
4590 $lines{$phonenum}{$desc}{amount} += $amount;
4591 $lines{$phonenum}{$desc}{calls}++;
4592 $lines{$phonenum}{$desc}{duration} += $detail->duration;
4594 my $line = $usage_class{$detail->classnum}->classname;
4595 $sections{"$phonenum $line"} ||=
4599 'sort_weight' => $usage_class{$detail->classnum}->weight,
4600 'phonenum' => $phonenum,
4601 'header' => [ @header ],
4603 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
4604 $sections{"$phonenum $line"}{calls}++;
4605 $sections{"$phonenum $line"}{duration} += $detail->duration;
4607 $lines{"$phonenum $line"}{$desc} ||= {
4608 description => &{$escape}($description),
4609 #pkgpart => $part_pkg->pkgpart,
4617 product_code => 'N/A',
4618 ext_description => [],
4621 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
4622 $lines{"$phonenum $line"}{$desc}{calls}++;
4623 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
4624 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
4625 $detail->formatted('format' => $format);
4630 my %sectionmap = ();
4631 my $simple = new FS::usage_class { format => 'simple' }; #bleh
4632 foreach ( keys %sections ) {
4633 my @header = @{ $sections{$_}{header} || [] };
4635 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
4636 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
4637 my $usage_class = $summary ? $simple : $usage_simple;
4638 my $ending = $summary ? ' usage charges' : '';
4641 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
4643 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
4644 'amount' => $sections{$_}{amount}, #subtotal
4645 'calls' => $sections{$_}{calls},
4646 'duration' => $sections{$_}{duration},
4648 'tax_section' => '',
4649 'phonenum' => $sections{$_}{phonenum},
4650 'sort_weight' => $sections{$_}{sort_weight},
4651 'post_total' => $summary, #inspire pagebreak
4653 ( map { $_ => $usage_class->$_($format, %gen_opt) }
4654 qw( description_generator
4657 total_line_generator
4664 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
4665 $a->{sort_weight} <=> $b->{sort_weight}
4670 foreach my $section ( keys %lines ) {
4671 foreach my $line ( keys %{$lines{$section}} ) {
4672 my $l = $lines{$section}{$line};
4673 $l->{section} = $sectionmap{$section};
4674 $l->{amount} = sprintf( "%.2f", $l->{amount} );
4675 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4680 if($conf->exists('phone_usage_class_summary')) {
4681 # this only works with Latex
4685 # after this, we'll have only two sections per DID:
4686 # Calls Summary and Calls Detail
4687 foreach my $section ( @sections ) {
4688 if($section->{'post_total'}) {
4689 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
4690 $section->{'total_line_generator'} = sub { '' };
4691 $section->{'total_generator'} = sub { '' };
4692 $section->{'header_generator'} = sub { '' };
4693 $section->{'description_generator'} = '';
4694 push @newsections, $section;
4695 my %calls_detail = %$section;
4696 $calls_detail{'post_total'} = '';
4697 $calls_detail{'sort_weight'} = '';
4698 $calls_detail{'description_generator'} = sub { '' };
4699 $calls_detail{'header_generator'} = sub {
4700 return ' & Date/Time & Called Number & Duration & Price'
4701 if $format eq 'latex';
4704 $calls_detail{'description'} = 'Calls Detail: '
4705 . $section->{'phonenum'};
4706 push @newsections, \%calls_detail;
4710 # after this, each usage class is collapsed/summarized into a single
4711 # line under the Calls Summary section
4712 foreach my $newsection ( @newsections ) {
4713 if($newsection->{'post_total'}) { # this means Calls Summary
4714 foreach my $section ( @sections ) {
4715 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
4716 && !$section->{'post_total'});
4717 my $newdesc = $section->{'description'};
4718 my $tn = $section->{'phonenum'};
4719 $newdesc =~ s/$tn//g;
4720 my $line = { ext_description => [],
4724 calls => $section->{'calls'},
4725 section => $newsection,
4726 duration => $section->{'duration'},
4727 description => $newdesc,
4728 amount => sprintf("%.2f",$section->{'amount'}),
4729 product_code => 'N/A',
4731 push @newlines, $line;
4736 # after this, Calls Details is populated with all CDRs
4737 foreach my $newsection ( @newsections ) {
4738 if(!$newsection->{'post_total'}) { # this means Calls Details
4739 foreach my $line ( @lines ) {
4740 next unless (scalar(@{$line->{'ext_description'}}) &&
4741 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
4743 my @extdesc = @{$line->{'ext_description'}};
4745 foreach my $extdesc ( @extdesc ) {
4746 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
4747 push @newextdesc, $extdesc;
4749 $line->{'ext_description'} = \@newextdesc;
4750 $line->{'section'} = $newsection;
4751 push @newlines, $line;
4756 return(\@newsections, \@newlines);
4759 return(\@sections, \@lines);
4763 sub _items { # seems to be unused
4766 #my @display = scalar(@_)
4768 # : qw( _items_previous _items_pkg );
4769 # #: qw( _items_pkg );
4770 # #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
4771 my @display = qw( _items_previous _items_pkg );
4774 foreach my $display ( @display ) {
4775 push @b, $self->$display(@_);
4780 sub _items_previous {
4782 my $conf = $self->conf;
4783 my $cust_main = $self->cust_main;
4784 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
4786 foreach ( @pr_cust_bill ) {
4787 my $date = $conf->exists('invoice_show_prior_due_date')
4788 ? 'due '. $_->due_date2str($date_format)
4789 : time2str($date_format, $_->_date);
4791 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
4792 #'pkgpart' => 'N/A',
4794 'amount' => sprintf("%.2f", $_->owed),
4800 # 'description' => 'Previous Balance',
4801 # #'pkgpart' => 'N/A',
4802 # 'pkgnum' => 'N/A',
4803 # 'amount' => sprintf("%10.2f", $pr_total ),
4804 # 'ext_description' => [ map {
4805 # "Invoice ". $_->invnum.
4806 # " (". time2str("%x",$_->_date). ") ".
4807 # sprintf("%10.2f", $_->owed)
4808 # } @pr_cust_bill ],
4813 =item _items_pkg [ OPTIONS ]
4815 Return line item hashes for each package item on this invoice. Nearly
4818 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
4820 The only OPTIONS accepted is 'section', which may point to a hashref
4821 with a key named 'condensed', which may have a true value. If it
4822 does, this method tries to merge identical items into items with
4823 'quantity' equal to the number of items (not the sum of their
4824 separate quantities, for some reason).
4832 warn "$me _items_pkg searching for all package line items\n"
4835 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
4837 warn "$me _items_pkg filtering line items\n"
4839 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4841 if ($options{section} && $options{section}->{condensed}) {
4843 warn "$me _items_pkg condensing section\n"
4847 local $Storable::canonical = 1;
4848 foreach ( @items ) {
4850 delete $item->{ref};
4851 delete $item->{ext_description};
4852 my $key = freeze($item);
4853 $itemshash{$key} ||= 0;
4854 $itemshash{$key} ++; # += $item->{quantity};
4856 @items = sort { $a->{description} cmp $b->{description} }
4857 map { my $i = thaw($_);
4858 $i->{quantity} = $itemshash{$_};
4860 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
4866 warn "$me _items_pkg returning ". scalar(@items). " items\n"
4873 return 0 unless $a->itemdesc cmp $b->itemdesc;
4874 return -1 if $b->itemdesc eq 'Tax';
4875 return 1 if $a->itemdesc eq 'Tax';
4876 return -1 if $b->itemdesc eq 'Other surcharges';
4877 return 1 if $a->itemdesc eq 'Other surcharges';
4878 $a->itemdesc cmp $b->itemdesc;
4883 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
4884 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4887 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
4889 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
4890 list of hashrefs describing the line items they generate on the invoice.
4892 OPTIONS may include:
4894 format: the invoice format.
4896 escape_function: the function used to escape strings.
4898 DEPRECATED? (expensive, mostly unused?)
4899 format_function: the function used to format CDRs.
4901 section: a hashref containing 'description'; if this is present,
4902 cust_bill_pkg_display records not belonging to this section are
4905 multisection: a flag indicating that this is a multisection invoice,
4906 which does something complicated.
4908 multilocation: a flag to display the location label for the package.
4910 Returns a list of hashrefs, each of which may contain:
4912 pkgnum, description, amount, unit_amount, quantity, _is_setup, and
4913 ext_description, which is an arrayref of detail lines to show below
4918 sub _items_cust_bill_pkg {
4920 my $conf = $self->conf;
4921 my $cust_bill_pkgs = shift;
4924 my $format = $opt{format} || '';
4925 my $escape_function = $opt{escape_function} || sub { shift };
4926 my $format_function = $opt{format_function} || '';
4927 my $no_usage = $opt{no_usage} || '';
4928 my $unsquelched = $opt{unsquelched} || ''; #unused
4929 my $section = $opt{section}->{description} if $opt{section};
4930 my $summary_page = $opt{summary_page} || ''; #unused
4931 my $multilocation = $opt{multilocation} || '';
4932 my $multisection = $opt{multisection} || '';
4933 my $discount_show_always = 0;
4935 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4937 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
4940 my ($s, $r, $u) = ( undef, undef, undef );
4941 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
4944 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4945 if ( $_ && !$cust_bill_pkg->hidden ) {
4946 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
4947 $_->{amount} =~ s/^\-0\.00$/0.00/;
4948 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4950 if $_->{amount} != 0
4951 || $discount_show_always
4952 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
4953 || ( $_->{_is_setup} && $_->{setup_show_zero} )
4959 my @cust_bill_pkg_display = $cust_bill_pkg->cust_bill_pkg_display;
4961 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
4962 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
4965 foreach my $display ( grep { defined($section)
4966 ? $_->section eq $section
4969 #grep { !$_->summary || !$summary_page } # bunk!
4970 grep { !$_->summary || $multisection }
4971 @cust_bill_pkg_display
4975 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
4976 $display->billpkgdisplaynum. "\n"
4979 my $type = $display->type;
4981 my $desc = $cust_bill_pkg->desc;
4982 $desc = substr($desc, 0, $maxlength). '...'
4983 if $format eq 'latex' && length($desc) > $maxlength;
4985 my %details_opt = ( 'format' => $format,
4986 'escape_function' => $escape_function,
4987 'format_function' => $format_function,
4988 'no_usage' => $opt{'no_usage'},
4991 if ( $cust_bill_pkg->pkgnum > 0 ) {
4993 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
4996 my $cust_pkg = $cust_bill_pkg->cust_pkg;
4998 # which pkgpart to show for display purposes?
4999 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
5001 # start/end dates for invoice formats that do nonstandard
5003 my %item_dates = ();
5004 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
5005 unless $cust_pkg->part_pkg->option('disable_line_item_date_ranges',1);
5007 if ( (!$type || $type eq 'S')
5008 && ( $cust_bill_pkg->setup != 0
5009 || $cust_bill_pkg->setup_show_zero
5014 warn "$me _items_cust_bill_pkg adding setup\n"
5017 my $description = $desc;
5018 $description .= ' Setup'
5019 if $cust_bill_pkg->recur != 0
5020 || $discount_show_always
5021 || $cust_bill_pkg->recur_show_zero;
5024 unless ( $cust_pkg->part_pkg->hide_svc_detail
5025 || $cust_bill_pkg->hidden )
5028 push @d, map &{$escape_function}($_),
5029 $cust_pkg->h_labels_short($self->_date, undef, 'I')
5030 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
5032 if ( $multilocation ) {
5033 my $loc = $cust_pkg->location_label;
5034 $loc = substr($loc, 0, $maxlength). '...'
5035 if $format eq 'latex' && length($loc) > $maxlength;
5036 push @d, &{$escape_function}($loc);
5039 } #unless hiding service details
5041 push @d, $cust_bill_pkg->details(%details_opt)
5042 if $cust_bill_pkg->recur == 0;
5044 if ( $cust_bill_pkg->hidden ) {
5045 $s->{amount} += $cust_bill_pkg->setup;
5046 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
5047 push @{ $s->{ext_description} }, @d;
5051 description => $description,
5052 pkgpart => $pkgpart,
5053 pkgnum => $cust_bill_pkg->pkgnum,
5054 amount => $cust_bill_pkg->setup,
5055 setup_show_zero => $cust_bill_pkg->setup_show_zero,
5056 unit_amount => $cust_bill_pkg->unitsetup,
5057 quantity => $cust_bill_pkg->quantity,
5058 ext_description => \@d,
5064 if ( ( !$type || $type eq 'R' || $type eq 'U' )
5066 $cust_bill_pkg->recur != 0
5067 || $cust_bill_pkg->setup == 0
5068 || $discount_show_always
5069 || $cust_bill_pkg->recur_show_zero
5074 warn "$me _items_cust_bill_pkg adding recur/usage\n"
5077 my $is_summary = $display->summary;
5078 my $description = ($is_summary && $type && $type eq 'U')
5079 ? "Usage charges" : $desc;
5081 my $part_pkg = $cust_pkg->part_pkg;
5083 #pry be a bit more efficient to look some of this conf stuff up
5086 $conf->exists('disable_line_item_date_ranges')
5087 || $part_pkg->option('disable_line_item_date_ranges',1)
5090 my $date_style = '';
5091 $date_style = $conf->config( 'cust_bill-line_item-date_style-non_monthly',
5092 $cust_main->agentnum
5094 if $part_pkg && $part_pkg->freq !~ /^1m?$/;
5095 $date_style ||= $conf->config( 'cust_bill-line_item-date_style',
5096 $cust_main->agentnum
5098 if ( defined($date_style) && $date_style eq 'month_of' ) {
5099 $time_period = time2str('The month of %B', $cust_bill_pkg->sdate);
5100 } elsif ( defined($date_style) && $date_style eq 'X_month' ) {
5101 my $desc = $conf->config( 'cust_bill-line_item-date_description',
5102 $cust_main->agentnum
5104 $desc .= ' ' unless $desc =~ /\s$/;
5105 $time_period = $desc. time2str('%B', $cust_bill_pkg->sdate);
5107 $time_period = time2str($date_format, $cust_bill_pkg->sdate).
5108 " - ". time2str($date_format, $cust_bill_pkg->edate);
5110 $description .= " ($time_period)";
5114 my @seconds = (); # for display of usage info
5116 #at least until cust_bill_pkg has "past" ranges in addition to
5117 #the "future" sdate/edate ones... see #3032
5118 my @dates = ( $self->_date );
5119 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
5120 push @dates, $prev->sdate if $prev;
5121 push @dates, undef if !$prev;
5123 unless ( $cust_pkg->part_pkg->hide_svc_detail
5124 || $cust_bill_pkg->itemdesc
5125 || $cust_bill_pkg->hidden
5126 || $is_summary && $type && $type eq 'U' )
5129 warn "$me _items_cust_bill_pkg adding service details\n"
5132 push @d, map &{$escape_function}($_),
5133 $cust_pkg->h_labels_short(@dates, 'I')
5134 #$cust_bill_pkg->edate,
5135 #$cust_bill_pkg->sdate)
5136 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
5138 warn "$me _items_cust_bill_pkg done adding service details\n"
5141 if ( $multilocation ) {
5142 my $loc = $cust_pkg->location_label;
5143 $loc = substr($loc, 0, $maxlength). '...'
5144 if $format eq 'latex' && length($loc) > $maxlength;
5145 push @d, &{$escape_function}($loc);
5148 # Display of seconds_since_sqlradacct:
5149 # On the invoice, when processing @detail_items, look for a field
5150 # named 'seconds'. This will contain total seconds for each
5151 # service, in the same order as @ext_description. For services
5152 # that don't support this it will show undef.
5153 if ( $conf->exists('svc_acct-usage_seconds')
5154 and ! $cust_bill_pkg->pkgpart_override ) {
5155 foreach my $cust_svc (
5156 $cust_pkg->h_cust_svc(@dates, 'I')
5159 # eval because not having any part_export_usage exports
5160 # is a fatal error, last_bill/_date because that's how
5161 # sqlradius_hour billing does it
5163 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
5165 push @seconds, $sec;
5167 } #if svc_acct-usage_seconds
5171 unless ( $is_summary ) {
5172 warn "$me _items_cust_bill_pkg adding details\n"
5175 #instead of omitting details entirely in this case (unwanted side
5176 # effects), just omit CDRs
5177 $details_opt{'no_usage'} = 1
5178 if $type && $type eq 'R';
5180 push @d, $cust_bill_pkg->details(%details_opt);
5183 warn "$me _items_cust_bill_pkg calculating amount\n"
5188 $amount = $cust_bill_pkg->recur;
5189 } elsif ($type eq 'R') {
5190 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
5191 } elsif ($type eq 'U') {
5192 $amount = $cust_bill_pkg->usage;
5195 if ( !$type || $type eq 'R' ) {
5197 warn "$me _items_cust_bill_pkg adding recur\n"
5200 if ( $cust_bill_pkg->hidden ) {
5201 $r->{amount} += $amount;
5202 $r->{unit_amount} += $cust_bill_pkg->unitrecur;
5203 push @{ $r->{ext_description} }, @d;
5206 description => $description,
5207 pkgpart => $pkgpart,
5208 pkgnum => $cust_bill_pkg->pkgnum,
5210 recur_show_zero => $cust_bill_pkg->recur_show_zero,
5211 unit_amount => $cust_bill_pkg->unitrecur,
5212 quantity => $cust_bill_pkg->quantity,
5214 ext_description => \@d,
5216 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
5219 } else { # $type eq 'U'
5221 warn "$me _items_cust_bill_pkg adding usage\n"
5224 if ( $cust_bill_pkg->hidden ) {
5225 $u->{amount} += $amount;
5226 $u->{unit_amount} += $cust_bill_pkg->unitrecur;
5227 push @{ $u->{ext_description} }, @d;
5230 description => $description,
5231 pkgpart => $pkgpart,
5232 pkgnum => $cust_bill_pkg->pkgnum,
5234 recur_show_zero => $cust_bill_pkg->recur_show_zero,
5235 unit_amount => $cust_bill_pkg->unitrecur,
5236 quantity => $cust_bill_pkg->quantity,
5238 ext_description => \@d,
5243 } # recurring or usage with recurring charge
5245 } else { #pkgnum tax or one-shot line item (??)
5247 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
5250 if ( $cust_bill_pkg->setup != 0 ) {
5252 'description' => $desc,
5253 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
5256 if ( $cust_bill_pkg->recur != 0 ) {
5258 'description' => "$desc (".
5259 time2str($date_format, $cust_bill_pkg->sdate). ' - '.
5260 time2str($date_format, $cust_bill_pkg->edate). ')',
5261 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
5269 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
5270 && $conf->exists('discount-show-always'));
5274 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
5276 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
5277 $_->{amount} =~ s/^\-0\.00$/0.00/;
5278 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
5280 if $_->{amount} != 0
5281 || $discount_show_always
5282 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
5283 || ( $_->{_is_setup} && $_->{setup_show_zero} )
5287 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
5294 sub _items_credits {
5295 my( $self, %opt ) = @_;
5296 my $trim_len = $opt{'trim_len'} || 60;
5300 foreach ( $self->cust_credited ) {
5302 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
5304 my $reason = substr($_->cust_credit->reason, 0, $trim_len);
5305 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
5306 $reason = " ($reason) " if $reason;
5309 #'description' => 'Credit ref\#'. $_->crednum.
5310 # " (". time2str("%x",$_->cust_credit->_date) .")".
5312 'description' => $self->mt('Credit applied').' '.
5313 time2str($date_format,$_->cust_credit->_date). $reason,
5314 'amount' => sprintf("%.2f",$_->amount),
5322 sub _items_payments {
5326 #get & print payments
5327 foreach ( $self->cust_bill_pay ) {
5329 #something more elaborate if $_->amount ne ->cust_pay->paid ?
5332 'description' => $self->mt('Payment received').' '.
5333 time2str($date_format,$_->cust_pay->_date ),
5334 'amount' => sprintf("%.2f", $_->amount )
5342 =item _items_discounts_avail
5344 Returns an array of line item hashrefs representing available term discounts
5345 for this invoice. This makes the same assumptions that apply to term
5346 discounts in general: that the package is billed monthly, at a flat rate,
5347 with no usage charges. A prorated first month will be handled, as will
5348 a setup fee if the discount is allowed to apply to setup fees.
5352 sub _items_discounts_avail {
5354 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
5356 my %plans = $self->discount_plans;
5358 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
5362 my $plan = $plans{$months};
5364 my $term_total = sprintf('%.2f', $plan->discounted_total);
5365 my $percent = sprintf('%.0f',
5366 100 * (1 - $term_total / $plan->base_total) );
5367 my $permonth = sprintf('%.2f', $term_total / $months);
5368 my $detail = $self->mt('discount on item'). ' '.
5369 join(', ', map { "#$_" } $plan->pkgnums)
5372 # discounts for non-integer months don't work anyway
5373 $months = sprintf("%d", $months);
5376 description => $self->mt('Save [_1]% by paying for [_2] months',
5378 amount => $self->mt('[_1] ([_2] per month)',
5379 $term_total, $money_char.$permonth),
5380 ext_description => ($detail || ''),
5383 sort { $b <=> $a } keys %plans;
5387 =item call_details [ OPTION => VALUE ... ]
5389 Returns an array of CSV strings representing the call details for this invoice
5390 The only option available is the boolean prepend_billed_number
5395 my ($self, %opt) = @_;
5397 my $format_function = sub { shift };
5399 if ($opt{prepend_billed_number}) {
5400 $format_function = sub {
5404 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
5409 my @details = map { $_->details( 'format_function' => $format_function,
5410 'escape_function' => sub{ return() },
5414 $self->cust_bill_pkg;
5415 my $header = $details[0];
5416 ( $header, grep { $_ ne $header } @details );
5426 =item process_reprint
5430 sub process_reprint {
5431 process_re_X('print', @_);
5434 =item process_reemail
5438 sub process_reemail {
5439 process_re_X('email', @_);
5447 process_re_X('fax', @_);
5455 process_re_X('ftp', @_);
5462 sub process_respool {
5463 process_re_X('spool', @_);
5466 use Storable qw(thaw);
5470 my( $method, $job ) = ( shift, shift );
5471 warn "$me process_re_X $method for job $job\n" if $DEBUG;
5473 my $param = thaw(decode_base64(shift));
5474 warn Dumper($param) if $DEBUG;
5485 my($method, $job, %param ) = @_;
5487 warn "re_X $method for job $job with param:\n".
5488 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
5491 #some false laziness w/search/cust_bill.html
5493 my $orderby = 'ORDER BY cust_bill._date';
5495 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
5497 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
5499 my @cust_bill = qsearch( {
5500 #'select' => "cust_bill.*",
5501 'table' => 'cust_bill',
5502 'addl_from' => $addl_from,
5504 'extra_sql' => $extra_sql,
5505 'order_by' => $orderby,
5509 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
5511 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
5514 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5515 foreach my $cust_bill ( @cust_bill ) {
5516 $cust_bill->$method();
5518 if ( $job ) { #progressbar foo
5520 if ( time - $min_sec > $last ) {
5521 my $error = $job->update_statustext(
5522 int( 100 * $num / scalar(@cust_bill) )
5524 die $error if $error;
5535 =head1 CLASS METHODS
5541 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
5546 my ($class, $start, $end) = @_;
5548 $class->paid_sql($start, $end). ' - '.
5549 $class->credited_sql($start, $end);
5554 Returns an SQL fragment to retreive the net amount (charged minus credited).
5559 my ($class, $start, $end) = @_;
5560 'charged - '. $class->credited_sql($start, $end);
5565 Returns an SQL fragment to retreive the amount paid against this invoice.
5570 my ($class, $start, $end) = @_;
5571 $start &&= "AND cust_bill_pay._date <= $start";
5572 $end &&= "AND cust_bill_pay._date > $end";
5573 $start = '' unless defined($start);
5574 $end = '' unless defined($end);
5575 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
5576 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
5581 Returns an SQL fragment to retreive the amount credited against this invoice.
5586 my ($class, $start, $end) = @_;
5587 $start &&= "AND cust_credit_bill._date <= $start";
5588 $end &&= "AND cust_credit_bill._date > $end";
5589 $start = '' unless defined($start);
5590 $end = '' unless defined($end);
5591 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
5592 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
5597 Returns an SQL fragment to retrieve the due date of an invoice.
5598 Currently only supported on PostgreSQL.
5603 my $conf = new FS::Conf;
5607 cust_bill.invoice_terms,
5608 cust_main.invoice_terms,
5609 \''.($conf->config('invoice_default_terms') || '').'\'
5610 ), E\'Net (\\\\d+)\'
5612 ) * 86400 + cust_bill._date'
5615 =item search_sql_where HASHREF
5617 Class method which returns an SQL WHERE fragment to search for parameters
5618 specified in HASHREF. Valid parameters are
5624 List reference of start date, end date, as UNIX timestamps.
5634 List reference of charged limits (exclusive).
5638 List reference of charged limits (exclusive).
5642 flag, return open invoices only
5646 flag, return net invoices only
5650 =item newest_percust
5654 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
5658 sub search_sql_where {
5659 my($class, $param) = @_;
5661 warn "$me search_sql_where called with params: \n".
5662 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
5668 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
5669 push @search, "cust_main.agentnum = $1";
5673 if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
5674 push @search, "cust_main.refnum = $1";
5678 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
5679 push @search, "cust_bill.custnum = $1";
5683 if ( $param->{'cust_classnum'} ) {
5684 my $classnums = $param->{'cust_classnum'};
5685 $classnums = [ $classnums ] if !ref($classnums);
5686 $classnums = [ grep /^\d+$/, @$classnums ];
5687 push @search, 'cust_main.classnum in ('.join(',',@$classnums).')'
5692 if ( $param->{_date} ) {
5693 my($beginning, $ending) = @{$param->{_date}};
5695 push @search, "cust_bill._date >= $beginning",
5696 "cust_bill._date < $ending";
5700 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
5701 push @search, "cust_bill.invnum >= $1";
5703 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
5704 push @search, "cust_bill.invnum <= $1";
5708 if ( $param->{charged} ) {
5709 my @charged = ref($param->{charged})
5710 ? @{ $param->{charged} }
5711 : ($param->{charged});
5713 push @search, map { s/^charged/cust_bill.charged/; $_; }
5717 my $owed_sql = FS::cust_bill->owed_sql;
5720 if ( $param->{owed} ) {
5721 my @owed = ref($param->{owed})
5722 ? @{ $param->{owed} }
5724 push @search, map { s/^owed/$owed_sql/; $_; }
5729 push @search, "0 != $owed_sql"
5730 if $param->{'open'};
5731 push @search, '0 != '. FS::cust_bill->net_sql
5735 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
5736 if $param->{'days'};
5739 if ( $param->{'newest_percust'} ) {
5741 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
5742 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
5744 my @newest_where = map { my $x = $_;
5745 $x =~ s/\bcust_bill\./newest_cust_bill./g;
5748 grep ! /^cust_main./, @search;
5749 my $newest_where = scalar(@newest_where)
5750 ? ' AND '. join(' AND ', @newest_where)
5754 push @search, "cust_bill._date = (
5755 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
5756 WHERE newest_cust_bill.custnum = cust_bill.custnum
5762 #promised_date - also has an option to accept nulls
5763 if ( $param->{promised_date} ) {
5764 my($beginning, $ending, $null) = @{$param->{promised_date}};
5766 push @search, "(( cust_bill.promised_date >= $beginning AND ".
5767 "cust_bill.promised_date < $ending )" .
5768 ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
5771 #agent virtualization
5772 my $curuser = $FS::CurrentUser::CurrentUser;
5773 if ( $curuser->username eq 'fs_queue'
5774 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
5776 my $newuser = qsearchs('access_user', {
5777 'username' => $username,
5781 $curuser = $newuser;
5783 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
5786 push @search, $curuser->agentnums_sql;
5788 join(' AND ', @search );
5800 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
5801 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base