4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
5 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
6 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 eval "use Time::Local;";
12 die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
13 if $] < 5.006 && !defined($Time::Local::VERSION);
14 #eval "use Time::Local qw(timelocal timelocal_nocheck);";
15 eval "use Time::Local qw(timelocal_nocheck);";
17 use Digest::MD5 qw(md5_base64);
21 use String::Approx qw(amatch);
22 use Business::CreditCard 0.28;
25 use FS::UID qw( getotaker dbh driver_name );
26 use FS::Record qw( qsearchs qsearch dbdef );
27 use FS::Misc qw( send_email generate_ps do_print );
28 use FS::Msgcat qw(gettext);
32 use FS::cust_bill_pkg;
34 use FS::cust_pay_pending;
35 use FS::cust_pay_void;
38 use FS::part_referral;
39 use FS::cust_main_county;
41 use FS::cust_main_invoice;
42 use FS::cust_credit_bill;
43 use FS::cust_bill_pay;
44 use FS::prepay_credit;
47 use FS::part_bill_event qw(due_events);
48 use FS::cust_bill_event;
49 use FS::cust_tax_exempt;
50 use FS::cust_tax_exempt_pkg;
52 use FS::payment_gateway;
53 use FS::agent_payment_gateway;
55 use FS::payinfo_Mixin;
57 @ISA = qw( FS::Record FS::payinfo_Mixin );
59 @EXPORT_OK = qw( smart_search );
61 $realtime_bop_decline_quiet = 0;
63 # 1 is mostly method/subroutine entry and options
64 # 2 traces progress of some operations
65 # 3 is even more information including possibly sensitive data
67 $me = '[FS::cust_main]';
71 $ignore_expired_card = 0;
73 @encrypted_fields = ('payinfo', 'paycvv');
74 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
76 #ask FS::UID to run this stuff for us later
77 #$FS::UID::callback{'FS::cust_main'} = sub {
78 install_callback FS::UID sub {
80 #yes, need it for stuff below (prolly should be cached)
85 my ( $hashref, $cache ) = @_;
86 if ( exists $hashref->{'pkgnum'} ) {
87 #@{ $self->{'_pkgnum'} } = ();
88 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
89 $self->{'_pkgnum'} = $subcache;
90 #push @{ $self->{'_pkgnum'} },
91 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
97 FS::cust_main - Object methods for cust_main records
103 $record = new FS::cust_main \%hash;
104 $record = new FS::cust_main { 'column' => 'value' };
106 $error = $record->insert;
108 $error = $new_record->replace($old_record);
110 $error = $record->delete;
112 $error = $record->check;
114 @cust_pkg = $record->all_pkgs;
116 @cust_pkg = $record->ncancelled_pkgs;
118 @cust_pkg = $record->suspended_pkgs;
120 $error = $record->bill;
121 $error = $record->bill %options;
122 $error = $record->bill 'time' => $time;
124 $error = $record->collect;
125 $error = $record->collect %options;
126 $error = $record->collect 'invoice_time' => $time,
131 An FS::cust_main object represents a customer. FS::cust_main inherits from
132 FS::Record. The following fields are currently supported:
136 =item custnum - primary key (assigned automatically for new customers)
138 =item agentnum - agent (see L<FS::agent>)
140 =item refnum - Advertising source (see L<FS::part_referral>)
146 =item ss - social security number (optional)
148 =item company - (optional)
152 =item address2 - (optional)
156 =item county - (optional, see L<FS::cust_main_county>)
158 =item state - (see L<FS::cust_main_county>)
162 =item country - (see L<FS::cust_main_county>)
164 =item daytime - phone (optional)
166 =item night - phone (optional)
168 =item fax - phone (optional)
170 =item ship_first - name
172 =item ship_last - name
174 =item ship_company - (optional)
178 =item ship_address2 - (optional)
182 =item ship_county - (optional, see L<FS::cust_main_county>)
184 =item ship_state - (see L<FS::cust_main_county>)
188 =item ship_country - (see L<FS::cust_main_county>)
190 =item ship_daytime - phone (optional)
192 =item ship_night - phone (optional)
194 =item ship_fax - phone (optional)
196 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
198 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
200 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
204 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
206 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
208 =item paystart_month - start date month (maestro/solo cards only)
210 =item paystart_year - start date year (maestro/solo cards only)
212 =item payissue - issue number (maestro/solo cards only)
214 =item payname - name on card or billing name
216 =item payip - IP address from which payment information was received
218 =item tax - tax exempt, empty or `Y'
220 =item otaker - order taker (assigned automatically, see L<FS::UID>)
222 =item comments - comments (optional)
224 =item referral_custnum - referring customer number
226 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
236 Creates a new customer. To add the customer to the database, see L<"insert">.
238 Note that this stores the hash reference, not a distinct copy of the hash it
239 points to. You can ask the object for a copy with the I<hash> method.
243 sub table { 'cust_main'; }
245 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
247 Adds this customer to the database. If there is an error, returns the error,
248 otherwise returns false.
250 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
251 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
252 are inserted atomicly, or the transaction is rolled back. Passing an empty
253 hash reference is equivalent to not supplying this parameter. There should be
254 a better explanation of this, but until then, here's an example:
257 tie %hash, 'Tie::RefHash'; #this part is important
259 $cust_pkg => [ $svc_acct ],
262 $cust_main->insert( \%hash );
264 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
265 be set as the invoicing list (see L<"invoicing_list">). Errors return as
266 expected and rollback the entire transaction; it is not necessary to call
267 check_invoicing_list first. The invoicing_list is set after the records in the
268 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
269 invoicing_list destination to the newly-created svc_acct. Here's an example:
271 $cust_main->insert( {}, [ $email, 'POST' ] );
273 Currently available options are: I<depend_jobnum> and I<noexport>.
275 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
276 on the supplied jobnum (they will not run until the specific job completes).
277 This can be used to defer provisioning until some action completes (such
278 as running the customer's credit card successfully).
280 The I<noexport> option is deprecated. If I<noexport> is set true, no
281 provisioning jobs (exports) are scheduled. (You can schedule them later with
282 the B<reexport> method.)
288 my $cust_pkgs = @_ ? shift : {};
289 my $invoicing_list = @_ ? shift : '';
291 warn "$me insert called with options ".
292 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
295 local $SIG{HUP} = 'IGNORE';
296 local $SIG{INT} = 'IGNORE';
297 local $SIG{QUIT} = 'IGNORE';
298 local $SIG{TERM} = 'IGNORE';
299 local $SIG{TSTP} = 'IGNORE';
300 local $SIG{PIPE} = 'IGNORE';
302 my $oldAutoCommit = $FS::UID::AutoCommit;
303 local $FS::UID::AutoCommit = 0;
306 my $prepay_identifier = '';
307 my( $amount, $seconds ) = ( 0, 0 );
309 if ( $self->payby eq 'PREPAY' ) {
311 $self->payby('BILL');
312 $prepay_identifier = $self->payinfo;
315 warn " looking up prepaid card $prepay_identifier\n"
318 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
320 $dbh->rollback if $oldAutoCommit;
321 #return "error applying prepaid card (transaction rolled back): $error";
325 $payby = 'PREP' if $amount;
327 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
330 $self->payby('BILL');
331 $amount = $self->paid;
335 warn " inserting $self\n"
338 $self->signupdate(time) unless $self->signupdate;
340 my $error = $self->SUPER::insert;
342 $dbh->rollback if $oldAutoCommit;
343 #return "inserting cust_main record (transaction rolled back): $error";
347 warn " setting invoicing list\n"
350 if ( $invoicing_list ) {
351 $error = $self->check_invoicing_list( $invoicing_list );
353 $dbh->rollback if $oldAutoCommit;
354 #return "checking invoicing_list (transaction rolled back): $error";
357 $self->invoicing_list( $invoicing_list );
360 if ( $conf->config('cust_main-skeleton_tables')
361 && $conf->config('cust_main-skeleton_custnum') ) {
363 warn " inserting skeleton records\n"
366 my $error = $self->start_copy_skel;
368 $dbh->rollback if $oldAutoCommit;
374 warn " ordering packages\n"
377 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
379 $dbh->rollback if $oldAutoCommit;
384 $dbh->rollback if $oldAutoCommit;
385 return "No svc_acct record to apply pre-paid time";
389 warn " inserting initial $payby payment of $amount\n"
391 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
393 $dbh->rollback if $oldAutoCommit;
394 return "inserting payment (transaction rolled back): $error";
398 unless ( $import || $skip_fuzzyfiles ) {
399 warn " queueing fuzzyfiles update\n"
401 $error = $self->queue_fuzzyfiles_update;
403 $dbh->rollback if $oldAutoCommit;
404 return "updating fuzzy search cache: $error";
408 warn " insert complete; committing transaction\n"
411 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
416 sub start_copy_skel {
419 #'mg_user_preference' => {},
420 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
421 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
422 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
423 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
424 my @tables = eval($conf->config_binary('cust_main-skeleton_tables'));
427 _copy_skel( 'cust_main', #tablename
428 $conf->config('cust_main-skeleton_custnum'), #sourceid
429 $self->custnum, #destid
430 @tables, #child tables
434 #recursive subroutine, not a method
436 my( $table, $sourceid, $destid, %child_tables ) = @_;
439 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
440 ( $table, $primary_key ) = ( $1, $2 );
442 my $dbdef_table = dbdef->table($table);
443 $primary_key = $dbdef_table->primary_key
444 or return "$table has no primary key".
445 " (or do you need to run dbdef-create?)";
448 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
449 join (', ', keys %child_tables). "\n"
452 foreach my $child_table_def ( keys %child_tables ) {
456 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
457 ( $child_table, $child_pkey ) = ( $1, $2 );
459 $child_table = $child_table_def;
461 $child_pkey = dbdef->table($child_table)->primary_key;
462 # or return "$table has no primary key".
463 # " (or do you need to run dbdef-create?)\n";
467 if ( keys %{ $child_tables{$child_table_def} } ) {
469 return "$child_table has no primary key".
470 " (run dbdef-create or try specifying it?)\n"
473 #false laziness w/Record::insert and only works on Pg
474 #refactor the proper last-inserted-id stuff out of Record::insert if this
475 # ever gets use for anything besides a quick kludge for one customer
476 my $default = dbdef->table($child_table)->column($child_pkey)->default;
477 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
478 or return "can't parse $child_table.$child_pkey default value ".
479 " for sequence name: $default";
484 my @sel_columns = grep { $_ ne $primary_key }
485 dbdef->table($child_table)->columns;
486 my $sel_columns = join(', ', @sel_columns );
488 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
489 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
490 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
492 my $sel_st = "SELECT $sel_columns FROM $child_table".
493 " WHERE $primary_key = $sourceid";
496 my $sel_sth = dbh->prepare( $sel_st )
497 or return dbh->errstr;
499 $sel_sth->execute or return $sel_sth->errstr;
501 while ( my $row = $sel_sth->fetchrow_hashref ) {
503 warn " selected row: ".
504 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
508 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
509 my $ins_sth =dbh->prepare($statement)
510 or return dbh->errstr;
511 my @param = ( $destid, map $row->{$_}, @ins_columns );
512 warn " $statement: [ ". join(', ', @param). " ]\n"
514 $ins_sth->execute( @param )
515 or return $ins_sth->errstr;
517 #next unless keys %{ $child_tables{$child_table} };
518 next unless $sequence;
520 #another section of that laziness
521 my $seq_sql = "SELECT currval('$sequence')";
522 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
523 $seq_sth->execute or return $seq_sth->errstr;
524 my $insertid = $seq_sth->fetchrow_arrayref->[0];
526 # don't drink soap! recurse! recurse! okay!
528 _copy_skel( $child_table_def,
529 $row->{$child_pkey}, #sourceid
531 %{ $child_tables{$child_table_def} },
533 return $error if $error;
543 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
545 Like the insert method on an existing record, this method orders a package
546 and included services atomicaly. Pass a Tie::RefHash data structure to this
547 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
548 be a better explanation of this, but until then, here's an example:
551 tie %hash, 'Tie::RefHash'; #this part is important
553 $cust_pkg => [ $svc_acct ],
556 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
558 Services can be new, in which case they are inserted, or existing unaudited
559 services, in which case they are linked to the newly-created package.
561 Currently available options are: I<depend_jobnum> and I<noexport>.
563 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
564 on the supplied jobnum (they will not run until the specific job completes).
565 This can be used to defer provisioning until some action completes (such
566 as running the customer's credit card successfully).
568 The I<noexport> option is deprecated. If I<noexport> is set true, no
569 provisioning jobs (exports) are scheduled. (You can schedule them later with
570 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
571 on the cust_main object is not recommended, as existing services will also be
578 my $cust_pkgs = shift;
581 my %svc_options = ();
582 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
583 if exists $options{'depend_jobnum'};
584 warn "$me order_pkgs called with options ".
585 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
588 local $SIG{HUP} = 'IGNORE';
589 local $SIG{INT} = 'IGNORE';
590 local $SIG{QUIT} = 'IGNORE';
591 local $SIG{TERM} = 'IGNORE';
592 local $SIG{TSTP} = 'IGNORE';
593 local $SIG{PIPE} = 'IGNORE';
595 my $oldAutoCommit = $FS::UID::AutoCommit;
596 local $FS::UID::AutoCommit = 0;
599 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
601 foreach my $cust_pkg ( keys %$cust_pkgs ) {
602 $cust_pkg->custnum( $self->custnum );
603 my $error = $cust_pkg->insert;
605 $dbh->rollback if $oldAutoCommit;
606 return "inserting cust_pkg (transaction rolled back): $error";
608 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
609 if ( $svc_something->svcnum ) {
610 my $old_cust_svc = $svc_something->cust_svc;
611 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
612 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
613 $error = $new_cust_svc->replace($old_cust_svc);
615 $svc_something->pkgnum( $cust_pkg->pkgnum );
616 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
617 $svc_something->seconds( $svc_something->seconds + $$seconds );
620 $error = $svc_something->insert(%svc_options);
623 $dbh->rollback if $oldAutoCommit;
624 #return "inserting svc_ (transaction rolled back): $error";
630 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
634 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
636 Recharges this (existing) customer with the specified prepaid card (see
637 L<FS::prepay_credit>), specified either by I<identifier> or as an
638 FS::prepay_credit object. If there is an error, returns the error, otherwise
641 Optionally, four scalar references can be passed as well. They will have their
642 values filled in with the amount, number of seconds, and number of upload and
643 download bytes applied by this prepaid
648 sub recharge_prepay {
649 my( $self, $prepay_credit, $amountref, $secondsref,
650 $upbytesref, $downbytesref, $totalbytesref ) = @_;
652 local $SIG{HUP} = 'IGNORE';
653 local $SIG{INT} = 'IGNORE';
654 local $SIG{QUIT} = 'IGNORE';
655 local $SIG{TERM} = 'IGNORE';
656 local $SIG{TSTP} = 'IGNORE';
657 local $SIG{PIPE} = 'IGNORE';
659 my $oldAutoCommit = $FS::UID::AutoCommit;
660 local $FS::UID::AutoCommit = 0;
663 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
665 my $error = $self->get_prepay($prepay_credit, \$amount,
666 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
667 || $self->increment_seconds($seconds)
668 || $self->increment_upbytes($upbytes)
669 || $self->increment_downbytes($downbytes)
670 || $self->increment_totalbytes($totalbytes)
671 || $self->insert_cust_pay_prepay( $amount,
673 ? $prepay_credit->identifier
678 $dbh->rollback if $oldAutoCommit;
682 if ( defined($amountref) ) { $$amountref = $amount; }
683 if ( defined($secondsref) ) { $$secondsref = $seconds; }
684 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
685 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
686 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
688 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
693 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
695 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
696 specified either by I<identifier> or as an FS::prepay_credit object.
698 References to I<amount> and I<seconds> scalars should be passed as arguments
699 and will be incremented by the values of the prepaid card.
701 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
702 check or set this customer's I<agentnum>.
704 If there is an error, returns the error, otherwise returns false.
710 my( $self, $prepay_credit, $amountref, $secondsref,
711 $upref, $downref, $totalref) = @_;
713 local $SIG{HUP} = 'IGNORE';
714 local $SIG{INT} = 'IGNORE';
715 local $SIG{QUIT} = 'IGNORE';
716 local $SIG{TERM} = 'IGNORE';
717 local $SIG{TSTP} = 'IGNORE';
718 local $SIG{PIPE} = 'IGNORE';
720 my $oldAutoCommit = $FS::UID::AutoCommit;
721 local $FS::UID::AutoCommit = 0;
724 unless ( ref($prepay_credit) ) {
726 my $identifier = $prepay_credit;
728 $prepay_credit = qsearchs(
730 { 'identifier' => $prepay_credit },
735 unless ( $prepay_credit ) {
736 $dbh->rollback if $oldAutoCommit;
737 return "Invalid prepaid card: ". $identifier;
742 if ( $prepay_credit->agentnum ) {
743 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
744 $dbh->rollback if $oldAutoCommit;
745 return "prepaid card not valid for agent ". $self->agentnum;
747 $self->agentnum($prepay_credit->agentnum);
750 my $error = $prepay_credit->delete;
752 $dbh->rollback if $oldAutoCommit;
753 return "removing prepay_credit (transaction rolled back): $error";
756 $$amountref += $prepay_credit->amount;
757 $$secondsref += $prepay_credit->seconds;
758 $$upref += $prepay_credit->upbytes;
759 $$downref += $prepay_credit->downbytes;
760 $$totalref += $prepay_credit->totalbytes;
762 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
767 =item increment_upbytes SECONDS
769 Updates this customer's single or primary account (see L<FS::svc_acct>) by
770 the specified number of upbytes. If there is an error, returns the error,
771 otherwise returns false.
775 sub increment_upbytes {
776 _increment_column( shift, 'upbytes', @_);
779 =item increment_downbytes SECONDS
781 Updates this customer's single or primary account (see L<FS::svc_acct>) by
782 the specified number of downbytes. If there is an error, returns the error,
783 otherwise returns false.
787 sub increment_downbytes {
788 _increment_column( shift, 'downbytes', @_);
791 =item increment_totalbytes SECONDS
793 Updates this customer's single or primary account (see L<FS::svc_acct>) by
794 the specified number of totalbytes. If there is an error, returns the error,
795 otherwise returns false.
799 sub increment_totalbytes {
800 _increment_column( shift, 'totalbytes', @_);
803 =item increment_seconds SECONDS
805 Updates this customer's single or primary account (see L<FS::svc_acct>) by
806 the specified number of seconds. If there is an error, returns the error,
807 otherwise returns false.
811 sub increment_seconds {
812 _increment_column( shift, 'seconds', @_);
815 =item _increment_column AMOUNT
817 Updates this customer's single or primary account (see L<FS::svc_acct>) by
818 the specified number of seconds or bytes. If there is an error, returns
819 the error, otherwise returns false.
823 sub _increment_column {
824 my( $self, $column, $amount ) = @_;
825 warn "$me increment_column called: $column, $amount\n"
828 return '' unless $amount;
830 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
831 $self->ncancelled_pkgs;
834 return 'No packages with primary or single services found'.
835 ' to apply pre-paid time';
836 } elsif ( scalar(@cust_pkg) > 1 ) {
837 #maybe have a way to specify the package/account?
838 return 'Multiple packages found to apply pre-paid time';
841 my $cust_pkg = $cust_pkg[0];
842 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
846 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
849 return 'No account found to apply pre-paid time';
850 } elsif ( scalar(@cust_svc) > 1 ) {
851 return 'Multiple accounts found to apply pre-paid time';
854 my $svc_acct = $cust_svc[0]->svc_x;
855 warn " found service svcnum ". $svc_acct->pkgnum.
856 ' ('. $svc_acct->email. ")\n"
859 $column = "increment_$column";
860 $svc_acct->$column($amount);
864 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
866 Inserts a prepayment in the specified amount for this customer. An optional
867 second argument can specify the prepayment identifier for tracking purposes.
868 If there is an error, returns the error, otherwise returns false.
872 sub insert_cust_pay_prepay {
873 shift->insert_cust_pay('PREP', @_);
876 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
878 Inserts a cash payment in the specified amount for this customer. An optional
879 second argument can specify the payment identifier for tracking purposes.
880 If there is an error, returns the error, otherwise returns false.
884 sub insert_cust_pay_cash {
885 shift->insert_cust_pay('CASH', @_);
888 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
890 Inserts a Western Union payment in the specified amount for this customer. An
891 optional second argument can specify the prepayment identifier for tracking
892 purposes. If there is an error, returns the error, otherwise returns false.
896 sub insert_cust_pay_west {
897 shift->insert_cust_pay('WEST', @_);
900 sub insert_cust_pay {
901 my( $self, $payby, $amount ) = splice(@_, 0, 3);
902 my $payinfo = scalar(@_) ? shift : '';
904 my $cust_pay = new FS::cust_pay {
905 'custnum' => $self->custnum,
906 'paid' => sprintf('%.2f', $amount),
907 #'_date' => #date the prepaid card was purchased???
909 'payinfo' => $payinfo,
917 This method is deprecated. See the I<depend_jobnum> option to the insert and
918 order_pkgs methods for a better way to defer provisioning.
920 Re-schedules all exports by calling the B<reexport> method of all associated
921 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
922 otherwise returns false.
929 carp "WARNING: FS::cust_main::reexport is deprectated; ".
930 "use the depend_jobnum option to insert or order_pkgs to delay export";
932 local $SIG{HUP} = 'IGNORE';
933 local $SIG{INT} = 'IGNORE';
934 local $SIG{QUIT} = 'IGNORE';
935 local $SIG{TERM} = 'IGNORE';
936 local $SIG{TSTP} = 'IGNORE';
937 local $SIG{PIPE} = 'IGNORE';
939 my $oldAutoCommit = $FS::UID::AutoCommit;
940 local $FS::UID::AutoCommit = 0;
943 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
944 my $error = $cust_pkg->reexport;
946 $dbh->rollback if $oldAutoCommit;
951 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
956 =item delete NEW_CUSTNUM
958 This deletes the customer. If there is an error, returns the error, otherwise
961 This will completely remove all traces of the customer record. This is not
962 what you want when a customer cancels service; for that, cancel all of the
963 customer's packages (see L</cancel>).
965 If the customer has any uncancelled packages, you need to pass a new (valid)
966 customer number for those packages to be transferred to. Cancelled packages
967 will be deleted. Did I mention that this is NOT what you want when a customer
968 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
970 You can't delete a customer with invoices (see L<FS::cust_bill>),
971 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
972 refunds (see L<FS::cust_refund>).
979 local $SIG{HUP} = 'IGNORE';
980 local $SIG{INT} = 'IGNORE';
981 local $SIG{QUIT} = 'IGNORE';
982 local $SIG{TERM} = 'IGNORE';
983 local $SIG{TSTP} = 'IGNORE';
984 local $SIG{PIPE} = 'IGNORE';
986 my $oldAutoCommit = $FS::UID::AutoCommit;
987 local $FS::UID::AutoCommit = 0;
990 if ( $self->cust_bill ) {
991 $dbh->rollback if $oldAutoCommit;
992 return "Can't delete a customer with invoices";
994 if ( $self->cust_credit ) {
995 $dbh->rollback if $oldAutoCommit;
996 return "Can't delete a customer with credits";
998 if ( $self->cust_pay ) {
999 $dbh->rollback if $oldAutoCommit;
1000 return "Can't delete a customer with payments";
1002 if ( $self->cust_refund ) {
1003 $dbh->rollback if $oldAutoCommit;
1004 return "Can't delete a customer with refunds";
1007 my @cust_pkg = $self->ncancelled_pkgs;
1009 my $new_custnum = shift;
1010 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1011 $dbh->rollback if $oldAutoCommit;
1012 return "Invalid new customer number: $new_custnum";
1014 foreach my $cust_pkg ( @cust_pkg ) {
1015 my %hash = $cust_pkg->hash;
1016 $hash{'custnum'} = $new_custnum;
1017 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1018 my $error = $new_cust_pkg->replace($cust_pkg,
1019 options => { $cust_pkg->options },
1022 $dbh->rollback if $oldAutoCommit;
1027 my @cancelled_cust_pkg = $self->all_pkgs;
1028 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1029 my $error = $cust_pkg->delete;
1031 $dbh->rollback if $oldAutoCommit;
1036 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1037 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1039 my $error = $cust_main_invoice->delete;
1041 $dbh->rollback if $oldAutoCommit;
1046 my $error = $self->SUPER::delete;
1048 $dbh->rollback if $oldAutoCommit;
1052 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1057 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1059 Replaces the OLD_RECORD with this one in the database. If there is an error,
1060 returns the error, otherwise returns false.
1062 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1063 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1064 expected and rollback the entire transaction; it is not necessary to call
1065 check_invoicing_list first. Here's an example:
1067 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1075 warn "$me replace called\n"
1078 local $SIG{HUP} = 'IGNORE';
1079 local $SIG{INT} = 'IGNORE';
1080 local $SIG{QUIT} = 'IGNORE';
1081 local $SIG{TERM} = 'IGNORE';
1082 local $SIG{TSTP} = 'IGNORE';
1083 local $SIG{PIPE} = 'IGNORE';
1085 # We absolutely have to have an old vs. new record to make this work.
1086 if (!defined($old)) {
1087 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1090 my $curuser = $FS::CurrentUser::CurrentUser;
1091 if ( $self->payby eq 'COMP'
1092 && $self->payby ne $old->payby
1093 && ! $curuser->access_right('Complimentary customer')
1096 return "You are not permitted to create complimentary accounts.";
1099 local($ignore_expired_card) = 1
1100 if $old->payby =~ /^(CARD|DCRD)$/
1101 && $self->payby =~ /^(CARD|DCRD)$/
1102 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1104 my $oldAutoCommit = $FS::UID::AutoCommit;
1105 local $FS::UID::AutoCommit = 0;
1108 my $error = $self->SUPER::replace($old);
1111 $dbh->rollback if $oldAutoCommit;
1115 if ( @param ) { # INVOICING_LIST_ARYREF
1116 my $invoicing_list = shift @param;
1117 $error = $self->check_invoicing_list( $invoicing_list );
1119 $dbh->rollback if $oldAutoCommit;
1122 $self->invoicing_list( $invoicing_list );
1125 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1126 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1127 # card/check/lec info has changed, want to retry realtime_ invoice events
1128 my $error = $self->retry_realtime;
1130 $dbh->rollback if $oldAutoCommit;
1135 unless ( $import || $skip_fuzzyfiles ) {
1136 $error = $self->queue_fuzzyfiles_update;
1138 $dbh->rollback if $oldAutoCommit;
1139 return "updating fuzzy search cache: $error";
1143 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1148 =item queue_fuzzyfiles_update
1150 Used by insert & replace to update the fuzzy search cache
1154 sub queue_fuzzyfiles_update {
1157 local $SIG{HUP} = 'IGNORE';
1158 local $SIG{INT} = 'IGNORE';
1159 local $SIG{QUIT} = 'IGNORE';
1160 local $SIG{TERM} = 'IGNORE';
1161 local $SIG{TSTP} = 'IGNORE';
1162 local $SIG{PIPE} = 'IGNORE';
1164 my $oldAutoCommit = $FS::UID::AutoCommit;
1165 local $FS::UID::AutoCommit = 0;
1168 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1169 my $error = $queue->insert( map $self->getfield($_),
1170 qw(first last company)
1173 $dbh->rollback if $oldAutoCommit;
1174 return "queueing job (transaction rolled back): $error";
1177 if ( $self->ship_last ) {
1178 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1179 $error = $queue->insert( map $self->getfield("ship_$_"),
1180 qw(first last company)
1183 $dbh->rollback if $oldAutoCommit;
1184 return "queueing job (transaction rolled back): $error";
1188 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1195 Checks all fields to make sure this is a valid customer record. If there is
1196 an error, returns the error, otherwise returns false. Called by the insert
1197 and replace methods.
1204 warn "$me check BEFORE: \n". $self->_dump
1208 $self->ut_numbern('custnum')
1209 || $self->ut_number('agentnum')
1210 || $self->ut_textn('agent_custid')
1211 || $self->ut_number('refnum')
1212 || $self->ut_name('last')
1213 || $self->ut_name('first')
1214 || $self->ut_snumbern('birthdate')
1215 || $self->ut_snumbern('signupdate')
1216 || $self->ut_textn('company')
1217 || $self->ut_text('address1')
1218 || $self->ut_textn('address2')
1219 || $self->ut_text('city')
1220 || $self->ut_textn('county')
1221 || $self->ut_textn('state')
1222 || $self->ut_country('country')
1223 || $self->ut_anything('comments')
1224 || $self->ut_numbern('referral_custnum')
1225 || $self->ut_textn('stateid')
1226 || $self->ut_textn('stateid_state')
1228 #barf. need message catalogs. i18n. etc.
1229 $error .= "Please select an advertising source."
1230 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231 return $error if $error;
1233 return "Unknown agent"
1234 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1236 return "Unknown refnum"
1237 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1239 return "Unknown referring custnum: ". $self->referral_custnum
1240 unless ! $self->referral_custnum
1241 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1243 if ( $self->ss eq '' ) {
1248 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249 or return "Illegal social security number: ". $self->ss;
1250 $self->ss("$1-$2-$3");
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 # unless ( $import ) {
1256 unless ( qsearch('cust_main_county', {
1257 'country' => $self->country,
1260 return "Unknown state/county/country: ".
1261 $self->state. "/". $self->county. "/". $self->country
1262 unless qsearch('cust_main_county',{
1263 'state' => $self->state,
1264 'county' => $self->county,
1265 'country' => $self->country,
1271 $self->ut_phonen('daytime', $self->country)
1272 || $self->ut_phonen('night', $self->country)
1273 || $self->ut_phonen('fax', $self->country)
1274 || $self->ut_zip('zip', $self->country)
1276 return $error if $error;
1278 if ( $conf->exists('cust_main-require_phone')
1279 && ! length($self->daytime) && ! length($self->night)
1282 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1284 : FS::Msgcat::_gettext('daytime');
1285 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1287 : FS::Msgcat::_gettext('night');
1289 return "$daytime_label or $night_label is required"
1293 if ( $self->has_ship_address
1294 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1295 $self->addr_fields )
1299 $self->ut_name('ship_last')
1300 || $self->ut_name('ship_first')
1301 || $self->ut_textn('ship_company')
1302 || $self->ut_text('ship_address1')
1303 || $self->ut_textn('ship_address2')
1304 || $self->ut_text('ship_city')
1305 || $self->ut_textn('ship_county')
1306 || $self->ut_textn('ship_state')
1307 || $self->ut_country('ship_country')
1309 return $error if $error;
1311 #false laziness with above
1312 unless ( qsearchs('cust_main_county', {
1313 'country' => $self->ship_country,
1316 return "Unknown ship_state/ship_county/ship_country: ".
1317 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1318 unless qsearch('cust_main_county',{
1319 'state' => $self->ship_state,
1320 'county' => $self->ship_county,
1321 'country' => $self->ship_country,
1327 $self->ut_phonen('ship_daytime', $self->ship_country)
1328 || $self->ut_phonen('ship_night', $self->ship_country)
1329 || $self->ut_phonen('ship_fax', $self->ship_country)
1330 || $self->ut_zip('ship_zip', $self->ship_country)
1332 return $error if $error;
1334 return "Unit # is required."
1335 if $self->ship_address2 =~ /^\s*$/
1336 && $conf->exists('cust_main-require_address2');
1338 } else { # ship_ info eq billing info, so don't store dup info in database
1340 $self->setfield("ship_$_", '')
1341 foreach $self->addr_fields;
1343 return "Unit # is required."
1344 if $self->address2 =~ /^\s*$/
1345 && $conf->exists('cust_main-require_address2');
1349 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1350 # or return "Illegal payby: ". $self->payby;
1352 FS::payby->can_payby($self->table, $self->payby)
1353 or return "Illegal payby: ". $self->payby;
1355 $error = $self->ut_numbern('paystart_month')
1356 || $self->ut_numbern('paystart_year')
1357 || $self->ut_numbern('payissue')
1358 || $self->ut_textn('paytype')
1360 return $error if $error;
1362 if ( $self->payip eq '' ) {
1365 $error = $self->ut_ip('payip');
1366 return $error if $error;
1369 # If it is encrypted and the private key is not availaible then we can't
1370 # check the credit card.
1372 my $check_payinfo = 1;
1374 if ($self->is_encrypted($self->payinfo)) {
1378 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1380 my $payinfo = $self->payinfo;
1381 $payinfo =~ s/\D//g;
1382 $payinfo =~ /^(\d{13,16})$/
1383 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1385 $self->payinfo($payinfo);
1387 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1389 return gettext('unknown_card_type')
1390 if cardtype($self->payinfo) eq "Unknown";
1392 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1394 return 'Banned credit card: banned on '.
1395 time2str('%a %h %o at %r', $ban->_date).
1396 ' by '. $ban->otaker.
1397 ' (ban# '. $ban->bannum. ')';
1400 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1401 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1402 $self->paycvv =~ /^(\d{4})$/
1403 or return "CVV2 (CID) for American Express cards is four digits.";
1406 $self->paycvv =~ /^(\d{3})$/
1407 or return "CVV2 (CVC2/CID) is three digits.";
1414 my $cardtype = cardtype($payinfo);
1415 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1417 return "Start date or issue number is required for $cardtype cards"
1418 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1420 return "Start month must be between 1 and 12"
1421 if $self->paystart_month
1422 and $self->paystart_month < 1 || $self->paystart_month > 12;
1424 return "Start year must be 1990 or later"
1425 if $self->paystart_year
1426 and $self->paystart_year < 1990;
1428 return "Issue number must be beween 1 and 99"
1430 and $self->payissue < 1 || $self->payissue > 99;
1433 $self->paystart_month('');
1434 $self->paystart_year('');
1435 $self->payissue('');
1438 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1440 my $payinfo = $self->payinfo;
1441 $payinfo =~ s/[^\d\@]//g;
1442 if ( $conf->exists('echeck-nonus') ) {
1443 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1444 $payinfo = "$1\@$2";
1446 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1447 $payinfo = "$1\@$2";
1449 $self->payinfo($payinfo);
1452 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1454 return 'Banned ACH account: banned on '.
1455 time2str('%a %h %o at %r', $ban->_date).
1456 ' by '. $ban->otaker.
1457 ' (ban# '. $ban->bannum. ')';
1460 } elsif ( $self->payby eq 'LECB' ) {
1462 my $payinfo = $self->payinfo;
1463 $payinfo =~ s/\D//g;
1464 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1466 $self->payinfo($payinfo);
1469 } elsif ( $self->payby eq 'BILL' ) {
1471 $error = $self->ut_textn('payinfo');
1472 return "Illegal P.O. number: ". $self->payinfo if $error;
1475 } elsif ( $self->payby eq 'COMP' ) {
1477 my $curuser = $FS::CurrentUser::CurrentUser;
1478 if ( ! $self->custnum
1479 && ! $curuser->access_right('Complimentary customer')
1482 return "You are not permitted to create complimentary accounts."
1485 $error = $self->ut_textn('payinfo');
1486 return "Illegal comp account issuer: ". $self->payinfo if $error;
1489 } elsif ( $self->payby eq 'PREPAY' ) {
1491 my $payinfo = $self->payinfo;
1492 $payinfo =~ s/\W//g; #anything else would just confuse things
1493 $self->payinfo($payinfo);
1494 $error = $self->ut_alpha('payinfo');
1495 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1496 return "Unknown prepayment identifier"
1497 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1502 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1503 return "Expiration date required"
1504 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1508 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1509 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1510 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1511 ( $m, $y ) = ( $3, "20$2" );
1513 return "Illegal expiration date: ". $self->paydate;
1515 $self->paydate("$y-$m-01");
1516 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1517 return gettext('expired_card')
1519 && !$ignore_expired_card
1520 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1523 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1524 ( ! $conf->exists('require_cardname')
1525 || $self->payby !~ /^(CARD|DCRD)$/ )
1527 $self->payname( $self->first. " ". $self->getfield('last') );
1529 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1530 or return gettext('illegal_name'). " payname: ". $self->payname;
1534 foreach my $flag (qw( tax spool_cdr )) {
1535 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1539 $self->otaker(getotaker) unless $self->otaker;
1541 warn "$me check AFTER: \n". $self->_dump
1544 $self->SUPER::check;
1549 Returns a list of fields which have ship_ duplicates.
1554 qw( last first company
1555 address1 address2 city county state zip country
1560 =item has_ship_address
1562 Returns true if this customer record has a separate shipping address.
1566 sub has_ship_address {
1568 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1573 Returns all packages (see L<FS::cust_pkg>) for this customer.
1580 return $self->num_pkgs unless wantarray;
1583 if ( $self->{'_pkgnum'} ) {
1584 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1586 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1589 sort sort_packages @cust_pkg;
1592 =item ncancelled_pkgs
1594 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1598 sub ncancelled_pkgs {
1601 return $self->num_ncancelled_pkgs unless wantarray;
1604 if ( $self->{'_pkgnum'} ) {
1606 @cust_pkg = grep { ! $_->getfield('cancel') }
1607 values %{ $self->{'_pkgnum'}->cache };
1612 qsearch( 'cust_pkg', {
1613 'custnum' => $self->custnum,
1617 qsearch( 'cust_pkg', {
1618 'custnum' => $self->custnum,
1623 sort sort_packages @cust_pkg;
1627 # This should be generalized to use config options to determine order.
1629 if ( $a->get('cancel') and $b->get('cancel') ) {
1630 $a->pkgnum <=> $b->pkgnum;
1631 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1632 return -1 if $b->get('cancel');
1633 return 1 if $a->get('cancel');
1636 $a->pkgnum <=> $b->pkgnum;
1640 =item suspended_pkgs
1642 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1646 sub suspended_pkgs {
1648 grep { $_->susp } $self->ncancelled_pkgs;
1651 =item unflagged_suspended_pkgs
1653 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1654 customer (thouse packages without the `manual_flag' set).
1658 sub unflagged_suspended_pkgs {
1660 return $self->suspended_pkgs
1661 unless dbdef->table('cust_pkg')->column('manual_flag');
1662 grep { ! $_->manual_flag } $self->suspended_pkgs;
1665 =item unsuspended_pkgs
1667 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1672 sub unsuspended_pkgs {
1674 grep { ! $_->susp } $self->ncancelled_pkgs;
1677 =item num_cancelled_pkgs
1679 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1684 sub num_cancelled_pkgs {
1685 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1688 sub num_ncancelled_pkgs {
1689 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1693 my( $self ) = shift;
1694 my $sql = scalar(@_) ? shift : '';
1695 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1696 my $sth = dbh->prepare(
1697 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1698 ) or die dbh->errstr;
1699 $sth->execute($self->custnum) or die $sth->errstr;
1700 $sth->fetchrow_arrayref->[0];
1705 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1706 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1707 on success or a list of errors.
1713 grep { $_->unsuspend } $self->suspended_pkgs;
1718 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1720 Returns a list: an empty list on success or a list of errors.
1726 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1729 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1731 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1732 PKGPARTs (see L<FS::part_pkg>).
1734 Returns a list: an empty list on success or a list of errors.
1738 sub suspend_if_pkgpart {
1740 my (@pkgparts, %opt);
1741 if (ref($_[0]) eq 'HASH'){
1742 @pkgparts = @{$_[0]{pkgparts}};
1747 grep { $_->suspend(%opt) }
1748 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1749 $self->unsuspended_pkgs;
1752 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1754 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1755 listed PKGPARTs (see L<FS::part_pkg>).
1757 Returns a list: an empty list on success or a list of errors.
1761 sub suspend_unless_pkgpart {
1763 my (@pkgparts, %opt);
1764 if (ref($_[0]) eq 'HASH'){
1765 @pkgparts = @{$_[0]{pkgparts}};
1770 grep { $_->suspend(%opt) }
1771 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1772 $self->unsuspended_pkgs;
1775 =item cancel [ OPTION => VALUE ... ]
1777 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1779 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1781 I<quiet> can be set true to supress email cancellation notices.
1783 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1785 I<ban> can be set true to ban this customer's credit card or ACH information,
1788 Always returns a list: an empty list on success or a list of errors.
1796 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1798 #should try decryption (we might have the private key)
1799 # and if not maybe queue a job for the server that does?
1800 return ( "Can't (yet) ban encrypted credit cards" )
1801 if $self->is_encrypted($self->payinfo);
1803 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1804 my $error = $ban->insert;
1805 return ( $error ) if $error;
1809 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1812 sub _banned_pay_hashref {
1823 'payby' => $payby2ban{$self->payby},
1824 'payinfo' => md5_base64($self->payinfo),
1825 #don't ever *search* on reason! #'reason' =>
1831 Returns all notes (see L<FS::cust_main_note>) for this customer.
1838 qsearch( 'cust_main_note',
1839 { 'custnum' => $self->custnum },
1841 'ORDER BY _DATE DESC'
1847 Returns the agent (see L<FS::agent>) for this customer.
1853 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1858 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1859 conjunction with the collect method.
1861 If there is an error, returns the error, otherwise returns false.
1863 Options are passed as name-value pairs. Currently available options are:
1867 =item resetup - if set true, re-charges setup fees.
1869 =item time - 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:
1873 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1875 =item invoice_time - 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.
1882 my( $self, %options ) = @_;
1883 return '' if $self->payby eq 'COMP';
1884 warn "$me bill customer ". $self->custnum. "\n"
1887 my $time = $options{'time'} || time;
1892 local $SIG{HUP} = 'IGNORE';
1893 local $SIG{INT} = 'IGNORE';
1894 local $SIG{QUIT} = 'IGNORE';
1895 local $SIG{TERM} = 'IGNORE';
1896 local $SIG{TSTP} = 'IGNORE';
1897 local $SIG{PIPE} = 'IGNORE';
1899 my $oldAutoCommit = $FS::UID::AutoCommit;
1900 local $FS::UID::AutoCommit = 0;
1903 $self->select_for_update; #mutex
1905 #create a new invoice
1906 #(we'll remove it later if it doesn't actually need to be generated [contains
1907 # no line items] and we're inside a transaciton so nothing else will see it)
1908 my $cust_bill = new FS::cust_bill ( {
1909 'custnum' => $self->custnum,
1910 '_date' => ( $options{'invoice_time'} || $time ),
1911 #'charged' => $charged,
1914 $error = $cust_bill->insert;
1916 $dbh->rollback if $oldAutoCommit;
1917 return "can't create invoice for customer #". $self->custnum. ": $error";
1919 my $invnum = $cust_bill->invnum;
1922 # find the packages which are due for billing, find out how much they are
1923 # & generate invoice database.
1926 my( $total_setup, $total_recur ) = ( 0, 0 );
1928 my @precommit_hooks = ();
1930 foreach my $cust_pkg (
1931 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1934 #NO!! next if $cust_pkg->cancel;
1935 next if $cust_pkg->getfield('cancel');
1937 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1939 #? to avoid use of uninitialized value errors... ?
1940 $cust_pkg->setfield('bill', '')
1941 unless defined($cust_pkg->bill);
1943 my $part_pkg = $cust_pkg->part_pkg;
1945 my %hash = $cust_pkg->hash;
1946 my $old_cust_pkg = new FS::cust_pkg \%hash;
1955 if ( ! $cust_pkg->setup &&
1957 ( $conf->exists('disable_setup_suspended_pkgs') &&
1958 ! $cust_pkg->getfield('susp')
1959 ) || ! $conf->exists('disable_setup_suspended_pkgs')
1961 || $options{'resetup'}
1964 warn " bill setup\n" if $DEBUG > 1;
1966 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
1968 $dbh->rollback if $oldAutoCommit;
1969 return "$@ running calc_setup for $cust_pkg\n";
1972 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1976 # bill recurring fee
1981 if ( $part_pkg->getfield('freq') ne '0' &&
1982 ! $cust_pkg->getfield('susp') &&
1983 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1986 # XXX should this be a package event? probably. events are called
1987 # at collection time at the moment, though...
1988 if ( $part_pkg->can('reset_usage') ) {
1989 warn " resetting usage counters" if $DEBUG > 1;
1990 $part_pkg->reset_usage($cust_pkg);
1993 warn " bill recur\n" if $DEBUG > 1;
1995 # XXX shared with $recur_prog
1996 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1998 #over two params! lets at least switch to a hashref for the rest...
1999 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2001 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2003 $dbh->rollback if $oldAutoCommit;
2004 return "$@ running calc_recur for $cust_pkg\n";
2007 #change this bit to use Date::Manip? CAREFUL with timezones (see
2008 # mailing list archive)
2009 my ($sec,$min,$hour,$mday,$mon,$year) =
2010 (localtime($sdate) )[0,1,2,3,4,5];
2012 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2013 # only for figuring next bill date, nothing else, so, reset $sdate again
2015 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2016 $cust_pkg->last_bill($sdate);
2018 if ( $part_pkg->freq =~ /^\d+$/ ) {
2019 $mon += $part_pkg->freq;
2020 until ( $mon < 12 ) { $mon -= 12; $year++; }
2021 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2023 $mday += $weeks * 7;
2024 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2027 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2031 $dbh->rollback if $oldAutoCommit;
2032 return "unparsable frequency: ". $part_pkg->freq;
2034 $cust_pkg->setfield('bill',
2035 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2038 warn "\$setup is undefined" unless defined($setup);
2039 warn "\$recur is undefined" unless defined($recur);
2040 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2043 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2046 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2048 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2051 $error=$cust_pkg->replace($old_cust_pkg,
2052 options => { $cust_pkg->options },
2054 if ( $error ) { #just in case
2055 $dbh->rollback if $oldAutoCommit;
2056 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2059 $setup = sprintf( "%.2f", $setup );
2060 $recur = sprintf( "%.2f", $recur );
2061 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2062 $dbh->rollback if $oldAutoCommit;
2063 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2065 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2066 $dbh->rollback if $oldAutoCommit;
2067 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2070 if ( $setup != 0 || $recur != 0 ) {
2072 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2074 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2075 'invnum' => $invnum,
2076 'pkgnum' => $cust_pkg->pkgnum,
2080 'edate' => $cust_pkg->bill,
2081 'details' => \@details,
2083 $error = $cust_bill_pkg->insert;
2085 $dbh->rollback if $oldAutoCommit;
2086 return "can't create invoice line item for invoice #$invnum: $error";
2088 $total_setup += $setup;
2089 $total_recur += $recur;
2095 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2098 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2101 my %taxhash = map { $_ => $self->get("$prefix$_") }
2102 qw( state county country );
2104 $taxhash{'taxclass'} = $part_pkg->taxclass;
2106 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2109 $taxhash{'taxclass'} = '';
2110 @taxes = qsearch( 'cust_main_county', \%taxhash );
2113 #one more try at a whole-country tax rate
2115 $taxhash{$_} = '' foreach qw( state county );
2116 @taxes = qsearch( 'cust_main_county', \%taxhash );
2119 # maybe eliminate this entirely, along with all the 0% records
2121 $dbh->rollback if $oldAutoCommit;
2123 "fatal: can't find tax rate for state/county/country/taxclass ".
2124 join('/', ( map $self->get("$prefix$_"),
2125 qw(state county country)
2127 $part_pkg->taxclass ). "\n";
2130 foreach my $tax ( @taxes ) {
2132 my $taxable_charged = 0;
2133 $taxable_charged += $setup
2134 unless $part_pkg->setuptax =~ /^Y$/i
2135 || $tax->setuptax =~ /^Y$/i;
2136 $taxable_charged += $recur
2137 unless $part_pkg->recurtax =~ /^Y$/i
2138 || $tax->recurtax =~ /^Y$/i;
2139 next unless $taxable_charged;
2141 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2142 #my ($mon,$year) = (localtime($sdate) )[4,5];
2143 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2145 my $freq = $part_pkg->freq || 1;
2146 if ( $freq !~ /(\d+)$/ ) {
2147 $dbh->rollback if $oldAutoCommit;
2148 return "daily/weekly package definitions not (yet?)".
2149 " compatible with monthly tax exemptions";
2151 my $taxable_per_month =
2152 sprintf("%.2f", $taxable_charged / $freq );
2154 #call the whole thing off if this customer has any old
2155 #exemption records...
2156 my @cust_tax_exempt =
2157 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2158 if ( @cust_tax_exempt ) {
2159 $dbh->rollback if $oldAutoCommit;
2161 'this customer still has old-style tax exemption records; '.
2162 'run bin/fs-migrate-cust_tax_exempt?';
2165 foreach my $which_month ( 1 .. $freq ) {
2167 #maintain the new exemption table now
2170 FROM cust_tax_exempt_pkg
2171 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2172 LEFT JOIN cust_bill USING ( invnum )
2178 my $sth = dbh->prepare($sql) or do {
2179 $dbh->rollback if $oldAutoCommit;
2180 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2188 $dbh->rollback if $oldAutoCommit;
2189 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2191 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2193 my $remaining_exemption =
2194 $tax->exempt_amount - $existing_exemption;
2195 if ( $remaining_exemption > 0 ) {
2196 my $addl = $remaining_exemption > $taxable_per_month
2197 ? $taxable_per_month
2198 : $remaining_exemption;
2199 $taxable_charged -= $addl;
2201 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2202 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2203 'taxnum' => $tax->taxnum,
2204 'year' => 1900+$year,
2206 'amount' => sprintf("%.2f", $addl ),
2208 $error = $cust_tax_exempt_pkg->insert;
2210 $dbh->rollback if $oldAutoCommit;
2211 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2213 } # if $remaining_exemption > 0
2217 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2218 until ( $mon < 13 ) { $mon -= 12; $year++; }
2220 } #foreach $which_month
2222 } #if $tax->exempt_amount
2224 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2226 #$tax += $taxable_charged * $cust_main_county->tax / 100
2227 $tax{ $tax->taxname || 'Tax' } +=
2228 $taxable_charged * $tax->tax / 100
2230 } #foreach my $tax ( @taxes )
2232 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2234 } #if $setup != 0 || $recur != 0
2236 } #if $cust_pkg->modified
2238 } #foreach my $cust_pkg
2240 unless ( $cust_bill->cust_bill_pkg ) {
2241 $cust_bill->delete; #don't create an invoice w/o line items
2242 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2246 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2248 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2249 my $tax = sprintf("%.2f", $tax{$taxname} );
2250 $charged = sprintf( "%.2f", $charged+$tax );
2252 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2253 'invnum' => $invnum,
2259 'itemdesc' => $taxname,
2261 $error = $cust_bill_pkg->insert;
2263 $dbh->rollback if $oldAutoCommit;
2264 return "can't create invoice line item for invoice #$invnum: $error";
2266 $total_setup += $tax;
2270 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2271 $error = $cust_bill->replace;
2273 $dbh->rollback if $oldAutoCommit;
2274 return "can't update charged for invoice #$invnum: $error";
2277 foreach my $hook ( @precommit_hooks ) {
2279 &{$hook}; #($self) ?
2282 $dbh->rollback if $oldAutoCommit;
2283 return "$@ running precommit hook $hook\n";
2287 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2291 =item collect OPTIONS
2293 (Attempt to) collect money for this customer's outstanding invoices (see
2294 L<FS::cust_bill>). Usually used after the bill method.
2296 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2297 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2298 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2300 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2301 and the invoice events web interface.
2303 If there is an error, returns the error, otherwise returns false.
2305 Options are passed as name-value pairs.
2307 Currently available options are:
2309 invoice_time - Use this time when deciding when to print invoices and
2310 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>
2311 for conversion functions.
2313 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2316 quiet - set true to surpress email card/ACH decline notices.
2318 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2321 payby - allows for one time override of normal customer billing method
2326 my( $self, %options ) = @_;
2327 my $invoice_time = $options{'invoice_time'} || time;
2330 local $SIG{HUP} = 'IGNORE';
2331 local $SIG{INT} = 'IGNORE';
2332 local $SIG{QUIT} = 'IGNORE';
2333 local $SIG{TERM} = 'IGNORE';
2334 local $SIG{TSTP} = 'IGNORE';
2335 local $SIG{PIPE} = 'IGNORE';
2337 my $oldAutoCommit = $FS::UID::AutoCommit;
2338 local $FS::UID::AutoCommit = 0;
2341 $self->select_for_update; #mutex
2343 my $balance = $self->balance;
2344 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2346 unless ( $balance > 0 ) { #redundant?????
2347 $dbh->rollback if $oldAutoCommit; #hmm
2351 if ( exists($options{'retry_card'}) ) {
2352 carp 'retry_card option passed to collect is deprecated; use retry';
2353 $options{'retry'} ||= $options{'retry_card'};
2355 if ( exists($options{'retry'}) && $options{'retry'} ) {
2356 my $error = $self->retry_realtime;
2358 $dbh->rollback if $oldAutoCommit;
2364 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2365 $extra_sql = " AND freq = '1m' ";
2367 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2370 foreach my $cust_bill ( $self->open_cust_bill ) {
2372 # don't try to charge for the same invoice if it's already in a batch
2373 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2375 last if $self->balance <= 0;
2377 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2380 foreach my $part_bill_event ( due_events ( $cust_bill,
2381 exists($options{'payby'})
2387 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2388 || $self->balance <= 0; # or if balance<=0
2391 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2392 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2395 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2396 # gah, even with transactions.
2397 $dbh->commit if $oldAutoCommit; #well.
2406 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2411 =item retry_realtime
2413 Schedules realtime / batch credit card / electronic check / LEC billing
2414 events for for retry. Useful if card information has changed or manual
2415 retry is desired. The 'collect' method must be called to actually retry
2418 Implementation details: For each of this customer's open invoices, changes
2419 the status of the first "done" (with statustext error) realtime processing
2424 sub retry_realtime {
2427 local $SIG{HUP} = 'IGNORE';
2428 local $SIG{INT} = 'IGNORE';
2429 local $SIG{QUIT} = 'IGNORE';
2430 local $SIG{TERM} = 'IGNORE';
2431 local $SIG{TSTP} = 'IGNORE';
2432 local $SIG{PIPE} = 'IGNORE';
2434 my $oldAutoCommit = $FS::UID::AutoCommit;
2435 local $FS::UID::AutoCommit = 0;
2438 foreach my $cust_bill (
2439 grep { $_->cust_bill_event }
2440 $self->open_cust_bill
2442 my @cust_bill_event =
2443 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2445 #$_->part_bill_event->plan eq 'realtime-card'
2446 $_->part_bill_event->eventcode =~
2447 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2448 && $_->status eq 'done'
2451 $cust_bill->cust_bill_event;
2452 next unless @cust_bill_event;
2453 my $error = $cust_bill_event[0]->retry;
2455 $dbh->rollback if $oldAutoCommit;
2456 return "error scheduling invoice event for retry: $error";
2461 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2466 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2468 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2469 via a Business::OnlinePayment realtime gateway. See
2470 L<http://420.am/business-onlinepayment> for supported gateways.
2472 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2474 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2476 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2477 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2478 if set, will override the value from the customer record.
2480 I<description> is a free-text field passed to the gateway. It defaults to
2481 "Internet services".
2483 If an I<invnum> is specified, this payment (if successful) is applied to the
2484 specified invoice. If you don't specify an I<invnum> you might want to
2485 call the B<apply_payments> method.
2487 I<quiet> can be set true to surpress email decline notices.
2489 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2490 resulting paynum, if any.
2492 I<payunique> is a unique identifier for this payment.
2494 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2501 my( $self, $method, $amount, %options ) = @_;
2503 warn "$me realtime_bop: $method $amount\n";
2504 warn " $_ => $options{$_}\n" foreach keys %options;
2507 $options{'description'} ||= 'Internet services';
2509 eval "use Business::OnlinePayment";
2512 my $payinfo = exists($options{'payinfo'})
2513 ? $options{'payinfo'}
2516 my %method2payby = (
2527 if ( $options{'invnum'} ) {
2528 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2529 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2531 map { $_->part_pkg->taxclass }
2533 map { $_->cust_pkg }
2534 $cust_bill->cust_bill_pkg;
2535 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2536 #different taxclasses
2537 $taxclass = $taxclasses[0];
2541 #look for an agent gateway override first
2543 if ( $method eq 'CC' ) {
2544 $cardtype = cardtype($payinfo);
2545 } elsif ( $method eq 'ECHECK' ) {
2548 $cardtype = $method;
2552 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2553 cardtype => $cardtype,
2554 taxclass => $taxclass, } )
2555 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2557 taxclass => $taxclass, } )
2558 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2559 cardtype => $cardtype,
2561 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2563 taxclass => '', } );
2565 my $payment_gateway = '';
2566 my( $processor, $login, $password, $action, @bop_options );
2567 if ( $override ) { #use a payment gateway override
2569 $payment_gateway = $override->payment_gateway;
2571 $processor = $payment_gateway->gateway_module;
2572 $login = $payment_gateway->gateway_username;
2573 $password = $payment_gateway->gateway_password;
2574 $action = $payment_gateway->gateway_action;
2575 @bop_options = $payment_gateway->options;
2577 } else { #use the standard settings from the config
2579 ( $processor, $login, $password, $action, @bop_options ) =
2580 $self->default_payment_gateway($method);
2588 my $address = exists($options{'address1'})
2589 ? $options{'address1'}
2591 my $address2 = exists($options{'address2'})
2592 ? $options{'address2'}
2594 $address .= ", ". $address2 if length($address2);
2596 my $o_payname = exists($options{'payname'})
2597 ? $options{'payname'}
2599 my($payname, $payfirst, $paylast);
2600 if ( $o_payname && $method ne 'ECHECK' ) {
2601 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2602 or return "Illegal payname $payname";
2603 ($payfirst, $paylast) = ($1, $2);
2605 $payfirst = $self->getfield('first');
2606 $paylast = $self->getfield('last');
2607 $payname = "$payfirst $paylast";
2610 my @invoicing_list = $self->invoicing_list_emailonly;
2611 if ( $conf->exists('emailinvoiceautoalways')
2612 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2613 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2614 push @invoicing_list, $self->all_emails;
2617 my $email = ($conf->exists('business-onlinepayment-email-override'))
2618 ? $conf->config('business-onlinepayment-email-override')
2619 : $invoicing_list[0];
2623 my $payip = exists($options{'payip'})
2626 $content{customer_ip} = $payip
2629 $content{invoice_number} = $options{'invnum'}
2630 if exists($options{'invnum'}) && length($options{'invnum'});
2632 $content{email_customer} =
2633 ( $conf->exists('business-onlinepayment-email_customer')
2634 || $conf->exists('business-onlinepayment-email-override') );
2637 if ( $method eq 'CC' ) {
2639 $content{card_number} = $payinfo;
2640 $paydate = exists($options{'paydate'})
2641 ? $options{'paydate'}
2643 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2644 $content{expiration} = "$2/$1";
2646 my $paycvv = exists($options{'paycvv'})
2647 ? $options{'paycvv'}
2649 $content{cvv2} = $paycvv
2652 my $paystart_month = exists($options{'paystart_month'})
2653 ? $options{'paystart_month'}
2654 : $self->paystart_month;
2656 my $paystart_year = exists($options{'paystart_year'})
2657 ? $options{'paystart_year'}
2658 : $self->paystart_year;
2660 $content{card_start} = "$paystart_month/$paystart_year"
2661 if $paystart_month && $paystart_year;
2663 my $payissue = exists($options{'payissue'})
2664 ? $options{'payissue'}
2666 $content{issue_number} = $payissue if $payissue;
2668 $content{recurring_billing} = 'YES'
2669 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2671 'payinfo' => $payinfo,
2673 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2675 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2679 } elsif ( $method eq 'ECHECK' ) {
2680 ( $content{account_number}, $content{routing_code} ) =
2681 split('@', $payinfo);
2682 $content{bank_name} = $o_payname;
2683 $content{bank_state} = exists($options{'paystate'})
2684 ? $options{'paystate'}
2685 : $self->getfield('paystate');
2686 $content{account_type} = exists($options{'paytype'})
2687 ? uc($options{'paytype'}) || 'CHECKING'
2688 : uc($self->getfield('paytype')) || 'CHECKING';
2689 $content{account_name} = $payname;
2690 $content{customer_org} = $self->company ? 'B' : 'I';
2691 $content{state_id} = exists($options{'stateid'})
2692 ? $options{'stateid'}
2693 : $self->getfield('stateid');
2694 $content{state_id_state} = exists($options{'stateid_state'})
2695 ? $options{'stateid_state'}
2696 : $self->getfield('stateid_state');
2697 $content{customer_ssn} = exists($options{'ss'})
2700 } elsif ( $method eq 'LEC' ) {
2701 $content{phone} = $payinfo;
2705 # run transaction(s)
2708 my $balance = exists( $options{'balance'} )
2709 ? $options{'balance'}
2712 $self->select_for_update; #mutex ... just until we get our pending record in
2714 #the checks here are intended to catch concurrent payments
2715 #double-form-submission prevention is taken care of in cust_pay_pending::check
2718 return "The customer's balance has changed; $method transaction aborted."
2719 if $self->balance < $balance;
2720 #&& $self->balance < $amount; #might as well anyway?
2722 #also check and make sure there aren't *other* pending payments for this cust
2724 my @pending = qsearch('cust_pay_pending', {
2725 'custnum' => $self->custnum,
2726 'status' => { op=>'!=', value=>'done' }
2728 return "A payment is already being processed for this customer (".
2729 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
2730 "); $method transaction aborted."
2731 if scalar(@pending);
2733 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
2735 my $cust_pay_pending = new FS::cust_pay_pending {
2736 'custnum' => $self->custnum,
2737 #'invnum' => $options{'invnum'},
2740 'payby' => $method2payby{$method},
2741 'payinfo' => $payinfo,
2742 'paydate' => $paydate,
2744 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
2746 $cust_pay_pending->payunique( $options{payunique} )
2747 if defined($options{payunique}) && length($options{payunique});
2748 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
2749 return $cpp_new_err if $cpp_new_err;
2751 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2753 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2754 $transaction->content(
2757 'password' => $password,
2758 'action' => $action1,
2759 'description' => $options{'description'},
2760 'amount' => $amount,
2761 #'invoice_number' => $options{'invnum'},
2762 'customer_id' => $self->custnum,
2763 'last_name' => $paylast,
2764 'first_name' => $payfirst,
2766 'address' => $address,
2767 'city' => ( exists($options{'city'})
2770 'state' => ( exists($options{'state'})
2773 'zip' => ( exists($options{'zip'})
2776 'country' => ( exists($options{'country'})
2777 ? $options{'country'}
2779 'referer' => 'http://cleanwhisker.420.am/',
2781 'phone' => $self->daytime || $self->night,
2785 $cust_pay_pending->status('pending');
2786 my $cpp_pending_err = $cust_pay_pending->replace;
2787 return $cpp_pending_err if $cpp_pending_err;
2789 $transaction->submit();
2791 if ( $transaction->is_success() && $action2 ) {
2793 $cust_pay_pending->status('authorized');
2794 my $cpp_authorized_err = $cust_pay_pending->replace;
2795 return $cpp_authorized_err if $cpp_authorized_err;
2797 my $auth = $transaction->authorization;
2798 my $ordernum = $transaction->can('order_number')
2799 ? $transaction->order_number
2803 new Business::OnlinePayment( $processor, @bop_options );
2810 password => $password,
2811 order_number => $ordernum,
2813 authorization => $auth,
2814 description => $options{'description'},
2817 foreach my $field (qw( authorization_source_code returned_ACI
2818 transaction_identifier validation_code
2819 transaction_sequence_num local_transaction_date
2820 local_transaction_time AVS_result_code )) {
2821 $capture{$field} = $transaction->$field() if $transaction->can($field);
2824 $capture->content( %capture );
2828 unless ( $capture->is_success ) {
2829 my $e = "Authorization successful but capture failed, custnum #".
2830 $self->custnum. ': '. $capture->result_code.
2831 ": ". $capture->error_message;
2838 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
2839 my $cpp_captured_err = $cust_pay_pending->replace;
2840 return $cpp_captured_err if $cpp_captured_err;
2843 # remove paycvv after initial transaction
2846 #false laziness w/misc/process/payment.cgi - check both to make sure working
2848 if ( defined $self->dbdef_table->column('paycvv')
2849 && length($self->paycvv)
2850 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2852 my $error = $self->remove_cvv;
2854 warn "WARNING: error removing cvv: $error\n";
2862 if ( $transaction->is_success() ) {
2865 if ( $payment_gateway ) { # agent override
2866 $paybatch = $payment_gateway->gatewaynum. '-';
2869 $paybatch .= "$processor:". $transaction->authorization;
2871 $paybatch .= ':'. $transaction->order_number
2872 if $transaction->can('order_number')
2873 && length($transaction->order_number);
2875 my $cust_pay = new FS::cust_pay ( {
2876 'custnum' => $self->custnum,
2877 'invnum' => $options{'invnum'},
2880 'payby' => $method2payby{$method},
2881 'payinfo' => $payinfo,
2882 'paybatch' => $paybatch,
2883 'paydate' => $paydate,
2885 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
2886 $cust_pay->payunique( $options{payunique} )
2887 if defined($options{payunique}) && length($options{payunique});
2889 my $oldAutoCommit = $FS::UID::AutoCommit;
2890 local $FS::UID::AutoCommit = 0;
2893 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
2895 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
2898 $cust_pay->invnum(''); #try again with no specific invnum
2899 my $error2 = $cust_pay->insert( $options{'manual'} ?
2900 ( 'manual' => 1 ) : ()
2903 # gah. but at least we have a record of the state we had to abort in
2904 # from cust_pay_pending now.
2905 my $e = "WARNING: $method captured but payment not recorded - ".
2906 "error inserting payment ($processor): $error2".
2907 " (previously tried insert with invnum #$options{'invnum'}" .
2908 ": $error ) - pending payment saved as paypendingnum ".
2909 $cust_pay_pending->paypendingnum. "\n";
2915 if ( $options{'paynum_ref'} ) {
2916 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
2919 $cust_pay_pending->status('done');
2920 $cust_pay_pending->statustext('captured');
2921 my $cpp_done_err = $cust_pay_pending->replace;
2923 if ( $cpp_done_err ) {
2925 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2926 my $e = "WARNING: $method captured but payment not recorded - ".
2927 "error updating status for paypendingnum ".
2928 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
2934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2935 return ''; #no error
2941 my $perror = "$processor error: ". $transaction->error_message;
2943 unless ( $transaction->error_message ) {
2946 #this should be normalized :/
2948 # bad, ad-hoc B:OP:PayflowPro "transaction_response" BS
2949 if ( $transaction->can('param')
2950 && $transaction->param('transaction_response') ) {
2951 $t_response = $transaction->param('transaction_response')
2953 # slightly better, ad-hoc B:OP:TransactionCentral without "param"
2954 } elsif ( $transaction->can('response_page') ) {
2956 'page' => ( $transaction->can('response_page')
2957 ? $transaction->response_page
2960 'code' => ( $transaction->can('response_code')
2961 ? $transaction->response_code
2964 'headers' => ( $transaction->can('response_headers')
2965 ? $transaction->response_headers
2971 "No additional debugging information available for $processor";
2974 $perror .= "No error_message returned from $processor -- ".
2975 ( ref($t_response) ? Dumper($t_response) : $t_response );
2979 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2980 && $conf->exists('emaildecline')
2981 && grep { $_ ne 'POST' } $self->invoicing_list
2982 && ! grep { $transaction->error_message =~ /$_/ }
2983 $conf->config('emaildecline-exclude')
2985 my @templ = $conf->config('declinetemplate');
2986 my $template = new Text::Template (
2988 SOURCE => [ map "$_\n", @templ ],
2989 ) or return "($perror) can't create template: $Text::Template::ERROR";
2990 $template->compile()
2991 or return "($perror) can't compile template: $Text::Template::ERROR";
2993 my $templ_hash = { error => $transaction->error_message };
2995 my $error = send_email(
2996 'from' => $conf->config('invoice_from'),
2997 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2998 'subject' => 'Your payment could not be processed',
2999 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3002 $perror .= " (also received error sending decline notification: $error)"
3007 $cust_pay_pending->status('done');
3008 $cust_pay_pending->statustext("declined: $perror");
3009 my $cpp_done_err = $cust_pay_pending->replace;
3010 if ( $cpp_done_err ) {
3011 my $e = "WARNING: $method declined but pending payment not resolved - ".
3012 "error updating status for paypendingnum ".
3013 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3015 $perror = "$e ($perror)";
3023 =item default_payment_gateway
3027 sub default_payment_gateway {
3028 my( $self, $method ) = @_;
3030 die "Real-time processing not enabled\n"
3031 unless $conf->exists('business-onlinepayment');
3034 my $bop_config = 'business-onlinepayment';
3035 $bop_config .= '-ach'
3036 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3037 my ( $processor, $login, $password, $action, @bop_options ) =
3038 $conf->config($bop_config);
3039 $action ||= 'normal authorization';
3040 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3041 die "No real-time processor is enabled - ".
3042 "did you set the business-onlinepayment configuration value?\n"
3045 ( $processor, $login, $password, $action, @bop_options )
3050 Removes the I<paycvv> field from the database directly.
3052 If there is an error, returns the error, otherwise returns false.
3058 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3059 or return dbh->errstr;
3060 $sth->execute($self->custnum)
3061 or return $sth->errstr;
3066 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3068 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3069 via a Business::OnlinePayment realtime gateway. See
3070 L<http://420.am/business-onlinepayment> for supported gateways.
3072 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3074 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3076 Most gateways require a reference to an original payment transaction to refund,
3077 so you probably need to specify a I<paynum>.
3079 I<amount> defaults to the original amount of the payment if not specified.
3081 I<reason> specifies a reason for the refund.
3083 I<paydate> specifies the expiration date for a credit card overriding the
3084 value from the customer record or the payment record. Specified as yyyy-mm-dd
3086 Implementation note: If I<amount> is unspecified or equal to the amount of the
3087 orignal payment, first an attempt is made to "void" the transaction via
3088 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3089 the normal attempt is made to "refund" ("credit") the transaction via the
3090 gateway is attempted.
3092 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3093 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3094 #if set, will override the value from the customer record.
3096 #If an I<invnum> is specified, this payment (if successful) is applied to the
3097 #specified invoice. If you don't specify an I<invnum> you might want to
3098 #call the B<apply_payments> method.
3102 #some false laziness w/realtime_bop, not enough to make it worth merging
3103 #but some useful small subs should be pulled out
3104 sub realtime_refund_bop {
3105 my( $self, $method, %options ) = @_;
3107 warn "$me realtime_refund_bop: $method refund\n";
3108 warn " $_ => $options{$_}\n" foreach keys %options;
3111 eval "use Business::OnlinePayment";
3115 # look up the original payment and optionally a gateway for that payment
3119 my $amount = $options{'amount'};
3121 my( $processor, $login, $password, @bop_options ) ;
3122 my( $auth, $order_number ) = ( '', '', '' );
3124 if ( $options{'paynum'} ) {
3126 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3127 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3128 or return "Unknown paynum $options{'paynum'}";
3129 $amount ||= $cust_pay->paid;
3131 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3132 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3133 $cust_pay->paybatch;
3134 my $gatewaynum = '';
3135 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3137 if ( $gatewaynum ) { #gateway for the payment to be refunded
3139 my $payment_gateway =
3140 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3141 die "payment gateway $gatewaynum not found"
3142 unless $payment_gateway;
3144 $processor = $payment_gateway->gateway_module;
3145 $login = $payment_gateway->gateway_username;
3146 $password = $payment_gateway->gateway_password;
3147 @bop_options = $payment_gateway->options;
3149 } else { #try the default gateway
3151 my( $conf_processor, $unused_action );
3152 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3153 $self->default_payment_gateway($method);
3155 return "processor of payment $options{'paynum'} $processor does not".
3156 " match default processor $conf_processor"
3157 unless $processor eq $conf_processor;
3162 } else { # didn't specify a paynum, so look for agent gateway overrides
3163 # like a normal transaction
3166 if ( $method eq 'CC' ) {
3167 $cardtype = cardtype($self->payinfo);
3168 } elsif ( $method eq 'ECHECK' ) {
3171 $cardtype = $method;
3174 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3175 cardtype => $cardtype,
3177 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3179 taxclass => '', } );
3181 if ( $override ) { #use a payment gateway override
3183 my $payment_gateway = $override->payment_gateway;
3185 $processor = $payment_gateway->gateway_module;
3186 $login = $payment_gateway->gateway_username;
3187 $password = $payment_gateway->gateway_password;
3188 #$action = $payment_gateway->gateway_action;
3189 @bop_options = $payment_gateway->options;
3191 } else { #use the standard settings from the config
3194 ( $processor, $login, $password, $unused_action, @bop_options ) =
3195 $self->default_payment_gateway($method);
3200 return "neither amount nor paynum specified" unless $amount;
3205 'password' => $password,
3206 'order_number' => $order_number,
3207 'amount' => $amount,
3208 'referer' => 'http://cleanwhisker.420.am/',
3210 $content{authorization} = $auth
3211 if length($auth); #echeck/ACH transactions have an order # but no auth
3212 #(at least with authorize.net)
3214 my $disable_void_after;
3215 if ($conf->exists('disable_void_after')
3216 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3217 $disable_void_after = $1;
3220 #first try void if applicable
3221 if ( $cust_pay && $cust_pay->paid == $amount
3223 ( not defined($disable_void_after) )
3224 || ( time < ($cust_pay->_date + $disable_void_after ) )
3227 warn " attempting void\n" if $DEBUG > 1;
3228 my $void = new Business::OnlinePayment( $processor, @bop_options );
3229 $void->content( 'action' => 'void', %content );
3231 if ( $void->is_success ) {
3232 my $error = $cust_pay->void($options{'reason'});
3234 # gah, even with transactions.
3235 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3236 "error voiding payment: $error";
3240 warn " void successful\n" if $DEBUG > 1;
3245 warn " void unsuccessful, trying refund\n"
3249 my $address = $self->address1;
3250 $address .= ", ". $self->address2 if $self->address2;
3252 my($payname, $payfirst, $paylast);
3253 if ( $self->payname && $method ne 'ECHECK' ) {
3254 $payname = $self->payname;
3255 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3256 or return "Illegal payname $payname";
3257 ($payfirst, $paylast) = ($1, $2);
3259 $payfirst = $self->getfield('first');
3260 $paylast = $self->getfield('last');
3261 $payname = "$payfirst $paylast";
3264 my @invoicing_list = $self->invoicing_list_emailonly;
3265 if ( $conf->exists('emailinvoiceautoalways')
3266 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3267 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3268 push @invoicing_list, $self->all_emails;
3271 my $email = ($conf->exists('business-onlinepayment-email-override'))
3272 ? $conf->config('business-onlinepayment-email-override')
3273 : $invoicing_list[0];
3275 my $payip = exists($options{'payip'})
3278 $content{customer_ip} = $payip
3282 if ( $method eq 'CC' ) {
3285 $content{card_number} = $payinfo = $cust_pay->payinfo;
3286 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3287 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3288 ($content{expiration} = "$2/$1"); # where available
3290 $content{card_number} = $payinfo = $self->payinfo;
3291 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3292 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3293 $content{expiration} = "$2/$1";
3296 } elsif ( $method eq 'ECHECK' ) {
3299 $payinfo = $cust_pay->payinfo;
3301 $payinfo = $self->payinfo;
3303 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3304 $content{bank_name} = $self->payname;
3305 $content{account_type} = 'CHECKING';
3306 $content{account_name} = $payname;
3307 $content{customer_org} = $self->company ? 'B' : 'I';
3308 $content{customer_ssn} = $self->ss;
3309 } elsif ( $method eq 'LEC' ) {
3310 $content{phone} = $payinfo = $self->payinfo;
3314 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3315 my %sub_content = $refund->content(
3316 'action' => 'credit',
3317 'customer_id' => $self->custnum,
3318 'last_name' => $paylast,
3319 'first_name' => $payfirst,
3321 'address' => $address,
3322 'city' => $self->city,
3323 'state' => $self->state,
3324 'zip' => $self->zip,
3325 'country' => $self->country,
3327 'phone' => $self->daytime || $self->night,
3330 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3334 return "$processor error: ". $refund->error_message
3335 unless $refund->is_success();
3337 my %method2payby = (
3343 my $paybatch = "$processor:". $refund->authorization;
3344 $paybatch .= ':'. $refund->order_number
3345 if $refund->can('order_number') && $refund->order_number;
3347 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3348 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3349 last unless @cust_bill_pay;
3350 my $cust_bill_pay = pop @cust_bill_pay;
3351 my $error = $cust_bill_pay->delete;
3355 my $cust_refund = new FS::cust_refund ( {
3356 'custnum' => $self->custnum,
3357 'paynum' => $options{'paynum'},
3358 'refund' => $amount,
3360 'payby' => $method2payby{$method},
3361 'payinfo' => $payinfo,
3362 'paybatch' => $paybatch,
3363 'reason' => $options{'reason'} || 'card or ACH refund',
3365 my $error = $cust_refund->insert;
3367 $cust_refund->paynum(''); #try again with no specific paynum
3368 my $error2 = $cust_refund->insert;
3370 # gah, even with transactions.
3371 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3372 "error inserting refund ($processor): $error2".
3373 " (previously tried insert with paynum #$options{'paynum'}" .
3384 =item batch_card OPTION => VALUE...
3386 Adds a payment for this invoice to the pending credit card batch (see
3387 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3388 runs the payment using a realtime gateway.
3393 my ($self, %options) = @_;
3396 if (exists($options{amount})) {
3397 $amount = $options{amount};
3399 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3401 return '' unless $amount > 0;
3403 my $invnum = delete $options{invnum};
3404 my $payby = $options{invnum} || $self->payby; #dubious
3406 if ($options{'realtime'}) {
3407 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3413 my $oldAutoCommit = $FS::UID::AutoCommit;
3414 local $FS::UID::AutoCommit = 0;
3417 #this needs to handle mysql as well as Pg, like svc_acct.pm
3418 #(make it into a common function if folks need to do batching with mysql)
3419 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3420 or return "Cannot lock pay_batch: " . $dbh->errstr;
3424 'payby' => FS::payby->payby2payment($payby),
3427 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3429 unless ( $pay_batch ) {
3430 $pay_batch = new FS::pay_batch \%pay_batch;
3431 my $error = $pay_batch->insert;
3433 $dbh->rollback if $oldAutoCommit;
3434 die "error creating new batch: $error\n";
3438 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3439 'batchnum' => $pay_batch->batchnum,
3440 'custnum' => $self->custnum,
3443 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3445 $options{$_} = '' unless exists($options{$_});
3448 my $cust_pay_batch = new FS::cust_pay_batch ( {
3449 'batchnum' => $pay_batch->batchnum,
3450 'invnum' => $invnum || 0, # is there a better value?
3451 # this field should be
3453 # cust_bill_pay_batch now
3454 'custnum' => $self->custnum,
3455 'last' => $self->getfield('last'),
3456 'first' => $self->getfield('first'),
3457 'address1' => $options{address1} || $self->address1,
3458 'address2' => $options{address2} || $self->address2,
3459 'city' => $options{city} || $self->city,
3460 'state' => $options{state} || $self->state,
3461 'zip' => $options{zip} || $self->zip,
3462 'country' => $options{country} || $self->country,
3463 'payby' => $options{payby} || $self->payby,
3464 'payinfo' => $options{payinfo} || $self->payinfo,
3465 'exp' => $options{paydate} || $self->paydate,
3466 'payname' => $options{payname} || $self->payname,
3467 'amount' => $amount, # consolidating
3470 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3471 if $old_cust_pay_batch;
3474 if ($old_cust_pay_batch) {
3475 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3477 $error = $cust_pay_batch->insert;
3481 $dbh->rollback if $oldAutoCommit;
3485 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3486 foreach my $cust_bill ($self->open_cust_bill) {
3487 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3488 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3489 'invnum' => $cust_bill->invnum,
3490 'paybatchnum' => $cust_pay_batch->paybatchnum,
3491 'amount' => $cust_bill->owed,
3494 if ($unapplied >= $cust_bill_pay_batch->amount){
3495 $unapplied -= $cust_bill_pay_batch->amount;
3498 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3499 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3501 $error = $cust_bill_pay_batch->insert;
3503 $dbh->rollback if $oldAutoCommit;
3508 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3514 Returns the total owed for this customer on all invoices
3515 (see L<FS::cust_bill/owed>).
3521 $self->total_owed_date(2145859200); #12/31/2037
3524 =item total_owed_date TIME
3526 Returns the total owed for this customer on all invoices with date earlier than
3527 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3528 see L<Time::Local> and L<Date::Parse> for conversion functions.
3532 sub total_owed_date {
3536 foreach my $cust_bill (
3537 grep { $_->_date <= $time }
3538 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3540 $total_bill += $cust_bill->owed;
3542 sprintf( "%.2f", $total_bill );
3545 =item apply_payments_and_credits
3547 Applies unapplied payments and credits.
3549 In most cases, this new method should be used in place of sequential
3550 apply_payments and apply_credits methods.
3552 If there is an error, returns the error, otherwise returns false.
3556 sub apply_payments_and_credits {
3559 local $SIG{HUP} = 'IGNORE';
3560 local $SIG{INT} = 'IGNORE';
3561 local $SIG{QUIT} = 'IGNORE';
3562 local $SIG{TERM} = 'IGNORE';
3563 local $SIG{TSTP} = 'IGNORE';
3564 local $SIG{PIPE} = 'IGNORE';
3566 my $oldAutoCommit = $FS::UID::AutoCommit;
3567 local $FS::UID::AutoCommit = 0;
3570 $self->select_for_update; #mutex
3572 foreach my $cust_bill ( $self->open_cust_bill ) {
3573 my $error = $cust_bill->apply_payments_and_credits;
3575 $dbh->rollback if $oldAutoCommit;
3576 return "Error applying: $error";
3580 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3585 =item apply_credits OPTION => VALUE ...
3587 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3588 to outstanding invoice balances in chronological order (or reverse
3589 chronological order if the I<order> option is set to B<newest>) and returns the
3590 value of any remaining unapplied credits available for refund (see
3591 L<FS::cust_refund>).
3593 Dies if there is an error.
3601 local $SIG{HUP} = 'IGNORE';
3602 local $SIG{INT} = 'IGNORE';
3603 local $SIG{QUIT} = 'IGNORE';
3604 local $SIG{TERM} = 'IGNORE';
3605 local $SIG{TSTP} = 'IGNORE';
3606 local $SIG{PIPE} = 'IGNORE';
3608 my $oldAutoCommit = $FS::UID::AutoCommit;
3609 local $FS::UID::AutoCommit = 0;
3612 $self->select_for_update; #mutex
3614 unless ( $self->total_credited ) {
3615 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3619 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3620 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3622 my @invoices = $self->open_cust_bill;
3623 @invoices = sort { $b->_date <=> $a->_date } @invoices
3624 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3627 foreach my $cust_bill ( @invoices ) {
3630 if ( !defined($credit) || $credit->credited == 0) {
3631 $credit = pop @credits or last;
3634 if ($cust_bill->owed >= $credit->credited) {
3635 $amount=$credit->credited;
3637 $amount=$cust_bill->owed;
3640 my $cust_credit_bill = new FS::cust_credit_bill ( {
3641 'crednum' => $credit->crednum,
3642 'invnum' => $cust_bill->invnum,
3643 'amount' => $amount,
3645 my $error = $cust_credit_bill->insert;
3647 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3651 redo if ($cust_bill->owed > 0);
3655 my $total_credited = $self->total_credited;
3657 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3659 return $total_credited;
3662 =item apply_payments
3664 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3665 to outstanding invoice balances in chronological order.
3667 #and returns the value of any remaining unapplied payments.
3669 Dies if there is an error.
3673 sub apply_payments {
3676 local $SIG{HUP} = 'IGNORE';
3677 local $SIG{INT} = 'IGNORE';
3678 local $SIG{QUIT} = 'IGNORE';
3679 local $SIG{TERM} = 'IGNORE';
3680 local $SIG{TSTP} = 'IGNORE';
3681 local $SIG{PIPE} = 'IGNORE';
3683 my $oldAutoCommit = $FS::UID::AutoCommit;
3684 local $FS::UID::AutoCommit = 0;
3687 $self->select_for_update; #mutex
3691 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3692 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3694 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3695 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3699 foreach my $cust_bill ( @invoices ) {
3702 if ( !defined($payment) || $payment->unapplied == 0 ) {
3703 $payment = pop @payments or last;
3706 if ( $cust_bill->owed >= $payment->unapplied ) {
3707 $amount = $payment->unapplied;
3709 $amount = $cust_bill->owed;
3712 my $cust_bill_pay = new FS::cust_bill_pay ( {
3713 'paynum' => $payment->paynum,
3714 'invnum' => $cust_bill->invnum,
3715 'amount' => $amount,
3717 my $error = $cust_bill_pay->insert;
3719 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3723 redo if ( $cust_bill->owed > 0);
3727 my $total_unapplied_payments = $self->total_unapplied_payments;
3729 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3731 return $total_unapplied_payments;
3734 =item total_credited
3736 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3737 customer. See L<FS::cust_credit/credited>.
3741 sub total_credited {
3743 my $total_credit = 0;
3744 foreach my $cust_credit ( qsearch('cust_credit', {
3745 'custnum' => $self->custnum,
3747 $total_credit += $cust_credit->credited;
3749 sprintf( "%.2f", $total_credit );
3752 =item total_unapplied_payments
3754 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3755 See L<FS::cust_pay/unapplied>.
3759 sub total_unapplied_payments {
3761 my $total_unapplied = 0;
3762 foreach my $cust_pay ( qsearch('cust_pay', {
3763 'custnum' => $self->custnum,
3765 $total_unapplied += $cust_pay->unapplied;
3767 sprintf( "%.2f", $total_unapplied );
3770 =item total_unapplied_refunds
3772 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3773 customer. See L<FS::cust_refund/unapplied>.
3777 sub total_unapplied_refunds {
3779 my $total_unapplied = 0;
3780 foreach my $cust_refund ( qsearch('cust_refund', {
3781 'custnum' => $self->custnum,
3783 $total_unapplied += $cust_refund->unapplied;
3785 sprintf( "%.2f", $total_unapplied );
3790 Returns the balance for this customer (total_owed plus total_unrefunded, minus
3791 total_credited minus total_unapplied_payments).
3799 + $self->total_unapplied_refunds
3800 - $self->total_credited
3801 - $self->total_unapplied_payments
3805 =item balance_date TIME
3807 Returns the balance for this customer, only considering invoices with date
3808 earlier than TIME (total_owed_date minus total_credited minus
3809 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3810 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3819 $self->total_owed_date($time)
3820 + $self->total_unapplied_refunds
3821 - $self->total_credited
3822 - $self->total_unapplied_payments
3826 =item in_transit_payments
3828 Returns the total of requests for payments for this customer pending in
3829 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3833 sub in_transit_payments {
3835 my $in_transit_payments = 0;
3836 foreach my $pay_batch ( qsearch('pay_batch', {
3839 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3840 'batchnum' => $pay_batch->batchnum,
3841 'custnum' => $self->custnum,
3843 $in_transit_payments += $cust_pay_batch->amount;
3846 sprintf( "%.2f", $in_transit_payments );
3849 =item paydate_monthyear
3851 Returns a two-element list consisting of the month and year of this customer's
3852 paydate (credit card expiration date for CARD customers)
3856 sub paydate_monthyear {
3858 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3860 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3867 =item invoicing_list [ ARRAYREF ]
3869 If an arguement is given, sets these email addresses as invoice recipients
3870 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3871 (except as warnings), so use check_invoicing_list first.
3873 Returns a list of email addresses (with svcnum entries expanded).
3875 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3876 check it without disturbing anything by passing nothing.
3878 This interface may change in the future.
3882 sub invoicing_list {
3883 my( $self, $arrayref ) = @_;
3886 my @cust_main_invoice;
3887 if ( $self->custnum ) {
3888 @cust_main_invoice =
3889 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3891 @cust_main_invoice = ();
3893 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3894 #warn $cust_main_invoice->destnum;
3895 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3896 #warn $cust_main_invoice->destnum;
3897 my $error = $cust_main_invoice->delete;
3898 warn $error if $error;
3901 if ( $self->custnum ) {
3902 @cust_main_invoice =
3903 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3905 @cust_main_invoice = ();
3907 my %seen = map { $_->address => 1 } @cust_main_invoice;
3908 foreach my $address ( @{$arrayref} ) {
3909 next if exists $seen{$address} && $seen{$address};
3910 $seen{$address} = 1;
3911 my $cust_main_invoice = new FS::cust_main_invoice ( {
3912 'custnum' => $self->custnum,
3915 my $error = $cust_main_invoice->insert;
3916 warn $error if $error;
3920 if ( $self->custnum ) {
3922 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3929 =item check_invoicing_list ARRAYREF
3931 Checks these arguements as valid input for the invoicing_list method. If there
3932 is an error, returns the error, otherwise returns false.
3936 sub check_invoicing_list {
3937 my( $self, $arrayref ) = @_;
3939 foreach my $address ( @$arrayref ) {
3941 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3942 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3945 my $cust_main_invoice = new FS::cust_main_invoice ( {
3946 'custnum' => $self->custnum,
3949 my $error = $self->custnum
3950 ? $cust_main_invoice->check
3951 : $cust_main_invoice->checkdest
3953 return $error if $error;
3957 return "Email address required"
3958 if $conf->exists('cust_main-require_invoicing_list_email')
3959 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3964 =item set_default_invoicing_list
3966 Sets the invoicing list to all accounts associated with this customer,
3967 overwriting any previous invoicing list.
3971 sub set_default_invoicing_list {
3973 $self->invoicing_list($self->all_emails);
3978 Returns the email addresses of all accounts provisioned for this customer.
3985 foreach my $cust_pkg ( $self->all_pkgs ) {
3986 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3988 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3989 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3991 $list{$_}=1 foreach map { $_->email } @svc_acct;
3996 =item invoicing_list_addpost
3998 Adds postal invoicing to this customer. If this customer is already configured
3999 to receive postal invoices, does nothing.
4003 sub invoicing_list_addpost {
4005 return if grep { $_ eq 'POST' } $self->invoicing_list;
4006 my @invoicing_list = $self->invoicing_list;
4007 push @invoicing_list, 'POST';
4008 $self->invoicing_list(\@invoicing_list);
4011 =item invoicing_list_emailonly
4013 Returns the list of email invoice recipients (invoicing_list without non-email
4014 destinations such as POST and FAX).
4018 sub invoicing_list_emailonly {
4020 warn "$me invoicing_list_emailonly called"
4022 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4025 =item invoicing_list_emailonly_scalar
4027 Returns the list of email invoice recipients (invoicing_list without non-email
4028 destinations such as POST and FAX) as a comma-separated scalar.
4032 sub invoicing_list_emailonly_scalar {
4034 warn "$me invoicing_list_emailonly_scalar called"
4036 join(', ', $self->invoicing_list_emailonly);
4039 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4041 Returns an array of customers referred by this customer (referral_custnum set
4042 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4043 customers referred by customers referred by this customer and so on, inclusive.
4044 The default behavior is DEPTH 1 (no recursion).
4048 sub referral_cust_main {
4050 my $depth = @_ ? shift : 1;
4051 my $exclude = @_ ? shift : {};
4054 map { $exclude->{$_->custnum}++; $_; }
4055 grep { ! $exclude->{ $_->custnum } }
4056 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4060 map { $_->referral_cust_main($depth-1, $exclude) }
4067 =item referral_cust_main_ncancelled
4069 Same as referral_cust_main, except only returns customers with uncancelled
4074 sub referral_cust_main_ncancelled {
4076 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4079 =item referral_cust_pkg [ DEPTH ]
4081 Like referral_cust_main, except returns a flat list of all unsuspended (and
4082 uncancelled) packages for each customer. The number of items in this list may
4083 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4087 sub referral_cust_pkg {
4089 my $depth = @_ ? shift : 1;
4091 map { $_->unsuspended_pkgs }
4092 grep { $_->unsuspended_pkgs }
4093 $self->referral_cust_main($depth);
4096 =item referring_cust_main
4098 Returns the single cust_main record for the customer who referred this customer
4099 (referral_custnum), or false.
4103 sub referring_cust_main {
4105 return '' unless $self->referral_custnum;
4106 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4109 =item credit AMOUNT, REASON
4111 Applies a credit to this customer. If there is an error, returns the error,
4112 otherwise returns false.
4117 my( $self, $amount, $reason, %options ) = @_;
4118 my $cust_credit = new FS::cust_credit {
4119 'custnum' => $self->custnum,
4120 'amount' => $amount,
4121 'reason' => $reason,
4123 $cust_credit->insert(%options);
4126 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4128 Creates a one-time charge for this customer. If there is an error, returns
4129 the error, otherwise returns false.
4135 my ( $amount, $pkg, $comment, $taxclass, $additional, $classnum );
4136 if ( ref( $_[0] ) ) {
4137 $amount = $_[0]->{amount};
4138 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4139 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4140 : '$'. sprintf("%.2f",$amount);
4141 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4142 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4143 $additional = $_[0]->{additional};
4146 $pkg = @_ ? shift : 'One-time charge';
4147 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4148 $taxclass = @_ ? shift : '';
4152 local $SIG{HUP} = 'IGNORE';
4153 local $SIG{INT} = 'IGNORE';
4154 local $SIG{QUIT} = 'IGNORE';
4155 local $SIG{TERM} = 'IGNORE';
4156 local $SIG{TSTP} = 'IGNORE';
4157 local $SIG{PIPE} = 'IGNORE';
4159 my $oldAutoCommit = $FS::UID::AutoCommit;
4160 local $FS::UID::AutoCommit = 0;
4163 my $part_pkg = new FS::part_pkg ( {
4165 'comment' => $comment,
4169 'classnum' => $classnum ? $classnum : '',
4170 'taxclass' => $taxclass,
4173 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4174 ( 0 .. @$additional - 1 )
4176 'additional_count' => scalar(@$additional),
4177 'setup_fee' => $amount,
4180 my $error = $part_pkg->insert( options => \%options );
4182 $dbh->rollback if $oldAutoCommit;
4186 my $pkgpart = $part_pkg->pkgpart;
4187 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4188 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4189 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4190 $error = $type_pkgs->insert;
4192 $dbh->rollback if $oldAutoCommit;
4197 my $cust_pkg = new FS::cust_pkg ( {
4198 'custnum' => $self->custnum,
4199 'pkgpart' => $pkgpart,
4202 $error = $cust_pkg->insert;
4204 $dbh->rollback if $oldAutoCommit;
4208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4215 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4221 sort { $a->_date <=> $b->_date }
4222 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4225 =item open_cust_bill
4227 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4232 sub open_cust_bill {
4234 grep { $_->owed > 0 } $self->cust_bill;
4239 Returns all the credits (see L<FS::cust_credit>) for this customer.
4245 sort { $a->_date <=> $b->_date }
4246 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4251 Returns all the payments (see L<FS::cust_pay>) for this customer.
4257 sort { $a->_date <=> $b->_date }
4258 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4263 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4269 sort { $a->_date <=> $b->_date }
4270 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4276 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4282 sort { $a->_date <=> $b->_date }
4283 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4288 Returns a name string for this customer, either "Company (Last, First)" or
4295 my $name = $self->contact;
4296 $name = $self->company. " ($name)" if $self->company;
4302 Returns a name string for this (service/shipping) contact, either
4303 "Company (Last, First)" or "Last, First".
4309 if ( $self->get('ship_last') ) {
4310 my $name = $self->ship_contact;
4311 $name = $self->ship_company. " ($name)" if $self->ship_company;
4320 Returns this customer's full (billing) contact name only, "Last, First"
4326 $self->get('last'). ', '. $self->first;
4331 Returns this customer's full (shipping) contact name only, "Last, First"
4337 $self->get('ship_last')
4338 ? $self->get('ship_last'). ', '. $self->ship_first
4344 Returns this customer's full country name
4350 code2country($self->country);
4357 Returns a status string for this customer, currently:
4361 =item prospect - No packages have ever been ordered
4363 =item active - One or more recurring packages is active
4365 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4367 =item suspended - All non-cancelled recurring packages are suspended
4369 =item cancelled - All recurring packages are cancelled
4375 sub status { shift->cust_status(@_); }
4379 for my $status (qw( prospect active inactive suspended cancelled )) {
4380 my $method = $status.'_sql';
4381 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4382 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4383 $sth->execute( ($self->custnum) x $numnum )
4384 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4385 return $status if $sth->fetchrow_arrayref->[0];
4389 =item ucfirst_cust_status
4391 =item ucfirst_status
4393 Returns the status with the first character capitalized.
4397 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4399 sub ucfirst_cust_status {
4401 ucfirst($self->cust_status);
4406 Returns a hex triplet color string for this customer's status.
4410 use vars qw(%statuscolor);
4412 'prospect' => '7e0079', #'000000', #black? naw, purple
4413 'active' => '00CC00', #green
4414 'inactive' => '0000CC', #blue
4415 'suspended' => 'FF9900', #yellow
4416 'cancelled' => 'FF0000', #red
4419 sub statuscolor { shift->cust_statuscolor(@_); }
4421 sub cust_statuscolor {
4423 $statuscolor{$self->cust_status};
4428 =head1 CLASS METHODS
4434 Returns an SQL expression identifying prospective cust_main records (customers
4435 with no packages ever ordered)
4439 use vars qw($select_count_pkgs);
4440 $select_count_pkgs =
4441 "SELECT COUNT(*) FROM cust_pkg
4442 WHERE cust_pkg.custnum = cust_main.custnum";
4444 sub select_count_pkgs_sql {
4448 sub prospect_sql { "
4449 0 = ( $select_count_pkgs )
4454 Returns an SQL expression identifying active cust_main records (customers with
4455 no active recurring packages, but otherwise unsuspended/uncancelled).
4460 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4466 Returns an SQL expression identifying inactive cust_main records (customers with
4467 active recurring packages).
4471 sub inactive_sql { "
4472 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4474 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4480 Returns an SQL expression identifying suspended cust_main records.
4485 sub suspended_sql { susp_sql(@_); }
4487 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4489 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4495 Returns an SQL expression identifying cancelled cust_main records.
4499 sub cancelled_sql { cancel_sql(@_); }
4502 my $recurring_sql = FS::cust_pkg->recurring_sql;
4503 #my $recurring_sql = "
4504 # '0' != ( select freq from part_pkg
4505 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4509 0 < ( $select_count_pkgs )
4510 AND 0 = ( $select_count_pkgs AND $recurring_sql
4511 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4517 =item uncancelled_sql
4519 Returns an SQL expression identifying un-cancelled cust_main records.
4523 sub uncancelled_sql { uncancel_sql(@_); }
4524 sub uncancel_sql { "
4525 ( 0 < ( $select_count_pkgs
4526 AND ( cust_pkg.cancel IS NULL
4527 OR cust_pkg.cancel = 0
4530 OR 0 = ( $select_count_pkgs )
4536 Returns an SQL fragment to retreive the balance.
4541 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4542 WHERE cust_bill.custnum = cust_main.custnum )
4543 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4544 WHERE cust_pay.custnum = cust_main.custnum )
4545 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4546 WHERE cust_credit.custnum = cust_main.custnum )
4547 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4548 WHERE cust_refund.custnum = cust_main.custnum )
4551 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4553 Returns an SQL fragment to retreive the balance for this customer, only
4554 considering invoices with date earlier than START_TIME, and optionally not
4555 later than END_TIME (total_owed_date minus total_credited minus
4556 total_unapplied_payments).
4558 Times are specified as SQL fragments or numeric
4559 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4560 L<Date::Parse> for conversion functions. The empty string can be passed
4561 to disable that time constraint completely.
4563 Available options are:
4567 =item unapplied_date - 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)
4569 =item total - set to true to remove all customer comparison clauses, for totals
4571 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4573 =item join - JOIN clause (typically used with the total option)
4581 sub balance_date_sql {
4582 my( $class, $start, $end, %opt ) = @_;
4584 my $owed = FS::cust_bill->owed_sql;
4585 my $unapp_refund = FS::cust_refund->unapplied_sql;
4586 my $unapp_credit = FS::cust_credit->unapplied_sql;
4587 my $unapp_pay = FS::cust_pay->unapplied_sql;
4589 my $j = $opt{'join'} || '';
4591 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4592 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4593 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4594 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4596 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4597 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4598 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4599 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4604 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4606 Helper method for balance_date_sql; name (and usage) subject to change
4607 (suggestions welcome).
4609 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4610 cust_refund, cust_credit or cust_pay).
4612 If TABLE is "cust_bill" or the unapplied_date option is true, only
4613 considers records with date earlier than START_TIME, and optionally not
4614 later than END_TIME .
4618 sub _money_table_where {
4619 my( $class, $table, $start, $end, %opt ) = @_;
4622 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4623 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4624 push @where, "$table._date <= $start" if defined($start) && length($start);
4625 push @where, "$table._date > $end" if defined($end) && length($end);
4627 push @where, @{$opt{'where'}} if $opt{'where'};
4628 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4634 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4636 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4637 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4638 appropriate ship_ field is also searched).
4640 Additional options are the same as FS::Record::qsearch
4645 my( $self, $fuzzy, $hash, @opt) = @_;
4650 check_and_rebuild_fuzzyfiles();
4651 foreach my $field ( keys %$fuzzy ) {
4653 my $all = $self->all_X($field);
4654 next unless scalar(@$all);
4657 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4660 foreach ( keys %match ) {
4661 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4662 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4665 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4668 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4670 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4678 Returns a masked version of the named field
4683 my ($self, $field) = @_;
4687 'x'x(length($self->getfield($field))-4).
4688 substr($self->getfield($field), (length($self->getfield($field))-4));
4698 =item smart_search OPTION => VALUE ...
4700 Accepts the following options: I<search>, the string to search for. The string
4701 will be searched for as a customer number, phone number, name or company name,
4702 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4703 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4704 skip fuzzy matching when an exact match is found.
4706 Any additional options are treated as an additional qualifier on the search
4709 Returns a (possibly empty) array of FS::cust_main objects.
4716 #here is the agent virtualization
4717 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4721 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4722 my $search = delete $options{'search'};
4723 ( my $alphanum_search = $search ) =~ s/\W//g;
4725 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4727 #false laziness w/Record::ut_phone
4728 my $phonen = "$1-$2-$3";
4729 $phonen .= " x$4" if $4;
4731 push @cust_main, qsearch( {
4732 'table' => 'cust_main',
4733 'hashref' => { %options },
4734 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4736 join(' OR ', map "$_ = '$phonen'",
4737 qw( daytime night fax
4738 ship_daytime ship_night ship_fax )
4741 " AND $agentnums_sql", #agent virtualization
4744 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4745 #try looking for matches with extensions unless one was specified
4747 push @cust_main, qsearch( {
4748 'table' => 'cust_main',
4749 'hashref' => { %options },
4750 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4752 join(' OR ', map "$_ LIKE '$phonen\%'",
4754 ship_daytime ship_night )
4757 " AND $agentnums_sql", #agent virtualization
4762 # custnum search (also try agent_custid), with some tweaking options if your
4763 # legacy cust "numbers" have letters
4764 } elsif ( $search =~ /^\s*(\d+)\s*$/
4765 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
4766 && $search =~ /^\s*(\w\w?\d+)\s*$/
4771 push @cust_main, qsearch( {
4772 'table' => 'cust_main',
4773 'hashref' => { 'custnum' => $1, %options },
4774 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4777 push @cust_main, qsearch( {
4778 'table' => 'cust_main',
4779 'hashref' => { 'agent_custid' => $1, %options },
4780 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4783 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4785 my($company, $last, $first) = ( $1, $2, $3 );
4787 # "Company (Last, First)"
4788 #this is probably something a browser remembered,
4789 #so just do an exact search
4791 foreach my $prefix ( '', 'ship_' ) {
4792 push @cust_main, qsearch( {
4793 'table' => 'cust_main',
4794 'hashref' => { $prefix.'first' => $first,
4795 $prefix.'last' => $last,
4796 $prefix.'company' => $company,
4799 'extra_sql' => " AND $agentnums_sql",
4803 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4804 # try (ship_){last,company}
4808 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4809 # # full strings the browser remembers won't work
4810 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4812 use Lingua::EN::NameParse;
4813 my $NameParse = new Lingua::EN::NameParse(
4815 allow_reversed => 1,
4818 my($last, $first) = ( '', '' );
4819 #maybe disable this too and just rely on NameParse?
4820 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4822 ($last, $first) = ( $1, $2 );
4824 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4825 } elsif ( ! $NameParse->parse($value) ) {
4827 my %name = $NameParse->components;
4828 $first = $name{'given_name_1'};
4829 $last = $name{'surname_1'};
4833 if ( $first && $last ) {
4835 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4838 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4840 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4841 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4844 push @cust_main, qsearch( {
4845 'table' => 'cust_main',
4846 'hashref' => \%options,
4847 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4850 # or it just be something that was typed in... (try that in a sec)
4854 my $q_value = dbh->quote($value);
4857 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4858 $sql .= " ( LOWER(last) = $q_value
4859 OR LOWER(company) = $q_value
4860 OR LOWER(ship_last) = $q_value
4861 OR LOWER(ship_company) = $q_value
4864 push @cust_main, qsearch( {
4865 'table' => 'cust_main',
4866 'hashref' => \%options,
4867 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4870 #always do substring & fuzzy,
4871 #getting complains searches are not returning enough
4872 unless ( @cust_main && $skip_fuzzy ) { #no exact match, trying substring/fuzzy
4874 #still some false laziness w/ search/cust_main.cgi
4879 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4880 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4883 if ( $first && $last ) {
4886 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4887 'last' => { op=>'ILIKE', value=>"%$last%" },
4889 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4890 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4897 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4898 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4902 foreach my $hashref ( @hashrefs ) {
4904 push @cust_main, qsearch( {
4905 'table' => 'cust_main',
4906 'hashref' => { %$hashref,
4909 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4918 " AND $agentnums_sql", #extra_sql #agent virtualization
4921 if ( $first && $last ) {
4922 push @cust_main, FS::cust_main->fuzzy_search(
4923 { 'last' => $last, #fuzzy hashref
4924 'first' => $first }, #
4928 foreach my $field ( 'last', 'company' ) {
4930 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4935 #eliminate duplicates
4937 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4945 =item check_and_rebuild_fuzzyfiles
4949 use vars qw(@fuzzyfields);
4950 @fuzzyfields = ( 'last', 'first', 'company' );
4952 sub check_and_rebuild_fuzzyfiles {
4953 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4954 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4957 =item rebuild_fuzzyfiles
4961 sub rebuild_fuzzyfiles {
4963 use Fcntl qw(:flock);
4965 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4966 mkdir $dir, 0700 unless -d $dir;
4968 foreach my $fuzzy ( @fuzzyfields ) {
4970 open(LOCK,">>$dir/cust_main.$fuzzy")
4971 or die "can't open $dir/cust_main.$fuzzy: $!";
4973 or die "can't lock $dir/cust_main.$fuzzy: $!";
4975 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4976 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4978 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4979 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4980 " WHERE $field != '' AND $field IS NOT NULL");
4981 $sth->execute or die $sth->errstr;
4983 while ( my $row = $sth->fetchrow_arrayref ) {
4984 print CACHE $row->[0]. "\n";
4989 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4991 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5002 my( $self, $field ) = @_;
5003 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
5004 open(CACHE,"<$dir/cust_main.$field")
5005 or die "can't open $dir/cust_main.$field: $!";
5006 my @array = map { chomp; $_; } <CACHE>;
5011 =item append_fuzzyfiles LASTNAME COMPANY
5015 sub append_fuzzyfiles {
5016 #my( $first, $last, $company ) = @_;
5018 &check_and_rebuild_fuzzyfiles;
5020 use Fcntl qw(:flock);
5022 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
5024 foreach my $field (qw( first last company )) {
5029 open(CACHE,">>$dir/cust_main.$field")
5030 or die "can't open $dir/cust_main.$field: $!";
5031 flock(CACHE,LOCK_EX)
5032 or die "can't lock $dir/cust_main.$field: $!";
5034 print CACHE "$value\n";
5036 flock(CACHE,LOCK_UN)
5037 or die "can't unlock $dir/cust_main.$field: $!";
5052 #warn join('-',keys %$param);
5053 my $fh = $param->{filehandle};
5054 my $agentnum = $param->{agentnum};
5056 my $refnum = $param->{refnum};
5057 my $pkgpart = $param->{pkgpart};
5059 #my @fields = @{$param->{fields}};
5060 my $format = $param->{'format'};
5063 if ( $format eq 'simple' ) {
5064 @fields = qw( cust_pkg.setup dayphone first last
5065 address1 address2 city state zip comments );
5067 } elsif ( $format eq 'extended' ) {
5068 @fields = qw( agent_custid refnum
5069 last first address1 address2 city state zip country
5071 ship_last ship_first ship_address1 ship_address2
5072 ship_city ship_state ship_zip ship_country
5073 payinfo paycvv paydate
5076 svc_acct.username svc_acct._password
5079 } elsif ( $format eq 'extended-plus_company' ) {
5080 @fields = qw( agent_custid refnum
5081 last first company address1 address2 city state zip country
5083 ship_last ship_first ship_company ship_address1 ship_address2
5084 ship_city ship_state ship_zip ship_country
5085 payinfo paycvv paydate
5088 svc_acct.username svc_acct._password
5092 die "unknown format $format";
5095 eval "use Text::CSV_XS;";
5098 my $csv = new Text::CSV_XS;
5105 local $SIG{HUP} = 'IGNORE';
5106 local $SIG{INT} = 'IGNORE';
5107 local $SIG{QUIT} = 'IGNORE';
5108 local $SIG{TERM} = 'IGNORE';
5109 local $SIG{TSTP} = 'IGNORE';
5110 local $SIG{PIPE} = 'IGNORE';
5112 my $oldAutoCommit = $FS::UID::AutoCommit;
5113 local $FS::UID::AutoCommit = 0;
5116 #while ( $columns = $csv->getline($fh) ) {
5118 while ( defined($line=<$fh>) ) {
5120 $csv->parse($line) or do {
5121 $dbh->rollback if $oldAutoCommit;
5122 return "can't parse: ". $csv->error_input();
5125 my @columns = $csv->fields();
5126 #warn join('-',@columns);
5129 agentnum => $agentnum,
5131 country => $conf->config('countrydefault') || 'US',
5132 payby => $payby, #default
5133 paydate => '12/2037', #default
5135 my $billtime = time;
5136 my %cust_pkg = ( pkgpart => $pkgpart );
5138 foreach my $field ( @fields ) {
5140 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5142 #$cust_pkg{$1} = str2time( shift @$columns );
5143 if ( $1 eq 'pkgpart' ) {
5144 $cust_pkg{$1} = shift @columns;
5145 } elsif ( $1 eq 'setup' ) {
5146 $billtime = str2time(shift @columns);
5148 $cust_pkg{$1} = str2time( shift @columns );
5151 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5153 $svc_acct{$1} = shift @columns;
5157 #refnum interception
5158 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5160 my $referral = $columns[0];
5161 my %hash = ( 'referral' => $referral,
5162 'agentnum' => $agentnum,
5166 my $part_referral = qsearchs('part_referral', \%hash )
5167 || new FS::part_referral \%hash;
5169 unless ( $part_referral->refnum ) {
5170 my $error = $part_referral->insert;
5172 $dbh->rollback if $oldAutoCommit;
5173 return "can't auto-insert advertising source: $referral: $error";
5177 $columns[0] = $part_referral->refnum;
5180 #$cust_main{$field} = shift @$columns;
5181 $cust_main{$field} = shift @columns;
5185 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5187 my $invoicing_list = $cust_main{'invoicing_list'}
5188 ? [ delete $cust_main{'invoicing_list'} ]
5191 my $cust_main = new FS::cust_main ( \%cust_main );
5194 tie my %hash, 'Tie::RefHash'; #this part is important
5196 if ( $cust_pkg{'pkgpart'} ) {
5197 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5200 if ( $svc_acct{'username'} ) {
5201 my $part_pkg = $cust_pkg->part_pkg;
5202 unless ( $part_pkg ) {
5203 $dbh->rollback if $oldAutoCommit;
5204 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5206 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5207 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5210 $hash{$cust_pkg} = \@svc_acct;
5213 my $error = $cust_main->insert( \%hash, $invoicing_list );
5216 $dbh->rollback if $oldAutoCommit;
5217 return "can't insert customer for $line: $error";
5220 if ( $format eq 'simple' ) {
5222 #false laziness w/bill.cgi
5223 $error = $cust_main->bill( 'time' => $billtime );
5225 $dbh->rollback if $oldAutoCommit;
5226 return "can't bill customer for $line: $error";
5229 $error = $cust_main->apply_payments_and_credits;
5231 $dbh->rollback if $oldAutoCommit;
5232 return "can't bill customer for $line: $error";
5235 $error = $cust_main->collect();
5237 $dbh->rollback if $oldAutoCommit;
5238 return "can't collect customer for $line: $error";
5246 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5248 return "Empty file!" unless $imported;
5260 #warn join('-',keys %$param);
5261 my $fh = $param->{filehandle};
5262 my @fields = @{$param->{fields}};
5264 eval "use Text::CSV_XS;";
5267 my $csv = new Text::CSV_XS;
5274 local $SIG{HUP} = 'IGNORE';
5275 local $SIG{INT} = 'IGNORE';
5276 local $SIG{QUIT} = 'IGNORE';
5277 local $SIG{TERM} = 'IGNORE';
5278 local $SIG{TSTP} = 'IGNORE';
5279 local $SIG{PIPE} = 'IGNORE';
5281 my $oldAutoCommit = $FS::UID::AutoCommit;
5282 local $FS::UID::AutoCommit = 0;
5285 #while ( $columns = $csv->getline($fh) ) {
5287 while ( defined($line=<$fh>) ) {
5289 $csv->parse($line) or do {
5290 $dbh->rollback if $oldAutoCommit;
5291 return "can't parse: ". $csv->error_input();
5294 my @columns = $csv->fields();
5295 #warn join('-',@columns);
5298 foreach my $field ( @fields ) {
5299 $row{$field} = shift @columns;
5302 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5303 unless ( $cust_main ) {
5304 $dbh->rollback if $oldAutoCommit;
5305 return "unknown custnum $row{'custnum'}";
5308 if ( $row{'amount'} > 0 ) {
5309 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5311 $dbh->rollback if $oldAutoCommit;
5315 } elsif ( $row{'amount'} < 0 ) {
5316 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5319 $dbh->rollback if $oldAutoCommit;
5329 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5331 return "Empty file!" unless $imported;
5337 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5339 Sends a templated email notification to the customer (see L<Text::Template>).
5341 OPTIONS is a hash and may include
5343 I<from> - the email sender (default is invoice_from)
5345 I<to> - comma-separated scalar or arrayref of recipients
5346 (default is invoicing_list)
5348 I<subject> - The subject line of the sent email notification
5349 (default is "Notice from company_name")
5351 I<extra_fields> - a hashref of name/value pairs which will be substituted
5354 The following variables are vavailable in the template.
5356 I<$first> - the customer first name
5357 I<$last> - the customer last name
5358 I<$company> - the customer company
5359 I<$payby> - a description of the method of payment for the customer
5360 # would be nice to use FS::payby::shortname
5361 I<$payinfo> - the account information used to collect for this customer
5362 I<$expdate> - the expiration of the customer payment in seconds from epoch
5367 my ($customer, $template, %options) = @_;
5369 return unless $conf->exists($template);
5371 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5372 $from = $options{from} if exists($options{from});
5374 my $to = join(',', $customer->invoicing_list_emailonly);
5375 $to = $options{to} if exists($options{to});
5377 my $subject = "Notice from " . $conf->config('company_name')
5378 if $conf->exists('company_name');
5379 $subject = $options{subject} if exists($options{subject});
5381 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5382 SOURCE => [ map "$_\n",
5383 $conf->config($template)]
5385 or die "can't create new Text::Template object: Text::Template::ERROR";
5386 $notify_template->compile()
5387 or die "can't compile template: Text::Template::ERROR";
5389 my $paydate = $customer->paydate || '2037-12-31';
5390 $FS::notify_template::_template::first = $customer->first;
5391 $FS::notify_template::_template::last = $customer->last;
5392 $FS::notify_template::_template::company = $customer->company;
5393 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5394 my $payby = $customer->payby;
5395 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5396 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5398 #credit cards expire at the end of the month/year of their exp date
5399 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5400 $FS::notify_template::_template::payby = 'credit card';
5401 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5402 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5404 }elsif ($payby eq 'COMP') {
5405 $FS::notify_template::_template::payby = 'complimentary account';
5407 $FS::notify_template::_template::payby = 'current method';
5409 $FS::notify_template::_template::expdate = $expire_time;
5411 for (keys %{$options{extra_fields}}){
5413 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5416 send_email(from => $from,
5418 subject => $subject,
5419 body => $notify_template->fill_in( PACKAGE =>
5420 'FS::notify_template::_template' ),
5425 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5427 Generates a templated notification to the customer (see L<Text::Template>).
5429 OPTIONS is a hash and may include
5431 I<extra_fields> - a hashref of name/value pairs which will be substituted
5432 into the template. These values may override values mentioned below
5433 and those from the customer record.
5435 The following variables are available in the template instead of or in addition
5436 to the fields of the customer record.
5438 I<$payby> - a description of the method of payment for the customer
5439 # would be nice to use FS::payby::shortname
5440 I<$payinfo> - the masked account information used to collect for this customer
5441 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5442 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5446 sub generate_letter {
5447 my ($self, $template, %options) = @_;
5449 return unless $conf->exists($template);
5451 my $letter_template = new Text::Template
5453 SOURCE => [ map "$_\n", $conf->config($template)],
5454 DELIMITERS => [ '[@--', '--@]' ],
5456 or die "can't create new Text::Template object: Text::Template::ERROR";
5458 $letter_template->compile()
5459 or die "can't compile template: Text::Template::ERROR";
5461 my %letter_data = map { $_ => $self->$_ } $self->fields;
5462 $letter_data{payinfo} = $self->mask_payinfo;
5464 my $paydate = $self->paydate || '2037-12-31';
5465 my $payby = $self->payby;
5466 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5467 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5469 #credit cards expire at the end of the month/year of their exp date
5470 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5471 $letter_data{payby} = 'credit card';
5472 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5473 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5475 }elsif ($payby eq 'COMP') {
5476 $letter_data{payby} = 'complimentary account';
5478 $letter_data{payby} = 'current method';
5480 $letter_data{expdate} = $expire_time;
5482 for (keys %{$options{extra_fields}}){
5483 $letter_data{$_} = $options{extra_fields}->{$_};
5486 unless(exists($letter_data{returnaddress})){
5487 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5488 $self->_agent_template)
5491 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5494 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5496 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5497 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5501 ) or die "can't open temp file: $!\n";
5503 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5505 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5509 =item print_ps TEMPLATE
5511 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5517 my $file = $self->generate_letter(@_);
5518 FS::Misc::generate_ps($file);
5521 =item print TEMPLATE
5523 Prints the filled in template.
5525 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5529 sub queueable_print {
5532 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5533 or die "invalid customer number: " . $opt{custvnum};
5535 my $error = $self->print( $opt{template} );
5536 die $error if $error;
5540 my ($self, $template) = (shift, shift);
5541 do_print [ $self->print_ps($template) ];
5544 sub agent_template {
5546 $self->_agent_plandata('agent_templatename');
5549 sub agent_invoice_from {
5551 $self->_agent_plandata('agent_invoice_from');
5554 sub _agent_plandata {
5555 my( $self, $option ) = @_;
5558 if ( driver_name =~ /^Pg/i ) {
5560 } elsif ( driver_name =~ /^mysql/i ) {
5563 die "don't know how to use regular expressions in ". driver_name. " databases";
5566 my $part_bill_event = qsearchs( 'part_bill_event',
5568 'payby' => $self->payby,
5569 'plan' => 'send_agent',
5570 'plandata' => { 'op' => $regexp,
5571 'value' => "(^|\n)agentnum ".
5579 'ORDER BY seconds LIMIT 1'
5582 return '' unless $part_bill_event;
5584 if ( $part_bill_event->plandata =~ /^$option (.*)$/m ) {
5587 warn "can't parse part_bill_event eventpart#". $part_bill_event->eventpart.
5588 " plandata for $option";
5600 The delete method should possibly take an FS::cust_main object reference
5601 instead of a scalar customer number.
5603 Bill and collect options should probably be passed as references instead of a
5606 There should probably be a configuration file with a list of allowed credit
5609 No multiple currency support (probably a larger project than just this module).
5611 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5613 Birthdates rely on negative epoch values.
5615 The payby for card/check batches is broken. With mixed batching, bad
5620 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5621 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5622 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.