5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf
7 $import $ignore_expired_card
8 $skip_fuzzyfiles @fuzzyfields
11 use vars qw( $realtime_bop_decline_quiet ); #ugh
15 use Scalar::Util qw( blessed );
16 use List::Util qw( min );
17 use Time::Local qw(timelocal);
20 use Digest::MD5 qw(md5_base64);
23 use File::Temp qw( tempfile );
24 use String::Approx qw(amatch);
25 use Business::CreditCard 0.28;
27 use FS::UID qw( getotaker dbh driver_name );
28 use FS::Record qw( qsearchs qsearch dbdef );
29 use FS::Misc qw( generate_email send_email generate_ps do_print );
30 use FS::Msgcat qw(gettext);
35 use FS::cust_bill_pkg;
36 use FS::cust_bill_pkg_display;
37 use FS::cust_bill_pkg_tax_location;
38 use FS::cust_bill_pkg_tax_rate_location;
40 use FS::cust_pay_pending;
41 use FS::cust_pay_void;
42 use FS::cust_pay_batch;
45 use FS::part_referral;
46 use FS::cust_main_county;
47 use FS::cust_location;
49 use FS::cust_main_exemption;
50 use FS::cust_tax_adjustment;
52 use FS::tax_rate_location;
53 use FS::cust_tax_location;
54 use FS::part_pkg_taxrate;
56 use FS::cust_main_invoice;
57 use FS::cust_credit_bill;
58 use FS::cust_bill_pay;
59 use FS::prepay_credit;
63 use FS::part_event_condition;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::payinfo_Mixin;
72 @ISA = qw( FS::payinfo_Mixin FS::Record );
74 @EXPORT_OK = qw( smart_search );
76 $realtime_bop_decline_quiet = 0;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 $me = '[FS::cust_main]';
85 $ignore_expired_card = 0;
88 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
90 @encrypted_fields = ('payinfo', 'paycvv');
91 sub nohistory_fields { ('paycvv'); }
93 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
95 #ask FS::UID to run this stuff for us later
96 #$FS::UID::callback{'FS::cust_main'} = sub {
97 install_callback FS::UID sub {
99 #yes, need it for stuff below (prolly should be cached)
104 my ( $hashref, $cache ) = @_;
105 if ( exists $hashref->{'pkgnum'} ) {
106 #@{ $self->{'_pkgnum'} } = ();
107 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
108 $self->{'_pkgnum'} = $subcache;
109 #push @{ $self->{'_pkgnum'} },
110 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
116 FS::cust_main - Object methods for cust_main records
122 $record = new FS::cust_main \%hash;
123 $record = new FS::cust_main { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 @cust_pkg = $record->all_pkgs;
135 @cust_pkg = $record->ncancelled_pkgs;
137 @cust_pkg = $record->suspended_pkgs;
139 $error = $record->bill;
140 $error = $record->bill %options;
141 $error = $record->bill 'time' => $time;
143 $error = $record->collect;
144 $error = $record->collect %options;
145 $error = $record->collect 'invoice_time' => $time,
150 An FS::cust_main object represents a customer. FS::cust_main inherits from
151 FS::Record. The following fields are currently supported:
157 Primary key (assigned automatically for new customers)
161 Agent (see L<FS::agent>)
165 Advertising source (see L<FS::part_referral>)
177 Cocial security number (optional)
193 (optional, see L<FS::cust_main_county>)
197 (see L<FS::cust_main_county>)
203 (see L<FS::cust_main_county>)
239 (optional, see L<FS::cust_main_county>)
243 (see L<FS::cust_main_county>)
249 (see L<FS::cust_main_county>)
265 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
269 Payment Information (See L<FS::payinfo_Mixin> for data format)
273 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
277 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
281 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
285 Start date month (maestro/solo cards only)
289 Start date year (maestro/solo cards only)
293 Issue number (maestro/solo cards only)
297 Name on card or billing name
301 IP address from which payment information was received
305 Tax exempt, empty or `Y'
309 Order taker (assigned automatically, see L<FS::UID>)
315 =item referral_custnum
317 Referring customer number
321 Enable individual CDR spooling, empty or `Y'
325 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
329 Discourage individual CDR printing, empty or `Y'
339 Creates a new customer. To add the customer to the database, see L<"insert">.
341 Note that this stores the hash reference, not a distinct copy of the hash it
342 points to. You can ask the object for a copy with the I<hash> method.
346 sub table { 'cust_main'; }
348 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
350 Adds this customer to the database. If there is an error, returns the error,
351 otherwise returns false.
353 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
354 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
355 are inserted atomicly, or the transaction is rolled back. Passing an empty
356 hash reference is equivalent to not supplying this parameter. There should be
357 a better explanation of this, but until then, here's an example:
360 tie %hash, 'Tie::RefHash'; #this part is important
362 $cust_pkg => [ $svc_acct ],
365 $cust_main->insert( \%hash );
367 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
368 be set as the invoicing list (see L<"invoicing_list">). Errors return as
369 expected and rollback the entire transaction; it is not necessary to call
370 check_invoicing_list first. The invoicing_list is set after the records in the
371 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
372 invoicing_list destination to the newly-created svc_acct. Here's an example:
374 $cust_main->insert( {}, [ $email, 'POST' ] );
376 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
378 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
379 on the supplied jobnum (they will not run until the specific job completes).
380 This can be used to defer provisioning until some action completes (such
381 as running the customer's credit card successfully).
383 The I<noexport> option is deprecated. If I<noexport> is set true, no
384 provisioning jobs (exports) are scheduled. (You can schedule them later with
385 the B<reexport> method.)
387 The I<tax_exemption> option can be set to an arrayref of tax names.
388 FS::cust_main_exemption records will be created and inserted.
394 my $cust_pkgs = @_ ? shift : {};
395 my $invoicing_list = @_ ? shift : '';
397 warn "$me insert called with options ".
398 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
401 local $SIG{HUP} = 'IGNORE';
402 local $SIG{INT} = 'IGNORE';
403 local $SIG{QUIT} = 'IGNORE';
404 local $SIG{TERM} = 'IGNORE';
405 local $SIG{TSTP} = 'IGNORE';
406 local $SIG{PIPE} = 'IGNORE';
408 my $oldAutoCommit = $FS::UID::AutoCommit;
409 local $FS::UID::AutoCommit = 0;
412 my $prepay_identifier = '';
413 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
415 if ( $self->payby eq 'PREPAY' ) {
417 $self->payby('BILL');
418 $prepay_identifier = $self->payinfo;
421 warn " looking up prepaid card $prepay_identifier\n"
424 my $error = $self->get_prepay( $prepay_identifier,
425 'amount_ref' => \$amount,
426 'seconds_ref' => \$seconds,
427 'upbytes_ref' => \$upbytes,
428 'downbytes_ref' => \$downbytes,
429 'totalbytes_ref' => \$totalbytes,
432 $dbh->rollback if $oldAutoCommit;
433 #return "error applying prepaid card (transaction rolled back): $error";
437 $payby = 'PREP' if $amount;
439 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
442 $self->payby('BILL');
443 $amount = $self->paid;
447 warn " inserting $self\n"
450 $self->signupdate(time) unless $self->signupdate;
452 $self->auto_agent_custid()
453 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
455 my $error = $self->SUPER::insert;
457 $dbh->rollback if $oldAutoCommit;
458 #return "inserting cust_main record (transaction rolled back): $error";
462 warn " setting invoicing list\n"
465 if ( $invoicing_list ) {
466 $error = $self->check_invoicing_list( $invoicing_list );
468 $dbh->rollback if $oldAutoCommit;
469 #return "checking invoicing_list (transaction rolled back): $error";
472 $self->invoicing_list( $invoicing_list );
475 warn " setting cust_main_exemption\n"
478 my $tax_exemption = delete $options{'tax_exemption'};
479 if ( $tax_exemption ) {
480 foreach my $taxname ( @$tax_exemption ) {
481 my $cust_main_exemption = new FS::cust_main_exemption {
482 'custnum' => $self->custnum,
483 'taxname' => $taxname,
485 my $error = $cust_main_exemption->insert;
487 $dbh->rollback if $oldAutoCommit;
488 return "inserting cust_main_exemption (transaction rolled back): $error";
493 if ( $conf->config('cust_main-skeleton_tables')
494 && $conf->config('cust_main-skeleton_custnum') ) {
496 warn " inserting skeleton records\n"
499 my $error = $self->start_copy_skel;
501 $dbh->rollback if $oldAutoCommit;
507 warn " ordering packages\n"
510 $error = $self->order_pkgs( $cust_pkgs,
512 'seconds_ref' => \$seconds,
513 'upbytes_ref' => \$upbytes,
514 'downbytes_ref' => \$downbytes,
515 'totalbytes_ref' => \$totalbytes,
518 $dbh->rollback if $oldAutoCommit;
523 $dbh->rollback if $oldAutoCommit;
524 return "No svc_acct record to apply pre-paid time";
526 if ( $upbytes || $downbytes || $totalbytes ) {
527 $dbh->rollback if $oldAutoCommit;
528 return "No svc_acct record to apply pre-paid data";
532 warn " inserting initial $payby payment of $amount\n"
534 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
536 $dbh->rollback if $oldAutoCommit;
537 return "inserting payment (transaction rolled back): $error";
541 unless ( $import || $skip_fuzzyfiles ) {
542 warn " queueing fuzzyfiles update\n"
544 $error = $self->queue_fuzzyfiles_update;
546 $dbh->rollback if $oldAutoCommit;
547 return "updating fuzzy search cache: $error";
551 warn " insert complete; committing transaction\n"
554 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
559 use File::CounterFile;
560 sub auto_agent_custid {
563 my $format = $conf->config('cust_main-auto_agent_custid');
565 if ( $format eq '1YMMXXXXXXXX' ) {
567 my $counter = new File::CounterFile 'cust_main.agent_custid';
570 my $ym = 100000000000 + time2str('%y%m00000000', time);
571 if ( $ym > $counter->value ) {
572 $counter->{'value'} = $agent_custid = $ym;
573 $counter->{'updated'} = 1;
575 $agent_custid = $counter->inc;
581 die "Unknown cust_main-auto_agent_custid format: $format";
584 $self->agent_custid($agent_custid);
588 sub start_copy_skel {
591 #'mg_user_preference' => {},
592 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
593 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
594 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
595 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
596 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
599 _copy_skel( 'cust_main', #tablename
600 $conf->config('cust_main-skeleton_custnum'), #sourceid
601 $self->custnum, #destid
602 @tables, #child tables
606 #recursive subroutine, not a method
608 my( $table, $sourceid, $destid, %child_tables ) = @_;
611 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
612 ( $table, $primary_key ) = ( $1, $2 );
614 my $dbdef_table = dbdef->table($table);
615 $primary_key = $dbdef_table->primary_key
616 or return "$table has no primary key".
617 " (or do you need to run dbdef-create?)";
620 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
621 join (', ', keys %child_tables). "\n"
624 foreach my $child_table_def ( keys %child_tables ) {
628 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
629 ( $child_table, $child_pkey ) = ( $1, $2 );
631 $child_table = $child_table_def;
633 $child_pkey = dbdef->table($child_table)->primary_key;
634 # or return "$table has no primary key".
635 # " (or do you need to run dbdef-create?)\n";
639 if ( keys %{ $child_tables{$child_table_def} } ) {
641 return "$child_table has no primary key".
642 " (run dbdef-create or try specifying it?)\n"
645 #false laziness w/Record::insert and only works on Pg
646 #refactor the proper last-inserted-id stuff out of Record::insert if this
647 # ever gets use for anything besides a quick kludge for one customer
648 my $default = dbdef->table($child_table)->column($child_pkey)->default;
649 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
650 or return "can't parse $child_table.$child_pkey default value ".
651 " for sequence name: $default";
656 my @sel_columns = grep { $_ ne $primary_key }
657 dbdef->table($child_table)->columns;
658 my $sel_columns = join(', ', @sel_columns );
660 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
661 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
662 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
664 my $sel_st = "SELECT $sel_columns FROM $child_table".
665 " WHERE $primary_key = $sourceid";
668 my $sel_sth = dbh->prepare( $sel_st )
669 or return dbh->errstr;
671 $sel_sth->execute or return $sel_sth->errstr;
673 while ( my $row = $sel_sth->fetchrow_hashref ) {
675 warn " selected row: ".
676 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
680 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
681 my $ins_sth =dbh->prepare($statement)
682 or return dbh->errstr;
683 my @param = ( $destid, map $row->{$_}, @ins_columns );
684 warn " $statement: [ ". join(', ', @param). " ]\n"
686 $ins_sth->execute( @param )
687 or return $ins_sth->errstr;
689 #next unless keys %{ $child_tables{$child_table} };
690 next unless $sequence;
692 #another section of that laziness
693 my $seq_sql = "SELECT currval('$sequence')";
694 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
695 $seq_sth->execute or return $seq_sth->errstr;
696 my $insertid = $seq_sth->fetchrow_arrayref->[0];
698 # don't drink soap! recurse! recurse! okay!
700 _copy_skel( $child_table_def,
701 $row->{$child_pkey}, #sourceid
703 %{ $child_tables{$child_table_def} },
705 return $error if $error;
715 =item order_pkg HASHREF | OPTION => VALUE ...
717 Orders a single package.
719 Options may be passed as a list of key/value pairs or as a hash reference.
730 Optional FS::cust_location object
734 Optional arryaref of FS::svc_* service objects.
738 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
739 jobs will have a dependancy on the supplied job (they will not run until the
740 specific job completes). This can be used to defer provisioning until some
741 action completes (such as running the customer's credit card successfully).
745 Optional subject for a ticket created and attached to this customer
749 Optional queue name for ticket additions
757 my $opt = ref($_[0]) ? shift : { @_ };
759 warn "$me order_pkg called with options ".
760 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
763 my $cust_pkg = $opt->{'cust_pkg'};
764 my $svcs = $opt->{'svcs'} || [];
766 my %svc_options = ();
767 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
768 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
770 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
771 qw( ticket_subject ticket_queue );
773 local $SIG{HUP} = 'IGNORE';
774 local $SIG{INT} = 'IGNORE';
775 local $SIG{QUIT} = 'IGNORE';
776 local $SIG{TERM} = 'IGNORE';
777 local $SIG{TSTP} = 'IGNORE';
778 local $SIG{PIPE} = 'IGNORE';
780 my $oldAutoCommit = $FS::UID::AutoCommit;
781 local $FS::UID::AutoCommit = 0;
784 if ( $opt->{'cust_location'} &&
785 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
786 my $error = $opt->{'cust_location'}->insert;
788 $dbh->rollback if $oldAutoCommit;
789 return "inserting cust_location (transaction rolled back): $error";
791 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
794 $cust_pkg->custnum( $self->custnum );
796 my $error = $cust_pkg->insert( %insert_params );
798 $dbh->rollback if $oldAutoCommit;
799 return "inserting cust_pkg (transaction rolled back): $error";
802 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
803 if ( $svc_something->svcnum ) {
804 my $old_cust_svc = $svc_something->cust_svc;
805 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
806 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
807 $error = $new_cust_svc->replace($old_cust_svc);
809 $svc_something->pkgnum( $cust_pkg->pkgnum );
810 if ( $svc_something->isa('FS::svc_acct') ) {
811 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
812 qw( seconds upbytes downbytes totalbytes ) ) {
813 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
814 ${ $opt->{$_.'_ref'} } = 0;
817 $error = $svc_something->insert(%svc_options);
820 $dbh->rollback if $oldAutoCommit;
821 return "inserting svc_ (transaction rolled back): $error";
825 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
830 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
831 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
833 Like the insert method on an existing record, this method orders multiple
834 packages and included services atomicaly. Pass a Tie::RefHash data structure
835 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
836 There should be a better explanation of this, but until then, here's an
840 tie %hash, 'Tie::RefHash'; #this part is important
842 $cust_pkg => [ $svc_acct ],
845 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
847 Services can be new, in which case they are inserted, or existing unaudited
848 services, in which case they are linked to the newly-created package.
850 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
851 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
853 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
854 on the supplied jobnum (they will not run until the specific job completes).
855 This can be used to defer provisioning until some action completes (such
856 as running the customer's credit card successfully).
858 The I<noexport> option is deprecated. If I<noexport> is set true, no
859 provisioning jobs (exports) are scheduled. (You can schedule them later with
860 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
861 on the cust_main object is not recommended, as existing services will also be
864 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
865 provided, the scalars (provided by references) will be incremented by the
866 values of the prepaid card.`
872 my $cust_pkgs = shift;
873 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
875 $seconds_ref ||= $options{'seconds_ref'};
877 warn "$me order_pkgs called with options ".
878 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
881 local $SIG{HUP} = 'IGNORE';
882 local $SIG{INT} = 'IGNORE';
883 local $SIG{QUIT} = 'IGNORE';
884 local $SIG{TERM} = 'IGNORE';
885 local $SIG{TSTP} = 'IGNORE';
886 local $SIG{PIPE} = 'IGNORE';
888 my $oldAutoCommit = $FS::UID::AutoCommit;
889 local $FS::UID::AutoCommit = 0;
892 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
894 foreach my $cust_pkg ( keys %$cust_pkgs ) {
896 my $error = $self->order_pkg(
897 'cust_pkg' => $cust_pkg,
898 'svcs' => $cust_pkgs->{$cust_pkg},
899 'seconds_ref' => $seconds_ref,
900 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
905 $dbh->rollback if $oldAutoCommit;
911 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
915 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
917 Recharges this (existing) customer with the specified prepaid card (see
918 L<FS::prepay_credit>), specified either by I<identifier> or as an
919 FS::prepay_credit object. If there is an error, returns the error, otherwise
922 Optionally, five scalar references can be passed as well. They will have their
923 values filled in with the amount, number of seconds, and number of upload,
924 download, and total bytes applied by this prepaid card.
928 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
929 #the only place that uses these args
930 sub recharge_prepay {
931 my( $self, $prepay_credit, $amountref, $secondsref,
932 $upbytesref, $downbytesref, $totalbytesref ) = @_;
934 local $SIG{HUP} = 'IGNORE';
935 local $SIG{INT} = 'IGNORE';
936 local $SIG{QUIT} = 'IGNORE';
937 local $SIG{TERM} = 'IGNORE';
938 local $SIG{TSTP} = 'IGNORE';
939 local $SIG{PIPE} = 'IGNORE';
941 my $oldAutoCommit = $FS::UID::AutoCommit;
942 local $FS::UID::AutoCommit = 0;
945 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
947 my $error = $self->get_prepay( $prepay_credit,
948 'amount_ref' => \$amount,
949 'seconds_ref' => \$seconds,
950 'upbytes_ref' => \$upbytes,
951 'downbytes_ref' => \$downbytes,
952 'totalbytes_ref' => \$totalbytes,
954 || $self->increment_seconds($seconds)
955 || $self->increment_upbytes($upbytes)
956 || $self->increment_downbytes($downbytes)
957 || $self->increment_totalbytes($totalbytes)
958 || $self->insert_cust_pay_prepay( $amount,
960 ? $prepay_credit->identifier
965 $dbh->rollback if $oldAutoCommit;
969 if ( defined($amountref) ) { $$amountref = $amount; }
970 if ( defined($secondsref) ) { $$secondsref = $seconds; }
971 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
972 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
973 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
980 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
982 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
983 specified either by I<identifier> or as an FS::prepay_credit object.
985 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
986 incremented by the values of the prepaid card.
988 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
989 check or set this customer's I<agentnum>.
991 If there is an error, returns the error, otherwise returns false.
997 my( $self, $prepay_credit, %opt ) = @_;
999 local $SIG{HUP} = 'IGNORE';
1000 local $SIG{INT} = 'IGNORE';
1001 local $SIG{QUIT} = 'IGNORE';
1002 local $SIG{TERM} = 'IGNORE';
1003 local $SIG{TSTP} = 'IGNORE';
1004 local $SIG{PIPE} = 'IGNORE';
1006 my $oldAutoCommit = $FS::UID::AutoCommit;
1007 local $FS::UID::AutoCommit = 0;
1010 unless ( ref($prepay_credit) ) {
1012 my $identifier = $prepay_credit;
1014 $prepay_credit = qsearchs(
1016 { 'identifier' => $prepay_credit },
1021 unless ( $prepay_credit ) {
1022 $dbh->rollback if $oldAutoCommit;
1023 return "Invalid prepaid card: ". $identifier;
1028 if ( $prepay_credit->agentnum ) {
1029 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1030 $dbh->rollback if $oldAutoCommit;
1031 return "prepaid card not valid for agent ". $self->agentnum;
1033 $self->agentnum($prepay_credit->agentnum);
1036 my $error = $prepay_credit->delete;
1038 $dbh->rollback if $oldAutoCommit;
1039 return "removing prepay_credit (transaction rolled back): $error";
1042 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1043 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1045 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1050 =item increment_upbytes SECONDS
1052 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1053 the specified number of upbytes. If there is an error, returns the error,
1054 otherwise returns false.
1058 sub increment_upbytes {
1059 _increment_column( shift, 'upbytes', @_);
1062 =item increment_downbytes SECONDS
1064 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1065 the specified number of downbytes. If there is an error, returns the error,
1066 otherwise returns false.
1070 sub increment_downbytes {
1071 _increment_column( shift, 'downbytes', @_);
1074 =item increment_totalbytes SECONDS
1076 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1077 the specified number of totalbytes. If there is an error, returns the error,
1078 otherwise returns false.
1082 sub increment_totalbytes {
1083 _increment_column( shift, 'totalbytes', @_);
1086 =item increment_seconds SECONDS
1088 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1089 the specified number of seconds. If there is an error, returns the error,
1090 otherwise returns false.
1094 sub increment_seconds {
1095 _increment_column( shift, 'seconds', @_);
1098 =item _increment_column AMOUNT
1100 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1101 the specified number of seconds or bytes. If there is an error, returns
1102 the error, otherwise returns false.
1106 sub _increment_column {
1107 my( $self, $column, $amount ) = @_;
1108 warn "$me increment_column called: $column, $amount\n"
1111 return '' unless $amount;
1113 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1114 $self->ncancelled_pkgs;
1116 if ( ! @cust_pkg ) {
1117 return 'No packages with primary or single services found'.
1118 ' to apply pre-paid time';
1119 } elsif ( scalar(@cust_pkg) > 1 ) {
1120 #maybe have a way to specify the package/account?
1121 return 'Multiple packages found to apply pre-paid time';
1124 my $cust_pkg = $cust_pkg[0];
1125 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1129 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1131 if ( ! @cust_svc ) {
1132 return 'No account found to apply pre-paid time';
1133 } elsif ( scalar(@cust_svc) > 1 ) {
1134 return 'Multiple accounts found to apply pre-paid time';
1137 my $svc_acct = $cust_svc[0]->svc_x;
1138 warn " found service svcnum ". $svc_acct->pkgnum.
1139 ' ('. $svc_acct->email. ")\n"
1142 $column = "increment_$column";
1143 $svc_acct->$column($amount);
1147 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1149 Inserts a prepayment in the specified amount for this customer. An optional
1150 second argument can specify the prepayment identifier for tracking purposes.
1151 If there is an error, returns the error, otherwise returns false.
1155 sub insert_cust_pay_prepay {
1156 shift->insert_cust_pay('PREP', @_);
1159 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1161 Inserts a cash payment in the specified amount for this customer. An optional
1162 second argument can specify the payment identifier for tracking purposes.
1163 If there is an error, returns the error, otherwise returns false.
1167 sub insert_cust_pay_cash {
1168 shift->insert_cust_pay('CASH', @_);
1171 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1173 Inserts a Western Union payment in the specified amount for this customer. An
1174 optional second argument can specify the prepayment identifier for tracking
1175 purposes. If there is an error, returns the error, otherwise returns false.
1179 sub insert_cust_pay_west {
1180 shift->insert_cust_pay('WEST', @_);
1183 sub insert_cust_pay {
1184 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1185 my $payinfo = scalar(@_) ? shift : '';
1187 my $cust_pay = new FS::cust_pay {
1188 'custnum' => $self->custnum,
1189 'paid' => sprintf('%.2f', $amount),
1190 #'_date' => #date the prepaid card was purchased???
1192 'payinfo' => $payinfo,
1200 This method is deprecated. See the I<depend_jobnum> option to the insert and
1201 order_pkgs methods for a better way to defer provisioning.
1203 Re-schedules all exports by calling the B<reexport> method of all associated
1204 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1205 otherwise returns false.
1212 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1213 "use the depend_jobnum option to insert or order_pkgs to delay export";
1215 local $SIG{HUP} = 'IGNORE';
1216 local $SIG{INT} = 'IGNORE';
1217 local $SIG{QUIT} = 'IGNORE';
1218 local $SIG{TERM} = 'IGNORE';
1219 local $SIG{TSTP} = 'IGNORE';
1220 local $SIG{PIPE} = 'IGNORE';
1222 my $oldAutoCommit = $FS::UID::AutoCommit;
1223 local $FS::UID::AutoCommit = 0;
1226 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1227 my $error = $cust_pkg->reexport;
1229 $dbh->rollback if $oldAutoCommit;
1234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1239 =item delete NEW_CUSTNUM
1241 This deletes the customer. If there is an error, returns the error, otherwise
1244 This will completely remove all traces of the customer record. This is not
1245 what you want when a customer cancels service; for that, cancel all of the
1246 customer's packages (see L</cancel>).
1248 If the customer has any uncancelled packages, you need to pass a new (valid)
1249 customer number for those packages to be transferred to. Cancelled packages
1250 will be deleted. Did I mention that this is NOT what you want when a customer
1251 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1253 You can't delete a customer with invoices (see L<FS::cust_bill>),
1254 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1255 refunds (see L<FS::cust_refund>).
1262 local $SIG{HUP} = 'IGNORE';
1263 local $SIG{INT} = 'IGNORE';
1264 local $SIG{QUIT} = 'IGNORE';
1265 local $SIG{TERM} = 'IGNORE';
1266 local $SIG{TSTP} = 'IGNORE';
1267 local $SIG{PIPE} = 'IGNORE';
1269 my $oldAutoCommit = $FS::UID::AutoCommit;
1270 local $FS::UID::AutoCommit = 0;
1273 if ( $self->cust_bill ) {
1274 $dbh->rollback if $oldAutoCommit;
1275 return "Can't delete a customer with invoices";
1277 if ( $self->cust_credit ) {
1278 $dbh->rollback if $oldAutoCommit;
1279 return "Can't delete a customer with credits";
1281 if ( $self->cust_pay ) {
1282 $dbh->rollback if $oldAutoCommit;
1283 return "Can't delete a customer with payments";
1285 if ( $self->cust_refund ) {
1286 $dbh->rollback if $oldAutoCommit;
1287 return "Can't delete a customer with refunds";
1290 my @cust_pkg = $self->ncancelled_pkgs;
1292 my $new_custnum = shift;
1293 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1294 $dbh->rollback if $oldAutoCommit;
1295 return "Invalid new customer number: $new_custnum";
1297 foreach my $cust_pkg ( @cust_pkg ) {
1298 my %hash = $cust_pkg->hash;
1299 $hash{'custnum'} = $new_custnum;
1300 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1301 my $error = $new_cust_pkg->replace($cust_pkg,
1302 options => { $cust_pkg->options },
1305 $dbh->rollback if $oldAutoCommit;
1310 my @cancelled_cust_pkg = $self->all_pkgs;
1311 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1312 my $error = $cust_pkg->delete;
1314 $dbh->rollback if $oldAutoCommit;
1319 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1320 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1322 my $error = $cust_main_invoice->delete;
1324 $dbh->rollback if $oldAutoCommit;
1329 foreach my $cust_main_exemption (
1330 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1332 my $error = $cust_main_exemption->delete;
1334 $dbh->rollback if $oldAutoCommit;
1339 my $error = $self->SUPER::delete;
1341 $dbh->rollback if $oldAutoCommit;
1345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1350 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1353 Replaces the OLD_RECORD with this one in the database. If there is an error,
1354 returns the error, otherwise returns false.
1356 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1357 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1358 expected and rollback the entire transaction; it is not necessary to call
1359 check_invoicing_list first. Here's an example:
1361 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1363 Currently available options are: I<tax_exemption>.
1365 The I<tax_exemption> option can be set to an arrayref of tax names.
1366 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1373 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1375 : $self->replace_old;
1379 warn "$me replace called\n"
1382 my $curuser = $FS::CurrentUser::CurrentUser;
1383 if ( $self->payby eq 'COMP'
1384 && $self->payby ne $old->payby
1385 && ! $curuser->access_right('Complimentary customer')
1388 return "You are not permitted to create complimentary accounts.";
1391 local($ignore_expired_card) = 1
1392 if $old->payby =~ /^(CARD|DCRD)$/
1393 && $self->payby =~ /^(CARD|DCRD)$/
1394 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1396 local $SIG{HUP} = 'IGNORE';
1397 local $SIG{INT} = 'IGNORE';
1398 local $SIG{QUIT} = 'IGNORE';
1399 local $SIG{TERM} = 'IGNORE';
1400 local $SIG{TSTP} = 'IGNORE';
1401 local $SIG{PIPE} = 'IGNORE';
1403 my $oldAutoCommit = $FS::UID::AutoCommit;
1404 local $FS::UID::AutoCommit = 0;
1407 my $error = $self->SUPER::replace($old);
1410 $dbh->rollback if $oldAutoCommit;
1414 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1415 my $invoicing_list = shift @param;
1416 $error = $self->check_invoicing_list( $invoicing_list );
1418 $dbh->rollback if $oldAutoCommit;
1421 $self->invoicing_list( $invoicing_list );
1424 my %options = @param;
1426 my $tax_exemption = delete $options{'tax_exemption'};
1427 if ( $tax_exemption ) {
1429 my %cust_main_exemption =
1430 map { $_->taxname => $_ }
1431 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1433 foreach my $taxname ( @$tax_exemption ) {
1435 next if delete $cust_main_exemption{$taxname};
1437 my $cust_main_exemption = new FS::cust_main_exemption {
1438 'custnum' => $self->custnum,
1439 'taxname' => $taxname,
1441 my $error = $cust_main_exemption->insert;
1443 $dbh->rollback if $oldAutoCommit;
1444 return "inserting cust_main_exemption (transaction rolled back): $error";
1448 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1449 my $error = $cust_main_exemption->delete;
1451 $dbh->rollback if $oldAutoCommit;
1452 return "deleting cust_main_exemption (transaction rolled back): $error";
1458 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1459 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1460 # card/check/lec info has changed, want to retry realtime_ invoice events
1461 my $error = $self->retry_realtime;
1463 $dbh->rollback if $oldAutoCommit;
1468 unless ( $import || $skip_fuzzyfiles ) {
1469 $error = $self->queue_fuzzyfiles_update;
1471 $dbh->rollback if $oldAutoCommit;
1472 return "updating fuzzy search cache: $error";
1476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1481 =item queue_fuzzyfiles_update
1483 Used by insert & replace to update the fuzzy search cache
1487 sub queue_fuzzyfiles_update {
1490 local $SIG{HUP} = 'IGNORE';
1491 local $SIG{INT} = 'IGNORE';
1492 local $SIG{QUIT} = 'IGNORE';
1493 local $SIG{TERM} = 'IGNORE';
1494 local $SIG{TSTP} = 'IGNORE';
1495 local $SIG{PIPE} = 'IGNORE';
1497 my $oldAutoCommit = $FS::UID::AutoCommit;
1498 local $FS::UID::AutoCommit = 0;
1501 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1502 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1504 $dbh->rollback if $oldAutoCommit;
1505 return "queueing job (transaction rolled back): $error";
1508 if ( $self->ship_last ) {
1509 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1510 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1512 $dbh->rollback if $oldAutoCommit;
1513 return "queueing job (transaction rolled back): $error";
1517 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1524 Checks all fields to make sure this is a valid customer record. If there is
1525 an error, returns the error, otherwise returns false. Called by the insert
1526 and replace methods.
1533 warn "$me check BEFORE: \n". $self->_dump
1537 $self->ut_numbern('custnum')
1538 || $self->ut_number('agentnum')
1539 || $self->ut_textn('agent_custid')
1540 || $self->ut_number('refnum')
1541 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1542 || $self->ut_textn('custbatch')
1543 || $self->ut_name('last')
1544 || $self->ut_name('first')
1545 || $self->ut_snumbern('birthdate')
1546 || $self->ut_snumbern('signupdate')
1547 || $self->ut_textn('company')
1548 || $self->ut_text('address1')
1549 || $self->ut_textn('address2')
1550 || $self->ut_text('city')
1551 || $self->ut_textn('county')
1552 || $self->ut_textn('state')
1553 || $self->ut_country('country')
1554 || $self->ut_anything('comments')
1555 || $self->ut_numbern('referral_custnum')
1556 || $self->ut_textn('stateid')
1557 || $self->ut_textn('stateid_state')
1558 || $self->ut_textn('invoice_terms')
1559 || $self->ut_alphan('geocode')
1560 || $self->ut_floatn('cdr_termination_percentage')
1563 #barf. need message catalogs. i18n. etc.
1564 $error .= "Please select an advertising source."
1565 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1566 return $error if $error;
1568 return "Unknown agent"
1569 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1571 return "Unknown refnum"
1572 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1574 return "Unknown referring custnum: ". $self->referral_custnum
1575 unless ! $self->referral_custnum
1576 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1578 if ( $self->censustract ne '' ) {
1579 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1580 or return "Illegal census tract: ". $self->censustract;
1582 $self->censustract("$1.$2");
1585 if ( $self->ss eq '' ) {
1590 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1591 or return "Illegal social security number: ". $self->ss;
1592 $self->ss("$1-$2-$3");
1596 # bad idea to disable, causes billing to fail because of no tax rates later
1597 # unless ( $import ) {
1598 unless ( qsearch('cust_main_county', {
1599 'country' => $self->country,
1602 return "Unknown state/county/country: ".
1603 $self->state. "/". $self->county. "/". $self->country
1604 unless qsearch('cust_main_county',{
1605 'state' => $self->state,
1606 'county' => $self->county,
1607 'country' => $self->country,
1613 $self->ut_phonen('daytime', $self->country)
1614 || $self->ut_phonen('night', $self->country)
1615 || $self->ut_phonen('fax', $self->country)
1616 || $self->ut_zip('zip', $self->country)
1618 return $error if $error;
1620 if ( $conf->exists('cust_main-require_phone')
1621 && ! length($self->daytime) && ! length($self->night)
1624 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1626 : FS::Msgcat::_gettext('daytime');
1627 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1629 : FS::Msgcat::_gettext('night');
1631 return "$daytime_label or $night_label is required"
1635 if ( $self->has_ship_address
1636 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1637 $self->addr_fields )
1641 $self->ut_name('ship_last')
1642 || $self->ut_name('ship_first')
1643 || $self->ut_textn('ship_company')
1644 || $self->ut_text('ship_address1')
1645 || $self->ut_textn('ship_address2')
1646 || $self->ut_text('ship_city')
1647 || $self->ut_textn('ship_county')
1648 || $self->ut_textn('ship_state')
1649 || $self->ut_country('ship_country')
1651 return $error if $error;
1653 #false laziness with above
1654 unless ( qsearchs('cust_main_county', {
1655 'country' => $self->ship_country,
1658 return "Unknown ship_state/ship_county/ship_country: ".
1659 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1660 unless qsearch('cust_main_county',{
1661 'state' => $self->ship_state,
1662 'county' => $self->ship_county,
1663 'country' => $self->ship_country,
1669 $self->ut_phonen('ship_daytime', $self->ship_country)
1670 || $self->ut_phonen('ship_night', $self->ship_country)
1671 || $self->ut_phonen('ship_fax', $self->ship_country)
1672 || $self->ut_zip('ship_zip', $self->ship_country)
1674 return $error if $error;
1676 return "Unit # is required."
1677 if $self->ship_address2 =~ /^\s*$/
1678 && $conf->exists('cust_main-require_address2');
1680 } else { # ship_ info eq billing info, so don't store dup info in database
1682 $self->setfield("ship_$_", '')
1683 foreach $self->addr_fields;
1685 return "Unit # is required."
1686 if $self->address2 =~ /^\s*$/
1687 && $conf->exists('cust_main-require_address2');
1691 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1692 # or return "Illegal payby: ". $self->payby;
1694 FS::payby->can_payby($self->table, $self->payby)
1695 or return "Illegal payby: ". $self->payby;
1697 $error = $self->ut_numbern('paystart_month')
1698 || $self->ut_numbern('paystart_year')
1699 || $self->ut_numbern('payissue')
1700 || $self->ut_textn('paytype')
1702 return $error if $error;
1704 if ( $self->payip eq '' ) {
1707 $error = $self->ut_ip('payip');
1708 return $error if $error;
1711 # If it is encrypted and the private key is not availaible then we can't
1712 # check the credit card.
1714 my $check_payinfo = 1;
1716 if ($self->is_encrypted($self->payinfo)) {
1720 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1722 my $payinfo = $self->payinfo;
1723 $payinfo =~ s/\D//g;
1724 $payinfo =~ /^(\d{13,16})$/
1725 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1727 $self->payinfo($payinfo);
1729 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1731 return gettext('unknown_card_type')
1732 if cardtype($self->payinfo) eq "Unknown";
1734 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1736 return 'Banned credit card: banned on '.
1737 time2str('%a %h %o at %r', $ban->_date).
1738 ' by '. $ban->otaker.
1739 ' (ban# '. $ban->bannum. ')';
1742 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1743 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1744 $self->paycvv =~ /^(\d{4})$/
1745 or return "CVV2 (CID) for American Express cards is four digits.";
1748 $self->paycvv =~ /^(\d{3})$/
1749 or return "CVV2 (CVC2/CID) is three digits.";
1756 my $cardtype = cardtype($payinfo);
1757 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1759 return "Start date or issue number is required for $cardtype cards"
1760 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1762 return "Start month must be between 1 and 12"
1763 if $self->paystart_month
1764 and $self->paystart_month < 1 || $self->paystart_month > 12;
1766 return "Start year must be 1990 or later"
1767 if $self->paystart_year
1768 and $self->paystart_year < 1990;
1770 return "Issue number must be beween 1 and 99"
1772 and $self->payissue < 1 || $self->payissue > 99;
1775 $self->paystart_month('');
1776 $self->paystart_year('');
1777 $self->payissue('');
1780 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1782 my $payinfo = $self->payinfo;
1783 $payinfo =~ s/[^\d\@]//g;
1784 if ( $conf->exists('echeck-nonus') ) {
1785 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1786 $payinfo = "$1\@$2";
1788 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1789 $payinfo = "$1\@$2";
1791 $self->payinfo($payinfo);
1794 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1796 return 'Banned ACH account: banned on '.
1797 time2str('%a %h %o at %r', $ban->_date).
1798 ' by '. $ban->otaker.
1799 ' (ban# '. $ban->bannum. ')';
1802 } elsif ( $self->payby eq 'LECB' ) {
1804 my $payinfo = $self->payinfo;
1805 $payinfo =~ s/\D//g;
1806 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1808 $self->payinfo($payinfo);
1811 } elsif ( $self->payby eq 'BILL' ) {
1813 $error = $self->ut_textn('payinfo');
1814 return "Illegal P.O. number: ". $self->payinfo if $error;
1817 } elsif ( $self->payby eq 'COMP' ) {
1819 my $curuser = $FS::CurrentUser::CurrentUser;
1820 if ( ! $self->custnum
1821 && ! $curuser->access_right('Complimentary customer')
1824 return "You are not permitted to create complimentary accounts."
1827 $error = $self->ut_textn('payinfo');
1828 return "Illegal comp account issuer: ". $self->payinfo if $error;
1831 } elsif ( $self->payby eq 'PREPAY' ) {
1833 my $payinfo = $self->payinfo;
1834 $payinfo =~ s/\W//g; #anything else would just confuse things
1835 $self->payinfo($payinfo);
1836 $error = $self->ut_alpha('payinfo');
1837 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1838 return "Unknown prepayment identifier"
1839 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1844 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1845 return "Expiration date required"
1846 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1850 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1851 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1852 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1853 ( $m, $y ) = ( $2, "19$1" );
1854 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1855 ( $m, $y ) = ( $3, "20$2" );
1857 return "Illegal expiration date: ". $self->paydate;
1859 $self->paydate("$y-$m-01");
1860 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1861 return gettext('expired_card')
1863 && !$ignore_expired_card
1864 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1867 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1868 ( ! $conf->exists('require_cardname')
1869 || $self->payby !~ /^(CARD|DCRD)$/ )
1871 $self->payname( $self->first. " ". $self->getfield('last') );
1873 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1874 or return gettext('illegal_name'). " payname: ". $self->payname;
1878 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1879 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1883 $self->otaker(getotaker) unless $self->otaker;
1885 warn "$me check AFTER: \n". $self->_dump
1888 $self->SUPER::check;
1893 Returns a list of fields which have ship_ duplicates.
1898 qw( last first company
1899 address1 address2 city county state zip country
1904 =item has_ship_address
1906 Returns true if this customer record has a separate shipping address.
1910 sub has_ship_address {
1912 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1915 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1917 Returns all packages (see L<FS::cust_pkg>) for this customer.
1923 my $extra_qsearch = ref($_[0]) ? shift : {};
1925 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1928 if ( $self->{'_pkgnum'} ) {
1929 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1931 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1934 sort sort_packages @cust_pkg;
1939 Synonym for B<all_pkgs>.
1944 shift->all_pkgs(@_);
1949 Returns all locations (see L<FS::cust_location>) for this customer.
1955 qsearch('cust_location', { 'custnum' => $self->custnum } );
1958 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1960 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1964 sub ncancelled_pkgs {
1966 my $extra_qsearch = ref($_[0]) ? shift : {};
1968 return $self->num_ncancelled_pkgs unless wantarray;
1971 if ( $self->{'_pkgnum'} ) {
1973 warn "$me ncancelled_pkgs: returning cached objects"
1976 @cust_pkg = grep { ! $_->getfield('cancel') }
1977 values %{ $self->{'_pkgnum'}->cache };
1981 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1982 $self->custnum. "\n"
1985 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1987 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1991 sort sort_packages @cust_pkg;
1997 my $extra_qsearch = ref($_[0]) ? shift : {};
1999 $extra_qsearch->{'select'} ||= '*';
2000 $extra_qsearch->{'select'} .=
2001 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2005 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2010 'table' => 'cust_pkg',
2011 'hashref' => { 'custnum' => $self->custnum },
2016 # This should be generalized to use config options to determine order.
2019 if ( $a->get('cancel') xor $b->get('cancel') ) {
2020 return -1 if $b->get('cancel');
2021 return 1 if $a->get('cancel');
2022 #shouldn't get here...
2025 my $a_num_cust_svc = $a->num_cust_svc;
2026 my $b_num_cust_svc = $b->num_cust_svc;
2027 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2028 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2029 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2030 my @a_cust_svc = $a->cust_svc;
2031 my @b_cust_svc = $b->cust_svc;
2032 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2037 =item suspended_pkgs
2039 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2043 sub suspended_pkgs {
2045 grep { $_->susp } $self->ncancelled_pkgs;
2048 =item unflagged_suspended_pkgs
2050 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2051 customer (thouse packages without the `manual_flag' set).
2055 sub unflagged_suspended_pkgs {
2057 return $self->suspended_pkgs
2058 unless dbdef->table('cust_pkg')->column('manual_flag');
2059 grep { ! $_->manual_flag } $self->suspended_pkgs;
2062 =item unsuspended_pkgs
2064 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2069 sub unsuspended_pkgs {
2071 grep { ! $_->susp } $self->ncancelled_pkgs;
2074 =item next_bill_date
2076 Returns the next date this customer will be billed, as a UNIX timestamp, or
2077 undef if no active package has a next bill date.
2081 sub next_bill_date {
2083 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2086 =item num_cancelled_pkgs
2088 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2093 sub num_cancelled_pkgs {
2094 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2097 sub num_ncancelled_pkgs {
2098 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2102 my( $self ) = shift;
2103 my $sql = scalar(@_) ? shift : '';
2104 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2105 my $sth = dbh->prepare(
2106 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2107 ) or die dbh->errstr;
2108 $sth->execute($self->custnum) or die $sth->errstr;
2109 $sth->fetchrow_arrayref->[0];
2114 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2115 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2116 on success or a list of errors.
2122 grep { $_->unsuspend } $self->suspended_pkgs;
2127 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2129 Returns a list: an empty list on success or a list of errors.
2135 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2138 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2140 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2141 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2142 of a list of pkgparts; the hashref has the following keys:
2146 =item pkgparts - listref of pkgparts
2148 =item (other options are passed to the suspend method)
2153 Returns a list: an empty list on success or a list of errors.
2157 sub suspend_if_pkgpart {
2159 my (@pkgparts, %opt);
2160 if (ref($_[0]) eq 'HASH'){
2161 @pkgparts = @{$_[0]{pkgparts}};
2166 grep { $_->suspend(%opt) }
2167 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2168 $self->unsuspended_pkgs;
2171 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2173 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2174 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2175 instead of a list of pkgparts; the hashref has the following keys:
2179 =item pkgparts - listref of pkgparts
2181 =item (other options are passed to the suspend method)
2185 Returns a list: an empty list on success or a list of errors.
2189 sub suspend_unless_pkgpart {
2191 my (@pkgparts, %opt);
2192 if (ref($_[0]) eq 'HASH'){
2193 @pkgparts = @{$_[0]{pkgparts}};
2198 grep { $_->suspend(%opt) }
2199 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2200 $self->unsuspended_pkgs;
2203 =item cancel [ OPTION => VALUE ... ]
2205 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2207 Available options are:
2211 =item quiet - can be set true to supress email cancellation notices.
2213 =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.
2215 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2217 =item nobill - can be set true to skip billing if it might otherwise be done.
2221 Always returns a list: an empty list on success or a list of errors.
2225 # nb that dates are not specified as valid options to this method
2228 my( $self, %opt ) = @_;
2230 warn "$me cancel called on customer ". $self->custnum. " with options ".
2231 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2234 return ( 'access denied' )
2235 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2237 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2239 #should try decryption (we might have the private key)
2240 # and if not maybe queue a job for the server that does?
2241 return ( "Can't (yet) ban encrypted credit cards" )
2242 if $self->is_encrypted($self->payinfo);
2244 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2245 my $error = $ban->insert;
2246 return ( $error ) if $error;
2250 my @pkgs = $self->ncancelled_pkgs;
2252 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2254 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2255 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2259 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2260 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2263 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2266 sub _banned_pay_hashref {
2277 'payby' => $payby2ban{$self->payby},
2278 'payinfo' => md5_base64($self->payinfo),
2279 #don't ever *search* on reason! #'reason' =>
2285 Returns all notes (see L<FS::cust_main_note>) for this customer.
2292 qsearch( 'cust_main_note',
2293 { 'custnum' => $self->custnum },
2295 'ORDER BY _DATE DESC'
2301 Returns the agent (see L<FS::agent>) for this customer.
2307 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2312 Returns the customer class, as an FS::cust_class object, or the empty string
2313 if there is no customer class.
2319 if ( $self->classnum ) {
2320 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2328 Returns the customer category name, or the empty string if there is no customer
2335 my $cust_class = $self->cust_class;
2337 ? $cust_class->categoryname
2343 Returns the customer class name, or the empty string if there is no customer
2350 my $cust_class = $self->cust_class;
2352 ? $cust_class->classname
2357 =item bill_and_collect
2359 Cancels and suspends any packages due, generates bills, applies payments and
2362 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2364 Options are passed as name-value pairs. Currently available options are:
2370 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:
2374 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2378 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.
2382 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2386 If set true, re-charges setup fees.
2390 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)
2394 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2395 options of those methods are also available.
2399 sub bill_and_collect {
2400 my( $self, %options ) = @_;
2402 #$options{actual_time} not $options{time} because freeside-daily -d is for
2403 #pre-printing invoices
2404 $self->cancel_expired_pkgs( $options{actual_time} );
2405 $self->suspend_adjourned_pkgs( $options{actual_time} );
2407 my $error = $self->bill( %options );
2408 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2410 $self->apply_payments_and_credits;
2412 unless ( $conf->exists('cancelled_cust-noevents')
2413 && ! $self->num_ncancelled_pkgs
2416 $error = $self->collect( %options );
2417 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2423 sub cancel_expired_pkgs {
2424 my ( $self, $time ) = @_;
2426 my @cancel_pkgs = $self->ncancelled_pkgs( {
2427 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2430 foreach my $cust_pkg ( @cancel_pkgs ) {
2431 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2432 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2433 'reason_otaker' => $cpr->otaker
2437 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2438 " for custnum ". $self->custnum. ": $error"
2444 sub suspend_adjourned_pkgs {
2445 my ( $self, $time ) = @_;
2447 my @susp_pkgs = $self->ncancelled_pkgs( {
2449 " AND ( susp IS NULL OR susp = 0 )
2450 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2451 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2456 #only because there's no SQL test for is_prepaid :/
2458 grep { ( $_->part_pkg->is_prepaid
2463 && $_->adjourn <= $time
2469 foreach my $cust_pkg ( @susp_pkgs ) {
2470 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2471 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2472 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2473 'reason_otaker' => $cpr->otaker
2478 warn "Error suspending package ". $cust_pkg->pkgnum.
2479 " for custnum ". $self->custnum. ": $error"
2487 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2488 conjunction with the collect method by calling B<bill_and_collect>.
2490 If there is an error, returns the error, otherwise returns false.
2492 Options are passed as name-value pairs. Currently available options are:
2498 If set true, re-charges setup fees.
2502 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:
2506 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2510 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2512 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2516 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2520 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.
2524 This boolean value informs the us that the package is being cancelled. This
2525 typically might mean not charging the normal recurring fee but only usage
2526 fees since the last billing. Setup charges may be charged. Not all package
2527 plans support this feature (they tend to charge 0).
2531 Options terms to be printed on this invocice. Otherwise, customer-specific
2532 terms or the default terms are used.
2539 my( $self, %options ) = @_;
2540 return '' if $self->payby eq 'COMP';
2541 warn "$me bill customer ". $self->custnum. "\n"
2544 my $time = $options{'time'} || time;
2545 my $invoice_time = $options{'invoice_time'} || $time;
2547 $options{'not_pkgpart'} ||= {};
2548 $options{'not_pkgpart'} = { map { $_ => 1 }
2549 split(/\s*,\s*/, $options{'not_pkgpart'})
2551 unless ref($options{'not_pkgpart'});
2553 local $SIG{HUP} = 'IGNORE';
2554 local $SIG{INT} = 'IGNORE';
2555 local $SIG{QUIT} = 'IGNORE';
2556 local $SIG{TERM} = 'IGNORE';
2557 local $SIG{TSTP} = 'IGNORE';
2558 local $SIG{PIPE} = 'IGNORE';
2560 my $oldAutoCommit = $FS::UID::AutoCommit;
2561 local $FS::UID::AutoCommit = 0;
2564 $self->select_for_update; #mutex
2566 my $error = $self->do_cust_event(
2567 'debug' => ( $options{'debug'} || 0 ),
2568 'time' => $invoice_time,
2569 'check_freq' => $options{'check_freq'},
2570 'stage' => 'pre-bill',
2573 $dbh->rollback if $oldAutoCommit;
2577 my @cust_bill_pkg = ();
2580 # find the packages which are due for billing, find out how much they are
2581 # & generate invoice database.
2584 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2586 my @precommit_hooks = ();
2588 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2589 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2591 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2593 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2595 #? to avoid use of uninitialized value errors... ?
2596 $cust_pkg->setfield('bill', '')
2597 unless defined($cust_pkg->bill);
2599 #my $part_pkg = $cust_pkg->part_pkg;
2601 my $real_pkgpart = $cust_pkg->pkgpart;
2602 my %hash = $cust_pkg->hash;
2604 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2606 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2609 $self->_make_lines( 'part_pkg' => $part_pkg,
2610 'cust_pkg' => $cust_pkg,
2611 'precommit_hooks' => \@precommit_hooks,
2612 'line_items' => \@cust_bill_pkg,
2613 'setup' => \$total_setup,
2614 'recur' => \$total_recur,
2615 'tax_matrix' => \%taxlisthash,
2617 'real_pkgpart' => $real_pkgpart,
2618 'options' => \%options,
2621 $dbh->rollback if $oldAutoCommit;
2625 } #foreach my $part_pkg
2627 } #foreach my $cust_pkg
2629 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2630 #but do commit any package date cycling that happened
2631 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2635 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2636 !$conf->exists('postal_invoice-recurring_only')
2640 my $postal_pkg = $self->charge_postal_fee();
2641 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2643 $dbh->rollback if $oldAutoCommit;
2644 return "can't charge postal invoice fee for customer ".
2645 $self->custnum. ": $postal_pkg";
2647 } elsif ( $postal_pkg ) {
2649 my $real_pkgpart = $postal_pkg->pkgpart;
2650 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2651 my %postal_options = %options;
2652 delete $postal_options{cancel};
2654 $self->_make_lines( 'part_pkg' => $part_pkg,
2655 'cust_pkg' => $postal_pkg,
2656 'precommit_hooks' => \@precommit_hooks,
2657 'line_items' => \@cust_bill_pkg,
2658 'setup' => \$total_setup,
2659 'recur' => \$total_recur,
2660 'tax_matrix' => \%taxlisthash,
2662 'real_pkgpart' => $real_pkgpart,
2663 'options' => \%postal_options,
2666 $dbh->rollback if $oldAutoCommit;
2675 my $listref_or_error =
2676 $self->calculate_taxes( \@cust_bill_pkg, \%taxlisthash, $invoice_time);
2678 unless ( ref( $listref_or_error ) ) {
2679 $dbh->rollback if $oldAutoCommit;
2680 return $listref_or_error;
2683 foreach my $taxline ( @$listref_or_error ) {
2684 $total_setup = sprintf('%.2f', $total_setup+$taxline->setup );
2685 push @cust_bill_pkg, $taxline;
2688 #add tax adjustments
2689 warn "adding tax adjustments...\n" if $DEBUG > 2;
2690 foreach my $cust_tax_adjustment (
2691 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2697 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2699 my $itemdesc = $cust_tax_adjustment->taxname;
2700 $itemdesc = '' if $itemdesc eq 'Tax';
2702 push @cust_bill_pkg, new FS::cust_bill_pkg {
2708 'itemdesc' => $itemdesc,
2709 'itemcomment' => $cust_tax_adjustment->comment,
2710 'cust_tax_adjustment' => $cust_tax_adjustment,
2711 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2716 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2718 my @cust_bill = $self->cust_bill;
2719 my $balance = $self->balance;
2720 my $previous_balance = scalar(@cust_bill)
2721 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2724 $previous_balance += $cust_bill[$#cust_bill]->charged
2725 if scalar(@cust_bill);
2726 #my $balance_adjustments =
2727 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2729 #create the new invoice
2730 my $cust_bill = new FS::cust_bill ( {
2731 'custnum' => $self->custnum,
2732 '_date' => ( $invoice_time ),
2733 'charged' => $charged,
2734 'billing_balance' => $balance,
2735 'previous_balance' => $previous_balance,
2736 'invoice_terms' => $options{'invoice_terms'},
2738 $error = $cust_bill->insert;
2740 $dbh->rollback if $oldAutoCommit;
2741 return "can't create invoice for customer #". $self->custnum. ": $error";
2744 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2745 $cust_bill_pkg->invnum($cust_bill->invnum);
2746 my $error = $cust_bill_pkg->insert;
2748 $dbh->rollback if $oldAutoCommit;
2749 return "can't create invoice line item: $error";
2754 foreach my $hook ( @precommit_hooks ) {
2756 &{$hook}; #($self) ?
2759 $dbh->rollback if $oldAutoCommit;
2760 return "$@ running precommit hook $hook\n";
2764 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2768 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
2770 This is a weird one. Perhaps it should not even be exposed.
2772 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
2773 Usually used internally by bill method B<bill>.
2775 If there is an error, returns the error, otherwise returns reference to a
2776 list of line items suitable for insertion.
2782 An array ref of the line items being billed.
2786 A strange beast. The keys to this hash are internal identifiers consisting
2787 of the name of the tax object type, a space, and its unique identifier ( e.g.
2788 'cust_main_county 23' ). The values of the hash are listrefs. The first
2789 item in the list is the tax object. The remaining items are either line
2790 items or floating point values (currency amounts).
2792 The taxes are calculated on this entity. Calculated exemption records are
2793 transferred to the LINEITEMREF items on the assumption that they are related.
2799 This specifies the date appearing on the associated invoice. Some
2800 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
2805 sub calculate_taxes {
2806 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
2808 my @tax_line_items = ();
2810 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2812 # keys are tax names (as printed on invoices / itemdesc )
2813 # values are listrefs of taxlisthash keys (internal identifiers)
2816 # keys are taxlisthash keys (internal identifiers)
2817 # values are (cumulative) amounts
2820 # keys are taxlisthash keys (internal identifiers)
2821 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2822 my %tax_location = ();
2824 # keys are taxlisthash keys (internal identifiers)
2825 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2826 my %tax_rate_location = ();
2828 foreach my $tax ( keys %$taxlisthash ) {
2829 my $tax_object = shift @{ $taxlisthash->{$tax} };
2830 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2831 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
2832 my $hashref_or_error =
2833 $tax_object->taxline( $taxlisthash->{$tax},
2834 'custnum' => $self->custnum,
2835 'invoice_time' => $invoice_time
2837 return $hashref_or_error unless ref($hashref_or_error);
2839 unshift @{ $taxlisthash->{$tax} }, $tax_object;
2841 my $name = $hashref_or_error->{'name'};
2842 my $amount = $hashref_or_error->{'amount'};
2844 #warn "adding $amount as $name\n";
2845 $taxname{ $name } ||= [];
2846 push @{ $taxname{ $name } }, $tax;
2848 $tax{ $tax } += $amount;
2850 $tax_location{ $tax } ||= [];
2851 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2852 push @{ $tax_location{ $tax } },
2854 'taxnum' => $tax_object->taxnum,
2855 'taxtype' => ref($tax_object),
2856 'pkgnum' => $tax_object->get('pkgnum'),
2857 'locationnum' => $tax_object->get('locationnum'),
2858 'amount' => sprintf('%.2f', $amount ),
2862 $tax_rate_location{ $tax } ||= [];
2863 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2864 my $taxratelocationnum =
2865 $tax_object->tax_rate_location->taxratelocationnum;
2866 push @{ $tax_rate_location{ $tax } },
2868 'taxnum' => $tax_object->taxnum,
2869 'taxtype' => ref($tax_object),
2870 'amount' => sprintf('%.2f', $amount ),
2871 'locationtaxid' => $tax_object->location,
2872 'taxratelocationnum' => $taxratelocationnum,
2878 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2879 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
2880 foreach my $tax ( keys %$taxlisthash ) {
2881 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
2882 next unless ref($_) eq 'FS::cust_bill_pkg';
2884 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2885 splice( @{ $_->_cust_tax_exempt_pkg } );
2889 #consolidate and create tax line items
2890 warn "consolidating and generating...\n" if $DEBUG > 2;
2891 foreach my $taxname ( keys %taxname ) {
2894 my @cust_bill_pkg_tax_location = ();
2895 my @cust_bill_pkg_tax_rate_location = ();
2896 warn "adding $taxname\n" if $DEBUG > 1;
2897 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2898 next if $seen{$taxitem}++;
2899 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2900 $tax += $tax{$taxitem};
2901 push @cust_bill_pkg_tax_location,
2902 map { new FS::cust_bill_pkg_tax_location $_ }
2903 @{ $tax_location{ $taxitem } };
2904 push @cust_bill_pkg_tax_rate_location,
2905 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2906 @{ $tax_rate_location{ $taxitem } };
2910 $tax = sprintf('%.2f', $tax );
2912 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2918 if ( $pkg_category and
2919 $conf->config('invoice_latexsummary') ||
2920 $conf->config('invoice_htmlsummary')
2924 my %hash = ( 'section' => $pkg_category->categoryname );
2925 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2929 push @tax_line_items, new FS::cust_bill_pkg {
2935 'itemdesc' => $taxname,
2936 'display' => \@display,
2937 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2938 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2947 my ($self, %params) = @_;
2949 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2950 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2951 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2952 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2953 my $total_setup = $params{setup} or die "no setup accumulator specified";
2954 my $total_recur = $params{recur} or die "no recur accumulator specified";
2955 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2956 my $time = $params{'time'} or die "no time specified";
2957 my (%options) = %{$params{options}};
2960 my $real_pkgpart = $params{real_pkgpart};
2961 my %hash = $cust_pkg->hash;
2962 my $old_cust_pkg = new FS::cust_pkg \%hash;
2968 $cust_pkg->pkgpart($part_pkg->pkgpart);
2976 if ( $options{'resetup'}
2977 || ( ! $cust_pkg->setup
2978 && ( ! $cust_pkg->start_date
2979 || $cust_pkg->start_date <= $time
2981 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2982 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2983 ! $cust_pkg->getfield('susp')
2990 warn " bill setup\n" if $DEBUG > 1;
2993 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2994 return "$@ running calc_setup for $cust_pkg\n"
2997 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2999 $cust_pkg->setfield('setup', $time)
3000 unless $cust_pkg->setup;
3001 #do need it, but it won't get written to the db
3002 #|| $cust_pkg->pkgpart != $real_pkgpart;
3004 $cust_pkg->setfield('start_date', '')
3005 if $cust_pkg->start_date;
3010 # bill recurring fee
3013 #XXX unit stuff here too
3017 if ( ! $cust_pkg->get('susp')
3018 and ! $cust_pkg->get('start_date')
3019 and ( $part_pkg->getfield('freq') ne '0'
3020 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3022 || ( $part_pkg->plan eq 'voip_cdr'
3023 && $part_pkg->option('bill_every_call')
3025 || ( $options{cancel} )
3028 # XXX should this be a package event? probably. events are called
3029 # at collection time at the moment, though...
3030 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
3031 if $part_pkg->can('reset_usage');
3032 #don't want to reset usage just cause we want a line item??
3033 #&& $part_pkg->pkgpart == $real_pkgpart;
3035 warn " bill recur\n" if $DEBUG > 1;
3038 # XXX shared with $recur_prog
3039 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
3043 #over two params! lets at least switch to a hashref for the rest...
3044 my $increment_next_bill = ( $part_pkg->freq ne '0'
3045 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
3046 && !$options{cancel}
3048 my %param = ( 'precommit_hooks' => $precommit_hooks,
3049 'increment_next_bill' => $increment_next_bill,
3052 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3053 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3054 return "$@ running $method for $cust_pkg\n"
3057 if ( $increment_next_bill ) {
3059 my $next_bill = $part_pkg->add_freq($sdate);
3060 return "unparsable frequency: ". $part_pkg->freq
3061 if $next_bill == -1;
3063 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3064 # only for figuring next bill date, nothing else, so, reset $sdate again
3066 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3067 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3068 $cust_pkg->last_bill($sdate);
3070 $cust_pkg->setfield('bill', $next_bill );
3076 warn "\$setup is undefined" unless defined($setup);
3077 warn "\$recur is undefined" unless defined($recur);
3078 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3081 # If there's line items, create em cust_bill_pkg records
3082 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3087 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3088 # hmm.. and if just the options are modified in some weird price plan?
3090 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
3093 my $error = $cust_pkg->replace( $old_cust_pkg,
3094 'options' => { $cust_pkg->options },
3096 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3097 if $error; #just in case
3100 $setup = sprintf( "%.2f", $setup );
3101 $recur = sprintf( "%.2f", $recur );
3102 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3103 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3105 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3106 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3109 if ( $setup != 0 || $recur != 0 ) {
3111 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3114 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3116 warn " adding customer package invoice detail: $_\n"
3117 foreach @cust_pkg_detail;
3119 push @details, @cust_pkg_detail;
3121 my $cust_bill_pkg = new FS::cust_bill_pkg {
3122 'pkgnum' => $cust_pkg->pkgnum,
3124 'unitsetup' => $unitsetup,
3126 'unitrecur' => $unitrecur,
3127 'quantity' => $cust_pkg->quantity,
3128 'details' => \@details,
3129 'hidden' => $part_pkg->hidden,
3132 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3133 $cust_bill_pkg->sdate( $hash{last_bill} );
3134 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3135 $cust_bill_pkg->edate( $time ) if $options{cancel};
3136 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3137 $cust_bill_pkg->sdate( $sdate );
3138 $cust_bill_pkg->edate( $cust_pkg->bill );
3139 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3142 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3143 unless $part_pkg->pkgpart == $real_pkgpart;
3145 $$total_setup += $setup;
3146 $$total_recur += $recur;
3153 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3154 return $error if $error;
3156 push @$cust_bill_pkgs, $cust_bill_pkg;
3158 } #if $setup != 0 || $recur != 0
3168 my $part_pkg = shift;
3169 my $taxlisthash = shift;
3170 my $cust_bill_pkg = shift;
3171 my $cust_pkg = shift;
3172 my $invoice_time = shift;
3173 my $real_pkgpart = shift;
3174 my $options = shift;
3176 my %cust_bill_pkg = ();
3180 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3181 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3182 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3183 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3185 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3187 if ( $conf->exists('enable_taxproducts')
3188 && ( scalar($part_pkg->part_pkg_taxoverride)
3189 || $part_pkg->has_taxproduct
3194 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3195 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3198 foreach my $class (@classes) {
3199 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3200 return $err_or_ref unless ref($err_or_ref);
3201 $taxes{$class} = $err_or_ref;
3204 unless (exists $taxes{''}) {
3205 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3206 return $err_or_ref unless ref($err_or_ref);
3207 $taxes{''} = $err_or_ref;
3212 my @loc_keys = qw( city county state country );
3214 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3215 my $cust_location = $cust_pkg->cust_location;
3216 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3219 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3222 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3225 $taxhash{'taxclass'} = $part_pkg->taxclass;
3228 my %taxhash_elim = %taxhash;
3229 my @elim = qw( city county state );
3232 #first try a match with taxclass
3233 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3235 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
3236 #then try a match without taxclass
3237 my %no_taxclass = %taxhash_elim;
3238 $no_taxclass{ 'taxclass' } = '';
3239 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
3242 $taxhash_elim{ shift(@elim) } = '';
3244 } while ( !scalar(@taxes) && scalar(@elim) );
3246 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3248 if $self->cust_main_exemption; #just to be safe
3250 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3252 $_->set('pkgnum', $cust_pkg->pkgnum );
3253 $_->set('locationnum', $cust_pkg->locationnum );
3257 $taxes{''} = [ @taxes ];
3258 $taxes{'setup'} = [ @taxes ];
3259 $taxes{'recur'} = [ @taxes ];
3260 $taxes{$_} = [ @taxes ] foreach (@classes);
3262 # # maybe eliminate this entirely, along with all the 0% records
3263 # unless ( @taxes ) {
3265 # "fatal: can't find tax rate for state/county/country/taxclass ".
3266 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3269 } #if $conf->exists('enable_taxproducts') ...
3274 my $separate = $conf->exists('separate_usage');
3275 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3276 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3278 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3279 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3280 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3283 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3284 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3286 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3287 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3289 push @display, new FS::cust_bill_pkg_display
3292 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3296 if ($separate && $section && $summary) {
3297 push @display, new FS::cust_bill_pkg_display { type => 'U',
3302 if ($usage_mandate || $section && $summary) {
3303 $hash{post_total} = 'Y';
3306 $hash{section} = $section if ($separate || $usage_mandate);
3307 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3310 $cust_bill_pkg->set('display', \@display);
3312 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3313 foreach my $key (keys %tax_cust_bill_pkg) {
3314 my @taxes = @{ $taxes{$key} || [] };
3315 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3317 my %localtaxlisthash = ();
3318 foreach my $tax ( @taxes ) {
3320 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3321 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3322 # ' locationnum'. $cust_pkg->locationnum
3323 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3325 $taxlisthash->{ $taxname } ||= [ $tax ];
3326 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3328 $localtaxlisthash{ $taxname } ||= [ $tax ];
3329 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3333 warn "finding taxed taxes...\n" if $DEBUG > 2;
3334 foreach my $tax ( keys %localtaxlisthash ) {
3335 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3336 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3338 next unless $tax_object->can('tax_on_tax');
3340 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3341 my $totname = ref( $tot ). ' '. $tot->taxnum;
3343 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3345 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3347 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3348 my $hashref_or_error =
3349 $tax_object->taxline( $localtaxlisthash{$tax},
3350 'custnum' => $self->custnum,
3351 'invoice_time' => $invoice_time,
3353 return $hashref_or_error
3354 unless ref($hashref_or_error);
3356 $taxlisthash->{ $totname } ||= [ $tot ];
3357 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3369 my $part_pkg = shift;
3373 my $geocode = $self->geocode('cch');
3375 my @taxclassnums = map { $_->taxclassnum }
3376 $part_pkg->part_pkg_taxoverride($class);
3378 unless (@taxclassnums) {
3379 @taxclassnums = map { $_->taxclassnum }
3380 grep { $_->taxable eq 'Y' }
3381 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3383 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3388 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3390 @taxes = qsearch({ 'table' => 'tax_rate',
3391 'hashref' => { 'geocode' => $geocode, },
3392 'extra_sql' => $extra_sql,
3394 if scalar(@taxclassnums);
3396 warn "Found taxes ".
3397 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3404 =item collect [ HASHREF | OPTION => VALUE ... ]
3406 (Attempt to) collect money for this customer's outstanding invoices (see
3407 L<FS::cust_bill>). Usually used after the bill method.
3409 Actions are now triggered by billing events; see L<FS::part_event> and the
3410 billing events web interface. Old-style invoice events (see
3411 L<FS::part_bill_event>) have been deprecated.
3413 If there is an error, returns the error, otherwise returns false.
3415 Options are passed as name-value pairs.
3417 Currently available options are:
3423 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.
3427 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3431 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3435 set true to surpress email card/ACH decline notices.
3439 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)
3445 # allows for one time override of normal customer billing method
3450 my( $self, %options ) = @_;
3451 my $invoice_time = $options{'invoice_time'} || time;
3454 local $SIG{HUP} = 'IGNORE';
3455 local $SIG{INT} = 'IGNORE';
3456 local $SIG{QUIT} = 'IGNORE';
3457 local $SIG{TERM} = 'IGNORE';
3458 local $SIG{TSTP} = 'IGNORE';
3459 local $SIG{PIPE} = 'IGNORE';
3461 my $oldAutoCommit = $FS::UID::AutoCommit;
3462 local $FS::UID::AutoCommit = 0;
3465 $self->select_for_update; #mutex
3468 my $balance = $self->balance;
3469 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3472 if ( exists($options{'retry_card'}) ) {
3473 carp 'retry_card option passed to collect is deprecated; use retry';
3474 $options{'retry'} ||= $options{'retry_card'};
3476 if ( exists($options{'retry'}) && $options{'retry'} ) {
3477 my $error = $self->retry_realtime;
3479 $dbh->rollback if $oldAutoCommit;
3484 my $error = $self->do_cust_event(
3485 'debug' => ( $options{'debug'} || 0 ),
3486 'time' => $invoice_time,
3487 'check_freq' => $options{'check_freq'},
3488 'stage' => 'collect',
3491 $dbh->rollback if $oldAutoCommit;
3495 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3500 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3502 Runs billing events; see L<FS::part_event> and the billing events web
3505 If there is an error, returns the error, otherwise returns false.
3507 Options are passed as name-value pairs.
3509 Currently available options are:
3515 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.
3519 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3523 "collect" (the default) or "pre-bill"
3527 set true to surpress email card/ACH decline notices.
3531 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)
3537 # allows for one time override of normal customer billing method
3541 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3544 my( $self, %options ) = @_;
3545 my $time = $options{'time'} || time;
3548 local $SIG{HUP} = 'IGNORE';
3549 local $SIG{INT} = 'IGNORE';
3550 local $SIG{QUIT} = 'IGNORE';
3551 local $SIG{TERM} = 'IGNORE';
3552 local $SIG{TSTP} = 'IGNORE';
3553 local $SIG{PIPE} = 'IGNORE';
3555 my $oldAutoCommit = $FS::UID::AutoCommit;
3556 local $FS::UID::AutoCommit = 0;
3559 $self->select_for_update; #mutex
3562 my $balance = $self->balance;
3563 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3566 # if ( exists($options{'retry_card'}) ) {
3567 # carp 'retry_card option passed to collect is deprecated; use retry';
3568 # $options{'retry'} ||= $options{'retry_card'};
3570 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3571 # my $error = $self->retry_realtime;
3573 # $dbh->rollback if $oldAutoCommit;
3578 # false laziness w/pay_batch::import_results
3580 my $due_cust_event = $self->due_cust_event(
3581 'debug' => ( $options{'debug'} || 0 ),
3583 'check_freq' => $options{'check_freq'},
3584 'stage' => ( $options{'stage'} || 'collect' ),
3586 unless( ref($due_cust_event) ) {
3587 $dbh->rollback if $oldAutoCommit;
3588 return $due_cust_event;
3591 foreach my $cust_event ( @$due_cust_event ) {
3595 #re-eval event conditions (a previous event could have changed things)
3596 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3597 #don't leave stray "new/locked" records around
3598 my $error = $cust_event->delete;
3600 #gah, even with transactions
3601 $dbh->commit if $oldAutoCommit; #well.
3608 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3609 warn " running cust_event ". $cust_event->eventnum. "\n"
3613 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3614 if ( my $error = $cust_event->do_event() ) {
3615 #XXX wtf is this? figure out a proper dealio with return value
3617 # gah, even with transactions.
3618 $dbh->commit if $oldAutoCommit; #well.
3625 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3630 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3632 Inserts database records for and returns an ordered listref of new events due
3633 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3634 events are due, an empty listref is returned. If there is an error, returns a
3635 scalar error message.
3637 To actually run the events, call each event's test_condition method, and if
3638 still true, call the event's do_event method.
3640 Options are passed as a hashref or as a list of name-value pairs. Available
3647 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.
3651 "collect" (the default) or "pre-bill"
3655 "Current time" for the events.
3659 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)
3663 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3667 Explicitly pass the objects to be tested (typically used with eventtable).
3671 Set to true to return the objects, but not actually insert them into the
3678 sub due_cust_event {
3680 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3683 #my $DEBUG = $opt{'debug'}
3684 local($DEBUG) = $opt{'debug'}
3685 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3687 warn "$me due_cust_event called with options ".
3688 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3691 $opt{'time'} ||= time;
3693 local $SIG{HUP} = 'IGNORE';
3694 local $SIG{INT} = 'IGNORE';
3695 local $SIG{QUIT} = 'IGNORE';
3696 local $SIG{TERM} = 'IGNORE';
3697 local $SIG{TSTP} = 'IGNORE';
3698 local $SIG{PIPE} = 'IGNORE';
3700 my $oldAutoCommit = $FS::UID::AutoCommit;
3701 local $FS::UID::AutoCommit = 0;
3704 $self->select_for_update #mutex
3705 unless $opt{testonly};
3708 # find possible events (initial search)
3711 my @cust_event = ();
3713 my @eventtable = $opt{'eventtable'}
3714 ? ( $opt{'eventtable'} )
3715 : FS::part_event->eventtables_runorder;
3717 foreach my $eventtable ( @eventtable ) {
3720 if ( $opt{'objects'} ) {
3722 @objects = @{ $opt{'objects'} };
3726 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3727 @objects = ( $eventtable eq 'cust_main' )
3729 : ( $self->$eventtable() );
3733 my @e_cust_event = ();
3735 my $cross = "CROSS JOIN $eventtable";
3736 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3737 unless $eventtable eq 'cust_main';
3739 foreach my $object ( @objects ) {
3741 #this first search uses the condition_sql magic for optimization.
3742 #the more possible events we can eliminate in this step the better
3744 my $cross_where = '';
3745 my $pkey = $object->primary_key;
3746 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3748 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3750 FS::part_event_condition->where_conditions_sql( $eventtable,
3751 'time'=>$opt{'time'}
3753 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3755 $extra_sql = "AND $extra_sql" if $extra_sql;
3757 #here is the agent virtualization
3758 $extra_sql .= " AND ( part_event.agentnum IS NULL
3759 OR part_event.agentnum = ". $self->agentnum. ' )';
3761 $extra_sql .= " $order";
3763 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3764 if $opt{'debug'} > 2;
3765 my @part_event = qsearch( {
3766 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3767 'select' => 'part_event.*',
3768 'table' => 'part_event',
3769 'addl_from' => "$cross $join",
3770 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3771 'eventtable' => $eventtable,
3774 'extra_sql' => "AND $cross_where $extra_sql",
3778 my $pkey = $object->primary_key;
3779 warn " ". scalar(@part_event).
3780 " possible events found for $eventtable ". $object->$pkey(). "\n";
3783 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3787 warn " ". scalar(@e_cust_event).
3788 " subtotal possible cust events found for $eventtable\n"
3791 push @cust_event, @e_cust_event;
3795 warn " ". scalar(@cust_event).
3796 " total possible cust events found in initial search\n"
3804 $opt{stage} ||= 'collect';
3806 grep { my $stage = $_->part_event->event_stage;
3807 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3817 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3818 'stats_hashref' => \%unsat ),
3821 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3824 warn " invalid conditions not eliminated with condition_sql:\n".
3825 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3832 unless( $opt{testonly} ) {
3833 foreach my $cust_event ( @cust_event ) {
3835 my $error = $cust_event->insert();
3837 $dbh->rollback if $oldAutoCommit;
3844 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3850 warn " returning events: ". Dumper(@cust_event). "\n"
3857 =item retry_realtime
3859 Schedules realtime / batch credit card / electronic check / LEC billing
3860 events for for retry. Useful if card information has changed or manual
3861 retry is desired. The 'collect' method must be called to actually retry
3864 Implementation details: For either this customer, or for each of this
3865 customer's open invoices, changes the status of the first "done" (with
3866 statustext error) realtime processing event to "failed".
3870 sub retry_realtime {
3873 local $SIG{HUP} = 'IGNORE';
3874 local $SIG{INT} = 'IGNORE';
3875 local $SIG{QUIT} = 'IGNORE';
3876 local $SIG{TERM} = 'IGNORE';
3877 local $SIG{TSTP} = 'IGNORE';
3878 local $SIG{PIPE} = 'IGNORE';
3880 my $oldAutoCommit = $FS::UID::AutoCommit;
3881 local $FS::UID::AutoCommit = 0;
3884 #a little false laziness w/due_cust_event (not too bad, really)
3886 my $join = FS::part_event_condition->join_conditions_sql;
3887 my $order = FS::part_event_condition->order_conditions_sql;
3890 . join ( ' OR ' , map {
3891 "( part_event.eventtable = " . dbh->quote($_)
3892 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3893 } FS::part_event->eventtables)
3896 #here is the agent virtualization
3897 my $agent_virt = " ( part_event.agentnum IS NULL
3898 OR part_event.agentnum = ". $self->agentnum. ' )';
3900 #XXX this shouldn't be hardcoded, actions should declare it...
3901 my @realtime_events = qw(
3902 cust_bill_realtime_card
3903 cust_bill_realtime_check
3904 cust_bill_realtime_lec
3908 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3913 my @cust_event = qsearchs({
3914 'table' => 'cust_event',
3915 'select' => 'cust_event.*',
3916 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3917 'hashref' => { 'status' => 'done' },
3918 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3919 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3922 my %seen_invnum = ();
3923 foreach my $cust_event (@cust_event) {
3925 #max one for the customer, one for each open invoice
3926 my $cust_X = $cust_event->cust_X;
3927 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3931 or $cust_event->part_event->eventtable eq 'cust_bill'
3934 my $error = $cust_event->retry;
3936 $dbh->rollback if $oldAutoCommit;
3937 return "error scheduling event for retry: $error";
3942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3947 # some horrid false laziness here to avoid refactor fallout
3948 # eventually realtime realtime_bop and realtime_refund_bop should go
3949 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3951 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3953 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3954 via a Business::OnlinePayment realtime gateway. See
3955 L<http://420.am/business-onlinepayment> for supported gateways.
3957 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3959 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3961 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3962 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3963 if set, will override the value from the customer record.
3965 I<description> is a free-text field passed to the gateway. It defaults to
3966 "Internet services".
3968 If an I<invnum> is specified, this payment (if successful) is applied to the
3969 specified invoice. If you don't specify an I<invnum> you might want to
3970 call the B<apply_payments> method or set the I<apply> option.
3972 I<apply> can be set to true to apply a resulting payment.
3974 I<quiet> can be set true to surpress email decline notices.
3976 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3977 resulting paynum, if any.
3979 I<payunique> is a unique identifier for this payment.
3981 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3988 return $self->_new_realtime_bop(@_)
3989 if $self->_new_bop_required();
3991 my($method, $amount);
3993 if (ref($_[0]) eq 'HASH') {
3994 %options = %{$_[0]};
3995 $method = $options{method};
3996 $amount = $options{amount};
3998 ( $method, $amount ) = ( shift, shift );
4002 warn "$me realtime_bop: $method $amount\n";
4003 warn " $_ => $options{$_}\n" foreach keys %options;
4006 $options{'description'} ||= 'Internet services';
4008 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4010 eval "use Business::OnlinePayment";
4013 my $payinfo = exists($options{'payinfo'})
4014 ? $options{'payinfo'}
4017 my %method2payby = (
4024 # check for banned credit card/ACH
4027 my $ban = qsearchs('banned_pay', {
4028 'payby' => $method2payby{$method},
4029 'payinfo' => md5_base64($payinfo),
4031 return "Banned credit card" if $ban;
4034 # set taxclass and trans_is_recur based on invnum if there is one
4038 my $trans_is_recur = 0;
4039 if ( $options{'invnum'} ) {
4041 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4042 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4045 map { $_->part_pkg }
4047 map { $_->cust_pkg }
4048 $cust_bill->cust_bill_pkg;
4050 my @taxclasses = map $_->taxclass, @part_pkg;
4051 $taxclass = $taxclasses[0]
4052 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4053 #different taxclasses
4055 if grep { $_->freq ne '0' } @part_pkg;
4063 #look for an agent gateway override first
4065 if ( $method eq 'CC' ) {
4066 $cardtype = cardtype($payinfo);
4067 } elsif ( $method eq 'ECHECK' ) {
4070 $cardtype = $method;
4074 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4075 cardtype => $cardtype,
4076 taxclass => $taxclass, } )
4077 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4079 taxclass => $taxclass, } )
4080 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4081 cardtype => $cardtype,
4083 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4085 taxclass => '', } );
4087 my $payment_gateway = '';
4088 my( $processor, $login, $password, $action, @bop_options );
4089 if ( $override ) { #use a payment gateway override
4091 $payment_gateway = $override->payment_gateway;
4093 $processor = $payment_gateway->gateway_module;
4094 $login = $payment_gateway->gateway_username;
4095 $password = $payment_gateway->gateway_password;
4096 $action = $payment_gateway->gateway_action;
4097 @bop_options = $payment_gateway->options;
4099 } else { #use the standard settings from the config
4101 ( $processor, $login, $password, $action, @bop_options ) =
4102 $self->default_payment_gateway($method);
4110 my $address = exists($options{'address1'})
4111 ? $options{'address1'}
4113 my $address2 = exists($options{'address2'})
4114 ? $options{'address2'}
4116 $address .= ", ". $address2 if length($address2);
4118 my $o_payname = exists($options{'payname'})
4119 ? $options{'payname'}
4121 my($payname, $payfirst, $paylast);
4122 if ( $o_payname && $method ne 'ECHECK' ) {
4123 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4124 or return "Illegal payname $payname";
4125 ($payfirst, $paylast) = ($1, $2);
4127 $payfirst = $self->getfield('first');
4128 $paylast = $self->getfield('last');
4129 $payname = "$payfirst $paylast";
4132 my @invoicing_list = $self->invoicing_list_emailonly;
4133 if ( $conf->exists('emailinvoiceautoalways')
4134 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4135 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4136 push @invoicing_list, $self->all_emails;
4139 my $email = ($conf->exists('business-onlinepayment-email-override'))
4140 ? $conf->config('business-onlinepayment-email-override')
4141 : $invoicing_list[0];
4145 my $payip = exists($options{'payip'})
4148 $content{customer_ip} = $payip
4151 $content{invoice_number} = $options{'invnum'}
4152 if exists($options{'invnum'}) && length($options{'invnum'});
4154 $content{email_customer} =
4155 ( $conf->exists('business-onlinepayment-email_customer')
4156 || $conf->exists('business-onlinepayment-email-override') );
4159 if ( $method eq 'CC' ) {
4161 $content{card_number} = $payinfo;
4162 $paydate = exists($options{'paydate'})
4163 ? $options{'paydate'}
4165 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4166 $content{expiration} = "$2/$1";
4168 my $paycvv = exists($options{'paycvv'})
4169 ? $options{'paycvv'}
4171 $content{cvv2} = $paycvv
4174 my $paystart_month = exists($options{'paystart_month'})
4175 ? $options{'paystart_month'}
4176 : $self->paystart_month;
4178 my $paystart_year = exists($options{'paystart_year'})
4179 ? $options{'paystart_year'}
4180 : $self->paystart_year;
4182 $content{card_start} = "$paystart_month/$paystart_year"
4183 if $paystart_month && $paystart_year;
4185 my $payissue = exists($options{'payissue'})
4186 ? $options{'payissue'}
4188 $content{issue_number} = $payissue if $payissue;
4190 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4191 'trans_is_recur' => $trans_is_recur,
4195 $content{recurring_billing} = 'YES';
4196 $content{acct_code} = 'rebill'
4197 if $conf->exists('credit_card-recurring_billing_acct_code');
4200 } elsif ( $method eq 'ECHECK' ) {
4201 ( $content{account_number}, $content{routing_code} ) =
4202 split('@', $payinfo);
4203 $content{bank_name} = $o_payname;
4204 $content{bank_state} = exists($options{'paystate'})
4205 ? $options{'paystate'}
4206 : $self->getfield('paystate');
4207 $content{account_type} = exists($options{'paytype'})
4208 ? uc($options{'paytype'}) || 'CHECKING'
4209 : uc($self->getfield('paytype')) || 'CHECKING';
4210 $content{account_name} = $payname;
4211 $content{customer_org} = $self->company ? 'B' : 'I';
4212 $content{state_id} = exists($options{'stateid'})
4213 ? $options{'stateid'}
4214 : $self->getfield('stateid');
4215 $content{state_id_state} = exists($options{'stateid_state'})
4216 ? $options{'stateid_state'}
4217 : $self->getfield('stateid_state');
4218 $content{customer_ssn} = exists($options{'ss'})
4221 } elsif ( $method eq 'LEC' ) {
4222 $content{phone} = $payinfo;
4226 # run transaction(s)
4229 my $balance = exists( $options{'balance'} )
4230 ? $options{'balance'}
4233 $self->select_for_update; #mutex ... just until we get our pending record in
4235 #the checks here are intended to catch concurrent payments
4236 #double-form-submission prevention is taken care of in cust_pay_pending::check
4239 return "The customer's balance has changed; $method transaction aborted."
4240 if $self->balance < $balance;
4241 #&& $self->balance < $amount; #might as well anyway?
4243 #also check and make sure there aren't *other* pending payments for this cust
4245 my @pending = qsearch('cust_pay_pending', {
4246 'custnum' => $self->custnum,
4247 'status' => { op=>'!=', value=>'done' }
4249 return "A payment is already being processed for this customer (".
4250 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4251 "); $method transaction aborted."
4252 if scalar(@pending);
4254 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4256 my $cust_pay_pending = new FS::cust_pay_pending {
4257 'custnum' => $self->custnum,
4258 #'invnum' => $options{'invnum'},
4261 'payby' => $method2payby{$method},
4262 'payinfo' => $payinfo,
4263 'paydate' => $paydate,
4264 'recurring_billing' => $content{recurring_billing},
4265 'pkgnum' => $options{'pkgnum'},
4267 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4269 $cust_pay_pending->payunique( $options{payunique} )
4270 if defined($options{payunique}) && length($options{payunique});
4271 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4272 return $cpp_new_err if $cpp_new_err;
4274 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4276 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4277 $transaction->content(
4280 'password' => $password,
4281 'action' => $action1,
4282 'description' => $options{'description'},
4283 'amount' => $amount,
4284 #'invoice_number' => $options{'invnum'},
4285 'customer_id' => $self->custnum,
4286 'last_name' => $paylast,
4287 'first_name' => $payfirst,
4289 'address' => $address,
4290 'city' => ( exists($options{'city'})
4293 'state' => ( exists($options{'state'})
4296 'zip' => ( exists($options{'zip'})
4299 'country' => ( exists($options{'country'})
4300 ? $options{'country'}
4302 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4304 'phone' => $self->daytime || $self->night,
4308 $cust_pay_pending->status('pending');
4309 my $cpp_pending_err = $cust_pay_pending->replace;
4310 return $cpp_pending_err if $cpp_pending_err;
4313 my $BOP_TESTING = 0;
4314 my $BOP_TESTING_SUCCESS = 1;
4316 unless ( $BOP_TESTING ) {
4317 $transaction->submit();
4319 if ( $BOP_TESTING_SUCCESS ) {
4320 $transaction->is_success(1);
4321 $transaction->authorization('fake auth');
4323 $transaction->is_success(0);
4324 $transaction->error_message('fake failure');
4328 if ( $transaction->is_success() && $action2 ) {
4330 $cust_pay_pending->status('authorized');
4331 my $cpp_authorized_err = $cust_pay_pending->replace;
4332 return $cpp_authorized_err if $cpp_authorized_err;
4334 my $auth = $transaction->authorization;
4335 my $ordernum = $transaction->can('order_number')
4336 ? $transaction->order_number
4340 new Business::OnlinePayment( $processor, @bop_options );
4347 password => $password,
4348 order_number => $ordernum,
4350 authorization => $auth,
4351 description => $options{'description'},
4354 foreach my $field (qw( authorization_source_code returned_ACI
4355 transaction_identifier validation_code
4356 transaction_sequence_num local_transaction_date
4357 local_transaction_time AVS_result_code )) {
4358 $capture{$field} = $transaction->$field() if $transaction->can($field);
4361 $capture->content( %capture );
4365 unless ( $capture->is_success ) {
4366 my $e = "Authorization successful but capture failed, custnum #".
4367 $self->custnum. ': '. $capture->result_code.
4368 ": ". $capture->error_message;
4375 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4376 my $cpp_captured_err = $cust_pay_pending->replace;
4377 return $cpp_captured_err if $cpp_captured_err;
4380 # remove paycvv after initial transaction
4383 #false laziness w/misc/process/payment.cgi - check both to make sure working
4385 if ( defined $self->dbdef_table->column('paycvv')
4386 && length($self->paycvv)
4387 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4389 my $error = $self->remove_cvv;
4391 warn "WARNING: error removing cvv: $error\n";
4399 if ( $transaction->is_success() ) {
4402 if ( $payment_gateway ) { # agent override
4403 $paybatch = $payment_gateway->gatewaynum. '-';
4406 $paybatch .= "$processor:". $transaction->authorization;
4408 $paybatch .= ':'. $transaction->order_number
4409 if $transaction->can('order_number')
4410 && length($transaction->order_number);
4412 my $cust_pay = new FS::cust_pay ( {
4413 'custnum' => $self->custnum,
4414 'invnum' => $options{'invnum'},
4417 'payby' => $method2payby{$method},
4418 'payinfo' => $payinfo,
4419 'paybatch' => $paybatch,
4420 'paydate' => $paydate,
4421 'pkgnum' => $options{'pkgnum'},
4423 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4424 $cust_pay->payunique( $options{payunique} )
4425 if defined($options{payunique}) && length($options{payunique});
4427 my $oldAutoCommit = $FS::UID::AutoCommit;
4428 local $FS::UID::AutoCommit = 0;
4431 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4433 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4436 $cust_pay->invnum(''); #try again with no specific invnum
4437 my $error2 = $cust_pay->insert( $options{'manual'} ?
4438 ( 'manual' => 1 ) : ()
4441 # gah. but at least we have a record of the state we had to abort in
4442 # from cust_pay_pending now.
4443 my $e = "WARNING: $method captured but payment not recorded - ".
4444 "error inserting payment ($processor): $error2".
4445 " (previously tried insert with invnum #$options{'invnum'}" .
4446 ": $error ) - pending payment saved as paypendingnum ".
4447 $cust_pay_pending->paypendingnum. "\n";
4453 if ( $options{'paynum_ref'} ) {
4454 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4457 $cust_pay_pending->status('done');
4458 $cust_pay_pending->statustext('captured');
4459 $cust_pay_pending->paynum($cust_pay->paynum);
4460 my $cpp_done_err = $cust_pay_pending->replace;
4462 if ( $cpp_done_err ) {
4464 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4465 my $e = "WARNING: $method captured but payment not recorded - ".
4466 "error updating status for paypendingnum ".
4467 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4473 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4475 if ( $options{'apply'} ) {
4476 my $apply_error = $self->apply_payments_and_credits;
4477 if ( $apply_error ) {
4478 warn "WARNING: error applying payment: $apply_error\n";
4479 #but we still should return no error cause the payment otherwise went
4484 return ''; #no error
4490 my $perror = "$processor error: ". $transaction->error_message;
4492 unless ( $transaction->error_message ) {
4495 if ( $transaction->can('response_page') ) {
4497 'page' => ( $transaction->can('response_page')
4498 ? $transaction->response_page
4501 'code' => ( $transaction->can('response_code')
4502 ? $transaction->response_code
4505 'headers' => ( $transaction->can('response_headers')
4506 ? $transaction->response_headers
4512 "No additional debugging information available for $processor";
4515 $perror .= "No error_message returned from $processor -- ".
4516 ( ref($t_response) ? Dumper($t_response) : $t_response );
4520 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4521 && $conf->exists('emaildecline')
4522 && grep { $_ ne 'POST' } $self->invoicing_list
4523 && ! grep { $transaction->error_message =~ /$_/ }
4524 $conf->config('emaildecline-exclude')
4526 my @templ = $conf->config('declinetemplate');
4527 my $template = new Text::Template (
4529 SOURCE => [ map "$_\n", @templ ],
4530 ) or return "($perror) can't create template: $Text::Template::ERROR";
4531 $template->compile()
4532 or return "($perror) can't compile template: $Text::Template::ERROR";
4536 scalar( $conf->config('company_name', $self->agentnum ) ),
4537 'company_address' =>
4538 join("\n", $conf->config('company_address', $self->agentnum ) ),
4539 'error' => $transaction->error_message,
4542 my $error = send_email(
4543 'from' => $conf->config('invoice_from', $self->agentnum ),
4544 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4545 'subject' => 'Your payment could not be processed',
4546 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4549 $perror .= " (also received error sending decline notification: $error)"
4554 $cust_pay_pending->status('done');
4555 $cust_pay_pending->statustext("declined: $perror");
4556 my $cpp_done_err = $cust_pay_pending->replace;
4557 if ( $cpp_done_err ) {
4558 my $e = "WARNING: $method declined but pending payment not resolved - ".
4559 "error updating status for paypendingnum ".
4560 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4562 $perror = "$e ($perror)";
4570 sub _bop_recurring_billing {
4571 my( $self, %opt ) = @_;
4573 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4575 if ( defined($method) && $method eq 'transaction_is_recur' ) {
4577 return 1 if $opt{'trans_is_recur'};
4581 my %hash = ( 'custnum' => $self->custnum,
4586 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4587 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4598 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4600 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4601 via a Business::OnlinePayment realtime gateway. See
4602 L<http://420.am/business-onlinepayment> for supported gateways.
4604 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4606 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4608 Most gateways require a reference to an original payment transaction to refund,
4609 so you probably need to specify a I<paynum>.
4611 I<amount> defaults to the original amount of the payment if not specified.
4613 I<reason> specifies a reason for the refund.
4615 I<paydate> specifies the expiration date for a credit card overriding the
4616 value from the customer record or the payment record. Specified as yyyy-mm-dd
4618 Implementation note: If I<amount> is unspecified or equal to the amount of the
4619 orignal payment, first an attempt is made to "void" the transaction via
4620 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4621 the normal attempt is made to "refund" ("credit") the transaction via the
4622 gateway is attempted.
4624 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4625 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4626 #if set, will override the value from the customer record.
4628 #If an I<invnum> is specified, this payment (if successful) is applied to the
4629 #specified invoice. If you don't specify an I<invnum> you might want to
4630 #call the B<apply_payments> method.
4634 #some false laziness w/realtime_bop, not enough to make it worth merging
4635 #but some useful small subs should be pulled out
4636 sub realtime_refund_bop {
4639 return $self->_new_realtime_refund_bop(@_)
4640 if $self->_new_bop_required();
4642 my( $method, %options ) = @_;
4644 warn "$me realtime_refund_bop: $method refund\n";
4645 warn " $_ => $options{$_}\n" foreach keys %options;
4648 eval "use Business::OnlinePayment";
4652 # look up the original payment and optionally a gateway for that payment
4656 my $amount = $options{'amount'};
4658 my( $processor, $login, $password, @bop_options ) ;
4659 my( $auth, $order_number ) = ( '', '', '' );
4661 if ( $options{'paynum'} ) {
4663 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4664 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4665 or return "Unknown paynum $options{'paynum'}";
4666 $amount ||= $cust_pay->paid;
4668 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4669 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4670 $cust_pay->paybatch;
4671 my $gatewaynum = '';
4672 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4674 if ( $gatewaynum ) { #gateway for the payment to be refunded
4676 my $payment_gateway =
4677 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4678 die "payment gateway $gatewaynum not found"
4679 unless $payment_gateway;
4681 $processor = $payment_gateway->gateway_module;
4682 $login = $payment_gateway->gateway_username;
4683 $password = $payment_gateway->gateway_password;
4684 @bop_options = $payment_gateway->options;
4686 } else { #try the default gateway
4688 my( $conf_processor, $unused_action );
4689 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4690 $self->default_payment_gateway($method);
4692 return "processor of payment $options{'paynum'} $processor does not".
4693 " match default processor $conf_processor"
4694 unless $processor eq $conf_processor;
4699 } else { # didn't specify a paynum, so look for agent gateway overrides
4700 # like a normal transaction
4703 if ( $method eq 'CC' ) {
4704 $cardtype = cardtype($self->payinfo);
4705 } elsif ( $method eq 'ECHECK' ) {
4708 $cardtype = $method;
4711 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4712 cardtype => $cardtype,
4714 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4716 taxclass => '', } );
4718 if ( $override ) { #use a payment gateway override
4720 my $payment_gateway = $override->payment_gateway;
4722 $processor = $payment_gateway->gateway_module;
4723 $login = $payment_gateway->gateway_username;
4724 $password = $payment_gateway->gateway_password;
4725 #$action = $payment_gateway->gateway_action;
4726 @bop_options = $payment_gateway->options;
4728 } else { #use the standard settings from the config
4731 ( $processor, $login, $password, $unused_action, @bop_options ) =
4732 $self->default_payment_gateway($method);
4737 return "neither amount nor paynum specified" unless $amount;
4742 'password' => $password,
4743 'order_number' => $order_number,
4744 'amount' => $amount,
4745 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4747 $content{authorization} = $auth
4748 if length($auth); #echeck/ACH transactions have an order # but no auth
4749 #(at least with authorize.net)
4751 my $disable_void_after;
4752 if ($conf->exists('disable_void_after')
4753 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4754 $disable_void_after = $1;
4757 #first try void if applicable
4758 if ( $cust_pay && $cust_pay->paid == $amount
4760 ( not defined($disable_void_after) )
4761 || ( time < ($cust_pay->_date + $disable_void_after ) )
4764 warn " attempting void\n" if $DEBUG > 1;
4765 my $void = new Business::OnlinePayment( $processor, @bop_options );
4766 $void->content( 'action' => 'void', %content );
4768 if ( $void->is_success ) {
4769 my $error = $cust_pay->void($options{'reason'});
4771 # gah, even with transactions.
4772 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4773 "error voiding payment: $error";
4777 warn " void successful\n" if $DEBUG > 1;
4782 warn " void unsuccessful, trying refund\n"
4786 my $address = $self->address1;
4787 $address .= ", ". $self->address2 if $self->address2;
4789 my($payname, $payfirst, $paylast);
4790 if ( $self->payname && $method ne 'ECHECK' ) {
4791 $payname = $self->payname;
4792 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4793 or return "Illegal payname $payname";
4794 ($payfirst, $paylast) = ($1, $2);
4796 $payfirst = $self->getfield('first');
4797 $paylast = $self->getfield('last');
4798 $payname = "$payfirst $paylast";
4801 my @invoicing_list = $self->invoicing_list_emailonly;
4802 if ( $conf->exists('emailinvoiceautoalways')
4803 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4804 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4805 push @invoicing_list, $self->all_emails;
4808 my $email = ($conf->exists('business-onlinepayment-email-override'))
4809 ? $conf->config('business-onlinepayment-email-override')
4810 : $invoicing_list[0];
4812 my $payip = exists($options{'payip'})
4815 $content{customer_ip} = $payip
4819 if ( $method eq 'CC' ) {
4822 $content{card_number} = $payinfo = $cust_pay->payinfo;
4823 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4824 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4825 ($content{expiration} = "$2/$1"); # where available
4827 $content{card_number} = $payinfo = $self->payinfo;
4828 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4829 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4830 $content{expiration} = "$2/$1";
4833 } elsif ( $method eq 'ECHECK' ) {
4836 $payinfo = $cust_pay->payinfo;
4838 $payinfo = $self->payinfo;
4840 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4841 $content{bank_name} = $self->payname;
4842 $content{account_type} = 'CHECKING';
4843 $content{account_name} = $payname;
4844 $content{customer_org} = $self->company ? 'B' : 'I';
4845 $content{customer_ssn} = $self->ss;
4846 } elsif ( $method eq 'LEC' ) {
4847 $content{phone} = $payinfo = $self->payinfo;
4851 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4852 my %sub_content = $refund->content(
4853 'action' => 'credit',
4854 'customer_id' => $self->custnum,
4855 'last_name' => $paylast,
4856 'first_name' => $payfirst,
4858 'address' => $address,
4859 'city' => $self->city,
4860 'state' => $self->state,
4861 'zip' => $self->zip,
4862 'country' => $self->country,
4864 'phone' => $self->daytime || $self->night,
4867 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4871 return "$processor error: ". $refund->error_message
4872 unless $refund->is_success();
4874 my %method2payby = (
4880 my $paybatch = "$processor:". $refund->authorization;
4881 $paybatch .= ':'. $refund->order_number
4882 if $refund->can('order_number') && $refund->order_number;
4884 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4885 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4886 last unless @cust_bill_pay;
4887 my $cust_bill_pay = pop @cust_bill_pay;
4888 my $error = $cust_bill_pay->delete;
4892 my $cust_refund = new FS::cust_refund ( {
4893 'custnum' => $self->custnum,
4894 'paynum' => $options{'paynum'},
4895 'refund' => $amount,
4897 'payby' => $method2payby{$method},
4898 'payinfo' => $payinfo,
4899 'paybatch' => $paybatch,
4900 'reason' => $options{'reason'} || 'card or ACH refund',
4902 my $error = $cust_refund->insert;
4904 $cust_refund->paynum(''); #try again with no specific paynum
4905 my $error2 = $cust_refund->insert;
4907 # gah, even with transactions.
4908 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4909 "error inserting refund ($processor): $error2".
4910 " (previously tried insert with paynum #$options{'paynum'}" .
4921 # does the configuration indicate the new bop routines are required?
4923 sub _new_bop_required {
4926 my $botpp = 'Business::OnlineThirdPartyPayment';
4929 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4930 scalar( grep { $_->gateway_namespace eq $botpp }
4931 qsearch( 'payment_gateway', { 'disabled' => '' } )
4939 =item realtime_collect [ OPTION => VALUE ... ]
4941 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4942 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4943 gateway. See L<http://420.am/business-onlinepayment> and
4944 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4946 On failure returns an error message.
4948 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.
4950 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4952 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4953 then it is deduced from the customer record.
4955 If no I<amount> is specified, then the customer balance is used.
4957 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4958 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4959 if set, will override the value from the customer record.
4961 I<description> is a free-text field passed to the gateway. It defaults to
4962 "Internet services".
4964 If an I<invnum> is specified, this payment (if successful) is applied to the
4965 specified invoice. If you don't specify an I<invnum> you might want to
4966 call the B<apply_payments> method or set the I<apply> option.
4968 I<apply> can be set to true to apply a resulting payment.
4970 I<quiet> can be set true to surpress email decline notices.
4972 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4973 resulting paynum, if any.
4975 I<payunique> is a unique identifier for this payment.
4977 I<session_id> is a session identifier associated with this payment.
4979 I<depend_jobnum> allows payment capture to unlock export jobs
4983 sub realtime_collect {
4984 my( $self, %options ) = @_;
4987 warn "$me realtime_collect:\n";
4988 warn " $_ => $options{$_}\n" foreach keys %options;
4991 $options{amount} = $self->balance unless exists( $options{amount} );
4992 $options{method} = FS::payby->payby2bop($self->payby)
4993 unless exists( $options{method} );
4995 return $self->realtime_bop({%options});
4999 =item _realtime_bop { [ ARG => VALUE ... ] }
5001 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5002 via a Business::OnlinePayment realtime gateway. See
5003 L<http://420.am/business-onlinepayment> for supported gateways.
5005 Required arguments in the hashref are I<method>, and I<amount>
5007 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5009 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5011 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5012 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5013 if set, will override the value from the customer record.
5015 I<description> is a free-text field passed to the gateway. It defaults to
5016 "Internet services".
5018 If an I<invnum> is specified, this payment (if successful) is applied to the
5019 specified invoice. If you don't specify an I<invnum> you might want to
5020 call the B<apply_payments> method.
5022 I<quiet> can be set true to surpress email decline notices.
5024 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5025 resulting paynum, if any.
5027 I<payunique> is a unique identifier for this payment.
5029 I<session_id> is a session identifier associated with this payment.
5031 I<depend_jobnum> allows payment capture to unlock export jobs
5033 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5037 # some helper routines
5038 sub _payment_gateway {
5039 my ($self, $options) = @_;
5041 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5042 unless exists($options->{payment_gateway});
5044 $options->{payment_gateway};
5048 my ($self, $options) = @_;
5051 'login' => $options->{payment_gateway}->gateway_username,
5052 'password' => $options->{payment_gateway}->gateway_password,
5057 my ($self, $options) = @_;
5059 $options->{payment_gateway}->gatewaynum
5060 ? $options->{payment_gateway}->options
5061 : @{ $options->{payment_gateway}->get('options') };
5065 my ($self, $options) = @_;
5067 $options->{description} ||= 'Internet services';
5068 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5069 $options->{invnum} ||= '';
5070 $options->{payname} = $self->payname unless exists( $options->{payname} );
5074 my ($self, $options) = @_;
5077 $content{address} = exists($options->{'address1'})
5078 ? $options->{'address1'}
5080 my $address2 = exists($options->{'address2'})
5081 ? $options->{'address2'}
5083 $content{address} .= ", ". $address2 if length($address2);
5085 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5086 $content{customer_ip} = $payip if length($payip);
5088 $content{invoice_number} = $options->{'invnum'}
5089 if exists($options->{'invnum'}) && length($options->{'invnum'});
5091 $content{email_customer} =
5092 ( $conf->exists('business-onlinepayment-email_customer')
5093 || $conf->exists('business-onlinepayment-email-override') );
5095 $content{payfirst} = $self->getfield('first');
5096 $content{paylast} = $self->getfield('last');
5098 $content{account_name} = "$content{payfirst} $content{paylast}"
5099 if $options->{method} eq 'ECHECK';
5101 $content{name} = $options->{payname};
5102 $content{name} = $content{account_name} if exists($content{account_name});
5104 $content{city} = exists($options->{city})
5107 $content{state} = exists($options->{state})
5110 $content{zip} = exists($options->{zip})
5113 $content{country} = exists($options->{country})
5114 ? $options->{country}
5116 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5117 $content{phone} = $self->daytime || $self->night;
5122 my %bop_method2payby = (
5128 sub _new_realtime_bop {
5132 if (ref($_[0]) eq 'HASH') {
5133 %options = %{$_[0]};
5135 my ( $method, $amount ) = ( shift, shift );
5137 $options{method} = $method;
5138 $options{amount} = $amount;
5142 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5143 warn " $_ => $options{$_}\n" foreach keys %options;
5146 return $self->fake_bop(%options) if $options{'fake'};
5148 $self->_bop_defaults(\%options);
5151 # set trans_is_recur based on invnum if there is one
5154 my $trans_is_recur = 0;
5155 if ( $options{'invnum'} ) {
5157 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5158 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5161 map { $_->part_pkg }
5163 map { $_->cust_pkg }
5164 $cust_bill->cust_bill_pkg;
5167 if grep { $_->freq ne '0' } @part_pkg;
5175 my $payment_gateway = $self->_payment_gateway( \%options );
5176 my $namespace = $payment_gateway->gateway_namespace;
5178 eval "use $namespace";
5182 # check for banned credit card/ACH
5185 my $ban = qsearchs('banned_pay', {
5186 'payby' => $bop_method2payby{$options{method}},
5187 'payinfo' => md5_base64($options{payinfo}),
5189 return "Banned credit card" if $ban;
5195 my (%bop_content) = $self->_bop_content(\%options);
5197 if ( $options{method} ne 'ECHECK' ) {
5198 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5199 or return "Illegal payname $options{payname}";
5200 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5203 my @invoicing_list = $self->invoicing_list_emailonly;
5204 if ( $conf->exists('emailinvoiceautoalways')
5205 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5206 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5207 push @invoicing_list, $self->all_emails;
5210 my $email = ($conf->exists('business-onlinepayment-email-override'))
5211 ? $conf->config('business-onlinepayment-email-override')
5212 : $invoicing_list[0];
5216 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5218 $content{card_number} = $options{payinfo};
5219 $paydate = exists($options{'paydate'})
5220 ? $options{'paydate'}
5222 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5223 $content{expiration} = "$2/$1";
5225 my $paycvv = exists($options{'paycvv'})
5226 ? $options{'paycvv'}
5228 $content{cvv2} = $paycvv
5231 my $paystart_month = exists($options{'paystart_month'})
5232 ? $options{'paystart_month'}
5233 : $self->paystart_month;
5235 my $paystart_year = exists($options{'paystart_year'})
5236 ? $options{'paystart_year'}
5237 : $self->paystart_year;
5239 $content{card_start} = "$paystart_month/$paystart_year"
5240 if $paystart_month && $paystart_year;
5242 my $payissue = exists($options{'payissue'})
5243 ? $options{'payissue'}
5245 $content{issue_number} = $payissue if $payissue;
5247 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5248 'trans_is_recur' => $trans_is_recur,
5252 $content{recurring_billing} = 'YES';
5253 $content{acct_code} = 'rebill'
5254 if $conf->exists('credit_card-recurring_billing_acct_code');
5257 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5258 ( $content{account_number}, $content{routing_code} ) =
5259 split('@', $options{payinfo});
5260 $content{bank_name} = $options{payname};
5261 $content{bank_state} = exists($options{'paystate'})
5262 ? $options{'paystate'}
5263 : $self->getfield('paystate');
5264 $content{account_type} = exists($options{'paytype'})
5265 ? uc($options{'paytype'}) || 'CHECKING'
5266 : uc($self->getfield('paytype')) || 'CHECKING';
5267 $content{customer_org} = $self->company ? 'B' : 'I';
5268 $content{state_id} = exists($options{'stateid'})
5269 ? $options{'stateid'}
5270 : $self->getfield('stateid');
5271 $content{state_id_state} = exists($options{'stateid_state'})
5272 ? $options{'stateid_state'}
5273 : $self->getfield('stateid_state');
5274 $content{customer_ssn} = exists($options{'ss'})
5277 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5278 $content{phone} = $options{payinfo};
5279 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5286 # run transaction(s)
5289 my $balance = exists( $options{'balance'} )
5290 ? $options{'balance'}
5293 $self->select_for_update; #mutex ... just until we get our pending record in
5295 #the checks here are intended to catch concurrent payments
5296 #double-form-submission prevention is taken care of in cust_pay_pending::check
5299 return "The customer's balance has changed; $options{method} transaction aborted."
5300 if $self->balance < $balance;
5301 #&& $self->balance < $options{amount}; #might as well anyway?
5303 #also check and make sure there aren't *other* pending payments for this cust
5305 my @pending = qsearch('cust_pay_pending', {
5306 'custnum' => $self->custnum,
5307 'status' => { op=>'!=', value=>'done' }
5309 return "A payment is already being processed for this customer (".
5310 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5311 "); $options{method} transaction aborted."
5312 if scalar(@pending);
5314 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5316 my $cust_pay_pending = new FS::cust_pay_pending {
5317 'custnum' => $self->custnum,
5318 #'invnum' => $options{'invnum'},
5319 'paid' => $options{amount},
5321 'payby' => $bop_method2payby{$options{method}},
5322 'payinfo' => $options{payinfo},
5323 'paydate' => $paydate,
5324 'recurring_billing' => $content{recurring_billing},
5325 'pkgnum' => $options{'pkgnum'},
5327 'gatewaynum' => $payment_gateway->gatewaynum || '',
5328 'session_id' => $options{session_id} || '',
5329 'jobnum' => $options{depend_jobnum} || '',
5331 $cust_pay_pending->payunique( $options{payunique} )
5332 if defined($options{payunique}) && length($options{payunique});
5333 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5334 return $cpp_new_err if $cpp_new_err;
5336 my( $action1, $action2 ) =
5337 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5339 my $transaction = new $namespace( $payment_gateway->gateway_module,
5340 $self->_bop_options(\%options),
5343 $transaction->content(
5344 'type' => $options{method},
5345 $self->_bop_auth(\%options),
5346 'action' => $action1,
5347 'description' => $options{'description'},
5348 'amount' => $options{amount},
5349 #'invoice_number' => $options{'invnum'},
5350 'customer_id' => $self->custnum,
5352 'reference' => $cust_pay_pending->paypendingnum, #for now
5357 $cust_pay_pending->status('pending');
5358 my $cpp_pending_err = $cust_pay_pending->replace;
5359 return $cpp_pending_err if $cpp_pending_err;
5362 my $BOP_TESTING = 0;
5363 my $BOP_TESTING_SUCCESS = 1;
5365 unless ( $BOP_TESTING ) {
5366 $transaction->submit();
5368 if ( $BOP_TESTING_SUCCESS ) {
5369 $transaction->is_success(1);
5370 $transaction->authorization('fake auth');
5372 $transaction->is_success(0);
5373 $transaction->error_message('fake failure');
5377 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5379 return { reference => $cust_pay_pending->paypendingnum,
5380 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5382 } elsif ( $transaction->is_success() && $action2 ) {
5384 $cust_pay_pending->status('authorized');
5385 my $cpp_authorized_err = $cust_pay_pending->replace;
5386 return $cpp_authorized_err if $cpp_authorized_err;
5388 my $auth = $transaction->authorization;
5389 my $ordernum = $transaction->can('order_number')
5390 ? $transaction->order_number
5394 new Business::OnlinePayment( $payment_gateway->gateway_module,
5395 $self->_bop_options(\%options),
5400 type => $options{method},
5402 $self->_bop_auth(\%options),
5403 order_number => $ordernum,
5404 amount => $options{amount},
5405 authorization => $auth,
5406 description => $options{'description'},
5409 foreach my $field (qw( authorization_source_code returned_ACI
5410 transaction_identifier validation_code
5411 transaction_sequence_num local_transaction_date
5412 local_transaction_time AVS_result_code )) {
5413 $capture{$field} = $transaction->$field() if $transaction->can($field);
5416 $capture->content( %capture );
5420 unless ( $capture->is_success ) {
5421 my $e = "Authorization successful but capture failed, custnum #".
5422 $self->custnum. ': '. $capture->result_code.
5423 ": ". $capture->error_message;
5431 # remove paycvv after initial transaction
5434 #false laziness w/misc/process/payment.cgi - check both to make sure working
5436 if ( defined $self->dbdef_table->column('paycvv')
5437 && length($self->paycvv)
5438 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5440 my $error = $self->remove_cvv;
5442 warn "WARNING: error removing cvv: $error\n";
5450 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5462 if (ref($_[0]) eq 'HASH') {
5463 %options = %{$_[0]};
5465 my ( $method, $amount ) = ( shift, shift );
5467 $options{method} = $method;
5468 $options{amount} = $amount;
5471 if ( $options{'fake_failure'} ) {
5472 return "Error: No error; test failure requested with fake_failure";
5476 #if ( $payment_gateway->gatewaynum ) { # agent override
5477 # $paybatch = $payment_gateway->gatewaynum. '-';
5480 #$paybatch .= "$processor:". $transaction->authorization;
5482 #$paybatch .= ':'. $transaction->order_number
5483 # if $transaction->can('order_number')
5484 # && length($transaction->order_number);
5486 my $paybatch = 'FakeProcessor:54:32';
5488 my $cust_pay = new FS::cust_pay ( {
5489 'custnum' => $self->custnum,
5490 'invnum' => $options{'invnum'},
5491 'paid' => $options{amount},
5493 'payby' => $bop_method2payby{$options{method}},
5494 #'payinfo' => $payinfo,
5495 'payinfo' => '4111111111111111',
5496 'paybatch' => $paybatch,
5497 #'paydate' => $paydate,
5498 'paydate' => '2012-05-01',
5500 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5502 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5505 $cust_pay->invnum(''); #try again with no specific invnum
5506 my $error2 = $cust_pay->insert( $options{'manual'} ?
5507 ( 'manual' => 1 ) : ()
5510 # gah, even with transactions.
5511 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5512 "error inserting (fake!) payment: $error2".
5513 " (previously tried insert with invnum #$options{'invnum'}" .
5520 if ( $options{'paynum_ref'} ) {
5521 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5524 return ''; #no error
5529 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5531 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5532 # phone bill transaction.
5534 sub _realtime_bop_result {
5535 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5537 warn "$me _realtime_bop_result: pending transaction ".
5538 $cust_pay_pending->paypendingnum. "\n";
5539 warn " $_ => $options{$_}\n" foreach keys %options;
5542 my $payment_gateway = $options{payment_gateway}
5543 or return "no payment gateway in arguments to _realtime_bop_result";
5545 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5546 my $cpp_captured_err = $cust_pay_pending->replace;
5547 return $cpp_captured_err if $cpp_captured_err;
5549 if ( $transaction->is_success() ) {
5552 if ( $payment_gateway->gatewaynum ) { # agent override
5553 $paybatch = $payment_gateway->gatewaynum. '-';
5556 $paybatch .= $payment_gateway->gateway_module. ":".
5557 $transaction->authorization;
5559 $paybatch .= ':'. $transaction->order_number
5560 if $transaction->can('order_number')
5561 && length($transaction->order_number);
5563 my $cust_pay = new FS::cust_pay ( {
5564 'custnum' => $self->custnum,
5565 'invnum' => $options{'invnum'},
5566 'paid' => $cust_pay_pending->paid,
5568 'payby' => $cust_pay_pending->payby,
5569 #'payinfo' => $payinfo,
5570 'paybatch' => $paybatch,
5571 'paydate' => $cust_pay_pending->paydate,
5572 'pkgnum' => $cust_pay_pending->pkgnum,
5574 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5575 $cust_pay->payunique( $options{payunique} )
5576 if defined($options{payunique}) && length($options{payunique});
5578 my $oldAutoCommit = $FS::UID::AutoCommit;
5579 local $FS::UID::AutoCommit = 0;
5582 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5584 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5587 $cust_pay->invnum(''); #try again with no specific invnum
5588 my $error2 = $cust_pay->insert( $options{'manual'} ?
5589 ( 'manual' => 1 ) : ()
5592 # gah. but at least we have a record of the state we had to abort in
5593 # from cust_pay_pending now.
5594 my $e = "WARNING: $options{method} captured but payment not recorded -".
5595 " error inserting payment (". $payment_gateway->gateway_module.
5597 " (previously tried insert with invnum #$options{'invnum'}" .
5598 ": $error ) - pending payment saved as paypendingnum ".
5599 $cust_pay_pending->paypendingnum. "\n";
5605 my $jobnum = $cust_pay_pending->jobnum;
5607 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5609 unless ( $placeholder ) {
5610 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5611 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5612 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5617 $error = $placeholder->delete;
5620 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5621 my $e = "WARNING: $options{method} captured but could not delete ".
5622 "job $jobnum for paypendingnum ".
5623 $cust_pay_pending->paypendingnum. ": $error\n";
5630 if ( $options{'paynum_ref'} ) {
5631 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5634 $cust_pay_pending->status('done');
5635 $cust_pay_pending->statustext('captured');
5636 $cust_pay_pending->paynum($cust_pay->paynum);
5637 my $cpp_done_err = $cust_pay_pending->replace;
5639 if ( $cpp_done_err ) {
5641 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5642 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5643 "error updating status for paypendingnum ".
5644 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5650 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5652 if ( $options{'apply'} ) {
5653 my $apply_error = $self->apply_payments_and_credits;
5654 if ( $apply_error ) {
5655 warn "WARNING: error applying payment: $apply_error\n";
5656 #but we still should return no error cause the payment otherwise went
5661 return ''; #no error
5667 my $perror = $payment_gateway->gateway_module. " error: ".
5668 $transaction->error_message;
5670 my $jobnum = $cust_pay_pending->jobnum;
5672 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5674 if ( $placeholder ) {
5675 my $error = $placeholder->depended_delete;
5676 $error ||= $placeholder->delete;
5677 warn "error removing provisioning jobs after declined paypendingnum ".
5678 $cust_pay_pending->paypendingnum. "\n";
5680 my $e = "error finding job $jobnum for declined paypendingnum ".
5681 $cust_pay_pending->paypendingnum. "\n";
5687 unless ( $transaction->error_message ) {
5690 if ( $transaction->can('response_page') ) {
5692 'page' => ( $transaction->can('response_page')
5693 ? $transaction->response_page
5696 'code' => ( $transaction->can('response_code')
5697 ? $transaction->response_code
5700 'headers' => ( $transaction->can('response_headers')
5701 ? $transaction->response_headers
5707 "No additional debugging information available for ".
5708 $payment_gateway->gateway_module;
5711 $perror .= "No error_message returned from ".
5712 $payment_gateway->gateway_module. " -- ".
5713 ( ref($t_response) ? Dumper($t_response) : $t_response );
5717 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5718 && $conf->exists('emaildecline')
5719 && grep { $_ ne 'POST' } $self->invoicing_list
5720 && ! grep { $transaction->error_message =~ /$_/ }
5721 $conf->config('emaildecline-exclude')
5723 my @templ = $conf->config('declinetemplate');
5724 my $template = new Text::Template (
5726 SOURCE => [ map "$_\n", @templ ],
5727 ) or return "($perror) can't create template: $Text::Template::ERROR";
5728 $template->compile()
5729 or return "($perror) can't compile template: $Text::Template::ERROR";
5733 scalar( $conf->config('company_name', $self->agentnum ) ),
5734 'company_address' =>
5735 join("\n", $conf->config('company_address', $self->agentnum ) ),
5736 'error' => $transaction->error_message,
5739 my $error = send_email(
5740 'from' => $conf->config('invoice_from', $self->agentnum ),
5741 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5742 'subject' => 'Your payment could not be processed',
5743 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5746 $perror .= " (also received error sending decline notification: $error)"
5751 $cust_pay_pending->status('done');
5752 $cust_pay_pending->statustext("declined: $perror");
5753 my $cpp_done_err = $cust_pay_pending->replace;
5754 if ( $cpp_done_err ) {
5755 my $e = "WARNING: $options{method} declined but pending payment not ".
5756 "resolved - error updating status for paypendingnum ".
5757 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5759 $perror = "$e ($perror)";
5767 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5769 Verifies successful third party processing of a realtime credit card,
5770 ACH (electronic check) or phone bill transaction via a
5771 Business::OnlineThirdPartyPayment realtime gateway. See
5772 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5774 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5776 The additional options I<payname>, I<city>, I<state>,
5777 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5778 if set, will override the value from the customer record.
5780 I<description> is a free-text field passed to the gateway. It defaults to
5781 "Internet services".
5783 If an I<invnum> is specified, this payment (if successful) is applied to the
5784 specified invoice. If you don't specify an I<invnum> you might want to
5785 call the B<apply_payments> method.
5787 I<quiet> can be set true to surpress email decline notices.
5789 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5790 resulting paynum, if any.
5792 I<payunique> is a unique identifier for this payment.
5794 Returns a hashref containing elements bill_error (which will be undefined
5795 upon success) and session_id of any associated session.
5799 sub realtime_botpp_capture {
5800 my( $self, $cust_pay_pending, %options ) = @_;
5802 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5803 warn " $_ => $options{$_}\n" foreach keys %options;
5806 eval "use Business::OnlineThirdPartyPayment";
5810 # select the gateway
5813 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5815 my $payment_gateway = $cust_pay_pending->gatewaynum
5816 ? qsearchs( 'payment_gateway',
5817 { gatewaynum => $cust_pay_pending->gatewaynum }
5819 : $self->agent->payment_gateway( 'method' => $method,
5820 # 'invnum' => $cust_pay_pending->invnum,
5821 # 'payinfo' => $cust_pay_pending->payinfo,
5824 $options{payment_gateway} = $payment_gateway; # for the helper subs
5830 my @invoicing_list = $self->invoicing_list_emailonly;
5831 if ( $conf->exists('emailinvoiceautoalways')
5832 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5833 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5834 push @invoicing_list, $self->all_emails;
5837 my $email = ($conf->exists('business-onlinepayment-email-override'))
5838 ? $conf->config('business-onlinepayment-email-override')
5839 : $invoicing_list[0];
5843 $content{email_customer} =
5844 ( $conf->exists('business-onlinepayment-email_customer')
5845 || $conf->exists('business-onlinepayment-email-override') );
5848 # run transaction(s)
5852 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5853 $self->_bop_options(\%options),
5856 $transaction->reference({ %options });
5858 $transaction->content(
5860 $self->_bop_auth(\%options),
5861 'action' => 'Post Authorization',
5862 'description' => $options{'description'},
5863 'amount' => $cust_pay_pending->paid,
5864 #'invoice_number' => $options{'invnum'},
5865 'customer_id' => $self->custnum,
5866 'referer' => 'http://cleanwhisker.420.am/',
5867 'reference' => $cust_pay_pending->paypendingnum,
5869 'phone' => $self->daytime || $self->night,
5871 # plus whatever is required for bogus capture avoidance
5874 $transaction->submit();
5877 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5880 bill_error => $error,
5881 session_id => $cust_pay_pending->session_id,
5886 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5890 sub default_payment_gateway {
5891 my( $self, $method ) = @_;
5893 die "Real-time processing not enabled\n"
5894 unless $conf->exists('business-onlinepayment');
5896 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5899 my $bop_config = 'business-onlinepayment';
5900 $bop_config .= '-ach'
5901 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5902 my ( $processor, $login, $password, $action, @bop_options ) =
5903 $conf->config($bop_config);
5904 $action ||= 'normal authorization';
5905 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5906 die "No real-time processor is enabled - ".
5907 "did you set the business-onlinepayment configuration value?\n"
5910 ( $processor, $login, $password, $action, @bop_options )
5915 Removes the I<paycvv> field from the database directly.
5917 If there is an error, returns the error, otherwise returns false.
5923 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5924 or return dbh->errstr;
5925 $sth->execute($self->custnum)
5926 or return $sth->errstr;
5931 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5933 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5934 via a Business::OnlinePayment realtime gateway. See
5935 L<http://420.am/business-onlinepayment> for supported gateways.
5937 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5939 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5941 Most gateways require a reference to an original payment transaction to refund,
5942 so you probably need to specify a I<paynum>.
5944 I<amount> defaults to the original amount of the payment if not specified.
5946 I<reason> specifies a reason for the refund.
5948 I<paydate> specifies the expiration date for a credit card overriding the
5949 value from the customer record or the payment record. Specified as yyyy-mm-dd
5951 Implementation note: If I<amount> is unspecified or equal to the amount of the
5952 orignal payment, first an attempt is made to "void" the transaction via
5953 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5954 the normal attempt is made to "refund" ("credit") the transaction via the
5955 gateway is attempted.
5957 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5958 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5959 #if set, will override the value from the customer record.
5961 #If an I<invnum> is specified, this payment (if successful) is applied to the
5962 #specified invoice. If you don't specify an I<invnum> you might want to
5963 #call the B<apply_payments> method.
5967 #some false laziness w/realtime_bop, not enough to make it worth merging
5968 #but some useful small subs should be pulled out
5969 sub _new_realtime_refund_bop {
5973 if (ref($_[0]) ne 'HASH') {
5974 %options = %{$_[0]};
5978 $options{method} = $method;
5982 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5983 warn " $_ => $options{$_}\n" foreach keys %options;
5987 # look up the original payment and optionally a gateway for that payment
5991 my $amount = $options{'amount'};
5993 my( $processor, $login, $password, @bop_options, $namespace ) ;
5994 my( $auth, $order_number ) = ( '', '', '' );
5996 if ( $options{'paynum'} ) {
5998 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5999 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6000 or return "Unknown paynum $options{'paynum'}";
6001 $amount ||= $cust_pay->paid;
6003 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6004 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6005 $cust_pay->paybatch;
6006 my $gatewaynum = '';
6007 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6009 if ( $gatewaynum ) { #gateway for the payment to be refunded
6011 my $payment_gateway =
6012 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6013 die "payment gateway $gatewaynum not found"
6014 unless $payment_gateway;
6016 $processor = $payment_gateway->gateway_module;
6017 $login = $payment_gateway->gateway_username;
6018 $password = $payment_gateway->gateway_password;
6019 $namespace = $payment_gateway->gateway_namespace;
6020 @bop_options = $payment_gateway->options;
6022 } else { #try the default gateway
6025 my $payment_gateway =
6026 $self->agent->payment_gateway('method' => $options{method});
6028 ( $conf_processor, $login, $password, $namespace ) =
6029 map { my $method = "gateway_$_"; $payment_gateway->$method }
6030 qw( module username password namespace );
6032 @bop_options = $payment_gateway->gatewaynum
6033 ? $payment_gateway->options
6034 : @{ $payment_gateway->get('options') };
6036 return "processor of payment $options{'paynum'} $processor does not".
6037 " match default processor $conf_processor"
6038 unless $processor eq $conf_processor;
6043 } else { # didn't specify a paynum, so look for agent gateway overrides
6044 # like a normal transaction
6046 my $payment_gateway =
6047 $self->agent->payment_gateway( 'method' => $options{method},
6048 #'payinfo' => $payinfo,
6050 my( $processor, $login, $password, $namespace ) =
6051 map { my $method = "gateway_$_"; $payment_gateway->$method }
6052 qw( module username password namespace );
6054 my @bop_options = $payment_gateway->gatewaynum
6055 ? $payment_gateway->options
6056 : @{ $payment_gateway->get('options') };
6059 return "neither amount nor paynum specified" unless $amount;
6061 eval "use $namespace";
6065 'type' => $options{method},
6067 'password' => $password,
6068 'order_number' => $order_number,
6069 'amount' => $amount,
6070 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6072 $content{authorization} = $auth
6073 if length($auth); #echeck/ACH transactions have an order # but no auth
6074 #(at least with authorize.net)
6076 my $disable_void_after;
6077 if ($conf->exists('disable_void_after')
6078 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6079 $disable_void_after = $1;
6082 #first try void if applicable
6083 if ( $cust_pay && $cust_pay->paid == $amount
6085 ( not defined($disable_void_after) )
6086 || ( time < ($cust_pay->_date + $disable_void_after ) )
6089 warn " attempting void\n" if $DEBUG > 1;
6090 my $void = new Business::OnlinePayment( $processor, @bop_options );
6091 $void->content( 'action' => 'void', %content );
6093 if ( $void->is_success ) {
6094 my $error = $cust_pay->void($options{'reason'});
6096 # gah, even with transactions.
6097 my $e = 'WARNING: Card/ACH voided but database not updated - '.
6098 "error voiding payment: $error";
6102 warn " void successful\n" if $DEBUG > 1;
6107 warn " void unsuccessful, trying refund\n"
6111 my $address = $self->address1;
6112 $address .= ", ". $self->address2 if $self->address2;
6114 my($payname, $payfirst, $paylast);
6115 if ( $self->payname && $options{method} ne 'ECHECK' ) {
6116 $payname = $self->payname;
6117 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6118 or return "Illegal payname $payname";
6119 ($payfirst, $paylast) = ($1, $2);
6121 $payfirst = $self->getfield('first');
6122 $paylast = $self->getfield('last');
6123 $payname = "$payfirst $paylast";
6126 my @invoicing_list = $self->invoicing_list_emailonly;
6127 if ( $conf->exists('emailinvoiceautoalways')
6128 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6129 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6130 push @invoicing_list, $self->all_emails;
6133 my $email = ($conf->exists('business-onlinepayment-email-override'))
6134 ? $conf->config('business-onlinepayment-email-override')
6135 : $invoicing_list[0];
6137 my $payip = exists($options{'payip'})
6140 $content{customer_ip} = $payip
6144 if ( $options{method} eq 'CC' ) {
6147 $content{card_number} = $payinfo = $cust_pay->payinfo;
6148 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6149 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6150 ($content{expiration} = "$2/$1"); # where available
6152 $content{card_number} = $payinfo = $self->payinfo;
6153 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6154 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6155 $content{expiration} = "$2/$1";
6158 } elsif ( $options{method} eq 'ECHECK' ) {
6161 $payinfo = $cust_pay->payinfo;
6163 $payinfo = $self->payinfo;
6165 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6166 $content{bank_name} = $self->payname;
6167 $content{account_type} = 'CHECKING';
6168 $content{account_name} = $payname;
6169 $content{customer_org} = $self->company ? 'B' : 'I';
6170 $content{customer_ssn} = $self->ss;
6171 } elsif ( $options{method} eq 'LEC' ) {
6172 $content{phone} = $payinfo = $self->payinfo;
6176 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6177 my %sub_content = $refund->content(
6178 'action' => 'credit',
6179 'customer_id' => $self->custnum,
6180 'last_name' => $paylast,
6181 'first_name' => $payfirst,
6183 'address' => $address,
6184 'city' => $self->city,
6185 'state' => $self->state,
6186 'zip' => $self->zip,
6187 'country' => $self->country,
6189 'phone' => $self->daytime || $self->night,
6192 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6196 return "$processor error: ". $refund->error_message
6197 unless $refund->is_success();
6199 my $paybatch = "$processor:". $refund->authorization;
6200 $paybatch .= ':'. $refund->order_number
6201 if $refund->can('order_number') && $refund->order_number;
6203 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6204 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6205 last unless @cust_bill_pay;
6206 my $cust_bill_pay = pop @cust_bill_pay;
6207 my $error = $cust_bill_pay->delete;
6211 my $cust_refund = new FS::cust_refund ( {
6212 'custnum' => $self->custnum,
6213 'paynum' => $options{'paynum'},
6214 'refund' => $amount,
6216 'payby' => $bop_method2payby{$options{method}},
6217 'payinfo' => $payinfo,
6218 'paybatch' => $paybatch,
6219 'reason' => $options{'reason'} || 'card or ACH refund',
6221 my $error = $cust_refund->insert;
6223 $cust_refund->paynum(''); #try again with no specific paynum
6224 my $error2 = $cust_refund->insert;
6226 # gah, even with transactions.
6227 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6228 "error inserting refund ($processor): $error2".
6229 " (previously tried insert with paynum #$options{'paynum'}" .
6240 =item batch_card OPTION => VALUE...
6242 Adds a payment for this invoice to the pending credit card batch (see
6243 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6244 runs the payment using a realtime gateway.
6249 my ($self, %options) = @_;
6252 if (exists($options{amount})) {
6253 $amount = $options{amount};
6255 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6257 return '' unless $amount > 0;
6259 my $invnum = delete $options{invnum};
6260 my $payby = $options{invnum} || $self->payby; #dubious
6262 if ($options{'realtime'}) {
6263 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6269 my $oldAutoCommit = $FS::UID::AutoCommit;
6270 local $FS::UID::AutoCommit = 0;
6273 #this needs to handle mysql as well as Pg, like svc_acct.pm
6274 #(make it into a common function if folks need to do batching with mysql)
6275 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6276 or return "Cannot lock pay_batch: " . $dbh->errstr;
6280 'payby' => FS::payby->payby2payment($payby),
6283 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6285 unless ( $pay_batch ) {
6286 $pay_batch = new FS::pay_batch \%pay_batch;
6287 my $error = $pay_batch->insert;
6289 $dbh->rollback if $oldAutoCommit;
6290 die "error creating new batch: $error\n";
6294 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6295 'batchnum' => $pay_batch->batchnum,
6296 'custnum' => $self->custnum,
6299 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6301 $options{$_} = '' unless exists($options{$_});
6304 my $cust_pay_batch = new FS::cust_pay_batch ( {
6305 'batchnum' => $pay_batch->batchnum,
6306 'invnum' => $invnum || 0, # is there a better value?
6307 # this field should be
6309 # cust_bill_pay_batch now
6310 'custnum' => $self->custnum,
6311 'last' => $self->getfield('last'),
6312 'first' => $self->getfield('first'),
6313 'address1' => $options{address1} || $self->address1,
6314 'address2' => $options{address2} || $self->address2,
6315 'city' => $options{city} || $self->city,
6316 'state' => $options{state} || $self->state,
6317 'zip' => $options{zip} || $self->zip,
6318 'country' => $options{country} || $self->country,
6319 'payby' => $options{payby} || $self->payby,
6320 'payinfo' => $options{payinfo} || $self->payinfo,
6321 'exp' => $options{paydate} || $self->paydate,
6322 'payname' => $options{payname} || $self->payname,
6323 'amount' => $amount, # consolidating
6326 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6327 if $old_cust_pay_batch;
6330 if ($old_cust_pay_batch) {
6331 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6333 $error = $cust_pay_batch->insert;
6337 $dbh->rollback if $oldAutoCommit;
6341 my $unapplied = $self->total_unapplied_credits
6342 + $self->total_unapplied_payments
6343 + $self->in_transit_payments;
6344 foreach my $cust_bill ($self->open_cust_bill) {
6345 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6346 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6347 'invnum' => $cust_bill->invnum,
6348 'paybatchnum' => $cust_pay_batch->paybatchnum,
6349 'amount' => $cust_bill->owed,
6352 if ($unapplied >= $cust_bill_pay_batch->amount){
6353 $unapplied -= $cust_bill_pay_batch->amount;
6356 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6357 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6359 $error = $cust_bill_pay_batch->insert;
6361 $dbh->rollback if $oldAutoCommit;
6366 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6370 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6372 Applies unapplied payments and credits.
6374 In most cases, this new method should be used in place of sequential
6375 apply_payments and apply_credits methods.
6377 A hash of optional arguments may be passed. Currently "manual" is supported.
6378 If true, a payment receipt is sent instead of a statement when
6379 'payment_receipt_email' configuration option is set.
6381 If there is an error, returns the error, otherwise returns false.
6385 sub apply_payments_and_credits {
6386 my( $self, %options ) = @_;
6388 local $SIG{HUP} = 'IGNORE';
6389 local $SIG{INT} = 'IGNORE';
6390 local $SIG{QUIT} = 'IGNORE';
6391 local $SIG{TERM} = 'IGNORE';
6392 local $SIG{TSTP} = 'IGNORE';
6393 local $SIG{PIPE} = 'IGNORE';
6395 my $oldAutoCommit = $FS::UID::AutoCommit;
6396 local $FS::UID::AutoCommit = 0;
6399 $self->select_for_update; #mutex
6401 foreach my $cust_bill ( $self->open_cust_bill ) {
6402 my $error = $cust_bill->apply_payments_and_credits(%options);
6404 $dbh->rollback if $oldAutoCommit;
6405 return "Error applying: $error";
6409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6414 =item apply_credits OPTION => VALUE ...
6416 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6417 to outstanding invoice balances in chronological order (or reverse
6418 chronological order if the I<order> option is set to B<newest>) and returns the
6419 value of any remaining unapplied credits available for refund (see
6420 L<FS::cust_refund>).
6422 Dies if there is an error.
6430 local $SIG{HUP} = 'IGNORE';
6431 local $SIG{INT} = 'IGNORE';
6432 local $SIG{QUIT} = 'IGNORE';
6433 local $SIG{TERM} = 'IGNORE';
6434 local $SIG{TSTP} = 'IGNORE';
6435 local $SIG{PIPE} = 'IGNORE';
6437 my $oldAutoCommit = $FS::UID::AutoCommit;
6438 local $FS::UID::AutoCommit = 0;
6441 $self->select_for_update; #mutex
6443 unless ( $self->total_unapplied_credits ) {
6444 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6448 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6449 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6451 my @invoices = $self->open_cust_bill;
6452 @invoices = sort { $b->_date <=> $a->_date } @invoices
6453 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6455 if ( $conf->exists('pkg-balances') ) {
6456 # limit @credits to those w/ a pkgnum grepped from $self
6458 foreach my $i (@invoices) {
6459 foreach my $li ( $i->cust_bill_pkg ) {
6460 $pkgnums{$li->pkgnum} = 1;
6463 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6468 foreach my $cust_bill ( @invoices ) {
6470 if ( !defined($credit) || $credit->credited == 0) {
6471 $credit = pop @credits or last;
6475 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6476 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6478 $owed = $cust_bill->owed;
6480 unless ( $owed > 0 ) {
6481 push @credits, $credit;
6485 my $amount = min( $credit->credited, $owed );
6487 my $cust_credit_bill = new FS::cust_credit_bill ( {
6488 'crednum' => $credit->crednum,
6489 'invnum' => $cust_bill->invnum,
6490 'amount' => $amount,
6492 $cust_credit_bill->pkgnum( $credit->pkgnum )
6493 if $conf->exists('pkg-balances') && $credit->pkgnum;
6494 my $error = $cust_credit_bill->insert;
6496 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6500 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6504 my $total_unapplied_credits = $self->total_unapplied_credits;
6506 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6508 return $total_unapplied_credits;
6511 =item apply_payments [ OPTION => VALUE ... ]
6513 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6514 to outstanding invoice balances in chronological order.
6516 #and returns the value of any remaining unapplied payments.
6518 A hash of optional arguments may be passed. Currently "manual" is supported.
6519 If true, a payment receipt is sent instead of a statement when
6520 'payment_receipt_email' configuration option is set.
6522 Dies if there is an error.
6526 sub apply_payments {
6527 my( $self, %options ) = @_;
6529 local $SIG{HUP} = 'IGNORE';
6530 local $SIG{INT} = 'IGNORE';
6531 local $SIG{QUIT} = 'IGNORE';
6532 local $SIG{TERM} = 'IGNORE';
6533 local $SIG{TSTP} = 'IGNORE';
6534 local $SIG{PIPE} = 'IGNORE';
6536 my $oldAutoCommit = $FS::UID::AutoCommit;
6537 local $FS::UID::AutoCommit = 0;
6540 $self->select_for_update; #mutex
6544 my @payments = sort { $b->_date <=> $a->_date }
6545 grep { $_->unapplied > 0 }
6548 my @invoices = sort { $a->_date <=> $b->_date}
6549 grep { $_->owed > 0 }
6552 if ( $conf->exists('pkg-balances') ) {
6553 # limit @payments to those w/ a pkgnum grepped from $self
6555 foreach my $i (@invoices) {
6556 foreach my $li ( $i->cust_bill_pkg ) {
6557 $pkgnums{$li->pkgnum} = 1;
6560 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6565 foreach my $cust_bill ( @invoices ) {
6567 if ( !defined($payment) || $payment->unapplied == 0 ) {
6568 $payment = pop @payments or last;
6572 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6573 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6575 $owed = $cust_bill->owed;
6577 unless ( $owed > 0 ) {
6578 push @payments, $payment;
6582 my $amount = min( $payment->unapplied, $owed );
6584 my $cust_bill_pay = new FS::cust_bill_pay ( {
6585 'paynum' => $payment->paynum,
6586 'invnum' => $cust_bill->invnum,
6587 'amount' => $amount,
6589 $cust_bill_pay->pkgnum( $payment->pkgnum )
6590 if $conf->exists('pkg-balances') && $payment->pkgnum;
6591 my $error = $cust_bill_pay->insert(%options);
6593 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6597 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6601 my $total_unapplied_payments = $self->total_unapplied_payments;
6603 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6605 return $total_unapplied_payments;
6610 Returns the total owed for this customer on all invoices
6611 (see L<FS::cust_bill/owed>).
6617 $self->total_owed_date(2145859200); #12/31/2037
6620 =item total_owed_date TIME
6622 Returns the total owed for this customer on all invoices with date earlier than
6623 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6624 see L<Time::Local> and L<Date::Parse> for conversion functions.
6628 sub total_owed_date {
6632 # my $custnum = $self->custnum;
6634 # my $owed_sql = FS::cust_bill->owed_sql;
6637 # SELECT SUM($owed_sql) FROM cust_bill
6638 # WHERE custnum = $custnum
6639 # AND _date <= $time
6642 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6643 # $sth->execute() or die $sth->errstr;
6645 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6648 foreach my $cust_bill (
6649 grep { $_->_date <= $time }
6650 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6652 $total_bill += $cust_bill->owed;
6654 sprintf( "%.2f", $total_bill );
6658 =item total_owed_pkgnum PKGNUM
6660 Returns the total owed on all invoices for this customer's specific package
6661 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6665 sub total_owed_pkgnum {
6666 my( $self, $pkgnum ) = @_;
6667 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6670 =item total_owed_date_pkgnum TIME PKGNUM
6672 Returns the total owed for this customer's specific package when using
6673 experimental package balances on all invoices with date earlier than
6674 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6675 see L<Time::Local> and L<Date::Parse> for conversion functions.
6679 sub total_owed_date_pkgnum {
6680 my( $self, $time, $pkgnum ) = @_;
6683 foreach my $cust_bill (
6684 grep { $_->_date <= $time }
6685 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6687 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6689 sprintf( "%.2f", $total_bill );
6695 Returns the total amount of all payments.
6702 $total += $_->paid foreach $self->cust_pay;
6703 sprintf( "%.2f", $total );
6706 =item total_unapplied_credits
6708 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6709 customer. See L<FS::cust_credit/credited>.
6711 =item total_credited
6713 Old name for total_unapplied_credits. Don't use.
6717 sub total_credited {
6718 #carp "total_credited deprecated, use total_unapplied_credits";
6719 shift->total_unapplied_credits(@_);
6722 sub total_unapplied_credits {
6724 my $total_credit = 0;
6725 $total_credit += $_->credited foreach $self->cust_credit;
6726 sprintf( "%.2f", $total_credit );
6729 =item total_unapplied_credits_pkgnum PKGNUM
6731 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6732 customer. See L<FS::cust_credit/credited>.
6736 sub total_unapplied_credits_pkgnum {
6737 my( $self, $pkgnum ) = @_;
6738 my $total_credit = 0;
6739 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6740 sprintf( "%.2f", $total_credit );
6744 =item total_unapplied_payments
6746 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6747 See L<FS::cust_pay/unapplied>.
6751 sub total_unapplied_payments {
6753 my $total_unapplied = 0;
6754 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6755 sprintf( "%.2f", $total_unapplied );
6758 =item total_unapplied_payments_pkgnum PKGNUM
6760 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6761 specific package when using experimental package balances. See
6762 L<FS::cust_pay/unapplied>.
6766 sub total_unapplied_payments_pkgnum {
6767 my( $self, $pkgnum ) = @_;
6768 my $total_unapplied = 0;
6769 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6770 sprintf( "%.2f", $total_unapplied );
6774 =item total_unapplied_refunds
6776 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6777 customer. See L<FS::cust_refund/unapplied>.
6781 sub total_unapplied_refunds {
6783 my $total_unapplied = 0;
6784 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6785 sprintf( "%.2f", $total_unapplied );
6790 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6791 total_unapplied_credits minus total_unapplied_payments).
6799 + $self->total_unapplied_refunds
6800 - $self->total_unapplied_credits
6801 - $self->total_unapplied_payments
6805 =item balance_date TIME
6807 Returns the balance for this customer, only considering invoices with date
6808 earlier than TIME (total_owed_date minus total_credited minus
6809 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6810 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6819 $self->total_owed_date($time)
6820 + $self->total_unapplied_refunds
6821 - $self->total_unapplied_credits
6822 - $self->total_unapplied_payments
6826 =item balance_pkgnum PKGNUM
6828 Returns the balance for this customer's specific package when using
6829 experimental package balances (total_owed plus total_unrefunded, minus
6830 total_unapplied_credits minus total_unapplied_payments)
6834 sub balance_pkgnum {
6835 my( $self, $pkgnum ) = @_;
6838 $self->total_owed_pkgnum($pkgnum)
6839 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6840 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6841 - $self->total_unapplied_credits_pkgnum($pkgnum)
6842 - $self->total_unapplied_payments_pkgnum($pkgnum)
6846 =item in_transit_payments
6848 Returns the total of requests for payments for this customer pending in
6849 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6853 sub in_transit_payments {
6855 my $in_transit_payments = 0;
6856 foreach my $pay_batch ( qsearch('pay_batch', {
6859 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6860 'batchnum' => $pay_batch->batchnum,
6861 'custnum' => $self->custnum,
6863 $in_transit_payments += $cust_pay_batch->amount;
6866 sprintf( "%.2f", $in_transit_payments );
6871 Returns a hash of useful information for making a payment.
6881 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6882 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6883 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6887 For credit card transactions:
6899 For electronic check transactions:
6914 $return{balance} = $self->balance;
6916 $return{payname} = $self->payname
6917 || ( $self->first. ' '. $self->get('last') );
6919 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6921 $return{payby} = $self->payby;
6922 $return{stateid_state} = $self->stateid_state;
6924 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6925 $return{card_type} = cardtype($self->payinfo);
6926 $return{payinfo} = $self->paymask;
6928 @return{'month', 'year'} = $self->paydate_monthyear;
6932 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6933 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6934 $return{payinfo1} = $payinfo1;
6935 $return{payinfo2} = $payinfo2;
6936 $return{paytype} = $self->paytype;
6937 $return{paystate} = $self->paystate;
6941 #doubleclick protection
6943 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6949 =item paydate_monthyear
6951 Returns a two-element list consisting of the month and year of this customer's
6952 paydate (credit card expiration date for CARD customers)
6956 sub paydate_monthyear {
6958 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6960 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6967 =item tax_exemption TAXNAME
6972 my( $self, $taxname ) = @_;
6974 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6975 'taxname' => $taxname,
6980 =item cust_main_exemption
6984 sub cust_main_exemption {
6986 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6989 =item invoicing_list [ ARRAYREF ]
6991 If an arguement is given, sets these email addresses as invoice recipients
6992 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6993 (except as warnings), so use check_invoicing_list first.
6995 Returns a list of email addresses (with svcnum entries expanded).
6997 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6998 check it without disturbing anything by passing nothing.
7000 This interface may change in the future.
7004 sub invoicing_list {
7005 my( $self, $arrayref ) = @_;
7008 my @cust_main_invoice;
7009 if ( $self->custnum ) {
7010 @cust_main_invoice =
7011 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7013 @cust_main_invoice = ();
7015 foreach my $cust_main_invoice ( @cust_main_invoice ) {
7016 #warn $cust_main_invoice->destnum;
7017 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7018 #warn $cust_main_invoice->destnum;
7019 my $error = $cust_main_invoice->delete;
7020 warn $error if $error;
7023 if ( $self->custnum ) {
7024 @cust_main_invoice =
7025 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7027 @cust_main_invoice = ();
7029 my %seen = map { $_->address => 1 } @cust_main_invoice;
7030 foreach my $address ( @{$arrayref} ) {
7031 next if exists $seen{$address} && $seen{$address};
7032 $seen{$address} = 1;
7033 my $cust_main_invoice = new FS::cust_main_invoice ( {
7034 'custnum' => $self->custnum,
7037 my $error = $cust_main_invoice->insert;
7038 warn $error if $error;
7042 if ( $self->custnum ) {
7044 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7051 =item check_invoicing_list ARRAYREF
7053 Checks these arguements as valid input for the invoicing_list method. If there
7054 is an error, returns the error, otherwise returns false.
7058 sub check_invoicing_list {
7059 my( $self, $arrayref ) = @_;
7061 foreach my $address ( @$arrayref ) {
7063 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7064 return 'Can\'t add FAX invoice destination with a blank FAX number.';
7067 my $cust_main_invoice = new FS::cust_main_invoice ( {
7068 'custnum' => $self->custnum,
7071 my $error = $self->custnum
7072 ? $cust_main_invoice->check
7073 : $cust_main_invoice->checkdest
7075 return $error if $error;
7079 return "Email address required"
7080 if $conf->exists('cust_main-require_invoicing_list_email')
7081 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7086 =item set_default_invoicing_list
7088 Sets the invoicing list to all accounts associated with this customer,
7089 overwriting any previous invoicing list.
7093 sub set_default_invoicing_list {
7095 $self->invoicing_list($self->all_emails);
7100 Returns the email addresses of all accounts provisioned for this customer.
7107 foreach my $cust_pkg ( $self->all_pkgs ) {
7108 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7110 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7111 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7113 $list{$_}=1 foreach map { $_->email } @svc_acct;
7118 =item invoicing_list_addpost
7120 Adds postal invoicing to this customer. If this customer is already configured
7121 to receive postal invoices, does nothing.
7125 sub invoicing_list_addpost {
7127 return if grep { $_ eq 'POST' } $self->invoicing_list;
7128 my @invoicing_list = $self->invoicing_list;
7129 push @invoicing_list, 'POST';
7130 $self->invoicing_list(\@invoicing_list);
7133 =item invoicing_list_emailonly
7135 Returns the list of email invoice recipients (invoicing_list without non-email
7136 destinations such as POST and FAX).
7140 sub invoicing_list_emailonly {
7142 warn "$me invoicing_list_emailonly called"
7144 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7147 =item invoicing_list_emailonly_scalar
7149 Returns the list of email invoice recipients (invoicing_list without non-email
7150 destinations such as POST and FAX) as a comma-separated scalar.
7154 sub invoicing_list_emailonly_scalar {
7156 warn "$me invoicing_list_emailonly_scalar called"
7158 join(', ', $self->invoicing_list_emailonly);
7161 =item referral_custnum_cust_main
7163 Returns the customer who referred this customer (or the empty string, if
7164 this customer was not referred).
7166 Note the difference with referral_cust_main method: This method,
7167 referral_custnum_cust_main returns the single customer (if any) who referred
7168 this customer, while referral_cust_main returns an array of customers referred
7173 sub referral_custnum_cust_main {
7175 return '' unless $self->referral_custnum;
7176 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7179 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7181 Returns an array of customers referred by this customer (referral_custnum set
7182 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7183 customers referred by customers referred by this customer and so on, inclusive.
7184 The default behavior is DEPTH 1 (no recursion).
7186 Note the difference with referral_custnum_cust_main method: This method,
7187 referral_cust_main, returns an array of customers referred BY this customer,
7188 while referral_custnum_cust_main returns the single customer (if any) who
7189 referred this customer.
7193 sub referral_cust_main {
7195 my $depth = @_ ? shift : 1;
7196 my $exclude = @_ ? shift : {};
7199 map { $exclude->{$_->custnum}++; $_; }
7200 grep { ! $exclude->{ $_->custnum } }
7201 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7205 map { $_->referral_cust_main($depth-1, $exclude) }
7212 =item referral_cust_main_ncancelled
7214 Same as referral_cust_main, except only returns customers with uncancelled
7219 sub referral_cust_main_ncancelled {
7221 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7224 =item referral_cust_pkg [ DEPTH ]
7226 Like referral_cust_main, except returns a flat list of all unsuspended (and
7227 uncancelled) packages for each customer. The number of items in this list may
7228 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7232 sub referral_cust_pkg {
7234 my $depth = @_ ? shift : 1;
7236 map { $_->unsuspended_pkgs }
7237 grep { $_->unsuspended_pkgs }
7238 $self->referral_cust_main($depth);
7241 =item referring_cust_main
7243 Returns the single cust_main record for the customer who referred this customer
7244 (referral_custnum), or false.
7248 sub referring_cust_main {
7250 return '' unless $self->referral_custnum;
7251 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7254 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7256 Applies a credit to this customer. If there is an error, returns the error,
7257 otherwise returns false.
7259 REASON can be a text string, an FS::reason object, or a scalar reference to
7260 a reasonnum. If a text string, it will be automatically inserted as a new
7261 reason, and a 'reason_type' option must be passed to indicate the
7262 FS::reason_type for the new reason.
7264 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7266 Any other options are passed to FS::cust_credit::insert.
7271 my( $self, $amount, $reason, %options ) = @_;
7273 my $cust_credit = new FS::cust_credit {
7274 'custnum' => $self->custnum,
7275 'amount' => $amount,
7278 if ( ref($reason) ) {
7280 if ( ref($reason) eq 'SCALAR' ) {
7281 $cust_credit->reasonnum( $$reason );
7283 $cust_credit->reasonnum( $reason->reasonnum );
7287 $cust_credit->set('reason', $reason)
7290 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7291 if exists($options{'addlinfo'});
7293 $cust_credit->insert(%options);
7297 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7299 Creates a one-time charge for this customer. If there is an error, returns
7300 the error, otherwise returns false.
7302 New-style, with a hashref of options:
7304 my $error = $cust_main->charge(
7308 'start_date' => str2time('7/4/2009'),
7309 'pkg' => 'Description',
7310 'comment' => 'Comment',
7311 'additional' => [], #extra invoice detail
7312 'classnum' => 1, #pkg_class
7314 'setuptax' => '', # or 'Y' for tax exempt
7317 'taxclass' => 'Tax class',
7320 'taxproduct' => 2, #part_pkg_taxproduct
7321 'override' => {}, #XXX describe
7323 #will be filled in with the new object
7324 'cust_pkg_ref' => \$cust_pkg,
7326 #generate an invoice immediately
7328 'invoice_terms' => '', #with these terms
7334 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7340 my ( $amount, $quantity, $start_date, $classnum );
7341 my ( $pkg, $comment, $additional );
7342 my ( $setuptax, $taxclass ); #internal taxes
7343 my ( $taxproduct, $override ); #vendor (CCH) taxes
7344 my $cust_pkg_ref = '';
7345 my ( $bill_now, $invoice_terms ) = ( 0, '' );
7346 if ( ref( $_[0] ) ) {
7347 $amount = $_[0]->{amount};
7348 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7349 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7350 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7351 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7352 : '$'. sprintf("%.2f",$amount);
7353 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7354 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7355 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7356 $additional = $_[0]->{additional} || [];
7357 $taxproduct = $_[0]->{taxproductnum};
7358 $override = { '' => $_[0]->{tax_override} };
7359 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7360 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7361 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7366 $pkg = @_ ? shift : 'One-time charge';
7367 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7369 $taxclass = @_ ? shift : '';
7373 local $SIG{HUP} = 'IGNORE';
7374 local $SIG{INT} = 'IGNORE';
7375 local $SIG{QUIT} = 'IGNORE';
7376 local $SIG{TERM} = 'IGNORE';
7377 local $SIG{TSTP} = 'IGNORE';
7378 local $SIG{PIPE} = 'IGNORE';
7380 my $oldAutoCommit = $FS::UID::AutoCommit;
7381 local $FS::UID::AutoCommit = 0;
7384 my $part_pkg = new FS::part_pkg ( {
7386 'comment' => $comment,
7390 'classnum' => ( $classnum ? $classnum : '' ),
7391 'setuptax' => $setuptax,
7392 'taxclass' => $taxclass,
7393 'taxproductnum' => $taxproduct,
7396 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7397 ( 0 .. @$additional - 1 )
7399 'additional_count' => scalar(@$additional),
7400 'setup_fee' => $amount,
7403 my $error = $part_pkg->insert( options => \%options,
7404 tax_overrides => $override,
7407 $dbh->rollback if $oldAutoCommit;
7411 my $pkgpart = $part_pkg->pkgpart;
7412 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7413 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7414 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7415 $error = $type_pkgs->insert;
7417 $dbh->rollback if $oldAutoCommit;
7422 my $cust_pkg = new FS::cust_pkg ( {
7423 'custnum' => $self->custnum,
7424 'pkgpart' => $pkgpart,
7425 'quantity' => $quantity,
7426 'start_date' => $start_date,
7429 $error = $cust_pkg->insert;
7431 $dbh->rollback if $oldAutoCommit;
7433 } elsif ( $cust_pkg_ref ) {
7434 ${$cust_pkg_ref} = $cust_pkg;
7438 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7439 'pkg_list' => [ $cust_pkg ],
7442 $dbh->rollback if $oldAutoCommit;
7447 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7452 #=item charge_postal_fee
7454 #Applies a one time charge this customer. If there is an error,
7455 #returns the error, returns the cust_pkg charge object or false
7456 #if there was no charge.
7460 # This should be a customer event. For that to work requires that bill
7461 # also be a customer event.
7463 sub charge_postal_fee {
7466 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7467 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7469 my $cust_pkg = new FS::cust_pkg ( {
7470 'custnum' => $self->custnum,
7471 'pkgpart' => $pkgpart,
7475 my $error = $cust_pkg->insert;
7476 $error ? $error : $cust_pkg;
7481 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7487 map { $_ } #return $self->num_cust_bill unless wantarray;
7488 sort { $a->_date <=> $b->_date }
7489 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7492 =item open_cust_bill
7494 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7499 sub open_cust_bill {
7503 'table' => 'cust_bill',
7504 'hashref' => { 'custnum' => $self->custnum, },
7505 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7506 'order_by' => 'ORDER BY _date ASC',
7511 =item cust_statements
7513 Returns all the statements (see L<FS::cust_statement>) for this customer.
7517 sub cust_statement {
7519 map { $_ } #return $self->num_cust_statement unless wantarray;
7520 sort { $a->_date <=> $b->_date }
7521 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7526 Returns all the credits (see L<FS::cust_credit>) for this customer.
7532 map { $_ } #return $self->num_cust_credit unless wantarray;
7533 sort { $a->_date <=> $b->_date }
7534 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7537 =item cust_credit_pkgnum
7539 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7540 package when using experimental package balances.
7544 sub cust_credit_pkgnum {
7545 my( $self, $pkgnum ) = @_;
7546 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7547 sort { $a->_date <=> $b->_date }
7548 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7549 'pkgnum' => $pkgnum,
7556 Returns all the payments (see L<FS::cust_pay>) for this customer.
7562 return $self->num_cust_pay unless wantarray;
7563 sort { $a->_date <=> $b->_date }
7564 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7569 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7570 called automatically when the cust_pay method is used in a scalar context.
7576 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7577 my $sth = dbh->prepare($sql) or die dbh->errstr;
7578 $sth->execute($self->custnum) or die $sth->errstr;
7579 $sth->fetchrow_arrayref->[0];
7582 =item cust_pay_pkgnum
7584 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7585 package when using experimental package balances.
7589 sub cust_pay_pkgnum {
7590 my( $self, $pkgnum ) = @_;
7591 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7592 sort { $a->_date <=> $b->_date }
7593 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7594 'pkgnum' => $pkgnum,
7601 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7607 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7608 sort { $a->_date <=> $b->_date }
7609 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7612 =item cust_pay_batch
7614 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7618 sub cust_pay_batch {
7620 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7621 sort { $a->paybatchnum <=> $b->paybatchnum }
7622 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7625 =item cust_pay_pending
7627 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7628 (without status "done").
7632 sub cust_pay_pending {
7634 return $self->num_cust_pay_pending unless wantarray;
7635 sort { $a->_date <=> $b->_date }
7636 qsearch( 'cust_pay_pending', {
7637 'custnum' => $self->custnum,
7638 'status' => { op=>'!=', value=>'done' },
7643 =item num_cust_pay_pending
7645 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7646 customer (without status "done"). Also called automatically when the
7647 cust_pay_pending method is used in a scalar context.
7651 sub num_cust_pay_pending {
7653 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7654 " WHERE custnum = ? AND status != 'done' ";
7655 my $sth = dbh->prepare($sql) or die dbh->errstr;
7656 $sth->execute($self->custnum) or die $sth->errstr;
7657 $sth->fetchrow_arrayref->[0];
7662 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7668 map { $_ } #return $self->num_cust_refund unless wantarray;
7669 sort { $a->_date <=> $b->_date }
7670 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7673 =item display_custnum
7675 Returns the displayed customer number for this customer: agent_custid if
7676 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7680 sub display_custnum {
7682 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7683 return $self->agent_custid;
7685 return $self->custnum;
7691 Returns a name string for this customer, either "Company (Last, First)" or
7698 my $name = $self->contact;
7699 $name = $self->company. " ($name)" if $self->company;
7705 Returns a name string for this (service/shipping) contact, either
7706 "Company (Last, First)" or "Last, First".
7712 if ( $self->get('ship_last') ) {
7713 my $name = $self->ship_contact;
7714 $name = $self->ship_company. " ($name)" if $self->ship_company;
7723 Returns a name string for this customer, either "Company" or "First Last".
7729 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7732 =item ship_name_short
7734 Returns a name string for this (service/shipping) contact, either "Company"
7739 sub ship_name_short {
7741 if ( $self->get('ship_last') ) {
7742 $self->ship_company !~ /^\s*$/
7743 ? $self->ship_company
7744 : $self->ship_contact_firstlast;
7746 $self->name_company_or_firstlast;
7752 Returns this customer's full (billing) contact name only, "Last, First"
7758 $self->get('last'). ', '. $self->first;
7763 Returns this customer's full (shipping) contact name only, "Last, First"
7769 $self->get('ship_last')
7770 ? $self->get('ship_last'). ', '. $self->ship_first
7774 =item contact_firstlast
7776 Returns this customers full (billing) contact name only, "First Last".
7780 sub contact_firstlast {
7782 $self->first. ' '. $self->get('last');
7785 =item ship_contact_firstlast
7787 Returns this customer's full (shipping) contact name only, "First Last".
7791 sub ship_contact_firstlast {
7793 $self->get('ship_last')
7794 ? $self->first. ' '. $self->get('ship_last')
7795 : $self->contact_firstlast;
7800 Returns this customer's full country name
7806 code2country($self->country);
7809 =item geocode DATA_VENDOR
7811 Returns a value for the customer location as encoded by DATA_VENDOR.
7812 Currently this only makes sense for "CCH" as DATA_VENDOR.
7817 my ($self, $data_vendor) = (shift, shift); #always cch for now
7819 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7820 return $geocode if $geocode;
7822 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7826 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7827 if $self->country eq 'US';
7829 #CCH specific location stuff
7830 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7832 my @cust_tax_location =
7834 'table' => 'cust_tax_location',
7835 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7836 'extra_sql' => $extra_sql,
7837 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7840 $geocode = $cust_tax_location[0]->geocode
7841 if scalar(@cust_tax_location);
7850 Returns a status string for this customer, currently:
7854 =item prospect - No packages have ever been ordered
7856 =item active - One or more recurring packages is active
7858 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7860 =item suspended - All non-cancelled recurring packages are suspended
7862 =item cancelled - All recurring packages are cancelled
7868 sub status { shift->cust_status(@_); }
7872 for my $status (qw( prospect active inactive suspended cancelled )) {
7873 my $method = $status.'_sql';
7874 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7875 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7876 $sth->execute( ($self->custnum) x $numnum )
7877 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7878 return $status if $sth->fetchrow_arrayref->[0];
7882 =item ucfirst_cust_status
7884 =item ucfirst_status
7886 Returns the status with the first character capitalized.
7890 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7892 sub ucfirst_cust_status {
7894 ucfirst($self->cust_status);
7899 Returns a hex triplet color string for this customer's status.
7903 use vars qw(%statuscolor);
7904 tie %statuscolor, 'Tie::IxHash',
7905 'prospect' => '7e0079', #'000000', #black? naw, purple
7906 'active' => '00CC00', #green
7907 'inactive' => '0000CC', #blue
7908 'suspended' => 'FF9900', #yellow
7909 'cancelled' => 'FF0000', #red
7912 sub statuscolor { shift->cust_statuscolor(@_); }
7914 sub cust_statuscolor {
7916 $statuscolor{$self->cust_status};
7921 Returns an array of hashes representing the customer's RT tickets.
7928 my $num = $conf->config('cust_main-max_tickets') || 10;
7931 if ( $conf->config('ticket_system') ) {
7932 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7934 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7938 foreach my $priority (
7939 $conf->config('ticket_system-custom_priority_field-values'), ''
7941 last if scalar(@tickets) >= $num;
7943 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7944 $num - scalar(@tickets),
7954 # Return services representing svc_accts in customer support packages
7955 sub support_services {
7957 my %packages = map { $_ => 1 } $conf->config('support_packages');
7959 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7960 grep { $_->part_svc->svcdb eq 'svc_acct' }
7961 map { $_->cust_svc }
7962 grep { exists $packages{ $_->pkgpart } }
7963 $self->ncancelled_pkgs;
7967 # Return a list of latitude/longitude for one of the services (if any)
7968 sub service_coordinates {
7972 grep { $_->latitude && $_->longitude }
7974 map { $_->cust_svc }
7975 $self->ncancelled_pkgs;
7977 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7982 =head1 CLASS METHODS
7988 Class method that returns the list of possible status strings for customers
7989 (see L<the status method|/status>). For example:
7991 @statuses = FS::cust_main->statuses();
7996 #my $self = shift; #could be class...
8002 Returns an SQL expression identifying prospective cust_main records (customers
8003 with no packages ever ordered)
8007 use vars qw($select_count_pkgs);
8008 $select_count_pkgs =
8009 "SELECT COUNT(*) FROM cust_pkg
8010 WHERE cust_pkg.custnum = cust_main.custnum";
8012 sub select_count_pkgs_sql {
8016 sub prospect_sql { "
8017 0 = ( $select_count_pkgs )
8022 Returns an SQL expression identifying active cust_main records (customers with
8023 active recurring packages).
8028 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8034 Returns an SQL expression identifying inactive cust_main records (customers with
8035 no active recurring packages, but otherwise unsuspended/uncancelled).
8039 sub inactive_sql { "
8040 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8042 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8048 Returns an SQL expression identifying suspended cust_main records.
8053 sub suspended_sql { susp_sql(@_); }
8055 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8057 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8063 Returns an SQL expression identifying cancelled cust_main records.
8067 sub cancelled_sql { cancel_sql(@_); }
8070 my $recurring_sql = FS::cust_pkg->recurring_sql;
8071 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8074 0 < ( $select_count_pkgs )
8075 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
8076 AND 0 = ( $select_count_pkgs AND $recurring_sql
8077 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8079 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8085 =item uncancelled_sql
8087 Returns an SQL expression identifying un-cancelled cust_main records.
8091 sub uncancelled_sql { uncancel_sql(@_); }
8092 sub uncancel_sql { "
8093 ( 0 < ( $select_count_pkgs
8094 AND ( cust_pkg.cancel IS NULL
8095 OR cust_pkg.cancel = 0
8098 OR 0 = ( $select_count_pkgs )
8104 Returns an SQL fragment to retreive the balance.
8109 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8110 WHERE cust_bill.custnum = cust_main.custnum )
8111 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
8112 WHERE cust_pay.custnum = cust_main.custnum )
8113 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
8114 WHERE cust_credit.custnum = cust_main.custnum )
8115 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
8116 WHERE cust_refund.custnum = cust_main.custnum )
8119 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8121 Returns an SQL fragment to retreive the balance for this customer, only
8122 considering invoices with date earlier than START_TIME, and optionally not
8123 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8124 total_unapplied_payments).
8126 Times are specified as SQL fragments or numeric
8127 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8128 L<Date::Parse> for conversion functions. The empty string can be passed
8129 to disable that time constraint completely.
8131 Available options are:
8135 =item unapplied_date
8137 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)
8142 set to true to remove all customer comparison clauses, for totals
8147 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8152 JOIN clause (typically used with the total option)
8158 sub balance_date_sql {
8159 my( $class, $start, $end, %opt ) = @_;
8161 my $owed = FS::cust_bill->owed_sql;
8162 my $unapp_refund = FS::cust_refund->unapplied_sql;
8163 my $unapp_credit = FS::cust_credit->unapplied_sql;
8164 my $unapp_pay = FS::cust_pay->unapplied_sql;
8166 my $j = $opt{'join'} || '';
8168 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8169 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8170 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8171 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8173 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8174 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8175 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8176 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8181 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8183 Returns an SQL fragment to retreive the total unapplied payments for this
8184 customer, only considering invoices with date earlier than START_TIME, and
8185 optionally not later than END_TIME.
8187 Times are specified as SQL fragments or numeric
8188 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8189 L<Date::Parse> for conversion functions. The empty string can be passed
8190 to disable that time constraint completely.
8192 Available options are:
8196 sub unapplied_payments_date_sql {
8197 my( $class, $start, $end, ) = @_;
8199 my $unapp_pay = FS::cust_pay->unapplied_sql;
8201 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8202 'unapplied_date'=>1 );
8204 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8207 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8209 Helper method for balance_date_sql; name (and usage) subject to change
8210 (suggestions welcome).
8212 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8213 cust_refund, cust_credit or cust_pay).
8215 If TABLE is "cust_bill" or the unapplied_date option is true, only
8216 considers records with date earlier than START_TIME, and optionally not
8217 later than END_TIME .
8221 sub _money_table_where {
8222 my( $class, $table, $start, $end, %opt ) = @_;
8225 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8226 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8227 push @where, "$table._date <= $start" if defined($start) && length($start);
8228 push @where, "$table._date > $end" if defined($end) && length($end);
8230 push @where, @{$opt{'where'}} if $opt{'where'};
8231 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8237 =item search_sql HASHREF
8241 Returns a qsearch hash expression to search for parameters specified in HREF.
8242 Valid parameters are
8250 =item cancelled_pkgs
8256 listref of start date, end date
8262 =item current_balance
8264 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8268 =item flattened_pkgs
8277 my ($class, $params) = @_;
8288 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8290 "cust_main.agentnum = $1";
8297 #prospect active inactive suspended cancelled
8298 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8299 my $method = $params->{'status'}. '_sql';
8300 #push @where, $class->$method();
8301 push @where, FS::cust_main->$method();
8305 # parse cancelled package checkbox
8310 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8311 unless $params->{'cancelled_pkgs'};
8314 # parse without census tract checkbox
8317 push @where, "(censustract = '' or censustract is null)"
8318 if $params->{'no_censustract'};
8324 foreach my $field (qw( signupdate )) {
8326 next unless exists($params->{$field});
8328 my($beginning, $ending) = @{$params->{$field}};
8331 "cust_main.$field IS NOT NULL",
8332 "cust_main.$field >= $beginning",
8333 "cust_main.$field <= $ending";
8335 $orderby ||= "ORDER BY cust_main.$field";
8343 my @classnum = grep /^(\d*)$/, @{ $params->{'classnum'} };
8345 push @where, '( '. join(' OR ', map {
8346 $_ ? "cust_main.classnum = $_"
8347 : "cust_main.classnum IS NULL"
8358 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8360 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8367 #my $balance_sql = $class->balance_sql();
8368 my $balance_sql = FS::cust_main->balance_sql();
8370 push @where, map { s/current_balance/$balance_sql/; $_ }
8371 @{ $params->{'current_balance'} };
8377 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8379 "cust_main.custbatch = '$1'";
8383 # setup queries, subs, etc. for the search
8386 $orderby ||= 'ORDER BY custnum';
8388 # here is the agent virtualization
8389 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8391 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8393 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8395 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8397 my $select = join(', ',
8398 'cust_main.custnum',
8399 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8402 my(@extra_headers) = ();
8403 my(@extra_fields) = ();
8405 if ($params->{'flattened_pkgs'}) {
8407 if ($dbh->{Driver}->{Name} eq 'Pg') {
8409 $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";
8411 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8412 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8413 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8415 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8416 "omitting packing information from report.";
8419 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";
8421 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8422 $sth->execute() or die $sth->errstr;
8423 my $headerrow = $sth->fetchrow_arrayref;
8424 my $headercount = $headerrow ? $headerrow->[0] : 0;
8425 while($headercount) {
8426 unshift @extra_headers, "Package ". $headercount;
8427 unshift @extra_fields, eval q!sub {my $c = shift;
8428 my @a = split '\|', $c->magic;
8429 my $p = $a[!.--$headercount. q!];
8437 'table' => 'cust_main',
8438 'select' => $select,
8440 'extra_sql' => $extra_sql,
8441 'order_by' => $orderby,
8442 'count_query' => $count_query,
8443 'extra_headers' => \@extra_headers,
8444 'extra_fields' => \@extra_fields,
8449 =item email_search_sql HASHREF
8453 Emails a notice to the specified customers.
8455 Valid parameters are those of the L<search_sql> method, plus the following:
8477 Optional job queue job for status updates.
8481 Returns an error message, or false for success.
8483 If an error occurs during any email, stops the enture send and returns that
8484 error. Presumably if you're getting SMTP errors aborting is better than
8485 retrying everything.
8489 sub email_search_sql {
8490 my($class, $params) = @_;
8492 my $from = delete $params->{from};
8493 my $subject = delete $params->{subject};
8494 my $html_body = delete $params->{html_body};
8495 my $text_body = delete $params->{text_body};
8497 my $job = delete $params->{'job'};
8499 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8500 unless ref($params->{'payby'});
8502 my $sql_query = $class->search_sql($params);
8504 my $count_query = delete($sql_query->{'count_query'});
8505 my $count_sth = dbh->prepare($count_query)
8506 or die "Error preparing $count_query: ". dbh->errstr;
8508 or die "Error executing $count_query: ". $count_sth->errstr;
8509 my $count_arrayref = $count_sth->fetchrow_arrayref;
8510 my $num_cust = $count_arrayref->[0];
8512 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8513 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8516 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8518 #eventually order+limit magic to reduce memory use?
8519 foreach my $cust_main ( qsearch($sql_query) ) {
8521 my $to = $cust_main->invoicing_list_emailonly_scalar;
8524 my $error = send_email(
8528 'subject' => $subject,
8529 'html_body' => $html_body,
8530 'text_body' => $text_body,
8533 return $error if $error;
8535 if ( $job ) { #progressbar foo
8537 if ( time - $min_sec > $last ) {
8538 my $error = $job->update_statustext(
8539 int( 100 * $num / $num_cust )
8541 die $error if $error;
8551 use Storable qw(thaw);
8554 sub process_email_search_sql {
8556 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8558 my $param = thaw(decode_base64(shift));
8559 warn Dumper($param) if $DEBUG;
8561 $param->{'job'} = $job;
8563 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8564 unless ref($param->{'payby'});
8566 my $error = FS::cust_main->email_search_sql( $param );
8567 die $error if $error;
8571 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8573 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8574 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8575 specified (the appropriate ship_ field is also searched).
8577 Additional options are the same as FS::Record::qsearch
8582 my( $self, $fuzzy, $hash, @opt) = @_;
8587 check_and_rebuild_fuzzyfiles();
8588 foreach my $field ( keys %$fuzzy ) {
8590 my $all = $self->all_X($field);
8591 next unless scalar(@$all);
8594 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8597 foreach ( keys %match ) {
8598 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8599 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8602 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8605 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8607 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8615 Returns a masked version of the named field
8620 my ($self,$field) = @_;
8624 'x'x(length($self->getfield($field))-4).
8625 substr($self->getfield($field), (length($self->getfield($field))-4));
8635 =item smart_search OPTION => VALUE ...
8637 Accepts the following options: I<search>, the string to search for. The string
8638 will be searched for as a customer number, phone number, name or company name,
8639 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8640 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8641 skip fuzzy matching when an exact match is found.
8643 Any additional options are treated as an additional qualifier on the search
8646 Returns a (possibly empty) array of FS::cust_main objects.
8653 #here is the agent virtualization
8654 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8658 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8659 my $search = delete $options{'search'};
8660 ( my $alphanum_search = $search ) =~ s/\W//g;
8662 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8664 #false laziness w/Record::ut_phone
8665 my $phonen = "$1-$2-$3";
8666 $phonen .= " x$4" if $4;
8668 push @cust_main, qsearch( {
8669 'table' => 'cust_main',
8670 'hashref' => { %options },
8671 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8673 join(' OR ', map "$_ = '$phonen'",
8674 qw( daytime night fax
8675 ship_daytime ship_night ship_fax )
8678 " AND $agentnums_sql", #agent virtualization
8681 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8682 #try looking for matches with extensions unless one was specified
8684 push @cust_main, qsearch( {
8685 'table' => 'cust_main',
8686 'hashref' => { %options },
8687 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8689 join(' OR ', map "$_ LIKE '$phonen\%'",
8691 ship_daytime ship_night )
8694 " AND $agentnums_sql", #agent virtualization
8699 # custnum search (also try agent_custid), with some tweaking options if your
8700 # legacy cust "numbers" have letters
8703 if ( $search =~ /^\s*(\d+)\s*$/
8704 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8705 && $search =~ /^\s*(\w\w?\d+)\s*$/
8707 || ( $conf->exists('address1-search' )
8708 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8715 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8716 push @cust_main, qsearch( {
8717 'table' => 'cust_main',
8718 'hashref' => { 'custnum' => $num, %options },
8719 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8723 push @cust_main, qsearch( {
8724 'table' => 'cust_main',
8725 'hashref' => { 'agent_custid' => $num, %options },
8726 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8729 if ( $conf->exists('address1-search') ) {
8730 my $len = length($num);
8732 foreach my $prefix ( '', 'ship_' ) {
8733 push @cust_main, qsearch( {
8734 'table' => 'cust_main',
8735 'hashref' => { %options, },
8737 ( keys(%options) ? ' AND ' : ' WHERE ' ).
8738 " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8739 " AND $agentnums_sql",
8744 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8746 my($company, $last, $first) = ( $1, $2, $3 );
8748 # "Company (Last, First)"
8749 #this is probably something a browser remembered,
8750 #so just do an exact (but case-insensitive) search
8752 foreach my $prefix ( '', 'ship_' ) {
8753 push @cust_main, qsearch( {
8754 'table' => 'cust_main',
8755 'hashref' => { $prefix.'first' => $first,
8756 $prefix.'last' => $last,
8757 $prefix.'company' => $company,
8760 'extra_sql' => " AND $agentnums_sql",
8764 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8765 # try (ship_){last,company}
8769 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8770 # # full strings the browser remembers won't work
8771 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8773 use Lingua::EN::NameParse;
8774 my $NameParse = new Lingua::EN::NameParse(
8776 allow_reversed => 1,
8779 my($last, $first) = ( '', '' );
8780 #maybe disable this too and just rely on NameParse?
8781 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8783 ($last, $first) = ( $1, $2 );
8785 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8786 } elsif ( ! $NameParse->parse($value) ) {
8788 my %name = $NameParse->components;
8789 $first = $name{'given_name_1'};
8790 $last = $name{'surname_1'};
8794 if ( $first && $last ) {
8796 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8799 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8801 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8802 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8805 push @cust_main, qsearch( {
8806 'table' => 'cust_main',
8807 'hashref' => \%options,
8808 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8811 # or it just be something that was typed in... (try that in a sec)
8815 my $q_value = dbh->quote($value);
8818 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8819 $sql .= " ( LOWER(last) = $q_value
8820 OR LOWER(company) = $q_value
8821 OR LOWER(ship_last) = $q_value
8822 OR LOWER(ship_company) = $q_value
8824 $sql .= " OR LOWER(address1) = $q_value
8825 OR LOWER(ship_address1) = $q_value
8827 if $conf->exists('address1-search');
8830 push @cust_main, qsearch( {
8831 'table' => 'cust_main',
8832 'hashref' => \%options,
8833 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8836 #no exact match, trying substring/fuzzy
8837 #always do substring & fuzzy (unless they're explicity config'ed off)
8838 #getting complaints searches are not returning enough
8839 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8841 #still some false laziness w/search_sql (was search/cust_main.cgi)
8846 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8847 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8850 if ( $first && $last ) {
8853 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8854 'last' => { op=>'ILIKE', value=>"%$last%" },
8856 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8857 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8864 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8865 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8869 if ( $conf->exists('address1-search') ) {
8871 { 'address1' => { op=>'ILIKE', value=>"%$value%" }, },
8872 { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8876 foreach my $hashref ( @hashrefs ) {
8878 push @cust_main, qsearch( {
8879 'table' => 'cust_main',
8880 'hashref' => { %$hashref,
8883 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8892 " AND $agentnums_sql", #extra_sql #agent virtualization
8895 if ( $first && $last ) {
8896 push @cust_main, FS::cust_main->fuzzy_search(
8897 { 'last' => $last, #fuzzy hashref
8898 'first' => $first }, #
8902 foreach my $field ( 'last', 'company' ) {
8904 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8906 if ( $conf->exists('address1-search') ) {
8908 FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8915 #eliminate duplicates
8917 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8925 Accepts the following options: I<email>, the email address to search for. The
8926 email address will be searched for as an email invoice destination and as an
8929 #Any additional options are treated as an additional qualifier on the search
8930 #(i.e. I<agentnum>).
8932 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8942 my $email = delete $options{'email'};
8944 #we're only being used by RT at the moment... no agent virtualization yet
8945 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8949 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8951 my ( $user, $domain ) = ( $1, $2 );
8953 warn "$me smart_search: searching for $user in domain $domain"
8959 'table' => 'cust_main_invoice',
8960 'hashref' => { 'dest' => $email },
8967 map $_->cust_svc->cust_pkg,
8969 'table' => 'svc_acct',
8970 'hashref' => { 'username' => $user, },
8972 'AND ( SELECT domain FROM svc_domain
8973 WHERE svc_acct.domsvc = svc_domain.svcnum
8974 ) = '. dbh->quote($domain),
8980 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8982 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8989 =item check_and_rebuild_fuzzyfiles
8993 sub check_and_rebuild_fuzzyfiles {
8994 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8995 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8998 =item rebuild_fuzzyfiles
9002 sub rebuild_fuzzyfiles {
9004 use Fcntl qw(:flock);
9006 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9007 mkdir $dir, 0700 unless -d $dir;
9009 foreach my $fuzzy ( @fuzzyfields ) {
9011 open(LOCK,">>$dir/cust_main.$fuzzy")
9012 or die "can't open $dir/cust_main.$fuzzy: $!";
9014 or die "can't lock $dir/cust_main.$fuzzy: $!";
9016 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9017 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9019 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9020 my $sth = dbh->prepare("SELECT $field FROM cust_main".
9021 " WHERE $field != '' AND $field IS NOT NULL");
9022 $sth->execute or die $sth->errstr;
9024 while ( my $row = $sth->fetchrow_arrayref ) {
9025 print CACHE $row->[0]. "\n";
9030 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9032 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9043 my( $self, $field ) = @_;
9044 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9045 open(CACHE,"<$dir/cust_main.$field")
9046 or die "can't open $dir/cust_main.$field: $!";
9047 my @array = map { chomp; $_; } <CACHE>;
9052 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9056 sub append_fuzzyfiles {
9057 #my( $first, $last, $company ) = @_;
9059 &check_and_rebuild_fuzzyfiles;
9061 use Fcntl qw(:flock);
9063 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9065 foreach my $field (@fuzzyfields) {
9070 open(CACHE,">>$dir/cust_main.$field")
9071 or die "can't open $dir/cust_main.$field: $!";
9072 flock(CACHE,LOCK_EX)
9073 or die "can't lock $dir/cust_main.$field: $!";
9075 print CACHE "$value\n";
9077 flock(CACHE,LOCK_UN)
9078 or die "can't unlock $dir/cust_main.$field: $!";
9093 #warn join('-',keys %$param);
9094 my $fh = $param->{filehandle};
9095 my @fields = @{$param->{fields}};
9097 eval "use Text::CSV_XS;";
9100 my $csv = new Text::CSV_XS;
9107 local $SIG{HUP} = 'IGNORE';
9108 local $SIG{INT} = 'IGNORE';
9109 local $SIG{QUIT} = 'IGNORE';
9110 local $SIG{TERM} = 'IGNORE';
9111 local $SIG{TSTP} = 'IGNORE';
9112 local $SIG{PIPE} = 'IGNORE';
9114 my $oldAutoCommit = $FS::UID::AutoCommit;
9115 local $FS::UID::AutoCommit = 0;
9118 #while ( $columns = $csv->getline($fh) ) {
9120 while ( defined($line=<$fh>) ) {
9122 $csv->parse($line) or do {
9123 $dbh->rollback if $oldAutoCommit;
9124 return "can't parse: ". $csv->error_input();
9127 my @columns = $csv->fields();
9128 #warn join('-',@columns);
9131 foreach my $field ( @fields ) {
9132 $row{$field} = shift @columns;
9135 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9136 unless ( $cust_main ) {
9137 $dbh->rollback if $oldAutoCommit;
9138 return "unknown custnum $row{'custnum'}";
9141 if ( $row{'amount'} > 0 ) {
9142 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9144 $dbh->rollback if $oldAutoCommit;
9148 } elsif ( $row{'amount'} < 0 ) {
9149 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9152 $dbh->rollback if $oldAutoCommit;
9162 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9164 return "Empty file!" unless $imported;
9170 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9172 Sends a templated email notification to the customer (see L<Text::Template>).
9174 OPTIONS is a hash and may include
9176 I<from> - the email sender (default is invoice_from)
9178 I<to> - comma-separated scalar or arrayref of recipients
9179 (default is invoicing_list)
9181 I<subject> - The subject line of the sent email notification
9182 (default is "Notice from company_name")
9184 I<extra_fields> - a hashref of name/value pairs which will be substituted
9187 The following variables are vavailable in the template.
9189 I<$first> - the customer first name
9190 I<$last> - the customer last name
9191 I<$company> - the customer company
9192 I<$payby> - a description of the method of payment for the customer
9193 # would be nice to use FS::payby::shortname
9194 I<$payinfo> - the account information used to collect for this customer
9195 I<$expdate> - the expiration of the customer payment in seconds from epoch
9200 my ($self, $template, %options) = @_;
9202 return unless $conf->exists($template);
9204 my $from = $conf->config('invoice_from', $self->agentnum)
9205 if $conf->exists('invoice_from', $self->agentnum);
9206 $from = $options{from} if exists($options{from});
9208 my $to = join(',', $self->invoicing_list_emailonly);
9209 $to = $options{to} if exists($options{to});
9211 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9212 if $conf->exists('company_name', $self->agentnum);
9213 $subject = $options{subject} if exists($options{subject});
9215 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9216 SOURCE => [ map "$_\n",
9217 $conf->config($template)]
9219 or die "can't create new Text::Template object: Text::Template::ERROR";
9220 $notify_template->compile()
9221 or die "can't compile template: Text::Template::ERROR";
9223 $FS::notify_template::_template::company_name =
9224 $conf->config('company_name', $self->agentnum);
9225 $FS::notify_template::_template::company_address =
9226 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9228 my $paydate = $self->paydate || '2037-12-31';
9229 $FS::notify_template::_template::first = $self->first;
9230 $FS::notify_template::_template::last = $self->last;
9231 $FS::notify_template::_template::company = $self->company;
9232 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9233 my $payby = $self->payby;
9234 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9235 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9237 #credit cards expire at the end of the month/year of their exp date
9238 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9239 $FS::notify_template::_template::payby = 'credit card';
9240 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9241 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9243 }elsif ($payby eq 'COMP') {
9244 $FS::notify_template::_template::payby = 'complimentary account';
9246 $FS::notify_template::_template::payby = 'current method';
9248 $FS::notify_template::_template::expdate = $expire_time;
9250 for (keys %{$options{extra_fields}}){
9252 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9255 send_email(from => $from,
9257 subject => $subject,
9258 body => $notify_template->fill_in( PACKAGE =>
9259 'FS::notify_template::_template' ),
9264 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9266 Generates a templated notification to the customer (see L<Text::Template>).
9268 OPTIONS is a hash and may include
9270 I<extra_fields> - a hashref of name/value pairs which will be substituted
9271 into the template. These values may override values mentioned below
9272 and those from the customer record.
9274 The following variables are available in the template instead of or in addition
9275 to the fields of the customer record.
9277 I<$payby> - a description of the method of payment for the customer
9278 # would be nice to use FS::payby::shortname
9279 I<$payinfo> - the masked account information used to collect for this customer
9280 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9281 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9285 sub generate_letter {
9286 my ($self, $template, %options) = @_;
9288 return unless $conf->exists($template);
9290 my $letter_template = new Text::Template
9292 SOURCE => [ map "$_\n", $conf->config($template)],
9293 DELIMITERS => [ '[@--', '--@]' ],
9295 or die "can't create new Text::Template object: Text::Template::ERROR";
9297 $letter_template->compile()
9298 or die "can't compile template: Text::Template::ERROR";
9300 my %letter_data = map { $_ => $self->$_ } $self->fields;
9301 $letter_data{payinfo} = $self->mask_payinfo;
9303 #my $paydate = $self->paydate || '2037-12-31';
9304 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9306 my $payby = $self->payby;
9307 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9308 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9310 #credit cards expire at the end of the month/year of their exp date
9311 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9312 $letter_data{payby} = 'credit card';
9313 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9314 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9316 }elsif ($payby eq 'COMP') {
9317 $letter_data{payby} = 'complimentary account';
9319 $letter_data{payby} = 'current method';
9321 $letter_data{expdate} = $expire_time;
9323 for (keys %{$options{extra_fields}}){
9324 $letter_data{$_} = $options{extra_fields}->{$_};
9327 unless(exists($letter_data{returnaddress})){
9328 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9329 $self->agent_template)
9331 if ( length($retadd) ) {
9332 $letter_data{returnaddress} = $retadd;
9333 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9334 $letter_data{returnaddress} =
9335 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9336 $conf->config('company_address', $self->agentnum)
9339 $letter_data{returnaddress} = '~';
9343 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9345 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9347 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9348 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9352 ) or die "can't open temp file: $!\n";
9354 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9356 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9360 =item print_ps TEMPLATE
9362 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9368 my $file = $self->generate_letter(@_);
9369 FS::Misc::generate_ps($file);
9372 =item print TEMPLATE
9374 Prints the filled in template.
9376 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9380 sub queueable_print {
9383 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9384 or die "invalid customer number: " . $opt{custvnum};
9386 my $error = $self->print( $opt{template} );
9387 die $error if $error;
9391 my ($self, $template) = (shift, shift);
9392 do_print [ $self->print_ps($template) ];
9395 #these three subs should just go away once agent stuff is all config overrides
9397 sub agent_template {
9399 $self->_agent_plandata('agent_templatename');
9402 sub agent_invoice_from {
9404 $self->_agent_plandata('agent_invoice_from');
9407 sub _agent_plandata {
9408 my( $self, $option ) = @_;
9410 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9411 #agent-specific Conf
9413 use FS::part_event::Condition;
9415 my $agentnum = $self->agentnum;
9418 if ( driver_name =~ /^Pg/i ) {
9420 } elsif ( driver_name =~ /^mysql/i ) {
9423 die "don't know how to use regular expressions in ". driver_name. " databases";
9426 my $part_event_option =
9428 'select' => 'part_event_option.*',
9429 'table' => 'part_event_option',
9431 LEFT JOIN part_event USING ( eventpart )
9432 LEFT JOIN part_event_option AS peo_agentnum
9433 ON ( part_event.eventpart = peo_agentnum.eventpart
9434 AND peo_agentnum.optionname = 'agentnum'
9435 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9437 LEFT JOIN part_event_condition
9438 ON ( part_event.eventpart = part_event_condition.eventpart
9439 AND part_event_condition.conditionname = 'cust_bill_age'
9441 LEFT JOIN part_event_condition_option
9442 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9443 AND part_event_condition_option.optionname = 'age'
9446 #'hashref' => { 'optionname' => $option },
9447 #'hashref' => { 'part_event_option.optionname' => $option },
9449 " WHERE part_event_option.optionname = ". dbh->quote($option).
9450 " AND action = 'cust_bill_send_agent' ".
9451 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9452 " AND peo_agentnum.optionname = 'agentnum' ".
9453 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9455 CASE WHEN part_event_condition_option.optionname IS NULL
9457 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9459 , part_event.weight".
9463 unless ( $part_event_option ) {
9464 return $self->agent->invoice_template || ''
9465 if $option eq 'agent_templatename';
9469 $part_event_option->optionvalue;
9474 ## actual sub, not a method, designed to be called from the queue.
9475 ## sets up the customer, and calls the bill_and_collect
9476 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9477 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9478 $cust_main->bill_and_collect(
9483 sub _upgrade_data { #class method
9484 my ($class, %opts) = @_;
9486 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9487 my $sth = dbh->prepare($sql) or die dbh->errstr;
9488 $sth->execute or die $sth->errstr;
9498 The delete method should possibly take an FS::cust_main object reference
9499 instead of a scalar customer number.
9501 Bill and collect options should probably be passed as references instead of a
9504 There should probably be a configuration file with a list of allowed credit
9507 No multiple currency support (probably a larger project than just this module).
9509 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9511 Birthdates rely on negative epoch values.
9513 The payby for card/check batches is broken. With mixed batching, bad
9516 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9520 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9521 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9522 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.