4 use vars qw( @ISA $DEBUG $me $conf $money_char $date_format $rdate_format );
5 use vars qw( $invoice_lines @buf ); #yuck
6 use Fcntl qw(:flock); #for spool_csv
7 use List::Util qw(min max);
9 use Text::Template 1.20;
11 use String::ShellQuote;
14 use Storable qw( freeze thaw );
15 use FS::UID qw( datasrc );
16 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
17 use FS::Record qw( qsearch qsearchs dbh );
18 use FS::cust_main_Mixin;
20 use FS::cust_statement;
21 use FS::cust_bill_pkg;
22 use FS::cust_bill_pkg_display;
23 use FS::cust_bill_pkg_detail;
27 use FS::cust_credit_bill;
29 use FS::cust_pay_batch;
30 use FS::cust_bill_event;
33 use FS::cust_bill_pay;
34 use FS::cust_bill_pay_batch;
35 use FS::part_bill_event;
38 @ISA = qw( FS::cust_main_Mixin FS::Record );
41 $me = '[FS::cust_bill]';
43 #ask FS::UID to run this stuff for us later
44 FS::UID->install_callback( sub {
46 $money_char = $conf->config('money_char') || '$';
47 $date_format = $conf->config('date_format') || '%x';
48 $rdate_format = $conf->config('date_format') || '%m/%d/%Y';
53 FS::cust_bill - Object methods for cust_bill records
59 $record = new FS::cust_bill \%hash;
60 $record = new FS::cust_bill { 'column' => 'value' };
62 $error = $record->insert;
64 $error = $new_record->replace($old_record);
66 $error = $record->delete;
68 $error = $record->check;
70 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
72 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
74 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
76 @cust_pay_objects = $cust_bill->cust_pay;
78 $tax_amount = $record->tax;
80 @lines = $cust_bill->print_text;
81 @lines = $cust_bill->print_text $time;
85 An FS::cust_bill object represents an invoice; a declaration that a customer
86 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
87 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
88 following fields are currently supported:
94 =item invnum - primary key (assigned automatically for new invoices)
96 =item custnum - customer (see L<FS::cust_main>)
98 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
99 L<Time::Local> and L<Date::Parse> for conversion functions.
101 =item charged - amount of this invoice
103 =item invoice_terms - optional terms override for this specific invoice
107 Customer info at invoice generation time
111 =item previous_balance
113 =item billing_balance
121 =item printed - deprecated
129 =item closed - books closed flag, empty or `Y'
131 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
133 =item agent_invid - legacy invoice number
143 Creates a new invoice. To add the invoice to the database, see L<"insert">.
144 Invoices are normally created by calling the bill method of a customer object
145 (see L<FS::cust_main>).
149 sub table { 'cust_bill'; }
151 sub cust_linked { $_[0]->cust_main_custnum; }
152 sub cust_unlinked_msg {
154 "WARNING: can't find cust_main.custnum ". $self->custnum.
155 ' (cust_bill.invnum '. $self->invnum. ')';
160 Adds this invoice to the database ("Posts" the invoice). If there is an error,
161 returns the error, otherwise returns false.
165 This method now works but you probably shouldn't use it. Instead, apply a
166 credit against the invoice.
168 Using this method to delete invoices outright is really, really bad. There
169 would be no record you ever posted this invoice, and there are no check to
170 make sure charged = 0 or that there are no associated cust_bill_pkg records.
172 Really, don't use it.
178 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
180 local $SIG{HUP} = 'IGNORE';
181 local $SIG{INT} = 'IGNORE';
182 local $SIG{QUIT} = 'IGNORE';
183 local $SIG{TERM} = 'IGNORE';
184 local $SIG{TSTP} = 'IGNORE';
185 local $SIG{PIPE} = 'IGNORE';
187 my $oldAutoCommit = $FS::UID::AutoCommit;
188 local $FS::UID::AutoCommit = 0;
191 foreach my $table (qw(
203 foreach my $linked ( $self->$table() ) {
204 my $error = $linked->delete;
206 $dbh->rollback if $oldAutoCommit;
213 my $error = $self->SUPER::delete(@_);
215 $dbh->rollback if $oldAutoCommit;
219 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
225 =item replace OLD_RECORD
227 Replaces the OLD_RECORD with this one in the database. If there is an error,
228 returns the error, otherwise returns false.
230 Only printed may be changed. printed is normally updated by calling the
231 collect method of a customer object (see L<FS::cust_main>).
235 #replace can be inherited from Record.pm
237 # replace_check is now the preferred way to #implement replace data checks
238 # (so $object->replace() works without an argument)
241 my( $new, $old ) = ( shift, shift );
242 return "Can't change custnum!" unless $old->custnum == $new->custnum;
243 #return "Can't change _date!" unless $old->_date eq $new->_date;
244 return "Can't change _date!" unless $old->_date == $new->_date;
245 return "Can't change charged!" unless $old->charged == $new->charged
246 || $old->charged == 0;
253 Checks all fields to make sure this is a valid invoice. If there is an error,
254 returns the error, otherwise returns false. Called by the insert and replace
263 $self->ut_numbern('invnum')
264 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
265 || $self->ut_numbern('_date')
266 || $self->ut_money('charged')
267 || $self->ut_numbern('printed')
268 || $self->ut_enum('closed', [ '', 'Y' ])
269 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
270 || $self->ut_numbern('agent_invid') #varchar?
272 return $error if $error;
274 $self->_date(time) unless $self->_date;
276 $self->printed(0) if $self->printed eq '';
283 Returns the displayed invoice number for this invoice: agent_invid if
284 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
290 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
291 return $self->agent_invid;
293 return $self->invnum;
299 Returns a list consisting of the total previous balance for this customer,
300 followed by the previous outstanding invoices (as FS::cust_bill objects also).
307 my @cust_bill = sort { $a->_date <=> $b->_date }
308 grep { $_->owed != 0 && $_->_date < $self->_date }
309 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
311 foreach ( @cust_bill ) { $total += $_->owed; }
317 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
324 { 'table' => 'cust_bill_pkg',
325 'hashref' => { 'invnum' => $self->invnum },
326 'order_by' => 'ORDER BY billpkgnum',
331 =item cust_bill_pkg_pkgnum PKGNUM
333 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
338 sub cust_bill_pkg_pkgnum {
339 my( $self, $pkgnum ) = @_;
341 { 'table' => 'cust_bill_pkg',
342 'hashref' => { 'invnum' => $self->invnum,
345 'order_by' => 'ORDER BY billpkgnum',
352 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
359 my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
361 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
364 =item open_cust_bill_pkg
366 Returns the open line items for this invoice.
368 Note that cust_bill_pkg with both setup and recur fees are returned as two
369 separate line items, each with only one fee.
373 # modeled after cust_main::open_cust_bill
374 sub open_cust_bill_pkg {
377 # grep { $_->owed > 0 } $self->cust_bill_pkg
379 my %other = ( 'recur' => 'setup',
380 'setup' => 'recur', );
382 foreach my $field ( qw( recur setup )) {
383 push @open, map { $_->set( $other{$field}, 0 ); $_; }
384 grep { $_->owed($field) > 0 }
385 $self->cust_bill_pkg;
391 =item cust_bill_event
393 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
397 sub cust_bill_event {
399 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
402 =item num_cust_bill_event
404 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
408 sub num_cust_bill_event {
411 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
412 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
413 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
414 $sth->fetchrow_arrayref->[0];
419 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
423 #false laziness w/cust_pkg.pm
427 'table' => 'cust_event',
428 'addl_from' => 'JOIN part_event USING ( eventpart )',
429 'hashref' => { 'tablenum' => $self->invnum },
430 'extra_sql' => " AND eventtable = 'cust_bill' ",
436 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
440 #false laziness w/cust_pkg.pm
444 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
445 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
446 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
447 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
448 $sth->fetchrow_arrayref->[0];
453 Returns the customer (see L<FS::cust_main>) for this invoice.
459 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
462 =item cust_suspend_if_balance_over AMOUNT
464 Suspends the customer associated with this invoice if the total amount owed on
465 this invoice and all older invoices is greater than the specified amount.
467 Returns a list: an empty list on success or a list of errors.
471 sub cust_suspend_if_balance_over {
472 my( $self, $amount ) = ( shift, shift );
473 my $cust_main = $self->cust_main;
474 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
477 $cust_main->suspend(@_);
483 Depreciated. See the cust_credited method.
485 #Returns a list consisting of the total previous credited (see
486 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
487 #outstanding credits (FS::cust_credit objects).
493 croak "FS::cust_bill->cust_credit depreciated; see ".
494 "FS::cust_bill->cust_credit_bill";
497 #my @cust_credit = sort { $a->_date <=> $b->_date }
498 # grep { $_->credited != 0 && $_->_date < $self->_date }
499 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
501 #foreach (@cust_credit) { $total += $_->credited; }
502 #$total, @cust_credit;
507 Depreciated. See the cust_bill_pay method.
509 #Returns all payments (see L<FS::cust_pay>) for this invoice.
515 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
517 #sort { $a->_date <=> $b->_date }
518 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
524 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
527 sub cust_bill_pay_batch {
529 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
534 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
540 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
541 sort { $a->_date <=> $b->_date }
542 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
547 =item cust_credit_bill
549 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
555 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
556 sort { $a->_date <=> $b->_date }
557 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
561 sub cust_credit_bill {
562 shift->cust_credited(@_);
565 =item cust_bill_pay_pkgnum PKGNUM
567 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
568 with matching pkgnum.
572 sub cust_bill_pay_pkgnum {
573 my( $self, $pkgnum ) = @_;
574 map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
575 sort { $a->_date <=> $b->_date }
576 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
582 =item cust_credited_pkgnum PKGNUM
584 =item cust_credit_bill_pkgnum PKGNUM
586 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
587 with matching pkgnum.
591 sub cust_credited_pkgnum {
592 my( $self, $pkgnum ) = @_;
593 map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
594 sort { $a->_date <=> $b->_date }
595 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
601 sub cust_credit_bill_pkgnum {
602 shift->cust_credited_pkgnum(@_);
607 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
614 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
616 foreach (@taxlines) { $total += $_->setup; }
622 Returns the amount owed (still outstanding) on this invoice, which is charged
623 minus all payment applications (see L<FS::cust_bill_pay>) and credit
624 applications (see L<FS::cust_credit_bill>).
630 my $balance = $self->charged;
631 $balance -= $_->amount foreach ( $self->cust_bill_pay );
632 $balance -= $_->amount foreach ( $self->cust_credited );
633 $balance = sprintf( "%.2f", $balance);
634 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
639 my( $self, $pkgnum ) = @_;
641 #my $balance = $self->charged;
643 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
645 $balance -= $_->amount for $self->cust_bill_pay_pkgnum($pkgnum);
646 $balance -= $_->amount for $self->cust_credited_pkgnum($pkgnum);
648 $balance = sprintf( "%.2f", $balance);
649 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
653 =item apply_payments_and_credits [ OPTION => VALUE ... ]
655 Applies unapplied payments and credits to this invoice.
657 A hash of optional arguments may be passed. Currently "manual" is supported.
658 If true, a payment receipt is sent instead of a statement when
659 'payment_receipt_email' configuration option is set.
661 If there is an error, returns the error, otherwise returns false.
665 sub apply_payments_and_credits {
666 my( $self, %options ) = @_;
668 local $SIG{HUP} = 'IGNORE';
669 local $SIG{INT} = 'IGNORE';
670 local $SIG{QUIT} = 'IGNORE';
671 local $SIG{TERM} = 'IGNORE';
672 local $SIG{TSTP} = 'IGNORE';
673 local $SIG{PIPE} = 'IGNORE';
675 my $oldAutoCommit = $FS::UID::AutoCommit;
676 local $FS::UID::AutoCommit = 0;
679 $self->select_for_update; #mutex
681 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
682 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
684 if ( $conf->exists('pkg-balances') ) {
685 # limit @payments & @credits to those w/ a pkgnum grepped from $self
686 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
687 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
688 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
691 while ( $self->owed > 0 and ( @payments || @credits ) ) {
694 if ( @payments && @credits ) {
696 #decide which goes first by weight of top (unapplied) line item
698 my @open_lineitems = $self->open_cust_bill_pkg;
701 max( map { $_->part_pkg->pay_weight || 0 }
706 my $max_credit_weight =
707 max( map { $_->part_pkg->credit_weight || 0 }
713 #if both are the same... payments first? it has to be something
714 if ( $max_pay_weight >= $max_credit_weight ) {
720 } elsif ( @payments ) {
722 } elsif ( @credits ) {
725 die "guru meditation #12 and 35";
729 if ( $app eq 'pay' ) {
731 my $payment = shift @payments;
732 $unapp_amount = $payment->unapplied;
733 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
734 $app->pkgnum( $payment->pkgnum )
735 if $conf->exists('pkg-balances') && $payment->pkgnum;
737 } elsif ( $app eq 'credit' ) {
739 my $credit = shift @credits;
740 $unapp_amount = $credit->credited;
741 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
742 $app->pkgnum( $credit->pkgnum )
743 if $conf->exists('pkg-balances') && $credit->pkgnum;
746 die "guru meditation #12 and 35";
750 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
751 warn "owed_pkgnum ". $app->pkgnum;
752 $owed = $self->owed_pkgnum($app->pkgnum);
756 next unless $owed > 0;
758 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
759 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
761 $app->invnum( $self->invnum );
763 my $error = $app->insert(%options);
765 $dbh->rollback if $oldAutoCommit;
766 return "Error inserting ". $app->table. " record: $error";
768 die $error if $error;
772 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
777 =item generate_email OPTION => VALUE ...
785 sender address, required
789 alternate template name, optional
793 text attachment arrayref, optional
797 email subject, optional
801 notice name instead of "Invoice", optional
805 Returns an argument list to be passed to L<FS::Misc::send_email>.
816 my $me = '[FS::cust_bill::generate_email]';
819 'from' => $args{'from'},
820 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
824 'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
825 'template' => $args{'template'},
826 'notice_name' => ( $args{'notice_name'} || 'Invoice' ),
829 my $cust_main = $self->cust_main;
831 if (ref($args{'to'}) eq 'ARRAY') {
832 $return{'to'} = $args{'to'};
834 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
835 $cust_main->invoicing_list
839 if ( $conf->exists('invoice_html') ) {
841 warn "$me creating HTML/text multipart message"
844 $return{'nobody'} = 1;
846 my $alternative = build MIME::Entity
847 'Type' => 'multipart/alternative',
848 'Encoding' => '7bit',
849 'Disposition' => 'inline'
853 if ( $conf->exists('invoice_email_pdf')
854 and scalar($conf->config('invoice_email_pdf_note')) ) {
856 warn "$me using 'invoice_email_pdf_note' in multipart message"
858 $data = [ map { $_ . "\n" }
859 $conf->config('invoice_email_pdf_note')
864 warn "$me not using 'invoice_email_pdf_note' in multipart message"
866 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
867 $data = $args{'print_text'};
869 $data = [ $self->print_text(\%opt) ];
874 $alternative->attach(
875 'Type' => 'text/plain',
876 #'Encoding' => 'quoted-printable',
877 'Encoding' => '7bit',
879 'Disposition' => 'inline',
882 $args{'from'} =~ /\@([\w\.\-]+)/;
883 my $from = $1 || 'example.com';
884 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
887 my $agentnum = $cust_main->agentnum;
888 if ( defined($args{'template'}) && length($args{'template'})
889 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
892 $logo = 'logo_'. $args{'template'}. '.png';
896 my $image_data = $conf->config_binary( $logo, $agentnum);
898 my $image = build MIME::Entity
899 'Type' => 'image/png',
900 'Encoding' => 'base64',
901 'Data' => $image_data,
902 'Filename' => 'logo.png',
903 'Content-ID' => "<$content_id>",
906 $alternative->attach(
907 'Type' => 'text/html',
908 'Encoding' => 'quoted-printable',
909 'Data' => [ '<html>',
912 ' '. encode_entities($return{'subject'}),
915 ' <body bgcolor="#e8e8e8">',
916 $self->print_html({ 'cid'=>$content_id, %opt }),
920 'Disposition' => 'inline',
921 #'Filename' => 'invoice.pdf',
925 if ( $cust_main->email_csv_cdr ) {
927 push @otherparts, build MIME::Entity
928 'Type' => 'text/csv',
929 'Encoding' => '7bit',
930 'Data' => [ map { "$_\n" }
931 $self->call_details('prepend_billed_number' => 1)
933 'Disposition' => 'attachment',
934 'Filename' => 'usage-'. $self->invnum. '.csv',
939 if ( $conf->exists('invoice_email_pdf') ) {
944 # multipart/alternative
950 my $related = build MIME::Entity 'Type' => 'multipart/related',
951 'Encoding' => '7bit';
953 #false laziness w/Misc::send_email
954 $related->head->replace('Content-type',
956 '; boundary="'. $related->head->multipart_boundary. '"'.
957 '; type=multipart/alternative'
960 $related->add_part($alternative);
962 $related->add_part($image);
964 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
966 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
970 #no other attachment:
972 # multipart/alternative
977 $return{'content-type'} = 'multipart/related';
978 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
979 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
980 #$return{'disposition'} = 'inline';
986 if ( $conf->exists('invoice_email_pdf') ) {
987 warn "$me creating PDF attachment"
990 #mime parts arguments a la MIME::Entity->build().
991 $return{'mimeparts'} = [
992 { $self->mimebuild_pdf(\%opt) }
996 if ( $conf->exists('invoice_email_pdf')
997 and scalar($conf->config('invoice_email_pdf_note')) ) {
999 warn "$me using 'invoice_email_pdf_note'"
1001 $return{'body'} = [ map { $_ . "\n" }
1002 $conf->config('invoice_email_pdf_note')
1007 warn "$me not using 'invoice_email_pdf_note'"
1009 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1010 $return{'body'} = $args{'print_text'};
1012 $return{'body'} = [ $self->print_text(\%opt) ];
1025 Returns a list suitable for passing to MIME::Entity->build(), representing
1026 this invoice as PDF attachment.
1033 'Type' => 'application/pdf',
1034 'Encoding' => 'base64',
1035 'Data' => [ $self->print_pdf(@_) ],
1036 'Disposition' => 'attachment',
1037 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1041 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1043 Sends this invoice to the destinations configured for this customer: sends
1044 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1046 Options can be passed as a hashref (recommended) or as a list of up to
1047 four values for templatename, agentnum, invoice_from and amount.
1049 I<template>, if specified, is the name of a suffix for alternate invoices.
1051 I<agentnum>, if specified, means that this invoice will only be sent for customers
1052 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
1053 single agent) or an arrayref of agentnums.
1055 I<invoice_from>, if specified, overrides the default email invoice From: address.
1057 I<amount>, if specified, only sends the invoice if the total amount owed on this
1058 invoice and all older invoices is greater than the specified amount.
1060 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1064 sub queueable_send {
1067 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1068 or die "invalid invoice number: " . $opt{invnum};
1070 my @args = ( $opt{template}, $opt{agentnum} );
1071 push @args, $opt{invoice_from}
1072 if exists($opt{invoice_from}) && $opt{invoice_from};
1074 my $error = $self->send( @args );
1075 die $error if $error;
1082 my( $template, $invoice_from, $notice_name );
1084 my $balance_over = 0;
1088 $template = $opt->{'template'} || '';
1089 if ( $agentnums = $opt->{'agentnum'} ) {
1090 $agentnums = [ $agentnums ] unless ref($agentnums);
1092 $invoice_from = $opt->{'invoice_from'};
1093 $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1094 $notice_name = $opt->{'notice_name'};
1096 $template = scalar(@_) ? shift : '';
1097 if ( scalar(@_) && $_[0] ) {
1098 $agentnums = ref($_[0]) ? shift : [ shift ];
1100 $invoice_from = shift if scalar(@_);
1101 $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1104 return 'N/A' unless ! $agentnums
1105 or grep { $_ == $self->cust_main->agentnum } @$agentnums;
1108 unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
1110 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1111 $conf->config('invoice_from', $self->cust_main->agentnum );
1114 'template' => $template,
1115 'invoice_from' => $invoice_from,
1116 'notice_name' => ( $notice_name || 'Invoice' ),
1119 my @invoicing_list = $self->cust_main->invoicing_list;
1121 #$self->email_invoice(\%opt)
1123 if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
1125 #$self->print_invoice(\%opt)
1127 if grep { $_ eq 'POST' } @invoicing_list; #postal
1129 $self->fax_invoice(\%opt)
1130 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1136 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1138 Emails this invoice.
1140 Options can be passed as a hashref (recommended) or as a list of up to
1141 two values for templatename and invoice_from.
1143 I<template>, if specified, is the name of a suffix for alternate invoices.
1145 I<invoice_from>, if specified, overrides the default email invoice From: address.
1147 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1151 sub queueable_email {
1154 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1155 or die "invalid invoice number: " . $opt{invnum};
1157 my @args = ( $opt{template} );
1158 push @args, $opt{invoice_from}
1159 if exists($opt{invoice_from}) && $opt{invoice_from};
1161 my $error = $self->email( @args );
1162 die $error if $error;
1166 #sub email_invoice {
1170 my( $template, $invoice_from, $notice_name );
1173 $template = $opt->{'template'} || '';
1174 $invoice_from = $opt->{'invoice_from'};
1175 $notice_name = $opt->{'notice_name'} || 'Invoice';
1177 $template = scalar(@_) ? shift : '';
1178 $invoice_from = shift if scalar(@_);
1179 $notice_name = 'Invoice';
1182 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1183 $conf->config('invoice_from', $self->cust_main->agentnum );
1185 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1186 $self->cust_main->invoicing_list;
1188 #better to notify this person than silence
1189 @invoicing_list = ($invoice_from) unless @invoicing_list;
1191 my $subject = $self->email_subject($template);
1193 my $error = send_email(
1194 $self->generate_email(
1195 'from' => $invoice_from,
1196 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1197 'subject' => $subject,
1198 'template' => $template,
1199 'notice_name' => $notice_name,
1202 die "can't email invoice: $error\n" if $error;
1203 #die "$error\n" if $error;
1210 #my $template = scalar(@_) ? shift : '';
1213 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1216 my $cust_main = $self->cust_main;
1217 my $name = $cust_main->name;
1218 my $name_short = $cust_main->name_short;
1219 my $invoice_number = $self->invnum;
1220 my $invoice_date = $self->_date_pretty;
1222 eval qq("$subject");
1225 =item lpr_data HASHREF | [ TEMPLATE ]
1227 Returns the postscript or plaintext for this invoice as an arrayref.
1229 Options can be passed as a hashref (recommended) or as a single optional value
1232 I<template>, if specified, is the name of a suffix for alternate invoices.
1234 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1240 my( $template, $notice_name );
1243 $template = $opt->{'template'} || '';
1244 $notice_name = $opt->{'notice_name'} || 'Invoice';
1246 $template = scalar(@_) ? shift : '';
1247 $notice_name = 'Invoice';
1251 'template' => $template,
1252 'notice_name' => $notice_name,
1255 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1256 [ $self->$method( \%opt ) ];
1259 =item print HASHREF | [ TEMPLATE ]
1261 Prints this invoice.
1263 Options can be passed as a hashref (recommended) or as a single optional
1266 I<template>, if specified, is the name of a suffix for alternate invoices.
1268 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1272 #sub print_invoice {
1275 my( $template, $notice_name );
1278 $template = $opt->{'template'} || '';
1279 $notice_name = $opt->{'notice_name'} || 'Invoice';
1281 $template = scalar(@_) ? shift : '';
1282 $notice_name = 'Invoice';
1286 'template' => $template,
1287 'notice_name' => $notice_name,
1290 do_print $self->lpr_data(\%opt);
1293 =item fax_invoice HASHREF | [ TEMPLATE ]
1297 Options can be passed as a hashref (recommended) or as a single optional
1300 I<template>, if specified, is the name of a suffix for alternate invoices.
1302 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1308 my( $template, $notice_name );
1311 $template = $opt->{'template'} || '';
1312 $notice_name = $opt->{'notice_name'} || 'Invoice';
1314 $template = scalar(@_) ? shift : '';
1315 $notice_name = 'Invoice';
1318 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1319 unless $conf->exists('invoice_latex');
1321 my $dialstring = $self->cust_main->getfield('fax');
1325 'template' => $template,
1326 'notice_name' => $notice_name,
1329 my $error = send_fax( 'docdata' => $self->lpr_data(\%opt),
1330 'dialstring' => $dialstring,
1332 die $error if $error;
1336 =item ftp_invoice [ TEMPLATENAME ]
1338 Sends this invoice data via FTP.
1340 TEMPLATENAME is unused?
1346 my $template = scalar(@_) ? shift : '';
1349 'protocol' => 'ftp',
1350 'server' => $conf->config('cust_bill-ftpserver'),
1351 'username' => $conf->config('cust_bill-ftpusername'),
1352 'password' => $conf->config('cust_bill-ftppassword'),
1353 'dir' => $conf->config('cust_bill-ftpdir'),
1354 'format' => $conf->config('cust_bill-ftpformat'),
1358 =item spool_invoice [ TEMPLATENAME ]
1360 Spools this invoice data (see L<FS::spool_csv>)
1362 TEMPLATENAME is unused?
1368 my $template = scalar(@_) ? shift : '';
1371 'format' => $conf->config('cust_bill-spoolformat'),
1372 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1376 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1378 Like B<send>, but only sends the invoice if it is the newest open invoice for
1383 sub send_if_newest {
1388 grep { $_->owed > 0 }
1389 qsearch('cust_bill', {
1390 'custnum' => $self->custnum,
1391 #'_date' => { op=>'>', value=>$self->_date },
1392 'invnum' => { op=>'>', value=>$self->invnum },
1399 =item send_csv OPTION => VALUE, ...
1401 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1405 protocol - currently only "ftp"
1411 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1412 and YYMMDDHHMMSS is a timestamp.
1414 See L</print_csv> for a description of the output format.
1419 my($self, %opt) = @_;
1423 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1424 mkdir $spooldir, 0700 unless -d $spooldir;
1426 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1427 my $file = "$spooldir/$tracctnum.csv";
1429 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1431 open(CSV, ">$file") or die "can't open $file: $!";
1439 if ( $opt{protocol} eq 'ftp' ) {
1440 eval "use Net::FTP;";
1442 $net = Net::FTP->new($opt{server}) or die @$;
1444 die "unknown protocol: $opt{protocol}";
1447 $net->login( $opt{username}, $opt{password} )
1448 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1450 $net->binary or die "can't set binary mode";
1452 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1454 $net->put($file) or die "can't put $file: $!";
1464 Spools CSV invoice data.
1470 =item format - 'default' or 'billco'
1472 =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>).
1474 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1476 =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.
1483 my($self, %opt) = @_;
1485 my $cust_main = $self->cust_main;
1487 if ( $opt{'dest'} ) {
1488 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1489 $cust_main->invoicing_list;
1490 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1491 || ! keys %invoicing_list;
1494 if ( $opt{'balanceover'} ) {
1496 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1499 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1500 mkdir $spooldir, 0700 unless -d $spooldir;
1502 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1506 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1507 ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1510 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1512 open(CSV, ">>$file") or die "can't open $file: $!";
1513 flock(CSV, LOCK_EX);
1518 if ( lc($opt{'format'}) eq 'billco' ) {
1520 flock(CSV, LOCK_UN);
1525 ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1528 open(CSV,">>$file") or die "can't open $file: $!";
1529 flock(CSV, LOCK_EX);
1535 flock(CSV, LOCK_UN);
1542 =item print_csv OPTION => VALUE, ...
1544 Returns CSV data for this invoice.
1548 format - 'default' or 'billco'
1550 Returns a list consisting of two scalars. The first is a single line of CSV
1551 header information for this invoice. The second is one or more lines of CSV
1552 detail information for this invoice.
1554 If I<format> is not specified or "default", the fields of the CSV file are as
1557 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1561 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1563 B<record_type> is C<cust_bill> for the initial header line only. The
1564 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1565 fields are filled in.
1567 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1568 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1571 =item invnum - invoice number
1573 =item custnum - customer number
1575 =item _date - invoice date
1577 =item charged - total invoice amount
1579 =item first - customer first name
1581 =item last - customer first name
1583 =item company - company name
1585 =item address1 - address line 1
1587 =item address2 - address line 1
1597 =item pkg - line item description
1599 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1601 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1603 =item sdate - start date for recurring fee
1605 =item edate - end date for recurring fee
1609 If I<format> is "billco", the fields of the header CSV file are as follows:
1611 +-------------------------------------------------------------------+
1612 | FORMAT HEADER FILE |
1613 |-------------------------------------------------------------------|
1614 | Field | Description | Name | Type | Width |
1615 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1616 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1617 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1618 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1619 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1620 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1621 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1622 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1623 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1624 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1625 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1626 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1627 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1628 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1629 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1630 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1631 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1632 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1633 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1634 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1635 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1636 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1637 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1638 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1639 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1640 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1641 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1642 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1643 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1644 +-------+-------------------------------+------------+------+-------+
1646 If I<format> is "billco", the fields of the detail CSV file are as follows:
1648 FORMAT FOR DETAIL FILE
1650 Field | Description | Name | Type | Width
1651 1 | N/A-Leave Empty | RC | CHAR | 2
1652 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1653 3 | Account Number | TRACCTNUM | CHAR | 15
1654 4 | Invoice Number | TRINVOICE | CHAR | 15
1655 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1656 6 | Transaction Detail | DETAILS | CHAR | 100
1657 7 | Amount | AMT | NUM* | 9
1658 8 | Line Format Control** | LNCTRL | CHAR | 2
1659 9 | Grouping Code | GROUP | CHAR | 2
1660 10 | User Defined | ACCT CODE | CHAR | 15
1665 my($self, %opt) = @_;
1667 eval "use Text::CSV_XS";
1670 my $cust_main = $self->cust_main;
1672 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1674 if ( lc($opt{'format'}) eq 'billco' ) {
1677 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1679 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1681 my( $previous_balance, @unused ) = $self->previous; #previous balance
1683 my $pmt_cr_applied = 0;
1684 $pmt_cr_applied += $_->{'amount'}
1685 foreach ( $self->_items_payments, $self->_items_credits ) ;
1687 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1690 '', # 1 | N/A-Leave Empty CHAR 2
1691 '', # 2 | N/A-Leave Empty CHAR 15
1692 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
1693 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1694 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1695 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1696 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1697 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1698 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1699 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1700 '', # 10 | Ancillary Billing Information CHAR 30
1701 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1702 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1705 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1708 $duedate, # 14 | Bill Due Date CHAR 10
1710 $previous_balance, # 15 | Previous Balance NUM* 9
1711 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1712 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1713 $totaldue, # 18 | Total Amt Due NUM* 9
1714 $totaldue, # 19 | Total Amt Due NUM* 9
1715 '', # 20 | 30 Day Aging NUM* 9
1716 '', # 21 | 60 Day Aging NUM* 9
1717 '', # 22 | 90 Day Aging NUM* 9
1718 'N', # 23 | Y/N CHAR 1
1719 '', # 24 | Remittance automation CHAR 100
1720 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1721 $self->custnum, # 26 | Customer Reference Number CHAR 15
1722 '0', # 27 | Federal Tax*** NUM* 9
1723 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1724 '0', # 29 | Other Taxes & Fees*** NUM* 9
1733 time2str("%x", $self->_date),
1734 sprintf("%.2f", $self->charged),
1735 ( map { $cust_main->getfield($_) }
1736 qw( first last company address1 address2 city state zip country ) ),
1738 ) or die "can't create csv";
1741 my $header = $csv->string. "\n";
1744 if ( lc($opt{'format'}) eq 'billco' ) {
1747 foreach my $item ( $self->_items_pkg ) {
1750 '', # 1 | N/A-Leave Empty CHAR 2
1751 '', # 2 | N/A-Leave Empty CHAR 15
1752 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
1753 $self->invnum, # 4 | Invoice Number CHAR 15
1754 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
1755 $item->{'description'}, # 6 | Transaction Detail CHAR 100
1756 $item->{'amount'}, # 7 | Amount NUM* 9
1757 '', # 8 | Line Format Control** CHAR 2
1758 '', # 9 | Grouping Code CHAR 2
1759 '', # 10 | User Defined CHAR 15
1762 $detail .= $csv->string. "\n";
1768 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1770 my($pkg, $setup, $recur, $sdate, $edate);
1771 if ( $cust_bill_pkg->pkgnum ) {
1773 ($pkg, $setup, $recur, $sdate, $edate) = (
1774 $cust_bill_pkg->part_pkg->pkg,
1775 ( $cust_bill_pkg->setup != 0
1776 ? sprintf("%.2f", $cust_bill_pkg->setup )
1778 ( $cust_bill_pkg->recur != 0
1779 ? sprintf("%.2f", $cust_bill_pkg->recur )
1781 ( $cust_bill_pkg->sdate
1782 ? time2str("%x", $cust_bill_pkg->sdate)
1784 ($cust_bill_pkg->edate
1785 ?time2str("%x", $cust_bill_pkg->edate)
1789 } else { #pkgnum tax
1790 next unless $cust_bill_pkg->setup != 0;
1791 $pkg = $cust_bill_pkg->desc;
1792 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
1793 ( $sdate, $edate ) = ( '', '' );
1799 ( map { '' } (1..11) ),
1800 ($pkg, $setup, $recur, $sdate, $edate)
1801 ) or die "can't create csv";
1803 $detail .= $csv->string. "\n";
1809 ( $header, $detail );
1815 Pays this invoice with a compliemntary payment. If there is an error,
1816 returns the error, otherwise returns false.
1822 my $cust_pay = new FS::cust_pay ( {
1823 'invnum' => $self->invnum,
1824 'paid' => $self->owed,
1827 'payinfo' => $self->cust_main->payinfo,
1835 Attempts to pay this invoice with a credit card payment via a
1836 Business::OnlinePayment realtime gateway. See
1837 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1838 for supported processors.
1844 $self->realtime_bop( 'CC', @_ );
1849 Attempts to pay this invoice with an electronic check (ACH) payment via a
1850 Business::OnlinePayment realtime gateway. See
1851 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1852 for supported processors.
1858 $self->realtime_bop( 'ECHECK', @_ );
1863 Attempts to pay this invoice with phone bill (LEC) payment via a
1864 Business::OnlinePayment realtime gateway. See
1865 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1866 for supported processors.
1872 $self->realtime_bop( 'LEC', @_ );
1876 my( $self, $method ) = @_;
1878 my $cust_main = $self->cust_main;
1879 my $balance = $cust_main->balance;
1880 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1881 $amount = sprintf("%.2f", $amount);
1882 return "not run (balance $balance)" unless $amount > 0;
1884 my $description = 'Internet Services';
1885 if ( $conf->exists('business-onlinepayment-description') ) {
1886 my $dtempl = $conf->config('business-onlinepayment-description');
1888 my $agent_obj = $cust_main->agent
1889 or die "can't retreive agent for $cust_main (agentnum ".
1890 $cust_main->agentnum. ")";
1891 my $agent = $agent_obj->agent;
1892 my $pkgs = join(', ',
1893 map { $_->part_pkg->pkg }
1894 grep { $_->pkgnum } $self->cust_bill_pkg
1896 $description = eval qq("$dtempl");
1899 $cust_main->realtime_bop($method, $amount,
1900 'description' => $description,
1901 'invnum' => $self->invnum,
1906 =item batch_card OPTION => VALUE...
1908 Adds a payment for this invoice to the pending credit card batch (see
1909 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1910 runs the payment using a realtime gateway.
1915 my ($self, %options) = @_;
1916 my $cust_main = $self->cust_main;
1918 $options{invnum} = $self->invnum;
1920 $cust_main->batch_card(%options);
1923 sub _agent_template {
1925 $self->cust_main->agent_template;
1928 sub _agent_invoice_from {
1930 $self->cust_main->agent_invoice_from;
1933 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
1935 Returns an text invoice, as a list of lines.
1937 Options can be passed as a hashref (recommended) or as a list of time, template
1938 and then any key/value pairs for any other options.
1940 I<time>, if specified, is used to control the printing of overdue messages. The
1941 default is now. It isn't the date of the invoice; that's the `_date' field.
1942 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1943 L<Time::Local> and L<Date::Parse> for conversion functions.
1945 I<template>, if specified, is the name of a suffix for alternate invoices.
1947 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1953 my( $today, $template, %opt );
1955 %opt = %{ shift() };
1956 $today = delete($opt{'time'}) || '';
1957 $template = delete($opt{template}) || '';
1959 ( $today, $template, %opt ) = @_;
1962 my %params = ( 'format' => 'template' );
1963 $params{'time'} = $today if $today;
1964 $params{'template'} = $template if $template;
1965 $params{$_} = $opt{$_}
1966 foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
1968 $self->print_generic( %params );
1971 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
1973 Internal method - returns a filename of a filled-in LaTeX template for this
1974 invoice (Note: add ".tex" to get the actual filename), and a filename of
1975 an associated logo (with the .eps extension included).
1977 See print_ps and print_pdf for methods that return PostScript and PDF output.
1979 Options can be passed as a hashref (recommended) or as a list of time, template
1980 and then any key/value pairs for any other options.
1982 I<time>, if specified, is used to control the printing of overdue messages. The
1983 default is now. It isn't the date of the invoice; that's the `_date' field.
1984 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1985 L<Time::Local> and L<Date::Parse> for conversion functions.
1987 I<template>, if specified, is the name of a suffix for alternate invoices.
1989 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1995 my( $today, $template, %opt );
1997 %opt = %{ shift() };
1998 $today = delete($opt{'time'}) || '';
1999 $template = delete($opt{template}) || '';
2001 ( $today, $template, %opt ) = @_;
2004 my %params = ( 'format' => 'latex' );
2005 $params{'time'} = $today if $today;
2006 $params{'template'} = $template if $template;
2007 $params{$_} = $opt{$_}
2008 foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
2010 $template ||= $self->_agent_template;
2012 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2013 my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2017 ) or die "can't open temp file: $!\n";
2019 my $agentnum = $self->cust_main->agentnum;
2021 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2022 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2023 or die "can't write temp file: $!\n";
2025 print $lh $conf->config_binary('logo.eps', $agentnum)
2026 or die "can't write temp file: $!\n";
2029 $params{'logo_file'} = $lh->filename;
2031 my @filled_in = $self->print_generic( %params );
2033 my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2037 ) or die "can't open temp file: $!\n";
2038 print $fh join('', @filled_in );
2041 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2042 return ($1, $params{'logo_file'});
2046 =item print_generic OPTION => VALUE ...
2048 Internal method - returns a filled-in template for this invoice as a scalar.
2050 See print_ps and print_pdf for methods that return PostScript and PDF output.
2052 Non optional options include
2053 format - latex, html, template
2055 Optional options include
2057 template - a value used as a suffix for a configuration template
2059 time - a value used to control the printing of overdue messages. The
2060 default is now. It isn't the date of the invoice; that's the `_date' field.
2061 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2062 L<Time::Local> and L<Date::Parse> for conversion functions.
2066 unsquelch_cdr - overrides any per customer cdr squelching when true
2068 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2072 #what's with all the sprintf('%10.2f')'s in here? will it cause any
2073 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2074 # yes: fixed width (dot matrix) text printing will be borked
2077 my( $self, %params ) = @_;
2078 my $today = $params{today} ? $params{today} : time;
2079 warn "$me print_generic called on $self with suffix $params{template}\n"
2082 my $format = $params{format};
2083 die "Unknown format: $format"
2084 unless $format =~ /^(latex|html|template)$/;
2086 my $cust_main = $self->cust_main;
2087 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2088 unless $cust_main->payname
2089 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2091 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
2092 'html' => [ '<%=', '%>' ],
2093 'template' => [ '{', '}' ],
2096 #create the template
2097 my $template = $params{template} ? $params{template} : $self->_agent_template;
2098 my $templatefile = "invoice_$format";
2099 $templatefile .= "_$template"
2100 if length($template);
2101 my @invoice_template = map "$_\n", $conf->config($templatefile)
2102 or die "cannot load config data $templatefile";
2105 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2106 #change this to a die when the old code is removed
2107 warn "old-style invoice template $templatefile; ".
2108 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2109 $old_latex = 'true';
2110 @invoice_template = _translate_old_latex_format(@invoice_template);
2113 my $text_template = new Text::Template(
2115 SOURCE => \@invoice_template,
2116 DELIMITERS => $delimiters{$format},
2119 $text_template->compile()
2120 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2123 # additional substitution could possibly cause breakage in existing templates
2124 my %convert_maps = (
2126 'notes' => sub { map "$_", @_ },
2127 'footer' => sub { map "$_", @_ },
2128 'smallfooter' => sub { map "$_", @_ },
2129 'returnaddress' => sub { map "$_", @_ },
2130 'coupon' => sub { map "$_", @_ },
2131 'summary' => sub { map "$_", @_ },
2137 s/%%(.*)$/<!-- $1 -->/g;
2138 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2139 s/\\begin\{enumerate\}/<ol>/g;
2141 s/\\end\{enumerate\}/<\/ol>/g;
2142 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2151 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2153 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2158 s/\\\\\*?\s*$/<BR>/;
2159 s/\\hyphenation\{[\w\s\-]+}//;
2164 'coupon' => sub { "" },
2165 'summary' => sub { "" },
2172 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2173 s/\\begin\{enumerate\}//g;
2175 s/\\end\{enumerate\}//g;
2176 s/\\textbf\{(.*)\}/$1/g;
2183 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2185 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2190 s/\\\\\*?\s*$/\n/; # dubious
2191 s/\\hyphenation\{[\w\s\-]+}//;
2195 'coupon' => sub { "" },
2196 'summary' => sub { "" },
2201 # hashes for differing output formats
2202 my %nbsps = ( 'latex' => '~',
2203 'html' => '', # '&nbps;' would be nice
2204 'template' => '', # not used
2206 my $nbsp = $nbsps{$format};
2208 my %escape_functions = ( 'latex' => \&_latex_escape,
2209 'html' => \&encode_entities,
2210 'template' => sub { shift },
2212 my $escape_function = $escape_functions{$format};
2214 my %date_formats = ( 'latex' => '%b %o, %Y',
2215 'html' => '%b %o, %Y',
2218 my $date_format = $date_formats{$format};
2220 my %embolden_functions = ( 'latex' => sub { return '\textbf{'. shift(). '}'
2222 'html' => sub { return '<b>'. shift(). '</b>'
2224 'template' => sub { shift },
2226 my $embolden_function = $embolden_functions{$format};
2229 # generate template variables
2232 defined( $conf->config_orbase( "invoice_${format}returnaddress",
2236 && length( $conf->config_orbase( "invoice_${format}returnaddress",
2242 $returnaddress = join("\n",
2243 $conf->config_orbase("invoice_${format}returnaddress", $template)
2246 } elsif ( grep /\S/,
2247 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2249 my $convert_map = $convert_maps{$format}{'returnaddress'};
2252 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2257 } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2259 my $convert_map = $convert_maps{$format}{'returnaddress'};
2260 $returnaddress = join( "\n", &$convert_map(
2261 map { s/( {2,})/'~' x length($1)/eg;
2265 ( $conf->config('company_name', $self->cust_main->agentnum),
2266 $conf->config('company_address', $self->cust_main->agentnum),
2273 my $warning = "Couldn't find a return address; ".
2274 "do you need to set the company_address configuration value?";
2276 $returnaddress = $nbsp;
2277 #$returnaddress = $warning;
2281 my %invoice_data = (
2284 'company_name' => scalar( $conf->config('company_name', $self->cust_main->agentnum) ),
2285 'company_address' => join("\n", $conf->config('company_address', $self->cust_main->agentnum) ). "\n",
2286 'returnaddress' => $returnaddress,
2287 'agent' => &$escape_function($cust_main->agent->agent),
2290 'invnum' => $self->invnum,
2291 'date' => time2str($date_format, $self->_date),
2292 'today' => time2str('%b %o, %Y', $today),
2293 'terms' => $self->terms,
2294 'template' => $template, #params{'template'},
2295 'notice_name' => ($params{'notice_name'} || 'Invoice'),#escape_function?
2296 'current_charges' => sprintf("%.2f", $self->charged),
2297 'duedate' => $self->due_date2str($rdate_format), #date_format?
2300 'custnum' => $cust_main->display_custnum,
2301 'agent_custid' => &$escape_function($cust_main->agent_custid),
2302 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2303 payname company address1 address2 city state zip fax
2307 'ship_enable' => $conf->exists('invoice-ship_address'),
2308 'unitprices' => $conf->exists('invoice-unitprice'),
2309 'smallernotes' => $conf->exists('invoice-smallernotes'),
2310 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
2312 # better hang on to conf_dir for a while (for old templates)
2313 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2315 #these are only used when doing paged plaintext
2321 $invoice_data{finance_section} = '';
2322 if ( $conf->config('finance_pkgclass') ) {
2324 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2325 $invoice_data{finance_section} = $pkg_class->categoryname;
2327 $invoice_data{finance_amount} = '0.00';
2329 my $countrydefault = $conf->config('countrydefault') || 'US';
2330 my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
2331 foreach ( qw( contact company address1 address2 city state zip country fax) ){
2332 my $method = $prefix.$_;
2333 $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2335 $invoice_data{'ship_country'} = ''
2336 if ( $invoice_data{'ship_country'} eq $countrydefault );
2338 $invoice_data{'cid'} = $params{'cid'}
2341 if ( $cust_main->country eq $countrydefault ) {
2342 $invoice_data{'country'} = '';
2344 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2348 $invoice_data{'address'} = \@address;
2350 $cust_main->payname.
2351 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2352 ? " (P.O. #". $cust_main->payinfo. ")"
2356 push @address, $cust_main->company
2357 if $cust_main->company;
2358 push @address, $cust_main->address1;
2359 push @address, $cust_main->address2
2360 if $cust_main->address2;
2362 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
2363 push @address, $invoice_data{'country'}
2364 if $invoice_data{'country'};
2366 while (scalar(@address) < 5);
2368 $invoice_data{'logo_file'} = $params{'logo_file'}
2369 if $params{'logo_file'};
2371 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2372 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2373 #my $balance_due = $self->owed + $pr_total - $cr_total;
2374 my $balance_due = $self->owed + $pr_total;
2375 $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2376 $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2377 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2378 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2380 my $agentnum = $self->cust_main->agentnum;
2382 my $summarypage = '';
2383 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2386 $invoice_data{'summarypage'} = $summarypage;
2388 #do variable substitution in notes, footer, smallfooter
2389 foreach my $include (qw( notes footer smallfooter coupon )) {
2391 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2394 if ( $conf->exists($inc_file, $agentnum)
2395 && length( $conf->config($inc_file, $agentnum) ) ) {
2397 @inc_src = $conf->config($inc_file, $agentnum);
2401 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2403 my $convert_map = $convert_maps{$format}{$include};
2405 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2406 s/--\@\]/$delimiters{$format}[1]/g;
2409 &$convert_map( $conf->config($inc_file, $agentnum) );
2413 my $inc_tt = new Text::Template (
2415 SOURCE => [ map "$_\n", @inc_src ],
2416 DELIMITERS => $delimiters{$format},
2417 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2419 unless ( $inc_tt->compile() ) {
2420 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2421 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2425 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2427 $invoice_data{$include} =~ s/\n+$//
2428 if ($format eq 'latex');
2431 $invoice_data{'po_line'} =
2432 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2433 ? &$escape_function("Purchase Order #". $cust_main->payinfo)
2436 my %money_chars = ( 'latex' => '',
2437 'html' => $conf->config('money_char') || '$',
2440 my $money_char = $money_chars{$format};
2442 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
2443 'html' => $conf->config('money_char') || '$',
2446 my $other_money_char = $other_money_chars{$format};
2447 $invoice_data{'dollar'} = $other_money_char;
2449 my @detail_items = ();
2450 my @total_items = ();
2454 $invoice_data{'detail_items'} = \@detail_items;
2455 $invoice_data{'total_items'} = \@total_items;
2456 $invoice_data{'buf'} = \@buf;
2457 $invoice_data{'sections'} = \@sections;
2459 my $previous_section = { 'description' => 'Previous Charges',
2460 'subtotal' => $other_money_char.
2461 sprintf('%.2f', $pr_total),
2462 'summarized' => $summarypage ? 'Y' : '',
2464 $previous_section->{posttotal} = '0 / 30 / 60/ 90 days overdue '.
2465 join(' / ', map { $cust_main->balance_date_range(@$_) }
2466 $self->_prior_month30s
2468 if $conf->exists('invoice_include_aging');
2471 my $tax_section = { 'description' => 'Taxes, Surcharges, and Fees',
2472 'subtotal' => $taxtotal, # adjusted below
2473 'summarized' => $summarypage ? 'Y' : '',
2475 my $tax_weight = _pkg_category($tax_section->{description})
2476 ? _pkg_category($tax_section->{description})->weight
2478 $tax_section->{'summarized'} = $summarypage && !$tax_weight ? 'Y' : '';
2479 $tax_section->{'sort_weight'} = $tax_weight;
2482 my $adjusttotal = 0;
2483 my $adjust_section = { 'description' => 'Credits, Payments, and Adjustments',
2484 'subtotal' => 0, # adjusted below
2485 'summarized' => $summarypage ? 'Y' : '',
2487 my $adjust_weight = _pkg_category($adjust_section->{description})
2488 ? _pkg_category($adjust_section->{description})->weight
2490 $adjust_section->{'summarized'} = $summarypage && !$adjust_weight ? 'Y' : '';
2491 $adjust_section->{'sort_weight'} = $adjust_weight;
2493 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2494 my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2495 my $late_sections = [];
2496 my $extra_sections = [];
2497 my $extra_lines = ();
2498 if ( $multisection ) {
2499 ($extra_sections, $extra_lines) =
2500 $self->_items_extra_usage_sections($escape_function, $format)
2501 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
2503 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
2505 push @detail_items, @$extra_lines if $extra_lines;
2507 $self->_items_sections( $late_sections, # this could stand a refactor
2513 if ($conf->exists('svc_phone_sections')) {
2514 my ($phone_sections, $phone_lines) =
2515 $self->_items_svc_phone_sections($escape_function, $format);
2516 push @{$late_sections}, @$phone_sections;
2517 push @detail_items, @$phone_lines;
2520 push @sections, { 'description' => '', 'subtotal' => '' };
2523 unless ( $conf->exists('disable_previous_balance')
2524 || $conf->exists('previous_balance-summary_only')
2528 foreach my $line_item ( $self->_items_previous ) {
2531 ext_description => [],
2533 $detail->{'ref'} = $line_item->{'pkgnum'};
2534 $detail->{'quantity'} = 1;
2535 $detail->{'section'} = $previous_section;
2536 $detail->{'description'} = &$escape_function($line_item->{'description'});
2537 if ( exists $line_item->{'ext_description'} ) {
2538 @{$detail->{'ext_description'}} = map {
2539 &$escape_function($_);
2540 } @{$line_item->{'ext_description'}};
2542 $detail->{'amount'} = ( $old_latex ? '' : $money_char).
2543 $line_item->{'amount'};
2544 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2546 push @detail_items, $detail;
2547 push @buf, [ $detail->{'description'},
2548 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2554 if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
2555 push @buf, ['','-----------'];
2556 push @buf, [ 'Total Previous Balance',
2557 $money_char. sprintf("%10.2f", $pr_total) ];
2561 foreach my $section (@sections, @$late_sections) {
2563 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
2564 if ( $invoice_data{finance_section} &&
2565 $section->{'description'} eq $invoice_data{finance_section} );
2567 $section->{'subtotal'} = $other_money_char.
2568 sprintf('%.2f', $section->{'subtotal'})
2571 # begin some normalization
2572 $section->{'amount'} = $section->{'subtotal'}
2576 if ( $section->{'description'} ) {
2577 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2582 my $multilocation = scalar($cust_main->cust_location); #too expensive?
2584 $options{'section'} = $section if $multisection;
2585 $options{'format'} = $format;
2586 $options{'escape_function'} = $escape_function;
2587 $options{'format_function'} = sub { () } unless $unsquelched;
2588 $options{'unsquelched'} = $unsquelched;
2589 $options{'summary_page'} = $summarypage;
2590 $options{'skip_usage'} =
2591 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
2592 $options{'multilocation'} = $multilocation;
2594 foreach my $line_item ( $self->_items_pkg(%options) ) {
2596 ext_description => [],
2598 $detail->{'ref'} = $line_item->{'pkgnum'};
2599 $detail->{'quantity'} = $line_item->{'quantity'};
2600 $detail->{'section'} = $section;
2601 $detail->{'description'} = &$escape_function($line_item->{'description'});
2602 if ( exists $line_item->{'ext_description'} ) {
2603 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2605 $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
2606 $line_item->{'amount'};
2607 $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
2608 $line_item->{'unit_amount'};
2609 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2611 push @detail_items, $detail;
2612 push @buf, ( [ $detail->{'description'},
2613 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2615 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2619 if ( $section->{'description'} ) {
2620 push @buf, ( ['','-----------'],
2621 [ $section->{'description'}. ' sub-total',
2622 $money_char. sprintf("%10.2f", $section->{'subtotal'})
2631 $invoice_data{current_less_finance} =
2632 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
2634 if ( $multisection && !$conf->exists('disable_previous_balance')
2635 || $conf->exists('previous_balance-summary_only') )
2637 unshift @sections, $previous_section if $pr_total;
2640 foreach my $tax ( $self->_items_tax ) {
2642 $taxtotal += $tax->{'amount'};
2644 my $description = &$escape_function( $tax->{'description'} );
2645 my $amount = sprintf( '%.2f', $tax->{'amount'} );
2647 if ( $multisection ) {
2649 my $money = $old_latex ? '' : $money_char;
2650 push @detail_items, {
2651 ext_description => [],
2654 description => $description,
2655 amount => $money. $amount,
2657 section => $tax_section,
2662 push @total_items, {
2663 'total_item' => $description,
2664 'total_amount' => $other_money_char. $amount,
2669 push @buf,[ $description,
2670 $money_char. $amount,
2677 $total->{'total_item'} = 'Sub-total';
2678 $total->{'total_amount'} =
2679 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2681 if ( $multisection ) {
2682 $tax_section->{'subtotal'} = $other_money_char.
2683 sprintf('%.2f', $taxtotal);
2684 $tax_section->{'pretotal'} = 'New charges sub-total '.
2685 $total->{'total_amount'};
2686 push @sections, $tax_section if $taxtotal;
2688 unshift @total_items, $total;
2691 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
2693 push @buf,['','-----------'];
2694 push @buf,[( $conf->exists('disable_previous_balance')
2696 : 'Total New Charges'
2698 $money_char. sprintf("%10.2f",$self->charged) ];
2703 $total->{'total_item'} = &$embolden_function('Total');
2704 $total->{'total_amount'} =
2705 &$embolden_function(
2708 $self->charged + ( $conf->exists('disable_previous_balance')
2714 if ( $multisection ) {
2715 if ( $adjust_section->{'sort_weight'} ) {
2716 $adjust_section->{'posttotal'} = 'Balance Forward '. $other_money_char.
2717 sprintf("%.2f", ($self->billing_balance || 0) );
2719 $adjust_section->{'pretotal'} = 'New charges total '. $other_money_char.
2720 sprintf('%.2f', $self->charged );
2723 push @total_items, $total;
2725 push @buf,['','-----------'];
2726 push @buf,['Total Charges',
2728 sprintf( '%10.2f', $self->charged +
2729 ( $conf->exists('disable_previous_balance')
2738 unless ( $conf->exists('disable_previous_balance') ) {
2739 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2742 my $credittotal = 0;
2743 foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
2746 $total->{'total_item'} = &$escape_function($credit->{'description'});
2747 $credittotal += $credit->{'amount'};
2748 $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2749 $adjusttotal += $credit->{'amount'};
2750 if ( $multisection ) {
2751 my $money = $old_latex ? '' : $money_char;
2752 push @detail_items, {
2753 ext_description => [],
2756 description => &$escape_function($credit->{'description'}),
2757 amount => $money. $credit->{'amount'},
2759 section => $adjust_section,
2762 push @total_items, $total;
2766 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
2769 foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
2770 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
2774 my $paymenttotal = 0;
2775 foreach my $payment ( $self->_items_payments ) {
2777 $total->{'total_item'} = &$escape_function($payment->{'description'});
2778 $paymenttotal += $payment->{'amount'};
2779 $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2780 $adjusttotal += $payment->{'amount'};
2781 if ( $multisection ) {
2782 my $money = $old_latex ? '' : $money_char;
2783 push @detail_items, {
2784 ext_description => [],
2787 description => &$escape_function($payment->{'description'}),
2788 amount => $money. $payment->{'amount'},
2790 section => $adjust_section,
2793 push @total_items, $total;
2795 push @buf, [ $payment->{'description'},
2796 $money_char. sprintf("%10.2f", $payment->{'amount'}),
2799 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
2801 if ( $multisection ) {
2802 $adjust_section->{'subtotal'} = $other_money_char.
2803 sprintf('%.2f', $adjusttotal);
2804 push @sections, $adjust_section
2805 unless $adjust_section->{sort_weight};
2810 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2811 $total->{'total_amount'} =
2812 &$embolden_function(
2813 $other_money_char. sprintf('%.2f', $summarypage
2815 $self->billing_balance
2816 : $self->owed + $pr_total
2819 if ( $multisection && !$adjust_section->{sort_weight} ) {
2820 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
2821 $total->{'total_amount'};
2823 push @total_items, $total;
2825 push @buf,['','-----------'];
2826 push @buf,[$self->balance_due_msg, $money_char.
2827 sprintf("%10.2f", $balance_due ) ];
2831 if ( $multisection ) {
2832 if ($conf->exists('svc_phone_sections')) {
2834 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2835 $total->{'total_amount'} =
2836 &$embolden_function(
2837 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
2839 my $last_section = pop @sections;
2840 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
2841 $total->{'total_amount'};
2842 push @sections, $last_section;
2844 push @sections, @$late_sections
2848 my @includelist = ();
2849 push @includelist, 'summary' if $summarypage;
2850 foreach my $include ( @includelist ) {
2852 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2855 if ( length( $conf->config($inc_file, $agentnum) ) ) {
2857 @inc_src = $conf->config($inc_file, $agentnum);
2861 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2863 my $convert_map = $convert_maps{$format}{$include};
2865 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2866 s/--\@\]/$delimiters{$format}[1]/g;
2869 &$convert_map( $conf->config($inc_file, $agentnum) );
2873 my $inc_tt = new Text::Template (
2875 SOURCE => [ map "$_\n", @inc_src ],
2876 DELIMITERS => $delimiters{$format},
2877 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2879 unless ( $inc_tt->compile() ) {
2880 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2881 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2885 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2887 $invoice_data{$include} =~ s/\n+$//
2888 if ($format eq 'latex');
2893 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2894 /invoice_lines\((\d*)\)/;
2895 $invoice_lines += $1 || scalar(@buf);
2898 die "no invoice_lines() functions in template?"
2899 if ( $format eq 'template' && !$wasfunc );
2901 if ($format eq 'template') {
2903 if ( $invoice_lines ) {
2904 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
2905 $invoice_data{'total_pages'}++
2906 if scalar(@buf) % $invoice_lines;
2909 #setup subroutine for the template
2910 sub FS::cust_bill::_template::invoice_lines {
2911 my $lines = shift || scalar(@FS::cust_bill::_template::buf);
2913 scalar(@FS::cust_bill::_template::buf)
2914 ? shift @FS::cust_bill::_template::buf
2923 push @collect, split("\n",
2924 $text_template->fill_in( HASH => \%invoice_data,
2925 PACKAGE => 'FS::cust_bill::_template'
2928 $FS::cust_bill::_template::page++;
2930 map "$_\n", @collect;
2932 warn "filling in template for invoice ". $self->invnum. "\n"
2934 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
2937 $text_template->fill_in(HASH => \%invoice_data);
2941 # helper routine for generating date ranges
2942 sub _prior_month30s {
2945 [ 1, 2592000 ], # 0-30 days ago
2946 [ 2592000, 5184000 ], # 30-60 days ago
2947 [ 5184000, 7776000 ], # 60-90 days ago
2948 [ 7776000, 0 ], # 90+ days ago
2951 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
2952 $_->[1] ? $self->_date - $_->[1] - 1 : '',
2957 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
2959 Returns an postscript invoice, as a scalar.
2961 Options can be passed as a hashref (recommended) or as a list of time, template
2962 and then any key/value pairs for any other options.
2964 I<time> an optional value used to control the printing of overdue messages. The
2965 default is now. It isn't the date of the invoice; that's the `_date' field.
2966 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2967 L<Time::Local> and L<Date::Parse> for conversion functions.
2969 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2976 my ($file, $lfile) = $self->print_latex(@_);
2977 my $ps = generate_ps($file);
2983 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
2985 Returns an PDF invoice, as a scalar.
2987 Options can be passed as a hashref (recommended) or as a list of time, template
2988 and then any key/value pairs for any other options.
2990 I<time> an optional value used to control the printing of overdue messages. The
2991 default is now. It isn't the date of the invoice; that's the `_date' field.
2992 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2993 L<Time::Local> and L<Date::Parse> for conversion functions.
2995 I<template>, if specified, is the name of a suffix for alternate invoices.
2997 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3004 my ($file, $lfile) = $self->print_latex(@_);
3005 my $pdf = generate_pdf($file);
3011 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3013 Returns an HTML invoice, as a scalar.
3015 I<time> an optional value used to control the printing of overdue messages. The
3016 default is now. It isn't the date of the invoice; that's the `_date' field.
3017 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3018 L<Time::Local> and L<Date::Parse> for conversion functions.
3020 I<template>, if specified, is the name of a suffix for alternate invoices.
3022 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3024 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3025 when emailing the invoice as part of a multipart/related MIME email.
3033 %params = %{ shift() };
3035 $params{'time'} = shift;
3036 $params{'template'} = shift;
3037 $params{'cid'} = shift;
3040 $params{'format'} = 'html';
3042 $self->print_generic( %params );
3045 # quick subroutine for print_latex
3047 # There are ten characters that LaTeX treats as special characters, which
3048 # means that they do not simply typeset themselves:
3049 # # $ % & ~ _ ^ \ { }
3051 # TeX ignores blanks following an escaped character; if you want a blank (as
3052 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
3056 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3057 $value =~ s/([<>])/\$$1\$/g;
3061 #utility methods for print_*
3063 sub _translate_old_latex_format {
3064 warn "_translate_old_latex_format called\n"
3071 if ( $line =~ /^%%Detail\s*$/ ) {
3073 push @template, q![@--!,
3074 q! foreach my $_tr_line (@detail_items) {!,
3075 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3076 q! $_tr_line->{'description'} .= !,
3077 q! "\\tabularnewline\n~~".!,
3078 q! join( "\\tabularnewline\n~~",!,
3079 q! @{$_tr_line->{'ext_description'}}!,
3083 while ( ( my $line_item_line = shift )
3084 !~ /^%%EndDetail\s*$/ ) {
3085 $line_item_line =~ s/'/\\'/g; # nice LTS
3086 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3087 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3088 push @template, " \$OUT .= '$line_item_line';";
3091 push @template, '}',
3094 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3096 push @template, '[@--',
3097 ' foreach my $_tr_line (@total_items) {';
3099 while ( ( my $total_item_line = shift )
3100 !~ /^%%EndTotalDetails\s*$/ ) {
3101 $total_item_line =~ s/'/\\'/g; # nice LTS
3102 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
3103 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3104 push @template, " \$OUT .= '$total_item_line';";
3107 push @template, '}',
3111 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3112 push @template, $line;
3118 warn "$_\n" foreach @template;
3127 #check for an invoice-specific override
3128 return $self->invoice_terms if $self->invoice_terms;
3130 #check for a customer- specific override
3131 my $cust_main = $self->cust_main;
3132 return $cust_main->invoice_terms if $cust_main->invoice_terms;
3134 #use configured default
3135 $conf->config('invoice_default_terms') || '';
3141 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3142 $duedate = $self->_date() + ( $1 * 86400 );
3149 $self->due_date ? time2str(shift, $self->due_date) : '';
3152 sub balance_due_msg {
3154 my $msg = 'Balance Due';
3155 return $msg unless $self->terms;
3156 if ( $self->due_date ) {
3157 $msg .= ' - Please pay by '. $self->due_date2str($date_format);
3158 } elsif ( $self->terms ) {
3159 $msg .= ' - '. $self->terms;
3164 sub balance_due_date {
3167 if ( $conf->exists('invoice_default_terms')
3168 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3169 $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3174 =item invnum_date_pretty
3176 Returns a string with the invoice number and date, for example:
3177 "Invoice #54 (3/20/2008)"
3181 sub invnum_date_pretty {
3183 'Invoice #'. $self->invnum. ' ('. $self->_date_pretty. ')';
3188 Returns a string with the date, for example: "3/20/2008"
3194 time2str($date_format, $self->_date);
3197 use vars qw(%pkg_category_cache);
3198 sub _items_sections {
3201 my $summarypage = shift;
3203 my $extra_sections = shift;
3207 my %late_subtotal = ();
3210 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3213 my $usage = $cust_bill_pkg->usage;
3215 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3216 next if ( $display->summary && $summarypage );
3218 my $section = $display->section;
3219 my $type = $display->type;
3221 $not_tax{$section} = 1
3222 unless $cust_bill_pkg->pkgnum == 0;
3224 if ( $display->post_total && !$summarypage ) {
3225 if (! $type || $type eq 'S') {
3226 $late_subtotal{$section} += $cust_bill_pkg->setup
3227 if $cust_bill_pkg->setup != 0;
3231 $late_subtotal{$section} += $cust_bill_pkg->recur
3232 if $cust_bill_pkg->recur != 0;
3235 if ($type && $type eq 'R') {
3236 $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3237 if $cust_bill_pkg->recur != 0;
3240 if ($type && $type eq 'U') {
3241 $late_subtotal{$section} += $usage
3242 unless scalar(@$extra_sections);
3247 next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3249 if (! $type || $type eq 'S') {
3250 $subtotal{$section} += $cust_bill_pkg->setup
3251 if $cust_bill_pkg->setup != 0;
3255 $subtotal{$section} += $cust_bill_pkg->recur
3256 if $cust_bill_pkg->recur != 0;
3259 if ($type && $type eq 'R') {
3260 $subtotal{$section} += $cust_bill_pkg->recur - $usage
3261 if $cust_bill_pkg->recur != 0;
3264 if ($type && $type eq 'U') {
3265 $subtotal{$section} += $usage
3266 unless scalar(@$extra_sections);
3275 %pkg_category_cache = ();
3277 push @$late, map { { 'description' => &{$escape}($_),
3278 'subtotal' => $late_subtotal{$_},
3280 'sort_weight' => ( _pkg_category($_)
3281 ? _pkg_category($_)->weight
3284 ((_pkg_category($_) && _pkg_category($_)->condense)
3285 ? $self->_condense_section($format)
3289 sort _sectionsort keys %late_subtotal;
3292 if ( $summarypage ) {
3293 @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3294 map { $_->categoryname } qsearch('pkg_category', {});
3296 @sections = keys %subtotal;
3299 my @early = map { { 'description' => &{$escape}($_),
3300 'subtotal' => $subtotal{$_},
3301 'summarized' => $not_tax{$_} ? '' : 'Y',
3302 'tax_section' => $not_tax{$_} ? '' : 'Y',
3303 'sort_weight' => ( _pkg_category($_)
3304 ? _pkg_category($_)->weight
3307 ((_pkg_category($_) && _pkg_category($_)->condense)
3308 ? $self->_condense_section($format)
3313 push @early, @$extra_sections if $extra_sections;
3315 sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
3319 #helper subs for above
3322 _pkg_category($a)->weight <=> _pkg_category($b)->weight;
3326 my $categoryname = shift;
3327 $pkg_category_cache{$categoryname} ||=
3328 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
3331 my %condensed_format = (
3332 'label' => [ qw( Description Qty Amount ) ],
3334 sub { shift->{description} },
3335 sub { shift->{quantity} },
3336 sub { shift->{amount} },
3338 'align' => [ qw( l r r ) ],
3339 'span' => [ qw( 5 1 1 ) ], # unitprices?
3340 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
3343 sub _condense_section {
3344 my ( $self, $format ) = ( shift, shift );
3346 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
3347 qw( description_generator
3350 total_line_generator
3355 sub _condensed_generator_defaults {
3356 my ( $self, $format ) = ( shift, shift );
3357 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
3366 sub _condensed_header_generator {
3367 my ( $self, $format ) = ( shift, shift );
3369 my ( $f, $prefix, $suffix, $separator, $column ) =
3370 _condensed_generator_defaults($format);
3372 if ($format eq 'latex') {
3373 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
3374 $suffix = "\\\\\n\\hline";
3377 sub { my ($d,$a,$s,$w) = @_;
3378 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3380 } elsif ( $format eq 'html' ) {
3381 $prefix = '<th></th>';
3385 sub { my ($d,$a,$s,$w) = @_;
3386 return qq!<th align="$html_align{$a}">$d</th>!;
3394 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3396 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
3399 $prefix. join($separator, @result). $suffix;
3404 sub _condensed_description_generator {
3405 my ( $self, $format ) = ( shift, shift );
3407 my ( $f, $prefix, $suffix, $separator, $column ) =
3408 _condensed_generator_defaults($format);
3410 if ($format eq 'latex') {
3411 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
3413 $separator = " & \n";
3415 sub { my ($d,$a,$s,$w) = @_;
3416 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3418 }elsif ( $format eq 'html' ) {
3419 $prefix = '"><td align="center"></td>';
3423 sub { my ($d,$a,$s,$w) = @_;
3424 return qq!<td align="$html_align{$a}">$d</td>!;
3432 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3433 push @result, &{$column}( &{$f->{fields}->[$i]}(@args),
3434 map { $f->{$_}->[$i] } qw(align span width)
3438 $prefix. join( $separator, @result ). $suffix;
3443 sub _condensed_total_generator {
3444 my ( $self, $format ) = ( shift, shift );
3446 my ( $f, $prefix, $suffix, $separator, $column ) =
3447 _condensed_generator_defaults($format);
3450 if ($format eq 'latex') {
3453 $separator = " & \n";
3455 sub { my ($d,$a,$s,$w) = @_;
3456 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3458 }elsif ( $format eq 'html' ) {
3462 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3464 sub { my ($d,$a,$s,$w) = @_;
3465 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3474 # my $r = &{$f->{fields}->[$i]}(@args);
3475 # $r .= ' Total' unless $i;
3477 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3479 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
3480 map { $f->{$_}->[$i] } qw(align span width)
3484 $prefix. join( $separator, @result ). $suffix;
3489 =item total_line_generator FORMAT
3491 Returns a coderef used for generation of invoice total line items for this
3492 usage_class. FORMAT is either html or latex
3496 # should not be used: will have issues with hash element names (description vs
3497 # total_item and amount vs total_amount -- another array of functions?
3499 sub _condensed_total_line_generator {
3500 my ( $self, $format ) = ( shift, shift );
3502 my ( $f, $prefix, $suffix, $separator, $column ) =
3503 _condensed_generator_defaults($format);
3506 if ($format eq 'latex') {
3509 $separator = " & \n";
3511 sub { my ($d,$a,$s,$w) = @_;
3512 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3514 }elsif ( $format eq 'html' ) {
3518 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3520 sub { my ($d,$a,$s,$w) = @_;
3521 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3530 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
3532 &{$column}( &{$f->{fields}->[$i]}(@args),
3533 map { $f->{$_}->[$i] } qw(align span width)
3537 $prefix. join( $separator, @result ). $suffix;
3542 #sub _items_extra_usage_sections {
3544 # my $escape = shift;
3546 # my %sections = ();
3548 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
3549 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3551 # next unless $cust_bill_pkg->pkgnum > 0;
3553 # foreach my $section ( keys %usage_class ) {
3555 # my $usage = $cust_bill_pkg->usage($section);
3557 # next unless $usage && $usage > 0;
3559 # $sections{$section} ||= 0;
3560 # $sections{$section} += $usage;
3566 # map { { 'description' => &{$escape}($_),
3567 # 'subtotal' => $sections{$_},
3568 # 'summarized' => '',
3569 # 'tax_section' => '',
3572 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
3576 sub _items_extra_usage_sections {
3585 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3586 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3587 next unless $cust_bill_pkg->pkgnum > 0;
3589 foreach my $classnum ( keys %usage_class ) {
3590 my $section = $usage_class{$classnum}->classname;
3591 $classnums{$section} = $classnum;
3593 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
3594 my $amount = $detail->amount;
3595 next unless $amount && $amount > 0;
3597 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
3598 $sections{$section}{amount} += $amount; #subtotal
3599 $sections{$section}{calls}++;
3600 $sections{$section}{duration} += $detail->duration;
3602 my $desc = $detail->regionname;
3603 my $description = $desc;
3604 $description = substr($desc, 0, 50). '...'
3605 if $format eq 'latex' && length($desc) > 50;
3607 $lines{$section}{$desc} ||= {
3608 description => &{$escape}($description),
3609 #pkgpart => $part_pkg->pkgpart,
3610 pkgnum => $cust_bill_pkg->pkgnum,
3615 #unit_amount => $cust_bill_pkg->unitrecur,
3616 quantity => $cust_bill_pkg->quantity,
3617 product_code => 'N/A',
3618 ext_description => [],
3621 $lines{$section}{$desc}{amount} += $amount;
3622 $lines{$section}{$desc}{calls}++;
3623 $lines{$section}{$desc}{duration} += $detail->duration;
3629 my %sectionmap = ();
3630 foreach (keys %sections) {
3631 my $usage_class = $usage_class{$classnums{$_}};
3632 $sectionmap{$_} = { 'description' => &{$escape}($_),
3633 'amount' => $sections{$_}{amount}, #subtotal
3634 'calls' => $sections{$_}{calls},
3635 'duration' => $sections{$_}{duration},
3637 'tax_section' => '',
3638 'sort_weight' => $usage_class->weight,
3639 ( $usage_class->format
3640 ? ( map { $_ => $usage_class->$_($format) }
3641 qw( description_generator header_generator total_generator total_line_generator )
3648 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
3652 foreach my $section ( keys %lines ) {
3653 foreach my $line ( keys %{$lines{$section}} ) {
3654 my $l = $lines{$section}{$line};
3655 $l->{section} = $sectionmap{$section};
3656 $l->{amount} = sprintf( "%.2f", $l->{amount} );
3657 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3662 return(\@sections, \@lines);
3666 sub _items_svc_phone_sections {
3675 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3677 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3678 next unless $cust_bill_pkg->pkgnum > 0;
3680 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
3682 my $phonenum = $detail->phonenum;
3683 next unless $phonenum;
3685 my $amount = $detail->amount;
3686 next unless $amount && $amount > 0;
3688 $sections{$phonenum} ||= { 'amount' => 0,
3691 'sort_weight' => -1,
3692 'phonenum' => $phonenum,
3694 $sections{$phonenum}{amount} += $amount; #subtotal
3695 $sections{$phonenum}{calls}++;
3696 $sections{$phonenum}{duration} += $detail->duration;
3698 my $desc = $detail->regionname;
3699 my $description = $desc;
3700 $description = substr($desc, 0, 50). '...'
3701 if $format eq 'latex' && length($desc) > 50;
3703 $lines{$phonenum}{$desc} ||= {
3704 description => &{$escape}($description),
3705 #pkgpart => $part_pkg->pkgpart,
3713 product_code => 'N/A',
3714 ext_description => [],
3717 $lines{$phonenum}{$desc}{amount} += $amount;
3718 $lines{$phonenum}{$desc}{calls}++;
3719 $lines{$phonenum}{$desc}{duration} += $detail->duration;
3721 my $line = $usage_class{$detail->classnum}->classname;
3722 $sections{"$phonenum $line"} ||=
3726 'sort_weight' => $usage_class{$detail->classnum}->weight,
3727 'phonenum' => $phonenum,
3729 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
3730 $sections{"$phonenum $line"}{calls}++;
3731 $sections{"$phonenum $line"}{duration} += $detail->duration;
3733 $lines{"$phonenum $line"}{$desc} ||= {
3734 description => &{$escape}($description),
3735 #pkgpart => $part_pkg->pkgpart,
3743 product_code => 'N/A',
3744 ext_description => [],
3747 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
3748 $lines{"$phonenum $line"}{$desc}{calls}++;
3749 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
3750 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
3751 $detail->formatted('format' => $format);
3756 my %sectionmap = ();
3757 my $simple = new FS::usage_class { format => 'simple' }; #bleh
3758 my $usage_simple = new FS::usage_class { format => 'usage_simple' }; #bleh
3759 foreach ( keys %sections ) {
3760 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
3761 my $usage_class = $summary ? $simple : $usage_simple;
3762 my $ending = $summary ? ' usage charges' : '';
3763 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
3764 'amount' => $sections{$_}{amount}, #subtotal
3765 'calls' => $sections{$_}{calls},
3766 'duration' => $sections{$_}{duration},
3768 'tax_section' => '',
3769 'phonenum' => $sections{$_}{phonenum},
3770 'sort_weight' => $sections{$_}{sort_weight},
3771 'post_total' => $summary, #inspire pagebreak
3773 ( map { $_ => $usage_class->$_($format) }
3774 qw( description_generator
3777 total_line_generator
3784 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
3785 $a->{sort_weight} <=> $b->{sort_weight}
3790 foreach my $section ( keys %lines ) {
3791 foreach my $line ( keys %{$lines{$section}} ) {
3792 my $l = $lines{$section}{$line};
3793 $l->{section} = $sectionmap{$section};
3794 $l->{amount} = sprintf( "%.2f", $l->{amount} );
3795 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3800 return(\@sections, \@lines);
3807 #my @display = scalar(@_)
3809 # : qw( _items_previous _items_pkg );
3810 # #: qw( _items_pkg );
3811 # #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
3812 my @display = qw( _items_previous _items_pkg );
3815 foreach my $display ( @display ) {
3816 push @b, $self->$display(@_);
3821 sub _items_previous {
3823 my $cust_main = $self->cust_main;
3824 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
3826 foreach ( @pr_cust_bill ) {
3827 my $date = $conf->exists('invoice_show_prior_due_date')
3828 ? 'due '. $_->due_date2str($date_format)
3829 : time2str($date_format, $_->_date);
3831 'description' => 'Previous Balance, Invoice #'. $_->invnum. " ($date)",
3832 #'pkgpart' => 'N/A',
3834 'amount' => sprintf("%.2f", $_->owed),
3840 # 'description' => 'Previous Balance',
3841 # #'pkgpart' => 'N/A',
3842 # 'pkgnum' => 'N/A',
3843 # 'amount' => sprintf("%10.2f", $pr_total ),
3844 # 'ext_description' => [ map {
3845 # "Invoice ". $_->invnum.
3846 # " (". time2str("%x",$_->_date). ") ".
3847 # sprintf("%10.2f", $_->owed)
3848 # } @pr_cust_bill ],
3856 my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
3857 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3858 if ($options{section} && $options{section}->{condensed}) {
3860 local $Storable::canonical = 1;
3861 foreach ( @items ) {
3863 delete $item->{ref};
3864 delete $item->{ext_description};
3865 my $key = freeze($item);
3866 $itemshash{$key} ||= 0;
3867 $itemshash{$key} ++; # += $item->{quantity};
3869 @items = sort { $a->{description} cmp $b->{description} }
3870 map { my $i = thaw($_);
3871 $i->{quantity} = $itemshash{$_};
3873 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3882 return 0 unless $a cmp $b;
3883 return -1 if $b eq 'Tax';
3884 return 1 if $a eq 'Tax';
3885 return -1 if $b eq 'Other surcharges';
3886 return 1 if $a eq 'Other surcharges';
3892 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
3893 $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3896 sub _items_cust_bill_pkg {
3898 my $cust_bill_pkg = shift;
3901 my $format = $opt{format} || '';
3902 my $escape_function = $opt{escape_function} || sub { shift };
3903 my $format_function = $opt{format_function} || '';
3904 my $unsquelched = $opt{unsquelched} || '';
3905 my $section = $opt{section}->{description} if $opt{section};
3906 my $summary_page = $opt{summary_page} || '';
3907 my $multilocation = $opt{multilocation} || '';
3910 my ($s, $r, $u) = ( undef, undef, undef );
3911 foreach my $cust_bill_pkg ( @$cust_bill_pkg )
3914 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
3915 if ( $_ && !$cust_bill_pkg->hidden ) {
3916 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3917 $_->{amount} =~ s/^\-0\.00$/0.00/;
3918 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
3920 unless $_->{amount} == 0;
3925 foreach my $display ( grep { defined($section)
3926 ? $_->section eq $section
3929 grep { !$_->summary || !$summary_page }
3930 $cust_bill_pkg->cust_bill_pkg_display
3934 my $type = $display->type;
3936 my $desc = $cust_bill_pkg->desc;
3937 $desc = substr($desc, 0, 50). '...'
3938 if $format eq 'latex' && length($desc) > 50;
3940 my %details_opt = ( 'format' => $format,
3941 'escape_function' => $escape_function,
3942 'format_function' => $format_function,
3945 if ( $cust_bill_pkg->pkgnum > 0 ) {
3947 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3949 if ( $cust_bill_pkg->setup != 0 && (!$type || $type eq 'S') ) {
3951 my $description = $desc;
3952 $description .= ' Setup' if $cust_bill_pkg->recur != 0;
3955 unless ( $cust_pkg->part_pkg->hide_svc_detail
3956 || $cust_bill_pkg->hidden )
3958 push @d, map &{$escape_function}($_),
3959 $cust_pkg->h_labels_short($self->_date);
3960 if ( $multilocation ) {
3961 my $loc = $cust_pkg->location_label;
3962 $loc = substr($desc, 0, 50). '...'
3963 if $format eq 'latex' && length($loc) > 50;
3964 push @d, &{$escape_function}($loc);
3967 push @d, $cust_bill_pkg->details(%details_opt)
3968 if $cust_bill_pkg->recur == 0;
3970 if ( $cust_bill_pkg->hidden ) {
3971 $s->{amount} += $cust_bill_pkg->setup;
3972 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3973 push @{ $s->{ext_description} }, @d;
3976 description => $description,
3977 #pkgpart => $part_pkg->pkgpart,
3978 pkgnum => $cust_bill_pkg->pkgnum,
3979 amount => $cust_bill_pkg->setup,
3980 unit_amount => $cust_bill_pkg->unitsetup,
3981 quantity => $cust_bill_pkg->quantity,
3982 ext_description => \@d,
3988 if ( $cust_bill_pkg->recur != 0 &&
3989 ( !$type || $type eq 'R' || $type eq 'U' )
3993 my $is_summary = $display->summary;
3994 my $description = ($is_summary && $type && $type eq 'U')
3995 ? "Usage charges" : $desc;
3997 unless ( $conf->exists('disable_line_item_date_ranges') ) {
3998 $description .= " (" . time2str($date_format, $cust_bill_pkg->sdate).
3999 " - ". time2str($date_format, $cust_bill_pkg->edate). ")";
4004 #at least until cust_bill_pkg has "past" ranges in addition to
4005 #the "future" sdate/edate ones... see #3032
4006 my @dates = ( $self->_date );
4007 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
4008 push @dates, $prev->sdate if $prev;
4010 unless ( $cust_pkg->part_pkg->hide_svc_detail
4011 || $cust_bill_pkg->itemdesc
4012 || $cust_bill_pkg->hidden
4013 || $is_summary && $type && $type eq 'U' )
4015 push @d, map &{$escape_function}($_),
4016 $cust_pkg->h_labels_short(@dates)
4017 #$cust_bill_pkg->edate,
4018 #$cust_bill_pkg->sdate)
4020 if ( $multilocation ) {
4021 my $loc = $cust_pkg->location_label;
4022 $loc = substr($desc, 0, 50). '...'
4023 if $format eq 'latex' && length($loc) > 50;
4024 push @d, &{$escape_function}($loc);
4028 push @d, $cust_bill_pkg->details(%details_opt)
4029 unless ($is_summary || $type && $type eq 'R');
4033 $amount = $cust_bill_pkg->recur;
4034 }elsif($type eq 'R') {
4035 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
4036 }elsif($type eq 'U') {
4037 $amount = $cust_bill_pkg->usage;
4040 if ( !$type || $type eq 'R' ) {
4042 if ( $cust_bill_pkg->hidden ) {
4043 $r->{amount} += $amount;
4044 $r->{unit_amount} += $cust_bill_pkg->unitrecur;
4045 push @{ $r->{ext_description} }, @d;
4048 description => $description,
4049 #pkgpart => $part_pkg->pkgpart,
4050 pkgnum => $cust_bill_pkg->pkgnum,
4052 unit_amount => $cust_bill_pkg->unitrecur,
4053 quantity => $cust_bill_pkg->quantity,
4054 ext_description => \@d,
4058 } elsif ( $amount ) { # && $type eq 'U'
4060 if ( $cust_bill_pkg->hidden ) {
4061 $u->{amount} += $amount;
4062 $u->{unit_amount} += $cust_bill_pkg->unitrecur;
4063 push @{ $u->{ext_description} }, @d;
4066 description => $description,
4067 #pkgpart => $part_pkg->pkgpart,
4068 pkgnum => $cust_bill_pkg->pkgnum,
4070 unit_amount => $cust_bill_pkg->unitrecur,
4071 quantity => $cust_bill_pkg->quantity,
4072 ext_description => \@d,
4078 } # recurring or usage with recurring charge
4080 } else { #pkgnum tax or one-shot line item (??)
4082 if ( $cust_bill_pkg->setup != 0 ) {
4084 'description' => $desc,
4085 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
4088 if ( $cust_bill_pkg->recur != 0 ) {
4090 'description' => "$desc (".
4091 time2str($date_format, $cust_bill_pkg->sdate). ' - '.
4092 time2str($date_format, $cust_bill_pkg->edate). ')',
4093 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
4103 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4105 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
4106 $_->{amount} =~ s/^\-0\.00$/0.00/;
4107 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4109 unless $_->{amount} == 0;
4117 sub _items_credits {
4118 my( $self, %opt ) = @_;
4119 my $trim_len = $opt{'trim_len'} || 60;
4123 foreach ( $self->cust_credited ) {
4125 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
4127 my $reason = substr($_->cust_credit->reason, 0, $trim_len);
4128 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
4129 $reason = " ($reason) " if $reason;
4132 #'description' => 'Credit ref\#'. $_->crednum.
4133 # " (". time2str("%x",$_->cust_credit->_date) .")".
4135 'description' => 'Credit applied '.
4136 time2str($date_format,$_->cust_credit->_date). $reason,
4137 'amount' => sprintf("%.2f",$_->amount),
4145 sub _items_payments {
4149 #get & print payments
4150 foreach ( $self->cust_bill_pay ) {
4152 #something more elaborate if $_->amount ne ->cust_pay->paid ?
4155 'description' => "Payment received ".
4156 time2str($date_format,$_->cust_pay->_date ),
4157 'amount' => sprintf("%.2f", $_->amount )
4165 =item call_details [ OPTION => VALUE ... ]
4167 Returns an array of CSV strings representing the call details for this invoice
4168 The only option available is the boolean prepend_billed_number
4173 my ($self, %opt) = @_;
4175 my $format_function = sub { shift };
4177 if ($opt{prepend_billed_number}) {
4178 $format_function = sub {
4182 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
4187 my @details = map { $_->details( 'format_function' => $format_function,
4188 'escape_function' => sub{ return() },
4192 $self->cust_bill_pkg;
4193 my $header = $details[0];
4194 ( $header, grep { $_ ne $header } @details );
4204 =item process_reprint
4208 sub process_reprint {
4209 process_re_X('print', @_);
4212 =item process_reemail
4216 sub process_reemail {
4217 process_re_X('email', @_);
4225 process_re_X('fax', @_);
4233 process_re_X('ftp', @_);
4240 sub process_respool {
4241 process_re_X('spool', @_);
4244 use Storable qw(thaw);
4248 my( $method, $job ) = ( shift, shift );
4249 warn "$me process_re_X $method for job $job\n" if $DEBUG;
4251 my $param = thaw(decode_base64(shift));
4252 warn Dumper($param) if $DEBUG;
4263 my($method, $job, %param ) = @_;
4265 warn "re_X $method for job $job with param:\n".
4266 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
4269 #some false laziness w/search/cust_bill.html
4271 my $orderby = 'ORDER BY cust_bill._date';
4273 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
4275 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
4277 my @cust_bill = qsearch( {
4278 #'select' => "cust_bill.*",
4279 'table' => 'cust_bill',
4280 'addl_from' => $addl_from,
4282 'extra_sql' => $extra_sql,
4283 'order_by' => $orderby,
4287 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
4289 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
4292 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
4293 foreach my $cust_bill ( @cust_bill ) {
4294 $cust_bill->$method();
4296 if ( $job ) { #progressbar foo
4298 if ( time - $min_sec > $last ) {
4299 my $error = $job->update_statustext(
4300 int( 100 * $num / scalar(@cust_bill) )
4302 die $error if $error;
4313 =head1 CLASS METHODS
4319 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
4325 'charged - '. $class->paid_sql. ' - '. $class->credited_sql;
4330 Returns an SQL fragment to retreive the net amount (charged minus credited).
4336 'charged - '. $class->credited_sql;
4341 Returns an SQL fragment to retreive the amount paid against this invoice.
4347 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
4348 WHERE cust_bill.invnum = cust_bill_pay.invnum )";
4353 Returns an SQL fragment to retreive the amount credited against this invoice.
4359 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
4360 WHERE cust_bill.invnum = cust_credit_bill.invnum )";
4363 =item search_sql_where HASHREF
4365 Class method which returns an SQL WHERE fragment to search for parameters
4366 specified in HASHREF. Valid parameters are
4372 List reference of start date, end date, as UNIX timestamps.
4382 List reference of charged limits (exclusive).
4386 List reference of charged limits (exclusive).
4390 flag, return open invoices only
4394 flag, return net invoices only
4398 =item newest_percust
4402 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
4406 sub search_sql_where {
4407 my($class, $param) = @_;
4409 warn "$me search_sql_where called with params: \n".
4410 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
4416 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
4417 push @search, "cust_main.agentnum = $1";
4421 if ( $param->{_date} ) {
4422 my($beginning, $ending) = @{$param->{_date}};
4424 push @search, "cust_bill._date >= $beginning",
4425 "cust_bill._date < $ending";
4429 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
4430 push @search, "cust_bill.invnum >= $1";
4432 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
4433 push @search, "cust_bill.invnum <= $1";
4437 if ( $param->{charged} ) {
4438 my @charged = ref($param->{charged})
4439 ? @{ $param->{charged} }
4440 : ($param->{charged});
4442 push @search, map { s/^charged/cust_bill.charged/; $_; }
4446 my $owed_sql = FS::cust_bill->owed_sql;
4449 if ( $param->{owed} ) {
4450 my @owed = ref($param->{owed})
4451 ? @{ $param->{owed} }
4453 push @search, map { s/^owed/$owed_sql/; $_; }
4458 push @search, "0 != $owed_sql"
4459 if $param->{'open'};
4460 push @search, '0 != '. FS::cust_bill->net_sql
4464 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
4465 if $param->{'days'};
4468 if ( $param->{'newest_percust'} ) {
4470 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
4471 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
4473 my @newest_where = map { my $x = $_;
4474 $x =~ s/\bcust_bill\./newest_cust_bill./g;
4477 grep ! /^cust_main./, @search;
4478 my $newest_where = scalar(@newest_where)
4479 ? ' AND '. join(' AND ', @newest_where)
4483 push @search, "cust_bill._date = (
4484 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
4485 WHERE newest_cust_bill.custnum = cust_bill.custnum
4491 #agent virtualization
4492 my $curuser = $FS::CurrentUser::CurrentUser;
4493 if ( $curuser->username eq 'fs_queue'
4494 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
4496 my $newuser = qsearchs('access_user', {
4497 'username' => $username,
4501 $curuser = $newuser;
4503 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
4506 push @search, $curuser->agentnums_sql;
4508 join(' AND ', @search );
4520 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
4521 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base