4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
5 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
6 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 eval "use Time::Local;";
12 die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
13 if $] < 5.006 && !defined($Time::Local::VERSION);
14 #eval "use Time::Local qw(timelocal timelocal_nocheck);";
15 eval "use Time::Local qw(timelocal_nocheck);";
17 use Digest::MD5 qw(md5_base64);
21 use String::Approx qw(amatch);
22 use Business::CreditCard 0.28;
25 use FS::UID qw( getotaker dbh );
26 use FS::Record qw( qsearchs qsearch dbdef );
27 use FS::Misc qw( send_email );
28 use FS::Msgcat qw(gettext);
32 use FS::cust_bill_pkg;
34 use FS::cust_pay_void;
37 use FS::part_referral;
38 use FS::cust_main_county;
40 use FS::cust_main_invoice;
41 use FS::cust_credit_bill;
42 use FS::cust_bill_pay;
43 use FS::prepay_credit;
46 use FS::part_bill_event qw(due_events);
47 use FS::cust_bill_event;
48 use FS::cust_tax_exempt;
49 use FS::cust_tax_exempt_pkg;
51 use FS::payment_gateway;
52 use FS::agent_payment_gateway;
54 use FS::payinfo_Mixin;
56 @ISA = qw( FS::Record FS::payinfo_Mixin );
58 @EXPORT_OK = qw( smart_search );
60 $realtime_bop_decline_quiet = 0;
62 # 1 is mostly method/subroutine entry and options
63 # 2 traces progress of some operations
64 # 3 is even more information including possibly sensitive data
66 $me = '[FS::cust_main]';
70 $ignore_expired_card = 0;
72 @encrypted_fields = ('payinfo', 'paycvv');
73 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
75 #ask FS::UID to run this stuff for us later
76 #$FS::UID::callback{'FS::cust_main'} = sub {
77 install_callback FS::UID sub {
79 #yes, need it for stuff below (prolly should be cached)
84 my ( $hashref, $cache ) = @_;
85 if ( exists $hashref->{'pkgnum'} ) {
86 #@{ $self->{'_pkgnum'} } = ();
87 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
88 $self->{'_pkgnum'} = $subcache;
89 #push @{ $self->{'_pkgnum'} },
90 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
96 FS::cust_main - Object methods for cust_main records
102 $record = new FS::cust_main \%hash;
103 $record = new FS::cust_main { 'column' => 'value' };
105 $error = $record->insert;
107 $error = $new_record->replace($old_record);
109 $error = $record->delete;
111 $error = $record->check;
113 @cust_pkg = $record->all_pkgs;
115 @cust_pkg = $record->ncancelled_pkgs;
117 @cust_pkg = $record->suspended_pkgs;
119 $error = $record->bill;
120 $error = $record->bill %options;
121 $error = $record->bill 'time' => $time;
123 $error = $record->collect;
124 $error = $record->collect %options;
125 $error = $record->collect 'invoice_time' => $time,
130 An FS::cust_main object represents a customer. FS::cust_main inherits from
131 FS::Record. The following fields are currently supported:
135 =item custnum - primary key (assigned automatically for new customers)
137 =item agentnum - agent (see L<FS::agent>)
139 =item refnum - Advertising source (see L<FS::part_referral>)
145 =item ss - social security number (optional)
147 =item company - (optional)
151 =item address2 - (optional)
155 =item county - (optional, see L<FS::cust_main_county>)
157 =item state - (see L<FS::cust_main_county>)
161 =item country - (see L<FS::cust_main_county>)
163 =item daytime - phone (optional)
165 =item night - phone (optional)
167 =item fax - phone (optional)
169 =item ship_first - name
171 =item ship_last - name
173 =item ship_company - (optional)
177 =item ship_address2 - (optional)
181 =item ship_county - (optional, see L<FS::cust_main_county>)
183 =item ship_state - (see L<FS::cust_main_county>)
187 =item ship_country - (see L<FS::cust_main_county>)
189 =item ship_daytime - phone (optional)
191 =item ship_night - phone (optional)
193 =item ship_fax - phone (optional)
195 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
197 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
199 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
203 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
205 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
207 =item paystart_month - start date month (maestro/solo cards only)
209 =item paystart_year - start date year (maestro/solo cards only)
211 =item payissue - issue number (maestro/solo cards only)
213 =item payname - name on card or billing name
215 =item payip - IP address from which payment information was received
217 =item tax - tax exempt, empty or `Y'
219 =item otaker - order taker (assigned automatically, see L<FS::UID>)
221 =item comments - comments (optional)
223 =item referral_custnum - referring customer number
225 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
235 Creates a new customer. To add the customer to the database, see L<"insert">.
237 Note that this stores the hash reference, not a distinct copy of the hash it
238 points to. You can ask the object for a copy with the I<hash> method.
242 sub table { 'cust_main'; }
244 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
246 Adds this customer to the database. If there is an error, returns the error,
247 otherwise returns false.
249 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
250 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
251 are inserted atomicly, or the transaction is rolled back. Passing an empty
252 hash reference is equivalent to not supplying this parameter. There should be
253 a better explanation of this, but until then, here's an example:
256 tie %hash, 'Tie::RefHash'; #this part is important
258 $cust_pkg => [ $svc_acct ],
261 $cust_main->insert( \%hash );
263 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
264 be set as the invoicing list (see L<"invoicing_list">). Errors return as
265 expected and rollback the entire transaction; it is not necessary to call
266 check_invoicing_list first. The invoicing_list is set after the records in the
267 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
268 invoicing_list destination to the newly-created svc_acct. Here's an example:
270 $cust_main->insert( {}, [ $email, 'POST' ] );
272 Currently available options are: I<depend_jobnum> and I<noexport>.
274 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
275 on the supplied jobnum (they will not run until the specific job completes).
276 This can be used to defer provisioning until some action completes (such
277 as running the customer's credit card successfully).
279 The I<noexport> option is deprecated. If I<noexport> is set true, no
280 provisioning jobs (exports) are scheduled. (You can schedule them later with
281 the B<reexport> method.)
287 my $cust_pkgs = @_ ? shift : {};
288 my $invoicing_list = @_ ? shift : '';
290 warn "$me insert called with options ".
291 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
294 local $SIG{HUP} = 'IGNORE';
295 local $SIG{INT} = 'IGNORE';
296 local $SIG{QUIT} = 'IGNORE';
297 local $SIG{TERM} = 'IGNORE';
298 local $SIG{TSTP} = 'IGNORE';
299 local $SIG{PIPE} = 'IGNORE';
301 my $oldAutoCommit = $FS::UID::AutoCommit;
302 local $FS::UID::AutoCommit = 0;
305 my $prepay_identifier = '';
306 my( $amount, $seconds ) = ( 0, 0 );
308 if ( $self->payby eq 'PREPAY' ) {
310 $self->payby('BILL');
311 $prepay_identifier = $self->payinfo;
314 warn " looking up prepaid card $prepay_identifier\n"
317 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
319 $dbh->rollback if $oldAutoCommit;
320 #return "error applying prepaid card (transaction rolled back): $error";
324 $payby = 'PREP' if $amount;
326 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
329 $self->payby('BILL');
330 $amount = $self->paid;
334 warn " inserting $self\n"
337 $self->signupdate(time) unless $self->signupdate;
339 my $error = $self->SUPER::insert;
341 $dbh->rollback if $oldAutoCommit;
342 #return "inserting cust_main record (transaction rolled back): $error";
346 warn " setting invoicing list\n"
349 if ( $invoicing_list ) {
350 $error = $self->check_invoicing_list( $invoicing_list );
352 $dbh->rollback if $oldAutoCommit;
353 return "checking invoicing_list (transaction rolled back): $error";
355 $self->invoicing_list( $invoicing_list );
358 if ( $conf->config('cust_main-skeleton_tables')
359 && $conf->config('cust_main-skeleton_custnum') ) {
361 warn " inserting skeleton records\n"
364 my $error = $self->start_copy_skel;
366 $dbh->rollback if $oldAutoCommit;
372 warn " ordering packages\n"
375 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
377 $dbh->rollback if $oldAutoCommit;
382 $dbh->rollback if $oldAutoCommit;
383 return "No svc_acct record to apply pre-paid time";
387 warn " inserting initial $payby payment of $amount\n"
389 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
391 $dbh->rollback if $oldAutoCommit;
392 return "inserting payment (transaction rolled back): $error";
396 unless ( $import || $skip_fuzzyfiles ) {
397 warn " queueing fuzzyfiles update\n"
399 $error = $self->queue_fuzzyfiles_update;
401 $dbh->rollback if $oldAutoCommit;
402 return "updating fuzzy search cache: $error";
406 warn " insert complete; committing transaction\n"
409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
414 sub start_copy_skel {
417 #'mg_user_preference' => {},
418 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
419 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
420 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
421 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
422 my @tables = eval($conf->config_binary('cust_main-skeleton_tables'));
425 _copy_skel( 'cust_main', #tablename
426 $conf->config('cust_main-skeleton_custnum'), #sourceid
427 $self->custnum, #destid
428 @tables, #child tables
432 #recursive subroutine, not a method
434 my( $table, $sourceid, $destid, %child_tables ) = @_;
437 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
438 ( $table, $primary_key ) = ( $1, $2 );
440 my $dbdef_table = dbdef->table($table);
441 $primary_key = $dbdef_table->primary_key
442 or return "$table has no primary key".
443 " (or do you need to run dbdef-create?)";
446 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
447 join (', ', keys %child_tables). "\n"
450 foreach my $child_table_def ( keys %child_tables ) {
454 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
455 ( $child_table, $child_pkey ) = ( $1, $2 );
457 $child_table = $child_table_def;
459 $child_pkey = dbdef->table($child_table)->primary_key;
460 # or return "$table has no primary key".
461 # " (or do you need to run dbdef-create?)\n";
465 if ( keys %{ $child_tables{$child_table_def} } ) {
467 return "$child_table has no primary key".
468 " (run dbdef-create or try specifying it?)\n"
471 #false laziness w/Record::insert and only works on Pg
472 #refactor the proper last-inserted-id stuff out of Record::insert if this
473 # ever gets use for anything besides a quick kludge for one customer
474 my $default = dbdef->table($child_table)->column($child_pkey)->default;
475 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
476 or return "can't parse $child_table.$child_pkey default value ".
477 " for sequence name: $default";
482 my @sel_columns = grep { $_ ne $primary_key }
483 dbdef->table($child_table)->columns;
484 my $sel_columns = join(', ', @sel_columns );
486 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
487 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
488 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
490 my $sel_st = "SELECT $sel_columns FROM $child_table".
491 " WHERE $primary_key = $sourceid";
494 my $sel_sth = dbh->prepare( $sel_st )
495 or return dbh->errstr;
497 $sel_sth->execute or return $sel_sth->errstr;
499 while ( my $row = $sel_sth->fetchrow_hashref ) {
501 warn " selected row: ".
502 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
506 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
507 my $ins_sth =dbh->prepare($statement)
508 or return dbh->errstr;
509 my @param = ( $destid, map $row->{$_}, @ins_columns );
510 warn " $statement: [ ". join(', ', @param). " ]\n"
512 $ins_sth->execute( @param )
513 or return $ins_sth->errstr;
515 #next unless keys %{ $child_tables{$child_table} };
516 next unless $sequence;
518 #another section of that laziness
519 my $seq_sql = "SELECT currval('$sequence')";
520 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
521 $seq_sth->execute or return $seq_sth->errstr;
522 my $insertid = $seq_sth->fetchrow_arrayref->[0];
524 # don't drink soap! recurse! recurse! okay!
526 _copy_skel( $child_table_def,
527 $row->{$child_pkey}, #sourceid
529 %{ $child_tables{$child_table_def} },
531 return $error if $error;
541 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
543 Like the insert method on an existing record, this method orders a package
544 and included services atomicaly. Pass a Tie::RefHash data structure to this
545 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
546 be a better explanation of this, but until then, here's an example:
549 tie %hash, 'Tie::RefHash'; #this part is important
551 $cust_pkg => [ $svc_acct ],
554 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
556 Services can be new, in which case they are inserted, or existing unaudited
557 services, in which case they are linked to the newly-created package.
559 Currently available options are: I<depend_jobnum> and I<noexport>.
561 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
562 on the supplied jobnum (they will not run until the specific job completes).
563 This can be used to defer provisioning until some action completes (such
564 as running the customer's credit card successfully).
566 The I<noexport> option is deprecated. If I<noexport> is set true, no
567 provisioning jobs (exports) are scheduled. (You can schedule them later with
568 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
569 on the cust_main object is not recommended, as existing services will also be
576 my $cust_pkgs = shift;
579 my %svc_options = ();
580 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
581 if exists $options{'depend_jobnum'};
582 warn "$me order_pkgs called with options ".
583 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
586 local $SIG{HUP} = 'IGNORE';
587 local $SIG{INT} = 'IGNORE';
588 local $SIG{QUIT} = 'IGNORE';
589 local $SIG{TERM} = 'IGNORE';
590 local $SIG{TSTP} = 'IGNORE';
591 local $SIG{PIPE} = 'IGNORE';
593 my $oldAutoCommit = $FS::UID::AutoCommit;
594 local $FS::UID::AutoCommit = 0;
597 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
599 foreach my $cust_pkg ( keys %$cust_pkgs ) {
600 $cust_pkg->custnum( $self->custnum );
601 my $error = $cust_pkg->insert;
603 $dbh->rollback if $oldAutoCommit;
604 return "inserting cust_pkg (transaction rolled back): $error";
606 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
607 if ( $svc_something->svcnum ) {
608 my $old_cust_svc = $svc_something->cust_svc;
609 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
610 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
611 $error = $new_cust_svc->replace($old_cust_svc);
613 $svc_something->pkgnum( $cust_pkg->pkgnum );
614 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
615 $svc_something->seconds( $svc_something->seconds + $$seconds );
618 $error = $svc_something->insert(%svc_options);
621 $dbh->rollback if $oldAutoCommit;
622 #return "inserting svc_ (transaction rolled back): $error";
628 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
632 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
634 Recharges this (existing) customer with the specified prepaid card (see
635 L<FS::prepay_credit>), specified either by I<identifier> or as an
636 FS::prepay_credit object. If there is an error, returns the error, otherwise
639 Optionally, four scalar references can be passed as well. They will have their
640 values filled in with the amount, number of seconds, and number of upload and
641 download bytes applied by this prepaid
646 sub recharge_prepay {
647 my( $self, $prepay_credit, $amountref, $secondsref,
648 $upbytesref, $downbytesref, $totalbytesref ) = @_;
650 local $SIG{HUP} = 'IGNORE';
651 local $SIG{INT} = 'IGNORE';
652 local $SIG{QUIT} = 'IGNORE';
653 local $SIG{TERM} = 'IGNORE';
654 local $SIG{TSTP} = 'IGNORE';
655 local $SIG{PIPE} = 'IGNORE';
657 my $oldAutoCommit = $FS::UID::AutoCommit;
658 local $FS::UID::AutoCommit = 0;
661 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
663 my $error = $self->get_prepay($prepay_credit, \$amount,
664 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
665 || $self->increment_seconds($seconds)
666 || $self->increment_upbytes($upbytes)
667 || $self->increment_downbytes($downbytes)
668 || $self->increment_totalbytes($totalbytes)
669 || $self->insert_cust_pay_prepay( $amount,
671 ? $prepay_credit->identifier
676 $dbh->rollback if $oldAutoCommit;
680 if ( defined($amountref) ) { $$amountref = $amount; }
681 if ( defined($secondsref) ) { $$secondsref = $seconds; }
682 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
683 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
684 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
686 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
691 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
693 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
694 specified either by I<identifier> or as an FS::prepay_credit object.
696 References to I<amount> and I<seconds> scalars should be passed as arguments
697 and will be incremented by the values of the prepaid card.
699 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
700 check or set this customer's I<agentnum>.
702 If there is an error, returns the error, otherwise returns false.
708 my( $self, $prepay_credit, $amountref, $secondsref,
709 $upref, $downref, $totalref) = @_;
711 local $SIG{HUP} = 'IGNORE';
712 local $SIG{INT} = 'IGNORE';
713 local $SIG{QUIT} = 'IGNORE';
714 local $SIG{TERM} = 'IGNORE';
715 local $SIG{TSTP} = 'IGNORE';
716 local $SIG{PIPE} = 'IGNORE';
718 my $oldAutoCommit = $FS::UID::AutoCommit;
719 local $FS::UID::AutoCommit = 0;
722 unless ( ref($prepay_credit) ) {
724 my $identifier = $prepay_credit;
726 $prepay_credit = qsearchs(
728 { 'identifier' => $prepay_credit },
733 unless ( $prepay_credit ) {
734 $dbh->rollback if $oldAutoCommit;
735 return "Invalid prepaid card: ". $identifier;
740 if ( $prepay_credit->agentnum ) {
741 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
742 $dbh->rollback if $oldAutoCommit;
743 return "prepaid card not valid for agent ". $self->agentnum;
745 $self->agentnum($prepay_credit->agentnum);
748 my $error = $prepay_credit->delete;
750 $dbh->rollback if $oldAutoCommit;
751 return "removing prepay_credit (transaction rolled back): $error";
754 $$amountref += $prepay_credit->amount;
755 $$secondsref += $prepay_credit->seconds;
756 $$upref += $prepay_credit->upbytes;
757 $$downref += $prepay_credit->downbytes;
758 $$totalref += $prepay_credit->totalbytes;
760 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
765 =item increment_upbytes SECONDS
767 Updates this customer's single or primary account (see L<FS::svc_acct>) by
768 the specified number of upbytes. If there is an error, returns the error,
769 otherwise returns false.
773 sub increment_upbytes {
774 _increment_column( shift, 'upbytes', @_);
777 =item increment_downbytes SECONDS
779 Updates this customer's single or primary account (see L<FS::svc_acct>) by
780 the specified number of downbytes. If there is an error, returns the error,
781 otherwise returns false.
785 sub increment_downbytes {
786 _increment_column( shift, 'downbytes', @_);
789 =item increment_totalbytes SECONDS
791 Updates this customer's single or primary account (see L<FS::svc_acct>) by
792 the specified number of totalbytes. If there is an error, returns the error,
793 otherwise returns false.
797 sub increment_totalbytes {
798 _increment_column( shift, 'totalbytes', @_);
801 =item increment_seconds SECONDS
803 Updates this customer's single or primary account (see L<FS::svc_acct>) by
804 the specified number of seconds. If there is an error, returns the error,
805 otherwise returns false.
809 sub increment_seconds {
810 _increment_column( shift, 'seconds', @_);
813 =item _increment_column AMOUNT
815 Updates this customer's single or primary account (see L<FS::svc_acct>) by
816 the specified number of seconds or bytes. If there is an error, returns
817 the error, otherwise returns false.
821 sub _increment_column {
822 my( $self, $column, $amount ) = @_;
823 warn "$me increment_column called: $column, $amount\n"
826 return '' unless $amount;
828 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
829 $self->ncancelled_pkgs;
832 return 'No packages with primary or single services found'.
833 ' to apply pre-paid time';
834 } elsif ( scalar(@cust_pkg) > 1 ) {
835 #maybe have a way to specify the package/account?
836 return 'Multiple packages found to apply pre-paid time';
839 my $cust_pkg = $cust_pkg[0];
840 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
844 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
847 return 'No account found to apply pre-paid time';
848 } elsif ( scalar(@cust_svc) > 1 ) {
849 return 'Multiple accounts found to apply pre-paid time';
852 my $svc_acct = $cust_svc[0]->svc_x;
853 warn " found service svcnum ". $svc_acct->pkgnum.
854 ' ('. $svc_acct->email. ")\n"
857 $column = "increment_$column";
858 $svc_acct->$column($amount);
862 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
864 Inserts a prepayment in the specified amount for this customer. An optional
865 second argument can specify the prepayment identifier for tracking purposes.
866 If there is an error, returns the error, otherwise returns false.
870 sub insert_cust_pay_prepay {
871 shift->insert_cust_pay('PREP', @_);
874 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
876 Inserts a cash payment in the specified amount for this customer. An optional
877 second argument can specify the payment identifier for tracking purposes.
878 If there is an error, returns the error, otherwise returns false.
882 sub insert_cust_pay_cash {
883 shift->insert_cust_pay('CASH', @_);
886 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
888 Inserts a Western Union payment in the specified amount for this customer. An
889 optional second argument can specify the prepayment identifier for tracking
890 purposes. If there is an error, returns the error, otherwise returns false.
894 sub insert_cust_pay_west {
895 shift->insert_cust_pay('WEST', @_);
898 sub insert_cust_pay {
899 my( $self, $payby, $amount ) = splice(@_, 0, 3);
900 my $payinfo = scalar(@_) ? shift : '';
902 my $cust_pay = new FS::cust_pay {
903 'custnum' => $self->custnum,
904 'paid' => sprintf('%.2f', $amount),
905 #'_date' => #date the prepaid card was purchased???
907 'payinfo' => $payinfo,
915 This method is deprecated. See the I<depend_jobnum> option to the insert and
916 order_pkgs methods for a better way to defer provisioning.
918 Re-schedules all exports by calling the B<reexport> method of all associated
919 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
920 otherwise returns false.
927 carp "WARNING: FS::cust_main::reexport is deprectated; ".
928 "use the depend_jobnum option to insert or order_pkgs to delay export";
930 local $SIG{HUP} = 'IGNORE';
931 local $SIG{INT} = 'IGNORE';
932 local $SIG{QUIT} = 'IGNORE';
933 local $SIG{TERM} = 'IGNORE';
934 local $SIG{TSTP} = 'IGNORE';
935 local $SIG{PIPE} = 'IGNORE';
937 my $oldAutoCommit = $FS::UID::AutoCommit;
938 local $FS::UID::AutoCommit = 0;
941 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
942 my $error = $cust_pkg->reexport;
944 $dbh->rollback if $oldAutoCommit;
949 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
954 =item delete NEW_CUSTNUM
956 This deletes the customer. If there is an error, returns the error, otherwise
959 This will completely remove all traces of the customer record. This is not
960 what you want when a customer cancels service; for that, cancel all of the
961 customer's packages (see L</cancel>).
963 If the customer has any uncancelled packages, you need to pass a new (valid)
964 customer number for those packages to be transferred to. Cancelled packages
965 will be deleted. Did I mention that this is NOT what you want when a customer
966 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
968 You can't delete a customer with invoices (see L<FS::cust_bill>),
969 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
970 refunds (see L<FS::cust_refund>).
977 local $SIG{HUP} = 'IGNORE';
978 local $SIG{INT} = 'IGNORE';
979 local $SIG{QUIT} = 'IGNORE';
980 local $SIG{TERM} = 'IGNORE';
981 local $SIG{TSTP} = 'IGNORE';
982 local $SIG{PIPE} = 'IGNORE';
984 my $oldAutoCommit = $FS::UID::AutoCommit;
985 local $FS::UID::AutoCommit = 0;
988 if ( $self->cust_bill ) {
989 $dbh->rollback if $oldAutoCommit;
990 return "Can't delete a customer with invoices";
992 if ( $self->cust_credit ) {
993 $dbh->rollback if $oldAutoCommit;
994 return "Can't delete a customer with credits";
996 if ( $self->cust_pay ) {
997 $dbh->rollback if $oldAutoCommit;
998 return "Can't delete a customer with payments";
1000 if ( $self->cust_refund ) {
1001 $dbh->rollback if $oldAutoCommit;
1002 return "Can't delete a customer with refunds";
1005 my @cust_pkg = $self->ncancelled_pkgs;
1007 my $new_custnum = shift;
1008 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1009 $dbh->rollback if $oldAutoCommit;
1010 return "Invalid new customer number: $new_custnum";
1012 foreach my $cust_pkg ( @cust_pkg ) {
1013 my %hash = $cust_pkg->hash;
1014 $hash{'custnum'} = $new_custnum;
1015 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1016 my $error = $new_cust_pkg->replace($cust_pkg,
1017 options => { $cust_pkg->options },
1020 $dbh->rollback if $oldAutoCommit;
1025 my @cancelled_cust_pkg = $self->all_pkgs;
1026 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1027 my $error = $cust_pkg->delete;
1029 $dbh->rollback if $oldAutoCommit;
1034 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1035 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1037 my $error = $cust_main_invoice->delete;
1039 $dbh->rollback if $oldAutoCommit;
1044 my $error = $self->SUPER::delete;
1046 $dbh->rollback if $oldAutoCommit;
1050 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1055 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1057 Replaces the OLD_RECORD with this one in the database. If there is an error,
1058 returns the error, otherwise returns false.
1060 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1061 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1062 expected and rollback the entire transaction; it is not necessary to call
1063 check_invoicing_list first. Here's an example:
1065 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1073 warn "$me replace called\n"
1076 local $SIG{HUP} = 'IGNORE';
1077 local $SIG{INT} = 'IGNORE';
1078 local $SIG{QUIT} = 'IGNORE';
1079 local $SIG{TERM} = 'IGNORE';
1080 local $SIG{TSTP} = 'IGNORE';
1081 local $SIG{PIPE} = 'IGNORE';
1083 # We absolutely have to have an old vs. new record to make this work.
1084 if (!defined($old)) {
1085 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1088 my $curuser = $FS::CurrentUser::CurrentUser;
1089 if ( $self->payby eq 'COMP'
1090 && $self->payby ne $old->payby
1091 && ! $curuser->access_right('Complimentary customer')
1094 return "You are not permitted to create complimentary accounts.";
1097 local($ignore_expired_card) = 1
1098 if $old->payby =~ /^(CARD|DCRD)$/
1099 && $self->payby =~ /^(CARD|DCRD)$/
1100 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1102 my $oldAutoCommit = $FS::UID::AutoCommit;
1103 local $FS::UID::AutoCommit = 0;
1106 my $error = $self->SUPER::replace($old);
1109 $dbh->rollback if $oldAutoCommit;
1113 if ( @param ) { # INVOICING_LIST_ARYREF
1114 my $invoicing_list = shift @param;
1115 $error = $self->check_invoicing_list( $invoicing_list );
1117 $dbh->rollback if $oldAutoCommit;
1120 $self->invoicing_list( $invoicing_list );
1123 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1124 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1125 # card/check/lec info has changed, want to retry realtime_ invoice events
1126 my $error = $self->retry_realtime;
1128 $dbh->rollback if $oldAutoCommit;
1133 unless ( $import || $skip_fuzzyfiles ) {
1134 $error = $self->queue_fuzzyfiles_update;
1136 $dbh->rollback if $oldAutoCommit;
1137 return "updating fuzzy search cache: $error";
1141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1146 =item queue_fuzzyfiles_update
1148 Used by insert & replace to update the fuzzy search cache
1152 sub queue_fuzzyfiles_update {
1155 local $SIG{HUP} = 'IGNORE';
1156 local $SIG{INT} = 'IGNORE';
1157 local $SIG{QUIT} = 'IGNORE';
1158 local $SIG{TERM} = 'IGNORE';
1159 local $SIG{TSTP} = 'IGNORE';
1160 local $SIG{PIPE} = 'IGNORE';
1162 my $oldAutoCommit = $FS::UID::AutoCommit;
1163 local $FS::UID::AutoCommit = 0;
1166 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1167 my $error = $queue->insert( map $self->getfield($_),
1168 qw(first last company)
1171 $dbh->rollback if $oldAutoCommit;
1172 return "queueing job (transaction rolled back): $error";
1175 if ( $self->ship_last ) {
1176 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1177 $error = $queue->insert( map $self->getfield("ship_$_"),
1178 qw(first last company)
1181 $dbh->rollback if $oldAutoCommit;
1182 return "queueing job (transaction rolled back): $error";
1186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1193 Checks all fields to make sure this is a valid customer record. If there is
1194 an error, returns the error, otherwise returns false. Called by the insert
1195 and replace methods.
1202 warn "$me check BEFORE: \n". $self->_dump
1206 $self->ut_numbern('custnum')
1207 || $self->ut_number('agentnum')
1208 || $self->ut_textn('agent_custid')
1209 || $self->ut_number('refnum')
1210 || $self->ut_name('last')
1211 || $self->ut_name('first')
1212 || $self->ut_snumbern('birthdate')
1213 || $self->ut_snumbern('signupdate')
1214 || $self->ut_textn('company')
1215 || $self->ut_text('address1')
1216 || $self->ut_textn('address2')
1217 || $self->ut_text('city')
1218 || $self->ut_textn('county')
1219 || $self->ut_textn('state')
1220 || $self->ut_country('country')
1221 || $self->ut_anything('comments')
1222 || $self->ut_numbern('referral_custnum')
1224 #barf. need message catalogs. i18n. etc.
1225 $error .= "Please select an advertising source."
1226 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1227 return $error if $error;
1229 return "Unknown agent"
1230 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1232 return "Unknown refnum"
1233 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1235 return "Unknown referring custnum: ". $self->referral_custnum
1236 unless ! $self->referral_custnum
1237 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1239 if ( $self->ss eq '' ) {
1244 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1245 or return "Illegal social security number: ". $self->ss;
1246 $self->ss("$1-$2-$3");
1250 # bad idea to disable, causes billing to fail because of no tax rates later
1251 # unless ( $import ) {
1252 unless ( qsearch('cust_main_county', {
1253 'country' => $self->country,
1256 return "Unknown state/county/country: ".
1257 $self->state. "/". $self->county. "/". $self->country
1258 unless qsearch('cust_main_county',{
1259 'state' => $self->state,
1260 'county' => $self->county,
1261 'country' => $self->country,
1267 $self->ut_phonen('daytime', $self->country)
1268 || $self->ut_phonen('night', $self->country)
1269 || $self->ut_phonen('fax', $self->country)
1270 || $self->ut_zip('zip', $self->country)
1272 return $error if $error;
1275 last first company address1 address2 city county state zip
1276 country daytime night fax
1279 if ( defined $self->dbdef_table->column('ship_last') ) {
1280 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1282 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1286 $self->ut_name('ship_last')
1287 || $self->ut_name('ship_first')
1288 || $self->ut_textn('ship_company')
1289 || $self->ut_text('ship_address1')
1290 || $self->ut_textn('ship_address2')
1291 || $self->ut_text('ship_city')
1292 || $self->ut_textn('ship_county')
1293 || $self->ut_textn('ship_state')
1294 || $self->ut_country('ship_country')
1296 return $error if $error;
1298 #false laziness with above
1299 unless ( qsearchs('cust_main_county', {
1300 'country' => $self->ship_country,
1303 return "Unknown ship_state/ship_county/ship_country: ".
1304 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1305 unless qsearch('cust_main_county',{
1306 'state' => $self->ship_state,
1307 'county' => $self->ship_county,
1308 'country' => $self->ship_country,
1314 $self->ut_phonen('ship_daytime', $self->ship_country)
1315 || $self->ut_phonen('ship_night', $self->ship_country)
1316 || $self->ut_phonen('ship_fax', $self->ship_country)
1317 || $self->ut_zip('ship_zip', $self->ship_country)
1319 return $error if $error;
1321 } else { # ship_ info eq billing info, so don't store dup info in database
1322 $self->setfield("ship_$_", '')
1323 foreach qw( last first company address1 address2 city county state zip
1324 country daytime night fax );
1328 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1329 # or return "Illegal payby: ". $self->payby;
1331 FS::payby->can_payby($self->table, $self->payby)
1332 or return "Illegal payby: ". $self->payby;
1334 $error = $self->ut_numbern('paystart_month')
1335 || $self->ut_numbern('paystart_year')
1336 || $self->ut_numbern('payissue')
1337 || $self->ut_textn('paytype')
1339 return $error if $error;
1341 if ( $self->payip eq '' ) {
1344 $error = $self->ut_ip('payip');
1345 return $error if $error;
1348 # If it is encrypted and the private key is not availaible then we can't
1349 # check the credit card.
1351 my $check_payinfo = 1;
1353 if ($self->is_encrypted($self->payinfo)) {
1357 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1359 my $payinfo = $self->payinfo;
1360 $payinfo =~ s/\D//g;
1361 $payinfo =~ /^(\d{13,16})$/
1362 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1364 $self->payinfo($payinfo);
1366 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1368 return gettext('unknown_card_type')
1369 if cardtype($self->payinfo) eq "Unknown";
1371 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1373 return 'Banned credit card: banned on '.
1374 time2str('%a %h %o at %r', $ban->_date).
1375 ' by '. $ban->otaker.
1376 ' (ban# '. $ban->bannum. ')';
1379 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1380 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1381 $self->paycvv =~ /^(\d{4})$/
1382 or return "CVV2 (CID) for American Express cards is four digits.";
1385 $self->paycvv =~ /^(\d{3})$/
1386 or return "CVV2 (CVC2/CID) is three digits.";
1393 my $cardtype = cardtype($payinfo);
1394 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1396 return "Start date or issue number is required for $cardtype cards"
1397 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1399 return "Start month must be between 1 and 12"
1400 if $self->paystart_month
1401 and $self->paystart_month < 1 || $self->paystart_month > 12;
1403 return "Start year must be 1990 or later"
1404 if $self->paystart_year
1405 and $self->paystart_year < 1990;
1407 return "Issue number must be beween 1 and 99"
1409 and $self->payissue < 1 || $self->payissue > 99;
1412 $self->paystart_month('');
1413 $self->paystart_year('');
1414 $self->payissue('');
1417 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1419 my $payinfo = $self->payinfo;
1420 $payinfo =~ s/[^\d\@]//g;
1421 if ( $conf->exists('echeck-nonus') ) {
1422 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1423 $payinfo = "$1\@$2";
1425 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1426 $payinfo = "$1\@$2";
1428 $self->payinfo($payinfo);
1431 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1433 return 'Banned ACH account: banned on '.
1434 time2str('%a %h %o at %r', $ban->_date).
1435 ' by '. $ban->otaker.
1436 ' (ban# '. $ban->bannum. ')';
1439 } elsif ( $self->payby eq 'LECB' ) {
1441 my $payinfo = $self->payinfo;
1442 $payinfo =~ s/\D//g;
1443 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1445 $self->payinfo($payinfo);
1448 } elsif ( $self->payby eq 'BILL' ) {
1450 $error = $self->ut_textn('payinfo');
1451 return "Illegal P.O. number: ". $self->payinfo if $error;
1454 } elsif ( $self->payby eq 'COMP' ) {
1456 my $curuser = $FS::CurrentUser::CurrentUser;
1457 if ( ! $self->custnum
1458 && ! $curuser->access_right('Complimentary customer')
1461 return "You are not permitted to create complimentary accounts."
1464 $error = $self->ut_textn('payinfo');
1465 return "Illegal comp account issuer: ". $self->payinfo if $error;
1468 } elsif ( $self->payby eq 'PREPAY' ) {
1470 my $payinfo = $self->payinfo;
1471 $payinfo =~ s/\W//g; #anything else would just confuse things
1472 $self->payinfo($payinfo);
1473 $error = $self->ut_alpha('payinfo');
1474 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1475 return "Unknown prepayment identifier"
1476 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1481 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1482 return "Expiration date required"
1483 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1487 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1488 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1489 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1490 ( $m, $y ) = ( $3, "20$2" );
1492 return "Illegal expiration date: ". $self->paydate;
1494 $self->paydate("$y-$m-01");
1495 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1496 return gettext('expired_card')
1498 && !$ignore_expired_card
1499 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1502 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1503 ( ! $conf->exists('require_cardname')
1504 || $self->payby !~ /^(CARD|DCRD)$/ )
1506 $self->payname( $self->first. " ". $self->getfield('last') );
1508 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1509 or return gettext('illegal_name'). " payname: ". $self->payname;
1513 foreach my $flag (qw( tax spool_cdr )) {
1514 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1518 $self->otaker(getotaker) unless $self->otaker;
1520 warn "$me check AFTER: \n". $self->_dump
1523 $self->SUPER::check;
1528 Returns all packages (see L<FS::cust_pkg>) for this customer.
1535 return $self->num_pkgs unless wantarray;
1538 if ( $self->{'_pkgnum'} ) {
1539 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1541 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1544 sort sort_packages @cust_pkg;
1547 =item ncancelled_pkgs
1549 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1553 sub ncancelled_pkgs {
1556 return $self->num_ncancelled_pkgs unless wantarray;
1559 if ( $self->{'_pkgnum'} ) {
1561 @cust_pkg = grep { ! $_->getfield('cancel') }
1562 values %{ $self->{'_pkgnum'}->cache };
1567 qsearch( 'cust_pkg', {
1568 'custnum' => $self->custnum,
1572 qsearch( 'cust_pkg', {
1573 'custnum' => $self->custnum,
1578 sort sort_packages @cust_pkg;
1582 # This should be generalized to use config options to determine order.
1584 if ( $a->get('cancel') and $b->get('cancel') ) {
1585 $a->pkgnum <=> $b->pkgnum;
1586 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1587 return -1 if $b->get('cancel');
1588 return 1 if $a->get('cancel');
1591 $a->pkgnum <=> $b->pkgnum;
1595 =item suspended_pkgs
1597 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1601 sub suspended_pkgs {
1603 grep { $_->susp } $self->ncancelled_pkgs;
1606 =item unflagged_suspended_pkgs
1608 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1609 customer (thouse packages without the `manual_flag' set).
1613 sub unflagged_suspended_pkgs {
1615 return $self->suspended_pkgs
1616 unless dbdef->table('cust_pkg')->column('manual_flag');
1617 grep { ! $_->manual_flag } $self->suspended_pkgs;
1620 =item unsuspended_pkgs
1622 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1627 sub unsuspended_pkgs {
1629 grep { ! $_->susp } $self->ncancelled_pkgs;
1632 =item num_cancelled_pkgs
1634 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1639 sub num_cancelled_pkgs {
1640 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1643 sub num_ncancelled_pkgs {
1644 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1648 my( $self, $sql ) = @_;
1649 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1650 my $sth = dbh->prepare(
1651 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1652 ) or die dbh->errstr;
1653 $sth->execute($self->custnum) or die $sth->errstr;
1654 $sth->fetchrow_arrayref->[0];
1659 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1660 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1661 on success or a list of errors.
1667 grep { $_->unsuspend } $self->suspended_pkgs;
1672 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1674 Returns a list: an empty list on success or a list of errors.
1680 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1683 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1685 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1686 PKGPARTs (see L<FS::part_pkg>).
1688 Returns a list: an empty list on success or a list of errors.
1692 sub suspend_if_pkgpart {
1694 my (@pkgparts, %opt);
1695 if (ref($_[0]) eq 'HASH'){
1696 @pkgparts = @{$_[0]{pkgparts}};
1701 grep { $_->suspend(%opt) }
1702 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1703 $self->unsuspended_pkgs;
1706 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1708 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1709 listed PKGPARTs (see L<FS::part_pkg>).
1711 Returns a list: an empty list on success or a list of errors.
1715 sub suspend_unless_pkgpart {
1717 my (@pkgparts, %opt);
1718 if (ref($_[0]) eq 'HASH'){
1719 @pkgparts = @{$_[0]{pkgparts}};
1724 grep { $_->suspend(%opt) }
1725 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1726 $self->unsuspended_pkgs;
1729 =item cancel [ OPTION => VALUE ... ]
1731 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1733 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1735 I<quiet> can be set true to supress email cancellation notices.
1737 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1739 I<ban> can be set true to ban this customer's credit card or ACH information,
1742 Always returns a list: an empty list on success or a list of errors.
1750 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1752 #should try decryption (we might have the private key)
1753 # and if not maybe queue a job for the server that does?
1754 return ( "Can't (yet) ban encrypted credit cards" )
1755 if $self->is_encrypted($self->payinfo);
1757 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1758 my $error = $ban->insert;
1759 return ( $error ) if $error;
1763 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1766 sub _banned_pay_hashref {
1777 'payby' => $payby2ban{$self->payby},
1778 'payinfo' => md5_base64($self->payinfo),
1779 #don't ever *search* on reason! #'reason' =>
1785 Returns all notes (see L<FS::cust_main_note>) for this customer.
1792 qsearch( 'cust_main_note',
1793 { 'custnum' => $self->custnum },
1795 'ORDER BY _DATE DESC'
1801 Returns the agent (see L<FS::agent>) for this customer.
1807 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1812 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1813 conjunction with the collect method.
1815 Options are passed as name-value pairs.
1817 Currently available options are:
1819 resetup - if set true, re-charges setup fees.
1821 time - bills the customer as if it were that time. Specified as a UNIX
1822 timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
1823 L<Date::Parse> for conversion functions. For example:
1827 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1830 If there is an error, returns the error, otherwise returns false.
1835 my( $self, %options ) = @_;
1836 return '' if $self->payby eq 'COMP';
1837 warn "$me bill customer ". $self->custnum. "\n"
1840 my $time = $options{'time'} || time;
1845 local $SIG{HUP} = 'IGNORE';
1846 local $SIG{INT} = 'IGNORE';
1847 local $SIG{QUIT} = 'IGNORE';
1848 local $SIG{TERM} = 'IGNORE';
1849 local $SIG{TSTP} = 'IGNORE';
1850 local $SIG{PIPE} = 'IGNORE';
1852 my $oldAutoCommit = $FS::UID::AutoCommit;
1853 local $FS::UID::AutoCommit = 0;
1856 $self->select_for_update; #mutex
1858 #create a new invoice
1859 #(we'll remove it later if it doesn't actually need to be generated [contains
1860 # no line items] and we're inside a transaciton so nothing else will see it)
1861 my $cust_bill = new FS::cust_bill ( {
1862 'custnum' => $self->custnum,
1864 #'charged' => $charged,
1867 $error = $cust_bill->insert;
1869 $dbh->rollback if $oldAutoCommit;
1870 return "can't create invoice for customer #". $self->custnum. ": $error";
1872 my $invnum = $cust_bill->invnum;
1875 # find the packages which are due for billing, find out how much they are
1876 # & generate invoice database.
1879 my( $total_setup, $total_recur ) = ( 0, 0 );
1881 my @precommit_hooks = ();
1883 foreach my $cust_pkg (
1884 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1887 #NO!! next if $cust_pkg->cancel;
1888 next if $cust_pkg->getfield('cancel');
1890 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1892 #? to avoid use of uninitialized value errors... ?
1893 $cust_pkg->setfield('bill', '')
1894 unless defined($cust_pkg->bill);
1896 my $part_pkg = $cust_pkg->part_pkg;
1898 my %hash = $cust_pkg->hash;
1899 my $old_cust_pkg = new FS::cust_pkg \%hash;
1908 if ( ! $cust_pkg->setup &&
1910 ( $conf->exists('disable_setup_suspended_pkgs') &&
1911 ! $cust_pkg->getfield('susp')
1912 ) || ! $conf->exists('disable_setup_suspended_pkgs')
1914 || $options{'resetup'}
1917 warn " bill setup\n" if $DEBUG > 1;
1919 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
1921 $dbh->rollback if $oldAutoCommit;
1922 return "$@ running calc_setup for $cust_pkg\n";
1925 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1929 # bill recurring fee
1934 if ( $part_pkg->getfield('freq') ne '0' &&
1935 ! $cust_pkg->getfield('susp') &&
1936 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1939 warn " bill recur\n" if $DEBUG > 1;
1941 # XXX shared with $recur_prog
1942 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1944 #over two params! lets at least switch to a hashref for the rest...
1945 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1947 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1949 $dbh->rollback if $oldAutoCommit;
1950 return "$@ running calc_recur for $cust_pkg\n";
1953 #change this bit to use Date::Manip? CAREFUL with timezones (see
1954 # mailing list archive)
1955 my ($sec,$min,$hour,$mday,$mon,$year) =
1956 (localtime($sdate) )[0,1,2,3,4,5];
1958 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1959 # only for figuring next bill date, nothing else, so, reset $sdate again
1961 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1962 $cust_pkg->last_bill($sdate)
1963 if $cust_pkg->dbdef_table->column('last_bill');
1965 if ( $part_pkg->freq =~ /^\d+$/ ) {
1966 $mon += $part_pkg->freq;
1967 until ( $mon < 12 ) { $mon -= 12; $year++; }
1968 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1970 $mday += $weeks * 7;
1971 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1974 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1978 $dbh->rollback if $oldAutoCommit;
1979 return "unparsable frequency: ". $part_pkg->freq;
1981 $cust_pkg->setfield('bill',
1982 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1985 warn "\$setup is undefined" unless defined($setup);
1986 warn "\$recur is undefined" unless defined($recur);
1987 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1990 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1993 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
1995 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1998 $error=$cust_pkg->replace($old_cust_pkg,
1999 options => { $cust_pkg->options },
2001 if ( $error ) { #just in case
2002 $dbh->rollback if $oldAutoCommit;
2003 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2006 $setup = sprintf( "%.2f", $setup );
2007 $recur = sprintf( "%.2f", $recur );
2008 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2009 $dbh->rollback if $oldAutoCommit;
2010 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2012 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2013 $dbh->rollback if $oldAutoCommit;
2014 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2017 if ( $setup != 0 || $recur != 0 ) {
2019 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2021 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2022 'invnum' => $invnum,
2023 'pkgnum' => $cust_pkg->pkgnum,
2027 'edate' => $cust_pkg->bill,
2028 'details' => \@details,
2030 $error = $cust_bill_pkg->insert;
2032 $dbh->rollback if $oldAutoCommit;
2033 return "can't create invoice line item for invoice #$invnum: $error";
2035 $total_setup += $setup;
2036 $total_recur += $recur;
2042 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2045 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2048 my %taxhash = map { $_ => $self->get("$prefix$_") }
2049 qw( state county country );
2051 $taxhash{'taxclass'} = $part_pkg->taxclass;
2053 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2056 $taxhash{'taxclass'} = '';
2057 @taxes = qsearch( 'cust_main_county', \%taxhash );
2060 #one more try at a whole-country tax rate
2062 $taxhash{$_} = '' foreach qw( state county );
2063 @taxes = qsearch( 'cust_main_county', \%taxhash );
2066 # maybe eliminate this entirely, along with all the 0% records
2068 $dbh->rollback if $oldAutoCommit;
2070 "fatal: can't find tax rate for state/county/country/taxclass ".
2071 join('/', ( map $self->get("$prefix$_"),
2072 qw(state county country)
2074 $part_pkg->taxclass ). "\n";
2077 foreach my $tax ( @taxes ) {
2079 my $taxable_charged = 0;
2080 $taxable_charged += $setup
2081 unless $part_pkg->setuptax =~ /^Y$/i
2082 || $tax->setuptax =~ /^Y$/i;
2083 $taxable_charged += $recur
2084 unless $part_pkg->recurtax =~ /^Y$/i
2085 || $tax->recurtax =~ /^Y$/i;
2086 next unless $taxable_charged;
2088 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2089 #my ($mon,$year) = (localtime($sdate) )[4,5];
2090 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2092 my $freq = $part_pkg->freq || 1;
2093 if ( $freq !~ /(\d+)$/ ) {
2094 $dbh->rollback if $oldAutoCommit;
2095 return "daily/weekly package definitions not (yet?)".
2096 " compatible with monthly tax exemptions";
2098 my $taxable_per_month =
2099 sprintf("%.2f", $taxable_charged / $freq );
2101 #call the whole thing off if this customer has any old
2102 #exemption records...
2103 my @cust_tax_exempt =
2104 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2105 if ( @cust_tax_exempt ) {
2106 $dbh->rollback if $oldAutoCommit;
2108 'this customer still has old-style tax exemption records; '.
2109 'run bin/fs-migrate-cust_tax_exempt?';
2112 foreach my $which_month ( 1 .. $freq ) {
2114 #maintain the new exemption table now
2117 FROM cust_tax_exempt_pkg
2118 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2119 LEFT JOIN cust_bill USING ( invnum )
2125 my $sth = dbh->prepare($sql) or do {
2126 $dbh->rollback if $oldAutoCommit;
2127 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2135 $dbh->rollback if $oldAutoCommit;
2136 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2138 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2140 my $remaining_exemption =
2141 $tax->exempt_amount - $existing_exemption;
2142 if ( $remaining_exemption > 0 ) {
2143 my $addl = $remaining_exemption > $taxable_per_month
2144 ? $taxable_per_month
2145 : $remaining_exemption;
2146 $taxable_charged -= $addl;
2148 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2149 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2150 'taxnum' => $tax->taxnum,
2151 'year' => 1900+$year,
2153 'amount' => sprintf("%.2f", $addl ),
2155 $error = $cust_tax_exempt_pkg->insert;
2157 $dbh->rollback if $oldAutoCommit;
2158 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2160 } # if $remaining_exemption > 0
2164 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2165 until ( $mon < 13 ) { $mon -= 12; $year++; }
2167 } #foreach $which_month
2169 } #if $tax->exempt_amount
2171 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2173 #$tax += $taxable_charged * $cust_main_county->tax / 100
2174 $tax{ $tax->taxname || 'Tax' } +=
2175 $taxable_charged * $tax->tax / 100
2177 } #foreach my $tax ( @taxes )
2179 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2181 } #if $setup != 0 || $recur != 0
2183 } #if $cust_pkg->modified
2185 } #foreach my $cust_pkg
2187 unless ( $cust_bill->cust_bill_pkg ) {
2188 $cust_bill->delete; #don't create an invoice w/o line items
2189 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2193 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2195 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2196 my $tax = sprintf("%.2f", $tax{$taxname} );
2197 $charged = sprintf( "%.2f", $charged+$tax );
2199 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2200 'invnum' => $invnum,
2206 'itemdesc' => $taxname,
2208 $error = $cust_bill_pkg->insert;
2210 $dbh->rollback if $oldAutoCommit;
2211 return "can't create invoice line item for invoice #$invnum: $error";
2213 $total_setup += $tax;
2217 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2218 $error = $cust_bill->replace;
2220 $dbh->rollback if $oldAutoCommit;
2221 return "can't update charged for invoice #$invnum: $error";
2224 foreach my $hook ( @precommit_hooks ) {
2226 &{$hook}; #($self) ?
2229 $dbh->rollback if $oldAutoCommit;
2230 return "$@ running precommit hook $hook\n";
2234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2238 =item collect OPTIONS
2240 (Attempt to) collect money for this customer's outstanding invoices (see
2241 L<FS::cust_bill>). Usually used after the bill method.
2243 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2244 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2245 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2247 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2248 and the invoice events web interface.
2250 If there is an error, returns the error, otherwise returns false.
2252 Options are passed as name-value pairs.
2254 Currently available options are:
2256 invoice_time - Use this time when deciding when to print invoices and
2257 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>
2258 for conversion functions.
2260 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2263 quiet - set true to surpress email card/ACH decline notices.
2265 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2268 payby - allows for one time override of normal customer billing method
2273 my( $self, %options ) = @_;
2274 my $invoice_time = $options{'invoice_time'} || time;
2277 local $SIG{HUP} = 'IGNORE';
2278 local $SIG{INT} = 'IGNORE';
2279 local $SIG{QUIT} = 'IGNORE';
2280 local $SIG{TERM} = 'IGNORE';
2281 local $SIG{TSTP} = 'IGNORE';
2282 local $SIG{PIPE} = 'IGNORE';
2284 my $oldAutoCommit = $FS::UID::AutoCommit;
2285 local $FS::UID::AutoCommit = 0;
2288 $self->select_for_update; #mutex
2290 my $balance = $self->balance;
2291 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2293 unless ( $balance > 0 ) { #redundant?????
2294 $dbh->rollback if $oldAutoCommit; #hmm
2298 if ( exists($options{'retry_card'}) ) {
2299 carp 'retry_card option passed to collect is deprecated; use retry';
2300 $options{'retry'} ||= $options{'retry_card'};
2302 if ( exists($options{'retry'}) && $options{'retry'} ) {
2303 my $error = $self->retry_realtime;
2305 $dbh->rollback if $oldAutoCommit;
2311 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2312 $extra_sql = " AND freq = '1m' ";
2314 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2317 foreach my $cust_bill ( $self->open_cust_bill ) {
2319 # don't try to charge for the same invoice if it's already in a batch
2320 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2322 last if $self->balance <= 0;
2324 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2327 foreach my $part_bill_event ( due_events ( $cust_bill,
2328 exists($options{'payby'})
2334 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2335 || $self->balance <= 0; # or if balance<=0
2338 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2339 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2342 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2343 # gah, even with transactions.
2344 $dbh->commit if $oldAutoCommit; #well.
2353 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2358 =item retry_realtime
2360 Schedules realtime / batch credit card / electronic check / LEC billing
2361 events for for retry. Useful if card information has changed or manual
2362 retry is desired. The 'collect' method must be called to actually retry
2365 Implementation details: For each of this customer's open invoices, changes
2366 the status of the first "done" (with statustext error) realtime processing
2371 sub retry_realtime {
2374 local $SIG{HUP} = 'IGNORE';
2375 local $SIG{INT} = 'IGNORE';
2376 local $SIG{QUIT} = 'IGNORE';
2377 local $SIG{TERM} = 'IGNORE';
2378 local $SIG{TSTP} = 'IGNORE';
2379 local $SIG{PIPE} = 'IGNORE';
2381 my $oldAutoCommit = $FS::UID::AutoCommit;
2382 local $FS::UID::AutoCommit = 0;
2385 foreach my $cust_bill (
2386 grep { $_->cust_bill_event }
2387 $self->open_cust_bill
2389 my @cust_bill_event =
2390 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2392 #$_->part_bill_event->plan eq 'realtime-card'
2393 $_->part_bill_event->eventcode =~
2394 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2395 && $_->status eq 'done'
2398 $cust_bill->cust_bill_event;
2399 next unless @cust_bill_event;
2400 my $error = $cust_bill_event[0]->retry;
2402 $dbh->rollback if $oldAutoCommit;
2403 return "error scheduling invoice event for retry: $error";
2408 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2413 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2415 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2416 via a Business::OnlinePayment realtime gateway. See
2417 L<http://420.am/business-onlinepayment> for supported gateways.
2419 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2421 Available options are: I<description>, I<invnum>, I<quiet>
2423 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2424 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2425 if set, will override the value from the customer record.
2427 I<description> is a free-text field passed to the gateway. It defaults to
2428 "Internet services".
2430 If an I<invnum> is specified, this payment (if successful) is applied to the
2431 specified invoice. If you don't specify an I<invnum> you might want to
2432 call the B<apply_payments> method.
2434 I<quiet> can be set true to surpress email decline notices.
2436 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2441 my( $self, $method, $amount, %options ) = @_;
2443 warn "$me realtime_bop: $method $amount\n";
2444 warn " $_ => $options{$_}\n" foreach keys %options;
2447 $options{'description'} ||= 'Internet services';
2449 eval "use Business::OnlinePayment";
2452 my $payinfo = exists($options{'payinfo'})
2453 ? $options{'payinfo'}
2461 if ( $options{'invnum'} ) {
2462 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2463 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2465 map { $_->part_pkg->taxclass }
2467 map { $_->cust_pkg }
2468 $cust_bill->cust_bill_pkg;
2469 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2470 #different taxclasses
2471 $taxclass = $taxclasses[0];
2475 #look for an agent gateway override first
2477 if ( $method eq 'CC' ) {
2478 $cardtype = cardtype($payinfo);
2479 } elsif ( $method eq 'ECHECK' ) {
2482 $cardtype = $method;
2486 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2487 cardtype => $cardtype,
2488 taxclass => $taxclass, } )
2489 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2491 taxclass => $taxclass, } )
2492 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2493 cardtype => $cardtype,
2495 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2497 taxclass => '', } );
2499 my $payment_gateway = '';
2500 my( $processor, $login, $password, $action, @bop_options );
2501 if ( $override ) { #use a payment gateway override
2503 $payment_gateway = $override->payment_gateway;
2505 $processor = $payment_gateway->gateway_module;
2506 $login = $payment_gateway->gateway_username;
2507 $password = $payment_gateway->gateway_password;
2508 $action = $payment_gateway->gateway_action;
2509 @bop_options = $payment_gateway->options;
2511 } else { #use the standard settings from the config
2513 ( $processor, $login, $password, $action, @bop_options ) =
2514 $self->default_payment_gateway($method);
2522 my $address = exists($options{'address1'})
2523 ? $options{'address1'}
2525 my $address2 = exists($options{'address2'})
2526 ? $options{'address2'}
2528 $address .= ", ". $address2 if length($address2);
2530 my $o_payname = exists($options{'payname'})
2531 ? $options{'payname'}
2533 my($payname, $payfirst, $paylast);
2534 if ( $o_payname && $method ne 'ECHECK' ) {
2535 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2536 or return "Illegal payname $payname";
2537 ($payfirst, $paylast) = ($1, $2);
2539 $payfirst = $self->getfield('first');
2540 $paylast = $self->getfield('last');
2541 $payname = "$payfirst $paylast";
2544 my @invoicing_list = $self->invoicing_list_emailonly;
2545 if ( $conf->exists('emailinvoiceautoalways')
2546 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2547 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2548 push @invoicing_list, $self->all_emails;
2551 my $email = ($conf->exists('business-onlinepayment-email-override'))
2552 ? $conf->config('business-onlinepayment-email-override')
2553 : $invoicing_list[0];
2557 my $payip = exists($options{'payip'})
2560 $content{customer_ip} = $payip
2563 $content{invoice_number} = $options{'invnum'}
2564 if exists($options{'invnum'}) && length($options{'invnum'});
2566 if ( $method eq 'CC' ) {
2568 $content{card_number} = $payinfo;
2569 my $paydate = exists($options{'paydate'})
2570 ? $options{'paydate'}
2572 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2573 $content{expiration} = "$2/$1";
2575 my $paycvv = exists($options{'paycvv'})
2576 ? $options{'paycvv'}
2578 $content{cvv2} = $self->paycvv
2581 my $paystart_month = exists($options{'paystart_month'})
2582 ? $options{'paystart_month'}
2583 : $self->paystart_month;
2585 my $paystart_year = exists($options{'paystart_year'})
2586 ? $options{'paystart_year'}
2587 : $self->paystart_year;
2589 $content{card_start} = "$paystart_month/$paystart_year"
2590 if $paystart_month && $paystart_year;
2592 my $payissue = exists($options{'payissue'})
2593 ? $options{'payissue'}
2595 $content{issue_number} = $payissue if $payissue;
2597 $content{recurring_billing} = 'YES'
2598 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2600 'payinfo' => $payinfo,
2602 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2604 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2608 } elsif ( $method eq 'ECHECK' ) {
2609 ( $content{account_number}, $content{routing_code} ) =
2610 split('@', $payinfo);
2611 $content{bank_name} = $o_payname;
2612 $content{bank_state} = $self->getfield('paystate');
2613 $content{account_type} = uc($self->getfield('paytype')) || 'CHECKING';
2614 $content{account_name} = $payname;
2615 $content{customer_org} = $self->company ? 'B' : 'I';
2616 $content{state_id} = $self->getfield('stateid');
2617 $content{state_id_state} = $self->getfield('stateid_state');
2618 $content{customer_ssn} = exists($options{'ss'})
2621 } elsif ( $method eq 'LEC' ) {
2622 $content{phone} = $payinfo;
2626 # run transaction(s)
2629 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2631 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2632 $transaction->content(
2635 'password' => $password,
2636 'action' => $action1,
2637 'description' => $options{'description'},
2638 'amount' => $amount,
2639 #'invoice_number' => $options{'invnum'},
2640 'customer_id' => $self->custnum,
2641 'last_name' => $paylast,
2642 'first_name' => $payfirst,
2644 'address' => $address,
2645 'city' => ( exists($options{'city'})
2648 'state' => ( exists($options{'state'})
2651 'zip' => ( exists($options{'zip'})
2654 'country' => ( exists($options{'country'})
2655 ? $options{'country'}
2657 'referer' => 'http://cleanwhisker.420.am/',
2659 'phone' => $self->daytime || $self->night,
2662 $transaction->submit();
2664 if ( $transaction->is_success() && $action2 ) {
2665 my $auth = $transaction->authorization;
2666 my $ordernum = $transaction->can('order_number')
2667 ? $transaction->order_number
2671 new Business::OnlinePayment( $processor, @bop_options );
2678 password => $password,
2679 order_number => $ordernum,
2681 authorization => $auth,
2682 description => $options{'description'},
2685 foreach my $field (qw( authorization_source_code returned_ACI
2686 transaction_identifier validation_code
2687 transaction_sequence_num local_transaction_date
2688 local_transaction_time AVS_result_code )) {
2689 $capture{$field} = $transaction->$field() if $transaction->can($field);
2692 $capture->content( %capture );
2696 unless ( $capture->is_success ) {
2697 my $e = "Authorization successful but capture failed, custnum #".
2698 $self->custnum. ': '. $capture->result_code.
2699 ": ". $capture->error_message;
2707 # remove paycvv after initial transaction
2710 #false laziness w/misc/process/payment.cgi - check both to make sure working
2712 if ( defined $self->dbdef_table->column('paycvv')
2713 && length($self->paycvv)
2714 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2716 my $error = $self->remove_cvv;
2718 warn "WARNING: error removing cvv: $error\n";
2726 if ( $transaction->is_success() ) {
2728 my %method2payby = (
2735 if ( $payment_gateway ) { # agent override
2736 $paybatch = $payment_gateway->gatewaynum. '-';
2739 $paybatch .= "$processor:". $transaction->authorization;
2741 $paybatch .= ':'. $transaction->order_number
2742 if $transaction->can('order_number')
2743 && length($transaction->order_number);
2745 my $cust_pay = new FS::cust_pay ( {
2746 'custnum' => $self->custnum,
2747 'invnum' => $options{'invnum'},
2750 'payby' => $method2payby{$method},
2751 'payinfo' => $payinfo,
2752 'paybatch' => $paybatch,
2754 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
2756 $cust_pay->invnum(''); #try again with no specific invnum
2757 my $error2 = $cust_pay->insert( $options{'manual'} ?
2758 ( 'manual' => 1 ) : ()
2761 # gah, even with transactions.
2762 my $e = 'WARNING: Card/ACH debited but database not updated - '.
2763 "error inserting payment ($processor): $error2".
2764 " (previously tried insert with invnum #$options{'invnum'}" .
2770 return ''; #no error
2774 my $perror = "$processor error: ". $transaction->error_message;
2776 unless ( $transaction->error_message ) {
2779 #this should be normalized :/
2781 # bad, ad-hoc B:OP:PayflowPro "transaction_response" BS
2782 if ( $transaction->can('param')
2783 && $transaction->param('transaction_response') ) {
2784 $t_response = $transaction->param('transaction_response')
2786 # slightly better, ad-hoc B:OP:TransactionCentral without "param"
2787 } elsif ( $transaction->can('response_page') ) {
2789 'page' => ( $transaction->can('response_page')
2790 ? $transaction->response_page
2793 'code' => ( $transaction->can('response_code')
2794 ? $transaction->response_code
2797 'headers' => ( $transaction->can('response_headers')
2798 ? $transaction->response_headers
2804 "No additional debugging information available for $processor";
2807 $perror .= "No error_message returned from $processor -- ".
2808 ( ref($t_response) ? Dumper($t_response) : $t_response );
2812 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2813 && $conf->exists('emaildecline')
2814 && grep { $_ ne 'POST' } $self->invoicing_list
2815 && ! grep { $transaction->error_message =~ /$_/ }
2816 $conf->config('emaildecline-exclude')
2818 my @templ = $conf->config('declinetemplate');
2819 my $template = new Text::Template (
2821 SOURCE => [ map "$_\n", @templ ],
2822 ) or return "($perror) can't create template: $Text::Template::ERROR";
2823 $template->compile()
2824 or return "($perror) can't compile template: $Text::Template::ERROR";
2826 my $templ_hash = { error => $transaction->error_message };
2828 my $error = send_email(
2829 'from' => $conf->config('invoice_from'),
2830 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2831 'subject' => 'Your payment could not be processed',
2832 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2835 $perror .= " (also received error sending decline notification: $error)"
2845 =item default_payment_gateway
2849 sub default_payment_gateway {
2850 my( $self, $method ) = @_;
2852 die "Real-time processing not enabled\n"
2853 unless $conf->exists('business-onlinepayment');
2856 my $bop_config = 'business-onlinepayment';
2857 $bop_config .= '-ach'
2858 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2859 my ( $processor, $login, $password, $action, @bop_options ) =
2860 $conf->config($bop_config);
2861 $action ||= 'normal authorization';
2862 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2863 die "No real-time processor is enabled - ".
2864 "did you set the business-onlinepayment configuration value?\n"
2867 ( $processor, $login, $password, $action, @bop_options )
2872 Removes the I<paycvv> field from the database directly.
2874 If there is an error, returns the error, otherwise returns false.
2880 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2881 or return dbh->errstr;
2882 $sth->execute($self->custnum)
2883 or return $sth->errstr;
2888 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2890 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2891 via a Business::OnlinePayment realtime gateway. See
2892 L<http://420.am/business-onlinepayment> for supported gateways.
2894 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2896 Available options are: I<amount>, I<reason>, I<paynum>
2898 Most gateways require a reference to an original payment transaction to refund,
2899 so you probably need to specify a I<paynum>.
2901 I<amount> defaults to the original amount of the payment if not specified.
2903 I<reason> specifies a reason for the refund.
2905 Implementation note: If I<amount> is unspecified or equal to the amount of the
2906 orignal payment, first an attempt is made to "void" the transaction via
2907 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2908 the normal attempt is made to "refund" ("credit") the transaction via the
2909 gateway is attempted.
2911 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2912 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2913 #if set, will override the value from the customer record.
2915 #If an I<invnum> is specified, this payment (if successful) is applied to the
2916 #specified invoice. If you don't specify an I<invnum> you might want to
2917 #call the B<apply_payments> method.
2921 #some false laziness w/realtime_bop, not enough to make it worth merging
2922 #but some useful small subs should be pulled out
2923 sub realtime_refund_bop {
2924 my( $self, $method, %options ) = @_;
2926 warn "$me realtime_refund_bop: $method refund\n";
2927 warn " $_ => $options{$_}\n" foreach keys %options;
2930 eval "use Business::OnlinePayment";
2934 # look up the original payment and optionally a gateway for that payment
2938 my $amount = $options{'amount'};
2940 my( $processor, $login, $password, @bop_options ) ;
2941 my( $auth, $order_number ) = ( '', '', '' );
2943 if ( $options{'paynum'} ) {
2945 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
2946 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2947 or return "Unknown paynum $options{'paynum'}";
2948 $amount ||= $cust_pay->paid;
2950 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
2951 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2952 $cust_pay->paybatch;
2953 my $gatewaynum = '';
2954 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2956 if ( $gatewaynum ) { #gateway for the payment to be refunded
2958 my $payment_gateway =
2959 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2960 die "payment gateway $gatewaynum not found"
2961 unless $payment_gateway;
2963 $processor = $payment_gateway->gateway_module;
2964 $login = $payment_gateway->gateway_username;
2965 $password = $payment_gateway->gateway_password;
2966 @bop_options = $payment_gateway->options;
2968 } else { #try the default gateway
2970 my( $conf_processor, $unused_action );
2971 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2972 $self->default_payment_gateway($method);
2974 return "processor of payment $options{'paynum'} $processor does not".
2975 " match default processor $conf_processor"
2976 unless $processor eq $conf_processor;
2981 } else { # didn't specify a paynum, so look for agent gateway overrides
2982 # like a normal transaction
2985 if ( $method eq 'CC' ) {
2986 $cardtype = cardtype($self->payinfo);
2987 } elsif ( $method eq 'ECHECK' ) {
2990 $cardtype = $method;
2993 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2994 cardtype => $cardtype,
2996 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2998 taxclass => '', } );
3000 if ( $override ) { #use a payment gateway override
3002 my $payment_gateway = $override->payment_gateway;
3004 $processor = $payment_gateway->gateway_module;
3005 $login = $payment_gateway->gateway_username;
3006 $password = $payment_gateway->gateway_password;
3007 #$action = $payment_gateway->gateway_action;
3008 @bop_options = $payment_gateway->options;
3010 } else { #use the standard settings from the config
3013 ( $processor, $login, $password, $unused_action, @bop_options ) =
3014 $self->default_payment_gateway($method);
3019 return "neither amount nor paynum specified" unless $amount;
3024 'password' => $password,
3025 'order_number' => $order_number,
3026 'amount' => $amount,
3027 'referer' => 'http://cleanwhisker.420.am/',
3029 $content{authorization} = $auth
3030 if length($auth); #echeck/ACH transactions have an order # but no auth
3031 #(at least with authorize.net)
3033 #first try void if applicable
3034 if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
3035 warn " attempting void\n" if $DEBUG > 1;
3036 my $void = new Business::OnlinePayment( $processor, @bop_options );
3037 $void->content( 'action' => 'void', %content );
3039 if ( $void->is_success ) {
3040 my $error = $cust_pay->void($options{'reason'});
3042 # gah, even with transactions.
3043 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3044 "error voiding payment: $error";
3048 warn " void successful\n" if $DEBUG > 1;
3053 warn " void unsuccessful, trying refund\n"
3057 my $address = $self->address1;
3058 $address .= ", ". $self->address2 if $self->address2;
3060 my($payname, $payfirst, $paylast);
3061 if ( $self->payname && $method ne 'ECHECK' ) {
3062 $payname = $self->payname;
3063 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3064 or return "Illegal payname $payname";
3065 ($payfirst, $paylast) = ($1, $2);
3067 $payfirst = $self->getfield('first');
3068 $paylast = $self->getfield('last');
3069 $payname = "$payfirst $paylast";
3072 my @invoicing_list = $self->invoicing_list_emailonly;
3073 if ( $conf->exists('emailinvoiceautoalways')
3074 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3075 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3076 push @invoicing_list, $self->all_emails;
3079 my $email = ($conf->exists('business-onlinepayment-email-override'))
3080 ? $conf->config('business-onlinepayment-email-override')
3081 : $invoicing_list[0];
3083 my $payip = exists($options{'payip'})
3086 $content{customer_ip} = $payip
3090 if ( $method eq 'CC' ) {
3093 $content{card_number} = $payinfo = $cust_pay->payinfo;
3094 #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3095 #$content{expiration} = "$2/$1";
3097 $content{card_number} = $payinfo = $self->payinfo;
3098 $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3099 $content{expiration} = "$2/$1";
3102 } elsif ( $method eq 'ECHECK' ) {
3103 ( $content{account_number}, $content{routing_code} ) =
3104 split('@', $payinfo = $self->payinfo);
3105 $content{bank_name} = $self->payname;
3106 $content{account_type} = 'CHECKING';
3107 $content{account_name} = $payname;
3108 $content{customer_org} = $self->company ? 'B' : 'I';
3109 $content{customer_ssn} = $self->ss;
3110 } elsif ( $method eq 'LEC' ) {
3111 $content{phone} = $payinfo = $self->payinfo;
3115 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3116 my %sub_content = $refund->content(
3117 'action' => 'credit',
3118 'customer_id' => $self->custnum,
3119 'last_name' => $paylast,
3120 'first_name' => $payfirst,
3122 'address' => $address,
3123 'city' => $self->city,
3124 'state' => $self->state,
3125 'zip' => $self->zip,
3126 'country' => $self->country,
3128 'phone' => $self->daytime || $self->night,
3131 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3135 return "$processor error: ". $refund->error_message
3136 unless $refund->is_success();
3138 my %method2payby = (
3144 my $paybatch = "$processor:". $refund->authorization;
3145 $paybatch .= ':'. $refund->order_number
3146 if $refund->can('order_number') && $refund->order_number;
3148 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3149 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3150 last unless @cust_bill_pay;
3151 my $cust_bill_pay = pop @cust_bill_pay;
3152 my $error = $cust_bill_pay->delete;
3156 my $cust_refund = new FS::cust_refund ( {
3157 'custnum' => $self->custnum,
3158 'paynum' => $options{'paynum'},
3159 'refund' => $amount,
3161 'payby' => $method2payby{$method},
3162 'payinfo' => $payinfo,
3163 'paybatch' => $paybatch,
3164 'reason' => $options{'reason'} || 'card or ACH refund',
3166 my $error = $cust_refund->insert;
3168 $cust_refund->paynum(''); #try again with no specific paynum
3169 my $error2 = $cust_refund->insert;
3171 # gah, even with transactions.
3172 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3173 "error inserting refund ($processor): $error2".
3174 " (previously tried insert with paynum #$options{'paynum'}" .
3187 Returns the total owed for this customer on all invoices
3188 (see L<FS::cust_bill/owed>).
3194 $self->total_owed_date(2145859200); #12/31/2037
3197 =item total_owed_date TIME
3199 Returns the total owed for this customer on all invoices with date earlier than
3200 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3201 see L<Time::Local> and L<Date::Parse> for conversion functions.
3205 sub total_owed_date {
3209 foreach my $cust_bill (
3210 grep { $_->_date <= $time }
3211 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3213 $total_bill += $cust_bill->owed;
3215 sprintf( "%.2f", $total_bill );
3218 =item apply_payments_and_credits
3220 Applies unapplied payments and credits.
3222 In most cases, this new method should be used in place of sequential
3223 apply_payments and apply_credits methods.
3227 sub apply_payments_and_credits {
3230 foreach my $cust_bill ( $self->open_cust_bill ) {
3231 $cust_bill->apply_payments_and_credits;
3236 =item apply_credits OPTION => VALUE ...
3238 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3239 to outstanding invoice balances in chronological order (or reverse
3240 chronological order if the I<order> option is set to B<newest>) and returns the
3241 value of any remaining unapplied credits available for refund (see
3242 L<FS::cust_refund>).
3250 return 0 unless $self->total_credited;
3252 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3253 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3255 my @invoices = $self->open_cust_bill;
3256 @invoices = sort { $b->_date <=> $a->_date } @invoices
3257 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3260 foreach my $cust_bill ( @invoices ) {
3263 if ( !defined($credit) || $credit->credited == 0) {
3264 $credit = pop @credits or last;
3267 if ($cust_bill->owed >= $credit->credited) {
3268 $amount=$credit->credited;
3270 $amount=$cust_bill->owed;
3273 my $cust_credit_bill = new FS::cust_credit_bill ( {
3274 'crednum' => $credit->crednum,
3275 'invnum' => $cust_bill->invnum,
3276 'amount' => $amount,
3278 my $error = $cust_credit_bill->insert;
3279 die $error if $error;
3281 redo if ($cust_bill->owed > 0);
3285 return $self->total_credited;
3288 =item apply_payments
3290 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3291 to outstanding invoice balances in chronological order.
3293 #and returns the value of any remaining unapplied payments.
3297 sub apply_payments {
3302 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3303 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3305 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3306 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3310 foreach my $cust_bill ( @invoices ) {
3313 if ( !defined($payment) || $payment->unapplied == 0 ) {
3314 $payment = pop @payments or last;
3317 if ( $cust_bill->owed >= $payment->unapplied ) {
3318 $amount = $payment->unapplied;
3320 $amount = $cust_bill->owed;
3323 my $cust_bill_pay = new FS::cust_bill_pay ( {
3324 'paynum' => $payment->paynum,
3325 'invnum' => $cust_bill->invnum,
3326 'amount' => $amount,
3328 my $error = $cust_bill_pay->insert;
3329 die $error if $error;
3331 redo if ( $cust_bill->owed > 0);
3335 return $self->total_unapplied_payments;
3338 =item total_credited
3340 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3341 customer. See L<FS::cust_credit/credited>.
3345 sub total_credited {
3347 my $total_credit = 0;
3348 foreach my $cust_credit ( qsearch('cust_credit', {
3349 'custnum' => $self->custnum,
3351 $total_credit += $cust_credit->credited;
3353 sprintf( "%.2f", $total_credit );
3356 =item total_unapplied_payments
3358 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3359 See L<FS::cust_pay/unapplied>.
3363 sub total_unapplied_payments {
3365 my $total_unapplied = 0;
3366 foreach my $cust_pay ( qsearch('cust_pay', {
3367 'custnum' => $self->custnum,
3369 $total_unapplied += $cust_pay->unapplied;
3371 sprintf( "%.2f", $total_unapplied );
3376 Returns the balance for this customer (total_owed minus total_credited
3377 minus total_unapplied_payments).
3384 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3388 =item balance_date TIME
3390 Returns the balance for this customer, only considering invoices with date
3391 earlier than TIME (total_owed_date minus total_credited minus
3392 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3393 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3402 $self->total_owed_date($time)
3403 - $self->total_credited
3404 - $self->total_unapplied_payments
3408 =item in_transit_payments
3410 Returns the total of requests for payments for this customer pending in
3411 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3415 sub in_transit_payments {
3417 my $in_transit_payments = 0;
3418 foreach my $pay_batch ( qsearch('pay_batch', {
3421 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3422 'batchnum' => $pay_batch->batchnum,
3423 'custnum' => $self->custnum,
3425 $in_transit_payments += $cust_pay_batch->amount;
3428 sprintf( "%.2f", $in_transit_payments );
3431 =item paydate_monthyear
3433 Returns a two-element list consisting of the month and year of this customer's
3434 paydate (credit card expiration date for CARD customers)
3438 sub paydate_monthyear {
3440 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3442 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3449 =item invoicing_list [ ARRAYREF ]
3451 If an arguement is given, sets these email addresses as invoice recipients
3452 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3453 (except as warnings), so use check_invoicing_list first.
3455 Returns a list of email addresses (with svcnum entries expanded).
3457 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3458 check it without disturbing anything by passing nothing.
3460 This interface may change in the future.
3464 sub invoicing_list {
3465 my( $self, $arrayref ) = @_;
3468 my @cust_main_invoice;
3469 if ( $self->custnum ) {
3470 @cust_main_invoice =
3471 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3473 @cust_main_invoice = ();
3475 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3476 #warn $cust_main_invoice->destnum;
3477 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3478 #warn $cust_main_invoice->destnum;
3479 my $error = $cust_main_invoice->delete;
3480 warn $error if $error;
3483 if ( $self->custnum ) {
3484 @cust_main_invoice =
3485 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3487 @cust_main_invoice = ();
3489 my %seen = map { $_->address => 1 } @cust_main_invoice;
3490 foreach my $address ( @{$arrayref} ) {
3491 next if exists $seen{$address} && $seen{$address};
3492 $seen{$address} = 1;
3493 my $cust_main_invoice = new FS::cust_main_invoice ( {
3494 'custnum' => $self->custnum,
3497 my $error = $cust_main_invoice->insert;
3498 warn $error if $error;
3502 if ( $self->custnum ) {
3504 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3511 =item check_invoicing_list ARRAYREF
3513 Checks these arguements as valid input for the invoicing_list method. If there
3514 is an error, returns the error, otherwise returns false.
3518 sub check_invoicing_list {
3519 my( $self, $arrayref ) = @_;
3520 foreach my $address ( @{$arrayref} ) {
3522 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3523 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3526 my $cust_main_invoice = new FS::cust_main_invoice ( {
3527 'custnum' => $self->custnum,
3530 my $error = $self->custnum
3531 ? $cust_main_invoice->check
3532 : $cust_main_invoice->checkdest
3534 return $error if $error;
3539 =item set_default_invoicing_list
3541 Sets the invoicing list to all accounts associated with this customer,
3542 overwriting any previous invoicing list.
3546 sub set_default_invoicing_list {
3548 $self->invoicing_list($self->all_emails);
3553 Returns the email addresses of all accounts provisioned for this customer.
3560 foreach my $cust_pkg ( $self->all_pkgs ) {
3561 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3563 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3564 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3566 $list{$_}=1 foreach map { $_->email } @svc_acct;
3571 =item invoicing_list_addpost
3573 Adds postal invoicing to this customer. If this customer is already configured
3574 to receive postal invoices, does nothing.
3578 sub invoicing_list_addpost {
3580 return if grep { $_ eq 'POST' } $self->invoicing_list;
3581 my @invoicing_list = $self->invoicing_list;
3582 push @invoicing_list, 'POST';
3583 $self->invoicing_list(\@invoicing_list);
3586 =item invoicing_list_emailonly
3588 Returns the list of email invoice recipients (invoicing_list without non-email
3589 destinations such as POST and FAX).
3593 sub invoicing_list_emailonly {
3595 warn "$me invoicing_list_emailonly called"
3597 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3600 =item invoicing_list_emailonly_scalar
3602 Returns the list of email invoice recipients (invoicing_list without non-email
3603 destinations such as POST and FAX) as a comma-separated scalar.
3607 sub invoicing_list_emailonly_scalar {
3609 warn "$me invoicing_list_emailonly_scalar called"
3611 join(', ', $self->invoicing_list_emailonly);
3614 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3616 Returns an array of customers referred by this customer (referral_custnum set
3617 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3618 customers referred by customers referred by this customer and so on, inclusive.
3619 The default behavior is DEPTH 1 (no recursion).
3623 sub referral_cust_main {
3625 my $depth = @_ ? shift : 1;
3626 my $exclude = @_ ? shift : {};
3629 map { $exclude->{$_->custnum}++; $_; }
3630 grep { ! $exclude->{ $_->custnum } }
3631 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3635 map { $_->referral_cust_main($depth-1, $exclude) }
3642 =item referral_cust_main_ncancelled
3644 Same as referral_cust_main, except only returns customers with uncancelled
3649 sub referral_cust_main_ncancelled {
3651 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3654 =item referral_cust_pkg [ DEPTH ]
3656 Like referral_cust_main, except returns a flat list of all unsuspended (and
3657 uncancelled) packages for each customer. The number of items in this list may
3658 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3662 sub referral_cust_pkg {
3664 my $depth = @_ ? shift : 1;
3666 map { $_->unsuspended_pkgs }
3667 grep { $_->unsuspended_pkgs }
3668 $self->referral_cust_main($depth);
3671 =item referring_cust_main
3673 Returns the single cust_main record for the customer who referred this customer
3674 (referral_custnum), or false.
3678 sub referring_cust_main {
3680 return '' unless $self->referral_custnum;
3681 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3684 =item credit AMOUNT, REASON
3686 Applies a credit to this customer. If there is an error, returns the error,
3687 otherwise returns false.
3692 my( $self, $amount, $reason ) = @_;
3693 my $cust_credit = new FS::cust_credit {
3694 'custnum' => $self->custnum,
3695 'amount' => $amount,
3696 'reason' => $reason,
3698 $cust_credit->insert;
3701 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3703 Creates a one-time charge for this customer. If there is an error, returns
3704 the error, otherwise returns false.
3710 my ( $amount, $pkg, $comment, $taxclass, $additional );
3711 if ( ref( $_[0] ) ) {
3712 $amount = $_[0]->{amount};
3713 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3714 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3715 : '$'. sprintf("%.2f",$amount);
3716 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3717 $additional = $_[0]->{additional};
3720 $pkg = @_ ? shift : 'One-time charge';
3721 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3722 $taxclass = @_ ? shift : '';
3726 local $SIG{HUP} = 'IGNORE';
3727 local $SIG{INT} = 'IGNORE';
3728 local $SIG{QUIT} = 'IGNORE';
3729 local $SIG{TERM} = 'IGNORE';
3730 local $SIG{TSTP} = 'IGNORE';
3731 local $SIG{PIPE} = 'IGNORE';
3733 my $oldAutoCommit = $FS::UID::AutoCommit;
3734 local $FS::UID::AutoCommit = 0;
3737 my $part_pkg = new FS::part_pkg ( {
3739 'comment' => $comment,
3743 'taxclass' => $taxclass,
3746 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3747 ( 0 .. @$additional - 1 )
3749 'additional_count' => scalar(@$additional),
3750 'setup_fee' => $amount,
3753 my $error = $part_pkg->insert( options => \%options );
3755 $dbh->rollback if $oldAutoCommit;
3759 my $pkgpart = $part_pkg->pkgpart;
3760 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3761 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3762 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3763 $error = $type_pkgs->insert;
3765 $dbh->rollback if $oldAutoCommit;
3770 my $cust_pkg = new FS::cust_pkg ( {
3771 'custnum' => $self->custnum,
3772 'pkgpart' => $pkgpart,
3775 $error = $cust_pkg->insert;
3777 $dbh->rollback if $oldAutoCommit;
3781 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3788 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3794 sort { $a->_date <=> $b->_date }
3795 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3798 =item open_cust_bill
3800 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3805 sub open_cust_bill {
3807 grep { $_->owed > 0 } $self->cust_bill;
3812 Returns all the credits (see L<FS::cust_credit>) for this customer.
3818 sort { $a->_date <=> $b->_date }
3819 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3824 Returns all the payments (see L<FS::cust_pay>) for this customer.
3830 sort { $a->_date <=> $b->_date }
3831 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3836 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3842 sort { $a->_date <=> $b->_date }
3843 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3849 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3855 sort { $a->_date <=> $b->_date }
3856 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3861 Returns a name string for this customer, either "Company (Last, First)" or
3868 my $name = $self->contact;
3869 $name = $self->company. " ($name)" if $self->company;
3875 Returns a name string for this (service/shipping) contact, either
3876 "Company (Last, First)" or "Last, First".
3882 if ( $self->get('ship_last') ) {
3883 my $name = $self->ship_contact;
3884 $name = $self->ship_company. " ($name)" if $self->ship_company;
3893 Returns this customer's full (billing) contact name only, "Last, First"
3899 $self->get('last'). ', '. $self->first;
3904 Returns this customer's full (shipping) contact name only, "Last, First"
3910 $self->get('ship_last')
3911 ? $self->get('ship_last'). ', '. $self->ship_first
3917 Returns this customer's full country name
3923 code2country($self->country);
3930 Returns a status string for this customer, currently:
3934 =item prospect - No packages have ever been ordered
3936 =item active - One or more recurring packages is active
3938 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3940 =item suspended - All non-cancelled recurring packages are suspended
3942 =item cancelled - All recurring packages are cancelled
3948 sub status { shift->cust_status(@_); }
3952 for my $status (qw( prospect active inactive suspended cancelled )) {
3953 my $method = $status.'_sql';
3954 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3955 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3956 $sth->execute( ($self->custnum) x $numnum )
3957 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3958 return $status if $sth->fetchrow_arrayref->[0];
3962 =item ucfirst_cust_status
3964 =item ucfirst_status
3966 Returns the status with the first character capitalized.
3970 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
3972 sub ucfirst_cust_status {
3974 ucfirst($self->cust_status);
3979 Returns a hex triplet color string for this customer's status.
3983 use vars qw(%statuscolor);
3985 'prospect' => '7e0079', #'000000', #black? naw, purple
3986 'active' => '00CC00', #green
3987 'inactive' => '0000CC', #blue
3988 'suspended' => 'FF9900', #yellow
3989 'cancelled' => 'FF0000', #red
3992 sub statuscolor { shift->cust_statuscolor(@_); }
3994 sub cust_statuscolor {
3996 $statuscolor{$self->cust_status};
4001 =head1 CLASS METHODS
4007 Returns an SQL expression identifying prospective cust_main records (customers
4008 with no packages ever ordered)
4012 use vars qw($select_count_pkgs);
4013 $select_count_pkgs =
4014 "SELECT COUNT(*) FROM cust_pkg
4015 WHERE cust_pkg.custnum = cust_main.custnum";
4017 sub select_count_pkgs_sql {
4021 sub prospect_sql { "
4022 0 = ( $select_count_pkgs )
4027 Returns an SQL expression identifying active cust_main records (customers with
4028 no active recurring packages, but otherwise unsuspended/uncancelled).
4033 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4039 Returns an SQL expression identifying inactive cust_main records (customers with
4040 active recurring packages).
4044 sub inactive_sql { "
4045 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4047 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4053 Returns an SQL expression identifying suspended cust_main records.
4058 sub suspended_sql { susp_sql(@_); }
4060 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4062 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4068 Returns an SQL expression identifying cancelled cust_main records.
4072 sub cancelled_sql { cancel_sql(@_); }
4075 my $recurring_sql = FS::cust_pkg->recurring_sql;
4076 #my $recurring_sql = "
4077 # '0' != ( select freq from part_pkg
4078 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4082 0 < ( $select_count_pkgs )
4083 AND 0 = ( $select_count_pkgs AND $recurring_sql
4084 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4090 =item uncancelled_sql
4092 Returns an SQL expression identifying un-cancelled cust_main records.
4096 sub uncancelled_sql { uncancel_sql(@_); }
4097 sub uncancel_sql { "
4098 ( 0 < ( $select_count_pkgs
4099 AND ( cust_pkg.cancel IS NULL
4100 OR cust_pkg.cancel = 0
4103 OR 0 = ( $select_count_pkgs )
4107 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4109 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4110 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4111 appropriate ship_ field is also searched).
4113 Additional options are the same as FS::Record::qsearch
4118 my( $self, $fuzzy, $hash, @opt) = @_;
4123 check_and_rebuild_fuzzyfiles();
4124 foreach my $field ( keys %$fuzzy ) {
4126 my $all = $self->all_X($field);
4127 next unless scalar(@$all);
4130 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4133 foreach ( keys %match ) {
4134 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4135 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4138 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4141 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4143 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4155 =item smart_search OPTION => VALUE ...
4157 Accepts the following options: I<search>, the string to search for. The string
4158 will be searched for as a customer number, phone number, name or company name,
4159 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4160 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4161 skip fuzzy matching when an exact match is found.
4163 Any additional options are treated as an additional qualifier on the search
4166 Returns a (possibly empty) array of FS::cust_main objects.
4173 #here is the agent virtualization
4174 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4178 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4179 my $search = delete $options{'search'};
4180 ( my $alphanum_search = $search ) =~ s/\W//g;
4182 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4184 #false laziness w/Record::ut_phone
4185 my $phonen = "$1-$2-$3";
4186 $phonen .= " x$4" if $4;
4188 push @cust_main, qsearch( {
4189 'table' => 'cust_main',
4190 'hashref' => { %options },
4191 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4193 join(' OR ', map "$_ = '$phonen'",
4194 qw( daytime night fax
4195 ship_daytime ship_night ship_fax )
4198 " AND $agentnums_sql", #agent virtualization
4201 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4202 #try looking for matches with extensions unless one was specified
4204 push @cust_main, qsearch( {
4205 'table' => 'cust_main',
4206 'hashref' => { %options },
4207 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4209 join(' OR ', map "$_ LIKE '$phonen\%'",
4211 ship_daytime ship_night )
4214 " AND $agentnums_sql", #agent virtualization
4219 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4221 push @cust_main, qsearch( {
4222 'table' => 'cust_main',
4223 'hashref' => { 'custnum' => $1, %options },
4224 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4227 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4229 my($company, $last, $first) = ( $1, $2, $3 );
4231 # "Company (Last, First)"
4232 #this is probably something a browser remembered,
4233 #so just do an exact search
4235 foreach my $prefix ( '', 'ship_' ) {
4236 push @cust_main, qsearch( {
4237 'table' => 'cust_main',
4238 'hashref' => { $prefix.'first' => $first,
4239 $prefix.'last' => $last,
4240 $prefix.'company' => $company,
4243 'extra_sql' => " AND $agentnums_sql",
4247 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4248 # try (ship_){last,company}
4252 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4253 # # full strings the browser remembers won't work
4254 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4256 use Lingua::EN::NameParse;
4257 my $NameParse = new Lingua::EN::NameParse(
4259 allow_reversed => 1,
4262 my($last, $first) = ( '', '' );
4263 #maybe disable this too and just rely on NameParse?
4264 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4266 ($last, $first) = ( $1, $2 );
4268 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4269 } elsif ( ! $NameParse->parse($value) ) {
4271 my %name = $NameParse->components;
4272 $first = $name{'given_name_1'};
4273 $last = $name{'surname_1'};
4277 if ( $first && $last ) {
4279 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4282 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4284 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4285 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4288 push @cust_main, qsearch( {
4289 'table' => 'cust_main',
4290 'hashref' => \%options,
4291 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4294 # or it just be something that was typed in... (try that in a sec)
4298 my $q_value = dbh->quote($value);
4301 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4302 $sql .= " ( LOWER(last) = $q_value
4303 OR LOWER(company) = $q_value
4304 OR LOWER(ship_last) = $q_value
4305 OR LOWER(ship_company) = $q_value
4308 push @cust_main, qsearch( {
4309 'table' => 'cust_main',
4310 'hashref' => \%options,
4311 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4314 #always do substring & fuzzy,
4315 #getting complains searches are not returning enough
4316 unless ( @cust_main && $skip_fuzzy ) { #no exact match, trying substring/fuzzy
4318 #still some false laziness w/ search/cust_main.cgi
4323 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4324 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4327 if ( $first && $last ) {
4330 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4331 'last' => { op=>'ILIKE', value=>"%$last%" },
4333 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4334 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4341 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4342 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4346 foreach my $hashref ( @hashrefs ) {
4348 push @cust_main, qsearch( {
4349 'table' => 'cust_main',
4350 'hashref' => { %$hashref,
4353 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4362 " AND $agentnums_sql", #extra_sql #agent virtualization
4365 if ( $first && $last ) {
4366 push @cust_main, FS::cust_main->fuzzy_search(
4367 { 'last' => $last, #fuzzy hashref
4368 'first' => $first }, #
4372 foreach my $field ( 'last', 'company' ) {
4374 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4379 #eliminate duplicates
4381 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4389 =item check_and_rebuild_fuzzyfiles
4393 use vars qw(@fuzzyfields);
4394 @fuzzyfields = ( 'last', 'first', 'company' );
4396 sub check_and_rebuild_fuzzyfiles {
4397 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4398 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4401 =item rebuild_fuzzyfiles
4405 sub rebuild_fuzzyfiles {
4407 use Fcntl qw(:flock);
4409 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4410 mkdir $dir, 0700 unless -d $dir;
4412 foreach my $fuzzy ( @fuzzyfields ) {
4414 open(LOCK,">>$dir/cust_main.$fuzzy")
4415 or die "can't open $dir/cust_main.$fuzzy: $!";
4417 or die "can't lock $dir/cust_main.$fuzzy: $!";
4419 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4420 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4422 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4423 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4424 " WHERE $field != '' AND $field IS NOT NULL");
4425 $sth->execute or die $sth->errstr;
4427 while ( my $row = $sth->fetchrow_arrayref ) {
4428 print CACHE $row->[0]. "\n";
4433 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4435 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4446 my( $self, $field ) = @_;
4447 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4448 open(CACHE,"<$dir/cust_main.$field")
4449 or die "can't open $dir/cust_main.$field: $!";
4450 my @array = map { chomp; $_; } <CACHE>;
4455 =item append_fuzzyfiles LASTNAME COMPANY
4459 sub append_fuzzyfiles {
4460 #my( $first, $last, $company ) = @_;
4462 &check_and_rebuild_fuzzyfiles;
4464 use Fcntl qw(:flock);
4466 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4468 foreach my $field (qw( first last company )) {
4473 open(CACHE,">>$dir/cust_main.$field")
4474 or die "can't open $dir/cust_main.$field: $!";
4475 flock(CACHE,LOCK_EX)
4476 or die "can't lock $dir/cust_main.$field: $!";
4478 print CACHE "$value\n";
4480 flock(CACHE,LOCK_UN)
4481 or die "can't unlock $dir/cust_main.$field: $!";
4496 #warn join('-',keys %$param);
4497 my $fh = $param->{filehandle};
4498 my $agentnum = $param->{agentnum};
4500 my $refnum = $param->{refnum};
4501 my $pkgpart = $param->{pkgpart};
4503 #my @fields = @{$param->{fields}};
4504 my $format = $param->{'format'};
4507 if ( $format eq 'simple' ) {
4508 @fields = qw( cust_pkg.setup dayphone first last
4509 address1 address2 city state zip comments );
4511 } elsif ( $format eq 'extended' ) {
4512 @fields = qw( agent_custid refnum
4513 last first address1 address2 city state zip country
4515 ship_last ship_first ship_address1 ship_address2
4516 ship_city ship_state ship_zip ship_country
4517 payinfo paycvv paydate
4520 svc_acct.username svc_acct._password
4524 die "unknown format $format";
4527 eval "use Text::CSV_XS;";
4530 my $csv = new Text::CSV_XS;
4537 local $SIG{HUP} = 'IGNORE';
4538 local $SIG{INT} = 'IGNORE';
4539 local $SIG{QUIT} = 'IGNORE';
4540 local $SIG{TERM} = 'IGNORE';
4541 local $SIG{TSTP} = 'IGNORE';
4542 local $SIG{PIPE} = 'IGNORE';
4544 my $oldAutoCommit = $FS::UID::AutoCommit;
4545 local $FS::UID::AutoCommit = 0;
4548 #while ( $columns = $csv->getline($fh) ) {
4550 while ( defined($line=<$fh>) ) {
4552 $csv->parse($line) or do {
4553 $dbh->rollback if $oldAutoCommit;
4554 return "can't parse: ". $csv->error_input();
4557 my @columns = $csv->fields();
4558 #warn join('-',@columns);
4561 agentnum => $agentnum,
4563 country => $conf->config('countrydefault') || 'US',
4564 payby => $payby, #default
4565 paydate => '12/2037', #default
4567 my $billtime = time;
4568 my %cust_pkg = ( pkgpart => $pkgpart );
4570 foreach my $field ( @fields ) {
4572 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4574 #$cust_pkg{$1} = str2time( shift @$columns );
4575 if ( $1 eq 'pkgpart' ) {
4576 $cust_pkg{$1} = shift @columns;
4577 } elsif ( $1 eq 'setup' ) {
4578 $billtime = str2time(shift @columns);
4580 $cust_pkg{$1} = str2time( shift @columns );
4583 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4585 $svc_acct{$1} = shift @columns;
4589 #refnum interception
4590 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4592 my $referral = $columns[0];
4593 my %hash = ( 'referral' => $referral,
4594 'agentnum' => $agentnum,
4598 my $part_referral = qsearchs('part_referral', \%hash )
4599 || new FS::part_referral \%hash;
4601 unless ( $part_referral->refnum ) {
4602 my $error = $part_referral->insert;
4604 $dbh->rollback if $oldAutoCommit;
4605 return "can't auto-insert advertising source: $referral: $error";
4609 $columns[0] = $part_referral->refnum;
4612 #$cust_main{$field} = shift @$columns;
4613 $cust_main{$field} = shift @columns;
4617 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4619 my $invoicing_list = $cust_main{'invoicing_list'}
4620 ? [ delete $cust_main{'invoicing_list'} ]
4623 my $cust_main = new FS::cust_main ( \%cust_main );
4626 tie my %hash, 'Tie::RefHash'; #this part is important
4628 if ( $cust_pkg{'pkgpart'} ) {
4629 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4632 if ( $svc_acct{'username'} ) {
4633 my $part_pkg = $cust_pkg->part_pkg;
4634 unless ( $part_pkg ) {
4635 $dbh->rollback if $oldAutoCommit;
4636 return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4638 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4639 push @svc_acct, new FS::svc_acct ( \%svc_acct )
4642 $hash{$cust_pkg} = \@svc_acct;
4645 my $error = $cust_main->insert( \%hash, $invoicing_list );
4648 $dbh->rollback if $oldAutoCommit;
4649 return "can't insert customer for $line: $error";
4652 if ( $format eq 'simple' ) {
4654 #false laziness w/bill.cgi
4655 $error = $cust_main->bill( 'time' => $billtime );
4657 $dbh->rollback if $oldAutoCommit;
4658 return "can't bill customer for $line: $error";
4661 $cust_main->apply_payments_and_credits;
4663 $error = $cust_main->collect();
4665 $dbh->rollback if $oldAutoCommit;
4666 return "can't collect customer for $line: $error";
4674 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4676 return "Empty file!" unless $imported;
4688 #warn join('-',keys %$param);
4689 my $fh = $param->{filehandle};
4690 my @fields = @{$param->{fields}};
4692 eval "use Text::CSV_XS;";
4695 my $csv = new Text::CSV_XS;
4702 local $SIG{HUP} = 'IGNORE';
4703 local $SIG{INT} = 'IGNORE';
4704 local $SIG{QUIT} = 'IGNORE';
4705 local $SIG{TERM} = 'IGNORE';
4706 local $SIG{TSTP} = 'IGNORE';
4707 local $SIG{PIPE} = 'IGNORE';
4709 my $oldAutoCommit = $FS::UID::AutoCommit;
4710 local $FS::UID::AutoCommit = 0;
4713 #while ( $columns = $csv->getline($fh) ) {
4715 while ( defined($line=<$fh>) ) {
4717 $csv->parse($line) or do {
4718 $dbh->rollback if $oldAutoCommit;
4719 return "can't parse: ". $csv->error_input();
4722 my @columns = $csv->fields();
4723 #warn join('-',@columns);
4726 foreach my $field ( @fields ) {
4727 $row{$field} = shift @columns;
4730 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4731 unless ( $cust_main ) {
4732 $dbh->rollback if $oldAutoCommit;
4733 return "unknown custnum $row{'custnum'}";
4736 if ( $row{'amount'} > 0 ) {
4737 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4739 $dbh->rollback if $oldAutoCommit;
4743 } elsif ( $row{'amount'} < 0 ) {
4744 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4747 $dbh->rollback if $oldAutoCommit;
4757 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4759 return "Empty file!" unless $imported;
4765 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4767 Sends a templated email notification to the customer (see L<Text::Template).
4769 OPTIONS is a hash and may include
4771 I<from> - the email sender (default is invoice_from)
4773 I<to> - comma-separated scalar or arrayref of recipients
4774 (default is invoicing_list)
4776 I<subject> - The subject line of the sent email notification
4777 (default is "Notice from company_name")
4779 I<extra_fields> - a hashref of name/value pairs which will be substituted
4782 The following variables are vavailable in the template.
4784 I<$first> - the customer first name
4785 I<$last> - the customer last name
4786 I<$company> - the customer company
4787 I<$payby> - a description of the method of payment for the customer
4788 # would be nice to use FS::payby::shortname
4789 I<$payinfo> - the account information used to collect for this customer
4790 I<$expdate> - the expiration of the customer payment in seconds from epoch
4795 my ($customer, $template, %options) = @_;
4797 return unless $conf->exists($template);
4799 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
4800 $from = $options{from} if exists($options{from});
4802 my $to = join(',', $customer->invoicing_list_emailonly);
4803 $to = $options{to} if exists($options{to});
4805 my $subject = "Notice from " . $conf->config('company_name')
4806 if $conf->exists('company_name');
4807 $subject = $options{subject} if exists($options{subject});
4809 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4810 SOURCE => [ map "$_\n",
4811 $conf->config($template)]
4813 or die "can't create new Text::Template object: Text::Template::ERROR";
4814 $notify_template->compile()
4815 or die "can't compile template: Text::Template::ERROR";
4817 my $paydate = $customer->paydate;
4818 $FS::notify_template::_template::first = $customer->first;
4819 $FS::notify_template::_template::last = $customer->last;
4820 $FS::notify_template::_template::company = $customer->company;
4821 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
4822 my $payby = $customer->payby;
4823 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4824 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4826 #credit cards expire at the end of the month/year of their exp date
4827 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4828 $FS::notify_template::_template::payby = 'credit card';
4829 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4830 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4832 }elsif ($payby eq 'COMP') {
4833 $FS::notify_template::_template::payby = 'complimentary account';
4835 $FS::notify_template::_template::payby = 'current method';
4837 $FS::notify_template::_template::expdate = $expire_time;
4839 for (keys %{$options{extra_fields}}){
4841 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4844 send_email(from => $from,
4846 subject => $subject,
4847 body => $notify_template->fill_in( PACKAGE =>
4848 'FS::notify_template::_template' ),
4859 The delete method should possibly take an FS::cust_main object reference
4860 instead of a scalar customer number.
4862 Bill and collect options should probably be passed as references instead of a
4865 There should probably be a configuration file with a list of allowed credit
4868 No multiple currency support (probably a larger project than just this module).
4870 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4872 Birthdates rely on negative epoch values.
4876 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4877 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4878 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.