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')
1223 || $self->ut_textn('stateid')
1224 || $self->ut_textn('stateid_state')
1226 #barf. need message catalogs. i18n. etc.
1227 $error .= "Please select an advertising source."
1228 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1229 return $error if $error;
1231 return "Unknown agent"
1232 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1234 return "Unknown refnum"
1235 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1237 return "Unknown referring custnum: ". $self->referral_custnum
1238 unless ! $self->referral_custnum
1239 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1241 if ( $self->ss eq '' ) {
1246 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1247 or return "Illegal social security number: ". $self->ss;
1248 $self->ss("$1-$2-$3");
1252 # bad idea to disable, causes billing to fail because of no tax rates later
1253 # unless ( $import ) {
1254 unless ( qsearch('cust_main_county', {
1255 'country' => $self->country,
1258 return "Unknown state/county/country: ".
1259 $self->state. "/". $self->county. "/". $self->country
1260 unless qsearch('cust_main_county',{
1261 'state' => $self->state,
1262 'county' => $self->county,
1263 'country' => $self->country,
1269 $self->ut_phonen('daytime', $self->country)
1270 || $self->ut_phonen('night', $self->country)
1271 || $self->ut_phonen('fax', $self->country)
1272 || $self->ut_zip('zip', $self->country)
1274 return $error if $error;
1277 last first company address1 address2 city county state zip
1278 country daytime night fax
1281 if ( defined $self->dbdef_table->column('ship_last') ) {
1282 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1284 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1288 $self->ut_name('ship_last')
1289 || $self->ut_name('ship_first')
1290 || $self->ut_textn('ship_company')
1291 || $self->ut_text('ship_address1')
1292 || $self->ut_textn('ship_address2')
1293 || $self->ut_text('ship_city')
1294 || $self->ut_textn('ship_county')
1295 || $self->ut_textn('ship_state')
1296 || $self->ut_country('ship_country')
1298 return $error if $error;
1300 #false laziness with above
1301 unless ( qsearchs('cust_main_county', {
1302 'country' => $self->ship_country,
1305 return "Unknown ship_state/ship_county/ship_country: ".
1306 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1307 unless qsearch('cust_main_county',{
1308 'state' => $self->ship_state,
1309 'county' => $self->ship_county,
1310 'country' => $self->ship_country,
1316 $self->ut_phonen('ship_daytime', $self->ship_country)
1317 || $self->ut_phonen('ship_night', $self->ship_country)
1318 || $self->ut_phonen('ship_fax', $self->ship_country)
1319 || $self->ut_zip('ship_zip', $self->ship_country)
1321 return $error if $error;
1323 } else { # ship_ info eq billing info, so don't store dup info in database
1324 $self->setfield("ship_$_", '')
1325 foreach qw( last first company address1 address2 city county state zip
1326 country daytime night fax );
1330 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1331 # or return "Illegal payby: ". $self->payby;
1333 FS::payby->can_payby($self->table, $self->payby)
1334 or return "Illegal payby: ". $self->payby;
1336 $error = $self->ut_numbern('paystart_month')
1337 || $self->ut_numbern('paystart_year')
1338 || $self->ut_numbern('payissue')
1339 || $self->ut_textn('paytype')
1341 return $error if $error;
1343 if ( $self->payip eq '' ) {
1346 $error = $self->ut_ip('payip');
1347 return $error if $error;
1350 # If it is encrypted and the private key is not availaible then we can't
1351 # check the credit card.
1353 my $check_payinfo = 1;
1355 if ($self->is_encrypted($self->payinfo)) {
1359 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1361 my $payinfo = $self->payinfo;
1362 $payinfo =~ s/\D//g;
1363 $payinfo =~ /^(\d{13,16})$/
1364 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1366 $self->payinfo($payinfo);
1368 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1370 return gettext('unknown_card_type')
1371 if cardtype($self->payinfo) eq "Unknown";
1373 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1375 return 'Banned credit card: banned on '.
1376 time2str('%a %h %o at %r', $ban->_date).
1377 ' by '. $ban->otaker.
1378 ' (ban# '. $ban->bannum. ')';
1381 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1382 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1383 $self->paycvv =~ /^(\d{4})$/
1384 or return "CVV2 (CID) for American Express cards is four digits.";
1387 $self->paycvv =~ /^(\d{3})$/
1388 or return "CVV2 (CVC2/CID) is three digits.";
1395 my $cardtype = cardtype($payinfo);
1396 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1398 return "Start date or issue number is required for $cardtype cards"
1399 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1401 return "Start month must be between 1 and 12"
1402 if $self->paystart_month
1403 and $self->paystart_month < 1 || $self->paystart_month > 12;
1405 return "Start year must be 1990 or later"
1406 if $self->paystart_year
1407 and $self->paystart_year < 1990;
1409 return "Issue number must be beween 1 and 99"
1411 and $self->payissue < 1 || $self->payissue > 99;
1414 $self->paystart_month('');
1415 $self->paystart_year('');
1416 $self->payissue('');
1419 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1421 my $payinfo = $self->payinfo;
1422 $payinfo =~ s/[^\d\@]//g;
1423 if ( $conf->exists('echeck-nonus') ) {
1424 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1425 $payinfo = "$1\@$2";
1427 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1428 $payinfo = "$1\@$2";
1430 $self->payinfo($payinfo);
1433 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1435 return 'Banned ACH account: banned on '.
1436 time2str('%a %h %o at %r', $ban->_date).
1437 ' by '. $ban->otaker.
1438 ' (ban# '. $ban->bannum. ')';
1441 } elsif ( $self->payby eq 'LECB' ) {
1443 my $payinfo = $self->payinfo;
1444 $payinfo =~ s/\D//g;
1445 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1447 $self->payinfo($payinfo);
1450 } elsif ( $self->payby eq 'BILL' ) {
1452 $error = $self->ut_textn('payinfo');
1453 return "Illegal P.O. number: ". $self->payinfo if $error;
1456 } elsif ( $self->payby eq 'COMP' ) {
1458 my $curuser = $FS::CurrentUser::CurrentUser;
1459 if ( ! $self->custnum
1460 && ! $curuser->access_right('Complimentary customer')
1463 return "You are not permitted to create complimentary accounts."
1466 $error = $self->ut_textn('payinfo');
1467 return "Illegal comp account issuer: ". $self->payinfo if $error;
1470 } elsif ( $self->payby eq 'PREPAY' ) {
1472 my $payinfo = $self->payinfo;
1473 $payinfo =~ s/\W//g; #anything else would just confuse things
1474 $self->payinfo($payinfo);
1475 $error = $self->ut_alpha('payinfo');
1476 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1477 return "Unknown prepayment identifier"
1478 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1483 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1484 return "Expiration date required"
1485 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1489 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1490 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1491 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1492 ( $m, $y ) = ( $3, "20$2" );
1494 return "Illegal expiration date: ". $self->paydate;
1496 $self->paydate("$y-$m-01");
1497 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1498 return gettext('expired_card')
1500 && !$ignore_expired_card
1501 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1504 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1505 ( ! $conf->exists('require_cardname')
1506 || $self->payby !~ /^(CARD|DCRD)$/ )
1508 $self->payname( $self->first. " ". $self->getfield('last') );
1510 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1511 or return gettext('illegal_name'). " payname: ". $self->payname;
1515 foreach my $flag (qw( tax spool_cdr )) {
1516 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1520 $self->otaker(getotaker) unless $self->otaker;
1522 warn "$me check AFTER: \n". $self->_dump
1525 $self->SUPER::check;
1530 Returns all packages (see L<FS::cust_pkg>) for this customer.
1537 return $self->num_pkgs unless wantarray;
1540 if ( $self->{'_pkgnum'} ) {
1541 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1543 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1546 sort sort_packages @cust_pkg;
1549 =item ncancelled_pkgs
1551 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1555 sub ncancelled_pkgs {
1558 return $self->num_ncancelled_pkgs unless wantarray;
1561 if ( $self->{'_pkgnum'} ) {
1563 @cust_pkg = grep { ! $_->getfield('cancel') }
1564 values %{ $self->{'_pkgnum'}->cache };
1569 qsearch( 'cust_pkg', {
1570 'custnum' => $self->custnum,
1574 qsearch( 'cust_pkg', {
1575 'custnum' => $self->custnum,
1580 sort sort_packages @cust_pkg;
1584 # This should be generalized to use config options to determine order.
1586 if ( $a->get('cancel') and $b->get('cancel') ) {
1587 $a->pkgnum <=> $b->pkgnum;
1588 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1589 return -1 if $b->get('cancel');
1590 return 1 if $a->get('cancel');
1593 $a->pkgnum <=> $b->pkgnum;
1597 =item suspended_pkgs
1599 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1603 sub suspended_pkgs {
1605 grep { $_->susp } $self->ncancelled_pkgs;
1608 =item unflagged_suspended_pkgs
1610 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1611 customer (thouse packages without the `manual_flag' set).
1615 sub unflagged_suspended_pkgs {
1617 return $self->suspended_pkgs
1618 unless dbdef->table('cust_pkg')->column('manual_flag');
1619 grep { ! $_->manual_flag } $self->suspended_pkgs;
1622 =item unsuspended_pkgs
1624 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1629 sub unsuspended_pkgs {
1631 grep { ! $_->susp } $self->ncancelled_pkgs;
1634 =item num_cancelled_pkgs
1636 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1641 sub num_cancelled_pkgs {
1642 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1645 sub num_ncancelled_pkgs {
1646 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1650 my( $self, $sql ) = @_;
1651 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1652 my $sth = dbh->prepare(
1653 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1654 ) or die dbh->errstr;
1655 $sth->execute($self->custnum) or die $sth->errstr;
1656 $sth->fetchrow_arrayref->[0];
1661 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1662 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1663 on success or a list of errors.
1669 grep { $_->unsuspend } $self->suspended_pkgs;
1674 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1676 Returns a list: an empty list on success or a list of errors.
1682 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1685 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1687 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1688 PKGPARTs (see L<FS::part_pkg>).
1690 Returns a list: an empty list on success or a list of errors.
1694 sub suspend_if_pkgpart {
1696 my (@pkgparts, %opt);
1697 if (ref($_[0]) eq 'HASH'){
1698 @pkgparts = @{$_[0]{pkgparts}};
1703 grep { $_->suspend(%opt) }
1704 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1705 $self->unsuspended_pkgs;
1708 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1710 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1711 listed PKGPARTs (see L<FS::part_pkg>).
1713 Returns a list: an empty list on success or a list of errors.
1717 sub suspend_unless_pkgpart {
1719 my (@pkgparts, %opt);
1720 if (ref($_[0]) eq 'HASH'){
1721 @pkgparts = @{$_[0]{pkgparts}};
1726 grep { $_->suspend(%opt) }
1727 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1728 $self->unsuspended_pkgs;
1731 =item cancel [ OPTION => VALUE ... ]
1733 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1735 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1737 I<quiet> can be set true to supress email cancellation notices.
1739 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1741 I<ban> can be set true to ban this customer's credit card or ACH information,
1744 Always returns a list: an empty list on success or a list of errors.
1752 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1754 #should try decryption (we might have the private key)
1755 # and if not maybe queue a job for the server that does?
1756 return ( "Can't (yet) ban encrypted credit cards" )
1757 if $self->is_encrypted($self->payinfo);
1759 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1760 my $error = $ban->insert;
1761 return ( $error ) if $error;
1765 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1768 sub _banned_pay_hashref {
1779 'payby' => $payby2ban{$self->payby},
1780 'payinfo' => md5_base64($self->payinfo),
1781 #don't ever *search* on reason! #'reason' =>
1787 Returns all notes (see L<FS::cust_main_note>) for this customer.
1794 qsearch( 'cust_main_note',
1795 { 'custnum' => $self->custnum },
1797 'ORDER BY _DATE DESC'
1803 Returns the agent (see L<FS::agent>) for this customer.
1809 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1814 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1815 conjunction with the collect method.
1817 Options are passed as name-value pairs.
1819 Currently available options are:
1821 resetup - if set true, re-charges setup fees.
1823 time - bills the customer as if it were that time. Specified as a UNIX
1824 timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
1825 L<Date::Parse> for conversion functions. For example:
1829 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1832 If there is an error, returns the error, otherwise returns false.
1837 my( $self, %options ) = @_;
1838 return '' if $self->payby eq 'COMP';
1839 warn "$me bill customer ". $self->custnum. "\n"
1842 my $time = $options{'time'} || time;
1847 local $SIG{HUP} = 'IGNORE';
1848 local $SIG{INT} = 'IGNORE';
1849 local $SIG{QUIT} = 'IGNORE';
1850 local $SIG{TERM} = 'IGNORE';
1851 local $SIG{TSTP} = 'IGNORE';
1852 local $SIG{PIPE} = 'IGNORE';
1854 my $oldAutoCommit = $FS::UID::AutoCommit;
1855 local $FS::UID::AutoCommit = 0;
1858 $self->select_for_update; #mutex
1860 #create a new invoice
1861 #(we'll remove it later if it doesn't actually need to be generated [contains
1862 # no line items] and we're inside a transaciton so nothing else will see it)
1863 my $cust_bill = new FS::cust_bill ( {
1864 'custnum' => $self->custnum,
1866 #'charged' => $charged,
1869 $error = $cust_bill->insert;
1871 $dbh->rollback if $oldAutoCommit;
1872 return "can't create invoice for customer #". $self->custnum. ": $error";
1874 my $invnum = $cust_bill->invnum;
1877 # find the packages which are due for billing, find out how much they are
1878 # & generate invoice database.
1881 my( $total_setup, $total_recur ) = ( 0, 0 );
1883 my @precommit_hooks = ();
1885 foreach my $cust_pkg (
1886 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1889 #NO!! next if $cust_pkg->cancel;
1890 next if $cust_pkg->getfield('cancel');
1892 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1894 #? to avoid use of uninitialized value errors... ?
1895 $cust_pkg->setfield('bill', '')
1896 unless defined($cust_pkg->bill);
1898 my $part_pkg = $cust_pkg->part_pkg;
1900 my %hash = $cust_pkg->hash;
1901 my $old_cust_pkg = new FS::cust_pkg \%hash;
1910 if ( ! $cust_pkg->setup &&
1912 ( $conf->exists('disable_setup_suspended_pkgs') &&
1913 ! $cust_pkg->getfield('susp')
1914 ) || ! $conf->exists('disable_setup_suspended_pkgs')
1916 || $options{'resetup'}
1919 warn " bill setup\n" if $DEBUG > 1;
1921 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
1923 $dbh->rollback if $oldAutoCommit;
1924 return "$@ running calc_setup for $cust_pkg\n";
1927 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1931 # bill recurring fee
1936 if ( $part_pkg->getfield('freq') ne '0' &&
1937 ! $cust_pkg->getfield('susp') &&
1938 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1941 warn " bill recur\n" if $DEBUG > 1;
1943 # XXX shared with $recur_prog
1944 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1946 #over two params! lets at least switch to a hashref for the rest...
1947 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1949 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1951 $dbh->rollback if $oldAutoCommit;
1952 return "$@ running calc_recur for $cust_pkg\n";
1955 #change this bit to use Date::Manip? CAREFUL with timezones (see
1956 # mailing list archive)
1957 my ($sec,$min,$hour,$mday,$mon,$year) =
1958 (localtime($sdate) )[0,1,2,3,4,5];
1960 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1961 # only for figuring next bill date, nothing else, so, reset $sdate again
1963 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1964 $cust_pkg->last_bill($sdate)
1965 if $cust_pkg->dbdef_table->column('last_bill');
1967 if ( $part_pkg->freq =~ /^\d+$/ ) {
1968 $mon += $part_pkg->freq;
1969 until ( $mon < 12 ) { $mon -= 12; $year++; }
1970 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1972 $mday += $weeks * 7;
1973 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1976 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1980 $dbh->rollback if $oldAutoCommit;
1981 return "unparsable frequency: ". $part_pkg->freq;
1983 $cust_pkg->setfield('bill',
1984 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1987 warn "\$setup is undefined" unless defined($setup);
1988 warn "\$recur is undefined" unless defined($recur);
1989 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1992 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1995 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
1997 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2000 $error=$cust_pkg->replace($old_cust_pkg,
2001 options => { $cust_pkg->options },
2003 if ( $error ) { #just in case
2004 $dbh->rollback if $oldAutoCommit;
2005 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2008 $setup = sprintf( "%.2f", $setup );
2009 $recur = sprintf( "%.2f", $recur );
2010 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2011 $dbh->rollback if $oldAutoCommit;
2012 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2014 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2015 $dbh->rollback if $oldAutoCommit;
2016 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2019 if ( $setup != 0 || $recur != 0 ) {
2021 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2023 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2024 'invnum' => $invnum,
2025 'pkgnum' => $cust_pkg->pkgnum,
2029 'edate' => $cust_pkg->bill,
2030 'details' => \@details,
2032 $error = $cust_bill_pkg->insert;
2034 $dbh->rollback if $oldAutoCommit;
2035 return "can't create invoice line item for invoice #$invnum: $error";
2037 $total_setup += $setup;
2038 $total_recur += $recur;
2044 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2047 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2050 my %taxhash = map { $_ => $self->get("$prefix$_") }
2051 qw( state county country );
2053 $taxhash{'taxclass'} = $part_pkg->taxclass;
2055 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2058 $taxhash{'taxclass'} = '';
2059 @taxes = qsearch( 'cust_main_county', \%taxhash );
2062 #one more try at a whole-country tax rate
2064 $taxhash{$_} = '' foreach qw( state county );
2065 @taxes = qsearch( 'cust_main_county', \%taxhash );
2068 # maybe eliminate this entirely, along with all the 0% records
2070 $dbh->rollback if $oldAutoCommit;
2072 "fatal: can't find tax rate for state/county/country/taxclass ".
2073 join('/', ( map $self->get("$prefix$_"),
2074 qw(state county country)
2076 $part_pkg->taxclass ). "\n";
2079 foreach my $tax ( @taxes ) {
2081 my $taxable_charged = 0;
2082 $taxable_charged += $setup
2083 unless $part_pkg->setuptax =~ /^Y$/i
2084 || $tax->setuptax =~ /^Y$/i;
2085 $taxable_charged += $recur
2086 unless $part_pkg->recurtax =~ /^Y$/i
2087 || $tax->recurtax =~ /^Y$/i;
2088 next unless $taxable_charged;
2090 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2091 #my ($mon,$year) = (localtime($sdate) )[4,5];
2092 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2094 my $freq = $part_pkg->freq || 1;
2095 if ( $freq !~ /(\d+)$/ ) {
2096 $dbh->rollback if $oldAutoCommit;
2097 return "daily/weekly package definitions not (yet?)".
2098 " compatible with monthly tax exemptions";
2100 my $taxable_per_month =
2101 sprintf("%.2f", $taxable_charged / $freq );
2103 #call the whole thing off if this customer has any old
2104 #exemption records...
2105 my @cust_tax_exempt =
2106 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2107 if ( @cust_tax_exempt ) {
2108 $dbh->rollback if $oldAutoCommit;
2110 'this customer still has old-style tax exemption records; '.
2111 'run bin/fs-migrate-cust_tax_exempt?';
2114 foreach my $which_month ( 1 .. $freq ) {
2116 #maintain the new exemption table now
2119 FROM cust_tax_exempt_pkg
2120 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2121 LEFT JOIN cust_bill USING ( invnum )
2127 my $sth = dbh->prepare($sql) or do {
2128 $dbh->rollback if $oldAutoCommit;
2129 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2137 $dbh->rollback if $oldAutoCommit;
2138 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2140 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2142 my $remaining_exemption =
2143 $tax->exempt_amount - $existing_exemption;
2144 if ( $remaining_exemption > 0 ) {
2145 my $addl = $remaining_exemption > $taxable_per_month
2146 ? $taxable_per_month
2147 : $remaining_exemption;
2148 $taxable_charged -= $addl;
2150 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2151 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2152 'taxnum' => $tax->taxnum,
2153 'year' => 1900+$year,
2155 'amount' => sprintf("%.2f", $addl ),
2157 $error = $cust_tax_exempt_pkg->insert;
2159 $dbh->rollback if $oldAutoCommit;
2160 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2162 } # if $remaining_exemption > 0
2166 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2167 until ( $mon < 13 ) { $mon -= 12; $year++; }
2169 } #foreach $which_month
2171 } #if $tax->exempt_amount
2173 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2175 #$tax += $taxable_charged * $cust_main_county->tax / 100
2176 $tax{ $tax->taxname || 'Tax' } +=
2177 $taxable_charged * $tax->tax / 100
2179 } #foreach my $tax ( @taxes )
2181 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2183 } #if $setup != 0 || $recur != 0
2185 } #if $cust_pkg->modified
2187 } #foreach my $cust_pkg
2189 unless ( $cust_bill->cust_bill_pkg ) {
2190 $cust_bill->delete; #don't create an invoice w/o line items
2191 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2195 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2197 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2198 my $tax = sprintf("%.2f", $tax{$taxname} );
2199 $charged = sprintf( "%.2f", $charged+$tax );
2201 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2202 'invnum' => $invnum,
2208 'itemdesc' => $taxname,
2210 $error = $cust_bill_pkg->insert;
2212 $dbh->rollback if $oldAutoCommit;
2213 return "can't create invoice line item for invoice #$invnum: $error";
2215 $total_setup += $tax;
2219 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2220 $error = $cust_bill->replace;
2222 $dbh->rollback if $oldAutoCommit;
2223 return "can't update charged for invoice #$invnum: $error";
2226 foreach my $hook ( @precommit_hooks ) {
2228 &{$hook}; #($self) ?
2231 $dbh->rollback if $oldAutoCommit;
2232 return "$@ running precommit hook $hook\n";
2236 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2240 =item collect OPTIONS
2242 (Attempt to) collect money for this customer's outstanding invoices (see
2243 L<FS::cust_bill>). Usually used after the bill method.
2245 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2246 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2247 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2249 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2250 and the invoice events web interface.
2252 If there is an error, returns the error, otherwise returns false.
2254 Options are passed as name-value pairs.
2256 Currently available options are:
2258 invoice_time - Use this time when deciding when to print invoices and
2259 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>
2260 for conversion functions.
2262 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2265 quiet - set true to surpress email card/ACH decline notices.
2267 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2270 payby - allows for one time override of normal customer billing method
2275 my( $self, %options ) = @_;
2276 my $invoice_time = $options{'invoice_time'} || time;
2279 local $SIG{HUP} = 'IGNORE';
2280 local $SIG{INT} = 'IGNORE';
2281 local $SIG{QUIT} = 'IGNORE';
2282 local $SIG{TERM} = 'IGNORE';
2283 local $SIG{TSTP} = 'IGNORE';
2284 local $SIG{PIPE} = 'IGNORE';
2286 my $oldAutoCommit = $FS::UID::AutoCommit;
2287 local $FS::UID::AutoCommit = 0;
2290 $self->select_for_update; #mutex
2292 my $balance = $self->balance;
2293 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2295 unless ( $balance > 0 ) { #redundant?????
2296 $dbh->rollback if $oldAutoCommit; #hmm
2300 if ( exists($options{'retry_card'}) ) {
2301 carp 'retry_card option passed to collect is deprecated; use retry';
2302 $options{'retry'} ||= $options{'retry_card'};
2304 if ( exists($options{'retry'}) && $options{'retry'} ) {
2305 my $error = $self->retry_realtime;
2307 $dbh->rollback if $oldAutoCommit;
2313 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2314 $extra_sql = " AND freq = '1m' ";
2316 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2319 foreach my $cust_bill ( $self->open_cust_bill ) {
2321 # don't try to charge for the same invoice if it's already in a batch
2322 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2324 last if $self->balance <= 0;
2326 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2329 foreach my $part_bill_event ( due_events ( $cust_bill,
2330 exists($options{'payby'})
2336 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2337 || $self->balance <= 0; # or if balance<=0
2340 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2341 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2344 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2345 # gah, even with transactions.
2346 $dbh->commit if $oldAutoCommit; #well.
2355 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2360 =item retry_realtime
2362 Schedules realtime / batch credit card / electronic check / LEC billing
2363 events for for retry. Useful if card information has changed or manual
2364 retry is desired. The 'collect' method must be called to actually retry
2367 Implementation details: For each of this customer's open invoices, changes
2368 the status of the first "done" (with statustext error) realtime processing
2373 sub retry_realtime {
2376 local $SIG{HUP} = 'IGNORE';
2377 local $SIG{INT} = 'IGNORE';
2378 local $SIG{QUIT} = 'IGNORE';
2379 local $SIG{TERM} = 'IGNORE';
2380 local $SIG{TSTP} = 'IGNORE';
2381 local $SIG{PIPE} = 'IGNORE';
2383 my $oldAutoCommit = $FS::UID::AutoCommit;
2384 local $FS::UID::AutoCommit = 0;
2387 foreach my $cust_bill (
2388 grep { $_->cust_bill_event }
2389 $self->open_cust_bill
2391 my @cust_bill_event =
2392 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2394 #$_->part_bill_event->plan eq 'realtime-card'
2395 $_->part_bill_event->eventcode =~
2396 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2397 && $_->status eq 'done'
2400 $cust_bill->cust_bill_event;
2401 next unless @cust_bill_event;
2402 my $error = $cust_bill_event[0]->retry;
2404 $dbh->rollback if $oldAutoCommit;
2405 return "error scheduling invoice event for retry: $error";
2410 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2415 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2417 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2418 via a Business::OnlinePayment realtime gateway. See
2419 L<http://420.am/business-onlinepayment> for supported gateways.
2421 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2423 Available options are: I<description>, I<invnum>, I<quiet>
2425 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2426 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2427 if set, will override the value from the customer record.
2429 I<description> is a free-text field passed to the gateway. It defaults to
2430 "Internet services".
2432 If an I<invnum> is specified, this payment (if successful) is applied to the
2433 specified invoice. If you don't specify an I<invnum> you might want to
2434 call the B<apply_payments> method.
2436 I<quiet> can be set true to surpress email decline notices.
2438 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2443 my( $self, $method, $amount, %options ) = @_;
2445 warn "$me realtime_bop: $method $amount\n";
2446 warn " $_ => $options{$_}\n" foreach keys %options;
2449 $options{'description'} ||= 'Internet services';
2451 eval "use Business::OnlinePayment";
2454 my $payinfo = exists($options{'payinfo'})
2455 ? $options{'payinfo'}
2463 if ( $options{'invnum'} ) {
2464 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2465 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2467 map { $_->part_pkg->taxclass }
2469 map { $_->cust_pkg }
2470 $cust_bill->cust_bill_pkg;
2471 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2472 #different taxclasses
2473 $taxclass = $taxclasses[0];
2477 #look for an agent gateway override first
2479 if ( $method eq 'CC' ) {
2480 $cardtype = cardtype($payinfo);
2481 } elsif ( $method eq 'ECHECK' ) {
2484 $cardtype = $method;
2488 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2489 cardtype => $cardtype,
2490 taxclass => $taxclass, } )
2491 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2493 taxclass => $taxclass, } )
2494 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2495 cardtype => $cardtype,
2497 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2499 taxclass => '', } );
2501 my $payment_gateway = '';
2502 my( $processor, $login, $password, $action, @bop_options );
2503 if ( $override ) { #use a payment gateway override
2505 $payment_gateway = $override->payment_gateway;
2507 $processor = $payment_gateway->gateway_module;
2508 $login = $payment_gateway->gateway_username;
2509 $password = $payment_gateway->gateway_password;
2510 $action = $payment_gateway->gateway_action;
2511 @bop_options = $payment_gateway->options;
2513 } else { #use the standard settings from the config
2515 ( $processor, $login, $password, $action, @bop_options ) =
2516 $self->default_payment_gateway($method);
2524 my $address = exists($options{'address1'})
2525 ? $options{'address1'}
2527 my $address2 = exists($options{'address2'})
2528 ? $options{'address2'}
2530 $address .= ", ". $address2 if length($address2);
2532 my $o_payname = exists($options{'payname'})
2533 ? $options{'payname'}
2535 my($payname, $payfirst, $paylast);
2536 if ( $o_payname && $method ne 'ECHECK' ) {
2537 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2538 or return "Illegal payname $payname";
2539 ($payfirst, $paylast) = ($1, $2);
2541 $payfirst = $self->getfield('first');
2542 $paylast = $self->getfield('last');
2543 $payname = "$payfirst $paylast";
2546 my @invoicing_list = $self->invoicing_list_emailonly;
2547 if ( $conf->exists('emailinvoiceautoalways')
2548 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2549 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2550 push @invoicing_list, $self->all_emails;
2553 my $email = ($conf->exists('business-onlinepayment-email-override'))
2554 ? $conf->config('business-onlinepayment-email-override')
2555 : $invoicing_list[0];
2559 my $payip = exists($options{'payip'})
2562 $content{customer_ip} = $payip
2565 $content{invoice_number} = $options{'invnum'}
2566 if exists($options{'invnum'}) && length($options{'invnum'});
2568 if ( $method eq 'CC' ) {
2570 $content{card_number} = $payinfo;
2571 my $paydate = exists($options{'paydate'})
2572 ? $options{'paydate'}
2574 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2575 $content{expiration} = "$2/$1";
2577 my $paycvv = exists($options{'paycvv'})
2578 ? $options{'paycvv'}
2580 $content{cvv2} = $self->paycvv
2583 my $paystart_month = exists($options{'paystart_month'})
2584 ? $options{'paystart_month'}
2585 : $self->paystart_month;
2587 my $paystart_year = exists($options{'paystart_year'})
2588 ? $options{'paystart_year'}
2589 : $self->paystart_year;
2591 $content{card_start} = "$paystart_month/$paystart_year"
2592 if $paystart_month && $paystart_year;
2594 my $payissue = exists($options{'payissue'})
2595 ? $options{'payissue'}
2597 $content{issue_number} = $payissue if $payissue;
2599 $content{recurring_billing} = 'YES'
2600 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2602 'payinfo' => $payinfo,
2604 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2606 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2610 } elsif ( $method eq 'ECHECK' ) {
2611 ( $content{account_number}, $content{routing_code} ) =
2612 split('@', $payinfo);
2613 $content{bank_name} = $o_payname;
2614 $content{bank_state} = $self->getfield('paystate');
2615 $content{account_type} = uc($self->getfield('paytype')) || 'CHECKING';
2616 $content{account_name} = $payname;
2617 $content{customer_org} = $self->company ? 'B' : 'I';
2618 $content{state_id} = $self->getfield('stateid');
2619 $content{state_id_state} = $self->getfield('stateid_state');
2620 $content{customer_ssn} = exists($options{'ss'})
2623 } elsif ( $method eq 'LEC' ) {
2624 $content{phone} = $payinfo;
2628 # run transaction(s)
2631 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2633 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2634 $transaction->content(
2637 'password' => $password,
2638 'action' => $action1,
2639 'description' => $options{'description'},
2640 'amount' => $amount,
2641 #'invoice_number' => $options{'invnum'},
2642 'customer_id' => $self->custnum,
2643 'last_name' => $paylast,
2644 'first_name' => $payfirst,
2646 'address' => $address,
2647 'city' => ( exists($options{'city'})
2650 'state' => ( exists($options{'state'})
2653 'zip' => ( exists($options{'zip'})
2656 'country' => ( exists($options{'country'})
2657 ? $options{'country'}
2659 'referer' => 'http://cleanwhisker.420.am/',
2661 'phone' => $self->daytime || $self->night,
2664 $transaction->submit();
2666 if ( $transaction->is_success() && $action2 ) {
2667 my $auth = $transaction->authorization;
2668 my $ordernum = $transaction->can('order_number')
2669 ? $transaction->order_number
2673 new Business::OnlinePayment( $processor, @bop_options );
2680 password => $password,
2681 order_number => $ordernum,
2683 authorization => $auth,
2684 description => $options{'description'},
2687 foreach my $field (qw( authorization_source_code returned_ACI
2688 transaction_identifier validation_code
2689 transaction_sequence_num local_transaction_date
2690 local_transaction_time AVS_result_code )) {
2691 $capture{$field} = $transaction->$field() if $transaction->can($field);
2694 $capture->content( %capture );
2698 unless ( $capture->is_success ) {
2699 my $e = "Authorization successful but capture failed, custnum #".
2700 $self->custnum. ': '. $capture->result_code.
2701 ": ". $capture->error_message;
2709 # remove paycvv after initial transaction
2712 #false laziness w/misc/process/payment.cgi - check both to make sure working
2714 if ( defined $self->dbdef_table->column('paycvv')
2715 && length($self->paycvv)
2716 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2718 my $error = $self->remove_cvv;
2720 warn "WARNING: error removing cvv: $error\n";
2728 if ( $transaction->is_success() ) {
2730 my %method2payby = (
2737 if ( $payment_gateway ) { # agent override
2738 $paybatch = $payment_gateway->gatewaynum. '-';
2741 $paybatch .= "$processor:". $transaction->authorization;
2743 $paybatch .= ':'. $transaction->order_number
2744 if $transaction->can('order_number')
2745 && length($transaction->order_number);
2747 my $cust_pay = new FS::cust_pay ( {
2748 'custnum' => $self->custnum,
2749 'invnum' => $options{'invnum'},
2752 'payby' => $method2payby{$method},
2753 'payinfo' => $payinfo,
2754 'paybatch' => $paybatch,
2756 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
2758 $cust_pay->invnum(''); #try again with no specific invnum
2759 my $error2 = $cust_pay->insert( $options{'manual'} ?
2760 ( 'manual' => 1 ) : ()
2763 # gah, even with transactions.
2764 my $e = 'WARNING: Card/ACH debited but database not updated - '.
2765 "error inserting payment ($processor): $error2".
2766 " (previously tried insert with invnum #$options{'invnum'}" .
2772 return ''; #no error
2776 my $perror = "$processor error: ". $transaction->error_message;
2778 unless ( $transaction->error_message ) {
2781 #this should be normalized :/
2783 # bad, ad-hoc B:OP:PayflowPro "transaction_response" BS
2784 if ( $transaction->can('param')
2785 && $transaction->param('transaction_response') ) {
2786 $t_response = $transaction->param('transaction_response')
2788 # slightly better, ad-hoc B:OP:TransactionCentral without "param"
2789 } elsif ( $transaction->can('response_page') ) {
2791 'page' => ( $transaction->can('response_page')
2792 ? $transaction->response_page
2795 'code' => ( $transaction->can('response_code')
2796 ? $transaction->response_code
2799 'headers' => ( $transaction->can('response_headers')
2800 ? $transaction->response_headers
2806 "No additional debugging information available for $processor";
2809 $perror .= "No error_message returned from $processor -- ".
2810 ( ref($t_response) ? Dumper($t_response) : $t_response );
2814 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2815 && $conf->exists('emaildecline')
2816 && grep { $_ ne 'POST' } $self->invoicing_list
2817 && ! grep { $transaction->error_message =~ /$_/ }
2818 $conf->config('emaildecline-exclude')
2820 my @templ = $conf->config('declinetemplate');
2821 my $template = new Text::Template (
2823 SOURCE => [ map "$_\n", @templ ],
2824 ) or return "($perror) can't create template: $Text::Template::ERROR";
2825 $template->compile()
2826 or return "($perror) can't compile template: $Text::Template::ERROR";
2828 my $templ_hash = { error => $transaction->error_message };
2830 my $error = send_email(
2831 'from' => $conf->config('invoice_from'),
2832 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2833 'subject' => 'Your payment could not be processed',
2834 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2837 $perror .= " (also received error sending decline notification: $error)"
2847 =item default_payment_gateway
2851 sub default_payment_gateway {
2852 my( $self, $method ) = @_;
2854 die "Real-time processing not enabled\n"
2855 unless $conf->exists('business-onlinepayment');
2858 my $bop_config = 'business-onlinepayment';
2859 $bop_config .= '-ach'
2860 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2861 my ( $processor, $login, $password, $action, @bop_options ) =
2862 $conf->config($bop_config);
2863 $action ||= 'normal authorization';
2864 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2865 die "No real-time processor is enabled - ".
2866 "did you set the business-onlinepayment configuration value?\n"
2869 ( $processor, $login, $password, $action, @bop_options )
2874 Removes the I<paycvv> field from the database directly.
2876 If there is an error, returns the error, otherwise returns false.
2882 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2883 or return dbh->errstr;
2884 $sth->execute($self->custnum)
2885 or return $sth->errstr;
2890 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2892 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2893 via a Business::OnlinePayment realtime gateway. See
2894 L<http://420.am/business-onlinepayment> for supported gateways.
2896 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2898 Available options are: I<amount>, I<reason>, I<paynum>
2900 Most gateways require a reference to an original payment transaction to refund,
2901 so you probably need to specify a I<paynum>.
2903 I<amount> defaults to the original amount of the payment if not specified.
2905 I<reason> specifies a reason for the refund.
2907 Implementation note: If I<amount> is unspecified or equal to the amount of the
2908 orignal payment, first an attempt is made to "void" the transaction via
2909 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2910 the normal attempt is made to "refund" ("credit") the transaction via the
2911 gateway is attempted.
2913 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2914 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2915 #if set, will override the value from the customer record.
2917 #If an I<invnum> is specified, this payment (if successful) is applied to the
2918 #specified invoice. If you don't specify an I<invnum> you might want to
2919 #call the B<apply_payments> method.
2923 #some false laziness w/realtime_bop, not enough to make it worth merging
2924 #but some useful small subs should be pulled out
2925 sub realtime_refund_bop {
2926 my( $self, $method, %options ) = @_;
2928 warn "$me realtime_refund_bop: $method refund\n";
2929 warn " $_ => $options{$_}\n" foreach keys %options;
2932 eval "use Business::OnlinePayment";
2936 # look up the original payment and optionally a gateway for that payment
2940 my $amount = $options{'amount'};
2942 my( $processor, $login, $password, @bop_options ) ;
2943 my( $auth, $order_number ) = ( '', '', '' );
2945 if ( $options{'paynum'} ) {
2947 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
2948 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2949 or return "Unknown paynum $options{'paynum'}";
2950 $amount ||= $cust_pay->paid;
2952 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
2953 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2954 $cust_pay->paybatch;
2955 my $gatewaynum = '';
2956 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2958 if ( $gatewaynum ) { #gateway for the payment to be refunded
2960 my $payment_gateway =
2961 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2962 die "payment gateway $gatewaynum not found"
2963 unless $payment_gateway;
2965 $processor = $payment_gateway->gateway_module;
2966 $login = $payment_gateway->gateway_username;
2967 $password = $payment_gateway->gateway_password;
2968 @bop_options = $payment_gateway->options;
2970 } else { #try the default gateway
2972 my( $conf_processor, $unused_action );
2973 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2974 $self->default_payment_gateway($method);
2976 return "processor of payment $options{'paynum'} $processor does not".
2977 " match default processor $conf_processor"
2978 unless $processor eq $conf_processor;
2983 } else { # didn't specify a paynum, so look for agent gateway overrides
2984 # like a normal transaction
2987 if ( $method eq 'CC' ) {
2988 $cardtype = cardtype($self->payinfo);
2989 } elsif ( $method eq 'ECHECK' ) {
2992 $cardtype = $method;
2995 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2996 cardtype => $cardtype,
2998 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3000 taxclass => '', } );
3002 if ( $override ) { #use a payment gateway override
3004 my $payment_gateway = $override->payment_gateway;
3006 $processor = $payment_gateway->gateway_module;
3007 $login = $payment_gateway->gateway_username;
3008 $password = $payment_gateway->gateway_password;
3009 #$action = $payment_gateway->gateway_action;
3010 @bop_options = $payment_gateway->options;
3012 } else { #use the standard settings from the config
3015 ( $processor, $login, $password, $unused_action, @bop_options ) =
3016 $self->default_payment_gateway($method);
3021 return "neither amount nor paynum specified" unless $amount;
3026 'password' => $password,
3027 'order_number' => $order_number,
3028 'amount' => $amount,
3029 'referer' => 'http://cleanwhisker.420.am/',
3031 $content{authorization} = $auth
3032 if length($auth); #echeck/ACH transactions have an order # but no auth
3033 #(at least with authorize.net)
3035 #first try void if applicable
3036 if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
3037 warn " attempting void\n" if $DEBUG > 1;
3038 my $void = new Business::OnlinePayment( $processor, @bop_options );
3039 $void->content( 'action' => 'void', %content );
3041 if ( $void->is_success ) {
3042 my $error = $cust_pay->void($options{'reason'});
3044 # gah, even with transactions.
3045 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3046 "error voiding payment: $error";
3050 warn " void successful\n" if $DEBUG > 1;
3055 warn " void unsuccessful, trying refund\n"
3059 my $address = $self->address1;
3060 $address .= ", ". $self->address2 if $self->address2;
3062 my($payname, $payfirst, $paylast);
3063 if ( $self->payname && $method ne 'ECHECK' ) {
3064 $payname = $self->payname;
3065 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3066 or return "Illegal payname $payname";
3067 ($payfirst, $paylast) = ($1, $2);
3069 $payfirst = $self->getfield('first');
3070 $paylast = $self->getfield('last');
3071 $payname = "$payfirst $paylast";
3074 my @invoicing_list = $self->invoicing_list_emailonly;
3075 if ( $conf->exists('emailinvoiceautoalways')
3076 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3077 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3078 push @invoicing_list, $self->all_emails;
3081 my $email = ($conf->exists('business-onlinepayment-email-override'))
3082 ? $conf->config('business-onlinepayment-email-override')
3083 : $invoicing_list[0];
3085 my $payip = exists($options{'payip'})
3088 $content{customer_ip} = $payip
3092 if ( $method eq 'CC' ) {
3095 $content{card_number} = $payinfo = $cust_pay->payinfo;
3096 #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3097 #$content{expiration} = "$2/$1";
3099 $content{card_number} = $payinfo = $self->payinfo;
3100 $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3101 $content{expiration} = "$2/$1";
3104 } elsif ( $method eq 'ECHECK' ) {
3105 ( $content{account_number}, $content{routing_code} ) =
3106 split('@', $payinfo = $self->payinfo);
3107 $content{bank_name} = $self->payname;
3108 $content{account_type} = 'CHECKING';
3109 $content{account_name} = $payname;
3110 $content{customer_org} = $self->company ? 'B' : 'I';
3111 $content{customer_ssn} = $self->ss;
3112 } elsif ( $method eq 'LEC' ) {
3113 $content{phone} = $payinfo = $self->payinfo;
3117 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3118 my %sub_content = $refund->content(
3119 'action' => 'credit',
3120 'customer_id' => $self->custnum,
3121 'last_name' => $paylast,
3122 'first_name' => $payfirst,
3124 'address' => $address,
3125 'city' => $self->city,
3126 'state' => $self->state,
3127 'zip' => $self->zip,
3128 'country' => $self->country,
3130 'phone' => $self->daytime || $self->night,
3133 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3137 return "$processor error: ". $refund->error_message
3138 unless $refund->is_success();
3140 my %method2payby = (
3146 my $paybatch = "$processor:". $refund->authorization;
3147 $paybatch .= ':'. $refund->order_number
3148 if $refund->can('order_number') && $refund->order_number;
3150 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3151 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3152 last unless @cust_bill_pay;
3153 my $cust_bill_pay = pop @cust_bill_pay;
3154 my $error = $cust_bill_pay->delete;
3158 my $cust_refund = new FS::cust_refund ( {
3159 'custnum' => $self->custnum,
3160 'paynum' => $options{'paynum'},
3161 'refund' => $amount,
3163 'payby' => $method2payby{$method},
3164 'payinfo' => $payinfo,
3165 'paybatch' => $paybatch,
3166 'reason' => $options{'reason'} || 'card or ACH refund',
3168 my $error = $cust_refund->insert;
3170 $cust_refund->paynum(''); #try again with no specific paynum
3171 my $error2 = $cust_refund->insert;
3173 # gah, even with transactions.
3174 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3175 "error inserting refund ($processor): $error2".
3176 " (previously tried insert with paynum #$options{'paynum'}" .
3187 =item batch_card OPTION => VALUE...
3189 Adds a payment for this invoice to the pending credit card batch (see
3190 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3191 runs the payment using a realtime gateway.
3196 my ($self, %options) = @_;
3199 if (exists($options{amount})) {
3200 $amount = $options{amount};
3202 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3204 return '' unless $amount > 0;
3206 my $invnum = delete $options{invnum};
3207 my $payby = $options{invnum} || $self->payby; #dubious
3209 if ($options{'realtime'}) {
3210 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3216 my $oldAutoCommit = $FS::UID::AutoCommit;
3217 local $FS::UID::AutoCommit = 0;
3220 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3221 or return "Cannot lock pay_batch: " . $dbh->errstr;
3225 'payby' => FS::payby->payby2payment($payby),
3228 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3230 unless ( $pay_batch ) {
3231 $pay_batch = new FS::pay_batch \%pay_batch;
3232 my $error = $pay_batch->insert;
3234 $dbh->rollback if $oldAutoCommit;
3235 die "error creating new batch: $error\n";
3239 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3240 'batchnum' => $pay_batch->batchnum,
3241 'custnum' => $self->custnum,
3244 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3246 $options{$_} = '' unless exists($options{$_});
3249 my $cust_pay_batch = new FS::cust_pay_batch ( {
3250 'batchnum' => $pay_batch->batchnum,
3251 'invnum' => $invnum || 0, # is there a better value?
3252 # this field should be
3254 # cust_bill_pay_batch now
3255 'custnum' => $self->custnum,
3256 'last' => $self->getfield('last'),
3257 'first' => $self->getfield('first'),
3258 'address1' => $options{address1} || $self->address1,
3259 'address2' => $options{address2} || $self->address2,
3260 'city' => $options{city} || $self->city,
3261 'state' => $options{state} || $self->state,
3262 'zip' => $options{zip} || $self->zip,
3263 'country' => $options{country} || $self->country,
3264 'payby' => $options{payby} || $self->payby,
3265 'payinfo' => $options{payinfo} || $self->payinfo,
3266 'exp' => $options{paydate} || $self->paydate,
3267 'payname' => $options{payname} || $self->payname,
3268 'amount' => $amount, # consolidating
3271 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3272 if $old_cust_pay_batch;
3275 if ($old_cust_pay_batch) {
3276 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3278 $error = $cust_pay_batch->insert;
3282 $dbh->rollback if $oldAutoCommit;
3286 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3287 foreach my $cust_bill ($self->open_cust_bill) {
3288 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3289 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3290 'invnum' => $cust_bill->invnum,
3291 'paybatchnum' => $cust_pay_batch->paybatchnum,
3292 'amount' => $cust_bill->owed,
3295 if ($unapplied >= $cust_bill_pay_batch->amount){
3296 $unapplied -= $cust_bill_pay_batch->amount;
3299 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3300 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3302 $error = $cust_bill_pay_batch->insert;
3304 $dbh->rollback if $oldAutoCommit;
3309 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3315 Returns the total owed for this customer on all invoices
3316 (see L<FS::cust_bill/owed>).
3322 $self->total_owed_date(2145859200); #12/31/2037
3325 =item total_owed_date TIME
3327 Returns the total owed for this customer on all invoices with date earlier than
3328 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3329 see L<Time::Local> and L<Date::Parse> for conversion functions.
3333 sub total_owed_date {
3337 foreach my $cust_bill (
3338 grep { $_->_date <= $time }
3339 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3341 $total_bill += $cust_bill->owed;
3343 sprintf( "%.2f", $total_bill );
3346 =item apply_payments_and_credits
3348 Applies unapplied payments and credits.
3350 In most cases, this new method should be used in place of sequential
3351 apply_payments and apply_credits methods.
3355 sub apply_payments_and_credits {
3358 foreach my $cust_bill ( $self->open_cust_bill ) {
3359 $cust_bill->apply_payments_and_credits;
3364 =item apply_credits OPTION => VALUE ...
3366 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3367 to outstanding invoice balances in chronological order (or reverse
3368 chronological order if the I<order> option is set to B<newest>) and returns the
3369 value of any remaining unapplied credits available for refund (see
3370 L<FS::cust_refund>).
3378 return 0 unless $self->total_credited;
3380 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3381 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3383 my @invoices = $self->open_cust_bill;
3384 @invoices = sort { $b->_date <=> $a->_date } @invoices
3385 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3388 foreach my $cust_bill ( @invoices ) {
3391 if ( !defined($credit) || $credit->credited == 0) {
3392 $credit = pop @credits or last;
3395 if ($cust_bill->owed >= $credit->credited) {
3396 $amount=$credit->credited;
3398 $amount=$cust_bill->owed;
3401 my $cust_credit_bill = new FS::cust_credit_bill ( {
3402 'crednum' => $credit->crednum,
3403 'invnum' => $cust_bill->invnum,
3404 'amount' => $amount,
3406 my $error = $cust_credit_bill->insert;
3407 die $error if $error;
3409 redo if ($cust_bill->owed > 0);
3413 return $self->total_credited;
3416 =item apply_payments
3418 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3419 to outstanding invoice balances in chronological order.
3421 #and returns the value of any remaining unapplied payments.
3425 sub apply_payments {
3430 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3431 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3433 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3434 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3438 foreach my $cust_bill ( @invoices ) {
3441 if ( !defined($payment) || $payment->unapplied == 0 ) {
3442 $payment = pop @payments or last;
3445 if ( $cust_bill->owed >= $payment->unapplied ) {
3446 $amount = $payment->unapplied;
3448 $amount = $cust_bill->owed;
3451 my $cust_bill_pay = new FS::cust_bill_pay ( {
3452 'paynum' => $payment->paynum,
3453 'invnum' => $cust_bill->invnum,
3454 'amount' => $amount,
3456 my $error = $cust_bill_pay->insert;
3457 die $error if $error;
3459 redo if ( $cust_bill->owed > 0);
3463 return $self->total_unapplied_payments;
3466 =item total_credited
3468 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3469 customer. See L<FS::cust_credit/credited>.
3473 sub total_credited {
3475 my $total_credit = 0;
3476 foreach my $cust_credit ( qsearch('cust_credit', {
3477 'custnum' => $self->custnum,
3479 $total_credit += $cust_credit->credited;
3481 sprintf( "%.2f", $total_credit );
3484 =item total_unapplied_payments
3486 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3487 See L<FS::cust_pay/unapplied>.
3491 sub total_unapplied_payments {
3493 my $total_unapplied = 0;
3494 foreach my $cust_pay ( qsearch('cust_pay', {
3495 'custnum' => $self->custnum,
3497 $total_unapplied += $cust_pay->unapplied;
3499 sprintf( "%.2f", $total_unapplied );
3504 Returns the balance for this customer (total_owed minus total_credited
3505 minus total_unapplied_payments).
3512 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3516 =item balance_date TIME
3518 Returns the balance for this customer, only considering invoices with date
3519 earlier than TIME (total_owed_date minus total_credited minus
3520 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3521 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3530 $self->total_owed_date($time)
3531 - $self->total_credited
3532 - $self->total_unapplied_payments
3536 =item in_transit_payments
3538 Returns the total of requests for payments for this customer pending in
3539 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3543 sub in_transit_payments {
3545 my $in_transit_payments = 0;
3546 foreach my $pay_batch ( qsearch('pay_batch', {
3549 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3550 'batchnum' => $pay_batch->batchnum,
3551 'custnum' => $self->custnum,
3553 $in_transit_payments += $cust_pay_batch->amount;
3556 sprintf( "%.2f", $in_transit_payments );
3559 =item paydate_monthyear
3561 Returns a two-element list consisting of the month and year of this customer's
3562 paydate (credit card expiration date for CARD customers)
3566 sub paydate_monthyear {
3568 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3570 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3577 =item invoicing_list [ ARRAYREF ]
3579 If an arguement is given, sets these email addresses as invoice recipients
3580 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3581 (except as warnings), so use check_invoicing_list first.
3583 Returns a list of email addresses (with svcnum entries expanded).
3585 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3586 check it without disturbing anything by passing nothing.
3588 This interface may change in the future.
3592 sub invoicing_list {
3593 my( $self, $arrayref ) = @_;
3596 my @cust_main_invoice;
3597 if ( $self->custnum ) {
3598 @cust_main_invoice =
3599 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3601 @cust_main_invoice = ();
3603 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3604 #warn $cust_main_invoice->destnum;
3605 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3606 #warn $cust_main_invoice->destnum;
3607 my $error = $cust_main_invoice->delete;
3608 warn $error if $error;
3611 if ( $self->custnum ) {
3612 @cust_main_invoice =
3613 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3615 @cust_main_invoice = ();
3617 my %seen = map { $_->address => 1 } @cust_main_invoice;
3618 foreach my $address ( @{$arrayref} ) {
3619 next if exists $seen{$address} && $seen{$address};
3620 $seen{$address} = 1;
3621 my $cust_main_invoice = new FS::cust_main_invoice ( {
3622 'custnum' => $self->custnum,
3625 my $error = $cust_main_invoice->insert;
3626 warn $error if $error;
3630 if ( $self->custnum ) {
3632 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3639 =item check_invoicing_list ARRAYREF
3641 Checks these arguements as valid input for the invoicing_list method. If there
3642 is an error, returns the error, otherwise returns false.
3646 sub check_invoicing_list {
3647 my( $self, $arrayref ) = @_;
3648 foreach my $address ( @{$arrayref} ) {
3650 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3651 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3654 my $cust_main_invoice = new FS::cust_main_invoice ( {
3655 'custnum' => $self->custnum,
3658 my $error = $self->custnum
3659 ? $cust_main_invoice->check
3660 : $cust_main_invoice->checkdest
3662 return $error if $error;
3667 =item set_default_invoicing_list
3669 Sets the invoicing list to all accounts associated with this customer,
3670 overwriting any previous invoicing list.
3674 sub set_default_invoicing_list {
3676 $self->invoicing_list($self->all_emails);
3681 Returns the email addresses of all accounts provisioned for this customer.
3688 foreach my $cust_pkg ( $self->all_pkgs ) {
3689 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3691 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3692 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3694 $list{$_}=1 foreach map { $_->email } @svc_acct;
3699 =item invoicing_list_addpost
3701 Adds postal invoicing to this customer. If this customer is already configured
3702 to receive postal invoices, does nothing.
3706 sub invoicing_list_addpost {
3708 return if grep { $_ eq 'POST' } $self->invoicing_list;
3709 my @invoicing_list = $self->invoicing_list;
3710 push @invoicing_list, 'POST';
3711 $self->invoicing_list(\@invoicing_list);
3714 =item invoicing_list_emailonly
3716 Returns the list of email invoice recipients (invoicing_list without non-email
3717 destinations such as POST and FAX).
3721 sub invoicing_list_emailonly {
3723 warn "$me invoicing_list_emailonly called"
3725 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3728 =item invoicing_list_emailonly_scalar
3730 Returns the list of email invoice recipients (invoicing_list without non-email
3731 destinations such as POST and FAX) as a comma-separated scalar.
3735 sub invoicing_list_emailonly_scalar {
3737 warn "$me invoicing_list_emailonly_scalar called"
3739 join(', ', $self->invoicing_list_emailonly);
3742 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3744 Returns an array of customers referred by this customer (referral_custnum set
3745 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3746 customers referred by customers referred by this customer and so on, inclusive.
3747 The default behavior is DEPTH 1 (no recursion).
3751 sub referral_cust_main {
3753 my $depth = @_ ? shift : 1;
3754 my $exclude = @_ ? shift : {};
3757 map { $exclude->{$_->custnum}++; $_; }
3758 grep { ! $exclude->{ $_->custnum } }
3759 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3763 map { $_->referral_cust_main($depth-1, $exclude) }
3770 =item referral_cust_main_ncancelled
3772 Same as referral_cust_main, except only returns customers with uncancelled
3777 sub referral_cust_main_ncancelled {
3779 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3782 =item referral_cust_pkg [ DEPTH ]
3784 Like referral_cust_main, except returns a flat list of all unsuspended (and
3785 uncancelled) packages for each customer. The number of items in this list may
3786 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3790 sub referral_cust_pkg {
3792 my $depth = @_ ? shift : 1;
3794 map { $_->unsuspended_pkgs }
3795 grep { $_->unsuspended_pkgs }
3796 $self->referral_cust_main($depth);
3799 =item referring_cust_main
3801 Returns the single cust_main record for the customer who referred this customer
3802 (referral_custnum), or false.
3806 sub referring_cust_main {
3808 return '' unless $self->referral_custnum;
3809 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3812 =item credit AMOUNT, REASON
3814 Applies a credit to this customer. If there is an error, returns the error,
3815 otherwise returns false.
3820 my( $self, $amount, $reason ) = @_;
3821 my $cust_credit = new FS::cust_credit {
3822 'custnum' => $self->custnum,
3823 'amount' => $amount,
3824 'reason' => $reason,
3826 $cust_credit->insert;
3829 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3831 Creates a one-time charge for this customer. If there is an error, returns
3832 the error, otherwise returns false.
3838 my ( $amount, $pkg, $comment, $taxclass, $additional );
3839 if ( ref( $_[0] ) ) {
3840 $amount = $_[0]->{amount};
3841 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3842 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3843 : '$'. sprintf("%.2f",$amount);
3844 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3845 $additional = $_[0]->{additional};
3848 $pkg = @_ ? shift : 'One-time charge';
3849 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3850 $taxclass = @_ ? shift : '';
3854 local $SIG{HUP} = 'IGNORE';
3855 local $SIG{INT} = 'IGNORE';
3856 local $SIG{QUIT} = 'IGNORE';
3857 local $SIG{TERM} = 'IGNORE';
3858 local $SIG{TSTP} = 'IGNORE';
3859 local $SIG{PIPE} = 'IGNORE';
3861 my $oldAutoCommit = $FS::UID::AutoCommit;
3862 local $FS::UID::AutoCommit = 0;
3865 my $part_pkg = new FS::part_pkg ( {
3867 'comment' => $comment,
3871 'taxclass' => $taxclass,
3874 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3875 ( 0 .. @$additional - 1 )
3877 'additional_count' => scalar(@$additional),
3878 'setup_fee' => $amount,
3881 my $error = $part_pkg->insert( options => \%options );
3883 $dbh->rollback if $oldAutoCommit;
3887 my $pkgpart = $part_pkg->pkgpart;
3888 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3889 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3890 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3891 $error = $type_pkgs->insert;
3893 $dbh->rollback if $oldAutoCommit;
3898 my $cust_pkg = new FS::cust_pkg ( {
3899 'custnum' => $self->custnum,
3900 'pkgpart' => $pkgpart,
3903 $error = $cust_pkg->insert;
3905 $dbh->rollback if $oldAutoCommit;
3909 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3916 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3922 sort { $a->_date <=> $b->_date }
3923 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3926 =item open_cust_bill
3928 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3933 sub open_cust_bill {
3935 grep { $_->owed > 0 } $self->cust_bill;
3940 Returns all the credits (see L<FS::cust_credit>) for this customer.
3946 sort { $a->_date <=> $b->_date }
3947 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3952 Returns all the payments (see L<FS::cust_pay>) for this customer.
3958 sort { $a->_date <=> $b->_date }
3959 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3964 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3970 sort { $a->_date <=> $b->_date }
3971 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3977 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3983 sort { $a->_date <=> $b->_date }
3984 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3989 Returns a name string for this customer, either "Company (Last, First)" or
3996 my $name = $self->contact;
3997 $name = $self->company. " ($name)" if $self->company;
4003 Returns a name string for this (service/shipping) contact, either
4004 "Company (Last, First)" or "Last, First".
4010 if ( $self->get('ship_last') ) {
4011 my $name = $self->ship_contact;
4012 $name = $self->ship_company. " ($name)" if $self->ship_company;
4021 Returns this customer's full (billing) contact name only, "Last, First"
4027 $self->get('last'). ', '. $self->first;
4032 Returns this customer's full (shipping) contact name only, "Last, First"
4038 $self->get('ship_last')
4039 ? $self->get('ship_last'). ', '. $self->ship_first
4045 Returns this customer's full country name
4051 code2country($self->country);
4058 Returns a status string for this customer, currently:
4062 =item prospect - No packages have ever been ordered
4064 =item active - One or more recurring packages is active
4066 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4068 =item suspended - All non-cancelled recurring packages are suspended
4070 =item cancelled - All recurring packages are cancelled
4076 sub status { shift->cust_status(@_); }
4080 for my $status (qw( prospect active inactive suspended cancelled )) {
4081 my $method = $status.'_sql';
4082 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4083 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4084 $sth->execute( ($self->custnum) x $numnum )
4085 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4086 return $status if $sth->fetchrow_arrayref->[0];
4090 =item ucfirst_cust_status
4092 =item ucfirst_status
4094 Returns the status with the first character capitalized.
4098 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4100 sub ucfirst_cust_status {
4102 ucfirst($self->cust_status);
4107 Returns a hex triplet color string for this customer's status.
4111 use vars qw(%statuscolor);
4113 'prospect' => '7e0079', #'000000', #black? naw, purple
4114 'active' => '00CC00', #green
4115 'inactive' => '0000CC', #blue
4116 'suspended' => 'FF9900', #yellow
4117 'cancelled' => 'FF0000', #red
4120 sub statuscolor { shift->cust_statuscolor(@_); }
4122 sub cust_statuscolor {
4124 $statuscolor{$self->cust_status};
4129 =head1 CLASS METHODS
4135 Returns an SQL expression identifying prospective cust_main records (customers
4136 with no packages ever ordered)
4140 use vars qw($select_count_pkgs);
4141 $select_count_pkgs =
4142 "SELECT COUNT(*) FROM cust_pkg
4143 WHERE cust_pkg.custnum = cust_main.custnum";
4145 sub select_count_pkgs_sql {
4149 sub prospect_sql { "
4150 0 = ( $select_count_pkgs )
4155 Returns an SQL expression identifying active cust_main records (customers with
4156 no active recurring packages, but otherwise unsuspended/uncancelled).
4161 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4167 Returns an SQL expression identifying inactive cust_main records (customers with
4168 active recurring packages).
4172 sub inactive_sql { "
4173 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4175 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4181 Returns an SQL expression identifying suspended cust_main records.
4186 sub suspended_sql { susp_sql(@_); }
4188 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4190 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4196 Returns an SQL expression identifying cancelled cust_main records.
4200 sub cancelled_sql { cancel_sql(@_); }
4203 my $recurring_sql = FS::cust_pkg->recurring_sql;
4204 #my $recurring_sql = "
4205 # '0' != ( select freq from part_pkg
4206 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4210 0 < ( $select_count_pkgs )
4211 AND 0 = ( $select_count_pkgs AND $recurring_sql
4212 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4218 =item uncancelled_sql
4220 Returns an SQL expression identifying un-cancelled cust_main records.
4224 sub uncancelled_sql { uncancel_sql(@_); }
4225 sub uncancel_sql { "
4226 ( 0 < ( $select_count_pkgs
4227 AND ( cust_pkg.cancel IS NULL
4228 OR cust_pkg.cancel = 0
4231 OR 0 = ( $select_count_pkgs )
4235 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4237 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4238 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4239 appropriate ship_ field is also searched).
4241 Additional options are the same as FS::Record::qsearch
4246 my( $self, $fuzzy, $hash, @opt) = @_;
4251 check_and_rebuild_fuzzyfiles();
4252 foreach my $field ( keys %$fuzzy ) {
4254 my $all = $self->all_X($field);
4255 next unless scalar(@$all);
4258 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4261 foreach ( keys %match ) {
4262 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4263 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4266 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4269 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4271 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4279 Returns a masked version of the named field
4284 my ($self, $field) = @_;
4288 'x'x(length($self->getfield($field))-4).
4289 substr($self->getfield($field), (length($self->getfield($field))-4));
4299 =item smart_search OPTION => VALUE ...
4301 Accepts the following options: I<search>, the string to search for. The string
4302 will be searched for as a customer number, phone number, name or company name,
4303 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4304 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4305 skip fuzzy matching when an exact match is found.
4307 Any additional options are treated as an additional qualifier on the search
4310 Returns a (possibly empty) array of FS::cust_main objects.
4317 #here is the agent virtualization
4318 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4322 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4323 my $search = delete $options{'search'};
4324 ( my $alphanum_search = $search ) =~ s/\W//g;
4326 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4328 #false laziness w/Record::ut_phone
4329 my $phonen = "$1-$2-$3";
4330 $phonen .= " x$4" if $4;
4332 push @cust_main, qsearch( {
4333 'table' => 'cust_main',
4334 'hashref' => { %options },
4335 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4337 join(' OR ', map "$_ = '$phonen'",
4338 qw( daytime night fax
4339 ship_daytime ship_night ship_fax )
4342 " AND $agentnums_sql", #agent virtualization
4345 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4346 #try looking for matches with extensions unless one was specified
4348 push @cust_main, qsearch( {
4349 'table' => 'cust_main',
4350 'hashref' => { %options },
4351 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4353 join(' OR ', map "$_ LIKE '$phonen\%'",
4355 ship_daytime ship_night )
4358 " AND $agentnums_sql", #agent virtualization
4363 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4365 push @cust_main, qsearch( {
4366 'table' => 'cust_main',
4367 'hashref' => { 'custnum' => $1, %options },
4368 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4371 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4373 my($company, $last, $first) = ( $1, $2, $3 );
4375 # "Company (Last, First)"
4376 #this is probably something a browser remembered,
4377 #so just do an exact search
4379 foreach my $prefix ( '', 'ship_' ) {
4380 push @cust_main, qsearch( {
4381 'table' => 'cust_main',
4382 'hashref' => { $prefix.'first' => $first,
4383 $prefix.'last' => $last,
4384 $prefix.'company' => $company,
4387 'extra_sql' => " AND $agentnums_sql",
4391 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4392 # try (ship_){last,company}
4396 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4397 # # full strings the browser remembers won't work
4398 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4400 use Lingua::EN::NameParse;
4401 my $NameParse = new Lingua::EN::NameParse(
4403 allow_reversed => 1,
4406 my($last, $first) = ( '', '' );
4407 #maybe disable this too and just rely on NameParse?
4408 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4410 ($last, $first) = ( $1, $2 );
4412 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4413 } elsif ( ! $NameParse->parse($value) ) {
4415 my %name = $NameParse->components;
4416 $first = $name{'given_name_1'};
4417 $last = $name{'surname_1'};
4421 if ( $first && $last ) {
4423 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4426 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4428 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4429 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4432 push @cust_main, qsearch( {
4433 'table' => 'cust_main',
4434 'hashref' => \%options,
4435 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4438 # or it just be something that was typed in... (try that in a sec)
4442 my $q_value = dbh->quote($value);
4445 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4446 $sql .= " ( LOWER(last) = $q_value
4447 OR LOWER(company) = $q_value
4448 OR LOWER(ship_last) = $q_value
4449 OR LOWER(ship_company) = $q_value
4452 push @cust_main, qsearch( {
4453 'table' => 'cust_main',
4454 'hashref' => \%options,
4455 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4458 #always do substring & fuzzy,
4459 #getting complains searches are not returning enough
4460 unless ( @cust_main && $skip_fuzzy ) { #no exact match, trying substring/fuzzy
4462 #still some false laziness w/ search/cust_main.cgi
4467 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4468 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4471 if ( $first && $last ) {
4474 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4475 'last' => { op=>'ILIKE', value=>"%$last%" },
4477 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4478 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4485 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4486 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4490 foreach my $hashref ( @hashrefs ) {
4492 push @cust_main, qsearch( {
4493 'table' => 'cust_main',
4494 'hashref' => { %$hashref,
4497 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4506 " AND $agentnums_sql", #extra_sql #agent virtualization
4509 if ( $first && $last ) {
4510 push @cust_main, FS::cust_main->fuzzy_search(
4511 { 'last' => $last, #fuzzy hashref
4512 'first' => $first }, #
4516 foreach my $field ( 'last', 'company' ) {
4518 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4523 #eliminate duplicates
4525 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4533 =item check_and_rebuild_fuzzyfiles
4537 use vars qw(@fuzzyfields);
4538 @fuzzyfields = ( 'last', 'first', 'company' );
4540 sub check_and_rebuild_fuzzyfiles {
4541 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4542 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4545 =item rebuild_fuzzyfiles
4549 sub rebuild_fuzzyfiles {
4551 use Fcntl qw(:flock);
4553 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4554 mkdir $dir, 0700 unless -d $dir;
4556 foreach my $fuzzy ( @fuzzyfields ) {
4558 open(LOCK,">>$dir/cust_main.$fuzzy")
4559 or die "can't open $dir/cust_main.$fuzzy: $!";
4561 or die "can't lock $dir/cust_main.$fuzzy: $!";
4563 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4564 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4566 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4567 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4568 " WHERE $field != '' AND $field IS NOT NULL");
4569 $sth->execute or die $sth->errstr;
4571 while ( my $row = $sth->fetchrow_arrayref ) {
4572 print CACHE $row->[0]. "\n";
4577 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4579 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4590 my( $self, $field ) = @_;
4591 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4592 open(CACHE,"<$dir/cust_main.$field")
4593 or die "can't open $dir/cust_main.$field: $!";
4594 my @array = map { chomp; $_; } <CACHE>;
4599 =item append_fuzzyfiles LASTNAME COMPANY
4603 sub append_fuzzyfiles {
4604 #my( $first, $last, $company ) = @_;
4606 &check_and_rebuild_fuzzyfiles;
4608 use Fcntl qw(:flock);
4610 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4612 foreach my $field (qw( first last company )) {
4617 open(CACHE,">>$dir/cust_main.$field")
4618 or die "can't open $dir/cust_main.$field: $!";
4619 flock(CACHE,LOCK_EX)
4620 or die "can't lock $dir/cust_main.$field: $!";
4622 print CACHE "$value\n";
4624 flock(CACHE,LOCK_UN)
4625 or die "can't unlock $dir/cust_main.$field: $!";
4640 #warn join('-',keys %$param);
4641 my $fh = $param->{filehandle};
4642 my $agentnum = $param->{agentnum};
4644 my $refnum = $param->{refnum};
4645 my $pkgpart = $param->{pkgpart};
4647 #my @fields = @{$param->{fields}};
4648 my $format = $param->{'format'};
4651 if ( $format eq 'simple' ) {
4652 @fields = qw( cust_pkg.setup dayphone first last
4653 address1 address2 city state zip comments );
4655 } elsif ( $format eq 'extended' ) {
4656 @fields = qw( agent_custid refnum
4657 last first address1 address2 city state zip country
4659 ship_last ship_first ship_address1 ship_address2
4660 ship_city ship_state ship_zip ship_country
4661 payinfo paycvv paydate
4664 svc_acct.username svc_acct._password
4668 die "unknown format $format";
4671 eval "use Text::CSV_XS;";
4674 my $csv = new Text::CSV_XS;
4681 local $SIG{HUP} = 'IGNORE';
4682 local $SIG{INT} = 'IGNORE';
4683 local $SIG{QUIT} = 'IGNORE';
4684 local $SIG{TERM} = 'IGNORE';
4685 local $SIG{TSTP} = 'IGNORE';
4686 local $SIG{PIPE} = 'IGNORE';
4688 my $oldAutoCommit = $FS::UID::AutoCommit;
4689 local $FS::UID::AutoCommit = 0;
4692 #while ( $columns = $csv->getline($fh) ) {
4694 while ( defined($line=<$fh>) ) {
4696 $csv->parse($line) or do {
4697 $dbh->rollback if $oldAutoCommit;
4698 return "can't parse: ". $csv->error_input();
4701 my @columns = $csv->fields();
4702 #warn join('-',@columns);
4705 agentnum => $agentnum,
4707 country => $conf->config('countrydefault') || 'US',
4708 payby => $payby, #default
4709 paydate => '12/2037', #default
4711 my $billtime = time;
4712 my %cust_pkg = ( pkgpart => $pkgpart );
4714 foreach my $field ( @fields ) {
4716 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4718 #$cust_pkg{$1} = str2time( shift @$columns );
4719 if ( $1 eq 'pkgpart' ) {
4720 $cust_pkg{$1} = shift @columns;
4721 } elsif ( $1 eq 'setup' ) {
4722 $billtime = str2time(shift @columns);
4724 $cust_pkg{$1} = str2time( shift @columns );
4727 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4729 $svc_acct{$1} = shift @columns;
4733 #refnum interception
4734 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4736 my $referral = $columns[0];
4737 my %hash = ( 'referral' => $referral,
4738 'agentnum' => $agentnum,
4742 my $part_referral = qsearchs('part_referral', \%hash )
4743 || new FS::part_referral \%hash;
4745 unless ( $part_referral->refnum ) {
4746 my $error = $part_referral->insert;
4748 $dbh->rollback if $oldAutoCommit;
4749 return "can't auto-insert advertising source: $referral: $error";
4753 $columns[0] = $part_referral->refnum;
4756 #$cust_main{$field} = shift @$columns;
4757 $cust_main{$field} = shift @columns;
4761 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4763 my $invoicing_list = $cust_main{'invoicing_list'}
4764 ? [ delete $cust_main{'invoicing_list'} ]
4767 my $cust_main = new FS::cust_main ( \%cust_main );
4770 tie my %hash, 'Tie::RefHash'; #this part is important
4772 if ( $cust_pkg{'pkgpart'} ) {
4773 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4776 if ( $svc_acct{'username'} ) {
4777 my $part_pkg = $cust_pkg->part_pkg;
4778 unless ( $part_pkg ) {
4779 $dbh->rollback if $oldAutoCommit;
4780 return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4782 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4783 push @svc_acct, new FS::svc_acct ( \%svc_acct )
4786 $hash{$cust_pkg} = \@svc_acct;
4789 my $error = $cust_main->insert( \%hash, $invoicing_list );
4792 $dbh->rollback if $oldAutoCommit;
4793 return "can't insert customer for $line: $error";
4796 if ( $format eq 'simple' ) {
4798 #false laziness w/bill.cgi
4799 $error = $cust_main->bill( 'time' => $billtime );
4801 $dbh->rollback if $oldAutoCommit;
4802 return "can't bill customer for $line: $error";
4805 $cust_main->apply_payments_and_credits;
4807 $error = $cust_main->collect();
4809 $dbh->rollback if $oldAutoCommit;
4810 return "can't collect customer for $line: $error";
4818 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4820 return "Empty file!" unless $imported;
4832 #warn join('-',keys %$param);
4833 my $fh = $param->{filehandle};
4834 my @fields = @{$param->{fields}};
4836 eval "use Text::CSV_XS;";
4839 my $csv = new Text::CSV_XS;
4846 local $SIG{HUP} = 'IGNORE';
4847 local $SIG{INT} = 'IGNORE';
4848 local $SIG{QUIT} = 'IGNORE';
4849 local $SIG{TERM} = 'IGNORE';
4850 local $SIG{TSTP} = 'IGNORE';
4851 local $SIG{PIPE} = 'IGNORE';
4853 my $oldAutoCommit = $FS::UID::AutoCommit;
4854 local $FS::UID::AutoCommit = 0;
4857 #while ( $columns = $csv->getline($fh) ) {
4859 while ( defined($line=<$fh>) ) {
4861 $csv->parse($line) or do {
4862 $dbh->rollback if $oldAutoCommit;
4863 return "can't parse: ". $csv->error_input();
4866 my @columns = $csv->fields();
4867 #warn join('-',@columns);
4870 foreach my $field ( @fields ) {
4871 $row{$field} = shift @columns;
4874 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4875 unless ( $cust_main ) {
4876 $dbh->rollback if $oldAutoCommit;
4877 return "unknown custnum $row{'custnum'}";
4880 if ( $row{'amount'} > 0 ) {
4881 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4883 $dbh->rollback if $oldAutoCommit;
4887 } elsif ( $row{'amount'} < 0 ) {
4888 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4891 $dbh->rollback if $oldAutoCommit;
4901 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4903 return "Empty file!" unless $imported;
4909 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4911 Sends a templated email notification to the customer (see L<Text::Template).
4913 OPTIONS is a hash and may include
4915 I<from> - the email sender (default is invoice_from)
4917 I<to> - comma-separated scalar or arrayref of recipients
4918 (default is invoicing_list)
4920 I<subject> - The subject line of the sent email notification
4921 (default is "Notice from company_name")
4923 I<extra_fields> - a hashref of name/value pairs which will be substituted
4926 The following variables are vavailable in the template.
4928 I<$first> - the customer first name
4929 I<$last> - the customer last name
4930 I<$company> - the customer company
4931 I<$payby> - a description of the method of payment for the customer
4932 # would be nice to use FS::payby::shortname
4933 I<$payinfo> - the account information used to collect for this customer
4934 I<$expdate> - the expiration of the customer payment in seconds from epoch
4939 my ($customer, $template, %options) = @_;
4941 return unless $conf->exists($template);
4943 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
4944 $from = $options{from} if exists($options{from});
4946 my $to = join(',', $customer->invoicing_list_emailonly);
4947 $to = $options{to} if exists($options{to});
4949 my $subject = "Notice from " . $conf->config('company_name')
4950 if $conf->exists('company_name');
4951 $subject = $options{subject} if exists($options{subject});
4953 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4954 SOURCE => [ map "$_\n",
4955 $conf->config($template)]
4957 or die "can't create new Text::Template object: Text::Template::ERROR";
4958 $notify_template->compile()
4959 or die "can't compile template: Text::Template::ERROR";
4961 my $paydate = $customer->paydate;
4962 $FS::notify_template::_template::first = $customer->first;
4963 $FS::notify_template::_template::last = $customer->last;
4964 $FS::notify_template::_template::company = $customer->company;
4965 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
4966 my $payby = $customer->payby;
4967 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4968 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4970 #credit cards expire at the end of the month/year of their exp date
4971 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4972 $FS::notify_template::_template::payby = 'credit card';
4973 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4974 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4976 }elsif ($payby eq 'COMP') {
4977 $FS::notify_template::_template::payby = 'complimentary account';
4979 $FS::notify_template::_template::payby = 'current method';
4981 $FS::notify_template::_template::expdate = $expire_time;
4983 for (keys %{$options{extra_fields}}){
4985 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4988 send_email(from => $from,
4990 subject => $subject,
4991 body => $notify_template->fill_in( PACKAGE =>
4992 'FS::notify_template::_template' ),
5003 The delete method should possibly take an FS::cust_main object reference
5004 instead of a scalar customer number.
5006 Bill and collect options should probably be passed as references instead of a
5009 There should probably be a configuration file with a list of allowed credit
5012 No multiple currency support (probably a larger project than just this module).
5014 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5016 Birthdates rely on negative epoch values.
5018 The payby for card/check batches is broken. With mixed batching, bad
5023 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5024 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5025 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.