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"
1294 last first company address1 address2 city county state zip
1295 country daytime night fax
1298 if ( defined $self->dbdef_table->column('ship_last') ) {
1299 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1301 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1305 $self->ut_name('ship_last')
1306 || $self->ut_name('ship_first')
1307 || $self->ut_textn('ship_company')
1308 || $self->ut_text('ship_address1')
1309 || $self->ut_textn('ship_address2')
1310 || $self->ut_text('ship_city')
1311 || $self->ut_textn('ship_county')
1312 || $self->ut_textn('ship_state')
1313 || $self->ut_country('ship_country')
1315 return $error if $error;
1317 #false laziness with above
1318 unless ( qsearchs('cust_main_county', {
1319 'country' => $self->ship_country,
1322 return "Unknown ship_state/ship_county/ship_country: ".
1323 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1324 unless qsearch('cust_main_county',{
1325 'state' => $self->ship_state,
1326 'county' => $self->ship_county,
1327 'country' => $self->ship_country,
1333 $self->ut_phonen('ship_daytime', $self->ship_country)
1334 || $self->ut_phonen('ship_night', $self->ship_country)
1335 || $self->ut_phonen('ship_fax', $self->ship_country)
1336 || $self->ut_zip('ship_zip', $self->ship_country)
1338 return $error if $error;
1340 } else { # ship_ info eq billing info, so don't store dup info in database
1341 $self->setfield("ship_$_", '')
1342 foreach qw( last first company address1 address2 city county state zip
1343 country daytime night fax );
1347 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1348 # or return "Illegal payby: ". $self->payby;
1350 FS::payby->can_payby($self->table, $self->payby)
1351 or return "Illegal payby: ". $self->payby;
1353 $error = $self->ut_numbern('paystart_month')
1354 || $self->ut_numbern('paystart_year')
1355 || $self->ut_numbern('payissue')
1356 || $self->ut_textn('paytype')
1358 return $error if $error;
1360 if ( $self->payip eq '' ) {
1363 $error = $self->ut_ip('payip');
1364 return $error if $error;
1367 # If it is encrypted and the private key is not availaible then we can't
1368 # check the credit card.
1370 my $check_payinfo = 1;
1372 if ($self->is_encrypted($self->payinfo)) {
1376 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1378 my $payinfo = $self->payinfo;
1379 $payinfo =~ s/\D//g;
1380 $payinfo =~ /^(\d{13,16})$/
1381 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1383 $self->payinfo($payinfo);
1385 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1387 return gettext('unknown_card_type')
1388 if cardtype($self->payinfo) eq "Unknown";
1390 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1392 return 'Banned credit card: banned on '.
1393 time2str('%a %h %o at %r', $ban->_date).
1394 ' by '. $ban->otaker.
1395 ' (ban# '. $ban->bannum. ')';
1398 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1399 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1400 $self->paycvv =~ /^(\d{4})$/
1401 or return "CVV2 (CID) for American Express cards is four digits.";
1404 $self->paycvv =~ /^(\d{3})$/
1405 or return "CVV2 (CVC2/CID) is three digits.";
1412 my $cardtype = cardtype($payinfo);
1413 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1415 return "Start date or issue number is required for $cardtype cards"
1416 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1418 return "Start month must be between 1 and 12"
1419 if $self->paystart_month
1420 and $self->paystart_month < 1 || $self->paystart_month > 12;
1422 return "Start year must be 1990 or later"
1423 if $self->paystart_year
1424 and $self->paystart_year < 1990;
1426 return "Issue number must be beween 1 and 99"
1428 and $self->payissue < 1 || $self->payissue > 99;
1431 $self->paystart_month('');
1432 $self->paystart_year('');
1433 $self->payissue('');
1436 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1438 my $payinfo = $self->payinfo;
1439 $payinfo =~ s/[^\d\@]//g;
1440 if ( $conf->exists('echeck-nonus') ) {
1441 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1442 $payinfo = "$1\@$2";
1444 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1445 $payinfo = "$1\@$2";
1447 $self->payinfo($payinfo);
1450 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1452 return 'Banned ACH account: banned on '.
1453 time2str('%a %h %o at %r', $ban->_date).
1454 ' by '. $ban->otaker.
1455 ' (ban# '. $ban->bannum. ')';
1458 } elsif ( $self->payby eq 'LECB' ) {
1460 my $payinfo = $self->payinfo;
1461 $payinfo =~ s/\D//g;
1462 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1464 $self->payinfo($payinfo);
1467 } elsif ( $self->payby eq 'BILL' ) {
1469 $error = $self->ut_textn('payinfo');
1470 return "Illegal P.O. number: ". $self->payinfo if $error;
1473 } elsif ( $self->payby eq 'COMP' ) {
1475 my $curuser = $FS::CurrentUser::CurrentUser;
1476 if ( ! $self->custnum
1477 && ! $curuser->access_right('Complimentary customer')
1480 return "You are not permitted to create complimentary accounts."
1483 $error = $self->ut_textn('payinfo');
1484 return "Illegal comp account issuer: ". $self->payinfo if $error;
1487 } elsif ( $self->payby eq 'PREPAY' ) {
1489 my $payinfo = $self->payinfo;
1490 $payinfo =~ s/\W//g; #anything else would just confuse things
1491 $self->payinfo($payinfo);
1492 $error = $self->ut_alpha('payinfo');
1493 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1494 return "Unknown prepayment identifier"
1495 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1500 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1501 return "Expiration date required"
1502 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1506 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1507 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1508 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1509 ( $m, $y ) = ( $3, "20$2" );
1511 return "Illegal expiration date: ". $self->paydate;
1513 $self->paydate("$y-$m-01");
1514 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1515 return gettext('expired_card')
1517 && !$ignore_expired_card
1518 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1521 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1522 ( ! $conf->exists('require_cardname')
1523 || $self->payby !~ /^(CARD|DCRD)$/ )
1525 $self->payname( $self->first. " ". $self->getfield('last') );
1527 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1528 or return gettext('illegal_name'). " payname: ". $self->payname;
1532 foreach my $flag (qw( tax spool_cdr )) {
1533 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1537 $self->otaker(getotaker) unless $self->otaker;
1539 warn "$me check AFTER: \n". $self->_dump
1542 $self->SUPER::check;
1547 Returns all packages (see L<FS::cust_pkg>) for this customer.
1554 return $self->num_pkgs unless wantarray;
1557 if ( $self->{'_pkgnum'} ) {
1558 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1560 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1563 sort sort_packages @cust_pkg;
1566 =item ncancelled_pkgs
1568 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1572 sub ncancelled_pkgs {
1575 return $self->num_ncancelled_pkgs unless wantarray;
1578 if ( $self->{'_pkgnum'} ) {
1580 @cust_pkg = grep { ! $_->getfield('cancel') }
1581 values %{ $self->{'_pkgnum'}->cache };
1586 qsearch( 'cust_pkg', {
1587 'custnum' => $self->custnum,
1591 qsearch( 'cust_pkg', {
1592 'custnum' => $self->custnum,
1597 sort sort_packages @cust_pkg;
1601 # This should be generalized to use config options to determine order.
1603 if ( $a->get('cancel') and $b->get('cancel') ) {
1604 $a->pkgnum <=> $b->pkgnum;
1605 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1606 return -1 if $b->get('cancel');
1607 return 1 if $a->get('cancel');
1610 $a->pkgnum <=> $b->pkgnum;
1614 =item suspended_pkgs
1616 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1620 sub suspended_pkgs {
1622 grep { $_->susp } $self->ncancelled_pkgs;
1625 =item unflagged_suspended_pkgs
1627 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1628 customer (thouse packages without the `manual_flag' set).
1632 sub unflagged_suspended_pkgs {
1634 return $self->suspended_pkgs
1635 unless dbdef->table('cust_pkg')->column('manual_flag');
1636 grep { ! $_->manual_flag } $self->suspended_pkgs;
1639 =item unsuspended_pkgs
1641 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1646 sub unsuspended_pkgs {
1648 grep { ! $_->susp } $self->ncancelled_pkgs;
1651 =item num_cancelled_pkgs
1653 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1658 sub num_cancelled_pkgs {
1659 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1662 sub num_ncancelled_pkgs {
1663 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1667 my( $self ) = shift;
1668 my $sql = scalar(@_) ? shift : '';
1669 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1670 my $sth = dbh->prepare(
1671 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1672 ) or die dbh->errstr;
1673 $sth->execute($self->custnum) or die $sth->errstr;
1674 $sth->fetchrow_arrayref->[0];
1679 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1680 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1681 on success or a list of errors.
1687 grep { $_->unsuspend } $self->suspended_pkgs;
1692 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1694 Returns a list: an empty list on success or a list of errors.
1700 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1703 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1705 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1706 PKGPARTs (see L<FS::part_pkg>).
1708 Returns a list: an empty list on success or a list of errors.
1712 sub suspend_if_pkgpart {
1714 my (@pkgparts, %opt);
1715 if (ref($_[0]) eq 'HASH'){
1716 @pkgparts = @{$_[0]{pkgparts}};
1721 grep { $_->suspend(%opt) }
1722 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1723 $self->unsuspended_pkgs;
1726 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1728 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1729 listed PKGPARTs (see L<FS::part_pkg>).
1731 Returns a list: an empty list on success or a list of errors.
1735 sub suspend_unless_pkgpart {
1737 my (@pkgparts, %opt);
1738 if (ref($_[0]) eq 'HASH'){
1739 @pkgparts = @{$_[0]{pkgparts}};
1744 grep { $_->suspend(%opt) }
1745 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1746 $self->unsuspended_pkgs;
1749 =item cancel [ OPTION => VALUE ... ]
1751 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1753 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1755 I<quiet> can be set true to supress email cancellation notices.
1757 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1759 I<ban> can be set true to ban this customer's credit card or ACH information,
1762 Always returns a list: an empty list on success or a list of errors.
1770 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1772 #should try decryption (we might have the private key)
1773 # and if not maybe queue a job for the server that does?
1774 return ( "Can't (yet) ban encrypted credit cards" )
1775 if $self->is_encrypted($self->payinfo);
1777 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1778 my $error = $ban->insert;
1779 return ( $error ) if $error;
1783 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1786 sub _banned_pay_hashref {
1797 'payby' => $payby2ban{$self->payby},
1798 'payinfo' => md5_base64($self->payinfo),
1799 #don't ever *search* on reason! #'reason' =>
1805 Returns all notes (see L<FS::cust_main_note>) for this customer.
1812 qsearch( 'cust_main_note',
1813 { 'custnum' => $self->custnum },
1815 'ORDER BY _DATE DESC'
1821 Returns the agent (see L<FS::agent>) for this customer.
1827 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1832 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1833 conjunction with the collect method.
1835 If there is an error, returns the error, otherwise returns false.
1837 Options are passed as name-value pairs. Currently available options are:
1841 =item resetup - if set true, re-charges setup fees.
1843 =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:
1847 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1849 =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.
1856 my( $self, %options ) = @_;
1857 return '' if $self->payby eq 'COMP';
1858 warn "$me bill customer ". $self->custnum. "\n"
1861 my $time = $options{'time'} || time;
1866 local $SIG{HUP} = 'IGNORE';
1867 local $SIG{INT} = 'IGNORE';
1868 local $SIG{QUIT} = 'IGNORE';
1869 local $SIG{TERM} = 'IGNORE';
1870 local $SIG{TSTP} = 'IGNORE';
1871 local $SIG{PIPE} = 'IGNORE';
1873 my $oldAutoCommit = $FS::UID::AutoCommit;
1874 local $FS::UID::AutoCommit = 0;
1877 $self->select_for_update; #mutex
1879 #create a new invoice
1880 #(we'll remove it later if it doesn't actually need to be generated [contains
1881 # no line items] and we're inside a transaciton so nothing else will see it)
1882 my $cust_bill = new FS::cust_bill ( {
1883 'custnum' => $self->custnum,
1884 '_date' => ( $options{'invoice_time'} || $time ),
1885 #'charged' => $charged,
1888 $error = $cust_bill->insert;
1890 $dbh->rollback if $oldAutoCommit;
1891 return "can't create invoice for customer #". $self->custnum. ": $error";
1893 my $invnum = $cust_bill->invnum;
1896 # find the packages which are due for billing, find out how much they are
1897 # & generate invoice database.
1900 my( $total_setup, $total_recur ) = ( 0, 0 );
1902 my @precommit_hooks = ();
1904 foreach my $cust_pkg (
1905 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1908 #NO!! next if $cust_pkg->cancel;
1909 next if $cust_pkg->getfield('cancel');
1911 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1913 #? to avoid use of uninitialized value errors... ?
1914 $cust_pkg->setfield('bill', '')
1915 unless defined($cust_pkg->bill);
1917 my $part_pkg = $cust_pkg->part_pkg;
1919 my %hash = $cust_pkg->hash;
1920 my $old_cust_pkg = new FS::cust_pkg \%hash;
1929 if ( ! $cust_pkg->setup &&
1931 ( $conf->exists('disable_setup_suspended_pkgs') &&
1932 ! $cust_pkg->getfield('susp')
1933 ) || ! $conf->exists('disable_setup_suspended_pkgs')
1935 || $options{'resetup'}
1938 warn " bill setup\n" if $DEBUG > 1;
1940 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
1942 $dbh->rollback if $oldAutoCommit;
1943 return "$@ running calc_setup for $cust_pkg\n";
1946 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1950 # bill recurring fee
1955 if ( $part_pkg->getfield('freq') ne '0' &&
1956 ! $cust_pkg->getfield('susp') &&
1957 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1960 warn " bill recur\n" if $DEBUG > 1;
1962 # XXX shared with $recur_prog
1963 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1965 #over two params! lets at least switch to a hashref for the rest...
1966 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1968 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1970 $dbh->rollback if $oldAutoCommit;
1971 return "$@ running calc_recur for $cust_pkg\n";
1974 #change this bit to use Date::Manip? CAREFUL with timezones (see
1975 # mailing list archive)
1976 my ($sec,$min,$hour,$mday,$mon,$year) =
1977 (localtime($sdate) )[0,1,2,3,4,5];
1979 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1980 # only for figuring next bill date, nothing else, so, reset $sdate again
1982 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1983 $cust_pkg->last_bill($sdate)
1984 if $cust_pkg->dbdef_table->column('last_bill');
1986 if ( $part_pkg->freq =~ /^\d+$/ ) {
1987 $mon += $part_pkg->freq;
1988 until ( $mon < 12 ) { $mon -= 12; $year++; }
1989 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1991 $mday += $weeks * 7;
1992 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1995 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1999 $dbh->rollback if $oldAutoCommit;
2000 return "unparsable frequency: ". $part_pkg->freq;
2002 $cust_pkg->setfield('bill',
2003 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2006 warn "\$setup is undefined" unless defined($setup);
2007 warn "\$recur is undefined" unless defined($recur);
2008 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2011 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2014 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2016 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2019 $error=$cust_pkg->replace($old_cust_pkg,
2020 options => { $cust_pkg->options },
2022 if ( $error ) { #just in case
2023 $dbh->rollback if $oldAutoCommit;
2024 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2027 $setup = sprintf( "%.2f", $setup );
2028 $recur = sprintf( "%.2f", $recur );
2029 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2030 $dbh->rollback if $oldAutoCommit;
2031 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2033 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2034 $dbh->rollback if $oldAutoCommit;
2035 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2038 if ( $setup != 0 || $recur != 0 ) {
2040 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2042 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2043 'invnum' => $invnum,
2044 'pkgnum' => $cust_pkg->pkgnum,
2048 'edate' => $cust_pkg->bill,
2049 'details' => \@details,
2051 $error = $cust_bill_pkg->insert;
2053 $dbh->rollback if $oldAutoCommit;
2054 return "can't create invoice line item for invoice #$invnum: $error";
2056 $total_setup += $setup;
2057 $total_recur += $recur;
2063 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2066 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2069 my %taxhash = map { $_ => $self->get("$prefix$_") }
2070 qw( state county country );
2072 $taxhash{'taxclass'} = $part_pkg->taxclass;
2074 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2077 $taxhash{'taxclass'} = '';
2078 @taxes = qsearch( 'cust_main_county', \%taxhash );
2081 #one more try at a whole-country tax rate
2083 $taxhash{$_} = '' foreach qw( state county );
2084 @taxes = qsearch( 'cust_main_county', \%taxhash );
2087 # maybe eliminate this entirely, along with all the 0% records
2089 $dbh->rollback if $oldAutoCommit;
2091 "fatal: can't find tax rate for state/county/country/taxclass ".
2092 join('/', ( map $self->get("$prefix$_"),
2093 qw(state county country)
2095 $part_pkg->taxclass ). "\n";
2098 foreach my $tax ( @taxes ) {
2100 my $taxable_charged = 0;
2101 $taxable_charged += $setup
2102 unless $part_pkg->setuptax =~ /^Y$/i
2103 || $tax->setuptax =~ /^Y$/i;
2104 $taxable_charged += $recur
2105 unless $part_pkg->recurtax =~ /^Y$/i
2106 || $tax->recurtax =~ /^Y$/i;
2107 next unless $taxable_charged;
2109 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2110 #my ($mon,$year) = (localtime($sdate) )[4,5];
2111 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2113 my $freq = $part_pkg->freq || 1;
2114 if ( $freq !~ /(\d+)$/ ) {
2115 $dbh->rollback if $oldAutoCommit;
2116 return "daily/weekly package definitions not (yet?)".
2117 " compatible with monthly tax exemptions";
2119 my $taxable_per_month =
2120 sprintf("%.2f", $taxable_charged / $freq );
2122 #call the whole thing off if this customer has any old
2123 #exemption records...
2124 my @cust_tax_exempt =
2125 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2126 if ( @cust_tax_exempt ) {
2127 $dbh->rollback if $oldAutoCommit;
2129 'this customer still has old-style tax exemption records; '.
2130 'run bin/fs-migrate-cust_tax_exempt?';
2133 foreach my $which_month ( 1 .. $freq ) {
2135 #maintain the new exemption table now
2138 FROM cust_tax_exempt_pkg
2139 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2140 LEFT JOIN cust_bill USING ( invnum )
2146 my $sth = dbh->prepare($sql) or do {
2147 $dbh->rollback if $oldAutoCommit;
2148 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2156 $dbh->rollback if $oldAutoCommit;
2157 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2159 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2161 my $remaining_exemption =
2162 $tax->exempt_amount - $existing_exemption;
2163 if ( $remaining_exemption > 0 ) {
2164 my $addl = $remaining_exemption > $taxable_per_month
2165 ? $taxable_per_month
2166 : $remaining_exemption;
2167 $taxable_charged -= $addl;
2169 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2170 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2171 'taxnum' => $tax->taxnum,
2172 'year' => 1900+$year,
2174 'amount' => sprintf("%.2f", $addl ),
2176 $error = $cust_tax_exempt_pkg->insert;
2178 $dbh->rollback if $oldAutoCommit;
2179 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2181 } # if $remaining_exemption > 0
2185 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2186 until ( $mon < 13 ) { $mon -= 12; $year++; }
2188 } #foreach $which_month
2190 } #if $tax->exempt_amount
2192 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2194 #$tax += $taxable_charged * $cust_main_county->tax / 100
2195 $tax{ $tax->taxname || 'Tax' } +=
2196 $taxable_charged * $tax->tax / 100
2198 } #foreach my $tax ( @taxes )
2200 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2202 } #if $setup != 0 || $recur != 0
2204 } #if $cust_pkg->modified
2206 } #foreach my $cust_pkg
2208 unless ( $cust_bill->cust_bill_pkg ) {
2209 $cust_bill->delete; #don't create an invoice w/o line items
2210 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2214 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2216 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2217 my $tax = sprintf("%.2f", $tax{$taxname} );
2218 $charged = sprintf( "%.2f", $charged+$tax );
2220 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2221 'invnum' => $invnum,
2227 'itemdesc' => $taxname,
2229 $error = $cust_bill_pkg->insert;
2231 $dbh->rollback if $oldAutoCommit;
2232 return "can't create invoice line item for invoice #$invnum: $error";
2234 $total_setup += $tax;
2238 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2239 $error = $cust_bill->replace;
2241 $dbh->rollback if $oldAutoCommit;
2242 return "can't update charged for invoice #$invnum: $error";
2245 foreach my $hook ( @precommit_hooks ) {
2247 &{$hook}; #($self) ?
2250 $dbh->rollback if $oldAutoCommit;
2251 return "$@ running precommit hook $hook\n";
2255 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2259 =item collect OPTIONS
2261 (Attempt to) collect money for this customer's outstanding invoices (see
2262 L<FS::cust_bill>). Usually used after the bill method.
2264 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2265 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2266 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2268 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2269 and the invoice events web interface.
2271 If there is an error, returns the error, otherwise returns false.
2273 Options are passed as name-value pairs.
2275 Currently available options are:
2277 invoice_time - Use this time when deciding when to print invoices and
2278 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>
2279 for conversion functions.
2281 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2284 quiet - set true to surpress email card/ACH decline notices.
2286 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2289 payby - allows for one time override of normal customer billing method
2294 my( $self, %options ) = @_;
2295 my $invoice_time = $options{'invoice_time'} || time;
2298 local $SIG{HUP} = 'IGNORE';
2299 local $SIG{INT} = 'IGNORE';
2300 local $SIG{QUIT} = 'IGNORE';
2301 local $SIG{TERM} = 'IGNORE';
2302 local $SIG{TSTP} = 'IGNORE';
2303 local $SIG{PIPE} = 'IGNORE';
2305 my $oldAutoCommit = $FS::UID::AutoCommit;
2306 local $FS::UID::AutoCommit = 0;
2309 $self->select_for_update; #mutex
2311 my $balance = $self->balance;
2312 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2314 unless ( $balance > 0 ) { #redundant?????
2315 $dbh->rollback if $oldAutoCommit; #hmm
2319 if ( exists($options{'retry_card'}) ) {
2320 carp 'retry_card option passed to collect is deprecated; use retry';
2321 $options{'retry'} ||= $options{'retry_card'};
2323 if ( exists($options{'retry'}) && $options{'retry'} ) {
2324 my $error = $self->retry_realtime;
2326 $dbh->rollback if $oldAutoCommit;
2332 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2333 $extra_sql = " AND freq = '1m' ";
2335 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2338 foreach my $cust_bill ( $self->open_cust_bill ) {
2340 # don't try to charge for the same invoice if it's already in a batch
2341 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2343 last if $self->balance <= 0;
2345 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2348 foreach my $part_bill_event ( due_events ( $cust_bill,
2349 exists($options{'payby'})
2355 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2356 || $self->balance <= 0; # or if balance<=0
2359 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2360 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2363 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2364 # gah, even with transactions.
2365 $dbh->commit if $oldAutoCommit; #well.
2374 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2379 =item retry_realtime
2381 Schedules realtime / batch credit card / electronic check / LEC billing
2382 events for for retry. Useful if card information has changed or manual
2383 retry is desired. The 'collect' method must be called to actually retry
2386 Implementation details: For each of this customer's open invoices, changes
2387 the status of the first "done" (with statustext error) realtime processing
2392 sub retry_realtime {
2395 local $SIG{HUP} = 'IGNORE';
2396 local $SIG{INT} = 'IGNORE';
2397 local $SIG{QUIT} = 'IGNORE';
2398 local $SIG{TERM} = 'IGNORE';
2399 local $SIG{TSTP} = 'IGNORE';
2400 local $SIG{PIPE} = 'IGNORE';
2402 my $oldAutoCommit = $FS::UID::AutoCommit;
2403 local $FS::UID::AutoCommit = 0;
2406 foreach my $cust_bill (
2407 grep { $_->cust_bill_event }
2408 $self->open_cust_bill
2410 my @cust_bill_event =
2411 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2413 #$_->part_bill_event->plan eq 'realtime-card'
2414 $_->part_bill_event->eventcode =~
2415 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2416 && $_->status eq 'done'
2419 $cust_bill->cust_bill_event;
2420 next unless @cust_bill_event;
2421 my $error = $cust_bill_event[0]->retry;
2423 $dbh->rollback if $oldAutoCommit;
2424 return "error scheduling invoice event for retry: $error";
2429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2434 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2436 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2437 via a Business::OnlinePayment realtime gateway. See
2438 L<http://420.am/business-onlinepayment> for supported gateways.
2440 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2442 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2444 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2445 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2446 if set, will override the value from the customer record.
2448 I<description> is a free-text field passed to the gateway. It defaults to
2449 "Internet services".
2451 If an I<invnum> is specified, this payment (if successful) is applied to the
2452 specified invoice. If you don't specify an I<invnum> you might want to
2453 call the B<apply_payments> method.
2455 I<quiet> can be set true to surpress email decline notices.
2457 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2458 resulting paynum, if any.
2460 I<payunique> is a unique identifier for this payment.
2462 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2469 my( $self, $method, $amount, %options ) = @_;
2471 warn "$me realtime_bop: $method $amount\n";
2472 warn " $_ => $options{$_}\n" foreach keys %options;
2475 $options{'description'} ||= 'Internet services';
2477 eval "use Business::OnlinePayment";
2480 my $payinfo = exists($options{'payinfo'})
2481 ? $options{'payinfo'}
2484 my %method2payby = (
2495 if ( $options{'invnum'} ) {
2496 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2497 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2499 map { $_->part_pkg->taxclass }
2501 map { $_->cust_pkg }
2502 $cust_bill->cust_bill_pkg;
2503 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2504 #different taxclasses
2505 $taxclass = $taxclasses[0];
2509 #look for an agent gateway override first
2511 if ( $method eq 'CC' ) {
2512 $cardtype = cardtype($payinfo);
2513 } elsif ( $method eq 'ECHECK' ) {
2516 $cardtype = $method;
2520 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2521 cardtype => $cardtype,
2522 taxclass => $taxclass, } )
2523 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2525 taxclass => $taxclass, } )
2526 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2527 cardtype => $cardtype,
2529 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2531 taxclass => '', } );
2533 my $payment_gateway = '';
2534 my( $processor, $login, $password, $action, @bop_options );
2535 if ( $override ) { #use a payment gateway override
2537 $payment_gateway = $override->payment_gateway;
2539 $processor = $payment_gateway->gateway_module;
2540 $login = $payment_gateway->gateway_username;
2541 $password = $payment_gateway->gateway_password;
2542 $action = $payment_gateway->gateway_action;
2543 @bop_options = $payment_gateway->options;
2545 } else { #use the standard settings from the config
2547 ( $processor, $login, $password, $action, @bop_options ) =
2548 $self->default_payment_gateway($method);
2556 my $address = exists($options{'address1'})
2557 ? $options{'address1'}
2559 my $address2 = exists($options{'address2'})
2560 ? $options{'address2'}
2562 $address .= ", ". $address2 if length($address2);
2564 my $o_payname = exists($options{'payname'})
2565 ? $options{'payname'}
2567 my($payname, $payfirst, $paylast);
2568 if ( $o_payname && $method ne 'ECHECK' ) {
2569 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2570 or return "Illegal payname $payname";
2571 ($payfirst, $paylast) = ($1, $2);
2573 $payfirst = $self->getfield('first');
2574 $paylast = $self->getfield('last');
2575 $payname = "$payfirst $paylast";
2578 my @invoicing_list = $self->invoicing_list_emailonly;
2579 if ( $conf->exists('emailinvoiceautoalways')
2580 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2581 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2582 push @invoicing_list, $self->all_emails;
2585 my $email = ($conf->exists('business-onlinepayment-email-override'))
2586 ? $conf->config('business-onlinepayment-email-override')
2587 : $invoicing_list[0];
2591 my $payip = exists($options{'payip'})
2594 $content{customer_ip} = $payip
2597 $content{invoice_number} = $options{'invnum'}
2598 if exists($options{'invnum'}) && length($options{'invnum'});
2600 $content{email_customer} =
2601 ( $conf->exists('business-onlinepayment-email_customer')
2602 || $conf->exists('business-onlinepayment-email-override') );
2605 if ( $method eq 'CC' ) {
2607 $content{card_number} = $payinfo;
2608 $paydate = exists($options{'paydate'})
2609 ? $options{'paydate'}
2611 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2612 $content{expiration} = "$2/$1";
2614 my $paycvv = exists($options{'paycvv'})
2615 ? $options{'paycvv'}
2617 $content{cvv2} = $paycvv
2620 my $paystart_month = exists($options{'paystart_month'})
2621 ? $options{'paystart_month'}
2622 : $self->paystart_month;
2624 my $paystart_year = exists($options{'paystart_year'})
2625 ? $options{'paystart_year'}
2626 : $self->paystart_year;
2628 $content{card_start} = "$paystart_month/$paystart_year"
2629 if $paystart_month && $paystart_year;
2631 my $payissue = exists($options{'payissue'})
2632 ? $options{'payissue'}
2634 $content{issue_number} = $payissue if $payissue;
2636 $content{recurring_billing} = 'YES'
2637 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2639 'payinfo' => $payinfo,
2641 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2643 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2647 } elsif ( $method eq 'ECHECK' ) {
2648 ( $content{account_number}, $content{routing_code} ) =
2649 split('@', $payinfo);
2650 $content{bank_name} = $o_payname;
2651 $content{bank_state} = exists($options{'paystate'})
2652 ? $options{'paystate'}
2653 : $self->getfield('paystate');
2654 $content{account_type} = exists($options{'paytype'})
2655 ? uc($options{'paytype'}) || 'CHECKING'
2656 : uc($self->getfield('paytype')) || 'CHECKING';
2657 $content{account_name} = $payname;
2658 $content{customer_org} = $self->company ? 'B' : 'I';
2659 $content{state_id} = exists($options{'stateid'})
2660 ? $options{'stateid'}
2661 : $self->getfield('stateid');
2662 $content{state_id_state} = exists($options{'stateid_state'})
2663 ? $options{'stateid_state'}
2664 : $self->getfield('stateid_state');
2665 $content{customer_ssn} = exists($options{'ss'})
2668 } elsif ( $method eq 'LEC' ) {
2669 $content{phone} = $payinfo;
2673 # run transaction(s)
2676 my $balance = exists( $options{'balance'} )
2677 ? $options{'balance'}
2680 $self->select_for_update; #mutex ... just until we get our pending record in
2682 #the checks here are intended to catch concurrent payments
2683 #double-form-submission prevention is taken care of in cust_pay_pending::check
2686 return "The customer's balance has changed; $method transaction aborted."
2687 if $self->balance < $balance;
2688 #&& $self->balance < $amount; #might as well anyway?
2690 #also check and make sure there aren't *other* pending payments for this cust
2692 my @pending = qsearch('cust_pay_pending', {
2693 'custnum' => $self->custnum,
2694 'status' => { op=>'!=', value=>'done' }
2696 return "A payment is already being processed for this customer (".
2697 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
2698 "); $method transaction aborted."
2699 if scalar(@pending);
2701 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
2703 my $cust_pay_pending = new FS::cust_pay_pending {
2704 'custnum' => $self->custnum,
2705 #'invnum' => $options{'invnum'},
2708 'payby' => $method2payby{$method},
2709 'payinfo' => $payinfo,
2710 'paydate' => $paydate,
2712 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
2714 $cust_pay_pending->payunique( $options{payunique} )
2715 if length($options{payunique});
2716 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
2717 return $cpp_new_err if $cpp_new_err;
2719 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2721 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2722 $transaction->content(
2725 'password' => $password,
2726 'action' => $action1,
2727 'description' => $options{'description'},
2728 'amount' => $amount,
2729 #'invoice_number' => $options{'invnum'},
2730 'customer_id' => $self->custnum,
2731 'last_name' => $paylast,
2732 'first_name' => $payfirst,
2734 'address' => $address,
2735 'city' => ( exists($options{'city'})
2738 'state' => ( exists($options{'state'})
2741 'zip' => ( exists($options{'zip'})
2744 'country' => ( exists($options{'country'})
2745 ? $options{'country'}
2747 'referer' => 'http://cleanwhisker.420.am/',
2749 'phone' => $self->daytime || $self->night,
2753 $cust_pay_pending->status('pending');
2754 my $cpp_pending_err = $cust_pay_pending->replace;
2755 return $cpp_pending_err if $cpp_pending_err;
2757 $transaction->submit();
2759 if ( $transaction->is_success() && $action2 ) {
2761 $cust_pay_pending->status('authorized');
2762 my $cpp_authorized_err = $cust_pay_pending->replace;
2763 return $cpp_authorized_err if $cpp_authorized_err;
2765 my $auth = $transaction->authorization;
2766 my $ordernum = $transaction->can('order_number')
2767 ? $transaction->order_number
2771 new Business::OnlinePayment( $processor, @bop_options );
2778 password => $password,
2779 order_number => $ordernum,
2781 authorization => $auth,
2782 description => $options{'description'},
2785 foreach my $field (qw( authorization_source_code returned_ACI
2786 transaction_identifier validation_code
2787 transaction_sequence_num local_transaction_date
2788 local_transaction_time AVS_result_code )) {
2789 $capture{$field} = $transaction->$field() if $transaction->can($field);
2792 $capture->content( %capture );
2796 unless ( $capture->is_success ) {
2797 my $e = "Authorization successful but capture failed, custnum #".
2798 $self->custnum. ': '. $capture->result_code.
2799 ": ". $capture->error_message;
2806 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
2807 my $cpp_captured_err = $cust_pay_pending->replace;
2808 return $cpp_captured_err if $cpp_captured_err;
2811 # remove paycvv after initial transaction
2814 #false laziness w/misc/process/payment.cgi - check both to make sure working
2816 if ( defined $self->dbdef_table->column('paycvv')
2817 && length($self->paycvv)
2818 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2820 my $error = $self->remove_cvv;
2822 warn "WARNING: error removing cvv: $error\n";
2830 if ( $transaction->is_success() ) {
2833 if ( $payment_gateway ) { # agent override
2834 $paybatch = $payment_gateway->gatewaynum. '-';
2837 $paybatch .= "$processor:". $transaction->authorization;
2839 $paybatch .= ':'. $transaction->order_number
2840 if $transaction->can('order_number')
2841 && length($transaction->order_number);
2843 my $cust_pay = new FS::cust_pay ( {
2844 'custnum' => $self->custnum,
2845 'invnum' => $options{'invnum'},
2848 'payby' => $method2payby{$method},
2849 'payinfo' => $payinfo,
2850 'paybatch' => $paybatch,
2851 'paydate' => $paydate,
2853 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
2854 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
2856 my $oldAutoCommit = $FS::UID::AutoCommit;
2857 local $FS::UID::AutoCommit = 0;
2860 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
2862 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
2865 $cust_pay->invnum(''); #try again with no specific invnum
2866 my $error2 = $cust_pay->insert( $options{'manual'} ?
2867 ( 'manual' => 1 ) : ()
2870 # gah. but at least we have a record of the state we had to abort in
2871 # from cust_pay_pending now.
2872 my $e = "WARNING: $method captured but payment not recorded - ".
2873 "error inserting payment ($processor): $error2".
2874 " (previously tried insert with invnum #$options{'invnum'}" .
2875 ": $error ) - pending payment saved as paypendingnum ".
2876 $cust_pay_pending->paypendingnum. "\n";
2882 if ( $options{'paynum_ref'} ) {
2883 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
2886 $cust_pay_pending->status('done');
2887 $cust_pay_pending->statustext('captured');
2888 my $cpp_done_err = $cust_pay_pending->replace;
2890 if ( $cpp_done_err ) {
2892 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2893 my $e = "WARNING: $method captured but payment not recorded - ".
2894 "error updating status for paypendingnum ".
2895 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
2901 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2902 return ''; #no error
2908 my $perror = "$processor error: ". $transaction->error_message;
2910 unless ( $transaction->error_message ) {
2913 #this should be normalized :/
2915 # bad, ad-hoc B:OP:PayflowPro "transaction_response" BS
2916 if ( $transaction->can('param')
2917 && $transaction->param('transaction_response') ) {
2918 $t_response = $transaction->param('transaction_response')
2920 # slightly better, ad-hoc B:OP:TransactionCentral without "param"
2921 } elsif ( $transaction->can('response_page') ) {
2923 'page' => ( $transaction->can('response_page')
2924 ? $transaction->response_page
2927 'code' => ( $transaction->can('response_code')
2928 ? $transaction->response_code
2931 'headers' => ( $transaction->can('response_headers')
2932 ? $transaction->response_headers
2938 "No additional debugging information available for $processor";
2941 $perror .= "No error_message returned from $processor -- ".
2942 ( ref($t_response) ? Dumper($t_response) : $t_response );
2946 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2947 && $conf->exists('emaildecline')
2948 && grep { $_ ne 'POST' } $self->invoicing_list
2949 && ! grep { $transaction->error_message =~ /$_/ }
2950 $conf->config('emaildecline-exclude')
2952 my @templ = $conf->config('declinetemplate');
2953 my $template = new Text::Template (
2955 SOURCE => [ map "$_\n", @templ ],
2956 ) or return "($perror) can't create template: $Text::Template::ERROR";
2957 $template->compile()
2958 or return "($perror) can't compile template: $Text::Template::ERROR";
2960 my $templ_hash = { error => $transaction->error_message };
2962 my $error = send_email(
2963 'from' => $conf->config('invoice_from'),
2964 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2965 'subject' => 'Your payment could not be processed',
2966 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2969 $perror .= " (also received error sending decline notification: $error)"
2974 $cust_pay_pending->status('done');
2975 $cust_pay_pending->statustext("declined: $perror");
2976 my $cpp_done_err = $cust_pay_pending->replace;
2977 if ( $cpp_done_err ) {
2978 my $e = "WARNING: $method declined but pending payment not resolved - ".
2979 "error updating status for paypendingnum ".
2980 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
2982 $perror = "$e ($perror)";
2990 =item default_payment_gateway
2994 sub default_payment_gateway {
2995 my( $self, $method ) = @_;
2997 die "Real-time processing not enabled\n"
2998 unless $conf->exists('business-onlinepayment');
3001 my $bop_config = 'business-onlinepayment';
3002 $bop_config .= '-ach'
3003 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3004 my ( $processor, $login, $password, $action, @bop_options ) =
3005 $conf->config($bop_config);
3006 $action ||= 'normal authorization';
3007 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3008 die "No real-time processor is enabled - ".
3009 "did you set the business-onlinepayment configuration value?\n"
3012 ( $processor, $login, $password, $action, @bop_options )
3017 Removes the I<paycvv> field from the database directly.
3019 If there is an error, returns the error, otherwise returns false.
3025 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3026 or return dbh->errstr;
3027 $sth->execute($self->custnum)
3028 or return $sth->errstr;
3033 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3035 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3036 via a Business::OnlinePayment realtime gateway. See
3037 L<http://420.am/business-onlinepayment> for supported gateways.
3039 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3041 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3043 Most gateways require a reference to an original payment transaction to refund,
3044 so you probably need to specify a I<paynum>.
3046 I<amount> defaults to the original amount of the payment if not specified.
3048 I<reason> specifies a reason for the refund.
3050 I<paydate> specifies the expiration date for a credit card overriding the
3051 value from the customer record or the payment record. Specified as yyyy-mm-dd
3053 Implementation note: If I<amount> is unspecified or equal to the amount of the
3054 orignal payment, first an attempt is made to "void" the transaction via
3055 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3056 the normal attempt is made to "refund" ("credit") the transaction via the
3057 gateway is attempted.
3059 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3060 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3061 #if set, will override the value from the customer record.
3063 #If an I<invnum> is specified, this payment (if successful) is applied to the
3064 #specified invoice. If you don't specify an I<invnum> you might want to
3065 #call the B<apply_payments> method.
3069 #some false laziness w/realtime_bop, not enough to make it worth merging
3070 #but some useful small subs should be pulled out
3071 sub realtime_refund_bop {
3072 my( $self, $method, %options ) = @_;
3074 warn "$me realtime_refund_bop: $method refund\n";
3075 warn " $_ => $options{$_}\n" foreach keys %options;
3078 eval "use Business::OnlinePayment";
3082 # look up the original payment and optionally a gateway for that payment
3086 my $amount = $options{'amount'};
3088 my( $processor, $login, $password, @bop_options ) ;
3089 my( $auth, $order_number ) = ( '', '', '' );
3091 if ( $options{'paynum'} ) {
3093 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3094 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3095 or return "Unknown paynum $options{'paynum'}";
3096 $amount ||= $cust_pay->paid;
3098 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3099 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3100 $cust_pay->paybatch;
3101 my $gatewaynum = '';
3102 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3104 if ( $gatewaynum ) { #gateway for the payment to be refunded
3106 my $payment_gateway =
3107 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3108 die "payment gateway $gatewaynum not found"
3109 unless $payment_gateway;
3111 $processor = $payment_gateway->gateway_module;
3112 $login = $payment_gateway->gateway_username;
3113 $password = $payment_gateway->gateway_password;
3114 @bop_options = $payment_gateway->options;
3116 } else { #try the default gateway
3118 my( $conf_processor, $unused_action );
3119 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3120 $self->default_payment_gateway($method);
3122 return "processor of payment $options{'paynum'} $processor does not".
3123 " match default processor $conf_processor"
3124 unless $processor eq $conf_processor;
3129 } else { # didn't specify a paynum, so look for agent gateway overrides
3130 # like a normal transaction
3133 if ( $method eq 'CC' ) {
3134 $cardtype = cardtype($self->payinfo);
3135 } elsif ( $method eq 'ECHECK' ) {
3138 $cardtype = $method;
3141 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3142 cardtype => $cardtype,
3144 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3146 taxclass => '', } );
3148 if ( $override ) { #use a payment gateway override
3150 my $payment_gateway = $override->payment_gateway;
3152 $processor = $payment_gateway->gateway_module;
3153 $login = $payment_gateway->gateway_username;
3154 $password = $payment_gateway->gateway_password;
3155 #$action = $payment_gateway->gateway_action;
3156 @bop_options = $payment_gateway->options;
3158 } else { #use the standard settings from the config
3161 ( $processor, $login, $password, $unused_action, @bop_options ) =
3162 $self->default_payment_gateway($method);
3167 return "neither amount nor paynum specified" unless $amount;
3172 'password' => $password,
3173 'order_number' => $order_number,
3174 'amount' => $amount,
3175 'referer' => 'http://cleanwhisker.420.am/',
3177 $content{authorization} = $auth
3178 if length($auth); #echeck/ACH transactions have an order # but no auth
3179 #(at least with authorize.net)
3181 my $disable_void_after;
3182 if ($conf->exists('disable_void_after')
3183 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3184 $disable_void_after = $1;
3187 #first try void if applicable
3188 if ( $cust_pay && $cust_pay->paid == $amount
3190 ( not defined($disable_void_after) )
3191 || ( time < ($cust_pay->_date + $disable_void_after ) )
3194 warn " attempting void\n" if $DEBUG > 1;
3195 my $void = new Business::OnlinePayment( $processor, @bop_options );
3196 $void->content( 'action' => 'void', %content );
3198 if ( $void->is_success ) {
3199 my $error = $cust_pay->void($options{'reason'});
3201 # gah, even with transactions.
3202 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3203 "error voiding payment: $error";
3207 warn " void successful\n" if $DEBUG > 1;
3212 warn " void unsuccessful, trying refund\n"
3216 my $address = $self->address1;
3217 $address .= ", ". $self->address2 if $self->address2;
3219 my($payname, $payfirst, $paylast);
3220 if ( $self->payname && $method ne 'ECHECK' ) {
3221 $payname = $self->payname;
3222 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3223 or return "Illegal payname $payname";
3224 ($payfirst, $paylast) = ($1, $2);
3226 $payfirst = $self->getfield('first');
3227 $paylast = $self->getfield('last');
3228 $payname = "$payfirst $paylast";
3231 my @invoicing_list = $self->invoicing_list_emailonly;
3232 if ( $conf->exists('emailinvoiceautoalways')
3233 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3234 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3235 push @invoicing_list, $self->all_emails;
3238 my $email = ($conf->exists('business-onlinepayment-email-override'))
3239 ? $conf->config('business-onlinepayment-email-override')
3240 : $invoicing_list[0];
3242 my $payip = exists($options{'payip'})
3245 $content{customer_ip} = $payip
3249 if ( $method eq 'CC' ) {
3252 $content{card_number} = $payinfo = $cust_pay->payinfo;
3253 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3254 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3255 ($content{expiration} = "$2/$1"); # where available
3257 $content{card_number} = $payinfo = $self->payinfo;
3258 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3259 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3260 $content{expiration} = "$2/$1";
3263 } elsif ( $method eq 'ECHECK' ) {
3266 $payinfo = $cust_pay->payinfo;
3268 $payinfo = $self->payinfo;
3270 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3271 $content{bank_name} = $self->payname;
3272 $content{account_type} = 'CHECKING';
3273 $content{account_name} = $payname;
3274 $content{customer_org} = $self->company ? 'B' : 'I';
3275 $content{customer_ssn} = $self->ss;
3276 } elsif ( $method eq 'LEC' ) {
3277 $content{phone} = $payinfo = $self->payinfo;
3281 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3282 my %sub_content = $refund->content(
3283 'action' => 'credit',
3284 'customer_id' => $self->custnum,
3285 'last_name' => $paylast,
3286 'first_name' => $payfirst,
3288 'address' => $address,
3289 'city' => $self->city,
3290 'state' => $self->state,
3291 'zip' => $self->zip,
3292 'country' => $self->country,
3294 'phone' => $self->daytime || $self->night,
3297 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3301 return "$processor error: ". $refund->error_message
3302 unless $refund->is_success();
3304 my %method2payby = (
3310 my $paybatch = "$processor:". $refund->authorization;
3311 $paybatch .= ':'. $refund->order_number
3312 if $refund->can('order_number') && $refund->order_number;
3314 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3315 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3316 last unless @cust_bill_pay;
3317 my $cust_bill_pay = pop @cust_bill_pay;
3318 my $error = $cust_bill_pay->delete;
3322 my $cust_refund = new FS::cust_refund ( {
3323 'custnum' => $self->custnum,
3324 'paynum' => $options{'paynum'},
3325 'refund' => $amount,
3327 'payby' => $method2payby{$method},
3328 'payinfo' => $payinfo,
3329 'paybatch' => $paybatch,
3330 'reason' => $options{'reason'} || 'card or ACH refund',
3332 my $error = $cust_refund->insert;
3334 $cust_refund->paynum(''); #try again with no specific paynum
3335 my $error2 = $cust_refund->insert;
3337 # gah, even with transactions.
3338 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3339 "error inserting refund ($processor): $error2".
3340 " (previously tried insert with paynum #$options{'paynum'}" .
3351 =item batch_card OPTION => VALUE...
3353 Adds a payment for this invoice to the pending credit card batch (see
3354 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3355 runs the payment using a realtime gateway.
3360 my ($self, %options) = @_;
3363 if (exists($options{amount})) {
3364 $amount = $options{amount};
3366 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3368 return '' unless $amount > 0;
3370 my $invnum = delete $options{invnum};
3371 my $payby = $options{invnum} || $self->payby; #dubious
3373 if ($options{'realtime'}) {
3374 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3380 my $oldAutoCommit = $FS::UID::AutoCommit;
3381 local $FS::UID::AutoCommit = 0;
3384 #this needs to handle mysql as well as Pg, like svc_acct.pm
3385 #(make it into a common function if folks need to do batching with mysql)
3386 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3387 or return "Cannot lock pay_batch: " . $dbh->errstr;
3391 'payby' => FS::payby->payby2payment($payby),
3394 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3396 unless ( $pay_batch ) {
3397 $pay_batch = new FS::pay_batch \%pay_batch;
3398 my $error = $pay_batch->insert;
3400 $dbh->rollback if $oldAutoCommit;
3401 die "error creating new batch: $error\n";
3405 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3406 'batchnum' => $pay_batch->batchnum,
3407 'custnum' => $self->custnum,
3410 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3412 $options{$_} = '' unless exists($options{$_});
3415 my $cust_pay_batch = new FS::cust_pay_batch ( {
3416 'batchnum' => $pay_batch->batchnum,
3417 'invnum' => $invnum || 0, # is there a better value?
3418 # this field should be
3420 # cust_bill_pay_batch now
3421 'custnum' => $self->custnum,
3422 'last' => $self->getfield('last'),
3423 'first' => $self->getfield('first'),
3424 'address1' => $options{address1} || $self->address1,
3425 'address2' => $options{address2} || $self->address2,
3426 'city' => $options{city} || $self->city,
3427 'state' => $options{state} || $self->state,
3428 'zip' => $options{zip} || $self->zip,
3429 'country' => $options{country} || $self->country,
3430 'payby' => $options{payby} || $self->payby,
3431 'payinfo' => $options{payinfo} || $self->payinfo,
3432 'exp' => $options{paydate} || $self->paydate,
3433 'payname' => $options{payname} || $self->payname,
3434 'amount' => $amount, # consolidating
3437 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3438 if $old_cust_pay_batch;
3441 if ($old_cust_pay_batch) {
3442 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3444 $error = $cust_pay_batch->insert;
3448 $dbh->rollback if $oldAutoCommit;
3452 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3453 foreach my $cust_bill ($self->open_cust_bill) {
3454 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3455 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3456 'invnum' => $cust_bill->invnum,
3457 'paybatchnum' => $cust_pay_batch->paybatchnum,
3458 'amount' => $cust_bill->owed,
3461 if ($unapplied >= $cust_bill_pay_batch->amount){
3462 $unapplied -= $cust_bill_pay_batch->amount;
3465 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3466 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3468 $error = $cust_bill_pay_batch->insert;
3470 $dbh->rollback if $oldAutoCommit;
3475 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3481 Returns the total owed for this customer on all invoices
3482 (see L<FS::cust_bill/owed>).
3488 $self->total_owed_date(2145859200); #12/31/2037
3491 =item total_owed_date TIME
3493 Returns the total owed for this customer on all invoices with date earlier than
3494 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3495 see L<Time::Local> and L<Date::Parse> for conversion functions.
3499 sub total_owed_date {
3503 foreach my $cust_bill (
3504 grep { $_->_date <= $time }
3505 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3507 $total_bill += $cust_bill->owed;
3509 sprintf( "%.2f", $total_bill );
3512 =item apply_payments_and_credits
3514 Applies unapplied payments and credits.
3516 In most cases, this new method should be used in place of sequential
3517 apply_payments and apply_credits methods.
3519 If there is an error, returns the error, otherwise returns false.
3523 sub apply_payments_and_credits {
3526 local $SIG{HUP} = 'IGNORE';
3527 local $SIG{INT} = 'IGNORE';
3528 local $SIG{QUIT} = 'IGNORE';
3529 local $SIG{TERM} = 'IGNORE';
3530 local $SIG{TSTP} = 'IGNORE';
3531 local $SIG{PIPE} = 'IGNORE';
3533 my $oldAutoCommit = $FS::UID::AutoCommit;
3534 local $FS::UID::AutoCommit = 0;
3537 $self->select_for_update; #mutex
3539 foreach my $cust_bill ( $self->open_cust_bill ) {
3540 my $error = $cust_bill->apply_payments_and_credits;
3542 $dbh->rollback if $oldAutoCommit;
3543 return "Error applying: $error";
3547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3552 =item apply_credits OPTION => VALUE ...
3554 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3555 to outstanding invoice balances in chronological order (or reverse
3556 chronological order if the I<order> option is set to B<newest>) and returns the
3557 value of any remaining unapplied credits available for refund (see
3558 L<FS::cust_refund>).
3560 Dies if there is an error.
3568 local $SIG{HUP} = 'IGNORE';
3569 local $SIG{INT} = 'IGNORE';
3570 local $SIG{QUIT} = 'IGNORE';
3571 local $SIG{TERM} = 'IGNORE';
3572 local $SIG{TSTP} = 'IGNORE';
3573 local $SIG{PIPE} = 'IGNORE';
3575 my $oldAutoCommit = $FS::UID::AutoCommit;
3576 local $FS::UID::AutoCommit = 0;
3579 $self->select_for_update; #mutex
3581 unless ( $self->total_credited ) {
3582 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3586 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3587 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3589 my @invoices = $self->open_cust_bill;
3590 @invoices = sort { $b->_date <=> $a->_date } @invoices
3591 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3594 foreach my $cust_bill ( @invoices ) {
3597 if ( !defined($credit) || $credit->credited == 0) {
3598 $credit = pop @credits or last;
3601 if ($cust_bill->owed >= $credit->credited) {
3602 $amount=$credit->credited;
3604 $amount=$cust_bill->owed;
3607 my $cust_credit_bill = new FS::cust_credit_bill ( {
3608 'crednum' => $credit->crednum,
3609 'invnum' => $cust_bill->invnum,
3610 'amount' => $amount,
3612 my $error = $cust_credit_bill->insert;
3614 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3618 redo if ($cust_bill->owed > 0);
3622 my $total_credited = $self->total_credited;
3624 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3626 return $total_credited;
3629 =item apply_payments
3631 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3632 to outstanding invoice balances in chronological order.
3634 #and returns the value of any remaining unapplied payments.
3636 Dies if there is an error.
3640 sub apply_payments {
3643 local $SIG{HUP} = 'IGNORE';
3644 local $SIG{INT} = 'IGNORE';
3645 local $SIG{QUIT} = 'IGNORE';
3646 local $SIG{TERM} = 'IGNORE';
3647 local $SIG{TSTP} = 'IGNORE';
3648 local $SIG{PIPE} = 'IGNORE';
3650 my $oldAutoCommit = $FS::UID::AutoCommit;
3651 local $FS::UID::AutoCommit = 0;
3654 $self->select_for_update; #mutex
3658 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3659 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3661 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3662 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3666 foreach my $cust_bill ( @invoices ) {
3669 if ( !defined($payment) || $payment->unapplied == 0 ) {
3670 $payment = pop @payments or last;
3673 if ( $cust_bill->owed >= $payment->unapplied ) {
3674 $amount = $payment->unapplied;
3676 $amount = $cust_bill->owed;
3679 my $cust_bill_pay = new FS::cust_bill_pay ( {
3680 'paynum' => $payment->paynum,
3681 'invnum' => $cust_bill->invnum,
3682 'amount' => $amount,
3684 my $error = $cust_bill_pay->insert;
3686 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3690 redo if ( $cust_bill->owed > 0);
3694 my $total_unapplied_payments = $self->total_unapplied_payments;
3696 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3698 return $total_unapplied_payments;
3701 =item total_credited
3703 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3704 customer. See L<FS::cust_credit/credited>.
3708 sub total_credited {
3710 my $total_credit = 0;
3711 foreach my $cust_credit ( qsearch('cust_credit', {
3712 'custnum' => $self->custnum,
3714 $total_credit += $cust_credit->credited;
3716 sprintf( "%.2f", $total_credit );
3719 =item total_unapplied_payments
3721 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3722 See L<FS::cust_pay/unapplied>.
3726 sub total_unapplied_payments {
3728 my $total_unapplied = 0;
3729 foreach my $cust_pay ( qsearch('cust_pay', {
3730 'custnum' => $self->custnum,
3732 $total_unapplied += $cust_pay->unapplied;
3734 sprintf( "%.2f", $total_unapplied );
3739 Returns the balance for this customer (total_owed minus total_credited
3740 minus total_unapplied_payments).
3747 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3751 =item balance_date TIME
3753 Returns the balance for this customer, only considering invoices with date
3754 earlier than TIME (total_owed_date minus total_credited minus
3755 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3756 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3765 $self->total_owed_date($time)
3766 - $self->total_credited
3767 - $self->total_unapplied_payments
3771 =item in_transit_payments
3773 Returns the total of requests for payments for this customer pending in
3774 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3778 sub in_transit_payments {
3780 my $in_transit_payments = 0;
3781 foreach my $pay_batch ( qsearch('pay_batch', {
3784 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3785 'batchnum' => $pay_batch->batchnum,
3786 'custnum' => $self->custnum,
3788 $in_transit_payments += $cust_pay_batch->amount;
3791 sprintf( "%.2f", $in_transit_payments );
3794 =item paydate_monthyear
3796 Returns a two-element list consisting of the month and year of this customer's
3797 paydate (credit card expiration date for CARD customers)
3801 sub paydate_monthyear {
3803 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3805 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3812 =item invoicing_list [ ARRAYREF ]
3814 If an arguement is given, sets these email addresses as invoice recipients
3815 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3816 (except as warnings), so use check_invoicing_list first.
3818 Returns a list of email addresses (with svcnum entries expanded).
3820 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3821 check it without disturbing anything by passing nothing.
3823 This interface may change in the future.
3827 sub invoicing_list {
3828 my( $self, $arrayref ) = @_;
3831 my @cust_main_invoice;
3832 if ( $self->custnum ) {
3833 @cust_main_invoice =
3834 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3836 @cust_main_invoice = ();
3838 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3839 #warn $cust_main_invoice->destnum;
3840 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3841 #warn $cust_main_invoice->destnum;
3842 my $error = $cust_main_invoice->delete;
3843 warn $error if $error;
3846 if ( $self->custnum ) {
3847 @cust_main_invoice =
3848 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3850 @cust_main_invoice = ();
3852 my %seen = map { $_->address => 1 } @cust_main_invoice;
3853 foreach my $address ( @{$arrayref} ) {
3854 next if exists $seen{$address} && $seen{$address};
3855 $seen{$address} = 1;
3856 my $cust_main_invoice = new FS::cust_main_invoice ( {
3857 'custnum' => $self->custnum,
3860 my $error = $cust_main_invoice->insert;
3861 warn $error if $error;
3865 if ( $self->custnum ) {
3867 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3874 =item check_invoicing_list ARRAYREF
3876 Checks these arguements as valid input for the invoicing_list method. If there
3877 is an error, returns the error, otherwise returns false.
3881 sub check_invoicing_list {
3882 my( $self, $arrayref ) = @_;
3884 foreach my $address ( @$arrayref ) {
3886 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3887 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3890 my $cust_main_invoice = new FS::cust_main_invoice ( {
3891 'custnum' => $self->custnum,
3894 my $error = $self->custnum
3895 ? $cust_main_invoice->check
3896 : $cust_main_invoice->checkdest
3898 return $error if $error;
3902 return "Email address required"
3903 if $conf->exists('cust_main-require_invoicing_list_email')
3904 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3909 =item set_default_invoicing_list
3911 Sets the invoicing list to all accounts associated with this customer,
3912 overwriting any previous invoicing list.
3916 sub set_default_invoicing_list {
3918 $self->invoicing_list($self->all_emails);
3923 Returns the email addresses of all accounts provisioned for this customer.
3930 foreach my $cust_pkg ( $self->all_pkgs ) {
3931 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3933 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3934 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3936 $list{$_}=1 foreach map { $_->email } @svc_acct;
3941 =item invoicing_list_addpost
3943 Adds postal invoicing to this customer. If this customer is already configured
3944 to receive postal invoices, does nothing.
3948 sub invoicing_list_addpost {
3950 return if grep { $_ eq 'POST' } $self->invoicing_list;
3951 my @invoicing_list = $self->invoicing_list;
3952 push @invoicing_list, 'POST';
3953 $self->invoicing_list(\@invoicing_list);
3956 =item invoicing_list_emailonly
3958 Returns the list of email invoice recipients (invoicing_list without non-email
3959 destinations such as POST and FAX).
3963 sub invoicing_list_emailonly {
3965 warn "$me invoicing_list_emailonly called"
3967 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3970 =item invoicing_list_emailonly_scalar
3972 Returns the list of email invoice recipients (invoicing_list without non-email
3973 destinations such as POST and FAX) as a comma-separated scalar.
3977 sub invoicing_list_emailonly_scalar {
3979 warn "$me invoicing_list_emailonly_scalar called"
3981 join(', ', $self->invoicing_list_emailonly);
3984 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3986 Returns an array of customers referred by this customer (referral_custnum set
3987 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3988 customers referred by customers referred by this customer and so on, inclusive.
3989 The default behavior is DEPTH 1 (no recursion).
3993 sub referral_cust_main {
3995 my $depth = @_ ? shift : 1;
3996 my $exclude = @_ ? shift : {};
3999 map { $exclude->{$_->custnum}++; $_; }
4000 grep { ! $exclude->{ $_->custnum } }
4001 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4005 map { $_->referral_cust_main($depth-1, $exclude) }
4012 =item referral_cust_main_ncancelled
4014 Same as referral_cust_main, except only returns customers with uncancelled
4019 sub referral_cust_main_ncancelled {
4021 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4024 =item referral_cust_pkg [ DEPTH ]
4026 Like referral_cust_main, except returns a flat list of all unsuspended (and
4027 uncancelled) packages for each customer. The number of items in this list may
4028 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4032 sub referral_cust_pkg {
4034 my $depth = @_ ? shift : 1;
4036 map { $_->unsuspended_pkgs }
4037 grep { $_->unsuspended_pkgs }
4038 $self->referral_cust_main($depth);
4041 =item referring_cust_main
4043 Returns the single cust_main record for the customer who referred this customer
4044 (referral_custnum), or false.
4048 sub referring_cust_main {
4050 return '' unless $self->referral_custnum;
4051 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4054 =item credit AMOUNT, REASON
4056 Applies a credit to this customer. If there is an error, returns the error,
4057 otherwise returns false.
4062 my( $self, $amount, $reason ) = @_;
4063 my $cust_credit = new FS::cust_credit {
4064 'custnum' => $self->custnum,
4065 'amount' => $amount,
4066 'reason' => $reason,
4068 $cust_credit->insert;
4071 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4073 Creates a one-time charge for this customer. If there is an error, returns
4074 the error, otherwise returns false.
4080 my ( $amount, $pkg, $comment, $taxclass, $additional );
4081 if ( ref( $_[0] ) ) {
4082 $amount = $_[0]->{amount};
4083 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4084 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4085 : '$'. sprintf("%.2f",$amount);
4086 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4087 $additional = $_[0]->{additional};
4090 $pkg = @_ ? shift : 'One-time charge';
4091 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4092 $taxclass = @_ ? shift : '';
4096 local $SIG{HUP} = 'IGNORE';
4097 local $SIG{INT} = 'IGNORE';
4098 local $SIG{QUIT} = 'IGNORE';
4099 local $SIG{TERM} = 'IGNORE';
4100 local $SIG{TSTP} = 'IGNORE';
4101 local $SIG{PIPE} = 'IGNORE';
4103 my $oldAutoCommit = $FS::UID::AutoCommit;
4104 local $FS::UID::AutoCommit = 0;
4107 my $part_pkg = new FS::part_pkg ( {
4109 'comment' => $comment,
4113 'taxclass' => $taxclass,
4116 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4117 ( 0 .. @$additional - 1 )
4119 'additional_count' => scalar(@$additional),
4120 'setup_fee' => $amount,
4123 my $error = $part_pkg->insert( options => \%options );
4125 $dbh->rollback if $oldAutoCommit;
4129 my $pkgpart = $part_pkg->pkgpart;
4130 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4131 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4132 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4133 $error = $type_pkgs->insert;
4135 $dbh->rollback if $oldAutoCommit;
4140 my $cust_pkg = new FS::cust_pkg ( {
4141 'custnum' => $self->custnum,
4142 'pkgpart' => $pkgpart,
4145 $error = $cust_pkg->insert;
4147 $dbh->rollback if $oldAutoCommit;
4151 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4158 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4164 sort { $a->_date <=> $b->_date }
4165 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4168 =item open_cust_bill
4170 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4175 sub open_cust_bill {
4177 grep { $_->owed > 0 } $self->cust_bill;
4182 Returns all the credits (see L<FS::cust_credit>) for this customer.
4188 sort { $a->_date <=> $b->_date }
4189 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4194 Returns all the payments (see L<FS::cust_pay>) for this customer.
4200 sort { $a->_date <=> $b->_date }
4201 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4206 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4212 sort { $a->_date <=> $b->_date }
4213 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4219 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4225 sort { $a->_date <=> $b->_date }
4226 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4231 Returns a name string for this customer, either "Company (Last, First)" or
4238 my $name = $self->contact;
4239 $name = $self->company. " ($name)" if $self->company;
4245 Returns a name string for this (service/shipping) contact, either
4246 "Company (Last, First)" or "Last, First".
4252 if ( $self->get('ship_last') ) {
4253 my $name = $self->ship_contact;
4254 $name = $self->ship_company. " ($name)" if $self->ship_company;
4263 Returns this customer's full (billing) contact name only, "Last, First"
4269 $self->get('last'). ', '. $self->first;
4274 Returns this customer's full (shipping) contact name only, "Last, First"
4280 $self->get('ship_last')
4281 ? $self->get('ship_last'). ', '. $self->ship_first
4287 Returns this customer's full country name
4293 code2country($self->country);
4300 Returns a status string for this customer, currently:
4304 =item prospect - No packages have ever been ordered
4306 =item active - One or more recurring packages is active
4308 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4310 =item suspended - All non-cancelled recurring packages are suspended
4312 =item cancelled - All recurring packages are cancelled
4318 sub status { shift->cust_status(@_); }
4322 for my $status (qw( prospect active inactive suspended cancelled )) {
4323 my $method = $status.'_sql';
4324 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4325 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4326 $sth->execute( ($self->custnum) x $numnum )
4327 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4328 return $status if $sth->fetchrow_arrayref->[0];
4332 =item ucfirst_cust_status
4334 =item ucfirst_status
4336 Returns the status with the first character capitalized.
4340 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4342 sub ucfirst_cust_status {
4344 ucfirst($self->cust_status);
4349 Returns a hex triplet color string for this customer's status.
4353 use vars qw(%statuscolor);
4355 'prospect' => '7e0079', #'000000', #black? naw, purple
4356 'active' => '00CC00', #green
4357 'inactive' => '0000CC', #blue
4358 'suspended' => 'FF9900', #yellow
4359 'cancelled' => 'FF0000', #red
4362 sub statuscolor { shift->cust_statuscolor(@_); }
4364 sub cust_statuscolor {
4366 $statuscolor{$self->cust_status};
4371 =head1 CLASS METHODS
4377 Returns an SQL expression identifying prospective cust_main records (customers
4378 with no packages ever ordered)
4382 use vars qw($select_count_pkgs);
4383 $select_count_pkgs =
4384 "SELECT COUNT(*) FROM cust_pkg
4385 WHERE cust_pkg.custnum = cust_main.custnum";
4387 sub select_count_pkgs_sql {
4391 sub prospect_sql { "
4392 0 = ( $select_count_pkgs )
4397 Returns an SQL expression identifying active cust_main records (customers with
4398 no active recurring packages, but otherwise unsuspended/uncancelled).
4403 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4409 Returns an SQL expression identifying inactive cust_main records (customers with
4410 active recurring packages).
4414 sub inactive_sql { "
4415 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4417 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4423 Returns an SQL expression identifying suspended cust_main records.
4428 sub suspended_sql { susp_sql(@_); }
4430 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4432 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4438 Returns an SQL expression identifying cancelled cust_main records.
4442 sub cancelled_sql { cancel_sql(@_); }
4445 my $recurring_sql = FS::cust_pkg->recurring_sql;
4446 #my $recurring_sql = "
4447 # '0' != ( select freq from part_pkg
4448 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4452 0 < ( $select_count_pkgs )
4453 AND 0 = ( $select_count_pkgs AND $recurring_sql
4454 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4460 =item uncancelled_sql
4462 Returns an SQL expression identifying un-cancelled cust_main records.
4466 sub uncancelled_sql { uncancel_sql(@_); }
4467 sub uncancel_sql { "
4468 ( 0 < ( $select_count_pkgs
4469 AND ( cust_pkg.cancel IS NULL
4470 OR cust_pkg.cancel = 0
4473 OR 0 = ( $select_count_pkgs )
4477 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4479 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4480 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4481 appropriate ship_ field is also searched).
4483 Additional options are the same as FS::Record::qsearch
4488 my( $self, $fuzzy, $hash, @opt) = @_;
4493 check_and_rebuild_fuzzyfiles();
4494 foreach my $field ( keys %$fuzzy ) {
4496 my $all = $self->all_X($field);
4497 next unless scalar(@$all);
4500 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4503 foreach ( keys %match ) {
4504 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4505 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4508 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4511 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4513 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4521 Returns a masked version of the named field
4526 my ($self, $field) = @_;
4530 'x'x(length($self->getfield($field))-4).
4531 substr($self->getfield($field), (length($self->getfield($field))-4));
4541 =item smart_search OPTION => VALUE ...
4543 Accepts the following options: I<search>, the string to search for. The string
4544 will be searched for as a customer number, phone number, name or company name,
4545 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4546 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4547 skip fuzzy matching when an exact match is found.
4549 Any additional options are treated as an additional qualifier on the search
4552 Returns a (possibly empty) array of FS::cust_main objects.
4559 #here is the agent virtualization
4560 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4564 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4565 my $search = delete $options{'search'};
4566 ( my $alphanum_search = $search ) =~ s/\W//g;
4568 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4570 #false laziness w/Record::ut_phone
4571 my $phonen = "$1-$2-$3";
4572 $phonen .= " x$4" if $4;
4574 push @cust_main, qsearch( {
4575 'table' => 'cust_main',
4576 'hashref' => { %options },
4577 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4579 join(' OR ', map "$_ = '$phonen'",
4580 qw( daytime night fax
4581 ship_daytime ship_night ship_fax )
4584 " AND $agentnums_sql", #agent virtualization
4587 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4588 #try looking for matches with extensions unless one was specified
4590 push @cust_main, qsearch( {
4591 'table' => 'cust_main',
4592 'hashref' => { %options },
4593 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4595 join(' OR ', map "$_ LIKE '$phonen\%'",
4597 ship_daytime ship_night )
4600 " AND $agentnums_sql", #agent virtualization
4605 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4607 push @cust_main, qsearch( {
4608 'table' => 'cust_main',
4609 'hashref' => { 'custnum' => $1, %options },
4610 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4613 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4615 my($company, $last, $first) = ( $1, $2, $3 );
4617 # "Company (Last, First)"
4618 #this is probably something a browser remembered,
4619 #so just do an exact search
4621 foreach my $prefix ( '', 'ship_' ) {
4622 push @cust_main, qsearch( {
4623 'table' => 'cust_main',
4624 'hashref' => { $prefix.'first' => $first,
4625 $prefix.'last' => $last,
4626 $prefix.'company' => $company,
4629 'extra_sql' => " AND $agentnums_sql",
4633 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4634 # try (ship_){last,company}
4638 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4639 # # full strings the browser remembers won't work
4640 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4642 use Lingua::EN::NameParse;
4643 my $NameParse = new Lingua::EN::NameParse(
4645 allow_reversed => 1,
4648 my($last, $first) = ( '', '' );
4649 #maybe disable this too and just rely on NameParse?
4650 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4652 ($last, $first) = ( $1, $2 );
4654 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4655 } elsif ( ! $NameParse->parse($value) ) {
4657 my %name = $NameParse->components;
4658 $first = $name{'given_name_1'};
4659 $last = $name{'surname_1'};
4663 if ( $first && $last ) {
4665 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4668 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4670 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4671 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4674 push @cust_main, qsearch( {
4675 'table' => 'cust_main',
4676 'hashref' => \%options,
4677 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4680 # or it just be something that was typed in... (try that in a sec)
4684 my $q_value = dbh->quote($value);
4687 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4688 $sql .= " ( LOWER(last) = $q_value
4689 OR LOWER(company) = $q_value
4690 OR LOWER(ship_last) = $q_value
4691 OR LOWER(ship_company) = $q_value
4694 push @cust_main, qsearch( {
4695 'table' => 'cust_main',
4696 'hashref' => \%options,
4697 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4700 #always do substring & fuzzy,
4701 #getting complains searches are not returning enough
4702 unless ( @cust_main && $skip_fuzzy ) { #no exact match, trying substring/fuzzy
4704 #still some false laziness w/ search/cust_main.cgi
4709 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4710 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4713 if ( $first && $last ) {
4716 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4717 'last' => { op=>'ILIKE', value=>"%$last%" },
4719 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4720 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4727 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4728 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4732 foreach my $hashref ( @hashrefs ) {
4734 push @cust_main, qsearch( {
4735 'table' => 'cust_main',
4736 'hashref' => { %$hashref,
4739 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4748 " AND $agentnums_sql", #extra_sql #agent virtualization
4751 if ( $first && $last ) {
4752 push @cust_main, FS::cust_main->fuzzy_search(
4753 { 'last' => $last, #fuzzy hashref
4754 'first' => $first }, #
4758 foreach my $field ( 'last', 'company' ) {
4760 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4765 #eliminate duplicates
4767 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4775 =item check_and_rebuild_fuzzyfiles
4779 use vars qw(@fuzzyfields);
4780 @fuzzyfields = ( 'last', 'first', 'company' );
4782 sub check_and_rebuild_fuzzyfiles {
4783 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4784 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4787 =item rebuild_fuzzyfiles
4791 sub rebuild_fuzzyfiles {
4793 use Fcntl qw(:flock);
4795 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4796 mkdir $dir, 0700 unless -d $dir;
4798 foreach my $fuzzy ( @fuzzyfields ) {
4800 open(LOCK,">>$dir/cust_main.$fuzzy")
4801 or die "can't open $dir/cust_main.$fuzzy: $!";
4803 or die "can't lock $dir/cust_main.$fuzzy: $!";
4805 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4806 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4808 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4809 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4810 " WHERE $field != '' AND $field IS NOT NULL");
4811 $sth->execute or die $sth->errstr;
4813 while ( my $row = $sth->fetchrow_arrayref ) {
4814 print CACHE $row->[0]. "\n";
4819 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4821 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4832 my( $self, $field ) = @_;
4833 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4834 open(CACHE,"<$dir/cust_main.$field")
4835 or die "can't open $dir/cust_main.$field: $!";
4836 my @array = map { chomp; $_; } <CACHE>;
4841 =item append_fuzzyfiles LASTNAME COMPANY
4845 sub append_fuzzyfiles {
4846 #my( $first, $last, $company ) = @_;
4848 &check_and_rebuild_fuzzyfiles;
4850 use Fcntl qw(:flock);
4852 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4854 foreach my $field (qw( first last company )) {
4859 open(CACHE,">>$dir/cust_main.$field")
4860 or die "can't open $dir/cust_main.$field: $!";
4861 flock(CACHE,LOCK_EX)
4862 or die "can't lock $dir/cust_main.$field: $!";
4864 print CACHE "$value\n";
4866 flock(CACHE,LOCK_UN)
4867 or die "can't unlock $dir/cust_main.$field: $!";
4882 #warn join('-',keys %$param);
4883 my $fh = $param->{filehandle};
4884 my $agentnum = $param->{agentnum};
4886 my $refnum = $param->{refnum};
4887 my $pkgpart = $param->{pkgpart};
4889 #my @fields = @{$param->{fields}};
4890 my $format = $param->{'format'};
4893 if ( $format eq 'simple' ) {
4894 @fields = qw( cust_pkg.setup dayphone first last
4895 address1 address2 city state zip comments );
4897 } elsif ( $format eq 'extended' ) {
4898 @fields = qw( agent_custid refnum
4899 last first address1 address2 city state zip country
4901 ship_last ship_first ship_address1 ship_address2
4902 ship_city ship_state ship_zip ship_country
4903 payinfo paycvv paydate
4906 svc_acct.username svc_acct._password
4909 } elsif ( $format eq 'extended-plus_company' ) {
4910 @fields = qw( agent_custid refnum
4911 last first company address1 address2 city state zip country
4913 ship_last ship_first ship_company ship_address1 ship_address2
4914 ship_city ship_state ship_zip ship_country
4915 payinfo paycvv paydate
4918 svc_acct.username svc_acct._password
4922 die "unknown format $format";
4925 eval "use Text::CSV_XS;";
4928 my $csv = new Text::CSV_XS;
4935 local $SIG{HUP} = 'IGNORE';
4936 local $SIG{INT} = 'IGNORE';
4937 local $SIG{QUIT} = 'IGNORE';
4938 local $SIG{TERM} = 'IGNORE';
4939 local $SIG{TSTP} = 'IGNORE';
4940 local $SIG{PIPE} = 'IGNORE';
4942 my $oldAutoCommit = $FS::UID::AutoCommit;
4943 local $FS::UID::AutoCommit = 0;
4946 #while ( $columns = $csv->getline($fh) ) {
4948 while ( defined($line=<$fh>) ) {
4950 $csv->parse($line) or do {
4951 $dbh->rollback if $oldAutoCommit;
4952 return "can't parse: ". $csv->error_input();
4955 my @columns = $csv->fields();
4956 #warn join('-',@columns);
4959 agentnum => $agentnum,
4961 country => $conf->config('countrydefault') || 'US',
4962 payby => $payby, #default
4963 paydate => '12/2037', #default
4965 my $billtime = time;
4966 my %cust_pkg = ( pkgpart => $pkgpart );
4968 foreach my $field ( @fields ) {
4970 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
4972 #$cust_pkg{$1} = str2time( shift @$columns );
4973 if ( $1 eq 'pkgpart' ) {
4974 $cust_pkg{$1} = shift @columns;
4975 } elsif ( $1 eq 'setup' ) {
4976 $billtime = str2time(shift @columns);
4978 $cust_pkg{$1} = str2time( shift @columns );
4981 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4983 $svc_acct{$1} = shift @columns;
4987 #refnum interception
4988 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4990 my $referral = $columns[0];
4991 my %hash = ( 'referral' => $referral,
4992 'agentnum' => $agentnum,
4996 my $part_referral = qsearchs('part_referral', \%hash )
4997 || new FS::part_referral \%hash;
4999 unless ( $part_referral->refnum ) {
5000 my $error = $part_referral->insert;
5002 $dbh->rollback if $oldAutoCommit;
5003 return "can't auto-insert advertising source: $referral: $error";
5007 $columns[0] = $part_referral->refnum;
5010 #$cust_main{$field} = shift @$columns;
5011 $cust_main{$field} = shift @columns;
5015 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5017 my $invoicing_list = $cust_main{'invoicing_list'}
5018 ? [ delete $cust_main{'invoicing_list'} ]
5021 my $cust_main = new FS::cust_main ( \%cust_main );
5024 tie my %hash, 'Tie::RefHash'; #this part is important
5026 if ( $cust_pkg{'pkgpart'} ) {
5027 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5030 if ( $svc_acct{'username'} ) {
5031 my $part_pkg = $cust_pkg->part_pkg;
5032 unless ( $part_pkg ) {
5033 $dbh->rollback if $oldAutoCommit;
5034 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5036 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5037 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5040 $hash{$cust_pkg} = \@svc_acct;
5043 my $error = $cust_main->insert( \%hash, $invoicing_list );
5046 $dbh->rollback if $oldAutoCommit;
5047 return "can't insert customer for $line: $error";
5050 if ( $format eq 'simple' ) {
5052 #false laziness w/bill.cgi
5053 $error = $cust_main->bill( 'time' => $billtime );
5055 $dbh->rollback if $oldAutoCommit;
5056 return "can't bill customer for $line: $error";
5059 $error = $cust_main->apply_payments_and_credits;
5061 $dbh->rollback if $oldAutoCommit;
5062 return "can't bill customer for $line: $error";
5065 $error = $cust_main->collect();
5067 $dbh->rollback if $oldAutoCommit;
5068 return "can't collect customer for $line: $error";
5076 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5078 return "Empty file!" unless $imported;
5090 #warn join('-',keys %$param);
5091 my $fh = $param->{filehandle};
5092 my @fields = @{$param->{fields}};
5094 eval "use Text::CSV_XS;";
5097 my $csv = new Text::CSV_XS;
5104 local $SIG{HUP} = 'IGNORE';
5105 local $SIG{INT} = 'IGNORE';
5106 local $SIG{QUIT} = 'IGNORE';
5107 local $SIG{TERM} = 'IGNORE';
5108 local $SIG{TSTP} = 'IGNORE';
5109 local $SIG{PIPE} = 'IGNORE';
5111 my $oldAutoCommit = $FS::UID::AutoCommit;
5112 local $FS::UID::AutoCommit = 0;
5115 #while ( $columns = $csv->getline($fh) ) {
5117 while ( defined($line=<$fh>) ) {
5119 $csv->parse($line) or do {
5120 $dbh->rollback if $oldAutoCommit;
5121 return "can't parse: ". $csv->error_input();
5124 my @columns = $csv->fields();
5125 #warn join('-',@columns);
5128 foreach my $field ( @fields ) {
5129 $row{$field} = shift @columns;
5132 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5133 unless ( $cust_main ) {
5134 $dbh->rollback if $oldAutoCommit;
5135 return "unknown custnum $row{'custnum'}";
5138 if ( $row{'amount'} > 0 ) {
5139 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5141 $dbh->rollback if $oldAutoCommit;
5145 } elsif ( $row{'amount'} < 0 ) {
5146 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5149 $dbh->rollback if $oldAutoCommit;
5159 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5161 return "Empty file!" unless $imported;
5167 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5169 Sends a templated email notification to the customer (see L<Text::Template>).
5171 OPTIONS is a hash and may include
5173 I<from> - the email sender (default is invoice_from)
5175 I<to> - comma-separated scalar or arrayref of recipients
5176 (default is invoicing_list)
5178 I<subject> - The subject line of the sent email notification
5179 (default is "Notice from company_name")
5181 I<extra_fields> - a hashref of name/value pairs which will be substituted
5184 The following variables are vavailable in the template.
5186 I<$first> - the customer first name
5187 I<$last> - the customer last name
5188 I<$company> - the customer company
5189 I<$payby> - a description of the method of payment for the customer
5190 # would be nice to use FS::payby::shortname
5191 I<$payinfo> - the account information used to collect for this customer
5192 I<$expdate> - the expiration of the customer payment in seconds from epoch
5197 my ($customer, $template, %options) = @_;
5199 return unless $conf->exists($template);
5201 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5202 $from = $options{from} if exists($options{from});
5204 my $to = join(',', $customer->invoicing_list_emailonly);
5205 $to = $options{to} if exists($options{to});
5207 my $subject = "Notice from " . $conf->config('company_name')
5208 if $conf->exists('company_name');
5209 $subject = $options{subject} if exists($options{subject});
5211 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5212 SOURCE => [ map "$_\n",
5213 $conf->config($template)]
5215 or die "can't create new Text::Template object: Text::Template::ERROR";
5216 $notify_template->compile()
5217 or die "can't compile template: Text::Template::ERROR";
5219 my $paydate = $customer->paydate;
5220 $FS::notify_template::_template::first = $customer->first;
5221 $FS::notify_template::_template::last = $customer->last;
5222 $FS::notify_template::_template::company = $customer->company;
5223 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5224 my $payby = $customer->payby;
5225 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5226 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5228 #credit cards expire at the end of the month/year of their exp date
5229 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5230 $FS::notify_template::_template::payby = 'credit card';
5231 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5232 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5234 }elsif ($payby eq 'COMP') {
5235 $FS::notify_template::_template::payby = 'complimentary account';
5237 $FS::notify_template::_template::payby = 'current method';
5239 $FS::notify_template::_template::expdate = $expire_time;
5241 for (keys %{$options{extra_fields}}){
5243 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5246 send_email(from => $from,
5248 subject => $subject,
5249 body => $notify_template->fill_in( PACKAGE =>
5250 'FS::notify_template::_template' ),
5255 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5257 Generates a templated notification to the customer (see L<Text::Template>).
5259 OPTIONS is a hash and may include
5261 I<extra_fields> - a hashref of name/value pairs which will be substituted
5262 into the template. These values may override values mentioned below
5263 and those from the customer record.
5265 The following variables are available in the template instead of or in addition
5266 to the fields of the customer record.
5268 I<$payby> - a description of the method of payment for the customer
5269 # would be nice to use FS::payby::shortname
5270 I<$payinfo> - the masked account information used to collect for this customer
5271 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5272 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5276 sub generate_letter {
5277 my ($self, $template, %options) = @_;
5279 return unless $conf->exists($template);
5281 my $letter_template = new Text::Template
5283 SOURCE => [ map "$_\n", $conf->config($template)],
5284 DELIMITERS => [ '[@--', '--@]' ],
5286 or die "can't create new Text::Template object: Text::Template::ERROR";
5288 $letter_template->compile()
5289 or die "can't compile template: Text::Template::ERROR";
5291 my %letter_data = map { $_ => $self->$_ } $self->fields;
5292 $letter_data{payinfo} = $self->mask_payinfo;
5294 my $paydate = $self->paydate || '2037-12';
5295 my $payby = $self->payby;
5296 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5297 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5299 #credit cards expire at the end of the month/year of their exp date
5300 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5301 $letter_data{payby} = 'credit card';
5302 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5303 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5305 }elsif ($payby eq 'COMP') {
5306 $letter_data{payby} = 'complimentary account';
5308 $letter_data{payby} = 'current method';
5310 $letter_data{expdate} = $expire_time;
5312 for (keys %{$options{extra_fields}}){
5313 $letter_data{$_} = $options{extra_fields}->{$_};
5316 unless(exists($letter_data{returnaddress})){
5317 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5318 $self->_agent_template)
5321 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5324 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5326 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5327 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5331 ) or die "can't open temp file: $!\n";
5333 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5335 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5339 =item print_ps TEMPLATE
5341 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5347 my $file = $self->generate_letter(@_);
5348 FS::Misc::generate_ps($file);
5351 =item print TEMPLATE
5353 Prints the filled in template.
5355 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5359 sub queueable_print {
5362 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5363 or die "invalid customer number: " . $opt{custvnum};
5365 my $error = $self->print( $opt{template} );
5366 die $error if $error;
5370 my ($self, $template) = (shift, shift);
5371 do_print [ $self->print_ps($template) ];
5374 sub agent_template {
5376 $self->_agent_plandata('agent_templatename');
5379 sub agent_invoice_from {
5381 $self->_agent_plandata('agent_invoice_from');
5384 sub _agent_plandata {
5385 my( $self, $option ) = @_;
5388 if ( driver_name =~ /^Pg/i ) {
5390 } elsif ( driver_name =~ /^mysql/i ) {
5393 die "don't know how to use regular expressions in ". driver_name. " databases";
5396 my $part_bill_event = qsearchs( 'part_bill_event',
5398 'payby' => $self->payby,
5399 'plan' => 'send_agent',
5400 'plandata' => { 'op' => $regexp,
5401 'value' => "(^|\n)agentnum ".
5409 'ORDER BY seconds LIMIT 1'
5412 return '' unless $part_bill_event;
5414 if ( $part_bill_event->plandata =~ /^$option (.*)$/m ) {
5417 warn "can't parse part_bill_event eventpart#". $part_bill_event->eventpart.
5418 " plandata for $option";
5430 The delete method should possibly take an FS::cust_main object reference
5431 instead of a scalar customer number.
5433 Bill and collect options should probably be passed as references instead of a
5436 There should probably be a configuration file with a list of allowed credit
5439 No multiple currency support (probably a larger project than just this module).
5441 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5443 Birthdates rely on negative epoch values.
5445 The payby for card/check batches is broken. With mixed batching, bad
5450 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5451 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5452 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.