2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::Record );
5 use vars qw( $DEBUG $me );
7 use Fcntl qw(:flock); #for spool_csv
9 use List::Util qw(min max sum);
13 use Storable qw( freeze thaw );
15 use FS::UID qw( datasrc );
16 use FS::Misc qw( send_email send_fax do_print );
17 use FS::Record qw( qsearch qsearchs dbh );
18 use FS::cust_statement;
19 use FS::cust_bill_pkg;
20 use FS::cust_bill_pkg_display;
21 use FS::cust_bill_pkg_detail;
25 use FS::cust_credit_bill;
27 use FS::cust_bill_event;
30 use FS::cust_bill_pay;
31 use FS::part_bill_event;
34 use FS::cust_bill_batch;
35 use FS::cust_bill_pay_pkg;
36 use FS::cust_credit_bill_pkg;
37 use FS::discount_plan;
38 use FS::cust_bill_void;
42 $me = '[FS::cust_bill]';
46 FS::cust_bill - Object methods for cust_bill records
52 $record = new FS::cust_bill \%hash;
53 $record = new FS::cust_bill { 'column' => 'value' };
55 $error = $record->insert;
57 $error = $new_record->replace($old_record);
59 $error = $record->delete;
61 $error = $record->check;
63 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
65 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
67 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
69 @cust_pay_objects = $cust_bill->cust_pay;
71 $tax_amount = $record->tax;
73 @lines = $cust_bill->print_text;
74 @lines = $cust_bill->print_text('time' => $time);
78 An FS::cust_bill object represents an invoice; a declaration that a customer
79 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
80 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
81 following fields are currently supported:
87 =item invnum - primary key (assigned automatically for new invoices)
89 =item custnum - customer (see L<FS::cust_main>)
91 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
92 L<Time::Local> and L<Date::Parse> for conversion functions.
94 =item charged - amount of this invoice
96 =item invoice_terms - optional terms override for this specific invoice
104 =item billing_balance - the customer's balance immediately before generating
105 this invoice. DEPRECATED. Use the L<FS::cust_main/balance_date> method
106 to determine the customer's balance at a specific time.
108 =item previous_balance - the customer's balance immediately after generating
109 the invoice before this one. DEPRECATED.
111 =item printed - formerly used to track the number of times an invoice had
112 been printed; no longer used.
120 =item closed - books closed flag, empty or `Y'
122 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
124 =item agent_invid - legacy invoice number
126 =item promised_date - customer promised payment date, for collection
128 =item pending - invoice is still being generated, empty or 'Y'
138 Creates a new invoice. To add the invoice to the database, see L<"insert">.
139 Invoices are normally created by calling the bill method of a customer object
140 (see L<FS::cust_main>).
144 sub table { 'cust_bill'; }
146 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
147 # (except email_subject and invnum_date_pretty)
150 $self->conf->config('notice_name') || 'Invoice'
153 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
154 sub cust_unlinked_msg {
156 "WARNING: can't find cust_main.custnum ". $self->custnum.
157 ' (cust_bill.invnum '. $self->invnum. ')';
162 Adds this invoice to the database ("Posts" the invoice). If there is an error,
163 returns the error, otherwise returns false.
169 warn "$me insert called\n" if $DEBUG;
171 local $SIG{HUP} = 'IGNORE';
172 local $SIG{INT} = 'IGNORE';
173 local $SIG{QUIT} = 'IGNORE';
174 local $SIG{TERM} = 'IGNORE';
175 local $SIG{TSTP} = 'IGNORE';
176 local $SIG{PIPE} = 'IGNORE';
178 my $oldAutoCommit = $FS::UID::AutoCommit;
179 local $FS::UID::AutoCommit = 0;
182 my $error = $self->SUPER::insert;
184 $dbh->rollback if $oldAutoCommit;
188 if ( $self->get('cust_bill_pkg') ) {
189 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
190 $cust_bill_pkg->invnum($self->invnum);
191 my $error = $cust_bill_pkg->insert;
193 $dbh->rollback if $oldAutoCommit;
194 return "can't create invoice line item: $error";
199 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
206 Voids this invoice: deletes the invoice and adds a record of the voided invoice
207 to the FS::cust_bill_void table (and related tables starting from
208 FS::cust_bill_pkg_void).
214 my $reason = scalar(@_) ? shift : '';
216 local $SIG{HUP} = 'IGNORE';
217 local $SIG{INT} = 'IGNORE';
218 local $SIG{QUIT} = 'IGNORE';
219 local $SIG{TERM} = 'IGNORE';
220 local $SIG{TSTP} = 'IGNORE';
221 local $SIG{PIPE} = 'IGNORE';
223 my $oldAutoCommit = $FS::UID::AutoCommit;
224 local $FS::UID::AutoCommit = 0;
227 my $cust_bill_void = new FS::cust_bill_void ( {
228 map { $_ => $self->get($_) } $self->fields
230 $cust_bill_void->reason($reason);
231 my $error = $cust_bill_void->insert;
233 $dbh->rollback if $oldAutoCommit;
237 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
238 my $error = $cust_bill_pkg->void($reason);
240 $dbh->rollback if $oldAutoCommit;
245 $error = $self->delete;
247 $dbh->rollback if $oldAutoCommit;
251 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
259 This method now works but you probably shouldn't use it. Instead, apply a
260 credit against the invoice, or use the new void method.
262 Using this method to delete invoices outright is really, really bad. There
263 would be no record you ever posted this invoice, and there are no check to
264 make sure charged = 0 or that there are no associated cust_bill_pkg records.
266 Really, don't use it.
272 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
274 local $SIG{HUP} = 'IGNORE';
275 local $SIG{INT} = 'IGNORE';
276 local $SIG{QUIT} = 'IGNORE';
277 local $SIG{TERM} = 'IGNORE';
278 local $SIG{TSTP} = 'IGNORE';
279 local $SIG{PIPE} = 'IGNORE';
281 my $oldAutoCommit = $FS::UID::AutoCommit;
282 local $FS::UID::AutoCommit = 0;
285 foreach my $table (qw(
296 foreach my $linked ( $self->$table() ) {
297 my $error = $linked->delete;
299 $dbh->rollback if $oldAutoCommit;
306 my $error = $self->SUPER::delete(@_);
308 $dbh->rollback if $oldAutoCommit;
312 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
318 =item replace [ OLD_RECORD ]
320 You can, but probably shouldn't modify invoices...
322 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
323 supplied, replaces this record. If there is an error, returns the error,
324 otherwise returns false.
328 #replace can be inherited from Record.pm
330 # replace_check is now the preferred way to #implement replace data checks
331 # (so $object->replace() works without an argument)
334 my( $new, $old ) = ( shift, shift );
335 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
336 #return "Can't change _date!" unless $old->_date eq $new->_date;
337 return "Can't change _date" unless $old->_date == $new->_date;
338 return "Can't change charged" unless $old->charged == $new->charged
339 || $old->pending eq 'Y'
340 || $old->charged == 0
341 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
347 =item add_cc_surcharge
353 sub add_cc_surcharge {
354 my ($self, $pkgnum, $amount) = (shift, shift, shift);
357 my $cust_bill_pkg = new FS::cust_bill_pkg({
358 'invnum' => $self->invnum,
362 $error = $cust_bill_pkg->insert;
363 return $error if $error;
365 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
366 $self->charged($self->charged+$amount);
367 $error = $self->replace;
368 return $error if $error;
370 $self->apply_payments_and_credits;
376 Checks all fields to make sure this is a valid invoice. If there is an error,
377 returns the error, otherwise returns false. Called by the insert and replace
386 $self->ut_numbern('invnum')
387 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
388 || $self->ut_numbern('_date')
389 || $self->ut_money('charged')
390 || $self->ut_numbern('printed')
391 || $self->ut_enum('closed', [ '', 'Y' ])
392 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
393 || $self->ut_numbern('agent_invid') #varchar?
394 || $self->ut_flag('pending')
396 return $error if $error;
398 $self->_date(time) unless $self->_date;
400 $self->printed(0) if $self->printed eq '';
407 Returns the displayed invoice number for this invoice: agent_invid if
408 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
414 if ( $self->agent_invid
415 && FS::Conf->new->exists('cust_bill-default_agent_invid') ) {
416 return $self->agent_invid;
418 return $self->invnum;
424 Returns the customer's last invoice before this one.
430 if ( !$self->get('previous_bill') ) {
431 $self->set('previous_bill', qsearchs({
432 'table' => 'cust_bill',
433 'hashref' => { 'custnum' => $self->custnum,
434 '_date' => { op=>'<', value=>$self->_date } },
435 'order_by' => 'ORDER BY _date DESC LIMIT 1',
438 $self->get('previous_bill');
443 Returns a list consisting of the total previous balance for this customer,
444 followed by the previous outstanding invoices (as FS::cust_bill objects also).
451 my @cust_bill = sort { $a->_date <=> $b->_date }
452 grep { $_->owed != 0 }
453 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
454 #'_date' => { op=>'<', value=>$self->_date },
455 'invnum' => { op=>'<', value=>$self->invnum },
458 foreach ( @cust_bill ) { $total += $_->owed; }
462 =item enable_previous
464 Whether to show the 'Previous Charges' section when printing this invoice.
465 The negation of the 'disable_previous_balance' config setting.
469 sub enable_previous {
471 my $agentnum = $self->cust_main->agentnum;
472 !$self->conf->exists('disable_previous_balance', $agentnum);
477 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
484 { 'table' => 'cust_bill_pkg',
485 'hashref' => { 'invnum' => $self->invnum },
486 'order_by' => 'ORDER BY billpkgnum', #important? otherwise we could use
487 # the AUTLOADED FK search. or should
488 # that default to ORDER by the pkey?
493 =item cust_bill_pkg_pkgnum PKGNUM
495 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
500 sub cust_bill_pkg_pkgnum {
501 my( $self, $pkgnum ) = @_;
503 { 'table' => 'cust_bill_pkg',
504 'hashref' => { 'invnum' => $self->invnum,
507 'order_by' => 'ORDER BY billpkgnum',
514 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
521 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
522 $self->cust_bill_pkg;
524 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
529 Returns true if any of the packages (or their definitions) corresponding to the
530 line items for this invoice have the no_auto flag set.
536 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
539 =item open_cust_bill_pkg
541 Returns the open line items for this invoice.
543 Note that cust_bill_pkg with both setup and recur fees are returned as two
544 separate line items, each with only one fee.
548 # modeled after cust_main::open_cust_bill
549 sub open_cust_bill_pkg {
552 # grep { $_->owed > 0 } $self->cust_bill_pkg
554 my %other = ( 'recur' => 'setup',
555 'setup' => 'recur', );
557 foreach my $field ( qw( recur setup )) {
558 push @open, map { $_->set( $other{$field}, 0 ); $_; }
559 grep { $_->owed($field) > 0 }
560 $self->cust_bill_pkg;
566 =item cust_bill_event
568 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
572 sub cust_bill_event {
574 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
577 =item num_cust_bill_event
579 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
583 sub num_cust_bill_event {
586 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
587 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
588 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
589 $sth->fetchrow_arrayref->[0];
594 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
598 #false laziness w/cust_pkg.pm
602 'table' => 'cust_event',
603 'addl_from' => 'JOIN part_event USING ( eventpart )',
604 'hashref' => { 'tablenum' => $self->invnum },
605 'extra_sql' => " AND eventtable = 'cust_bill' ",
611 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
615 #false laziness w/cust_pkg.pm
619 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
620 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
621 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
622 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
623 $sth->fetchrow_arrayref->[0];
628 Returns the customer (see L<FS::cust_main>) for this invoice.
630 =item cust_suspend_if_balance_over AMOUNT
632 Suspends the customer associated with this invoice if the total amount owed on
633 this invoice and all older invoices is greater than the specified amount.
635 Returns a list: an empty list on success or a list of errors.
639 sub cust_suspend_if_balance_over {
640 my( $self, $amount ) = ( shift, shift );
641 my $cust_main = $self->cust_main;
642 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
645 $cust_main->suspend(@_);
651 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
657 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
658 sort { $a->_date <=> $b->_date }
659 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
664 =item cust_credit_bill
666 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
672 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
673 sort { $a->_date <=> $b->_date }
674 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
678 sub cust_credit_bill {
679 shift->cust_credited(@_);
682 #=item cust_bill_pay_pkgnum PKGNUM
684 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
685 #with matching pkgnum.
689 #sub cust_bill_pay_pkgnum {
690 # my( $self, $pkgnum ) = @_;
691 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
692 # sort { $a->_date <=> $b->_date }
693 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
694 # 'pkgnum' => $pkgnum,
699 =item cust_bill_pay_pkg PKGNUM
701 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
702 applied against the matching pkgnum.
706 sub cust_bill_pay_pkg {
707 my( $self, $pkgnum ) = @_;
710 'select' => 'cust_bill_pay_pkg.*',
711 'table' => 'cust_bill_pay_pkg',
712 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
713 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
714 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
715 " AND cust_bill_pkg.pkgnum = $pkgnum",
720 #=item cust_credited_pkgnum PKGNUM
722 #=item cust_credit_bill_pkgnum PKGNUM
724 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
725 #with matching pkgnum.
729 #sub cust_credited_pkgnum {
730 # my( $self, $pkgnum ) = @_;
731 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
732 # sort { $a->_date <=> $b->_date }
733 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
734 # 'pkgnum' => $pkgnum,
739 #sub cust_credit_bill_pkgnum {
740 # shift->cust_credited_pkgnum(@_);
743 =item cust_credit_bill_pkg PKGNUM
745 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
746 applied against the matching pkgnum.
750 sub cust_credit_bill_pkg {
751 my( $self, $pkgnum ) = @_;
754 'select' => 'cust_credit_bill_pkg.*',
755 'table' => 'cust_credit_bill_pkg',
756 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
757 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
758 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
759 " AND cust_bill_pkg.pkgnum = $pkgnum",
764 =item cust_bill_batch
766 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
770 sub cust_bill_batch {
772 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
777 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
778 hash keyed by term length.
784 FS::discount_plan->all($self);
789 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
796 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
798 foreach (@taxlines) { $total += $_->setup; }
804 Returns the amount owed (still outstanding) on this invoice, which is charged
805 minus all payment applications (see L<FS::cust_bill_pay>) and credit
806 applications (see L<FS::cust_credit_bill>).
812 my $balance = $self->charged;
813 $balance -= $_->amount foreach ( $self->cust_bill_pay );
814 $balance -= $_->amount foreach ( $self->cust_credited );
815 $balance = sprintf( "%.2f", $balance);
816 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
821 my( $self, $pkgnum ) = @_;
823 #my $balance = $self->charged;
825 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
827 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
828 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
830 $balance = sprintf( "%.2f", $balance);
831 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
837 Returns true if this invoice should be hidden. See the
838 selfservice-hide_invoices-taxclass configuraiton setting.
844 my $conf = $self->conf;
845 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
847 my @cust_bill_pkg = $self->cust_bill_pkg;
848 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
849 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
852 =item apply_payments_and_credits [ OPTION => VALUE ... ]
854 Applies unapplied payments and credits to this invoice.
856 A hash of optional arguments may be passed. Currently "manual" is supported.
857 If true, a payment receipt is sent instead of a statement when
858 'payment_receipt_email' configuration option is set.
860 If there is an error, returns the error, otherwise returns false.
864 sub apply_payments_and_credits {
865 my( $self, %options ) = @_;
866 my $conf = $self->conf;
868 local $SIG{HUP} = 'IGNORE';
869 local $SIG{INT} = 'IGNORE';
870 local $SIG{QUIT} = 'IGNORE';
871 local $SIG{TERM} = 'IGNORE';
872 local $SIG{TSTP} = 'IGNORE';
873 local $SIG{PIPE} = 'IGNORE';
875 my $oldAutoCommit = $FS::UID::AutoCommit;
876 local $FS::UID::AutoCommit = 0;
879 $self->select_for_update; #mutex
881 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
882 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
884 if ( $conf->exists('pkg-balances') ) {
885 # limit @payments & @credits to those w/ a pkgnum grepped from $self
886 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
887 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
888 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
891 while ( $self->owed > 0 and ( @payments || @credits ) ) {
894 if ( @payments && @credits ) {
896 #decide which goes first by weight of top (unapplied) line item
898 my @open_lineitems = $self->open_cust_bill_pkg;
901 max( map { $_->part_pkg->pay_weight || 0 }
906 my $max_credit_weight =
907 max( map { $_->part_pkg->credit_weight || 0 }
913 #if both are the same... payments first? it has to be something
914 if ( $max_pay_weight >= $max_credit_weight ) {
920 } elsif ( @payments ) {
922 } elsif ( @credits ) {
925 die "guru meditation #12 and 35";
929 if ( $app eq 'pay' ) {
931 my $payment = shift @payments;
932 $unapp_amount = $payment->unapplied;
933 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
934 $app->pkgnum( $payment->pkgnum )
935 if $conf->exists('pkg-balances') && $payment->pkgnum;
937 } elsif ( $app eq 'credit' ) {
939 my $credit = shift @credits;
940 $unapp_amount = $credit->credited;
941 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
942 $app->pkgnum( $credit->pkgnum )
943 if $conf->exists('pkg-balances') && $credit->pkgnum;
946 die "guru meditation #12 and 35";
950 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
951 warn "owed_pkgnum ". $app->pkgnum;
952 $owed = $self->owed_pkgnum($app->pkgnum);
956 next unless $owed > 0;
958 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
959 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
961 $app->invnum( $self->invnum );
963 my $error = $app->insert(%options);
965 $dbh->rollback if $oldAutoCommit;
966 return "Error inserting ". $app->table. " record: $error";
968 die $error if $error;
972 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
977 =item generate_email OPTION => VALUE ...
985 sender address, required
989 alternate template name, optional
993 text attachment arrayref, optional
997 email subject, optional
1001 notice name instead of "Invoice", optional
1005 Returns an argument list to be passed to L<FS::Misc::send_email>.
1011 sub generate_email {
1015 my $conf = $self->conf;
1017 my $me = '[FS::cust_bill::generate_email]';
1020 'from' => $args{'from'},
1021 'subject' => ($args{'subject'} || $self->email_subject),
1022 'custnum' => $self->custnum,
1023 'msgtype' => 'invoice',
1026 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
1028 my $cust_main = $self->cust_main;
1030 if (ref($args{'to'}) eq 'ARRAY') {
1031 $return{'to'} = $args{'to'};
1033 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1034 $cust_main->invoicing_list
1038 if ( $conf->exists('invoice_html') ) {
1040 warn "$me creating HTML/text multipart message"
1043 $return{'nobody'} = 1;
1045 my $alternative = build MIME::Entity
1046 'Type' => 'multipart/alternative',
1047 #'Encoding' => '7bit',
1048 'Disposition' => 'inline'
1052 if ( $conf->exists('invoice_email_pdf')
1053 and scalar($conf->config('invoice_email_pdf_note')) ) {
1055 warn "$me using 'invoice_email_pdf_note' in multipart message"
1057 $data = [ map { $_ . "\n" }
1058 $conf->config('invoice_email_pdf_note')
1063 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1065 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1066 $data = $args{'print_text'};
1068 $data = [ $self->print_text(\%args) ];
1073 $alternative->attach(
1074 'Type' => 'text/plain',
1075 'Encoding' => 'quoted-printable',
1076 'Charset' => 'UTF-8',
1077 #'Encoding' => '7bit',
1079 'Disposition' => 'inline',
1086 if ( $conf->exists('invoice_email_pdf')
1087 and scalar($conf->config('invoice_email_pdf_note')) ) {
1089 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1093 $args{'from'} =~ /\@([\w\.\-]+)/;
1094 my $from = $1 || 'example.com';
1095 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1098 my $agentnum = $cust_main->agentnum;
1099 if ( defined($args{'template'}) && length($args{'template'})
1100 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1103 $logo = 'logo_'. $args{'template'}. '.png';
1107 my $image_data = $conf->config_binary( $logo, $agentnum);
1109 $image = build MIME::Entity
1110 'Type' => 'image/png',
1111 'Encoding' => 'base64',
1112 'Data' => $image_data,
1113 'Filename' => 'logo.png',
1114 'Content-ID' => "<$content_id>",
1117 if ($conf->exists('invoice-barcode')) {
1118 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1119 $barcode = build MIME::Entity
1120 'Type' => 'image/png',
1121 'Encoding' => 'base64',
1122 'Data' => $self->invoice_barcode(0),
1123 'Filename' => 'barcode.png',
1124 'Content-ID' => "<$barcode_content_id>",
1126 $args{'barcode_cid'} = $barcode_content_id;
1129 $htmldata = $self->print_html({ 'cid'=>$content_id, %args });
1132 $alternative->attach(
1133 'Type' => 'text/html',
1134 'Encoding' => 'quoted-printable',
1135 'Data' => [ '<html>',
1138 ' '. encode_entities($return{'subject'}),
1141 ' <body bgcolor="#e8e8e8">',
1146 'Disposition' => 'inline',
1147 #'Filename' => 'invoice.pdf',
1151 my @otherparts = ();
1152 if ( $cust_main->email_csv_cdr ) {
1154 push @otherparts, build MIME::Entity
1155 'Type' => 'text/csv',
1156 'Encoding' => '7bit',
1157 'Data' => [ map { "$_\n" }
1158 $self->call_details('prepend_billed_number' => 1)
1160 'Disposition' => 'attachment',
1161 'Filename' => 'usage-'. $self->invnum. '.csv',
1166 if ( $conf->exists('invoice_email_pdf') ) {
1171 # multipart/alternative
1177 my $related = build MIME::Entity 'Type' => 'multipart/related',
1178 'Encoding' => '7bit';
1180 #false laziness w/Misc::send_email
1181 $related->head->replace('Content-type',
1182 $related->mime_type.
1183 '; boundary="'. $related->head->multipart_boundary. '"'.
1184 '; type=multipart/alternative'
1187 $related->add_part($alternative);
1189 $related->add_part($image) if $image;
1191 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
1193 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1197 #no other attachment:
1199 # multipart/alternative
1204 $return{'content-type'} = 'multipart/related';
1205 if ($conf->exists('invoice-barcode') && $barcode) {
1206 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1208 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1210 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1211 #$return{'disposition'} = 'inline';
1217 if ( $conf->exists('invoice_email_pdf') ) {
1218 warn "$me creating PDF attachment"
1221 #mime parts arguments a la MIME::Entity->build().
1222 $return{'mimeparts'} = [
1223 { $self->mimebuild_pdf(\%args) }
1227 if ( $conf->exists('invoice_email_pdf')
1228 and scalar($conf->config('invoice_email_pdf_note')) ) {
1230 warn "$me using 'invoice_email_pdf_note'"
1232 $return{'body'} = [ map { $_ . "\n" }
1233 $conf->config('invoice_email_pdf_note')
1238 warn "$me not using 'invoice_email_pdf_note'"
1240 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1241 $return{'body'} = $args{'print_text'};
1243 $return{'body'} = [ $self->print_text(\%args) ];
1256 Returns a list suitable for passing to MIME::Entity->build(), representing
1257 this invoice as PDF attachment.
1264 'Type' => 'application/pdf',
1265 'Encoding' => 'base64',
1266 'Data' => [ $self->print_pdf(@_) ],
1267 'Disposition' => 'attachment',
1268 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1274 Sends this invoice to the destinations configured for this customer: sends
1275 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1277 Options can be passed as a hashref. Positional parameters are no longer
1280 I<template>: a suffix for alternate invoices
1282 I<agentnum>: obsolete, now does nothing.
1284 I<invoice_from> overrides the default email invoice From: address.
1286 I<amount>: obsolete, does nothing
1288 I<notice_name> overrides "Invoice" as the name of the sent document
1289 (templates from 10/2009 or newer required).
1291 I<lpr> overrides the system 'lpr' option as the command to print a document
1292 from standard input.
1298 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1299 my $conf = $self->conf;
1301 my $cust_main = $self->cust_main;
1303 my @invoicing_list = $cust_main->invoicing_list;
1306 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1307 && ! $self->invoice_noemail;
1310 if grep { $_ eq 'POST' } @invoicing_list; #postal
1312 #this has never been used post-$ORIGINAL_ISP afaik
1313 $self->fax_invoice($opt)
1314 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1320 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1322 Sends this invoice to the customer's email destination(s).
1324 Options must be passed as a hashref. Positional parameters are no longer
1327 I<template>, if specified, is the name of a suffix for alternate invoices.
1329 I<invoice_from>, if specified, overrides the default email invoice From:
1332 I<notice_name> is the name of the sent document.
1336 sub queueable_email {
1339 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1340 or die "invalid invoice number: " . $opt{invnum};
1342 my %args = map {$_ => $opt{$_}}
1344 qw( invoice_from notice_name no_coupon template );
1346 my $error = $self->email( \%args );
1347 die $error if $error;
1353 return if $self->hide;
1354 my $conf = $self->conf;
1355 my $opt = shift || {};
1356 if ($opt and !ref($opt)) {
1357 die "FS::cust_bill::email called with positional parameters";
1360 my $template = $opt->{template};
1361 my $from = delete $opt->{invoice_from};
1363 # this is where we set the From: address
1364 $from ||= $self->_agent_invoice_from || #XXX should go away
1365 $conf->config('invoice_from', $self->cust_main->agentnum );
1367 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1368 $self->cust_main->invoicing_list;
1370 if ( ! @invoicing_list ) { #no recipients
1371 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1372 die 'No recipients for customer #'. $self->custnum;
1374 #default: better to notify this person than silence
1375 @invoicing_list = ($from);
1379 # this is where we set the Subject:
1380 my $subject = $self->email_subject($template);
1382 my $error = send_email(
1383 $self->generate_email(
1385 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1386 'subject' => $subject,
1387 %$opt, # template, etc.
1390 die "can't email invoice: $error\n" if $error;
1391 #die "$error\n" if $error;
1397 my $conf = $self->conf;
1399 #my $template = scalar(@_) ? shift : '';
1402 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1405 my $cust_main = $self->cust_main;
1406 my $name = $cust_main->name;
1407 my $name_short = $cust_main->name_short;
1408 my $invoice_number = $self->invnum;
1409 my $invoice_date = $self->_date_pretty;
1411 eval qq("$subject");
1414 =item lpr_data HASHREF
1416 Returns the postscript or plaintext for this invoice as an arrayref.
1418 Options must be passed as a hashref. Positional parameters are no longer
1421 I<template>, if specified, is the name of a suffix for alternate invoices.
1423 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1429 my $conf = $self->conf;
1430 my $opt = shift || {};
1431 if ($opt and !ref($opt)) {
1432 # nobody does this anyway
1433 die "FS::cust_bill::lpr_data called with positional parameters";
1436 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1437 [ $self->$method( $opt ) ];
1442 Prints this invoice.
1444 Options must be passed as a hashref.
1446 I<template>, if specified, is the name of a suffix for alternate invoices.
1448 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1454 return if $self->hide;
1455 my $conf = $self->conf;
1456 my $opt = shift || {};
1457 if ($opt and !ref($opt)) {
1458 die "FS::cust_bill::print called with positional parameters";
1461 my $lpr = delete $opt->{lpr};
1462 if($conf->exists('invoice_print_pdf')) {
1463 # Add the invoice to the current batch.
1464 $self->batch_invoice($opt);
1468 $self->lpr_data($opt),
1469 'agentnum' => $self->cust_main->agentnum,
1475 =item fax_invoice HASHREF
1479 Options must be passed as a hashref.
1481 I<template>, if specified, is the name of a suffix for alternate invoices.
1483 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1489 return if $self->hide;
1490 my $conf = $self->conf;
1491 my $opt = shift || {};
1492 if ($opt and !ref($opt)) {
1493 die "FS::cust_bill::fax_invoice called with positional parameters";
1496 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1497 unless $conf->exists('invoice_latex');
1499 my $dialstring = $self->cust_main->getfield('fax');
1502 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1503 'dialstring' => $dialstring,
1505 die $error if $error;
1509 =item batch_invoice [ HASHREF ]
1511 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1512 isn't an open batch, one will be created.
1514 HASHREF may contain any options to be passed to C<print_pdf>.
1519 my ($self, $opt) = @_;
1520 my $bill_batch = $self->get_open_bill_batch;
1521 my $cust_bill_batch = FS::cust_bill_batch->new({
1522 batchnum => $bill_batch->batchnum,
1523 invnum => $self->invnum,
1525 return $cust_bill_batch->insert($opt);
1528 =item get_open_batch
1530 Returns the currently open batch as an FS::bill_batch object, creating a new
1531 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1536 sub get_open_bill_batch {
1538 my $conf = $self->conf;
1539 my $hashref = { status => 'O' };
1540 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1541 ? $self->cust_main->agentnum
1543 my $batch = qsearchs('bill_batch', $hashref);
1544 return $batch if $batch;
1545 $batch = FS::bill_batch->new($hashref);
1546 my $error = $batch->insert;
1547 die $error if $error;
1551 =item ftp_invoice [ TEMPLATENAME ]
1553 Sends this invoice data via FTP.
1555 TEMPLATENAME is unused?
1561 my $conf = $self->conf;
1562 my $template = scalar(@_) ? shift : '';
1565 'protocol' => 'ftp',
1566 'server' => $conf->config('cust_bill-ftpserver'),
1567 'username' => $conf->config('cust_bill-ftpusername'),
1568 'password' => $conf->config('cust_bill-ftppassword'),
1569 'dir' => $conf->config('cust_bill-ftpdir'),
1570 'format' => $conf->config('cust_bill-ftpformat'),
1574 =item spool_invoice [ TEMPLATENAME ]
1576 Spools this invoice data (see L<FS::spool_csv>)
1578 TEMPLATENAME is unused?
1584 my $conf = $self->conf;
1585 my $template = scalar(@_) ? shift : '';
1588 'format' => $conf->config('cust_bill-spoolformat'),
1589 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1593 =item send_csv OPTION => VALUE, ...
1595 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1599 protocol - currently only "ftp"
1605 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1606 and YYMMDDHHMMSS is a timestamp.
1608 See L</print_csv> for a description of the output format.
1613 my($self, %opt) = @_;
1617 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1618 mkdir $spooldir, 0700 unless -d $spooldir;
1620 # don't localize dates here, they're a defined format
1621 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1622 my $file = "$spooldir/$tracctnum.csv";
1624 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1626 open(CSV, ">$file") or die "can't open $file: $!";
1634 if ( $opt{protocol} eq 'ftp' ) {
1635 eval "use Net::FTP;";
1637 $net = Net::FTP->new($opt{server}) or die @$;
1639 die "unknown protocol: $opt{protocol}";
1642 $net->login( $opt{username}, $opt{password} )
1643 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1645 $net->binary or die "can't set binary mode";
1647 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1649 $net->put($file) or die "can't put $file: $!";
1659 Spools CSV invoice data.
1665 =item format - any of FS::Misc::::Invoicing::spool_formats
1667 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1668 customer has the corresponding invoice destinations set (see
1669 L<FS::cust_main_invoice>).
1671 =item agent_spools - if set to a true value, will spool to per-agent files
1672 rather than a single global file
1674 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1675 append to that spool. L<FS::Cron::upload> will then send the spool file to
1678 =item balanceover - if set, only spools the invoice if the total amount owed on
1679 this invoice and all older invoices is greater than the specified amount.
1681 =item time - the "current time". Controls the printing of past due messages
1689 my($self, %opt) = @_;
1691 my $time = $opt{'time'} || time;
1692 my $cust_main = $self->cust_main;
1694 if ( $opt{'dest'} ) {
1695 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1696 $cust_main->invoicing_list;
1697 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1698 || ! keys %invoicing_list;
1701 if ( $opt{'balanceover'} ) {
1703 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1706 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1707 mkdir $spooldir, 0700 unless -d $spooldir;
1709 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1712 if ( $opt{'agent_spools'} ) {
1713 $file = 'agentnum'.$cust_main->agentnum;
1718 if ( $opt{'upload_targetnum'} ) {
1719 $spooldir .= '/target'.$opt{'upload_targetnum'};
1720 mkdir $spooldir, 0700 unless -d $spooldir;
1721 } # otherwise it just goes into export.xxx/cust_bill
1723 if ( lc($opt{'format'}) eq 'billco' ) {
1727 $file = "$spooldir/$file.csv";
1729 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1731 open(CSV, ">>$file") or die "can't open $file: $!";
1732 flock(CSV, LOCK_EX);
1737 if ( lc($opt{'format'}) eq 'billco' ) {
1739 flock(CSV, LOCK_UN);
1742 $file =~ s/-header.csv$/-detail.csv/;
1744 open(CSV,">>$file") or die "can't open $file: $!";
1745 flock(CSV, LOCK_EX);
1749 print CSV $detail if defined($detail);
1751 flock(CSV, LOCK_UN);
1758 =item print_csv OPTION => VALUE, ...
1760 Returns CSV data for this invoice.
1764 format - 'default', 'billco', 'oneline', 'bridgestone'
1766 Returns a list consisting of two scalars. The first is a single line of CSV
1767 header information for this invoice. The second is one or more lines of CSV
1768 detail information for this invoice.
1770 If I<format> is not specified or "default", the fields of the CSV file are as
1773 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1774 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1778 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1780 B<record_type> is C<cust_bill> for the initial header line only. The
1781 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1782 fields are filled in.
1784 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1785 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1788 =item invnum - invoice number
1790 =item custnum - customer number
1792 =item _date - invoice date
1794 =item charged - total invoice amount
1796 =item first - customer first name
1798 =item last - customer first name
1800 =item company - company name
1802 =item address1 - address line 1
1804 =item address2 - address line 1
1814 =item pkg - line item description
1816 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1818 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1820 =item sdate - start date for recurring fee
1822 =item edate - end date for recurring fee
1826 If I<format> is "billco", the fields of the header CSV file are as follows:
1828 +-------------------------------------------------------------------+
1829 | FORMAT HEADER FILE |
1830 |-------------------------------------------------------------------|
1831 | Field | Description | Name | Type | Width |
1832 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1833 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1834 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1835 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1836 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1837 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1838 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1839 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1840 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1841 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1842 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1843 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1844 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1845 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1846 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1847 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1848 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1849 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1850 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1851 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1852 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1853 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1854 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1855 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1856 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1857 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1858 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1859 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1860 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1861 +-------+-------------------------------+------------+------+-------+
1863 If I<format> is "billco", the fields of the detail CSV file are as follows:
1865 FORMAT FOR DETAIL FILE
1867 Field | Description | Name | Type | Width
1868 1 | N/A-Leave Empty | RC | CHAR | 2
1869 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1870 3 | Account Number | TRACCTNUM | CHAR | 15
1871 4 | Invoice Number | TRINVOICE | CHAR | 15
1872 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1873 6 | Transaction Detail | DETAILS | CHAR | 100
1874 7 | Amount | AMT | NUM* | 9
1875 8 | Line Format Control** | LNCTRL | CHAR | 2
1876 9 | Grouping Code | GROUP | CHAR | 2
1877 10 | User Defined | ACCT CODE | CHAR | 15
1879 If format is 'oneline', there is no detail file. Each invoice has a
1880 header line only, with the fields:
1882 Agent number, agent name, customer number, first name, last name, address
1883 line 1, address line 2, city, state, zip, invoice date, invoice number,
1884 amount charged, amount due, previous balance, due date.
1886 and then, for each line item, three columns containing the package number,
1887 description, and amount.
1889 If format is 'bridgestone', there is no detail file. Each invoice has a
1890 header line with the following fields in a fixed-width format:
1892 Customer number (in display format), date, name (first last), company,
1893 address 1, address 2, city, state, zip.
1895 This is a mailing list format, and has no per-invoice fields. To avoid
1896 sending redundant notices, the spooling event should have a "once" or
1897 "once_percust_every" condition.
1902 my($self, %opt) = @_;
1904 eval "use Text::CSV_XS";
1907 my $cust_main = $self->cust_main;
1909 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1910 my $format = lc($opt{'format'});
1912 my $time = $opt{'time'} || time;
1914 my $tracctnum = ''; #leaking out from billco-specific sections :/
1915 if ( $format eq 'billco' ) {
1918 $self->conf->config('billco-account_num', $cust_main->agentnum);
1920 $tracctnum = $account_num eq 'display_custnum'
1921 ? $cust_main->display_custnum
1922 : $opt{'tracctnum'};
1925 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1927 my $duedate = $self->due_date2str('%m/%d/%Y'); # hardcoded, NOT date_format
1929 my( $previous_balance, @unused ) = $self->previous; #previous balance
1931 my $pmt_cr_applied = 0;
1932 $pmt_cr_applied += $_->{'amount'}
1933 foreach ( $self->_items_payments(%opt), $self->_items_credits(%opt) ) ;
1935 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1938 '', # 1 | N/A-Leave Empty CHAR 2
1939 '', # 2 | N/A-Leave Empty CHAR 15
1940 $tracctnum, # 3 | Transaction Account No CHAR 15
1941 $self->invnum, # 4 | Transaction Invoice No CHAR 15
1942 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
1943 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
1944 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
1945 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
1946 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
1947 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
1948 '', # 10 | Ancillary Billing Information CHAR 30
1949 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
1950 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
1953 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
1956 $duedate, # 14 | Bill Due Date CHAR 10
1958 $previous_balance, # 15 | Previous Balance NUM* 9
1959 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
1960 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
1961 $totaldue, # 18 | Total Amt Due NUM* 9
1962 $totaldue, # 19 | Total Amt Due NUM* 9
1963 '', # 20 | 30 Day Aging NUM* 9
1964 '', # 21 | 60 Day Aging NUM* 9
1965 '', # 22 | 90 Day Aging NUM* 9
1966 'N', # 23 | Y/N CHAR 1
1967 '', # 24 | Remittance automation CHAR 100
1968 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
1969 $self->custnum, # 26 | Customer Reference Number CHAR 15
1970 '0', # 27 | Federal Tax*** NUM* 9
1971 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
1972 '0', # 29 | Other Taxes & Fees*** NUM* 9
1975 } elsif ( $format eq 'oneline' ) { #name
1977 my ($previous_balance) = $self->previous;
1978 $previous_balance = sprintf('%.2f', $previous_balance);
1979 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1985 $self->_items_pkg, #_items_nontax? no sections or anything
1990 $cust_main->agentnum,
1991 $cust_main->agent->agent,
1995 $cust_main->company,
1996 $cust_main->address1,
1997 $cust_main->address2,
2003 time2str("%x", $self->_date),
2008 $self->due_date2str("%x"),
2013 } elsif ( $format eq 'bridgestone' ) {
2015 # bypass the CSV stuff and just return this
2016 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2017 my $zip = $cust_main->zip;
2019 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2023 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2025 $cust_main->display_custnum,
2027 uc(substr($cust_main->contact_firstlast,0,30)),
2028 uc(substr($cust_main->company ,0,30)),
2029 uc(substr($cust_main->address1 ,0,30)),
2030 uc(substr($cust_main->address2 ,0,30)),
2031 uc(substr($cust_main->city ,0,20)),
2032 uc($cust_main->state),
2038 } elsif ( $format eq 'ics' ) {
2040 my $bill = $cust_main->bill_location;
2041 my $zip = $bill->zip;
2045 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2050 # minor false laziness with print_generic
2051 my ($previous_balance) = $self->previous;
2052 my $balance_due = $self->owed + $previous_balance;
2053 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2054 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
2057 if ( $self->due_date and $time >= $self->due_date ) {
2058 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2062 my $header = sprintf(
2063 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2064 $cust_main->display_custnum, #BID
2065 uc($cust_main->first), #FNAME
2066 uc($cust_main->last), #LNAME
2067 '00', #BATCH, should this ever be anything else?
2068 uc($cust_main->company), #COMP
2069 uc($bill->address1), #STREET1
2070 uc($bill->address2), #STREET2
2071 uc($bill->city), #CITY
2072 uc($bill->state), #STATE
2075 time2str('%Y%m%d', $self->_date), #BILL_DATE
2076 $self->due_date2str('%Y%m%d'), #DUE_DATE,
2077 ( map {sprintf('%0.2f', $_)}
2078 $balance_due, #AMNT_DUE
2079 $previous_balance, #PREV_BAL
2080 $payment_total, #PYMT_RCVD
2081 $credit_total, #CREDITS
2082 $previous_balance, #BEG_BAL--is this correct?
2083 $self->charged, #NEW_CHRG
2086 $past_due, #PAST_MSG
2090 my %svc_class = ('' => ''); # maybe cache this more persistently?
2092 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2094 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2095 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2099 my @dates = ( $self->_date, undef );
2100 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2101 $dates[1] = $prev->sdate; #questionable
2104 # generate an 01 detail for each service
2105 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2106 foreach my $cust_svc ( @svcs ) {
2107 $show_pkgnum = ''; # hide it if we're showing svcnums
2109 my $svcpart = $cust_svc->svcpart;
2110 if (!exists($svc_class{$svcpart})) {
2111 my $classnum = $cust_svc->part_svc->classnum;
2112 my $part_svc_class = FS::part_svc_class->by_key($classnum)
2114 $svc_class{$svcpart} = $part_svc_class ?
2115 $part_svc_class->classname :
2119 my @h_label = $cust_svc->label(@dates, 'I');
2120 push @details, sprintf('01%-9s%-20s%-47s',
2122 $svc_class{$svcpart},
2125 } #foreach $cust_svc
2128 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2129 if ($cust_bill_pkg->recur > 0) {
2130 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2131 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2133 push @details, sprintf('02%-6s%-60s%-10s',
2136 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2138 } #foreach $cust_bill_pkg
2140 # Tag this row so that we know whether this is one page (1), two pages
2141 # (2), # or "big" (B). The tag will be stripped off before uploading.
2142 if ( scalar(@details) < 12 ) {
2144 } elsif ( scalar(@details) < 58 ) {
2150 return join('', $header, @details, "\n");
2158 time2str("%x", $self->_date),
2159 sprintf("%.2f", $self->charged),
2160 ( map { $cust_main->getfield($_) }
2161 qw( first last company address1 address2 city state zip country ) ),
2163 ) or die "can't create csv";
2166 my $header = $csv->string. "\n";
2169 if ( lc($opt{'format'}) eq 'billco' ) {
2172 foreach my $item ( $self->_items_pkg ) {
2175 '', # 1 | N/A-Leave Empty CHAR 2
2176 '', # 2 | N/A-Leave Empty CHAR 15
2177 $tracctnum, # 3 | Account Number CHAR 15
2178 $self->invnum, # 4 | Invoice Number CHAR 15
2179 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2180 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2181 $item->{'amount'}, # 7 | Amount NUM* 9
2182 '', # 8 | Line Format Control** CHAR 2
2183 '', # 9 | Grouping Code CHAR 2
2184 '', # 10 | User Defined CHAR 15
2187 $detail .= $csv->string. "\n";
2191 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2197 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2199 my($pkg, $setup, $recur, $sdate, $edate);
2200 if ( $cust_bill_pkg->pkgnum ) {
2202 ($pkg, $setup, $recur, $sdate, $edate) = (
2203 $cust_bill_pkg->part_pkg->pkg,
2204 ( $cust_bill_pkg->setup != 0
2205 ? sprintf("%.2f", $cust_bill_pkg->setup )
2207 ( $cust_bill_pkg->recur != 0
2208 ? sprintf("%.2f", $cust_bill_pkg->recur )
2210 ( $cust_bill_pkg->sdate
2211 ? time2str("%x", $cust_bill_pkg->sdate)
2213 ($cust_bill_pkg->edate
2214 ? time2str("%x", $cust_bill_pkg->edate)
2218 } else { #pkgnum tax
2219 next unless $cust_bill_pkg->setup != 0;
2220 $pkg = $cust_bill_pkg->desc;
2221 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2222 ( $sdate, $edate ) = ( '', '' );
2228 ( map { '' } (1..11) ),
2229 ($pkg, $setup, $recur, $sdate, $edate)
2230 ) or die "can't create csv";
2232 $detail .= $csv->string. "\n";
2238 ( $header, $detail );
2244 Pays this invoice with a compliemntary payment. If there is an error,
2245 returns the error, otherwise returns false.
2251 my $cust_pay = new FS::cust_pay ( {
2252 'invnum' => $self->invnum,
2253 'paid' => $self->owed,
2256 'payinfo' => $self->cust_main->payinfo,
2264 Attempts to pay this invoice with a credit card payment via a
2265 Business::OnlinePayment realtime gateway. See
2266 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2267 for supported processors.
2273 $self->realtime_bop( 'CC', @_ );
2278 Attempts to pay this invoice with an electronic check (ACH) payment via a
2279 Business::OnlinePayment realtime gateway. See
2280 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2281 for supported processors.
2287 $self->realtime_bop( 'ECHECK', @_ );
2292 Attempts to pay this invoice with phone bill (LEC) payment via a
2293 Business::OnlinePayment realtime gateway. See
2294 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2295 for supported processors.
2301 $self->realtime_bop( 'LEC', @_ );
2305 my( $self, $method ) = (shift,shift);
2306 my $conf = $self->conf;
2309 my $cust_main = $self->cust_main;
2310 my $balance = $cust_main->balance;
2311 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2312 $amount = sprintf("%.2f", $amount);
2313 return "not run (balance $balance)" unless $amount > 0;
2315 my $description = 'Internet Services';
2316 if ( $conf->exists('business-onlinepayment-description') ) {
2317 my $dtempl = $conf->config('business-onlinepayment-description');
2319 my $agent_obj = $cust_main->agent
2320 or die "can't retreive agent for $cust_main (agentnum ".
2321 $cust_main->agentnum. ")";
2322 my $agent = $agent_obj->agent;
2323 my $pkgs = join(', ',
2324 map { $_->part_pkg->pkg }
2325 grep { $_->pkgnum } $self->cust_bill_pkg
2327 $description = eval qq("$dtempl");
2330 $cust_main->realtime_bop($method, $amount,
2331 'description' => $description,
2332 'invnum' => $self->invnum,
2333 #this didn't do what we want, it just calls apply_payments_and_credits
2335 'apply_to_invoice' => 1,
2338 #this changes application behavior: auto payments
2339 #triggered against a specific invoice are now applied
2340 #to that invoice instead of oldest open.
2346 =item batch_card OPTION => VALUE...
2348 Adds a payment for this invoice to the pending credit card batch (see
2349 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2350 runs the payment using a realtime gateway.
2355 my ($self, %options) = @_;
2356 my $cust_main = $self->cust_main;
2358 $options{invnum} = $self->invnum;
2360 $cust_main->batch_card(%options);
2363 sub _agent_template {
2365 $self->cust_main->agent_template;
2368 sub _agent_invoice_from {
2370 $self->cust_main->agent_invoice_from;
2373 =item invoice_barcode DIR_OR_FALSE
2375 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2376 it is taken as the temp directory where the PNG file will be generated and the
2377 PNG file name is returned. Otherwise, the PNG image itself is returned.
2381 sub invoice_barcode {
2382 my ($self, $dir) = (shift,shift);
2384 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2385 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2386 my $gd = $gdbar->plot(Height => 30);
2389 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2393 ) or die "can't open temp file: $!\n";
2394 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2395 my $png_file = $bh->filename;
2402 =item invnum_date_pretty
2404 Returns a string with the invoice number and date, for example:
2405 "Invoice #54 (3/20/2008)".
2407 Intended for back-end context, with regard to translation and date formatting.
2411 #note: this uses _date_pretty_unlocalized because _date_pretty is too expensive
2412 # for backend use (and also does the wrong thing, localizing for end customer
2413 # instead of backoffice configured date format)
2414 sub invnum_date_pretty {
2416 #$self->mt('Invoice #').
2417 'Invoice #'. #XXX should be translated ala web UI user (not invoice customer)
2418 $self->invnum. ' ('. $self->_date_pretty_unlocalized. ')';
2421 #sub _items_extra_usage_sections {
2423 # my $escape = shift;
2425 # my %sections = ();
2427 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2428 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2430 # next unless $cust_bill_pkg->pkgnum > 0;
2432 # foreach my $section ( keys %usage_class ) {
2434 # my $usage = $cust_bill_pkg->usage($section);
2436 # next unless $usage && $usage > 0;
2438 # $sections{$section} ||= 0;
2439 # $sections{$section} += $usage;
2445 # map { { 'description' => &{$escape}($_),
2446 # 'subtotal' => $sections{$_},
2447 # 'summarized' => '',
2448 # 'tax_section' => '',
2451 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2455 sub _items_extra_usage_sections {
2457 my $conf = $self->conf;
2465 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2467 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2468 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2469 next unless $cust_bill_pkg->pkgnum > 0;
2471 foreach my $classnum ( keys %usage_class ) {
2472 my $section = $usage_class{$classnum}->classname;
2473 $classnums{$section} = $classnum;
2475 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2476 my $amount = $detail->amount;
2477 next unless $amount && $amount > 0;
2479 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2480 $sections{$section}{amount} += $amount; #subtotal
2481 $sections{$section}{calls}++;
2482 $sections{$section}{duration} += $detail->duration;
2484 my $desc = $detail->regionname;
2485 my $description = $desc;
2486 $description = substr($desc, 0, $maxlength). '...'
2487 if $format eq 'latex' && length($desc) > $maxlength;
2489 $lines{$section}{$desc} ||= {
2490 description => &{$escape}($description),
2491 #pkgpart => $part_pkg->pkgpart,
2492 pkgnum => $cust_bill_pkg->pkgnum,
2497 #unit_amount => $cust_bill_pkg->unitrecur,
2498 quantity => $cust_bill_pkg->quantity,
2499 product_code => 'N/A',
2500 ext_description => [],
2503 $lines{$section}{$desc}{amount} += $amount;
2504 $lines{$section}{$desc}{calls}++;
2505 $lines{$section}{$desc}{duration} += $detail->duration;
2511 my %sectionmap = ();
2512 foreach (keys %sections) {
2513 my $usage_class = $usage_class{$classnums{$_}};
2514 $sectionmap{$_} = { 'description' => &{$escape}($_),
2515 'amount' => $sections{$_}{amount}, #subtotal
2516 'calls' => $sections{$_}{calls},
2517 'duration' => $sections{$_}{duration},
2519 'tax_section' => '',
2520 'sort_weight' => $usage_class->weight,
2521 ( $usage_class->format
2522 ? ( map { $_ => $usage_class->$_($format) }
2523 qw( description_generator header_generator total_generator total_line_generator )
2530 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2534 foreach my $section ( keys %lines ) {
2535 foreach my $line ( keys %{$lines{$section}} ) {
2536 my $l = $lines{$section}{$line};
2537 $l->{section} = $sectionmap{$section};
2538 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2539 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2544 return(\@sections, \@lines);
2550 my $end = $self->_date;
2552 # start at date of previous invoice + 1 second or 0 if no previous invoice
2553 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2554 $start = 0 if !$start;
2557 my $cust_main = $self->cust_main;
2558 my @pkgs = $cust_main->all_pkgs;
2559 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2562 foreach my $pkg ( @pkgs ) {
2563 my @h_cust_svc = $pkg->h_cust_svc($end);
2564 foreach my $h_cust_svc ( @h_cust_svc ) {
2565 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2566 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2568 my $inserted = $h_cust_svc->date_inserted;
2569 my $deleted = $h_cust_svc->date_deleted;
2570 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2572 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2574 # DID either activated or ported in; cannot be both for same DID simultaneously
2575 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2576 && (!$phone_inserted->lnp_status
2577 || $phone_inserted->lnp_status eq ''
2578 || $phone_inserted->lnp_status eq 'native')) {
2581 else { # this one not so clean, should probably move to (h_)svc_phone
2582 my $phone_portedin = qsearchs( 'h_svc_phone',
2583 { 'svcnum' => $h_cust_svc->svcnum,
2584 'lnp_status' => 'portedin' },
2585 FS::h_svc_phone->sql_h_searchs($end),
2587 $num_portedin++ if $phone_portedin;
2590 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2591 if($deleted >= $start && $deleted <= $end && $phone_deleted
2592 && (!$phone_deleted->lnp_status
2593 || $phone_deleted->lnp_status ne 'portingout')) {
2596 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2597 && $phone_deleted->lnp_status
2598 && $phone_deleted->lnp_status eq 'portingout') {
2602 # increment usage minutes
2603 if ( $phone_inserted ) {
2604 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2605 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2608 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2611 # don't look at this service again
2612 push @seen, $h_cust_svc->svcnum;
2616 $minutes = sprintf("%d", $minutes);
2617 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2618 . "$num_deactivated Ported-Out: $num_portedout ",
2619 "Total Minutes: $minutes");
2622 sub _items_accountcode_cdr {
2627 my $section = { 'amount' => 0,
2630 'sort_weight' => '',
2632 'description' => 'Usage by Account Code',
2638 my %accountcodes = ();
2640 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2641 next unless $cust_bill_pkg->pkgnum > 0;
2643 my @header = $cust_bill_pkg->details_header;
2644 next unless scalar(@header);
2645 $section->{'header'} = join(',',@header);
2647 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2649 $section->{'header'} = $detail->formatted('format' => $format)
2650 if($detail->detail eq $section->{'header'});
2652 my $accountcode = $detail->accountcode;
2653 next unless $accountcode;
2655 my $amount = $detail->amount;
2656 next unless $amount && $amount > 0;
2658 $accountcodes{$accountcode} ||= {
2659 description => $accountcode,
2666 product_code => 'N/A',
2667 section => $section,
2668 ext_description => [ $section->{'header'} ],
2672 $section->{'amount'} += $amount;
2673 $accountcodes{$accountcode}{'amount'} += $amount;
2674 $accountcodes{$accountcode}{calls}++;
2675 $accountcodes{$accountcode}{duration} += $detail->duration;
2676 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2680 foreach my $l ( values %accountcodes ) {
2681 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2682 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2683 foreach my $sorted_detail ( @sorted_detail ) {
2684 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2686 delete $l->{detail_temp};
2690 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2692 return ($section,\@sorted_lines);
2695 sub _items_svc_phone_sections {
2697 my $conf = $self->conf;
2705 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2707 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2708 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2710 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2711 next unless $cust_bill_pkg->pkgnum > 0;
2713 my @header = $cust_bill_pkg->details_header;
2714 next unless scalar(@header);
2716 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2718 my $phonenum = $detail->phonenum;
2719 next unless $phonenum;
2721 my $amount = $detail->amount;
2722 next unless $amount && $amount > 0;
2724 $sections{$phonenum} ||= { 'amount' => 0,
2727 'sort_weight' => -1,
2728 'phonenum' => $phonenum,
2730 $sections{$phonenum}{amount} += $amount; #subtotal
2731 $sections{$phonenum}{calls}++;
2732 $sections{$phonenum}{duration} += $detail->duration;
2734 my $desc = $detail->regionname;
2735 my $description = $desc;
2736 $description = substr($desc, 0, $maxlength). '...'
2737 if $format eq 'latex' && length($desc) > $maxlength;
2739 $lines{$phonenum}{$desc} ||= {
2740 description => &{$escape}($description),
2741 #pkgpart => $part_pkg->pkgpart,
2749 product_code => 'N/A',
2750 ext_description => [],
2753 $lines{$phonenum}{$desc}{amount} += $amount;
2754 $lines{$phonenum}{$desc}{calls}++;
2755 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2757 my $line = $usage_class{$detail->classnum}->classname;
2758 $sections{"$phonenum $line"} ||=
2762 'sort_weight' => $usage_class{$detail->classnum}->weight,
2763 'phonenum' => $phonenum,
2764 'header' => [ @header ],
2766 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2767 $sections{"$phonenum $line"}{calls}++;
2768 $sections{"$phonenum $line"}{duration} += $detail->duration;
2770 $lines{"$phonenum $line"}{$desc} ||= {
2771 description => &{$escape}($description),
2772 #pkgpart => $part_pkg->pkgpart,
2780 product_code => 'N/A',
2781 ext_description => [],
2784 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2785 $lines{"$phonenum $line"}{$desc}{calls}++;
2786 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2787 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2788 $detail->formatted('format' => $format);
2793 my %sectionmap = ();
2794 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2795 foreach ( keys %sections ) {
2796 my @header = @{ $sections{$_}{header} || [] };
2798 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2799 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2800 my $usage_class = $summary ? $simple : $usage_simple;
2801 my $ending = $summary ? ' usage charges' : '';
2804 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2806 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2807 'amount' => $sections{$_}{amount}, #subtotal
2808 'calls' => $sections{$_}{calls},
2809 'duration' => $sections{$_}{duration},
2811 'tax_section' => '',
2812 'phonenum' => $sections{$_}{phonenum},
2813 'sort_weight' => $sections{$_}{sort_weight},
2814 'post_total' => $summary, #inspire pagebreak
2816 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2817 qw( description_generator
2820 total_line_generator
2827 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2828 $a->{sort_weight} <=> $b->{sort_weight}
2833 foreach my $section ( keys %lines ) {
2834 foreach my $line ( keys %{$lines{$section}} ) {
2835 my $l = $lines{$section}{$line};
2836 $l->{section} = $sectionmap{$section};
2837 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2838 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2843 if($conf->exists('phone_usage_class_summary')) {
2844 # this only works with Latex
2848 # after this, we'll have only two sections per DID:
2849 # Calls Summary and Calls Detail
2850 foreach my $section ( @sections ) {
2851 if($section->{'post_total'}) {
2852 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2853 $section->{'total_line_generator'} = sub { '' };
2854 $section->{'total_generator'} = sub { '' };
2855 $section->{'header_generator'} = sub { '' };
2856 $section->{'description_generator'} = '';
2857 push @newsections, $section;
2858 my %calls_detail = %$section;
2859 $calls_detail{'post_total'} = '';
2860 $calls_detail{'sort_weight'} = '';
2861 $calls_detail{'description_generator'} = sub { '' };
2862 $calls_detail{'header_generator'} = sub {
2863 return ' & Date/Time & Called Number & Duration & Price'
2864 if $format eq 'latex';
2867 $calls_detail{'description'} = 'Calls Detail: '
2868 . $section->{'phonenum'};
2869 push @newsections, \%calls_detail;
2873 # after this, each usage class is collapsed/summarized into a single
2874 # line under the Calls Summary section
2875 foreach my $newsection ( @newsections ) {
2876 if($newsection->{'post_total'}) { # this means Calls Summary
2877 foreach my $section ( @sections ) {
2878 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2879 && !$section->{'post_total'});
2880 my $newdesc = $section->{'description'};
2881 my $tn = $section->{'phonenum'};
2882 $newdesc =~ s/$tn//g;
2883 my $line = { ext_description => [],
2887 calls => $section->{'calls'},
2888 section => $newsection,
2889 duration => $section->{'duration'},
2890 description => $newdesc,
2891 amount => sprintf("%.2f",$section->{'amount'}),
2892 product_code => 'N/A',
2894 push @newlines, $line;
2899 # after this, Calls Details is populated with all CDRs
2900 foreach my $newsection ( @newsections ) {
2901 if(!$newsection->{'post_total'}) { # this means Calls Details
2902 foreach my $line ( @lines ) {
2903 next unless (scalar(@{$line->{'ext_description'}}) &&
2904 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2906 my @extdesc = @{$line->{'ext_description'}};
2908 foreach my $extdesc ( @extdesc ) {
2909 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2910 push @newextdesc, $extdesc;
2912 $line->{'ext_description'} = \@newextdesc;
2913 $line->{'section'} = $newsection;
2914 push @newlines, $line;
2919 return(\@newsections, \@newlines);
2922 return(\@sections, \@lines);
2926 =sub _items_usage_class_summary OPTIONS
2928 Returns a list of detail items summarizing the usage charges on this
2929 invoice. Each one will have 'amount', 'description' (the usage charge name),
2930 and 'usage_classnum'.
2932 OPTIONS can include 'escape' (a function to escape the descriptions).
2936 sub _items_usage_class_summary {
2940 my $escape = $opt{escape} || sub { $_[0] };
2941 my $invnum = $self->invnum;
2942 my @classes = qsearch({
2943 'table' => 'usage_class',
2944 'select' => 'classnum, classname, SUM(amount) AS amount',
2945 'addl_from' => ' LEFT JOIN cust_bill_pkg_detail USING (classnum)' .
2946 ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
2947 'extra_sql' => " WHERE cust_bill_pkg.invnum = $invnum".
2948 ' GROUP BY classnum, classname, weight'.
2949 ' HAVING (usage_class.disabled IS NULL OR SUM(amount) > 0)'.
2950 ' ORDER BY weight ASC',
2954 description => &{$escape}($self->mt('Usage Summary')),
2958 foreach my $class (@classes) {
2960 'description' => &{$escape}($class->classname),
2961 'amount' => sprintf('%.2f', $class->amount),
2962 'usage_classnum' => $class->classnum,
2963 'section' => $section,
2969 sub _items_previous {
2971 my $conf = $self->conf;
2972 my $cust_main = $self->cust_main;
2973 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2975 foreach ( @pr_cust_bill ) {
2976 my $date = $conf->exists('invoice_show_prior_due_date')
2977 ? 'due '. $_->due_date2str('short')
2978 : $self->time2str_local('short', $_->_date);
2980 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2981 #'pkgpart' => 'N/A',
2983 'amount' => sprintf("%.2f", $_->owed),
2989 # 'description' => 'Previous Balance',
2990 # #'pkgpart' => 'N/A',
2991 # 'pkgnum' => 'N/A',
2992 # 'amount' => sprintf("%10.2f", $pr_total ),
2993 # 'ext_description' => [ map {
2994 # "Invoice ". $_->invnum.
2995 # " (". time2str("%x",$_->_date). ") ".
2996 # sprintf("%10.2f", $_->owed)
2997 # } @pr_cust_bill ],
3002 sub _items_credits {
3003 my( $self, %opt ) = @_;
3004 my $trim_len = $opt{'trim_len'} || 60;
3009 if ( $self->conf->exists('previous_balance-payments_since') ) {
3010 if ( $opt{'template'} eq 'statement' ) {
3011 # then the current bill is a "statement" (i.e. an invoice sent as
3012 # a payment receipt)
3013 # and in that case we want to see payments on or after THIS invoice
3014 @objects = qsearch('cust_credit', {
3015 'custnum' => $self->custnum,
3016 '_date' => {op => '>=', value => $self->_date},
3020 $date = $self->previous_bill->_date if $self->previous_bill;
3021 @objects = qsearch('cust_credit', {
3022 'custnum' => $self->custnum,
3023 '_date' => {op => '>=', value => $date},
3027 @objects = $self->cust_credited;
3030 foreach my $obj ( @objects ) {
3031 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
3033 my $reason = substr($cust_credit->reason, 0, $trim_len);
3034 $reason .= '...' if length($reason) < length($cust_credit->reason);
3035 $reason = " ($reason) " if $reason;
3038 #'description' => 'Credit ref\#'. $_->crednum.
3039 # " (". time2str("%x",$_->cust_credit->_date) .")".
3041 'description' => $self->mt('Credit applied').' '.
3042 $self->time2str_local('short', $obj->_date). $reason,
3043 'amount' => sprintf("%.2f",$obj->amount),
3051 sub _items_payments {
3056 my $detailed = $self->conf->exists('invoice_payment_details');
3058 if ( $self->conf->exists('previous_balance-payments_since') ) {
3059 # then show payments dated on/after the previous bill...
3060 if ( $opt{'template'} eq 'statement' ) {
3061 # then the current bill is a "statement" (i.e. an invoice sent as
3062 # a payment receipt)
3063 # and in that case we want to see payments on or after THIS invoice
3064 @objects = qsearch('cust_pay', {
3065 'custnum' => $self->custnum,
3066 '_date' => {op => '>=', value => $self->_date},
3069 # the normal case: payments on or after the previous invoice
3071 $date = $self->previous_bill->_date if $self->previous_bill;
3072 @objects = qsearch('cust_pay', {
3073 'custnum' => $self->custnum,
3074 '_date' => {op => '>=', value => $date},
3076 # and before the current bill...
3077 @objects = grep { $_->_date < $self->_date } @objects;
3080 @objects = $self->cust_bill_pay;
3083 foreach my $obj (@objects) {
3084 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
3085 my $desc = $self->mt('Payment received').' '.
3086 $self->time2str_local('short', $cust_pay->_date );
3087 $desc .= $self->mt(' via ') .
3088 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
3092 'description' => $desc,
3093 'amount' => sprintf("%.2f", $obj->amount )
3101 =item call_details [ OPTION => VALUE ... ]
3103 Returns an array of CSV strings representing the call details for this invoice
3104 The only option available is the boolean prepend_billed_number
3109 my ($self, %opt) = @_;
3111 my $format_function = sub { shift };
3113 if ($opt{prepend_billed_number}) {
3114 $format_function = sub {
3118 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3123 my @details = map { $_->details( 'format_function' => $format_function,
3124 'escape_function' => sub{ return() },
3128 $self->cust_bill_pkg;
3129 my $header = $details[0];
3130 ( $header, grep { $_ ne $header } @details );
3140 =item process_reprint
3144 sub process_reprint {
3145 process_re_X('print', @_);
3148 =item process_reemail
3152 sub process_reemail {
3153 process_re_X('email', @_);
3161 process_re_X('fax', @_);
3169 process_re_X('ftp', @_);
3176 sub process_respool {
3177 process_re_X('spool', @_);
3182 my( $method, $job ) = ( shift, shift );
3183 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3186 warn Dumper($param) if $DEBUG;
3197 # spool_invoice ftp_invoice fax_invoice print_invoice
3198 my($method, $job, %param ) = @_;
3200 warn "re_X $method for job $job with param:\n".
3201 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3204 #some false laziness w/search/cust_bill.html
3206 my $orderby = 'ORDER BY cust_bill._date';
3208 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3210 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3212 my @cust_bill = qsearch( {
3213 #'select' => "cust_bill.*",
3214 'table' => 'cust_bill',
3215 'addl_from' => $addl_from,
3217 'extra_sql' => $extra_sql,
3218 'order_by' => $orderby,
3222 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3224 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3227 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3228 foreach my $cust_bill ( @cust_bill ) {
3229 $cust_bill->$method();
3231 if ( $job ) { #progressbar foo
3233 if ( time - $min_sec > $last ) {
3234 my $error = $job->update_statustext(
3235 int( 100 * $num / scalar(@cust_bill) )
3237 die $error if $error;
3248 +{ ( map { $_=>$self->$_ } $self->fields ),
3249 'owed' => $self->owed,
3250 #XXX last payment applied date
3256 =head1 CLASS METHODS
3262 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3267 my ($class, $start, $end) = @_;
3269 $class->paid_sql($start, $end). ' - '.
3270 $class->credited_sql($start, $end);
3275 Returns an SQL fragment to retreive the net amount (charged minus credited).
3280 my ($class, $start, $end) = @_;
3281 'charged - '. $class->credited_sql($start, $end);
3286 Returns an SQL fragment to retreive the amount paid against this invoice.
3291 my ($class, $start, $end) = @_;
3292 $start &&= "AND cust_bill_pay._date <= $start";
3293 $end &&= "AND cust_bill_pay._date > $end";
3294 $start = '' unless defined($start);
3295 $end = '' unless defined($end);
3296 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3297 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3302 Returns an SQL fragment to retreive the amount credited against this invoice.
3307 my ($class, $start, $end) = @_;
3308 $start &&= "AND cust_credit_bill._date <= $start";
3309 $end &&= "AND cust_credit_bill._date > $end";
3310 $start = '' unless defined($start);
3311 $end = '' unless defined($end);
3312 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3313 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3318 Returns an SQL fragment to retrieve the due date of an invoice.
3319 Currently only supported on PostgreSQL.
3324 my $conf = new FS::Conf;
3328 cust_bill.invoice_terms,
3329 cust_main.invoice_terms,
3330 \''.($conf->config('invoice_default_terms') || '').'\'
3331 ), E\'Net (\\\\d+)\'
3333 ) * 86400 + cust_bill._date'
3336 =item search_sql_where HASHREF
3338 Class method which returns an SQL WHERE fragment to search for parameters
3339 specified in HASHREF. Valid parameters are
3345 List reference of start date, end date, as UNIX timestamps.
3355 List reference of charged limits (exclusive).
3359 List reference of charged limits (exclusive).
3363 flag, return open invoices only
3367 flag, return net invoices only
3371 =item newest_percust
3375 Return only invoices belonging to that customer.
3379 Limit to that customer class (single value or arrayref).
3383 Limit to customers with that payment method (single value or arrayref).
3387 Limit to customers with that advertising source.
3391 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3395 sub search_sql_where {
3396 my($class, $param) = @_;
3398 warn "$me search_sql_where called with params: \n".
3399 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
3405 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3406 push @search, "cust_main.agentnum = $1";
3410 if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3411 push @search, "cust_main.refnum = $1";
3415 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3416 push @search, "cust_bill.custnum = $1";
3419 #customer classnum (false laziness w/ cust_main/Search.pm)
3420 if ( $param->{'cust_classnum'} ) {
3422 my @classnum = ref( $param->{'cust_classnum'} )
3423 ? @{ $param->{'cust_classnum'} }
3424 : ( $param->{'cust_classnum'} );
3426 @classnum = grep /^(\d*)$/, @classnum;
3429 push @search, '( '. join(' OR ', map {
3430 $_ ? "cust_main.classnum = $_"
3431 : "cust_main.classnum IS NULL"
3441 if ( $param->{payby} ) {
3442 my $payby = $param->{payby};
3443 $payby = [ $payby ] unless ref $payby;
3444 my $payby_in = join(',', map {dbh->quote($_)} @$payby);
3445 push @search, "cust_main.payby IN($payby_in)" if length($payby_in);
3449 if ( $param->{_date} ) {
3450 my($beginning, $ending) = @{$param->{_date}};
3452 push @search, "cust_bill._date >= $beginning",
3453 "cust_bill._date < $ending";
3457 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3458 push @search, "cust_bill.invnum >= $1";
3460 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3461 push @search, "cust_bill.invnum <= $1";
3465 if ( $param->{charged} ) {
3466 my @charged = ref($param->{charged})
3467 ? @{ $param->{charged} }
3468 : ($param->{charged});
3470 push @search, map { s/^charged/cust_bill.charged/; $_; }
3474 my $owed_sql = FS::cust_bill->owed_sql;
3477 if ( $param->{owed} ) {
3478 my @owed = ref($param->{owed})
3479 ? @{ $param->{owed} }
3481 push @search, map { s/^owed/$owed_sql/; $_; }
3486 push @search, "0 != $owed_sql"
3487 if $param->{'open'};
3488 push @search, '0 != '. FS::cust_bill->net_sql
3492 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3493 if $param->{'days'};
3496 if ( $param->{'newest_percust'} ) {
3498 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3499 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3501 my @newest_where = map { my $x = $_;
3502 $x =~ s/\bcust_bill\./newest_cust_bill./g;
3505 grep ! /^cust_main./, @search;
3506 my $newest_where = scalar(@newest_where)
3507 ? ' AND '. join(' AND ', @newest_where)
3511 push @search, "cust_bill._date = (
3512 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3513 WHERE newest_cust_bill.custnum = cust_bill.custnum
3519 #promised_date - also has an option to accept nulls
3520 if ( $param->{promised_date} ) {
3521 my($beginning, $ending, $null) = @{$param->{promised_date}};
3523 push @search, "(( cust_bill.promised_date >= $beginning AND ".
3524 "cust_bill.promised_date < $ending )" .
3525 ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3528 #agent virtualization
3529 my $curuser = $FS::CurrentUser::CurrentUser;
3530 if ( $curuser->username eq 'fs_queue'
3531 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3533 my $newuser = qsearchs('access_user', {
3534 'username' => $username,
3538 $curuser = $newuser;
3540 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3543 push @search, $curuser->agentnums_sql;
3545 join(' AND ', @search );
3557 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3558 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base