2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::Record );
5 use vars qw( $DEBUG $me $date_format );
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 );
19 use FS::cust_statement;
20 use FS::cust_bill_pkg;
21 use FS::cust_bill_pkg_display;
22 use FS::cust_bill_pkg_detail;
26 use FS::cust_credit_bill;
28 use FS::cust_pay_batch;
29 use FS::cust_bill_event;
32 use FS::cust_bill_pay;
33 use FS::cust_bill_pay_batch;
34 use FS::part_bill_event;
37 use FS::cust_bill_batch;
38 use FS::cust_bill_pay_pkg;
39 use FS::cust_credit_bill_pkg;
40 use FS::discount_plan;
41 use FS::cust_bill_void;
45 $me = '[FS::cust_bill]';
47 #ask FS::UID to run this stuff for us later
48 FS::UID->install_callback( sub {
49 my $conf = new FS::Conf; #global
50 $date_format = $conf->config('date_format') || '%x'; #/YY
55 FS::cust_bill - Object methods for cust_bill records
61 $record = new FS::cust_bill \%hash;
62 $record = new FS::cust_bill { 'column' => 'value' };
64 $error = $record->insert;
66 $error = $new_record->replace($old_record);
68 $error = $record->delete;
70 $error = $record->check;
72 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
74 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
76 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
78 @cust_pay_objects = $cust_bill->cust_pay;
80 $tax_amount = $record->tax;
82 @lines = $cust_bill->print_text;
83 @lines = $cust_bill->print_text('time' => $time);
87 An FS::cust_bill object represents an invoice; a declaration that a customer
88 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
89 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
90 following fields are currently supported:
96 =item invnum - primary key (assigned automatically for new invoices)
98 =item custnum - customer (see L<FS::cust_main>)
100 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
101 L<Time::Local> and L<Date::Parse> for conversion functions.
103 =item charged - amount of this invoice
105 =item invoice_terms - optional terms override for this specific invoice
109 Customer info at invoice generation time
113 =item billing_balance - the customer's balance at the time the invoice was
114 generated (not including charges on this invoice)
116 =item previous_balance - the billing_balance of this customer's previous
117 invoice plus the charges on that invoice
125 =item printed - deprecated
133 =item closed - books closed flag, empty or `Y'
135 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
137 =item agent_invid - legacy invoice number
139 =item promised_date - customer promised payment date, for collection
149 Creates a new invoice. To add the invoice to the database, see L<"insert">.
150 Invoices are normally created by calling the bill method of a customer object
151 (see L<FS::cust_main>).
155 sub table { 'cust_bill'; }
157 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
158 # (except email_subject and invnum_date_pretty)
161 $self->conf->config('notice_name') || 'Invoice'
164 sub cust_linked { $_[0]->cust_main_custnum; }
165 sub cust_unlinked_msg {
167 "WARNING: can't find cust_main.custnum ". $self->custnum.
168 ' (cust_bill.invnum '. $self->invnum. ')';
173 Adds this invoice to the database ("Posts" the invoice). If there is an error,
174 returns the error, otherwise returns false.
180 warn "$me insert called\n" if $DEBUG;
182 local $SIG{HUP} = 'IGNORE';
183 local $SIG{INT} = 'IGNORE';
184 local $SIG{QUIT} = 'IGNORE';
185 local $SIG{TERM} = 'IGNORE';
186 local $SIG{TSTP} = 'IGNORE';
187 local $SIG{PIPE} = 'IGNORE';
189 my $oldAutoCommit = $FS::UID::AutoCommit;
190 local $FS::UID::AutoCommit = 0;
193 my $error = $self->SUPER::insert;
195 $dbh->rollback if $oldAutoCommit;
199 if ( $self->get('cust_bill_pkg') ) {
200 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
201 $cust_bill_pkg->invnum($self->invnum);
202 my $error = $cust_bill_pkg->insert;
204 $dbh->rollback if $oldAutoCommit;
205 return "can't create invoice line item: $error";
210 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
217 Voids this invoice: deletes the invoice and adds a record of the voided invoice
218 to the FS::cust_bill_void table (and related tables starting from
219 FS::cust_bill_pkg_void).
225 my $reason = scalar(@_) ? shift : '';
227 local $SIG{HUP} = 'IGNORE';
228 local $SIG{INT} = 'IGNORE';
229 local $SIG{QUIT} = 'IGNORE';
230 local $SIG{TERM} = 'IGNORE';
231 local $SIG{TSTP} = 'IGNORE';
232 local $SIG{PIPE} = 'IGNORE';
234 my $oldAutoCommit = $FS::UID::AutoCommit;
235 local $FS::UID::AutoCommit = 0;
238 my $cust_bill_void = new FS::cust_bill_void ( {
239 map { $_ => $self->get($_) } $self->fields
241 $cust_bill_void->reason($reason);
242 my $error = $cust_bill_void->insert;
244 $dbh->rollback if $oldAutoCommit;
248 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
249 my $error = $cust_bill_pkg->void($reason);
251 $dbh->rollback if $oldAutoCommit;
256 $error = $self->delete;
258 $dbh->rollback if $oldAutoCommit;
262 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
270 This method now works but you probably shouldn't use it. Instead, apply a
271 credit against the invoice, or use the new void method.
273 Using this method to delete invoices outright is really, really bad. There
274 would be no record you ever posted this invoice, and there are no check to
275 make sure charged = 0 or that there are no associated cust_bill_pkg records.
277 Really, don't use it.
283 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
285 local $SIG{HUP} = 'IGNORE';
286 local $SIG{INT} = 'IGNORE';
287 local $SIG{QUIT} = 'IGNORE';
288 local $SIG{TERM} = 'IGNORE';
289 local $SIG{TSTP} = 'IGNORE';
290 local $SIG{PIPE} = 'IGNORE';
292 my $oldAutoCommit = $FS::UID::AutoCommit;
293 local $FS::UID::AutoCommit = 0;
296 foreach my $table (qw(
307 foreach my $linked ( $self->$table() ) {
308 my $error = $linked->delete;
310 $dbh->rollback if $oldAutoCommit;
317 my $error = $self->SUPER::delete(@_);
319 $dbh->rollback if $oldAutoCommit;
323 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
329 =item replace [ OLD_RECORD ]
331 You can, but probably shouldn't modify invoices...
333 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
334 supplied, replaces this record. If there is an error, returns the error,
335 otherwise returns false.
339 #replace can be inherited from Record.pm
341 # replace_check is now the preferred way to #implement replace data checks
342 # (so $object->replace() works without an argument)
345 my( $new, $old ) = ( shift, shift );
346 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
347 #return "Can't change _date!" unless $old->_date eq $new->_date;
348 return "Can't change _date" unless $old->_date == $new->_date;
349 return "Can't change charged" unless $old->charged == $new->charged
350 || $old->charged == 0
351 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
357 =item add_cc_surcharge
363 sub add_cc_surcharge {
364 my ($self, $pkgnum, $amount) = (shift, shift, shift);
367 my $cust_bill_pkg = new FS::cust_bill_pkg({
368 'invnum' => $self->invnum,
372 $error = $cust_bill_pkg->insert;
373 return $error if $error;
375 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
376 $self->charged($self->charged+$amount);
377 $error = $self->replace;
378 return $error if $error;
380 $self->apply_payments_and_credits;
386 Checks all fields to make sure this is a valid invoice. If there is an error,
387 returns the error, otherwise returns false. Called by the insert and replace
396 $self->ut_numbern('invnum')
397 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
398 || $self->ut_numbern('_date')
399 || $self->ut_money('charged')
400 || $self->ut_numbern('printed')
401 || $self->ut_enum('closed', [ '', 'Y' ])
402 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
403 || $self->ut_numbern('agent_invid') #varchar?
405 return $error if $error;
407 $self->_date(time) unless $self->_date;
409 $self->printed(0) if $self->printed eq '';
416 Returns the displayed invoice number for this invoice: agent_invid if
417 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
423 my $conf = $self->conf;
424 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
425 return $self->agent_invid;
427 return $self->invnum;
433 Returns the customer's last invoice before this one.
439 if ( !$self->get('previous_bill') ) {
440 $self->set('previous_bill', qsearchs({
441 'table' => 'cust_bill',
442 'hashref' => { 'custnum' => $self->custnum,
443 '_date' => { op=>'<', value=>$self->_date } },
444 'order_by' => 'ORDER BY _date DESC LIMIT 1',
447 $self->get('previous_bill');
452 Returns a list consisting of the total previous balance for this customer,
453 followed by the previous outstanding invoices (as FS::cust_bill objects also).
460 my @cust_bill = sort { $a->_date <=> $b->_date }
461 grep { $_->owed != 0 }
462 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
463 #'_date' => { op=>'<', value=>$self->_date },
464 'invnum' => { op=>'<', value=>$self->invnum },
467 foreach ( @cust_bill ) { $total += $_->owed; }
471 =item enable_previous
473 Whether to show the 'Previous Charges' section when printing this invoice.
474 The negation of the 'disable_previous_balance' config setting.
478 sub enable_previous {
480 my $agentnum = $self->cust_main->agentnum;
481 !$self->conf->exists('disable_previous_balance', $agentnum);
486 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
493 { 'table' => 'cust_bill_pkg',
494 'hashref' => { 'invnum' => $self->invnum },
495 'order_by' => 'ORDER BY billpkgnum',
500 =item cust_bill_pkg_pkgnum PKGNUM
502 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
507 sub cust_bill_pkg_pkgnum {
508 my( $self, $pkgnum ) = @_;
510 { 'table' => 'cust_bill_pkg',
511 'hashref' => { 'invnum' => $self->invnum,
514 'order_by' => 'ORDER BY billpkgnum',
521 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
528 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
529 $self->cust_bill_pkg;
531 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
536 Returns true if any of the packages (or their definitions) corresponding to the
537 line items for this invoice have the no_auto flag set.
543 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
546 =item open_cust_bill_pkg
548 Returns the open line items for this invoice.
550 Note that cust_bill_pkg with both setup and recur fees are returned as two
551 separate line items, each with only one fee.
555 # modeled after cust_main::open_cust_bill
556 sub open_cust_bill_pkg {
559 # grep { $_->owed > 0 } $self->cust_bill_pkg
561 my %other = ( 'recur' => 'setup',
562 'setup' => 'recur', );
564 foreach my $field ( qw( recur setup )) {
565 push @open, map { $_->set( $other{$field}, 0 ); $_; }
566 grep { $_->owed($field) > 0 }
567 $self->cust_bill_pkg;
573 =item cust_bill_event
575 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
579 sub cust_bill_event {
581 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
584 =item num_cust_bill_event
586 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
590 sub num_cust_bill_event {
593 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
594 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
595 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
596 $sth->fetchrow_arrayref->[0];
601 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
605 #false laziness w/cust_pkg.pm
609 'table' => 'cust_event',
610 'addl_from' => 'JOIN part_event USING ( eventpart )',
611 'hashref' => { 'tablenum' => $self->invnum },
612 'extra_sql' => " AND eventtable = 'cust_bill' ",
618 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
622 #false laziness w/cust_pkg.pm
626 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
627 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
628 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
629 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
630 $sth->fetchrow_arrayref->[0];
635 Returns the customer (see L<FS::cust_main>) for this invoice.
641 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
644 =item cust_suspend_if_balance_over AMOUNT
646 Suspends the customer associated with this invoice if the total amount owed on
647 this invoice and all older invoices is greater than the specified amount.
649 Returns a list: an empty list on success or a list of errors.
653 sub cust_suspend_if_balance_over {
654 my( $self, $amount ) = ( shift, shift );
655 my $cust_main = $self->cust_main;
656 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
659 $cust_main->suspend(@_);
665 Depreciated. See the cust_credited method.
667 #Returns a list consisting of the total previous credited (see
668 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
669 #outstanding credits (FS::cust_credit objects).
675 croak "FS::cust_bill->cust_credit depreciated; see ".
676 "FS::cust_bill->cust_credit_bill";
679 #my @cust_credit = sort { $a->_date <=> $b->_date }
680 # grep { $_->credited != 0 && $_->_date < $self->_date }
681 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
683 #foreach (@cust_credit) { $total += $_->credited; }
684 #$total, @cust_credit;
689 Depreciated. See the cust_bill_pay method.
691 #Returns all payments (see L<FS::cust_pay>) for this invoice.
697 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
699 #sort { $a->_date <=> $b->_date }
700 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
706 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
709 sub cust_bill_pay_batch {
711 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
716 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
722 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
723 sort { $a->_date <=> $b->_date }
724 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
729 =item cust_credit_bill
731 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
737 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
738 sort { $a->_date <=> $b->_date }
739 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
743 sub cust_credit_bill {
744 shift->cust_credited(@_);
747 #=item cust_bill_pay_pkgnum PKGNUM
749 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
750 #with matching pkgnum.
754 #sub cust_bill_pay_pkgnum {
755 # my( $self, $pkgnum ) = @_;
756 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
757 # sort { $a->_date <=> $b->_date }
758 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
759 # 'pkgnum' => $pkgnum,
764 =item cust_bill_pay_pkg PKGNUM
766 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
767 applied against the matching pkgnum.
771 sub cust_bill_pay_pkg {
772 my( $self, $pkgnum ) = @_;
775 'select' => 'cust_bill_pay_pkg.*',
776 'table' => 'cust_bill_pay_pkg',
777 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
778 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
779 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
780 " AND cust_bill_pkg.pkgnum = $pkgnum",
785 #=item cust_credited_pkgnum PKGNUM
787 #=item cust_credit_bill_pkgnum PKGNUM
789 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
790 #with matching pkgnum.
794 #sub cust_credited_pkgnum {
795 # my( $self, $pkgnum ) = @_;
796 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
797 # sort { $a->_date <=> $b->_date }
798 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
799 # 'pkgnum' => $pkgnum,
804 #sub cust_credit_bill_pkgnum {
805 # shift->cust_credited_pkgnum(@_);
808 =item cust_credit_bill_pkg PKGNUM
810 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
811 applied against the matching pkgnum.
815 sub cust_credit_bill_pkg {
816 my( $self, $pkgnum ) = @_;
819 'select' => 'cust_credit_bill_pkg.*',
820 'table' => 'cust_credit_bill_pkg',
821 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
822 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
823 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
824 " AND cust_bill_pkg.pkgnum = $pkgnum",
829 =item cust_bill_batch
831 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
835 sub cust_bill_batch {
837 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
842 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
843 hash keyed by term length.
849 FS::discount_plan->all($self);
854 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
861 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
863 foreach (@taxlines) { $total += $_->setup; }
869 Returns the amount owed (still outstanding) on this invoice, which is charged
870 minus all payment applications (see L<FS::cust_bill_pay>) and credit
871 applications (see L<FS::cust_credit_bill>).
877 my $balance = $self->charged;
878 $balance -= $_->amount foreach ( $self->cust_bill_pay );
879 $balance -= $_->amount foreach ( $self->cust_credited );
880 $balance = sprintf( "%.2f", $balance);
881 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
886 my( $self, $pkgnum ) = @_;
888 #my $balance = $self->charged;
890 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
892 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
893 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
895 $balance = sprintf( "%.2f", $balance);
896 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
902 Returns true if this invoice should be hidden. See the
903 selfservice-hide_invoices-taxclass configuraiton setting.
909 my $conf = $self->conf;
910 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
912 my @cust_bill_pkg = $self->cust_bill_pkg;
913 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
914 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
917 =item apply_payments_and_credits [ OPTION => VALUE ... ]
919 Applies unapplied payments and credits to this invoice.
921 A hash of optional arguments may be passed. Currently "manual" is supported.
922 If true, a payment receipt is sent instead of a statement when
923 'payment_receipt_email' configuration option is set.
925 If there is an error, returns the error, otherwise returns false.
929 sub apply_payments_and_credits {
930 my( $self, %options ) = @_;
931 my $conf = $self->conf;
933 local $SIG{HUP} = 'IGNORE';
934 local $SIG{INT} = 'IGNORE';
935 local $SIG{QUIT} = 'IGNORE';
936 local $SIG{TERM} = 'IGNORE';
937 local $SIG{TSTP} = 'IGNORE';
938 local $SIG{PIPE} = 'IGNORE';
940 my $oldAutoCommit = $FS::UID::AutoCommit;
941 local $FS::UID::AutoCommit = 0;
944 $self->select_for_update; #mutex
946 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
947 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
949 if ( $conf->exists('pkg-balances') ) {
950 # limit @payments & @credits to those w/ a pkgnum grepped from $self
951 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
952 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
953 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
956 while ( $self->owed > 0 and ( @payments || @credits ) ) {
959 if ( @payments && @credits ) {
961 #decide which goes first by weight of top (unapplied) line item
963 my @open_lineitems = $self->open_cust_bill_pkg;
966 max( map { $_->part_pkg->pay_weight || 0 }
971 my $max_credit_weight =
972 max( map { $_->part_pkg->credit_weight || 0 }
978 #if both are the same... payments first? it has to be something
979 if ( $max_pay_weight >= $max_credit_weight ) {
985 } elsif ( @payments ) {
987 } elsif ( @credits ) {
990 die "guru meditation #12 and 35";
994 if ( $app eq 'pay' ) {
996 my $payment = shift @payments;
997 $unapp_amount = $payment->unapplied;
998 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
999 $app->pkgnum( $payment->pkgnum )
1000 if $conf->exists('pkg-balances') && $payment->pkgnum;
1002 } elsif ( $app eq 'credit' ) {
1004 my $credit = shift @credits;
1005 $unapp_amount = $credit->credited;
1006 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
1007 $app->pkgnum( $credit->pkgnum )
1008 if $conf->exists('pkg-balances') && $credit->pkgnum;
1011 die "guru meditation #12 and 35";
1015 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
1016 warn "owed_pkgnum ". $app->pkgnum;
1017 $owed = $self->owed_pkgnum($app->pkgnum);
1019 $owed = $self->owed;
1021 next unless $owed > 0;
1023 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
1024 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
1026 $app->invnum( $self->invnum );
1028 my $error = $app->insert(%options);
1030 $dbh->rollback if $oldAutoCommit;
1031 return "Error inserting ". $app->table. " record: $error";
1033 die $error if $error;
1037 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1042 =item generate_email OPTION => VALUE ...
1050 sender address, required
1054 alternate template name, optional
1058 text attachment arrayref, optional
1062 email subject, optional
1066 notice name instead of "Invoice", optional
1070 Returns an argument list to be passed to L<FS::Misc::send_email>.
1076 sub generate_email {
1080 my $conf = $self->conf;
1082 my $me = '[FS::cust_bill::generate_email]';
1085 'from' => $args{'from'},
1086 'subject' => ($args{'subject'} || $self->email_subject),
1089 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
1091 my $cust_main = $self->cust_main;
1093 if (ref($args{'to'}) eq 'ARRAY') {
1094 $return{'to'} = $args{'to'};
1096 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1097 $cust_main->invoicing_list
1101 if ( $conf->exists('invoice_html') ) {
1103 warn "$me creating HTML/text multipart message"
1106 $return{'nobody'} = 1;
1108 my $alternative = build MIME::Entity
1109 'Type' => 'multipart/alternative',
1110 #'Encoding' => '7bit',
1111 'Disposition' => 'inline'
1115 if ( $conf->exists('invoice_email_pdf')
1116 and scalar($conf->config('invoice_email_pdf_note')) ) {
1118 warn "$me using 'invoice_email_pdf_note' in multipart message"
1120 $data = [ map { $_ . "\n" }
1121 $conf->config('invoice_email_pdf_note')
1126 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1128 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1129 $data = $args{'print_text'};
1131 $data = [ $self->print_text(\%args) ];
1136 $alternative->attach(
1137 'Type' => 'text/plain',
1138 'Encoding' => 'quoted-printable',
1139 #'Encoding' => '7bit',
1141 'Disposition' => 'inline',
1148 if ( $conf->exists('invoice_email_pdf')
1149 and scalar($conf->config('invoice_email_pdf_note')) ) {
1151 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1155 $args{'from'} =~ /\@([\w\.\-]+)/;
1156 my $from = $1 || 'example.com';
1157 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1160 my $agentnum = $cust_main->agentnum;
1161 if ( defined($args{'template'}) && length($args{'template'})
1162 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1165 $logo = 'logo_'. $args{'template'}. '.png';
1169 my $image_data = $conf->config_binary( $logo, $agentnum);
1171 $image = build MIME::Entity
1172 'Type' => 'image/png',
1173 'Encoding' => 'base64',
1174 'Data' => $image_data,
1175 'Filename' => 'logo.png',
1176 'Content-ID' => "<$content_id>",
1179 if ($conf->exists('invoice-barcode')) {
1180 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1181 $barcode = build MIME::Entity
1182 'Type' => 'image/png',
1183 'Encoding' => 'base64',
1184 'Data' => $self->invoice_barcode(0),
1185 'Filename' => 'barcode.png',
1186 'Content-ID' => "<$barcode_content_id>",
1188 $args{'barcode_cid'} = $barcode_content_id;
1191 $htmldata = $self->print_html({ 'cid'=>$content_id, %args });
1194 $alternative->attach(
1195 'Type' => 'text/html',
1196 'Encoding' => 'quoted-printable',
1197 'Data' => [ '<html>',
1200 ' '. encode_entities($return{'subject'}),
1203 ' <body bgcolor="#e8e8e8">',
1208 'Disposition' => 'inline',
1209 #'Filename' => 'invoice.pdf',
1213 my @otherparts = ();
1214 if ( $cust_main->email_csv_cdr ) {
1216 push @otherparts, build MIME::Entity
1217 'Type' => 'text/csv',
1218 'Encoding' => '7bit',
1219 'Data' => [ map { "$_\n" }
1220 $self->call_details('prepend_billed_number' => 1)
1222 'Disposition' => 'attachment',
1223 'Filename' => 'usage-'. $self->invnum. '.csv',
1228 if ( $conf->exists('invoice_email_pdf') ) {
1233 # multipart/alternative
1239 my $related = build MIME::Entity 'Type' => 'multipart/related',
1240 'Encoding' => '7bit';
1242 #false laziness w/Misc::send_email
1243 $related->head->replace('Content-type',
1244 $related->mime_type.
1245 '; boundary="'. $related->head->multipart_boundary. '"'.
1246 '; type=multipart/alternative'
1249 $related->add_part($alternative);
1251 $related->add_part($image) if $image;
1253 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
1255 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1259 #no other attachment:
1261 # multipart/alternative
1266 $return{'content-type'} = 'multipart/related';
1267 if ($conf->exists('invoice-barcode') && $barcode) {
1268 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1270 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1272 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1273 #$return{'disposition'} = 'inline';
1279 if ( $conf->exists('invoice_email_pdf') ) {
1280 warn "$me creating PDF attachment"
1283 #mime parts arguments a la MIME::Entity->build().
1284 $return{'mimeparts'} = [
1285 { $self->mimebuild_pdf(\%args) }
1289 if ( $conf->exists('invoice_email_pdf')
1290 and scalar($conf->config('invoice_email_pdf_note')) ) {
1292 warn "$me using 'invoice_email_pdf_note'"
1294 $return{'body'} = [ map { $_ . "\n" }
1295 $conf->config('invoice_email_pdf_note')
1300 warn "$me not using 'invoice_email_pdf_note'"
1302 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1303 $return{'body'} = $args{'print_text'};
1305 $return{'body'} = [ $self->print_text(\%args) ];
1318 Returns a list suitable for passing to MIME::Entity->build(), representing
1319 this invoice as PDF attachment.
1326 'Type' => 'application/pdf',
1327 'Encoding' => 'base64',
1328 'Data' => [ $self->print_pdf(@_) ],
1329 'Disposition' => 'attachment',
1330 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1336 Sends this invoice to the destinations configured for this customer: sends
1337 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1339 Options can be passed as a hashref. Positional parameters are no longer
1342 I<template>: a suffix for alternate invoices
1344 I<agentnum>: obsolete, now does nothing.
1346 I<invoice_from> overrides the default email invoice From: address.
1348 I<amount>: obsolete, does nothing
1350 I<notice_name> overrides "Invoice" as the name of the sent document
1351 (templates from 10/2009 or newer required).
1353 I<lpr> overrides the system 'lpr' option as the command to print a document
1354 from standard input.
1360 my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1361 my $conf = $self->conf;
1363 my $cust_main = $self->cust_main;
1365 my @invoicing_list = $cust_main->invoicing_list;
1368 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1369 && ! $self->invoice_noemail;
1372 if grep { $_ eq 'POST' } @invoicing_list; #postal
1374 #this has never been used post-$ORIGINAL_ISP afaik
1375 $self->fax_invoice($opt)
1376 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1382 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1384 Sends this invoice to the customer's email destination(s).
1386 Options must be passed as a hashref. Positional parameters are no longer
1389 I<template>, if specified, is the name of a suffix for alternate invoices.
1391 I<invoice_from>, if specified, overrides the default email invoice From:
1394 I<notice_name> is the name of the sent document.
1398 sub queueable_email {
1401 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1402 or die "invalid invoice number: " . $opt{invnum};
1404 my %args = map {$_ => $opt{$_}}
1406 qw( invoice_from notice_name no_coupon template );
1408 my $error = $self->email( \%args );
1409 die $error if $error;
1415 return if $self->hide;
1416 my $conf = $self->conf;
1417 my $opt = shift || {};
1418 if ($opt and !ref($opt)) {
1419 die "FS::cust_bill::email called with positional parameters";
1422 my $template = $opt->{template};
1423 my $from = delete $opt->{invoice_from};
1425 # this is where we set the From: address
1426 $from ||= $self->_agent_invoice_from || #XXX should go away
1427 $conf->config('invoice_from', $self->cust_main->agentnum );
1429 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1430 $self->cust_main->invoicing_list;
1432 if ( ! @invoicing_list ) { #no recipients
1433 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1434 die 'No recipients for customer #'. $self->custnum;
1436 #default: better to notify this person than silence
1437 @invoicing_list = ($from);
1441 # this is where we set the Subject:
1442 my $subject = $self->email_subject($template);
1444 my $error = send_email(
1445 $self->generate_email(
1447 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1448 'subject' => $subject,
1449 %$opt, # template, etc.
1452 die "can't email invoice: $error\n" if $error;
1453 #die "$error\n" if $error;
1459 my $conf = $self->conf;
1461 #my $template = scalar(@_) ? shift : '';
1464 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1467 my $cust_main = $self->cust_main;
1468 my $name = $cust_main->name;
1469 my $name_short = $cust_main->name_short;
1470 my $invoice_number = $self->invnum;
1471 my $invoice_date = $self->_date_pretty;
1473 eval qq("$subject");
1476 =item lpr_data HASHREF
1478 Returns the postscript or plaintext for this invoice as an arrayref.
1480 Options must be passed as a hashref. Positional parameters are no longer
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 my $conf = $self->conf;
1492 my $opt = shift || {};
1493 if ($opt and !ref($opt)) {
1494 # nobody does this anyway
1495 die "FS::cust_bill::lpr_data called with positional parameters";
1498 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1499 [ $self->$method( $opt ) ];
1504 Prints this invoice.
1506 Options must be passed as a hashref.
1508 I<template>, if specified, is the name of a suffix for alternate invoices.
1510 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1516 return if $self->hide;
1517 my $conf = $self->conf;
1518 my $opt = shift || {};
1519 if ($opt and !ref($opt)) {
1520 die "FS::cust_bill::print called with positional parameters";
1523 my $lpr = delete $opt->{lpr};
1524 if($conf->exists('invoice_print_pdf')) {
1525 # Add the invoice to the current batch.
1526 $self->batch_invoice($opt);
1530 $self->lpr_data($opt),
1531 'agentnum' => $self->cust_main->agentnum,
1537 =item fax_invoice HASHREF
1541 Options must be passed as a hashref.
1543 I<template>, if specified, is the name of a suffix for alternate invoices.
1545 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1551 return if $self->hide;
1552 my $conf = $self->conf;
1553 my $opt = shift || {};
1554 if ($opt and !ref($opt)) {
1555 die "FS::cust_bill::fax_invoice called with positional parameters";
1558 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1559 unless $conf->exists('invoice_latex');
1561 my $dialstring = $self->cust_main->getfield('fax');
1564 my $error = send_fax( 'docdata' => $self->lpr_data($opt),
1565 'dialstring' => $dialstring,
1567 die $error if $error;
1571 =item batch_invoice [ HASHREF ]
1573 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1574 isn't an open batch, one will be created.
1579 my ($self, $opt) = @_;
1580 my $bill_batch = $self->get_open_bill_batch;
1581 my $cust_bill_batch = FS::cust_bill_batch->new({
1582 batchnum => $bill_batch->batchnum,
1583 invnum => $self->invnum,
1585 return $cust_bill_batch->insert($opt);
1588 =item get_open_batch
1590 Returns the currently open batch as an FS::bill_batch object, creating a new
1591 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1596 sub get_open_bill_batch {
1598 my $conf = $self->conf;
1599 my $hashref = { status => 'O' };
1600 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1601 ? $self->cust_main->agentnum
1603 my $batch = qsearchs('bill_batch', $hashref);
1604 return $batch if $batch;
1605 $batch = FS::bill_batch->new($hashref);
1606 my $error = $batch->insert;
1607 die $error if $error;
1611 =item ftp_invoice [ TEMPLATENAME ]
1613 Sends this invoice data via FTP.
1615 TEMPLATENAME is unused?
1621 my $conf = $self->conf;
1622 my $template = scalar(@_) ? shift : '';
1625 'protocol' => 'ftp',
1626 'server' => $conf->config('cust_bill-ftpserver'),
1627 'username' => $conf->config('cust_bill-ftpusername'),
1628 'password' => $conf->config('cust_bill-ftppassword'),
1629 'dir' => $conf->config('cust_bill-ftpdir'),
1630 'format' => $conf->config('cust_bill-ftpformat'),
1634 =item spool_invoice [ TEMPLATENAME ]
1636 Spools this invoice data (see L<FS::spool_csv>)
1638 TEMPLATENAME is unused?
1644 my $conf = $self->conf;
1645 my $template = scalar(@_) ? shift : '';
1648 'format' => $conf->config('cust_bill-spoolformat'),
1649 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1653 =item send_csv OPTION => VALUE, ...
1655 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1659 protocol - currently only "ftp"
1665 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1666 and YYMMDDHHMMSS is a timestamp.
1668 See L</print_csv> for a description of the output format.
1673 my($self, %opt) = @_;
1677 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1678 mkdir $spooldir, 0700 unless -d $spooldir;
1680 # don't localize dates here, they're a defined format
1681 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1682 my $file = "$spooldir/$tracctnum.csv";
1684 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1686 open(CSV, ">$file") or die "can't open $file: $!";
1694 if ( $opt{protocol} eq 'ftp' ) {
1695 eval "use Net::FTP;";
1697 $net = Net::FTP->new($opt{server}) or die @$;
1699 die "unknown protocol: $opt{protocol}";
1702 $net->login( $opt{username}, $opt{password} )
1703 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1705 $net->binary or die "can't set binary mode";
1707 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1709 $net->put($file) or die "can't put $file: $!";
1719 Spools CSV invoice data.
1725 =item format - any of FS::Misc::::Invoicing::spool_formats
1727 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1728 customer has the corresponding invoice destinations set (see
1729 L<FS::cust_main_invoice>).
1731 =item agent_spools - if set to a true value, will spool to per-agent files
1732 rather than a single global file
1734 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1735 append to that spool. L<FS::Cron::upload> will then send the spool file to
1738 =item balanceover - if set, only spools the invoice if the total amount owed on
1739 this invoice and all older invoices is greater than the specified amount.
1741 =item time - the "current time". Controls the printing of past due messages
1749 my($self, %opt) = @_;
1751 my $time = $opt{'time'} || time;
1752 my $cust_main = $self->cust_main;
1754 if ( $opt{'dest'} ) {
1755 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1756 $cust_main->invoicing_list;
1757 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1758 || ! keys %invoicing_list;
1761 if ( $opt{'balanceover'} ) {
1763 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1766 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1767 mkdir $spooldir, 0700 unless -d $spooldir;
1769 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1772 if ( $opt{'agent_spools'} ) {
1773 $file = 'agentnum'.$cust_main->agentnum;
1778 if ( $opt{'upload_targetnum'} ) {
1779 $spooldir .= '/target'.$opt{'upload_targetnum'};
1780 mkdir $spooldir, 0700 unless -d $spooldir;
1781 } # otherwise it just goes into export.xxx/cust_bill
1783 if ( lc($opt{'format'}) eq 'billco' ) {
1787 $file = "$spooldir/$file.csv";
1789 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1791 open(CSV, ">>$file") or die "can't open $file: $!";
1792 flock(CSV, LOCK_EX);
1797 if ( lc($opt{'format'}) eq 'billco' ) {
1799 flock(CSV, LOCK_UN);
1802 $file =~ s/-header.csv$/-detail.csv/;
1804 open(CSV,">>$file") or die "can't open $file: $!";
1805 flock(CSV, LOCK_EX);
1809 print CSV $detail if defined($detail);
1811 flock(CSV, LOCK_UN);
1818 =item print_csv OPTION => VALUE, ...
1820 Returns CSV data for this invoice.
1824 format - 'default', 'billco', 'oneline', 'bridgestone'
1826 Returns a list consisting of two scalars. The first is a single line of CSV
1827 header information for this invoice. The second is one or more lines of CSV
1828 detail information for this invoice.
1830 If I<format> is not specified or "default", the fields of the CSV file are as
1833 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1834 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1838 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1840 B<record_type> is C<cust_bill> for the initial header line only. The
1841 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1842 fields are filled in.
1844 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1845 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1848 =item invnum - invoice number
1850 =item custnum - customer number
1852 =item _date - invoice date
1854 =item charged - total invoice amount
1856 =item first - customer first name
1858 =item last - customer first name
1860 =item company - company name
1862 =item address1 - address line 1
1864 =item address2 - address line 1
1874 =item pkg - line item description
1876 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1878 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1880 =item sdate - start date for recurring fee
1882 =item edate - end date for recurring fee
1886 If I<format> is "billco", the fields of the header CSV file are as follows:
1888 +-------------------------------------------------------------------+
1889 | FORMAT HEADER FILE |
1890 |-------------------------------------------------------------------|
1891 | Field | Description | Name | Type | Width |
1892 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1893 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1894 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1895 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1896 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1897 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1898 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1899 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1900 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1901 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1902 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1903 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1904 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1905 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1906 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1907 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1908 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1909 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1910 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1911 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1912 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1913 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1914 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1915 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
1916 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
1917 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
1918 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
1919 | 28 | State Tax*** | STATETAX | NUM* | 9 |
1920 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
1921 +-------+-------------------------------+------------+------+-------+
1923 If I<format> is "billco", the fields of the detail CSV file are as follows:
1925 FORMAT FOR DETAIL FILE
1927 Field | Description | Name | Type | Width
1928 1 | N/A-Leave Empty | RC | CHAR | 2
1929 2 | N/A-Leave Empty | CUSTID | CHAR | 15
1930 3 | Account Number | TRACCTNUM | CHAR | 15
1931 4 | Invoice Number | TRINVOICE | CHAR | 15
1932 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
1933 6 | Transaction Detail | DETAILS | CHAR | 100
1934 7 | Amount | AMT | NUM* | 9
1935 8 | Line Format Control** | LNCTRL | CHAR | 2
1936 9 | Grouping Code | GROUP | CHAR | 2
1937 10 | User Defined | ACCT CODE | CHAR | 15
1939 If format is 'oneline', there is no detail file. Each invoice has a
1940 header line only, with the fields:
1942 Agent number, agent name, customer number, first name, last name, address
1943 line 1, address line 2, city, state, zip, invoice date, invoice number,
1944 amount charged, amount due, previous balance, due date.
1946 and then, for each line item, three columns containing the package number,
1947 description, and amount.
1949 If format is 'bridgestone', there is no detail file. Each invoice has a
1950 header line with the following fields in a fixed-width format:
1952 Customer number (in display format), date, name (first last), company,
1953 address 1, address 2, city, state, zip.
1955 This is a mailing list format, and has no per-invoice fields. To avoid
1956 sending redundant notices, the spooling event should have a "once" or
1957 "once_percust_every" condition.
1962 my($self, %opt) = @_;
1964 eval "use Text::CSV_XS";
1967 my $cust_main = $self->cust_main;
1969 my $csv = Text::CSV_XS->new({'always_quote'=>1});
1970 my $format = lc($opt{'format'});
1972 my $time = $opt{'time'} || time;
1974 my $tracctnum = ''; #leaking out from billco-specific sections :/
1975 if ( $format eq 'billco' ) {
1978 $self->conf->config('billco-account_num', $cust_main->agentnum);
1980 $tracctnum = $account_num eq 'display_custnum'
1981 ? $cust_main->display_custnum
1982 : $opt{'tracctnum'};
1985 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1987 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1989 my( $previous_balance, @unused ) = $self->previous; #previous balance
1991 my $pmt_cr_applied = 0;
1992 $pmt_cr_applied += $_->{'amount'}
1993 foreach ( $self->_items_payments(%opt), $self->_items_credits(%opt) ) ;
1995 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1998 '', # 1 | N/A-Leave Empty CHAR 2
1999 '', # 2 | N/A-Leave Empty CHAR 15
2000 $tracctnum, # 3 | Transaction Account No CHAR 15
2001 $self->invnum, # 4 | Transaction Invoice No CHAR 15
2002 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
2003 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
2004 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
2005 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
2006 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
2007 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
2008 '', # 10 | Ancillary Billing Information CHAR 30
2009 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
2010 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
2013 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
2016 $duedate, # 14 | Bill Due Date CHAR 10
2018 $previous_balance, # 15 | Previous Balance NUM* 9
2019 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
2020 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
2021 $totaldue, # 18 | Total Amt Due NUM* 9
2022 $totaldue, # 19 | Total Amt Due NUM* 9
2023 '', # 20 | 30 Day Aging NUM* 9
2024 '', # 21 | 60 Day Aging NUM* 9
2025 '', # 22 | 90 Day Aging NUM* 9
2026 'N', # 23 | Y/N CHAR 1
2027 '', # 24 | Remittance automation CHAR 100
2028 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
2029 $self->custnum, # 26 | Customer Reference Number CHAR 15
2030 '0', # 27 | Federal Tax*** NUM* 9
2031 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
2032 '0', # 29 | Other Taxes & Fees*** NUM* 9
2035 } elsif ( $format eq 'oneline' ) { #name
2037 my ($previous_balance) = $self->previous;
2038 $previous_balance = sprintf('%.2f', $previous_balance);
2039 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2045 $self->_items_pkg, #_items_nontax? no sections or anything
2050 $cust_main->agentnum,
2051 $cust_main->agent->agent,
2055 $cust_main->company,
2056 $cust_main->address1,
2057 $cust_main->address2,
2063 time2str("%x", $self->_date),
2068 $self->due_date2str("%x"),
2073 } elsif ( $format eq 'bridgestone' ) {
2075 # bypass the CSV stuff and just return this
2076 my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2077 my $zip = $cust_main->zip;
2079 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2083 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2085 $cust_main->display_custnum,
2087 uc(substr($cust_main->contact_firstlast,0,30)),
2088 uc(substr($cust_main->company ,0,30)),
2089 uc(substr($cust_main->address1 ,0,30)),
2090 uc(substr($cust_main->address2 ,0,30)),
2091 uc(substr($cust_main->city ,0,20)),
2092 uc($cust_main->state),
2098 } elsif ( $format eq 'ics' ) {
2100 my $bill = $cust_main->bill_location;
2101 my $zip = $bill->zip;
2105 if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2110 # minor false laziness with print_generic
2111 my ($previous_balance) = $self->previous;
2112 my $balance_due = $self->owed + $previous_balance;
2113 my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2114 my $credit_total = sum(0, map { $_->{'amount'} } $self->_items_credits);
2117 if ( $self->due_date and $time >= $self->due_date ) {
2118 $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2122 my $header = sprintf(
2123 '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2124 $cust_main->display_custnum, #BID
2125 uc($cust_main->first), #FNAME
2126 uc($cust_main->last), #LNAME
2127 '00', #BATCH, should this ever be anything else?
2128 uc($cust_main->company), #COMP
2129 uc($bill->address1), #STREET1
2130 uc($bill->address2), #STREET2
2131 uc($bill->city), #CITY
2132 uc($bill->state), #STATE
2135 time2str('%Y%m%d', $self->_date), #BILL_DATE
2136 $self->due_date2str('%Y%m%d'), #DUE_DATE,
2137 ( map {sprintf('%0.2f', $_)}
2138 $balance_due, #AMNT_DUE
2139 $previous_balance, #PREV_BAL
2140 $payment_total, #PYMT_RCVD
2141 $credit_total, #CREDITS
2142 $previous_balance, #BEG_BAL--is this correct?
2143 $self->charged, #NEW_CHRG
2146 $past_due, #PAST_MSG
2150 my %svc_class = ('' => ''); # maybe cache this more persistently?
2152 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2154 my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2155 my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2159 my @dates = ( $self->_date, undef );
2160 if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2161 $dates[1] = $prev->sdate; #questionable
2164 # generate an 01 detail for each service
2165 my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2166 foreach my $cust_svc ( @svcs ) {
2167 $show_pkgnum = ''; # hide it if we're showing svcnums
2169 my $svcpart = $cust_svc->svcpart;
2170 if (!exists($svc_class{$svcpart})) {
2171 my $classnum = $cust_svc->part_svc->classnum;
2172 my $part_svc_class = FS::part_svc_class->by_key($classnum)
2174 $svc_class{$svcpart} = $part_svc_class ?
2175 $part_svc_class->classname :
2179 my @h_label = $cust_svc->label(@dates, 'I');
2180 push @details, sprintf('01%-9s%-20s%-47s',
2182 $svc_class{$svcpart},
2185 } #foreach $cust_svc
2188 my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2189 if ($cust_bill_pkg->recur > 0) {
2190 $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2191 time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2193 push @details, sprintf('02%-6s%-60s%-10s',
2196 sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2198 } #foreach $cust_bill_pkg
2200 # Tag this row so that we know whether this is one page (1), two pages
2201 # (2), # or "big" (B). The tag will be stripped off before uploading.
2202 if ( scalar(@details) < 12 ) {
2204 } elsif ( scalar(@details) < 58 ) {
2210 return join('', $header, @details, "\n");
2218 time2str("%x", $self->_date),
2219 sprintf("%.2f", $self->charged),
2220 ( map { $cust_main->getfield($_) }
2221 qw( first last company address1 address2 city state zip country ) ),
2223 ) or die "can't create csv";
2226 my $header = $csv->string. "\n";
2229 if ( lc($opt{'format'}) eq 'billco' ) {
2232 foreach my $item ( $self->_items_pkg ) {
2235 '', # 1 | N/A-Leave Empty CHAR 2
2236 '', # 2 | N/A-Leave Empty CHAR 15
2237 $tracctnum, # 3 | Account Number CHAR 15
2238 $self->invnum, # 4 | Invoice Number CHAR 15
2239 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2240 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2241 $item->{'amount'}, # 7 | Amount NUM* 9
2242 '', # 8 | Line Format Control** CHAR 2
2243 '', # 9 | Grouping Code CHAR 2
2244 '', # 10 | User Defined CHAR 15
2247 $detail .= $csv->string. "\n";
2251 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2257 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2259 my($pkg, $setup, $recur, $sdate, $edate);
2260 if ( $cust_bill_pkg->pkgnum ) {
2262 ($pkg, $setup, $recur, $sdate, $edate) = (
2263 $cust_bill_pkg->part_pkg->pkg,
2264 ( $cust_bill_pkg->setup != 0
2265 ? sprintf("%.2f", $cust_bill_pkg->setup )
2267 ( $cust_bill_pkg->recur != 0
2268 ? sprintf("%.2f", $cust_bill_pkg->recur )
2270 ( $cust_bill_pkg->sdate
2271 ? time2str("%x", $cust_bill_pkg->sdate)
2273 ($cust_bill_pkg->edate
2274 ? time2str("%x", $cust_bill_pkg->edate)
2278 } else { #pkgnum tax
2279 next unless $cust_bill_pkg->setup != 0;
2280 $pkg = $cust_bill_pkg->desc;
2281 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2282 ( $sdate, $edate ) = ( '', '' );
2288 ( map { '' } (1..11) ),
2289 ($pkg, $setup, $recur, $sdate, $edate)
2290 ) or die "can't create csv";
2292 $detail .= $csv->string. "\n";
2298 ( $header, $detail );
2304 Pays this invoice with a compliemntary payment. If there is an error,
2305 returns the error, otherwise returns false.
2311 my $cust_pay = new FS::cust_pay ( {
2312 'invnum' => $self->invnum,
2313 'paid' => $self->owed,
2316 'payinfo' => $self->cust_main->payinfo,
2324 Attempts to pay this invoice with a credit card payment via a
2325 Business::OnlinePayment realtime gateway. See
2326 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2327 for supported processors.
2333 $self->realtime_bop( 'CC', @_ );
2338 Attempts to pay this invoice with an electronic check (ACH) payment via a
2339 Business::OnlinePayment realtime gateway. See
2340 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2341 for supported processors.
2347 $self->realtime_bop( 'ECHECK', @_ );
2352 Attempts to pay this invoice with phone bill (LEC) payment via a
2353 Business::OnlinePayment realtime gateway. See
2354 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2355 for supported processors.
2361 $self->realtime_bop( 'LEC', @_ );
2365 my( $self, $method ) = (shift,shift);
2366 my $conf = $self->conf;
2369 my $cust_main = $self->cust_main;
2370 my $balance = $cust_main->balance;
2371 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2372 $amount = sprintf("%.2f", $amount);
2373 return "not run (balance $balance)" unless $amount > 0;
2375 my $description = 'Internet Services';
2376 if ( $conf->exists('business-onlinepayment-description') ) {
2377 my $dtempl = $conf->config('business-onlinepayment-description');
2379 my $agent_obj = $cust_main->agent
2380 or die "can't retreive agent for $cust_main (agentnum ".
2381 $cust_main->agentnum. ")";
2382 my $agent = $agent_obj->agent;
2383 my $pkgs = join(', ',
2384 map { $_->part_pkg->pkg }
2385 grep { $_->pkgnum } $self->cust_bill_pkg
2387 $description = eval qq("$dtempl");
2390 $cust_main->realtime_bop($method, $amount,
2391 'description' => $description,
2392 'invnum' => $self->invnum,
2393 #this didn't do what we want, it just calls apply_payments_and_credits
2395 'apply_to_invoice' => 1,
2398 #this changes application behavior: auto payments
2399 #triggered against a specific invoice are now applied
2400 #to that invoice instead of oldest open.
2406 =item batch_card OPTION => VALUE...
2408 Adds a payment for this invoice to the pending credit card batch (see
2409 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2410 runs the payment using a realtime gateway.
2415 my ($self, %options) = @_;
2416 my $cust_main = $self->cust_main;
2418 $options{invnum} = $self->invnum;
2420 $cust_main->batch_card(%options);
2423 sub _agent_template {
2425 $self->cust_main->agent_template;
2428 sub _agent_invoice_from {
2430 $self->cust_main->agent_invoice_from;
2433 =item invoice_barcode DIR_OR_FALSE
2435 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2436 it is taken as the temp directory where the PNG file will be generated and the
2437 PNG file name is returned. Otherwise, the PNG image itself is returned.
2441 sub invoice_barcode {
2442 my ($self, $dir) = (shift,shift);
2444 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2445 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2446 my $gd = $gdbar->plot(Height => 30);
2449 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2453 ) or die "can't open temp file: $!\n";
2454 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2455 my $png_file = $bh->filename;
2462 =item invnum_date_pretty
2464 Returns a string with the invoice number and date, for example:
2465 "Invoice #54 (3/20/2008)"
2469 sub invnum_date_pretty {
2471 $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
2474 #sub _items_extra_usage_sections {
2476 # my $escape = shift;
2478 # my %sections = ();
2480 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2481 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2483 # next unless $cust_bill_pkg->pkgnum > 0;
2485 # foreach my $section ( keys %usage_class ) {
2487 # my $usage = $cust_bill_pkg->usage($section);
2489 # next unless $usage && $usage > 0;
2491 # $sections{$section} ||= 0;
2492 # $sections{$section} += $usage;
2498 # map { { 'description' => &{$escape}($_),
2499 # 'subtotal' => $sections{$_},
2500 # 'summarized' => '',
2501 # 'tax_section' => '',
2504 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2508 sub _items_extra_usage_sections {
2510 my $conf = $self->conf;
2518 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2520 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2521 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2522 next unless $cust_bill_pkg->pkgnum > 0;
2524 foreach my $classnum ( keys %usage_class ) {
2525 my $section = $usage_class{$classnum}->classname;
2526 $classnums{$section} = $classnum;
2528 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2529 my $amount = $detail->amount;
2530 next unless $amount && $amount > 0;
2532 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2533 $sections{$section}{amount} += $amount; #subtotal
2534 $sections{$section}{calls}++;
2535 $sections{$section}{duration} += $detail->duration;
2537 my $desc = $detail->regionname;
2538 my $description = $desc;
2539 $description = substr($desc, 0, $maxlength). '...'
2540 if $format eq 'latex' && length($desc) > $maxlength;
2542 $lines{$section}{$desc} ||= {
2543 description => &{$escape}($description),
2544 #pkgpart => $part_pkg->pkgpart,
2545 pkgnum => $cust_bill_pkg->pkgnum,
2550 #unit_amount => $cust_bill_pkg->unitrecur,
2551 quantity => $cust_bill_pkg->quantity,
2552 product_code => 'N/A',
2553 ext_description => [],
2556 $lines{$section}{$desc}{amount} += $amount;
2557 $lines{$section}{$desc}{calls}++;
2558 $lines{$section}{$desc}{duration} += $detail->duration;
2564 my %sectionmap = ();
2565 foreach (keys %sections) {
2566 my $usage_class = $usage_class{$classnums{$_}};
2567 $sectionmap{$_} = { 'description' => &{$escape}($_),
2568 'amount' => $sections{$_}{amount}, #subtotal
2569 'calls' => $sections{$_}{calls},
2570 'duration' => $sections{$_}{duration},
2572 'tax_section' => '',
2573 'sort_weight' => $usage_class->weight,
2574 ( $usage_class->format
2575 ? ( map { $_ => $usage_class->$_($format) }
2576 qw( description_generator header_generator total_generator total_line_generator )
2583 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2587 foreach my $section ( keys %lines ) {
2588 foreach my $line ( keys %{$lines{$section}} ) {
2589 my $l = $lines{$section}{$line};
2590 $l->{section} = $sectionmap{$section};
2591 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2592 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2597 return(\@sections, \@lines);
2603 my $end = $self->_date;
2605 # start at date of previous invoice + 1 second or 0 if no previous invoice
2606 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2607 $start = 0 if !$start;
2610 my $cust_main = $self->cust_main;
2611 my @pkgs = $cust_main->all_pkgs;
2612 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2615 foreach my $pkg ( @pkgs ) {
2616 my @h_cust_svc = $pkg->h_cust_svc($end);
2617 foreach my $h_cust_svc ( @h_cust_svc ) {
2618 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2619 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2621 my $inserted = $h_cust_svc->date_inserted;
2622 my $deleted = $h_cust_svc->date_deleted;
2623 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2625 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2627 # DID either activated or ported in; cannot be both for same DID simultaneously
2628 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2629 && (!$phone_inserted->lnp_status
2630 || $phone_inserted->lnp_status eq ''
2631 || $phone_inserted->lnp_status eq 'native')) {
2634 else { # this one not so clean, should probably move to (h_)svc_phone
2635 my $phone_portedin = qsearchs( 'h_svc_phone',
2636 { 'svcnum' => $h_cust_svc->svcnum,
2637 'lnp_status' => 'portedin' },
2638 FS::h_svc_phone->sql_h_searchs($end),
2640 $num_portedin++ if $phone_portedin;
2643 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2644 if($deleted >= $start && $deleted <= $end && $phone_deleted
2645 && (!$phone_deleted->lnp_status
2646 || $phone_deleted->lnp_status ne 'portingout')) {
2649 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2650 && $phone_deleted->lnp_status
2651 && $phone_deleted->lnp_status eq 'portingout') {
2655 # increment usage minutes
2656 if ( $phone_inserted ) {
2657 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2658 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2661 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2664 # don't look at this service again
2665 push @seen, $h_cust_svc->svcnum;
2669 $minutes = sprintf("%d", $minutes);
2670 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2671 . "$num_deactivated Ported-Out: $num_portedout ",
2672 "Total Minutes: $minutes");
2675 sub _items_accountcode_cdr {
2680 my $section = { 'amount' => 0,
2683 'sort_weight' => '',
2685 'description' => 'Usage by Account Code',
2691 my %accountcodes = ();
2693 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2694 next unless $cust_bill_pkg->pkgnum > 0;
2696 my @header = $cust_bill_pkg->details_header;
2697 next unless scalar(@header);
2698 $section->{'header'} = join(',',@header);
2700 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2702 $section->{'header'} = $detail->formatted('format' => $format)
2703 if($detail->detail eq $section->{'header'});
2705 my $accountcode = $detail->accountcode;
2706 next unless $accountcode;
2708 my $amount = $detail->amount;
2709 next unless $amount && $amount > 0;
2711 $accountcodes{$accountcode} ||= {
2712 description => $accountcode,
2719 product_code => 'N/A',
2720 section => $section,
2721 ext_description => [ $section->{'header'} ],
2725 $section->{'amount'} += $amount;
2726 $accountcodes{$accountcode}{'amount'} += $amount;
2727 $accountcodes{$accountcode}{calls}++;
2728 $accountcodes{$accountcode}{duration} += $detail->duration;
2729 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2733 foreach my $l ( values %accountcodes ) {
2734 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2735 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2736 foreach my $sorted_detail ( @sorted_detail ) {
2737 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2739 delete $l->{detail_temp};
2743 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2745 return ($section,\@sorted_lines);
2748 sub _items_svc_phone_sections {
2750 my $conf = $self->conf;
2758 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2760 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2761 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2763 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2764 next unless $cust_bill_pkg->pkgnum > 0;
2766 my @header = $cust_bill_pkg->details_header;
2767 next unless scalar(@header);
2769 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2771 my $phonenum = $detail->phonenum;
2772 next unless $phonenum;
2774 my $amount = $detail->amount;
2775 next unless $amount && $amount > 0;
2777 $sections{$phonenum} ||= { 'amount' => 0,
2780 'sort_weight' => -1,
2781 'phonenum' => $phonenum,
2783 $sections{$phonenum}{amount} += $amount; #subtotal
2784 $sections{$phonenum}{calls}++;
2785 $sections{$phonenum}{duration} += $detail->duration;
2787 my $desc = $detail->regionname;
2788 my $description = $desc;
2789 $description = substr($desc, 0, $maxlength). '...'
2790 if $format eq 'latex' && length($desc) > $maxlength;
2792 $lines{$phonenum}{$desc} ||= {
2793 description => &{$escape}($description),
2794 #pkgpart => $part_pkg->pkgpart,
2802 product_code => 'N/A',
2803 ext_description => [],
2806 $lines{$phonenum}{$desc}{amount} += $amount;
2807 $lines{$phonenum}{$desc}{calls}++;
2808 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2810 my $line = $usage_class{$detail->classnum}->classname;
2811 $sections{"$phonenum $line"} ||=
2815 'sort_weight' => $usage_class{$detail->classnum}->weight,
2816 'phonenum' => $phonenum,
2817 'header' => [ @header ],
2819 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2820 $sections{"$phonenum $line"}{calls}++;
2821 $sections{"$phonenum $line"}{duration} += $detail->duration;
2823 $lines{"$phonenum $line"}{$desc} ||= {
2824 description => &{$escape}($description),
2825 #pkgpart => $part_pkg->pkgpart,
2833 product_code => 'N/A',
2834 ext_description => [],
2837 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2838 $lines{"$phonenum $line"}{$desc}{calls}++;
2839 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2840 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2841 $detail->formatted('format' => $format);
2846 my %sectionmap = ();
2847 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2848 foreach ( keys %sections ) {
2849 my @header = @{ $sections{$_}{header} || [] };
2851 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2852 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2853 my $usage_class = $summary ? $simple : $usage_simple;
2854 my $ending = $summary ? ' usage charges' : '';
2857 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2859 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2860 'amount' => $sections{$_}{amount}, #subtotal
2861 'calls' => $sections{$_}{calls},
2862 'duration' => $sections{$_}{duration},
2864 'tax_section' => '',
2865 'phonenum' => $sections{$_}{phonenum},
2866 'sort_weight' => $sections{$_}{sort_weight},
2867 'post_total' => $summary, #inspire pagebreak
2869 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2870 qw( description_generator
2873 total_line_generator
2880 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2881 $a->{sort_weight} <=> $b->{sort_weight}
2886 foreach my $section ( keys %lines ) {
2887 foreach my $line ( keys %{$lines{$section}} ) {
2888 my $l = $lines{$section}{$line};
2889 $l->{section} = $sectionmap{$section};
2890 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2891 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2896 if($conf->exists('phone_usage_class_summary')) {
2897 # this only works with Latex
2901 # after this, we'll have only two sections per DID:
2902 # Calls Summary and Calls Detail
2903 foreach my $section ( @sections ) {
2904 if($section->{'post_total'}) {
2905 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2906 $section->{'total_line_generator'} = sub { '' };
2907 $section->{'total_generator'} = sub { '' };
2908 $section->{'header_generator'} = sub { '' };
2909 $section->{'description_generator'} = '';
2910 push @newsections, $section;
2911 my %calls_detail = %$section;
2912 $calls_detail{'post_total'} = '';
2913 $calls_detail{'sort_weight'} = '';
2914 $calls_detail{'description_generator'} = sub { '' };
2915 $calls_detail{'header_generator'} = sub {
2916 return ' & Date/Time & Called Number & Duration & Price'
2917 if $format eq 'latex';
2920 $calls_detail{'description'} = 'Calls Detail: '
2921 . $section->{'phonenum'};
2922 push @newsections, \%calls_detail;
2926 # after this, each usage class is collapsed/summarized into a single
2927 # line under the Calls Summary section
2928 foreach my $newsection ( @newsections ) {
2929 if($newsection->{'post_total'}) { # this means Calls Summary
2930 foreach my $section ( @sections ) {
2931 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2932 && !$section->{'post_total'});
2933 my $newdesc = $section->{'description'};
2934 my $tn = $section->{'phonenum'};
2935 $newdesc =~ s/$tn//g;
2936 my $line = { ext_description => [],
2940 calls => $section->{'calls'},
2941 section => $newsection,
2942 duration => $section->{'duration'},
2943 description => $newdesc,
2944 amount => sprintf("%.2f",$section->{'amount'}),
2945 product_code => 'N/A',
2947 push @newlines, $line;
2952 # after this, Calls Details is populated with all CDRs
2953 foreach my $newsection ( @newsections ) {
2954 if(!$newsection->{'post_total'}) { # this means Calls Details
2955 foreach my $line ( @lines ) {
2956 next unless (scalar(@{$line->{'ext_description'}}) &&
2957 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2959 my @extdesc = @{$line->{'ext_description'}};
2961 foreach my $extdesc ( @extdesc ) {
2962 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2963 push @newextdesc, $extdesc;
2965 $line->{'ext_description'} = \@newextdesc;
2966 $line->{'section'} = $newsection;
2967 push @newlines, $line;
2972 return(\@newsections, \@newlines);
2975 return(\@sections, \@lines);
2979 sub _items_previous {
2981 my $conf = $self->conf;
2982 my $cust_main = $self->cust_main;
2983 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2985 foreach ( @pr_cust_bill ) {
2986 my $date = $conf->exists('invoice_show_prior_due_date')
2987 ? 'due '. $_->due_date2str($date_format)
2988 : $self->time2str_local($date_format, $_->_date);
2990 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2991 #'pkgpart' => 'N/A',
2993 'amount' => sprintf("%.2f", $_->owed),
2999 # 'description' => 'Previous Balance',
3000 # #'pkgpart' => 'N/A',
3001 # 'pkgnum' => 'N/A',
3002 # 'amount' => sprintf("%10.2f", $pr_total ),
3003 # 'ext_description' => [ map {
3004 # "Invoice ". $_->invnum.
3005 # " (". time2str("%x",$_->_date). ") ".
3006 # sprintf("%10.2f", $_->owed)
3007 # } @pr_cust_bill ],
3012 sub _items_credits {
3013 my( $self, %opt ) = @_;
3014 my $trim_len = $opt{'trim_len'} || 60;
3019 if ( $self->conf->exists('previous_balance-payments_since') ) {
3020 if ( $opt{'template'} eq 'statement' ) {
3021 # then the current bill is a "statement" (i.e. an invoice sent as
3022 # a payment receipt)
3023 # and in that case we want to see payments on or after THIS invoice
3024 @objects = qsearch('cust_credit', {
3025 'custnum' => $self->custnum,
3026 '_date' => {op => '>=', value => $self->_date},
3030 $date = $self->previous_bill->_date if $self->previous_bill;
3031 @objects = qsearch('cust_credit', {
3032 'custnum' => $self->custnum,
3033 '_date' => {op => '>=', value => $date},
3037 @objects = $self->cust_credited;
3040 foreach my $obj ( @objects ) {
3041 my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
3043 my $reason = substr($cust_credit->reason, 0, $trim_len);
3044 $reason .= '...' if length($reason) < length($cust_credit->reason);
3045 $reason = " ($reason) " if $reason;
3048 #'description' => 'Credit ref\#'. $_->crednum.
3049 # " (". time2str("%x",$_->cust_credit->_date) .")".
3051 'description' => $self->mt('Credit applied').' '.
3052 $self->time2str_local($date_format,$obj->_date). $reason,
3053 'amount' => sprintf("%.2f",$obj->amount),
3061 sub _items_payments {
3066 my $detailed = $self->conf->exists('invoice_payment_details');
3068 if ( $self->conf->exists('previous_balance-payments_since') ) {
3069 # then show payments dated on/after the previous bill...
3070 if ( $opt{'template'} eq 'statement' ) {
3071 # then the current bill is a "statement" (i.e. an invoice sent as
3072 # a payment receipt)
3073 # and in that case we want to see payments on or after THIS invoice
3074 @objects = qsearch('cust_pay', {
3075 'custnum' => $self->custnum,
3076 '_date' => {op => '>=', value => $self->_date},
3079 # the normal case: payments on or after the previous invoice
3081 $date = $self->previous_bill->_date if $self->previous_bill;
3082 @objects = qsearch('cust_pay', {
3083 'custnum' => $self->custnum,
3084 '_date' => {op => '>=', value => $date},
3086 # and before the current bill...
3087 @objects = grep { $_->_date < $self->_date } @objects;
3090 @objects = $self->cust_bill_pay;
3093 foreach my $obj (@objects) {
3094 my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
3095 my $desc = $self->mt('Payment received').' '.
3096 $self->time2str_local($date_format, $cust_pay->_date );
3097 $desc .= $self->mt(' via ') .
3098 $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
3102 'description' => $desc,
3103 'amount' => sprintf("%.2f", $obj->amount )
3111 =item call_details [ OPTION => VALUE ... ]
3113 Returns an array of CSV strings representing the call details for this invoice
3114 The only option available is the boolean prepend_billed_number
3119 my ($self, %opt) = @_;
3121 my $format_function = sub { shift };
3123 if ($opt{prepend_billed_number}) {
3124 $format_function = sub {
3128 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3133 my @details = map { $_->details( 'format_function' => $format_function,
3134 'escape_function' => sub{ return() },
3138 $self->cust_bill_pkg;
3139 my $header = $details[0];
3140 ( $header, grep { $_ ne $header } @details );
3150 =item process_reprint
3154 sub process_reprint {
3155 process_re_X('print', @_);
3158 =item process_reemail
3162 sub process_reemail {
3163 process_re_X('email', @_);
3171 process_re_X('fax', @_);
3179 process_re_X('ftp', @_);
3186 sub process_respool {
3187 process_re_X('spool', @_);
3190 use Storable qw(thaw);
3194 my( $method, $job ) = ( shift, shift );
3195 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3197 my $param = thaw(decode_base64(shift));
3198 warn Dumper($param) if $DEBUG;
3209 # spool_invoice ftp_invoice fax_invoice print_invoice
3210 my($method, $job, %param ) = @_;
3212 warn "re_X $method for job $job with param:\n".
3213 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3216 #some false laziness w/search/cust_bill.html
3218 my $orderby = 'ORDER BY cust_bill._date';
3220 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3222 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3224 my @cust_bill = qsearch( {
3225 #'select' => "cust_bill.*",
3226 'table' => 'cust_bill',
3227 'addl_from' => $addl_from,
3229 'extra_sql' => $extra_sql,
3230 'order_by' => $orderby,
3234 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3236 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3239 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3240 foreach my $cust_bill ( @cust_bill ) {
3241 $cust_bill->$method();
3243 if ( $job ) { #progressbar foo
3245 if ( time - $min_sec > $last ) {
3246 my $error = $job->update_statustext(
3247 int( 100 * $num / scalar(@cust_bill) )
3249 die $error if $error;
3260 =head1 CLASS METHODS
3266 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3271 my ($class, $start, $end) = @_;
3273 $class->paid_sql($start, $end). ' - '.
3274 $class->credited_sql($start, $end);
3279 Returns an SQL fragment to retreive the net amount (charged minus credited).
3284 my ($class, $start, $end) = @_;
3285 'charged - '. $class->credited_sql($start, $end);
3290 Returns an SQL fragment to retreive the amount paid against this invoice.
3295 my ($class, $start, $end) = @_;
3296 $start &&= "AND cust_bill_pay._date <= $start";
3297 $end &&= "AND cust_bill_pay._date > $end";
3298 $start = '' unless defined($start);
3299 $end = '' unless defined($end);
3300 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3301 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3306 Returns an SQL fragment to retreive the amount credited against this invoice.
3311 my ($class, $start, $end) = @_;
3312 $start &&= "AND cust_credit_bill._date <= $start";
3313 $end &&= "AND cust_credit_bill._date > $end";
3314 $start = '' unless defined($start);
3315 $end = '' unless defined($end);
3316 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3317 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3322 Returns an SQL fragment to retrieve the due date of an invoice.
3323 Currently only supported on PostgreSQL.
3328 my $conf = new FS::Conf;
3332 cust_bill.invoice_terms,
3333 cust_main.invoice_terms,
3334 \''.($conf->config('invoice_default_terms') || '').'\'
3335 ), E\'Net (\\\\d+)\'
3337 ) * 86400 + cust_bill._date'
3340 =item search_sql_where HASHREF
3342 Class method which returns an SQL WHERE fragment to search for parameters
3343 specified in HASHREF. Valid parameters are
3349 List reference of start date, end date, as UNIX timestamps.
3359 List reference of charged limits (exclusive).
3363 List reference of charged limits (exclusive).
3367 flag, return open invoices only
3371 flag, return net invoices only
3375 =item newest_percust
3379 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3383 sub search_sql_where {
3384 my($class, $param) = @_;
3386 warn "$me search_sql_where called with params: \n".
3387 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
3393 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3394 push @search, "cust_main.agentnum = $1";
3398 if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3399 push @search, "cust_main.refnum = $1";
3403 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3404 push @search, "cust_bill.custnum = $1";
3407 #customer classnum (false laziness w/ cust_main/Search.pm)
3408 if ( $param->{'cust_classnum'} ) {
3410 my @classnum = ref( $param->{'cust_classnum'} )
3411 ? @{ $param->{'cust_classnum'} }
3412 : ( $param->{'cust_classnum'} );
3414 @classnum = grep /^(\d*)$/, @classnum;
3417 push @search, '( '. join(' OR ', map {
3418 $_ ? "cust_main.classnum = $_"
3419 : "cust_main.classnum IS NULL"
3429 if ( $param->{_date} ) {
3430 my($beginning, $ending) = @{$param->{_date}};
3432 push @search, "cust_bill._date >= $beginning",
3433 "cust_bill._date < $ending";
3437 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3438 push @search, "cust_bill.invnum >= $1";
3440 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3441 push @search, "cust_bill.invnum <= $1";
3445 if ( $param->{charged} ) {
3446 my @charged = ref($param->{charged})
3447 ? @{ $param->{charged} }
3448 : ($param->{charged});
3450 push @search, map { s/^charged/cust_bill.charged/; $_; }
3454 my $owed_sql = FS::cust_bill->owed_sql;
3457 if ( $param->{owed} ) {
3458 my @owed = ref($param->{owed})
3459 ? @{ $param->{owed} }
3461 push @search, map { s/^owed/$owed_sql/; $_; }
3466 push @search, "0 != $owed_sql"
3467 if $param->{'open'};
3468 push @search, '0 != '. FS::cust_bill->net_sql
3472 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3473 if $param->{'days'};
3476 if ( $param->{'newest_percust'} ) {
3478 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3479 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3481 my @newest_where = map { my $x = $_;
3482 $x =~ s/\bcust_bill\./newest_cust_bill./g;
3485 grep ! /^cust_main./, @search;
3486 my $newest_where = scalar(@newest_where)
3487 ? ' AND '. join(' AND ', @newest_where)
3491 push @search, "cust_bill._date = (
3492 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3493 WHERE newest_cust_bill.custnum = cust_bill.custnum
3499 #promised_date - also has an option to accept nulls
3500 if ( $param->{promised_date} ) {
3501 my($beginning, $ending, $null) = @{$param->{promised_date}};
3503 push @search, "(( cust_bill.promised_date >= $beginning AND ".
3504 "cust_bill.promised_date < $ending )" .
3505 ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3508 #agent virtualization
3509 my $curuser = $FS::CurrentUser::CurrentUser;
3510 if ( $curuser->username eq 'fs_queue'
3511 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3513 my $newuser = qsearchs('access_user', {
3514 'username' => $username,
3518 $curuser = $newuser;
3520 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3523 push @search, $curuser->agentnums_sql;
3525 join(' AND ', @search );
3537 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3538 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base