5 use base qw( FS::otaker_Mixin FS::payinfo_Mixin FS::Record );
6 use vars qw( @EXPORT_OK $DEBUG $me $conf
8 $import $ignore_expired_card
9 $skip_fuzzyfiles @fuzzyfields
12 use vars qw( $realtime_bop_decline_quiet ); #ugh
16 use Scalar::Util qw( blessed );
17 use List::Util qw( min );
18 use Time::Local qw(timelocal);
21 use Digest::MD5 qw(md5_base64);
24 use File::Temp qw( tempfile );
25 use String::Approx qw(amatch);
26 use Business::CreditCard 0.28;
28 use FS::UID qw( getotaker dbh driver_name );
29 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
30 use FS::Misc qw( generate_email send_email generate_ps do_print );
31 use FS::Msgcat qw(gettext);
36 use FS::cust_bill_pkg;
37 use FS::cust_bill_pkg_display;
38 use FS::cust_bill_pkg_tax_location;
39 use FS::cust_bill_pkg_tax_rate_location;
41 use FS::cust_pay_pending;
42 use FS::cust_pay_void;
43 use FS::cust_pay_batch;
46 use FS::part_referral;
47 use FS::cust_main_county;
48 use FS::cust_location;
50 use FS::cust_main_exemption;
51 use FS::cust_tax_adjustment;
53 use FS::tax_rate_location;
54 use FS::cust_tax_location;
55 use FS::part_pkg_taxrate;
57 use FS::cust_main_invoice;
58 use FS::cust_credit_bill;
59 use FS::cust_bill_pay;
60 use FS::prepay_credit;
64 use FS::part_event_condition;
67 use FS::payment_gateway;
68 use FS::agent_payment_gateway;
72 @EXPORT_OK = qw( smart_search );
74 $realtime_bop_decline_quiet = 0;
76 # 1 is mostly method/subroutine entry and options
77 # 2 traces progress of some operations
78 # 3 is even more information including possibly sensitive data
80 $me = '[FS::cust_main]';
83 $ignore_expired_card = 0;
86 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
88 @encrypted_fields = ('payinfo', 'paycvv');
89 sub nohistory_fields { ('payinfo', 'paycvv'); }
91 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
93 #ask FS::UID to run this stuff for us later
94 #$FS::UID::callback{'FS::cust_main'} = sub {
95 install_callback FS::UID sub {
97 #yes, need it for stuff below (prolly should be cached)
102 my ( $hashref, $cache ) = @_;
103 if ( exists $hashref->{'pkgnum'} ) {
104 #@{ $self->{'_pkgnum'} } = ();
105 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
106 $self->{'_pkgnum'} = $subcache;
107 #push @{ $self->{'_pkgnum'} },
108 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
114 FS::cust_main - Object methods for cust_main records
120 $record = new FS::cust_main \%hash;
121 $record = new FS::cust_main { 'column' => 'value' };
123 $error = $record->insert;
125 $error = $new_record->replace($old_record);
127 $error = $record->delete;
129 $error = $record->check;
131 @cust_pkg = $record->all_pkgs;
133 @cust_pkg = $record->ncancelled_pkgs;
135 @cust_pkg = $record->suspended_pkgs;
137 $error = $record->bill;
138 $error = $record->bill %options;
139 $error = $record->bill 'time' => $time;
141 $error = $record->collect;
142 $error = $record->collect %options;
143 $error = $record->collect 'invoice_time' => $time,
148 An FS::cust_main object represents a customer. FS::cust_main inherits from
149 FS::Record. The following fields are currently supported:
155 Primary key (assigned automatically for new customers)
159 Agent (see L<FS::agent>)
163 Advertising source (see L<FS::part_referral>)
175 Cocial security number (optional)
191 (optional, see L<FS::cust_main_county>)
195 (see L<FS::cust_main_county>)
201 (see L<FS::cust_main_county>)
237 (optional, see L<FS::cust_main_county>)
241 (see L<FS::cust_main_county>)
247 (see L<FS::cust_main_county>)
263 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
267 Payment Information (See L<FS::payinfo_Mixin> for data format)
271 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
275 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
279 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
283 Start date month (maestro/solo cards only)
287 Start date year (maestro/solo cards only)
291 Issue number (maestro/solo cards only)
295 Name on card or billing name
299 IP address from which payment information was received
303 Tax exempt, empty or `Y'
307 Order taker (see L<FS::access_user>)
313 =item referral_custnum
315 Referring customer number
319 Enable individual CDR spooling, empty or `Y'
323 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
327 Discourage individual CDR printing, empty or `Y'
337 Creates a new customer. To add the customer to the database, see L<"insert">.
339 Note that this stores the hash reference, not a distinct copy of the hash it
340 points to. You can ask the object for a copy with the I<hash> method.
344 sub table { 'cust_main'; }
346 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
348 Adds this customer to the database. If there is an error, returns the error,
349 otherwise returns false.
351 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
352 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
353 are inserted atomicly, or the transaction is rolled back. Passing an empty
354 hash reference is equivalent to not supplying this parameter. There should be
355 a better explanation of this, but until then, here's an example:
358 tie %hash, 'Tie::RefHash'; #this part is important
360 $cust_pkg => [ $svc_acct ],
363 $cust_main->insert( \%hash );
365 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
366 be set as the invoicing list (see L<"invoicing_list">). Errors return as
367 expected and rollback the entire transaction; it is not necessary to call
368 check_invoicing_list first. The invoicing_list is set after the records in the
369 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
370 invoicing_list destination to the newly-created svc_acct. Here's an example:
372 $cust_main->insert( {}, [ $email, 'POST' ] );
374 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
376 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
377 on the supplied jobnum (they will not run until the specific job completes).
378 This can be used to defer provisioning until some action completes (such
379 as running the customer's credit card successfully).
381 The I<noexport> option is deprecated. If I<noexport> is set true, no
382 provisioning jobs (exports) are scheduled. (You can schedule them later with
383 the B<reexport> method.)
385 The I<tax_exemption> option can be set to an arrayref of tax names.
386 FS::cust_main_exemption records will be created and inserted.
392 my $cust_pkgs = @_ ? shift : {};
393 my $invoicing_list = @_ ? shift : '';
395 warn "$me insert called with options ".
396 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
399 local $SIG{HUP} = 'IGNORE';
400 local $SIG{INT} = 'IGNORE';
401 local $SIG{QUIT} = 'IGNORE';
402 local $SIG{TERM} = 'IGNORE';
403 local $SIG{TSTP} = 'IGNORE';
404 local $SIG{PIPE} = 'IGNORE';
406 my $oldAutoCommit = $FS::UID::AutoCommit;
407 local $FS::UID::AutoCommit = 0;
410 my $prepay_identifier = '';
411 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
413 if ( $self->payby eq 'PREPAY' ) {
415 $self->payby('BILL');
416 $prepay_identifier = $self->payinfo;
419 warn " looking up prepaid card $prepay_identifier\n"
422 my $error = $self->get_prepay( $prepay_identifier,
423 'amount_ref' => \$amount,
424 'seconds_ref' => \$seconds,
425 'upbytes_ref' => \$upbytes,
426 'downbytes_ref' => \$downbytes,
427 'totalbytes_ref' => \$totalbytes,
430 $dbh->rollback if $oldAutoCommit;
431 #return "error applying prepaid card (transaction rolled back): $error";
435 $payby = 'PREP' if $amount;
437 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
440 $self->payby('BILL');
441 $amount = $self->paid;
445 warn " inserting $self\n"
448 $self->signupdate(time) unless $self->signupdate;
450 $self->auto_agent_custid()
451 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
453 my $error = $self->SUPER::insert;
455 $dbh->rollback if $oldAutoCommit;
456 #return "inserting cust_main record (transaction rolled back): $error";
460 warn " setting invoicing list\n"
463 if ( $invoicing_list ) {
464 $error = $self->check_invoicing_list( $invoicing_list );
466 $dbh->rollback if $oldAutoCommit;
467 #return "checking invoicing_list (transaction rolled back): $error";
470 $self->invoicing_list( $invoicing_list );
473 warn " setting cust_main_exemption\n"
476 my $tax_exemption = delete $options{'tax_exemption'};
477 if ( $tax_exemption ) {
478 foreach my $taxname ( @$tax_exemption ) {
479 my $cust_main_exemption = new FS::cust_main_exemption {
480 'custnum' => $self->custnum,
481 'taxname' => $taxname,
483 my $error = $cust_main_exemption->insert;
485 $dbh->rollback if $oldAutoCommit;
486 return "inserting cust_main_exemption (transaction rolled back): $error";
491 if ( $conf->config('cust_main-skeleton_tables')
492 && $conf->config('cust_main-skeleton_custnum') ) {
494 warn " inserting skeleton records\n"
497 my $error = $self->start_copy_skel;
499 $dbh->rollback if $oldAutoCommit;
505 warn " ordering packages\n"
508 $error = $self->order_pkgs( $cust_pkgs,
510 'seconds_ref' => \$seconds,
511 'upbytes_ref' => \$upbytes,
512 'downbytes_ref' => \$downbytes,
513 'totalbytes_ref' => \$totalbytes,
516 $dbh->rollback if $oldAutoCommit;
521 $dbh->rollback if $oldAutoCommit;
522 return "No svc_acct record to apply pre-paid time";
524 if ( $upbytes || $downbytes || $totalbytes ) {
525 $dbh->rollback if $oldAutoCommit;
526 return "No svc_acct record to apply pre-paid data";
530 warn " inserting initial $payby payment of $amount\n"
532 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
534 $dbh->rollback if $oldAutoCommit;
535 return "inserting payment (transaction rolled back): $error";
539 unless ( $import || $skip_fuzzyfiles ) {
540 warn " queueing fuzzyfiles update\n"
542 $error = $self->queue_fuzzyfiles_update;
544 $dbh->rollback if $oldAutoCommit;
545 return "updating fuzzy search cache: $error";
549 warn " insert complete; committing transaction\n"
552 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
557 use File::CounterFile;
558 sub auto_agent_custid {
561 my $format = $conf->config('cust_main-auto_agent_custid');
563 if ( $format eq '1YMMXXXXXXXX' ) {
565 my $counter = new File::CounterFile 'cust_main.agent_custid';
568 my $ym = 100000000000 + time2str('%y%m00000000', time);
569 if ( $ym > $counter->value ) {
570 $counter->{'value'} = $agent_custid = $ym;
571 $counter->{'updated'} = 1;
573 $agent_custid = $counter->inc;
579 die "Unknown cust_main-auto_agent_custid format: $format";
582 $self->agent_custid($agent_custid);
586 sub start_copy_skel {
589 #'mg_user_preference' => {},
590 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
591 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
592 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
593 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
594 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
597 _copy_skel( 'cust_main', #tablename
598 $conf->config('cust_main-skeleton_custnum'), #sourceid
599 $self->custnum, #destid
600 @tables, #child tables
604 #recursive subroutine, not a method
606 my( $table, $sourceid, $destid, %child_tables ) = @_;
609 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
610 ( $table, $primary_key ) = ( $1, $2 );
612 my $dbdef_table = dbdef->table($table);
613 $primary_key = $dbdef_table->primary_key
614 or return "$table has no primary key".
615 " (or do you need to run dbdef-create?)";
618 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
619 join (', ', keys %child_tables). "\n"
622 foreach my $child_table_def ( keys %child_tables ) {
626 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
627 ( $child_table, $child_pkey ) = ( $1, $2 );
629 $child_table = $child_table_def;
631 $child_pkey = dbdef->table($child_table)->primary_key;
632 # or return "$table has no primary key".
633 # " (or do you need to run dbdef-create?)\n";
637 if ( keys %{ $child_tables{$child_table_def} } ) {
639 return "$child_table has no primary key".
640 " (run dbdef-create or try specifying it?)\n"
643 #false laziness w/Record::insert and only works on Pg
644 #refactor the proper last-inserted-id stuff out of Record::insert if this
645 # ever gets use for anything besides a quick kludge for one customer
646 my $default = dbdef->table($child_table)->column($child_pkey)->default;
647 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
648 or return "can't parse $child_table.$child_pkey default value ".
649 " for sequence name: $default";
654 my @sel_columns = grep { $_ ne $primary_key }
655 dbdef->table($child_table)->columns;
656 my $sel_columns = join(', ', @sel_columns );
658 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
659 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
660 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
662 my $sel_st = "SELECT $sel_columns FROM $child_table".
663 " WHERE $primary_key = $sourceid";
666 my $sel_sth = dbh->prepare( $sel_st )
667 or return dbh->errstr;
669 $sel_sth->execute or return $sel_sth->errstr;
671 while ( my $row = $sel_sth->fetchrow_hashref ) {
673 warn " selected row: ".
674 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
678 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
679 my $ins_sth =dbh->prepare($statement)
680 or return dbh->errstr;
681 my @param = ( $destid, map $row->{$_}, @ins_columns );
682 warn " $statement: [ ". join(', ', @param). " ]\n"
684 $ins_sth->execute( @param )
685 or return $ins_sth->errstr;
687 #next unless keys %{ $child_tables{$child_table} };
688 next unless $sequence;
690 #another section of that laziness
691 my $seq_sql = "SELECT currval('$sequence')";
692 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
693 $seq_sth->execute or return $seq_sth->errstr;
694 my $insertid = $seq_sth->fetchrow_arrayref->[0];
696 # don't drink soap! recurse! recurse! okay!
698 _copy_skel( $child_table_def,
699 $row->{$child_pkey}, #sourceid
701 %{ $child_tables{$child_table_def} },
703 return $error if $error;
713 =item order_pkg HASHREF | OPTION => VALUE ...
715 Orders a single package.
717 Options may be passed as a list of key/value pairs or as a hash reference.
728 Optional FS::cust_location object
732 Optional arryaref of FS::svc_* service objects.
736 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
737 jobs will have a dependancy on the supplied job (they will not run until the
738 specific job completes). This can be used to defer provisioning until some
739 action completes (such as running the customer's credit card successfully).
743 Optional subject for a ticket created and attached to this customer
747 Optional queue name for ticket additions
755 my $opt = ref($_[0]) ? shift : { @_ };
757 warn "$me order_pkg called with options ".
758 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
761 my $cust_pkg = $opt->{'cust_pkg'};
762 my $svcs = $opt->{'svcs'} || [];
764 my %svc_options = ();
765 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
766 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
768 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
769 qw( ticket_subject ticket_queue );
771 local $SIG{HUP} = 'IGNORE';
772 local $SIG{INT} = 'IGNORE';
773 local $SIG{QUIT} = 'IGNORE';
774 local $SIG{TERM} = 'IGNORE';
775 local $SIG{TSTP} = 'IGNORE';
776 local $SIG{PIPE} = 'IGNORE';
778 my $oldAutoCommit = $FS::UID::AutoCommit;
779 local $FS::UID::AutoCommit = 0;
782 if ( $opt->{'cust_location'} &&
783 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
784 my $error = $opt->{'cust_location'}->insert;
786 $dbh->rollback if $oldAutoCommit;
787 return "inserting cust_location (transaction rolled back): $error";
789 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
792 $cust_pkg->custnum( $self->custnum );
794 my $error = $cust_pkg->insert( %insert_params );
796 $dbh->rollback if $oldAutoCommit;
797 return "inserting cust_pkg (transaction rolled back): $error";
800 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
801 if ( $svc_something->svcnum ) {
802 my $old_cust_svc = $svc_something->cust_svc;
803 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
804 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
805 $error = $new_cust_svc->replace($old_cust_svc);
807 $svc_something->pkgnum( $cust_pkg->pkgnum );
808 if ( $svc_something->isa('FS::svc_acct') ) {
809 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
810 qw( seconds upbytes downbytes totalbytes ) ) {
811 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
812 ${ $opt->{$_.'_ref'} } = 0;
815 $error = $svc_something->insert(%svc_options);
818 $dbh->rollback if $oldAutoCommit;
819 return "inserting svc_ (transaction rolled back): $error";
823 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
828 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
829 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
831 Like the insert method on an existing record, this method orders multiple
832 packages and included services atomicaly. Pass a Tie::RefHash data structure
833 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
834 There should be a better explanation of this, but until then, here's an
838 tie %hash, 'Tie::RefHash'; #this part is important
840 $cust_pkg => [ $svc_acct ],
843 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
845 Services can be new, in which case they are inserted, or existing unaudited
846 services, in which case they are linked to the newly-created package.
848 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
849 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
851 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
852 on the supplied jobnum (they will not run until the specific job completes).
853 This can be used to defer provisioning until some action completes (such
854 as running the customer's credit card successfully).
856 The I<noexport> option is deprecated. If I<noexport> is set true, no
857 provisioning jobs (exports) are scheduled. (You can schedule them later with
858 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
859 on the cust_main object is not recommended, as existing services will also be
862 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
863 provided, the scalars (provided by references) will be incremented by the
864 values of the prepaid card.`
870 my $cust_pkgs = shift;
871 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
873 $seconds_ref ||= $options{'seconds_ref'};
875 warn "$me order_pkgs called with options ".
876 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
879 local $SIG{HUP} = 'IGNORE';
880 local $SIG{INT} = 'IGNORE';
881 local $SIG{QUIT} = 'IGNORE';
882 local $SIG{TERM} = 'IGNORE';
883 local $SIG{TSTP} = 'IGNORE';
884 local $SIG{PIPE} = 'IGNORE';
886 my $oldAutoCommit = $FS::UID::AutoCommit;
887 local $FS::UID::AutoCommit = 0;
890 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
892 foreach my $cust_pkg ( keys %$cust_pkgs ) {
894 my $error = $self->order_pkg(
895 'cust_pkg' => $cust_pkg,
896 'svcs' => $cust_pkgs->{$cust_pkg},
897 'seconds_ref' => $seconds_ref,
898 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
903 $dbh->rollback if $oldAutoCommit;
909 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
913 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
915 Recharges this (existing) customer with the specified prepaid card (see
916 L<FS::prepay_credit>), specified either by I<identifier> or as an
917 FS::prepay_credit object. If there is an error, returns the error, otherwise
920 Optionally, five scalar references can be passed as well. They will have their
921 values filled in with the amount, number of seconds, and number of upload,
922 download, and total bytes applied by this prepaid card.
926 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
927 #the only place that uses these args
928 sub recharge_prepay {
929 my( $self, $prepay_credit, $amountref, $secondsref,
930 $upbytesref, $downbytesref, $totalbytesref ) = @_;
932 local $SIG{HUP} = 'IGNORE';
933 local $SIG{INT} = 'IGNORE';
934 local $SIG{QUIT} = 'IGNORE';
935 local $SIG{TERM} = 'IGNORE';
936 local $SIG{TSTP} = 'IGNORE';
937 local $SIG{PIPE} = 'IGNORE';
939 my $oldAutoCommit = $FS::UID::AutoCommit;
940 local $FS::UID::AutoCommit = 0;
943 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
945 my $error = $self->get_prepay( $prepay_credit,
946 'amount_ref' => \$amount,
947 'seconds_ref' => \$seconds,
948 'upbytes_ref' => \$upbytes,
949 'downbytes_ref' => \$downbytes,
950 'totalbytes_ref' => \$totalbytes,
952 || $self->increment_seconds($seconds)
953 || $self->increment_upbytes($upbytes)
954 || $self->increment_downbytes($downbytes)
955 || $self->increment_totalbytes($totalbytes)
956 || $self->insert_cust_pay_prepay( $amount,
958 ? $prepay_credit->identifier
963 $dbh->rollback if $oldAutoCommit;
967 if ( defined($amountref) ) { $$amountref = $amount; }
968 if ( defined($secondsref) ) { $$secondsref = $seconds; }
969 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
970 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
971 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
973 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
978 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
980 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
981 specified either by I<identifier> or as an FS::prepay_credit object.
983 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
984 incremented by the values of the prepaid card.
986 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
987 check or set this customer's I<agentnum>.
989 If there is an error, returns the error, otherwise returns false.
995 my( $self, $prepay_credit, %opt ) = @_;
997 local $SIG{HUP} = 'IGNORE';
998 local $SIG{INT} = 'IGNORE';
999 local $SIG{QUIT} = 'IGNORE';
1000 local $SIG{TERM} = 'IGNORE';
1001 local $SIG{TSTP} = 'IGNORE';
1002 local $SIG{PIPE} = 'IGNORE';
1004 my $oldAutoCommit = $FS::UID::AutoCommit;
1005 local $FS::UID::AutoCommit = 0;
1008 unless ( ref($prepay_credit) ) {
1010 my $identifier = $prepay_credit;
1012 $prepay_credit = qsearchs(
1014 { 'identifier' => $prepay_credit },
1019 unless ( $prepay_credit ) {
1020 $dbh->rollback if $oldAutoCommit;
1021 return "Invalid prepaid card: ". $identifier;
1026 if ( $prepay_credit->agentnum ) {
1027 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1028 $dbh->rollback if $oldAutoCommit;
1029 return "prepaid card not valid for agent ". $self->agentnum;
1031 $self->agentnum($prepay_credit->agentnum);
1034 my $error = $prepay_credit->delete;
1036 $dbh->rollback if $oldAutoCommit;
1037 return "removing prepay_credit (transaction rolled back): $error";
1040 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1041 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1043 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1048 =item increment_upbytes SECONDS
1050 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1051 the specified number of upbytes. If there is an error, returns the error,
1052 otherwise returns false.
1056 sub increment_upbytes {
1057 _increment_column( shift, 'upbytes', @_);
1060 =item increment_downbytes SECONDS
1062 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1063 the specified number of downbytes. If there is an error, returns the error,
1064 otherwise returns false.
1068 sub increment_downbytes {
1069 _increment_column( shift, 'downbytes', @_);
1072 =item increment_totalbytes SECONDS
1074 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1075 the specified number of totalbytes. If there is an error, returns the error,
1076 otherwise returns false.
1080 sub increment_totalbytes {
1081 _increment_column( shift, 'totalbytes', @_);
1084 =item increment_seconds SECONDS
1086 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1087 the specified number of seconds. If there is an error, returns the error,
1088 otherwise returns false.
1092 sub increment_seconds {
1093 _increment_column( shift, 'seconds', @_);
1096 =item _increment_column AMOUNT
1098 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1099 the specified number of seconds or bytes. If there is an error, returns
1100 the error, otherwise returns false.
1104 sub _increment_column {
1105 my( $self, $column, $amount ) = @_;
1106 warn "$me increment_column called: $column, $amount\n"
1109 return '' unless $amount;
1111 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1112 $self->ncancelled_pkgs;
1114 if ( ! @cust_pkg ) {
1115 return 'No packages with primary or single services found'.
1116 ' to apply pre-paid time';
1117 } elsif ( scalar(@cust_pkg) > 1 ) {
1118 #maybe have a way to specify the package/account?
1119 return 'Multiple packages found to apply pre-paid time';
1122 my $cust_pkg = $cust_pkg[0];
1123 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1127 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1129 if ( ! @cust_svc ) {
1130 return 'No account found to apply pre-paid time';
1131 } elsif ( scalar(@cust_svc) > 1 ) {
1132 return 'Multiple accounts found to apply pre-paid time';
1135 my $svc_acct = $cust_svc[0]->svc_x;
1136 warn " found service svcnum ". $svc_acct->pkgnum.
1137 ' ('. $svc_acct->email. ")\n"
1140 $column = "increment_$column";
1141 $svc_acct->$column($amount);
1145 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1147 Inserts a prepayment in the specified amount for this customer. An optional
1148 second argument can specify the prepayment identifier for tracking purposes.
1149 If there is an error, returns the error, otherwise returns false.
1153 sub insert_cust_pay_prepay {
1154 shift->insert_cust_pay('PREP', @_);
1157 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1159 Inserts a cash payment in the specified amount for this customer. An optional
1160 second argument can specify the payment identifier for tracking purposes.
1161 If there is an error, returns the error, otherwise returns false.
1165 sub insert_cust_pay_cash {
1166 shift->insert_cust_pay('CASH', @_);
1169 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1171 Inserts a Western Union payment in the specified amount for this customer. An
1172 optional second argument can specify the prepayment identifier for tracking
1173 purposes. If there is an error, returns the error, otherwise returns false.
1177 sub insert_cust_pay_west {
1178 shift->insert_cust_pay('WEST', @_);
1181 sub insert_cust_pay {
1182 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1183 my $payinfo = scalar(@_) ? shift : '';
1185 my $cust_pay = new FS::cust_pay {
1186 'custnum' => $self->custnum,
1187 'paid' => sprintf('%.2f', $amount),
1188 #'_date' => #date the prepaid card was purchased???
1190 'payinfo' => $payinfo,
1198 This method is deprecated. See the I<depend_jobnum> option to the insert and
1199 order_pkgs methods for a better way to defer provisioning.
1201 Re-schedules all exports by calling the B<reexport> method of all associated
1202 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1203 otherwise returns false.
1210 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1211 "use the depend_jobnum option to insert or order_pkgs to delay export";
1213 local $SIG{HUP} = 'IGNORE';
1214 local $SIG{INT} = 'IGNORE';
1215 local $SIG{QUIT} = 'IGNORE';
1216 local $SIG{TERM} = 'IGNORE';
1217 local $SIG{TSTP} = 'IGNORE';
1218 local $SIG{PIPE} = 'IGNORE';
1220 my $oldAutoCommit = $FS::UID::AutoCommit;
1221 local $FS::UID::AutoCommit = 0;
1224 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1225 my $error = $cust_pkg->reexport;
1227 $dbh->rollback if $oldAutoCommit;
1232 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1237 =item delete NEW_CUSTNUM
1239 This deletes the customer. If there is an error, returns the error, otherwise
1242 This will completely remove all traces of the customer record. This is not
1243 what you want when a customer cancels service; for that, cancel all of the
1244 customer's packages (see L</cancel>).
1246 If the customer has any uncancelled packages, you need to pass a new (valid)
1247 customer number for those packages to be transferred to. Cancelled packages
1248 will be deleted. Did I mention that this is NOT what you want when a customer
1249 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1251 You can't delete a customer with invoices (see L<FS::cust_bill>),
1252 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1253 refunds (see L<FS::cust_refund>).
1260 local $SIG{HUP} = 'IGNORE';
1261 local $SIG{INT} = 'IGNORE';
1262 local $SIG{QUIT} = 'IGNORE';
1263 local $SIG{TERM} = 'IGNORE';
1264 local $SIG{TSTP} = 'IGNORE';
1265 local $SIG{PIPE} = 'IGNORE';
1267 my $oldAutoCommit = $FS::UID::AutoCommit;
1268 local $FS::UID::AutoCommit = 0;
1271 if ( $self->cust_bill ) {
1272 $dbh->rollback if $oldAutoCommit;
1273 return "Can't delete a customer with invoices";
1275 if ( $self->cust_credit ) {
1276 $dbh->rollback if $oldAutoCommit;
1277 return "Can't delete a customer with credits";
1279 if ( $self->cust_pay ) {
1280 $dbh->rollback if $oldAutoCommit;
1281 return "Can't delete a customer with payments";
1283 if ( $self->cust_refund ) {
1284 $dbh->rollback if $oldAutoCommit;
1285 return "Can't delete a customer with refunds";
1288 my @cust_pkg = $self->ncancelled_pkgs;
1290 my $new_custnum = shift;
1291 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1292 $dbh->rollback if $oldAutoCommit;
1293 return "Invalid new customer number: $new_custnum";
1295 foreach my $cust_pkg ( @cust_pkg ) {
1296 my %hash = $cust_pkg->hash;
1297 $hash{'custnum'} = $new_custnum;
1298 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1299 my $error = $new_cust_pkg->replace($cust_pkg,
1300 options => { $cust_pkg->options },
1303 $dbh->rollback if $oldAutoCommit;
1308 my @cancelled_cust_pkg = $self->all_pkgs;
1309 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1310 my $error = $cust_pkg->delete;
1312 $dbh->rollback if $oldAutoCommit;
1317 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1318 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1320 my $error = $cust_main_invoice->delete;
1322 $dbh->rollback if $oldAutoCommit;
1327 foreach my $cust_main_exemption (
1328 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1330 my $error = $cust_main_exemption->delete;
1332 $dbh->rollback if $oldAutoCommit;
1337 my $error = $self->SUPER::delete;
1339 $dbh->rollback if $oldAutoCommit;
1343 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1348 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1351 Replaces the OLD_RECORD with this one in the database. If there is an error,
1352 returns the error, otherwise returns false.
1354 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1355 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1356 expected and rollback the entire transaction; it is not necessary to call
1357 check_invoicing_list first. Here's an example:
1359 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1361 Currently available options are: I<tax_exemption>.
1363 The I<tax_exemption> option can be set to an arrayref of tax names.
1364 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1371 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1373 : $self->replace_old;
1377 warn "$me replace called\n"
1380 my $curuser = $FS::CurrentUser::CurrentUser;
1381 if ( $self->payby eq 'COMP'
1382 && $self->payby ne $old->payby
1383 && ! $curuser->access_right('Complimentary customer')
1386 return "You are not permitted to create complimentary accounts.";
1389 local($ignore_expired_card) = 1
1390 if $old->payby =~ /^(CARD|DCRD)$/
1391 && $self->payby =~ /^(CARD|DCRD)$/
1392 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1394 local $SIG{HUP} = 'IGNORE';
1395 local $SIG{INT} = 'IGNORE';
1396 local $SIG{QUIT} = 'IGNORE';
1397 local $SIG{TERM} = 'IGNORE';
1398 local $SIG{TSTP} = 'IGNORE';
1399 local $SIG{PIPE} = 'IGNORE';
1401 my $oldAutoCommit = $FS::UID::AutoCommit;
1402 local $FS::UID::AutoCommit = 0;
1405 my $error = $self->SUPER::replace($old);
1408 $dbh->rollback if $oldAutoCommit;
1412 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1413 my $invoicing_list = shift @param;
1414 $error = $self->check_invoicing_list( $invoicing_list );
1416 $dbh->rollback if $oldAutoCommit;
1419 $self->invoicing_list( $invoicing_list );
1422 my %options = @param;
1424 my $tax_exemption = delete $options{'tax_exemption'};
1425 if ( $tax_exemption ) {
1427 my %cust_main_exemption =
1428 map { $_->taxname => $_ }
1429 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1431 foreach my $taxname ( @$tax_exemption ) {
1433 next if delete $cust_main_exemption{$taxname};
1435 my $cust_main_exemption = new FS::cust_main_exemption {
1436 'custnum' => $self->custnum,
1437 'taxname' => $taxname,
1439 my $error = $cust_main_exemption->insert;
1441 $dbh->rollback if $oldAutoCommit;
1442 return "inserting cust_main_exemption (transaction rolled back): $error";
1446 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1447 my $error = $cust_main_exemption->delete;
1449 $dbh->rollback if $oldAutoCommit;
1450 return "deleting cust_main_exemption (transaction rolled back): $error";
1456 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1457 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1458 && $self->get('payinfo') !~ /^99\d{14}$/
1460 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1465 # card/check/lec info has changed, want to retry realtime_ invoice events
1466 my $error = $self->retry_realtime;
1468 $dbh->rollback if $oldAutoCommit;
1473 unless ( $import || $skip_fuzzyfiles ) {
1474 $error = $self->queue_fuzzyfiles_update;
1476 $dbh->rollback if $oldAutoCommit;
1477 return "updating fuzzy search cache: $error";
1481 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1486 =item queue_fuzzyfiles_update
1488 Used by insert & replace to update the fuzzy search cache
1492 sub queue_fuzzyfiles_update {
1495 local $SIG{HUP} = 'IGNORE';
1496 local $SIG{INT} = 'IGNORE';
1497 local $SIG{QUIT} = 'IGNORE';
1498 local $SIG{TERM} = 'IGNORE';
1499 local $SIG{TSTP} = 'IGNORE';
1500 local $SIG{PIPE} = 'IGNORE';
1502 my $oldAutoCommit = $FS::UID::AutoCommit;
1503 local $FS::UID::AutoCommit = 0;
1506 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1507 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1509 $dbh->rollback if $oldAutoCommit;
1510 return "queueing job (transaction rolled back): $error";
1513 if ( $self->ship_last ) {
1514 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1515 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1517 $dbh->rollback if $oldAutoCommit;
1518 return "queueing job (transaction rolled back): $error";
1522 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1529 Checks all fields to make sure this is a valid customer record. If there is
1530 an error, returns the error, otherwise returns false. Called by the insert
1531 and replace methods.
1538 warn "$me check BEFORE: \n". $self->_dump
1542 $self->ut_numbern('custnum')
1543 || $self->ut_number('agentnum')
1544 || $self->ut_textn('agent_custid')
1545 || $self->ut_number('refnum')
1546 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1547 || $self->ut_textn('custbatch')
1548 || $self->ut_name('last')
1549 || $self->ut_name('first')
1550 || $self->ut_snumbern('birthdate')
1551 || $self->ut_snumbern('signupdate')
1552 || $self->ut_textn('company')
1553 || $self->ut_text('address1')
1554 || $self->ut_textn('address2')
1555 || $self->ut_text('city')
1556 || $self->ut_textn('county')
1557 || $self->ut_textn('state')
1558 || $self->ut_country('country')
1559 || $self->ut_anything('comments')
1560 || $self->ut_numbern('referral_custnum')
1561 || $self->ut_textn('stateid')
1562 || $self->ut_textn('stateid_state')
1563 || $self->ut_textn('invoice_terms')
1564 || $self->ut_alphan('geocode')
1565 || $self->ut_floatn('cdr_termination_percentage')
1568 #barf. need message catalogs. i18n. etc.
1569 $error .= "Please select an advertising source."
1570 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1571 return $error if $error;
1573 return "Unknown agent"
1574 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1576 return "Unknown refnum"
1577 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1579 return "Unknown referring custnum: ". $self->referral_custnum
1580 unless ! $self->referral_custnum
1581 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1583 if ( $self->censustract ne '' ) {
1584 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1585 or return "Illegal census tract: ". $self->censustract;
1587 $self->censustract("$1.$2");
1590 if ( $self->ss eq '' ) {
1595 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1596 or return "Illegal social security number: ". $self->ss;
1597 $self->ss("$1-$2-$3");
1601 # bad idea to disable, causes billing to fail because of no tax rates later
1602 # unless ( $import ) {
1603 unless ( qsearch('cust_main_county', {
1604 'country' => $self->country,
1607 return "Unknown state/county/country: ".
1608 $self->state. "/". $self->county. "/". $self->country
1609 unless qsearch('cust_main_county',{
1610 'state' => $self->state,
1611 'county' => $self->county,
1612 'country' => $self->country,
1618 $self->ut_phonen('daytime', $self->country)
1619 || $self->ut_phonen('night', $self->country)
1620 || $self->ut_phonen('fax', $self->country)
1621 || $self->ut_zip('zip', $self->country)
1623 return $error if $error;
1625 if ( $conf->exists('cust_main-require_phone')
1626 && ! length($self->daytime) && ! length($self->night)
1629 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1631 : FS::Msgcat::_gettext('daytime');
1632 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1634 : FS::Msgcat::_gettext('night');
1636 return "$daytime_label or $night_label is required"
1640 if ( $self->has_ship_address
1641 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1642 $self->addr_fields )
1646 $self->ut_name('ship_last')
1647 || $self->ut_name('ship_first')
1648 || $self->ut_textn('ship_company')
1649 || $self->ut_text('ship_address1')
1650 || $self->ut_textn('ship_address2')
1651 || $self->ut_text('ship_city')
1652 || $self->ut_textn('ship_county')
1653 || $self->ut_textn('ship_state')
1654 || $self->ut_country('ship_country')
1656 return $error if $error;
1658 #false laziness with above
1659 unless ( qsearchs('cust_main_county', {
1660 'country' => $self->ship_country,
1663 return "Unknown ship_state/ship_county/ship_country: ".
1664 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1665 unless qsearch('cust_main_county',{
1666 'state' => $self->ship_state,
1667 'county' => $self->ship_county,
1668 'country' => $self->ship_country,
1674 $self->ut_phonen('ship_daytime', $self->ship_country)
1675 || $self->ut_phonen('ship_night', $self->ship_country)
1676 || $self->ut_phonen('ship_fax', $self->ship_country)
1677 || $self->ut_zip('ship_zip', $self->ship_country)
1679 return $error if $error;
1681 return "Unit # is required."
1682 if $self->ship_address2 =~ /^\s*$/
1683 && $conf->exists('cust_main-require_address2');
1685 } else { # ship_ info eq billing info, so don't store dup info in database
1687 $self->setfield("ship_$_", '')
1688 foreach $self->addr_fields;
1690 return "Unit # is required."
1691 if $self->address2 =~ /^\s*$/
1692 && $conf->exists('cust_main-require_address2');
1696 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1697 # or return "Illegal payby: ". $self->payby;
1699 FS::payby->can_payby($self->table, $self->payby)
1700 or return "Illegal payby: ". $self->payby;
1702 $error = $self->ut_numbern('paystart_month')
1703 || $self->ut_numbern('paystart_year')
1704 || $self->ut_numbern('payissue')
1705 || $self->ut_textn('paytype')
1707 return $error if $error;
1709 if ( $self->payip eq '' ) {
1712 $error = $self->ut_ip('payip');
1713 return $error if $error;
1716 # If it is encrypted and the private key is not availaible then we can't
1717 # check the credit card.
1719 my $check_payinfo = 1;
1721 if ($self->is_encrypted($self->payinfo)) {
1725 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1727 my $payinfo = $self->payinfo;
1728 $payinfo =~ s/\D//g;
1729 $payinfo =~ /^(\d{13,16})$/
1730 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1732 $self->payinfo($payinfo);
1734 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1736 return gettext('unknown_card_type')
1737 if $self->payinfo !~ /^99\d{14}$/ #token
1738 && cardtype($self->payinfo) eq "Unknown";
1740 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1742 return 'Banned credit card: banned on '.
1743 time2str('%a %h %o at %r', $ban->_date).
1744 ' by '. $ban->otaker.
1745 ' (ban# '. $ban->bannum. ')';
1748 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1749 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1750 $self->paycvv =~ /^(\d{4})$/
1751 or return "CVV2 (CID) for American Express cards is four digits.";
1754 $self->paycvv =~ /^(\d{3})$/
1755 or return "CVV2 (CVC2/CID) is three digits.";
1762 my $cardtype = cardtype($payinfo);
1763 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1765 return "Start date or issue number is required for $cardtype cards"
1766 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1768 return "Start month must be between 1 and 12"
1769 if $self->paystart_month
1770 and $self->paystart_month < 1 || $self->paystart_month > 12;
1772 return "Start year must be 1990 or later"
1773 if $self->paystart_year
1774 and $self->paystart_year < 1990;
1776 return "Issue number must be beween 1 and 99"
1778 and $self->payissue < 1 || $self->payissue > 99;
1781 $self->paystart_month('');
1782 $self->paystart_year('');
1783 $self->payissue('');
1786 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1788 my $payinfo = $self->payinfo;
1789 $payinfo =~ s/[^\d\@]//g;
1790 if ( $conf->exists('echeck-nonus') ) {
1791 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1792 $payinfo = "$1\@$2";
1794 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1795 $payinfo = "$1\@$2";
1797 $self->payinfo($payinfo);
1800 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1802 return 'Banned ACH account: banned on '.
1803 time2str('%a %h %o at %r', $ban->_date).
1804 ' by '. $ban->otaker.
1805 ' (ban# '. $ban->bannum. ')';
1808 } elsif ( $self->payby eq 'LECB' ) {
1810 my $payinfo = $self->payinfo;
1811 $payinfo =~ s/\D//g;
1812 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1814 $self->payinfo($payinfo);
1817 } elsif ( $self->payby eq 'BILL' ) {
1819 $error = $self->ut_textn('payinfo');
1820 return "Illegal P.O. number: ". $self->payinfo if $error;
1823 } elsif ( $self->payby eq 'COMP' ) {
1825 my $curuser = $FS::CurrentUser::CurrentUser;
1826 if ( ! $self->custnum
1827 && ! $curuser->access_right('Complimentary customer')
1830 return "You are not permitted to create complimentary accounts."
1833 $error = $self->ut_textn('payinfo');
1834 return "Illegal comp account issuer: ". $self->payinfo if $error;
1837 } elsif ( $self->payby eq 'PREPAY' ) {
1839 my $payinfo = $self->payinfo;
1840 $payinfo =~ s/\W//g; #anything else would just confuse things
1841 $self->payinfo($payinfo);
1842 $error = $self->ut_alpha('payinfo');
1843 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1844 return "Unknown prepayment identifier"
1845 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1850 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1851 return "Expiration date required"
1852 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1856 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1857 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1858 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1859 ( $m, $y ) = ( $2, "19$1" );
1860 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1861 ( $m, $y ) = ( $3, "20$2" );
1863 return "Illegal expiration date: ". $self->paydate;
1865 $self->paydate("$y-$m-01");
1866 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1867 return gettext('expired_card')
1869 && !$ignore_expired_card
1870 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1873 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1874 ( ! $conf->exists('require_cardname')
1875 || $self->payby !~ /^(CARD|DCRD)$/ )
1877 $self->payname( $self->first. " ". $self->getfield('last') );
1879 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1880 or return gettext('illegal_name'). " payname: ". $self->payname;
1884 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1885 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1889 $self->otaker(getotaker) unless $self->otaker;
1891 warn "$me check AFTER: \n". $self->_dump
1894 $self->SUPER::check;
1899 Returns a list of fields which have ship_ duplicates.
1904 qw( last first company
1905 address1 address2 city county state zip country
1910 =item has_ship_address
1912 Returns true if this customer record has a separate shipping address.
1916 sub has_ship_address {
1918 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1923 Returns a list of key/value pairs, with the following keys: address1, adddress2,
1924 city, county, state, zip, country. The shipping address is used if present.
1928 #geocode? dependent on tax-ship_address config, not available in cust_location
1929 #mostly. not yet then.
1933 my $prefix = $self->has_ship_address ? 'ship_' : '';
1935 map { $_ => $self->get($prefix.$_) }
1936 qw( address1 address2 city county state zip country geocode );
1937 #fields that cust_location has
1940 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1942 Returns all packages (see L<FS::cust_pkg>) for this customer.
1948 my $extra_qsearch = ref($_[0]) ? shift : {};
1950 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1953 if ( $self->{'_pkgnum'} ) {
1954 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1956 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1959 sort sort_packages @cust_pkg;
1964 Synonym for B<all_pkgs>.
1969 shift->all_pkgs(@_);
1974 Returns all locations (see L<FS::cust_location>) for this customer.
1980 qsearch('cust_location', { 'custnum' => $self->custnum } );
1983 =item location_label [ OPTION => VALUE ... ]
1985 Returns the label of the service location (see analog in L<FS::cust_location>) for this customer.
1993 used to separate the address elements (defaults to ', ')
1995 =item escape_function
1997 a callback used for escaping the text of the address elements
2003 # false laziness with FS::cust_location::line
2005 sub location_label {
2009 my $separator = $opt{join_string} || ', ';
2010 my $escape = $opt{escape_function} || sub{ shift };
2012 my $cydefault = FS::conf->new->config('countrydefault') || 'US';
2013 my $prefix = length($self->ship_last) ? 'ship_' : '';
2016 foreach (qw ( address1 address2 ) ) {
2017 my $method = "$prefix$_";
2018 $line .= ($notfirst ? $separator : ''). &$escape($self->$method)
2023 foreach (qw ( city county state zip ) ) {
2024 my $method = "$prefix$_";
2025 if ( $self->$method ) {
2026 $line .= ' (' if $method eq 'county';
2027 $line .= ($notfirst ? ' ' : $separator). &$escape($self->$method);
2028 $line .= ' )' if $method eq 'county';
2032 $line .= $separator. &$escape(code2country($self->country))
2033 if $self->country ne $cydefault;
2038 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
2040 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
2044 sub ncancelled_pkgs {
2046 my $extra_qsearch = ref($_[0]) ? shift : {};
2048 return $self->num_ncancelled_pkgs unless wantarray;
2051 if ( $self->{'_pkgnum'} ) {
2053 warn "$me ncancelled_pkgs: returning cached objects"
2056 @cust_pkg = grep { ! $_->getfield('cancel') }
2057 values %{ $self->{'_pkgnum'}->cache };
2061 warn "$me ncancelled_pkgs: searching for packages with custnum ".
2062 $self->custnum. "\n"
2065 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
2067 @cust_pkg = $self->_cust_pkg($extra_qsearch);
2071 sort sort_packages @cust_pkg;
2077 my $extra_qsearch = ref($_[0]) ? shift : {};
2079 $extra_qsearch->{'select'} ||= '*';
2080 $extra_qsearch->{'select'} .=
2081 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2085 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2090 'table' => 'cust_pkg',
2091 'hashref' => { 'custnum' => $self->custnum },
2096 # This should be generalized to use config options to determine order.
2099 my $locationsort = ( $a->locationnum || 0 ) <=> ( $b->locationnum || 0 );
2100 return $locationsort if $locationsort;
2102 if ( $a->get('cancel') xor $b->get('cancel') ) {
2103 return -1 if $b->get('cancel');
2104 return 1 if $a->get('cancel');
2105 #shouldn't get here...
2108 my $a_num_cust_svc = $a->num_cust_svc;
2109 my $b_num_cust_svc = $b->num_cust_svc;
2110 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2111 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2112 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2113 my @a_cust_svc = $a->cust_svc;
2114 my @b_cust_svc = $b->cust_svc;
2115 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2120 =item suspended_pkgs
2122 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2126 sub suspended_pkgs {
2128 grep { $_->susp } $self->ncancelled_pkgs;
2131 =item unflagged_suspended_pkgs
2133 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2134 customer (thouse packages without the `manual_flag' set).
2138 sub unflagged_suspended_pkgs {
2140 return $self->suspended_pkgs
2141 unless dbdef->table('cust_pkg')->column('manual_flag');
2142 grep { ! $_->manual_flag } $self->suspended_pkgs;
2145 =item unsuspended_pkgs
2147 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2152 sub unsuspended_pkgs {
2154 grep { ! $_->susp } $self->ncancelled_pkgs;
2157 =item next_bill_date
2159 Returns the next date this customer will be billed, as a UNIX timestamp, or
2160 undef if no active package has a next bill date.
2164 sub next_bill_date {
2166 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2169 =item num_cancelled_pkgs
2171 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2176 sub num_cancelled_pkgs {
2177 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2180 sub num_ncancelled_pkgs {
2181 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2185 my( $self ) = shift;
2186 my $sql = scalar(@_) ? shift : '';
2187 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2188 my $sth = dbh->prepare(
2189 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2190 ) or die dbh->errstr;
2191 $sth->execute($self->custnum) or die $sth->errstr;
2192 $sth->fetchrow_arrayref->[0];
2197 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2198 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2199 on success or a list of errors.
2205 grep { $_->unsuspend } $self->suspended_pkgs;
2210 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2212 Returns a list: an empty list on success or a list of errors.
2218 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2221 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2223 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2224 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2225 of a list of pkgparts; the hashref has the following keys:
2229 =item pkgparts - listref of pkgparts
2231 =item (other options are passed to the suspend method)
2236 Returns a list: an empty list on success or a list of errors.
2240 sub suspend_if_pkgpart {
2242 my (@pkgparts, %opt);
2243 if (ref($_[0]) eq 'HASH'){
2244 @pkgparts = @{$_[0]{pkgparts}};
2249 grep { $_->suspend(%opt) }
2250 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2251 $self->unsuspended_pkgs;
2254 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2256 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2257 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2258 instead of a list of pkgparts; the hashref has the following keys:
2262 =item pkgparts - listref of pkgparts
2264 =item (other options are passed to the suspend method)
2268 Returns a list: an empty list on success or a list of errors.
2272 sub suspend_unless_pkgpart {
2274 my (@pkgparts, %opt);
2275 if (ref($_[0]) eq 'HASH'){
2276 @pkgparts = @{$_[0]{pkgparts}};
2281 grep { $_->suspend(%opt) }
2282 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2283 $self->unsuspended_pkgs;
2286 =item cancel [ OPTION => VALUE ... ]
2288 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2290 Available options are:
2294 =item quiet - can be set true to supress email cancellation notices.
2296 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2298 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2300 =item nobill - can be set true to skip billing if it might otherwise be done.
2304 Always returns a list: an empty list on success or a list of errors.
2308 # nb that dates are not specified as valid options to this method
2311 my( $self, %opt ) = @_;
2313 warn "$me cancel called on customer ". $self->custnum. " with options ".
2314 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2317 return ( 'access denied' )
2318 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2320 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2322 #should try decryption (we might have the private key)
2323 # and if not maybe queue a job for the server that does?
2324 return ( "Can't (yet) ban encrypted credit cards" )
2325 if $self->is_encrypted($self->payinfo);
2327 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2328 my $error = $ban->insert;
2329 return ( $error ) if $error;
2333 my @pkgs = $self->ncancelled_pkgs;
2335 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2337 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2338 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2342 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2343 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2346 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2349 sub _banned_pay_hashref {
2360 'payby' => $payby2ban{$self->payby},
2361 'payinfo' => md5_base64($self->payinfo),
2362 #don't ever *search* on reason! #'reason' =>
2368 Returns all notes (see L<FS::cust_main_note>) for this customer.
2375 qsearch( 'cust_main_note',
2376 { 'custnum' => $self->custnum },
2378 'ORDER BY _DATE DESC'
2384 Returns the agent (see L<FS::agent>) for this customer.
2390 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2395 Returns the customer class, as an FS::cust_class object, or the empty string
2396 if there is no customer class.
2402 if ( $self->classnum ) {
2403 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2411 Returns the customer category name, or the empty string if there is no customer
2418 my $cust_class = $self->cust_class;
2420 ? $cust_class->categoryname
2426 Returns the customer class name, or the empty string if there is no customer
2433 my $cust_class = $self->cust_class;
2435 ? $cust_class->classname
2440 =item bill_and_collect
2442 Cancels and suspends any packages due, generates bills, applies payments and
2443 credits, and applies collection events to run cards, send bills and notices,
2446 By default, warns on errors and continues with the next operation (but see the
2447 "fatal" flag below).
2449 Options are passed as name-value pairs. Currently available options are:
2455 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2459 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2463 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2467 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2471 If set true, re-charges setup fees.
2475 If set any errors prevent subsequent operations from continusing. If set
2476 specifically to "return", returns the error (or false, if there is no error).
2477 Any other true value causes errors to die.
2481 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2485 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2486 options of those methods are also available.
2490 sub bill_and_collect {
2491 my( $self, %options ) = @_;
2495 #$options{actual_time} not $options{time} because freeside-daily -d is for
2496 #pre-printing invoices
2498 $options{'actual_time'} ||= time;
2500 $error = $self->cancel_expired_pkgs( $options{actual_time} );
2502 $error = "Error expiring custnum ". $self->custnum. ": $error";
2503 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2504 elsif ( $options{fatal} ) { die $error; }
2505 else { warn $error; }
2508 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
2510 $error = "Error adjourning custnum ". $self->custnum. ": $error";
2511 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2512 elsif ( $options{fatal} ) { die $error; }
2513 else { warn $error; }
2516 $error = $self->bill( %options );
2518 $error = "Error billing custnum ". $self->custnum. ": $error";
2519 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2520 elsif ( $options{fatal} ) { die $error; }
2521 else { warn $error; }
2524 $error = $self->apply_payments_and_credits;
2526 $error = "Error applying custnum ". $self->custnum. ": $error";
2527 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
2528 elsif ( $options{fatal} ) { die $error; }
2529 else { warn $error; }
2532 unless ( $conf->exists('cancelled_cust-noevents')
2533 && ! $self->num_ncancelled_pkgs
2535 $error = $self->collect( %options );
2537 $error = "Error collecting custnum ". $self->custnum. ": $error";
2538 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
2539 elsif ($options{fatal} ) { die $error; }
2540 else { warn $error; }
2548 sub cancel_expired_pkgs {
2549 my ( $self, $time, %options ) = @_;
2551 my @cancel_pkgs = $self->ncancelled_pkgs( {
2552 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2557 foreach my $cust_pkg ( @cancel_pkgs ) {
2558 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2559 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2560 'reason_otaker' => $cpr->otaker
2564 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2567 scalar(@errors) ? join(' / ', @errors) : '';
2571 sub suspend_adjourned_pkgs {
2572 my ( $self, $time, %options ) = @_;
2574 my @susp_pkgs = $self->ncancelled_pkgs( {
2576 " AND ( susp IS NULL OR susp = 0 )
2577 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2578 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2583 #only because there's no SQL test for is_prepaid :/
2585 grep { ( $_->part_pkg->is_prepaid
2590 && $_->adjourn <= $time
2598 foreach my $cust_pkg ( @susp_pkgs ) {
2599 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2600 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2601 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2602 'reason_otaker' => $cpr->otaker
2606 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
2609 scalar(@errors) ? join(' / ', @errors) : '';
2615 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2616 conjunction with the collect method by calling B<bill_and_collect>.
2618 If there is an error, returns the error, otherwise returns false.
2620 Options are passed as name-value pairs. Currently available options are:
2626 If set true, re-charges setup fees.
2630 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2634 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2638 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2640 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2644 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2648 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2652 This boolean value informs the us that the package is being cancelled. This
2653 typically might mean not charging the normal recurring fee but only usage
2654 fees since the last billing. Setup charges may be charged. Not all package
2655 plans support this feature (they tend to charge 0).
2659 Optional terms to be printed on this invoice. Otherwise, customer-specific
2660 terms or the default terms are used.
2667 my( $self, %options ) = @_;
2668 return '' if $self->payby eq 'COMP';
2669 warn "$me bill customer ". $self->custnum. "\n"
2672 my $time = $options{'time'} || time;
2673 my $invoice_time = $options{'invoice_time'} || $time;
2675 $options{'not_pkgpart'} ||= {};
2676 $options{'not_pkgpart'} = { map { $_ => 1 }
2677 split(/\s*,\s*/, $options{'not_pkgpart'})
2679 unless ref($options{'not_pkgpart'});
2681 local $SIG{HUP} = 'IGNORE';
2682 local $SIG{INT} = 'IGNORE';
2683 local $SIG{QUIT} = 'IGNORE';
2684 local $SIG{TERM} = 'IGNORE';
2685 local $SIG{TSTP} = 'IGNORE';
2686 local $SIG{PIPE} = 'IGNORE';
2688 my $oldAutoCommit = $FS::UID::AutoCommit;
2689 local $FS::UID::AutoCommit = 0;
2692 $self->select_for_update; #mutex
2694 my $error = $self->do_cust_event(
2695 'debug' => ( $options{'debug'} || 0 ),
2696 'time' => $invoice_time,
2697 'check_freq' => $options{'check_freq'},
2698 'stage' => 'pre-bill',
2701 $dbh->rollback if $oldAutoCommit;
2705 #keep auto-charge and non-auto-charge line items separate
2706 my @passes = ( '', 'no_auto' );
2708 my %cust_bill_pkg = map { $_ => [] } @passes;
2711 # find the packages which are due for billing, find out how much they are
2712 # & generate invoice database.
2715 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
2716 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
2718 my %taxlisthash = map { $_ => {} } @passes;
2720 my @precommit_hooks = ();
2722 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2723 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2725 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2727 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2729 #? to avoid use of uninitialized value errors... ?
2730 $cust_pkg->setfield('bill', '')
2731 unless defined($cust_pkg->bill);
2733 #my $part_pkg = $cust_pkg->part_pkg;
2735 my $real_pkgpart = $cust_pkg->pkgpart;
2736 my %hash = $cust_pkg->hash;
2738 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2740 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2742 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
2745 $self->_make_lines( 'part_pkg' => $part_pkg,
2746 'cust_pkg' => $cust_pkg,
2747 'precommit_hooks' => \@precommit_hooks,
2748 'line_items' => $cust_bill_pkg{$pass},
2749 'setup' => $total_setup{$pass},
2750 'recur' => $total_recur{$pass},
2751 'tax_matrix' => $taxlisthash{$pass},
2753 'real_pkgpart' => $real_pkgpart,
2754 'options' => \%options,
2757 $dbh->rollback if $oldAutoCommit;
2761 } #foreach my $part_pkg
2763 } #foreach my $cust_pkg
2765 #if the customer isn't on an automatic payby, everything can go on a single
2767 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
2768 #merge everything into one list
2771 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
2773 my @cust_bill_pkg = @{ $cust_bill_pkg{$pass} };
2775 next unless @cust_bill_pkg; #don't create an invoice w/o line items
2777 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2778 !$conf->exists('postal_invoice-recurring_only')
2782 my $postal_pkg = $self->charge_postal_fee();
2783 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2785 $dbh->rollback if $oldAutoCommit;
2786 return "can't charge postal invoice fee for customer ".
2787 $self->custnum. ": $postal_pkg";
2789 } elsif ( $postal_pkg ) {
2791 my $real_pkgpart = $postal_pkg->pkgpart;
2792 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2793 my %postal_options = %options;
2794 delete $postal_options{cancel};
2796 $self->_make_lines( 'part_pkg' => $part_pkg,
2797 'cust_pkg' => $postal_pkg,
2798 'precommit_hooks' => \@precommit_hooks,
2799 'line_items' => \@cust_bill_pkg,
2800 'setup' => $total_setup{$pass},
2801 'recur' => $total_recur{$pass},
2802 'tax_matrix' => $taxlisthash{$pass},
2804 'real_pkgpart' => $real_pkgpart,
2805 'options' => \%postal_options,
2808 $dbh->rollback if $oldAutoCommit;
2817 my $listref_or_error =
2818 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
2820 unless ( ref( $listref_or_error ) ) {
2821 $dbh->rollback if $oldAutoCommit;
2822 return $listref_or_error;
2825 foreach my $taxline ( @$listref_or_error ) {
2826 ${ $total_setup{$pass} } =
2827 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
2828 push @cust_bill_pkg, $taxline;
2831 #add tax adjustments
2832 warn "adding tax adjustments...\n" if $DEBUG > 2;
2833 foreach my $cust_tax_adjustment (
2834 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2840 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2842 my $itemdesc = $cust_tax_adjustment->taxname;
2843 $itemdesc = '' if $itemdesc eq 'Tax';
2845 push @cust_bill_pkg, new FS::cust_bill_pkg {
2851 'itemdesc' => $itemdesc,
2852 'itemcomment' => $cust_tax_adjustment->comment,
2853 'cust_tax_adjustment' => $cust_tax_adjustment,
2854 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2859 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
2861 my @cust_bill = $self->cust_bill;
2862 my $balance = $self->balance;
2863 my $previous_balance = scalar(@cust_bill)
2864 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2867 $previous_balance += $cust_bill[$#cust_bill]->charged
2868 if scalar(@cust_bill);
2869 #my $balance_adjustments =
2870 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2872 #create the new invoice
2873 my $cust_bill = new FS::cust_bill ( {
2874 'custnum' => $self->custnum,
2875 '_date' => ( $invoice_time ),
2876 'charged' => $charged,
2877 'billing_balance' => $balance,
2878 'previous_balance' => $previous_balance,
2879 'invoice_terms' => $options{'invoice_terms'},
2881 $error = $cust_bill->insert;
2883 $dbh->rollback if $oldAutoCommit;
2884 return "can't create invoice for customer #". $self->custnum. ": $error";
2887 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2888 $cust_bill_pkg->invnum($cust_bill->invnum);
2889 my $error = $cust_bill_pkg->insert;
2891 $dbh->rollback if $oldAutoCommit;
2892 return "can't create invoice line item: $error";
2896 } #foreach my $pass ( keys %cust_bill_pkg )
2898 foreach my $hook ( @precommit_hooks ) {
2900 &{$hook}; #($self) ?
2903 $dbh->rollback if $oldAutoCommit;
2904 return "$@ running precommit hook $hook\n";
2908 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2912 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
2914 This is a weird one. Perhaps it should not even be exposed.
2916 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
2917 Usually used internally by bill method B<bill>.
2919 If there is an error, returns the error, otherwise returns reference to a
2920 list of line items suitable for insertion.
2926 An array ref of the line items being billed.
2930 A strange beast. The keys to this hash are internal identifiers consisting
2931 of the name of the tax object type, a space, and its unique identifier ( e.g.
2932 'cust_main_county 23' ). The values of the hash are listrefs. The first
2933 item in the list is the tax object. The remaining items are either line
2934 items or floating point values (currency amounts).
2936 The taxes are calculated on this entity. Calculated exemption records are
2937 transferred to the LINEITEMREF items on the assumption that they are related.
2943 This specifies the date appearing on the associated invoice. Some
2944 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
2949 sub calculate_taxes {
2950 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
2952 my @tax_line_items = ();
2954 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2956 # keys are tax names (as printed on invoices / itemdesc )
2957 # values are listrefs of taxlisthash keys (internal identifiers)
2960 # keys are taxlisthash keys (internal identifiers)
2961 # values are (cumulative) amounts
2964 # keys are taxlisthash keys (internal identifiers)
2965 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2966 my %tax_location = ();
2968 # keys are taxlisthash keys (internal identifiers)
2969 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2970 my %tax_rate_location = ();
2972 foreach my $tax ( keys %$taxlisthash ) {
2973 my $tax_object = shift @{ $taxlisthash->{$tax} };
2974 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2975 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
2976 my $hashref_or_error =
2977 $tax_object->taxline( $taxlisthash->{$tax},
2978 'custnum' => $self->custnum,
2979 'invoice_time' => $invoice_time
2981 return $hashref_or_error unless ref($hashref_or_error);
2983 unshift @{ $taxlisthash->{$tax} }, $tax_object;
2985 my $name = $hashref_or_error->{'name'};
2986 my $amount = $hashref_or_error->{'amount'};
2988 #warn "adding $amount as $name\n";
2989 $taxname{ $name } ||= [];
2990 push @{ $taxname{ $name } }, $tax;
2992 $tax{ $tax } += $amount;
2994 $tax_location{ $tax } ||= [];
2995 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2996 push @{ $tax_location{ $tax } },
2998 'taxnum' => $tax_object->taxnum,
2999 'taxtype' => ref($tax_object),
3000 'pkgnum' => $tax_object->get('pkgnum'),
3001 'locationnum' => $tax_object->get('locationnum'),
3002 'amount' => sprintf('%.2f', $amount ),
3006 $tax_rate_location{ $tax } ||= [];
3007 if ( ref($tax_object) eq 'FS::tax_rate' ) {
3008 my $taxratelocationnum =
3009 $tax_object->tax_rate_location->taxratelocationnum;
3010 push @{ $tax_rate_location{ $tax } },
3012 'taxnum' => $tax_object->taxnum,
3013 'taxtype' => ref($tax_object),
3014 'amount' => sprintf('%.2f', $amount ),
3015 'locationtaxid' => $tax_object->location,
3016 'taxratelocationnum' => $taxratelocationnum,
3022 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
3023 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
3024 foreach my $tax ( keys %$taxlisthash ) {
3025 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
3026 next unless ref($_) eq 'FS::cust_bill_pkg';
3028 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
3029 splice( @{ $_->_cust_tax_exempt_pkg } );
3033 #consolidate and create tax line items
3034 warn "consolidating and generating...\n" if $DEBUG > 2;
3035 foreach my $taxname ( keys %taxname ) {
3038 my @cust_bill_pkg_tax_location = ();
3039 my @cust_bill_pkg_tax_rate_location = ();
3040 warn "adding $taxname\n" if $DEBUG > 1;
3041 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
3042 next if $seen{$taxitem}++;
3043 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
3044 $tax += $tax{$taxitem};
3045 push @cust_bill_pkg_tax_location,
3046 map { new FS::cust_bill_pkg_tax_location $_ }
3047 @{ $tax_location{ $taxitem } };
3048 push @cust_bill_pkg_tax_rate_location,
3049 map { new FS::cust_bill_pkg_tax_rate_location $_ }
3050 @{ $tax_rate_location{ $taxitem } };
3054 $tax = sprintf('%.2f', $tax );
3056 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
3062 if ( $pkg_category and
3063 $conf->config('invoice_latexsummary') ||
3064 $conf->config('invoice_htmlsummary')
3068 my %hash = ( 'section' => $pkg_category->categoryname );
3069 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3073 push @tax_line_items, new FS::cust_bill_pkg {
3079 'itemdesc' => $taxname,
3080 'display' => \@display,
3081 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
3082 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
3091 my ($self, %params) = @_;
3093 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
3094 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
3095 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
3096 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
3097 my $total_setup = $params{setup} or die "no setup accumulator specified";
3098 my $total_recur = $params{recur} or die "no recur accumulator specified";
3099 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
3100 my $time = $params{'time'} or die "no time specified";
3101 my (%options) = %{$params{options}};
3104 my $real_pkgpart = $params{real_pkgpart};
3105 my %hash = $cust_pkg->hash;
3106 my $old_cust_pkg = new FS::cust_pkg \%hash;
3112 $cust_pkg->pkgpart($part_pkg->pkgpart);
3120 if ( $options{'resetup'}
3121 || ( ! $cust_pkg->setup
3122 && ( ! $cust_pkg->start_date
3123 || $cust_pkg->start_date <= $time
3125 && ( ! $conf->exists('disable_setup_suspended_pkgs')
3126 || ( $conf->exists('disable_setup_suspended_pkgs') &&
3127 ! $cust_pkg->getfield('susp')
3134 warn " bill setup\n" if $DEBUG > 1;
3137 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
3138 return "$@ running calc_setup for $cust_pkg\n"
3141 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
3143 $cust_pkg->setfield('setup', $time)
3144 unless $cust_pkg->setup;
3145 #do need it, but it won't get written to the db
3146 #|| $cust_pkg->pkgpart != $real_pkgpart;
3148 $cust_pkg->setfield('start_date', '')
3149 if $cust_pkg->start_date;
3154 # bill recurring fee
3157 #XXX unit stuff here too
3161 if ( ! $cust_pkg->get('susp')
3162 and ! $cust_pkg->get('start_date')
3163 and ( $part_pkg->getfield('freq') ne '0'
3164 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3166 || ( $part_pkg->plan eq 'voip_cdr'
3167 && $part_pkg->option('bill_every_call')
3169 || ( $options{cancel} )
3172 # XXX should this be a package event? probably. events are called
3173 # at collection time at the moment, though...
3174 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3175 if $part_pkg->can('reset_usage');
3176 #don't want to reset usage just cause we want a line item??
3177 #&& $part_pkg->pkgpart == $real_pkgpart;
3179 warn " bill recur\n" if $DEBUG > 1;
3182 # XXX shared with $recur_prog
3183 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3187 #over two params! lets at least switch to a hashref for the rest...
3188 my $increment_next_bill = ( $part_pkg->freq ne '0'
3189 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3190 && !$options{cancel}
3192 my %param = ( 'precommit_hooks' => $precommit_hooks,
3193 'increment_next_bill' => $increment_next_bill,
3194 'discounts' => \@discounts,
3197 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3198 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3199 return "$@ running $method for $cust_pkg\n"
3202 if ( $increment_next_bill ) {
3204 my $next_bill = $part_pkg->add_freq($sdate);
3205 return "unparsable frequency: ". $part_pkg->freq
3206 if $next_bill == -1;
3208 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3209 # only for figuring next bill date, nothing else, so, reset $sdate again
3211 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3212 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3213 $cust_pkg->last_bill($sdate);
3215 $cust_pkg->setfield('bill', $next_bill );
3221 warn "\$setup is undefined" unless defined($setup);
3222 warn "\$recur is undefined" unless defined($recur);
3223 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3226 # If there's line items, create em cust_bill_pkg records
3227 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3232 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3233 # hmm.. and if just the options are modified in some weird price plan?
3235 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3238 my $error = $cust_pkg->replace( $old_cust_pkg,
3239 'options' => { $cust_pkg->options },
3241 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3242 if $error; #just in case
3245 $setup = sprintf( "%.2f", $setup );
3246 $recur = sprintf( "%.2f", $recur );
3247 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3248 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3250 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3251 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3254 if ( $setup != 0 || $recur != 0 ) {
3256 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3259 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3261 warn " adding customer package invoice detail: $_\n"
3262 foreach @cust_pkg_detail;
3264 push @details, @cust_pkg_detail;
3266 my $cust_bill_pkg = new FS::cust_bill_pkg {
3267 'pkgnum' => $cust_pkg->pkgnum,
3269 'unitsetup' => $unitsetup,
3271 'unitrecur' => $unitrecur,
3272 'quantity' => $cust_pkg->quantity,
3273 'details' => \@details,
3274 'discounts' => \@discounts,
3275 'hidden' => $part_pkg->hidden,
3278 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3279 $cust_bill_pkg->sdate( $hash{last_bill} );
3280 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3281 $cust_bill_pkg->edate( $time ) if $options{cancel};
3282 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3283 $cust_bill_pkg->sdate( $sdate );
3284 $cust_bill_pkg->edate( $cust_pkg->bill );
3285 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3288 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3289 unless $part_pkg->pkgpart == $real_pkgpart;
3291 $$total_setup += $setup;
3292 $$total_recur += $recur;
3299 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3300 return $error if $error;
3302 push @$cust_bill_pkgs, $cust_bill_pkg;
3304 } #if $setup != 0 || $recur != 0
3314 my $part_pkg = shift;
3315 my $taxlisthash = shift;
3316 my $cust_bill_pkg = shift;
3317 my $cust_pkg = shift;
3318 my $invoice_time = shift;
3319 my $real_pkgpart = shift;
3320 my $options = shift;
3322 my %cust_bill_pkg = ();
3326 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3327 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3328 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3329 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3331 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3333 if ( $conf->exists('enable_taxproducts')
3334 && ( scalar($part_pkg->part_pkg_taxoverride)
3335 || $part_pkg->has_taxproduct
3340 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3341 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3344 foreach my $class (@classes) {
3345 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3346 return $err_or_ref unless ref($err_or_ref);
3347 $taxes{$class} = $err_or_ref;
3350 unless (exists $taxes{''}) {
3351 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3352 return $err_or_ref unless ref($err_or_ref);
3353 $taxes{''} = $err_or_ref;
3358 my @loc_keys = qw( city county state country );
3360 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3361 my $cust_location = $cust_pkg->cust_location;
3362 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3365 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3368 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3371 $taxhash{'taxclass'} = $part_pkg->taxclass;
3374 my %taxhash_elim = %taxhash;
3375 my @elim = qw( city county state );
3378 #first try a match with taxclass
3379 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3381 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3382 #then try a match without taxclass
3383 my %no_taxclass = %taxhash_elim;
3384 $no_taxclass{ 'taxclass' } = '';
3385 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3388 $taxhash_elim{ shift(@elim) } = '';
3390 } while ( !scalar(@taxes) && scalar(@elim) );
3392 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3394 if $self->cust_main_exemption; #just to be safe
3396 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3398 $_->set('pkgnum', $cust_pkg->pkgnum );
3399 $_->set('locationnum', $cust_pkg->locationnum );
3403 $taxes{''} = [ @taxes ];
3404 $taxes{'setup'} = [ @taxes ];
3405 $taxes{'recur'} = [ @taxes ];
3406 $taxes{$_} = [ @taxes ] foreach (@classes);
3408 # # maybe eliminate this entirely, along with all the 0% records
3409 # unless ( @taxes ) {
3411 # "fatal: can't find tax rate for state/county/country/taxclass ".
3412 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3415 } #if $conf->exists('enable_taxproducts') ...
3420 my $separate = $conf->exists('separate_usage');
3421 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3422 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3424 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3425 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3426 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3429 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3430 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3432 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3433 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3435 push @display, new FS::cust_bill_pkg_display
3438 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3442 if ($separate && $section && $summary) {
3443 push @display, new FS::cust_bill_pkg_display { type => 'U',
3448 if ($usage_mandate || $section && $summary) {
3449 $hash{post_total} = 'Y';
3452 $hash{section} = $section if ($separate || $usage_mandate);
3453 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3456 $cust_bill_pkg->set('display', \@display);
3458 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3459 foreach my $key (keys %tax_cust_bill_pkg) {
3460 my @taxes = @{ $taxes{$key} || [] };
3461 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3463 my %localtaxlisthash = ();
3464 foreach my $tax ( @taxes ) {
3466 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3467 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3468 # ' locationnum'. $cust_pkg->locationnum
3469 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3471 $taxlisthash->{ $taxname } ||= [ $tax ];
3472 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3474 $localtaxlisthash{ $taxname } ||= [ $tax ];
3475 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3479 warn "finding taxed taxes...\n" if $DEBUG > 2;
3480 foreach my $tax ( keys %localtaxlisthash ) {
3481 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3482 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3484 next unless $tax_object->can('tax_on_tax');
3486 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3487 my $totname = ref( $tot ). ' '. $tot->taxnum;
3489 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3491 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3493 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3494 my $hashref_or_error =
3495 $tax_object->taxline( $localtaxlisthash{$tax},
3496 'custnum' => $self->custnum,
3497 'invoice_time' => $invoice_time,
3499 return $hashref_or_error
3500 unless ref($hashref_or_error);
3502 $taxlisthash->{ $totname } ||= [ $tot ];
3503 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3515 my $part_pkg = shift;
3519 my $geocode = $self->geocode('cch');
3521 my @taxclassnums = map { $_->taxclassnum }
3522 $part_pkg->part_pkg_taxoverride($class);
3524 unless (@taxclassnums) {
3525 @taxclassnums = map { $_->taxclassnum }
3526 grep { $_->taxable eq 'Y' }
3527 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3529 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3534 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3536 @taxes = qsearch({ 'table' => 'tax_rate',
3537 'hashref' => { 'geocode' => $geocode, },
3538 'extra_sql' => $extra_sql,
3540 if scalar(@taxclassnums);
3542 warn "Found taxes ".
3543 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3550 =item collect [ HASHREF | OPTION => VALUE ... ]
3552 (Attempt to) collect money for this customer's outstanding invoices (see
3553 L<FS::cust_bill>). Usually used after the bill method.
3555 Actions are now triggered by billing events; see L<FS::part_event> and the
3556 billing events web interface. Old-style invoice events (see
3557 L<FS::part_bill_event>) have been deprecated.
3559 If there is an error, returns the error, otherwise returns false.
3561 Options are passed as name-value pairs.
3563 Currently available options are:
3569 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3573 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3577 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3581 set true to surpress email card/ACH decline notices.
3585 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3591 # allows for one time override of normal customer billing method
3596 my( $self, %options ) = @_;
3597 my $invoice_time = $options{'invoice_time'} || time;
3600 local $SIG{HUP} = 'IGNORE';
3601 local $SIG{INT} = 'IGNORE';
3602 local $SIG{QUIT} = 'IGNORE';
3603 local $SIG{TERM} = 'IGNORE';
3604 local $SIG{TSTP} = 'IGNORE';
3605 local $SIG{PIPE} = 'IGNORE';
3607 my $oldAutoCommit = $FS::UID::AutoCommit;
3608 local $FS::UID::AutoCommit = 0;
3611 $self->select_for_update; #mutex
3614 my $balance = $self->balance;
3615 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3618 if ( exists($options{'retry_card'}) ) {
3619 carp 'retry_card option passed to collect is deprecated; use retry';
3620 $options{'retry'} ||= $options{'retry_card'};
3622 if ( exists($options{'retry'}) && $options{'retry'} ) {
3623 my $error = $self->retry_realtime;
3625 $dbh->rollback if $oldAutoCommit;
3630 my $error = $self->do_cust_event(
3631 'debug' => ( $options{'debug'} || 0 ),
3632 'time' => $invoice_time,
3633 'check_freq' => $options{'check_freq'},
3634 'stage' => 'collect',
3637 $dbh->rollback if $oldAutoCommit;
3641 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3646 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3648 Runs billing events; see L<FS::part_event> and the billing events web
3651 If there is an error, returns the error, otherwise returns false.
3653 Options are passed as name-value pairs.
3655 Currently available options are:
3661 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
3665 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3669 "collect" (the default) or "pre-bill"
3673 set true to surpress email card/ACH decline notices.
3677 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3683 # allows for one time override of normal customer billing method
3687 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3690 my( $self, %options ) = @_;
3691 my $time = $options{'time'} || time;
3694 local $SIG{HUP} = 'IGNORE';
3695 local $SIG{INT} = 'IGNORE';
3696 local $SIG{QUIT} = 'IGNORE';
3697 local $SIG{TERM} = 'IGNORE';
3698 local $SIG{TSTP} = 'IGNORE';
3699 local $SIG{PIPE} = 'IGNORE';
3701 my $oldAutoCommit = $FS::UID::AutoCommit;
3702 local $FS::UID::AutoCommit = 0;
3705 $self->select_for_update; #mutex
3708 my $balance = $self->balance;
3709 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3712 # if ( exists($options{'retry_card'}) ) {
3713 # carp 'retry_card option passed to collect is deprecated; use retry';
3714 # $options{'retry'} ||= $options{'retry_card'};
3716 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3717 # my $error = $self->retry_realtime;
3719 # $dbh->rollback if $oldAutoCommit;
3724 # false laziness w/pay_batch::import_results
3726 my $due_cust_event = $self->due_cust_event(
3727 'debug' => ( $options{'debug'} || 0 ),
3729 'check_freq' => $options{'check_freq'},
3730 'stage' => ( $options{'stage'} || 'collect' ),
3732 unless( ref($due_cust_event) ) {
3733 $dbh->rollback if $oldAutoCommit;
3734 return $due_cust_event;
3737 foreach my $cust_event ( @$due_cust_event ) {
3741 #re-eval event conditions (a previous event could have changed things)
3742 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3743 #don't leave stray "new/locked" records around
3744 my $error = $cust_event->delete;
3746 #gah, even with transactions
3747 $dbh->commit if $oldAutoCommit; #well.
3754 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3755 warn " running cust_event ". $cust_event->eventnum. "\n"
3759 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3760 if ( my $error = $cust_event->do_event() ) {
3761 #XXX wtf is this? figure out a proper dealio with return value
3763 # gah, even with transactions.
3764 $dbh->commit if $oldAutoCommit; #well.
3771 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3776 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3778 Inserts database records for and returns an ordered listref of new events due
3779 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3780 events are due, an empty listref is returned. If there is an error, returns a
3781 scalar error message.
3783 To actually run the events, call each event's test_condition method, and if
3784 still true, call the event's do_event method.
3786 Options are passed as a hashref or as a list of name-value pairs. Available
3793 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
3797 "collect" (the default) or "pre-bill"
3801 "Current time" for the events.
3805 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
3809 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3813 Explicitly pass the objects to be tested (typically used with eventtable).
3817 Set to true to return the objects, but not actually insert them into the
3824 sub due_cust_event {
3826 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3829 #my $DEBUG = $opt{'debug'}
3830 local($DEBUG) = $opt{'debug'}
3831 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3833 warn "$me due_cust_event called with options ".
3834 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3837 $opt{'time'} ||= time;
3839 local $SIG{HUP} = 'IGNORE';
3840 local $SIG{INT} = 'IGNORE';
3841 local $SIG{QUIT} = 'IGNORE';
3842 local $SIG{TERM} = 'IGNORE';
3843 local $SIG{TSTP} = 'IGNORE';
3844 local $SIG{PIPE} = 'IGNORE';
3846 my $oldAutoCommit = $FS::UID::AutoCommit;
3847 local $FS::UID::AutoCommit = 0;
3850 $self->select_for_update #mutex
3851 unless $opt{testonly};
3854 # find possible events (initial search)
3857 my @cust_event = ();
3859 my @eventtable = $opt{'eventtable'}
3860 ? ( $opt{'eventtable'} )
3861 : FS::part_event->eventtables_runorder;
3863 foreach my $eventtable ( @eventtable ) {
3866 if ( $opt{'objects'} ) {
3868 @objects = @{ $opt{'objects'} };
3872 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3873 @objects = ( $eventtable eq 'cust_main' )
3875 : ( $self->$eventtable() );
3879 my @e_cust_event = ();
3881 my $cross = "CROSS JOIN $eventtable";
3882 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3883 unless $eventtable eq 'cust_main';
3885 foreach my $object ( @objects ) {
3887 #this first search uses the condition_sql magic for optimization.
3888 #the more possible events we can eliminate in this step the better
3890 my $cross_where = '';
3891 my $pkey = $object->primary_key;
3892 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3894 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3896 FS::part_event_condition->where_conditions_sql( $eventtable,
3897 'time'=>$opt{'time'}
3899 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3901 $extra_sql = "AND $extra_sql" if $extra_sql;
3903 #here is the agent virtualization
3904 $extra_sql .= " AND ( part_event.agentnum IS NULL
3905 OR part_event.agentnum = ". $self->agentnum. ' )';
3907 $extra_sql .= " $order";
3909 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3910 if $opt{'debug'} > 2;
3911 my @part_event = qsearch( {
3912 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3913 'select' => 'part_event.*',
3914 'table' => 'part_event',
3915 'addl_from' => "$cross $join",
3916 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3917 'eventtable' => $eventtable,
3920 'extra_sql' => "AND $cross_where $extra_sql",
3924 my $pkey = $object->primary_key;
3925 warn " ". scalar(@part_event).
3926 " possible events found for $eventtable ". $object->$pkey(). "\n";
3929 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3933 warn " ". scalar(@e_cust_event).
3934 " subtotal possible cust events found for $eventtable\n"
3937 push @cust_event, @e_cust_event;
3941 warn " ". scalar(@cust_event).
3942 " total possible cust events found in initial search\n"
3950 $opt{stage} ||= 'collect';
3952 grep { my $stage = $_->part_event->event_stage;
3953 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3963 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3964 'stats_hashref' => \%unsat ),
3967 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3970 warn " invalid conditions not eliminated with condition_sql:\n".
3971 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3972 if keys %unsat && $DEBUG; # > 1;
3978 unless( $opt{testonly} ) {
3979 foreach my $cust_event ( @cust_event ) {
3981 my $error = $cust_event->insert();
3983 $dbh->rollback if $oldAutoCommit;
3990 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3996 warn " returning events: ". Dumper(@cust_event). "\n"
4003 =item retry_realtime
4005 Schedules realtime / batch credit card / electronic check / LEC billing
4006 events for for retry. Useful if card information has changed or manual
4007 retry is desired. The 'collect' method must be called to actually retry
4010 Implementation details: For either this customer, or for each of this
4011 customer's open invoices, changes the status of the first "done" (with
4012 statustext error) realtime processing event to "failed".
4016 sub retry_realtime {
4019 local $SIG{HUP} = 'IGNORE';
4020 local $SIG{INT} = 'IGNORE';
4021 local $SIG{QUIT} = 'IGNORE';
4022 local $SIG{TERM} = 'IGNORE';
4023 local $SIG{TSTP} = 'IGNORE';
4024 local $SIG{PIPE} = 'IGNORE';
4026 my $oldAutoCommit = $FS::UID::AutoCommit;
4027 local $FS::UID::AutoCommit = 0;
4030 #a little false laziness w/due_cust_event (not too bad, really)
4032 my $join = FS::part_event_condition->join_conditions_sql;
4033 my $order = FS::part_event_condition->order_conditions_sql;
4036 . join ( ' OR ' , map {
4037 "( part_event.eventtable = " . dbh->quote($_)
4038 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
4039 } FS::part_event->eventtables)
4042 #here is the agent virtualization
4043 my $agent_virt = " ( part_event.agentnum IS NULL
4044 OR part_event.agentnum = ". $self->agentnum. ' )';
4046 #XXX this shouldn't be hardcoded, actions should declare it...
4047 my @realtime_events = qw(
4048 cust_bill_realtime_card
4049 cust_bill_realtime_check
4050 cust_bill_realtime_lec
4054 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
4059 my @cust_event = qsearchs({
4060 'table' => 'cust_event',
4061 'select' => 'cust_event.*',
4062 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
4063 'hashref' => { 'status' => 'done' },
4064 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
4065 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
4068 my %seen_invnum = ();
4069 foreach my $cust_event (@cust_event) {
4071 #max one for the customer, one for each open invoice
4072 my $cust_X = $cust_event->cust_X;
4073 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
4077 or $cust_event->part_event->eventtable eq 'cust_bill'
4080 my $error = $cust_event->retry;
4082 $dbh->rollback if $oldAutoCommit;
4083 return "error scheduling event for retry: $error";
4088 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4096 =item realtime_collect [ OPTION => VALUE ... ]
4098 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4099 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4100 gateway. See L<http://420.am/business-onlinepayment> and
4101 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4103 On failure returns an error message.
4105 Returns false or a hashref upon success. The hashref contains keys popup_url reference, and collectitems. The first is a URL to which a browser should be redirected for completion of collection. The second is a reference id for the transaction suitable for the end user. The collectitems is a reference to a list of name value pairs suitable for assigning to a html form and posted to popup_url.
4107 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4109 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4110 then it is deduced from the customer record.
4112 If no I<amount> is specified, then the customer balance is used.
4114 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4115 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4116 if set, will override the value from the customer record.
4118 I<description> is a free-text field passed to the gateway. It defaults to
4119 the value defined by the business-onlinepayment-description configuration
4120 option, or "Internet services" if that is unset.
4122 If an I<invnum> is specified, this payment (if successful) is applied to the
4123 specified invoice. If you don't specify an I<invnum> you might want to
4124 call the B<apply_payments> method or set the I<apply> option.
4126 I<apply> can be set to true to apply a resulting payment.
4128 I<quiet> can be set true to surpress email decline notices.
4130 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4131 resulting paynum, if any.
4133 I<payunique> is a unique identifier for this payment.
4135 I<session_id> is a session identifier associated with this payment.
4137 I<depend_jobnum> allows payment capture to unlock export jobs
4141 sub realtime_collect {
4142 my( $self, %options ) = @_;
4145 warn "$me realtime_collect:\n";
4146 warn " $_ => $options{$_}\n" foreach keys %options;
4149 $options{amount} = $self->balance unless exists( $options{amount} );
4150 $options{method} = FS::payby->payby2bop($self->payby)
4151 unless exists( $options{method} );
4153 return $self->realtime_bop({%options});
4157 =item realtime_bop { [ ARG => VALUE ... ] }
4159 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4160 via a Business::OnlinePayment realtime gateway. See
4161 L<http://420.am/business-onlinepayment> for supported gateways.
4163 Required arguments in the hashref are I<method>, and I<amount>
4165 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4167 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4169 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4170 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4171 if set, will override the value from the customer record.
4173 I<description> is a free-text field passed to the gateway. It defaults to
4174 the value defined by the business-onlinepayment-description configuration
4175 option, or "Internet services" if that is unset.
4177 If an I<invnum> is specified, this payment (if successful) is applied to the
4178 specified invoice. If you don't specify an I<invnum> you might want to
4179 call the B<apply_payments> method or set the I<apply> option.
4181 I<apply> can be set to true to apply a resulting payment.
4183 I<quiet> can be set true to surpress email decline notices.
4185 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4186 resulting paynum, if any.
4188 I<payunique> is a unique identifier for this payment.
4190 I<session_id> is a session identifier associated with this payment.
4192 I<depend_jobnum> allows payment capture to unlock export jobs
4194 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4198 # some helper routines
4199 sub _bop_recurring_billing {
4200 my( $self, %opt ) = @_;
4202 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4204 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4206 return 1 if $opt{'trans_is_recur'};
4210 my %hash = ( 'custnum' => $self->custnum,
4215 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4216 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4226 sub _payment_gateway {
4227 my ($self, $options) = @_;
4229 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4230 unless exists($options->{payment_gateway});
4232 $options->{payment_gateway};
4236 my ($self, $options) = @_;
4239 'login' => $options->{payment_gateway}->gateway_username,
4240 'password' => $options->{payment_gateway}->gateway_password,
4245 my ($self, $options) = @_;
4247 $options->{payment_gateway}->gatewaynum
4248 ? $options->{payment_gateway}->options
4249 : @{ $options->{payment_gateway}->get('options') };
4254 my ($self, $options) = @_;
4256 unless ( $options->{'description'} ) {
4257 if ( $conf->exists('business-onlinepayment-description') ) {
4258 my $dtempl = $conf->config('business-onlinepayment-description');
4260 my $agent = $self->agent->agent;
4262 $options->{'description'} = eval qq("$dtempl");
4264 $options->{'description'} = 'Internet services';
4268 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4269 $options->{invnum} ||= '';
4270 $options->{payname} = $self->payname unless exists( $options->{payname} );
4274 my ($self, $options) = @_;
4277 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4278 $content{customer_ip} = $payip if length($payip);
4280 $content{invoice_number} = $options->{'invnum'}
4281 if exists($options->{'invnum'}) && length($options->{'invnum'});
4283 $content{email_customer} =
4284 ( $conf->exists('business-onlinepayment-email_customer')
4285 || $conf->exists('business-onlinepayment-email-override') );
4287 my ($payname, $payfirst, $paylast);
4288 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
4289 ($payname = $options->{payname}) =~
4290 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4291 or return "Illegal payname $payname";
4292 ($payfirst, $paylast) = ($1, $2);
4294 $payfirst = $self->getfield('first');
4295 $paylast = $self->getfield('last');
4296 $payname = "$payfirst $paylast";
4299 $content{last_name} = $paylast;
4300 $content{first_name} = $payfirst;
4302 $content{name} = $payname;
4304 $content{address} = exists($options->{'address1'})
4305 ? $options->{'address1'}
4307 my $address2 = exists($options->{'address2'})
4308 ? $options->{'address2'}
4310 $content{address} .= ", ". $address2 if length($address2);
4312 $content{city} = exists($options->{city})
4315 $content{state} = exists($options->{state})
4318 $content{zip} = exists($options->{zip})
4321 $content{country} = exists($options->{country})
4322 ? $options->{country}
4325 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4326 $content{phone} = $self->daytime || $self->night;
4331 my %bop_method2payby = (
4341 if (ref($_[0]) eq 'HASH') {
4342 %options = %{$_[0]};
4344 my ( $method, $amount ) = ( shift, shift );
4346 $options{method} = $method;
4347 $options{amount} = $amount;
4351 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4352 warn " $_ => $options{$_}\n" foreach keys %options;
4355 return $self->fake_bop(%options) if $options{'fake'};
4357 $self->_bop_defaults(\%options);
4360 # set trans_is_recur based on invnum if there is one
4363 my $trans_is_recur = 0;
4364 if ( $options{'invnum'} ) {
4366 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4367 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4370 map { $_->part_pkg }
4372 map { $_->cust_pkg }
4373 $cust_bill->cust_bill_pkg;
4376 if grep { $_->freq ne '0' } @part_pkg;
4384 my $payment_gateway = $self->_payment_gateway( \%options );
4385 my $namespace = $payment_gateway->gateway_namespace;
4387 eval "use $namespace";
4391 # check for banned credit card/ACH
4394 my $ban = qsearchs('banned_pay', {
4395 'payby' => $bop_method2payby{$options{method}},
4396 'payinfo' => md5_base64($options{payinfo}),
4398 return "Banned credit card" if $ban;
4404 my $bop_content = $self->_bop_content(\%options);
4405 return $bop_content unless ref($bop_content);
4407 my @invoicing_list = $self->invoicing_list_emailonly;
4408 if ( $conf->exists('emailinvoiceautoalways')
4409 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4410 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4411 push @invoicing_list, $self->all_emails;
4414 my $email = ($conf->exists('business-onlinepayment-email-override'))
4415 ? $conf->config('business-onlinepayment-email-override')
4416 : $invoicing_list[0];
4420 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4422 $content{card_number} = $options{payinfo};
4423 $paydate = exists($options{'paydate'})
4424 ? $options{'paydate'}
4426 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4427 $content{expiration} = "$2/$1";
4429 my $paycvv = exists($options{'paycvv'})
4430 ? $options{'paycvv'}
4432 $content{cvv2} = $paycvv
4435 my $paystart_month = exists($options{'paystart_month'})
4436 ? $options{'paystart_month'}
4437 : $self->paystart_month;
4439 my $paystart_year = exists($options{'paystart_year'})
4440 ? $options{'paystart_year'}
4441 : $self->paystart_year;
4443 $content{card_start} = "$paystart_month/$paystart_year"
4444 if $paystart_month && $paystart_year;
4446 my $payissue = exists($options{'payissue'})
4447 ? $options{'payissue'}
4449 $content{issue_number} = $payissue if $payissue;
4451 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4452 'trans_is_recur' => $trans_is_recur,
4456 $content{recurring_billing} = 'YES';
4457 $content{acct_code} = 'rebill'
4458 if $conf->exists('credit_card-recurring_billing_acct_code');
4461 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4462 ( $content{account_number}, $content{routing_code} ) =
4463 split('@', $options{payinfo});
4464 $content{bank_name} = $options{payname};
4465 $content{bank_state} = exists($options{'paystate'})
4466 ? $options{'paystate'}
4467 : $self->getfield('paystate');
4468 $content{account_type} = exists($options{'paytype'})
4469 ? uc($options{'paytype'}) || 'CHECKING'
4470 : uc($self->getfield('paytype')) || 'CHECKING';
4471 $content{account_name} = $self->getfield('first'). ' '.
4472 $self->getfield('last');
4474 $content{customer_org} = $self->company ? 'B' : 'I';
4475 $content{state_id} = exists($options{'stateid'})
4476 ? $options{'stateid'}
4477 : $self->getfield('stateid');
4478 $content{state_id_state} = exists($options{'stateid_state'})
4479 ? $options{'stateid_state'}
4480 : $self->getfield('stateid_state');
4481 $content{customer_ssn} = exists($options{'ss'})
4484 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4485 $content{phone} = $options{payinfo};
4486 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4493 # run transaction(s)
4496 my $balance = exists( $options{'balance'} )
4497 ? $options{'balance'}
4500 $self->select_for_update; #mutex ... just until we get our pending record in
4502 #the checks here are intended to catch concurrent payments
4503 #double-form-submission prevention is taken care of in cust_pay_pending::check
4506 return "The customer's balance has changed; $options{method} transaction aborted."
4507 if $self->balance < $balance;
4508 #&& $self->balance < $options{amount}; #might as well anyway?
4510 #also check and make sure there aren't *other* pending payments for this cust
4512 my @pending = qsearch('cust_pay_pending', {
4513 'custnum' => $self->custnum,
4514 'status' => { op=>'!=', value=>'done' }
4516 return "A payment is already being processed for this customer (".
4517 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4518 "); $options{method} transaction aborted."
4519 if scalar(@pending);
4521 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4523 my $cust_pay_pending = new FS::cust_pay_pending {
4524 'custnum' => $self->custnum,
4525 #'invnum' => $options{'invnum'},
4526 'paid' => $options{amount},
4528 'payby' => $bop_method2payby{$options{method}},
4529 'payinfo' => $options{payinfo},
4530 'paydate' => $paydate,
4531 'recurring_billing' => $content{recurring_billing},
4532 'pkgnum' => $options{'pkgnum'},
4534 'gatewaynum' => $payment_gateway->gatewaynum || '',
4535 'session_id' => $options{session_id} || '',
4536 'jobnum' => $options{depend_jobnum} || '',
4538 $cust_pay_pending->payunique( $options{payunique} )
4539 if defined($options{payunique}) && length($options{payunique});
4540 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4541 return $cpp_new_err if $cpp_new_err;
4543 my( $action1, $action2 ) =
4544 split( /\s*\,\s*/, $payment_gateway->gateway_action );
4546 my $transaction = new $namespace( $payment_gateway->gateway_module,
4547 $self->_bop_options(\%options),
4550 $transaction->content(
4551 'type' => $options{method},
4552 $self->_bop_auth(\%options),
4553 'action' => $action1,
4554 'description' => $options{'description'},
4555 'amount' => $options{amount},
4556 #'invoice_number' => $options{'invnum'},
4557 'customer_id' => $self->custnum,
4559 'reference' => $cust_pay_pending->paypendingnum, #for now
4564 $cust_pay_pending->status('pending');
4565 my $cpp_pending_err = $cust_pay_pending->replace;
4566 return $cpp_pending_err if $cpp_pending_err;
4569 my $BOP_TESTING = 0;
4570 my $BOP_TESTING_SUCCESS = 1;
4572 unless ( $BOP_TESTING ) {
4573 $transaction->test_transaction(1)
4574 if $conf->exists('business-onlinepayment-test_transaction');
4575 $transaction->submit();
4577 if ( $BOP_TESTING_SUCCESS ) {
4578 $transaction->is_success(1);
4579 $transaction->authorization('fake auth');
4581 $transaction->is_success(0);
4582 $transaction->error_message('fake failure');
4586 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4588 return { reference => $cust_pay_pending->paypendingnum,
4589 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
4591 } elsif ( $transaction->is_success() && $action2 ) {
4593 $cust_pay_pending->status('authorized');
4594 my $cpp_authorized_err = $cust_pay_pending->replace;
4595 return $cpp_authorized_err if $cpp_authorized_err;
4597 my $auth = $transaction->authorization;
4598 my $ordernum = $transaction->can('order_number')
4599 ? $transaction->order_number
4603 new Business::OnlinePayment( $payment_gateway->gateway_module,
4604 $self->_bop_options(\%options),
4609 type => $options{method},
4611 $self->_bop_auth(\%options),
4612 order_number => $ordernum,
4613 amount => $options{amount},
4614 authorization => $auth,
4615 description => $options{'description'},
4618 foreach my $field (qw( authorization_source_code returned_ACI
4619 transaction_identifier validation_code
4620 transaction_sequence_num local_transaction_date
4621 local_transaction_time AVS_result_code )) {
4622 $capture{$field} = $transaction->$field() if $transaction->can($field);
4625 $capture->content( %capture );
4627 $capture->test_transaction(1)
4628 if $conf->exists('business-onlinepayment-test_transaction');
4631 unless ( $capture->is_success ) {
4632 my $e = "Authorization successful but capture failed, custnum #".
4633 $self->custnum. ': '. $capture->result_code.
4634 ": ". $capture->error_message;
4642 # remove paycvv after initial transaction
4645 #false laziness w/misc/process/payment.cgi - check both to make sure working
4647 if ( defined $self->dbdef_table->column('paycvv')
4648 && length($self->paycvv)
4649 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
4651 my $error = $self->remove_cvv;
4653 warn "WARNING: error removing cvv: $error\n";
4662 if ( $transaction->can('card_token') && $transaction->card_token ) {
4664 $self->card_token($transaction->card_token);
4666 if ( $options{'payinfo'} eq $self->payinfo ) {
4667 $self->payinfo($transaction->card_token);
4668 my $error = $self->replace;
4670 warn "WARNING: error storing token: $error, but proceeding anyway\n";
4680 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
4692 if (ref($_[0]) eq 'HASH') {
4693 %options = %{$_[0]};
4695 my ( $method, $amount ) = ( shift, shift );
4697 $options{method} = $method;
4698 $options{amount} = $amount;
4701 if ( $options{'fake_failure'} ) {
4702 return "Error: No error; test failure requested with fake_failure";
4706 #if ( $payment_gateway->gatewaynum ) { # agent override
4707 # $paybatch = $payment_gateway->gatewaynum. '-';
4710 #$paybatch .= "$processor:". $transaction->authorization;
4712 #$paybatch .= ':'. $transaction->order_number
4713 # if $transaction->can('order_number')
4714 # && length($transaction->order_number);
4716 my $paybatch = 'FakeProcessor:54:32';
4718 my $cust_pay = new FS::cust_pay ( {
4719 'custnum' => $self->custnum,
4720 'invnum' => $options{'invnum'},
4721 'paid' => $options{amount},
4723 'payby' => $bop_method2payby{$options{method}},
4724 #'payinfo' => $payinfo,
4725 'payinfo' => '4111111111111111',
4726 'paybatch' => $paybatch,
4727 #'paydate' => $paydate,
4728 'paydate' => '2012-05-01',
4730 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
4732 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4735 $cust_pay->invnum(''); #try again with no specific invnum
4736 my $error2 = $cust_pay->insert( $options{'manual'} ?
4737 ( 'manual' => 1 ) : ()
4740 # gah, even with transactions.
4741 my $e = 'WARNING: Card/ACH debited but database not updated - '.
4742 "error inserting (fake!) payment: $error2".
4743 " (previously tried insert with invnum #$options{'invnum'}" .
4750 if ( $options{'paynum_ref'} ) {
4751 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4754 return ''; #no error
4759 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
4761 # Wraps up processing of a realtime credit card, ACH (electronic check) or
4762 # phone bill transaction.
4764 sub _realtime_bop_result {
4765 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
4767 warn "$me _realtime_bop_result: pending transaction ".
4768 $cust_pay_pending->paypendingnum. "\n";
4769 warn " $_ => $options{$_}\n" foreach keys %options;
4772 my $payment_gateway = $options{payment_gateway}
4773 or return "no payment gateway in arguments to _realtime_bop_result";
4775 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4776 my $cpp_captured_err = $cust_pay_pending->replace;
4777 return $cpp_captured_err if $cpp_captured_err;
4779 if ( $transaction->is_success() ) {
4782 if ( $payment_gateway->gatewaynum ) { # agent override
4783 $paybatch = $payment_gateway->gatewaynum. '-';
4786 $paybatch .= $payment_gateway->gateway_module. ":".
4787 $transaction->authorization;
4789 $paybatch .= ':'. $transaction->order_number
4790 if $transaction->can('order_number')
4791 && length($transaction->order_number);
4793 my $cust_pay = new FS::cust_pay ( {
4794 'custnum' => $self->custnum,
4795 'invnum' => $options{'invnum'},
4796 'paid' => $cust_pay_pending->paid,
4798 'payby' => $cust_pay_pending->payby,
4799 #'payinfo' => $payinfo,
4800 'paybatch' => $paybatch,
4801 'paydate' => $cust_pay_pending->paydate,
4802 'pkgnum' => $cust_pay_pending->pkgnum,
4804 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4805 $cust_pay->payunique( $options{payunique} )
4806 if defined($options{payunique}) && length($options{payunique});
4808 my $oldAutoCommit = $FS::UID::AutoCommit;
4809 local $FS::UID::AutoCommit = 0;
4812 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4814 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4817 $cust_pay->invnum(''); #try again with no specific invnum
4818 my $error2 = $cust_pay->insert( $options{'manual'} ?
4819 ( 'manual' => 1 ) : ()
4822 # gah. but at least we have a record of the state we had to abort in
4823 # from cust_pay_pending now.
4824 my $e = "WARNING: $options{method} captured but payment not recorded -".
4825 " error inserting payment (". $payment_gateway->gateway_module.
4827 " (previously tried insert with invnum #$options{'invnum'}" .
4828 ": $error ) - pending payment saved as paypendingnum ".
4829 $cust_pay_pending->paypendingnum. "\n";
4835 my $jobnum = $cust_pay_pending->jobnum;
4837 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
4839 unless ( $placeholder ) {
4840 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4841 my $e = "WARNING: $options{method} captured but job $jobnum not ".
4842 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
4847 $error = $placeholder->delete;
4850 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4851 my $e = "WARNING: $options{method} captured but could not delete ".
4852 "job $jobnum for paypendingnum ".
4853 $cust_pay_pending->paypendingnum. ": $error\n";
4860 if ( $options{'paynum_ref'} ) {
4861 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4864 $cust_pay_pending->status('done');
4865 $cust_pay_pending->statustext('captured');
4866 $cust_pay_pending->paynum($cust_pay->paynum);
4867 my $cpp_done_err = $cust_pay_pending->replace;
4869 if ( $cpp_done_err ) {
4871 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4872 my $e = "WARNING: $options{method} captured but payment not recorded - ".
4873 "error updating status for paypendingnum ".
4874 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4880 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4882 if ( $options{'apply'} ) {
4883 my $apply_error = $self->apply_payments_and_credits;
4884 if ( $apply_error ) {
4885 warn "WARNING: error applying payment: $apply_error\n";
4886 #but we still should return no error cause the payment otherwise went
4891 return ''; #no error
4897 my $perror = $payment_gateway->gateway_module. " error: ".
4898 $transaction->error_message;
4900 my $jobnum = $cust_pay_pending->jobnum;
4902 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
4904 if ( $placeholder ) {
4905 my $error = $placeholder->depended_delete;
4906 $error ||= $placeholder->delete;
4907 warn "error removing provisioning jobs after declined paypendingnum ".
4908 $cust_pay_pending->paypendingnum. "\n";
4910 my $e = "error finding job $jobnum for declined paypendingnum ".
4911 $cust_pay_pending->paypendingnum. "\n";
4917 unless ( $transaction->error_message ) {
4920 if ( $transaction->can('response_page') ) {
4922 'page' => ( $transaction->can('response_page')
4923 ? $transaction->response_page
4926 'code' => ( $transaction->can('response_code')
4927 ? $transaction->response_code
4930 'headers' => ( $transaction->can('response_headers')
4931 ? $transaction->response_headers
4937 "No additional debugging information available for ".
4938 $payment_gateway->gateway_module;
4941 $perror .= "No error_message returned from ".
4942 $payment_gateway->gateway_module. " -- ".
4943 ( ref($t_response) ? Dumper($t_response) : $t_response );
4947 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4948 && $conf->exists('emaildecline')
4949 && grep { $_ ne 'POST' } $self->invoicing_list
4950 && ! grep { $transaction->error_message =~ /$_/ }
4951 $conf->config('emaildecline-exclude')
4953 my @templ = $conf->config('declinetemplate');
4954 my $template = new Text::Template (
4956 SOURCE => [ map "$_\n", @templ ],
4957 ) or return "($perror) can't create template: $Text::Template::ERROR";
4958 $template->compile()
4959 or return "($perror) can't compile template: $Text::Template::ERROR";
4963 scalar( $conf->config('company_name', $self->agentnum ) ),
4964 'company_address' =>
4965 join("\n", $conf->config('company_address', $self->agentnum ) ),
4966 'error' => $transaction->error_message,
4969 my $error = send_email(
4970 'from' => $conf->config('invoice_from', $self->agentnum ),
4971 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4972 'subject' => 'Your payment could not be processed',
4973 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4976 $perror .= " (also received error sending decline notification: $error)"
4981 $cust_pay_pending->status('done');
4982 $cust_pay_pending->statustext("declined: $perror");
4983 my $cpp_done_err = $cust_pay_pending->replace;
4984 if ( $cpp_done_err ) {
4985 my $e = "WARNING: $options{method} declined but pending payment not ".
4986 "resolved - error updating status for paypendingnum ".
4987 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4989 $perror = "$e ($perror)";
4997 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
4999 Verifies successful third party processing of a realtime credit card,
5000 ACH (electronic check) or phone bill transaction via a
5001 Business::OnlineThirdPartyPayment realtime gateway. See
5002 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5004 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5006 The additional options I<payname>, I<city>, I<state>,
5007 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5008 if set, will override the value from the customer record.
5010 I<description> is a free-text field passed to the gateway. It defaults to
5011 "Internet services".
5013 If an I<invnum> is specified, this payment (if successful) is applied to the
5014 specified invoice. If you don't specify an I<invnum> you might want to
5015 call the B<apply_payments> method.
5017 I<quiet> can be set true to surpress email decline notices.
5019 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5020 resulting paynum, if any.
5022 I<payunique> is a unique identifier for this payment.
5024 Returns a hashref containing elements bill_error (which will be undefined
5025 upon success) and session_id of any associated session.
5029 sub realtime_botpp_capture {
5030 my( $self, $cust_pay_pending, %options ) = @_;
5032 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5033 warn " $_ => $options{$_}\n" foreach keys %options;
5036 eval "use Business::OnlineThirdPartyPayment";
5040 # select the gateway
5043 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5045 my $payment_gateway = $cust_pay_pending->gatewaynum
5046 ? qsearchs( 'payment_gateway',
5047 { gatewaynum => $cust_pay_pending->gatewaynum }
5049 : $self->agent->payment_gateway( 'method' => $method,
5050 # 'invnum' => $cust_pay_pending->invnum,
5051 # 'payinfo' => $cust_pay_pending->payinfo,
5054 $options{payment_gateway} = $payment_gateway; # for the helper subs
5060 my @invoicing_list = $self->invoicing_list_emailonly;
5061 if ( $conf->exists('emailinvoiceautoalways')
5062 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5063 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5064 push @invoicing_list, $self->all_emails;
5067 my $email = ($conf->exists('business-onlinepayment-email-override'))
5068 ? $conf->config('business-onlinepayment-email-override')
5069 : $invoicing_list[0];
5073 $content{email_customer} =
5074 ( $conf->exists('business-onlinepayment-email_customer')
5075 || $conf->exists('business-onlinepayment-email-override') );
5078 # run transaction(s)
5082 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5083 $self->_bop_options(\%options),
5086 $transaction->reference({ %options });
5088 $transaction->content(
5090 $self->_bop_auth(\%options),
5091 'action' => 'Post Authorization',
5092 'description' => $options{'description'},
5093 'amount' => $cust_pay_pending->paid,
5094 #'invoice_number' => $options{'invnum'},
5095 'customer_id' => $self->custnum,
5096 'referer' => 'http://cleanwhisker.420.am/',
5097 'reference' => $cust_pay_pending->paypendingnum,
5099 'phone' => $self->daytime || $self->night,
5101 # plus whatever is required for bogus capture avoidance
5104 $transaction->submit();
5107 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5110 bill_error => $error,
5111 session_id => $cust_pay_pending->session_id,
5116 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5120 sub default_payment_gateway {
5121 my( $self, $method ) = @_;
5123 die "Real-time processing not enabled\n"
5124 unless $conf->exists('business-onlinepayment');
5126 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5129 my $bop_config = 'business-onlinepayment';
5130 $bop_config .= '-ach'
5131 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5132 my ( $processor, $login, $password, $action, @bop_options ) =
5133 $conf->config($bop_config);
5134 $action ||= 'normal authorization';
5135 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5136 die "No real-time processor is enabled - ".
5137 "did you set the business-onlinepayment configuration value?\n"
5140 ( $processor, $login, $password, $action, @bop_options )
5145 Removes the I<paycvv> field from the database directly.
5147 If there is an error, returns the error, otherwise returns false.
5153 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5154 or return dbh->errstr;
5155 $sth->execute($self->custnum)
5156 or return $sth->errstr;
5161 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5163 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5164 via a Business::OnlinePayment realtime gateway. See
5165 L<http://420.am/business-onlinepayment> for supported gateways.
5167 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5169 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5171 Most gateways require a reference to an original payment transaction to refund,
5172 so you probably need to specify a I<paynum>.
5174 I<amount> defaults to the original amount of the payment if not specified.
5176 I<reason> specifies a reason for the refund.
5178 I<paydate> specifies the expiration date for a credit card overriding the
5179 value from the customer record or the payment record. Specified as yyyy-mm-dd
5181 Implementation note: If I<amount> is unspecified or equal to the amount of the
5182 orignal payment, first an attempt is made to "void" the transaction via
5183 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5184 the normal attempt is made to "refund" ("credit") the transaction via the
5185 gateway is attempted.
5187 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5188 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5189 #if set, will override the value from the customer record.
5191 #If an I<invnum> is specified, this payment (if successful) is applied to the
5192 #specified invoice. If you don't specify an I<invnum> you might want to
5193 #call the B<apply_payments> method.
5197 #some false laziness w/realtime_bop, not enough to make it worth merging
5198 #but some useful small subs should be pulled out
5199 sub realtime_refund_bop {
5203 if (ref($_[0]) ne 'HASH') {
5204 %options = %{$_[0]};
5208 $options{method} = $method;
5212 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5213 warn " $_ => $options{$_}\n" foreach keys %options;
5217 # look up the original payment and optionally a gateway for that payment
5221 my $amount = $options{'amount'};
5223 my( $processor, $login, $password, @bop_options, $namespace ) ;
5224 my( $auth, $order_number ) = ( '', '', '' );
5226 if ( $options{'paynum'} ) {
5228 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5229 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5230 or return "Unknown paynum $options{'paynum'}";
5231 $amount ||= $cust_pay->paid;
5233 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5234 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5235 $cust_pay->paybatch;
5236 my $gatewaynum = '';
5237 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5239 if ( $gatewaynum ) { #gateway for the payment to be refunded
5241 my $payment_gateway =
5242 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5243 die "payment gateway $gatewaynum not found"
5244 unless $payment_gateway;
5246 $processor = $payment_gateway->gateway_module;
5247 $login = $payment_gateway->gateway_username;
5248 $password = $payment_gateway->gateway_password;
5249 $namespace = $payment_gateway->gateway_namespace;
5250 @bop_options = $payment_gateway->options;
5252 } else { #try the default gateway
5255 my $payment_gateway =
5256 $self->agent->payment_gateway('method' => $options{method});
5258 ( $conf_processor, $login, $password, $namespace ) =
5259 map { my $method = "gateway_$_"; $payment_gateway->$method }
5260 qw( module username password namespace );
5262 @bop_options = $payment_gateway->gatewaynum
5263 ? $payment_gateway->options
5264 : @{ $payment_gateway->get('options') };
5266 return "processor of payment $options{'paynum'} $processor does not".
5267 " match default processor $conf_processor"
5268 unless $processor eq $conf_processor;
5273 } else { # didn't specify a paynum, so look for agent gateway overrides
5274 # like a normal transaction
5276 my $payment_gateway =
5277 $self->agent->payment_gateway( 'method' => $options{method},
5278 #'payinfo' => $payinfo,
5280 my( $processor, $login, $password, $namespace ) =
5281 map { my $method = "gateway_$_"; $payment_gateway->$method }
5282 qw( module username password namespace );
5284 my @bop_options = $payment_gateway->gatewaynum
5285 ? $payment_gateway->options
5286 : @{ $payment_gateway->get('options') };
5289 return "neither amount nor paynum specified" unless $amount;
5291 eval "use $namespace";
5295 'type' => $options{method},
5297 'password' => $password,
5298 'order_number' => $order_number,
5299 'amount' => $amount,
5300 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5302 $content{authorization} = $auth
5303 if length($auth); #echeck/ACH transactions have an order # but no auth
5304 #(at least with authorize.net)
5306 my $disable_void_after;
5307 if ($conf->exists('disable_void_after')
5308 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5309 $disable_void_after = $1;
5312 #first try void if applicable
5313 if ( $cust_pay && $cust_pay->paid == $amount
5315 ( not defined($disable_void_after) )
5316 || ( time < ($cust_pay->_date + $disable_void_after ) )
5319 warn " attempting void\n" if $DEBUG > 1;
5320 my $void = new Business::OnlinePayment( $processor, @bop_options );
5321 if ( $void->can('info') ) {
5322 if ( $cust_pay->payby eq 'CARD'
5323 && $void->info('CC_void_requires_card') )
5325 $content{'card_number'} = $cust_pay->payinfo;
5326 } elsif ( $cust_pay->payby eq 'CHEK'
5327 && $void->info('ECHECK_void_requires_account') )
5329 ( $content{'account_number'}, $content{'routing_code'} ) =
5330 split('@', $cust_pay->payinfo);
5331 $content{'name'} = $self->get('first'). ' '. $self->get('last');
5334 $void->content( 'action' => 'void', %content );
5335 $void->test_transaction(1)
5336 if $conf->exists('business-onlinepayment-test_transaction');
5338 if ( $void->is_success ) {
5339 my $error = $cust_pay->void($options{'reason'});
5341 # gah, even with transactions.
5342 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5343 "error voiding payment: $error";
5347 warn " void successful\n" if $DEBUG > 1;
5352 warn " void unsuccessful, trying refund\n"
5356 my $address = $self->address1;
5357 $address .= ", ". $self->address2 if $self->address2;
5359 my($payname, $payfirst, $paylast);
5360 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5361 $payname = $self->payname;
5362 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5363 or return "Illegal payname $payname";
5364 ($payfirst, $paylast) = ($1, $2);
5366 $payfirst = $self->getfield('first');
5367 $paylast = $self->getfield('last');
5368 $payname = "$payfirst $paylast";
5371 my @invoicing_list = $self->invoicing_list_emailonly;
5372 if ( $conf->exists('emailinvoiceautoalways')
5373 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5374 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5375 push @invoicing_list, $self->all_emails;
5378 my $email = ($conf->exists('business-onlinepayment-email-override'))
5379 ? $conf->config('business-onlinepayment-email-override')
5380 : $invoicing_list[0];
5382 my $payip = exists($options{'payip'})
5385 $content{customer_ip} = $payip
5389 if ( $options{method} eq 'CC' ) {
5392 $content{card_number} = $payinfo = $cust_pay->payinfo;
5393 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5394 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5395 ($content{expiration} = "$2/$1"); # where available
5397 $content{card_number} = $payinfo = $self->payinfo;
5398 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5399 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5400 $content{expiration} = "$2/$1";
5403 } elsif ( $options{method} eq 'ECHECK' ) {
5406 $payinfo = $cust_pay->payinfo;
5408 $payinfo = $self->payinfo;
5410 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5411 $content{bank_name} = $self->payname;
5412 $content{account_type} = 'CHECKING';
5413 $content{account_name} = $payname;
5414 $content{customer_org} = $self->company ? 'B' : 'I';
5415 $content{customer_ssn} = $self->ss;
5416 } elsif ( $options{method} eq 'LEC' ) {
5417 $content{phone} = $payinfo = $self->payinfo;
5421 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5422 my %sub_content = $refund->content(
5423 'action' => 'credit',
5424 'customer_id' => $self->custnum,
5425 'last_name' => $paylast,
5426 'first_name' => $payfirst,
5428 'address' => $address,
5429 'city' => $self->city,
5430 'state' => $self->state,
5431 'zip' => $self->zip,
5432 'country' => $self->country,
5434 'phone' => $self->daytime || $self->night,
5437 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5439 $refund->test_transaction(1)
5440 if $conf->exists('business-onlinepayment-test_transaction');
5443 return "$processor error: ". $refund->error_message
5444 unless $refund->is_success();
5446 my $paybatch = "$processor:". $refund->authorization;
5447 $paybatch .= ':'. $refund->order_number
5448 if $refund->can('order_number') && $refund->order_number;
5450 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5451 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5452 last unless @cust_bill_pay;
5453 my $cust_bill_pay = pop @cust_bill_pay;
5454 my $error = $cust_bill_pay->delete;
5458 my $cust_refund = new FS::cust_refund ( {
5459 'custnum' => $self->custnum,
5460 'paynum' => $options{'paynum'},
5461 'refund' => $amount,
5463 'payby' => $bop_method2payby{$options{method}},
5464 'payinfo' => $payinfo,
5465 'paybatch' => $paybatch,
5466 'reason' => $options{'reason'} || 'card or ACH refund',
5468 my $error = $cust_refund->insert;
5470 $cust_refund->paynum(''); #try again with no specific paynum
5471 my $error2 = $cust_refund->insert;
5473 # gah, even with transactions.
5474 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5475 "error inserting refund ($processor): $error2".
5476 " (previously tried insert with paynum #$options{'paynum'}" .
5487 =item batch_card OPTION => VALUE...
5489 Adds a payment for this invoice to the pending credit card batch (see
5490 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5491 runs the payment using a realtime gateway.
5496 my ($self, %options) = @_;
5499 if (exists($options{amount})) {
5500 $amount = $options{amount};
5502 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5504 return '' unless $amount > 0;
5506 my $invnum = delete $options{invnum};
5507 my $payby = $options{invnum} || $self->payby; #dubious
5509 if ($options{'realtime'}) {
5510 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5516 my $oldAutoCommit = $FS::UID::AutoCommit;
5517 local $FS::UID::AutoCommit = 0;
5520 #this needs to handle mysql as well as Pg, like svc_acct.pm
5521 #(make it into a common function if folks need to do batching with mysql)
5522 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5523 or return "Cannot lock pay_batch: " . $dbh->errstr;
5527 'payby' => FS::payby->payby2payment($payby),
5530 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5532 unless ( $pay_batch ) {
5533 $pay_batch = new FS::pay_batch \%pay_batch;
5534 my $error = $pay_batch->insert;
5536 $dbh->rollback if $oldAutoCommit;
5537 die "error creating new batch: $error\n";
5541 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5542 'batchnum' => $pay_batch->batchnum,
5543 'custnum' => $self->custnum,
5546 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5548 $options{$_} = '' unless exists($options{$_});
5551 my $cust_pay_batch = new FS::cust_pay_batch ( {
5552 'batchnum' => $pay_batch->batchnum,
5553 'invnum' => $invnum || 0, # is there a better value?
5554 # this field should be
5556 # cust_bill_pay_batch now
5557 'custnum' => $self->custnum,
5558 'last' => $self->getfield('last'),
5559 'first' => $self->getfield('first'),
5560 'address1' => $options{address1} || $self->address1,
5561 'address2' => $options{address2} || $self->address2,
5562 'city' => $options{city} || $self->city,
5563 'state' => $options{state} || $self->state,
5564 'zip' => $options{zip} || $self->zip,
5565 'country' => $options{country} || $self->country,
5566 'payby' => $options{payby} || $self->payby,
5567 'payinfo' => $options{payinfo} || $self->payinfo,
5568 'exp' => $options{paydate} || $self->paydate,
5569 'payname' => $options{payname} || $self->payname,
5570 'amount' => $amount, # consolidating
5573 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5574 if $old_cust_pay_batch;
5577 if ($old_cust_pay_batch) {
5578 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5580 $error = $cust_pay_batch->insert;
5584 $dbh->rollback if $oldAutoCommit;
5588 my $unapplied = $self->total_unapplied_credits
5589 + $self->total_unapplied_payments
5590 + $self->in_transit_payments;
5591 foreach my $cust_bill ($self->open_cust_bill) {
5592 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5593 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5594 'invnum' => $cust_bill->invnum,
5595 'paybatchnum' => $cust_pay_batch->paybatchnum,
5596 'amount' => $cust_bill->owed,
5599 if ($unapplied >= $cust_bill_pay_batch->amount){
5600 $unapplied -= $cust_bill_pay_batch->amount;
5603 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5604 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
5606 $error = $cust_bill_pay_batch->insert;
5608 $dbh->rollback if $oldAutoCommit;
5613 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5617 =item apply_payments_and_credits [ OPTION => VALUE ... ]
5619 Applies unapplied payments and credits.
5621 In most cases, this new method should be used in place of sequential
5622 apply_payments and apply_credits methods.
5624 A hash of optional arguments may be passed. Currently "manual" is supported.
5625 If true, a payment receipt is sent instead of a statement when
5626 'payment_receipt_email' configuration option is set.
5628 If there is an error, returns the error, otherwise returns false.
5632 sub apply_payments_and_credits {
5633 my( $self, %options ) = @_;
5635 local $SIG{HUP} = 'IGNORE';
5636 local $SIG{INT} = 'IGNORE';
5637 local $SIG{QUIT} = 'IGNORE';
5638 local $SIG{TERM} = 'IGNORE';
5639 local $SIG{TSTP} = 'IGNORE';
5640 local $SIG{PIPE} = 'IGNORE';
5642 my $oldAutoCommit = $FS::UID::AutoCommit;
5643 local $FS::UID::AutoCommit = 0;
5646 $self->select_for_update; #mutex
5648 foreach my $cust_bill ( $self->open_cust_bill ) {
5649 my $error = $cust_bill->apply_payments_and_credits(%options);
5651 $dbh->rollback if $oldAutoCommit;
5652 return "Error applying: $error";
5656 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5661 =item apply_credits OPTION => VALUE ...
5663 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
5664 to outstanding invoice balances in chronological order (or reverse
5665 chronological order if the I<order> option is set to B<newest>) and returns the
5666 value of any remaining unapplied credits available for refund (see
5667 L<FS::cust_refund>).
5669 Dies if there is an error.
5677 local $SIG{HUP} = 'IGNORE';
5678 local $SIG{INT} = 'IGNORE';
5679 local $SIG{QUIT} = 'IGNORE';
5680 local $SIG{TERM} = 'IGNORE';
5681 local $SIG{TSTP} = 'IGNORE';
5682 local $SIG{PIPE} = 'IGNORE';
5684 my $oldAutoCommit = $FS::UID::AutoCommit;
5685 local $FS::UID::AutoCommit = 0;
5688 $self->select_for_update; #mutex
5690 unless ( $self->total_unapplied_credits ) {
5691 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5695 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
5696 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
5698 my @invoices = $self->open_cust_bill;
5699 @invoices = sort { $b->_date <=> $a->_date } @invoices
5700 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
5702 if ( $conf->exists('pkg-balances') ) {
5703 # limit @credits to those w/ a pkgnum grepped from $self
5705 foreach my $i (@invoices) {
5706 foreach my $li ( $i->cust_bill_pkg ) {
5707 $pkgnums{$li->pkgnum} = 1;
5710 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
5715 foreach my $cust_bill ( @invoices ) {
5717 if ( !defined($credit) || $credit->credited == 0) {
5718 $credit = pop @credits or last;
5722 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
5723 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
5725 $owed = $cust_bill->owed;
5727 unless ( $owed > 0 ) {
5728 push @credits, $credit;
5732 my $amount = min( $credit->credited, $owed );
5734 my $cust_credit_bill = new FS::cust_credit_bill ( {
5735 'crednum' => $credit->crednum,
5736 'invnum' => $cust_bill->invnum,
5737 'amount' => $amount,
5739 $cust_credit_bill->pkgnum( $credit->pkgnum )
5740 if $conf->exists('pkg-balances') && $credit->pkgnum;
5741 my $error = $cust_credit_bill->insert;
5743 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5747 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
5751 my $total_unapplied_credits = $self->total_unapplied_credits;
5753 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5755 return $total_unapplied_credits;
5758 =item apply_payments [ OPTION => VALUE ... ]
5760 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
5761 to outstanding invoice balances in chronological order.
5763 #and returns the value of any remaining unapplied payments.
5765 A hash of optional arguments may be passed. Currently "manual" is supported.
5766 If true, a payment receipt is sent instead of a statement when
5767 'payment_receipt_email' configuration option is set.
5769 Dies if there is an error.
5773 sub apply_payments {
5774 my( $self, %options ) = @_;
5776 local $SIG{HUP} = 'IGNORE';
5777 local $SIG{INT} = 'IGNORE';
5778 local $SIG{QUIT} = 'IGNORE';
5779 local $SIG{TERM} = 'IGNORE';
5780 local $SIG{TSTP} = 'IGNORE';
5781 local $SIG{PIPE} = 'IGNORE';
5783 my $oldAutoCommit = $FS::UID::AutoCommit;
5784 local $FS::UID::AutoCommit = 0;
5787 $self->select_for_update; #mutex
5791 my @payments = sort { $b->_date <=> $a->_date }
5792 grep { $_->unapplied > 0 }
5795 my @invoices = sort { $a->_date <=> $b->_date}
5796 grep { $_->owed > 0 }
5799 if ( $conf->exists('pkg-balances') ) {
5800 # limit @payments to those w/ a pkgnum grepped from $self
5802 foreach my $i (@invoices) {
5803 foreach my $li ( $i->cust_bill_pkg ) {
5804 $pkgnums{$li->pkgnum} = 1;
5807 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
5812 foreach my $cust_bill ( @invoices ) {
5814 if ( !defined($payment) || $payment->unapplied == 0 ) {
5815 $payment = pop @payments or last;
5819 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
5820 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
5822 $owed = $cust_bill->owed;
5824 unless ( $owed > 0 ) {
5825 push @payments, $payment;
5829 my $amount = min( $payment->unapplied, $owed );
5831 my $cust_bill_pay = new FS::cust_bill_pay ( {
5832 'paynum' => $payment->paynum,
5833 'invnum' => $cust_bill->invnum,
5834 'amount' => $amount,
5836 $cust_bill_pay->pkgnum( $payment->pkgnum )
5837 if $conf->exists('pkg-balances') && $payment->pkgnum;
5838 my $error = $cust_bill_pay->insert(%options);
5840 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5844 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
5848 my $total_unapplied_payments = $self->total_unapplied_payments;
5850 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5852 return $total_unapplied_payments;
5857 Returns the total owed for this customer on all invoices
5858 (see L<FS::cust_bill/owed>).
5864 $self->total_owed_date(2145859200); #12/31/2037
5867 =item total_owed_date TIME
5869 Returns the total owed for this customer on all invoices with date earlier than
5870 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
5871 see L<Time::Local> and L<Date::Parse> for conversion functions.
5875 sub total_owed_date {
5879 # my $custnum = $self->custnum;
5881 # my $owed_sql = FS::cust_bill->owed_sql;
5884 # SELECT SUM($owed_sql) FROM cust_bill
5885 # WHERE custnum = $custnum
5886 # AND _date <= $time
5889 # my $sth = dbh->prepare($sql) or die dbh->errstr;
5890 # $sth->execute() or die $sth->errstr;
5892 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
5895 foreach my $cust_bill (
5896 grep { $_->_date <= $time }
5897 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
5899 $total_bill += $cust_bill->owed;
5901 sprintf( "%.2f", $total_bill );
5905 =item total_owed_pkgnum PKGNUM
5907 Returns the total owed on all invoices for this customer's specific package
5908 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
5912 sub total_owed_pkgnum {
5913 my( $self, $pkgnum ) = @_;
5914 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
5917 =item total_owed_date_pkgnum TIME PKGNUM
5919 Returns the total owed for this customer's specific package when using
5920 experimental package balances on all invoices with date earlier than
5921 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
5922 see L<Time::Local> and L<Date::Parse> for conversion functions.
5926 sub total_owed_date_pkgnum {
5927 my( $self, $time, $pkgnum ) = @_;
5930 foreach my $cust_bill (
5931 grep { $_->_date <= $time }
5932 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
5934 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
5936 sprintf( "%.2f", $total_bill );
5942 Returns the total amount of all payments.
5949 $total += $_->paid foreach $self->cust_pay;
5950 sprintf( "%.2f", $total );
5953 =item total_unapplied_credits
5955 Returns the total outstanding credit (see L<FS::cust_credit>) for this
5956 customer. See L<FS::cust_credit/credited>.
5958 =item total_credited
5960 Old name for total_unapplied_credits. Don't use.
5964 sub total_credited {
5965 #carp "total_credited deprecated, use total_unapplied_credits";
5966 shift->total_unapplied_credits(@_);
5969 sub total_unapplied_credits {
5971 my $total_credit = 0;
5972 $total_credit += $_->credited foreach $self->cust_credit;
5973 sprintf( "%.2f", $total_credit );
5976 =item total_unapplied_credits_pkgnum PKGNUM
5978 Returns the total outstanding credit (see L<FS::cust_credit>) for this
5979 customer. See L<FS::cust_credit/credited>.
5983 sub total_unapplied_credits_pkgnum {
5984 my( $self, $pkgnum ) = @_;
5985 my $total_credit = 0;
5986 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
5987 sprintf( "%.2f", $total_credit );
5991 =item total_unapplied_payments
5993 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
5994 See L<FS::cust_pay/unapplied>.
5998 sub total_unapplied_payments {
6000 my $total_unapplied = 0;
6001 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6002 sprintf( "%.2f", $total_unapplied );
6005 =item total_unapplied_payments_pkgnum PKGNUM
6007 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6008 specific package when using experimental package balances. See
6009 L<FS::cust_pay/unapplied>.
6013 sub total_unapplied_payments_pkgnum {
6014 my( $self, $pkgnum ) = @_;
6015 my $total_unapplied = 0;
6016 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6017 sprintf( "%.2f", $total_unapplied );
6021 =item total_unapplied_refunds
6023 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6024 customer. See L<FS::cust_refund/unapplied>.
6028 sub total_unapplied_refunds {
6030 my $total_unapplied = 0;
6031 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6032 sprintf( "%.2f", $total_unapplied );
6037 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6038 total_unapplied_credits minus total_unapplied_payments).
6046 + $self->total_unapplied_refunds
6047 - $self->total_unapplied_credits
6048 - $self->total_unapplied_payments
6052 =item balance_date TIME
6054 Returns the balance for this customer, only considering invoices with date
6055 earlier than TIME (total_owed_date minus total_credited minus
6056 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6057 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6066 $self->total_owed_date($time)
6067 + $self->total_unapplied_refunds
6068 - $self->total_unapplied_credits
6069 - $self->total_unapplied_payments
6073 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
6075 Returns the balance for this customer, only considering invoices with date
6076 earlier than START_TIME, and optionally not later than END_TIME
6077 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6079 Times are specified as SQL fragments or numeric
6080 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
6081 L<Date::Parse> for conversion functions. The empty string can be passed
6082 to disable that time constraint completely.
6084 Available options are:
6088 =item unapplied_date
6090 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
6096 sub balance_date_range {
6098 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6099 ') FROM cust_main WHERE custnum='. $self->custnum;
6100 sprintf( "%.2f", $self->scalar_sql($sql) );
6103 =item balance_pkgnum PKGNUM
6105 Returns the balance for this customer's specific package when using
6106 experimental package balances (total_owed plus total_unrefunded, minus
6107 total_unapplied_credits minus total_unapplied_payments)
6111 sub balance_pkgnum {
6112 my( $self, $pkgnum ) = @_;
6115 $self->total_owed_pkgnum($pkgnum)
6116 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6117 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6118 - $self->total_unapplied_credits_pkgnum($pkgnum)
6119 - $self->total_unapplied_payments_pkgnum($pkgnum)
6123 =item in_transit_payments
6125 Returns the total of requests for payments for this customer pending in
6126 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6130 sub in_transit_payments {
6132 my $in_transit_payments = 0;
6133 foreach my $pay_batch ( qsearch('pay_batch', {
6136 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6137 'batchnum' => $pay_batch->batchnum,
6138 'custnum' => $self->custnum,
6140 $in_transit_payments += $cust_pay_batch->amount;
6143 sprintf( "%.2f", $in_transit_payments );
6148 Returns a hash of useful information for making a payment.
6158 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6159 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6160 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6164 For credit card transactions:
6176 For electronic check transactions:
6191 $return{balance} = $self->balance;
6193 $return{payname} = $self->payname
6194 || ( $self->first. ' '. $self->get('last') );
6196 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6198 $return{payby} = $self->payby;
6199 $return{stateid_state} = $self->stateid_state;
6201 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6202 $return{card_type} = cardtype($self->payinfo);
6203 $return{payinfo} = $self->paymask;
6205 @return{'month', 'year'} = $self->paydate_monthyear;
6209 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6210 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6211 $return{payinfo1} = $payinfo1;
6212 $return{payinfo2} = $payinfo2;
6213 $return{paytype} = $self->paytype;
6214 $return{paystate} = $self->paystate;
6218 #doubleclick protection
6220 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6226 =item paydate_monthyear
6228 Returns a two-element list consisting of the month and year of this customer's
6229 paydate (credit card expiration date for CARD customers)
6233 sub paydate_monthyear {
6235 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6237 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6244 =item tax_exemption TAXNAME
6249 my( $self, $taxname ) = @_;
6251 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6252 'taxname' => $taxname,
6257 =item cust_main_exemption
6261 sub cust_main_exemption {
6263 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6266 =item invoicing_list [ ARRAYREF ]
6268 If an arguement is given, sets these email addresses as invoice recipients
6269 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6270 (except as warnings), so use check_invoicing_list first.
6272 Returns a list of email addresses (with svcnum entries expanded).
6274 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6275 check it without disturbing anything by passing nothing.
6277 This interface may change in the future.
6281 sub invoicing_list {
6282 my( $self, $arrayref ) = @_;
6285 my @cust_main_invoice;
6286 if ( $self->custnum ) {
6287 @cust_main_invoice =
6288 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6290 @cust_main_invoice = ();
6292 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6293 #warn $cust_main_invoice->destnum;
6294 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6295 #warn $cust_main_invoice->destnum;
6296 my $error = $cust_main_invoice->delete;
6297 warn $error if $error;
6300 if ( $self->custnum ) {
6301 @cust_main_invoice =
6302 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6304 @cust_main_invoice = ();
6306 my %seen = map { $_->address => 1 } @cust_main_invoice;
6307 foreach my $address ( @{$arrayref} ) {
6308 next if exists $seen{$address} && $seen{$address};
6309 $seen{$address} = 1;
6310 my $cust_main_invoice = new FS::cust_main_invoice ( {
6311 'custnum' => $self->custnum,
6314 my $error = $cust_main_invoice->insert;
6315 warn $error if $error;
6319 if ( $self->custnum ) {
6321 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6328 =item check_invoicing_list ARRAYREF
6330 Checks these arguements as valid input for the invoicing_list method. If there
6331 is an error, returns the error, otherwise returns false.
6335 sub check_invoicing_list {
6336 my( $self, $arrayref ) = @_;
6338 foreach my $address ( @$arrayref ) {
6340 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6341 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6344 my $cust_main_invoice = new FS::cust_main_invoice ( {
6345 'custnum' => $self->custnum,
6348 my $error = $self->custnum
6349 ? $cust_main_invoice->check
6350 : $cust_main_invoice->checkdest
6352 return $error if $error;
6356 return "Email address required"
6357 if $conf->exists('cust_main-require_invoicing_list_email')
6358 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6363 =item set_default_invoicing_list
6365 Sets the invoicing list to all accounts associated with this customer,
6366 overwriting any previous invoicing list.
6370 sub set_default_invoicing_list {
6372 $self->invoicing_list($self->all_emails);
6377 Returns the email addresses of all accounts provisioned for this customer.
6384 foreach my $cust_pkg ( $self->all_pkgs ) {
6385 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6387 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6388 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6390 $list{$_}=1 foreach map { $_->email } @svc_acct;
6395 =item invoicing_list_addpost
6397 Adds postal invoicing to this customer. If this customer is already configured
6398 to receive postal invoices, does nothing.
6402 sub invoicing_list_addpost {
6404 return if grep { $_ eq 'POST' } $self->invoicing_list;
6405 my @invoicing_list = $self->invoicing_list;
6406 push @invoicing_list, 'POST';
6407 $self->invoicing_list(\@invoicing_list);
6410 =item invoicing_list_emailonly
6412 Returns the list of email invoice recipients (invoicing_list without non-email
6413 destinations such as POST and FAX).
6417 sub invoicing_list_emailonly {
6419 warn "$me invoicing_list_emailonly called"
6421 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6424 =item invoicing_list_emailonly_scalar
6426 Returns the list of email invoice recipients (invoicing_list without non-email
6427 destinations such as POST and FAX) as a comma-separated scalar.
6431 sub invoicing_list_emailonly_scalar {
6433 warn "$me invoicing_list_emailonly_scalar called"
6435 join(', ', $self->invoicing_list_emailonly);
6438 =item referral_custnum_cust_main
6440 Returns the customer who referred this customer (or the empty string, if
6441 this customer was not referred).
6443 Note the difference with referral_cust_main method: This method,
6444 referral_custnum_cust_main returns the single customer (if any) who referred
6445 this customer, while referral_cust_main returns an array of customers referred
6450 sub referral_custnum_cust_main {
6452 return '' unless $self->referral_custnum;
6453 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6456 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6458 Returns an array of customers referred by this customer (referral_custnum set
6459 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6460 customers referred by customers referred by this customer and so on, inclusive.
6461 The default behavior is DEPTH 1 (no recursion).
6463 Note the difference with referral_custnum_cust_main method: This method,
6464 referral_cust_main, returns an array of customers referred BY this customer,
6465 while referral_custnum_cust_main returns the single customer (if any) who
6466 referred this customer.
6470 sub referral_cust_main {
6472 my $depth = @_ ? shift : 1;
6473 my $exclude = @_ ? shift : {};
6476 map { $exclude->{$_->custnum}++; $_; }
6477 grep { ! $exclude->{ $_->custnum } }
6478 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6482 map { $_->referral_cust_main($depth-1, $exclude) }
6489 =item referral_cust_main_ncancelled
6491 Same as referral_cust_main, except only returns customers with uncancelled
6496 sub referral_cust_main_ncancelled {
6498 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6501 =item referral_cust_pkg [ DEPTH ]
6503 Like referral_cust_main, except returns a flat list of all unsuspended (and
6504 uncancelled) packages for each customer. The number of items in this list may
6505 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6509 sub referral_cust_pkg {
6511 my $depth = @_ ? shift : 1;
6513 map { $_->unsuspended_pkgs }
6514 grep { $_->unsuspended_pkgs }
6515 $self->referral_cust_main($depth);
6518 =item referring_cust_main
6520 Returns the single cust_main record for the customer who referred this customer
6521 (referral_custnum), or false.
6525 sub referring_cust_main {
6527 return '' unless $self->referral_custnum;
6528 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6531 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6533 Applies a credit to this customer. If there is an error, returns the error,
6534 otherwise returns false.
6536 REASON can be a text string, an FS::reason object, or a scalar reference to
6537 a reasonnum. If a text string, it will be automatically inserted as a new
6538 reason, and a 'reason_type' option must be passed to indicate the
6539 FS::reason_type for the new reason.
6541 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6543 Any other options are passed to FS::cust_credit::insert.
6548 my( $self, $amount, $reason, %options ) = @_;
6550 my $cust_credit = new FS::cust_credit {
6551 'custnum' => $self->custnum,
6552 'amount' => $amount,
6555 if ( ref($reason) ) {
6557 if ( ref($reason) eq 'SCALAR' ) {
6558 $cust_credit->reasonnum( $$reason );
6560 $cust_credit->reasonnum( $reason->reasonnum );
6564 $cust_credit->set('reason', $reason)
6567 for (qw( addlinfo eventnum )) {
6568 $cust_credit->$_( delete $options{$_} )
6569 if exists($options{$_});
6572 $cust_credit->insert(%options);
6576 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6578 Creates a one-time charge for this customer. If there is an error, returns
6579 the error, otherwise returns false.
6581 New-style, with a hashref of options:
6583 my $error = $cust_main->charge(
6587 'start_date' => str2time('7/4/2009'),
6588 'pkg' => 'Description',
6589 'comment' => 'Comment',
6590 'additional' => [], #extra invoice detail
6591 'classnum' => 1, #pkg_class
6593 'setuptax' => '', # or 'Y' for tax exempt
6596 'taxclass' => 'Tax class',
6599 'taxproduct' => 2, #part_pkg_taxproduct
6600 'override' => {}, #XXX describe
6602 #will be filled in with the new object
6603 'cust_pkg_ref' => \$cust_pkg,
6605 #generate an invoice immediately
6607 'invoice_terms' => '', #with these terms
6613 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6619 my ( $amount, $quantity, $start_date, $classnum );
6620 my ( $pkg, $comment, $additional );
6621 my ( $setuptax, $taxclass ); #internal taxes
6622 my ( $taxproduct, $override ); #vendor (CCH) taxes
6624 my $cust_pkg_ref = '';
6625 my ( $bill_now, $invoice_terms ) = ( 0, '' );
6626 if ( ref( $_[0] ) ) {
6627 $amount = $_[0]->{amount};
6628 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6629 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6630 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
6631 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6632 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6633 : '$'. sprintf("%.2f",$amount);
6634 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6635 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6636 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6637 $additional = $_[0]->{additional} || [];
6638 $taxproduct = $_[0]->{taxproductnum};
6639 $override = { '' => $_[0]->{tax_override} };
6640 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
6641 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
6642 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
6647 $pkg = @_ ? shift : 'One-time charge';
6648 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6650 $taxclass = @_ ? shift : '';
6654 local $SIG{HUP} = 'IGNORE';
6655 local $SIG{INT} = 'IGNORE';
6656 local $SIG{QUIT} = 'IGNORE';
6657 local $SIG{TERM} = 'IGNORE';
6658 local $SIG{TSTP} = 'IGNORE';
6659 local $SIG{PIPE} = 'IGNORE';
6661 my $oldAutoCommit = $FS::UID::AutoCommit;
6662 local $FS::UID::AutoCommit = 0;
6665 my $part_pkg = new FS::part_pkg ( {
6667 'comment' => $comment,
6671 'classnum' => ( $classnum ? $classnum : '' ),
6672 'setuptax' => $setuptax,
6673 'taxclass' => $taxclass,
6674 'taxproductnum' => $taxproduct,
6677 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6678 ( 0 .. @$additional - 1 )
6680 'additional_count' => scalar(@$additional),
6681 'setup_fee' => $amount,
6684 my $error = $part_pkg->insert( options => \%options,
6685 tax_overrides => $override,
6688 $dbh->rollback if $oldAutoCommit;
6692 my $pkgpart = $part_pkg->pkgpart;
6693 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6694 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6695 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6696 $error = $type_pkgs->insert;
6698 $dbh->rollback if $oldAutoCommit;
6703 my $cust_pkg = new FS::cust_pkg ( {
6704 'custnum' => $self->custnum,
6705 'pkgpart' => $pkgpart,
6706 'quantity' => $quantity,
6707 'start_date' => $start_date,
6708 'no_auto' => $no_auto,
6711 $error = $cust_pkg->insert;
6713 $dbh->rollback if $oldAutoCommit;
6715 } elsif ( $cust_pkg_ref ) {
6716 ${$cust_pkg_ref} = $cust_pkg;
6720 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
6721 'pkg_list' => [ $cust_pkg ],
6724 $dbh->rollback if $oldAutoCommit;
6729 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6734 #=item charge_postal_fee
6736 #Applies a one time charge this customer. If there is an error,
6737 #returns the error, returns the cust_pkg charge object or false
6738 #if there was no charge.
6742 # This should be a customer event. For that to work requires that bill
6743 # also be a customer event.
6745 sub charge_postal_fee {
6748 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
6749 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
6751 my $cust_pkg = new FS::cust_pkg ( {
6752 'custnum' => $self->custnum,
6753 'pkgpart' => $pkgpart,
6757 my $error = $cust_pkg->insert;
6758 $error ? $error : $cust_pkg;
6763 Returns all the invoices (see L<FS::cust_bill>) for this customer.
6769 map { $_ } #return $self->num_cust_bill unless wantarray;
6770 sort { $a->_date <=> $b->_date }
6771 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6774 =item open_cust_bill
6776 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
6781 sub open_cust_bill {
6785 'table' => 'cust_bill',
6786 'hashref' => { 'custnum' => $self->custnum, },
6787 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
6788 'order_by' => 'ORDER BY _date ASC',
6793 =item cust_statements
6795 Returns all the statements (see L<FS::cust_statement>) for this customer.
6799 sub cust_statement {
6801 map { $_ } #return $self->num_cust_statement unless wantarray;
6802 sort { $a->_date <=> $b->_date }
6803 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
6808 Returns all the credits (see L<FS::cust_credit>) for this customer.
6814 map { $_ } #return $self->num_cust_credit unless wantarray;
6815 sort { $a->_date <=> $b->_date }
6816 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
6819 =item cust_credit_pkgnum
6821 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
6822 package when using experimental package balances.
6826 sub cust_credit_pkgnum {
6827 my( $self, $pkgnum ) = @_;
6828 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
6829 sort { $a->_date <=> $b->_date }
6830 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
6831 'pkgnum' => $pkgnum,
6838 Returns all the payments (see L<FS::cust_pay>) for this customer.
6844 return $self->num_cust_pay unless wantarray;
6845 sort { $a->_date <=> $b->_date }
6846 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
6851 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
6852 called automatically when the cust_pay method is used in a scalar context.
6858 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
6859 my $sth = dbh->prepare($sql) or die dbh->errstr;
6860 $sth->execute($self->custnum) or die $sth->errstr;
6861 $sth->fetchrow_arrayref->[0];
6864 =item cust_pay_pkgnum
6866 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
6867 package when using experimental package balances.
6871 sub cust_pay_pkgnum {
6872 my( $self, $pkgnum ) = @_;
6873 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
6874 sort { $a->_date <=> $b->_date }
6875 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
6876 'pkgnum' => $pkgnum,
6883 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
6889 map { $_ } #return $self->num_cust_pay_void unless wantarray;
6890 sort { $a->_date <=> $b->_date }
6891 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
6894 =item cust_pay_batch
6896 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
6900 sub cust_pay_batch {
6902 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
6903 sort { $a->paybatchnum <=> $b->paybatchnum }
6904 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
6907 =item cust_pay_pending
6909 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
6910 (without status "done").
6914 sub cust_pay_pending {
6916 return $self->num_cust_pay_pending unless wantarray;
6917 sort { $a->_date <=> $b->_date }
6918 qsearch( 'cust_pay_pending', {
6919 'custnum' => $self->custnum,
6920 'status' => { op=>'!=', value=>'done' },
6925 =item num_cust_pay_pending
6927 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
6928 customer (without status "done"). Also called automatically when the
6929 cust_pay_pending method is used in a scalar context.
6933 sub num_cust_pay_pending {
6935 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
6936 " WHERE custnum = ? AND status != 'done' ";
6937 my $sth = dbh->prepare($sql) or die dbh->errstr;
6938 $sth->execute($self->custnum) or die $sth->errstr;
6939 $sth->fetchrow_arrayref->[0];
6944 Returns all the refunds (see L<FS::cust_refund>) for this customer.
6950 map { $_ } #return $self->num_cust_refund unless wantarray;
6951 sort { $a->_date <=> $b->_date }
6952 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
6955 =item display_custnum
6957 Returns the displayed customer number for this customer: agent_custid if
6958 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
6962 sub display_custnum {
6964 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
6965 return $self->agent_custid;
6967 return $self->custnum;
6973 Returns a name string for this customer, either "Company (Last, First)" or
6980 my $name = $self->contact;
6981 $name = $self->company. " ($name)" if $self->company;
6987 Returns a name string for this (service/shipping) contact, either
6988 "Company (Last, First)" or "Last, First".
6994 if ( $self->get('ship_last') ) {
6995 my $name = $self->ship_contact;
6996 $name = $self->ship_company. " ($name)" if $self->ship_company;
7005 Returns a name string for this customer, either "Company" or "First Last".
7011 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7014 =item ship_name_short
7016 Returns a name string for this (service/shipping) contact, either "Company"
7021 sub ship_name_short {
7023 if ( $self->get('ship_last') ) {
7024 $self->ship_company !~ /^\s*$/
7025 ? $self->ship_company
7026 : $self->ship_contact_firstlast;
7028 $self->name_company_or_firstlast;
7034 Returns this customer's full (billing) contact name only, "Last, First"
7040 $self->get('last'). ', '. $self->first;
7045 Returns this customer's full (shipping) contact name only, "Last, First"
7051 $self->get('ship_last')
7052 ? $self->get('ship_last'). ', '. $self->ship_first
7056 =item contact_firstlast
7058 Returns this customers full (billing) contact name only, "First Last".
7062 sub contact_firstlast {
7064 $self->first. ' '. $self->get('last');
7067 =item ship_contact_firstlast
7069 Returns this customer's full (shipping) contact name only, "First Last".
7073 sub ship_contact_firstlast {
7075 $self->get('ship_last')
7076 ? $self->first. ' '. $self->get('ship_last')
7077 : $self->contact_firstlast;
7082 Returns this customer's full country name
7088 code2country($self->country);
7091 =item geocode DATA_VENDOR
7093 Returns a value for the customer location as encoded by DATA_VENDOR.
7094 Currently this only makes sense for "CCH" as DATA_VENDOR.
7099 my ($self, $data_vendor) = (shift, shift); #always cch for now
7101 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7102 return $geocode if $geocode;
7104 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7108 my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7109 if $self->country eq 'US';
7113 #CCH specific location stuff
7114 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7116 my @cust_tax_location =
7118 'table' => 'cust_tax_location',
7119 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7120 'extra_sql' => $extra_sql,
7121 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7124 $geocode = $cust_tax_location[0]->geocode
7125 if scalar(@cust_tax_location);
7134 Returns a status string for this customer, currently:
7138 =item prospect - No packages have ever been ordered
7140 =item active - One or more recurring packages is active
7142 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7144 =item suspended - All non-cancelled recurring packages are suspended
7146 =item cancelled - All recurring packages are cancelled
7152 sub status { shift->cust_status(@_); }
7156 for my $status (qw( prospect active inactive suspended cancelled )) {
7157 my $method = $status.'_sql';
7158 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7159 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7160 $sth->execute( ($self->custnum) x $numnum )
7161 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7162 return $status if $sth->fetchrow_arrayref->[0];
7166 =item ucfirst_cust_status
7168 =item ucfirst_status
7170 Returns the status with the first character capitalized.
7174 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7176 sub ucfirst_cust_status {
7178 ucfirst($self->cust_status);
7183 Returns a hex triplet color string for this customer's status.
7187 use vars qw(%statuscolor);
7188 tie %statuscolor, 'Tie::IxHash',
7189 'prospect' => '7e0079', #'000000', #black? naw, purple
7190 'active' => '00CC00', #green
7191 'inactive' => '0000CC', #blue
7192 'suspended' => 'FF9900', #yellow
7193 'cancelled' => 'FF0000', #red
7196 sub statuscolor { shift->cust_statuscolor(@_); }
7198 sub cust_statuscolor {
7200 $statuscolor{$self->cust_status};
7205 Returns an array of hashes representing the customer's RT tickets.
7212 my $num = $conf->config('cust_main-max_tickets') || 10;
7215 if ( $conf->config('ticket_system') ) {
7216 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7218 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7222 foreach my $priority (
7223 $conf->config('ticket_system-custom_priority_field-values'), ''
7225 last if scalar(@tickets) >= $num;
7227 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7228 $num - scalar(@tickets),
7238 # Return services representing svc_accts in customer support packages
7239 sub support_services {
7241 my %packages = map { $_ => 1 } $conf->config('support_packages');
7243 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7244 grep { $_->part_svc->svcdb eq 'svc_acct' }
7245 map { $_->cust_svc }
7246 grep { exists $packages{ $_->pkgpart } }
7247 $self->ncancelled_pkgs;
7251 # Return a list of latitude/longitude for one of the services (if any)
7252 sub service_coordinates {
7256 grep { $_->latitude && $_->longitude }
7258 map { $_->cust_svc }
7259 $self->ncancelled_pkgs;
7261 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7266 =head1 CLASS METHODS
7272 Class method that returns the list of possible status strings for customers
7273 (see L<the status method|/status>). For example:
7275 @statuses = FS::cust_main->statuses();
7280 #my $self = shift; #could be class...
7286 Returns an SQL expression identifying prospective cust_main records (customers
7287 with no packages ever ordered)
7291 use vars qw($select_count_pkgs);
7292 $select_count_pkgs =
7293 "SELECT COUNT(*) FROM cust_pkg
7294 WHERE cust_pkg.custnum = cust_main.custnum";
7296 sub select_count_pkgs_sql {
7300 sub prospect_sql { "
7301 0 = ( $select_count_pkgs )
7306 Returns an SQL expression identifying active cust_main records (customers with
7307 active recurring packages).
7312 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7318 Returns an SQL expression identifying inactive cust_main records (customers with
7319 no active recurring packages, but otherwise unsuspended/uncancelled).
7323 sub inactive_sql { "
7324 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7326 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7332 Returns an SQL expression identifying suspended cust_main records.
7337 sub suspended_sql { susp_sql(@_); }
7339 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7341 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7347 Returns an SQL expression identifying cancelled cust_main records.
7351 sub cancelled_sql { cancel_sql(@_); }
7354 my $recurring_sql = FS::cust_pkg->recurring_sql;
7355 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7358 0 < ( $select_count_pkgs )
7359 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7360 AND 0 = ( $select_count_pkgs AND $recurring_sql
7361 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7363 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7369 =item uncancelled_sql
7371 Returns an SQL expression identifying un-cancelled cust_main records.
7375 sub uncancelled_sql { uncancel_sql(@_); }
7376 sub uncancel_sql { "
7377 ( 0 < ( $select_count_pkgs
7378 AND ( cust_pkg.cancel IS NULL
7379 OR cust_pkg.cancel = 0
7382 OR 0 = ( $select_count_pkgs )
7388 Returns an SQL fragment to retreive the balance.
7393 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7394 WHERE cust_bill.custnum = cust_main.custnum )
7395 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7396 WHERE cust_pay.custnum = cust_main.custnum )
7397 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7398 WHERE cust_credit.custnum = cust_main.custnum )
7399 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7400 WHERE cust_refund.custnum = cust_main.custnum )
7403 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7405 Returns an SQL fragment to retreive the balance for this customer, only
7406 considering invoices with date earlier than START_TIME, and optionally not
7407 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7408 total_unapplied_payments).
7410 Times are specified as SQL fragments or numeric
7411 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7412 L<Date::Parse> for conversion functions. The empty string can be passed
7413 to disable that time constraint completely.
7415 Available options are:
7419 =item unapplied_date
7421 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
7426 set to true to remove all customer comparison clauses, for totals
7431 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7436 JOIN clause (typically used with the total option)
7440 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
7441 time will be ignored. Note that START_TIME and END_TIME only limit the date
7442 range for invoices and I<unapplied> payments, credits, and refunds.
7448 sub balance_date_sql {
7449 my( $class, $start, $end, %opt ) = @_;
7451 my $cutoff = $opt{'cutoff'};
7453 my $owed = FS::cust_bill->owed_sql($cutoff);
7454 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
7455 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
7456 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
7458 my $j = $opt{'join'} || '';
7460 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7461 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7462 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7463 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7465 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7466 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7467 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7468 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7473 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7475 Returns an SQL fragment to retreive the total unapplied payments for this
7476 customer, only considering invoices with date earlier than START_TIME, and
7477 optionally not later than END_TIME.
7479 Times are specified as SQL fragments or numeric
7480 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7481 L<Date::Parse> for conversion functions. The empty string can be passed
7482 to disable that time constraint completely.
7484 Available options are:
7488 sub unapplied_payments_date_sql {
7489 my( $class, $start, $end, ) = @_;
7491 my $unapp_pay = FS::cust_pay->unapplied_sql;
7493 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7494 'unapplied_date'=>1 );
7496 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7499 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7501 Helper method for balance_date_sql; name (and usage) subject to change
7502 (suggestions welcome).
7504 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7505 cust_refund, cust_credit or cust_pay).
7507 If TABLE is "cust_bill" or the unapplied_date option is true, only
7508 considers records with date earlier than START_TIME, and optionally not
7509 later than END_TIME .
7513 sub _money_table_where {
7514 my( $class, $table, $start, $end, %opt ) = @_;
7517 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7518 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7519 push @where, "$table._date <= $start" if defined($start) && length($start);
7520 push @where, "$table._date > $end" if defined($end) && length($end);
7522 push @where, @{$opt{'where'}} if $opt{'where'};
7523 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7529 =item search HASHREF
7533 Returns a qsearch hash expression to search for parameters specified in
7534 HASHREF. Valid parameters are
7542 =item cancelled_pkgs
7548 listref of start date, end date
7558 =item current_balance
7560 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7564 =item flattened_pkgs
7573 my ($class, $params) = @_;
7584 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7586 "cust_main.agentnum = $1";
7590 # do the same for user
7593 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
7595 "cust_main.usernum = $1";
7602 #prospect active inactive suspended cancelled
7603 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7604 my $method = $params->{'status'}. '_sql';
7605 #push @where, $class->$method();
7606 push @where, FS::cust_main->$method();
7610 # parse cancelled package checkbox
7615 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7616 unless $params->{'cancelled_pkgs'};
7619 # parse without census tract checkbox
7622 push @where, "(censustract = '' or censustract is null)"
7623 if $params->{'no_censustract'};
7629 foreach my $field (qw( signupdate )) {
7631 next unless exists($params->{$field});
7633 my($beginning, $ending, $hour) = @{$params->{$field}};
7636 "cust_main.$field IS NOT NULL",
7637 "cust_main.$field >= $beginning",
7638 "cust_main.$field <= $ending";
7640 # XXX: do this for mysql and/or pull it out of here
7642 if ($dbh->{Driver}->{Name} eq 'Pg') {
7643 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
7646 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
7650 $orderby ||= "ORDER BY cust_main.$field";
7658 if ( $params->{'classnum'} ) {
7660 my @classnum = ref( $params->{'classnum'} )
7661 ? @{ $params->{'classnum'} }
7662 : ( $params->{'classnum'} );
7664 @classnum = grep /^(\d*)$/, @classnum;
7667 push @where, '( '. join(' OR ', map {
7668 $_ ? "cust_main.classnum = $_"
7669 : "cust_main.classnum IS NULL"
7682 if ( $params->{'payby'} ) {
7684 my @payby = ref( $params->{'payby'} )
7685 ? @{ $params->{'payby'} }
7686 : ( $params->{'payby'} );
7688 @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
7690 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
7696 # paydate_year / paydate_month
7699 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
7701 $params->{'paydate_month'} =~ /^(\d\d?)$/
7702 or die "paydate_year without paydate_month?";
7706 'paydate IS NOT NULL',
7708 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
7716 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
7718 if ( $1 eq 'NULL' ) {
7720 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
7723 "cust_main.invoice_terms IS NOT NULL",
7724 "cust_main.invoice_terms = '$1'";
7732 if ( $params->{'current_balance'} ) {
7734 #my $balance_sql = $class->balance_sql();
7735 my $balance_sql = FS::cust_main->balance_sql();
7737 my @current_balance =
7738 ref( $params->{'current_balance'} )
7739 ? @{ $params->{'current_balance'} }
7740 : ( $params->{'current_balance'} );
7742 push @where, map { s/current_balance/$balance_sql/; $_ }
7751 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
7753 "cust_main.custbatch = '$1'";
7757 # setup queries, subs, etc. for the search
7760 $orderby ||= 'ORDER BY custnum';
7762 # here is the agent virtualization
7763 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
7765 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
7767 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
7769 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
7771 my $select = join(', ',
7772 'cust_main.custnum',
7773 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
7776 my(@extra_headers) = ();
7777 my(@extra_fields) = ();
7779 if ($params->{'flattened_pkgs'}) {
7781 if ($dbh->{Driver}->{Name} eq 'Pg') {
7783 $select .= ", array_to_string(array(select pkg from cust_pkg left join part_pkg using ( pkgpart ) where cust_main.custnum = cust_pkg.custnum $pkgwhere),'|') as magic";
7785 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
7786 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
7787 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
7789 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
7790 "omitting packing information from report.";
7793 my $header_query = "SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count FROM cust_main $addl_from $extra_sql $pkgwhere group by cust_main.custnum order by count desc limit 1";
7795 my $sth = dbh->prepare($header_query) or die dbh->errstr;
7796 $sth->execute() or die $sth->errstr;
7797 my $headerrow = $sth->fetchrow_arrayref;
7798 my $headercount = $headerrow ? $headerrow->[0] : 0;
7799 while($headercount) {
7800 unshift @extra_headers, "Package ". $headercount;
7801 unshift @extra_fields, eval q!sub {my $c = shift;
7802 my @a = split '\|', $c->magic;
7803 my $p = $a[!.--$headercount. q!];
7811 'table' => 'cust_main',
7812 'select' => $select,
7814 'extra_sql' => $extra_sql,
7815 'order_by' => $orderby,
7816 'count_query' => $count_query,
7817 'extra_headers' => \@extra_headers,
7818 'extra_fields' => \@extra_fields,
7823 =item email_search_result HASHREF
7827 Emails a notice to the specified customers.
7829 Valid parameters are those of the L<search> method, plus the following:
7851 Optional job queue job for status updates.
7855 Returns an error message, or false for success.
7857 If an error occurs during any email, stops the enture send and returns that
7858 error. Presumably if you're getting SMTP errors aborting is better than
7859 retrying everything.
7863 sub email_search_result {
7864 my($class, $params) = @_;
7866 my $from = delete $params->{from};
7867 my $subject = delete $params->{subject};
7868 my $html_body = delete $params->{html_body};
7869 my $text_body = delete $params->{text_body};
7871 my $job = delete $params->{'job'};
7873 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
7874 unless ref($params->{'payby'});
7876 my $sql_query = $class->search($params);
7878 my $count_query = delete($sql_query->{'count_query'});
7879 my $count_sth = dbh->prepare($count_query)
7880 or die "Error preparing $count_query: ". dbh->errstr;
7882 or die "Error executing $count_query: ". $count_sth->errstr;
7883 my $count_arrayref = $count_sth->fetchrow_arrayref;
7884 my $num_cust = $count_arrayref->[0];
7886 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
7887 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
7890 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
7892 #eventually order+limit magic to reduce memory use?
7893 foreach my $cust_main ( qsearch($sql_query) ) {
7895 my $to = $cust_main->invoicing_list_emailonly_scalar;
7898 my $error = send_email(
7902 'subject' => $subject,
7903 'html_body' => $html_body,
7904 'text_body' => $text_body,
7907 return $error if $error;
7909 if ( $job ) { #progressbar foo
7911 if ( time - $min_sec > $last ) {
7912 my $error = $job->update_statustext(
7913 int( 100 * $num / $num_cust )
7915 die $error if $error;
7925 use Storable qw(thaw);
7928 sub process_email_search_result {
7930 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
7932 my $param = thaw(decode_base64(shift));
7933 warn Dumper($param) if $DEBUG;
7935 $param->{'job'} = $job;
7937 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
7938 unless ref($param->{'payby'});
7940 my $error = FS::cust_main->email_search_result( $param );
7941 die $error if $error;
7945 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
7947 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
7948 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
7949 specified (the appropriate ship_ field is also searched).
7951 Additional options are the same as FS::Record::qsearch
7956 my( $self, $fuzzy, $hash, @opt) = @_;
7961 check_and_rebuild_fuzzyfiles();
7962 foreach my $field ( keys %$fuzzy ) {
7964 my $all = $self->all_X($field);
7965 next unless scalar(@$all);
7968 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
7971 foreach ( keys %match ) {
7972 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
7973 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
7976 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
7979 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
7981 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
7989 Returns a masked version of the named field
7994 my ($self,$field) = @_;
7998 'x'x(length($self->getfield($field))-4).
7999 substr($self->getfield($field), (length($self->getfield($field))-4));
8009 =item smart_search OPTION => VALUE ...
8011 Accepts the following options: I<search>, the string to search for. The string
8012 will be searched for as a customer number, phone number, name or company name,
8013 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8014 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8015 skip fuzzy matching when an exact match is found.
8017 Any additional options are treated as an additional qualifier on the search
8020 Returns a (possibly empty) array of FS::cust_main objects.
8027 #here is the agent virtualization
8028 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8032 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8033 my $search = delete $options{'search'};
8034 ( my $alphanum_search = $search ) =~ s/\W//g;
8036 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8038 #false laziness w/Record::ut_phone
8039 my $phonen = "$1-$2-$3";
8040 $phonen .= " x$4" if $4;
8042 push @cust_main, qsearch( {
8043 'table' => 'cust_main',
8044 'hashref' => { %options },
8045 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8047 join(' OR ', map "$_ = '$phonen'",
8048 qw( daytime night fax
8049 ship_daytime ship_night ship_fax )
8052 " AND $agentnums_sql", #agent virtualization
8055 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8056 #try looking for matches with extensions unless one was specified
8058 push @cust_main, qsearch( {
8059 'table' => 'cust_main',
8060 'hashref' => { %options },
8061 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8063 join(' OR ', map "$_ LIKE '$phonen\%'",
8065 ship_daytime ship_night )
8068 " AND $agentnums_sql", #agent virtualization
8073 # custnum search (also try agent_custid), with some tweaking options if your
8074 # legacy cust "numbers" have letters
8077 if ( $search =~ /^\s*(\d+)\s*$/
8078 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8079 && $search =~ /^\s*(\w\w?\d+)\s*$/
8081 || ( $conf->exists('address1-search' )
8082 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8089 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8090 push @cust_main, qsearch( {
8091 'table' => 'cust_main',
8092 'hashref' => { 'custnum' => $num, %options },
8093 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8097 push @cust_main, qsearch( {
8098 'table' => 'cust_main',
8099 'hashref' => { 'agent_custid' => $num, %options },
8100 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8103 if ( $conf->exists('address1-search') ) {
8104 my $len = length($num);
8106 foreach my $prefix ( '', 'ship_' ) {
8107 push @cust_main, qsearch( {
8108 'table' => 'cust_main',
8109 'hashref' => { %options, },
8111 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8112 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8113 " AND $agentnums_sql",
8118 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8120 my($company, $last, $first) = ( $1, $2, $3 );
8122 # "Company (Last, First)"
8123 #this is probably something a browser remembered,
8124 #so just do an exact search (but case-insensitive, so USPS standardization
8125 #doesn't throw a wrench in the works)
8127 foreach my $prefix ( '', 'ship_' ) {
8128 push @cust_main, qsearch( {
8129 'table' => 'cust_main',
8130 'hashref' => { %options },
8132 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8134 " LOWER(${prefix}first) = ". dbh->quote(lc($first)),
8135 " LOWER(${prefix}last) = ". dbh->quote(lc($last)),
8136 " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8142 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8143 # try (ship_){last,company}
8147 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8148 # # full strings the browser remembers won't work
8149 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8151 use Lingua::EN::NameParse;
8152 my $NameParse = new Lingua::EN::NameParse(
8154 allow_reversed => 1,
8157 my($last, $first) = ( '', '' );
8158 #maybe disable this too and just rely on NameParse?
8159 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8161 ($last, $first) = ( $1, $2 );
8163 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8164 } elsif ( ! $NameParse->parse($value) ) {
8166 my %name = $NameParse->components;
8167 $first = $name{'given_name_1'};
8168 $last = $name{'surname_1'};
8172 if ( $first && $last ) {
8174 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8177 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8179 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8180 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8183 push @cust_main, qsearch( {
8184 'table' => 'cust_main',
8185 'hashref' => \%options,
8186 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8189 # or it just be something that was typed in... (try that in a sec)
8193 my $q_value = dbh->quote($value);
8196 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8197 $sql .= " ( LOWER(last) = $q_value
8198 OR LOWER(company) = $q_value
8199 OR LOWER(ship_last) = $q_value
8200 OR LOWER(ship_company) = $q_value
8202 $sql .= " OR LOWER(address1) = $q_value
8203 OR LOWER(ship_address1) = $q_value
8205 if $conf->exists('address1-search');
8208 push @cust_main, qsearch( {
8209 'table' => 'cust_main',
8210 'hashref' => \%options,
8211 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8214 #no exact match, trying substring/fuzzy
8215 #always do substring & fuzzy (unless they're explicity config'ed off)
8216 #getting complaints searches are not returning enough
8217 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8219 #still some false laziness w/search (was search/cust_main.cgi)
8224 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8225 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8228 if ( $first && $last ) {
8231 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8232 'last' => { op=>'ILIKE', value=>"%$last%" },
8234 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8235 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8242 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8243 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8247 if ( $conf->exists('address1-search') ) {
8249 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8250 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8254 foreach my $hashref ( @hashrefs ) {
8256 push @cust_main, qsearch( {
8257 'table' => 'cust_main',
8258 'hashref' => { %$hashref,
8261 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8270 " AND $agentnums_sql", #extra_sql #agent virtualization
8273 if ( $first && $last ) {
8274 push @cust_main, FS::cust_main->fuzzy_search(
8275 { 'last' => $last, #fuzzy hashref
8276 'first' => $first }, #
8280 foreach my $field ( 'last', 'company' ) {
8282 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8284 if ( $conf->exists('address1-search') ) {
8286 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8293 #eliminate duplicates
8295 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8303 Accepts the following options: I<email>, the email address to search for. The
8304 email address will be searched for as an email invoice destination and as an
8307 #Any additional options are treated as an additional qualifier on the search
8308 #(i.e. I<agentnum>).
8310 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8320 my $email = delete $options{'email'};
8322 #we're only being used by RT at the moment... no agent virtualization yet
8323 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8327 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8329 my ( $user, $domain ) = ( $1, $2 );
8331 warn "$me smart_search: searching for $user in domain $domain"
8337 'table' => 'cust_main_invoice',
8338 'hashref' => { 'dest' => $email },
8345 map $_->cust_svc->cust_pkg,
8347 'table' => 'svc_acct',
8348 'hashref' => { 'username' => $user, },
8350 'AND ( SELECT domain FROM svc_domain
8351 WHERE svc_acct.domsvc = svc_domain.svcnum
8352 ) = '. dbh->quote($domain),
8358 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8360 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8367 =item check_and_rebuild_fuzzyfiles
8371 sub check_and_rebuild_fuzzyfiles {
8372 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8373 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8376 =item rebuild_fuzzyfiles
8380 sub rebuild_fuzzyfiles {
8382 use Fcntl qw(:flock);
8384 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8385 mkdir $dir, 0700 unless -d $dir;
8387 foreach my $fuzzy ( @fuzzyfields ) {
8389 open(LOCK,">>$dir/cust_main.$fuzzy")
8390 or die "can't open $dir/cust_main.$fuzzy: $!";
8392 or die "can't lock $dir/cust_main.$fuzzy: $!";
8394 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8395 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8397 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8398 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8399 " WHERE $field != '' AND $field IS NOT NULL");
8400 $sth->execute or die $sth->errstr;
8402 while ( my $row = $sth->fetchrow_arrayref ) {
8403 print CACHE $row->[0]. "\n";
8408 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8410 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8421 my( $self, $field ) = @_;
8422 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8423 open(CACHE,"<$dir/cust_main.$field")
8424 or die "can't open $dir/cust_main.$field: $!";
8425 my @array = map { chomp; $_; } <CACHE>;
8430 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
8434 sub append_fuzzyfiles {
8435 #my( $first, $last, $company ) = @_;
8437 &check_and_rebuild_fuzzyfiles;
8439 use Fcntl qw(:flock);
8441 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8443 foreach my $field (@fuzzyfields) {
8448 open(CACHE,">>$dir/cust_main.$field")
8449 or die "can't open $dir/cust_main.$field: $!";
8450 flock(CACHE,LOCK_EX)
8451 or die "can't lock $dir/cust_main.$field: $!";
8453 print CACHE "$value\n";
8455 flock(CACHE,LOCK_UN)
8456 or die "can't unlock $dir/cust_main.$field: $!";
8471 #warn join('-',keys %$param);
8472 my $fh = $param->{filehandle};
8473 my @fields = @{$param->{fields}};
8475 eval "use Text::CSV_XS;";
8478 my $csv = new Text::CSV_XS;
8485 local $SIG{HUP} = 'IGNORE';
8486 local $SIG{INT} = 'IGNORE';
8487 local $SIG{QUIT} = 'IGNORE';
8488 local $SIG{TERM} = 'IGNORE';
8489 local $SIG{TSTP} = 'IGNORE';
8490 local $SIG{PIPE} = 'IGNORE';
8492 my $oldAutoCommit = $FS::UID::AutoCommit;
8493 local $FS::UID::AutoCommit = 0;
8496 #while ( $columns = $csv->getline($fh) ) {
8498 while ( defined($line=<$fh>) ) {
8500 $csv->parse($line) or do {
8501 $dbh->rollback if $oldAutoCommit;
8502 return "can't parse: ". $csv->error_input();
8505 my @columns = $csv->fields();
8506 #warn join('-',@columns);
8509 foreach my $field ( @fields ) {
8510 $row{$field} = shift @columns;
8513 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8514 unless ( $cust_main ) {
8515 $dbh->rollback if $oldAutoCommit;
8516 return "unknown custnum $row{'custnum'}";
8519 if ( $row{'amount'} > 0 ) {
8520 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8522 $dbh->rollback if $oldAutoCommit;
8526 } elsif ( $row{'amount'} < 0 ) {
8527 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8530 $dbh->rollback if $oldAutoCommit;
8540 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8542 return "Empty file!" unless $imported;
8548 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8550 Sends a templated email notification to the customer (see L<Text::Template>).
8552 OPTIONS is a hash and may include
8554 I<from> - the email sender (default is invoice_from)
8556 I<to> - comma-separated scalar or arrayref of recipients
8557 (default is invoicing_list)
8559 I<subject> - The subject line of the sent email notification
8560 (default is "Notice from company_name")
8562 I<extra_fields> - a hashref of name/value pairs which will be substituted
8565 The following variables are vavailable in the template.
8567 I<$first> - the customer first name
8568 I<$last> - the customer last name
8569 I<$company> - the customer company
8570 I<$payby> - a description of the method of payment for the customer
8571 # would be nice to use FS::payby::shortname
8572 I<$payinfo> - the account information used to collect for this customer
8573 I<$expdate> - the expiration of the customer payment in seconds from epoch
8578 my ($self, $template, %options) = @_;
8580 return unless $conf->exists($template);
8582 my $from = $conf->config('invoice_from', $self->agentnum)
8583 if $conf->exists('invoice_from', $self->agentnum);
8584 $from = $options{from} if exists($options{from});
8586 my $to = join(',', $self->invoicing_list_emailonly);
8587 $to = $options{to} if exists($options{to});
8589 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8590 if $conf->exists('company_name', $self->agentnum);
8591 $subject = $options{subject} if exists($options{subject});
8593 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8594 SOURCE => [ map "$_\n",
8595 $conf->config($template)]
8597 or die "can't create new Text::Template object: Text::Template::ERROR";
8598 $notify_template->compile()
8599 or die "can't compile template: Text::Template::ERROR";
8601 $FS::notify_template::_template::company_name =
8602 $conf->config('company_name', $self->agentnum);
8603 $FS::notify_template::_template::company_address =
8604 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8606 my $paydate = $self->paydate || '2037-12-31';
8607 $FS::notify_template::_template::first = $self->first;
8608 $FS::notify_template::_template::last = $self->last;
8609 $FS::notify_template::_template::company = $self->company;
8610 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8611 my $payby = $self->payby;
8612 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8613 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8615 #credit cards expire at the end of the month/year of their exp date
8616 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8617 $FS::notify_template::_template::payby = 'credit card';
8618 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8619 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8621 }elsif ($payby eq 'COMP') {
8622 $FS::notify_template::_template::payby = 'complimentary account';
8624 $FS::notify_template::_template::payby = 'current method';
8626 $FS::notify_template::_template::expdate = $expire_time;
8628 for (keys %{$options{extra_fields}}){
8630 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8633 send_email(from => $from,
8635 subject => $subject,
8636 body => $notify_template->fill_in( PACKAGE =>
8637 'FS::notify_template::_template' ),
8642 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8644 Generates a templated notification to the customer (see L<Text::Template>).
8646 OPTIONS is a hash and may include
8648 I<extra_fields> - a hashref of name/value pairs which will be substituted
8649 into the template. These values may override values mentioned below
8650 and those from the customer record.
8652 The following variables are available in the template instead of or in addition
8653 to the fields of the customer record.
8655 I<$payby> - a description of the method of payment for the customer
8656 # would be nice to use FS::payby::shortname
8657 I<$payinfo> - the masked account information used to collect for this customer
8658 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8659 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8663 sub generate_letter {
8664 my ($self, $template, %options) = @_;
8666 return unless $conf->exists($template);
8668 my $letter_template = new Text::Template
8670 SOURCE => [ map "$_\n", $conf->config($template)],
8671 DELIMITERS => [ '[@--', '--@]' ],
8673 or die "can't create new Text::Template object: Text::Template::ERROR";
8675 $letter_template->compile()
8676 or die "can't compile template: Text::Template::ERROR";
8678 my %letter_data = map { $_ => $self->$_ } $self->fields;
8679 $letter_data{payinfo} = $self->mask_payinfo;
8681 #my $paydate = $self->paydate || '2037-12-31';
8682 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8684 my $payby = $self->payby;
8685 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8686 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8688 #credit cards expire at the end of the month/year of their exp date
8689 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8690 $letter_data{payby} = 'credit card';
8691 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8692 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8694 }elsif ($payby eq 'COMP') {
8695 $letter_data{payby} = 'complimentary account';
8697 $letter_data{payby} = 'current method';
8699 $letter_data{expdate} = $expire_time;
8701 for (keys %{$options{extra_fields}}){
8702 $letter_data{$_} = $options{extra_fields}->{$_};
8705 unless(exists($letter_data{returnaddress})){
8706 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8707 $self->agent_template)
8709 if ( length($retadd) ) {
8710 $letter_data{returnaddress} = $retadd;
8711 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8712 $letter_data{returnaddress} =
8713 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8714 $conf->config('company_address', $self->agentnum)
8717 $letter_data{returnaddress} = '~';
8721 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
8723 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
8725 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
8726 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
8730 ) or die "can't open temp file: $!\n";
8732 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
8734 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
8738 =item print_ps TEMPLATE
8740 Returns an postscript letter filled in from TEMPLATE, as a scalar.
8746 my $file = $self->generate_letter(@_);
8747 FS::Misc::generate_ps($file);
8750 =item print TEMPLATE
8752 Prints the filled in template.
8754 TEMPLATE is the name of a L<Text::Template> to fill in and print.
8758 sub queueable_print {
8761 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
8762 or die "invalid customer number: " . $opt{custvnum};
8764 my $error = $self->print( $opt{template} );
8765 die $error if $error;
8769 my ($self, $template) = (shift, shift);
8770 do_print [ $self->print_ps($template) ];
8773 #these three subs should just go away once agent stuff is all config overrides
8775 sub agent_template {
8777 $self->_agent_plandata('agent_templatename');
8780 sub agent_invoice_from {
8782 $self->_agent_plandata('agent_invoice_from');
8785 sub _agent_plandata {
8786 my( $self, $option ) = @_;
8788 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
8789 #agent-specific Conf
8791 use FS::part_event::Condition;
8793 my $agentnum = $self->agentnum;
8795 my $regexp = regexp_sql();
8797 my $part_event_option =
8799 'select' => 'part_event_option.*',
8800 'table' => 'part_event_option',
8802 LEFT JOIN part_event USING ( eventpart )
8803 LEFT JOIN part_event_option AS peo_agentnum
8804 ON ( part_event.eventpart = peo_agentnum.eventpart
8805 AND peo_agentnum.optionname = 'agentnum'
8806 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
8808 LEFT JOIN part_event_condition
8809 ON ( part_event.eventpart = part_event_condition.eventpart
8810 AND part_event_condition.conditionname = 'cust_bill_age'
8812 LEFT JOIN part_event_condition_option
8813 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
8814 AND part_event_condition_option.optionname = 'age'
8817 #'hashref' => { 'optionname' => $option },
8818 #'hashref' => { 'part_event_option.optionname' => $option },
8820 " WHERE part_event_option.optionname = ". dbh->quote($option).
8821 " AND action = 'cust_bill_send_agent' ".
8822 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
8823 " AND peo_agentnum.optionname = 'agentnum' ".
8824 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
8826 CASE WHEN part_event_condition_option.optionname IS NULL
8828 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
8830 , part_event.weight".
8834 unless ( $part_event_option ) {
8835 return $self->agent->invoice_template || ''
8836 if $option eq 'agent_templatename';
8840 $part_event_option->optionvalue;
8845 ## actual sub, not a method, designed to be called from the queue.
8846 ## sets up the customer, and calls the bill_and_collect
8847 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
8848 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
8849 $cust_main->bill_and_collect(
8854 sub _upgrade_data { #class method
8855 my ($class, %opts) = @_;
8857 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
8858 my $sth = dbh->prepare($sql) or die dbh->errstr;
8859 $sth->execute or die $sth->errstr;
8861 local($ignore_expired_card) = 1;
8862 $class->_upgrade_otaker(%opts);
8872 The delete method should possibly take an FS::cust_main object reference
8873 instead of a scalar customer number.
8875 Bill and collect options should probably be passed as references instead of a
8878 There should probably be a configuration file with a list of allowed credit
8881 No multiple currency support (probably a larger project than just this module).
8883 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
8885 Birthdates rely on negative epoch values.
8887 The payby for card/check batches is broken. With mixed batching, bad
8890 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
8894 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
8895 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
8896 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.