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);
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;
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 previous_balance
115 =item billing_balance
123 =item printed - deprecated
131 =item closed - books closed flag, empty or `Y'
133 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
135 =item agent_invid - legacy invoice number
137 =item promised_date - customer promised payment date, for collection
147 Creates a new invoice. To add the invoice to the database, see L<"insert">.
148 Invoices are normally created by calling the bill method of a customer object
149 (see L<FS::cust_main>).
153 sub table { 'cust_bill'; }
154 sub notice_name { 'Invoice'; }
156 sub cust_linked { $_[0]->cust_main_custnum; }
157 sub cust_unlinked_msg {
159 "WARNING: can't find cust_main.custnum ". $self->custnum.
160 ' (cust_bill.invnum '. $self->invnum. ')';
165 Adds this invoice to the database ("Posts" the invoice). If there is an error,
166 returns the error, otherwise returns false.
172 warn "$me insert called\n" if $DEBUG;
174 local $SIG{HUP} = 'IGNORE';
175 local $SIG{INT} = 'IGNORE';
176 local $SIG{QUIT} = 'IGNORE';
177 local $SIG{TERM} = 'IGNORE';
178 local $SIG{TSTP} = 'IGNORE';
179 local $SIG{PIPE} = 'IGNORE';
181 my $oldAutoCommit = $FS::UID::AutoCommit;
182 local $FS::UID::AutoCommit = 0;
185 my $error = $self->SUPER::insert;
187 $dbh->rollback if $oldAutoCommit;
191 if ( $self->get('cust_bill_pkg') ) {
192 foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
193 $cust_bill_pkg->invnum($self->invnum);
194 my $error = $cust_bill_pkg->insert;
196 $dbh->rollback if $oldAutoCommit;
197 return "can't create invoice line item: $error";
202 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
209 Voids this invoice: deletes the invoice and adds a record of the voided invoice
210 to the FS::cust_bill_void table (and related tables starting from
211 FS::cust_bill_pkg_void).
217 my $reason = scalar(@_) ? shift : '';
219 local $SIG{HUP} = 'IGNORE';
220 local $SIG{INT} = 'IGNORE';
221 local $SIG{QUIT} = 'IGNORE';
222 local $SIG{TERM} = 'IGNORE';
223 local $SIG{TSTP} = 'IGNORE';
224 local $SIG{PIPE} = 'IGNORE';
226 my $oldAutoCommit = $FS::UID::AutoCommit;
227 local $FS::UID::AutoCommit = 0;
230 my $cust_bill_void = new FS::cust_bill_void ( {
231 map { $_ => $self->get($_) } $self->fields
233 $cust_bill_void->reason($reason);
234 my $error = $cust_bill_void->insert;
236 $dbh->rollback if $oldAutoCommit;
240 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
241 my $error = $cust_bill_pkg->void($reason);
243 $dbh->rollback if $oldAutoCommit;
248 $error = $self->delete;
250 $dbh->rollback if $oldAutoCommit;
254 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
262 This method now works but you probably shouldn't use it. Instead, apply a
263 credit against the invoice, or use the new void method.
265 Using this method to delete invoices outright is really, really bad. There
266 would be no record you ever posted this invoice, and there are no check to
267 make sure charged = 0 or that there are no associated cust_bill_pkg records.
269 Really, don't use it.
275 return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
277 local $SIG{HUP} = 'IGNORE';
278 local $SIG{INT} = 'IGNORE';
279 local $SIG{QUIT} = 'IGNORE';
280 local $SIG{TERM} = 'IGNORE';
281 local $SIG{TSTP} = 'IGNORE';
282 local $SIG{PIPE} = 'IGNORE';
284 my $oldAutoCommit = $FS::UID::AutoCommit;
285 local $FS::UID::AutoCommit = 0;
288 foreach my $table (qw(
299 foreach my $linked ( $self->$table() ) {
300 my $error = $linked->delete;
302 $dbh->rollback if $oldAutoCommit;
309 my $error = $self->SUPER::delete(@_);
311 $dbh->rollback if $oldAutoCommit;
315 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
321 =item replace [ OLD_RECORD ]
323 You can, but probably shouldn't modify invoices...
325 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
326 supplied, replaces this record. If there is an error, returns the error,
327 otherwise returns false.
331 #replace can be inherited from Record.pm
333 # replace_check is now the preferred way to #implement replace data checks
334 # (so $object->replace() works without an argument)
337 my( $new, $old ) = ( shift, shift );
338 return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
339 #return "Can't change _date!" unless $old->_date eq $new->_date;
340 return "Can't change _date" unless $old->_date == $new->_date;
341 return "Can't change charged" unless $old->charged == $new->charged
342 || $old->charged == 0
343 || $new->{'Hash'}{'cc_surcharge_replace_hack'};
349 =item add_cc_surcharge
355 sub add_cc_surcharge {
356 my ($self, $pkgnum, $amount) = (shift, shift, shift);
359 my $cust_bill_pkg = new FS::cust_bill_pkg({
360 'invnum' => $self->invnum,
364 $error = $cust_bill_pkg->insert;
365 return $error if $error;
367 $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
368 $self->charged($self->charged+$amount);
369 $error = $self->replace;
370 return $error if $error;
372 $self->apply_payments_and_credits;
378 Checks all fields to make sure this is a valid invoice. If there is an error,
379 returns the error, otherwise returns false. Called by the insert and replace
388 $self->ut_numbern('invnum')
389 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
390 || $self->ut_numbern('_date')
391 || $self->ut_money('charged')
392 || $self->ut_numbern('printed')
393 || $self->ut_enum('closed', [ '', 'Y' ])
394 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
395 || $self->ut_numbern('agent_invid') #varchar?
397 return $error if $error;
399 $self->_date(time) unless $self->_date;
401 $self->printed(0) if $self->printed eq '';
408 Returns the displayed invoice number for this invoice: agent_invid if
409 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
415 my $conf = $self->conf;
416 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
417 return $self->agent_invid;
419 return $self->invnum;
425 Returns a list consisting of the total previous balance for this customer,
426 followed by the previous outstanding invoices (as FS::cust_bill objects also).
433 my @cust_bill = sort { $a->_date <=> $b->_date }
434 grep { $_->owed != 0 }
435 qsearch( 'cust_bill', { 'custnum' => $self->custnum,
436 #'_date' => { op=>'<', value=>$self->_date },
437 'invnum' => { op=>'<', value=>$self->invnum },
440 foreach ( @cust_bill ) { $total += $_->owed; }
444 =item enable_previous
446 Whether to show the 'Previous Charges' section when printing this invoice.
447 The negation of the 'disable_previous_balance' config setting.
451 sub enable_previous {
453 my $agentnum = $self->cust_main->agentnum;
454 !$self->conf->exists('disable_previous_balance', $agentnum);
459 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
466 { 'table' => 'cust_bill_pkg',
467 'hashref' => { 'invnum' => $self->invnum },
468 'order_by' => 'ORDER BY billpkgnum',
473 =item cust_bill_pkg_pkgnum PKGNUM
475 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
480 sub cust_bill_pkg_pkgnum {
481 my( $self, $pkgnum ) = @_;
483 { 'table' => 'cust_bill_pkg',
484 'hashref' => { 'invnum' => $self->invnum,
487 'order_by' => 'ORDER BY billpkgnum',
494 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
501 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
502 $self->cust_bill_pkg;
504 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
509 Returns true if any of the packages (or their definitions) corresponding to the
510 line items for this invoice have the no_auto flag set.
516 grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
519 =item open_cust_bill_pkg
521 Returns the open line items for this invoice.
523 Note that cust_bill_pkg with both setup and recur fees are returned as two
524 separate line items, each with only one fee.
528 # modeled after cust_main::open_cust_bill
529 sub open_cust_bill_pkg {
532 # grep { $_->owed > 0 } $self->cust_bill_pkg
534 my %other = ( 'recur' => 'setup',
535 'setup' => 'recur', );
537 foreach my $field ( qw( recur setup )) {
538 push @open, map { $_->set( $other{$field}, 0 ); $_; }
539 grep { $_->owed($field) > 0 }
540 $self->cust_bill_pkg;
546 =item cust_bill_event
548 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
552 sub cust_bill_event {
554 qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
557 =item num_cust_bill_event
559 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
563 sub num_cust_bill_event {
566 "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
567 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
568 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
569 $sth->fetchrow_arrayref->[0];
574 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
578 #false laziness w/cust_pkg.pm
582 'table' => 'cust_event',
583 'addl_from' => 'JOIN part_event USING ( eventpart )',
584 'hashref' => { 'tablenum' => $self->invnum },
585 'extra_sql' => " AND eventtable = 'cust_bill' ",
591 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
595 #false laziness w/cust_pkg.pm
599 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
600 " WHERE tablenum = ? AND eventtable = 'cust_bill'";
601 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
602 $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
603 $sth->fetchrow_arrayref->[0];
608 Returns the customer (see L<FS::cust_main>) for this invoice.
614 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
617 =item cust_suspend_if_balance_over AMOUNT
619 Suspends the customer associated with this invoice if the total amount owed on
620 this invoice and all older invoices is greater than the specified amount.
622 Returns a list: an empty list on success or a list of errors.
626 sub cust_suspend_if_balance_over {
627 my( $self, $amount ) = ( shift, shift );
628 my $cust_main = $self->cust_main;
629 if ( $cust_main->total_owed_date($self->_date) < $amount ) {
632 $cust_main->suspend(@_);
638 Depreciated. See the cust_credited method.
640 #Returns a list consisting of the total previous credited (see
641 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
642 #outstanding credits (FS::cust_credit objects).
648 croak "FS::cust_bill->cust_credit depreciated; see ".
649 "FS::cust_bill->cust_credit_bill";
652 #my @cust_credit = sort { $a->_date <=> $b->_date }
653 # grep { $_->credited != 0 && $_->_date < $self->_date }
654 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
656 #foreach (@cust_credit) { $total += $_->credited; }
657 #$total, @cust_credit;
662 Depreciated. See the cust_bill_pay method.
664 #Returns all payments (see L<FS::cust_pay>) for this invoice.
670 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
672 #sort { $a->_date <=> $b->_date }
673 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
679 qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
682 sub cust_bill_pay_batch {
684 qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
689 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
695 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
696 sort { $a->_date <=> $b->_date }
697 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
702 =item cust_credit_bill
704 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
710 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
711 sort { $a->_date <=> $b->_date }
712 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
716 sub cust_credit_bill {
717 shift->cust_credited(@_);
720 #=item cust_bill_pay_pkgnum PKGNUM
722 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
723 #with matching pkgnum.
727 #sub cust_bill_pay_pkgnum {
728 # my( $self, $pkgnum ) = @_;
729 # map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
730 # sort { $a->_date <=> $b->_date }
731 # qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
732 # 'pkgnum' => $pkgnum,
737 =item cust_bill_pay_pkg PKGNUM
739 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
740 applied against the matching pkgnum.
744 sub cust_bill_pay_pkg {
745 my( $self, $pkgnum ) = @_;
748 'select' => 'cust_bill_pay_pkg.*',
749 'table' => 'cust_bill_pay_pkg',
750 'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
751 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
752 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
753 " AND cust_bill_pkg.pkgnum = $pkgnum",
758 #=item cust_credited_pkgnum PKGNUM
760 #=item cust_credit_bill_pkgnum PKGNUM
762 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
763 #with matching pkgnum.
767 #sub cust_credited_pkgnum {
768 # my( $self, $pkgnum ) = @_;
769 # map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
770 # sort { $a->_date <=> $b->_date }
771 # qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
772 # 'pkgnum' => $pkgnum,
777 #sub cust_credit_bill_pkgnum {
778 # shift->cust_credited_pkgnum(@_);
781 =item cust_credit_bill_pkg PKGNUM
783 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
784 applied against the matching pkgnum.
788 sub cust_credit_bill_pkg {
789 my( $self, $pkgnum ) = @_;
792 'select' => 'cust_credit_bill_pkg.*',
793 'table' => 'cust_credit_bill_pkg',
794 'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
795 ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
796 'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
797 " AND cust_bill_pkg.pkgnum = $pkgnum",
802 =item cust_bill_batch
804 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
808 sub cust_bill_batch {
810 qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
815 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
816 hash keyed by term length.
822 FS::discount_plan->all($self);
827 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
834 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
836 foreach (@taxlines) { $total += $_->setup; }
842 Returns the amount owed (still outstanding) on this invoice, which is charged
843 minus all payment applications (see L<FS::cust_bill_pay>) and credit
844 applications (see L<FS::cust_credit_bill>).
850 my $balance = $self->charged;
851 $balance -= $_->amount foreach ( $self->cust_bill_pay );
852 $balance -= $_->amount foreach ( $self->cust_credited );
853 $balance = sprintf( "%.2f", $balance);
854 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
859 my( $self, $pkgnum ) = @_;
861 #my $balance = $self->charged;
863 $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
865 $balance -= $_->amount for $self->cust_bill_pay_pkg($pkgnum);
866 $balance -= $_->amount for $self->cust_credit_bill_pkg($pkgnum);
868 $balance = sprintf( "%.2f", $balance);
869 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
875 Returns true if this invoice should be hidden. See the
876 selfservice-hide_invoices-taxclass configuraiton setting.
882 my $conf = $self->conf;
883 my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
885 my @cust_bill_pkg = $self->cust_bill_pkg;
886 my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
887 ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
890 =item apply_payments_and_credits [ OPTION => VALUE ... ]
892 Applies unapplied payments and credits to this invoice.
894 A hash of optional arguments may be passed. Currently "manual" is supported.
895 If true, a payment receipt is sent instead of a statement when
896 'payment_receipt_email' configuration option is set.
898 If there is an error, returns the error, otherwise returns false.
902 sub apply_payments_and_credits {
903 my( $self, %options ) = @_;
904 my $conf = $self->conf;
906 local $SIG{HUP} = 'IGNORE';
907 local $SIG{INT} = 'IGNORE';
908 local $SIG{QUIT} = 'IGNORE';
909 local $SIG{TERM} = 'IGNORE';
910 local $SIG{TSTP} = 'IGNORE';
911 local $SIG{PIPE} = 'IGNORE';
913 my $oldAutoCommit = $FS::UID::AutoCommit;
914 local $FS::UID::AutoCommit = 0;
917 $self->select_for_update; #mutex
919 my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
920 my @credits = grep { $_->credited > 0 } $self->cust_main->cust_credit;
922 if ( $conf->exists('pkg-balances') ) {
923 # limit @payments & @credits to those w/ a pkgnum grepped from $self
924 my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
925 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
926 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
929 while ( $self->owed > 0 and ( @payments || @credits ) ) {
932 if ( @payments && @credits ) {
934 #decide which goes first by weight of top (unapplied) line item
936 my @open_lineitems = $self->open_cust_bill_pkg;
939 max( map { $_->part_pkg->pay_weight || 0 }
944 my $max_credit_weight =
945 max( map { $_->part_pkg->credit_weight || 0 }
951 #if both are the same... payments first? it has to be something
952 if ( $max_pay_weight >= $max_credit_weight ) {
958 } elsif ( @payments ) {
960 } elsif ( @credits ) {
963 die "guru meditation #12 and 35";
967 if ( $app eq 'pay' ) {
969 my $payment = shift @payments;
970 $unapp_amount = $payment->unapplied;
971 $app = new FS::cust_bill_pay { 'paynum' => $payment->paynum };
972 $app->pkgnum( $payment->pkgnum )
973 if $conf->exists('pkg-balances') && $payment->pkgnum;
975 } elsif ( $app eq 'credit' ) {
977 my $credit = shift @credits;
978 $unapp_amount = $credit->credited;
979 $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
980 $app->pkgnum( $credit->pkgnum )
981 if $conf->exists('pkg-balances') && $credit->pkgnum;
984 die "guru meditation #12 and 35";
988 if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
989 warn "owed_pkgnum ". $app->pkgnum;
990 $owed = $self->owed_pkgnum($app->pkgnum);
994 next unless $owed > 0;
996 warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
997 $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
999 $app->invnum( $self->invnum );
1001 my $error = $app->insert(%options);
1003 $dbh->rollback if $oldAutoCommit;
1004 return "Error inserting ". $app->table. " record: $error";
1006 die $error if $error;
1010 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1015 =item generate_email OPTION => VALUE ...
1023 sender address, required
1027 alternate template name, optional
1031 text attachment arrayref, optional
1035 email subject, optional
1039 notice name instead of "Invoice", optional
1043 Returns an argument list to be passed to L<FS::Misc::send_email>.
1049 sub generate_email {
1053 my $conf = $self->conf;
1055 my $me = '[FS::cust_bill::generate_email]';
1058 'from' => $args{'from'},
1059 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
1063 'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
1064 'template' => $args{'template'},
1065 'notice_name' => ( $args{'notice_name'} || 'Invoice' ),
1066 'no_coupon' => $args{'no_coupon'},
1069 my $cust_main = $self->cust_main;
1071 if (ref($args{'to'}) eq 'ARRAY') {
1072 $return{'to'} = $args{'to'};
1074 $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1075 $cust_main->invoicing_list
1079 if ( $conf->exists('invoice_html') ) {
1081 warn "$me creating HTML/text multipart message"
1084 $return{'nobody'} = 1;
1086 my $alternative = build MIME::Entity
1087 'Type' => 'multipart/alternative',
1088 #'Encoding' => '7bit',
1089 'Disposition' => 'inline'
1093 if ( $conf->exists('invoice_email_pdf')
1094 and scalar($conf->config('invoice_email_pdf_note')) ) {
1096 warn "$me using 'invoice_email_pdf_note' in multipart message"
1098 $data = [ map { $_ . "\n" }
1099 $conf->config('invoice_email_pdf_note')
1104 warn "$me not using 'invoice_email_pdf_note' in multipart message"
1106 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1107 $data = $args{'print_text'};
1109 $data = [ $self->print_text(\%opt) ];
1114 $alternative->attach(
1115 'Type' => 'text/plain',
1116 'Encoding' => 'quoted-printable',
1117 #'Encoding' => '7bit',
1119 'Disposition' => 'inline',
1126 if ( $conf->exists('invoice_email_pdf')
1127 and scalar($conf->config('invoice_email_pdf_note')) ) {
1129 $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1133 $args{'from'} =~ /\@([\w\.\-]+)/;
1134 my $from = $1 || 'example.com';
1135 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1138 my $agentnum = $cust_main->agentnum;
1139 if ( defined($args{'template'}) && length($args{'template'})
1140 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1143 $logo = 'logo_'. $args{'template'}. '.png';
1147 my $image_data = $conf->config_binary( $logo, $agentnum);
1149 $image = build MIME::Entity
1150 'Type' => 'image/png',
1151 'Encoding' => 'base64',
1152 'Data' => $image_data,
1153 'Filename' => 'logo.png',
1154 'Content-ID' => "<$content_id>",
1157 if ($conf->exists('invoice-barcode')) {
1158 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1159 $barcode = build MIME::Entity
1160 'Type' => 'image/png',
1161 'Encoding' => 'base64',
1162 'Data' => $self->invoice_barcode(0),
1163 'Filename' => 'barcode.png',
1164 'Content-ID' => "<$barcode_content_id>",
1166 $opt{'barcode_cid'} = $barcode_content_id;
1169 $htmldata = $self->print_html({ 'cid'=>$content_id, %opt });
1172 $alternative->attach(
1173 'Type' => 'text/html',
1174 'Encoding' => 'quoted-printable',
1175 'Data' => [ '<html>',
1178 ' '. encode_entities($return{'subject'}),
1181 ' <body bgcolor="#e8e8e8">',
1186 'Disposition' => 'inline',
1187 #'Filename' => 'invoice.pdf',
1191 my @otherparts = ();
1192 if ( $cust_main->email_csv_cdr ) {
1194 push @otherparts, build MIME::Entity
1195 'Type' => 'text/csv',
1196 'Encoding' => '7bit',
1197 'Data' => [ map { "$_\n" }
1198 $self->call_details('prepend_billed_number' => 1)
1200 'Disposition' => 'attachment',
1201 'Filename' => 'usage-'. $self->invnum. '.csv',
1206 if ( $conf->exists('invoice_email_pdf') ) {
1211 # multipart/alternative
1217 my $related = build MIME::Entity 'Type' => 'multipart/related',
1218 'Encoding' => '7bit';
1220 #false laziness w/Misc::send_email
1221 $related->head->replace('Content-type',
1222 $related->mime_type.
1223 '; boundary="'. $related->head->multipart_boundary. '"'.
1224 '; type=multipart/alternative'
1227 $related->add_part($alternative);
1229 $related->add_part($image) if $image;
1231 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1233 $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1237 #no other attachment:
1239 # multipart/alternative
1244 $return{'content-type'} = 'multipart/related';
1245 if ($conf->exists('invoice-barcode') && $barcode) {
1246 $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1248 $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1250 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1251 #$return{'disposition'} = 'inline';
1257 if ( $conf->exists('invoice_email_pdf') ) {
1258 warn "$me creating PDF attachment"
1261 #mime parts arguments a la MIME::Entity->build().
1262 $return{'mimeparts'} = [
1263 { $self->mimebuild_pdf(\%opt) }
1267 if ( $conf->exists('invoice_email_pdf')
1268 and scalar($conf->config('invoice_email_pdf_note')) ) {
1270 warn "$me using 'invoice_email_pdf_note'"
1272 $return{'body'} = [ map { $_ . "\n" }
1273 $conf->config('invoice_email_pdf_note')
1278 warn "$me not using 'invoice_email_pdf_note'"
1280 if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1281 $return{'body'} = $args{'print_text'};
1283 $return{'body'} = [ $self->print_text(\%opt) ];
1296 Returns a list suitable for passing to MIME::Entity->build(), representing
1297 this invoice as PDF attachment.
1304 'Type' => 'application/pdf',
1305 'Encoding' => 'base64',
1306 'Data' => [ $self->print_pdf(@_) ],
1307 'Disposition' => 'attachment',
1308 'Filename' => 'invoice-'. $self->invnum. '.pdf',
1312 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1314 Sends this invoice to the destinations configured for this customer: sends
1315 email, prints and/or faxes. See L<FS::cust_main_invoice>.
1317 Options can be passed as a hashref (recommended) or as a list of up to
1318 four values for templatename, agentnum, invoice_from and amount.
1320 I<template>, if specified, is the name of a suffix for alternate invoices.
1322 I<agentnum>, if specified, means that this invoice will only be sent for customers
1323 of the specified agent or agent(s). AGENTNUM can be a scalar agentnum (for a
1324 single agent) or an arrayref of agentnums.
1326 I<invoice_from>, if specified, overrides the default email invoice From: address.
1328 I<amount>, if specified, only sends the invoice if the total amount owed on this
1329 invoice and all older invoices is greater than the specified amount.
1331 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1335 sub queueable_send {
1338 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1339 or die "invalid invoice number: " . $opt{invnum};
1341 my @args = ( $opt{template}, $opt{agentnum} );
1342 push @args, $opt{invoice_from}
1343 if exists($opt{invoice_from}) && $opt{invoice_from};
1345 my $error = $self->send( @args );
1346 die $error if $error;
1352 my $conf = $self->conf;
1354 my( $template, $invoice_from, $notice_name );
1356 my $balance_over = 0;
1360 $template = $opt->{'template'} || '';
1361 if ( $agentnums = $opt->{'agentnum'} ) {
1362 $agentnums = [ $agentnums ] unless ref($agentnums);
1364 $invoice_from = $opt->{'invoice_from'};
1365 $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1366 $notice_name = $opt->{'notice_name'};
1368 $template = scalar(@_) ? shift : '';
1369 if ( scalar(@_) && $_[0] ) {
1370 $agentnums = ref($_[0]) ? shift : [ shift ];
1372 $invoice_from = shift if scalar(@_);
1373 $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1376 my $cust_main = $self->cust_main;
1378 return 'N/A' unless ! $agentnums
1379 or grep { $_ == $cust_main->agentnum } @$agentnums;
1382 unless $cust_main->total_owed_date($self->_date) > $balance_over;
1384 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1385 $conf->config('invoice_from', $cust_main->agentnum );
1388 'template' => $template,
1389 'invoice_from' => $invoice_from,
1390 'notice_name' => ( $notice_name || 'Invoice' ),
1393 my @invoicing_list = $cust_main->invoicing_list;
1395 #$self->email_invoice(\%opt)
1397 if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1398 && ! $self->invoice_noemail;
1400 #$self->print_invoice(\%opt)
1402 if grep { $_ eq 'POST' } @invoicing_list; #postal
1404 $self->fax_invoice(\%opt)
1405 if grep { $_ eq 'FAX' } @invoicing_list; #fax
1411 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1413 Emails this invoice.
1415 Options can be passed as a hashref (recommended) or as a list of up to
1416 two values for templatename and invoice_from.
1418 I<template>, if specified, is the name of a suffix for alternate invoices.
1420 I<invoice_from>, if specified, overrides the default email invoice From: address.
1422 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1426 sub queueable_email {
1429 my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1430 or die "invalid invoice number: " . $opt{invnum};
1432 my %args = ( 'template' => $opt{template} );
1433 $args{$_} = $opt{$_}
1434 foreach grep { exists($opt{$_}) && $opt{$_} }
1435 qw( invoice_from notice_name no_coupon );
1437 my $error = $self->email( \%args );
1438 die $error if $error;
1442 #sub email_invoice {
1445 return if $self->hide;
1446 my $conf = $self->conf;
1448 my( $template, $invoice_from, $notice_name, $no_coupon );
1451 $template = $opt->{'template'} || '';
1452 $invoice_from = $opt->{'invoice_from'};
1453 $notice_name = $opt->{'notice_name'} || 'Invoice';
1454 $no_coupon = $opt->{'no_coupon'} || 0;
1456 $template = scalar(@_) ? shift : '';
1457 $invoice_from = shift if scalar(@_);
1458 $notice_name = 'Invoice';
1462 $invoice_from ||= $self->_agent_invoice_from || #XXX should go away
1463 $conf->config('invoice_from', $self->cust_main->agentnum );
1465 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1466 $self->cust_main->invoicing_list;
1468 if ( ! @invoicing_list ) { #no recipients
1469 if ( $conf->exists('cust_bill-no_recipients-error') ) {
1470 die 'No recipients for customer #'. $self->custnum;
1472 #default: better to notify this person than silence
1473 @invoicing_list = ($invoice_from);
1477 my $subject = $self->email_subject($template);
1479 my $error = send_email(
1480 $self->generate_email(
1481 'from' => $invoice_from,
1482 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1483 'subject' => $subject,
1484 'template' => $template,
1485 'notice_name' => $notice_name,
1486 'no_coupon' => $no_coupon,
1489 die "can't email invoice: $error\n" if $error;
1490 #die "$error\n" if $error;
1496 my $conf = $self->conf;
1498 #my $template = scalar(@_) ? shift : '';
1501 my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1504 my $cust_main = $self->cust_main;
1505 my $name = $cust_main->name;
1506 my $name_short = $cust_main->name_short;
1507 my $invoice_number = $self->invnum;
1508 my $invoice_date = $self->_date_pretty;
1510 eval qq("$subject");
1513 =item lpr_data HASHREF | [ TEMPLATE ]
1515 Returns the postscript or plaintext for this invoice as an arrayref.
1517 Options can be passed as a hashref (recommended) or as a single optional value
1520 I<template>, if specified, is the name of a suffix for alternate invoices.
1522 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1528 my $conf = $self->conf;
1529 my( $template, $notice_name );
1532 $template = $opt->{'template'} || '';
1533 $notice_name = $opt->{'notice_name'} || 'Invoice';
1535 $template = scalar(@_) ? shift : '';
1536 $notice_name = 'Invoice';
1540 'template' => $template,
1541 'notice_name' => $notice_name,
1544 my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1545 [ $self->$method( \%opt ) ];
1548 =item print HASHREF | [ TEMPLATE ]
1550 Prints this invoice.
1552 Options can be passed as a hashref (recommended) or as a single optional
1555 I<template>, if specified, is the name of a suffix for alternate invoices.
1557 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1561 #sub print_invoice {
1564 return if $self->hide;
1565 my $conf = $self->conf;
1567 my( $template, $notice_name );
1570 $template = $opt->{'template'} || '';
1571 $notice_name = $opt->{'notice_name'} || 'Invoice';
1573 $template = scalar(@_) ? shift : '';
1574 $notice_name = 'Invoice';
1578 'template' => $template,
1579 'notice_name' => $notice_name,
1582 if($conf->exists('invoice_print_pdf')) {
1583 # Add the invoice to the current batch.
1584 $self->batch_invoice(\%opt);
1587 do_print $self->lpr_data(\%opt);
1591 =item fax_invoice HASHREF | [ TEMPLATE ]
1595 Options can be passed as a hashref (recommended) or as a single optional
1598 I<template>, if specified, is the name of a suffix for alternate invoices.
1600 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1606 return if $self->hide;
1607 my $conf = $self->conf;
1609 my( $template, $notice_name );
1612 $template = $opt->{'template'} || '';
1613 $notice_name = $opt->{'notice_name'} || 'Invoice';
1615 $template = scalar(@_) ? shift : '';
1616 $notice_name = 'Invoice';
1619 die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1620 unless $conf->exists('invoice_latex');
1622 my $dialstring = $self->cust_main->getfield('fax');
1626 'template' => $template,
1627 'notice_name' => $notice_name,
1630 my $error = send_fax( 'docdata' => $self->lpr_data(\%opt),
1631 'dialstring' => $dialstring,
1633 die $error if $error;
1637 =item batch_invoice [ HASHREF ]
1639 Place this invoice into the open batch (see C<FS::bill_batch>). If there
1640 isn't an open batch, one will be created.
1645 my ($self, $opt) = @_;
1646 my $bill_batch = $self->get_open_bill_batch;
1647 my $cust_bill_batch = FS::cust_bill_batch->new({
1648 batchnum => $bill_batch->batchnum,
1649 invnum => $self->invnum,
1651 return $cust_bill_batch->insert($opt);
1654 =item get_open_batch
1656 Returns the currently open batch as an FS::bill_batch object, creating a new
1657 one if necessary. (A per-agent batch if invoice_print_pdf-spoolagent is
1662 sub get_open_bill_batch {
1664 my $conf = $self->conf;
1665 my $hashref = { status => 'O' };
1666 $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1667 ? $self->cust_main->agentnum
1669 my $batch = qsearchs('bill_batch', $hashref);
1670 return $batch if $batch;
1671 $batch = FS::bill_batch->new($hashref);
1672 my $error = $batch->insert;
1673 die $error if $error;
1677 =item ftp_invoice [ TEMPLATENAME ]
1679 Sends this invoice data via FTP.
1681 TEMPLATENAME is unused?
1687 my $conf = $self->conf;
1688 my $template = scalar(@_) ? shift : '';
1691 'protocol' => 'ftp',
1692 'server' => $conf->config('cust_bill-ftpserver'),
1693 'username' => $conf->config('cust_bill-ftpusername'),
1694 'password' => $conf->config('cust_bill-ftppassword'),
1695 'dir' => $conf->config('cust_bill-ftpdir'),
1696 'format' => $conf->config('cust_bill-ftpformat'),
1700 =item spool_invoice [ TEMPLATENAME ]
1702 Spools this invoice data (see L<FS::spool_csv>)
1704 TEMPLATENAME is unused?
1710 my $conf = $self->conf;
1711 my $template = scalar(@_) ? shift : '';
1714 'format' => $conf->config('cust_bill-spoolformat'),
1715 'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1719 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1721 Like B<send>, but only sends the invoice if it is the newest open invoice for
1726 sub send_if_newest {
1731 grep { $_->owed > 0 }
1732 qsearch('cust_bill', {
1733 'custnum' => $self->custnum,
1734 #'_date' => { op=>'>', value=>$self->_date },
1735 'invnum' => { op=>'>', value=>$self->invnum },
1742 =item send_csv OPTION => VALUE, ...
1744 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1748 protocol - currently only "ftp"
1754 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1755 and YYMMDDHHMMSS is a timestamp.
1757 See L</print_csv> for a description of the output format.
1762 my($self, %opt) = @_;
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);
1770 my $file = "$spooldir/$tracctnum.csv";
1772 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1774 open(CSV, ">$file") or die "can't open $file: $!";
1782 if ( $opt{protocol} eq 'ftp' ) {
1783 eval "use Net::FTP;";
1785 $net = Net::FTP->new($opt{server}) or die @$;
1787 die "unknown protocol: $opt{protocol}";
1790 $net->login( $opt{username}, $opt{password} )
1791 or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1793 $net->binary or die "can't set binary mode";
1795 $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1797 $net->put($file) or die "can't put $file: $!";
1807 Spools CSV invoice data.
1813 =item format - any of FS::Misc::::Invoicing::spool_formats
1815 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1816 customer has the corresponding invoice destinations set (see
1817 L<FS::cust_main_invoice>).
1819 =item agent_spools - if set to a true value, will spool to per-agent files
1820 rather than a single global file
1822 =item ftp_targetnum - if set to an FTP target (see L<FS::ftp_target>), will
1823 append to that spool. L<FS::Cron::upload> will then send the spool file to
1826 =item balanceover - if set, only spools the invoice if the total amount owed on
1827 this invoice and all older invoices is greater than the specified amount.
1834 my($self, %opt) = @_;
1836 my $cust_main = $self->cust_main;
1838 if ( $opt{'dest'} ) {
1839 my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1840 $cust_main->invoicing_list;
1841 return 'N/A' unless $invoicing_list{$opt{'dest'}}
1842 || ! keys %invoicing_list;
1845 if ( $opt{'balanceover'} ) {
1847 if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1850 my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1851 mkdir $spooldir, 0700 unless -d $spooldir;
1853 my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1856 if ( $opt{'agent_spools'} ) {
1857 $file = 'agentnum'.$cust_main->agentnum;
1862 if ( $opt{'ftp_targetnum'} ) {
1863 $spooldir .= '/target'.$opt{'ftp_targetnum'};
1864 mkdir $spooldir, 0700 unless -d $spooldir;
1865 } # otherwise it just goes into export.xxx/cust_bill
1867 if ( lc($opt{'format'}) eq 'billco' ) {
1871 $file = "$spooldir/$file.csv";
1873 my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1875 open(CSV, ">>$file") or die "can't open $file: $!";
1876 flock(CSV, LOCK_EX);
1881 if ( lc($opt{'format'}) eq 'billco' ) {
1883 flock(CSV, LOCK_UN);
1886 $file =~ s/-header.csv$/-detail.csv/;
1888 open(CSV,">>$file") or die "can't open $file: $!";
1889 flock(CSV, LOCK_EX);
1895 flock(CSV, LOCK_UN);
1902 =item print_csv OPTION => VALUE, ...
1904 Returns CSV data for this invoice.
1908 format - 'default', 'billco', 'oneline', 'bridgestone'
1910 Returns a list consisting of two scalars. The first is a single line of CSV
1911 header information for this invoice. The second is one or more lines of CSV
1912 detail information for this invoice.
1914 If I<format> is not specified or "default", the fields of the CSV file are as
1917 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1918 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1922 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1924 B<record_type> is C<cust_bill> for the initial header line only. The
1925 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1926 fields are filled in.
1928 B<record_type> is C<cust_bill_pkg> for detail lines. Only the first two fields
1929 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1932 =item invnum - invoice number
1934 =item custnum - customer number
1936 =item _date - invoice date
1938 =item charged - total invoice amount
1940 =item first - customer first name
1942 =item last - customer first name
1944 =item company - company name
1946 =item address1 - address line 1
1948 =item address2 - address line 1
1958 =item pkg - line item description
1960 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1962 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1964 =item sdate - start date for recurring fee
1966 =item edate - end date for recurring fee
1970 If I<format> is "billco", the fields of the header CSV file are as follows:
1972 +-------------------------------------------------------------------+
1973 | FORMAT HEADER FILE |
1974 |-------------------------------------------------------------------|
1975 | Field | Description | Name | Type | Width |
1976 | 1 | N/A-Leave Empty | RC | CHAR | 2 |
1977 | 2 | N/A-Leave Empty | CUSTID | CHAR | 15 |
1978 | 3 | Transaction Account No | TRACCTNUM | CHAR | 15 |
1979 | 4 | Transaction Invoice No | TRINVOICE | CHAR | 15 |
1980 | 5 | Transaction Zip Code | TRZIP | CHAR | 5 |
1981 | 6 | Transaction Company Bill To | TRCOMPANY | CHAR | 30 |
1982 | 7 | Transaction Contact Bill To | TRNAME | CHAR | 30 |
1983 | 8 | Additional Address Unit Info | TRADDR1 | CHAR | 30 |
1984 | 9 | Bill To Street Address | TRADDR2 | CHAR | 30 |
1985 | 10 | Ancillary Billing Information | TRADDR3 | CHAR | 30 |
1986 | 11 | Transaction City Bill To | TRCITY | CHAR | 20 |
1987 | 12 | Transaction State Bill To | TRSTATE | CHAR | 2 |
1988 | 13 | Bill Cycle Close Date | CLOSEDATE | CHAR | 10 |
1989 | 14 | Bill Due Date | DUEDATE | CHAR | 10 |
1990 | 15 | Previous Balance | BALFWD | NUM* | 9 |
1991 | 16 | Pmt/CR Applied | CREDAPPLY | NUM* | 9 |
1992 | 17 | Total Current Charges | CURRENTCHG | NUM* | 9 |
1993 | 18 | Total Amt Due | TOTALDUE | NUM* | 9 |
1994 | 19 | Total Amt Due | AMTDUE | NUM* | 9 |
1995 | 20 | 30 Day Aging | AMT30 | NUM* | 9 |
1996 | 21 | 60 Day Aging | AMT60 | NUM* | 9 |
1997 | 22 | 90 Day Aging | AMT90 | NUM* | 9 |
1998 | 23 | Y/N | AGESWITCH | CHAR | 1 |
1999 | 24 | Remittance automation | SCANLINE | CHAR | 100 |
2000 | 25 | Total Taxes & Fees | TAXTOT | NUM* | 9 |
2001 | 26 | Customer Reference Number | CUSTREF | CHAR | 15 |
2002 | 27 | Federal Tax*** | FEDTAX | NUM* | 9 |
2003 | 28 | State Tax*** | STATETAX | NUM* | 9 |
2004 | 29 | Other Taxes & Fees*** | OTHERTAX | NUM* | 9 |
2005 +-------+-------------------------------+------------+------+-------+
2007 If I<format> is "billco", the fields of the detail CSV file are as follows:
2009 FORMAT FOR DETAIL FILE
2011 Field | Description | Name | Type | Width
2012 1 | N/A-Leave Empty | RC | CHAR | 2
2013 2 | N/A-Leave Empty | CUSTID | CHAR | 15
2014 3 | Account Number | TRACCTNUM | CHAR | 15
2015 4 | Invoice Number | TRINVOICE | CHAR | 15
2016 5 | Line Sequence (sort order) | LINESEQ | NUM | 6
2017 6 | Transaction Detail | DETAILS | CHAR | 100
2018 7 | Amount | AMT | NUM* | 9
2019 8 | Line Format Control** | LNCTRL | CHAR | 2
2020 9 | Grouping Code | GROUP | CHAR | 2
2021 10 | User Defined | ACCT CODE | CHAR | 15
2023 If format is 'oneline', there is no detail file. Each invoice has a
2024 header line only, with the fields:
2026 Agent number, agent name, customer number, first name, last name, address
2027 line 1, address line 2, city, state, zip, invoice date, invoice number,
2028 amount charged, amount due,
2030 and then, for each line item, three columns containing the package number,
2031 description, and amount.
2033 If format is 'bridgestone', there is no detail file. Each invoice has a
2034 header line with the following fields in a fixed-width format:
2036 Customer number (in display format), date, name (first last), company,
2037 address 1, address 2, city, state, zip.
2039 This is a mailing list format, and has no per-invoice fields. To avoid
2040 sending redundant notices, the spooling event should have a "once" or
2041 "once_percust_every" condition.
2046 my($self, %opt) = @_;
2048 eval "use Text::CSV_XS";
2051 my $cust_main = $self->cust_main;
2053 my $csv = Text::CSV_XS->new({'always_quote'=>1});
2055 if ( lc($opt{'format'}) eq 'billco' ) {
2058 $taxtotal += $_->{'amount'} foreach $self->_items_tax;
2060 my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
2062 my( $previous_balance, @unused ) = $self->previous; #previous balance
2064 my $pmt_cr_applied = 0;
2065 $pmt_cr_applied += $_->{'amount'}
2066 foreach ( $self->_items_payments, $self->_items_credits ) ;
2068 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2071 '', # 1 | N/A-Leave Empty CHAR 2
2072 '', # 2 | N/A-Leave Empty CHAR 15
2073 $opt{'tracctnum'}, # 3 | Transaction Account No CHAR 15
2074 $self->invnum, # 4 | Transaction Invoice No CHAR 15
2075 $cust_main->zip, # 5 | Transaction Zip Code CHAR 5
2076 $cust_main->company, # 6 | Transaction Company Bill To CHAR 30
2077 #$cust_main->payname, # 7 | Transaction Contact Bill To CHAR 30
2078 $cust_main->contact, # 7 | Transaction Contact Bill To CHAR 30
2079 $cust_main->address2, # 8 | Additional Address Unit Info CHAR 30
2080 $cust_main->address1, # 9 | Bill To Street Address CHAR 30
2081 '', # 10 | Ancillary Billing Information CHAR 30
2082 $cust_main->city, # 11 | Transaction City Bill To CHAR 20
2083 $cust_main->state, # 12 | Transaction State Bill To CHAR 2
2086 time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR 10
2089 $duedate, # 14 | Bill Due Date CHAR 10
2091 $previous_balance, # 15 | Previous Balance NUM* 9
2092 $pmt_cr_applied, # 16 | Pmt/CR Applied NUM* 9
2093 sprintf("%.2f", $self->charged), # 17 | Total Current Charges NUM* 9
2094 $totaldue, # 18 | Total Amt Due NUM* 9
2095 $totaldue, # 19 | Total Amt Due NUM* 9
2096 '', # 20 | 30 Day Aging NUM* 9
2097 '', # 21 | 60 Day Aging NUM* 9
2098 '', # 22 | 90 Day Aging NUM* 9
2099 'N', # 23 | Y/N CHAR 1
2100 '', # 24 | Remittance automation CHAR 100
2101 $taxtotal, # 25 | Total Taxes & Fees NUM* 9
2102 $self->custnum, # 26 | Customer Reference Number CHAR 15
2103 '0', # 27 | Federal Tax*** NUM* 9
2104 sprintf("%.2f", $taxtotal), # 28 | State Tax*** NUM* 9
2105 '0', # 29 | Other Taxes & Fees*** NUM* 9
2108 } elsif ( lc($opt{'format'}) eq 'oneline' ) { #name?
2110 my ($previous_balance) = $self->previous;
2111 my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2113 ($_->{pkgnum} || ''),
2116 } $self->_items_pkg;
2119 $cust_main->agentnum,
2120 $cust_main->agent->agent,
2124 $cust_main->address1,
2125 $cust_main->address2,
2131 time2str("%x", $self->_date),
2139 } elsif ( lc($opt{'format'}) eq 'bridgestone' ) {
2141 # bypass the CSV stuff and just return this
2142 my $longdate = time2str('%B %d, %Y', time); #current time, right?
2143 my $zip = $cust_main->zip;
2145 my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2149 "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2151 $cust_main->display_custnum,
2153 uc(substr($cust_main->contact_firstlast,0,30)),
2154 uc(substr($cust_main->company ,0,30)),
2155 uc(substr($cust_main->address1 ,0,30)),
2156 uc(substr($cust_main->address2 ,0,30)),
2157 uc(substr($cust_main->city ,0,20)),
2158 uc($cust_main->state),
2170 time2str("%x", $self->_date),
2171 sprintf("%.2f", $self->charged),
2172 ( map { $cust_main->getfield($_) }
2173 qw( first last company address1 address2 city state zip country ) ),
2175 ) or die "can't create csv";
2178 my $header = $csv->string. "\n";
2181 if ( lc($opt{'format'}) eq 'billco' ) {
2184 foreach my $item ( $self->_items_pkg ) {
2187 '', # 1 | N/A-Leave Empty CHAR 2
2188 '', # 2 | N/A-Leave Empty CHAR 15
2189 $opt{'tracctnum'}, # 3 | Account Number CHAR 15
2190 $self->invnum, # 4 | Invoice Number CHAR 15
2191 $lineseq++, # 5 | Line Sequence (sort order) NUM 6
2192 $item->{'description'}, # 6 | Transaction Detail CHAR 100
2193 $item->{'amount'}, # 7 | Amount NUM* 9
2194 '', # 8 | Line Format Control** CHAR 2
2195 '', # 9 | Grouping Code CHAR 2
2196 '', # 10 | User Defined CHAR 15
2199 $detail .= $csv->string. "\n";
2203 } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2209 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2211 my($pkg, $setup, $recur, $sdate, $edate);
2212 if ( $cust_bill_pkg->pkgnum ) {
2214 ($pkg, $setup, $recur, $sdate, $edate) = (
2215 $cust_bill_pkg->part_pkg->pkg,
2216 ( $cust_bill_pkg->setup != 0
2217 ? sprintf("%.2f", $cust_bill_pkg->setup )
2219 ( $cust_bill_pkg->recur != 0
2220 ? sprintf("%.2f", $cust_bill_pkg->recur )
2222 ( $cust_bill_pkg->sdate
2223 ? time2str("%x", $cust_bill_pkg->sdate)
2225 ($cust_bill_pkg->edate
2226 ?time2str("%x", $cust_bill_pkg->edate)
2230 } else { #pkgnum tax
2231 next unless $cust_bill_pkg->setup != 0;
2232 $pkg = $cust_bill_pkg->desc;
2233 $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2234 ( $sdate, $edate ) = ( '', '' );
2240 ( map { '' } (1..11) ),
2241 ($pkg, $setup, $recur, $sdate, $edate)
2242 ) or die "can't create csv";
2244 $detail .= $csv->string. "\n";
2250 ( $header, $detail );
2256 Pays this invoice with a compliemntary payment. If there is an error,
2257 returns the error, otherwise returns false.
2263 my $cust_pay = new FS::cust_pay ( {
2264 'invnum' => $self->invnum,
2265 'paid' => $self->owed,
2268 'payinfo' => $self->cust_main->payinfo,
2276 Attempts to pay this invoice with a credit card payment via a
2277 Business::OnlinePayment realtime gateway. See
2278 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2279 for supported processors.
2285 $self->realtime_bop( 'CC', @_ );
2290 Attempts to pay this invoice with an electronic check (ACH) payment via a
2291 Business::OnlinePayment realtime gateway. See
2292 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2293 for supported processors.
2299 $self->realtime_bop( 'ECHECK', @_ );
2304 Attempts to pay this invoice with phone bill (LEC) payment via a
2305 Business::OnlinePayment realtime gateway. See
2306 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2307 for supported processors.
2313 $self->realtime_bop( 'LEC', @_ );
2317 my( $self, $method ) = (shift,shift);
2318 my $conf = $self->conf;
2321 my $cust_main = $self->cust_main;
2322 my $balance = $cust_main->balance;
2323 my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2324 $amount = sprintf("%.2f", $amount);
2325 return "not run (balance $balance)" unless $amount > 0;
2327 my $description = 'Internet Services';
2328 if ( $conf->exists('business-onlinepayment-description') ) {
2329 my $dtempl = $conf->config('business-onlinepayment-description');
2331 my $agent_obj = $cust_main->agent
2332 or die "can't retreive agent for $cust_main (agentnum ".
2333 $cust_main->agentnum. ")";
2334 my $agent = $agent_obj->agent;
2335 my $pkgs = join(', ',
2336 map { $_->part_pkg->pkg }
2337 grep { $_->pkgnum } $self->cust_bill_pkg
2339 $description = eval qq("$dtempl");
2342 $cust_main->realtime_bop($method, $amount,
2343 'description' => $description,
2344 'invnum' => $self->invnum,
2345 #this didn't do what we want, it just calls apply_payments_and_credits
2347 'apply_to_invoice' => 1,
2350 #this changes application behavior: auto payments
2351 #triggered against a specific invoice are now applied
2352 #to that invoice instead of oldest open.
2358 =item batch_card OPTION => VALUE...
2360 Adds a payment for this invoice to the pending credit card batch (see
2361 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2362 runs the payment using a realtime gateway.
2367 my ($self, %options) = @_;
2368 my $cust_main = $self->cust_main;
2370 $options{invnum} = $self->invnum;
2372 $cust_main->batch_card(%options);
2375 sub _agent_template {
2377 $self->cust_main->agent_template;
2380 sub _agent_invoice_from {
2382 $self->cust_main->agent_invoice_from;
2385 =item invoice_barcode DIR_OR_FALSE
2387 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2388 it is taken as the temp directory where the PNG file will be generated and the
2389 PNG file name is returned. Otherwise, the PNG image itself is returned.
2393 sub invoice_barcode {
2394 my ($self, $dir) = (shift,shift);
2396 my $gdbar = new GD::Barcode('Code39',$self->invnum);
2397 die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2398 my $gd = $gdbar->plot(Height => 30);
2401 my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2405 ) or die "can't open temp file: $!\n";
2406 print $bh $gd->png or die "cannot write barcode to file: $!\n";
2407 my $png_file = $bh->filename;
2414 =item invnum_date_pretty
2416 Returns a string with the invoice number and date, for example:
2417 "Invoice #54 (3/20/2008)"
2421 sub invnum_date_pretty {
2423 $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
2426 #sub _items_extra_usage_sections {
2428 # my $escape = shift;
2430 # my %sections = ();
2432 # my %usage_class = map{ $_->classname, $_ } qsearch('usage_class', {});
2433 # foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2435 # next unless $cust_bill_pkg->pkgnum > 0;
2437 # foreach my $section ( keys %usage_class ) {
2439 # my $usage = $cust_bill_pkg->usage($section);
2441 # next unless $usage && $usage > 0;
2443 # $sections{$section} ||= 0;
2444 # $sections{$section} += $usage;
2450 # map { { 'description' => &{$escape}($_),
2451 # 'subtotal' => $sections{$_},
2452 # 'summarized' => '',
2453 # 'tax_section' => '',
2456 # sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2460 sub _items_extra_usage_sections {
2462 my $conf = $self->conf;
2470 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2472 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2473 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2474 next unless $cust_bill_pkg->pkgnum > 0;
2476 foreach my $classnum ( keys %usage_class ) {
2477 my $section = $usage_class{$classnum}->classname;
2478 $classnums{$section} = $classnum;
2480 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2481 my $amount = $detail->amount;
2482 next unless $amount && $amount > 0;
2484 $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2485 $sections{$section}{amount} += $amount; #subtotal
2486 $sections{$section}{calls}++;
2487 $sections{$section}{duration} += $detail->duration;
2489 my $desc = $detail->regionname;
2490 my $description = $desc;
2491 $description = substr($desc, 0, $maxlength). '...'
2492 if $format eq 'latex' && length($desc) > $maxlength;
2494 $lines{$section}{$desc} ||= {
2495 description => &{$escape}($description),
2496 #pkgpart => $part_pkg->pkgpart,
2497 pkgnum => $cust_bill_pkg->pkgnum,
2502 #unit_amount => $cust_bill_pkg->unitrecur,
2503 quantity => $cust_bill_pkg->quantity,
2504 product_code => 'N/A',
2505 ext_description => [],
2508 $lines{$section}{$desc}{amount} += $amount;
2509 $lines{$section}{$desc}{calls}++;
2510 $lines{$section}{$desc}{duration} += $detail->duration;
2516 my %sectionmap = ();
2517 foreach (keys %sections) {
2518 my $usage_class = $usage_class{$classnums{$_}};
2519 $sectionmap{$_} = { 'description' => &{$escape}($_),
2520 'amount' => $sections{$_}{amount}, #subtotal
2521 'calls' => $sections{$_}{calls},
2522 'duration' => $sections{$_}{duration},
2524 'tax_section' => '',
2525 'sort_weight' => $usage_class->weight,
2526 ( $usage_class->format
2527 ? ( map { $_ => $usage_class->$_($format) }
2528 qw( description_generator header_generator total_generator total_line_generator )
2535 my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2539 foreach my $section ( keys %lines ) {
2540 foreach my $line ( keys %{$lines{$section}} ) {
2541 my $l = $lines{$section}{$line};
2542 $l->{section} = $sectionmap{$section};
2543 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2544 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2549 return(\@sections, \@lines);
2555 my $end = $self->_date;
2557 # start at date of previous invoice + 1 second or 0 if no previous invoice
2558 my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2559 $start = 0 if !$start;
2562 my $cust_main = $self->cust_main;
2563 my @pkgs = $cust_main->all_pkgs;
2564 my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2567 foreach my $pkg ( @pkgs ) {
2568 my @h_cust_svc = $pkg->h_cust_svc($end);
2569 foreach my $h_cust_svc ( @h_cust_svc ) {
2570 next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2571 next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2573 my $inserted = $h_cust_svc->date_inserted;
2574 my $deleted = $h_cust_svc->date_deleted;
2575 my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2577 $phone_deleted = $h_cust_svc->h_svc_x($deleted) if $deleted;
2579 # DID either activated or ported in; cannot be both for same DID simultaneously
2580 if ($inserted >= $start && $inserted <= $end && $phone_inserted
2581 && (!$phone_inserted->lnp_status
2582 || $phone_inserted->lnp_status eq ''
2583 || $phone_inserted->lnp_status eq 'native')) {
2586 else { # this one not so clean, should probably move to (h_)svc_phone
2587 my $phone_portedin = qsearchs( 'h_svc_phone',
2588 { 'svcnum' => $h_cust_svc->svcnum,
2589 'lnp_status' => 'portedin' },
2590 FS::h_svc_phone->sql_h_searchs($end),
2592 $num_portedin++ if $phone_portedin;
2595 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2596 if($deleted >= $start && $deleted <= $end && $phone_deleted
2597 && (!$phone_deleted->lnp_status
2598 || $phone_deleted->lnp_status ne 'portingout')) {
2601 elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2602 && $phone_deleted->lnp_status
2603 && $phone_deleted->lnp_status eq 'portingout') {
2607 # increment usage minutes
2608 if ( $phone_inserted ) {
2609 my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2610 $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2613 warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2616 # don't look at this service again
2617 push @seen, $h_cust_svc->svcnum;
2621 $minutes = sprintf("%d", $minutes);
2622 ("Activated: $num_activated Ported-In: $num_portedin Deactivated: "
2623 . "$num_deactivated Ported-Out: $num_portedout ",
2624 "Total Minutes: $minutes");
2627 sub _items_accountcode_cdr {
2632 my $section = { 'amount' => 0,
2635 'sort_weight' => '',
2637 'description' => 'Usage by Account Code',
2643 my %accountcodes = ();
2645 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2646 next unless $cust_bill_pkg->pkgnum > 0;
2648 my @header = $cust_bill_pkg->details_header;
2649 next unless scalar(@header);
2650 $section->{'header'} = join(',',@header);
2652 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2654 $section->{'header'} = $detail->formatted('format' => $format)
2655 if($detail->detail eq $section->{'header'});
2657 my $accountcode = $detail->accountcode;
2658 next unless $accountcode;
2660 my $amount = $detail->amount;
2661 next unless $amount && $amount > 0;
2663 $accountcodes{$accountcode} ||= {
2664 description => $accountcode,
2671 product_code => 'N/A',
2672 section => $section,
2673 ext_description => [ $section->{'header'} ],
2677 $section->{'amount'} += $amount;
2678 $accountcodes{$accountcode}{'amount'} += $amount;
2679 $accountcodes{$accountcode}{calls}++;
2680 $accountcodes{$accountcode}{duration} += $detail->duration;
2681 push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2685 foreach my $l ( values %accountcodes ) {
2686 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2687 my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2688 foreach my $sorted_detail ( @sorted_detail ) {
2689 push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2691 delete $l->{detail_temp};
2695 my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2697 return ($section,\@sorted_lines);
2700 sub _items_svc_phone_sections {
2702 my $conf = $self->conf;
2710 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2712 my %usage_class = map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2713 $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2715 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2716 next unless $cust_bill_pkg->pkgnum > 0;
2718 my @header = $cust_bill_pkg->details_header;
2719 next unless scalar(@header);
2721 foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2723 my $phonenum = $detail->phonenum;
2724 next unless $phonenum;
2726 my $amount = $detail->amount;
2727 next unless $amount && $amount > 0;
2729 $sections{$phonenum} ||= { 'amount' => 0,
2732 'sort_weight' => -1,
2733 'phonenum' => $phonenum,
2735 $sections{$phonenum}{amount} += $amount; #subtotal
2736 $sections{$phonenum}{calls}++;
2737 $sections{$phonenum}{duration} += $detail->duration;
2739 my $desc = $detail->regionname;
2740 my $description = $desc;
2741 $description = substr($desc, 0, $maxlength). '...'
2742 if $format eq 'latex' && length($desc) > $maxlength;
2744 $lines{$phonenum}{$desc} ||= {
2745 description => &{$escape}($description),
2746 #pkgpart => $part_pkg->pkgpart,
2754 product_code => 'N/A',
2755 ext_description => [],
2758 $lines{$phonenum}{$desc}{amount} += $amount;
2759 $lines{$phonenum}{$desc}{calls}++;
2760 $lines{$phonenum}{$desc}{duration} += $detail->duration;
2762 my $line = $usage_class{$detail->classnum}->classname;
2763 $sections{"$phonenum $line"} ||=
2767 'sort_weight' => $usage_class{$detail->classnum}->weight,
2768 'phonenum' => $phonenum,
2769 'header' => [ @header ],
2771 $sections{"$phonenum $line"}{amount} += $amount; #subtotal
2772 $sections{"$phonenum $line"}{calls}++;
2773 $sections{"$phonenum $line"}{duration} += $detail->duration;
2775 $lines{"$phonenum $line"}{$desc} ||= {
2776 description => &{$escape}($description),
2777 #pkgpart => $part_pkg->pkgpart,
2785 product_code => 'N/A',
2786 ext_description => [],
2789 $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2790 $lines{"$phonenum $line"}{$desc}{calls}++;
2791 $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2792 push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2793 $detail->formatted('format' => $format);
2798 my %sectionmap = ();
2799 my $simple = new FS::usage_class { format => 'simple' }; #bleh
2800 foreach ( keys %sections ) {
2801 my @header = @{ $sections{$_}{header} || [] };
2803 new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2804 my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2805 my $usage_class = $summary ? $simple : $usage_simple;
2806 my $ending = $summary ? ' usage charges' : '';
2809 $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2811 $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2812 'amount' => $sections{$_}{amount}, #subtotal
2813 'calls' => $sections{$_}{calls},
2814 'duration' => $sections{$_}{duration},
2816 'tax_section' => '',
2817 'phonenum' => $sections{$_}{phonenum},
2818 'sort_weight' => $sections{$_}{sort_weight},
2819 'post_total' => $summary, #inspire pagebreak
2821 ( map { $_ => $usage_class->$_($format, %gen_opt) }
2822 qw( description_generator
2825 total_line_generator
2832 my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2833 $a->{sort_weight} <=> $b->{sort_weight}
2838 foreach my $section ( keys %lines ) {
2839 foreach my $line ( keys %{$lines{$section}} ) {
2840 my $l = $lines{$section}{$line};
2841 $l->{section} = $sectionmap{$section};
2842 $l->{amount} = sprintf( "%.2f", $l->{amount} );
2843 #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2848 if($conf->exists('phone_usage_class_summary')) {
2849 # this only works with Latex
2853 # after this, we'll have only two sections per DID:
2854 # Calls Summary and Calls Detail
2855 foreach my $section ( @sections ) {
2856 if($section->{'post_total'}) {
2857 $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2858 $section->{'total_line_generator'} = sub { '' };
2859 $section->{'total_generator'} = sub { '' };
2860 $section->{'header_generator'} = sub { '' };
2861 $section->{'description_generator'} = '';
2862 push @newsections, $section;
2863 my %calls_detail = %$section;
2864 $calls_detail{'post_total'} = '';
2865 $calls_detail{'sort_weight'} = '';
2866 $calls_detail{'description_generator'} = sub { '' };
2867 $calls_detail{'header_generator'} = sub {
2868 return ' & Date/Time & Called Number & Duration & Price'
2869 if $format eq 'latex';
2872 $calls_detail{'description'} = 'Calls Detail: '
2873 . $section->{'phonenum'};
2874 push @newsections, \%calls_detail;
2878 # after this, each usage class is collapsed/summarized into a single
2879 # line under the Calls Summary section
2880 foreach my $newsection ( @newsections ) {
2881 if($newsection->{'post_total'}) { # this means Calls Summary
2882 foreach my $section ( @sections ) {
2883 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2884 && !$section->{'post_total'});
2885 my $newdesc = $section->{'description'};
2886 my $tn = $section->{'phonenum'};
2887 $newdesc =~ s/$tn//g;
2888 my $line = { ext_description => [],
2892 calls => $section->{'calls'},
2893 section => $newsection,
2894 duration => $section->{'duration'},
2895 description => $newdesc,
2896 amount => sprintf("%.2f",$section->{'amount'}),
2897 product_code => 'N/A',
2899 push @newlines, $line;
2904 # after this, Calls Details is populated with all CDRs
2905 foreach my $newsection ( @newsections ) {
2906 if(!$newsection->{'post_total'}) { # this means Calls Details
2907 foreach my $line ( @lines ) {
2908 next unless (scalar(@{$line->{'ext_description'}}) &&
2909 $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2911 my @extdesc = @{$line->{'ext_description'}};
2913 foreach my $extdesc ( @extdesc ) {
2914 $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2915 push @newextdesc, $extdesc;
2917 $line->{'ext_description'} = \@newextdesc;
2918 $line->{'section'} = $newsection;
2919 push @newlines, $line;
2924 return(\@newsections, \@newlines);
2927 return(\@sections, \@lines);
2931 sub _items_previous {
2933 my $conf = $self->conf;
2934 my $cust_main = $self->cust_main;
2935 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2937 foreach ( @pr_cust_bill ) {
2938 my $date = $conf->exists('invoice_show_prior_due_date')
2939 ? 'due '. $_->due_date2str($date_format)
2940 : time2str($date_format, $_->_date);
2942 'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2943 #'pkgpart' => 'N/A',
2945 'amount' => sprintf("%.2f", $_->owed),
2951 # 'description' => 'Previous Balance',
2952 # #'pkgpart' => 'N/A',
2953 # 'pkgnum' => 'N/A',
2954 # 'amount' => sprintf("%10.2f", $pr_total ),
2955 # 'ext_description' => [ map {
2956 # "Invoice ". $_->invnum.
2957 # " (". time2str("%x",$_->_date). ") ".
2958 # sprintf("%10.2f", $_->owed)
2959 # } @pr_cust_bill ],
2964 sub _items_credits {
2965 my( $self, %opt ) = @_;
2966 my $trim_len = $opt{'trim_len'} || 60;
2970 foreach ( $self->cust_credited ) {
2972 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2974 my $reason = substr($_->cust_credit->reason, 0, $trim_len);
2975 $reason .= '...' if length($reason) < length($_->cust_credit->reason);
2976 $reason = " ($reason) " if $reason;
2979 #'description' => 'Credit ref\#'. $_->crednum.
2980 # " (". time2str("%x",$_->cust_credit->_date) .")".
2982 'description' => $self->mt('Credit applied').' '.
2983 time2str($date_format,$_->cust_credit->_date). $reason,
2984 'amount' => sprintf("%.2f",$_->amount),
2992 sub _items_payments {
2996 #get & print payments
2997 foreach ( $self->cust_bill_pay ) {
2999 #something more elaborate if $_->amount ne ->cust_pay->paid ?
3002 'description' => $self->mt('Payment received').' '.
3003 time2str($date_format,$_->cust_pay->_date ),
3004 'amount' => sprintf("%.2f", $_->amount )
3012 =item call_details [ OPTION => VALUE ... ]
3014 Returns an array of CSV strings representing the call details for this invoice
3015 The only option available is the boolean prepend_billed_number
3020 my ($self, %opt) = @_;
3022 my $format_function = sub { shift };
3024 if ($opt{prepend_billed_number}) {
3025 $format_function = sub {
3029 $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3034 my @details = map { $_->details( 'format_function' => $format_function,
3035 'escape_function' => sub{ return() },
3039 $self->cust_bill_pkg;
3040 my $header = $details[0];
3041 ( $header, grep { $_ ne $header } @details );
3051 =item process_reprint
3055 sub process_reprint {
3056 process_re_X('print', @_);
3059 =item process_reemail
3063 sub process_reemail {
3064 process_re_X('email', @_);
3072 process_re_X('fax', @_);
3080 process_re_X('ftp', @_);
3087 sub process_respool {
3088 process_re_X('spool', @_);
3091 use Storable qw(thaw);
3095 my( $method, $job ) = ( shift, shift );
3096 warn "$me process_re_X $method for job $job\n" if $DEBUG;
3098 my $param = thaw(decode_base64(shift));
3099 warn Dumper($param) if $DEBUG;
3110 # spool_invoice ftp_invoice fax_invoice print_invoice
3111 my($method, $job, %param ) = @_;
3113 warn "re_X $method for job $job with param:\n".
3114 join( '', map { " $_ => ". $param{$_}. "\n" } keys %param );
3117 #some false laziness w/search/cust_bill.html
3119 my $orderby = 'ORDER BY cust_bill._date';
3121 my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3123 my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3125 my @cust_bill = qsearch( {
3126 #'select' => "cust_bill.*",
3127 'table' => 'cust_bill',
3128 'addl_from' => $addl_from,
3130 'extra_sql' => $extra_sql,
3131 'order_by' => $orderby,
3135 $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3137 warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3140 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3141 foreach my $cust_bill ( @cust_bill ) {
3142 $cust_bill->$method();
3144 if ( $job ) { #progressbar foo
3146 if ( time - $min_sec > $last ) {
3147 my $error = $job->update_statustext(
3148 int( 100 * $num / scalar(@cust_bill) )
3150 die $error if $error;
3161 =head1 CLASS METHODS
3167 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3172 my ($class, $start, $end) = @_;
3174 $class->paid_sql($start, $end). ' - '.
3175 $class->credited_sql($start, $end);
3180 Returns an SQL fragment to retreive the net amount (charged minus credited).
3185 my ($class, $start, $end) = @_;
3186 'charged - '. $class->credited_sql($start, $end);
3191 Returns an SQL fragment to retreive the amount paid against this invoice.
3196 my ($class, $start, $end) = @_;
3197 $start &&= "AND cust_bill_pay._date <= $start";
3198 $end &&= "AND cust_bill_pay._date > $end";
3199 $start = '' unless defined($start);
3200 $end = '' unless defined($end);
3201 "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3202 WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end )";
3207 Returns an SQL fragment to retreive the amount credited against this invoice.
3212 my ($class, $start, $end) = @_;
3213 $start &&= "AND cust_credit_bill._date <= $start";
3214 $end &&= "AND cust_credit_bill._date > $end";
3215 $start = '' unless defined($start);
3216 $end = '' unless defined($end);
3217 "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3218 WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end )";
3223 Returns an SQL fragment to retrieve the due date of an invoice.
3224 Currently only supported on PostgreSQL.
3229 my $conf = new FS::Conf;
3233 cust_bill.invoice_terms,
3234 cust_main.invoice_terms,
3235 \''.($conf->config('invoice_default_terms') || '').'\'
3236 ), E\'Net (\\\\d+)\'
3238 ) * 86400 + cust_bill._date'
3241 =item search_sql_where HASHREF
3243 Class method which returns an SQL WHERE fragment to search for parameters
3244 specified in HASHREF. Valid parameters are
3250 List reference of start date, end date, as UNIX timestamps.
3260 List reference of charged limits (exclusive).
3264 List reference of charged limits (exclusive).
3268 flag, return open invoices only
3272 flag, return net invoices only
3276 =item newest_percust
3280 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3284 sub search_sql_where {
3285 my($class, $param) = @_;
3287 warn "$me search_sql_where called with params: \n".
3288 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
3294 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3295 push @search, "cust_main.agentnum = $1";
3299 if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3300 push @search, "cust_main.refnum = $1";
3304 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3305 push @search, "cust_bill.custnum = $1";
3309 if ( $param->{_date} ) {
3310 my($beginning, $ending) = @{$param->{_date}};
3312 push @search, "cust_bill._date >= $beginning",
3313 "cust_bill._date < $ending";
3317 if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3318 push @search, "cust_bill.invnum >= $1";
3320 if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3321 push @search, "cust_bill.invnum <= $1";
3325 if ( $param->{charged} ) {
3326 my @charged = ref($param->{charged})
3327 ? @{ $param->{charged} }
3328 : ($param->{charged});
3330 push @search, map { s/^charged/cust_bill.charged/; $_; }
3334 my $owed_sql = FS::cust_bill->owed_sql;
3337 if ( $param->{owed} ) {
3338 my @owed = ref($param->{owed})
3339 ? @{ $param->{owed} }
3341 push @search, map { s/^owed/$owed_sql/; $_; }
3346 push @search, "0 != $owed_sql"
3347 if $param->{'open'};
3348 push @search, '0 != '. FS::cust_bill->net_sql
3352 push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3353 if $param->{'days'};
3356 if ( $param->{'newest_percust'} ) {
3358 #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3359 #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3361 my @newest_where = map { my $x = $_;
3362 $x =~ s/\bcust_bill\./newest_cust_bill./g;
3365 grep ! /^cust_main./, @search;
3366 my $newest_where = scalar(@newest_where)
3367 ? ' AND '. join(' AND ', @newest_where)
3371 push @search, "cust_bill._date = (
3372 SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3373 WHERE newest_cust_bill.custnum = cust_bill.custnum
3379 #promised_date - also has an option to accept nulls
3380 if ( $param->{promised_date} ) {
3381 my($beginning, $ending, $null) = @{$param->{promised_date}};
3383 push @search, "(( cust_bill.promised_date >= $beginning AND ".
3384 "cust_bill.promised_date < $ending )" .
3385 ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3388 #agent virtualization
3389 my $curuser = $FS::CurrentUser::CurrentUser;
3390 if ( $curuser->username eq 'fs_queue'
3391 && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3393 my $newuser = qsearchs('access_user', {
3394 'username' => $username,
3398 $curuser = $newuser;
3400 warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3403 push @search, $curuser->agentnums_sql;
3405 join(' AND ', @search );
3417 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3418 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base