5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Scalar::Util qw( blessed );
12 use List::Util qw( min );
13 use Time::Local qw(timelocal);
16 use Digest::MD5 qw(md5_base64);
19 use File::Temp qw( tempfile );
20 use String::Approx qw(amatch);
21 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh driver_name );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( generate_email send_email generate_ps do_print );
26 use FS::Msgcat qw(gettext);
31 use FS::cust_bill_pkg;
32 use FS::cust_bill_pkg_display;
33 use FS::cust_bill_pkg_tax_location;
34 use FS::cust_bill_pkg_tax_rate_location;
36 use FS::cust_pay_pending;
37 use FS::cust_pay_void;
38 use FS::cust_pay_batch;
41 use FS::part_referral;
42 use FS::cust_main_county;
43 use FS::cust_location;
44 use FS::cust_main_exemption;
45 use FS::cust_tax_adjustment;
47 use FS::tax_rate_location;
48 use FS::cust_tax_location;
49 use FS::part_pkg_taxrate;
51 use FS::cust_main_invoice;
52 use FS::cust_credit_bill;
53 use FS::cust_bill_pay;
54 use FS::prepay_credit;
58 use FS::part_event_condition;
61 use FS::payment_gateway;
62 use FS::agent_payment_gateway;
64 use FS::payinfo_Mixin;
67 @ISA = qw( FS::payinfo_Mixin FS::Record );
69 @EXPORT_OK = qw( smart_search );
71 $realtime_bop_decline_quiet = 0;
73 # 1 is mostly method/subroutine entry and options
74 # 2 traces progress of some operations
75 # 3 is even more information including possibly sensitive data
77 $me = '[FS::cust_main]';
81 $ignore_expired_card = 0;
83 @encrypted_fields = ('payinfo', 'paycvv');
84 sub nohistory_fields { ('paycvv'); }
86 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
88 #ask FS::UID to run this stuff for us later
89 #$FS::UID::callback{'FS::cust_main'} = sub {
90 install_callback FS::UID sub {
92 #yes, need it for stuff below (prolly should be cached)
97 my ( $hashref, $cache ) = @_;
98 if ( exists $hashref->{'pkgnum'} ) {
99 #@{ $self->{'_pkgnum'} } = ();
100 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
101 $self->{'_pkgnum'} = $subcache;
102 #push @{ $self->{'_pkgnum'} },
103 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
109 FS::cust_main - Object methods for cust_main records
115 $record = new FS::cust_main \%hash;
116 $record = new FS::cust_main { 'column' => 'value' };
118 $error = $record->insert;
120 $error = $new_record->replace($old_record);
122 $error = $record->delete;
124 $error = $record->check;
126 @cust_pkg = $record->all_pkgs;
128 @cust_pkg = $record->ncancelled_pkgs;
130 @cust_pkg = $record->suspended_pkgs;
132 $error = $record->bill;
133 $error = $record->bill %options;
134 $error = $record->bill 'time' => $time;
136 $error = $record->collect;
137 $error = $record->collect %options;
138 $error = $record->collect 'invoice_time' => $time,
143 An FS::cust_main object represents a customer. FS::cust_main inherits from
144 FS::Record. The following fields are currently supported:
150 Primary key (assigned automatically for new customers)
154 Agent (see L<FS::agent>)
158 Advertising source (see L<FS::part_referral>)
170 Cocial security number (optional)
186 (optional, see L<FS::cust_main_county>)
190 (see L<FS::cust_main_county>)
196 (see L<FS::cust_main_county>)
232 (optional, see L<FS::cust_main_county>)
236 (see L<FS::cust_main_county>)
242 (see L<FS::cust_main_county>)
258 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
262 Payment Information (See L<FS::payinfo_Mixin> for data format)
266 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
270 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
274 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
278 Start date month (maestro/solo cards only)
282 Start date year (maestro/solo cards only)
286 Issue number (maestro/solo cards only)
290 Name on card or billing name
294 IP address from which payment information was received
298 Tax exempt, empty or `Y'
302 Order taker (assigned automatically, see L<FS::UID>)
308 =item referral_custnum
310 Referring customer number
314 Enable individual CDR spooling, empty or `Y'
318 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
322 Discourage individual CDR printing, empty or `Y'
332 Creates a new customer. To add the customer to the database, see L<"insert">.
334 Note that this stores the hash reference, not a distinct copy of the hash it
335 points to. You can ask the object for a copy with the I<hash> method.
339 sub table { 'cust_main'; }
341 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
343 Adds this customer to the database. If there is an error, returns the error,
344 otherwise returns false.
346 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
347 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
348 are inserted atomicly, or the transaction is rolled back. Passing an empty
349 hash reference is equivalent to not supplying this parameter. There should be
350 a better explanation of this, but until then, here's an example:
353 tie %hash, 'Tie::RefHash'; #this part is important
355 $cust_pkg => [ $svc_acct ],
358 $cust_main->insert( \%hash );
360 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
361 be set as the invoicing list (see L<"invoicing_list">). Errors return as
362 expected and rollback the entire transaction; it is not necessary to call
363 check_invoicing_list first. The invoicing_list is set after the records in the
364 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
365 invoicing_list destination to the newly-created svc_acct. Here's an example:
367 $cust_main->insert( {}, [ $email, 'POST' ] );
369 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
371 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
372 on the supplied jobnum (they will not run until the specific job completes).
373 This can be used to defer provisioning until some action completes (such
374 as running the customer's credit card successfully).
376 The I<noexport> option is deprecated. If I<noexport> is set true, no
377 provisioning jobs (exports) are scheduled. (You can schedule them later with
378 the B<reexport> method.)
380 The I<tax_exemption> option can be set to an arrayref of tax names.
381 FS::cust_main_exemption records will be created and inserted.
387 my $cust_pkgs = @_ ? shift : {};
388 my $invoicing_list = @_ ? shift : '';
390 warn "$me insert called with options ".
391 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
394 local $SIG{HUP} = 'IGNORE';
395 local $SIG{INT} = 'IGNORE';
396 local $SIG{QUIT} = 'IGNORE';
397 local $SIG{TERM} = 'IGNORE';
398 local $SIG{TSTP} = 'IGNORE';
399 local $SIG{PIPE} = 'IGNORE';
401 my $oldAutoCommit = $FS::UID::AutoCommit;
402 local $FS::UID::AutoCommit = 0;
405 my $prepay_identifier = '';
406 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
408 if ( $self->payby eq 'PREPAY' ) {
410 $self->payby('BILL');
411 $prepay_identifier = $self->payinfo;
414 warn " looking up prepaid card $prepay_identifier\n"
417 my $error = $self->get_prepay( $prepay_identifier,
418 'amount_ref' => \$amount,
419 'seconds_ref' => \$seconds,
420 'upbytes_ref' => \$upbytes,
421 'downbytes_ref' => \$downbytes,
422 'totalbytes_ref' => \$totalbytes,
425 $dbh->rollback if $oldAutoCommit;
426 #return "error applying prepaid card (transaction rolled back): $error";
430 $payby = 'PREP' if $amount;
432 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
435 $self->payby('BILL');
436 $amount = $self->paid;
440 warn " inserting $self\n"
443 $self->signupdate(time) unless $self->signupdate;
445 $self->auto_agent_custid()
446 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
448 my $error = $self->SUPER::insert;
450 $dbh->rollback if $oldAutoCommit;
451 #return "inserting cust_main record (transaction rolled back): $error";
455 warn " setting invoicing list\n"
458 if ( $invoicing_list ) {
459 $error = $self->check_invoicing_list( $invoicing_list );
461 $dbh->rollback if $oldAutoCommit;
462 #return "checking invoicing_list (transaction rolled back): $error";
465 $self->invoicing_list( $invoicing_list );
468 warn " setting cust_main_exemption\n"
471 my $tax_exemption = delete $options{'tax_exemption'};
472 if ( $tax_exemption ) {
473 foreach my $taxname ( @$tax_exemption ) {
474 my $cust_main_exemption = new FS::cust_main_exemption {
475 'custnum' => $self->custnum,
476 'taxname' => $taxname,
478 my $error = $cust_main_exemption->insert;
480 $dbh->rollback if $oldAutoCommit;
481 return "inserting cust_main_exemption (transaction rolled back): $error";
486 if ( $conf->config('cust_main-skeleton_tables')
487 && $conf->config('cust_main-skeleton_custnum') ) {
489 warn " inserting skeleton records\n"
492 my $error = $self->start_copy_skel;
494 $dbh->rollback if $oldAutoCommit;
500 warn " ordering packages\n"
503 $error = $self->order_pkgs( $cust_pkgs,
505 'seconds_ref' => \$seconds,
506 'upbytes_ref' => \$upbytes,
507 'downbytes_ref' => \$downbytes,
508 'totalbytes_ref' => \$totalbytes,
511 $dbh->rollback if $oldAutoCommit;
516 $dbh->rollback if $oldAutoCommit;
517 return "No svc_acct record to apply pre-paid time";
519 if ( $upbytes || $downbytes || $totalbytes ) {
520 $dbh->rollback if $oldAutoCommit;
521 return "No svc_acct record to apply pre-paid data";
525 warn " inserting initial $payby payment of $amount\n"
527 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
529 $dbh->rollback if $oldAutoCommit;
530 return "inserting payment (transaction rolled back): $error";
534 unless ( $import || $skip_fuzzyfiles ) {
535 warn " queueing fuzzyfiles update\n"
537 $error = $self->queue_fuzzyfiles_update;
539 $dbh->rollback if $oldAutoCommit;
540 return "updating fuzzy search cache: $error";
544 warn " insert complete; committing transaction\n"
547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
552 use File::CounterFile;
553 sub auto_agent_custid {
556 my $format = $conf->config('cust_main-auto_agent_custid');
558 if ( $format eq '1YMMXXXXXXXX' ) {
560 my $counter = new File::CounterFile 'cust_main.agent_custid';
563 my $ym = 100000000000 + time2str('%y%m00000000', time);
564 if ( $ym > $counter->value ) {
565 $counter->{'value'} = $agent_custid = $ym;
566 $counter->{'updated'} = 1;
568 $agent_custid = $counter->inc;
574 die "Unknown cust_main-auto_agent_custid format: $format";
577 $self->agent_custid($agent_custid);
581 sub start_copy_skel {
584 #'mg_user_preference' => {},
585 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
586 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
587 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
588 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
589 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
592 _copy_skel( 'cust_main', #tablename
593 $conf->config('cust_main-skeleton_custnum'), #sourceid
594 $self->custnum, #destid
595 @tables, #child tables
599 #recursive subroutine, not a method
601 my( $table, $sourceid, $destid, %child_tables ) = @_;
604 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
605 ( $table, $primary_key ) = ( $1, $2 );
607 my $dbdef_table = dbdef->table($table);
608 $primary_key = $dbdef_table->primary_key
609 or return "$table has no primary key".
610 " (or do you need to run dbdef-create?)";
613 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
614 join (', ', keys %child_tables). "\n"
617 foreach my $child_table_def ( keys %child_tables ) {
621 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
622 ( $child_table, $child_pkey ) = ( $1, $2 );
624 $child_table = $child_table_def;
626 $child_pkey = dbdef->table($child_table)->primary_key;
627 # or return "$table has no primary key".
628 # " (or do you need to run dbdef-create?)\n";
632 if ( keys %{ $child_tables{$child_table_def} } ) {
634 return "$child_table has no primary key".
635 " (run dbdef-create or try specifying it?)\n"
638 #false laziness w/Record::insert and only works on Pg
639 #refactor the proper last-inserted-id stuff out of Record::insert if this
640 # ever gets use for anything besides a quick kludge for one customer
641 my $default = dbdef->table($child_table)->column($child_pkey)->default;
642 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
643 or return "can't parse $child_table.$child_pkey default value ".
644 " for sequence name: $default";
649 my @sel_columns = grep { $_ ne $primary_key }
650 dbdef->table($child_table)->columns;
651 my $sel_columns = join(', ', @sel_columns );
653 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
654 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
655 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
657 my $sel_st = "SELECT $sel_columns FROM $child_table".
658 " WHERE $primary_key = $sourceid";
661 my $sel_sth = dbh->prepare( $sel_st )
662 or return dbh->errstr;
664 $sel_sth->execute or return $sel_sth->errstr;
666 while ( my $row = $sel_sth->fetchrow_hashref ) {
668 warn " selected row: ".
669 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
673 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
674 my $ins_sth =dbh->prepare($statement)
675 or return dbh->errstr;
676 my @param = ( $destid, map $row->{$_}, @ins_columns );
677 warn " $statement: [ ". join(', ', @param). " ]\n"
679 $ins_sth->execute( @param )
680 or return $ins_sth->errstr;
682 #next unless keys %{ $child_tables{$child_table} };
683 next unless $sequence;
685 #another section of that laziness
686 my $seq_sql = "SELECT currval('$sequence')";
687 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
688 $seq_sth->execute or return $seq_sth->errstr;
689 my $insertid = $seq_sth->fetchrow_arrayref->[0];
691 # don't drink soap! recurse! recurse! okay!
693 _copy_skel( $child_table_def,
694 $row->{$child_pkey}, #sourceid
696 %{ $child_tables{$child_table_def} },
698 return $error if $error;
708 =item order_pkg HASHREF | OPTION => VALUE ...
710 Orders a single package.
712 Options may be passed as a list of key/value pairs or as a hash reference.
723 Optional FS::cust_location object
727 Optional arryaref of FS::svc_* service objects.
731 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
732 jobs will have a dependancy on the supplied job (they will not run until the
733 specific job completes). This can be used to defer provisioning until some
734 action completes (such as running the customer's credit card successfully).
738 Optional subject for a ticket created and attached to this customer
742 Optional queue name for ticket additions
750 my $opt = ref($_[0]) ? shift : { @_ };
752 warn "$me order_pkg called with options ".
753 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
756 my $cust_pkg = $opt->{'cust_pkg'};
757 my $svcs = $opt->{'svcs'} || [];
759 my %svc_options = ();
760 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
761 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
763 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
764 qw( ticket_subject ticket_queue );
766 local $SIG{HUP} = 'IGNORE';
767 local $SIG{INT} = 'IGNORE';
768 local $SIG{QUIT} = 'IGNORE';
769 local $SIG{TERM} = 'IGNORE';
770 local $SIG{TSTP} = 'IGNORE';
771 local $SIG{PIPE} = 'IGNORE';
773 my $oldAutoCommit = $FS::UID::AutoCommit;
774 local $FS::UID::AutoCommit = 0;
777 if ( $opt->{'cust_location'} &&
778 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
779 my $error = $opt->{'cust_location'}->insert;
781 $dbh->rollback if $oldAutoCommit;
782 return "inserting cust_location (transaction rolled back): $error";
784 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
787 $cust_pkg->custnum( $self->custnum );
789 my $error = $cust_pkg->insert( %insert_params );
791 $dbh->rollback if $oldAutoCommit;
792 return "inserting cust_pkg (transaction rolled back): $error";
795 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
796 if ( $svc_something->svcnum ) {
797 my $old_cust_svc = $svc_something->cust_svc;
798 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
799 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
800 $error = $new_cust_svc->replace($old_cust_svc);
802 $svc_something->pkgnum( $cust_pkg->pkgnum );
803 if ( $svc_something->isa('FS::svc_acct') ) {
804 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
805 qw( seconds upbytes downbytes totalbytes ) ) {
806 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
807 ${ $opt->{$_.'_ref'} } = 0;
810 $error = $svc_something->insert(%svc_options);
813 $dbh->rollback if $oldAutoCommit;
814 return "inserting svc_ (transaction rolled back): $error";
818 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
823 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
824 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
826 Like the insert method on an existing record, this method orders multiple
827 packages and included services atomicaly. Pass a Tie::RefHash data structure
828 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
829 There should be a better explanation of this, but until then, here's an
833 tie %hash, 'Tie::RefHash'; #this part is important
835 $cust_pkg => [ $svc_acct ],
838 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
840 Services can be new, in which case they are inserted, or existing unaudited
841 services, in which case they are linked to the newly-created package.
843 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
844 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
846 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
847 on the supplied jobnum (they will not run until the specific job completes).
848 This can be used to defer provisioning until some action completes (such
849 as running the customer's credit card successfully).
851 The I<noexport> option is deprecated. If I<noexport> is set true, no
852 provisioning jobs (exports) are scheduled. (You can schedule them later with
853 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
854 on the cust_main object is not recommended, as existing services will also be
857 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
858 provided, the scalars (provided by references) will be incremented by the
859 values of the prepaid card.`
865 my $cust_pkgs = shift;
866 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
868 $seconds_ref ||= $options{'seconds_ref'};
870 warn "$me order_pkgs called with options ".
871 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
874 local $SIG{HUP} = 'IGNORE';
875 local $SIG{INT} = 'IGNORE';
876 local $SIG{QUIT} = 'IGNORE';
877 local $SIG{TERM} = 'IGNORE';
878 local $SIG{TSTP} = 'IGNORE';
879 local $SIG{PIPE} = 'IGNORE';
881 my $oldAutoCommit = $FS::UID::AutoCommit;
882 local $FS::UID::AutoCommit = 0;
885 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
887 foreach my $cust_pkg ( keys %$cust_pkgs ) {
889 my $error = $self->order_pkg(
890 'cust_pkg' => $cust_pkg,
891 'svcs' => $cust_pkgs->{$cust_pkg},
892 'seconds_ref' => $seconds_ref,
893 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
898 $dbh->rollback if $oldAutoCommit;
904 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
908 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
910 Recharges this (existing) customer with the specified prepaid card (see
911 L<FS::prepay_credit>), specified either by I<identifier> or as an
912 FS::prepay_credit object. If there is an error, returns the error, otherwise
915 Optionally, five scalar references can be passed as well. They will have their
916 values filled in with the amount, number of seconds, and number of upload,
917 download, and total bytes applied by this prepaid card.
921 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
922 #the only place that uses these args
923 sub recharge_prepay {
924 my( $self, $prepay_credit, $amountref, $secondsref,
925 $upbytesref, $downbytesref, $totalbytesref ) = @_;
927 local $SIG{HUP} = 'IGNORE';
928 local $SIG{INT} = 'IGNORE';
929 local $SIG{QUIT} = 'IGNORE';
930 local $SIG{TERM} = 'IGNORE';
931 local $SIG{TSTP} = 'IGNORE';
932 local $SIG{PIPE} = 'IGNORE';
934 my $oldAutoCommit = $FS::UID::AutoCommit;
935 local $FS::UID::AutoCommit = 0;
938 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
940 my $error = $self->get_prepay( $prepay_credit,
941 'amount_ref' => \$amount,
942 'seconds_ref' => \$seconds,
943 'upbytes_ref' => \$upbytes,
944 'downbytes_ref' => \$downbytes,
945 'totalbytes_ref' => \$totalbytes,
947 || $self->increment_seconds($seconds)
948 || $self->increment_upbytes($upbytes)
949 || $self->increment_downbytes($downbytes)
950 || $self->increment_totalbytes($totalbytes)
951 || $self->insert_cust_pay_prepay( $amount,
953 ? $prepay_credit->identifier
958 $dbh->rollback if $oldAutoCommit;
962 if ( defined($amountref) ) { $$amountref = $amount; }
963 if ( defined($secondsref) ) { $$secondsref = $seconds; }
964 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
965 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
966 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
968 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
973 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
975 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
976 specified either by I<identifier> or as an FS::prepay_credit object.
978 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
979 incremented by the values of the prepaid card.
981 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
982 check or set this customer's I<agentnum>.
984 If there is an error, returns the error, otherwise returns false.
990 my( $self, $prepay_credit, %opt ) = @_;
992 local $SIG{HUP} = 'IGNORE';
993 local $SIG{INT} = 'IGNORE';
994 local $SIG{QUIT} = 'IGNORE';
995 local $SIG{TERM} = 'IGNORE';
996 local $SIG{TSTP} = 'IGNORE';
997 local $SIG{PIPE} = 'IGNORE';
999 my $oldAutoCommit = $FS::UID::AutoCommit;
1000 local $FS::UID::AutoCommit = 0;
1003 unless ( ref($prepay_credit) ) {
1005 my $identifier = $prepay_credit;
1007 $prepay_credit = qsearchs(
1009 { 'identifier' => $prepay_credit },
1014 unless ( $prepay_credit ) {
1015 $dbh->rollback if $oldAutoCommit;
1016 return "Invalid prepaid card: ". $identifier;
1021 if ( $prepay_credit->agentnum ) {
1022 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1023 $dbh->rollback if $oldAutoCommit;
1024 return "prepaid card not valid for agent ". $self->agentnum;
1026 $self->agentnum($prepay_credit->agentnum);
1029 my $error = $prepay_credit->delete;
1031 $dbh->rollback if $oldAutoCommit;
1032 return "removing prepay_credit (transaction rolled back): $error";
1035 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1036 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1038 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1043 =item increment_upbytes SECONDS
1045 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1046 the specified number of upbytes. If there is an error, returns the error,
1047 otherwise returns false.
1051 sub increment_upbytes {
1052 _increment_column( shift, 'upbytes', @_);
1055 =item increment_downbytes SECONDS
1057 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1058 the specified number of downbytes. If there is an error, returns the error,
1059 otherwise returns false.
1063 sub increment_downbytes {
1064 _increment_column( shift, 'downbytes', @_);
1067 =item increment_totalbytes SECONDS
1069 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1070 the specified number of totalbytes. If there is an error, returns the error,
1071 otherwise returns false.
1075 sub increment_totalbytes {
1076 _increment_column( shift, 'totalbytes', @_);
1079 =item increment_seconds SECONDS
1081 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1082 the specified number of seconds. If there is an error, returns the error,
1083 otherwise returns false.
1087 sub increment_seconds {
1088 _increment_column( shift, 'seconds', @_);
1091 =item _increment_column AMOUNT
1093 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1094 the specified number of seconds or bytes. If there is an error, returns
1095 the error, otherwise returns false.
1099 sub _increment_column {
1100 my( $self, $column, $amount ) = @_;
1101 warn "$me increment_column called: $column, $amount\n"
1104 return '' unless $amount;
1106 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1107 $self->ncancelled_pkgs;
1109 if ( ! @cust_pkg ) {
1110 return 'No packages with primary or single services found'.
1111 ' to apply pre-paid time';
1112 } elsif ( scalar(@cust_pkg) > 1 ) {
1113 #maybe have a way to specify the package/account?
1114 return 'Multiple packages found to apply pre-paid time';
1117 my $cust_pkg = $cust_pkg[0];
1118 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1122 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1124 if ( ! @cust_svc ) {
1125 return 'No account found to apply pre-paid time';
1126 } elsif ( scalar(@cust_svc) > 1 ) {
1127 return 'Multiple accounts found to apply pre-paid time';
1130 my $svc_acct = $cust_svc[0]->svc_x;
1131 warn " found service svcnum ". $svc_acct->pkgnum.
1132 ' ('. $svc_acct->email. ")\n"
1135 $column = "increment_$column";
1136 $svc_acct->$column($amount);
1140 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1142 Inserts a prepayment in the specified amount for this customer. An optional
1143 second argument can specify the prepayment identifier for tracking purposes.
1144 If there is an error, returns the error, otherwise returns false.
1148 sub insert_cust_pay_prepay {
1149 shift->insert_cust_pay('PREP', @_);
1152 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1154 Inserts a cash payment in the specified amount for this customer. An optional
1155 second argument can specify the payment identifier for tracking purposes.
1156 If there is an error, returns the error, otherwise returns false.
1160 sub insert_cust_pay_cash {
1161 shift->insert_cust_pay('CASH', @_);
1164 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1166 Inserts a Western Union payment in the specified amount for this customer. An
1167 optional second argument can specify the prepayment identifier for tracking
1168 purposes. If there is an error, returns the error, otherwise returns false.
1172 sub insert_cust_pay_west {
1173 shift->insert_cust_pay('WEST', @_);
1176 sub insert_cust_pay {
1177 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1178 my $payinfo = scalar(@_) ? shift : '';
1180 my $cust_pay = new FS::cust_pay {
1181 'custnum' => $self->custnum,
1182 'paid' => sprintf('%.2f', $amount),
1183 #'_date' => #date the prepaid card was purchased???
1185 'payinfo' => $payinfo,
1193 This method is deprecated. See the I<depend_jobnum> option to the insert and
1194 order_pkgs methods for a better way to defer provisioning.
1196 Re-schedules all exports by calling the B<reexport> method of all associated
1197 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1198 otherwise returns false.
1205 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1206 "use the depend_jobnum option to insert or order_pkgs to delay export";
1208 local $SIG{HUP} = 'IGNORE';
1209 local $SIG{INT} = 'IGNORE';
1210 local $SIG{QUIT} = 'IGNORE';
1211 local $SIG{TERM} = 'IGNORE';
1212 local $SIG{TSTP} = 'IGNORE';
1213 local $SIG{PIPE} = 'IGNORE';
1215 my $oldAutoCommit = $FS::UID::AutoCommit;
1216 local $FS::UID::AutoCommit = 0;
1219 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1220 my $error = $cust_pkg->reexport;
1222 $dbh->rollback if $oldAutoCommit;
1227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1232 =item delete NEW_CUSTNUM
1234 This deletes the customer. If there is an error, returns the error, otherwise
1237 This will completely remove all traces of the customer record. This is not
1238 what you want when a customer cancels service; for that, cancel all of the
1239 customer's packages (see L</cancel>).
1241 If the customer has any uncancelled packages, you need to pass a new (valid)
1242 customer number for those packages to be transferred to. Cancelled packages
1243 will be deleted. Did I mention that this is NOT what you want when a customer
1244 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1246 You can't delete a customer with invoices (see L<FS::cust_bill>),
1247 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1248 refunds (see L<FS::cust_refund>).
1255 local $SIG{HUP} = 'IGNORE';
1256 local $SIG{INT} = 'IGNORE';
1257 local $SIG{QUIT} = 'IGNORE';
1258 local $SIG{TERM} = 'IGNORE';
1259 local $SIG{TSTP} = 'IGNORE';
1260 local $SIG{PIPE} = 'IGNORE';
1262 my $oldAutoCommit = $FS::UID::AutoCommit;
1263 local $FS::UID::AutoCommit = 0;
1266 if ( $self->cust_bill ) {
1267 $dbh->rollback if $oldAutoCommit;
1268 return "Can't delete a customer with invoices";
1270 if ( $self->cust_credit ) {
1271 $dbh->rollback if $oldAutoCommit;
1272 return "Can't delete a customer with credits";
1274 if ( $self->cust_pay ) {
1275 $dbh->rollback if $oldAutoCommit;
1276 return "Can't delete a customer with payments";
1278 if ( $self->cust_refund ) {
1279 $dbh->rollback if $oldAutoCommit;
1280 return "Can't delete a customer with refunds";
1283 my @cust_pkg = $self->ncancelled_pkgs;
1285 my $new_custnum = shift;
1286 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1287 $dbh->rollback if $oldAutoCommit;
1288 return "Invalid new customer number: $new_custnum";
1290 foreach my $cust_pkg ( @cust_pkg ) {
1291 my %hash = $cust_pkg->hash;
1292 $hash{'custnum'} = $new_custnum;
1293 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1294 my $error = $new_cust_pkg->replace($cust_pkg,
1295 options => { $cust_pkg->options },
1298 $dbh->rollback if $oldAutoCommit;
1303 my @cancelled_cust_pkg = $self->all_pkgs;
1304 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1305 my $error = $cust_pkg->delete;
1307 $dbh->rollback if $oldAutoCommit;
1312 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1313 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1315 my $error = $cust_main_invoice->delete;
1317 $dbh->rollback if $oldAutoCommit;
1322 foreach my $cust_main_exemption (
1323 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1325 my $error = $cust_main_exemption->delete;
1327 $dbh->rollback if $oldAutoCommit;
1332 my $error = $self->SUPER::delete;
1334 $dbh->rollback if $oldAutoCommit;
1338 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1343 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1346 Replaces the OLD_RECORD with this one in the database. If there is an error,
1347 returns the error, otherwise returns false.
1349 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1350 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1351 expected and rollback the entire transaction; it is not necessary to call
1352 check_invoicing_list first. Here's an example:
1354 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1356 Currently available options are: I<tax_exemption>.
1358 The I<tax_exemption> option can be set to an arrayref of tax names.
1359 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1366 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1368 : $self->replace_old;
1372 warn "$me replace called\n"
1375 my $curuser = $FS::CurrentUser::CurrentUser;
1376 if ( $self->payby eq 'COMP'
1377 && $self->payby ne $old->payby
1378 && ! $curuser->access_right('Complimentary customer')
1381 return "You are not permitted to create complimentary accounts.";
1384 local($ignore_expired_card) = 1
1385 if $old->payby =~ /^(CARD|DCRD)$/
1386 && $self->payby =~ /^(CARD|DCRD)$/
1387 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1389 local $SIG{HUP} = 'IGNORE';
1390 local $SIG{INT} = 'IGNORE';
1391 local $SIG{QUIT} = 'IGNORE';
1392 local $SIG{TERM} = 'IGNORE';
1393 local $SIG{TSTP} = 'IGNORE';
1394 local $SIG{PIPE} = 'IGNORE';
1396 my $oldAutoCommit = $FS::UID::AutoCommit;
1397 local $FS::UID::AutoCommit = 0;
1400 my $error = $self->SUPER::replace($old);
1403 $dbh->rollback if $oldAutoCommit;
1407 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1408 my $invoicing_list = shift @param;
1409 $error = $self->check_invoicing_list( $invoicing_list );
1411 $dbh->rollback if $oldAutoCommit;
1414 $self->invoicing_list( $invoicing_list );
1417 my %options = @param;
1419 my $tax_exemption = delete $options{'tax_exemption'};
1420 if ( $tax_exemption ) {
1422 my %cust_main_exemption =
1423 map { $_->taxname => $_ }
1424 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1426 foreach my $taxname ( @$tax_exemption ) {
1428 next if delete $cust_main_exemption{$taxname};
1430 my $cust_main_exemption = new FS::cust_main_exemption {
1431 'custnum' => $self->custnum,
1432 'taxname' => $taxname,
1434 my $error = $cust_main_exemption->insert;
1436 $dbh->rollback if $oldAutoCommit;
1437 return "inserting cust_main_exemption (transaction rolled back): $error";
1441 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1442 my $error = $cust_main_exemption->delete;
1444 $dbh->rollback if $oldAutoCommit;
1445 return "deleting cust_main_exemption (transaction rolled back): $error";
1451 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1452 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1453 # card/check/lec info has changed, want to retry realtime_ invoice events
1454 my $error = $self->retry_realtime;
1456 $dbh->rollback if $oldAutoCommit;
1461 unless ( $import || $skip_fuzzyfiles ) {
1462 $error = $self->queue_fuzzyfiles_update;
1464 $dbh->rollback if $oldAutoCommit;
1465 return "updating fuzzy search cache: $error";
1469 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1474 =item queue_fuzzyfiles_update
1476 Used by insert & replace to update the fuzzy search cache
1480 sub queue_fuzzyfiles_update {
1483 local $SIG{HUP} = 'IGNORE';
1484 local $SIG{INT} = 'IGNORE';
1485 local $SIG{QUIT} = 'IGNORE';
1486 local $SIG{TERM} = 'IGNORE';
1487 local $SIG{TSTP} = 'IGNORE';
1488 local $SIG{PIPE} = 'IGNORE';
1490 my $oldAutoCommit = $FS::UID::AutoCommit;
1491 local $FS::UID::AutoCommit = 0;
1494 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1495 my $error = $queue->insert( map $self->getfield($_),
1496 qw(first last company)
1499 $dbh->rollback if $oldAutoCommit;
1500 return "queueing job (transaction rolled back): $error";
1503 if ( $self->ship_last ) {
1504 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1505 $error = $queue->insert( map $self->getfield("ship_$_"),
1506 qw(first last company)
1509 $dbh->rollback if $oldAutoCommit;
1510 return "queueing job (transaction rolled back): $error";
1514 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1521 Checks all fields to make sure this is a valid customer record. If there is
1522 an error, returns the error, otherwise returns false. Called by the insert
1523 and replace methods.
1530 warn "$me check BEFORE: \n". $self->_dump
1534 $self->ut_numbern('custnum')
1535 || $self->ut_number('agentnum')
1536 || $self->ut_textn('agent_custid')
1537 || $self->ut_number('refnum')
1538 || $self->ut_textn('custbatch')
1539 || $self->ut_name('last')
1540 || $self->ut_name('first')
1541 || $self->ut_snumbern('birthdate')
1542 || $self->ut_snumbern('signupdate')
1543 || $self->ut_textn('company')
1544 || $self->ut_text('address1')
1545 || $self->ut_textn('address2')
1546 || $self->ut_text('city')
1547 || $self->ut_textn('county')
1548 || $self->ut_textn('state')
1549 || $self->ut_country('country')
1550 || $self->ut_anything('comments')
1551 || $self->ut_numbern('referral_custnum')
1552 || $self->ut_textn('stateid')
1553 || $self->ut_textn('stateid_state')
1554 || $self->ut_textn('invoice_terms')
1555 || $self->ut_alphan('geocode')
1556 || $self->ut_floatn('cdr_termination_percentage')
1559 #barf. need message catalogs. i18n. etc.
1560 $error .= "Please select an advertising source."
1561 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1562 return $error if $error;
1564 return "Unknown agent"
1565 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1567 return "Unknown refnum"
1568 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1570 return "Unknown referring custnum: ". $self->referral_custnum
1571 unless ! $self->referral_custnum
1572 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1574 if ( $self->censustract ne '' ) {
1575 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1576 or return "Illegal census tract: ". $self->censustract;
1578 $self->censustract("$1.$2");
1581 if ( $self->ss eq '' ) {
1586 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1587 or return "Illegal social security number: ". $self->ss;
1588 $self->ss("$1-$2-$3");
1592 # bad idea to disable, causes billing to fail because of no tax rates later
1593 # unless ( $import ) {
1594 unless ( qsearch('cust_main_county', {
1595 'country' => $self->country,
1598 return "Unknown state/county/country: ".
1599 $self->state. "/". $self->county. "/". $self->country
1600 unless qsearch('cust_main_county',{
1601 'state' => $self->state,
1602 'county' => $self->county,
1603 'country' => $self->country,
1609 $self->ut_phonen('daytime', $self->country)
1610 || $self->ut_phonen('night', $self->country)
1611 || $self->ut_phonen('fax', $self->country)
1612 || $self->ut_zip('zip', $self->country)
1614 return $error if $error;
1616 if ( $conf->exists('cust_main-require_phone')
1617 && ! length($self->daytime) && ! length($self->night)
1620 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1622 : FS::Msgcat::_gettext('daytime');
1623 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1625 : FS::Msgcat::_gettext('night');
1627 return "$daytime_label or $night_label is required"
1631 if ( $self->has_ship_address
1632 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1633 $self->addr_fields )
1637 $self->ut_name('ship_last')
1638 || $self->ut_name('ship_first')
1639 || $self->ut_textn('ship_company')
1640 || $self->ut_text('ship_address1')
1641 || $self->ut_textn('ship_address2')
1642 || $self->ut_text('ship_city')
1643 || $self->ut_textn('ship_county')
1644 || $self->ut_textn('ship_state')
1645 || $self->ut_country('ship_country')
1647 return $error if $error;
1649 #false laziness with above
1650 unless ( qsearchs('cust_main_county', {
1651 'country' => $self->ship_country,
1654 return "Unknown ship_state/ship_county/ship_country: ".
1655 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1656 unless qsearch('cust_main_county',{
1657 'state' => $self->ship_state,
1658 'county' => $self->ship_county,
1659 'country' => $self->ship_country,
1665 $self->ut_phonen('ship_daytime', $self->ship_country)
1666 || $self->ut_phonen('ship_night', $self->ship_country)
1667 || $self->ut_phonen('ship_fax', $self->ship_country)
1668 || $self->ut_zip('ship_zip', $self->ship_country)
1670 return $error if $error;
1672 return "Unit # is required."
1673 if $self->ship_address2 =~ /^\s*$/
1674 && $conf->exists('cust_main-require_address2');
1676 } else { # ship_ info eq billing info, so don't store dup info in database
1678 $self->setfield("ship_$_", '')
1679 foreach $self->addr_fields;
1681 return "Unit # is required."
1682 if $self->address2 =~ /^\s*$/
1683 && $conf->exists('cust_main-require_address2');
1687 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1688 # or return "Illegal payby: ". $self->payby;
1690 FS::payby->can_payby($self->table, $self->payby)
1691 or return "Illegal payby: ". $self->payby;
1693 $error = $self->ut_numbern('paystart_month')
1694 || $self->ut_numbern('paystart_year')
1695 || $self->ut_numbern('payissue')
1696 || $self->ut_textn('paytype')
1698 return $error if $error;
1700 if ( $self->payip eq '' ) {
1703 $error = $self->ut_ip('payip');
1704 return $error if $error;
1707 # If it is encrypted and the private key is not availaible then we can't
1708 # check the credit card.
1710 my $check_payinfo = 1;
1712 if ($self->is_encrypted($self->payinfo)) {
1716 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1718 my $payinfo = $self->payinfo;
1719 $payinfo =~ s/\D//g;
1720 $payinfo =~ /^(\d{13,16})$/
1721 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1723 $self->payinfo($payinfo);
1725 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1727 return gettext('unknown_card_type')
1728 if cardtype($self->payinfo) eq "Unknown";
1730 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1732 return 'Banned credit card: banned on '.
1733 time2str('%a %h %o at %r', $ban->_date).
1734 ' by '. $ban->otaker.
1735 ' (ban# '. $ban->bannum. ')';
1738 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1739 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1740 $self->paycvv =~ /^(\d{4})$/
1741 or return "CVV2 (CID) for American Express cards is four digits.";
1744 $self->paycvv =~ /^(\d{3})$/
1745 or return "CVV2 (CVC2/CID) is three digits.";
1752 my $cardtype = cardtype($payinfo);
1753 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1755 return "Start date or issue number is required for $cardtype cards"
1756 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1758 return "Start month must be between 1 and 12"
1759 if $self->paystart_month
1760 and $self->paystart_month < 1 || $self->paystart_month > 12;
1762 return "Start year must be 1990 or later"
1763 if $self->paystart_year
1764 and $self->paystart_year < 1990;
1766 return "Issue number must be beween 1 and 99"
1768 and $self->payissue < 1 || $self->payissue > 99;
1771 $self->paystart_month('');
1772 $self->paystart_year('');
1773 $self->payissue('');
1776 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1778 my $payinfo = $self->payinfo;
1779 $payinfo =~ s/[^\d\@]//g;
1780 if ( $conf->exists('echeck-nonus') ) {
1781 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1782 $payinfo = "$1\@$2";
1784 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1785 $payinfo = "$1\@$2";
1787 $self->payinfo($payinfo);
1790 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1792 return 'Banned ACH account: banned on '.
1793 time2str('%a %h %o at %r', $ban->_date).
1794 ' by '. $ban->otaker.
1795 ' (ban# '. $ban->bannum. ')';
1798 } elsif ( $self->payby eq 'LECB' ) {
1800 my $payinfo = $self->payinfo;
1801 $payinfo =~ s/\D//g;
1802 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1804 $self->payinfo($payinfo);
1807 } elsif ( $self->payby eq 'BILL' ) {
1809 $error = $self->ut_textn('payinfo');
1810 return "Illegal P.O. number: ". $self->payinfo if $error;
1813 } elsif ( $self->payby eq 'COMP' ) {
1815 my $curuser = $FS::CurrentUser::CurrentUser;
1816 if ( ! $self->custnum
1817 && ! $curuser->access_right('Complimentary customer')
1820 return "You are not permitted to create complimentary accounts."
1823 $error = $self->ut_textn('payinfo');
1824 return "Illegal comp account issuer: ". $self->payinfo if $error;
1827 } elsif ( $self->payby eq 'PREPAY' ) {
1829 my $payinfo = $self->payinfo;
1830 $payinfo =~ s/\W//g; #anything else would just confuse things
1831 $self->payinfo($payinfo);
1832 $error = $self->ut_alpha('payinfo');
1833 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1834 return "Unknown prepayment identifier"
1835 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1840 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1841 return "Expiration date required"
1842 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1846 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1847 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1848 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1849 ( $m, $y ) = ( $2, "19$1" );
1850 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1851 ( $m, $y ) = ( $3, "20$2" );
1853 return "Illegal expiration date: ". $self->paydate;
1855 $self->paydate("$y-$m-01");
1856 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1857 return gettext('expired_card')
1859 && !$ignore_expired_card
1860 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1863 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1864 ( ! $conf->exists('require_cardname')
1865 || $self->payby !~ /^(CARD|DCRD)$/ )
1867 $self->payname( $self->first. " ". $self->getfield('last') );
1869 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1870 or return gettext('illegal_name'). " payname: ". $self->payname;
1874 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1875 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1879 $self->otaker(getotaker) unless $self->otaker;
1881 warn "$me check AFTER: \n". $self->_dump
1884 $self->SUPER::check;
1889 Returns a list of fields which have ship_ duplicates.
1894 qw( last first company
1895 address1 address2 city county state zip country
1900 =item has_ship_address
1902 Returns true if this customer record has a separate shipping address.
1906 sub has_ship_address {
1908 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1911 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1913 Returns all packages (see L<FS::cust_pkg>) for this customer.
1919 my $extra_qsearch = ref($_[0]) ? shift : {};
1921 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1924 if ( $self->{'_pkgnum'} ) {
1925 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1927 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1930 sort sort_packages @cust_pkg;
1935 Synonym for B<all_pkgs>.
1940 shift->all_pkgs(@_);
1945 Returns all locations (see L<FS::cust_location>) for this customer.
1951 qsearch('cust_location', { 'custnum' => $self->custnum } );
1954 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1956 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1960 sub ncancelled_pkgs {
1962 my $extra_qsearch = ref($_[0]) ? shift : {};
1964 return $self->num_ncancelled_pkgs unless wantarray;
1967 if ( $self->{'_pkgnum'} ) {
1969 warn "$me ncancelled_pkgs: returning cached objects"
1972 @cust_pkg = grep { ! $_->getfield('cancel') }
1973 values %{ $self->{'_pkgnum'}->cache };
1977 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1978 $self->custnum. "\n"
1981 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1983 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1987 sort sort_packages @cust_pkg;
1993 my $extra_qsearch = ref($_[0]) ? shift : {};
1995 $extra_qsearch->{'select'} ||= '*';
1996 $extra_qsearch->{'select'} .=
1997 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2001 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2006 'table' => 'cust_pkg',
2007 'hashref' => { 'custnum' => $self->custnum },
2012 # This should be generalized to use config options to determine order.
2015 if ( $a->get('cancel') xor $b->get('cancel') ) {
2016 return -1 if $b->get('cancel');
2017 return 1 if $a->get('cancel');
2018 #shouldn't get here...
2021 my $a_num_cust_svc = $a->num_cust_svc;
2022 my $b_num_cust_svc = $b->num_cust_svc;
2023 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2024 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2025 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2026 my @a_cust_svc = $a->cust_svc;
2027 my @b_cust_svc = $b->cust_svc;
2028 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2033 =item suspended_pkgs
2035 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2039 sub suspended_pkgs {
2041 grep { $_->susp } $self->ncancelled_pkgs;
2044 =item unflagged_suspended_pkgs
2046 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2047 customer (thouse packages without the `manual_flag' set).
2051 sub unflagged_suspended_pkgs {
2053 return $self->suspended_pkgs
2054 unless dbdef->table('cust_pkg')->column('manual_flag');
2055 grep { ! $_->manual_flag } $self->suspended_pkgs;
2058 =item unsuspended_pkgs
2060 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2065 sub unsuspended_pkgs {
2067 grep { ! $_->susp } $self->ncancelled_pkgs;
2070 =item next_bill_date
2072 Returns the next date this customer will be billed, as a UNIX timestamp, or
2073 undef if no active package has a next bill date.
2077 sub next_bill_date {
2079 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2082 =item num_cancelled_pkgs
2084 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2089 sub num_cancelled_pkgs {
2090 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2093 sub num_ncancelled_pkgs {
2094 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2098 my( $self ) = shift;
2099 my $sql = scalar(@_) ? shift : '';
2100 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2101 my $sth = dbh->prepare(
2102 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2103 ) or die dbh->errstr;
2104 $sth->execute($self->custnum) or die $sth->errstr;
2105 $sth->fetchrow_arrayref->[0];
2110 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2111 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2112 on success or a list of errors.
2118 grep { $_->unsuspend } $self->suspended_pkgs;
2123 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2125 Returns a list: an empty list on success or a list of errors.
2131 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2134 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2136 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2137 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2138 of a list of pkgparts; the hashref has the following keys:
2142 =item pkgparts - listref of pkgparts
2144 =item (other options are passed to the suspend method)
2149 Returns a list: an empty list on success or a list of errors.
2153 sub suspend_if_pkgpart {
2155 my (@pkgparts, %opt);
2156 if (ref($_[0]) eq 'HASH'){
2157 @pkgparts = @{$_[0]{pkgparts}};
2162 grep { $_->suspend(%opt) }
2163 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2164 $self->unsuspended_pkgs;
2167 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2169 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2170 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2171 instead of a list of pkgparts; the hashref has the following keys:
2175 =item pkgparts - listref of pkgparts
2177 =item (other options are passed to the suspend method)
2181 Returns a list: an empty list on success or a list of errors.
2185 sub suspend_unless_pkgpart {
2187 my (@pkgparts, %opt);
2188 if (ref($_[0]) eq 'HASH'){
2189 @pkgparts = @{$_[0]{pkgparts}};
2194 grep { $_->suspend(%opt) }
2195 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2196 $self->unsuspended_pkgs;
2199 =item cancel [ OPTION => VALUE ... ]
2201 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2203 Available options are:
2207 =item quiet - can be set true to supress email cancellation notices.
2209 =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.
2211 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2213 =item nobill - can be set true to skip billing if it might otherwise be done.
2217 Always returns a list: an empty list on success or a list of errors.
2221 # nb that dates are not specified as valid options to this method
2224 my( $self, %opt ) = @_;
2226 warn "$me cancel called on customer ". $self->custnum. " with options ".
2227 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2230 return ( 'access denied' )
2231 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2233 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2235 #should try decryption (we might have the private key)
2236 # and if not maybe queue a job for the server that does?
2237 return ( "Can't (yet) ban encrypted credit cards" )
2238 if $self->is_encrypted($self->payinfo);
2240 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2241 my $error = $ban->insert;
2242 return ( $error ) if $error;
2246 my @pkgs = $self->ncancelled_pkgs;
2248 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2250 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2251 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2255 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2256 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2259 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2262 sub _banned_pay_hashref {
2273 'payby' => $payby2ban{$self->payby},
2274 'payinfo' => md5_base64($self->payinfo),
2275 #don't ever *search* on reason! #'reason' =>
2281 Returns all notes (see L<FS::cust_main_note>) for this customer.
2288 qsearch( 'cust_main_note',
2289 { 'custnum' => $self->custnum },
2291 'ORDER BY _DATE DESC'
2297 Returns the agent (see L<FS::agent>) for this customer.
2303 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2306 =item bill_and_collect
2308 Cancels and suspends any packages due, generates bills, applies payments and
2311 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2313 Options are passed as name-value pairs. Currently available options are:
2319 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:
2323 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2327 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.
2331 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2335 If set true, re-charges setup fees.
2339 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)
2343 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2344 options of those methods are also available.
2348 sub bill_and_collect {
2349 my( $self, %options ) = @_;
2351 #$options{actual_time} not $options{time} because freeside-daily -d is for
2352 #pre-printing invoices
2353 $self->cancel_expired_pkgs( $options{actual_time} );
2354 $self->suspend_adjourned_pkgs( $options{actual_time} );
2356 my $error = $self->bill( %options );
2357 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2359 $self->apply_payments_and_credits;
2361 unless ( $conf->exists('cancelled_cust-noevents')
2362 && ! $self->num_ncancelled_pkgs
2365 $error = $self->collect( %options );
2366 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2372 sub cancel_expired_pkgs {
2373 my ( $self, $time ) = @_;
2375 my @cancel_pkgs = $self->ncancelled_pkgs( {
2376 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2379 foreach my $cust_pkg ( @cancel_pkgs ) {
2380 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2381 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2382 'reason_otaker' => $cpr->otaker
2386 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2387 " for custnum ". $self->custnum. ": $error"
2393 sub suspend_adjourned_pkgs {
2394 my ( $self, $time ) = @_;
2396 my @susp_pkgs = $self->ncancelled_pkgs( {
2398 " AND ( susp IS NULL OR susp = 0 )
2399 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2400 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2405 #only because there's no SQL test for is_prepaid :/
2407 grep { ( $_->part_pkg->is_prepaid
2412 && $_->adjourn <= $time
2418 foreach my $cust_pkg ( @susp_pkgs ) {
2419 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2420 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2421 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2422 'reason_otaker' => $cpr->otaker
2427 warn "Error suspending package ". $cust_pkg->pkgnum.
2428 " for custnum ". $self->custnum. ": $error"
2436 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2437 conjunction with the collect method by calling B<bill_and_collect>.
2439 If there is an error, returns the error, otherwise returns false.
2441 Options are passed as name-value pairs. Currently available options are:
2447 If set true, re-charges setup fees.
2451 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:
2455 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2459 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2461 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2465 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2469 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.
2473 This boolean value informs the us that the package is being cancelled. This
2474 typically might mean not charging the normal recurring fee but only usage
2475 fees since the last billing. Setup charges may be charged. Not all package
2476 plans support this feature (they tend to charge 0).
2483 my( $self, %options ) = @_;
2484 return '' if $self->payby eq 'COMP';
2485 warn "$me bill customer ". $self->custnum. "\n"
2488 my $time = $options{'time'} || time;
2489 my $invoice_time = $options{'invoice_time'} || $time;
2491 $options{'not_pkgpart'} ||= {};
2492 $options{'not_pkgpart'} = { map { $_ => 1 }
2493 split(/\s*,\s*/, $options{'not_pkgpart'})
2495 unless ref($options{'not_pkgpart'});
2497 local $SIG{HUP} = 'IGNORE';
2498 local $SIG{INT} = 'IGNORE';
2499 local $SIG{QUIT} = 'IGNORE';
2500 local $SIG{TERM} = 'IGNORE';
2501 local $SIG{TSTP} = 'IGNORE';
2502 local $SIG{PIPE} = 'IGNORE';
2504 my $oldAutoCommit = $FS::UID::AutoCommit;
2505 local $FS::UID::AutoCommit = 0;
2508 $self->select_for_update; #mutex
2510 my $error = $self->do_cust_event(
2511 'debug' => ( $options{'debug'} || 0 ),
2512 'time' => $invoice_time,
2513 'check_freq' => $options{'check_freq'},
2514 'stage' => 'pre-bill',
2517 $dbh->rollback if $oldAutoCommit;
2521 my @cust_bill_pkg = ();
2524 # find the packages which are due for billing, find out how much they are
2525 # & generate invoice database.
2528 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2530 my @precommit_hooks = ();
2532 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2533 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2535 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2537 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2539 #? to avoid use of uninitialized value errors... ?
2540 $cust_pkg->setfield('bill', '')
2541 unless defined($cust_pkg->bill);
2543 #my $part_pkg = $cust_pkg->part_pkg;
2545 my $real_pkgpart = $cust_pkg->pkgpart;
2546 my %hash = $cust_pkg->hash;
2548 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2550 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2553 $self->_make_lines( 'part_pkg' => $part_pkg,
2554 'cust_pkg' => $cust_pkg,
2555 'precommit_hooks' => \@precommit_hooks,
2556 'line_items' => \@cust_bill_pkg,
2557 'setup' => \$total_setup,
2558 'recur' => \$total_recur,
2559 'tax_matrix' => \%taxlisthash,
2561 'real_pkgpart' => $real_pkgpart,
2562 'options' => \%options,
2565 $dbh->rollback if $oldAutoCommit;
2569 } #foreach my $part_pkg
2571 } #foreach my $cust_pkg
2573 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2574 #but do commit any package date cycling that happened
2575 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2579 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2580 !$conf->exists('postal_invoice-recurring_only')
2584 my $postal_pkg = $self->charge_postal_fee();
2585 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2587 $dbh->rollback if $oldAutoCommit;
2588 return "can't charge postal invoice fee for customer ".
2589 $self->custnum. ": $postal_pkg";
2591 } elsif ( $postal_pkg ) {
2593 my $real_pkgpart = $postal_pkg->pkgpart;
2594 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2595 my %postal_options = %options;
2596 delete $postal_options{cancel};
2598 $self->_make_lines( 'part_pkg' => $part_pkg,
2599 'cust_pkg' => $postal_pkg,
2600 'precommit_hooks' => \@precommit_hooks,
2601 'line_items' => \@cust_bill_pkg,
2602 'setup' => \$total_setup,
2603 'recur' => \$total_recur,
2604 'tax_matrix' => \%taxlisthash,
2606 'real_pkgpart' => $real_pkgpart,
2607 'options' => \%postal_options,
2610 $dbh->rollback if $oldAutoCommit;
2619 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2621 # keys are tax names (as printed on invoices / itemdesc )
2622 # values are listrefs of taxlisthash keys (internal identifiers)
2625 # keys are taxlisthash keys (internal identifiers)
2626 # values are (cumulative) amounts
2629 # keys are taxlisthash keys (internal identifiers)
2630 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2631 my %tax_location = ();
2633 # keys are taxlisthash keys (internal identifiers)
2634 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2635 my %tax_rate_location = ();
2637 foreach my $tax ( keys %taxlisthash ) {
2638 my $tax_object = shift @{ $taxlisthash{$tax} };
2639 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2640 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2641 my $hashref_or_error =
2642 $tax_object->taxline( $taxlisthash{$tax},
2643 'custnum' => $self->custnum,
2644 'invoice_time' => $invoice_time
2646 unless ( ref($hashref_or_error) ) {
2647 $dbh->rollback if $oldAutoCommit;
2648 return $hashref_or_error;
2650 unshift @{ $taxlisthash{$tax} }, $tax_object;
2652 my $name = $hashref_or_error->{'name'};
2653 my $amount = $hashref_or_error->{'amount'};
2655 #warn "adding $amount as $name\n";
2656 $taxname{ $name } ||= [];
2657 push @{ $taxname{ $name } }, $tax;
2659 $tax{ $tax } += $amount;
2661 $tax_location{ $tax } ||= [];
2662 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2663 push @{ $tax_location{ $tax } },
2665 'taxnum' => $tax_object->taxnum,
2666 'taxtype' => ref($tax_object),
2667 'pkgnum' => $tax_object->get('pkgnum'),
2668 'locationnum' => $tax_object->get('locationnum'),
2669 'amount' => sprintf('%.2f', $amount ),
2673 $tax_rate_location{ $tax } ||= [];
2674 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2675 my $taxratelocationnum =
2676 $tax_object->tax_rate_location->taxratelocationnum;
2677 push @{ $tax_rate_location{ $tax } },
2679 'taxnum' => $tax_object->taxnum,
2680 'taxtype' => ref($tax_object),
2681 'amount' => sprintf('%.2f', $amount ),
2682 'locationtaxid' => $tax_object->location,
2683 'taxratelocationnum' => $taxratelocationnum,
2689 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2690 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2691 foreach my $tax ( keys %taxlisthash ) {
2692 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2693 next unless ref($_) eq 'FS::cust_bill_pkg';
2695 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2696 splice( @{ $_->_cust_tax_exempt_pkg } );
2700 #consolidate and create tax line items
2701 warn "consolidating and generating...\n" if $DEBUG > 2;
2702 foreach my $taxname ( keys %taxname ) {
2705 my @cust_bill_pkg_tax_location = ();
2706 my @cust_bill_pkg_tax_rate_location = ();
2707 warn "adding $taxname\n" if $DEBUG > 1;
2708 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2709 next if $seen{$taxitem}++;
2710 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2711 $tax += $tax{$taxitem};
2712 push @cust_bill_pkg_tax_location,
2713 map { new FS::cust_bill_pkg_tax_location $_ }
2714 @{ $tax_location{ $taxitem } };
2715 push @cust_bill_pkg_tax_rate_location,
2716 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2717 @{ $tax_rate_location{ $taxitem } };
2721 $tax = sprintf('%.2f', $tax );
2722 $total_setup = sprintf('%.2f', $total_setup+$tax );
2724 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2730 if ( $pkg_category and
2731 $conf->config('invoice_latexsummary') ||
2732 $conf->config('invoice_htmlsummary')
2736 my %hash = ( 'section' => $pkg_category->categoryname );
2737 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2741 push @cust_bill_pkg, new FS::cust_bill_pkg {
2747 'itemdesc' => $taxname,
2748 'display' => \@display,
2749 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2750 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2755 #add tax adjustments
2756 warn "adding tax adjustments...\n" if $DEBUG > 2;
2757 foreach my $cust_tax_adjustment (
2758 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2764 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2765 $total_setup = sprintf('%.2f', $total_setup+$tax );
2767 my $itemdesc = $cust_tax_adjustment->taxname;
2768 $itemdesc = '' if $itemdesc eq 'Tax';
2770 push @cust_bill_pkg, new FS::cust_bill_pkg {
2776 'itemdesc' => $itemdesc,
2777 'itemcomment' => $cust_tax_adjustment->comment,
2778 'cust_tax_adjustment' => $cust_tax_adjustment,
2779 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2784 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2786 my @cust_bill = $self->cust_bill;
2787 my $balance = $self->balance;
2788 my $previous_balance = scalar(@cust_bill)
2789 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2792 $previous_balance += $cust_bill[$#cust_bill]->charged
2793 if scalar(@cust_bill);
2794 #my $balance_adjustments =
2795 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2797 #create the new invoice
2798 my $cust_bill = new FS::cust_bill ( {
2799 'custnum' => $self->custnum,
2800 '_date' => ( $invoice_time ),
2801 'charged' => $charged,
2802 'billing_balance' => $balance,
2803 'previous_balance' => $previous_balance,
2805 $error = $cust_bill->insert;
2807 $dbh->rollback if $oldAutoCommit;
2808 return "can't create invoice for customer #". $self->custnum. ": $error";
2811 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2812 $cust_bill_pkg->invnum($cust_bill->invnum);
2813 my $error = $cust_bill_pkg->insert;
2815 $dbh->rollback if $oldAutoCommit;
2816 return "can't create invoice line item: $error";
2821 foreach my $hook ( @precommit_hooks ) {
2823 &{$hook}; #($self) ?
2826 $dbh->rollback if $oldAutoCommit;
2827 return "$@ running precommit hook $hook\n";
2831 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2837 my ($self, %params) = @_;
2839 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2840 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2841 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2842 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2843 my $total_setup = $params{setup} or die "no setup accumulator specified";
2844 my $total_recur = $params{recur} or die "no recur accumulator specified";
2845 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2846 my $time = $params{'time'} or die "no time specified";
2847 my (%options) = %{$params{options}};
2850 my $real_pkgpart = $params{real_pkgpart};
2851 my %hash = $cust_pkg->hash;
2852 my $old_cust_pkg = new FS::cust_pkg \%hash;
2858 $cust_pkg->pkgpart($part_pkg->pkgpart);
2866 if ( $options{'resetup'}
2867 || ( ! $cust_pkg->setup
2868 && ( ! $cust_pkg->start_date
2869 || $cust_pkg->start_date <= $time
2871 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2872 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2873 ! $cust_pkg->getfield('susp')
2880 warn " bill setup\n" if $DEBUG > 1;
2883 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2884 return "$@ running calc_setup for $cust_pkg\n"
2887 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2889 $cust_pkg->setfield('setup', $time)
2890 unless $cust_pkg->setup;
2891 #do need it, but it won't get written to the db
2892 #|| $cust_pkg->pkgpart != $real_pkgpart;
2894 $cust_pkg->setfield('start_date', '')
2895 if $cust_pkg->start_date;
2900 # bill recurring fee
2903 #XXX unit stuff here too
2907 if ( ! $cust_pkg->get('susp')
2908 and ! $cust_pkg->get('start_date')
2909 and ( $part_pkg->getfield('freq') ne '0'
2910 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2912 || ( $part_pkg->plan eq 'voip_cdr'
2913 && $part_pkg->option('bill_every_call')
2915 || ( $options{cancel} )
2918 # XXX should this be a package event? probably. events are called
2919 # at collection time at the moment, though...
2920 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2921 if $part_pkg->can('reset_usage');
2922 #don't want to reset usage just cause we want a line item??
2923 #&& $part_pkg->pkgpart == $real_pkgpart;
2925 warn " bill recur\n" if $DEBUG > 1;
2928 # XXX shared with $recur_prog
2929 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2933 #over two params! lets at least switch to a hashref for the rest...
2934 my $increment_next_bill = ( $part_pkg->freq ne '0'
2935 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2936 && !$options{cancel}
2938 my %param = ( 'precommit_hooks' => $precommit_hooks,
2939 'increment_next_bill' => $increment_next_bill,
2942 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
2943 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
2944 return "$@ running $method for $cust_pkg\n"
2947 if ( $increment_next_bill ) {
2949 my $next_bill = $part_pkg->add_freq($sdate);
2950 return "unparsable frequency: ". $part_pkg->freq
2951 if $next_bill == -1;
2953 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2954 # only for figuring next bill date, nothing else, so, reset $sdate again
2956 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2957 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2958 $cust_pkg->last_bill($sdate);
2960 $cust_pkg->setfield('bill', $next_bill );
2966 warn "\$setup is undefined" unless defined($setup);
2967 warn "\$recur is undefined" unless defined($recur);
2968 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2971 # If there's line items, create em cust_bill_pkg records
2972 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2977 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2978 # hmm.. and if just the options are modified in some weird price plan?
2980 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2983 my $error = $cust_pkg->replace( $old_cust_pkg,
2984 'options' => { $cust_pkg->options },
2986 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2987 if $error; #just in case
2990 $setup = sprintf( "%.2f", $setup );
2991 $recur = sprintf( "%.2f", $recur );
2992 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2993 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2995 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2996 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2999 if ( $setup != 0 || $recur != 0 ) {
3001 warn " charges (setup=$setup, recur=$recur); adding line items\n"
3004 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3006 warn " adding customer package invoice detail: $_\n"
3007 foreach @cust_pkg_detail;
3009 push @details, @cust_pkg_detail;
3011 my $cust_bill_pkg = new FS::cust_bill_pkg {
3012 'pkgnum' => $cust_pkg->pkgnum,
3014 'unitsetup' => $unitsetup,
3016 'unitrecur' => $unitrecur,
3017 'quantity' => $cust_pkg->quantity,
3018 'details' => \@details,
3019 'hidden' => $part_pkg->hidden,
3022 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3023 $cust_bill_pkg->sdate( $hash{last_bill} );
3024 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
3025 $cust_bill_pkg->edate( $time ) if $options{cancel};
3026 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3027 $cust_bill_pkg->sdate( $sdate );
3028 $cust_bill_pkg->edate( $cust_pkg->bill );
3029 #$cust_bill_pkg->edate( $time ) if $options{cancel};
3032 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3033 unless $part_pkg->pkgpart == $real_pkgpart;
3035 $$total_setup += $setup;
3036 $$total_recur += $recur;
3043 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3044 return $error if $error;
3046 push @$cust_bill_pkgs, $cust_bill_pkg;
3048 } #if $setup != 0 || $recur != 0
3058 my $part_pkg = shift;
3059 my $taxlisthash = shift;
3060 my $cust_bill_pkg = shift;
3061 my $cust_pkg = shift;
3062 my $invoice_time = shift;
3063 my $real_pkgpart = shift;
3064 my $options = shift;
3066 my %cust_bill_pkg = ();
3070 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3071 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3072 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3073 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3075 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3077 if ( $conf->exists('enable_taxproducts')
3078 && ( scalar($part_pkg->part_pkg_taxoverride)
3079 || $part_pkg->has_taxproduct
3084 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3085 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3088 foreach my $class (@classes) {
3089 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3090 return $err_or_ref unless ref($err_or_ref);
3091 $taxes{$class} = $err_or_ref;
3094 unless (exists $taxes{''}) {
3095 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3096 return $err_or_ref unless ref($err_or_ref);
3097 $taxes{''} = $err_or_ref;
3102 my @loc_keys = qw( state county country );
3104 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3105 my $cust_location = $cust_pkg->cust_location;
3106 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3109 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3112 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3115 $taxhash{'taxclass'} = $part_pkg->taxclass;
3117 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3119 my %taxhash_elim = %taxhash;
3121 my @elim = qw( taxclass county state );
3122 while ( !scalar(@taxes) && scalar(@elim) ) {
3123 $taxhash_elim{ shift(@elim) } = '';
3124 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3127 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3129 if $self->cust_main_exemption; #just to be safe
3131 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3133 $_->set('pkgnum', $cust_pkg->pkgnum );
3134 $_->set('locationnum', $cust_pkg->locationnum );
3138 $taxes{''} = [ @taxes ];
3139 $taxes{'setup'} = [ @taxes ];
3140 $taxes{'recur'} = [ @taxes ];
3141 $taxes{$_} = [ @taxes ] foreach (@classes);
3143 # # maybe eliminate this entirely, along with all the 0% records
3144 # unless ( @taxes ) {
3146 # "fatal: can't find tax rate for state/county/country/taxclass ".
3147 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3150 } #if $conf->exists('enable_taxproducts') ...
3155 my $separate = $conf->exists('separate_usage');
3156 my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3157 if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3159 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3160 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3161 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3164 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3165 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3167 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3168 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3170 push @display, new FS::cust_bill_pkg_display
3173 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3177 if ($separate && $section && $summary) {
3178 push @display, new FS::cust_bill_pkg_display { type => 'U',
3183 if ($usage_mandate || $section && $summary) {
3184 $hash{post_total} = 'Y';
3187 $hash{section} = $section if ($separate || $usage_mandate);
3188 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3191 $cust_bill_pkg->set('display', \@display);
3193 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3194 foreach my $key (keys %tax_cust_bill_pkg) {
3195 my @taxes = @{ $taxes{$key} || [] };
3196 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3198 my %localtaxlisthash = ();
3199 foreach my $tax ( @taxes ) {
3201 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3202 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3203 # ' locationnum'. $cust_pkg->locationnum
3204 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3206 $taxlisthash->{ $taxname } ||= [ $tax ];
3207 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3209 $localtaxlisthash{ $taxname } ||= [ $tax ];
3210 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3214 warn "finding taxed taxes...\n" if $DEBUG > 2;
3215 foreach my $tax ( keys %localtaxlisthash ) {
3216 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3217 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3219 next unless $tax_object->can('tax_on_tax');
3221 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3222 my $totname = ref( $tot ). ' '. $tot->taxnum;
3224 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3226 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3228 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3229 my $hashref_or_error =
3230 $tax_object->taxline( $localtaxlisthash{$tax},
3231 'custnum' => $self->custnum,
3232 'invoice_time' => $invoice_time,
3234 return $hashref_or_error
3235 unless ref($hashref_or_error);
3237 $taxlisthash->{ $totname } ||= [ $tot ];
3238 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3250 my $part_pkg = shift;
3254 my $geocode = $self->geocode('cch');
3256 my @taxclassnums = map { $_->taxclassnum }
3257 $part_pkg->part_pkg_taxoverride($class);
3259 unless (@taxclassnums) {
3260 @taxclassnums = map { $_->taxclassnum }
3261 grep { $_->taxable eq 'Y' }
3262 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3264 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3269 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3271 @taxes = qsearch({ 'table' => 'tax_rate',
3272 'hashref' => { 'geocode' => $geocode, },
3273 'extra_sql' => $extra_sql,
3275 if scalar(@taxclassnums);
3277 warn "Found taxes ".
3278 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3285 =item collect [ HASHREF | OPTION => VALUE ... ]
3287 (Attempt to) collect money for this customer's outstanding invoices (see
3288 L<FS::cust_bill>). Usually used after the bill method.
3290 Actions are now triggered by billing events; see L<FS::part_event> and the
3291 billing events web interface. Old-style invoice events (see
3292 L<FS::part_bill_event>) have been deprecated.
3294 If there is an error, returns the error, otherwise returns false.
3296 Options are passed as name-value pairs.
3298 Currently available options are:
3304 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.
3308 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3312 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3316 set true to surpress email card/ACH decline notices.
3320 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)
3326 # allows for one time override of normal customer billing method
3331 my( $self, %options ) = @_;
3332 my $invoice_time = $options{'invoice_time'} || time;
3335 local $SIG{HUP} = 'IGNORE';
3336 local $SIG{INT} = 'IGNORE';
3337 local $SIG{QUIT} = 'IGNORE';
3338 local $SIG{TERM} = 'IGNORE';
3339 local $SIG{TSTP} = 'IGNORE';
3340 local $SIG{PIPE} = 'IGNORE';
3342 my $oldAutoCommit = $FS::UID::AutoCommit;
3343 local $FS::UID::AutoCommit = 0;
3346 $self->select_for_update; #mutex
3349 my $balance = $self->balance;
3350 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3353 if ( exists($options{'retry_card'}) ) {
3354 carp 'retry_card option passed to collect is deprecated; use retry';
3355 $options{'retry'} ||= $options{'retry_card'};
3357 if ( exists($options{'retry'}) && $options{'retry'} ) {
3358 my $error = $self->retry_realtime;
3360 $dbh->rollback if $oldAutoCommit;
3365 my $error = $self->do_cust_event(
3366 'debug' => ( $options{'debug'} || 0 ),
3367 'time' => $invoice_time,
3368 'check_freq' => $options{'check_freq'},
3369 'stage' => 'collect',
3372 $dbh->rollback if $oldAutoCommit;
3376 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3381 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3383 Runs billing events; see L<FS::part_event> and the billing events web
3386 If there is an error, returns the error, otherwise returns false.
3388 Options are passed as name-value pairs.
3390 Currently available options are:
3396 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.
3400 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3404 "collect" (the default) or "pre-bill"
3408 set true to surpress email card/ACH decline notices.
3412 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)
3418 # allows for one time override of normal customer billing method
3422 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3425 my( $self, %options ) = @_;
3426 my $time = $options{'time'} || time;
3429 local $SIG{HUP} = 'IGNORE';
3430 local $SIG{INT} = 'IGNORE';
3431 local $SIG{QUIT} = 'IGNORE';
3432 local $SIG{TERM} = 'IGNORE';
3433 local $SIG{TSTP} = 'IGNORE';
3434 local $SIG{PIPE} = 'IGNORE';
3436 my $oldAutoCommit = $FS::UID::AutoCommit;
3437 local $FS::UID::AutoCommit = 0;
3440 $self->select_for_update; #mutex
3443 my $balance = $self->balance;
3444 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3447 # if ( exists($options{'retry_card'}) ) {
3448 # carp 'retry_card option passed to collect is deprecated; use retry';
3449 # $options{'retry'} ||= $options{'retry_card'};
3451 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3452 # my $error = $self->retry_realtime;
3454 # $dbh->rollback if $oldAutoCommit;
3459 # false laziness w/pay_batch::import_results
3461 my $due_cust_event = $self->due_cust_event(
3462 'debug' => ( $options{'debug'} || 0 ),
3464 'check_freq' => $options{'check_freq'},
3465 'stage' => ( $options{'stage'} || 'collect' ),
3467 unless( ref($due_cust_event) ) {
3468 $dbh->rollback if $oldAutoCommit;
3469 return $due_cust_event;
3472 foreach my $cust_event ( @$due_cust_event ) {
3476 #re-eval event conditions (a previous event could have changed things)
3477 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3478 #don't leave stray "new/locked" records around
3479 my $error = $cust_event->delete;
3481 #gah, even with transactions
3482 $dbh->commit if $oldAutoCommit; #well.
3489 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3490 warn " running cust_event ". $cust_event->eventnum. "\n"
3494 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3495 if ( my $error = $cust_event->do_event() ) {
3496 #XXX wtf is this? figure out a proper dealio with return value
3498 # gah, even with transactions.
3499 $dbh->commit if $oldAutoCommit; #well.
3506 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3511 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3513 Inserts database records for and returns an ordered listref of new events due
3514 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3515 events are due, an empty listref is returned. If there is an error, returns a
3516 scalar error message.
3518 To actually run the events, call each event's test_condition method, and if
3519 still true, call the event's do_event method.
3521 Options are passed as a hashref or as a list of name-value pairs. Available
3528 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.
3532 "collect" (the default) or "pre-bill"
3536 "Current time" for the events.
3540 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)
3544 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3548 Explicitly pass the objects to be tested (typically used with eventtable).
3552 Set to true to return the objects, but not actually insert them into the
3559 sub due_cust_event {
3561 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3564 #my $DEBUG = $opt{'debug'}
3565 local($DEBUG) = $opt{'debug'}
3566 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3568 warn "$me due_cust_event called with options ".
3569 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3572 $opt{'time'} ||= time;
3574 local $SIG{HUP} = 'IGNORE';
3575 local $SIG{INT} = 'IGNORE';
3576 local $SIG{QUIT} = 'IGNORE';
3577 local $SIG{TERM} = 'IGNORE';
3578 local $SIG{TSTP} = 'IGNORE';
3579 local $SIG{PIPE} = 'IGNORE';
3581 my $oldAutoCommit = $FS::UID::AutoCommit;
3582 local $FS::UID::AutoCommit = 0;
3585 $self->select_for_update #mutex
3586 unless $opt{testonly};
3589 # find possible events (initial search)
3592 my @cust_event = ();
3594 my @eventtable = $opt{'eventtable'}
3595 ? ( $opt{'eventtable'} )
3596 : FS::part_event->eventtables_runorder;
3598 foreach my $eventtable ( @eventtable ) {
3601 if ( $opt{'objects'} ) {
3603 @objects = @{ $opt{'objects'} };
3607 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3608 @objects = ( $eventtable eq 'cust_main' )
3610 : ( $self->$eventtable() );
3614 my @e_cust_event = ();
3616 my $cross = "CROSS JOIN $eventtable";
3617 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3618 unless $eventtable eq 'cust_main';
3620 foreach my $object ( @objects ) {
3622 #this first search uses the condition_sql magic for optimization.
3623 #the more possible events we can eliminate in this step the better
3625 my $cross_where = '';
3626 my $pkey = $object->primary_key;
3627 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3629 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3631 FS::part_event_condition->where_conditions_sql( $eventtable,
3632 'time'=>$opt{'time'}
3634 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3636 $extra_sql = "AND $extra_sql" if $extra_sql;
3638 #here is the agent virtualization
3639 $extra_sql .= " AND ( part_event.agentnum IS NULL
3640 OR part_event.agentnum = ". $self->agentnum. ' )';
3642 $extra_sql .= " $order";
3644 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3645 if $opt{'debug'} > 2;
3646 my @part_event = qsearch( {
3647 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3648 'select' => 'part_event.*',
3649 'table' => 'part_event',
3650 'addl_from' => "$cross $join",
3651 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3652 'eventtable' => $eventtable,
3655 'extra_sql' => "AND $cross_where $extra_sql",
3659 my $pkey = $object->primary_key;
3660 warn " ". scalar(@part_event).
3661 " possible events found for $eventtable ". $object->$pkey(). "\n";
3664 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3668 warn " ". scalar(@e_cust_event).
3669 " subtotal possible cust events found for $eventtable\n"
3672 push @cust_event, @e_cust_event;
3676 warn " ". scalar(@cust_event).
3677 " total possible cust events found in initial search\n"
3685 $opt{stage} ||= 'collect';
3687 grep { my $stage = $_->part_event->event_stage;
3688 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3698 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3699 'stats_hashref' => \%unsat ),
3702 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3705 warn " invalid conditions not eliminated with condition_sql:\n".
3706 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3713 unless( $opt{testonly} ) {
3714 foreach my $cust_event ( @cust_event ) {
3716 my $error = $cust_event->insert();
3718 $dbh->rollback if $oldAutoCommit;
3725 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3731 warn " returning events: ". Dumper(@cust_event). "\n"
3738 =item retry_realtime
3740 Schedules realtime / batch credit card / electronic check / LEC billing
3741 events for for retry. Useful if card information has changed or manual
3742 retry is desired. The 'collect' method must be called to actually retry
3745 Implementation details: For either this customer, or for each of this
3746 customer's open invoices, changes the status of the first "done" (with
3747 statustext error) realtime processing event to "failed".
3751 sub retry_realtime {
3754 local $SIG{HUP} = 'IGNORE';
3755 local $SIG{INT} = 'IGNORE';
3756 local $SIG{QUIT} = 'IGNORE';
3757 local $SIG{TERM} = 'IGNORE';
3758 local $SIG{TSTP} = 'IGNORE';
3759 local $SIG{PIPE} = 'IGNORE';
3761 my $oldAutoCommit = $FS::UID::AutoCommit;
3762 local $FS::UID::AutoCommit = 0;
3765 #a little false laziness w/due_cust_event (not too bad, really)
3767 my $join = FS::part_event_condition->join_conditions_sql;
3768 my $order = FS::part_event_condition->order_conditions_sql;
3771 . join ( ' OR ' , map {
3772 "( part_event.eventtable = " . dbh->quote($_)
3773 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3774 } FS::part_event->eventtables)
3777 #here is the agent virtualization
3778 my $agent_virt = " ( part_event.agentnum IS NULL
3779 OR part_event.agentnum = ". $self->agentnum. ' )';
3781 #XXX this shouldn't be hardcoded, actions should declare it...
3782 my @realtime_events = qw(
3783 cust_bill_realtime_card
3784 cust_bill_realtime_check
3785 cust_bill_realtime_lec
3789 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3794 my @cust_event = qsearchs({
3795 'table' => 'cust_event',
3796 'select' => 'cust_event.*',
3797 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3798 'hashref' => { 'status' => 'done' },
3799 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3800 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3803 my %seen_invnum = ();
3804 foreach my $cust_event (@cust_event) {
3806 #max one for the customer, one for each open invoice
3807 my $cust_X = $cust_event->cust_X;
3808 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3812 or $cust_event->part_event->eventtable eq 'cust_bill'
3815 my $error = $cust_event->retry;
3817 $dbh->rollback if $oldAutoCommit;
3818 return "error scheduling event for retry: $error";
3823 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3828 # some horrid false laziness here to avoid refactor fallout
3829 # eventually realtime realtime_bop and realtime_refund_bop should go
3830 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3832 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3834 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3835 via a Business::OnlinePayment realtime gateway. See
3836 L<http://420.am/business-onlinepayment> for supported gateways.
3838 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3840 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3842 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3843 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3844 if set, will override the value from the customer record.
3846 I<description> is a free-text field passed to the gateway. It defaults to
3847 "Internet services".
3849 If an I<invnum> is specified, this payment (if successful) is applied to the
3850 specified invoice. If you don't specify an I<invnum> you might want to
3851 call the B<apply_payments> method.
3853 I<quiet> can be set true to surpress email decline notices.
3855 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3856 resulting paynum, if any.
3858 I<payunique> is a unique identifier for this payment.
3860 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3867 return $self->_new_realtime_bop(@_)
3868 if $self->_new_bop_required();
3870 my( $method, $amount, %options ) = @_;
3872 warn "$me realtime_bop: $method $amount\n";
3873 warn " $_ => $options{$_}\n" foreach keys %options;
3876 $options{'description'} ||= 'Internet services';
3878 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3880 eval "use Business::OnlinePayment";
3883 my $payinfo = exists($options{'payinfo'})
3884 ? $options{'payinfo'}
3887 my %method2payby = (
3894 # check for banned credit card/ACH
3897 my $ban = qsearchs('banned_pay', {
3898 'payby' => $method2payby{$method},
3899 'payinfo' => md5_base64($payinfo),
3901 return "Banned credit card" if $ban;
3904 # set taxclass and trans_is_recur based on invnum if there is one
3908 my $trans_is_recur = 0;
3909 if ( $options{'invnum'} ) {
3911 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3912 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3915 map { $_->part_pkg }
3917 map { $_->cust_pkg }
3918 $cust_bill->cust_bill_pkg;
3920 my @taxclasses = map $_->taxclass, @part_pkg;
3921 $taxclass = $taxclasses[0]
3922 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3923 #different taxclasses
3925 if grep { $_->freq ne '0' } @part_pkg;
3933 #look for an agent gateway override first
3935 if ( $method eq 'CC' ) {
3936 $cardtype = cardtype($payinfo);
3937 } elsif ( $method eq 'ECHECK' ) {
3940 $cardtype = $method;
3944 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3945 cardtype => $cardtype,
3946 taxclass => $taxclass, } )
3947 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3949 taxclass => $taxclass, } )
3950 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3951 cardtype => $cardtype,
3953 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3955 taxclass => '', } );
3957 my $payment_gateway = '';
3958 my( $processor, $login, $password, $action, @bop_options );
3959 if ( $override ) { #use a payment gateway override
3961 $payment_gateway = $override->payment_gateway;
3963 $processor = $payment_gateway->gateway_module;
3964 $login = $payment_gateway->gateway_username;
3965 $password = $payment_gateway->gateway_password;
3966 $action = $payment_gateway->gateway_action;
3967 @bop_options = $payment_gateway->options;
3969 } else { #use the standard settings from the config
3971 ( $processor, $login, $password, $action, @bop_options ) =
3972 $self->default_payment_gateway($method);
3980 my $address = exists($options{'address1'})
3981 ? $options{'address1'}
3983 my $address2 = exists($options{'address2'})
3984 ? $options{'address2'}
3986 $address .= ", ". $address2 if length($address2);
3988 my $o_payname = exists($options{'payname'})
3989 ? $options{'payname'}
3991 my($payname, $payfirst, $paylast);
3992 if ( $o_payname && $method ne 'ECHECK' ) {
3993 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3994 or return "Illegal payname $payname";
3995 ($payfirst, $paylast) = ($1, $2);
3997 $payfirst = $self->getfield('first');
3998 $paylast = $self->getfield('last');
3999 $payname = "$payfirst $paylast";
4002 my @invoicing_list = $self->invoicing_list_emailonly;
4003 if ( $conf->exists('emailinvoiceautoalways')
4004 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4005 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4006 push @invoicing_list, $self->all_emails;
4009 my $email = ($conf->exists('business-onlinepayment-email-override'))
4010 ? $conf->config('business-onlinepayment-email-override')
4011 : $invoicing_list[0];
4015 my $payip = exists($options{'payip'})
4018 $content{customer_ip} = $payip
4021 $content{invoice_number} = $options{'invnum'}
4022 if exists($options{'invnum'}) && length($options{'invnum'});
4024 $content{email_customer} =
4025 ( $conf->exists('business-onlinepayment-email_customer')
4026 || $conf->exists('business-onlinepayment-email-override') );
4029 if ( $method eq 'CC' ) {
4031 $content{card_number} = $payinfo;
4032 $paydate = exists($options{'paydate'})
4033 ? $options{'paydate'}
4035 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4036 $content{expiration} = "$2/$1";
4038 my $paycvv = exists($options{'paycvv'})
4039 ? $options{'paycvv'}
4041 $content{cvv2} = $paycvv
4044 my $paystart_month = exists($options{'paystart_month'})
4045 ? $options{'paystart_month'}
4046 : $self->paystart_month;
4048 my $paystart_year = exists($options{'paystart_year'})
4049 ? $options{'paystart_year'}
4050 : $self->paystart_year;
4052 $content{card_start} = "$paystart_month/$paystart_year"
4053 if $paystart_month && $paystart_year;
4055 my $payissue = exists($options{'payissue'})
4056 ? $options{'payissue'}
4058 $content{issue_number} = $payissue if $payissue;
4060 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4061 'trans_is_recur' => $trans_is_recur,
4065 $content{recurring_billing} = 'YES';
4066 $content{acct_code} = 'rebill'
4067 if $conf->exists('credit_card-recurring_billing_acct_code');
4070 } elsif ( $method eq 'ECHECK' ) {
4071 ( $content{account_number}, $content{routing_code} ) =
4072 split('@', $payinfo);
4073 $content{bank_name} = $o_payname;
4074 $content{bank_state} = exists($options{'paystate'})
4075 ? $options{'paystate'}
4076 : $self->getfield('paystate');
4077 $content{account_type} = exists($options{'paytype'})
4078 ? uc($options{'paytype'}) || 'CHECKING'
4079 : uc($self->getfield('paytype')) || 'CHECKING';
4080 $content{account_name} = $payname;
4081 $content{customer_org} = $self->company ? 'B' : 'I';
4082 $content{state_id} = exists($options{'stateid'})
4083 ? $options{'stateid'}
4084 : $self->getfield('stateid');
4085 $content{state_id_state} = exists($options{'stateid_state'})
4086 ? $options{'stateid_state'}
4087 : $self->getfield('stateid_state');
4088 $content{customer_ssn} = exists($options{'ss'})
4091 } elsif ( $method eq 'LEC' ) {
4092 $content{phone} = $payinfo;
4096 # run transaction(s)
4099 my $balance = exists( $options{'balance'} )
4100 ? $options{'balance'}
4103 $self->select_for_update; #mutex ... just until we get our pending record in
4105 #the checks here are intended to catch concurrent payments
4106 #double-form-submission prevention is taken care of in cust_pay_pending::check
4109 return "The customer's balance has changed; $method transaction aborted."
4110 if $self->balance < $balance;
4111 #&& $self->balance < $amount; #might as well anyway?
4113 #also check and make sure there aren't *other* pending payments for this cust
4115 my @pending = qsearch('cust_pay_pending', {
4116 'custnum' => $self->custnum,
4117 'status' => { op=>'!=', value=>'done' }
4119 return "A payment is already being processed for this customer (".
4120 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4121 "); $method transaction aborted."
4122 if scalar(@pending);
4124 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4126 my $cust_pay_pending = new FS::cust_pay_pending {
4127 'custnum' => $self->custnum,
4128 #'invnum' => $options{'invnum'},
4131 'payby' => $method2payby{$method},
4132 'payinfo' => $payinfo,
4133 'paydate' => $paydate,
4134 'recurring_billing' => $content{recurring_billing},
4135 'pkgnum' => $options{'pkgnum'},
4137 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4139 $cust_pay_pending->payunique( $options{payunique} )
4140 if defined($options{payunique}) && length($options{payunique});
4141 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4142 return $cpp_new_err if $cpp_new_err;
4144 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4146 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4147 $transaction->content(
4150 'password' => $password,
4151 'action' => $action1,
4152 'description' => $options{'description'},
4153 'amount' => $amount,
4154 #'invoice_number' => $options{'invnum'},
4155 'customer_id' => $self->custnum,
4156 'last_name' => $paylast,
4157 'first_name' => $payfirst,
4159 'address' => $address,
4160 'city' => ( exists($options{'city'})
4163 'state' => ( exists($options{'state'})
4166 'zip' => ( exists($options{'zip'})
4169 'country' => ( exists($options{'country'})
4170 ? $options{'country'}
4172 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4174 'phone' => $self->daytime || $self->night,
4178 $cust_pay_pending->status('pending');
4179 my $cpp_pending_err = $cust_pay_pending->replace;
4180 return $cpp_pending_err if $cpp_pending_err;
4183 my $BOP_TESTING = 0;
4184 my $BOP_TESTING_SUCCESS = 1;
4186 unless ( $BOP_TESTING ) {
4187 $transaction->submit();
4189 if ( $BOP_TESTING_SUCCESS ) {
4190 $transaction->is_success(1);
4191 $transaction->authorization('fake auth');
4193 $transaction->is_success(0);
4194 $transaction->error_message('fake failure');
4198 if ( $transaction->is_success() && $action2 ) {
4200 $cust_pay_pending->status('authorized');
4201 my $cpp_authorized_err = $cust_pay_pending->replace;
4202 return $cpp_authorized_err if $cpp_authorized_err;
4204 my $auth = $transaction->authorization;
4205 my $ordernum = $transaction->can('order_number')
4206 ? $transaction->order_number
4210 new Business::OnlinePayment( $processor, @bop_options );
4217 password => $password,
4218 order_number => $ordernum,
4220 authorization => $auth,
4221 description => $options{'description'},
4224 foreach my $field (qw( authorization_source_code returned_ACI
4225 transaction_identifier validation_code
4226 transaction_sequence_num local_transaction_date
4227 local_transaction_time AVS_result_code )) {
4228 $capture{$field} = $transaction->$field() if $transaction->can($field);
4231 $capture->content( %capture );
4235 unless ( $capture->is_success ) {
4236 my $e = "Authorization successful but capture failed, custnum #".
4237 $self->custnum. ': '. $capture->result_code.
4238 ": ". $capture->error_message;
4245 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4246 my $cpp_captured_err = $cust_pay_pending->replace;
4247 return $cpp_captured_err if $cpp_captured_err;
4250 # remove paycvv after initial transaction
4253 #false laziness w/misc/process/payment.cgi - check both to make sure working
4255 if ( defined $self->dbdef_table->column('paycvv')
4256 && length($self->paycvv)
4257 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4259 my $error = $self->remove_cvv;
4261 warn "WARNING: error removing cvv: $error\n";
4269 if ( $transaction->is_success() ) {
4272 if ( $payment_gateway ) { # agent override
4273 $paybatch = $payment_gateway->gatewaynum. '-';
4276 $paybatch .= "$processor:". $transaction->authorization;
4278 $paybatch .= ':'. $transaction->order_number
4279 if $transaction->can('order_number')
4280 && length($transaction->order_number);
4282 my $cust_pay = new FS::cust_pay ( {
4283 'custnum' => $self->custnum,
4284 'invnum' => $options{'invnum'},
4287 'payby' => $method2payby{$method},
4288 'payinfo' => $payinfo,
4289 'paybatch' => $paybatch,
4290 'paydate' => $paydate,
4291 'pkgnum' => $options{'pkgnum'},
4293 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4294 $cust_pay->payunique( $options{payunique} )
4295 if defined($options{payunique}) && length($options{payunique});
4297 my $oldAutoCommit = $FS::UID::AutoCommit;
4298 local $FS::UID::AutoCommit = 0;
4301 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4303 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4306 $cust_pay->invnum(''); #try again with no specific invnum
4307 my $error2 = $cust_pay->insert( $options{'manual'} ?
4308 ( 'manual' => 1 ) : ()
4311 # gah. but at least we have a record of the state we had to abort in
4312 # from cust_pay_pending now.
4313 my $e = "WARNING: $method captured but payment not recorded - ".
4314 "error inserting payment ($processor): $error2".
4315 " (previously tried insert with invnum #$options{'invnum'}" .
4316 ": $error ) - pending payment saved as paypendingnum ".
4317 $cust_pay_pending->paypendingnum. "\n";
4323 if ( $options{'paynum_ref'} ) {
4324 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4327 $cust_pay_pending->status('done');
4328 $cust_pay_pending->statustext('captured');
4329 $cust_pay_pending->paynum($cust_pay->paynum);
4330 my $cpp_done_err = $cust_pay_pending->replace;
4332 if ( $cpp_done_err ) {
4334 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4335 my $e = "WARNING: $method captured but payment not recorded - ".
4336 "error updating status for paypendingnum ".
4337 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4343 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4344 return ''; #no error
4350 my $perror = "$processor error: ". $transaction->error_message;
4352 unless ( $transaction->error_message ) {
4355 if ( $transaction->can('response_page') ) {
4357 'page' => ( $transaction->can('response_page')
4358 ? $transaction->response_page
4361 'code' => ( $transaction->can('response_code')
4362 ? $transaction->response_code
4365 'headers' => ( $transaction->can('response_headers')
4366 ? $transaction->response_headers
4372 "No additional debugging information available for $processor";
4375 $perror .= "No error_message returned from $processor -- ".
4376 ( ref($t_response) ? Dumper($t_response) : $t_response );
4380 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4381 && $conf->exists('emaildecline')
4382 && grep { $_ ne 'POST' } $self->invoicing_list
4383 && ! grep { $transaction->error_message =~ /$_/ }
4384 $conf->config('emaildecline-exclude')
4386 my @templ = $conf->config('declinetemplate');
4387 my $template = new Text::Template (
4389 SOURCE => [ map "$_\n", @templ ],
4390 ) or return "($perror) can't create template: $Text::Template::ERROR";
4391 $template->compile()
4392 or return "($perror) can't compile template: $Text::Template::ERROR";
4396 scalar( $conf->config('company_name', $self->agentnum ) ),
4397 'company_address' =>
4398 join("\n", $conf->config('company_address', $self->agentnum ) ),
4399 'error' => $transaction->error_message,
4402 my $error = send_email(
4403 'from' => $conf->config('invoice_from', $self->agentnum ),
4404 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4405 'subject' => 'Your payment could not be processed',
4406 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4409 $perror .= " (also received error sending decline notification: $error)"
4414 $cust_pay_pending->status('done');
4415 $cust_pay_pending->statustext("declined: $perror");
4416 my $cpp_done_err = $cust_pay_pending->replace;
4417 if ( $cpp_done_err ) {
4418 my $e = "WARNING: $method declined but pending payment not resolved - ".
4419 "error updating status for paypendingnum ".
4420 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4422 $perror = "$e ($perror)";
4430 sub _bop_recurring_billing {
4431 my( $self, %opt ) = @_;
4433 my $method = $conf->config('credit_card-recurring_billing_flag');
4435 if ( $method eq 'transaction_is_recur' ) {
4437 return 1 if $opt{'trans_is_recur'};
4441 my %hash = ( 'custnum' => $self->custnum,
4446 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4447 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4458 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4460 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4461 via a Business::OnlinePayment realtime gateway. See
4462 L<http://420.am/business-onlinepayment> for supported gateways.
4464 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4466 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4468 Most gateways require a reference to an original payment transaction to refund,
4469 so you probably need to specify a I<paynum>.
4471 I<amount> defaults to the original amount of the payment if not specified.
4473 I<reason> specifies a reason for the refund.
4475 I<paydate> specifies the expiration date for a credit card overriding the
4476 value from the customer record or the payment record. Specified as yyyy-mm-dd
4478 Implementation note: If I<amount> is unspecified or equal to the amount of the
4479 orignal payment, first an attempt is made to "void" the transaction via
4480 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4481 the normal attempt is made to "refund" ("credit") the transaction via the
4482 gateway is attempted.
4484 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4485 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4486 #if set, will override the value from the customer record.
4488 #If an I<invnum> is specified, this payment (if successful) is applied to the
4489 #specified invoice. If you don't specify an I<invnum> you might want to
4490 #call the B<apply_payments> method.
4494 #some false laziness w/realtime_bop, not enough to make it worth merging
4495 #but some useful small subs should be pulled out
4496 sub realtime_refund_bop {
4499 return $self->_new_realtime_refund_bop(@_)
4500 if $self->_new_bop_required();
4502 my( $method, %options ) = @_;
4504 warn "$me realtime_refund_bop: $method refund\n";
4505 warn " $_ => $options{$_}\n" foreach keys %options;
4508 eval "use Business::OnlinePayment";
4512 # look up the original payment and optionally a gateway for that payment
4516 my $amount = $options{'amount'};
4518 my( $processor, $login, $password, @bop_options ) ;
4519 my( $auth, $order_number ) = ( '', '', '' );
4521 if ( $options{'paynum'} ) {
4523 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4524 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4525 or return "Unknown paynum $options{'paynum'}";
4526 $amount ||= $cust_pay->paid;
4528 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4529 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4530 $cust_pay->paybatch;
4531 my $gatewaynum = '';
4532 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4534 if ( $gatewaynum ) { #gateway for the payment to be refunded
4536 my $payment_gateway =
4537 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4538 die "payment gateway $gatewaynum not found"
4539 unless $payment_gateway;
4541 $processor = $payment_gateway->gateway_module;
4542 $login = $payment_gateway->gateway_username;
4543 $password = $payment_gateway->gateway_password;
4544 @bop_options = $payment_gateway->options;
4546 } else { #try the default gateway
4548 my( $conf_processor, $unused_action );
4549 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4550 $self->default_payment_gateway($method);
4552 return "processor of payment $options{'paynum'} $processor does not".
4553 " match default processor $conf_processor"
4554 unless $processor eq $conf_processor;
4559 } else { # didn't specify a paynum, so look for agent gateway overrides
4560 # like a normal transaction
4563 if ( $method eq 'CC' ) {
4564 $cardtype = cardtype($self->payinfo);
4565 } elsif ( $method eq 'ECHECK' ) {
4568 $cardtype = $method;
4571 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4572 cardtype => $cardtype,
4574 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4576 taxclass => '', } );
4578 if ( $override ) { #use a payment gateway override
4580 my $payment_gateway = $override->payment_gateway;
4582 $processor = $payment_gateway->gateway_module;
4583 $login = $payment_gateway->gateway_username;
4584 $password = $payment_gateway->gateway_password;
4585 #$action = $payment_gateway->gateway_action;
4586 @bop_options = $payment_gateway->options;
4588 } else { #use the standard settings from the config
4591 ( $processor, $login, $password, $unused_action, @bop_options ) =
4592 $self->default_payment_gateway($method);
4597 return "neither amount nor paynum specified" unless $amount;
4602 'password' => $password,
4603 'order_number' => $order_number,
4604 'amount' => $amount,
4605 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4607 $content{authorization} = $auth
4608 if length($auth); #echeck/ACH transactions have an order # but no auth
4609 #(at least with authorize.net)
4611 my $disable_void_after;
4612 if ($conf->exists('disable_void_after')
4613 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4614 $disable_void_after = $1;
4617 #first try void if applicable
4618 if ( $cust_pay && $cust_pay->paid == $amount
4620 ( not defined($disable_void_after) )
4621 || ( time < ($cust_pay->_date + $disable_void_after ) )
4624 warn " attempting void\n" if $DEBUG > 1;
4625 my $void = new Business::OnlinePayment( $processor, @bop_options );
4626 $void->content( 'action' => 'void', %content );
4628 if ( $void->is_success ) {
4629 my $error = $cust_pay->void($options{'reason'});
4631 # gah, even with transactions.
4632 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4633 "error voiding payment: $error";
4637 warn " void successful\n" if $DEBUG > 1;
4642 warn " void unsuccessful, trying refund\n"
4646 my $address = $self->address1;
4647 $address .= ", ". $self->address2 if $self->address2;
4649 my($payname, $payfirst, $paylast);
4650 if ( $self->payname && $method ne 'ECHECK' ) {
4651 $payname = $self->payname;
4652 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4653 or return "Illegal payname $payname";
4654 ($payfirst, $paylast) = ($1, $2);
4656 $payfirst = $self->getfield('first');
4657 $paylast = $self->getfield('last');
4658 $payname = "$payfirst $paylast";
4661 my @invoicing_list = $self->invoicing_list_emailonly;
4662 if ( $conf->exists('emailinvoiceautoalways')
4663 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4664 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4665 push @invoicing_list, $self->all_emails;
4668 my $email = ($conf->exists('business-onlinepayment-email-override'))
4669 ? $conf->config('business-onlinepayment-email-override')
4670 : $invoicing_list[0];
4672 my $payip = exists($options{'payip'})
4675 $content{customer_ip} = $payip
4679 if ( $method eq 'CC' ) {
4682 $content{card_number} = $payinfo = $cust_pay->payinfo;
4683 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4684 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4685 ($content{expiration} = "$2/$1"); # where available
4687 $content{card_number} = $payinfo = $self->payinfo;
4688 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4689 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4690 $content{expiration} = "$2/$1";
4693 } elsif ( $method eq 'ECHECK' ) {
4696 $payinfo = $cust_pay->payinfo;
4698 $payinfo = $self->payinfo;
4700 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4701 $content{bank_name} = $self->payname;
4702 $content{account_type} = 'CHECKING';
4703 $content{account_name} = $payname;
4704 $content{customer_org} = $self->company ? 'B' : 'I';
4705 $content{customer_ssn} = $self->ss;
4706 } elsif ( $method eq 'LEC' ) {
4707 $content{phone} = $payinfo = $self->payinfo;
4711 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4712 my %sub_content = $refund->content(
4713 'action' => 'credit',
4714 'customer_id' => $self->custnum,
4715 'last_name' => $paylast,
4716 'first_name' => $payfirst,
4718 'address' => $address,
4719 'city' => $self->city,
4720 'state' => $self->state,
4721 'zip' => $self->zip,
4722 'country' => $self->country,
4724 'phone' => $self->daytime || $self->night,
4727 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4731 return "$processor error: ". $refund->error_message
4732 unless $refund->is_success();
4734 my %method2payby = (
4740 my $paybatch = "$processor:". $refund->authorization;
4741 $paybatch .= ':'. $refund->order_number
4742 if $refund->can('order_number') && $refund->order_number;
4744 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4745 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4746 last unless @cust_bill_pay;
4747 my $cust_bill_pay = pop @cust_bill_pay;
4748 my $error = $cust_bill_pay->delete;
4752 my $cust_refund = new FS::cust_refund ( {
4753 'custnum' => $self->custnum,
4754 'paynum' => $options{'paynum'},
4755 'refund' => $amount,
4757 'payby' => $method2payby{$method},
4758 'payinfo' => $payinfo,
4759 'paybatch' => $paybatch,
4760 'reason' => $options{'reason'} || 'card or ACH refund',
4762 my $error = $cust_refund->insert;
4764 $cust_refund->paynum(''); #try again with no specific paynum
4765 my $error2 = $cust_refund->insert;
4767 # gah, even with transactions.
4768 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4769 "error inserting refund ($processor): $error2".
4770 " (previously tried insert with paynum #$options{'paynum'}" .
4781 # does the configuration indicate the new bop routines are required?
4783 sub _new_bop_required {
4786 my $botpp = 'Business::OnlineThirdPartyPayment';
4789 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4790 scalar( grep { $_->gateway_namespace eq $botpp }
4791 qsearch( 'payment_gateway', { 'disabled' => '' } )
4800 =item realtime_collect [ OPTION => VALUE ... ]
4802 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4803 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4804 gateway. See L<http://420.am/business-onlinepayment> and
4805 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4807 On failure returns an error message.
4809 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.
4811 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4813 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4814 then it is deduced from the customer record.
4816 If no I<amount> is specified, then the customer balance is used.
4818 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4819 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4820 if set, will override the value from the customer record.
4822 I<description> is a free-text field passed to the gateway. It defaults to
4823 "Internet services".
4825 If an I<invnum> is specified, this payment (if successful) is applied to the
4826 specified invoice. If you don't specify an I<invnum> you might want to
4827 call the B<apply_payments> method.
4829 I<quiet> can be set true to surpress email decline notices.
4831 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4832 resulting paynum, if any.
4834 I<payunique> is a unique identifier for this payment.
4836 I<session_id> is a session identifier associated with this payment.
4838 I<depend_jobnum> allows payment capture to unlock export jobs
4842 sub realtime_collect {
4843 my( $self, %options ) = @_;
4846 warn "$me realtime_collect:\n";
4847 warn " $_ => $options{$_}\n" foreach keys %options;
4850 $options{amount} = $self->balance unless exists( $options{amount} );
4851 $options{method} = FS::payby->payby2bop($self->payby)
4852 unless exists( $options{method} );
4854 return $self->realtime_bop({%options});
4858 =item _realtime_bop { [ ARG => VALUE ... ] }
4860 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4861 via a Business::OnlinePayment realtime gateway. See
4862 L<http://420.am/business-onlinepayment> for supported gateways.
4864 Required arguments in the hashref are I<method>, and I<amount>
4866 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4868 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4870 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4871 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4872 if set, will override the value from the customer record.
4874 I<description> is a free-text field passed to the gateway. It defaults to
4875 "Internet services".
4877 If an I<invnum> is specified, this payment (if successful) is applied to the
4878 specified invoice. If you don't specify an I<invnum> you might want to
4879 call the B<apply_payments> method.
4881 I<quiet> can be set true to surpress email decline notices.
4883 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4884 resulting paynum, if any.
4886 I<payunique> is a unique identifier for this payment.
4888 I<session_id> is a session identifier associated with this payment.
4890 I<depend_jobnum> allows payment capture to unlock export jobs
4892 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4896 # some helper routines
4897 sub _payment_gateway {
4898 my ($self, $options) = @_;
4900 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4901 unless exists($options->{payment_gateway});
4903 $options->{payment_gateway};
4907 my ($self, $options) = @_;
4910 'login' => $options->{payment_gateway}->gateway_username,
4911 'password' => $options->{payment_gateway}->gateway_password,
4916 my ($self, $options) = @_;
4918 $options->{payment_gateway}->gatewaynum
4919 ? $options->{payment_gateway}->options
4920 : @{ $options->{payment_gateway}->get('options') };
4924 my ($self, $options) = @_;
4926 $options->{description} ||= 'Internet services';
4927 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4928 $options->{invnum} ||= '';
4929 $options->{payname} = $self->payname unless exists( $options->{payname} );
4933 my ($self, $options) = @_;
4936 $content{address} = exists($options->{'address1'})
4937 ? $options->{'address1'}
4939 my $address2 = exists($options->{'address2'})
4940 ? $options->{'address2'}
4942 $content{address} .= ", ". $address2 if length($address2);
4944 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4945 $content{customer_ip} = $payip if length($payip);
4947 $content{invoice_number} = $options->{'invnum'}
4948 if exists($options->{'invnum'}) && length($options->{'invnum'});
4950 $content{email_customer} =
4951 ( $conf->exists('business-onlinepayment-email_customer')
4952 || $conf->exists('business-onlinepayment-email-override') );
4954 $content{payfirst} = $self->getfield('first');
4955 $content{paylast} = $self->getfield('last');
4957 $content{account_name} = "$content{payfirst} $content{paylast}"
4958 if $options->{method} eq 'ECHECK';
4960 $content{name} = $options->{payname};
4961 $content{name} = $content{account_name} if exists($content{account_name});
4963 $content{city} = exists($options->{city})
4966 $content{state} = exists($options->{state})
4969 $content{zip} = exists($options->{zip})
4972 $content{country} = exists($options->{country})
4973 ? $options->{country}
4975 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4976 $content{phone} = $self->daytime || $self->night;
4981 my %bop_method2payby = (
4987 sub _new_realtime_bop {
4991 if (ref($_[0]) eq 'HASH') {
4992 %options = %{$_[0]};
4994 my ( $method, $amount ) = ( shift, shift );
4996 $options{method} = $method;
4997 $options{amount} = $amount;
5001 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5002 warn " $_ => $options{$_}\n" foreach keys %options;
5005 return $self->fake_bop(%options) if $options{'fake'};
5007 $self->_bop_defaults(\%options);
5010 # set trans_is_recur based on invnum if there is one
5013 my $trans_is_recur = 0;
5014 if ( $options{'invnum'} ) {
5016 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5017 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5020 map { $_->part_pkg }
5022 map { $_->cust_pkg }
5023 $cust_bill->cust_bill_pkg;
5026 if grep { $_->freq ne '0' } @part_pkg;
5034 my $payment_gateway = $self->_payment_gateway( \%options );
5035 my $namespace = $payment_gateway->gateway_namespace;
5037 eval "use $namespace";
5041 # check for banned credit card/ACH
5044 my $ban = qsearchs('banned_pay', {
5045 'payby' => $bop_method2payby{$options{method}},
5046 'payinfo' => md5_base64($options{payinfo}),
5048 return "Banned credit card" if $ban;
5054 my (%bop_content) = $self->_bop_content(\%options);
5056 if ( $options{method} ne 'ECHECK' ) {
5057 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5058 or return "Illegal payname $options{payname}";
5059 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5062 my @invoicing_list = $self->invoicing_list_emailonly;
5063 if ( $conf->exists('emailinvoiceautoalways')
5064 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5065 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5066 push @invoicing_list, $self->all_emails;
5069 my $email = ($conf->exists('business-onlinepayment-email-override'))
5070 ? $conf->config('business-onlinepayment-email-override')
5071 : $invoicing_list[0];
5075 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5077 $content{card_number} = $options{payinfo};
5078 $paydate = exists($options{'paydate'})
5079 ? $options{'paydate'}
5081 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5082 $content{expiration} = "$2/$1";
5084 my $paycvv = exists($options{'paycvv'})
5085 ? $options{'paycvv'}
5087 $content{cvv2} = $paycvv
5090 my $paystart_month = exists($options{'paystart_month'})
5091 ? $options{'paystart_month'}
5092 : $self->paystart_month;
5094 my $paystart_year = exists($options{'paystart_year'})
5095 ? $options{'paystart_year'}
5096 : $self->paystart_year;
5098 $content{card_start} = "$paystart_month/$paystart_year"
5099 if $paystart_month && $paystart_year;
5101 my $payissue = exists($options{'payissue'})
5102 ? $options{'payissue'}
5104 $content{issue_number} = $payissue if $payissue;
5106 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5107 'trans_is_recur' => $trans_is_recur,
5111 $content{recurring_billing} = 'YES';
5112 $content{acct_code} = 'rebill'
5113 if $conf->exists('credit_card-recurring_billing_acct_code');
5116 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5117 ( $content{account_number}, $content{routing_code} ) =
5118 split('@', $options{payinfo});
5119 $content{bank_name} = $options{payname};
5120 $content{bank_state} = exists($options{'paystate'})
5121 ? $options{'paystate'}
5122 : $self->getfield('paystate');
5123 $content{account_type} = exists($options{'paytype'})
5124 ? uc($options{'paytype'}) || 'CHECKING'
5125 : uc($self->getfield('paytype')) || 'CHECKING';
5126 $content{customer_org} = $self->company ? 'B' : 'I';
5127 $content{state_id} = exists($options{'stateid'})
5128 ? $options{'stateid'}
5129 : $self->getfield('stateid');
5130 $content{state_id_state} = exists($options{'stateid_state'})
5131 ? $options{'stateid_state'}
5132 : $self->getfield('stateid_state');
5133 $content{customer_ssn} = exists($options{'ss'})
5136 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5137 $content{phone} = $options{payinfo};
5138 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5145 # run transaction(s)
5148 my $balance = exists( $options{'balance'} )
5149 ? $options{'balance'}
5152 $self->select_for_update; #mutex ... just until we get our pending record in
5154 #the checks here are intended to catch concurrent payments
5155 #double-form-submission prevention is taken care of in cust_pay_pending::check
5158 return "The customer's balance has changed; $options{method} transaction aborted."
5159 if $self->balance < $balance;
5160 #&& $self->balance < $options{amount}; #might as well anyway?
5162 #also check and make sure there aren't *other* pending payments for this cust
5164 my @pending = qsearch('cust_pay_pending', {
5165 'custnum' => $self->custnum,
5166 'status' => { op=>'!=', value=>'done' }
5168 return "A payment is already being processed for this customer (".
5169 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5170 "); $options{method} transaction aborted."
5171 if scalar(@pending);
5173 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5175 my $cust_pay_pending = new FS::cust_pay_pending {
5176 'custnum' => $self->custnum,
5177 #'invnum' => $options{'invnum'},
5178 'paid' => $options{amount},
5180 'payby' => $bop_method2payby{$options{method}},
5181 'payinfo' => $options{payinfo},
5182 'paydate' => $paydate,
5183 'recurring_billing' => $content{recurring_billing},
5184 'pkgnum' => $options{'pkgnum'},
5186 'gatewaynum' => $payment_gateway->gatewaynum || '',
5187 'session_id' => $options{session_id} || '',
5188 'jobnum' => $options{depend_jobnum} || '',
5190 $cust_pay_pending->payunique( $options{payunique} )
5191 if defined($options{payunique}) && length($options{payunique});
5192 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5193 return $cpp_new_err if $cpp_new_err;
5195 my( $action1, $action2 ) =
5196 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5198 my $transaction = new $namespace( $payment_gateway->gateway_module,
5199 $self->_bop_options(\%options),
5202 $transaction->content(
5203 'type' => $options{method},
5204 $self->_bop_auth(\%options),
5205 'action' => $action1,
5206 'description' => $options{'description'},
5207 'amount' => $options{amount},
5208 #'invoice_number' => $options{'invnum'},
5209 'customer_id' => $self->custnum,
5211 'reference' => $cust_pay_pending->paypendingnum, #for now
5216 $cust_pay_pending->status('pending');
5217 my $cpp_pending_err = $cust_pay_pending->replace;
5218 return $cpp_pending_err if $cpp_pending_err;
5221 my $BOP_TESTING = 0;
5222 my $BOP_TESTING_SUCCESS = 1;
5224 unless ( $BOP_TESTING ) {
5225 $transaction->submit();
5227 if ( $BOP_TESTING_SUCCESS ) {
5228 $transaction->is_success(1);
5229 $transaction->authorization('fake auth');
5231 $transaction->is_success(0);
5232 $transaction->error_message('fake failure');
5236 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5238 return { reference => $cust_pay_pending->paypendingnum,
5239 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5241 } elsif ( $transaction->is_success() && $action2 ) {
5243 $cust_pay_pending->status('authorized');
5244 my $cpp_authorized_err = $cust_pay_pending->replace;
5245 return $cpp_authorized_err if $cpp_authorized_err;
5247 my $auth = $transaction->authorization;
5248 my $ordernum = $transaction->can('order_number')
5249 ? $transaction->order_number
5253 new Business::OnlinePayment( $payment_gateway->gateway_module,
5254 $self->_bop_options(\%options),
5259 type => $options{method},
5261 $self->_bop_auth(\%options),
5262 order_number => $ordernum,
5263 amount => $options{amount},
5264 authorization => $auth,
5265 description => $options{'description'},
5268 foreach my $field (qw( authorization_source_code returned_ACI
5269 transaction_identifier validation_code
5270 transaction_sequence_num local_transaction_date
5271 local_transaction_time AVS_result_code )) {
5272 $capture{$field} = $transaction->$field() if $transaction->can($field);
5275 $capture->content( %capture );
5279 unless ( $capture->is_success ) {
5280 my $e = "Authorization successful but capture failed, custnum #".
5281 $self->custnum. ': '. $capture->result_code.
5282 ": ". $capture->error_message;
5290 # remove paycvv after initial transaction
5293 #false laziness w/misc/process/payment.cgi - check both to make sure working
5295 if ( defined $self->dbdef_table->column('paycvv')
5296 && length($self->paycvv)
5297 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5299 my $error = $self->remove_cvv;
5301 warn "WARNING: error removing cvv: $error\n";
5309 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5321 if (ref($_[0]) eq 'HASH') {
5322 %options = %{$_[0]};
5324 my ( $method, $amount ) = ( shift, shift );
5326 $options{method} = $method;
5327 $options{amount} = $amount;
5330 if ( $options{'fake_failure'} ) {
5331 return "Error: No error; test failure requested with fake_failure";
5335 #if ( $payment_gateway->gatewaynum ) { # agent override
5336 # $paybatch = $payment_gateway->gatewaynum. '-';
5339 #$paybatch .= "$processor:". $transaction->authorization;
5341 #$paybatch .= ':'. $transaction->order_number
5342 # if $transaction->can('order_number')
5343 # && length($transaction->order_number);
5345 my $paybatch = 'FakeProcessor:54:32';
5347 my $cust_pay = new FS::cust_pay ( {
5348 'custnum' => $self->custnum,
5349 'invnum' => $options{'invnum'},
5350 'paid' => $options{amount},
5352 'payby' => $bop_method2payby{$options{method}},
5353 #'payinfo' => $payinfo,
5354 'payinfo' => '4111111111111111',
5355 'paybatch' => $paybatch,
5356 #'paydate' => $paydate,
5357 'paydate' => '2012-05-01',
5359 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5361 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5364 $cust_pay->invnum(''); #try again with no specific invnum
5365 my $error2 = $cust_pay->insert( $options{'manual'} ?
5366 ( 'manual' => 1 ) : ()
5369 # gah, even with transactions.
5370 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5371 "error inserting (fake!) payment: $error2".
5372 " (previously tried insert with invnum #$options{'invnum'}" .
5379 if ( $options{'paynum_ref'} ) {
5380 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5383 return ''; #no error
5388 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5390 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5391 # phone bill transaction.
5393 sub _realtime_bop_result {
5394 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5396 warn "$me _realtime_bop_result: pending transaction ".
5397 $cust_pay_pending->paypendingnum. "\n";
5398 warn " $_ => $options{$_}\n" foreach keys %options;
5401 my $payment_gateway = $options{payment_gateway}
5402 or return "no payment gateway in arguments to _realtime_bop_result";
5404 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5405 my $cpp_captured_err = $cust_pay_pending->replace;
5406 return $cpp_captured_err if $cpp_captured_err;
5408 if ( $transaction->is_success() ) {
5411 if ( $payment_gateway->gatewaynum ) { # agent override
5412 $paybatch = $payment_gateway->gatewaynum. '-';
5415 $paybatch .= $payment_gateway->gateway_module. ":".
5416 $transaction->authorization;
5418 $paybatch .= ':'. $transaction->order_number
5419 if $transaction->can('order_number')
5420 && length($transaction->order_number);
5422 my $cust_pay = new FS::cust_pay ( {
5423 'custnum' => $self->custnum,
5424 'invnum' => $options{'invnum'},
5425 'paid' => $cust_pay_pending->paid,
5427 'payby' => $cust_pay_pending->payby,
5428 #'payinfo' => $payinfo,
5429 'paybatch' => $paybatch,
5430 'paydate' => $cust_pay_pending->paydate,
5431 'pkgnum' => $cust_pay_pending->pkgnum,
5433 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5434 $cust_pay->payunique( $options{payunique} )
5435 if defined($options{payunique}) && length($options{payunique});
5437 my $oldAutoCommit = $FS::UID::AutoCommit;
5438 local $FS::UID::AutoCommit = 0;
5441 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5443 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5446 $cust_pay->invnum(''); #try again with no specific invnum
5447 my $error2 = $cust_pay->insert( $options{'manual'} ?
5448 ( 'manual' => 1 ) : ()
5451 # gah. but at least we have a record of the state we had to abort in
5452 # from cust_pay_pending now.
5453 my $e = "WARNING: $options{method} captured but payment not recorded -".
5454 " error inserting payment (". $payment_gateway->gateway_module.
5456 " (previously tried insert with invnum #$options{'invnum'}" .
5457 ": $error ) - pending payment saved as paypendingnum ".
5458 $cust_pay_pending->paypendingnum. "\n";
5464 my $jobnum = $cust_pay_pending->jobnum;
5466 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5468 unless ( $placeholder ) {
5469 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5470 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5471 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5476 $error = $placeholder->delete;
5479 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5480 my $e = "WARNING: $options{method} captured but could not delete ".
5481 "job $jobnum for paypendingnum ".
5482 $cust_pay_pending->paypendingnum. ": $error\n";
5489 if ( $options{'paynum_ref'} ) {
5490 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5493 $cust_pay_pending->status('done');
5494 $cust_pay_pending->statustext('captured');
5495 $cust_pay_pending->paynum($cust_pay->paynum);
5496 my $cpp_done_err = $cust_pay_pending->replace;
5498 if ( $cpp_done_err ) {
5500 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5501 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5502 "error updating status for paypendingnum ".
5503 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5509 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5510 return ''; #no error
5516 my $perror = $payment_gateway->gateway_module. " error: ".
5517 $transaction->error_message;
5519 my $jobnum = $cust_pay_pending->jobnum;
5521 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5523 if ( $placeholder ) {
5524 my $error = $placeholder->depended_delete;
5525 $error ||= $placeholder->delete;
5526 warn "error removing provisioning jobs after declined paypendingnum ".
5527 $cust_pay_pending->paypendingnum. "\n";
5529 my $e = "error finding job $jobnum for declined paypendingnum ".
5530 $cust_pay_pending->paypendingnum. "\n";
5536 unless ( $transaction->error_message ) {
5539 if ( $transaction->can('response_page') ) {
5541 'page' => ( $transaction->can('response_page')
5542 ? $transaction->response_page
5545 'code' => ( $transaction->can('response_code')
5546 ? $transaction->response_code
5549 'headers' => ( $transaction->can('response_headers')
5550 ? $transaction->response_headers
5556 "No additional debugging information available for ".
5557 $payment_gateway->gateway_module;
5560 $perror .= "No error_message returned from ".
5561 $payment_gateway->gateway_module. " -- ".
5562 ( ref($t_response) ? Dumper($t_response) : $t_response );
5566 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5567 && $conf->exists('emaildecline')
5568 && grep { $_ ne 'POST' } $self->invoicing_list
5569 && ! grep { $transaction->error_message =~ /$_/ }
5570 $conf->config('emaildecline-exclude')
5572 my @templ = $conf->config('declinetemplate');
5573 my $template = new Text::Template (
5575 SOURCE => [ map "$_\n", @templ ],
5576 ) or return "($perror) can't create template: $Text::Template::ERROR";
5577 $template->compile()
5578 or return "($perror) can't compile template: $Text::Template::ERROR";
5582 scalar( $conf->config('company_name', $self->agentnum ) ),
5583 'company_address' =>
5584 join("\n", $conf->config('company_address', $self->agentnum ) ),
5585 'error' => $transaction->error_message,
5588 my $error = send_email(
5589 'from' => $conf->config('invoice_from', $self->agentnum ),
5590 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5591 'subject' => 'Your payment could not be processed',
5592 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5595 $perror .= " (also received error sending decline notification: $error)"
5600 $cust_pay_pending->status('done');
5601 $cust_pay_pending->statustext("declined: $perror");
5602 my $cpp_done_err = $cust_pay_pending->replace;
5603 if ( $cpp_done_err ) {
5604 my $e = "WARNING: $options{method} declined but pending payment not ".
5605 "resolved - error updating status for paypendingnum ".
5606 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5608 $perror = "$e ($perror)";
5616 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5618 Verifies successful third party processing of a realtime credit card,
5619 ACH (electronic check) or phone bill transaction via a
5620 Business::OnlineThirdPartyPayment realtime gateway. See
5621 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5623 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5625 The additional options I<payname>, I<city>, I<state>,
5626 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5627 if set, will override the value from the customer record.
5629 I<description> is a free-text field passed to the gateway. It defaults to
5630 "Internet services".
5632 If an I<invnum> is specified, this payment (if successful) is applied to the
5633 specified invoice. If you don't specify an I<invnum> you might want to
5634 call the B<apply_payments> method.
5636 I<quiet> can be set true to surpress email decline notices.
5638 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5639 resulting paynum, if any.
5641 I<payunique> is a unique identifier for this payment.
5643 Returns a hashref containing elements bill_error (which will be undefined
5644 upon success) and session_id of any associated session.
5648 sub realtime_botpp_capture {
5649 my( $self, $cust_pay_pending, %options ) = @_;
5651 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5652 warn " $_ => $options{$_}\n" foreach keys %options;
5655 eval "use Business::OnlineThirdPartyPayment";
5659 # select the gateway
5662 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5664 my $payment_gateway = $cust_pay_pending->gatewaynum
5665 ? qsearchs( 'payment_gateway',
5666 { gatewaynum => $cust_pay_pending->gatewaynum }
5668 : $self->agent->payment_gateway( 'method' => $method,
5669 # 'invnum' => $cust_pay_pending->invnum,
5670 # 'payinfo' => $cust_pay_pending->payinfo,
5673 $options{payment_gateway} = $payment_gateway; # for the helper subs
5679 my @invoicing_list = $self->invoicing_list_emailonly;
5680 if ( $conf->exists('emailinvoiceautoalways')
5681 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5682 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5683 push @invoicing_list, $self->all_emails;
5686 my $email = ($conf->exists('business-onlinepayment-email-override'))
5687 ? $conf->config('business-onlinepayment-email-override')
5688 : $invoicing_list[0];
5692 $content{email_customer} =
5693 ( $conf->exists('business-onlinepayment-email_customer')
5694 || $conf->exists('business-onlinepayment-email-override') );
5697 # run transaction(s)
5701 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5702 $self->_bop_options(\%options),
5705 $transaction->reference({ %options });
5707 $transaction->content(
5709 $self->_bop_auth(\%options),
5710 'action' => 'Post Authorization',
5711 'description' => $options{'description'},
5712 'amount' => $cust_pay_pending->paid,
5713 #'invoice_number' => $options{'invnum'},
5714 'customer_id' => $self->custnum,
5715 'referer' => 'http://cleanwhisker.420.am/',
5716 'reference' => $cust_pay_pending->paypendingnum,
5718 'phone' => $self->daytime || $self->night,
5720 # plus whatever is required for bogus capture avoidance
5723 $transaction->submit();
5726 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5729 bill_error => $error,
5730 session_id => $cust_pay_pending->session_id,
5735 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5739 sub default_payment_gateway {
5740 my( $self, $method ) = @_;
5742 die "Real-time processing not enabled\n"
5743 unless $conf->exists('business-onlinepayment');
5745 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5748 my $bop_config = 'business-onlinepayment';
5749 $bop_config .= '-ach'
5750 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5751 my ( $processor, $login, $password, $action, @bop_options ) =
5752 $conf->config($bop_config);
5753 $action ||= 'normal authorization';
5754 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5755 die "No real-time processor is enabled - ".
5756 "did you set the business-onlinepayment configuration value?\n"
5759 ( $processor, $login, $password, $action, @bop_options )
5764 Removes the I<paycvv> field from the database directly.
5766 If there is an error, returns the error, otherwise returns false.
5772 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5773 or return dbh->errstr;
5774 $sth->execute($self->custnum)
5775 or return $sth->errstr;
5780 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5782 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5783 via a Business::OnlinePayment realtime gateway. See
5784 L<http://420.am/business-onlinepayment> for supported gateways.
5786 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5788 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5790 Most gateways require a reference to an original payment transaction to refund,
5791 so you probably need to specify a I<paynum>.
5793 I<amount> defaults to the original amount of the payment if not specified.
5795 I<reason> specifies a reason for the refund.
5797 I<paydate> specifies the expiration date for a credit card overriding the
5798 value from the customer record or the payment record. Specified as yyyy-mm-dd
5800 Implementation note: If I<amount> is unspecified or equal to the amount of the
5801 orignal payment, first an attempt is made to "void" the transaction via
5802 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5803 the normal attempt is made to "refund" ("credit") the transaction via the
5804 gateway is attempted.
5806 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5807 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5808 #if set, will override the value from the customer record.
5810 #If an I<invnum> is specified, this payment (if successful) is applied to the
5811 #specified invoice. If you don't specify an I<invnum> you might want to
5812 #call the B<apply_payments> method.
5816 #some false laziness w/realtime_bop, not enough to make it worth merging
5817 #but some useful small subs should be pulled out
5818 sub _new_realtime_refund_bop {
5822 if (ref($_[0]) ne 'HASH') {
5823 %options = %{$_[0]};
5827 $options{method} = $method;
5831 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5832 warn " $_ => $options{$_}\n" foreach keys %options;
5836 # look up the original payment and optionally a gateway for that payment
5840 my $amount = $options{'amount'};
5842 my( $processor, $login, $password, @bop_options, $namespace ) ;
5843 my( $auth, $order_number ) = ( '', '', '' );
5845 if ( $options{'paynum'} ) {
5847 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5848 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5849 or return "Unknown paynum $options{'paynum'}";
5850 $amount ||= $cust_pay->paid;
5852 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5853 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5854 $cust_pay->paybatch;
5855 my $gatewaynum = '';
5856 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5858 if ( $gatewaynum ) { #gateway for the payment to be refunded
5860 my $payment_gateway =
5861 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5862 die "payment gateway $gatewaynum not found"
5863 unless $payment_gateway;
5865 $processor = $payment_gateway->gateway_module;
5866 $login = $payment_gateway->gateway_username;
5867 $password = $payment_gateway->gateway_password;
5868 $namespace = $payment_gateway->gateway_namespace;
5869 @bop_options = $payment_gateway->options;
5871 } else { #try the default gateway
5874 my $payment_gateway =
5875 $self->agent->payment_gateway('method' => $options{method});
5877 ( $conf_processor, $login, $password, $namespace ) =
5878 map { my $method = "gateway_$_"; $payment_gateway->$method }
5879 qw( module username password namespace );
5881 @bop_options = $payment_gateway->gatewaynum
5882 ? $payment_gateway->options
5883 : @{ $payment_gateway->get('options') };
5885 return "processor of payment $options{'paynum'} $processor does not".
5886 " match default processor $conf_processor"
5887 unless $processor eq $conf_processor;
5892 } else { # didn't specify a paynum, so look for agent gateway overrides
5893 # like a normal transaction
5895 my $payment_gateway =
5896 $self->agent->payment_gateway( 'method' => $options{method},
5897 #'payinfo' => $payinfo,
5899 my( $processor, $login, $password, $namespace ) =
5900 map { my $method = "gateway_$_"; $payment_gateway->$method }
5901 qw( module username password namespace );
5903 my @bop_options = $payment_gateway->gatewaynum
5904 ? $payment_gateway->options
5905 : @{ $payment_gateway->get('options') };
5908 return "neither amount nor paynum specified" unless $amount;
5910 eval "use $namespace";
5914 'type' => $options{method},
5916 'password' => $password,
5917 'order_number' => $order_number,
5918 'amount' => $amount,
5919 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5921 $content{authorization} = $auth
5922 if length($auth); #echeck/ACH transactions have an order # but no auth
5923 #(at least with authorize.net)
5925 my $disable_void_after;
5926 if ($conf->exists('disable_void_after')
5927 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5928 $disable_void_after = $1;
5931 #first try void if applicable
5932 if ( $cust_pay && $cust_pay->paid == $amount
5934 ( not defined($disable_void_after) )
5935 || ( time < ($cust_pay->_date + $disable_void_after ) )
5938 warn " attempting void\n" if $DEBUG > 1;
5939 my $void = new Business::OnlinePayment( $processor, @bop_options );
5940 $void->content( 'action' => 'void', %content );
5942 if ( $void->is_success ) {
5943 my $error = $cust_pay->void($options{'reason'});
5945 # gah, even with transactions.
5946 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5947 "error voiding payment: $error";
5951 warn " void successful\n" if $DEBUG > 1;
5956 warn " void unsuccessful, trying refund\n"
5960 my $address = $self->address1;
5961 $address .= ", ". $self->address2 if $self->address2;
5963 my($payname, $payfirst, $paylast);
5964 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5965 $payname = $self->payname;
5966 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5967 or return "Illegal payname $payname";
5968 ($payfirst, $paylast) = ($1, $2);
5970 $payfirst = $self->getfield('first');
5971 $paylast = $self->getfield('last');
5972 $payname = "$payfirst $paylast";
5975 my @invoicing_list = $self->invoicing_list_emailonly;
5976 if ( $conf->exists('emailinvoiceautoalways')
5977 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5978 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5979 push @invoicing_list, $self->all_emails;
5982 my $email = ($conf->exists('business-onlinepayment-email-override'))
5983 ? $conf->config('business-onlinepayment-email-override')
5984 : $invoicing_list[0];
5986 my $payip = exists($options{'payip'})
5989 $content{customer_ip} = $payip
5993 if ( $options{method} eq 'CC' ) {
5996 $content{card_number} = $payinfo = $cust_pay->payinfo;
5997 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5998 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5999 ($content{expiration} = "$2/$1"); # where available
6001 $content{card_number} = $payinfo = $self->payinfo;
6002 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6003 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6004 $content{expiration} = "$2/$1";
6007 } elsif ( $options{method} eq 'ECHECK' ) {
6010 $payinfo = $cust_pay->payinfo;
6012 $payinfo = $self->payinfo;
6014 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6015 $content{bank_name} = $self->payname;
6016 $content{account_type} = 'CHECKING';
6017 $content{account_name} = $payname;
6018 $content{customer_org} = $self->company ? 'B' : 'I';
6019 $content{customer_ssn} = $self->ss;
6020 } elsif ( $options{method} eq 'LEC' ) {
6021 $content{phone} = $payinfo = $self->payinfo;
6025 my $refund = new Business::OnlinePayment( $processor, @bop_options );
6026 my %sub_content = $refund->content(
6027 'action' => 'credit',
6028 'customer_id' => $self->custnum,
6029 'last_name' => $paylast,
6030 'first_name' => $payfirst,
6032 'address' => $address,
6033 'city' => $self->city,
6034 'state' => $self->state,
6035 'zip' => $self->zip,
6036 'country' => $self->country,
6038 'phone' => $self->daytime || $self->night,
6041 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
6045 return "$processor error: ". $refund->error_message
6046 unless $refund->is_success();
6048 my $paybatch = "$processor:". $refund->authorization;
6049 $paybatch .= ':'. $refund->order_number
6050 if $refund->can('order_number') && $refund->order_number;
6052 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6053 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6054 last unless @cust_bill_pay;
6055 my $cust_bill_pay = pop @cust_bill_pay;
6056 my $error = $cust_bill_pay->delete;
6060 my $cust_refund = new FS::cust_refund ( {
6061 'custnum' => $self->custnum,
6062 'paynum' => $options{'paynum'},
6063 'refund' => $amount,
6065 'payby' => $bop_method2payby{$options{method}},
6066 'payinfo' => $payinfo,
6067 'paybatch' => $paybatch,
6068 'reason' => $options{'reason'} || 'card or ACH refund',
6070 my $error = $cust_refund->insert;
6072 $cust_refund->paynum(''); #try again with no specific paynum
6073 my $error2 = $cust_refund->insert;
6075 # gah, even with transactions.
6076 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6077 "error inserting refund ($processor): $error2".
6078 " (previously tried insert with paynum #$options{'paynum'}" .
6089 =item batch_card OPTION => VALUE...
6091 Adds a payment for this invoice to the pending credit card batch (see
6092 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6093 runs the payment using a realtime gateway.
6098 my ($self, %options) = @_;
6101 if (exists($options{amount})) {
6102 $amount = $options{amount};
6104 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6106 return '' unless $amount > 0;
6108 my $invnum = delete $options{invnum};
6109 my $payby = $options{invnum} || $self->payby; #dubious
6111 if ($options{'realtime'}) {
6112 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6118 my $oldAutoCommit = $FS::UID::AutoCommit;
6119 local $FS::UID::AutoCommit = 0;
6122 #this needs to handle mysql as well as Pg, like svc_acct.pm
6123 #(make it into a common function if folks need to do batching with mysql)
6124 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6125 or return "Cannot lock pay_batch: " . $dbh->errstr;
6129 'payby' => FS::payby->payby2payment($payby),
6132 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6134 unless ( $pay_batch ) {
6135 $pay_batch = new FS::pay_batch \%pay_batch;
6136 my $error = $pay_batch->insert;
6138 $dbh->rollback if $oldAutoCommit;
6139 die "error creating new batch: $error\n";
6143 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6144 'batchnum' => $pay_batch->batchnum,
6145 'custnum' => $self->custnum,
6148 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6150 $options{$_} = '' unless exists($options{$_});
6153 my $cust_pay_batch = new FS::cust_pay_batch ( {
6154 'batchnum' => $pay_batch->batchnum,
6155 'invnum' => $invnum || 0, # is there a better value?
6156 # this field should be
6158 # cust_bill_pay_batch now
6159 'custnum' => $self->custnum,
6160 'last' => $self->getfield('last'),
6161 'first' => $self->getfield('first'),
6162 'address1' => $options{address1} || $self->address1,
6163 'address2' => $options{address2} || $self->address2,
6164 'city' => $options{city} || $self->city,
6165 'state' => $options{state} || $self->state,
6166 'zip' => $options{zip} || $self->zip,
6167 'country' => $options{country} || $self->country,
6168 'payby' => $options{payby} || $self->payby,
6169 'payinfo' => $options{payinfo} || $self->payinfo,
6170 'exp' => $options{paydate} || $self->paydate,
6171 'payname' => $options{payname} || $self->payname,
6172 'amount' => $amount, # consolidating
6175 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6176 if $old_cust_pay_batch;
6179 if ($old_cust_pay_batch) {
6180 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6182 $error = $cust_pay_batch->insert;
6186 $dbh->rollback if $oldAutoCommit;
6190 my $unapplied = $self->total_unapplied_credits
6191 + $self->total_unapplied_payments
6192 + $self->in_transit_payments;
6193 foreach my $cust_bill ($self->open_cust_bill) {
6194 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6195 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6196 'invnum' => $cust_bill->invnum,
6197 'paybatchnum' => $cust_pay_batch->paybatchnum,
6198 'amount' => $cust_bill->owed,
6201 if ($unapplied >= $cust_bill_pay_batch->amount){
6202 $unapplied -= $cust_bill_pay_batch->amount;
6205 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6206 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6208 $error = $cust_bill_pay_batch->insert;
6210 $dbh->rollback if $oldAutoCommit;
6215 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6219 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6221 Applies unapplied payments and credits.
6223 In most cases, this new method should be used in place of sequential
6224 apply_payments and apply_credits methods.
6226 A hash of optional arguments may be passed. Currently "manual" is supported.
6227 If true, a payment receipt is sent instead of a statement when
6228 'payment_receipt_email' configuration option is set.
6230 If there is an error, returns the error, otherwise returns false.
6234 sub apply_payments_and_credits {
6235 my( $self, %options ) = @_;
6237 local $SIG{HUP} = 'IGNORE';
6238 local $SIG{INT} = 'IGNORE';
6239 local $SIG{QUIT} = 'IGNORE';
6240 local $SIG{TERM} = 'IGNORE';
6241 local $SIG{TSTP} = 'IGNORE';
6242 local $SIG{PIPE} = 'IGNORE';
6244 my $oldAutoCommit = $FS::UID::AutoCommit;
6245 local $FS::UID::AutoCommit = 0;
6248 $self->select_for_update; #mutex
6250 foreach my $cust_bill ( $self->open_cust_bill ) {
6251 my $error = $cust_bill->apply_payments_and_credits(%options);
6253 $dbh->rollback if $oldAutoCommit;
6254 return "Error applying: $error";
6258 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6263 =item apply_credits OPTION => VALUE ...
6265 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6266 to outstanding invoice balances in chronological order (or reverse
6267 chronological order if the I<order> option is set to B<newest>) and returns the
6268 value of any remaining unapplied credits available for refund (see
6269 L<FS::cust_refund>).
6271 Dies if there is an error.
6279 local $SIG{HUP} = 'IGNORE';
6280 local $SIG{INT} = 'IGNORE';
6281 local $SIG{QUIT} = 'IGNORE';
6282 local $SIG{TERM} = 'IGNORE';
6283 local $SIG{TSTP} = 'IGNORE';
6284 local $SIG{PIPE} = 'IGNORE';
6286 my $oldAutoCommit = $FS::UID::AutoCommit;
6287 local $FS::UID::AutoCommit = 0;
6290 $self->select_for_update; #mutex
6292 unless ( $self->total_unapplied_credits ) {
6293 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6297 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6298 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6300 my @invoices = $self->open_cust_bill;
6301 @invoices = sort { $b->_date <=> $a->_date } @invoices
6302 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6304 if ( $conf->exists('pkg-balances') ) {
6305 # limit @credits to those w/ a pkgnum grepped from $self
6307 foreach my $i (@invoices) {
6308 foreach my $li ( $i->cust_bill_pkg ) {
6309 $pkgnums{$li->pkgnum} = 1;
6312 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6317 foreach my $cust_bill ( @invoices ) {
6319 if ( !defined($credit) || $credit->credited == 0) {
6320 $credit = pop @credits or last;
6324 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6325 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6327 $owed = $cust_bill->owed;
6329 unless ( $owed > 0 ) {
6330 push @credits, $credit;
6334 my $amount = min( $credit->credited, $owed );
6336 my $cust_credit_bill = new FS::cust_credit_bill ( {
6337 'crednum' => $credit->crednum,
6338 'invnum' => $cust_bill->invnum,
6339 'amount' => $amount,
6341 $cust_credit_bill->pkgnum( $credit->pkgnum )
6342 if $conf->exists('pkg-balances') && $credit->pkgnum;
6343 my $error = $cust_credit_bill->insert;
6345 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6349 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6353 my $total_unapplied_credits = $self->total_unapplied_credits;
6355 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6357 return $total_unapplied_credits;
6360 =item apply_payments [ OPTION => VALUE ... ]
6362 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6363 to outstanding invoice balances in chronological order.
6365 #and returns the value of any remaining unapplied payments.
6367 A hash of optional arguments may be passed. Currently "manual" is supported.
6368 If true, a payment receipt is sent instead of a statement when
6369 'payment_receipt_email' configuration option is set.
6372 Dies if there is an error.
6376 sub apply_payments {
6377 my( $self, %options ) = @_;
6379 local $SIG{HUP} = 'IGNORE';
6380 local $SIG{INT} = 'IGNORE';
6381 local $SIG{QUIT} = 'IGNORE';
6382 local $SIG{TERM} = 'IGNORE';
6383 local $SIG{TSTP} = 'IGNORE';
6384 local $SIG{PIPE} = 'IGNORE';
6386 my $oldAutoCommit = $FS::UID::AutoCommit;
6387 local $FS::UID::AutoCommit = 0;
6390 $self->select_for_update; #mutex
6394 my @payments = sort { $b->_date <=> $a->_date }
6395 grep { $_->unapplied > 0 }
6398 my @invoices = sort { $a->_date <=> $b->_date}
6399 grep { $_->owed > 0 }
6402 if ( $conf->exists('pkg-balances') ) {
6403 # limit @payments to those w/ a pkgnum grepped from $self
6405 foreach my $i (@invoices) {
6406 foreach my $li ( $i->cust_bill_pkg ) {
6407 $pkgnums{$li->pkgnum} = 1;
6410 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6415 foreach my $cust_bill ( @invoices ) {
6417 if ( !defined($payment) || $payment->unapplied == 0 ) {
6418 $payment = pop @payments or last;
6422 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6423 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6425 $owed = $cust_bill->owed;
6427 unless ( $owed > 0 ) {
6428 push @payments, $payment;
6432 my $amount = min( $payment->unapplied, $owed );
6434 my $cust_bill_pay = new FS::cust_bill_pay ( {
6435 'paynum' => $payment->paynum,
6436 'invnum' => $cust_bill->invnum,
6437 'amount' => $amount,
6439 $cust_bill_pay->pkgnum( $payment->pkgnum )
6440 if $conf->exists('pkg-balances') && $payment->pkgnum;
6441 my $error = $cust_bill_pay->insert(%options);
6443 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6447 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6451 my $total_unapplied_payments = $self->total_unapplied_payments;
6453 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6455 return $total_unapplied_payments;
6460 Returns the total owed for this customer on all invoices
6461 (see L<FS::cust_bill/owed>).
6467 $self->total_owed_date(2145859200); #12/31/2037
6470 =item total_owed_date TIME
6472 Returns the total owed for this customer on all invoices with date earlier than
6473 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6474 see L<Time::Local> and L<Date::Parse> for conversion functions.
6478 sub total_owed_date {
6482 # my $custnum = $self->custnum;
6484 # my $owed_sql = FS::cust_bill->owed_sql;
6487 # SELECT SUM($owed_sql) FROM cust_bill
6488 # WHERE custnum = $custnum
6489 # AND _date <= $time
6492 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6493 # $sth->execute() or die $sth->errstr;
6495 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6498 foreach my $cust_bill (
6499 grep { $_->_date <= $time }
6500 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6502 $total_bill += $cust_bill->owed;
6504 sprintf( "%.2f", $total_bill );
6508 =item total_owed_pkgnum PKGNUM
6510 Returns the total owed on all invoices for this customer's specific package
6511 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6515 sub total_owed_pkgnum {
6516 my( $self, $pkgnum ) = @_;
6517 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6520 =item total_owed_date_pkgnum TIME PKGNUM
6522 Returns the total owed for this customer's specific package when using
6523 experimental package balances on all invoices with date earlier than
6524 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6525 see L<Time::Local> and L<Date::Parse> for conversion functions.
6529 sub total_owed_date_pkgnum {
6530 my( $self, $time, $pkgnum ) = @_;
6533 foreach my $cust_bill (
6534 grep { $_->_date <= $time }
6535 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6537 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6539 sprintf( "%.2f", $total_bill );
6545 Returns the total amount of all payments.
6552 $total += $_->paid foreach $self->cust_pay;
6553 sprintf( "%.2f", $total );
6556 =item total_unapplied_credits
6558 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6559 customer. See L<FS::cust_credit/credited>.
6561 =item total_credited
6563 Old name for total_unapplied_credits. Don't use.
6567 sub total_credited {
6568 #carp "total_credited deprecated, use total_unapplied_credits";
6569 shift->total_unapplied_credits(@_);
6572 sub total_unapplied_credits {
6574 my $total_credit = 0;
6575 $total_credit += $_->credited foreach $self->cust_credit;
6576 sprintf( "%.2f", $total_credit );
6579 =item total_unapplied_credits_pkgnum PKGNUM
6581 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6582 customer. See L<FS::cust_credit/credited>.
6586 sub total_unapplied_credits_pkgnum {
6587 my( $self, $pkgnum ) = @_;
6588 my $total_credit = 0;
6589 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6590 sprintf( "%.2f", $total_credit );
6594 =item total_unapplied_payments
6596 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6597 See L<FS::cust_pay/unapplied>.
6601 sub total_unapplied_payments {
6603 my $total_unapplied = 0;
6604 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6605 sprintf( "%.2f", $total_unapplied );
6608 =item total_unapplied_payments_pkgnum PKGNUM
6610 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6611 specific package when using experimental package balances. See
6612 L<FS::cust_pay/unapplied>.
6616 sub total_unapplied_payments_pkgnum {
6617 my( $self, $pkgnum ) = @_;
6618 my $total_unapplied = 0;
6619 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6620 sprintf( "%.2f", $total_unapplied );
6624 =item total_unapplied_refunds
6626 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6627 customer. See L<FS::cust_refund/unapplied>.
6631 sub total_unapplied_refunds {
6633 my $total_unapplied = 0;
6634 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6635 sprintf( "%.2f", $total_unapplied );
6640 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6641 total_unapplied_credits minus total_unapplied_payments).
6649 + $self->total_unapplied_refunds
6650 - $self->total_unapplied_credits
6651 - $self->total_unapplied_payments
6655 =item balance_date TIME
6657 Returns the balance for this customer, only considering invoices with date
6658 earlier than TIME (total_owed_date minus total_credited minus
6659 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6660 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6669 $self->total_owed_date($time)
6670 + $self->total_unapplied_refunds
6671 - $self->total_unapplied_credits
6672 - $self->total_unapplied_payments
6676 =item balance_pkgnum PKGNUM
6678 Returns the balance for this customer's specific package when using
6679 experimental package balances (total_owed plus total_unrefunded, minus
6680 total_unapplied_credits minus total_unapplied_payments)
6684 sub balance_pkgnum {
6685 my( $self, $pkgnum ) = @_;
6688 $self->total_owed_pkgnum($pkgnum)
6689 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6690 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6691 - $self->total_unapplied_credits_pkgnum($pkgnum)
6692 - $self->total_unapplied_payments_pkgnum($pkgnum)
6696 =item in_transit_payments
6698 Returns the total of requests for payments for this customer pending in
6699 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6703 sub in_transit_payments {
6705 my $in_transit_payments = 0;
6706 foreach my $pay_batch ( qsearch('pay_batch', {
6709 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6710 'batchnum' => $pay_batch->batchnum,
6711 'custnum' => $self->custnum,
6713 $in_transit_payments += $cust_pay_batch->amount;
6716 sprintf( "%.2f", $in_transit_payments );
6721 Returns a hash of useful information for making a payment.
6731 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6732 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6733 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6737 For credit card transactions:
6749 For electronic check transactions:
6764 $return{balance} = $self->balance;
6766 $return{payname} = $self->payname
6767 || ( $self->first. ' '. $self->get('last') );
6769 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6771 $return{payby} = $self->payby;
6772 $return{stateid_state} = $self->stateid_state;
6774 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6775 $return{card_type} = cardtype($self->payinfo);
6776 $return{payinfo} = $self->paymask;
6778 @return{'month', 'year'} = $self->paydate_monthyear;
6782 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6783 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6784 $return{payinfo1} = $payinfo1;
6785 $return{payinfo2} = $payinfo2;
6786 $return{paytype} = $self->paytype;
6787 $return{paystate} = $self->paystate;
6791 #doubleclick protection
6793 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6799 =item paydate_monthyear
6801 Returns a two-element list consisting of the month and year of this customer's
6802 paydate (credit card expiration date for CARD customers)
6806 sub paydate_monthyear {
6808 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6810 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6817 =item tax_exemption TAXNAME
6822 my( $self, $taxname ) = @_;
6824 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6825 'taxname' => $taxname,
6830 =item cust_main_exemption
6834 sub cust_main_exemption {
6836 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6839 =item invoicing_list [ ARRAYREF ]
6841 If an arguement is given, sets these email addresses as invoice recipients
6842 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6843 (except as warnings), so use check_invoicing_list first.
6845 Returns a list of email addresses (with svcnum entries expanded).
6847 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6848 check it without disturbing anything by passing nothing.
6850 This interface may change in the future.
6854 sub invoicing_list {
6855 my( $self, $arrayref ) = @_;
6858 my @cust_main_invoice;
6859 if ( $self->custnum ) {
6860 @cust_main_invoice =
6861 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6863 @cust_main_invoice = ();
6865 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6866 #warn $cust_main_invoice->destnum;
6867 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6868 #warn $cust_main_invoice->destnum;
6869 my $error = $cust_main_invoice->delete;
6870 warn $error if $error;
6873 if ( $self->custnum ) {
6874 @cust_main_invoice =
6875 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6877 @cust_main_invoice = ();
6879 my %seen = map { $_->address => 1 } @cust_main_invoice;
6880 foreach my $address ( @{$arrayref} ) {
6881 next if exists $seen{$address} && $seen{$address};
6882 $seen{$address} = 1;
6883 my $cust_main_invoice = new FS::cust_main_invoice ( {
6884 'custnum' => $self->custnum,
6887 my $error = $cust_main_invoice->insert;
6888 warn $error if $error;
6892 if ( $self->custnum ) {
6894 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6901 =item check_invoicing_list ARRAYREF
6903 Checks these arguements as valid input for the invoicing_list method. If there
6904 is an error, returns the error, otherwise returns false.
6908 sub check_invoicing_list {
6909 my( $self, $arrayref ) = @_;
6911 foreach my $address ( @$arrayref ) {
6913 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6914 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6917 my $cust_main_invoice = new FS::cust_main_invoice ( {
6918 'custnum' => $self->custnum,
6921 my $error = $self->custnum
6922 ? $cust_main_invoice->check
6923 : $cust_main_invoice->checkdest
6925 return $error if $error;
6929 return "Email address required"
6930 if $conf->exists('cust_main-require_invoicing_list_email')
6931 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6936 =item set_default_invoicing_list
6938 Sets the invoicing list to all accounts associated with this customer,
6939 overwriting any previous invoicing list.
6943 sub set_default_invoicing_list {
6945 $self->invoicing_list($self->all_emails);
6950 Returns the email addresses of all accounts provisioned for this customer.
6957 foreach my $cust_pkg ( $self->all_pkgs ) {
6958 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6960 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6961 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6963 $list{$_}=1 foreach map { $_->email } @svc_acct;
6968 =item invoicing_list_addpost
6970 Adds postal invoicing to this customer. If this customer is already configured
6971 to receive postal invoices, does nothing.
6975 sub invoicing_list_addpost {
6977 return if grep { $_ eq 'POST' } $self->invoicing_list;
6978 my @invoicing_list = $self->invoicing_list;
6979 push @invoicing_list, 'POST';
6980 $self->invoicing_list(\@invoicing_list);
6983 =item invoicing_list_emailonly
6985 Returns the list of email invoice recipients (invoicing_list without non-email
6986 destinations such as POST and FAX).
6990 sub invoicing_list_emailonly {
6992 warn "$me invoicing_list_emailonly called"
6994 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6997 =item invoicing_list_emailonly_scalar
6999 Returns the list of email invoice recipients (invoicing_list without non-email
7000 destinations such as POST and FAX) as a comma-separated scalar.
7004 sub invoicing_list_emailonly_scalar {
7006 warn "$me invoicing_list_emailonly_scalar called"
7008 join(', ', $self->invoicing_list_emailonly);
7011 =item referral_custnum_cust_main
7013 Returns the customer who referred this customer (or the empty string, if
7014 this customer was not referred).
7016 Note the difference with referral_cust_main method: This method,
7017 referral_custnum_cust_main returns the single customer (if any) who referred
7018 this customer, while referral_cust_main returns an array of customers referred
7023 sub referral_custnum_cust_main {
7025 return '' unless $self->referral_custnum;
7026 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7029 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7031 Returns an array of customers referred by this customer (referral_custnum set
7032 to this custnum). If DEPTH is given, recurses up to the given depth, returning
7033 customers referred by customers referred by this customer and so on, inclusive.
7034 The default behavior is DEPTH 1 (no recursion).
7036 Note the difference with referral_custnum_cust_main method: This method,
7037 referral_cust_main, returns an array of customers referred BY this customer,
7038 while referral_custnum_cust_main returns the single customer (if any) who
7039 referred this customer.
7043 sub referral_cust_main {
7045 my $depth = @_ ? shift : 1;
7046 my $exclude = @_ ? shift : {};
7049 map { $exclude->{$_->custnum}++; $_; }
7050 grep { ! $exclude->{ $_->custnum } }
7051 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7055 map { $_->referral_cust_main($depth-1, $exclude) }
7062 =item referral_cust_main_ncancelled
7064 Same as referral_cust_main, except only returns customers with uncancelled
7069 sub referral_cust_main_ncancelled {
7071 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7074 =item referral_cust_pkg [ DEPTH ]
7076 Like referral_cust_main, except returns a flat list of all unsuspended (and
7077 uncancelled) packages for each customer. The number of items in this list may
7078 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7082 sub referral_cust_pkg {
7084 my $depth = @_ ? shift : 1;
7086 map { $_->unsuspended_pkgs }
7087 grep { $_->unsuspended_pkgs }
7088 $self->referral_cust_main($depth);
7091 =item referring_cust_main
7093 Returns the single cust_main record for the customer who referred this customer
7094 (referral_custnum), or false.
7098 sub referring_cust_main {
7100 return '' unless $self->referral_custnum;
7101 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7104 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7106 Applies a credit to this customer. If there is an error, returns the error,
7107 otherwise returns false.
7109 REASON can be a text string, an FS::reason object, or a scalar reference to
7110 a reasonnum. If a text string, it will be automatically inserted as a new
7111 reason, and a 'reason_type' option must be passed to indicate the
7112 FS::reason_type for the new reason.
7114 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7116 Any other options are passed to FS::cust_credit::insert.
7121 my( $self, $amount, $reason, %options ) = @_;
7123 my $cust_credit = new FS::cust_credit {
7124 'custnum' => $self->custnum,
7125 'amount' => $amount,
7128 if ( ref($reason) ) {
7130 if ( ref($reason) eq 'SCALAR' ) {
7131 $cust_credit->reasonnum( $$reason );
7133 $cust_credit->reasonnum( $reason->reasonnum );
7137 $cust_credit->set('reason', $reason)
7140 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7141 if exists($options{'addlinfo'});
7143 $cust_credit->insert(%options);
7147 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7149 Creates a one-time charge for this customer. If there is an error, returns
7150 the error, otherwise returns false.
7152 New-style, with a hashref of options:
7154 my $error = $cust_main->charge(
7158 'start_date' => str2time('7/4/2009'),
7159 'pkg' => 'Description',
7160 'comment' => 'Comment',
7161 'additional' => [], #extra invoice detail
7162 'classnum' => 1, #pkg_class
7164 'setuptax' => '', # or 'Y' for tax exempt
7167 'taxclass' => 'Tax class',
7170 'taxproduct' => 2, #part_pkg_taxproduct
7171 'override' => {}, #XXX describe
7173 #will be filled in with the new object
7174 'cust_pkg_ref' => \$cust_pkg,
7180 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7186 my ( $amount, $quantity, $start_date, $classnum );
7187 my ( $pkg, $comment, $additional );
7188 my ( $setuptax, $taxclass ); #internal taxes
7189 my ( $taxproduct, $override ); #vendor (CCH) taxes
7190 my $cust_pkg_ref = '';
7191 if ( ref( $_[0] ) ) {
7192 $amount = $_[0]->{amount};
7193 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7194 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7195 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7196 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7197 : '$'. sprintf("%.2f",$amount);
7198 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7199 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7200 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7201 $additional = $_[0]->{additional} || [];
7202 $taxproduct = $_[0]->{taxproductnum};
7203 $override = { '' => $_[0]->{tax_override} };
7204 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7209 $pkg = @_ ? shift : 'One-time charge';
7210 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7212 $taxclass = @_ ? shift : '';
7216 local $SIG{HUP} = 'IGNORE';
7217 local $SIG{INT} = 'IGNORE';
7218 local $SIG{QUIT} = 'IGNORE';
7219 local $SIG{TERM} = 'IGNORE';
7220 local $SIG{TSTP} = 'IGNORE';
7221 local $SIG{PIPE} = 'IGNORE';
7223 my $oldAutoCommit = $FS::UID::AutoCommit;
7224 local $FS::UID::AutoCommit = 0;
7227 my $part_pkg = new FS::part_pkg ( {
7229 'comment' => $comment,
7233 'classnum' => $classnum ? $classnum : '',
7234 'setuptax' => $setuptax,
7235 'taxclass' => $taxclass,
7236 'taxproductnum' => $taxproduct,
7239 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7240 ( 0 .. @$additional - 1 )
7242 'additional_count' => scalar(@$additional),
7243 'setup_fee' => $amount,
7246 my $error = $part_pkg->insert( options => \%options,
7247 tax_overrides => $override,
7250 $dbh->rollback if $oldAutoCommit;
7254 my $pkgpart = $part_pkg->pkgpart;
7255 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7256 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7257 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7258 $error = $type_pkgs->insert;
7260 $dbh->rollback if $oldAutoCommit;
7265 my $cust_pkg = new FS::cust_pkg ( {
7266 'custnum' => $self->custnum,
7267 'pkgpart' => $pkgpart,
7268 'quantity' => $quantity,
7269 'start_date' => $start_date,
7272 $error = $cust_pkg->insert;
7274 $dbh->rollback if $oldAutoCommit;
7276 } elsif ( $cust_pkg_ref ) {
7277 ${$cust_pkg_ref} = $cust_pkg;
7280 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7285 #=item charge_postal_fee
7287 #Applies a one time charge this customer. If there is an error,
7288 #returns the error, returns the cust_pkg charge object or false
7289 #if there was no charge.
7293 # This should be a customer event. For that to work requires that bill
7294 # also be a customer event.
7296 sub charge_postal_fee {
7299 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7300 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7302 my $cust_pkg = new FS::cust_pkg ( {
7303 'custnum' => $self->custnum,
7304 'pkgpart' => $pkgpart,
7308 my $error = $cust_pkg->insert;
7309 $error ? $error : $cust_pkg;
7314 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7320 map { $_ } #return $self->num_cust_bill unless wantarray;
7321 sort { $a->_date <=> $b->_date }
7322 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7325 =item open_cust_bill
7327 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7332 sub open_cust_bill {
7336 'table' => 'cust_bill',
7337 'hashref' => { 'custnum' => $self->custnum, },
7338 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7339 'order_by' => 'ORDER BY _date ASC',
7344 =item cust_statements
7346 Returns all the statements (see L<FS::cust_statement>) for this customer.
7350 sub cust_statement {
7352 map { $_ } #return $self->num_cust_statement unless wantarray;
7353 sort { $a->_date <=> $b->_date }
7354 qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7359 Returns all the credits (see L<FS::cust_credit>) for this customer.
7365 map { $_ } #return $self->num_cust_credit unless wantarray;
7366 sort { $a->_date <=> $b->_date }
7367 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7370 =item cust_credit_pkgnum
7372 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7373 package when using experimental package balances.
7377 sub cust_credit_pkgnum {
7378 my( $self, $pkgnum ) = @_;
7379 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7380 sort { $a->_date <=> $b->_date }
7381 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7382 'pkgnum' => $pkgnum,
7389 Returns all the payments (see L<FS::cust_pay>) for this customer.
7395 return $self->num_cust_pay unless wantarray;
7396 sort { $a->_date <=> $b->_date }
7397 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7402 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
7403 called automatically when the cust_pay method is used in a scalar context.
7409 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7410 my $sth = dbh->prepare($sql) or die dbh->errstr;
7411 $sth->execute($self->custnum) or die $sth->errstr;
7412 $sth->fetchrow_arrayref->[0];
7415 =item cust_pay_pkgnum
7417 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7418 package when using experimental package balances.
7422 sub cust_pay_pkgnum {
7423 my( $self, $pkgnum ) = @_;
7424 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7425 sort { $a->_date <=> $b->_date }
7426 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7427 'pkgnum' => $pkgnum,
7434 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7440 map { $_ } #return $self->num_cust_pay_void unless wantarray;
7441 sort { $a->_date <=> $b->_date }
7442 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7445 =item cust_pay_batch
7447 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7451 sub cust_pay_batch {
7453 map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7454 sort { $a->paybatchnum <=> $b->paybatchnum }
7455 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7458 =item cust_pay_pending
7460 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7461 (without status "done").
7465 sub cust_pay_pending {
7467 return $self->num_cust_pay_pending unless wantarray;
7468 sort { $a->_date <=> $b->_date }
7469 qsearch( 'cust_pay_pending', {
7470 'custnum' => $self->custnum,
7471 'status' => { op=>'!=', value=>'done' },
7476 =item num_cust_pay_pending
7478 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7479 customer (without status "done"). Also called automatically when the
7480 cust_pay_pending method is used in a scalar context.
7484 sub num_cust_pay_pending {
7486 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7487 " WHERE custnum = ? AND status != 'done' ";
7488 my $sth = dbh->prepare($sql) or die dbh->errstr;
7489 $sth->execute($self->custnum) or die $sth->errstr;
7490 $sth->fetchrow_arrayref->[0];
7495 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7501 map { $_ } #return $self->num_cust_refund unless wantarray;
7502 sort { $a->_date <=> $b->_date }
7503 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7506 =item display_custnum
7508 Returns the displayed customer number for this customer: agent_custid if
7509 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7513 sub display_custnum {
7515 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7516 return $self->agent_custid;
7518 return $self->custnum;
7524 Returns a name string for this customer, either "Company (Last, First)" or
7531 my $name = $self->contact;
7532 $name = $self->company. " ($name)" if $self->company;
7538 Returns a name string for this (service/shipping) contact, either
7539 "Company (Last, First)" or "Last, First".
7545 if ( $self->get('ship_last') ) {
7546 my $name = $self->ship_contact;
7547 $name = $self->ship_company. " ($name)" if $self->ship_company;
7556 Returns a name string for this customer, either "Company" or "First Last".
7562 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7565 =item ship_name_short
7567 Returns a name string for this (service/shipping) contact, either "Company"
7572 sub ship_name_short {
7574 if ( $self->get('ship_last') ) {
7575 $self->ship_company !~ /^\s*$/
7576 ? $self->ship_company
7577 : $self->ship_contact_firstlast;
7579 $self->name_company_or_firstlast;
7585 Returns this customer's full (billing) contact name only, "Last, First"
7591 $self->get('last'). ', '. $self->first;
7596 Returns this customer's full (shipping) contact name only, "Last, First"
7602 $self->get('ship_last')
7603 ? $self->get('ship_last'). ', '. $self->ship_first
7607 =item contact_firstlast
7609 Returns this customers full (billing) contact name only, "First Last".
7613 sub contact_firstlast {
7615 $self->first. ' '. $self->get('last');
7618 =item ship_contact_firstlast
7620 Returns this customer's full (shipping) contact name only, "First Last".
7624 sub ship_contact_firstlast {
7626 $self->get('ship_last')
7627 ? $self->first. ' '. $self->get('ship_last')
7628 : $self->contact_firstlast;
7633 Returns this customer's full country name
7639 code2country($self->country);
7642 =item geocode DATA_VENDOR
7644 Returns a value for the customer location as encoded by DATA_VENDOR.
7645 Currently this only makes sense for "CCH" as DATA_VENDOR.
7650 my ($self, $data_vendor) = (shift, shift); #always cch for now
7652 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7653 return $geocode if $geocode;
7655 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7659 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7660 if $self->country eq 'US';
7662 #CCH specific location stuff
7663 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7665 my @cust_tax_location =
7667 'table' => 'cust_tax_location',
7668 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7669 'extra_sql' => $extra_sql,
7670 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7673 $geocode = $cust_tax_location[0]->geocode
7674 if scalar(@cust_tax_location);
7683 Returns a status string for this customer, currently:
7687 =item prospect - No packages have ever been ordered
7689 =item active - One or more recurring packages is active
7691 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7693 =item suspended - All non-cancelled recurring packages are suspended
7695 =item cancelled - All recurring packages are cancelled
7701 sub status { shift->cust_status(@_); }
7705 for my $status (qw( prospect active inactive suspended cancelled )) {
7706 my $method = $status.'_sql';
7707 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7708 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7709 $sth->execute( ($self->custnum) x $numnum )
7710 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7711 return $status if $sth->fetchrow_arrayref->[0];
7715 =item ucfirst_cust_status
7717 =item ucfirst_status
7719 Returns the status with the first character capitalized.
7723 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7725 sub ucfirst_cust_status {
7727 ucfirst($self->cust_status);
7732 Returns a hex triplet color string for this customer's status.
7736 use vars qw(%statuscolor);
7737 tie %statuscolor, 'Tie::IxHash',
7738 'prospect' => '7e0079', #'000000', #black? naw, purple
7739 'active' => '00CC00', #green
7740 'inactive' => '0000CC', #blue
7741 'suspended' => 'FF9900', #yellow
7742 'cancelled' => 'FF0000', #red
7745 sub statuscolor { shift->cust_statuscolor(@_); }
7747 sub cust_statuscolor {
7749 $statuscolor{$self->cust_status};
7754 Returns an array of hashes representing the customer's RT tickets.
7761 my $num = $conf->config('cust_main-max_tickets') || 10;
7764 if ( $conf->config('ticket_system') ) {
7765 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7767 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7771 foreach my $priority (
7772 $conf->config('ticket_system-custom_priority_field-values'), ''
7774 last if scalar(@tickets) >= $num;
7776 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7777 $num - scalar(@tickets),
7787 # Return services representing svc_accts in customer support packages
7788 sub support_services {
7790 my %packages = map { $_ => 1 } $conf->config('support_packages');
7792 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7793 grep { $_->part_svc->svcdb eq 'svc_acct' }
7794 map { $_->cust_svc }
7795 grep { exists $packages{ $_->pkgpart } }
7796 $self->ncancelled_pkgs;
7800 # Return a list of latitude/longitude for one of the services (if any)
7801 sub service_coordinates {
7805 grep { $_->latitude && $_->longitude }
7807 map { $_->cust_svc }
7808 $self->ncancelled_pkgs;
7810 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7815 =head1 CLASS METHODS
7821 Class method that returns the list of possible status strings for customers
7822 (see L<the status method|/status>). For example:
7824 @statuses = FS::cust_main->statuses();
7829 #my $self = shift; #could be class...
7835 Returns an SQL expression identifying prospective cust_main records (customers
7836 with no packages ever ordered)
7840 use vars qw($select_count_pkgs);
7841 $select_count_pkgs =
7842 "SELECT COUNT(*) FROM cust_pkg
7843 WHERE cust_pkg.custnum = cust_main.custnum";
7845 sub select_count_pkgs_sql {
7849 sub prospect_sql { "
7850 0 = ( $select_count_pkgs )
7855 Returns an SQL expression identifying active cust_main records (customers with
7856 active recurring packages).
7861 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7867 Returns an SQL expression identifying inactive cust_main records (customers with
7868 no active recurring packages, but otherwise unsuspended/uncancelled).
7872 sub inactive_sql { "
7873 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7875 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7881 Returns an SQL expression identifying suspended cust_main records.
7886 sub suspended_sql { susp_sql(@_); }
7888 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7890 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7896 Returns an SQL expression identifying cancelled cust_main records.
7900 sub cancelled_sql { cancel_sql(@_); }
7903 my $recurring_sql = FS::cust_pkg->recurring_sql;
7904 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7907 0 < ( $select_count_pkgs )
7908 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7909 AND 0 = ( $select_count_pkgs AND $recurring_sql
7910 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7912 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7918 =item uncancelled_sql
7920 Returns an SQL expression identifying un-cancelled cust_main records.
7924 sub uncancelled_sql { uncancel_sql(@_); }
7925 sub uncancel_sql { "
7926 ( 0 < ( $select_count_pkgs
7927 AND ( cust_pkg.cancel IS NULL
7928 OR cust_pkg.cancel = 0
7931 OR 0 = ( $select_count_pkgs )
7937 Returns an SQL fragment to retreive the balance.
7942 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7943 WHERE cust_bill.custnum = cust_main.custnum )
7944 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7945 WHERE cust_pay.custnum = cust_main.custnum )
7946 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7947 WHERE cust_credit.custnum = cust_main.custnum )
7948 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7949 WHERE cust_refund.custnum = cust_main.custnum )
7952 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7954 Returns an SQL fragment to retreive the balance for this customer, only
7955 considering invoices with date earlier than START_TIME, and optionally not
7956 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7957 total_unapplied_payments).
7959 Times are specified as SQL fragments or numeric
7960 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7961 L<Date::Parse> for conversion functions. The empty string can be passed
7962 to disable that time constraint completely.
7964 Available options are:
7968 =item unapplied_date
7970 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)
7975 set to true to remove all customer comparison clauses, for totals
7980 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7985 JOIN clause (typically used with the total option)
7991 sub balance_date_sql {
7992 my( $class, $start, $end, %opt ) = @_;
7994 my $owed = FS::cust_bill->owed_sql;
7995 my $unapp_refund = FS::cust_refund->unapplied_sql;
7996 my $unapp_credit = FS::cust_credit->unapplied_sql;
7997 my $unapp_pay = FS::cust_pay->unapplied_sql;
7999 my $j = $opt{'join'} || '';
8001 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
8002 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8003 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8004 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
8006 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
8007 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8008 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8009 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
8014 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8016 Returns an SQL fragment to retreive the total unapplied payments for this
8017 customer, only considering invoices with date earlier than START_TIME, and
8018 optionally not later than END_TIME.
8020 Times are specified as SQL fragments or numeric
8021 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
8022 L<Date::Parse> for conversion functions. The empty string can be passed
8023 to disable that time constraint completely.
8025 Available options are:
8029 sub unapplied_payments_date_sql {
8030 my( $class, $start, $end, ) = @_;
8032 my $unapp_pay = FS::cust_pay->unapplied_sql;
8034 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8035 'unapplied_date'=>1 );
8037 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8040 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8042 Helper method for balance_date_sql; name (and usage) subject to change
8043 (suggestions welcome).
8045 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8046 cust_refund, cust_credit or cust_pay).
8048 If TABLE is "cust_bill" or the unapplied_date option is true, only
8049 considers records with date earlier than START_TIME, and optionally not
8050 later than END_TIME .
8054 sub _money_table_where {
8055 my( $class, $table, $start, $end, %opt ) = @_;
8058 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8059 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8060 push @where, "$table._date <= $start" if defined($start) && length($start);
8061 push @where, "$table._date > $end" if defined($end) && length($end);
8063 push @where, @{$opt{'where'}} if $opt{'where'};
8064 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8070 =item search_sql HASHREF
8074 Returns a qsearch hash expression to search for parameters specified in HREF.
8075 Valid parameters are
8083 =item cancelled_pkgs
8089 listref of start date, end date
8095 =item current_balance
8097 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8101 =item flattened_pkgs
8110 my ($class, $params) = @_;
8121 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8123 "cust_main.agentnum = $1";
8130 #prospect active inactive suspended cancelled
8131 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8132 my $method = $params->{'status'}. '_sql';
8133 #push @where, $class->$method();
8134 push @where, FS::cust_main->$method();
8138 # parse cancelled package checkbox
8143 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8144 unless $params->{'cancelled_pkgs'};
8147 # parse without census tract checkbox
8150 push @where, "(censustract = '' or censustract is null)"
8151 if $params->{'no_censustract'};
8157 foreach my $field (qw( signupdate )) {
8159 next unless exists($params->{$field});
8161 my($beginning, $ending) = @{$params->{$field}};
8164 "cust_main.$field IS NOT NULL",
8165 "cust_main.$field >= $beginning",
8166 "cust_main.$field <= $ending";
8168 $orderby ||= "ORDER BY cust_main.$field";
8176 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8178 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8185 #my $balance_sql = $class->balance_sql();
8186 my $balance_sql = FS::cust_main->balance_sql();
8188 push @where, map { s/current_balance/$balance_sql/; $_ }
8189 @{ $params->{'current_balance'} };
8195 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8197 "cust_main.custbatch = '$1'";
8201 # setup queries, subs, etc. for the search
8204 $orderby ||= 'ORDER BY custnum';
8206 # here is the agent virtualization
8207 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8209 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8211 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8213 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8215 my $select = join(', ',
8216 'cust_main.custnum',
8217 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8220 my(@extra_headers) = ();
8221 my(@extra_fields) = ();
8223 if ($params->{'flattened_pkgs'}) {
8225 if ($dbh->{Driver}->{Name} eq 'Pg') {
8227 $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";
8229 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8230 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8231 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8233 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8234 "omitting packing information from report.";
8237 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";
8239 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8240 $sth->execute() or die $sth->errstr;
8241 my $headerrow = $sth->fetchrow_arrayref;
8242 my $headercount = $headerrow ? $headerrow->[0] : 0;
8243 while($headercount) {
8244 unshift @extra_headers, "Package ". $headercount;
8245 unshift @extra_fields, eval q!sub {my $c = shift;
8246 my @a = split '\|', $c->magic;
8247 my $p = $a[!.--$headercount. q!];
8255 'table' => 'cust_main',
8256 'select' => $select,
8258 'extra_sql' => $extra_sql,
8259 'order_by' => $orderby,
8260 'count_query' => $count_query,
8261 'extra_headers' => \@extra_headers,
8262 'extra_fields' => \@extra_fields,
8267 =item email_search_sql HASHREF
8271 Emails a notice to the specified customers.
8273 Valid parameters are those of the L<search_sql> method, plus the following:
8295 Optional job queue job for status updates.
8299 Returns an error message, or false for success.
8301 If an error occurs during any email, stops the enture send and returns that
8302 error. Presumably if you're getting SMTP errors aborting is better than
8303 retrying everything.
8307 sub email_search_sql {
8308 my($class, $params) = @_;
8310 my $from = delete $params->{from};
8311 my $subject = delete $params->{subject};
8312 my $html_body = delete $params->{html_body};
8313 my $text_body = delete $params->{text_body};
8315 my $job = delete $params->{'job'};
8317 $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8318 unless ref($params->{'payby'});
8320 my $sql_query = $class->search_sql($params);
8322 my $count_query = delete($sql_query->{'count_query'});
8323 my $count_sth = dbh->prepare($count_query)
8324 or die "Error preparing $count_query: ". dbh->errstr;
8326 or die "Error executing $count_query: ". $count_sth->errstr;
8327 my $count_arrayref = $count_sth->fetchrow_arrayref;
8328 my $num_cust = $count_arrayref->[0];
8330 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8331 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8334 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8336 #eventually order+limit magic to reduce memory use?
8337 foreach my $cust_main ( qsearch($sql_query) ) {
8339 my $to = $cust_main->invoicing_list_emailonly_scalar;
8342 my $error = send_email(
8346 'subject' => $subject,
8347 'html_body' => $html_body,
8348 'text_body' => $text_body,
8351 return $error if $error;
8353 if ( $job ) { #progressbar foo
8355 if ( time - $min_sec > $last ) {
8356 my $error = $job->update_statustext(
8357 int( 100 * $num / $num_cust )
8359 die $error if $error;
8369 use Storable qw(thaw);
8372 sub process_email_search_sql {
8374 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8376 my $param = thaw(decode_base64(shift));
8377 warn Dumper($param) if $DEBUG;
8379 $param->{'job'} = $job;
8381 $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8382 unless ref($param->{'payby'});
8384 my $error = FS::cust_main->email_search_sql( $param );
8385 die $error if $error;
8389 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8391 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8392 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
8393 appropriate ship_ field is also searched).
8395 Additional options are the same as FS::Record::qsearch
8400 my( $self, $fuzzy, $hash, @opt) = @_;
8405 check_and_rebuild_fuzzyfiles();
8406 foreach my $field ( keys %$fuzzy ) {
8408 my $all = $self->all_X($field);
8409 next unless scalar(@$all);
8412 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8415 foreach ( keys %match ) {
8416 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8417 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8420 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8423 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8425 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8433 Returns a masked version of the named field
8438 my ($self,$field) = @_;
8442 'x'x(length($self->getfield($field))-4).
8443 substr($self->getfield($field), (length($self->getfield($field))-4));
8453 =item smart_search OPTION => VALUE ...
8455 Accepts the following options: I<search>, the string to search for. The string
8456 will be searched for as a customer number, phone number, name or company name,
8457 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8458 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8459 skip fuzzy matching when an exact match is found.
8461 Any additional options are treated as an additional qualifier on the search
8464 Returns a (possibly empty) array of FS::cust_main objects.
8471 #here is the agent virtualization
8472 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8476 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8477 my $search = delete $options{'search'};
8478 ( my $alphanum_search = $search ) =~ s/\W//g;
8480 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8482 #false laziness w/Record::ut_phone
8483 my $phonen = "$1-$2-$3";
8484 $phonen .= " x$4" if $4;
8486 push @cust_main, qsearch( {
8487 'table' => 'cust_main',
8488 'hashref' => { %options },
8489 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8491 join(' OR ', map "$_ = '$phonen'",
8492 qw( daytime night fax
8493 ship_daytime ship_night ship_fax )
8496 " AND $agentnums_sql", #agent virtualization
8499 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8500 #try looking for matches with extensions unless one was specified
8502 push @cust_main, qsearch( {
8503 'table' => 'cust_main',
8504 'hashref' => { %options },
8505 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8507 join(' OR ', map "$_ LIKE '$phonen\%'",
8509 ship_daytime ship_night )
8512 " AND $agentnums_sql", #agent virtualization
8517 # custnum search (also try agent_custid), with some tweaking options if your
8518 # legacy cust "numbers" have letters
8521 if ( $search =~ /^\s*(\d+)\s*$/
8522 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8523 && $search =~ /^\s*(\w\w?\d+)\s*$/
8530 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
8531 push @cust_main, qsearch( {
8532 'table' => 'cust_main',
8533 'hashref' => { 'custnum' => $num, %options },
8534 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8538 push @cust_main, qsearch( {
8539 'table' => 'cust_main',
8540 'hashref' => { 'agent_custid' => $num, %options },
8541 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8544 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8546 my($company, $last, $first) = ( $1, $2, $3 );
8548 # "Company (Last, First)"
8549 #this is probably something a browser remembered,
8550 #so just do an exact search
8552 foreach my $prefix ( '', 'ship_' ) {
8553 push @cust_main, qsearch( {
8554 'table' => 'cust_main',
8555 'hashref' => { $prefix.'first' => $first,
8556 $prefix.'last' => $last,
8557 $prefix.'company' => $company,
8560 'extra_sql' => " AND $agentnums_sql",
8564 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8565 # try (ship_){last,company}
8569 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8570 # # full strings the browser remembers won't work
8571 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8573 use Lingua::EN::NameParse;
8574 my $NameParse = new Lingua::EN::NameParse(
8576 allow_reversed => 1,
8579 my($last, $first) = ( '', '' );
8580 #maybe disable this too and just rely on NameParse?
8581 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8583 ($last, $first) = ( $1, $2 );
8585 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8586 } elsif ( ! $NameParse->parse($value) ) {
8588 my %name = $NameParse->components;
8589 $first = $name{'given_name_1'};
8590 $last = $name{'surname_1'};
8594 if ( $first && $last ) {
8596 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8599 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8601 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8602 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8605 push @cust_main, qsearch( {
8606 'table' => 'cust_main',
8607 'hashref' => \%options,
8608 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8611 # or it just be something that was typed in... (try that in a sec)
8615 my $q_value = dbh->quote($value);
8618 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8619 $sql .= " ( LOWER(last) = $q_value
8620 OR LOWER(company) = $q_value
8621 OR LOWER(ship_last) = $q_value
8622 OR LOWER(ship_company) = $q_value
8625 push @cust_main, qsearch( {
8626 'table' => 'cust_main',
8627 'hashref' => \%options,
8628 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8631 #no exact match, trying substring/fuzzy
8632 #always do substring & fuzzy (unless they're explicity config'ed off)
8633 #getting complaints searches are not returning enough
8634 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8636 #still some false laziness w/search_sql (was search/cust_main.cgi)
8641 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8642 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8645 if ( $first && $last ) {
8648 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8649 'last' => { op=>'ILIKE', value=>"%$last%" },
8651 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8652 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8659 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8660 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8664 foreach my $hashref ( @hashrefs ) {
8666 push @cust_main, qsearch( {
8667 'table' => 'cust_main',
8668 'hashref' => { %$hashref,
8671 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8680 " AND $agentnums_sql", #extra_sql #agent virtualization
8683 if ( $first && $last ) {
8684 push @cust_main, FS::cust_main->fuzzy_search(
8685 { 'last' => $last, #fuzzy hashref
8686 'first' => $first }, #
8690 foreach my $field ( 'last', 'company' ) {
8692 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8699 #eliminate duplicates
8701 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8709 Accepts the following options: I<email>, the email address to search for. The
8710 email address will be searched for as an email invoice destination and as an
8713 #Any additional options are treated as an additional qualifier on the search
8714 #(i.e. I<agentnum>).
8716 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8726 my $email = delete $options{'email'};
8728 #we're only being used by RT at the moment... no agent virtualization yet
8729 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8733 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8735 my ( $user, $domain ) = ( $1, $2 );
8737 warn "$me smart_search: searching for $user in domain $domain"
8743 'table' => 'cust_main_invoice',
8744 'hashref' => { 'dest' => $email },
8751 map $_->cust_svc->cust_pkg,
8753 'table' => 'svc_acct',
8754 'hashref' => { 'username' => $user, },
8756 'AND ( SELECT domain FROM svc_domain
8757 WHERE svc_acct.domsvc = svc_domain.svcnum
8758 ) = '. dbh->quote($domain),
8764 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8766 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8773 =item check_and_rebuild_fuzzyfiles
8777 use vars qw(@fuzzyfields);
8778 @fuzzyfields = ( 'last', 'first', 'company' );
8780 sub check_and_rebuild_fuzzyfiles {
8781 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8782 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8785 =item rebuild_fuzzyfiles
8789 sub rebuild_fuzzyfiles {
8791 use Fcntl qw(:flock);
8793 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8794 mkdir $dir, 0700 unless -d $dir;
8796 foreach my $fuzzy ( @fuzzyfields ) {
8798 open(LOCK,">>$dir/cust_main.$fuzzy")
8799 or die "can't open $dir/cust_main.$fuzzy: $!";
8801 or die "can't lock $dir/cust_main.$fuzzy: $!";
8803 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8804 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8806 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8807 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8808 " WHERE $field != '' AND $field IS NOT NULL");
8809 $sth->execute or die $sth->errstr;
8811 while ( my $row = $sth->fetchrow_arrayref ) {
8812 print CACHE $row->[0]. "\n";
8817 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8819 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8830 my( $self, $field ) = @_;
8831 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8832 open(CACHE,"<$dir/cust_main.$field")
8833 or die "can't open $dir/cust_main.$field: $!";
8834 my @array = map { chomp; $_; } <CACHE>;
8839 =item append_fuzzyfiles LASTNAME COMPANY
8843 sub append_fuzzyfiles {
8844 #my( $first, $last, $company ) = @_;
8846 &check_and_rebuild_fuzzyfiles;
8848 use Fcntl qw(:flock);
8850 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8852 foreach my $field (qw( first last company )) {
8857 open(CACHE,">>$dir/cust_main.$field")
8858 or die "can't open $dir/cust_main.$field: $!";
8859 flock(CACHE,LOCK_EX)
8860 or die "can't lock $dir/cust_main.$field: $!";
8862 print CACHE "$value\n";
8864 flock(CACHE,LOCK_UN)
8865 or die "can't unlock $dir/cust_main.$field: $!";
8880 #warn join('-',keys %$param);
8881 my $fh = $param->{filehandle};
8882 my @fields = @{$param->{fields}};
8884 eval "use Text::CSV_XS;";
8887 my $csv = new Text::CSV_XS;
8894 local $SIG{HUP} = 'IGNORE';
8895 local $SIG{INT} = 'IGNORE';
8896 local $SIG{QUIT} = 'IGNORE';
8897 local $SIG{TERM} = 'IGNORE';
8898 local $SIG{TSTP} = 'IGNORE';
8899 local $SIG{PIPE} = 'IGNORE';
8901 my $oldAutoCommit = $FS::UID::AutoCommit;
8902 local $FS::UID::AutoCommit = 0;
8905 #while ( $columns = $csv->getline($fh) ) {
8907 while ( defined($line=<$fh>) ) {
8909 $csv->parse($line) or do {
8910 $dbh->rollback if $oldAutoCommit;
8911 return "can't parse: ". $csv->error_input();
8914 my @columns = $csv->fields();
8915 #warn join('-',@columns);
8918 foreach my $field ( @fields ) {
8919 $row{$field} = shift @columns;
8922 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8923 unless ( $cust_main ) {
8924 $dbh->rollback if $oldAutoCommit;
8925 return "unknown custnum $row{'custnum'}";
8928 if ( $row{'amount'} > 0 ) {
8929 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8931 $dbh->rollback if $oldAutoCommit;
8935 } elsif ( $row{'amount'} < 0 ) {
8936 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8939 $dbh->rollback if $oldAutoCommit;
8949 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8951 return "Empty file!" unless $imported;
8957 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8959 Sends a templated email notification to the customer (see L<Text::Template>).
8961 OPTIONS is a hash and may include
8963 I<from> - the email sender (default is invoice_from)
8965 I<to> - comma-separated scalar or arrayref of recipients
8966 (default is invoicing_list)
8968 I<subject> - The subject line of the sent email notification
8969 (default is "Notice from company_name")
8971 I<extra_fields> - a hashref of name/value pairs which will be substituted
8974 The following variables are vavailable in the template.
8976 I<$first> - the customer first name
8977 I<$last> - the customer last name
8978 I<$company> - the customer company
8979 I<$payby> - a description of the method of payment for the customer
8980 # would be nice to use FS::payby::shortname
8981 I<$payinfo> - the account information used to collect for this customer
8982 I<$expdate> - the expiration of the customer payment in seconds from epoch
8987 my ($self, $template, %options) = @_;
8989 return unless $conf->exists($template);
8991 my $from = $conf->config('invoice_from', $self->agentnum)
8992 if $conf->exists('invoice_from', $self->agentnum);
8993 $from = $options{from} if exists($options{from});
8995 my $to = join(',', $self->invoicing_list_emailonly);
8996 $to = $options{to} if exists($options{to});
8998 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8999 if $conf->exists('company_name', $self->agentnum);
9000 $subject = $options{subject} if exists($options{subject});
9002 my $notify_template = new Text::Template (TYPE => 'ARRAY',
9003 SOURCE => [ map "$_\n",
9004 $conf->config($template)]
9006 or die "can't create new Text::Template object: Text::Template::ERROR";
9007 $notify_template->compile()
9008 or die "can't compile template: Text::Template::ERROR";
9010 $FS::notify_template::_template::company_name =
9011 $conf->config('company_name', $self->agentnum);
9012 $FS::notify_template::_template::company_address =
9013 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9015 my $paydate = $self->paydate || '2037-12-31';
9016 $FS::notify_template::_template::first = $self->first;
9017 $FS::notify_template::_template::last = $self->last;
9018 $FS::notify_template::_template::company = $self->company;
9019 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9020 my $payby = $self->payby;
9021 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9022 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9024 #credit cards expire at the end of the month/year of their exp date
9025 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9026 $FS::notify_template::_template::payby = 'credit card';
9027 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9028 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9030 }elsif ($payby eq 'COMP') {
9031 $FS::notify_template::_template::payby = 'complimentary account';
9033 $FS::notify_template::_template::payby = 'current method';
9035 $FS::notify_template::_template::expdate = $expire_time;
9037 for (keys %{$options{extra_fields}}){
9039 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9042 send_email(from => $from,
9044 subject => $subject,
9045 body => $notify_template->fill_in( PACKAGE =>
9046 'FS::notify_template::_template' ),
9051 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9053 Generates a templated notification to the customer (see L<Text::Template>).
9055 OPTIONS is a hash and may include
9057 I<extra_fields> - a hashref of name/value pairs which will be substituted
9058 into the template. These values may override values mentioned below
9059 and those from the customer record.
9061 The following variables are available in the template instead of or in addition
9062 to the fields of the customer record.
9064 I<$payby> - a description of the method of payment for the customer
9065 # would be nice to use FS::payby::shortname
9066 I<$payinfo> - the masked account information used to collect for this customer
9067 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9068 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9072 sub generate_letter {
9073 my ($self, $template, %options) = @_;
9075 return unless $conf->exists($template);
9077 my $letter_template = new Text::Template
9079 SOURCE => [ map "$_\n", $conf->config($template)],
9080 DELIMITERS => [ '[@--', '--@]' ],
9082 or die "can't create new Text::Template object: Text::Template::ERROR";
9084 $letter_template->compile()
9085 or die "can't compile template: Text::Template::ERROR";
9087 my %letter_data = map { $_ => $self->$_ } $self->fields;
9088 $letter_data{payinfo} = $self->mask_payinfo;
9090 #my $paydate = $self->paydate || '2037-12-31';
9091 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9093 my $payby = $self->payby;
9094 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9095 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9097 #credit cards expire at the end of the month/year of their exp date
9098 if ($payby eq 'CARD' || $payby eq 'DCRD') {
9099 $letter_data{payby} = 'credit card';
9100 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9101 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9103 }elsif ($payby eq 'COMP') {
9104 $letter_data{payby} = 'complimentary account';
9106 $letter_data{payby} = 'current method';
9108 $letter_data{expdate} = $expire_time;
9110 for (keys %{$options{extra_fields}}){
9111 $letter_data{$_} = $options{extra_fields}->{$_};
9114 unless(exists($letter_data{returnaddress})){
9115 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9116 $self->agent_template)
9118 if ( length($retadd) ) {
9119 $letter_data{returnaddress} = $retadd;
9120 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9121 $letter_data{returnaddress} =
9122 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9123 $conf->config('company_address', $self->agentnum)
9126 $letter_data{returnaddress} = '~';
9130 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9132 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9134 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9135 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9139 ) or die "can't open temp file: $!\n";
9141 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9143 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9147 =item print_ps TEMPLATE
9149 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9155 my $file = $self->generate_letter(@_);
9156 FS::Misc::generate_ps($file);
9159 =item print TEMPLATE
9161 Prints the filled in template.
9163 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9167 sub queueable_print {
9170 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9171 or die "invalid customer number: " . $opt{custvnum};
9173 my $error = $self->print( $opt{template} );
9174 die $error if $error;
9178 my ($self, $template) = (shift, shift);
9179 do_print [ $self->print_ps($template) ];
9182 #these three subs should just go away once agent stuff is all config overrides
9184 sub agent_template {
9186 $self->_agent_plandata('agent_templatename');
9189 sub agent_invoice_from {
9191 $self->_agent_plandata('agent_invoice_from');
9194 sub _agent_plandata {
9195 my( $self, $option ) = @_;
9197 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9198 #agent-specific Conf
9200 use FS::part_event::Condition;
9202 my $agentnum = $self->agentnum;
9205 if ( driver_name =~ /^Pg/i ) {
9207 } elsif ( driver_name =~ /^mysql/i ) {
9210 die "don't know how to use regular expressions in ". driver_name. " databases";
9213 my $part_event_option =
9215 'select' => 'part_event_option.*',
9216 'table' => 'part_event_option',
9218 LEFT JOIN part_event USING ( eventpart )
9219 LEFT JOIN part_event_option AS peo_agentnum
9220 ON ( part_event.eventpart = peo_agentnum.eventpart
9221 AND peo_agentnum.optionname = 'agentnum'
9222 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9224 LEFT JOIN part_event_condition
9225 ON ( part_event.eventpart = part_event_condition.eventpart
9226 AND part_event_condition.conditionname = 'cust_bill_age'
9228 LEFT JOIN part_event_condition_option
9229 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9230 AND part_event_condition_option.optionname = 'age'
9233 #'hashref' => { 'optionname' => $option },
9234 #'hashref' => { 'part_event_option.optionname' => $option },
9236 " WHERE part_event_option.optionname = ". dbh->quote($option).
9237 " AND action = 'cust_bill_send_agent' ".
9238 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9239 " AND peo_agentnum.optionname = 'agentnum' ".
9240 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9242 CASE WHEN part_event_condition_option.optionname IS NULL
9244 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9246 , part_event.weight".
9250 unless ( $part_event_option ) {
9251 return $self->agent->invoice_template || ''
9252 if $option eq 'agent_templatename';
9256 $part_event_option->optionvalue;
9261 ## actual sub, not a method, designed to be called from the queue.
9262 ## sets up the customer, and calls the bill_and_collect
9263 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9264 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9265 $cust_main->bill_and_collect(
9270 sub _upgrade_data { #class method
9271 my ($class, %opts) = @_;
9273 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9274 my $sth = dbh->prepare($sql) or die dbh->errstr;
9275 $sth->execute or die $sth->errstr;
9285 The delete method should possibly take an FS::cust_main object reference
9286 instead of a scalar customer number.
9288 Bill and collect options should probably be passed as references instead of a
9291 There should probably be a configuration file with a list of allowed credit
9294 No multiple currency support (probably a larger project than just this module).
9296 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9298 Birthdates rely on negative epoch values.
9300 The payby for card/check batches is broken. With mixed batching, bad
9303 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9307 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9308 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9309 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.