2 use base qw( FS::cust_bill::Search FS::Template_Mixin
3 FS::cust_main_Mixin FS::Record
7 use vars qw( $DEBUG $me );
9 use Fcntl qw(:flock); #for spool_csv
11 use List::Util qw(min max sum);
15 use Storable qw( freeze thaw );
17 use FS::UID qw( datasrc );
18 use FS::Misc qw( send_email send_fax do_print );
19 use FS::Record qw( qsearch qsearchs dbh );
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_bill_event;
32 use FS::cust_bill_pay;
33 use FS::part_bill_event;
36 use FS::cust_bill_batch;
37 use FS::cust_bill_pay_pkg;
38 use FS::cust_credit_bill_pkg;
39 use FS::discount_plan;
40 use FS::cust_bill_void;
44 $me = '[FS::cust_bill]';
48 FS::cust_bill - Object methods for cust_bill records
54 $record = new FS::cust_bill \%hash;
55 $record = new FS::cust_bill { 'column' => 'value' };
57 $error = $record->insert;
59 $error = $new_record->replace($old_record);
61 $error = $record->delete;
63 $error = $record->check;
65 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
67 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
69 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
71 @cust_pay_objects = $cust_bill->cust_pay;
73 $tax_amount = $record->tax;
75 @lines = $cust_bill->print_text;
76 @lines = $cust_bill->print_text('time' => $time);
80 An FS::cust_bill object represents an invoice; a declaration that a customer
81 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
82 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
83 following fields are currently supported:
89 =item invnum - primary key (assigned automatically for new invoices)
91 =item custnum - customer (see L<FS::cust_main>)
93 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
94 L<Time::Local> and L<Date::Parse> for conversion functions.
96 =item charged - amount of this invoice
98 =item invoice_terms - optional terms override for this specific invoice
106 =item billing_balance - the customer's balance immediately before generating
107 this invoice. DEPRECATED. Use the L<FS::cust_main/balance_date> method
108 to determine the customer's balance at a specific time.
110 =item previous_balance - the customer's balance immediately after generating
111 the invoice before this one. DEPRECATED.
113 =item printed - formerly used to track the number of times an invoice had
114 been printed; no longer used.
122 =item closed - books closed flag, empty or `Y'
124 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
126 =item agent_invid - legacy invoice number
128 =item promised_date - customer promised payment date, for collection
130 =item pending - invoice is still being generated, empty or 'Y'
140 Creates a new invoice. To add the invoice to the database, see L<"insert">.
141 Invoices are normally created by calling the bill method of a customer object
142 (see L<FS::cust_main>).
146 sub table { 'cust_bill'; }
148 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
149 # (except email_subject and invnum_date_pretty)
152 $self->conf->config('notice_name') || 'Invoice'
155 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
156 sub cust_unlinked_msg {
158 "WARNING: can't find cust_main.custnum ". $self->custnum.
159 ' (cust_bill.invnum '. $self->invnum. ')';
164 Adds this invoice to the database ("Posts" the invoice). If there is an error,
165 returns the error, otherwise returns false.
171 warn "$me insert called\n" if $DEBUG;
173 local $SIG{HUP} = 'IGNORE';
174 local $SIG{INT} = 'IGNORE';
175 local $SIG{QUIT} = 'IGNORE';
176 local $SIG{TERM} = 'IGNORE';
177 local $SIG{TSTP} = 'IGNORE';
178 local $SIG{PIPE} = 'IGNORE';
180 my $oldAutoCommit = $FS::UID::AutoCommit;
181 local $FS::UID::AutoCommit = 0;
184 my $error = $self->SUPER::insert;
186 $dbh->rollback if $oldAutoCommit;
190 if ( $self->get('cust_bill_pkg') ) {
191 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
192 $cust_bill_pkg->invnum($self->invnum);
193 my $error = $cust_bill_pkg->insert;
195 $dbh->rollback if $oldAutoCommit;
196 return "can't create invoice line item: $error";
201 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
208 Voids this invoice: deletes the invoice and adds a record of the voided invoice
209 to the FS::cust_bill_void table (and related tables starting from
210 FS::cust_bill_pkg_void).
216 my $reason = scalar(@_) ? shift : '';
218 local $SIG{HUP} = 'IGNORE';
219 local $SIG{INT} = 'IGNORE';
220 local $SIG{QUIT} = 'IGNORE';
221 local $SIG{TERM} = 'IGNORE';
222 local $SIG{TSTP} = 'IGNORE';
223 local $SIG{PIPE} = 'IGNORE';
225 my $oldAutoCommit = $FS::UID::AutoCommit;
226 local $FS::UID::AutoCommit = 0;
229 my $cust_bill_void = new FS::cust_bill_void ( {
230 map { $_ => $self->get($_) } $self->fields
232 $cust_bill_void->reason($reason);
233 my $error = $cust_bill_void->insert;
235 $dbh->rollback if $oldAutoCommit;
239 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
240 my $error = $cust_bill_pkg->void($reason);
242 $dbh->rollback if $oldAutoCommit;
247 $error = $self->delete;
249 $dbh->rollback if $oldAutoCommit;
253 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
261 This method now works but you probably shouldn't use it. Instead, apply a
262 credit against the invoice, or use the new void method.
264 Using this method to delete invoices outright is really, really bad. There
265 would be no record you ever posted this invoice, and there are no check to
266 make sure charged = 0 or that there are no associated cust_bill_pkg records.
268 Really, don't use it.
274 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
276 local $SIG{HUP} = 'IGNORE';
277 local $SIG{INT} = 'IGNORE';
278 local $SIG{QUIT} = 'IGNORE';
279 local $SIG{TERM} = 'IGNORE';
280 local $SIG{TSTP} = 'IGNORE';
281 local $SIG{PIPE} = 'IGNORE';
283 my $oldAutoCommit = $FS::UID::AutoCommit;
284 local $FS::UID::AutoCommit = 0;
287 foreach my $table (qw(
298 foreach my $linked ( $self->$table() ) {
299 my $error = $linked->delete;
301 $dbh->rollback if $oldAutoCommit;
308 my $error = $self->SUPER::delete(@_);
310 $dbh->rollback if $oldAutoCommit;
314 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
320 =item replace [ OLD_RECORD ]
322 You can, but probably shouldn't modify invoices...
324 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
325 supplied, replaces this record. If there is an error, returns the error,
326 otherwise returns false.
330 #replace can be inherited from Record.pm
332 # replace_check is now the preferred way to #implement replace data checks
333 # (so $object->replace() works without an argument)
336 my( $new, $old ) = ( shift, shift );
337 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
338 #return "Can't change _date!" unless $old->_date eq $new->_date;
339 return "Can't change _date" unless $old->_date == $new->_date;
340 return "Can't change charged" unless $old->charged == $new->charged
341 || $old->pending eq 'Y'
342 || $old->charged == 0
343 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
349 =item add_cc_surcharge
355 sub add_cc_surcharge {
356 my ($self, $pkgnum, $amount) = (shift, shift, shift);
359 my $cust_bill_pkg = new FS::cust_bill_pkg({
360 'invnum' => $self->invnum,
364 $error = $cust_bill_pkg->insert;
365 return $error if $error;
367 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
368 $self->charged($self->charged+$amount);
369 $error = $self->replace;
370 return $error if $error;
372 $self->apply_payments_and_credits;
378 Checks all fields to make sure this is a valid invoice. If there is an error,
379 returns the error, otherwise returns false. Called by the insert and replace
388 $self->ut_numbern('invnum')
389 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
390 || $self->ut_numbern('_date')
391 || $self->ut_money('charged')
392 || $self->ut_numbern('printed')
393 || $self->ut_enum('closed', [ '', 'Y' ])
394 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
395 || $self->ut_numbern('agent_invid') #varchar?
396 || $self->ut_flag('pending')
398 return $error if $error;
400 $self->_date(time) unless $self->_date;
402 $self->printed(0) if $self->printed eq '';
409 Returns the displayed invoice number for this invoice: agent_invid if
410 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
416 if ( $self->agent_invid
417 && FS::Conf->new->exists('cust_bill-default_agent_invid') ) {
418 return $self->agent_invid;
420 return $self->invnum;
426 Returns the customer's last invoice before this one.
432 if ( !$self->get('previous_bill') ) {
433 $self->set('previous_bill', qsearchs({
434 'table' => 'cust_bill',
435 'hashref' => { 'custnum' => $self->custnum,
436 '_date' => { op=>'<', value=>$self->_date } },
437 'order_by' => 'ORDER BY _date DESC LIMIT 1',
440 $self->get('previous_bill');
445 Returns a list consisting of the total previous balance for this customer,
446 followed by the previous outstanding invoices (as FS::cust_bill objects also).
453 my @cust_bill = sort { $a->_date <=> $b->_date }
454 grep { $_->owed != 0 }
455 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
456 #'_date' => { op=>'<', value=>$self->_date },
457 'invnum' => { op=>'<', value=>$self->invnum },
460 foreach ( @cust_bill ) { $total += $_->owed; }
464 =item enable_previous
466 Whether to show the 'Previous Charges' section when printing this invoice.
467 The negation of the 'disable_previous_balance' config setting.
471 sub enable_previous {
473 my $agentnum = $self->cust_main->agentnum;
474 !$self->conf->exists('disable_previous_balance', $agentnum);
479 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
486 { 'table' => 'cust_bill_pkg',
487 'hashref' => { 'invnum' => $self->invnum },
488 'order_by' => 'ORDER BY billpkgnum', #important? otherwise we could use
489 # the AUTLOADED FK search. or should
490 # that default to ORDER by the pkey?
495 =item cust_bill_pkg_pkgnum PKGNUM
497 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
502 sub cust_bill_pkg_pkgnum {
503 my( $self, $pkgnum ) = @_;
505 { 'table' => 'cust_bill_pkg',
506 'hashref' => { 'invnum' => $self->invnum,
509 'order_by' => 'ORDER BY billpkgnum',
516 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
523 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
524 $self->cust_bill_pkg;
526 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
531 Returns true if any of the packages (or their definitions) corresponding to the
532 line items for this invoice have the no_auto flag set.
538 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
541 =item open_cust_bill_pkg
543 Returns the open line items for this invoice.
545 Note that cust_bill_pkg with both setup and recur fees are returned as two
546 separate line items, each with only one fee.
550 # modeled after cust_main::open_cust_bill
551 sub open_cust_bill_pkg {
554 # grep { $_->owed > 0 } $self->cust_bill_pkg
556 my %other = ( 'recur' => 'setup',
557 'setup' => 'recur', );
559 foreach my $field ( qw( recur setup )) {
560 push @open, map { $_->set( $other{$field}, 0 ); $_; }
561 grep { $_->owed($field) > 0 }
562 $self->cust_bill_pkg;
568 =item cust_bill_event
570 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
574 sub cust_bill_event {
576 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
579 =item num_cust_bill_event
581 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
585 sub num_cust_bill_event {
588 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
589 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
590 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
591 $sth->fetchrow_arrayref->[0];
596 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
600 #false laziness w/cust_pkg.pm
604 'table' => 'cust_event',
605 'addl_from' => 'JOIN part_event USING ( eventpart )',
606 'hashref' => { 'tablenum' => $self->invnum },
607 'extra_sql' => " AND eventtable = 'cust_bill' ",
613 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
617 #false laziness w/cust_pkg.pm
621 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
622 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
623 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
624 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
625 $sth->fetchrow_arrayref->[0];
630 Returns the customer (see L<FS::cust_main>) for this invoice.
634 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this invoice
636 Returns a list: an empty list on success or a list of errors.
643 grep { $_->suspend(@_) }
644 grep { $_->getfield('cancel') }
649 =item cust_suspend_if_balance_over AMOUNT
651 Suspends the customer associated with this invoice if the total amount owed on
652 this invoice and all older invoices is greater than the specified amount.
654 Returns a list: an empty list on success or a list of errors.
658 sub cust_suspend_if_balance_over {
659 my( $self, $amount ) = ( shift, shift );
660 my $cust_main = $self->cust_main;
661 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
664 $cust_main->suspend(@_);
670 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
676 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
677 sort { $a->_date <=> $b->_date }
678 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
683 =item cust_credit_bill
685 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
691 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
692 sort { $a->_date <=> $b->_date }
693 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
697 sub cust_credit_bill {
698 shift->cust_credited(@_);
701 #=item cust_bill_pay_pkgnum PKGNUM
703 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
704 #with matching pkgnum.
708 #sub cust_bill_pay_pkgnum {
709 # my( $self, $pkgnum ) = @_;
710 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
711 # sort { $a->_date <=> $b->_date }
712 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
713 # 'pkgnum' => $pkgnum,
718 =item cust_bill_pay_pkg PKGNUM
720 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
721 applied against the matching pkgnum.
725 sub cust_bill_pay_pkg {
726 my( $self, $pkgnum ) = @_;
729 'select' => 'cust_bill_pay_pkg.*',
730 'table' => 'cust_bill_pay_pkg',
731 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
732 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
733 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
734 " AND cust_bill_pkg.pkgnum = $pkgnum",
739 #=item cust_credited_pkgnum PKGNUM
741 #=item cust_credit_bill_pkgnum PKGNUM
743 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
744 #with matching pkgnum.
748 #sub cust_credited_pkgnum {
749 # my( $self, $pkgnum ) = @_;
750 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
751 # sort { $a->_date <=> $b->_date }
752 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
753 # 'pkgnum' => $pkgnum,
758 #sub cust_credit_bill_pkgnum {
759 # shift->cust_credited_pkgnum(@_);
762 =item cust_credit_bill_pkg PKGNUM
764 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
765 applied against the matching pkgnum.
769 sub cust_credit_bill_pkg {
770 my( $self, $pkgnum ) = @_;
773 'select' => 'cust_credit_bill_pkg.*',
774 'table' => 'cust_credit_bill_pkg',
775 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
776 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
777 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
778 " AND cust_bill_pkg.pkgnum = $pkgnum",
783 =item cust_bill_batch
785 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
789 sub cust_bill_batch {
791 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
796 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
797 hash keyed by term length.
803 FS::discount_plan->all($self);
808 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
815 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
817 foreach (@taxlines) { $total += $_->setup; }
823 Returns the amount owed (still outstanding) on this invoice, which is charged
824 minus all payment applications (see L<FS::cust_bill_pay>) and credit
825 applications (see L<FS::cust_credit_bill>).
831 my $balance = $self->charged;
832 $balance -= $_->amount foreach ( $self->cust_bill_pay );
833 $balance -= $_->amount foreach ( $self->cust_credited );
834 $balance = sprintf( "%.2f", $balance);
835 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
840 my( $self, $pkgnum ) = @_;
842 #my $balance = $self->charged;
844 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
846 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
847 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
849 $balance = sprintf( "%.2f", $balance);
850 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
856 Returns true if this invoice should be hidden. See the
857 selfservice-hide_invoices-taxclass configuraiton setting.
863 my $conf = $self->conf;
864 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
866 my @cust_bill_pkg = $self->cust_bill_pkg;
867 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
868 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
871 =item apply_payments_and_credits [ OPTION => VALUE ... ]
873 Applies unapplied payments and credits to this invoice.
875 A hash of optional arguments may be passed. Currently "manual" is supported.
876 If true, a payment receipt is sent instead of a statement when
877 'payment_receipt_email' configuration option is set.
879 If there is an error, returns the error, otherwise returns false.
883 sub apply_payments_and_credits {
884 my( $self, %options ) = @_;
885 my $conf = $self->conf;
887 local $SIG{HUP} = 'IGNORE';
888 local $SIG{INT} = 'IGNORE';
889 local $SIG{QUIT} = 'IGNORE';
890 local $SIG{TERM} = 'IGNORE';
891 local $SIG{TSTP} = 'IGNORE';
892 local $SIG{PIPE} = 'IGNORE';
894 my $oldAutoCommit = $FS::UID::AutoCommit;
895 local $FS::UID::AutoCommit = 0;
898 $self->select_for_update; #mutex
900 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
901 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
903 if ( $conf->exists('pkg-balances') ) {
904 # limit @payments & @credits to those w/ a pkgnum grepped from $self
905 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
906 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
907 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
910 while ( $self->owed > 0 and ( @payments || @credits ) ) {
913 if ( @payments && @credits ) {
915 #decide which goes first by weight of top (unapplied) line item
917 my @open_lineitems = $self->open_cust_bill_pkg;
920 max( map { $_->part_pkg->pay_weight || 0 }
925 my $max_credit_weight =
926 max( map { $_->part_pkg->credit_weight || 0 }
932 #if both are the same... payments first? it has to be something
933 if ( $max_pay_weight >= $max_credit_weight ) {
939 } elsif ( @payments ) {
941 } elsif ( @credits ) {
944 die "guru meditation #12 and 35";
948 if ( $app eq 'pay' ) {
950 my $payment = shift @payments;
951 $unapp_amount = $payment->unapplied;
952 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
953 $app->pkgnum( $payment->pkgnum )
954 if $conf->exists('pkg-balances') && $payment->pkgnum;
956 } elsif ( $app eq 'credit' ) {
958 my $credit = shift @credits;
959 $unapp_amount = $credit->credited;
960 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
961 $app->pkgnum( $credit->pkgnum )
962 if $conf->exists('pkg-balances') && $credit->pkgnum;
965 die "guru meditation #12 and 35";
969 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
970 warn "owed_pkgnum ". $app->pkgnum;
971 $owed = $self->owed_pkgnum($app->pkgnum);
975 next unless $owed > 0;
977 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
978 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
980 $app->invnum( $self->invnum );
982 my $error = $app->insert(%options);
984 $dbh->rollback if $oldAutoCommit;
985 return "Error inserting ". $app->table. " record: $error";
987 die $error if $error;
991 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
996 =item generate_email OPTION => VALUE ...
1004 sender address, required
1008 alternate template name, optional
1012 text attachment arrayref, optional
1016 email subject, optional
1020 notice name instead of "Invoice", optional
1024 Returns an argument list to be passed to L<FS::Misc::send_email>.
1030 sub generate_email {
1034 my $conf = $self->conf;
1036 my $me = '[FS::cust_bill::generate_email]';
1039 'from' => $args{'from'},
1040 'subject' => ($args{'subject'} || $self->email_subject),
1041 'custnum' => $self->custnum,
1042 'msgtype' => 'invoice',
1045 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
1047 my $cust_main = $self->cust_main;
1049 if (ref($args{'to'}) eq 'ARRAY') {
1050 $return{'to'} = $args{'to'};
1052 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1053 $cust_main->invoicing_list
1057 if ( $conf->exists('invoice_html') ) {
1059 warn "$me creating HTML/text multipart message"
1062 $return{'nobody'} = 1;
1064 my $alternative = build MIME::Entity
1065 'Type' => 'multipart/alternative',
1066 #'Encoding' => '7bit',
1067 'Disposition' => 'inline'
1071 if ( $conf->exists('invoice_email_pdf')
1072 and scalar($conf->config('invoice_email_pdf_note')) ) {
1074 warn "$me using 'invoice_email_pdf_note' in multipart message"
1076 $data = [ map { $_ . "\n" }
1077 $conf->config('invoice_email_pdf_note')
1082 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1084 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1085 $data = $args{'print_text'};
1087 $data = [ $self->print_text(\%args) ];
1092 $alternative->attach(
1093 'Type' => 'text/plain',
1094 'Encoding' => 'quoted-printable',
1095 'Charset' => 'UTF-8',
1096 #'Encoding' => '7bit',
1098 'Disposition' => 'inline',
1105 if ( $conf->exists('invoice_email_pdf')
1106 and scalar($conf->config('invoice_email_pdf_note')) ) {
1108 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1112 $args{'from'} =~ /\@([\w\.\-]+)/;
1113 my $from = $1 || 'example.com';
1114 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1117 my $agentnum = $cust_main->agentnum;
1118 if ( defined($args{'template'}) && length($args{'template'})
1119 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1122 $logo = 'logo_'. $args{'template'}. '.png';
1126 my $image_data = $conf->config_binary( $logo, $agentnum);
1128 $image = build MIME::Entity
1129 'Type' => 'image/png',
1130 'Encoding' => 'base64',
1131 'Data' => $image_data,
1132 'Filename' => 'logo.png',
1133 'Content-ID' => "<$content_id>",
1136 if ($conf->exists('invoice-barcode')) {
1137 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1138 $barcode = build MIME::Entity
1139 'Type' => 'image/png',
1140 'Encoding' => 'base64',
1141 'Data' => $self->invoice_barcode(0),
1142 'Filename' => 'barcode.png',
1143 'Content-ID' => "<$barcode_content_id>",
1145 $args{'barcode_cid'} = $barcode_content_id;
1148 $htmldata = $self->print_html({ 'cid'=>$content_id, %args });
1151 $alternative->attach(
1152 'Type' => 'text/html',
1153 'Encoding' => 'quoted-printable',
1154 'Data' => [ '<html>',
1157 ' '. encode_entities($return{'subject'}),
1160 ' <body bgcolor="#e8e8e8">',
1165 'Disposition' => 'inline',
1166 #'Filename' => 'invoice.pdf',
1170 my @otherparts = ();
1171 if ( $cust_main->email_csv_cdr ) {
1173 push @otherparts, build MIME::Entity
1174 'Type' => 'text/csv',
1175 'Encoding' => '7bit',
1176 'Data' => [ map { "$_\n" }
1177 $self->call_details('prepend_billed_number' => 1)
1179 'Disposition' => 'attachment',
1180 'Filename' => 'usage-'. $self->invnum. '.csv',
1185 if ( $conf->exists('invoice_email_pdf') ) {
1190 # multipart/alternative
1196 my $related = build MIME::Entity 'Type' => 'multipart/related',
1197 'Encoding' => '7bit';
1199 #false laziness w/Misc::send_email
1200 $related->head->replace('Content-type',
1201 $related->mime_type.
1202 '; boundary="'. $related->head->multipart_boundary. '"'.
1203 '; type=multipart/alternative'
1206 $related->add_part($alternative);
1208 $related->add_part($image) if $image;
1210 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
1212 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1216 #no other attachment:
1218 # multipart/alternative
1223 $return{'content-type'} = 'multipart/related';
1224 if ($conf->exists('invoice-barcode') && $barcode) {
1225 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1227 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1229 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1230 #$return{'disposition'} = 'inline';
1236 if ( $conf->exists('invoice_email_pdf') ) {
1237 warn "$me creating PDF attachment"
1240 #mime parts arguments a la MIME::Entity->build().
1241 $return{'mimeparts'} = [
1242 { $self->mimebuild_pdf(\%args) }
1246 if ( $conf->exists('invoice_email_pdf')
1247 and scalar($conf->config('invoice_email_pdf_note')) ) {
1249 warn "$me using 'invoice_email_pdf_note'"
1251 $return{'body'} = [ map { $_ . "\n" }
1252 $conf->config('invoice_email_pdf_note')
1257 warn "$me not using 'invoice_email_pdf_note'"
1259 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1260 $return{'body'} = $args{'print_text'};
1262 $return{'body'} = [ $self->print_text(\%args) ];
1275 Returns a list suitable for passing to MIME::Entity->build(), representing
1276 this invoice as PDF attachment.
1283 'Type' => 'application/pdf',
1284 'Encoding' => 'base64',
1285 'Data' => [ $self->print_pdf(@_) ],
1286 'Disposition' => 'attachment',
1287 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1293 Sends this invoice to the destinations configured for this customer: sends
1294 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1296 Options can be passed as a hashref. Positional parameters are no longer
1299 I<template>: a suffix for alternate invoices
1301 I<agentnum>: obsolete, now does nothing.
1303 I<invoice_from> overrides the default email invoice From: address.
1305 I<amount>: obsolete, does nothing
1307 I<notice_name> overrides "Invoice" as the name of the sent document
1308 (templates from 10/2009 or newer required).
1310 I<lpr> overrides the system 'lpr' option as the command to print a document
1311 from standard input.
1317 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1318 my $conf = $self->conf;
1320 my $cust_main = $self->cust_main;
1322 my @invoicing_list = $cust_main->invoicing_list;
1325 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1326 && ! $self->invoice_noemail;
1329 if grep { $_ eq 'POST' } @invoicing_list; #postal
1331 #this has never been used post-$ORIGINAL_ISP afaik
1332 $self->fax_invoice($opt)
1333 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1339 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1341 Sends this invoice to the customer's email destination(s).
1343 Options must be passed as a hashref. Positional parameters are no longer
1346 I<template>, if specified, is the name of a suffix for alternate invoices.
1348 I<invoice_from>, if specified, overrides the default email invoice From:
1351 I<notice_name> is the name of the sent document.
1355 sub queueable_email {
1358 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1359 or die "invalid invoice number: " . $opt{invnum};
1361 my %args = map {$_ => $opt{$_}}
1363 qw( invoice_from notice_name no_coupon template );
1365 my $error = $self->email( \%args );
1366 die $error if $error;
1372 return if $self->hide;
1373 my $conf = $self->conf;
1374 my $opt = shift || {};
1375 if ($opt and !ref($opt)) {
1376 die "FS::cust_bill::email called with positional parameters";
1379 my $template = $opt->{template};
1380 my $from = delete $opt->{invoice_from};
1382 # this is where we set the From: address
1383 $from ||= $self->_agent_invoice_from || #XXX should go away
1384 $conf->config('invoice_from', $self->cust_main->agentnum );
1386 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1387 $self->cust_main->invoicing_list;
1389 if ( ! @invoicing_list ) { #no recipients
1390 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1391 die 'No recipients for customer #'. $self->custnum;
1393 #default: better to notify this person than silence
1394 @invoicing_list = ($from);
1398 # this is where we set the Subject:
1399 my $subject = $self->email_subject($template);
1401 my $error = send_email(
1402 $self->generate_email(
1404 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1405 'subject' => $subject,
1406 %$opt, # template, etc.
1409 die "can't email invoice: $error\n" if $error;
1410 #die "$error\n" if $error;
1416 my $conf = $self->conf;
1418 #my $template = scalar(@_) ? shift : '';
1421 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1424 my $cust_main = $self->cust_main;
1425 my $name = $cust_main->name;
1426 my $name_short = $cust_main->name_short;
1427 my $invoice_number = $self->invnum;
1428 my $invoice_date = $self->_date_pretty;
1430 eval qq("$subject");
1433 =item lpr_data HASHREF
1435 Returns the postscript or plaintext for this invoice as an arrayref.
1437 Options must be passed as a hashref. Positional parameters are no longer
1440 I<template>, if specified, is the name of a suffix for alternate invoices.
1442 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1448 my $conf = $self->conf;
1449 my $opt = shift || {};
1450 if ($opt and !ref($opt)) {
1451 # nobody does this anyway
1452 die "FS::cust_bill::lpr_data called with positional parameters";
1455 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1456 [ $self->$method( $opt ) ];
1461 Prints this invoice.
1463 Options must be passed as a hashref.
1465 I<template>, if specified, is the name of a suffix for alternate invoices.
1467 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1473 return if $self->hide;
1474 my $conf = $self->conf;
1475 my $opt = shift || {};
1476 if ($opt and !ref($opt)) {
1477 die "FS::cust_bill::print called with positional parameters";
1480 my $lpr = delete $opt->{lpr};
1481 if($conf->exists('invoice_print_pdf')) {
1482 # Add the invoice to the current batch.
1483 $self->batch_invoice($opt);
1487 $self->lpr_data($opt),
1488 'agentnum' => $self->cust_main->agentnum,
1494 =item fax_invoice HASHREF
1498 Options must be passed as a hashref.
1500 I<template>, if specified, is the name of a suffix for alternate invoices.
1502 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1508 return if $self->hide;
1509 my $conf = $self->conf;
1510 my $opt = shift || {};
1511 if ($opt and !ref($opt)) {
1512 die "FS::cust_bill::fax_invoice called with positional parameters";
1515 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1516 unless $conf->exists('invoice_latex');
1518 my $dialstring = $self->cust_main->getfield('fax');
1521 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1522 'dialstring' => $dialstring,
1524 die $error if $error;
1528 =item batch_invoice [ HASHREF ]
1530 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1531 isn't an open batch, one will be created.
1533 HASHREF may contain any options to be passed to C<print_pdf>.
1538 my ($self, $opt) = @_;
1539 my $bill_batch = $self->get_open_bill_batch;
1540 my $cust_bill_batch = FS::cust_bill_batch->new({
1541 batchnum => $bill_batch->batchnum,
1542 invnum => $self->invnum,
1544 return $cust_bill_batch->insert($opt);
1547 =item get_open_batch
1549 Returns the currently open batch as an FS::bill_batch object, creating a new
1550 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1555 sub get_open_bill_batch {
1557 my $conf = $self->conf;
1558 my $hashref = { status => 'O' };
1559 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1560 ? $self->cust_main->agentnum
1562 my $batch = qsearchs('bill_batch', $hashref);
1563 return $batch if $batch;
1564 $batch = FS::bill_batch->new($hashref);
1565 my $error = $batch->insert;
1566 die $error if $error;
1570 =item ftp_invoice [ TEMPLATENAME ]
1572 Sends this invoice data via FTP.
1574 TEMPLATENAME is unused?
1580 my $conf = $self->conf;
1581 my $template = scalar(@_) ? shift : '';
1584 'protocol' => 'ftp',
1585 'server' => $conf->config('cust_bill-ftpserver'),
1586 'username' => $conf->config('cust_bill-ftpusername'),
1587 'password' => $conf->config('cust_bill-ftppassword'),
1588 'dir' => $conf->config('cust_bill-ftpdir'),
1589 'format' => $conf->config('cust_bill-ftpformat'),
1593 =item spool_invoice [ TEMPLATENAME ]
1595 Spools this invoice data (see L<FS::spool_csv>)
1597 TEMPLATENAME is unused?
1603 my $conf = $self->conf;
1604 my $template = scalar(@_) ? shift : '';
1607 'format' => $conf->config('cust_bill-spoolformat'),
1608 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1612 =item send_csv OPTION => VALUE, ...
1614 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1618 protocol - currently only "ftp"
1624 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1625 and YYMMDDHHMMSS is a timestamp.
1627 See L</print_csv> for a description of the output format.
1632 my($self, %opt) = @_;
1636 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1637 mkdir $spooldir, 0700 unless -d $spooldir;
1639 # don't localize dates here, they're a defined format
1640 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1641 my $file = "$spooldir/$tracctnum.csv";
1643 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1645 open(CSV, ">$file") or die "can't open $file: $!";
1653 if ( $opt{protocol} eq 'ftp' ) {
1654 eval "use Net::FTP;";
1656 $net = Net::FTP->new($opt{server}) or die @$;
1658 die "unknown protocol: $opt{protocol}";
1661 $net->login( $opt{username}, $opt{password} )
1662 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1664 $net->binary or die "can't set binary mode";
1666 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1668 $net->put($file) or die "can't put $file: $!";
1678 Spools CSV invoice data.
1684 =item format - any of FS::Misc::::Invoicing::spool_formats
1686 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1687 customer has the corresponding invoice destinations set (see
1688 L<FS::cust_main_invoice>).
1690 =item agent_spools - if set to a true value, will spool to per-agent files
1691 rather than a single global file
1693 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1694 append to that spool. L<FS::Cron::upload> will then send the spool file to
1697 =item balanceover - if set, only spools the invoice if the total amount owed on
1698 this invoice and all older invoices is greater than the specified amount.
1700 =item time - the "current time". Controls the printing of past due messages
1708 my($self, %opt) = @_;
1710 my $time = $opt{'time'} || time;
1711 my $cust_main = $self->cust_main;
1713 if ( $opt{'dest'} ) {
1714 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1715 $cust_main->invoicing_list;
1716 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1717 || ! keys %invoicing_list;
1720 if ( $opt{'balanceover'} ) {
1722 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1725 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1726 mkdir $spooldir, 0700 unless -d $spooldir;
1728 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1731 if ( $opt{'agent_spools'} ) {
1732 $file = 'agentnum'.$cust_main->agentnum;
1737 if ( $opt{'upload_targetnum'} ) {
1738 $spooldir .= '/target'.$opt{'upload_targetnum'};
1739 mkdir $spooldir, 0700 unless -d $spooldir;
1740 } # otherwise it just goes into export.xxx/cust_bill
1742 if ( lc($opt{'format'}) eq 'billco' ) {
1746 $file = "$spooldir/$file.csv";
1748 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1750 open(CSV, ">>$file") or die "can't open $file: $!";
1751 flock(CSV, LOCK_EX);
1756 if ( lc($opt{'format'}) eq 'billco' ) {
1758 flock(CSV, LOCK_UN);
1761 $file =~ s/-header.csv$/-detail.csv/;
1763 open(CSV,">>$file") or die "can't open $file: $!";
1764 flock(CSV, LOCK_EX);
1768 print CSV $detail if defined($detail);
1770 flock(CSV, LOCK_UN);
1777 =item print_csv OPTION => VALUE, ...
1779 Returns CSV data for this invoice.
1783 format - 'default', 'billco', 'oneline', 'bridgestone'
1785 Returns a list consisting of two scalars. The first is a single line of CSV
1786 header information for this invoice. The second is one or more lines of CSV
1787 detail information for this invoice.
1789 If I<format> is not specified or "default", the fields of the CSV file are as
1792 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1793 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1797 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1799 B<record_type> is C<cust_bill> for the initial header line only. The
1800 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1801 fields are filled in.
1803 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1804 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1807 =item invnum - invoice number
1809 =item custnum - customer number
1811 =item _date - invoice date
1813 =item charged - total invoice amount
1815 =item first - customer first name
1817 =item last - customer first name
1819 =item company - company name
1821 =item address1 - address line 1
1823 =item address2 - address line 1
1833 =item pkg - line item description
1835 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1837 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1839 =item sdate - start date for recurring fee
1841 =item edate - end date for recurring fee
1845 If I<format> is "billco", the fields of the header CSV file are as follows:
1847 +-------------------------------------------------------------------+
1848 | FORMAT HEADER FILE |
1849 |-------------------------------------------------------------------|
1850 | Field | Description | Name | Type | Width |
1851 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1852 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1853 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1854 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1855 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1856 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1857 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1858 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1859 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1860 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1861 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1862 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1863 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1864 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1865 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1866 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1867 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1868 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1869 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1870 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1871 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1872 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1873 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1874 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1875 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1876 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1877 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1878 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1879 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1880 +-------+-------------------------------+------------+------+-------+
1882 If I<format> is "billco", the fields of the detail CSV file are as follows:
1884 FORMAT FOR DETAIL FILE
1886 Field | Description | Name | Type | Width
1887 1 | N/A-Leave Empty | RC | CHAR | 2
1888 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1889 3 | Account Number | TRACCTNUM | CHAR | 15
1890 4 | Invoice Number | TRINVOICE | CHAR | 15
1891 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1892 6 | Transaction Detail | DETAILS | CHAR | 100
1893 7 | Amount | AMT | NUM* | 9
1894 8 | Line Format Control** | LNCTRL | CHAR | 2
1895 9 | Grouping Code | GROUP | CHAR | 2
1896 10 | User Defined | ACCT CODE | CHAR | 15
1898 If format is 'oneline', there is no detail file. Each invoice has a
1899 header line only, with the fields:
1901 Agent number, agent name, customer number, first name, last name, address
1902 line 1, address line 2, city, state, zip, invoice date, invoice number,
1903 amount charged, amount due, previous balance, due date.
1905 and then, for each line item, three columns containing the package number,
1906 description, and amount.
1908 If format is 'bridgestone', there is no detail file. Each invoice has a
1909 header line with the following fields in a fixed-width format:
1911 Customer number (in display format), date, name (first last), company,
1912 address 1, address 2, city, state, zip.
1914 This is a mailing list format, and has no per-invoice fields. To avoid
1915 sending redundant notices, the spooling event should have a "once" or
1916 "once_percust_every" condition.
1921 my($self, %opt) = @_;
1923 eval "use Text::CSV_XS";
1926 my $cust_main = $self->cust_main;
1928 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1929 my $format = lc($opt{'format'});
1931 my $time = $opt{'time'} || time;
1933 my $tracctnum = ''; #leaking out from billco-specific sections :/
1934 if ( $format eq 'billco' ) {
1937 $self->conf->config('billco-account_num', $cust_main->agentnum);
1939 $tracctnum = $account_num eq 'display_custnum'
1940 ? $cust_main->display_custnum
1941 : $opt{'tracctnum'};
1944 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1946 my $duedate = $self->due_date2str('%m/%d/%Y'); # hardcoded, NOT date_format
1948 my( $previous_balance, @unused ) = $self->previous; #previous balance
1950 my $pmt_cr_applied = 0;
1951 $pmt_cr_applied += $_->{'amount'}
1952 foreach ( $self->_items_payments(%opt), $self->_items_credits(%opt) ) ;
1954 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1957 '', # 1 | N/A-Leave Empty CHAR 2
1958 '', # 2 | N/A-Leave Empty CHAR 15
1959 $tracctnum, # 3 | Transaction Account No CHAR 15
1960 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1961 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1962 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1963 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1964 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1965 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1966 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1967 '', # 10 | Ancillary Billing Information CHAR 30
1968 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1969 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1972 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1975 $duedate, # 14 | Bill Due Date CHAR 10
1977 $previous_balance, # 15 | Previous Balance NUM* 9
1978 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1979 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1980 $totaldue, # 18 | Total Amt Due NUM* 9
1981 $totaldue, # 19 | Total Amt Due NUM* 9
1982 '', # 20 | 30 Day Aging NUM* 9
1983 '', # 21 | 60 Day Aging NUM* 9
1984 '', # 22 | 90 Day Aging NUM* 9
1985 'N', # 23 | Y/N CHAR 1
1986 '', # 24 | Remittance automation CHAR 100
1987 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1988 $self->custnum, # 26 | Customer Reference Number CHAR 15
1989 '0', # 27 | Federal Tax*** NUM* 9
1990 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1991 '0', # 29 | Other Taxes & Fees*** NUM* 9
1994 } elsif ( $format eq 'oneline' ) { #name
1996 my ($previous_balance) = $self->previous;
1997 $previous_balance = sprintf('%.2f', $previous_balance);
1998 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2004 $self->_items_pkg, #_items_nontax? no sections or anything
2009 $cust_main->agentnum,
2010 $cust_main->agent->agent,
2014 $cust_main->company,
2015 $cust_main->address1,
2016 $cust_main->address2,
2022 time2str("%x", $self->_date),
2027 $self->due_date2str("%x"),
2032 } elsif ( $format eq 'bridgestone' ) {
2034 # bypass the CSV stuff and just return this
2035 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2036 my $zip = $cust_main->zip;
2038 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2042 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2044 $cust_main->display_custnum,
2046 uc(substr($cust_main->contact_firstlast,0,30)),
2047 uc(substr($cust_main->company ,0,30)),
2048 uc(substr($cust_main->address1 ,0,30)),
2049 uc(substr($cust_main->address2 ,0,30)),
2050 uc(substr($cust_main->city ,0,20)),
2051 uc($cust_main->state),
2057 } elsif ( $format eq 'ics' ) {
2059 my $bill = $cust_main->bill_location;
2060 my $zip = $bill->zip;
2064 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2069 # minor false laziness with print_generic
2070 my ($previous_balance) = $self->previous;
2071 my $balance_due = $self->owed + $previous_balance;
2072 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2073 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
2076 if ( $self->due_date and $time >= $self->due_date ) {
2077 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2081 my $header = sprintf(
2082 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2083 $cust_main->display_custnum, #BID
2084 uc($cust_main->first), #FNAME
2085 uc($cust_main->last), #LNAME
2086 '00', #BATCH, should this ever be anything else?
2087 uc($cust_main->company), #COMP
2088 uc($bill->address1), #STREET1
2089 uc($bill->address2), #STREET2
2090 uc($bill->city), #CITY
2091 uc($bill->state), #STATE
2094 time2str('%Y%m%d', $self->_date), #BILL_DATE
2095 $self->due_date2str('%Y%m%d'), #DUE_DATE,
2096 ( map {sprintf('%0.2f', $_)}
2097 $balance_due, #AMNT_DUE
2098 $previous_balance, #PREV_BAL
2099 $payment_total, #PYMT_RCVD
2100 $credit_total, #CREDITS
2101 $previous_balance, #BEG_BAL--is this correct?
2102 $self->charged, #NEW_CHRG
2105 $past_due, #PAST_MSG
2109 my %svc_class = ('' => ''); # maybe cache this more persistently?
2111 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2113 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2114 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2118 my @dates = ( $self->_date, undef );
2119 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2120 $dates[1] = $prev->sdate; #questionable
2123 # generate an 01 detail for each service
2124 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2125 foreach my $cust_svc ( @svcs ) {
2126 $show_pkgnum = ''; # hide it if we're showing svcnums
2128 my $svcpart = $cust_svc->svcpart;
2129 if (!exists($svc_class{$svcpart})) {
2130 my $classnum = $cust_svc->part_svc->classnum;
2131 my $part_svc_class = FS::part_svc_class->by_key($classnum)
2133 $svc_class{$svcpart} = $part_svc_class ?
2134 $part_svc_class->classname :
2138 my @h_label = $cust_svc->label(@dates, 'I');
2139 push @details, sprintf('01%-9s%-20s%-47s',
2141 $svc_class{$svcpart},
2144 } #foreach $cust_svc
2147 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2148 if ($cust_bill_pkg->recur > 0) {
2149 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2150 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2152 push @details, sprintf('02%-6s%-60s%-10s',
2155 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2157 } #foreach $cust_bill_pkg
2159 # Tag this row so that we know whether this is one page (1), two pages
2160 # (2), # or "big" (B). The tag will be stripped off before uploading.
2161 if ( scalar(@details) < 12 ) {
2163 } elsif ( scalar(@details) < 58 ) {
2169 return join('', $header, @details, "\n");
2177 time2str("%x", $self->_date),
2178 sprintf("%.2f", $self->charged),
2179 ( map { $cust_main->getfield($_) }
2180 qw( first last company address1 address2 city state zip country ) ),
2182 ) or die "can't create csv";
2185 my $header = $csv->string. "\n";
2188 if ( lc($opt{'format'}) eq 'billco' ) {
2191 foreach my $item ( $self->_items_pkg ) {
2194 '', # 1 | N/A-Leave Empty CHAR 2
2195 '', # 2 | N/A-Leave Empty CHAR 15
2196 $tracctnum, # 3 | Account Number CHAR 15
2197 $self->invnum, # 4 | Invoice Number CHAR 15
2198 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2199 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2200 $item->{'amount'}, # 7 | Amount NUM* 9
2201 '', # 8 | Line Format Control** CHAR 2
2202 '', # 9 | Grouping Code CHAR 2
2203 '', # 10 | User Defined CHAR 15
2206 $detail .= $csv->string. "\n";
2210 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2216 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2218 my($pkg, $setup, $recur, $sdate, $edate);
2219 if ( $cust_bill_pkg->pkgnum ) {
2221 ($pkg, $setup, $recur, $sdate, $edate) = (
2222 $cust_bill_pkg->part_pkg->pkg,
2223 ( $cust_bill_pkg->setup != 0
2224 ? sprintf("%.2f", $cust_bill_pkg->setup )
2226 ( $cust_bill_pkg->recur != 0
2227 ? sprintf("%.2f", $cust_bill_pkg->recur )
2229 ( $cust_bill_pkg->sdate
2230 ? time2str("%x", $cust_bill_pkg->sdate)
2232 ($cust_bill_pkg->edate
2233 ? time2str("%x", $cust_bill_pkg->edate)
2237 } else { #pkgnum tax
2238 next unless $cust_bill_pkg->setup != 0;
2239 $pkg = $cust_bill_pkg->desc;
2240 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2241 ( $sdate, $edate ) = ( '', '' );
2247 ( map { '' } (1..11) ),
2248 ($pkg, $setup, $recur, $sdate, $edate)
2249 ) or die "can't create csv";
2251 $detail .= $csv->string. "\n";
2257 ( $header, $detail );
2263 Pays this invoice with a compliemntary payment. If there is an error,
2264 returns the error, otherwise returns false.
2270 my $cust_pay = new FS::cust_pay ( {
2271 'invnum' => $self->invnum,
2272 'paid' => $self->owed,
2275 'payinfo' => $self->cust_main->payinfo,
2283 Attempts to pay this invoice with a credit card payment via a
2284 Business::OnlinePayment realtime gateway. See
2285 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2286 for supported processors.
2292 $self->realtime_bop( 'CC', @_ );
2297 Attempts to pay this invoice with an electronic check (ACH) payment via a
2298 Business::OnlinePayment realtime gateway. See
2299 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2300 for supported processors.
2306 $self->realtime_bop( 'ECHECK', @_ );
2311 Attempts to pay this invoice with phone bill (LEC) payment via a
2312 Business::OnlinePayment realtime gateway. See
2313 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2314 for supported processors.
2320 $self->realtime_bop( 'LEC', @_ );
2324 my( $self, $method ) = (shift,shift);
2325 my $conf = $self->conf;
2328 my $cust_main = $self->cust_main;
2329 my $balance = $cust_main->balance;
2330 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2331 $amount = sprintf("%.2f", $amount);
2332 return "not run (balance $balance)" unless $amount > 0;
2334 my $description = 'Internet Services';
2335 if ( $conf->exists('business-onlinepayment-description') ) {
2336 my $dtempl = $conf->config('business-onlinepayment-description');
2338 my $agent_obj = $cust_main->agent
2339 or die "can't retreive agent for $cust_main (agentnum ".
2340 $cust_main->agentnum. ")";
2341 my $agent = $agent_obj->agent;
2342 my $pkgs = join(', ',
2343 map { $_->part_pkg->pkg }
2344 grep { $_->pkgnum } $self->cust_bill_pkg
2346 $description = eval qq("$dtempl");
2349 $cust_main->realtime_bop($method, $amount,
2350 'description' => $description,
2351 'invnum' => $self->invnum,
2352 #this didn't do what we want, it just calls apply_payments_and_credits
2354 'apply_to_invoice' => 1,
2357 #this changes application behavior: auto payments
2358 #triggered against a specific invoice are now applied
2359 #to that invoice instead of oldest open.
2365 =item batch_card OPTION => VALUE...
2367 Adds a payment for this invoice to the pending credit card batch (see
2368 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2369 runs the payment using a realtime gateway.
2374 my ($self, %options) = @_;
2375 my $cust_main = $self->cust_main;
2377 $options{invnum} = $self->invnum;
2379 $cust_main->batch_card(%options);
2382 sub _agent_template {
2384 $self->cust_main->agent_template;
2387 sub _agent_invoice_from {
2389 $self->cust_main->agent_invoice_from;
2392 =item invoice_barcode DIR_OR_FALSE
2394 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2395 it is taken as the temp directory where the PNG file will be generated and the
2396 PNG file name is returned. Otherwise, the PNG image itself is returned.
2400 sub invoice_barcode {
2401 my ($self, $dir) = (shift,shift);
2403 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2404 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2405 my $gd = $gdbar->plot(Height => 30);
2408 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2412 ) or die "can't open temp file: $!\n";
2413 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2414 my $png_file = $bh->filename;
2421 =item invnum_date_pretty
2423 Returns a string with the invoice number and date, for example:
2424 "Invoice #54 (3/20/2008)".
2426 Intended for back-end context, with regard to translation and date formatting.
2430 #note: this uses _date_pretty_unlocalized because _date_pretty is too expensive
2431 # for backend use (and also does the wrong thing, localizing for end customer
2432 # instead of backoffice configured date format)
2433 sub invnum_date_pretty {
2435 #$self->mt('Invoice #').
2436 'Invoice #'. #XXX should be translated ala web UI user (not invoice customer)
2437 $self->invnum. ' ('. $self->_date_pretty_unlocalized. ')';
2440 #sub _items_extra_usage_sections {
2442 # my $escape = shift;
2444 # my %sections = ();
2446 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2447 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2449 # next unless $cust_bill_pkg->pkgnum > 0;
2451 # foreach my $section ( keys %usage_class ) {
2453 # my $usage = $cust_bill_pkg->usage($section);
2455 # next unless $usage && $usage > 0;
2457 # $sections{$section} ||= 0;
2458 # $sections{$section} += $usage;
2464 # map { { 'description' => &{$escape}($_),
2465 # 'subtotal' => $sections{$_},
2466 # 'summarized' => '',
2467 # 'tax_section' => '',
2470 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2474 sub _items_extra_usage_sections {
2476 my $conf = $self->conf;
2484 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2486 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2487 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2488 next unless $cust_bill_pkg->pkgnum > 0;
2490 foreach my $classnum ( keys %usage_class ) {
2491 my $section = $usage_class{$classnum}->classname;
2492 $classnums{$section} = $classnum;
2494 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2495 my $amount = $detail->amount;
2496 next unless $amount && $amount > 0;
2498 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2499 $sections{$section}{amount} += $amount; #subtotal
2500 $sections{$section}{calls}++;
2501 $sections{$section}{duration} += $detail->duration;
2503 my $desc = $detail->regionname;
2504 my $description = $desc;
2505 $description = substr($desc, 0, $maxlength). '...'
2506 if $format eq 'latex' && length($desc) > $maxlength;
2508 $lines{$section}{$desc} ||= {
2509 description => &{$escape}($description),
2510 #pkgpart => $part_pkg->pkgpart,
2511 pkgnum => $cust_bill_pkg->pkgnum,
2516 #unit_amount => $cust_bill_pkg->unitrecur,
2517 quantity => $cust_bill_pkg->quantity,
2518 product_code => 'N/A',
2519 ext_description => [],
2522 $lines{$section}{$desc}{amount} += $amount;
2523 $lines{$section}{$desc}{calls}++;
2524 $lines{$section}{$desc}{duration} += $detail->duration;
2530 my %sectionmap = ();
2531 foreach (keys %sections) {
2532 my $usage_class = $usage_class{$classnums{$_}};
2533 $sectionmap{$_} = { 'description' => &{$escape}($_),
2534 'amount' => $sections{$_}{amount}, #subtotal
2535 'calls' => $sections{$_}{calls},
2536 'duration' => $sections{$_}{duration},
2538 'tax_section' => '',
2539 'sort_weight' => $usage_class->weight,
2540 ( $usage_class->format
2541 ? ( map { $_ => $usage_class->$_($format) }
2542 qw( description_generator header_generator total_generator total_line_generator )
2549 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2553 foreach my $section ( keys %lines ) {
2554 foreach my $line ( keys %{$lines{$section}} ) {
2555 my $l = $lines{$section}{$line};
2556 $l->{section} = $sectionmap{$section};
2557 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2558 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2563 return(\@sections, \@lines);
2569 my $end = $self->_date;
2571 # start at date of previous invoice + 1 second or 0 if no previous invoice
2572 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2573 $start = 0 if !$start;
2576 my $cust_main = $self->cust_main;
2577 my @pkgs = $cust_main->all_pkgs;
2578 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2581 foreach my $pkg ( @pkgs ) {
2582 my @h_cust_svc = $pkg->h_cust_svc($end);
2583 foreach my $h_cust_svc ( @h_cust_svc ) {
2584 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2585 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2587 my $inserted = $h_cust_svc->date_inserted;
2588 my $deleted = $h_cust_svc->date_deleted;
2589 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2591 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2593 # DID either activated or ported in; cannot be both for same DID simultaneously
2594 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2595 && (!$phone_inserted->lnp_status
2596 || $phone_inserted->lnp_status eq ''
2597 || $phone_inserted->lnp_status eq 'native')) {
2600 else { # this one not so clean, should probably move to (h_)svc_phone
2601 my $phone_portedin = qsearchs( 'h_svc_phone',
2602 { 'svcnum' => $h_cust_svc->svcnum,
2603 'lnp_status' => 'portedin' },
2604 FS::h_svc_phone->sql_h_searchs($end),
2606 $num_portedin++ if $phone_portedin;
2609 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2610 if($deleted >= $start && $deleted <= $end && $phone_deleted
2611 && (!$phone_deleted->lnp_status
2612 || $phone_deleted->lnp_status ne 'portingout')) {
2615 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2616 && $phone_deleted->lnp_status
2617 && $phone_deleted->lnp_status eq 'portingout') {
2621 # increment usage minutes
2622 if ( $phone_inserted ) {
2623 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2624 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2627 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2630 # don't look at this service again
2631 push @seen, $h_cust_svc->svcnum;
2635 $minutes = sprintf("%d", $minutes);
2636 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2637 . "$num_deactivated Ported-Out: $num_portedout ",
2638 "Total Minutes: $minutes");
2641 sub _items_accountcode_cdr {
2646 my $section = { 'amount' => 0,
2649 'sort_weight' => '',
2651 'description' => 'Usage by Account Code',
2657 my %accountcodes = ();
2659 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2660 next unless $cust_bill_pkg->pkgnum > 0;
2662 my @header = $cust_bill_pkg->details_header;
2663 next unless scalar(@header);
2664 $section->{'header'} = join(',',@header);
2666 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2668 $section->{'header'} = $detail->formatted('format' => $format)
2669 if($detail->detail eq $section->{'header'});
2671 my $accountcode = $detail->accountcode;
2672 next unless $accountcode;
2674 my $amount = $detail->amount;
2675 next unless $amount && $amount > 0;
2677 $accountcodes{$accountcode} ||= {
2678 description => $accountcode,
2685 product_code => 'N/A',
2686 section => $section,
2687 ext_description => [ $section->{'header'} ],
2691 $section->{'amount'} += $amount;
2692 $accountcodes{$accountcode}{'amount'} += $amount;
2693 $accountcodes{$accountcode}{calls}++;
2694 $accountcodes{$accountcode}{duration} += $detail->duration;
2695 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2699 foreach my $l ( values %accountcodes ) {
2700 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2701 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2702 foreach my $sorted_detail ( @sorted_detail ) {
2703 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2705 delete $l->{detail_temp};
2709 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2711 return ($section,\@sorted_lines);
2714 sub _items_svc_phone_sections {
2716 my $conf = $self->conf;
2724 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2726 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2727 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2729 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2730 next unless $cust_bill_pkg->pkgnum > 0;
2732 my @header = $cust_bill_pkg->details_header;
2733 next unless scalar(@header);
2735 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2737 my $phonenum = $detail->phonenum;
2738 next unless $phonenum;
2740 my $amount = $detail->amount;
2741 next unless $amount && $amount > 0;
2743 $sections{$phonenum} ||= { 'amount' => 0,
2746 'sort_weight' => -1,
2747 'phonenum' => $phonenum,
2749 $sections{$phonenum}{amount} += $amount; #subtotal
2750 $sections{$phonenum}{calls}++;
2751 $sections{$phonenum}{duration} += $detail->duration;
2753 my $desc = $detail->regionname;
2754 my $description = $desc;
2755 $description = substr($desc, 0, $maxlength). '...'
2756 if $format eq 'latex' && length($desc) > $maxlength;
2758 $lines{$phonenum}{$desc} ||= {
2759 description => &{$escape}($description),
2760 #pkgpart => $part_pkg->pkgpart,
2768 product_code => 'N/A',
2769 ext_description => [],
2772 $lines{$phonenum}{$desc}{amount} += $amount;
2773 $lines{$phonenum}{$desc}{calls}++;
2774 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2776 my $line = $usage_class{$detail->classnum}->classname;
2777 $sections{"$phonenum $line"} ||=
2781 'sort_weight' => $usage_class{$detail->classnum}->weight,
2782 'phonenum' => $phonenum,
2783 'header' => [ @header ],
2785 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2786 $sections{"$phonenum $line"}{calls}++;
2787 $sections{"$phonenum $line"}{duration} += $detail->duration;
2789 $lines{"$phonenum $line"}{$desc} ||= {
2790 description => &{$escape}($description),
2791 #pkgpart => $part_pkg->pkgpart,
2799 product_code => 'N/A',
2800 ext_description => [],
2803 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2804 $lines{"$phonenum $line"}{$desc}{calls}++;
2805 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2806 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2807 $detail->formatted('format' => $format);
2812 my %sectionmap = ();
2813 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2814 foreach ( keys %sections ) {
2815 my @header = @{ $sections{$_}{header} || [] };
2817 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2818 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2819 my $usage_class = $summary ? $simple : $usage_simple;
2820 my $ending = $summary ? ' usage charges' : '';
2823 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2825 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2826 'amount' => $sections{$_}{amount}, #subtotal
2827 'calls' => $sections{$_}{calls},
2828 'duration' => $sections{$_}{duration},
2830 'tax_section' => '',
2831 'phonenum' => $sections{$_}{phonenum},
2832 'sort_weight' => $sections{$_}{sort_weight},
2833 'post_total' => $summary, #inspire pagebreak
2835 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2836 qw( description_generator
2839 total_line_generator
2846 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2847 $a->{sort_weight} <=> $b->{sort_weight}
2852 foreach my $section ( keys %lines ) {
2853 foreach my $line ( keys %{$lines{$section}} ) {
2854 my $l = $lines{$section}{$line};
2855 $l->{section} = $sectionmap{$section};
2856 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2857 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2862 if($conf->exists('phone_usage_class_summary')) {
2863 # this only works with Latex
2867 # after this, we'll have only two sections per DID:
2868 # Calls Summary and Calls Detail
2869 foreach my $section ( @sections ) {
2870 if($section->{'post_total'}) {
2871 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2872 $section->{'total_line_generator'} = sub { '' };
2873 $section->{'total_generator'} = sub { '' };
2874 $section->{'header_generator'} = sub { '' };
2875 $section->{'description_generator'} = '';
2876 push @newsections, $section;
2877 my %calls_detail = %$section;
2878 $calls_detail{'post_total'} = '';
2879 $calls_detail{'sort_weight'} = '';
2880 $calls_detail{'description_generator'} = sub { '' };
2881 $calls_detail{'header_generator'} = sub {
2882 return ' & Date/Time & Called Number & Duration & Price'
2883 if $format eq 'latex';
2886 $calls_detail{'description'} = 'Calls Detail: '
2887 . $section->{'phonenum'};
2888 push @newsections, \%calls_detail;
2892 # after this, each usage class is collapsed/summarized into a single
2893 # line under the Calls Summary section
2894 foreach my $newsection ( @newsections ) {
2895 if($newsection->{'post_total'}) { # this means Calls Summary
2896 foreach my $section ( @sections ) {
2897 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2898 && !$section->{'post_total'});
2899 my $newdesc = $section->{'description'};
2900 my $tn = $section->{'phonenum'};
2901 $newdesc =~ s/$tn//g;
2902 my $line = { ext_description => [],
2906 calls => $section->{'calls'},
2907 section => $newsection,
2908 duration => $section->{'duration'},
2909 description => $newdesc,
2910 amount => sprintf("%.2f",$section->{'amount'}),
2911 product_code => 'N/A',
2913 push @newlines, $line;
2918 # after this, Calls Details is populated with all CDRs
2919 foreach my $newsection ( @newsections ) {
2920 if(!$newsection->{'post_total'}) { # this means Calls Details
2921 foreach my $line ( @lines ) {
2922 next unless (scalar(@{$line->{'ext_description'}}) &&
2923 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2925 my @extdesc = @{$line->{'ext_description'}};
2927 foreach my $extdesc ( @extdesc ) {
2928 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2929 push @newextdesc, $extdesc;
2931 $line->{'ext_description'} = \@newextdesc;
2932 $line->{'section'} = $newsection;
2933 push @newlines, $line;
2938 return(\@newsections, \@newlines);
2941 return(\@sections, \@lines);
2945 =sub _items_usage_class_summary OPTIONS
2947 Returns a list of detail items summarizing the usage charges on this
2948 invoice. Each one will have 'amount', 'description' (the usage charge name),
2949 and 'usage_classnum'.
2951 OPTIONS can include 'escape' (a function to escape the descriptions).
2955 sub _items_usage_class_summary {
2959 my $escape = $opt{escape} || sub { $_[0] };
2960 my $invnum = $self->invnum;
2961 my @classes = qsearch({
2962 'table' => 'usage_class',
2963 'select' => 'classnum, classname, SUM(amount) AS amount',
2964 'addl_from' => ' LEFT JOIN cust_bill_pkg_detail USING (classnum)' .
2965 ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
2966 'extra_sql' => " WHERE cust_bill_pkg.invnum = $invnum".
2967 ' GROUP BY classnum, classname, weight'.
2968 ' HAVING (usage_class.disabled IS NULL OR SUM(amount) > 0)'.
2969 ' ORDER BY weight ASC',
2973 description => &{$escape}($self->mt('Usage Summary')),
2977 foreach my $class (@classes) {
2979 'description' => &{$escape}($class->classname),
2980 'amount' => sprintf('%.2f', $class->amount),
2981 'usage_classnum' => $class->classnum,
2982 'section' => $section,
2988 sub _items_previous {
2990 my $conf = $self->conf;
2991 my $cust_main = $self->cust_main;
2992 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2994 foreach ( @pr_cust_bill ) {
2995 my $date = $conf->exists('invoice_show_prior_due_date')
2996 ? 'due '. $_->due_date2str('short')
2997 : $self->time2str_local('short', $_->_date);
2999 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
3000 #'pkgpart' => 'N/A',
3002 'amount' => sprintf("%.2f", $_->owed),
3008 # 'description' => 'Previous Balance',
3009 # #'pkgpart' => 'N/A',
3010 # 'pkgnum' => 'N/A',
3011 # 'amount' => sprintf("%10.2f", $pr_total ),
3012 # 'ext_description' => [ map {
3013 # "Invoice ". $_->invnum.
3014 # " (". time2str("%x",$_->_date). ") ".
3015 # sprintf("%10.2f", $_->owed)
3016 # } @pr_cust_bill ],
3021 sub _items_credits {
3022 my( $self, %opt ) = @_;
3023 my $trim_len = $opt{'trim_len'} || 60;
3028 if ( $self->conf->exists('previous_balance-payments_since') ) {
3029 if ( $opt{'template'} eq 'statement' ) {
3030 # then the current bill is a "statement" (i.e. an invoice sent as
3031 # a payment receipt)
3032 # and in that case we want to see payments on or after THIS invoice
3033 @objects = qsearch('cust_credit', {
3034 'custnum' => $self->custnum,
3035 '_date' => {op => '>=', value => $self->_date},
3039 $date = $self->previous_bill->_date if $self->previous_bill;
3040 @objects = qsearch('cust_credit', {
3041 'custnum' => $self->custnum,
3042 '_date' => {op => '>=', value => $date},
3046 @objects = $self->cust_credited;
3049 foreach my $obj ( @objects ) {
3050 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
3052 my $reason = substr($cust_credit->reason, 0, $trim_len);
3053 $reason .= '...' if length($reason) < length($cust_credit->reason);
3054 $reason = " ($reason) " if $reason;
3057 #'description' => 'Credit ref\#'. $_->crednum.
3058 # " (". time2str("%x",$_->cust_credit->_date) .")".
3060 'description' => $self->mt('Credit applied').' '.
3061 $self->time2str_local('short', $obj->_date). $reason,
3062 'amount' => sprintf("%.2f",$obj->amount),
3070 sub _items_payments {
3075 my $detailed = $self->conf->exists('invoice_payment_details');
3077 if ( $self->conf->exists('previous_balance-payments_since') ) {
3078 # then show payments dated on/after the previous bill...
3079 if ( $opt{'template'} eq 'statement' ) {
3080 # then the current bill is a "statement" (i.e. an invoice sent as
3081 # a payment receipt)
3082 # and in that case we want to see payments on or after THIS invoice
3083 @objects = qsearch('cust_pay', {
3084 'custnum' => $self->custnum,
3085 '_date' => {op => '>=', value => $self->_date},
3088 # the normal case: payments on or after the previous invoice
3090 $date = $self->previous_bill->_date if $self->previous_bill;
3091 @objects = qsearch('cust_pay', {
3092 'custnum' => $self->custnum,
3093 '_date' => {op => '>=', value => $date},
3095 # and before the current bill...
3096 @objects = grep { $_->_date < $self->_date } @objects;
3099 @objects = $self->cust_bill_pay;
3102 foreach my $obj (@objects) {
3103 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
3104 my $desc = $self->mt('Payment received').' '.
3105 $self->time2str_local('short', $cust_pay->_date );
3106 $desc .= $self->mt(' via ') .
3107 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
3111 'description' => $desc,
3112 'amount' => sprintf("%.2f", $obj->amount )
3120 =item call_details [ OPTION => VALUE ... ]
3122 Returns an array of CSV strings representing the call details for this invoice
3123 The only option available is the boolean prepend_billed_number
3128 my ($self, %opt) = @_;
3130 my $format_function = sub { shift };
3132 if ($opt{prepend_billed_number}) {
3133 $format_function = sub {
3137 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3142 my @details = map { $_->details( 'format_function' => $format_function,
3143 'escape_function' => sub{ return() },
3147 $self->cust_bill_pkg;
3148 my $header = $details[0];
3149 ( $header, grep { $_ ne $header } @details );
3159 =item process_reprint
3163 sub process_reprint {
3164 process_re_X('print', @_);
3167 =item process_reemail
3171 sub process_reemail {
3172 process_re_X('email', @_);
3180 process_re_X('fax', @_);
3188 process_re_X('ftp', @_);
3195 sub process_respool {
3196 process_re_X('spool', @_);
3201 my( $method, $job ) = ( shift, shift );
3202 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3205 warn Dumper($param) if $DEBUG;
3216 # spool_invoice ftp_invoice fax_invoice print_invoice
3217 my($method, $job, %param ) = @_;
3219 warn "re_X $method for job $job with param:\n".
3220 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3223 #some false laziness w/search/cust_bill.html
3225 my $orderby = 'ORDER BY cust_bill._date';
3227 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3229 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3231 my @cust_bill = qsearch( {
3232 #'select' => "cust_bill.*",
3233 'table' => 'cust_bill',
3234 'addl_from' => $addl_from,
3236 'extra_sql' => $extra_sql,
3237 'order_by' => $orderby,
3241 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3243 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3246 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3247 foreach my $cust_bill ( @cust_bill ) {
3248 $cust_bill->$method();
3250 if ( $job ) { #progressbar foo
3252 if ( time - $min_sec > $last ) {
3253 my $error = $job->update_statustext(
3254 int( 100 * $num / scalar(@cust_bill) )
3256 die $error if $error;
3267 +{ ( map { $_=>$self->$_ } $self->fields ),
3268 'owed' => $self->owed,
3269 #XXX last payment applied date
3275 =head1 CLASS METHODS
3281 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3286 my ($class, $start, $end) = @_;
3288 $class->paid_sql($start, $end). ' - '.
3289 $class->credited_sql($start, $end);
3294 Returns an SQL fragment to retreive the net amount (charged minus credited).
3299 my ($class, $start, $end) = @_;
3300 'charged - '. $class->credited_sql($start, $end);
3305 Returns an SQL fragment to retreive the amount paid against this invoice.
3310 my ($class, $start, $end) = @_;
3311 $start &&= "AND cust_bill_pay._date <= $start";
3312 $end &&= "AND cust_bill_pay._date > $end";
3313 $start = '' unless defined($start);
3314 $end = '' unless defined($end);
3315 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3316 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3321 Returns an SQL fragment to retreive the amount credited against this invoice.
3326 my ($class, $start, $end) = @_;
3327 $start &&= "AND cust_credit_bill._date <= $start";
3328 $end &&= "AND cust_credit_bill._date > $end";
3329 $start = '' unless defined($start);
3330 $end = '' unless defined($end);
3331 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3332 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3337 Returns an SQL fragment to retrieve the due date of an invoice.
3338 Currently only supported on PostgreSQL.
3343 die "don't use: doesn't account for agent-specific invoice_default_terms";
3345 #we're passed a $conf but not a specific customer (that's in the query), so
3346 # to make this work we'd need an agentnum-aware "condition_sql_conf" like
3347 # "condition_sql_option" that retreives a conf value with SQL in an agent-
3350 my $conf = new FS::Conf;
3354 cust_bill.invoice_terms,
3355 cust_main.invoice_terms,
3356 \''.($conf->config('invoice_default_terms') || '').'\'
3357 ), E\'Net (\\\\d+)\'
3359 ) * 86400 + cust_bill._date'
3370 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3371 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base