5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Scalar::Util qw( blessed );
12 use Time::Local qw(timelocal_nocheck);
15 use Digest::MD5 qw(md5_base64);
19 use File::Slurp qw( slurp );
20 use File::Temp qw( tempfile );
21 use String::Approx qw(amatch);
22 use Business::CreditCard 0.28;
24 use FS::UID qw( getotaker dbh driver_name );
25 use FS::Record qw( qsearchs qsearch dbdef );
26 use FS::Misc qw( generate_email send_email generate_ps do_print );
27 use FS::Msgcat qw(gettext);
31 use FS::cust_bill_pkg;
32 use FS::cust_bill_pkg_display;
34 use FS::cust_pay_pending;
35 use FS::cust_pay_void;
36 use FS::cust_pay_batch;
39 use FS::part_referral;
40 use FS::cust_main_county;
41 use FS::cust_tax_location;
43 use FS::cust_main_invoice;
44 use FS::cust_credit_bill;
45 use FS::cust_bill_pay;
46 use FS::prepay_credit;
50 use FS::part_event_condition;
53 use FS::payment_gateway;
54 use FS::agent_payment_gateway;
56 use FS::payinfo_Mixin;
59 @ISA = qw( FS::payinfo_Mixin FS::Record );
61 @EXPORT_OK = qw( smart_search );
63 $realtime_bop_decline_quiet = 0;
65 # 1 is mostly method/subroutine entry and options
66 # 2 traces progress of some operations
67 # 3 is even more information including possibly sensitive data
69 $me = '[FS::cust_main]';
73 $ignore_expired_card = 0;
75 @encrypted_fields = ('payinfo', 'paycvv');
76 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
78 #ask FS::UID to run this stuff for us later
79 #$FS::UID::callback{'FS::cust_main'} = sub {
80 install_callback FS::UID sub {
82 #yes, need it for stuff below (prolly should be cached)
87 my ( $hashref, $cache ) = @_;
88 if ( exists $hashref->{'pkgnum'} ) {
89 #@{ $self->{'_pkgnum'} } = ();
90 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
91 $self->{'_pkgnum'} = $subcache;
92 #push @{ $self->{'_pkgnum'} },
93 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
99 FS::cust_main - Object methods for cust_main records
105 $record = new FS::cust_main \%hash;
106 $record = new FS::cust_main { 'column' => 'value' };
108 $error = $record->insert;
110 $error = $new_record->replace($old_record);
112 $error = $record->delete;
114 $error = $record->check;
116 @cust_pkg = $record->all_pkgs;
118 @cust_pkg = $record->ncancelled_pkgs;
120 @cust_pkg = $record->suspended_pkgs;
122 $error = $record->bill;
123 $error = $record->bill %options;
124 $error = $record->bill 'time' => $time;
126 $error = $record->collect;
127 $error = $record->collect %options;
128 $error = $record->collect 'invoice_time' => $time,
133 An FS::cust_main object represents a customer. FS::cust_main inherits from
134 FS::Record. The following fields are currently supported:
138 =item custnum - primary key (assigned automatically for new customers)
140 =item agentnum - agent (see L<FS::agent>)
142 =item refnum - Advertising source (see L<FS::part_referral>)
148 =item ss - social security number (optional)
150 =item company - (optional)
154 =item address2 - (optional)
158 =item county - (optional, see L<FS::cust_main_county>)
160 =item state - (see L<FS::cust_main_county>)
164 =item country - (see L<FS::cust_main_county>)
166 =item daytime - phone (optional)
168 =item night - phone (optional)
170 =item fax - phone (optional)
172 =item ship_first - name
174 =item ship_last - name
176 =item ship_company - (optional)
180 =item ship_address2 - (optional)
184 =item ship_county - (optional, see L<FS::cust_main_county>)
186 =item ship_state - (see L<FS::cust_main_county>)
190 =item ship_country - (see L<FS::cust_main_county>)
192 =item ship_daytime - phone (optional)
194 =item ship_night - phone (optional)
196 =item ship_fax - phone (optional)
198 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
200 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
202 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
206 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
208 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
210 =item paystart_month - start date month (maestro/solo cards only)
212 =item paystart_year - start date year (maestro/solo cards only)
214 =item payissue - issue number (maestro/solo cards only)
216 =item payname - name on card or billing name
218 =item payip - IP address from which payment information was received
220 =item tax - tax exempt, empty or `Y'
222 =item otaker - order taker (assigned automatically, see L<FS::UID>)
224 =item comments - comments (optional)
226 =item referral_custnum - referring customer number
228 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
230 =item dundate - a suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
232 =item squelch_cdr - Discourage individual CDR printing, empty or `Y'
242 Creates a new customer. To add the customer to the database, see L<"insert">.
244 Note that this stores the hash reference, not a distinct copy of the hash it
245 points to. You can ask the object for a copy with the I<hash> method.
249 sub table { 'cust_main'; }
251 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
253 Adds this customer to the database. If there is an error, returns the error,
254 otherwise returns false.
256 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
257 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
258 are inserted atomicly, or the transaction is rolled back. Passing an empty
259 hash reference is equivalent to not supplying this parameter. There should be
260 a better explanation of this, but until then, here's an example:
263 tie %hash, 'Tie::RefHash'; #this part is important
265 $cust_pkg => [ $svc_acct ],
268 $cust_main->insert( \%hash );
270 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
271 be set as the invoicing list (see L<"invoicing_list">). Errors return as
272 expected and rollback the entire transaction; it is not necessary to call
273 check_invoicing_list first. The invoicing_list is set after the records in the
274 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
275 invoicing_list destination to the newly-created svc_acct. Here's an example:
277 $cust_main->insert( {}, [ $email, 'POST' ] );
279 Currently available options are: I<depend_jobnum> and I<noexport>.
281 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
282 on the supplied jobnum (they will not run until the specific job completes).
283 This can be used to defer provisioning until some action completes (such
284 as running the customer's credit card successfully).
286 The I<noexport> option is deprecated. If I<noexport> is set true, no
287 provisioning jobs (exports) are scheduled. (You can schedule them later with
288 the B<reexport> method.)
294 my $cust_pkgs = @_ ? shift : {};
295 my $invoicing_list = @_ ? shift : '';
297 warn "$me insert called with options ".
298 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
301 local $SIG{HUP} = 'IGNORE';
302 local $SIG{INT} = 'IGNORE';
303 local $SIG{QUIT} = 'IGNORE';
304 local $SIG{TERM} = 'IGNORE';
305 local $SIG{TSTP} = 'IGNORE';
306 local $SIG{PIPE} = 'IGNORE';
308 my $oldAutoCommit = $FS::UID::AutoCommit;
309 local $FS::UID::AutoCommit = 0;
312 my $prepay_identifier = '';
313 my( $amount, $seconds ) = ( 0, 0 );
315 if ( $self->payby eq 'PREPAY' ) {
317 $self->payby('BILL');
318 $prepay_identifier = $self->payinfo;
321 warn " looking up prepaid card $prepay_identifier\n"
324 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
326 $dbh->rollback if $oldAutoCommit;
327 #return "error applying prepaid card (transaction rolled back): $error";
331 $payby = 'PREP' if $amount;
333 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
336 $self->payby('BILL');
337 $amount = $self->paid;
341 warn " inserting $self\n"
344 $self->signupdate(time) unless $self->signupdate;
346 $self->auto_agent_custid()
347 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
349 my $error = $self->SUPER::insert;
351 $dbh->rollback if $oldAutoCommit;
352 #return "inserting cust_main record (transaction rolled back): $error";
356 warn " setting invoicing list\n"
359 if ( $invoicing_list ) {
360 $error = $self->check_invoicing_list( $invoicing_list );
362 $dbh->rollback if $oldAutoCommit;
363 #return "checking invoicing_list (transaction rolled back): $error";
366 $self->invoicing_list( $invoicing_list );
369 if ( $conf->config('cust_main-skeleton_tables')
370 && $conf->config('cust_main-skeleton_custnum') ) {
372 warn " inserting skeleton records\n"
375 my $error = $self->start_copy_skel;
377 $dbh->rollback if $oldAutoCommit;
383 warn " ordering packages\n"
386 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
388 $dbh->rollback if $oldAutoCommit;
393 $dbh->rollback if $oldAutoCommit;
394 return "No svc_acct record to apply pre-paid time";
398 warn " inserting initial $payby payment of $amount\n"
400 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
402 $dbh->rollback if $oldAutoCommit;
403 return "inserting payment (transaction rolled back): $error";
407 unless ( $import || $skip_fuzzyfiles ) {
408 warn " queueing fuzzyfiles update\n"
410 $error = $self->queue_fuzzyfiles_update;
412 $dbh->rollback if $oldAutoCommit;
413 return "updating fuzzy search cache: $error";
417 warn " insert complete; committing transaction\n"
420 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
425 use File::CounterFile;
426 sub auto_agent_custid {
429 my $format = $conf->config('cust_main-auto_agent_custid');
431 if ( $format eq '1YMMXXXXXXXX' ) {
433 my $counter = new File::CounterFile 'cust_main.agent_custid';
436 my $ym = 100000000000 + time2str('%y%m00000000', time);
437 if ( $ym > $counter->value ) {
438 $counter->{'value'} = $agent_custid = $ym;
439 $counter->{'updated'} = 1;
441 $agent_custid = $counter->inc;
447 die "Unknown cust_main-auto_agent_custid format: $format";
450 $self->agent_custid($agent_custid);
454 sub start_copy_skel {
457 #'mg_user_preference' => {},
458 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
459 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
460 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
461 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
462 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
465 _copy_skel( 'cust_main', #tablename
466 $conf->config('cust_main-skeleton_custnum'), #sourceid
467 $self->custnum, #destid
468 @tables, #child tables
472 #recursive subroutine, not a method
474 my( $table, $sourceid, $destid, %child_tables ) = @_;
477 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
478 ( $table, $primary_key ) = ( $1, $2 );
480 my $dbdef_table = dbdef->table($table);
481 $primary_key = $dbdef_table->primary_key
482 or return "$table has no primary key".
483 " (or do you need to run dbdef-create?)";
486 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
487 join (', ', keys %child_tables). "\n"
490 foreach my $child_table_def ( keys %child_tables ) {
494 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
495 ( $child_table, $child_pkey ) = ( $1, $2 );
497 $child_table = $child_table_def;
499 $child_pkey = dbdef->table($child_table)->primary_key;
500 # or return "$table has no primary key".
501 # " (or do you need to run dbdef-create?)\n";
505 if ( keys %{ $child_tables{$child_table_def} } ) {
507 return "$child_table has no primary key".
508 " (run dbdef-create or try specifying it?)\n"
511 #false laziness w/Record::insert and only works on Pg
512 #refactor the proper last-inserted-id stuff out of Record::insert if this
513 # ever gets use for anything besides a quick kludge for one customer
514 my $default = dbdef->table($child_table)->column($child_pkey)->default;
515 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
516 or return "can't parse $child_table.$child_pkey default value ".
517 " for sequence name: $default";
522 my @sel_columns = grep { $_ ne $primary_key }
523 dbdef->table($child_table)->columns;
524 my $sel_columns = join(', ', @sel_columns );
526 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
527 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
528 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
530 my $sel_st = "SELECT $sel_columns FROM $child_table".
531 " WHERE $primary_key = $sourceid";
534 my $sel_sth = dbh->prepare( $sel_st )
535 or return dbh->errstr;
537 $sel_sth->execute or return $sel_sth->errstr;
539 while ( my $row = $sel_sth->fetchrow_hashref ) {
541 warn " selected row: ".
542 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
546 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
547 my $ins_sth =dbh->prepare($statement)
548 or return dbh->errstr;
549 my @param = ( $destid, map $row->{$_}, @ins_columns );
550 warn " $statement: [ ". join(', ', @param). " ]\n"
552 $ins_sth->execute( @param )
553 or return $ins_sth->errstr;
555 #next unless keys %{ $child_tables{$child_table} };
556 next unless $sequence;
558 #another section of that laziness
559 my $seq_sql = "SELECT currval('$sequence')";
560 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
561 $seq_sth->execute or return $seq_sth->errstr;
562 my $insertid = $seq_sth->fetchrow_arrayref->[0];
564 # don't drink soap! recurse! recurse! okay!
566 _copy_skel( $child_table_def,
567 $row->{$child_pkey}, #sourceid
569 %{ $child_tables{$child_table_def} },
571 return $error if $error;
581 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
583 Like the insert method on an existing record, this method orders a package
584 and included services atomicaly. Pass a Tie::RefHash data structure to this
585 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
586 be a better explanation of this, but until then, here's an example:
589 tie %hash, 'Tie::RefHash'; #this part is important
591 $cust_pkg => [ $svc_acct ],
594 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
596 Services can be new, in which case they are inserted, or existing unaudited
597 services, in which case they are linked to the newly-created package.
599 Currently available options are: I<depend_jobnum> and I<noexport>.
601 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
602 on the supplied jobnum (they will not run until the specific job completes).
603 This can be used to defer provisioning until some action completes (such
604 as running the customer's credit card successfully).
606 The I<noexport> option is deprecated. If I<noexport> is set true, no
607 provisioning jobs (exports) are scheduled. (You can schedule them later with
608 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
609 on the cust_main object is not recommended, as existing services will also be
616 my $cust_pkgs = shift;
619 my %svc_options = ();
620 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
621 if exists $options{'depend_jobnum'};
622 warn "$me order_pkgs called with options ".
623 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
626 local $SIG{HUP} = 'IGNORE';
627 local $SIG{INT} = 'IGNORE';
628 local $SIG{QUIT} = 'IGNORE';
629 local $SIG{TERM} = 'IGNORE';
630 local $SIG{TSTP} = 'IGNORE';
631 local $SIG{PIPE} = 'IGNORE';
633 my $oldAutoCommit = $FS::UID::AutoCommit;
634 local $FS::UID::AutoCommit = 0;
637 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
639 foreach my $cust_pkg ( keys %$cust_pkgs ) {
640 $cust_pkg->custnum( $self->custnum );
641 my $error = $cust_pkg->insert;
643 $dbh->rollback if $oldAutoCommit;
644 return "inserting cust_pkg (transaction rolled back): $error";
646 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
647 if ( $svc_something->svcnum ) {
648 my $old_cust_svc = $svc_something->cust_svc;
649 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
650 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
651 $error = $new_cust_svc->replace($old_cust_svc);
653 $svc_something->pkgnum( $cust_pkg->pkgnum );
654 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
655 $svc_something->seconds( $svc_something->seconds + $$seconds );
658 $error = $svc_something->insert(%svc_options);
661 $dbh->rollback if $oldAutoCommit;
662 #return "inserting svc_ (transaction rolled back): $error";
668 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
672 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
674 Recharges this (existing) customer with the specified prepaid card (see
675 L<FS::prepay_credit>), specified either by I<identifier> or as an
676 FS::prepay_credit object. If there is an error, returns the error, otherwise
679 Optionally, four scalar references can be passed as well. They will have their
680 values filled in with the amount, number of seconds, and number of upload and
681 download bytes applied by this prepaid
686 sub recharge_prepay {
687 my( $self, $prepay_credit, $amountref, $secondsref,
688 $upbytesref, $downbytesref, $totalbytesref ) = @_;
690 local $SIG{HUP} = 'IGNORE';
691 local $SIG{INT} = 'IGNORE';
692 local $SIG{QUIT} = 'IGNORE';
693 local $SIG{TERM} = 'IGNORE';
694 local $SIG{TSTP} = 'IGNORE';
695 local $SIG{PIPE} = 'IGNORE';
697 my $oldAutoCommit = $FS::UID::AutoCommit;
698 local $FS::UID::AutoCommit = 0;
701 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
703 my $error = $self->get_prepay($prepay_credit, \$amount,
704 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
705 || $self->increment_seconds($seconds)
706 || $self->increment_upbytes($upbytes)
707 || $self->increment_downbytes($downbytes)
708 || $self->increment_totalbytes($totalbytes)
709 || $self->insert_cust_pay_prepay( $amount,
711 ? $prepay_credit->identifier
716 $dbh->rollback if $oldAutoCommit;
720 if ( defined($amountref) ) { $$amountref = $amount; }
721 if ( defined($secondsref) ) { $$secondsref = $seconds; }
722 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
723 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
724 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
726 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
731 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
733 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
734 specified either by I<identifier> or as an FS::prepay_credit object.
736 References to I<amount> and I<seconds> scalars should be passed as arguments
737 and will be incremented by the values of the prepaid card.
739 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
740 check or set this customer's I<agentnum>.
742 If there is an error, returns the error, otherwise returns false.
748 my( $self, $prepay_credit, $amountref, $secondsref,
749 $upref, $downref, $totalref) = @_;
751 local $SIG{HUP} = 'IGNORE';
752 local $SIG{INT} = 'IGNORE';
753 local $SIG{QUIT} = 'IGNORE';
754 local $SIG{TERM} = 'IGNORE';
755 local $SIG{TSTP} = 'IGNORE';
756 local $SIG{PIPE} = 'IGNORE';
758 my $oldAutoCommit = $FS::UID::AutoCommit;
759 local $FS::UID::AutoCommit = 0;
762 unless ( ref($prepay_credit) ) {
764 my $identifier = $prepay_credit;
766 $prepay_credit = qsearchs(
768 { 'identifier' => $prepay_credit },
773 unless ( $prepay_credit ) {
774 $dbh->rollback if $oldAutoCommit;
775 return "Invalid prepaid card: ". $identifier;
780 if ( $prepay_credit->agentnum ) {
781 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
782 $dbh->rollback if $oldAutoCommit;
783 return "prepaid card not valid for agent ". $self->agentnum;
785 $self->agentnum($prepay_credit->agentnum);
788 my $error = $prepay_credit->delete;
790 $dbh->rollback if $oldAutoCommit;
791 return "removing prepay_credit (transaction rolled back): $error";
794 $$amountref += $prepay_credit->amount;
795 $$secondsref += $prepay_credit->seconds;
796 $$upref += $prepay_credit->upbytes;
797 $$downref += $prepay_credit->downbytes;
798 $$totalref += $prepay_credit->totalbytes;
800 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
805 =item increment_upbytes SECONDS
807 Updates this customer's single or primary account (see L<FS::svc_acct>) by
808 the specified number of upbytes. If there is an error, returns the error,
809 otherwise returns false.
813 sub increment_upbytes {
814 _increment_column( shift, 'upbytes', @_);
817 =item increment_downbytes SECONDS
819 Updates this customer's single or primary account (see L<FS::svc_acct>) by
820 the specified number of downbytes. If there is an error, returns the error,
821 otherwise returns false.
825 sub increment_downbytes {
826 _increment_column( shift, 'downbytes', @_);
829 =item increment_totalbytes SECONDS
831 Updates this customer's single or primary account (see L<FS::svc_acct>) by
832 the specified number of totalbytes. If there is an error, returns the error,
833 otherwise returns false.
837 sub increment_totalbytes {
838 _increment_column( shift, 'totalbytes', @_);
841 =item increment_seconds SECONDS
843 Updates this customer's single or primary account (see L<FS::svc_acct>) by
844 the specified number of seconds. If there is an error, returns the error,
845 otherwise returns false.
849 sub increment_seconds {
850 _increment_column( shift, 'seconds', @_);
853 =item _increment_column AMOUNT
855 Updates this customer's single or primary account (see L<FS::svc_acct>) by
856 the specified number of seconds or bytes. If there is an error, returns
857 the error, otherwise returns false.
861 sub _increment_column {
862 my( $self, $column, $amount ) = @_;
863 warn "$me increment_column called: $column, $amount\n"
866 return '' unless $amount;
868 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
869 $self->ncancelled_pkgs;
872 return 'No packages with primary or single services found'.
873 ' to apply pre-paid time';
874 } elsif ( scalar(@cust_pkg) > 1 ) {
875 #maybe have a way to specify the package/account?
876 return 'Multiple packages found to apply pre-paid time';
879 my $cust_pkg = $cust_pkg[0];
880 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
884 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
887 return 'No account found to apply pre-paid time';
888 } elsif ( scalar(@cust_svc) > 1 ) {
889 return 'Multiple accounts found to apply pre-paid time';
892 my $svc_acct = $cust_svc[0]->svc_x;
893 warn " found service svcnum ". $svc_acct->pkgnum.
894 ' ('. $svc_acct->email. ")\n"
897 $column = "increment_$column";
898 $svc_acct->$column($amount);
902 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
904 Inserts a prepayment in the specified amount for this customer. An optional
905 second argument can specify the prepayment identifier for tracking purposes.
906 If there is an error, returns the error, otherwise returns false.
910 sub insert_cust_pay_prepay {
911 shift->insert_cust_pay('PREP', @_);
914 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
916 Inserts a cash payment in the specified amount for this customer. An optional
917 second argument can specify the payment identifier for tracking purposes.
918 If there is an error, returns the error, otherwise returns false.
922 sub insert_cust_pay_cash {
923 shift->insert_cust_pay('CASH', @_);
926 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
928 Inserts a Western Union payment in the specified amount for this customer. An
929 optional second argument can specify the prepayment identifier for tracking
930 purposes. If there is an error, returns the error, otherwise returns false.
934 sub insert_cust_pay_west {
935 shift->insert_cust_pay('WEST', @_);
938 sub insert_cust_pay {
939 my( $self, $payby, $amount ) = splice(@_, 0, 3);
940 my $payinfo = scalar(@_) ? shift : '';
942 my $cust_pay = new FS::cust_pay {
943 'custnum' => $self->custnum,
944 'paid' => sprintf('%.2f', $amount),
945 #'_date' => #date the prepaid card was purchased???
947 'payinfo' => $payinfo,
955 This method is deprecated. See the I<depend_jobnum> option to the insert and
956 order_pkgs methods for a better way to defer provisioning.
958 Re-schedules all exports by calling the B<reexport> method of all associated
959 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
960 otherwise returns false.
967 carp "WARNING: FS::cust_main::reexport is deprectated; ".
968 "use the depend_jobnum option to insert or order_pkgs to delay export";
970 local $SIG{HUP} = 'IGNORE';
971 local $SIG{INT} = 'IGNORE';
972 local $SIG{QUIT} = 'IGNORE';
973 local $SIG{TERM} = 'IGNORE';
974 local $SIG{TSTP} = 'IGNORE';
975 local $SIG{PIPE} = 'IGNORE';
977 my $oldAutoCommit = $FS::UID::AutoCommit;
978 local $FS::UID::AutoCommit = 0;
981 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
982 my $error = $cust_pkg->reexport;
984 $dbh->rollback if $oldAutoCommit;
989 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
994 =item delete NEW_CUSTNUM
996 This deletes the customer. If there is an error, returns the error, otherwise
999 This will completely remove all traces of the customer record. This is not
1000 what you want when a customer cancels service; for that, cancel all of the
1001 customer's packages (see L</cancel>).
1003 If the customer has any uncancelled packages, you need to pass a new (valid)
1004 customer number for those packages to be transferred to. Cancelled packages
1005 will be deleted. Did I mention that this is NOT what you want when a customer
1006 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1008 You can't delete a customer with invoices (see L<FS::cust_bill>),
1009 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1010 refunds (see L<FS::cust_refund>).
1017 local $SIG{HUP} = 'IGNORE';
1018 local $SIG{INT} = 'IGNORE';
1019 local $SIG{QUIT} = 'IGNORE';
1020 local $SIG{TERM} = 'IGNORE';
1021 local $SIG{TSTP} = 'IGNORE';
1022 local $SIG{PIPE} = 'IGNORE';
1024 my $oldAutoCommit = $FS::UID::AutoCommit;
1025 local $FS::UID::AutoCommit = 0;
1028 if ( $self->cust_bill ) {
1029 $dbh->rollback if $oldAutoCommit;
1030 return "Can't delete a customer with invoices";
1032 if ( $self->cust_credit ) {
1033 $dbh->rollback if $oldAutoCommit;
1034 return "Can't delete a customer with credits";
1036 if ( $self->cust_pay ) {
1037 $dbh->rollback if $oldAutoCommit;
1038 return "Can't delete a customer with payments";
1040 if ( $self->cust_refund ) {
1041 $dbh->rollback if $oldAutoCommit;
1042 return "Can't delete a customer with refunds";
1045 my @cust_pkg = $self->ncancelled_pkgs;
1047 my $new_custnum = shift;
1048 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1049 $dbh->rollback if $oldAutoCommit;
1050 return "Invalid new customer number: $new_custnum";
1052 foreach my $cust_pkg ( @cust_pkg ) {
1053 my %hash = $cust_pkg->hash;
1054 $hash{'custnum'} = $new_custnum;
1055 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1056 my $error = $new_cust_pkg->replace($cust_pkg,
1057 options => { $cust_pkg->options },
1060 $dbh->rollback if $oldAutoCommit;
1065 my @cancelled_cust_pkg = $self->all_pkgs;
1066 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1067 my $error = $cust_pkg->delete;
1069 $dbh->rollback if $oldAutoCommit;
1074 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1075 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1077 my $error = $cust_main_invoice->delete;
1079 $dbh->rollback if $oldAutoCommit;
1084 my $error = $self->SUPER::delete;
1086 $dbh->rollback if $oldAutoCommit;
1090 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1095 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1097 Replaces the OLD_RECORD with this one in the database. If there is an error,
1098 returns the error, otherwise returns false.
1100 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1101 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1102 expected and rollback the entire transaction; it is not necessary to call
1103 check_invoicing_list first. Here's an example:
1105 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1112 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1114 : $self->replace_old;
1118 warn "$me replace called\n"
1121 my $curuser = $FS::CurrentUser::CurrentUser;
1122 if ( $self->payby eq 'COMP'
1123 && $self->payby ne $old->payby
1124 && ! $curuser->access_right('Complimentary customer')
1127 return "You are not permitted to create complimentary accounts.";
1130 local($ignore_expired_card) = 1
1131 if $old->payby =~ /^(CARD|DCRD)$/
1132 && $self->payby =~ /^(CARD|DCRD)$/
1133 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1135 local $SIG{HUP} = 'IGNORE';
1136 local $SIG{INT} = 'IGNORE';
1137 local $SIG{QUIT} = 'IGNORE';
1138 local $SIG{TERM} = 'IGNORE';
1139 local $SIG{TSTP} = 'IGNORE';
1140 local $SIG{PIPE} = 'IGNORE';
1142 my $oldAutoCommit = $FS::UID::AutoCommit;
1143 local $FS::UID::AutoCommit = 0;
1146 my $error = $self->SUPER::replace($old);
1149 $dbh->rollback if $oldAutoCommit;
1153 if ( @param ) { # INVOICING_LIST_ARYREF
1154 my $invoicing_list = shift @param;
1155 $error = $self->check_invoicing_list( $invoicing_list );
1157 $dbh->rollback if $oldAutoCommit;
1160 $self->invoicing_list( $invoicing_list );
1163 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1164 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1165 # card/check/lec info has changed, want to retry realtime_ invoice events
1166 my $error = $self->retry_realtime;
1168 $dbh->rollback if $oldAutoCommit;
1173 unless ( $import || $skip_fuzzyfiles ) {
1174 $error = $self->queue_fuzzyfiles_update;
1176 $dbh->rollback if $oldAutoCommit;
1177 return "updating fuzzy search cache: $error";
1181 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1186 =item queue_fuzzyfiles_update
1188 Used by insert & replace to update the fuzzy search cache
1192 sub queue_fuzzyfiles_update {
1195 local $SIG{HUP} = 'IGNORE';
1196 local $SIG{INT} = 'IGNORE';
1197 local $SIG{QUIT} = 'IGNORE';
1198 local $SIG{TERM} = 'IGNORE';
1199 local $SIG{TSTP} = 'IGNORE';
1200 local $SIG{PIPE} = 'IGNORE';
1202 my $oldAutoCommit = $FS::UID::AutoCommit;
1203 local $FS::UID::AutoCommit = 0;
1206 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1207 my $error = $queue->insert( map $self->getfield($_),
1208 qw(first last company)
1211 $dbh->rollback if $oldAutoCommit;
1212 return "queueing job (transaction rolled back): $error";
1215 if ( $self->ship_last ) {
1216 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1217 $error = $queue->insert( map $self->getfield("ship_$_"),
1218 qw(first last company)
1221 $dbh->rollback if $oldAutoCommit;
1222 return "queueing job (transaction rolled back): $error";
1226 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1233 Checks all fields to make sure this is a valid customer record. If there is
1234 an error, returns the error, otherwise returns false. Called by the insert
1235 and replace methods.
1242 warn "$me check BEFORE: \n". $self->_dump
1246 $self->ut_numbern('custnum')
1247 || $self->ut_number('agentnum')
1248 || $self->ut_textn('agent_custid')
1249 || $self->ut_number('refnum')
1250 || $self->ut_textn('custbatch')
1251 || $self->ut_name('last')
1252 || $self->ut_name('first')
1253 || $self->ut_snumbern('birthdate')
1254 || $self->ut_snumbern('signupdate')
1255 || $self->ut_textn('company')
1256 || $self->ut_text('address1')
1257 || $self->ut_textn('address2')
1258 || $self->ut_text('city')
1259 || $self->ut_textn('county')
1260 || $self->ut_textn('state')
1261 || $self->ut_country('country')
1262 || $self->ut_anything('comments')
1263 || $self->ut_numbern('referral_custnum')
1264 || $self->ut_textn('stateid')
1265 || $self->ut_textn('stateid_state')
1266 || $self->ut_textn('invoice_terms')
1269 #barf. need message catalogs. i18n. etc.
1270 $error .= "Please select an advertising source."
1271 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1272 return $error if $error;
1274 return "Unknown agent"
1275 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1277 return "Unknown refnum"
1278 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1280 return "Unknown referring custnum: ". $self->referral_custnum
1281 unless ! $self->referral_custnum
1282 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1284 if ( $self->ss eq '' ) {
1289 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1290 or return "Illegal social security number: ". $self->ss;
1291 $self->ss("$1-$2-$3");
1295 # bad idea to disable, causes billing to fail because of no tax rates later
1296 # unless ( $import ) {
1297 unless ( qsearch('cust_main_county', {
1298 'country' => $self->country,
1301 return "Unknown state/county/country: ".
1302 $self->state. "/". $self->county. "/". $self->country
1303 unless qsearch('cust_main_county',{
1304 'state' => $self->state,
1305 'county' => $self->county,
1306 'country' => $self->country,
1312 $self->ut_phonen('daytime', $self->country)
1313 || $self->ut_phonen('night', $self->country)
1314 || $self->ut_phonen('fax', $self->country)
1315 || $self->ut_zip('zip', $self->country)
1317 return $error if $error;
1319 if ( $conf->exists('cust_main-require_phone')
1320 && ! length($self->daytime) && ! length($self->night)
1323 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1325 : FS::Msgcat::_gettext('daytime');
1326 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1328 : FS::Msgcat::_gettext('night');
1330 return "$daytime_label or $night_label is required"
1334 if ( $self->has_ship_address
1335 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1336 $self->addr_fields )
1340 $self->ut_name('ship_last')
1341 || $self->ut_name('ship_first')
1342 || $self->ut_textn('ship_company')
1343 || $self->ut_text('ship_address1')
1344 || $self->ut_textn('ship_address2')
1345 || $self->ut_text('ship_city')
1346 || $self->ut_textn('ship_county')
1347 || $self->ut_textn('ship_state')
1348 || $self->ut_country('ship_country')
1350 return $error if $error;
1352 #false laziness with above
1353 unless ( qsearchs('cust_main_county', {
1354 'country' => $self->ship_country,
1357 return "Unknown ship_state/ship_county/ship_country: ".
1358 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1359 unless qsearch('cust_main_county',{
1360 'state' => $self->ship_state,
1361 'county' => $self->ship_county,
1362 'country' => $self->ship_country,
1368 $self->ut_phonen('ship_daytime', $self->ship_country)
1369 || $self->ut_phonen('ship_night', $self->ship_country)
1370 || $self->ut_phonen('ship_fax', $self->ship_country)
1371 || $self->ut_zip('ship_zip', $self->ship_country)
1373 return $error if $error;
1375 return "Unit # is required."
1376 if $self->ship_address2 =~ /^\s*$/
1377 && $conf->exists('cust_main-require_address2');
1379 } else { # ship_ info eq billing info, so don't store dup info in database
1381 $self->setfield("ship_$_", '')
1382 foreach $self->addr_fields;
1384 return "Unit # is required."
1385 if $self->address2 =~ /^\s*$/
1386 && $conf->exists('cust_main-require_address2');
1390 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1391 # or return "Illegal payby: ". $self->payby;
1393 FS::payby->can_payby($self->table, $self->payby)
1394 or return "Illegal payby: ". $self->payby;
1396 $error = $self->ut_numbern('paystart_month')
1397 || $self->ut_numbern('paystart_year')
1398 || $self->ut_numbern('payissue')
1399 || $self->ut_textn('paytype')
1401 return $error if $error;
1403 if ( $self->payip eq '' ) {
1406 $error = $self->ut_ip('payip');
1407 return $error if $error;
1410 # If it is encrypted and the private key is not availaible then we can't
1411 # check the credit card.
1413 my $check_payinfo = 1;
1415 if ($self->is_encrypted($self->payinfo)) {
1419 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1421 my $payinfo = $self->payinfo;
1422 $payinfo =~ s/\D//g;
1423 $payinfo =~ /^(\d{13,16})$/
1424 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1426 $self->payinfo($payinfo);
1428 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1430 return gettext('unknown_card_type')
1431 if cardtype($self->payinfo) eq "Unknown";
1433 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1435 return 'Banned credit card: banned on '.
1436 time2str('%a %h %o at %r', $ban->_date).
1437 ' by '. $ban->otaker.
1438 ' (ban# '. $ban->bannum. ')';
1441 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1442 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1443 $self->paycvv =~ /^(\d{4})$/
1444 or return "CVV2 (CID) for American Express cards is four digits.";
1447 $self->paycvv =~ /^(\d{3})$/
1448 or return "CVV2 (CVC2/CID) is three digits.";
1455 my $cardtype = cardtype($payinfo);
1456 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1458 return "Start date or issue number is required for $cardtype cards"
1459 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1461 return "Start month must be between 1 and 12"
1462 if $self->paystart_month
1463 and $self->paystart_month < 1 || $self->paystart_month > 12;
1465 return "Start year must be 1990 or later"
1466 if $self->paystart_year
1467 and $self->paystart_year < 1990;
1469 return "Issue number must be beween 1 and 99"
1471 and $self->payissue < 1 || $self->payissue > 99;
1474 $self->paystart_month('');
1475 $self->paystart_year('');
1476 $self->payissue('');
1479 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1481 my $payinfo = $self->payinfo;
1482 $payinfo =~ s/[^\d\@]//g;
1483 if ( $conf->exists('echeck-nonus') ) {
1484 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1485 $payinfo = "$1\@$2";
1487 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1488 $payinfo = "$1\@$2";
1490 $self->payinfo($payinfo);
1493 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1495 return 'Banned ACH account: banned on '.
1496 time2str('%a %h %o at %r', $ban->_date).
1497 ' by '. $ban->otaker.
1498 ' (ban# '. $ban->bannum. ')';
1501 } elsif ( $self->payby eq 'LECB' ) {
1503 my $payinfo = $self->payinfo;
1504 $payinfo =~ s/\D//g;
1505 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1507 $self->payinfo($payinfo);
1510 } elsif ( $self->payby eq 'BILL' ) {
1512 $error = $self->ut_textn('payinfo');
1513 return "Illegal P.O. number: ". $self->payinfo if $error;
1516 } elsif ( $self->payby eq 'COMP' ) {
1518 my $curuser = $FS::CurrentUser::CurrentUser;
1519 if ( ! $self->custnum
1520 && ! $curuser->access_right('Complimentary customer')
1523 return "You are not permitted to create complimentary accounts."
1526 $error = $self->ut_textn('payinfo');
1527 return "Illegal comp account issuer: ". $self->payinfo if $error;
1530 } elsif ( $self->payby eq 'PREPAY' ) {
1532 my $payinfo = $self->payinfo;
1533 $payinfo =~ s/\W//g; #anything else would just confuse things
1534 $self->payinfo($payinfo);
1535 $error = $self->ut_alpha('payinfo');
1536 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1537 return "Unknown prepayment identifier"
1538 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1543 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1544 return "Expiration date required"
1545 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1549 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1550 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1551 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1552 ( $m, $y ) = ( $3, "20$2" );
1554 return "Illegal expiration date: ". $self->paydate;
1556 $self->paydate("$y-$m-01");
1557 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1558 return gettext('expired_card')
1560 && !$ignore_expired_card
1561 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1564 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1565 ( ! $conf->exists('require_cardname')
1566 || $self->payby !~ /^(CARD|DCRD)$/ )
1568 $self->payname( $self->first. " ". $self->getfield('last') );
1570 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1571 or return gettext('illegal_name'). " payname: ". $self->payname;
1575 foreach my $flag (qw( tax spool_cdr squelch_cdr )) {
1576 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1580 $self->otaker(getotaker) unless $self->otaker;
1582 warn "$me check AFTER: \n". $self->_dump
1585 $self->SUPER::check;
1590 Returns a list of fields which have ship_ duplicates.
1595 qw( last first company
1596 address1 address2 city county state zip country
1601 =item has_ship_address
1603 Returns true if this customer record has a separate shipping address.
1607 sub has_ship_address {
1609 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1614 Returns all packages (see L<FS::cust_pkg>) for this customer.
1621 return $self->num_pkgs unless wantarray;
1624 if ( $self->{'_pkgnum'} ) {
1625 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1627 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1630 sort sort_packages @cust_pkg;
1635 Synonym for B<all_pkgs>.
1640 shift->all_pkgs(@_);
1643 =item ncancelled_pkgs
1645 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1649 sub ncancelled_pkgs {
1652 return $self->num_ncancelled_pkgs unless wantarray;
1655 if ( $self->{'_pkgnum'} ) {
1657 warn "$me ncancelled_pkgs: returning cached objects"
1660 @cust_pkg = grep { ! $_->getfield('cancel') }
1661 values %{ $self->{'_pkgnum'}->cache };
1665 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1666 $self->custnum. "\n"
1670 qsearch( 'cust_pkg', {
1671 'custnum' => $self->custnum,
1675 qsearch( 'cust_pkg', {
1676 'custnum' => $self->custnum,
1681 sort sort_packages @cust_pkg;
1685 # This should be generalized to use config options to determine order.
1687 if ( $a->get('cancel') and $b->get('cancel') ) {
1688 $a->pkgnum <=> $b->pkgnum;
1689 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1690 return -1 if $b->get('cancel');
1691 return 1 if $a->get('cancel');
1694 $a->pkgnum <=> $b->pkgnum;
1698 =item suspended_pkgs
1700 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1704 sub suspended_pkgs {
1706 grep { $_->susp } $self->ncancelled_pkgs;
1709 =item unflagged_suspended_pkgs
1711 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1712 customer (thouse packages without the `manual_flag' set).
1716 sub unflagged_suspended_pkgs {
1718 return $self->suspended_pkgs
1719 unless dbdef->table('cust_pkg')->column('manual_flag');
1720 grep { ! $_->manual_flag } $self->suspended_pkgs;
1723 =item unsuspended_pkgs
1725 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1730 sub unsuspended_pkgs {
1732 grep { ! $_->susp } $self->ncancelled_pkgs;
1735 =item num_cancelled_pkgs
1737 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1742 sub num_cancelled_pkgs {
1743 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1746 sub num_ncancelled_pkgs {
1747 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1751 my( $self ) = shift;
1752 my $sql = scalar(@_) ? shift : '';
1753 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1754 my $sth = dbh->prepare(
1755 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1756 ) or die dbh->errstr;
1757 $sth->execute($self->custnum) or die $sth->errstr;
1758 $sth->fetchrow_arrayref->[0];
1763 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1764 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1765 on success or a list of errors.
1771 grep { $_->unsuspend } $self->suspended_pkgs;
1776 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1778 Returns a list: an empty list on success or a list of errors.
1784 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1787 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1789 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1790 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1791 of a list of pkgparts; the hashref has the following keys:
1795 =item pkgparts - listref of pkgparts
1797 =item (other options are passed to the suspend method)
1802 Returns a list: an empty list on success or a list of errors.
1806 sub suspend_if_pkgpart {
1808 my (@pkgparts, %opt);
1809 if (ref($_[0]) eq 'HASH'){
1810 @pkgparts = @{$_[0]{pkgparts}};
1815 grep { $_->suspend(%opt) }
1816 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1817 $self->unsuspended_pkgs;
1820 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1822 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1823 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1824 instead of a list of pkgparts; the hashref has the following keys:
1828 =item pkgparts - listref of pkgparts
1830 =item (other options are passed to the suspend method)
1834 Returns a list: an empty list on success or a list of errors.
1838 sub suspend_unless_pkgpart {
1840 my (@pkgparts, %opt);
1841 if (ref($_[0]) eq 'HASH'){
1842 @pkgparts = @{$_[0]{pkgparts}};
1847 grep { $_->suspend(%opt) }
1848 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1849 $self->unsuspended_pkgs;
1852 =item cancel [ OPTION => VALUE ... ]
1854 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1856 Available options are:
1860 =item quiet - can be set true to supress email cancellation notices.
1862 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
1864 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1868 Always returns a list: an empty list on success or a list of errors.
1873 my( $self, %opt ) = @_;
1875 warn "$me cancel called on customer ". $self->custnum. " with options ".
1876 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1879 return ( 'access denied' )
1880 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1882 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1884 #should try decryption (we might have the private key)
1885 # and if not maybe queue a job for the server that does?
1886 return ( "Can't (yet) ban encrypted credit cards" )
1887 if $self->is_encrypted($self->payinfo);
1889 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1890 my $error = $ban->insert;
1891 return ( $error ) if $error;
1895 my @pkgs = $self->ncancelled_pkgs;
1897 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1898 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1901 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1904 sub _banned_pay_hashref {
1915 'payby' => $payby2ban{$self->payby},
1916 'payinfo' => md5_base64($self->payinfo),
1917 #don't ever *search* on reason! #'reason' =>
1923 Returns all notes (see L<FS::cust_main_note>) for this customer.
1930 qsearch( 'cust_main_note',
1931 { 'custnum' => $self->custnum },
1933 'ORDER BY _DATE DESC'
1939 Returns the agent (see L<FS::agent>) for this customer.
1945 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1948 =item bill_and_collect
1950 Cancels and suspends any packages due, generates bills, applies payments and
1953 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1955 Options are passed as name-value pairs. Currently available options are:
1961 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
1965 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1969 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
1973 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1977 If set true, re-charges setup fees.
1981 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1987 sub bill_and_collect {
1988 my( $self, %options ) = @_;
1994 #$options{actual_time} not $options{time} because freeside-daily -d is for
1995 #pre-printing invoices
1996 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
1997 $self->ncancelled_pkgs;
1999 foreach my $cust_pkg ( @cancel_pkgs ) {
2000 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2001 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2002 'reason_otaker' => $cpr->otaker
2006 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2007 " for custnum ". $self->custnum. ": $error"
2015 #$options{actual_time} not $options{time} because freeside-daily -d is for
2016 #pre-printing invoices
2019 && ( ( $_->part_pkg->is_prepaid
2021 && $_->bill < $options{actual_time}
2024 && $_->adjourn <= $options{actual_time}
2028 $self->ncancelled_pkgs;
2030 foreach my $cust_pkg ( @susp_pkgs ) {
2031 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2032 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2033 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2034 'reason_otaker' => $cpr->otaker
2039 warn "Error suspending package ". $cust_pkg->pkgnum.
2040 " for custnum ". $self->custnum. ": $error"
2048 my $error = $self->bill( %options );
2049 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2051 $self->apply_payments_and_credits;
2053 $error = $self->collect( %options );
2054 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2060 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2061 conjunction with the collect method by calling B<bill_and_collect>.
2063 If there is an error, returns the error, otherwise returns false.
2065 Options are passed as name-value pairs. Currently available options are:
2071 If set true, re-charges setup fees.
2075 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2079 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2083 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2085 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2089 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2096 my( $self, %options ) = @_;
2097 return '' if $self->payby eq 'COMP';
2098 warn "$me bill customer ". $self->custnum. "\n"
2101 my $time = $options{'time'} || time;
2104 local $SIG{HUP} = 'IGNORE';
2105 local $SIG{INT} = 'IGNORE';
2106 local $SIG{QUIT} = 'IGNORE';
2107 local $SIG{TERM} = 'IGNORE';
2108 local $SIG{TSTP} = 'IGNORE';
2109 local $SIG{PIPE} = 'IGNORE';
2111 my $oldAutoCommit = $FS::UID::AutoCommit;
2112 local $FS::UID::AutoCommit = 0;
2115 $self->select_for_update; #mutex
2117 my @cust_bill_pkg = ();
2120 # find the packages which are due for billing, find out how much they are
2121 # & generate invoice database.
2124 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2128 my @precommit_hooks = ();
2130 my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2131 foreach my $cust_pkg (@cust_pkgs) {
2133 #NO!! next if $cust_pkg->cancel;
2134 next if $cust_pkg->getfield('cancel');
2136 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2138 #? to avoid use of uninitialized value errors... ?
2139 $cust_pkg->setfield('bill', '')
2140 unless defined($cust_pkg->bill);
2142 #my $part_pkg = $cust_pkg->part_pkg;
2144 my $real_pkgpart = $cust_pkg->pkgpart;
2145 my %hash = $cust_pkg->hash;
2147 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2149 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2152 $self->_make_lines( 'part_pkg' => $part_pkg,
2153 'cust_pkg' => $cust_pkg,
2154 'precommit_hooks' => \@precommit_hooks,
2155 'line_items' => \@cust_bill_pkg,
2156 'setup' => \$total_setup,
2157 'recur' => \$total_recur,
2158 'tax_matrix' => \%taxlisthash,
2160 'options' => \%options,
2163 $dbh->rollback if $oldAutoCommit;
2167 } #foreach my $part_pkg
2169 } #foreach my $cust_pkg
2171 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2172 #but do commit any package date cycling that happened
2173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2177 my $postal_pkg = $self->charge_postal_fee();
2178 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2179 $dbh->rollback if $oldAutoCommit;
2180 return "can't charge postal invoice fee for customer ".
2181 $self->custnum. ": $postal_pkg";
2184 ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2185 !$conf->exists('postal_invoice-recurring_only')
2189 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2191 $self->_make_lines( 'part_pkg' => $part_pkg,
2192 'cust_pkg' => $postal_pkg,
2193 'precommit_hooks' => \@precommit_hooks,
2194 'line_items' => \@cust_bill_pkg,
2195 'setup' => \$total_setup,
2196 'recur' => \$total_recur,
2197 'tax_matrix' => \%taxlisthash,
2199 'options' => \%options,
2202 $dbh->rollback if $oldAutoCommit;
2208 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2209 foreach my $tax ( keys %taxlisthash ) {
2210 my $tax_object = shift @{ $taxlisthash{$tax} };
2211 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2212 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2213 unless (ref($listref_or_error)) {
2214 $dbh->rollback if $oldAutoCommit;
2215 return $listref_or_error;
2217 unshift @{ $taxlisthash{$tax} }, $tax_object;
2219 warn "adding ". $listref_or_error->[1].
2220 " as ". $listref_or_error->[0]. "\n"
2222 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2223 if ( $taxname{ $listref_or_error->[0] } ) {
2224 push @{ $taxname{ $listref_or_error->[0] } }, $tax_object->taxname;
2226 $taxname{ $listref_or_error->[0] } = [ $tax_object->taxname ];
2231 #some taxes are taxed
2234 warn "finding taxed taxes...\n" if $DEBUG > 2;
2235 foreach my $tax ( keys %taxlisthash ) {
2236 my $tax_object = shift @{ $taxlisthash{$tax} };
2237 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2239 next unless $tax_object->can('tax_on_tax');
2241 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2242 my $totname = ref( $tot ). ' '. $tot->taxnum;
2244 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2246 next unless exists( $taxlisthash{ $totname } ); # only increase
2248 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2249 if ( exists( $totlisthash{ $totname } ) ) {
2250 push @{ $totlisthash{ $totname } }, $tax{ $tax_object->taxname };
2252 $totlisthash{ $totname } = [ $tot, $tax{ $tax_object->taxname } ];
2257 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2258 foreach my $tax ( keys %totlisthash ) {
2259 my $tax_object = shift @{ $totlisthash{$tax} };
2260 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2262 my $listref_or_error = $tax_object->taxline( @{ $totlisthash{$tax} } );
2263 unless (ref($listref_or_error)) {
2264 $dbh->rollback if $oldAutoCommit;
2265 return $listref_or_error;
2268 warn "adding taxed tax amount ". $listref_or_error->[1].
2269 " as ". $tax_object->taxname. "\n"
2271 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2274 #consolidate and create tax line items
2275 warn "consolidating and generating...\n" if $DEBUG > 2;
2276 foreach my $taxname ( keys %taxname ) {
2279 warn "adding $taxname\n" if $DEBUG > 1;
2280 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2281 $tax += $tax{$taxitem} unless $seen{$taxitem};
2282 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2286 $tax = sprintf('%.2f', $tax );
2287 $total_setup = sprintf('%.2f', $total_setup+$tax );
2289 push @cust_bill_pkg, new FS::cust_bill_pkg {
2295 'itemdesc' => $taxname,
2300 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2302 #create the new invoice
2303 my $cust_bill = new FS::cust_bill ( {
2304 'custnum' => $self->custnum,
2305 '_date' => ( $options{'invoice_time'} || $time ),
2306 'charged' => $charged,
2308 my $error = $cust_bill->insert;
2310 $dbh->rollback if $oldAutoCommit;
2311 return "can't create invoice for customer #". $self->custnum. ": $error";
2314 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2315 $cust_bill_pkg->invnum($cust_bill->invnum);
2316 my $error = $cust_bill_pkg->insert;
2318 $dbh->rollback if $oldAutoCommit;
2319 return "can't create invoice line item: $error";
2324 foreach my $hook ( @precommit_hooks ) {
2326 &{$hook}; #($self) ?
2329 $dbh->rollback if $oldAutoCommit;
2330 return "$@ running precommit hook $hook\n";
2334 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2340 my ($self, %params) = @_;
2342 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2343 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2344 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2345 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2346 my $total_setup = $params{setup} or die "no setup accumulator specified";
2347 my $total_recur = $params{recur} or die "no recur accumulator specified";
2348 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2349 my $time = $params{'time'} or die "no time specified";
2350 my (%options) = %{$params{options}}; #hmmm only for 'resetup'
2353 my $real_pkgpart = $cust_pkg->pkgpart;
2354 my %hash = $cust_pkg->hash;
2355 my $old_cust_pkg = new FS::cust_pkg \%hash;
2361 $cust_pkg->pkgpart($part_pkg->pkgpart);
2369 if ( ! $cust_pkg->setup &&
2371 ( $conf->exists('disable_setup_suspended_pkgs') &&
2372 ! $cust_pkg->getfield('susp')
2373 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2375 || $options{'resetup'}
2378 warn " bill setup\n" if $DEBUG > 1;
2381 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2382 return "$@ running calc_setup for $cust_pkg\n"
2385 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2387 $cust_pkg->setfield('setup', $time)
2388 unless $cust_pkg->setup;
2389 #do need it, but it won't get written to the db
2390 #|| $cust_pkg->pkgpart != $real_pkgpart;
2395 # bill recurring fee
2398 #XXX unit stuff here too
2402 if ( $part_pkg->getfield('freq') ne '0' &&
2403 ! $cust_pkg->getfield('susp') &&
2404 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2407 # XXX should this be a package event? probably. events are called
2408 # at collection time at the moment, though...
2409 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2410 if $part_pkg->can('reset_usage');
2411 #don't want to reset usage just cause we want a line item??
2412 #&& $part_pkg->pkgpart == $real_pkgpart;
2414 warn " bill recur\n" if $DEBUG > 1;
2417 # XXX shared with $recur_prog
2418 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2420 #over two params! lets at least switch to a hashref for the rest...
2421 my %param = ( 'precommit_hooks' => $precommit_hooks, );
2423 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2424 return "$@ running calc_recur for $cust_pkg\n"
2428 #change this bit to use Date::Manip? CAREFUL with timezones (see
2429 # mailing list archive)
2430 my ($sec,$min,$hour,$mday,$mon,$year) =
2431 (localtime($sdate) )[0,1,2,3,4,5];
2433 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2434 # only for figuring next bill date, nothing else, so, reset $sdate again
2436 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2437 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2438 $cust_pkg->last_bill($sdate);
2440 if ( $part_pkg->freq =~ /^\d+$/ ) {
2441 $mon += $part_pkg->freq;
2442 until ( $mon < 12 ) { $mon -= 12; $year++; }
2443 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2445 $mday += $weeks * 7;
2446 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2449 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2453 return "unparsable frequency: ". $part_pkg->freq;
2455 $cust_pkg->setfield('bill',
2456 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2460 warn "\$setup is undefined" unless defined($setup);
2461 warn "\$recur is undefined" unless defined($recur);
2462 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2465 # If there's line items, create em cust_bill_pkg records
2466 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2471 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2472 # hmm.. and if just the options are modified in some weird price plan?
2474 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2477 my $error = $cust_pkg->replace( $old_cust_pkg,
2478 'options' => { $cust_pkg->options },
2480 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2481 if $error; #just in case
2484 $setup = sprintf( "%.2f", $setup );
2485 $recur = sprintf( "%.2f", $recur );
2486 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2487 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2489 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2490 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2493 if ( $setup != 0 || $recur != 0 ) {
2495 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2498 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2500 warn " adding customer package invoice detail: $_\n"
2501 foreach @cust_pkg_detail;
2503 push @details, @cust_pkg_detail;
2505 my $cust_bill_pkg = new FS::cust_bill_pkg {
2506 'pkgnum' => $cust_pkg->pkgnum,
2508 'unitsetup' => $unitsetup,
2510 'unitrecur' => $unitrecur,
2511 'quantity' => $cust_pkg->quantity,
2512 'details' => \@details,
2515 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2516 $cust_bill_pkg->sdate( $hash{last_bill} );
2517 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2518 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2519 $cust_bill_pkg->sdate( $sdate );
2520 $cust_bill_pkg->edate( $cust_pkg->bill );
2523 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2524 unless $part_pkg->pkgpart == $real_pkgpart;
2526 $$total_setup += $setup;
2527 $$total_recur += $recur;
2534 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg);
2535 return $error if $error;
2537 push @$cust_bill_pkgs, $cust_bill_pkg;
2539 } #if $setup != 0 || $recur != 0
2549 my $part_pkg = shift;
2550 my $taxlisthash = shift;
2551 my $cust_bill_pkg = shift;
2552 my $cust_pkg = shift;
2554 my %cust_bill_pkg = ();
2558 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2563 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
2564 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
2565 push @classes, 'setup' if $cust_bill_pkg->setup;
2566 push @classes, 'recur' if $cust_bill_pkg->recur;
2568 if ( $conf->exists('enable_taxproducts')
2569 && (scalar($part_pkg->part_pkg_taxoverride) || $part_pkg->has_taxproduct)
2570 && ( $self->tax !~ /Y/i && $self->payby ne 'COMP' )
2574 foreach my $class (@classes) {
2575 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $prefix );
2576 return $err_or_ref unless ref($err_or_ref);
2577 $taxes{$class} = $err_or_ref;
2580 unless (exists $taxes{''}) {
2581 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $prefix );
2582 return $err_or_ref unless ref($err_or_ref);
2583 $taxes{''} = $err_or_ref;
2586 } elsif ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
2588 my %taxhash = map { $_ => $self->get("$prefix$_") }
2589 qw( state county country );
2591 $taxhash{'taxclass'} = $part_pkg->taxclass;
2593 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2596 $taxhash{'taxclass'} = '';
2597 @taxes = qsearch( 'cust_main_county', \%taxhash );
2600 #one more try at a whole-country tax rate
2602 $taxhash{$_} = '' foreach qw( state county );
2603 @taxes = qsearch( 'cust_main_county', \%taxhash );
2606 $taxes{''} = [ @taxes ];
2607 $taxes{'setup'} = [ @taxes ];
2608 $taxes{'recur'} = [ @taxes ];
2609 $taxes{$_} = [ @taxes ] foreach (@classes);
2611 # maybe eliminate this entirely, along with all the 0% records
2614 "fatal: can't find tax rate for state/county/country/taxclass ".
2615 join('/', ( map $self->get("$prefix$_"),
2616 qw(state county country)
2618 $part_pkg->taxclass ). "\n";
2621 } #if $conf->exists('enable_taxproducts') ...
2624 if ( $conf->exists('separate_usage') ) {
2625 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
2626 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
2627 push @display, new FS::cust_bill_pkg_display { type => 'S' };
2628 push @display, new FS::cust_bill_pkg_display { type => 'R' };
2629 push @display, new FS::cust_bill_pkg_display { type => 'U',
2632 if ($section && $summary) {
2633 $display[2]->post_total('Y');
2634 push @display, new FS::cust_bill_pkg_display { type => 'U',
2639 $cust_bill_pkg->set('display', \@display);
2641 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
2642 foreach my $key (keys %tax_cust_bill_pkg) {
2643 my @taxes = @{ $taxes{$key} };
2644 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
2646 foreach my $tax ( @taxes ) {
2647 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2648 if ( exists( $taxlisthash->{ $taxname } ) ) {
2649 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
2651 $taxlisthash->{ $taxname } = [ $tax, $tax_cust_bill_pkg ];
2661 my $part_pkg = shift;
2666 my $geocode = $self->geocode('cch');
2668 my @taxclassnums = map { $_->taxclassnum }
2669 $part_pkg->part_pkg_taxoverride($class);
2671 unless (@taxclassnums) {
2672 @taxclassnums = map { $_->taxclassnum }
2673 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
2675 warn "Found taxclassnum values of ". join(',', @taxclassnums)
2680 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2682 @taxes = qsearch({ 'table' => 'tax_rate',
2683 'hashref' => { 'geocode' => $geocode, },
2684 'extra_sql' => $extra_sql,
2686 if scalar(@taxclassnums);
2688 # maybe eliminate this entirely, along with all the 0% records
2691 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2692 join('/', ( map $self->get("$prefix$_"),
2695 $part_pkg->taxproduct_description,
2696 $part_pkg->pkgpart ). "\n";
2699 warn "Found taxes ".
2700 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
2707 =item collect OPTIONS
2709 (Attempt to) collect money for this customer's outstanding invoices (see
2710 L<FS::cust_bill>). Usually used after the bill method.
2712 Actions are now triggered by billing events; see L<FS::part_event> and the
2713 billing events web interface. Old-style invoice events (see
2714 L<FS::part_bill_event>) have been deprecated.
2716 If there is an error, returns the error, otherwise returns false.
2718 Options are passed as name-value pairs.
2720 Currently available options are:
2726 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
2730 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2734 set true to surpress email card/ACH decline notices.
2738 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2742 allows for one time override of normal customer billing method
2746 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2754 my( $self, %options ) = @_;
2755 my $invoice_time = $options{'invoice_time'} || time;
2758 local $SIG{HUP} = 'IGNORE';
2759 local $SIG{INT} = 'IGNORE';
2760 local $SIG{QUIT} = 'IGNORE';
2761 local $SIG{TERM} = 'IGNORE';
2762 local $SIG{TSTP} = 'IGNORE';
2763 local $SIG{PIPE} = 'IGNORE';
2765 my $oldAutoCommit = $FS::UID::AutoCommit;
2766 local $FS::UID::AutoCommit = 0;
2769 $self->select_for_update; #mutex
2772 my $balance = $self->balance;
2773 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2776 if ( exists($options{'retry_card'}) ) {
2777 carp 'retry_card option passed to collect is deprecated; use retry';
2778 $options{'retry'} ||= $options{'retry_card'};
2780 if ( exists($options{'retry'}) && $options{'retry'} ) {
2781 my $error = $self->retry_realtime;
2783 $dbh->rollback if $oldAutoCommit;
2788 # false laziness w/pay_batch::import_results
2790 my $due_cust_event = $self->due_cust_event(
2791 'debug' => ( $options{'debug'} || 0 ),
2792 'time' => $invoice_time,
2793 'check_freq' => $options{'check_freq'},
2795 unless( ref($due_cust_event) ) {
2796 $dbh->rollback if $oldAutoCommit;
2797 return $due_cust_event;
2800 foreach my $cust_event ( @$due_cust_event ) {
2804 #re-eval event conditions (a previous event could have changed things)
2805 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2806 #don't leave stray "new/locked" records around
2807 my $error = $cust_event->delete;
2809 #gah, even with transactions
2810 $dbh->commit if $oldAutoCommit; #well.
2817 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2818 warn " running cust_event ". $cust_event->eventnum. "\n"
2822 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2823 if ( my $error = $cust_event->do_event() ) {
2824 #XXX wtf is this? figure out a proper dealio with return value
2826 # gah, even with transactions.
2827 $dbh->commit if $oldAutoCommit; #well.
2834 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2839 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2841 Inserts database records for and returns an ordered listref of new events due
2842 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2843 events are due, an empty listref is returned. If there is an error, returns a
2844 scalar error message.
2846 To actually run the events, call each event's test_condition method, and if
2847 still true, call the event's do_event method.
2849 Options are passed as a hashref or as a list of name-value pairs. Available
2856 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
2860 "Current time" for the events.
2864 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2868 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2872 Explicitly pass the objects to be tested (typically used with eventtable).
2878 sub due_cust_event {
2880 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2883 #my $DEBUG = $opt{'debug'}
2884 local($DEBUG) = $opt{'debug'}
2885 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2887 warn "$me due_cust_event called with options ".
2888 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2891 $opt{'time'} ||= time;
2893 local $SIG{HUP} = 'IGNORE';
2894 local $SIG{INT} = 'IGNORE';
2895 local $SIG{QUIT} = 'IGNORE';
2896 local $SIG{TERM} = 'IGNORE';
2897 local $SIG{TSTP} = 'IGNORE';
2898 local $SIG{PIPE} = 'IGNORE';
2900 my $oldAutoCommit = $FS::UID::AutoCommit;
2901 local $FS::UID::AutoCommit = 0;
2904 $self->select_for_update; #mutex
2907 # 1: find possible events (initial search)
2910 my @cust_event = ();
2912 my @eventtable = $opt{'eventtable'}
2913 ? ( $opt{'eventtable'} )
2914 : FS::part_event->eventtables_runorder;
2916 foreach my $eventtable ( @eventtable ) {
2919 if ( $opt{'objects'} ) {
2921 @objects = @{ $opt{'objects'} };
2925 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2926 @objects = ( $eventtable eq 'cust_main' )
2928 : ( $self->$eventtable() );
2932 my @e_cust_event = ();
2934 my $cross = "CROSS JOIN $eventtable";
2935 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2936 unless $eventtable eq 'cust_main';
2938 foreach my $object ( @objects ) {
2940 #this first search uses the condition_sql magic for optimization.
2941 #the more possible events we can eliminate in this step the better
2943 my $cross_where = '';
2944 my $pkey = $object->primary_key;
2945 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2947 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2949 FS::part_event_condition->where_conditions_sql( $eventtable,
2950 'time'=>$opt{'time'}
2952 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2954 $extra_sql = "AND $extra_sql" if $extra_sql;
2956 #here is the agent virtualization
2957 $extra_sql .= " AND ( part_event.agentnum IS NULL
2958 OR part_event.agentnum = ". $self->agentnum. ' )';
2960 $extra_sql .= " $order";
2962 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2963 if $opt{'debug'} > 2;
2964 my @part_event = qsearch( {
2965 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2966 'select' => 'part_event.*',
2967 'table' => 'part_event',
2968 'addl_from' => "$cross $join",
2969 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2970 'eventtable' => $eventtable,
2973 'extra_sql' => "AND $cross_where $extra_sql",
2977 my $pkey = $object->primary_key;
2978 warn " ". scalar(@part_event).
2979 " possible events found for $eventtable ". $object->$pkey(). "\n";
2982 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2986 warn " ". scalar(@e_cust_event).
2987 " subtotal possible cust events found for $eventtable\n"
2990 push @cust_event, @e_cust_event;
2994 warn " ". scalar(@cust_event).
2995 " total possible cust events found in initial search\n"
2999 # 2: test conditions
3004 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3005 'stats_hashref' => \%unsat ),
3008 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3011 warn " invalid conditions not eliminated with condition_sql:\n".
3012 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3019 unless( $opt{testonly} ) {
3020 foreach my $cust_event ( @cust_event ) {
3022 my $error = $cust_event->insert();
3024 $dbh->rollback if $oldAutoCommit;
3031 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3037 warn " returning events: ". Dumper(@cust_event). "\n"
3044 =item retry_realtime
3046 Schedules realtime / batch credit card / electronic check / LEC billing
3047 events for for retry. Useful if card information has changed or manual
3048 retry is desired. The 'collect' method must be called to actually retry
3051 Implementation details: For either this customer, or for each of this
3052 customer's open invoices, changes the status of the first "done" (with
3053 statustext error) realtime processing event to "failed".
3057 sub retry_realtime {
3060 local $SIG{HUP} = 'IGNORE';
3061 local $SIG{INT} = 'IGNORE';
3062 local $SIG{QUIT} = 'IGNORE';
3063 local $SIG{TERM} = 'IGNORE';
3064 local $SIG{TSTP} = 'IGNORE';
3065 local $SIG{PIPE} = 'IGNORE';
3067 my $oldAutoCommit = $FS::UID::AutoCommit;
3068 local $FS::UID::AutoCommit = 0;
3071 #a little false laziness w/due_cust_event (not too bad, really)
3073 my $join = FS::part_event_condition->join_conditions_sql;
3074 my $order = FS::part_event_condition->order_conditions_sql;
3077 . join ( ' OR ' , map {
3078 "( part_event.eventtable = " . dbh->quote($_)
3079 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3080 } FS::part_event->eventtables)
3083 #here is the agent virtualization
3084 my $agent_virt = " ( part_event.agentnum IS NULL
3085 OR part_event.agentnum = ". $self->agentnum. ' )';
3087 #XXX this shouldn't be hardcoded, actions should declare it...
3088 my @realtime_events = qw(
3089 cust_bill_realtime_card
3090 cust_bill_realtime_check
3091 cust_bill_realtime_lec
3095 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3100 my @cust_event = qsearchs({
3101 'table' => 'cust_event',
3102 'select' => 'cust_event.*',
3103 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3104 'hashref' => { 'status' => 'done' },
3105 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3106 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3109 my %seen_invnum = ();
3110 foreach my $cust_event (@cust_event) {
3112 #max one for the customer, one for each open invoice
3113 my $cust_X = $cust_event->cust_X;
3114 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3118 or $cust_event->part_event->eventtable eq 'cust_bill'
3121 my $error = $cust_event->retry;
3123 $dbh->rollback if $oldAutoCommit;
3124 return "error scheduling event for retry: $error";
3129 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3134 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3136 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3137 via a Business::OnlinePayment realtime gateway. See
3138 L<http://420.am/business-onlinepayment> for supported gateways.
3140 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3142 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3144 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3145 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3146 if set, will override the value from the customer record.
3148 I<description> is a free-text field passed to the gateway. It defaults to
3149 "Internet services".
3151 If an I<invnum> is specified, this payment (if successful) is applied to the
3152 specified invoice. If you don't specify an I<invnum> you might want to
3153 call the B<apply_payments> method.
3155 I<quiet> can be set true to surpress email decline notices.
3157 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3158 resulting paynum, if any.
3160 I<payunique> is a unique identifier for this payment.
3162 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3167 my( $self, $method, $amount, %options ) = @_;
3169 warn "$me realtime_bop: $method $amount\n";
3170 warn " $_ => $options{$_}\n" foreach keys %options;
3173 $options{'description'} ||= 'Internet services';
3175 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3177 eval "use Business::OnlinePayment";
3180 my $payinfo = exists($options{'payinfo'})
3181 ? $options{'payinfo'}
3184 my %method2payby = (
3191 # check for banned credit card/ACH
3194 my $ban = qsearchs('banned_pay', {
3195 'payby' => $method2payby{$method},
3196 'payinfo' => md5_base64($payinfo),
3198 return "Banned credit card" if $ban;
3205 if ( $options{'invnum'} ) {
3206 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3207 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3209 map { $_->part_pkg->taxclass }
3211 map { $_->cust_pkg }
3212 $cust_bill->cust_bill_pkg;
3213 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3214 #different taxclasses
3215 $taxclass = $taxclasses[0];
3219 #look for an agent gateway override first
3221 if ( $method eq 'CC' ) {
3222 $cardtype = cardtype($payinfo);
3223 } elsif ( $method eq 'ECHECK' ) {
3226 $cardtype = $method;
3230 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3231 cardtype => $cardtype,
3232 taxclass => $taxclass, } )
3233 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3235 taxclass => $taxclass, } )
3236 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3237 cardtype => $cardtype,
3239 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3241 taxclass => '', } );
3243 my $payment_gateway = '';
3244 my( $processor, $login, $password, $action, @bop_options );
3245 if ( $override ) { #use a payment gateway override
3247 $payment_gateway = $override->payment_gateway;
3249 $processor = $payment_gateway->gateway_module;
3250 $login = $payment_gateway->gateway_username;
3251 $password = $payment_gateway->gateway_password;
3252 $action = $payment_gateway->gateway_action;
3253 @bop_options = $payment_gateway->options;
3255 } else { #use the standard settings from the config
3257 ( $processor, $login, $password, $action, @bop_options ) =
3258 $self->default_payment_gateway($method);
3266 my $address = exists($options{'address1'})
3267 ? $options{'address1'}
3269 my $address2 = exists($options{'address2'})
3270 ? $options{'address2'}
3272 $address .= ", ". $address2 if length($address2);
3274 my $o_payname = exists($options{'payname'})
3275 ? $options{'payname'}
3277 my($payname, $payfirst, $paylast);
3278 if ( $o_payname && $method ne 'ECHECK' ) {
3279 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3280 or return "Illegal payname $payname";
3281 ($payfirst, $paylast) = ($1, $2);
3283 $payfirst = $self->getfield('first');
3284 $paylast = $self->getfield('last');
3285 $payname = "$payfirst $paylast";
3288 my @invoicing_list = $self->invoicing_list_emailonly;
3289 if ( $conf->exists('emailinvoiceautoalways')
3290 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3291 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3292 push @invoicing_list, $self->all_emails;
3295 my $email = ($conf->exists('business-onlinepayment-email-override'))
3296 ? $conf->config('business-onlinepayment-email-override')
3297 : $invoicing_list[0];
3301 my $payip = exists($options{'payip'})
3304 $content{customer_ip} = $payip
3307 $content{invoice_number} = $options{'invnum'}
3308 if exists($options{'invnum'}) && length($options{'invnum'});
3310 $content{email_customer} =
3311 ( $conf->exists('business-onlinepayment-email_customer')
3312 || $conf->exists('business-onlinepayment-email-override') );
3315 if ( $method eq 'CC' ) {
3317 $content{card_number} = $payinfo;
3318 $paydate = exists($options{'paydate'})
3319 ? $options{'paydate'}
3321 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3322 $content{expiration} = "$2/$1";
3324 my $paycvv = exists($options{'paycvv'})
3325 ? $options{'paycvv'}
3327 $content{cvv2} = $paycvv
3330 my $paystart_month = exists($options{'paystart_month'})
3331 ? $options{'paystart_month'}
3332 : $self->paystart_month;
3334 my $paystart_year = exists($options{'paystart_year'})
3335 ? $options{'paystart_year'}
3336 : $self->paystart_year;
3338 $content{card_start} = "$paystart_month/$paystart_year"
3339 if $paystart_month && $paystart_year;
3341 my $payissue = exists($options{'payissue'})
3342 ? $options{'payissue'}
3344 $content{issue_number} = $payissue if $payissue;
3346 $content{recurring_billing} = 'YES'
3347 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3349 'payinfo' => $payinfo,
3351 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3353 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3357 } elsif ( $method eq 'ECHECK' ) {
3358 ( $content{account_number}, $content{routing_code} ) =
3359 split('@', $payinfo);
3360 $content{bank_name} = $o_payname;
3361 $content{bank_state} = exists($options{'paystate'})
3362 ? $options{'paystate'}
3363 : $self->getfield('paystate');
3364 $content{account_type} = exists($options{'paytype'})
3365 ? uc($options{'paytype'}) || 'CHECKING'
3366 : uc($self->getfield('paytype')) || 'CHECKING';
3367 $content{account_name} = $payname;
3368 $content{customer_org} = $self->company ? 'B' : 'I';
3369 $content{state_id} = exists($options{'stateid'})
3370 ? $options{'stateid'}
3371 : $self->getfield('stateid');
3372 $content{state_id_state} = exists($options{'stateid_state'})
3373 ? $options{'stateid_state'}
3374 : $self->getfield('stateid_state');
3375 $content{customer_ssn} = exists($options{'ss'})
3378 } elsif ( $method eq 'LEC' ) {
3379 $content{phone} = $payinfo;
3383 # run transaction(s)
3386 my $balance = exists( $options{'balance'} )
3387 ? $options{'balance'}
3390 $self->select_for_update; #mutex ... just until we get our pending record in
3392 #the checks here are intended to catch concurrent payments
3393 #double-form-submission prevention is taken care of in cust_pay_pending::check
3396 return "The customer's balance has changed; $method transaction aborted."
3397 if $self->balance < $balance;
3398 #&& $self->balance < $amount; #might as well anyway?
3400 #also check and make sure there aren't *other* pending payments for this cust
3402 my @pending = qsearch('cust_pay_pending', {
3403 'custnum' => $self->custnum,
3404 'status' => { op=>'!=', value=>'done' }
3406 return "A payment is already being processed for this customer (".
3407 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3408 "); $method transaction aborted."
3409 if scalar(@pending);
3411 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3413 my $cust_pay_pending = new FS::cust_pay_pending {
3414 'custnum' => $self->custnum,
3415 #'invnum' => $options{'invnum'},
3418 'payby' => $method2payby{$method},
3419 'payinfo' => $payinfo,
3420 'paydate' => $paydate,
3422 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3424 $cust_pay_pending->payunique( $options{payunique} )
3425 if defined($options{payunique}) && length($options{payunique});
3426 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3427 return $cpp_new_err if $cpp_new_err;
3429 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3431 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3432 $transaction->content(
3435 'password' => $password,
3436 'action' => $action1,
3437 'description' => $options{'description'},
3438 'amount' => $amount,
3439 #'invoice_number' => $options{'invnum'},
3440 'customer_id' => $self->custnum,
3441 'last_name' => $paylast,
3442 'first_name' => $payfirst,
3444 'address' => $address,
3445 'city' => ( exists($options{'city'})
3448 'state' => ( exists($options{'state'})
3451 'zip' => ( exists($options{'zip'})
3454 'country' => ( exists($options{'country'})
3455 ? $options{'country'}
3457 'referer' => 'http://cleanwhisker.420.am/',
3459 'phone' => $self->daytime || $self->night,
3463 $cust_pay_pending->status('pending');
3464 my $cpp_pending_err = $cust_pay_pending->replace;
3465 return $cpp_pending_err if $cpp_pending_err;
3468 my $BOP_TESTING = 0;
3469 my $BOP_TESTING_SUCCESS = 1;
3471 unless ( $BOP_TESTING ) {
3472 $transaction->submit();
3474 if ( $BOP_TESTING_SUCCESS ) {
3475 $transaction->is_success(1);
3476 $transaction->authorization('fake auth');
3478 $transaction->is_success(0);
3479 $transaction->error_message('fake failure');
3483 if ( $transaction->is_success() && $action2 ) {
3485 $cust_pay_pending->status('authorized');
3486 my $cpp_authorized_err = $cust_pay_pending->replace;
3487 return $cpp_authorized_err if $cpp_authorized_err;
3489 my $auth = $transaction->authorization;
3490 my $ordernum = $transaction->can('order_number')
3491 ? $transaction->order_number
3495 new Business::OnlinePayment( $processor, @bop_options );
3502 password => $password,
3503 order_number => $ordernum,
3505 authorization => $auth,
3506 description => $options{'description'},
3509 foreach my $field (qw( authorization_source_code returned_ACI
3510 transaction_identifier validation_code
3511 transaction_sequence_num local_transaction_date
3512 local_transaction_time AVS_result_code )) {
3513 $capture{$field} = $transaction->$field() if $transaction->can($field);
3516 $capture->content( %capture );
3520 unless ( $capture->is_success ) {
3521 my $e = "Authorization successful but capture failed, custnum #".
3522 $self->custnum. ': '. $capture->result_code.
3523 ": ". $capture->error_message;
3530 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3531 my $cpp_captured_err = $cust_pay_pending->replace;
3532 return $cpp_captured_err if $cpp_captured_err;
3535 # remove paycvv after initial transaction
3538 #false laziness w/misc/process/payment.cgi - check both to make sure working
3540 if ( defined $self->dbdef_table->column('paycvv')
3541 && length($self->paycvv)
3542 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3544 my $error = $self->remove_cvv;
3546 warn "WARNING: error removing cvv: $error\n";
3554 if ( $transaction->is_success() ) {
3557 if ( $payment_gateway ) { # agent override
3558 $paybatch = $payment_gateway->gatewaynum. '-';
3561 $paybatch .= "$processor:". $transaction->authorization;
3563 $paybatch .= ':'. $transaction->order_number
3564 if $transaction->can('order_number')
3565 && length($transaction->order_number);
3567 my $cust_pay = new FS::cust_pay ( {
3568 'custnum' => $self->custnum,
3569 'invnum' => $options{'invnum'},
3572 'payby' => $method2payby{$method},
3573 'payinfo' => $payinfo,
3574 'paybatch' => $paybatch,
3575 'paydate' => $paydate,
3577 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3578 $cust_pay->payunique( $options{payunique} )
3579 if defined($options{payunique}) && length($options{payunique});
3581 my $oldAutoCommit = $FS::UID::AutoCommit;
3582 local $FS::UID::AutoCommit = 0;
3585 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3587 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3590 $cust_pay->invnum(''); #try again with no specific invnum
3591 my $error2 = $cust_pay->insert( $options{'manual'} ?
3592 ( 'manual' => 1 ) : ()
3595 # gah. but at least we have a record of the state we had to abort in
3596 # from cust_pay_pending now.
3597 my $e = "WARNING: $method captured but payment not recorded - ".
3598 "error inserting payment ($processor): $error2".
3599 " (previously tried insert with invnum #$options{'invnum'}" .
3600 ": $error ) - pending payment saved as paypendingnum ".
3601 $cust_pay_pending->paypendingnum. "\n";
3607 if ( $options{'paynum_ref'} ) {
3608 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3611 $cust_pay_pending->status('done');
3612 $cust_pay_pending->statustext('captured');
3613 my $cpp_done_err = $cust_pay_pending->replace;
3615 if ( $cpp_done_err ) {
3617 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3618 my $e = "WARNING: $method captured but payment not recorded - ".
3619 "error updating status for paypendingnum ".
3620 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3626 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3627 return ''; #no error
3633 my $perror = "$processor error: ". $transaction->error_message;
3635 unless ( $transaction->error_message ) {
3638 if ( $transaction->can('response_page') ) {
3640 'page' => ( $transaction->can('response_page')
3641 ? $transaction->response_page
3644 'code' => ( $transaction->can('response_code')
3645 ? $transaction->response_code
3648 'headers' => ( $transaction->can('response_headers')
3649 ? $transaction->response_headers
3655 "No additional debugging information available for $processor";
3658 $perror .= "No error_message returned from $processor -- ".
3659 ( ref($t_response) ? Dumper($t_response) : $t_response );
3663 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3664 && $conf->exists('emaildecline')
3665 && grep { $_ ne 'POST' } $self->invoicing_list
3666 && ! grep { $transaction->error_message =~ /$_/ }
3667 $conf->config('emaildecline-exclude')
3669 my @templ = $conf->config('declinetemplate');
3670 my $template = new Text::Template (
3672 SOURCE => [ map "$_\n", @templ ],
3673 ) or return "($perror) can't create template: $Text::Template::ERROR";
3674 $template->compile()
3675 or return "($perror) can't compile template: $Text::Template::ERROR";
3677 my $templ_hash = { error => $transaction->error_message };
3679 my $error = send_email(
3680 'from' => $conf->config('invoice_from'),
3681 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3682 'subject' => 'Your payment could not be processed',
3683 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3686 $perror .= " (also received error sending decline notification: $error)"
3691 $cust_pay_pending->status('done');
3692 $cust_pay_pending->statustext("declined: $perror");
3693 my $cpp_done_err = $cust_pay_pending->replace;
3694 if ( $cpp_done_err ) {
3695 my $e = "WARNING: $method declined but pending payment not resolved - ".
3696 "error updating status for paypendingnum ".
3697 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3699 $perror = "$e ($perror)";
3712 my( $self, $method, $amount, %options ) = @_;
3714 if ( $options{'fake_failure'} ) {
3715 return "Error: No error; test failure requested with fake_failure";
3718 my %method2payby = (
3725 #if ( $payment_gateway ) { # agent override
3726 # $paybatch = $payment_gateway->gatewaynum. '-';
3729 #$paybatch .= "$processor:". $transaction->authorization;
3731 #$paybatch .= ':'. $transaction->order_number
3732 # if $transaction->can('order_number')
3733 # && length($transaction->order_number);
3735 my $paybatch = 'FakeProcessor:54:32';
3737 my $cust_pay = new FS::cust_pay ( {
3738 'custnum' => $self->custnum,
3739 'invnum' => $options{'invnum'},
3742 'payby' => $method2payby{$method},
3743 #'payinfo' => $payinfo,
3744 'payinfo' => '4111111111111111',
3745 'paybatch' => $paybatch,
3746 #'paydate' => $paydate,
3747 'paydate' => '2012-05-01',
3749 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3751 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3754 $cust_pay->invnum(''); #try again with no specific invnum
3755 my $error2 = $cust_pay->insert( $options{'manual'} ?
3756 ( 'manual' => 1 ) : ()
3759 # gah, even with transactions.
3760 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3761 "error inserting (fake!) payment: $error2".
3762 " (previously tried insert with invnum #$options{'invnum'}" .
3769 if ( $options{'paynum_ref'} ) {
3770 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3773 return ''; #no error
3777 =item default_payment_gateway
3781 sub default_payment_gateway {
3782 my( $self, $method ) = @_;
3784 die "Real-time processing not enabled\n"
3785 unless $conf->exists('business-onlinepayment');
3788 my $bop_config = 'business-onlinepayment';
3789 $bop_config .= '-ach'
3790 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3791 my ( $processor, $login, $password, $action, @bop_options ) =
3792 $conf->config($bop_config);
3793 $action ||= 'normal authorization';
3794 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3795 die "No real-time processor is enabled - ".
3796 "did you set the business-onlinepayment configuration value?\n"
3799 ( $processor, $login, $password, $action, @bop_options )
3804 Removes the I<paycvv> field from the database directly.
3806 If there is an error, returns the error, otherwise returns false.
3812 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3813 or return dbh->errstr;
3814 $sth->execute($self->custnum)
3815 or return $sth->errstr;
3820 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3822 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3823 via a Business::OnlinePayment realtime gateway. See
3824 L<http://420.am/business-onlinepayment> for supported gateways.
3826 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3828 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3830 Most gateways require a reference to an original payment transaction to refund,
3831 so you probably need to specify a I<paynum>.
3833 I<amount> defaults to the original amount of the payment if not specified.
3835 I<reason> specifies a reason for the refund.
3837 I<paydate> specifies the expiration date for a credit card overriding the
3838 value from the customer record or the payment record. Specified as yyyy-mm-dd
3840 Implementation note: If I<amount> is unspecified or equal to the amount of the
3841 orignal payment, first an attempt is made to "void" the transaction via
3842 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3843 the normal attempt is made to "refund" ("credit") the transaction via the
3844 gateway is attempted.
3846 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3847 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3848 #if set, will override the value from the customer record.
3850 #If an I<invnum> is specified, this payment (if successful) is applied to the
3851 #specified invoice. If you don't specify an I<invnum> you might want to
3852 #call the B<apply_payments> method.
3856 #some false laziness w/realtime_bop, not enough to make it worth merging
3857 #but some useful small subs should be pulled out
3858 sub realtime_refund_bop {
3859 my( $self, $method, %options ) = @_;
3861 warn "$me realtime_refund_bop: $method refund\n";
3862 warn " $_ => $options{$_}\n" foreach keys %options;
3865 eval "use Business::OnlinePayment";
3869 # look up the original payment and optionally a gateway for that payment
3873 my $amount = $options{'amount'};
3875 my( $processor, $login, $password, @bop_options ) ;
3876 my( $auth, $order_number ) = ( '', '', '' );
3878 if ( $options{'paynum'} ) {
3880 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3881 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3882 or return "Unknown paynum $options{'paynum'}";
3883 $amount ||= $cust_pay->paid;
3885 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3886 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3887 $cust_pay->paybatch;
3888 my $gatewaynum = '';
3889 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3891 if ( $gatewaynum ) { #gateway for the payment to be refunded
3893 my $payment_gateway =
3894 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3895 die "payment gateway $gatewaynum not found"
3896 unless $payment_gateway;
3898 $processor = $payment_gateway->gateway_module;
3899 $login = $payment_gateway->gateway_username;
3900 $password = $payment_gateway->gateway_password;
3901 @bop_options = $payment_gateway->options;
3903 } else { #try the default gateway
3905 my( $conf_processor, $unused_action );
3906 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3907 $self->default_payment_gateway($method);
3909 return "processor of payment $options{'paynum'} $processor does not".
3910 " match default processor $conf_processor"
3911 unless $processor eq $conf_processor;
3916 } else { # didn't specify a paynum, so look for agent gateway overrides
3917 # like a normal transaction
3920 if ( $method eq 'CC' ) {
3921 $cardtype = cardtype($self->payinfo);
3922 } elsif ( $method eq 'ECHECK' ) {
3925 $cardtype = $method;
3928 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3929 cardtype => $cardtype,
3931 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3933 taxclass => '', } );
3935 if ( $override ) { #use a payment gateway override
3937 my $payment_gateway = $override->payment_gateway;
3939 $processor = $payment_gateway->gateway_module;
3940 $login = $payment_gateway->gateway_username;
3941 $password = $payment_gateway->gateway_password;
3942 #$action = $payment_gateway->gateway_action;
3943 @bop_options = $payment_gateway->options;
3945 } else { #use the standard settings from the config
3948 ( $processor, $login, $password, $unused_action, @bop_options ) =
3949 $self->default_payment_gateway($method);
3954 return "neither amount nor paynum specified" unless $amount;
3959 'password' => $password,
3960 'order_number' => $order_number,
3961 'amount' => $amount,
3962 'referer' => 'http://cleanwhisker.420.am/',
3964 $content{authorization} = $auth
3965 if length($auth); #echeck/ACH transactions have an order # but no auth
3966 #(at least with authorize.net)
3968 my $disable_void_after;
3969 if ($conf->exists('disable_void_after')
3970 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3971 $disable_void_after = $1;
3974 #first try void if applicable
3975 if ( $cust_pay && $cust_pay->paid == $amount
3977 ( not defined($disable_void_after) )
3978 || ( time < ($cust_pay->_date + $disable_void_after ) )
3981 warn " attempting void\n" if $DEBUG > 1;
3982 my $void = new Business::OnlinePayment( $processor, @bop_options );
3983 $void->content( 'action' => 'void', %content );
3985 if ( $void->is_success ) {
3986 my $error = $cust_pay->void($options{'reason'});
3988 # gah, even with transactions.
3989 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3990 "error voiding payment: $error";
3994 warn " void successful\n" if $DEBUG > 1;
3999 warn " void unsuccessful, trying refund\n"
4003 my $address = $self->address1;
4004 $address .= ", ". $self->address2 if $self->address2;
4006 my($payname, $payfirst, $paylast);
4007 if ( $self->payname && $method ne 'ECHECK' ) {
4008 $payname = $self->payname;
4009 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4010 or return "Illegal payname $payname";
4011 ($payfirst, $paylast) = ($1, $2);
4013 $payfirst = $self->getfield('first');
4014 $paylast = $self->getfield('last');
4015 $payname = "$payfirst $paylast";
4018 my @invoicing_list = $self->invoicing_list_emailonly;
4019 if ( $conf->exists('emailinvoiceautoalways')
4020 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4021 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4022 push @invoicing_list, $self->all_emails;
4025 my $email = ($conf->exists('business-onlinepayment-email-override'))
4026 ? $conf->config('business-onlinepayment-email-override')
4027 : $invoicing_list[0];
4029 my $payip = exists($options{'payip'})
4032 $content{customer_ip} = $payip
4036 if ( $method eq 'CC' ) {
4039 $content{card_number} = $payinfo = $cust_pay->payinfo;
4040 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4041 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4042 ($content{expiration} = "$2/$1"); # where available
4044 $content{card_number} = $payinfo = $self->payinfo;
4045 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4046 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4047 $content{expiration} = "$2/$1";
4050 } elsif ( $method eq 'ECHECK' ) {
4053 $payinfo = $cust_pay->payinfo;
4055 $payinfo = $self->payinfo;
4057 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4058 $content{bank_name} = $self->payname;
4059 $content{account_type} = 'CHECKING';
4060 $content{account_name} = $payname;
4061 $content{customer_org} = $self->company ? 'B' : 'I';
4062 $content{customer_ssn} = $self->ss;
4063 } elsif ( $method eq 'LEC' ) {
4064 $content{phone} = $payinfo = $self->payinfo;
4068 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4069 my %sub_content = $refund->content(
4070 'action' => 'credit',
4071 'customer_id' => $self->custnum,
4072 'last_name' => $paylast,
4073 'first_name' => $payfirst,
4075 'address' => $address,
4076 'city' => $self->city,
4077 'state' => $self->state,
4078 'zip' => $self->zip,
4079 'country' => $self->country,
4081 'phone' => $self->daytime || $self->night,
4084 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4088 return "$processor error: ". $refund->error_message
4089 unless $refund->is_success();
4091 my %method2payby = (
4097 my $paybatch = "$processor:". $refund->authorization;
4098 $paybatch .= ':'. $refund->order_number
4099 if $refund->can('order_number') && $refund->order_number;
4101 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4102 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4103 last unless @cust_bill_pay;
4104 my $cust_bill_pay = pop @cust_bill_pay;
4105 my $error = $cust_bill_pay->delete;
4109 my $cust_refund = new FS::cust_refund ( {
4110 'custnum' => $self->custnum,
4111 'paynum' => $options{'paynum'},
4112 'refund' => $amount,
4114 'payby' => $method2payby{$method},
4115 'payinfo' => $payinfo,
4116 'paybatch' => $paybatch,
4117 'reason' => $options{'reason'} || 'card or ACH refund',
4119 my $error = $cust_refund->insert;
4121 $cust_refund->paynum(''); #try again with no specific paynum
4122 my $error2 = $cust_refund->insert;
4124 # gah, even with transactions.
4125 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4126 "error inserting refund ($processor): $error2".
4127 " (previously tried insert with paynum #$options{'paynum'}" .
4138 =item batch_card OPTION => VALUE...
4140 Adds a payment for this invoice to the pending credit card batch (see
4141 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
4142 runs the payment using a realtime gateway.
4147 my ($self, %options) = @_;
4150 if (exists($options{amount})) {
4151 $amount = $options{amount};
4153 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
4155 return '' unless $amount > 0;
4157 my $invnum = delete $options{invnum};
4158 my $payby = $options{invnum} || $self->payby; #dubious
4160 if ($options{'realtime'}) {
4161 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
4167 my $oldAutoCommit = $FS::UID::AutoCommit;
4168 local $FS::UID::AutoCommit = 0;
4171 #this needs to handle mysql as well as Pg, like svc_acct.pm
4172 #(make it into a common function if folks need to do batching with mysql)
4173 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
4174 or return "Cannot lock pay_batch: " . $dbh->errstr;
4178 'payby' => FS::payby->payby2payment($payby),
4181 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
4183 unless ( $pay_batch ) {
4184 $pay_batch = new FS::pay_batch \%pay_batch;
4185 my $error = $pay_batch->insert;
4187 $dbh->rollback if $oldAutoCommit;
4188 die "error creating new batch: $error\n";
4192 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
4193 'batchnum' => $pay_batch->batchnum,
4194 'custnum' => $self->custnum,
4197 foreach (qw( address1 address2 city state zip country payby payinfo paydate
4199 $options{$_} = '' unless exists($options{$_});
4202 my $cust_pay_batch = new FS::cust_pay_batch ( {
4203 'batchnum' => $pay_batch->batchnum,
4204 'invnum' => $invnum || 0, # is there a better value?
4205 # this field should be
4207 # cust_bill_pay_batch now
4208 'custnum' => $self->custnum,
4209 'last' => $self->getfield('last'),
4210 'first' => $self->getfield('first'),
4211 'address1' => $options{address1} || $self->address1,
4212 'address2' => $options{address2} || $self->address2,
4213 'city' => $options{city} || $self->city,
4214 'state' => $options{state} || $self->state,
4215 'zip' => $options{zip} || $self->zip,
4216 'country' => $options{country} || $self->country,
4217 'payby' => $options{payby} || $self->payby,
4218 'payinfo' => $options{payinfo} || $self->payinfo,
4219 'exp' => $options{paydate} || $self->paydate,
4220 'payname' => $options{payname} || $self->payname,
4221 'amount' => $amount, # consolidating
4224 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
4225 if $old_cust_pay_batch;
4228 if ($old_cust_pay_batch) {
4229 $error = $cust_pay_batch->replace($old_cust_pay_batch)
4231 $error = $cust_pay_batch->insert;
4235 $dbh->rollback if $oldAutoCommit;
4239 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
4240 foreach my $cust_bill ($self->open_cust_bill) {
4241 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
4242 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
4243 'invnum' => $cust_bill->invnum,
4244 'paybatchnum' => $cust_pay_batch->paybatchnum,
4245 'amount' => $cust_bill->owed,
4248 if ($unapplied >= $cust_bill_pay_batch->amount){
4249 $unapplied -= $cust_bill_pay_batch->amount;
4252 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
4253 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
4255 $error = $cust_bill_pay_batch->insert;
4257 $dbh->rollback if $oldAutoCommit;
4262 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4268 Returns the total owed for this customer on all invoices
4269 (see L<FS::cust_bill/owed>).
4275 $self->total_owed_date(2145859200); #12/31/2037
4278 =item total_owed_date TIME
4280 Returns the total owed for this customer on all invoices with date earlier than
4281 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4282 see L<Time::Local> and L<Date::Parse> for conversion functions.
4286 sub total_owed_date {
4290 foreach my $cust_bill (
4291 grep { $_->_date <= $time }
4292 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4294 $total_bill += $cust_bill->owed;
4296 sprintf( "%.2f", $total_bill );
4299 =item apply_payments_and_credits
4301 Applies unapplied payments and credits.
4303 In most cases, this new method should be used in place of sequential
4304 apply_payments and apply_credits methods.
4306 If there is an error, returns the error, otherwise returns false.
4310 sub apply_payments_and_credits {
4313 local $SIG{HUP} = 'IGNORE';
4314 local $SIG{INT} = 'IGNORE';
4315 local $SIG{QUIT} = 'IGNORE';
4316 local $SIG{TERM} = 'IGNORE';
4317 local $SIG{TSTP} = 'IGNORE';
4318 local $SIG{PIPE} = 'IGNORE';
4320 my $oldAutoCommit = $FS::UID::AutoCommit;
4321 local $FS::UID::AutoCommit = 0;
4324 $self->select_for_update; #mutex
4326 foreach my $cust_bill ( $self->open_cust_bill ) {
4327 my $error = $cust_bill->apply_payments_and_credits;
4329 $dbh->rollback if $oldAutoCommit;
4330 return "Error applying: $error";
4334 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4339 =item apply_credits OPTION => VALUE ...
4341 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4342 to outstanding invoice balances in chronological order (or reverse
4343 chronological order if the I<order> option is set to B<newest>) and returns the
4344 value of any remaining unapplied credits available for refund (see
4345 L<FS::cust_refund>).
4347 Dies if there is an error.
4355 local $SIG{HUP} = 'IGNORE';
4356 local $SIG{INT} = 'IGNORE';
4357 local $SIG{QUIT} = 'IGNORE';
4358 local $SIG{TERM} = 'IGNORE';
4359 local $SIG{TSTP} = 'IGNORE';
4360 local $SIG{PIPE} = 'IGNORE';
4362 my $oldAutoCommit = $FS::UID::AutoCommit;
4363 local $FS::UID::AutoCommit = 0;
4366 $self->select_for_update; #mutex
4368 unless ( $self->total_credited ) {
4369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4373 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4374 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4376 my @invoices = $self->open_cust_bill;
4377 @invoices = sort { $b->_date <=> $a->_date } @invoices
4378 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4381 foreach my $cust_bill ( @invoices ) {
4384 if ( !defined($credit) || $credit->credited == 0) {
4385 $credit = pop @credits or last;
4388 if ($cust_bill->owed >= $credit->credited) {
4389 $amount=$credit->credited;
4391 $amount=$cust_bill->owed;
4394 my $cust_credit_bill = new FS::cust_credit_bill ( {
4395 'crednum' => $credit->crednum,
4396 'invnum' => $cust_bill->invnum,
4397 'amount' => $amount,
4399 my $error = $cust_credit_bill->insert;
4401 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4405 redo if ($cust_bill->owed > 0);
4409 my $total_credited = $self->total_credited;
4411 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4413 return $total_credited;
4416 =item apply_payments
4418 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4419 to outstanding invoice balances in chronological order.
4421 #and returns the value of any remaining unapplied payments.
4423 Dies if there is an error.
4427 sub apply_payments {
4430 local $SIG{HUP} = 'IGNORE';
4431 local $SIG{INT} = 'IGNORE';
4432 local $SIG{QUIT} = 'IGNORE';
4433 local $SIG{TERM} = 'IGNORE';
4434 local $SIG{TSTP} = 'IGNORE';
4435 local $SIG{PIPE} = 'IGNORE';
4437 my $oldAutoCommit = $FS::UID::AutoCommit;
4438 local $FS::UID::AutoCommit = 0;
4441 $self->select_for_update; #mutex
4445 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4446 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4448 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4449 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4453 foreach my $cust_bill ( @invoices ) {
4456 if ( !defined($payment) || $payment->unapplied == 0 ) {
4457 $payment = pop @payments or last;
4460 if ( $cust_bill->owed >= $payment->unapplied ) {
4461 $amount = $payment->unapplied;
4463 $amount = $cust_bill->owed;
4466 my $cust_bill_pay = new FS::cust_bill_pay ( {
4467 'paynum' => $payment->paynum,
4468 'invnum' => $cust_bill->invnum,
4469 'amount' => $amount,
4471 my $error = $cust_bill_pay->insert;
4473 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4477 redo if ( $cust_bill->owed > 0);
4481 my $total_unapplied_payments = $self->total_unapplied_payments;
4483 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4485 return $total_unapplied_payments;
4488 =item total_credited
4490 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4491 customer. See L<FS::cust_credit/credited>.
4495 sub total_credited {
4497 my $total_credit = 0;
4498 foreach my $cust_credit ( qsearch('cust_credit', {
4499 'custnum' => $self->custnum,
4501 $total_credit += $cust_credit->credited;
4503 sprintf( "%.2f", $total_credit );
4506 =item total_unapplied_payments
4508 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4509 See L<FS::cust_pay/unapplied>.
4513 sub total_unapplied_payments {
4515 my $total_unapplied = 0;
4516 foreach my $cust_pay ( qsearch('cust_pay', {
4517 'custnum' => $self->custnum,
4519 $total_unapplied += $cust_pay->unapplied;
4521 sprintf( "%.2f", $total_unapplied );
4524 =item total_unapplied_refunds
4526 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4527 customer. See L<FS::cust_refund/unapplied>.
4531 sub total_unapplied_refunds {
4533 my $total_unapplied = 0;
4534 foreach my $cust_refund ( qsearch('cust_refund', {
4535 'custnum' => $self->custnum,
4537 $total_unapplied += $cust_refund->unapplied;
4539 sprintf( "%.2f", $total_unapplied );
4544 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4545 total_credited minus total_unapplied_payments).
4553 + $self->total_unapplied_refunds
4554 - $self->total_credited
4555 - $self->total_unapplied_payments
4559 =item balance_date TIME
4561 Returns the balance for this customer, only considering invoices with date
4562 earlier than TIME (total_owed_date minus total_credited minus
4563 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4564 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4573 $self->total_owed_date($time)
4574 + $self->total_unapplied_refunds
4575 - $self->total_credited
4576 - $self->total_unapplied_payments
4580 =item in_transit_payments
4582 Returns the total of requests for payments for this customer pending in
4583 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4587 sub in_transit_payments {
4589 my $in_transit_payments = 0;
4590 foreach my $pay_batch ( qsearch('pay_batch', {
4593 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4594 'batchnum' => $pay_batch->batchnum,
4595 'custnum' => $self->custnum,
4597 $in_transit_payments += $cust_pay_batch->amount;
4600 sprintf( "%.2f", $in_transit_payments );
4603 =item paydate_monthyear
4605 Returns a two-element list consisting of the month and year of this customer's
4606 paydate (credit card expiration date for CARD customers)
4610 sub paydate_monthyear {
4612 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4614 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4621 =item invoicing_list [ ARRAYREF ]
4623 If an arguement is given, sets these email addresses as invoice recipients
4624 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4625 (except as warnings), so use check_invoicing_list first.
4627 Returns a list of email addresses (with svcnum entries expanded).
4629 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4630 check it without disturbing anything by passing nothing.
4632 This interface may change in the future.
4636 sub invoicing_list {
4637 my( $self, $arrayref ) = @_;
4640 my @cust_main_invoice;
4641 if ( $self->custnum ) {
4642 @cust_main_invoice =
4643 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4645 @cust_main_invoice = ();
4647 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4648 #warn $cust_main_invoice->destnum;
4649 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4650 #warn $cust_main_invoice->destnum;
4651 my $error = $cust_main_invoice->delete;
4652 warn $error if $error;
4655 if ( $self->custnum ) {
4656 @cust_main_invoice =
4657 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4659 @cust_main_invoice = ();
4661 my %seen = map { $_->address => 1 } @cust_main_invoice;
4662 foreach my $address ( @{$arrayref} ) {
4663 next if exists $seen{$address} && $seen{$address};
4664 $seen{$address} = 1;
4665 my $cust_main_invoice = new FS::cust_main_invoice ( {
4666 'custnum' => $self->custnum,
4669 my $error = $cust_main_invoice->insert;
4670 warn $error if $error;
4674 if ( $self->custnum ) {
4676 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4683 =item check_invoicing_list ARRAYREF
4685 Checks these arguements as valid input for the invoicing_list method. If there
4686 is an error, returns the error, otherwise returns false.
4690 sub check_invoicing_list {
4691 my( $self, $arrayref ) = @_;
4693 foreach my $address ( @$arrayref ) {
4695 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4696 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4699 my $cust_main_invoice = new FS::cust_main_invoice ( {
4700 'custnum' => $self->custnum,
4703 my $error = $self->custnum
4704 ? $cust_main_invoice->check
4705 : $cust_main_invoice->checkdest
4707 return $error if $error;
4711 return "Email address required"
4712 if $conf->exists('cust_main-require_invoicing_list_email')
4713 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4718 =item set_default_invoicing_list
4720 Sets the invoicing list to all accounts associated with this customer,
4721 overwriting any previous invoicing list.
4725 sub set_default_invoicing_list {
4727 $self->invoicing_list($self->all_emails);
4732 Returns the email addresses of all accounts provisioned for this customer.
4739 foreach my $cust_pkg ( $self->all_pkgs ) {
4740 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4742 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4743 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4745 $list{$_}=1 foreach map { $_->email } @svc_acct;
4750 =item invoicing_list_addpost
4752 Adds postal invoicing to this customer. If this customer is already configured
4753 to receive postal invoices, does nothing.
4757 sub invoicing_list_addpost {
4759 return if grep { $_ eq 'POST' } $self->invoicing_list;
4760 my @invoicing_list = $self->invoicing_list;
4761 push @invoicing_list, 'POST';
4762 $self->invoicing_list(\@invoicing_list);
4765 =item invoicing_list_emailonly
4767 Returns the list of email invoice recipients (invoicing_list without non-email
4768 destinations such as POST and FAX).
4772 sub invoicing_list_emailonly {
4774 warn "$me invoicing_list_emailonly called"
4776 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4779 =item invoicing_list_emailonly_scalar
4781 Returns the list of email invoice recipients (invoicing_list without non-email
4782 destinations such as POST and FAX) as a comma-separated scalar.
4786 sub invoicing_list_emailonly_scalar {
4788 warn "$me invoicing_list_emailonly_scalar called"
4790 join(', ', $self->invoicing_list_emailonly);
4793 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4795 Returns an array of customers referred by this customer (referral_custnum set
4796 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4797 customers referred by customers referred by this customer and so on, inclusive.
4798 The default behavior is DEPTH 1 (no recursion).
4802 sub referral_cust_main {
4804 my $depth = @_ ? shift : 1;
4805 my $exclude = @_ ? shift : {};
4808 map { $exclude->{$_->custnum}++; $_; }
4809 grep { ! $exclude->{ $_->custnum } }
4810 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4814 map { $_->referral_cust_main($depth-1, $exclude) }
4821 =item referral_cust_main_ncancelled
4823 Same as referral_cust_main, except only returns customers with uncancelled
4828 sub referral_cust_main_ncancelled {
4830 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4833 =item referral_cust_pkg [ DEPTH ]
4835 Like referral_cust_main, except returns a flat list of all unsuspended (and
4836 uncancelled) packages for each customer. The number of items in this list may
4837 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4841 sub referral_cust_pkg {
4843 my $depth = @_ ? shift : 1;
4845 map { $_->unsuspended_pkgs }
4846 grep { $_->unsuspended_pkgs }
4847 $self->referral_cust_main($depth);
4850 =item referring_cust_main
4852 Returns the single cust_main record for the customer who referred this customer
4853 (referral_custnum), or false.
4857 sub referring_cust_main {
4859 return '' unless $self->referral_custnum;
4860 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4863 =item credit AMOUNT, REASON
4865 Applies a credit to this customer. If there is an error, returns the error,
4866 otherwise returns false.
4871 my( $self, $amount, $reason, %options ) = @_;
4872 my $cust_credit = new FS::cust_credit {
4873 'custnum' => $self->custnum,
4874 'amount' => $amount,
4875 'reason' => $reason,
4877 $cust_credit->insert(%options);
4880 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4882 Creates a one-time charge for this customer. If there is an error, returns
4883 the error, otherwise returns false.
4889 my ( $amount, $quantity, $pkg, $comment, $taxclass, $additional, $classnum );
4890 my ( $taxproduct, $override );
4891 if ( ref( $_[0] ) ) {
4892 $amount = $_[0]->{amount};
4893 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
4894 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4895 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4896 : '$'. sprintf("%.2f",$amount);
4897 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4898 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4899 $additional = $_[0]->{additional};
4900 $taxproduct = $_[0]->{taxproductnum};
4901 $override = { '' => $_[0]->{tax_override} };
4905 $pkg = @_ ? shift : 'One-time charge';
4906 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4907 $taxclass = @_ ? shift : '';
4911 local $SIG{HUP} = 'IGNORE';
4912 local $SIG{INT} = 'IGNORE';
4913 local $SIG{QUIT} = 'IGNORE';
4914 local $SIG{TERM} = 'IGNORE';
4915 local $SIG{TSTP} = 'IGNORE';
4916 local $SIG{PIPE} = 'IGNORE';
4918 my $oldAutoCommit = $FS::UID::AutoCommit;
4919 local $FS::UID::AutoCommit = 0;
4922 my $part_pkg = new FS::part_pkg ( {
4924 'comment' => $comment,
4928 'classnum' => $classnum ? $classnum : '',
4929 'taxclass' => $taxclass,
4930 'taxproductnum' => $taxproduct,
4933 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4934 ( 0 .. @$additional - 1 )
4936 'additional_count' => scalar(@$additional),
4937 'setup_fee' => $amount,
4940 my $error = $part_pkg->insert( options => \%options,
4941 tax_overrides => $override,
4944 $dbh->rollback if $oldAutoCommit;
4948 my $pkgpart = $part_pkg->pkgpart;
4949 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4950 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4951 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4952 $error = $type_pkgs->insert;
4954 $dbh->rollback if $oldAutoCommit;
4959 my $cust_pkg = new FS::cust_pkg ( {
4960 'custnum' => $self->custnum,
4961 'pkgpart' => $pkgpart,
4962 'quantity' => $quantity,
4965 $error = $cust_pkg->insert;
4967 $dbh->rollback if $oldAutoCommit;
4971 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4976 #=item charge_postal_fee
4978 #Applies a one time charge this customer. If there is an error,
4979 #returns the error, returns the cust_pkg charge object or false
4980 #if there was no charge.
4984 # This should be a customer event. For that to work requires that bill
4985 # also be a customer event.
4987 sub charge_postal_fee {
4990 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
4991 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
4993 my $cust_pkg = new FS::cust_pkg ( {
4994 'custnum' => $self->custnum,
4995 'pkgpart' => $pkgpart,
4999 my $error = $cust_pkg->insert;
5000 $error ? $error : $cust_pkg;
5005 Returns all the invoices (see L<FS::cust_bill>) for this customer.
5011 sort { $a->_date <=> $b->_date }
5012 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
5015 =item open_cust_bill
5017 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
5022 sub open_cust_bill {
5024 grep { $_->owed > 0 } $self->cust_bill;
5029 Returns all the credits (see L<FS::cust_credit>) for this customer.
5035 sort { $a->_date <=> $b->_date }
5036 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
5041 Returns all the payments (see L<FS::cust_pay>) for this customer.
5047 sort { $a->_date <=> $b->_date }
5048 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
5053 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
5059 sort { $a->_date <=> $b->_date }
5060 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
5063 =item cust_pay_batch
5065 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
5069 sub cust_pay_batch {
5071 sort { $a->_date <=> $b->_date }
5072 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
5077 Returns all the refunds (see L<FS::cust_refund>) for this customer.
5083 sort { $a->_date <=> $b->_date }
5084 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
5087 =item display_custnum
5089 Returns the displayed customer number for this customer: agent_custid if
5090 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
5094 sub display_custnum {
5096 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
5097 return $self->agent_custid;
5099 return $self->custnum;
5105 Returns a name string for this customer, either "Company (Last, First)" or
5112 my $name = $self->contact;
5113 $name = $self->company. " ($name)" if $self->company;
5119 Returns a name string for this (service/shipping) contact, either
5120 "Company (Last, First)" or "Last, First".
5126 if ( $self->get('ship_last') ) {
5127 my $name = $self->ship_contact;
5128 $name = $self->ship_company. " ($name)" if $self->ship_company;
5137 Returns this customer's full (billing) contact name only, "Last, First"
5143 $self->get('last'). ', '. $self->first;
5148 Returns this customer's full (shipping) contact name only, "Last, First"
5154 $self->get('ship_last')
5155 ? $self->get('ship_last'). ', '. $self->ship_first
5161 Returns this customer's full country name
5167 code2country($self->country);
5170 =item geocode DATA_VENDOR
5172 Returns a value for the customer location as encoded by DATA_VENDOR.
5173 Currently this only makes sense for "CCH" as DATA_VENDOR.
5178 my ($self, $data_vendor) = (shift, shift); #always cch for now
5180 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
5184 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
5185 if $self->country eq 'US';
5187 #CCH specific location stuff
5188 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
5191 my @cust_tax_location =
5193 'table' => 'cust_tax_location',
5194 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
5195 'extra_sql' => $extra_sql,
5196 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
5199 $geocode = $cust_tax_location[0]->geocode
5200 if scalar(@cust_tax_location);
5209 Returns a status string for this customer, currently:
5213 =item prospect - No packages have ever been ordered
5215 =item active - One or more recurring packages is active
5217 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
5219 =item suspended - All non-cancelled recurring packages are suspended
5221 =item cancelled - All recurring packages are cancelled
5227 sub status { shift->cust_status(@_); }
5231 for my $status (qw( prospect active inactive suspended cancelled )) {
5232 my $method = $status.'_sql';
5233 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
5234 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
5235 $sth->execute( ($self->custnum) x $numnum )
5236 or die "Error executing 'SELECT $sql': ". $sth->errstr;
5237 return $status if $sth->fetchrow_arrayref->[0];
5241 =item ucfirst_cust_status
5243 =item ucfirst_status
5245 Returns the status with the first character capitalized.
5249 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
5251 sub ucfirst_cust_status {
5253 ucfirst($self->cust_status);
5258 Returns a hex triplet color string for this customer's status.
5262 use vars qw(%statuscolor);
5263 tie %statuscolor, 'Tie::IxHash',
5264 'prospect' => '7e0079', #'000000', #black? naw, purple
5265 'active' => '00CC00', #green
5266 'inactive' => '0000CC', #blue
5267 'suspended' => 'FF9900', #yellow
5268 'cancelled' => 'FF0000', #red
5271 sub statuscolor { shift->cust_statuscolor(@_); }
5273 sub cust_statuscolor {
5275 $statuscolor{$self->cust_status};
5280 Returns an array of hashes representing the customer's RT tickets.
5287 my $num = $conf->config('cust_main-max_tickets') || 10;
5290 unless ( $conf->config('ticket_system-custom_priority_field') ) {
5292 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
5296 foreach my $priority (
5297 $conf->config('ticket_system-custom_priority_field-values'), ''
5299 last if scalar(@tickets) >= $num;
5301 @{ FS::TicketSystem->customer_tickets( $self->custnum,
5302 $num - scalar(@tickets),
5311 # Return services representing svc_accts in customer support packages
5312 sub support_services {
5314 my %packages = map { $_ => 1 } $conf->config('support_packages');
5316 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
5317 grep { $_->part_svc->svcdb eq 'svc_acct' }
5318 map { $_->cust_svc }
5319 grep { exists $packages{ $_->pkgpart } }
5320 $self->ncancelled_pkgs;
5326 =head1 CLASS METHODS
5332 Class method that returns the list of possible status strings for customers
5333 (see L<the status method|/status>). For example:
5335 @statuses = FS::cust_main->statuses();
5340 #my $self = shift; #could be class...
5346 Returns an SQL expression identifying prospective cust_main records (customers
5347 with no packages ever ordered)
5351 use vars qw($select_count_pkgs);
5352 $select_count_pkgs =
5353 "SELECT COUNT(*) FROM cust_pkg
5354 WHERE cust_pkg.custnum = cust_main.custnum";
5356 sub select_count_pkgs_sql {
5360 sub prospect_sql { "
5361 0 = ( $select_count_pkgs )
5366 Returns an SQL expression identifying active cust_main records (customers with
5367 active recurring packages).
5372 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5378 Returns an SQL expression identifying inactive cust_main records (customers with
5379 no active recurring packages, but otherwise unsuspended/uncancelled).
5383 sub inactive_sql { "
5384 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5386 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5392 Returns an SQL expression identifying suspended cust_main records.
5397 sub suspended_sql { susp_sql(@_); }
5399 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5401 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5407 Returns an SQL expression identifying cancelled cust_main records.
5411 sub cancelled_sql { cancel_sql(@_); }
5414 my $recurring_sql = FS::cust_pkg->recurring_sql;
5415 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
5418 0 < ( $select_count_pkgs )
5419 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
5420 AND 0 = ( $select_count_pkgs AND $recurring_sql
5421 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5423 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5429 =item uncancelled_sql
5431 Returns an SQL expression identifying un-cancelled cust_main records.
5435 sub uncancelled_sql { uncancel_sql(@_); }
5436 sub uncancel_sql { "
5437 ( 0 < ( $select_count_pkgs
5438 AND ( cust_pkg.cancel IS NULL
5439 OR cust_pkg.cancel = 0
5442 OR 0 = ( $select_count_pkgs )
5448 Returns an SQL fragment to retreive the balance.
5453 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5454 WHERE cust_bill.custnum = cust_main.custnum )
5455 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5456 WHERE cust_pay.custnum = cust_main.custnum )
5457 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5458 WHERE cust_credit.custnum = cust_main.custnum )
5459 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5460 WHERE cust_refund.custnum = cust_main.custnum )
5463 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5465 Returns an SQL fragment to retreive the balance for this customer, only
5466 considering invoices with date earlier than START_TIME, and optionally not
5467 later than END_TIME (total_owed_date minus total_credited minus
5468 total_unapplied_payments).
5470 Times are specified as SQL fragments or numeric
5471 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5472 L<Date::Parse> for conversion functions. The empty string can be passed
5473 to disable that time constraint completely.
5475 Available options are:
5479 =item unapplied_date
5481 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
5486 set to true to remove all customer comparison clauses, for totals
5491 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5496 JOIN clause (typically used with the total option)
5502 sub balance_date_sql {
5503 my( $class, $start, $end, %opt ) = @_;
5505 my $owed = FS::cust_bill->owed_sql;
5506 my $unapp_refund = FS::cust_refund->unapplied_sql;
5507 my $unapp_credit = FS::cust_credit->unapplied_sql;
5508 my $unapp_pay = FS::cust_pay->unapplied_sql;
5510 my $j = $opt{'join'} || '';
5512 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5513 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5514 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5515 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5517 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5518 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5519 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5520 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5525 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5527 Helper method for balance_date_sql; name (and usage) subject to change
5528 (suggestions welcome).
5530 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5531 cust_refund, cust_credit or cust_pay).
5533 If TABLE is "cust_bill" or the unapplied_date option is true, only
5534 considers records with date earlier than START_TIME, and optionally not
5535 later than END_TIME .
5539 sub _money_table_where {
5540 my( $class, $table, $start, $end, %opt ) = @_;
5543 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5544 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5545 push @where, "$table._date <= $start" if defined($start) && length($start);
5546 push @where, "$table._date > $end" if defined($end) && length($end);
5548 push @where, @{$opt{'where'}} if $opt{'where'};
5549 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5555 =item search_sql HASHREF
5559 Returns a qsearch hash expression to search for parameters specified in HREF.
5560 Valid parameters are
5568 =item cancelled_pkgs
5574 listref of start date, end date
5580 =item current_balance
5582 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
5586 =item flattened_pkgs
5595 my ($class, $params) = @_;
5606 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5608 "cust_main.agentnum = $1";
5615 #prospect active inactive suspended cancelled
5616 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
5617 my $method = $params->{'status'}. '_sql';
5618 #push @where, $class->$method();
5619 push @where, FS::cust_main->$method();
5623 # parse cancelled package checkbox
5628 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
5629 unless $params->{'cancelled_pkgs'};
5635 foreach my $field (qw( signupdate )) {
5637 next unless exists($params->{$field});
5639 my($beginning, $ending) = @{$params->{$field}};
5642 "cust_main.$field IS NOT NULL",
5643 "cust_main.$field >= $beginning",
5644 "cust_main.$field <= $ending";
5646 $orderby ||= "ORDER BY cust_main.$field";
5654 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
5656 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
5663 #my $balance_sql = $class->balance_sql();
5664 my $balance_sql = FS::cust_main->balance_sql();
5666 push @where, map { s/current_balance/$balance_sql/; $_ }
5667 @{ $params->{'current_balance'} };
5673 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5675 "cust_main.custbatch = '$1'";
5679 # setup queries, subs, etc. for the search
5682 $orderby ||= 'ORDER BY custnum';
5684 # here is the agent virtualization
5685 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
5687 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5689 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
5691 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
5693 my $select = join(', ',
5694 'cust_main.custnum',
5695 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
5698 my(@extra_headers) = ();
5699 my(@extra_fields) = ();
5701 if ($params->{'flattened_pkgs'}) {
5703 if ($dbh->{Driver}->{Name} eq 'Pg') {
5705 $select .= ", array_to_string(array(select pkg from cust_pkg left join part_pkg using ( pkgpart ) where cust_main.custnum = cust_pkg.custnum $pkgwhere),'|') as magic";
5707 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
5708 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
5709 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
5711 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
5712 "omitting packing information from report.";
5715 my $header_query = "SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count FROM cust_main $addl_from $extra_sql $pkgwhere group by cust_main.custnum order by count desc limit 1";
5717 my $sth = dbh->prepare($header_query) or die dbh->errstr;
5718 $sth->execute() or die $sth->errstr;
5719 my $headerrow = $sth->fetchrow_arrayref;
5720 my $headercount = $headerrow ? $headerrow->[0] : 0;
5721 while($headercount) {
5722 unshift @extra_headers, "Package ". $headercount;
5723 unshift @extra_fields, eval q!sub {my $c = shift;
5724 my @a = split '\|', $c->magic;
5725 my $p = $a[!.--$headercount. q!];
5733 'table' => 'cust_main',
5734 'select' => $select,
5736 'extra_sql' => $extra_sql,
5737 'order_by' => $orderby,
5738 'count_query' => $count_query,
5739 'extra_headers' => \@extra_headers,
5740 'extra_fields' => \@extra_fields,
5745 =item email_search_sql HASHREF
5749 Emails a notice to the specified customers.
5751 Valid parameters are those of the L<search_sql> method, plus the following:
5773 Optional job queue job for status updates.
5777 Returns an error message, or false for success.
5779 If an error occurs during any email, stops the enture send and returns that
5780 error. Presumably if you're getting SMTP errors aborting is better than
5781 retrying everything.
5785 sub email_search_sql {
5786 my($class, $params) = @_;
5788 my $from = delete $params->{from};
5789 my $subject = delete $params->{subject};
5790 my $html_body = delete $params->{html_body};
5791 my $text_body = delete $params->{text_body};
5793 my $job = delete $params->{'job'};
5795 my $sql_query = $class->search_sql($params);
5797 my $count_query = delete($sql_query->{'count_query'});
5798 my $count_sth = dbh->prepare($count_query)
5799 or die "Error preparing $count_query: ". dbh->errstr;
5801 or die "Error executing $count_query: ". $count_sth->errstr;
5802 my $count_arrayref = $count_sth->fetchrow_arrayref;
5803 my $num_cust = $count_arrayref->[0];
5805 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
5806 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
5809 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5811 #eventually order+limit magic to reduce memory use?
5812 foreach my $cust_main ( qsearch($sql_query) ) {
5814 my $to = $cust_main->invoicing_list_emailonly_scalar;
5817 my $error = send_email(
5821 'subject' => $subject,
5822 'html_body' => $html_body,
5823 'text_body' => $text_body,
5826 return $error if $error;
5828 if ( $job ) { #progressbar foo
5830 if ( time - $min_sec > $last ) {
5831 my $error = $job->update_statustext(
5832 int( 100 * $num / $num_cust )
5834 die $error if $error;
5844 use Storable qw(thaw);
5847 sub process_email_search_sql {
5849 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
5851 my $param = thaw(decode_base64(shift));
5852 warn Dumper($param) if $DEBUG;
5854 $param->{'job'} = $job;
5856 my $error = FS::cust_main->email_search_sql( $param );
5857 die $error if $error;
5861 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5863 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5864 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5865 appropriate ship_ field is also searched).
5867 Additional options are the same as FS::Record::qsearch
5872 my( $self, $fuzzy, $hash, @opt) = @_;
5877 check_and_rebuild_fuzzyfiles();
5878 foreach my $field ( keys %$fuzzy ) {
5880 my $all = $self->all_X($field);
5881 next unless scalar(@$all);
5884 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5887 foreach ( keys %match ) {
5888 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5889 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5892 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5895 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5897 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5905 Returns a masked version of the named field
5910 my ($self,$field) = @_;
5914 'x'x(length($self->getfield($field))-4).
5915 substr($self->getfield($field), (length($self->getfield($field))-4));
5925 =item smart_search OPTION => VALUE ...
5927 Accepts the following options: I<search>, the string to search for. The string
5928 will be searched for as a customer number, phone number, name or company name,
5929 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5930 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5931 skip fuzzy matching when an exact match is found.
5933 Any additional options are treated as an additional qualifier on the search
5936 Returns a (possibly empty) array of FS::cust_main objects.
5943 #here is the agent virtualization
5944 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5948 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5949 my $search = delete $options{'search'};
5950 ( my $alphanum_search = $search ) =~ s/\W//g;
5952 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5954 #false laziness w/Record::ut_phone
5955 my $phonen = "$1-$2-$3";
5956 $phonen .= " x$4" if $4;
5958 push @cust_main, qsearch( {
5959 'table' => 'cust_main',
5960 'hashref' => { %options },
5961 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5963 join(' OR ', map "$_ = '$phonen'",
5964 qw( daytime night fax
5965 ship_daytime ship_night ship_fax )
5968 " AND $agentnums_sql", #agent virtualization
5971 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5972 #try looking for matches with extensions unless one was specified
5974 push @cust_main, qsearch( {
5975 'table' => 'cust_main',
5976 'hashref' => { %options },
5977 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5979 join(' OR ', map "$_ LIKE '$phonen\%'",
5981 ship_daytime ship_night )
5984 " AND $agentnums_sql", #agent virtualization
5989 # custnum search (also try agent_custid), with some tweaking options if your
5990 # legacy cust "numbers" have letters
5993 if ( $search =~ /^\s*(\d+)\s*$/
5994 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5995 && $search =~ /^\s*(\w\w?\d+)\s*$/
6002 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
6003 push @cust_main, qsearch( {
6004 'table' => 'cust_main',
6005 'hashref' => { 'custnum' => $num, %options },
6006 'extra_sql' => " AND $agentnums_sql", #agent virtualization
6010 push @cust_main, qsearch( {
6011 'table' => 'cust_main',
6012 'hashref' => { 'agent_custid' => $num, %options },
6013 'extra_sql' => " AND $agentnums_sql", #agent virtualization
6016 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
6018 my($company, $last, $first) = ( $1, $2, $3 );
6020 # "Company (Last, First)"
6021 #this is probably something a browser remembered,
6022 #so just do an exact search
6024 foreach my $prefix ( '', 'ship_' ) {
6025 push @cust_main, qsearch( {
6026 'table' => 'cust_main',
6027 'hashref' => { $prefix.'first' => $first,
6028 $prefix.'last' => $last,
6029 $prefix.'company' => $company,
6032 'extra_sql' => " AND $agentnums_sql",
6036 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
6037 # try (ship_){last,company}
6041 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
6042 # # full strings the browser remembers won't work
6043 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
6045 use Lingua::EN::NameParse;
6046 my $NameParse = new Lingua::EN::NameParse(
6048 allow_reversed => 1,
6051 my($last, $first) = ( '', '' );
6052 #maybe disable this too and just rely on NameParse?
6053 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
6055 ($last, $first) = ( $1, $2 );
6057 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
6058 } elsif ( ! $NameParse->parse($value) ) {
6060 my %name = $NameParse->components;
6061 $first = $name{'given_name_1'};
6062 $last = $name{'surname_1'};
6066 if ( $first && $last ) {
6068 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
6071 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
6073 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
6074 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
6077 push @cust_main, qsearch( {
6078 'table' => 'cust_main',
6079 'hashref' => \%options,
6080 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
6083 # or it just be something that was typed in... (try that in a sec)
6087 my $q_value = dbh->quote($value);
6090 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
6091 $sql .= " ( LOWER(last) = $q_value
6092 OR LOWER(company) = $q_value
6093 OR LOWER(ship_last) = $q_value
6094 OR LOWER(ship_company) = $q_value
6097 push @cust_main, qsearch( {
6098 'table' => 'cust_main',
6099 'hashref' => \%options,
6100 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
6103 #no exact match, trying substring/fuzzy
6104 #always do substring & fuzzy (unless they're explicity config'ed off)
6105 #getting complaints searches are not returning enough
6106 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
6108 #still some false laziness w/search_sql (was search/cust_main.cgi)
6113 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
6114 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
6117 if ( $first && $last ) {
6120 { 'first' => { op=>'ILIKE', value=>"%$first%" },
6121 'last' => { op=>'ILIKE', value=>"%$last%" },
6123 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
6124 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
6131 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
6132 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
6136 foreach my $hashref ( @hashrefs ) {
6138 push @cust_main, qsearch( {
6139 'table' => 'cust_main',
6140 'hashref' => { %$hashref,
6143 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
6152 " AND $agentnums_sql", #extra_sql #agent virtualization
6155 if ( $first && $last ) {
6156 push @cust_main, FS::cust_main->fuzzy_search(
6157 { 'last' => $last, #fuzzy hashref
6158 'first' => $first }, #
6162 foreach my $field ( 'last', 'company' ) {
6164 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
6169 #eliminate duplicates
6171 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6181 Accepts the following options: I<email>, the email address to search for. The
6182 email address will be searched for as an email invoice destination and as an
6185 #Any additional options are treated as an additional qualifier on the search
6186 #(i.e. I<agentnum>).
6188 Returns a (possibly empty) array of FS::cust_main objects (but usually just
6198 my $email = delete $options{'email'};
6200 #we're only being used by RT at the moment... no agent virtualization yet
6201 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
6205 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
6207 my ( $user, $domain ) = ( $1, $2 );
6209 warn "$me smart_search: searching for $user in domain $domain"
6215 'table' => 'cust_main_invoice',
6216 'hashref' => { 'dest' => $email },
6223 map $_->cust_svc->cust_pkg,
6225 'table' => 'svc_acct',
6226 'hashref' => { 'username' => $user, },
6228 'AND ( SELECT domain FROM svc_domain
6229 WHERE svc_acct.domsvc = svc_domain.svcnum
6230 ) = '. dbh->quote($domain),
6236 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
6238 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
6245 =item check_and_rebuild_fuzzyfiles
6249 use vars qw(@fuzzyfields);
6250 @fuzzyfields = ( 'last', 'first', 'company' );
6252 sub check_and_rebuild_fuzzyfiles {
6253 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6254 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
6257 =item rebuild_fuzzyfiles
6261 sub rebuild_fuzzyfiles {
6263 use Fcntl qw(:flock);
6265 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6266 mkdir $dir, 0700 unless -d $dir;
6268 foreach my $fuzzy ( @fuzzyfields ) {
6270 open(LOCK,">>$dir/cust_main.$fuzzy")
6271 or die "can't open $dir/cust_main.$fuzzy: $!";
6273 or die "can't lock $dir/cust_main.$fuzzy: $!";
6275 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
6276 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
6278 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
6279 my $sth = dbh->prepare("SELECT $field FROM cust_main".
6280 " WHERE $field != '' AND $field IS NOT NULL");
6281 $sth->execute or die $sth->errstr;
6283 while ( my $row = $sth->fetchrow_arrayref ) {
6284 print CACHE $row->[0]. "\n";
6289 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
6291 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
6302 my( $self, $field ) = @_;
6303 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6304 open(CACHE,"<$dir/cust_main.$field")
6305 or die "can't open $dir/cust_main.$field: $!";
6306 my @array = map { chomp; $_; } <CACHE>;
6311 =item append_fuzzyfiles LASTNAME COMPANY
6315 sub append_fuzzyfiles {
6316 #my( $first, $last, $company ) = @_;
6318 &check_and_rebuild_fuzzyfiles;
6320 use Fcntl qw(:flock);
6322 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
6324 foreach my $field (qw( first last company )) {
6329 open(CACHE,">>$dir/cust_main.$field")
6330 or die "can't open $dir/cust_main.$field: $!";
6331 flock(CACHE,LOCK_EX)
6332 or die "can't lock $dir/cust_main.$field: $!";
6334 print CACHE "$value\n";
6336 flock(CACHE,LOCK_UN)
6337 or die "can't unlock $dir/cust_main.$field: $!";
6346 =item process_batch_import
6348 Load a batch import as a queued JSRPC job
6352 use Storable qw(thaw);
6355 sub process_batch_import {
6358 my $param = thaw(decode_base64(shift));
6359 warn Dumper($param) if $DEBUG;
6361 my $files = $param->{'uploaded_files'}
6362 or die "No files provided.\n";
6364 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
6366 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
6367 my $file = $dir. $files{'file'};
6370 if ( $file =~ /\.(\w+)$/i ) {
6374 warn "can't parse file type from filename $file; defaulting to CSV";
6379 FS::cust_main::batch_import( {
6383 custbatch => $param->{custbatch},
6384 agentnum => $param->{'agentnum'},
6385 refnum => $param->{'refnum'},
6386 pkgpart => $param->{'pkgpart'},
6387 #'fields' => [qw( cust_pkg.setup dayphone first last address1 address2
6388 # city state zip comments )],
6389 'format' => $param->{'format'},
6394 die "$error\n" if $error;
6403 use FS::svc_external;
6405 #some false laziness w/cdr.pm now
6409 my $job = $param->{job};
6411 my $filename = $param->{file};
6412 my $type = $param->{type} || 'csv';
6414 my $custbatch = $param->{custbatch};
6416 my $agentnum = $param->{agentnum};
6417 my $refnum = $param->{refnum};
6418 my $pkgpart = $param->{pkgpart};
6420 my $format = $param->{'format'};
6424 if ( $format eq 'simple' ) {
6425 @fields = qw( cust_pkg.setup dayphone first last
6426 address1 address2 city state zip comments );
6428 } elsif ( $format eq 'extended' ) {
6429 @fields = qw( agent_custid refnum
6430 last first address1 address2 city state zip country
6432 ship_last ship_first ship_address1 ship_address2
6433 ship_city ship_state ship_zip ship_country
6434 payinfo paycvv paydate
6437 svc_acct.username svc_acct._password
6440 } elsif ( $format eq 'extended-plus_company' ) {
6441 @fields = qw( agent_custid refnum
6442 last first company address1 address2 city state zip country
6444 ship_last ship_first ship_company ship_address1 ship_address2
6445 ship_city ship_state ship_zip ship_country
6446 payinfo paycvv paydate
6449 svc_acct.username svc_acct._password
6452 } elsif ( $format eq 'svc_external' ) {
6453 @fields = qw( agent_custid refnum
6454 last first company address1 address2 city state zip country
6456 ship_last ship_first ship_company ship_address1 ship_address2
6457 ship_city ship_state ship_zip ship_country
6458 payinfo paycvv paydate
6460 cust_pkg.pkgpart cust_pkg.bill
6461 svc_external.id svc_external.title
6465 die "unknown format $format";
6471 if ( $type eq 'csv' ) {
6473 eval "use Text::CSV_XS;";
6476 $parser = new Text::CSV_XS;
6478 @buffer = split(/\r?\n/, slurp($filename) );
6479 $count = scalar(@buffer);
6481 } elsif ( $type eq 'xls' ) {
6483 eval "use Spreadsheet::ParseExcel;";
6486 my $excel = new Spreadsheet::ParseExcel::Workbook->Parse($filename);
6487 $parser = $excel->{Worksheet}[0]; #first sheet
6489 $count = $parser->{MaxRow} || $parser->{MinRow};
6493 die "Unknown file type $type\n";
6498 local $SIG{HUP} = 'IGNORE';
6499 local $SIG{INT} = 'IGNORE';
6500 local $SIG{QUIT} = 'IGNORE';
6501 local $SIG{TERM} = 'IGNORE';
6502 local $SIG{TSTP} = 'IGNORE';
6503 local $SIG{PIPE} = 'IGNORE';
6505 my $oldAutoCommit = $FS::UID::AutoCommit;
6506 local $FS::UID::AutoCommit = 0;
6511 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
6515 if ( $type eq 'csv' ) {
6517 last unless scalar(@buffer);
6518 $line = shift(@buffer);
6520 $parser->parse($line) or do {
6521 $dbh->rollback if $oldAutoCommit;
6522 return "can't parse: ". $parser->error_input();
6524 @columns = $parser->fields();
6526 } elsif ( $type eq 'xls' ) {
6528 last if $row > ($parser->{MaxRow} || $parser->{MinRow});
6530 my @row = @{ $parser->{Cells}[$row] };
6531 @columns = map $_->{Val}, @row;
6534 #warn $z++. ": $_\n" for @columns;
6537 die "Unknown file type $type\n";
6540 #warn join('-',@columns);
6543 custbatch => $custbatch,
6544 agentnum => $agentnum,
6546 country => $conf->config('countrydefault') || 'US',
6547 payby => $payby, #default
6548 paydate => '12/2037', #default
6550 my $billtime = time;
6551 my %cust_pkg = ( pkgpart => $pkgpart );
6553 foreach my $field ( @fields ) {
6555 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
6557 #$cust_pkg{$1} = str2time( shift @$columns );
6558 if ( $1 eq 'pkgpart' ) {
6559 $cust_pkg{$1} = shift @columns;
6560 } elsif ( $1 eq 'setup' ) {
6561 $billtime = str2time(shift @columns);
6563 $cust_pkg{$1} = str2time( shift @columns );
6566 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
6568 $svc_x{$1} = shift @columns;
6570 } elsif ( $field =~ /^svc_external\.(id|title)$/ ) {
6572 $svc_x{$1} = shift @columns;
6576 #refnum interception
6577 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
6579 my $referral = $columns[0];
6580 my %hash = ( 'referral' => $referral,
6581 'agentnum' => $agentnum,
6585 my $part_referral = qsearchs('part_referral', \%hash )
6586 || new FS::part_referral \%hash;
6588 unless ( $part_referral->refnum ) {
6589 my $error = $part_referral->insert;
6591 $dbh->rollback if $oldAutoCommit;
6592 return "can't auto-insert advertising source: $referral: $error";
6596 $columns[0] = $part_referral->refnum;
6599 my $value = shift @columns;
6600 $cust_main{$field} = $value if length($value);
6604 $cust_main{'payby'} = 'CARD'
6605 if defined $cust_main{'payinfo'}
6606 && length $cust_main{'payinfo'};
6608 my $invoicing_list = $cust_main{'invoicing_list'}
6609 ? [ delete $cust_main{'invoicing_list'} ]
6612 my $cust_main = new FS::cust_main ( \%cust_main );
6615 tie my %hash, 'Tie::RefHash'; #this part is important
6617 if ( $cust_pkg{'pkgpart'} ) {
6618 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
6622 if ( $svc_x{'username'} ) {
6623 $svcdb = 'svc_acct';
6624 } elsif ( $svc_x{'id'} || $svc_x{'title'} ) {
6625 $svcdb = 'svc_external';
6628 my $part_pkg = $cust_pkg->part_pkg;
6629 unless ( $part_pkg ) {
6630 $dbh->rollback if $oldAutoCommit;
6631 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
6633 $svc_x{svcpart} = $part_pkg->svcpart( $svcdb );
6634 my $class = "FS::$svcdb";
6635 push @svc_x, $class->new( \%svc_x );
6638 $hash{$cust_pkg} = \@svc_x;
6641 my $error = $cust_main->insert( \%hash, $invoicing_list );
6644 $dbh->rollback if $oldAutoCommit;
6645 return "can't insert customer". ( $line ? " for $line" : '' ). ": $error";
6648 if ( $format eq 'simple' ) {
6650 #false laziness w/bill.cgi
6651 $error = $cust_main->bill( 'time' => $billtime );
6653 $dbh->rollback if $oldAutoCommit;
6654 return "can't bill customer for $line: $error";
6657 $error = $cust_main->apply_payments_and_credits;
6659 $dbh->rollback if $oldAutoCommit;
6660 return "can't bill customer for $line: $error";
6663 $error = $cust_main->collect();
6665 $dbh->rollback if $oldAutoCommit;
6666 return "can't collect customer for $line: $error";
6673 if ( $job && time - $min_sec > $last ) { #progress bar
6674 $job->update_statustext( int(100 * $row / $count) );
6680 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
6682 return "Empty file!" unless $row;
6694 #warn join('-',keys %$param);
6695 my $fh = $param->{filehandle};
6696 my @fields = @{$param->{fields}};
6698 eval "use Text::CSV_XS;";
6701 my $csv = new Text::CSV_XS;
6708 local $SIG{HUP} = 'IGNORE';
6709 local $SIG{INT} = 'IGNORE';
6710 local $SIG{QUIT} = 'IGNORE';
6711 local $SIG{TERM} = 'IGNORE';
6712 local $SIG{TSTP} = 'IGNORE';
6713 local $SIG{PIPE} = 'IGNORE';
6715 my $oldAutoCommit = $FS::UID::AutoCommit;
6716 local $FS::UID::AutoCommit = 0;
6719 #while ( $columns = $csv->getline($fh) ) {
6721 while ( defined($line=<$fh>) ) {
6723 $csv->parse($line) or do {
6724 $dbh->rollback if $oldAutoCommit;
6725 return "can't parse: ". $csv->error_input();
6728 my @columns = $csv->fields();
6729 #warn join('-',@columns);
6732 foreach my $field ( @fields ) {
6733 $row{$field} = shift @columns;
6736 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6737 unless ( $cust_main ) {
6738 $dbh->rollback if $oldAutoCommit;
6739 return "unknown custnum $row{'custnum'}";
6742 if ( $row{'amount'} > 0 ) {
6743 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6745 $dbh->rollback if $oldAutoCommit;
6749 } elsif ( $row{'amount'} < 0 ) {
6750 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6753 $dbh->rollback if $oldAutoCommit;
6763 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6765 return "Empty file!" unless $imported;
6771 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6773 Sends a templated email notification to the customer (see L<Text::Template>).
6775 OPTIONS is a hash and may include
6777 I<from> - the email sender (default is invoice_from)
6779 I<to> - comma-separated scalar or arrayref of recipients
6780 (default is invoicing_list)
6782 I<subject> - The subject line of the sent email notification
6783 (default is "Notice from company_name")
6785 I<extra_fields> - a hashref of name/value pairs which will be substituted
6788 The following variables are vavailable in the template.
6790 I<$first> - the customer first name
6791 I<$last> - the customer last name
6792 I<$company> - the customer company
6793 I<$payby> - a description of the method of payment for the customer
6794 # would be nice to use FS::payby::shortname
6795 I<$payinfo> - the account information used to collect for this customer
6796 I<$expdate> - the expiration of the customer payment in seconds from epoch
6801 my ($customer, $template, %options) = @_;
6803 return unless $conf->exists($template);
6805 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6806 $from = $options{from} if exists($options{from});
6808 my $to = join(',', $customer->invoicing_list_emailonly);
6809 $to = $options{to} if exists($options{to});
6811 my $subject = "Notice from " . $conf->config('company_name')
6812 if $conf->exists('company_name');
6813 $subject = $options{subject} if exists($options{subject});
6815 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6816 SOURCE => [ map "$_\n",
6817 $conf->config($template)]
6819 or die "can't create new Text::Template object: Text::Template::ERROR";
6820 $notify_template->compile()
6821 or die "can't compile template: Text::Template::ERROR";
6823 $FS::notify_template::_template::company_name = $conf->config('company_name');
6824 $FS::notify_template::_template::company_address =
6825 join("\n", $conf->config('company_address') ). "\n";
6827 my $paydate = $customer->paydate || '2037-12-31';
6828 $FS::notify_template::_template::first = $customer->first;
6829 $FS::notify_template::_template::last = $customer->last;
6830 $FS::notify_template::_template::company = $customer->company;
6831 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6832 my $payby = $customer->payby;
6833 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6834 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6836 #credit cards expire at the end of the month/year of their exp date
6837 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6838 $FS::notify_template::_template::payby = 'credit card';
6839 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6840 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6842 }elsif ($payby eq 'COMP') {
6843 $FS::notify_template::_template::payby = 'complimentary account';
6845 $FS::notify_template::_template::payby = 'current method';
6847 $FS::notify_template::_template::expdate = $expire_time;
6849 for (keys %{$options{extra_fields}}){
6851 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6854 send_email(from => $from,
6856 subject => $subject,
6857 body => $notify_template->fill_in( PACKAGE =>
6858 'FS::notify_template::_template' ),
6863 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6865 Generates a templated notification to the customer (see L<Text::Template>).
6867 OPTIONS is a hash and may include
6869 I<extra_fields> - a hashref of name/value pairs which will be substituted
6870 into the template. These values may override values mentioned below
6871 and those from the customer record.
6873 The following variables are available in the template instead of or in addition
6874 to the fields of the customer record.
6876 I<$payby> - a description of the method of payment for the customer
6877 # would be nice to use FS::payby::shortname
6878 I<$payinfo> - the masked account information used to collect for this customer
6879 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6880 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6884 sub generate_letter {
6885 my ($self, $template, %options) = @_;
6887 return unless $conf->exists($template);
6889 my $letter_template = new Text::Template
6891 SOURCE => [ map "$_\n", $conf->config($template)],
6892 DELIMITERS => [ '[@--', '--@]' ],
6894 or die "can't create new Text::Template object: Text::Template::ERROR";
6896 $letter_template->compile()
6897 or die "can't compile template: Text::Template::ERROR";
6899 my %letter_data = map { $_ => $self->$_ } $self->fields;
6900 $letter_data{payinfo} = $self->mask_payinfo;
6902 #my $paydate = $self->paydate || '2037-12-31';
6903 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6905 my $payby = $self->payby;
6906 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6907 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6909 #credit cards expire at the end of the month/year of their exp date
6910 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6911 $letter_data{payby} = 'credit card';
6912 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6913 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6915 }elsif ($payby eq 'COMP') {
6916 $letter_data{payby} = 'complimentary account';
6918 $letter_data{payby} = 'current method';
6920 $letter_data{expdate} = $expire_time;
6922 for (keys %{$options{extra_fields}}){
6923 $letter_data{$_} = $options{extra_fields}->{$_};
6926 unless(exists($letter_data{returnaddress})){
6927 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6928 $self->agent_template)
6930 if ( length($retadd) ) {
6931 $letter_data{returnaddress} = $retadd;
6932 } elsif ( grep /\S/, $conf->config('company_address') ) {
6933 $letter_data{returnaddress} =
6934 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6935 $conf->config('company_address')
6938 $letter_data{returnaddress} = '~';
6942 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6944 $letter_data{company_name} = $conf->config('company_name');
6946 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6947 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6951 ) or die "can't open temp file: $!\n";
6953 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6955 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6959 =item print_ps TEMPLATE
6961 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6967 my $file = $self->generate_letter(@_);
6968 FS::Misc::generate_ps($file);
6971 =item print TEMPLATE
6973 Prints the filled in template.
6975 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6979 sub queueable_print {
6982 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6983 or die "invalid customer number: " . $opt{custvnum};
6985 my $error = $self->print( $opt{template} );
6986 die $error if $error;
6990 my ($self, $template) = (shift, shift);
6991 do_print [ $self->print_ps($template) ];
6994 sub agent_template {
6996 $self->_agent_plandata('agent_templatename');
6999 sub agent_invoice_from {
7001 $self->_agent_plandata('agent_invoice_from');
7004 sub _agent_plandata {
7005 my( $self, $option ) = @_;
7007 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
7008 #agent-specific Conf
7010 use FS::part_event::Condition;
7012 my $agentnum = $self->agentnum;
7015 if ( driver_name =~ /^Pg/i ) {
7017 } elsif ( driver_name =~ /^mysql/i ) {
7020 die "don't know how to use regular expressions in ". driver_name. " databases";
7023 my $part_event_option =
7025 'select' => 'part_event_option.*',
7026 'table' => 'part_event_option',
7028 LEFT JOIN part_event USING ( eventpart )
7029 LEFT JOIN part_event_option AS peo_agentnum
7030 ON ( part_event.eventpart = peo_agentnum.eventpart
7031 AND peo_agentnum.optionname = 'agentnum'
7032 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
7034 LEFT JOIN part_event_option AS peo_cust_bill_age
7035 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
7036 AND peo_cust_bill_age.optionname = 'cust_bill_age'
7039 #'hashref' => { 'optionname' => $option },
7040 #'hashref' => { 'part_event_option.optionname' => $option },
7042 " WHERE part_event_option.optionname = ". dbh->quote($option).
7043 " AND action = 'cust_bill_send_agent' ".
7044 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
7045 " AND peo_agentnum.optionname = 'agentnum' ".
7046 " AND agentnum IS NULL OR agentnum = $agentnum ".
7048 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
7050 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
7052 , part_event.weight".
7056 unless ( $part_event_option ) {
7057 return $self->agent->invoice_template || ''
7058 if $option eq 'agent_templatename';
7062 $part_event_option->optionvalue;
7067 ## actual sub, not a method, designed to be called from the queue.
7068 ## sets up the customer, and calls the bill_and_collect
7069 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
7070 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
7071 $cust_main->bill_and_collect(
7082 The delete method should possibly take an FS::cust_main object reference
7083 instead of a scalar customer number.
7085 Bill and collect options should probably be passed as references instead of a
7088 There should probably be a configuration file with a list of allowed credit
7091 No multiple currency support (probably a larger project than just this module).
7093 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
7095 Birthdates rely on negative epoch values.
7097 The payby for card/check batches is broken. With mixed batching, bad
7100 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
7104 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
7105 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
7106 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.