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.
632 =item cust_suspend_if_balance_over AMOUNT
634 Suspends the customer associated with this invoice if the total amount owed on
635 this invoice and all older invoices is greater than the specified amount.
637 Returns a list: an empty list on success or a list of errors.
641 sub cust_suspend_if_balance_over {
642 my( $self, $amount ) = ( shift, shift );
643 my $cust_main = $self->cust_main;
644 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
647 $cust_main->suspend(@_);
653 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
659 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
660 sort { $a->_date <=> $b->_date }
661 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
666 =item cust_credit_bill
668 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
674 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
675 sort { $a->_date <=> $b->_date }
676 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
680 sub cust_credit_bill {
681 shift->cust_credited(@_);
684 #=item cust_bill_pay_pkgnum PKGNUM
686 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
687 #with matching pkgnum.
691 #sub cust_bill_pay_pkgnum {
692 # my( $self, $pkgnum ) = @_;
693 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
694 # sort { $a->_date <=> $b->_date }
695 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
696 # 'pkgnum' => $pkgnum,
701 =item cust_bill_pay_pkg PKGNUM
703 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
704 applied against the matching pkgnum.
708 sub cust_bill_pay_pkg {
709 my( $self, $pkgnum ) = @_;
712 'select' => 'cust_bill_pay_pkg.*',
713 'table' => 'cust_bill_pay_pkg',
714 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
715 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
716 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
717 " AND cust_bill_pkg.pkgnum = $pkgnum",
722 #=item cust_credited_pkgnum PKGNUM
724 #=item cust_credit_bill_pkgnum PKGNUM
726 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
727 #with matching pkgnum.
731 #sub cust_credited_pkgnum {
732 # my( $self, $pkgnum ) = @_;
733 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
734 # sort { $a->_date <=> $b->_date }
735 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
736 # 'pkgnum' => $pkgnum,
741 #sub cust_credit_bill_pkgnum {
742 # shift->cust_credited_pkgnum(@_);
745 =item cust_credit_bill_pkg PKGNUM
747 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
748 applied against the matching pkgnum.
752 sub cust_credit_bill_pkg {
753 my( $self, $pkgnum ) = @_;
756 'select' => 'cust_credit_bill_pkg.*',
757 'table' => 'cust_credit_bill_pkg',
758 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
759 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
760 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
761 " AND cust_bill_pkg.pkgnum = $pkgnum",
766 =item cust_bill_batch
768 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
772 sub cust_bill_batch {
774 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
779 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
780 hash keyed by term length.
786 FS::discount_plan->all($self);
791 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
798 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
800 foreach (@taxlines) { $total += $_->setup; }
806 Returns the amount owed (still outstanding) on this invoice, which is charged
807 minus all payment applications (see L<FS::cust_bill_pay>) and credit
808 applications (see L<FS::cust_credit_bill>).
814 my $balance = $self->charged;
815 $balance -= $_->amount foreach ( $self->cust_bill_pay );
816 $balance -= $_->amount foreach ( $self->cust_credited );
817 $balance = sprintf( "%.2f", $balance);
818 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
823 my( $self, $pkgnum ) = @_;
825 #my $balance = $self->charged;
827 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
829 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
830 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
832 $balance = sprintf( "%.2f", $balance);
833 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
839 Returns true if this invoice should be hidden. See the
840 selfservice-hide_invoices-taxclass configuraiton setting.
846 my $conf = $self->conf;
847 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
849 my @cust_bill_pkg = $self->cust_bill_pkg;
850 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
851 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
854 =item apply_payments_and_credits [ OPTION => VALUE ... ]
856 Applies unapplied payments and credits to this invoice.
858 A hash of optional arguments may be passed. Currently "manual" is supported.
859 If true, a payment receipt is sent instead of a statement when
860 'payment_receipt_email' configuration option is set.
862 If there is an error, returns the error, otherwise returns false.
866 sub apply_payments_and_credits {
867 my( $self, %options ) = @_;
868 my $conf = $self->conf;
870 local $SIG{HUP} = 'IGNORE';
871 local $SIG{INT} = 'IGNORE';
872 local $SIG{QUIT} = 'IGNORE';
873 local $SIG{TERM} = 'IGNORE';
874 local $SIG{TSTP} = 'IGNORE';
875 local $SIG{PIPE} = 'IGNORE';
877 my $oldAutoCommit = $FS::UID::AutoCommit;
878 local $FS::UID::AutoCommit = 0;
881 $self->select_for_update; #mutex
883 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
884 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
886 if ( $conf->exists('pkg-balances') ) {
887 # limit @payments & @credits to those w/ a pkgnum grepped from $self
888 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
889 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
890 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
893 while ( $self->owed > 0 and ( @payments || @credits ) ) {
896 if ( @payments && @credits ) {
898 #decide which goes first by weight of top (unapplied) line item
900 my @open_lineitems = $self->open_cust_bill_pkg;
903 max( map { $_->part_pkg->pay_weight || 0 }
908 my $max_credit_weight =
909 max( map { $_->part_pkg->credit_weight || 0 }
915 #if both are the same... payments first? it has to be something
916 if ( $max_pay_weight >= $max_credit_weight ) {
922 } elsif ( @payments ) {
924 } elsif ( @credits ) {
927 die "guru meditation #12 and 35";
931 if ( $app eq 'pay' ) {
933 my $payment = shift @payments;
934 $unapp_amount = $payment->unapplied;
935 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
936 $app->pkgnum( $payment->pkgnum )
937 if $conf->exists('pkg-balances') && $payment->pkgnum;
939 } elsif ( $app eq 'credit' ) {
941 my $credit = shift @credits;
942 $unapp_amount = $credit->credited;
943 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
944 $app->pkgnum( $credit->pkgnum )
945 if $conf->exists('pkg-balances') && $credit->pkgnum;
948 die "guru meditation #12 and 35";
952 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
953 warn "owed_pkgnum ". $app->pkgnum;
954 $owed = $self->owed_pkgnum($app->pkgnum);
958 next unless $owed > 0;
960 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
961 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
963 $app->invnum( $self->invnum );
965 my $error = $app->insert(%options);
967 $dbh->rollback if $oldAutoCommit;
968 return "Error inserting ". $app->table. " record: $error";
970 die $error if $error;
974 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
979 =item generate_email OPTION => VALUE ...
987 sender address, required
991 alternate template name, optional
995 text attachment arrayref, optional
999 email subject, optional
1003 notice name instead of "Invoice", optional
1007 Returns an argument list to be passed to L<FS::Misc::send_email>.
1013 sub generate_email {
1017 my $conf = $self->conf;
1019 my $me = '[FS::cust_bill::generate_email]';
1022 'from' => $args{'from'},
1023 'subject' => ($args{'subject'} || $self->email_subject),
1024 'custnum' => $self->custnum,
1025 'msgtype' => 'invoice',
1028 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
1030 my $cust_main = $self->cust_main;
1032 if (ref($args{'to'}) eq 'ARRAY') {
1033 $return{'to'} = $args{'to'};
1035 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1036 $cust_main->invoicing_list
1040 if ( $conf->exists('invoice_html') ) {
1042 warn "$me creating HTML/text multipart message"
1045 $return{'nobody'} = 1;
1047 my $alternative = build MIME::Entity
1048 'Type' => 'multipart/alternative',
1049 #'Encoding' => '7bit',
1050 'Disposition' => 'inline'
1054 if ( $conf->exists('invoice_email_pdf')
1055 and scalar($conf->config('invoice_email_pdf_note')) ) {
1057 warn "$me using 'invoice_email_pdf_note' in multipart message"
1059 $data = [ map { $_ . "\n" }
1060 $conf->config('invoice_email_pdf_note')
1065 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1067 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1068 $data = $args{'print_text'};
1070 $data = [ $self->print_text(\%args) ];
1075 $alternative->attach(
1076 'Type' => 'text/plain',
1077 'Encoding' => 'quoted-printable',
1078 'Charset' => 'UTF-8',
1079 #'Encoding' => '7bit',
1081 'Disposition' => 'inline',
1088 if ( $conf->exists('invoice_email_pdf')
1089 and scalar($conf->config('invoice_email_pdf_note')) ) {
1091 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1095 $args{'from'} =~ /\@([\w\.\-]+)/;
1096 my $from = $1 || 'example.com';
1097 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1100 my $agentnum = $cust_main->agentnum;
1101 if ( defined($args{'template'}) && length($args{'template'})
1102 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1105 $logo = 'logo_'. $args{'template'}. '.png';
1109 my $image_data = $conf->config_binary( $logo, $agentnum);
1111 $image = build MIME::Entity
1112 'Type' => 'image/png',
1113 'Encoding' => 'base64',
1114 'Data' => $image_data,
1115 'Filename' => 'logo.png',
1116 'Content-ID' => "<$content_id>",
1119 if ($conf->exists('invoice-barcode')) {
1120 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1121 $barcode = build MIME::Entity
1122 'Type' => 'image/png',
1123 'Encoding' => 'base64',
1124 'Data' => $self->invoice_barcode(0),
1125 'Filename' => 'barcode.png',
1126 'Content-ID' => "<$barcode_content_id>",
1128 $args{'barcode_cid'} = $barcode_content_id;
1131 $htmldata = $self->print_html({ 'cid'=>$content_id, %args });
1134 $alternative->attach(
1135 'Type' => 'text/html',
1136 'Encoding' => 'quoted-printable',
1137 'Data' => [ '<html>',
1140 ' '. encode_entities($return{'subject'}),
1143 ' <body bgcolor="#e8e8e8">',
1148 'Disposition' => 'inline',
1149 #'Filename' => 'invoice.pdf',
1153 my @otherparts = ();
1154 if ( $cust_main->email_csv_cdr ) {
1156 push @otherparts, build MIME::Entity
1157 'Type' => 'text/csv',
1158 'Encoding' => '7bit',
1159 'Data' => [ map { "$_\n" }
1160 $self->call_details('prepend_billed_number' => 1)
1162 'Disposition' => 'attachment',
1163 'Filename' => 'usage-'. $self->invnum. '.csv',
1168 if ( $conf->exists('invoice_email_pdf') ) {
1173 # multipart/alternative
1179 my $related = build MIME::Entity 'Type' => 'multipart/related',
1180 'Encoding' => '7bit';
1182 #false laziness w/Misc::send_email
1183 $related->head->replace('Content-type',
1184 $related->mime_type.
1185 '; boundary="'. $related->head->multipart_boundary. '"'.
1186 '; type=multipart/alternative'
1189 $related->add_part($alternative);
1191 $related->add_part($image) if $image;
1193 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
1195 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1199 #no other attachment:
1201 # multipart/alternative
1206 $return{'content-type'} = 'multipart/related';
1207 if ($conf->exists('invoice-barcode') && $barcode) {
1208 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1210 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1212 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1213 #$return{'disposition'} = 'inline';
1219 if ( $conf->exists('invoice_email_pdf') ) {
1220 warn "$me creating PDF attachment"
1223 #mime parts arguments a la MIME::Entity->build().
1224 $return{'mimeparts'} = [
1225 { $self->mimebuild_pdf(\%args) }
1229 if ( $conf->exists('invoice_email_pdf')
1230 and scalar($conf->config('invoice_email_pdf_note')) ) {
1232 warn "$me using 'invoice_email_pdf_note'"
1234 $return{'body'} = [ map { $_ . "\n" }
1235 $conf->config('invoice_email_pdf_note')
1240 warn "$me not using 'invoice_email_pdf_note'"
1242 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1243 $return{'body'} = $args{'print_text'};
1245 $return{'body'} = [ $self->print_text(\%args) ];
1258 Returns a list suitable for passing to MIME::Entity->build(), representing
1259 this invoice as PDF attachment.
1266 'Type' => 'application/pdf',
1267 'Encoding' => 'base64',
1268 'Data' => [ $self->print_pdf(@_) ],
1269 'Disposition' => 'attachment',
1270 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1276 Sends this invoice to the destinations configured for this customer: sends
1277 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1279 Options can be passed as a hashref. Positional parameters are no longer
1282 I<template>: a suffix for alternate invoices
1284 I<agentnum>: obsolete, now does nothing.
1286 I<invoice_from> overrides the default email invoice From: address.
1288 I<amount>: obsolete, does nothing
1290 I<notice_name> overrides "Invoice" as the name of the sent document
1291 (templates from 10/2009 or newer required).
1293 I<lpr> overrides the system 'lpr' option as the command to print a document
1294 from standard input.
1300 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1301 my $conf = $self->conf;
1303 my $cust_main = $self->cust_main;
1305 my @invoicing_list = $cust_main->invoicing_list;
1308 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1309 && ! $self->invoice_noemail;
1312 if grep { $_ eq 'POST' } @invoicing_list; #postal
1314 #this has never been used post-$ORIGINAL_ISP afaik
1315 $self->fax_invoice($opt)
1316 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1322 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1324 Sends this invoice to the customer's email destination(s).
1326 Options must be passed as a hashref. Positional parameters are no longer
1329 I<template>, if specified, is the name of a suffix for alternate invoices.
1331 I<invoice_from>, if specified, overrides the default email invoice From:
1334 I<notice_name> is the name of the sent document.
1338 sub queueable_email {
1341 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1342 or die "invalid invoice number: " . $opt{invnum};
1344 my %args = map {$_ => $opt{$_}}
1346 qw( invoice_from notice_name no_coupon template );
1348 my $error = $self->email( \%args );
1349 die $error if $error;
1355 return if $self->hide;
1356 my $conf = $self->conf;
1357 my $opt = shift || {};
1358 if ($opt and !ref($opt)) {
1359 die "FS::cust_bill::email called with positional parameters";
1362 my $template = $opt->{template};
1363 my $from = delete $opt->{invoice_from};
1365 # this is where we set the From: address
1366 $from ||= $self->_agent_invoice_from || #XXX should go away
1367 $conf->config('invoice_from', $self->cust_main->agentnum );
1369 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1370 $self->cust_main->invoicing_list;
1372 if ( ! @invoicing_list ) { #no recipients
1373 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1374 die 'No recipients for customer #'. $self->custnum;
1376 #default: better to notify this person than silence
1377 @invoicing_list = ($from);
1381 # this is where we set the Subject:
1382 my $subject = $self->email_subject($template);
1384 my $error = send_email(
1385 $self->generate_email(
1387 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1388 'subject' => $subject,
1389 %$opt, # template, etc.
1392 die "can't email invoice: $error\n" if $error;
1393 #die "$error\n" if $error;
1399 my $conf = $self->conf;
1401 #my $template = scalar(@_) ? shift : '';
1404 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1407 my $cust_main = $self->cust_main;
1408 my $name = $cust_main->name;
1409 my $name_short = $cust_main->name_short;
1410 my $invoice_number = $self->invnum;
1411 my $invoice_date = $self->_date_pretty;
1413 eval qq("$subject");
1416 =item lpr_data HASHREF
1418 Returns the postscript or plaintext for this invoice as an arrayref.
1420 Options must be passed as a hashref. Positional parameters are no longer
1423 I<template>, if specified, is the name of a suffix for alternate invoices.
1425 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1431 my $conf = $self->conf;
1432 my $opt = shift || {};
1433 if ($opt and !ref($opt)) {
1434 # nobody does this anyway
1435 die "FS::cust_bill::lpr_data called with positional parameters";
1438 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1439 [ $self->$method( $opt ) ];
1444 Prints this invoice.
1446 Options must be passed as a hashref.
1448 I<template>, if specified, is the name of a suffix for alternate invoices.
1450 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1456 return if $self->hide;
1457 my $conf = $self->conf;
1458 my $opt = shift || {};
1459 if ($opt and !ref($opt)) {
1460 die "FS::cust_bill::print called with positional parameters";
1463 my $lpr = delete $opt->{lpr};
1464 if($conf->exists('invoice_print_pdf')) {
1465 # Add the invoice to the current batch.
1466 $self->batch_invoice($opt);
1470 $self->lpr_data($opt),
1471 'agentnum' => $self->cust_main->agentnum,
1477 =item fax_invoice HASHREF
1481 Options must be passed as a hashref.
1483 I<template>, if specified, is the name of a suffix for alternate invoices.
1485 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1491 return if $self->hide;
1492 my $conf = $self->conf;
1493 my $opt = shift || {};
1494 if ($opt and !ref($opt)) {
1495 die "FS::cust_bill::fax_invoice called with positional parameters";
1498 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1499 unless $conf->exists('invoice_latex');
1501 my $dialstring = $self->cust_main->getfield('fax');
1504 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1505 'dialstring' => $dialstring,
1507 die $error if $error;
1511 =item batch_invoice [ HASHREF ]
1513 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1514 isn't an open batch, one will be created.
1516 HASHREF may contain any options to be passed to C<print_pdf>.
1521 my ($self, $opt) = @_;
1522 my $bill_batch = $self->get_open_bill_batch;
1523 my $cust_bill_batch = FS::cust_bill_batch->new({
1524 batchnum => $bill_batch->batchnum,
1525 invnum => $self->invnum,
1527 return $cust_bill_batch->insert($opt);
1530 =item get_open_batch
1532 Returns the currently open batch as an FS::bill_batch object, creating a new
1533 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1538 sub get_open_bill_batch {
1540 my $conf = $self->conf;
1541 my $hashref = { status => 'O' };
1542 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1543 ? $self->cust_main->agentnum
1545 my $batch = qsearchs('bill_batch', $hashref);
1546 return $batch if $batch;
1547 $batch = FS::bill_batch->new($hashref);
1548 my $error = $batch->insert;
1549 die $error if $error;
1553 =item ftp_invoice [ TEMPLATENAME ]
1555 Sends this invoice data via FTP.
1557 TEMPLATENAME is unused?
1563 my $conf = $self->conf;
1564 my $template = scalar(@_) ? shift : '';
1567 'protocol' => 'ftp',
1568 'server' => $conf->config('cust_bill-ftpserver'),
1569 'username' => $conf->config('cust_bill-ftpusername'),
1570 'password' => $conf->config('cust_bill-ftppassword'),
1571 'dir' => $conf->config('cust_bill-ftpdir'),
1572 'format' => $conf->config('cust_bill-ftpformat'),
1576 =item spool_invoice [ TEMPLATENAME ]
1578 Spools this invoice data (see L<FS::spool_csv>)
1580 TEMPLATENAME is unused?
1586 my $conf = $self->conf;
1587 my $template = scalar(@_) ? shift : '';
1590 'format' => $conf->config('cust_bill-spoolformat'),
1591 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1595 =item send_csv OPTION => VALUE, ...
1597 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1601 protocol - currently only "ftp"
1607 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1608 and YYMMDDHHMMSS is a timestamp.
1610 See L</print_csv> for a description of the output format.
1615 my($self, %opt) = @_;
1619 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1620 mkdir $spooldir, 0700 unless -d $spooldir;
1622 # don't localize dates here, they're a defined format
1623 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1624 my $file = "$spooldir/$tracctnum.csv";
1626 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1628 open(CSV, ">$file") or die "can't open $file: $!";
1636 if ( $opt{protocol} eq 'ftp' ) {
1637 eval "use Net::FTP;";
1639 $net = Net::FTP->new($opt{server}) or die @$;
1641 die "unknown protocol: $opt{protocol}";
1644 $net->login( $opt{username}, $opt{password} )
1645 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1647 $net->binary or die "can't set binary mode";
1649 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1651 $net->put($file) or die "can't put $file: $!";
1661 Spools CSV invoice data.
1667 =item format - any of FS::Misc::::Invoicing::spool_formats
1669 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1670 customer has the corresponding invoice destinations set (see
1671 L<FS::cust_main_invoice>).
1673 =item agent_spools - if set to a true value, will spool to per-agent files
1674 rather than a single global file
1676 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1677 append to that spool. L<FS::Cron::upload> will then send the spool file to
1680 =item balanceover - if set, only spools the invoice if the total amount owed on
1681 this invoice and all older invoices is greater than the specified amount.
1683 =item time - the "current time". Controls the printing of past due messages
1691 my($self, %opt) = @_;
1693 my $time = $opt{'time'} || time;
1694 my $cust_main = $self->cust_main;
1696 if ( $opt{'dest'} ) {
1697 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1698 $cust_main->invoicing_list;
1699 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1700 || ! keys %invoicing_list;
1703 if ( $opt{'balanceover'} ) {
1705 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1708 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1709 mkdir $spooldir, 0700 unless -d $spooldir;
1711 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1714 if ( $opt{'agent_spools'} ) {
1715 $file = 'agentnum'.$cust_main->agentnum;
1720 if ( $opt{'upload_targetnum'} ) {
1721 $spooldir .= '/target'.$opt{'upload_targetnum'};
1722 mkdir $spooldir, 0700 unless -d $spooldir;
1723 } # otherwise it just goes into export.xxx/cust_bill
1725 if ( lc($opt{'format'}) eq 'billco' ) {
1729 $file = "$spooldir/$file.csv";
1731 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1733 open(CSV, ">>$file") or die "can't open $file: $!";
1734 flock(CSV, LOCK_EX);
1739 if ( lc($opt{'format'}) eq 'billco' ) {
1741 flock(CSV, LOCK_UN);
1744 $file =~ s/-header.csv$/-detail.csv/;
1746 open(CSV,">>$file") or die "can't open $file: $!";
1747 flock(CSV, LOCK_EX);
1751 print CSV $detail if defined($detail);
1753 flock(CSV, LOCK_UN);
1760 =item print_csv OPTION => VALUE, ...
1762 Returns CSV data for this invoice.
1766 format - 'default', 'billco', 'oneline', 'bridgestone'
1768 Returns a list consisting of two scalars. The first is a single line of CSV
1769 header information for this invoice. The second is one or more lines of CSV
1770 detail information for this invoice.
1772 If I<format> is not specified or "default", the fields of the CSV file are as
1775 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1776 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1780 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1782 B<record_type> is C<cust_bill> for the initial header line only. The
1783 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1784 fields are filled in.
1786 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1787 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1790 =item invnum - invoice number
1792 =item custnum - customer number
1794 =item _date - invoice date
1796 =item charged - total invoice amount
1798 =item first - customer first name
1800 =item last - customer first name
1802 =item company - company name
1804 =item address1 - address line 1
1806 =item address2 - address line 1
1816 =item pkg - line item description
1818 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1820 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1822 =item sdate - start date for recurring fee
1824 =item edate - end date for recurring fee
1828 If I<format> is "billco", the fields of the header CSV file are as follows:
1830 +-------------------------------------------------------------------+
1831 | FORMAT HEADER FILE |
1832 |-------------------------------------------------------------------|
1833 | Field | Description | Name | Type | Width |
1834 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1835 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1836 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1837 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1838 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1839 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1840 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1841 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1842 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1843 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1844 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1845 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1846 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1847 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1848 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1849 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1850 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1851 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1852 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1853 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1854 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1855 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1856 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1857 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1858 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1859 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1860 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1861 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1862 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1863 +-------+-------------------------------+------------+------+-------+
1865 If I<format> is "billco", the fields of the detail CSV file are as follows:
1867 FORMAT FOR DETAIL FILE
1869 Field | Description | Name | Type | Width
1870 1 | N/A-Leave Empty | RC | CHAR | 2
1871 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1872 3 | Account Number | TRACCTNUM | CHAR | 15
1873 4 | Invoice Number | TRINVOICE | CHAR | 15
1874 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1875 6 | Transaction Detail | DETAILS | CHAR | 100
1876 7 | Amount | AMT | NUM* | 9
1877 8 | Line Format Control** | LNCTRL | CHAR | 2
1878 9 | Grouping Code | GROUP | CHAR | 2
1879 10 | User Defined | ACCT CODE | CHAR | 15
1881 If format is 'oneline', there is no detail file. Each invoice has a
1882 header line only, with the fields:
1884 Agent number, agent name, customer number, first name, last name, address
1885 line 1, address line 2, city, state, zip, invoice date, invoice number,
1886 amount charged, amount due, previous balance, due date.
1888 and then, for each line item, three columns containing the package number,
1889 description, and amount.
1891 If format is 'bridgestone', there is no detail file. Each invoice has a
1892 header line with the following fields in a fixed-width format:
1894 Customer number (in display format), date, name (first last), company,
1895 address 1, address 2, city, state, zip.
1897 This is a mailing list format, and has no per-invoice fields. To avoid
1898 sending redundant notices, the spooling event should have a "once" or
1899 "once_percust_every" condition.
1904 my($self, %opt) = @_;
1906 eval "use Text::CSV_XS";
1909 my $cust_main = $self->cust_main;
1911 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1912 my $format = lc($opt{'format'});
1914 my $time = $opt{'time'} || time;
1916 my $tracctnum = ''; #leaking out from billco-specific sections :/
1917 if ( $format eq 'billco' ) {
1920 $self->conf->config('billco-account_num', $cust_main->agentnum);
1922 $tracctnum = $account_num eq 'display_custnum'
1923 ? $cust_main->display_custnum
1924 : $opt{'tracctnum'};
1927 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1929 my $duedate = $self->due_date2str('%m/%d/%Y'); # hardcoded, NOT date_format
1931 my( $previous_balance, @unused ) = $self->previous; #previous balance
1933 my $pmt_cr_applied = 0;
1934 $pmt_cr_applied += $_->{'amount'}
1935 foreach ( $self->_items_payments(%opt), $self->_items_credits(%opt) ) ;
1937 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1940 '', # 1 | N/A-Leave Empty CHAR 2
1941 '', # 2 | N/A-Leave Empty CHAR 15
1942 $tracctnum, # 3 | Transaction Account No CHAR 15
1943 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1944 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1945 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1946 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1947 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1948 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1949 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1950 '', # 10 | Ancillary Billing Information CHAR 30
1951 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1952 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1955 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1958 $duedate, # 14 | Bill Due Date CHAR 10
1960 $previous_balance, # 15 | Previous Balance NUM* 9
1961 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1962 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1963 $totaldue, # 18 | Total Amt Due NUM* 9
1964 $totaldue, # 19 | Total Amt Due NUM* 9
1965 '', # 20 | 30 Day Aging NUM* 9
1966 '', # 21 | 60 Day Aging NUM* 9
1967 '', # 22 | 90 Day Aging NUM* 9
1968 'N', # 23 | Y/N CHAR 1
1969 '', # 24 | Remittance automation CHAR 100
1970 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1971 $self->custnum, # 26 | Customer Reference Number CHAR 15
1972 '0', # 27 | Federal Tax*** NUM* 9
1973 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1974 '0', # 29 | Other Taxes & Fees*** NUM* 9
1977 } elsif ( $format eq 'oneline' ) { #name
1979 my ($previous_balance) = $self->previous;
1980 $previous_balance = sprintf('%.2f', $previous_balance);
1981 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1987 $self->_items_pkg, #_items_nontax? no sections or anything
1992 $cust_main->agentnum,
1993 $cust_main->agent->agent,
1997 $cust_main->company,
1998 $cust_main->address1,
1999 $cust_main->address2,
2005 time2str("%x", $self->_date),
2010 $self->due_date2str("%x"),
2015 } elsif ( $format eq 'bridgestone' ) {
2017 # bypass the CSV stuff and just return this
2018 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2019 my $zip = $cust_main->zip;
2021 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2025 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2027 $cust_main->display_custnum,
2029 uc(substr($cust_main->contact_firstlast,0,30)),
2030 uc(substr($cust_main->company ,0,30)),
2031 uc(substr($cust_main->address1 ,0,30)),
2032 uc(substr($cust_main->address2 ,0,30)),
2033 uc(substr($cust_main->city ,0,20)),
2034 uc($cust_main->state),
2040 } elsif ( $format eq 'ics' ) {
2042 my $bill = $cust_main->bill_location;
2043 my $zip = $bill->zip;
2047 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2052 # minor false laziness with print_generic
2053 my ($previous_balance) = $self->previous;
2054 my $balance_due = $self->owed + $previous_balance;
2055 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2056 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
2059 if ( $self->due_date and $time >= $self->due_date ) {
2060 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2064 my $header = sprintf(
2065 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2066 $cust_main->display_custnum, #BID
2067 uc($cust_main->first), #FNAME
2068 uc($cust_main->last), #LNAME
2069 '00', #BATCH, should this ever be anything else?
2070 uc($cust_main->company), #COMP
2071 uc($bill->address1), #STREET1
2072 uc($bill->address2), #STREET2
2073 uc($bill->city), #CITY
2074 uc($bill->state), #STATE
2077 time2str('%Y%m%d', $self->_date), #BILL_DATE
2078 $self->due_date2str('%Y%m%d'), #DUE_DATE,
2079 ( map {sprintf('%0.2f', $_)}
2080 $balance_due, #AMNT_DUE
2081 $previous_balance, #PREV_BAL
2082 $payment_total, #PYMT_RCVD
2083 $credit_total, #CREDITS
2084 $previous_balance, #BEG_BAL--is this correct?
2085 $self->charged, #NEW_CHRG
2088 $past_due, #PAST_MSG
2092 my %svc_class = ('' => ''); # maybe cache this more persistently?
2094 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2096 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2097 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2101 my @dates = ( $self->_date, undef );
2102 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2103 $dates[1] = $prev->sdate; #questionable
2106 # generate an 01 detail for each service
2107 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2108 foreach my $cust_svc ( @svcs ) {
2109 $show_pkgnum = ''; # hide it if we're showing svcnums
2111 my $svcpart = $cust_svc->svcpart;
2112 if (!exists($svc_class{$svcpart})) {
2113 my $classnum = $cust_svc->part_svc->classnum;
2114 my $part_svc_class = FS::part_svc_class->by_key($classnum)
2116 $svc_class{$svcpart} = $part_svc_class ?
2117 $part_svc_class->classname :
2121 my @h_label = $cust_svc->label(@dates, 'I');
2122 push @details, sprintf('01%-9s%-20s%-47s',
2124 $svc_class{$svcpart},
2127 } #foreach $cust_svc
2130 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2131 if ($cust_bill_pkg->recur > 0) {
2132 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2133 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2135 push @details, sprintf('02%-6s%-60s%-10s',
2138 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2140 } #foreach $cust_bill_pkg
2142 # Tag this row so that we know whether this is one page (1), two pages
2143 # (2), # or "big" (B). The tag will be stripped off before uploading.
2144 if ( scalar(@details) < 12 ) {
2146 } elsif ( scalar(@details) < 58 ) {
2152 return join('', $header, @details, "\n");
2160 time2str("%x", $self->_date),
2161 sprintf("%.2f", $self->charged),
2162 ( map { $cust_main->getfield($_) }
2163 qw( first last company address1 address2 city state zip country ) ),
2165 ) or die "can't create csv";
2168 my $header = $csv->string. "\n";
2171 if ( lc($opt{'format'}) eq 'billco' ) {
2174 foreach my $item ( $self->_items_pkg ) {
2177 '', # 1 | N/A-Leave Empty CHAR 2
2178 '', # 2 | N/A-Leave Empty CHAR 15
2179 $tracctnum, # 3 | Account Number CHAR 15
2180 $self->invnum, # 4 | Invoice Number CHAR 15
2181 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2182 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2183 $item->{'amount'}, # 7 | Amount NUM* 9
2184 '', # 8 | Line Format Control** CHAR 2
2185 '', # 9 | Grouping Code CHAR 2
2186 '', # 10 | User Defined CHAR 15
2189 $detail .= $csv->string. "\n";
2193 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2199 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2201 my($pkg, $setup, $recur, $sdate, $edate);
2202 if ( $cust_bill_pkg->pkgnum ) {
2204 ($pkg, $setup, $recur, $sdate, $edate) = (
2205 $cust_bill_pkg->part_pkg->pkg,
2206 ( $cust_bill_pkg->setup != 0
2207 ? sprintf("%.2f", $cust_bill_pkg->setup )
2209 ( $cust_bill_pkg->recur != 0
2210 ? sprintf("%.2f", $cust_bill_pkg->recur )
2212 ( $cust_bill_pkg->sdate
2213 ? time2str("%x", $cust_bill_pkg->sdate)
2215 ($cust_bill_pkg->edate
2216 ? time2str("%x", $cust_bill_pkg->edate)
2220 } else { #pkgnum tax
2221 next unless $cust_bill_pkg->setup != 0;
2222 $pkg = $cust_bill_pkg->desc;
2223 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2224 ( $sdate, $edate ) = ( '', '' );
2230 ( map { '' } (1..11) ),
2231 ($pkg, $setup, $recur, $sdate, $edate)
2232 ) or die "can't create csv";
2234 $detail .= $csv->string. "\n";
2240 ( $header, $detail );
2246 Pays this invoice with a compliemntary payment. If there is an error,
2247 returns the error, otherwise returns false.
2253 my $cust_pay = new FS::cust_pay ( {
2254 'invnum' => $self->invnum,
2255 'paid' => $self->owed,
2258 'payinfo' => $self->cust_main->payinfo,
2266 Attempts to pay this invoice with a credit card payment via a
2267 Business::OnlinePayment realtime gateway. See
2268 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2269 for supported processors.
2275 $self->realtime_bop( 'CC', @_ );
2280 Attempts to pay this invoice with an electronic check (ACH) payment via a
2281 Business::OnlinePayment realtime gateway. See
2282 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2283 for supported processors.
2289 $self->realtime_bop( 'ECHECK', @_ );
2294 Attempts to pay this invoice with phone bill (LEC) payment via a
2295 Business::OnlinePayment realtime gateway. See
2296 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2297 for supported processors.
2303 $self->realtime_bop( 'LEC', @_ );
2307 my( $self, $method ) = (shift,shift);
2308 my $conf = $self->conf;
2311 my $cust_main = $self->cust_main;
2312 my $balance = $cust_main->balance;
2313 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2314 $amount = sprintf("%.2f", $amount);
2315 return "not run (balance $balance)" unless $amount > 0;
2317 my $description = 'Internet Services';
2318 if ( $conf->exists('business-onlinepayment-description') ) {
2319 my $dtempl = $conf->config('business-onlinepayment-description');
2321 my $agent_obj = $cust_main->agent
2322 or die "can't retreive agent for $cust_main (agentnum ".
2323 $cust_main->agentnum. ")";
2324 my $agent = $agent_obj->agent;
2325 my $pkgs = join(', ',
2326 map { $_->part_pkg->pkg }
2327 grep { $_->pkgnum } $self->cust_bill_pkg
2329 $description = eval qq("$dtempl");
2332 $cust_main->realtime_bop($method, $amount,
2333 'description' => $description,
2334 'invnum' => $self->invnum,
2335 #this didn't do what we want, it just calls apply_payments_and_credits
2337 'apply_to_invoice' => 1,
2340 #this changes application behavior: auto payments
2341 #triggered against a specific invoice are now applied
2342 #to that invoice instead of oldest open.
2348 =item batch_card OPTION => VALUE...
2350 Adds a payment for this invoice to the pending credit card batch (see
2351 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2352 runs the payment using a realtime gateway.
2357 my ($self, %options) = @_;
2358 my $cust_main = $self->cust_main;
2360 $options{invnum} = $self->invnum;
2362 $cust_main->batch_card(%options);
2365 sub _agent_template {
2367 $self->cust_main->agent_template;
2370 sub _agent_invoice_from {
2372 $self->cust_main->agent_invoice_from;
2375 =item invoice_barcode DIR_OR_FALSE
2377 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2378 it is taken as the temp directory where the PNG file will be generated and the
2379 PNG file name is returned. Otherwise, the PNG image itself is returned.
2383 sub invoice_barcode {
2384 my ($self, $dir) = (shift,shift);
2386 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2387 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2388 my $gd = $gdbar->plot(Height => 30);
2391 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2395 ) or die "can't open temp file: $!\n";
2396 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2397 my $png_file = $bh->filename;
2404 =item invnum_date_pretty
2406 Returns a string with the invoice number and date, for example:
2407 "Invoice #54 (3/20/2008)".
2409 Intended for back-end context, with regard to translation and date formatting.
2413 #note: this uses _date_pretty_unlocalized because _date_pretty is too expensive
2414 # for backend use (and also does the wrong thing, localizing for end customer
2415 # instead of backoffice configured date format)
2416 sub invnum_date_pretty {
2418 #$self->mt('Invoice #').
2419 'Invoice #'. #XXX should be translated ala web UI user (not invoice customer)
2420 $self->invnum. ' ('. $self->_date_pretty_unlocalized. ')';
2423 #sub _items_extra_usage_sections {
2425 # my $escape = shift;
2427 # my %sections = ();
2429 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2430 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2432 # next unless $cust_bill_pkg->pkgnum > 0;
2434 # foreach my $section ( keys %usage_class ) {
2436 # my $usage = $cust_bill_pkg->usage($section);
2438 # next unless $usage && $usage > 0;
2440 # $sections{$section} ||= 0;
2441 # $sections{$section} += $usage;
2447 # map { { 'description' => &{$escape}($_),
2448 # 'subtotal' => $sections{$_},
2449 # 'summarized' => '',
2450 # 'tax_section' => '',
2453 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2457 sub _items_extra_usage_sections {
2459 my $conf = $self->conf;
2467 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2469 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2470 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2471 next unless $cust_bill_pkg->pkgnum > 0;
2473 foreach my $classnum ( keys %usage_class ) {
2474 my $section = $usage_class{$classnum}->classname;
2475 $classnums{$section} = $classnum;
2477 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2478 my $amount = $detail->amount;
2479 next unless $amount && $amount > 0;
2481 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2482 $sections{$section}{amount} += $amount; #subtotal
2483 $sections{$section}{calls}++;
2484 $sections{$section}{duration} += $detail->duration;
2486 my $desc = $detail->regionname;
2487 my $description = $desc;
2488 $description = substr($desc, 0, $maxlength). '...'
2489 if $format eq 'latex' && length($desc) > $maxlength;
2491 $lines{$section}{$desc} ||= {
2492 description => &{$escape}($description),
2493 #pkgpart => $part_pkg->pkgpart,
2494 pkgnum => $cust_bill_pkg->pkgnum,
2499 #unit_amount => $cust_bill_pkg->unitrecur,
2500 quantity => $cust_bill_pkg->quantity,
2501 product_code => 'N/A',
2502 ext_description => [],
2505 $lines{$section}{$desc}{amount} += $amount;
2506 $lines{$section}{$desc}{calls}++;
2507 $lines{$section}{$desc}{duration} += $detail->duration;
2513 my %sectionmap = ();
2514 foreach (keys %sections) {
2515 my $usage_class = $usage_class{$classnums{$_}};
2516 $sectionmap{$_} = { 'description' => &{$escape}($_),
2517 'amount' => $sections{$_}{amount}, #subtotal
2518 'calls' => $sections{$_}{calls},
2519 'duration' => $sections{$_}{duration},
2521 'tax_section' => '',
2522 'sort_weight' => $usage_class->weight,
2523 ( $usage_class->format
2524 ? ( map { $_ => $usage_class->$_($format) }
2525 qw( description_generator header_generator total_generator total_line_generator )
2532 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2536 foreach my $section ( keys %lines ) {
2537 foreach my $line ( keys %{$lines{$section}} ) {
2538 my $l = $lines{$section}{$line};
2539 $l->{section} = $sectionmap{$section};
2540 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2541 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2546 return(\@sections, \@lines);
2552 my $end = $self->_date;
2554 # start at date of previous invoice + 1 second or 0 if no previous invoice
2555 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2556 $start = 0 if !$start;
2559 my $cust_main = $self->cust_main;
2560 my @pkgs = $cust_main->all_pkgs;
2561 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2564 foreach my $pkg ( @pkgs ) {
2565 my @h_cust_svc = $pkg->h_cust_svc($end);
2566 foreach my $h_cust_svc ( @h_cust_svc ) {
2567 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2568 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2570 my $inserted = $h_cust_svc->date_inserted;
2571 my $deleted = $h_cust_svc->date_deleted;
2572 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2574 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2576 # DID either activated or ported in; cannot be both for same DID simultaneously
2577 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2578 && (!$phone_inserted->lnp_status
2579 || $phone_inserted->lnp_status eq ''
2580 || $phone_inserted->lnp_status eq 'native')) {
2583 else { # this one not so clean, should probably move to (h_)svc_phone
2584 my $phone_portedin = qsearchs( 'h_svc_phone',
2585 { 'svcnum' => $h_cust_svc->svcnum,
2586 'lnp_status' => 'portedin' },
2587 FS::h_svc_phone->sql_h_searchs($end),
2589 $num_portedin++ if $phone_portedin;
2592 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2593 if($deleted >= $start && $deleted <= $end && $phone_deleted
2594 && (!$phone_deleted->lnp_status
2595 || $phone_deleted->lnp_status ne 'portingout')) {
2598 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2599 && $phone_deleted->lnp_status
2600 && $phone_deleted->lnp_status eq 'portingout') {
2604 # increment usage minutes
2605 if ( $phone_inserted ) {
2606 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2607 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2610 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2613 # don't look at this service again
2614 push @seen, $h_cust_svc->svcnum;
2618 $minutes = sprintf("%d", $minutes);
2619 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2620 . "$num_deactivated Ported-Out: $num_portedout ",
2621 "Total Minutes: $minutes");
2624 sub _items_accountcode_cdr {
2629 my $section = { 'amount' => 0,
2632 'sort_weight' => '',
2634 'description' => 'Usage by Account Code',
2640 my %accountcodes = ();
2642 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2643 next unless $cust_bill_pkg->pkgnum > 0;
2645 my @header = $cust_bill_pkg->details_header;
2646 next unless scalar(@header);
2647 $section->{'header'} = join(',',@header);
2649 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2651 $section->{'header'} = $detail->formatted('format' => $format)
2652 if($detail->detail eq $section->{'header'});
2654 my $accountcode = $detail->accountcode;
2655 next unless $accountcode;
2657 my $amount = $detail->amount;
2658 next unless $amount && $amount > 0;
2660 $accountcodes{$accountcode} ||= {
2661 description => $accountcode,
2668 product_code => 'N/A',
2669 section => $section,
2670 ext_description => [ $section->{'header'} ],
2674 $section->{'amount'} += $amount;
2675 $accountcodes{$accountcode}{'amount'} += $amount;
2676 $accountcodes{$accountcode}{calls}++;
2677 $accountcodes{$accountcode}{duration} += $detail->duration;
2678 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2682 foreach my $l ( values %accountcodes ) {
2683 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2684 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2685 foreach my $sorted_detail ( @sorted_detail ) {
2686 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2688 delete $l->{detail_temp};
2692 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2694 return ($section,\@sorted_lines);
2697 sub _items_svc_phone_sections {
2699 my $conf = $self->conf;
2707 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2709 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2710 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2712 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2713 next unless $cust_bill_pkg->pkgnum > 0;
2715 my @header = $cust_bill_pkg->details_header;
2716 next unless scalar(@header);
2718 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2720 my $phonenum = $detail->phonenum;
2721 next unless $phonenum;
2723 my $amount = $detail->amount;
2724 next unless $amount && $amount > 0;
2726 $sections{$phonenum} ||= { 'amount' => 0,
2729 'sort_weight' => -1,
2730 'phonenum' => $phonenum,
2732 $sections{$phonenum}{amount} += $amount; #subtotal
2733 $sections{$phonenum}{calls}++;
2734 $sections{$phonenum}{duration} += $detail->duration;
2736 my $desc = $detail->regionname;
2737 my $description = $desc;
2738 $description = substr($desc, 0, $maxlength). '...'
2739 if $format eq 'latex' && length($desc) > $maxlength;
2741 $lines{$phonenum}{$desc} ||= {
2742 description => &{$escape}($description),
2743 #pkgpart => $part_pkg->pkgpart,
2751 product_code => 'N/A',
2752 ext_description => [],
2755 $lines{$phonenum}{$desc}{amount} += $amount;
2756 $lines{$phonenum}{$desc}{calls}++;
2757 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2759 my $line = $usage_class{$detail->classnum}->classname;
2760 $sections{"$phonenum $line"} ||=
2764 'sort_weight' => $usage_class{$detail->classnum}->weight,
2765 'phonenum' => $phonenum,
2766 'header' => [ @header ],
2768 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2769 $sections{"$phonenum $line"}{calls}++;
2770 $sections{"$phonenum $line"}{duration} += $detail->duration;
2772 $lines{"$phonenum $line"}{$desc} ||= {
2773 description => &{$escape}($description),
2774 #pkgpart => $part_pkg->pkgpart,
2782 product_code => 'N/A',
2783 ext_description => [],
2786 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2787 $lines{"$phonenum $line"}{$desc}{calls}++;
2788 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2789 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2790 $detail->formatted('format' => $format);
2795 my %sectionmap = ();
2796 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2797 foreach ( keys %sections ) {
2798 my @header = @{ $sections{$_}{header} || [] };
2800 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2801 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2802 my $usage_class = $summary ? $simple : $usage_simple;
2803 my $ending = $summary ? ' usage charges' : '';
2806 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2808 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2809 'amount' => $sections{$_}{amount}, #subtotal
2810 'calls' => $sections{$_}{calls},
2811 'duration' => $sections{$_}{duration},
2813 'tax_section' => '',
2814 'phonenum' => $sections{$_}{phonenum},
2815 'sort_weight' => $sections{$_}{sort_weight},
2816 'post_total' => $summary, #inspire pagebreak
2818 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2819 qw( description_generator
2822 total_line_generator
2829 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2830 $a->{sort_weight} <=> $b->{sort_weight}
2835 foreach my $section ( keys %lines ) {
2836 foreach my $line ( keys %{$lines{$section}} ) {
2837 my $l = $lines{$section}{$line};
2838 $l->{section} = $sectionmap{$section};
2839 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2840 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2845 if($conf->exists('phone_usage_class_summary')) {
2846 # this only works with Latex
2850 # after this, we'll have only two sections per DID:
2851 # Calls Summary and Calls Detail
2852 foreach my $section ( @sections ) {
2853 if($section->{'post_total'}) {
2854 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2855 $section->{'total_line_generator'} = sub { '' };
2856 $section->{'total_generator'} = sub { '' };
2857 $section->{'header_generator'} = sub { '' };
2858 $section->{'description_generator'} = '';
2859 push @newsections, $section;
2860 my %calls_detail = %$section;
2861 $calls_detail{'post_total'} = '';
2862 $calls_detail{'sort_weight'} = '';
2863 $calls_detail{'description_generator'} = sub { '' };
2864 $calls_detail{'header_generator'} = sub {
2865 return ' & Date/Time & Called Number & Duration & Price'
2866 if $format eq 'latex';
2869 $calls_detail{'description'} = 'Calls Detail: '
2870 . $section->{'phonenum'};
2871 push @newsections, \%calls_detail;
2875 # after this, each usage class is collapsed/summarized into a single
2876 # line under the Calls Summary section
2877 foreach my $newsection ( @newsections ) {
2878 if($newsection->{'post_total'}) { # this means Calls Summary
2879 foreach my $section ( @sections ) {
2880 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2881 && !$section->{'post_total'});
2882 my $newdesc = $section->{'description'};
2883 my $tn = $section->{'phonenum'};
2884 $newdesc =~ s/$tn//g;
2885 my $line = { ext_description => [],
2889 calls => $section->{'calls'},
2890 section => $newsection,
2891 duration => $section->{'duration'},
2892 description => $newdesc,
2893 amount => sprintf("%.2f",$section->{'amount'}),
2894 product_code => 'N/A',
2896 push @newlines, $line;
2901 # after this, Calls Details is populated with all CDRs
2902 foreach my $newsection ( @newsections ) {
2903 if(!$newsection->{'post_total'}) { # this means Calls Details
2904 foreach my $line ( @lines ) {
2905 next unless (scalar(@{$line->{'ext_description'}}) &&
2906 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2908 my @extdesc = @{$line->{'ext_description'}};
2910 foreach my $extdesc ( @extdesc ) {
2911 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2912 push @newextdesc, $extdesc;
2914 $line->{'ext_description'} = \@newextdesc;
2915 $line->{'section'} = $newsection;
2916 push @newlines, $line;
2921 return(\@newsections, \@newlines);
2924 return(\@sections, \@lines);
2928 =sub _items_usage_class_summary OPTIONS
2930 Returns a list of detail items summarizing the usage charges on this
2931 invoice. Each one will have 'amount', 'description' (the usage charge name),
2932 and 'usage_classnum'.
2934 OPTIONS can include 'escape' (a function to escape the descriptions).
2938 sub _items_usage_class_summary {
2942 my $escape = $opt{escape} || sub { $_[0] };
2943 my $invnum = $self->invnum;
2944 my @classes = qsearch({
2945 'table' => 'usage_class',
2946 'select' => 'classnum, classname, SUM(amount) AS amount',
2947 'addl_from' => ' LEFT JOIN cust_bill_pkg_detail USING (classnum)' .
2948 ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
2949 'extra_sql' => " WHERE cust_bill_pkg.invnum = $invnum".
2950 ' GROUP BY classnum, classname, weight'.
2951 ' HAVING (usage_class.disabled IS NULL OR SUM(amount) > 0)'.
2952 ' ORDER BY weight ASC',
2956 description => &{$escape}($self->mt('Usage Summary')),
2960 foreach my $class (@classes) {
2962 'description' => &{$escape}($class->classname),
2963 'amount' => sprintf('%.2f', $class->amount),
2964 'usage_classnum' => $class->classnum,
2965 'section' => $section,
2971 sub _items_previous {
2973 my $conf = $self->conf;
2974 my $cust_main = $self->cust_main;
2975 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2977 foreach ( @pr_cust_bill ) {
2978 my $date = $conf->exists('invoice_show_prior_due_date')
2979 ? 'due '. $_->due_date2str('short')
2980 : $self->time2str_local('short', $_->_date);
2982 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2983 #'pkgpart' => 'N/A',
2985 'amount' => sprintf("%.2f", $_->owed),
2991 # 'description' => 'Previous Balance',
2992 # #'pkgpart' => 'N/A',
2993 # 'pkgnum' => 'N/A',
2994 # 'amount' => sprintf("%10.2f", $pr_total ),
2995 # 'ext_description' => [ map {
2996 # "Invoice ". $_->invnum.
2997 # " (". time2str("%x",$_->_date). ") ".
2998 # sprintf("%10.2f", $_->owed)
2999 # } @pr_cust_bill ],
3004 sub _items_credits {
3005 my( $self, %opt ) = @_;
3006 my $trim_len = $opt{'trim_len'} || 60;
3011 if ( $self->conf->exists('previous_balance-payments_since') ) {
3012 if ( $opt{'template'} eq 'statement' ) {
3013 # then the current bill is a "statement" (i.e. an invoice sent as
3014 # a payment receipt)
3015 # and in that case we want to see payments on or after THIS invoice
3016 @objects = qsearch('cust_credit', {
3017 'custnum' => $self->custnum,
3018 '_date' => {op => '>=', value => $self->_date},
3022 $date = $self->previous_bill->_date if $self->previous_bill;
3023 @objects = qsearch('cust_credit', {
3024 'custnum' => $self->custnum,
3025 '_date' => {op => '>=', value => $date},
3029 @objects = $self->cust_credited;
3032 foreach my $obj ( @objects ) {
3033 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
3035 my $reason = substr($cust_credit->reason, 0, $trim_len);
3036 $reason .= '...' if length($reason) < length($cust_credit->reason);
3037 $reason = " ($reason) " if $reason;
3040 #'description' => 'Credit ref\#'. $_->crednum.
3041 # " (". time2str("%x",$_->cust_credit->_date) .")".
3043 'description' => $self->mt('Credit applied').' '.
3044 $self->time2str_local('short', $obj->_date). $reason,
3045 'amount' => sprintf("%.2f",$obj->amount),
3053 sub _items_payments {
3058 my $detailed = $self->conf->exists('invoice_payment_details');
3060 if ( $self->conf->exists('previous_balance-payments_since') ) {
3061 # then show payments dated on/after the previous bill...
3062 if ( $opt{'template'} eq 'statement' ) {
3063 # then the current bill is a "statement" (i.e. an invoice sent as
3064 # a payment receipt)
3065 # and in that case we want to see payments on or after THIS invoice
3066 @objects = qsearch('cust_pay', {
3067 'custnum' => $self->custnum,
3068 '_date' => {op => '>=', value => $self->_date},
3071 # the normal case: payments on or after the previous invoice
3073 $date = $self->previous_bill->_date if $self->previous_bill;
3074 @objects = qsearch('cust_pay', {
3075 'custnum' => $self->custnum,
3076 '_date' => {op => '>=', value => $date},
3078 # and before the current bill...
3079 @objects = grep { $_->_date < $self->_date } @objects;
3082 @objects = $self->cust_bill_pay;
3085 foreach my $obj (@objects) {
3086 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
3087 my $desc = $self->mt('Payment received').' '.
3088 $self->time2str_local('short', $cust_pay->_date );
3089 $desc .= $self->mt(' via ') .
3090 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
3094 'description' => $desc,
3095 'amount' => sprintf("%.2f", $obj->amount )
3103 =item call_details [ OPTION => VALUE ... ]
3105 Returns an array of CSV strings representing the call details for this invoice
3106 The only option available is the boolean prepend_billed_number
3111 my ($self, %opt) = @_;
3113 my $format_function = sub { shift };
3115 if ($opt{prepend_billed_number}) {
3116 $format_function = sub {
3120 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3125 my @details = map { $_->details( 'format_function' => $format_function,
3126 'escape_function' => sub{ return() },
3130 $self->cust_bill_pkg;
3131 my $header = $details[0];
3132 ( $header, grep { $_ ne $header } @details );
3142 =item process_reprint
3146 sub process_reprint {
3147 process_re_X('print', @_);
3150 =item process_reemail
3154 sub process_reemail {
3155 process_re_X('email', @_);
3163 process_re_X('fax', @_);
3171 process_re_X('ftp', @_);
3178 sub process_respool {
3179 process_re_X('spool', @_);
3184 my( $method, $job ) = ( shift, shift );
3185 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3188 warn Dumper($param) if $DEBUG;
3199 # spool_invoice ftp_invoice fax_invoice print_invoice
3200 my($method, $job, %param ) = @_;
3202 warn "re_X $method for job $job with param:\n".
3203 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3206 #some false laziness w/search/cust_bill.html
3208 my $orderby = 'ORDER BY cust_bill._date';
3210 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3212 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3214 my @cust_bill = qsearch( {
3215 #'select' => "cust_bill.*",
3216 'table' => 'cust_bill',
3217 'addl_from' => $addl_from,
3219 'extra_sql' => $extra_sql,
3220 'order_by' => $orderby,
3224 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3226 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3229 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3230 foreach my $cust_bill ( @cust_bill ) {
3231 $cust_bill->$method();
3233 if ( $job ) { #progressbar foo
3235 if ( time - $min_sec > $last ) {
3236 my $error = $job->update_statustext(
3237 int( 100 * $num / scalar(@cust_bill) )
3239 die $error if $error;
3250 +{ ( map { $_=>$self->$_ } $self->fields ),
3251 'owed' => $self->owed,
3252 #XXX last payment applied date
3258 =head1 CLASS METHODS
3264 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3269 my ($class, $start, $end) = @_;
3271 $class->paid_sql($start, $end). ' - '.
3272 $class->credited_sql($start, $end);
3277 Returns an SQL fragment to retreive the net amount (charged minus credited).
3282 my ($class, $start, $end) = @_;
3283 'charged - '. $class->credited_sql($start, $end);
3288 Returns an SQL fragment to retreive the amount paid against this invoice.
3293 my ($class, $start, $end) = @_;
3294 $start &&= "AND cust_bill_pay._date <= $start";
3295 $end &&= "AND cust_bill_pay._date > $end";
3296 $start = '' unless defined($start);
3297 $end = '' unless defined($end);
3298 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3299 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3304 Returns an SQL fragment to retreive the amount credited against this invoice.
3309 my ($class, $start, $end) = @_;
3310 $start &&= "AND cust_credit_bill._date <= $start";
3311 $end &&= "AND cust_credit_bill._date > $end";
3312 $start = '' unless defined($start);
3313 $end = '' unless defined($end);
3314 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3315 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3320 Returns an SQL fragment to retrieve the due date of an invoice.
3321 Currently only supported on PostgreSQL.
3326 my $conf = new FS::Conf;
3330 cust_bill.invoice_terms,
3331 cust_main.invoice_terms,
3332 \''.($conf->config('invoice_default_terms') || '').'\'
3333 ), E\'Net (\\\\d+)\'
3335 ) * 86400 + cust_bill._date'
3346 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3347 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base