4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
5 $import $skip_fuzzyfiles $ignore_expired_card );
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;
24 use FS::UID qw( getotaker dbh );
25 use FS::Record qw( qsearchs qsearch dbdef );
26 use FS::Misc qw( send_email );
27 use FS::Msgcat qw(gettext);
31 use FS::cust_bill_pkg;
33 use FS::cust_pay_void;
36 use FS::part_referral;
37 use FS::cust_main_county;
39 use FS::cust_main_invoice;
40 use FS::cust_credit_bill;
41 use FS::cust_bill_pay;
42 use FS::prepay_credit;
45 use FS::part_bill_event qw(due_events);
46 use FS::cust_bill_event;
47 use FS::cust_tax_exempt;
48 use FS::cust_tax_exempt_pkg;
50 use FS::payment_gateway;
51 use FS::agent_payment_gateway;
53 use FS::payinfo_Mixin;
55 @ISA = qw( FS::Record FS::payinfo_Mixin );
57 @EXPORT_OK = qw( smart_search );
59 $realtime_bop_decline_quiet = 0;
61 # 1 is mostly method/subroutine entry and options
62 # 2 traces progress of some operations
63 # 3 is even more information including possibly sensitive data
65 $me = '[FS::cust_main]';
69 $ignore_expired_card = 0;
71 @encrypted_fields = ('payinfo', 'paycvv');
73 #ask FS::UID to run this stuff for us later
74 #$FS::UID::callback{'FS::cust_main'} = sub {
75 install_callback FS::UID sub {
77 #yes, need it for stuff below (prolly should be cached)
82 my ( $hashref, $cache ) = @_;
83 if ( exists $hashref->{'pkgnum'} ) {
84 #@{ $self->{'_pkgnum'} } = ();
85 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
86 $self->{'_pkgnum'} = $subcache;
87 #push @{ $self->{'_pkgnum'} },
88 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
94 FS::cust_main - Object methods for cust_main records
100 $record = new FS::cust_main \%hash;
101 $record = new FS::cust_main { 'column' => 'value' };
103 $error = $record->insert;
105 $error = $new_record->replace($old_record);
107 $error = $record->delete;
109 $error = $record->check;
111 @cust_pkg = $record->all_pkgs;
113 @cust_pkg = $record->ncancelled_pkgs;
115 @cust_pkg = $record->suspended_pkgs;
117 $error = $record->bill;
118 $error = $record->bill %options;
119 $error = $record->bill 'time' => $time;
121 $error = $record->collect;
122 $error = $record->collect %options;
123 $error = $record->collect 'invoice_time' => $time,
128 An FS::cust_main object represents a customer. FS::cust_main inherits from
129 FS::Record. The following fields are currently supported:
133 =item custnum - primary key (assigned automatically for new customers)
135 =item agentnum - agent (see L<FS::agent>)
137 =item refnum - Advertising source (see L<FS::part_referral>)
143 =item ss - social security number (optional)
145 =item company - (optional)
149 =item address2 - (optional)
153 =item county - (optional, see L<FS::cust_main_county>)
155 =item state - (see L<FS::cust_main_county>)
159 =item country - (see L<FS::cust_main_county>)
161 =item daytime - phone (optional)
163 =item night - phone (optional)
165 =item fax - phone (optional)
167 =item ship_first - name
169 =item ship_last - name
171 =item ship_company - (optional)
175 =item ship_address2 - (optional)
179 =item ship_county - (optional, see L<FS::cust_main_county>)
181 =item ship_state - (see L<FS::cust_main_county>)
185 =item ship_country - (see L<FS::cust_main_county>)
187 =item ship_daytime - phone (optional)
189 =item ship_night - phone (optional)
191 =item ship_fax - phone (optional)
193 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
195 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
197 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
201 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
203 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
205 =item paystart_month - start date month (maestro/solo cards only)
207 =item paystart_year - start date year (maestro/solo cards only)
209 =item payissue - issue number (maestro/solo cards only)
211 =item payname - name on card or billing name
213 =item payip - IP address from which payment information was received
215 =item tax - tax exempt, empty or `Y'
217 =item otaker - order taker (assigned automatically, see L<FS::UID>)
219 =item comments - comments (optional)
221 =item referral_custnum - referring customer number
223 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
233 Creates a new customer. To add the customer to the database, see L<"insert">.
235 Note that this stores the hash reference, not a distinct copy of the hash it
236 points to. You can ask the object for a copy with the I<hash> method.
240 sub table { 'cust_main'; }
242 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
244 Adds this customer to the database. If there is an error, returns the error,
245 otherwise returns false.
247 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
248 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
249 are inserted atomicly, or the transaction is rolled back. Passing an empty
250 hash reference is equivalent to not supplying this parameter. There should be
251 a better explanation of this, but until then, here's an example:
254 tie %hash, 'Tie::RefHash'; #this part is important
256 $cust_pkg => [ $svc_acct ],
259 $cust_main->insert( \%hash );
261 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
262 be set as the invoicing list (see L<"invoicing_list">). Errors return as
263 expected and rollback the entire transaction; it is not necessary to call
264 check_invoicing_list first. The invoicing_list is set after the records in the
265 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
266 invoicing_list destination to the newly-created svc_acct. Here's an example:
268 $cust_main->insert( {}, [ $email, 'POST' ] );
270 Currently available options are: I<depend_jobnum> and I<noexport>.
272 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
273 on the supplied jobnum (they will not run until the specific job completes).
274 This can be used to defer provisioning until some action completes (such
275 as running the customer's credit card successfully).
277 The I<noexport> option is deprecated. If I<noexport> is set true, no
278 provisioning jobs (exports) are scheduled. (You can schedule them later with
279 the B<reexport> method.)
285 my $cust_pkgs = @_ ? shift : {};
286 my $invoicing_list = @_ ? shift : '';
288 warn "$me insert called with options ".
289 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
292 local $SIG{HUP} = 'IGNORE';
293 local $SIG{INT} = 'IGNORE';
294 local $SIG{QUIT} = 'IGNORE';
295 local $SIG{TERM} = 'IGNORE';
296 local $SIG{TSTP} = 'IGNORE';
297 local $SIG{PIPE} = 'IGNORE';
299 my $oldAutoCommit = $FS::UID::AutoCommit;
300 local $FS::UID::AutoCommit = 0;
303 my $prepay_identifier = '';
304 my( $amount, $seconds ) = ( 0, 0 );
306 if ( $self->payby eq 'PREPAY' ) {
308 $self->payby('BILL');
309 $prepay_identifier = $self->payinfo;
312 warn " looking up prepaid card $prepay_identifier\n"
315 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
317 $dbh->rollback if $oldAutoCommit;
318 #return "error applying prepaid card (transaction rolled back): $error";
322 $payby = 'PREP' if $amount;
324 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
327 $self->payby('BILL');
328 $amount = $self->paid;
332 warn " inserting $self\n"
335 $self->signupdate(time) unless $self->signupdate;
337 my $error = $self->SUPER::insert;
339 $dbh->rollback if $oldAutoCommit;
340 #return "inserting cust_main record (transaction rolled back): $error";
344 warn " setting invoicing list\n"
347 if ( $invoicing_list ) {
348 $error = $self->check_invoicing_list( $invoicing_list );
350 $dbh->rollback if $oldAutoCommit;
351 return "checking invoicing_list (transaction rolled back): $error";
353 $self->invoicing_list( $invoicing_list );
356 if ( $conf->config('cust_main-skeleton_tables')
357 && $conf->config('cust_main-skeleton_custnum') ) {
359 warn " inserting skeleton records\n"
362 my $error = $self->start_copy_skel;
364 $dbh->rollback if $oldAutoCommit;
370 warn " ordering packages\n"
373 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
375 $dbh->rollback if $oldAutoCommit;
380 $dbh->rollback if $oldAutoCommit;
381 return "No svc_acct record to apply pre-paid time";
385 warn " inserting initial $payby payment of $amount\n"
387 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
389 $dbh->rollback if $oldAutoCommit;
390 return "inserting payment (transaction rolled back): $error";
394 unless ( $import || $skip_fuzzyfiles ) {
395 warn " queueing fuzzyfiles update\n"
397 $error = $self->queue_fuzzyfiles_update;
399 $dbh->rollback if $oldAutoCommit;
400 return "updating fuzzy search cache: $error";
404 warn " insert complete; committing transaction\n"
407 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
412 sub start_copy_skel {
415 #'mg_user_preference' => {},
416 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
417 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
418 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
419 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
420 my @tables = eval($conf->config_binary('cust_main-skeleton_tables'));
423 _copy_skel( 'cust_main', #tablename
424 $conf->config('cust_main-skeleton_custnum'), #sourceid
425 $self->custnum, #destid
426 @tables, #child tables
430 #recursive subroutine, not a method
432 my( $table, $sourceid, $destid, %child_tables ) = @_;
435 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
436 ( $table, $primary_key ) = ( $1, $2 );
438 my $dbdef_table = dbdef->table($table);
439 $primary_key = $dbdef_table->primary_key
440 or return "$table has no primary key".
441 " (or do you need to run dbdef-create?)";
444 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
445 join (', ', keys %child_tables). "\n"
448 foreach my $child_table_def ( keys %child_tables ) {
452 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
453 ( $child_table, $child_pkey ) = ( $1, $2 );
455 $child_table = $child_table_def;
457 $child_pkey = dbdef->table($child_table)->primary_key;
458 # or return "$table has no primary key".
459 # " (or do you need to run dbdef-create?)\n";
463 if ( keys %{ $child_tables{$child_table_def} } ) {
465 return "$child_table has no primary key".
466 " (run dbdef-create or try specifying it?)\n"
469 #false laziness w/Record::insert and only works on Pg
470 #refactor the proper last-inserted-id stuff out of Record::insert if this
471 # ever gets use for anything besides a quick kludge for one customer
472 my $default = dbdef->table($child_table)->column($child_pkey)->default;
473 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
474 or return "can't parse $child_table.$child_pkey default value ".
475 " for sequence name: $default";
480 my @sel_columns = grep { $_ ne $primary_key }
481 dbdef->table($child_table)->columns;
482 my $sel_columns = join(', ', @sel_columns );
484 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
485 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
486 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
488 my $sel_st = "SELECT $sel_columns FROM $child_table".
489 " WHERE $primary_key = $sourceid";
492 my $sel_sth = dbh->prepare( $sel_st )
493 or return dbh->errstr;
495 $sel_sth->execute or return $sel_sth->errstr;
497 while ( my $row = $sel_sth->fetchrow_hashref ) {
499 warn " selected row: ".
500 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
504 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
505 my $ins_sth =dbh->prepare($statement)
506 or return dbh->errstr;
507 my @param = ( $destid, map $row->{$_}, @ins_columns );
508 warn " $statement: [ ". join(', ', @param). " ]\n"
510 $ins_sth->execute( @param )
511 or return $ins_sth->errstr;
513 #next unless keys %{ $child_tables{$child_table} };
514 next unless $sequence;
516 #another section of that laziness
517 my $seq_sql = "SELECT currval('$sequence')";
518 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
519 $seq_sth->execute or return $seq_sth->errstr;
520 my $insertid = $seq_sth->fetchrow_arrayref->[0];
522 # don't drink soap! recurse! recurse! okay!
524 _copy_skel( $child_table_def,
525 $row->{$child_pkey}, #sourceid
527 %{ $child_tables{$child_table_def} },
529 return $error if $error;
539 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
541 Like the insert method on an existing record, this method orders a package
542 and included services atomicaly. Pass a Tie::RefHash data structure to this
543 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
544 be a better explanation of this, but until then, here's an example:
547 tie %hash, 'Tie::RefHash'; #this part is important
549 $cust_pkg => [ $svc_acct ],
552 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
554 Services can be new, in which case they are inserted, or existing unaudited
555 services, in which case they are linked to the newly-created package.
557 Currently available options are: I<depend_jobnum> and I<noexport>.
559 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
560 on the supplied jobnum (they will not run until the specific job completes).
561 This can be used to defer provisioning until some action completes (such
562 as running the customer's credit card successfully).
564 The I<noexport> option is deprecated. If I<noexport> is set true, no
565 provisioning jobs (exports) are scheduled. (You can schedule them later with
566 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
567 on the cust_main object is not recommended, as existing services will also be
574 my $cust_pkgs = shift;
577 my %svc_options = ();
578 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
579 if exists $options{'depend_jobnum'};
580 warn "$me order_pkgs called with options ".
581 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
584 local $SIG{HUP} = 'IGNORE';
585 local $SIG{INT} = 'IGNORE';
586 local $SIG{QUIT} = 'IGNORE';
587 local $SIG{TERM} = 'IGNORE';
588 local $SIG{TSTP} = 'IGNORE';
589 local $SIG{PIPE} = 'IGNORE';
591 my $oldAutoCommit = $FS::UID::AutoCommit;
592 local $FS::UID::AutoCommit = 0;
595 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
597 foreach my $cust_pkg ( keys %$cust_pkgs ) {
598 $cust_pkg->custnum( $self->custnum );
599 my $error = $cust_pkg->insert;
601 $dbh->rollback if $oldAutoCommit;
602 return "inserting cust_pkg (transaction rolled back): $error";
604 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
605 if ( $svc_something->svcnum ) {
606 my $old_cust_svc = $svc_something->cust_svc;
607 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
608 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
609 $error = $new_cust_svc->replace($old_cust_svc);
611 $svc_something->pkgnum( $cust_pkg->pkgnum );
612 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
613 $svc_something->seconds( $svc_something->seconds + $$seconds );
616 $error = $svc_something->insert(%svc_options);
619 $dbh->rollback if $oldAutoCommit;
620 #return "inserting svc_ (transaction rolled back): $error";
626 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
630 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
632 Recharges this (existing) customer with the specified prepaid card (see
633 L<FS::prepay_credit>), specified either by I<identifier> or as an
634 FS::prepay_credit object. If there is an error, returns the error, otherwise
637 Optionally, four scalar references can be passed as well. They will have their
638 values filled in with the amount, number of seconds, and number of upload and
639 download bytes applied by this prepaid
644 sub recharge_prepay {
645 my( $self, $prepay_credit, $amountref, $secondsref,
646 $upbytesref, $downbytesref, $totalbytesref ) = @_;
648 local $SIG{HUP} = 'IGNORE';
649 local $SIG{INT} = 'IGNORE';
650 local $SIG{QUIT} = 'IGNORE';
651 local $SIG{TERM} = 'IGNORE';
652 local $SIG{TSTP} = 'IGNORE';
653 local $SIG{PIPE} = 'IGNORE';
655 my $oldAutoCommit = $FS::UID::AutoCommit;
656 local $FS::UID::AutoCommit = 0;
659 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
661 my $error = $self->get_prepay($prepay_credit, \$amount,
662 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
663 || $self->increment_seconds($seconds)
664 || $self->increment_upbytes($upbytes)
665 || $self->increment_downbytes($downbytes)
666 || $self->increment_totalbytes($totalbytes)
667 || $self->insert_cust_pay_prepay( $amount,
669 ? $prepay_credit->identifier
674 $dbh->rollback if $oldAutoCommit;
678 if ( defined($amountref) ) { $$amountref = $amount; }
679 if ( defined($secondsref) ) { $$secondsref = $seconds; }
680 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
681 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
682 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
684 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
689 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
691 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
692 specified either by I<identifier> or as an FS::prepay_credit object.
694 References to I<amount> and I<seconds> scalars should be passed as arguments
695 and will be incremented by the values of the prepaid card.
697 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
698 check or set this customer's I<agentnum>.
700 If there is an error, returns the error, otherwise returns false.
706 my( $self, $prepay_credit, $amountref, $secondsref,
707 $upref, $downref, $totalref) = @_;
709 local $SIG{HUP} = 'IGNORE';
710 local $SIG{INT} = 'IGNORE';
711 local $SIG{QUIT} = 'IGNORE';
712 local $SIG{TERM} = 'IGNORE';
713 local $SIG{TSTP} = 'IGNORE';
714 local $SIG{PIPE} = 'IGNORE';
716 my $oldAutoCommit = $FS::UID::AutoCommit;
717 local $FS::UID::AutoCommit = 0;
720 unless ( ref($prepay_credit) ) {
722 my $identifier = $prepay_credit;
724 $prepay_credit = qsearchs(
726 { 'identifier' => $prepay_credit },
731 unless ( $prepay_credit ) {
732 $dbh->rollback if $oldAutoCommit;
733 return "Invalid prepaid card: ". $identifier;
738 if ( $prepay_credit->agentnum ) {
739 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
740 $dbh->rollback if $oldAutoCommit;
741 return "prepaid card not valid for agent ". $self->agentnum;
743 $self->agentnum($prepay_credit->agentnum);
746 my $error = $prepay_credit->delete;
748 $dbh->rollback if $oldAutoCommit;
749 return "removing prepay_credit (transaction rolled back): $error";
752 $$amountref += $prepay_credit->amount;
753 $$secondsref += $prepay_credit->seconds;
754 $$upref += $prepay_credit->upbytes;
755 $$downref += $prepay_credit->downbytes;
756 $$totalref += $prepay_credit->totalbytes;
758 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
763 =item increment_upbytes SECONDS
765 Updates this customer's single or primary account (see L<FS::svc_acct>) by
766 the specified number of upbytes. If there is an error, returns the error,
767 otherwise returns false.
771 sub increment_upbytes {
772 _increment_column( shift, 'upbytes', @_);
775 =item increment_downbytes SECONDS
777 Updates this customer's single or primary account (see L<FS::svc_acct>) by
778 the specified number of downbytes. If there is an error, returns the error,
779 otherwise returns false.
783 sub increment_downbytes {
784 _increment_column( shift, 'downbytes', @_);
787 =item increment_totalbytes SECONDS
789 Updates this customer's single or primary account (see L<FS::svc_acct>) by
790 the specified number of totalbytes. If there is an error, returns the error,
791 otherwise returns false.
795 sub increment_totalbytes {
796 _increment_column( shift, 'totalbytes', @_);
799 =item increment_seconds SECONDS
801 Updates this customer's single or primary account (see L<FS::svc_acct>) by
802 the specified number of seconds. If there is an error, returns the error,
803 otherwise returns false.
807 sub increment_seconds {
808 _increment_column( shift, 'seconds', @_);
811 =item _increment_column AMOUNT
813 Updates this customer's single or primary account (see L<FS::svc_acct>) by
814 the specified number of seconds or bytes. If there is an error, returns
815 the error, otherwise returns false.
819 sub _increment_column {
820 my( $self, $column, $amount ) = @_;
821 warn "$me increment_column called: $column, $amount\n"
824 return '' unless $amount;
826 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
827 $self->ncancelled_pkgs;
830 return 'No packages with primary or single services found'.
831 ' to apply pre-paid time';
832 } elsif ( scalar(@cust_pkg) > 1 ) {
833 #maybe have a way to specify the package/account?
834 return 'Multiple packages found to apply pre-paid time';
837 my $cust_pkg = $cust_pkg[0];
838 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
842 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
845 return 'No account found to apply pre-paid time';
846 } elsif ( scalar(@cust_svc) > 1 ) {
847 return 'Multiple accounts found to apply pre-paid time';
850 my $svc_acct = $cust_svc[0]->svc_x;
851 warn " found service svcnum ". $svc_acct->pkgnum.
852 ' ('. $svc_acct->email. ")\n"
855 $column = "increment_$column";
856 $svc_acct->$column($amount);
860 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
862 Inserts a prepayment in the specified amount for this customer. An optional
863 second argument can specify the prepayment identifier for tracking purposes.
864 If there is an error, returns the error, otherwise returns false.
868 sub insert_cust_pay_prepay {
869 shift->insert_cust_pay('PREP', @_);
872 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
874 Inserts a cash payment in the specified amount for this customer. An optional
875 second argument can specify the payment identifier for tracking purposes.
876 If there is an error, returns the error, otherwise returns false.
880 sub insert_cust_pay_cash {
881 shift->insert_cust_pay('CASH', @_);
884 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
886 Inserts a Western Union payment in the specified amount for this customer. An
887 optional second argument can specify the prepayment identifier for tracking
888 purposes. If there is an error, returns the error, otherwise returns false.
892 sub insert_cust_pay_west {
893 shift->insert_cust_pay('WEST', @_);
896 sub insert_cust_pay {
897 my( $self, $payby, $amount ) = splice(@_, 0, 3);
898 my $payinfo = scalar(@_) ? shift : '';
900 my $cust_pay = new FS::cust_pay {
901 'custnum' => $self->custnum,
902 'paid' => sprintf('%.2f', $amount),
903 #'_date' => #date the prepaid card was purchased???
905 'payinfo' => $payinfo,
913 This method is deprecated. See the I<depend_jobnum> option to the insert and
914 order_pkgs methods for a better way to defer provisioning.
916 Re-schedules all exports by calling the B<reexport> method of all associated
917 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
918 otherwise returns false.
925 carp "WARNING: FS::cust_main::reexport is deprectated; ".
926 "use the depend_jobnum option to insert or order_pkgs to delay export";
928 local $SIG{HUP} = 'IGNORE';
929 local $SIG{INT} = 'IGNORE';
930 local $SIG{QUIT} = 'IGNORE';
931 local $SIG{TERM} = 'IGNORE';
932 local $SIG{TSTP} = 'IGNORE';
933 local $SIG{PIPE} = 'IGNORE';
935 my $oldAutoCommit = $FS::UID::AutoCommit;
936 local $FS::UID::AutoCommit = 0;
939 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
940 my $error = $cust_pkg->reexport;
942 $dbh->rollback if $oldAutoCommit;
947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
952 =item delete NEW_CUSTNUM
954 This deletes the customer. If there is an error, returns the error, otherwise
957 This will completely remove all traces of the customer record. This is not
958 what you want when a customer cancels service; for that, cancel all of the
959 customer's packages (see L</cancel>).
961 If the customer has any uncancelled packages, you need to pass a new (valid)
962 customer number for those packages to be transferred to. Cancelled packages
963 will be deleted. Did I mention that this is NOT what you want when a customer
964 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
966 You can't delete a customer with invoices (see L<FS::cust_bill>),
967 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
968 refunds (see L<FS::cust_refund>).
975 local $SIG{HUP} = 'IGNORE';
976 local $SIG{INT} = 'IGNORE';
977 local $SIG{QUIT} = 'IGNORE';
978 local $SIG{TERM} = 'IGNORE';
979 local $SIG{TSTP} = 'IGNORE';
980 local $SIG{PIPE} = 'IGNORE';
982 my $oldAutoCommit = $FS::UID::AutoCommit;
983 local $FS::UID::AutoCommit = 0;
986 if ( $self->cust_bill ) {
987 $dbh->rollback if $oldAutoCommit;
988 return "Can't delete a customer with invoices";
990 if ( $self->cust_credit ) {
991 $dbh->rollback if $oldAutoCommit;
992 return "Can't delete a customer with credits";
994 if ( $self->cust_pay ) {
995 $dbh->rollback if $oldAutoCommit;
996 return "Can't delete a customer with payments";
998 if ( $self->cust_refund ) {
999 $dbh->rollback if $oldAutoCommit;
1000 return "Can't delete a customer with refunds";
1003 my @cust_pkg = $self->ncancelled_pkgs;
1005 my $new_custnum = shift;
1006 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1007 $dbh->rollback if $oldAutoCommit;
1008 return "Invalid new customer number: $new_custnum";
1010 foreach my $cust_pkg ( @cust_pkg ) {
1011 my %hash = $cust_pkg->hash;
1012 $hash{'custnum'} = $new_custnum;
1013 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1014 my $error = $new_cust_pkg->replace($cust_pkg);
1016 $dbh->rollback if $oldAutoCommit;
1021 my @cancelled_cust_pkg = $self->all_pkgs;
1022 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1023 my $error = $cust_pkg->delete;
1025 $dbh->rollback if $oldAutoCommit;
1030 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1031 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1033 my $error = $cust_main_invoice->delete;
1035 $dbh->rollback if $oldAutoCommit;
1040 my $error = $self->SUPER::delete;
1042 $dbh->rollback if $oldAutoCommit;
1046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1051 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1053 Replaces the OLD_RECORD with this one in the database. If there is an error,
1054 returns the error, otherwise returns false.
1056 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1057 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1058 expected and rollback the entire transaction; it is not necessary to call
1059 check_invoicing_list first. Here's an example:
1061 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1069 warn "$me replace called\n"
1072 local $SIG{HUP} = 'IGNORE';
1073 local $SIG{INT} = 'IGNORE';
1074 local $SIG{QUIT} = 'IGNORE';
1075 local $SIG{TERM} = 'IGNORE';
1076 local $SIG{TSTP} = 'IGNORE';
1077 local $SIG{PIPE} = 'IGNORE';
1079 # We absolutely have to have an old vs. new record to make this work.
1080 if (!defined($old)) {
1081 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1084 my $curuser = $FS::CurrentUser::CurrentUser;
1085 if ( $self->payby eq 'COMP'
1086 && $self->payby ne $old->payby
1087 && ! $curuser->access_right('Complimentary customer')
1090 return "You are not permitted to create complimentary accounts.";
1093 local($ignore_expired_card) = 1
1094 if $old->payby =~ /^(CARD|DCRD)$/
1095 && $self->payby =~ /^(CARD|DCRD)$/
1096 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1098 my $oldAutoCommit = $FS::UID::AutoCommit;
1099 local $FS::UID::AutoCommit = 0;
1102 my $error = $self->SUPER::replace($old);
1105 $dbh->rollback if $oldAutoCommit;
1109 if ( @param ) { # INVOICING_LIST_ARYREF
1110 my $invoicing_list = shift @param;
1111 $error = $self->check_invoicing_list( $invoicing_list );
1113 $dbh->rollback if $oldAutoCommit;
1116 $self->invoicing_list( $invoicing_list );
1119 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1120 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1121 # card/check/lec info has changed, want to retry realtime_ invoice events
1122 my $error = $self->retry_realtime;
1124 $dbh->rollback if $oldAutoCommit;
1129 unless ( $import || $skip_fuzzyfiles ) {
1130 $error = $self->queue_fuzzyfiles_update;
1132 $dbh->rollback if $oldAutoCommit;
1133 return "updating fuzzy search cache: $error";
1137 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1142 =item queue_fuzzyfiles_update
1144 Used by insert & replace to update the fuzzy search cache
1148 sub queue_fuzzyfiles_update {
1151 local $SIG{HUP} = 'IGNORE';
1152 local $SIG{INT} = 'IGNORE';
1153 local $SIG{QUIT} = 'IGNORE';
1154 local $SIG{TERM} = 'IGNORE';
1155 local $SIG{TSTP} = 'IGNORE';
1156 local $SIG{PIPE} = 'IGNORE';
1158 my $oldAutoCommit = $FS::UID::AutoCommit;
1159 local $FS::UID::AutoCommit = 0;
1162 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1163 my $error = $queue->insert( map $self->getfield($_),
1164 qw(first last company)
1167 $dbh->rollback if $oldAutoCommit;
1168 return "queueing job (transaction rolled back): $error";
1171 if ( $self->ship_last ) {
1172 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1173 $error = $queue->insert( map $self->getfield("ship_$_"),
1174 qw(first last company)
1177 $dbh->rollback if $oldAutoCommit;
1178 return "queueing job (transaction rolled back): $error";
1182 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1189 Checks all fields to make sure this is a valid customer record. If there is
1190 an error, returns the error, otherwise returns false. Called by the insert
1191 and replace methods.
1198 warn "$me check BEFORE: \n". $self->_dump
1202 $self->ut_numbern('custnum')
1203 || $self->ut_number('agentnum')
1204 || $self->ut_textn('agent_custid')
1205 || $self->ut_number('refnum')
1206 || $self->ut_name('last')
1207 || $self->ut_name('first')
1208 || $self->ut_snumbern('birthdate')
1209 || $self->ut_snumbern('signupdate')
1210 || $self->ut_textn('company')
1211 || $self->ut_text('address1')
1212 || $self->ut_textn('address2')
1213 || $self->ut_text('city')
1214 || $self->ut_textn('county')
1215 || $self->ut_textn('state')
1216 || $self->ut_country('country')
1217 || $self->ut_anything('comments')
1218 || $self->ut_numbern('referral_custnum')
1220 #barf. need message catalogs. i18n. etc.
1221 $error .= "Please select an advertising source."
1222 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1223 return $error if $error;
1225 return "Unknown agent"
1226 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1228 return "Unknown refnum"
1229 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1231 return "Unknown referring custnum: ". $self->referral_custnum
1232 unless ! $self->referral_custnum
1233 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1235 if ( $self->ss eq '' ) {
1240 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1241 or return "Illegal social security number: ". $self->ss;
1242 $self->ss("$1-$2-$3");
1246 # bad idea to disable, causes billing to fail because of no tax rates later
1247 # unless ( $import ) {
1248 unless ( qsearch('cust_main_county', {
1249 'country' => $self->country,
1252 return "Unknown state/county/country: ".
1253 $self->state. "/". $self->county. "/". $self->country
1254 unless qsearch('cust_main_county',{
1255 'state' => $self->state,
1256 'county' => $self->county,
1257 'country' => $self->country,
1263 $self->ut_phonen('daytime', $self->country)
1264 || $self->ut_phonen('night', $self->country)
1265 || $self->ut_phonen('fax', $self->country)
1266 || $self->ut_zip('zip', $self->country)
1268 return $error if $error;
1271 last first company address1 address2 city county state zip
1272 country daytime night fax
1275 if ( defined $self->dbdef_table->column('ship_last') ) {
1276 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1278 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1282 $self->ut_name('ship_last')
1283 || $self->ut_name('ship_first')
1284 || $self->ut_textn('ship_company')
1285 || $self->ut_text('ship_address1')
1286 || $self->ut_textn('ship_address2')
1287 || $self->ut_text('ship_city')
1288 || $self->ut_textn('ship_county')
1289 || $self->ut_textn('ship_state')
1290 || $self->ut_country('ship_country')
1292 return $error if $error;
1294 #false laziness with above
1295 unless ( qsearchs('cust_main_county', {
1296 'country' => $self->ship_country,
1299 return "Unknown ship_state/ship_county/ship_country: ".
1300 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1301 unless qsearch('cust_main_county',{
1302 'state' => $self->ship_state,
1303 'county' => $self->ship_county,
1304 'country' => $self->ship_country,
1310 $self->ut_phonen('ship_daytime', $self->ship_country)
1311 || $self->ut_phonen('ship_night', $self->ship_country)
1312 || $self->ut_phonen('ship_fax', $self->ship_country)
1313 || $self->ut_zip('ship_zip', $self->ship_country)
1315 return $error if $error;
1317 } else { # ship_ info eq billing info, so don't store dup info in database
1318 $self->setfield("ship_$_", '')
1319 foreach qw( last first company address1 address2 city county state zip
1320 country daytime night fax );
1324 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1325 # or return "Illegal payby: ". $self->payby;
1327 FS::payby->can_payby($self->table, $self->payby)
1328 or return "Illegal payby: ". $self->payby;
1330 $error = $self->ut_numbern('paystart_month')
1331 || $self->ut_numbern('paystart_year')
1332 || $self->ut_numbern('payissue')
1334 return $error if $error;
1336 if ( $self->payip eq '' ) {
1339 $error = $self->ut_ip('payip');
1340 return $error if $error;
1343 # If it is encrypted and the private key is not availaible then we can't
1344 # check the credit card.
1346 my $check_payinfo = 1;
1348 if ($self->is_encrypted($self->payinfo)) {
1352 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1354 my $payinfo = $self->payinfo;
1355 $payinfo =~ s/\D//g;
1356 $payinfo =~ /^(\d{13,16})$/
1357 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1359 $self->payinfo($payinfo);
1361 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1363 return gettext('unknown_card_type')
1364 if cardtype($self->payinfo) eq "Unknown";
1366 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1368 return 'Banned credit card: banned on '.
1369 time2str('%a %h %o at %r', $ban->_date).
1370 ' by '. $ban->otaker.
1371 ' (ban# '. $ban->bannum. ')';
1374 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1375 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1376 $self->paycvv =~ /^(\d{4})$/
1377 or return "CVV2 (CID) for American Express cards is four digits.";
1380 $self->paycvv =~ /^(\d{3})$/
1381 or return "CVV2 (CVC2/CID) is three digits.";
1388 my $cardtype = cardtype($payinfo);
1389 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1391 return "Start date or issue number is required for $cardtype cards"
1392 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1394 return "Start month must be between 1 and 12"
1395 if $self->paystart_month
1396 and $self->paystart_month < 1 || $self->paystart_month > 12;
1398 return "Start year must be 1990 or later"
1399 if $self->paystart_year
1400 and $self->paystart_year < 1990;
1402 return "Issue number must be beween 1 and 99"
1404 and $self->payissue < 1 || $self->payissue > 99;
1407 $self->paystart_month('');
1408 $self->paystart_year('');
1409 $self->payissue('');
1412 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1414 my $payinfo = $self->payinfo;
1415 $payinfo =~ s/[^\d\@]//g;
1416 if ( $conf->exists('echeck-nonus') ) {
1417 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1418 $payinfo = "$1\@$2";
1420 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1421 $payinfo = "$1\@$2";
1423 $self->payinfo($payinfo);
1426 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1428 return 'Banned ACH account: banned on '.
1429 time2str('%a %h %o at %r', $ban->_date).
1430 ' by '. $ban->otaker.
1431 ' (ban# '. $ban->bannum. ')';
1434 } elsif ( $self->payby eq 'LECB' ) {
1436 my $payinfo = $self->payinfo;
1437 $payinfo =~ s/\D//g;
1438 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1440 $self->payinfo($payinfo);
1443 } elsif ( $self->payby eq 'BILL' ) {
1445 $error = $self->ut_textn('payinfo');
1446 return "Illegal P.O. number: ". $self->payinfo if $error;
1449 } elsif ( $self->payby eq 'COMP' ) {
1451 my $curuser = $FS::CurrentUser::CurrentUser;
1452 if ( ! $self->custnum
1453 && ! $curuser->access_right('Complimentary customer')
1456 return "You are not permitted to create complimentary accounts."
1459 $error = $self->ut_textn('payinfo');
1460 return "Illegal comp account issuer: ". $self->payinfo if $error;
1463 } elsif ( $self->payby eq 'PREPAY' ) {
1465 my $payinfo = $self->payinfo;
1466 $payinfo =~ s/\W//g; #anything else would just confuse things
1467 $self->payinfo($payinfo);
1468 $error = $self->ut_alpha('payinfo');
1469 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1470 return "Unknown prepayment identifier"
1471 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1476 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1477 return "Expiration date required"
1478 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1482 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1483 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1484 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1485 ( $m, $y ) = ( $3, "20$2" );
1487 return "Illegal expiration date: ". $self->paydate;
1489 $self->paydate("$y-$m-01");
1490 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1491 return gettext('expired_card')
1493 && !$ignore_expired_card
1494 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1497 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1498 ( ! $conf->exists('require_cardname')
1499 || $self->payby !~ /^(CARD|DCRD)$/ )
1501 $self->payname( $self->first. " ". $self->getfield('last') );
1503 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1504 or return gettext('illegal_name'). " payname: ". $self->payname;
1508 foreach my $flag (qw( tax spool_cdr )) {
1509 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1513 $self->otaker(getotaker) unless $self->otaker;
1515 warn "$me check AFTER: \n". $self->_dump
1518 $self->SUPER::check;
1523 Returns all packages (see L<FS::cust_pkg>) for this customer.
1530 return $self->num_pkgs unless wantarray;
1533 if ( $self->{'_pkgnum'} ) {
1534 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1536 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1539 sort sort_packages @cust_pkg;
1542 =item ncancelled_pkgs
1544 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1548 sub ncancelled_pkgs {
1551 return $self->num_ncancelled_pkgs unless wantarray;
1554 if ( $self->{'_pkgnum'} ) {
1556 @cust_pkg = grep { ! $_->getfield('cancel') }
1557 values %{ $self->{'_pkgnum'}->cache };
1562 qsearch( 'cust_pkg', {
1563 'custnum' => $self->custnum,
1567 qsearch( 'cust_pkg', {
1568 'custnum' => $self->custnum,
1573 sort sort_packages @cust_pkg;
1577 # This should be generalized to use config options to determine order.
1579 if ( $a->get('cancel') and $b->get('cancel') ) {
1580 $a->pkgnum <=> $b->pkgnum;
1581 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1582 return -1 if $b->get('cancel');
1583 return 1 if $a->get('cancel');
1586 $a->pkgnum <=> $b->pkgnum;
1590 =item suspended_pkgs
1592 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1596 sub suspended_pkgs {
1598 grep { $_->susp } $self->ncancelled_pkgs;
1601 =item unflagged_suspended_pkgs
1603 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1604 customer (thouse packages without the `manual_flag' set).
1608 sub unflagged_suspended_pkgs {
1610 return $self->suspended_pkgs
1611 unless dbdef->table('cust_pkg')->column('manual_flag');
1612 grep { ! $_->manual_flag } $self->suspended_pkgs;
1615 =item unsuspended_pkgs
1617 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1622 sub unsuspended_pkgs {
1624 grep { ! $_->susp } $self->ncancelled_pkgs;
1627 =item num_cancelled_pkgs
1629 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1634 sub num_cancelled_pkgs {
1635 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1638 sub num_ncancelled_pkgs {
1639 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1643 my( $self, $sql ) = @_;
1644 my $sth = dbh->prepare(
1645 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? AND $sql"
1646 ) or die dbh->errstr;
1647 $sth->execute($self->custnum) or die $sth->errstr;
1648 $sth->fetchrow_arrayref->[0];
1653 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1654 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1655 on success or a list of errors.
1661 grep { $_->unsuspend } $self->suspended_pkgs;
1666 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1668 Returns a list: an empty list on success or a list of errors.
1674 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1677 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1679 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1680 PKGPARTs (see L<FS::part_pkg>).
1682 Returns a list: an empty list on success or a list of errors.
1686 sub suspend_if_pkgpart {
1688 my (@pkgparts, %opt);
1689 if (ref($_[0]) eq 'HASH'){
1690 @pkgparts = @{$_[0]{pkgparts}};
1695 grep { $_->suspend(%opt) }
1696 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1697 $self->unsuspended_pkgs;
1700 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1702 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1703 listed PKGPARTs (see L<FS::part_pkg>).
1705 Returns a list: an empty list on success or a list of errors.
1709 sub suspend_unless_pkgpart {
1711 my (@pkgparts, %opt);
1712 if (ref($_[0]) eq 'HASH'){
1713 @pkgparts = @{$_[0]{pkgparts}};
1718 grep { $_->suspend(%opt) }
1719 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1720 $self->unsuspended_pkgs;
1723 =item cancel [ OPTION => VALUE ... ]
1725 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1727 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1729 I<quiet> can be set true to supress email cancellation notices.
1731 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1733 I<ban> can be set true to ban this customer's credit card or ACH information,
1736 Always returns a list: an empty list on success or a list of errors.
1744 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1746 #should try decryption (we might have the private key)
1747 # and if not maybe queue a job for the server that does?
1748 return ( "Can't (yet) ban encrypted credit cards" )
1749 if $self->is_encrypted($self->payinfo);
1751 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1752 my $error = $ban->insert;
1753 return ( $error ) if $error;
1757 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1760 sub _banned_pay_hashref {
1771 'payby' => $payby2ban{$self->payby},
1772 'payinfo' => md5_base64($self->payinfo),
1773 #don't ever *search* on reason! #'reason' =>
1779 Returns all notes (see L<FS::cust_main_note>) for this customer.
1786 qsearch( 'cust_main_note',
1787 { 'custnum' => $self->custnum },
1789 'ORDER BY _DATE DESC'
1795 Returns the agent (see L<FS::agent>) for this customer.
1801 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1806 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1807 conjunction with the collect method.
1809 Options are passed as name-value pairs.
1811 Currently available options are:
1813 resetup - if set true, re-charges setup fees.
1815 time - bills the customer as if it were that time. Specified as a UNIX
1816 timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
1817 L<Date::Parse> for conversion functions. For example:
1821 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1824 If there is an error, returns the error, otherwise returns false.
1829 my( $self, %options ) = @_;
1830 return '' if $self->payby eq 'COMP';
1831 warn "$me bill customer ". $self->custnum. "\n"
1834 my $time = $options{'time'} || time;
1839 local $SIG{HUP} = 'IGNORE';
1840 local $SIG{INT} = 'IGNORE';
1841 local $SIG{QUIT} = 'IGNORE';
1842 local $SIG{TERM} = 'IGNORE';
1843 local $SIG{TSTP} = 'IGNORE';
1844 local $SIG{PIPE} = 'IGNORE';
1846 my $oldAutoCommit = $FS::UID::AutoCommit;
1847 local $FS::UID::AutoCommit = 0;
1850 $self->select_for_update; #mutex
1852 #create a new invoice
1853 #(we'll remove it later if it doesn't actually need to be generated [contains
1854 # no line items] and we're inside a transaciton so nothing else will see it)
1855 my $cust_bill = new FS::cust_bill ( {
1856 'custnum' => $self->custnum,
1858 #'charged' => $charged,
1861 $error = $cust_bill->insert;
1863 $dbh->rollback if $oldAutoCommit;
1864 return "can't create invoice for customer #". $self->custnum. ": $error";
1866 my $invnum = $cust_bill->invnum;
1869 # find the packages which are due for billing, find out how much they are
1870 # & generate invoice database.
1873 my( $total_setup, $total_recur ) = ( 0, 0 );
1875 my @precommit_hooks = ();
1877 foreach my $cust_pkg (
1878 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1881 #NO!! next if $cust_pkg->cancel;
1882 next if $cust_pkg->getfield('cancel');
1884 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1886 #? to avoid use of uninitialized value errors... ?
1887 $cust_pkg->setfield('bill', '')
1888 unless defined($cust_pkg->bill);
1890 my $part_pkg = $cust_pkg->part_pkg;
1892 my %hash = $cust_pkg->hash;
1893 my $old_cust_pkg = new FS::cust_pkg \%hash;
1902 if ( !$cust_pkg->setup || $options{'resetup'} ) {
1904 warn " bill setup\n" if $DEBUG > 1;
1906 $setup = eval { $cust_pkg->calc_setup( $time ) };
1908 $dbh->rollback if $oldAutoCommit;
1909 return "$@ running calc_setup for $cust_pkg\n";
1912 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1916 # bill recurring fee
1921 if ( $part_pkg->getfield('freq') ne '0' &&
1922 ! $cust_pkg->getfield('susp') &&
1923 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1926 warn " bill recur\n" if $DEBUG > 1;
1928 # XXX shared with $recur_prog
1929 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1931 #over two params! lets at least switch to a hashref for the rest...
1932 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1934 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1936 $dbh->rollback if $oldAutoCommit;
1937 return "$@ running calc_recur for $cust_pkg\n";
1940 #change this bit to use Date::Manip? CAREFUL with timezones (see
1941 # mailing list archive)
1942 my ($sec,$min,$hour,$mday,$mon,$year) =
1943 (localtime($sdate) )[0,1,2,3,4,5];
1945 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1946 # only for figuring next bill date, nothing else, so, reset $sdate again
1948 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1949 $cust_pkg->last_bill($sdate)
1950 if $cust_pkg->dbdef_table->column('last_bill');
1952 if ( $part_pkg->freq =~ /^\d+$/ ) {
1953 $mon += $part_pkg->freq;
1954 until ( $mon < 12 ) { $mon -= 12; $year++; }
1955 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1957 $mday += $weeks * 7;
1958 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1961 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1965 $dbh->rollback if $oldAutoCommit;
1966 return "unparsable frequency: ". $part_pkg->freq;
1968 $cust_pkg->setfield('bill',
1969 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1972 warn "\$setup is undefined" unless defined($setup);
1973 warn "\$recur is undefined" unless defined($recur);
1974 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1977 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1980 if ( $cust_pkg->modified ) {
1982 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1985 $error=$cust_pkg->replace($old_cust_pkg);
1986 if ( $error ) { #just in case
1987 $dbh->rollback if $oldAutoCommit;
1988 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1991 $setup = sprintf( "%.2f", $setup );
1992 $recur = sprintf( "%.2f", $recur );
1993 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1994 $dbh->rollback if $oldAutoCommit;
1995 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1997 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1998 $dbh->rollback if $oldAutoCommit;
1999 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2002 if ( $setup != 0 || $recur != 0 ) {
2004 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2006 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2007 'invnum' => $invnum,
2008 'pkgnum' => $cust_pkg->pkgnum,
2012 'edate' => $cust_pkg->bill,
2013 'details' => \@details,
2015 $error = $cust_bill_pkg->insert;
2017 $dbh->rollback if $oldAutoCommit;
2018 return "can't create invoice line item for invoice #$invnum: $error";
2020 $total_setup += $setup;
2021 $total_recur += $recur;
2027 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2030 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2033 my %taxhash = map { $_ => $self->get("$prefix$_") }
2034 qw( state county country );
2036 $taxhash{'taxclass'} = $part_pkg->taxclass;
2038 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2041 $taxhash{'taxclass'} = '';
2042 @taxes = qsearch( 'cust_main_county', \%taxhash );
2045 #one more try at a whole-country tax rate
2047 $taxhash{$_} = '' foreach qw( state county );
2048 @taxes = qsearch( 'cust_main_county', \%taxhash );
2051 # maybe eliminate this entirely, along with all the 0% records
2053 $dbh->rollback if $oldAutoCommit;
2055 "fatal: can't find tax rate for state/county/country/taxclass ".
2056 join('/', ( map $self->get("$prefix$_"),
2057 qw(state county country)
2059 $part_pkg->taxclass ). "\n";
2062 foreach my $tax ( @taxes ) {
2064 my $taxable_charged = 0;
2065 $taxable_charged += $setup
2066 unless $part_pkg->setuptax =~ /^Y$/i
2067 || $tax->setuptax =~ /^Y$/i;
2068 $taxable_charged += $recur
2069 unless $part_pkg->recurtax =~ /^Y$/i
2070 || $tax->recurtax =~ /^Y$/i;
2071 next unless $taxable_charged;
2073 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2074 #my ($mon,$year) = (localtime($sdate) )[4,5];
2075 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2077 my $freq = $part_pkg->freq || 1;
2078 if ( $freq !~ /(\d+)$/ ) {
2079 $dbh->rollback if $oldAutoCommit;
2080 return "daily/weekly package definitions not (yet?)".
2081 " compatible with monthly tax exemptions";
2083 my $taxable_per_month =
2084 sprintf("%.2f", $taxable_charged / $freq );
2086 #call the whole thing off if this customer has any old
2087 #exemption records...
2088 my @cust_tax_exempt =
2089 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2090 if ( @cust_tax_exempt ) {
2091 $dbh->rollback if $oldAutoCommit;
2093 'this customer still has old-style tax exemption records; '.
2094 'run bin/fs-migrate-cust_tax_exempt?';
2097 foreach my $which_month ( 1 .. $freq ) {
2099 #maintain the new exemption table now
2102 FROM cust_tax_exempt_pkg
2103 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2104 LEFT JOIN cust_bill USING ( invnum )
2110 my $sth = dbh->prepare($sql) or do {
2111 $dbh->rollback if $oldAutoCommit;
2112 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2120 $dbh->rollback if $oldAutoCommit;
2121 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2123 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2125 my $remaining_exemption =
2126 $tax->exempt_amount - $existing_exemption;
2127 if ( $remaining_exemption > 0 ) {
2128 my $addl = $remaining_exemption > $taxable_per_month
2129 ? $taxable_per_month
2130 : $remaining_exemption;
2131 $taxable_charged -= $addl;
2133 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2134 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2135 'taxnum' => $tax->taxnum,
2136 'year' => 1900+$year,
2138 'amount' => sprintf("%.2f", $addl ),
2140 $error = $cust_tax_exempt_pkg->insert;
2142 $dbh->rollback if $oldAutoCommit;
2143 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2145 } # if $remaining_exemption > 0
2149 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2150 until ( $mon < 13 ) { $mon -= 12; $year++; }
2152 } #foreach $which_month
2154 } #if $tax->exempt_amount
2156 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2158 #$tax += $taxable_charged * $cust_main_county->tax / 100
2159 $tax{ $tax->taxname || 'Tax' } +=
2160 $taxable_charged * $tax->tax / 100
2162 } #foreach my $tax ( @taxes )
2164 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2166 } #if $setup != 0 || $recur != 0
2168 } #if $cust_pkg->modified
2170 } #foreach my $cust_pkg
2172 unless ( $cust_bill->cust_bill_pkg ) {
2173 $cust_bill->delete; #don't create an invoice w/o line items
2174 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2178 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2180 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2181 my $tax = sprintf("%.2f", $tax{$taxname} );
2182 $charged = sprintf( "%.2f", $charged+$tax );
2184 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2185 'invnum' => $invnum,
2191 'itemdesc' => $taxname,
2193 $error = $cust_bill_pkg->insert;
2195 $dbh->rollback if $oldAutoCommit;
2196 return "can't create invoice line item for invoice #$invnum: $error";
2198 $total_setup += $tax;
2202 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2203 $error = $cust_bill->replace;
2205 $dbh->rollback if $oldAutoCommit;
2206 return "can't update charged for invoice #$invnum: $error";
2209 foreach my $hook ( @precommit_hooks ) {
2211 &{$hook}; #($self) ?
2214 $dbh->rollback if $oldAutoCommit;
2215 return "$@ running precommit hook $hook\n";
2219 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2223 =item collect OPTIONS
2225 (Attempt to) collect money for this customer's outstanding invoices (see
2226 L<FS::cust_bill>). Usually used after the bill method.
2228 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2229 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2230 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2232 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2233 and the invoice events web interface.
2235 If there is an error, returns the error, otherwise returns false.
2237 Options are passed as name-value pairs.
2239 Currently available options are:
2241 invoice_time - Use this time when deciding when to print invoices and
2242 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>
2243 for conversion functions.
2245 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2248 quiet - set true to surpress email card/ACH decline notices.
2250 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2253 payby - allows for one time override of normal customer billing method
2258 my( $self, %options ) = @_;
2259 my $invoice_time = $options{'invoice_time'} || time;
2262 local $SIG{HUP} = 'IGNORE';
2263 local $SIG{INT} = 'IGNORE';
2264 local $SIG{QUIT} = 'IGNORE';
2265 local $SIG{TERM} = 'IGNORE';
2266 local $SIG{TSTP} = 'IGNORE';
2267 local $SIG{PIPE} = 'IGNORE';
2269 my $oldAutoCommit = $FS::UID::AutoCommit;
2270 local $FS::UID::AutoCommit = 0;
2273 $self->select_for_update; #mutex
2275 my $balance = $self->balance;
2276 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2278 unless ( $balance > 0 ) { #redundant?????
2279 $dbh->rollback if $oldAutoCommit; #hmm
2283 if ( exists($options{'retry_card'}) ) {
2284 carp 'retry_card option passed to collect is deprecated; use retry';
2285 $options{'retry'} ||= $options{'retry_card'};
2287 if ( exists($options{'retry'}) && $options{'retry'} ) {
2288 my $error = $self->retry_realtime;
2290 $dbh->rollback if $oldAutoCommit;
2296 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2297 $extra_sql = " AND freq = '1m' ";
2299 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2302 foreach my $cust_bill ( $self->open_cust_bill ) {
2304 # don't try to charge for the same invoice if it's already in a batch
2305 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2307 last if $self->balance <= 0;
2309 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2312 foreach my $part_bill_event ( due_events ( $cust_bill,
2313 exists($options{'payby'})
2319 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2320 || $self->balance <= 0; # or if balance<=0
2323 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2324 warn " do_event " . $cust_bill . " ". (%options) . "\n"
2327 if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2328 # gah, even with transactions.
2329 $dbh->commit if $oldAutoCommit; #well.
2338 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2343 =item retry_realtime
2345 Schedules realtime / batch credit card / electronic check / LEC billing
2346 events for for retry. Useful if card information has changed or manual
2347 retry is desired. The 'collect' method must be called to actually retry
2350 Implementation details: For each of this customer's open invoices, changes
2351 the status of the first "done" (with statustext error) realtime processing
2356 sub retry_realtime {
2359 local $SIG{HUP} = 'IGNORE';
2360 local $SIG{INT} = 'IGNORE';
2361 local $SIG{QUIT} = 'IGNORE';
2362 local $SIG{TERM} = 'IGNORE';
2363 local $SIG{TSTP} = 'IGNORE';
2364 local $SIG{PIPE} = 'IGNORE';
2366 my $oldAutoCommit = $FS::UID::AutoCommit;
2367 local $FS::UID::AutoCommit = 0;
2370 foreach my $cust_bill (
2371 grep { $_->cust_bill_event }
2372 $self->open_cust_bill
2374 my @cust_bill_event =
2375 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2377 #$_->part_bill_event->plan eq 'realtime-card'
2378 $_->part_bill_event->eventcode =~
2379 /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2380 && $_->status eq 'done'
2383 $cust_bill->cust_bill_event;
2384 next unless @cust_bill_event;
2385 my $error = $cust_bill_event[0]->retry;
2387 $dbh->rollback if $oldAutoCommit;
2388 return "error scheduling invoice event for retry: $error";
2393 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2398 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2400 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2401 via a Business::OnlinePayment realtime gateway. See
2402 L<http://420.am/business-onlinepayment> for supported gateways.
2404 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2406 Available options are: I<description>, I<invnum>, I<quiet>
2408 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2409 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2410 if set, will override the value from the customer record.
2412 I<description> is a free-text field passed to the gateway. It defaults to
2413 "Internet services".
2415 If an I<invnum> is specified, this payment (if successful) is applied to the
2416 specified invoice. If you don't specify an I<invnum> you might want to
2417 call the B<apply_payments> method.
2419 I<quiet> can be set true to surpress email decline notices.
2421 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2426 my( $self, $method, $amount, %options ) = @_;
2428 warn "$me realtime_bop: $method $amount\n";
2429 warn " $_ => $options{$_}\n" foreach keys %options;
2432 $options{'description'} ||= 'Internet services';
2434 eval "use Business::OnlinePayment";
2437 my $payinfo = exists($options{'payinfo'})
2438 ? $options{'payinfo'}
2446 if ( $options{'invnum'} ) {
2447 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2448 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2450 map { $_->part_pkg->taxclass }
2452 map { $_->cust_pkg }
2453 $cust_bill->cust_bill_pkg;
2454 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2455 #different taxclasses
2456 $taxclass = $taxclasses[0];
2460 #look for an agent gateway override first
2462 if ( $method eq 'CC' ) {
2463 $cardtype = cardtype($payinfo);
2464 } elsif ( $method eq 'ECHECK' ) {
2467 $cardtype = $method;
2471 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2472 cardtype => $cardtype,
2473 taxclass => $taxclass, } )
2474 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2476 taxclass => $taxclass, } )
2477 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2478 cardtype => $cardtype,
2480 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2482 taxclass => '', } );
2484 my $payment_gateway = '';
2485 my( $processor, $login, $password, $action, @bop_options );
2486 if ( $override ) { #use a payment gateway override
2488 $payment_gateway = $override->payment_gateway;
2490 $processor = $payment_gateway->gateway_module;
2491 $login = $payment_gateway->gateway_username;
2492 $password = $payment_gateway->gateway_password;
2493 $action = $payment_gateway->gateway_action;
2494 @bop_options = $payment_gateway->options;
2496 } else { #use the standard settings from the config
2498 ( $processor, $login, $password, $action, @bop_options ) =
2499 $self->default_payment_gateway($method);
2507 my $address = exists($options{'address1'})
2508 ? $options{'address1'}
2510 my $address2 = exists($options{'address2'})
2511 ? $options{'address2'}
2513 $address .= ", ". $address2 if length($address2);
2515 my $o_payname = exists($options{'payname'})
2516 ? $options{'payname'}
2518 my($payname, $payfirst, $paylast);
2519 if ( $o_payname && $method ne 'ECHECK' ) {
2520 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2521 or return "Illegal payname $payname";
2522 ($payfirst, $paylast) = ($1, $2);
2524 $payfirst = $self->getfield('first');
2525 $paylast = $self->getfield('last');
2526 $payname = "$payfirst $paylast";
2529 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2530 if ( $conf->exists('emailinvoiceauto')
2531 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2532 push @invoicing_list, $self->all_emails;
2535 my $email = ($conf->exists('business-onlinepayment-email-override'))
2536 ? $conf->config('business-onlinepayment-email-override')
2537 : $invoicing_list[0];
2541 my $payip = exists($options{'payip'})
2544 $content{customer_ip} = $payip
2547 $content{invoice_number} = $options{'invnum'}
2548 if exists($options{'invnum'}) && length($options{'invnum'});
2550 if ( $method eq 'CC' ) {
2552 $content{card_number} = $payinfo;
2553 my $paydate = exists($options{'paydate'})
2554 ? $options{'paydate'}
2556 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2557 $content{expiration} = "$2/$1";
2559 my $paycvv = exists($options{'paycvv'})
2560 ? $options{'paycvv'}
2562 $content{cvv2} = $self->paycvv
2565 my $paystart_month = exists($options{'paystart_month'})
2566 ? $options{'paystart_month'}
2567 : $self->paystart_month;
2569 my $paystart_year = exists($options{'paystart_year'})
2570 ? $options{'paystart_year'}
2571 : $self->paystart_year;
2573 $content{card_start} = "$paystart_month/$paystart_year"
2574 if $paystart_month && $paystart_year;
2576 my $payissue = exists($options{'payissue'})
2577 ? $options{'payissue'}
2579 $content{issue_number} = $payissue if $payissue;
2581 $content{recurring_billing} = 'YES'
2582 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2584 'payinfo' => $payinfo,
2586 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2588 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2592 } elsif ( $method eq 'ECHECK' ) {
2593 ( $content{account_number}, $content{routing_code} ) =
2594 split('@', $payinfo);
2595 $content{bank_name} = $o_payname;
2596 $content{account_type} = 'CHECKING';
2597 $content{account_name} = $payname;
2598 $content{customer_org} = $self->company ? 'B' : 'I';
2599 $content{customer_ssn} = exists($options{'ss'})
2602 } elsif ( $method eq 'LEC' ) {
2603 $content{phone} = $payinfo;
2607 # run transaction(s)
2610 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2612 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2613 $transaction->content(
2616 'password' => $password,
2617 'action' => $action1,
2618 'description' => $options{'description'},
2619 'amount' => $amount,
2620 #'invoice_number' => $options{'invnum'},
2621 'customer_id' => $self->custnum,
2622 'last_name' => $paylast,
2623 'first_name' => $payfirst,
2625 'address' => $address,
2626 'city' => ( exists($options{'city'})
2629 'state' => ( exists($options{'state'})
2632 'zip' => ( exists($options{'zip'})
2635 'country' => ( exists($options{'country'})
2636 ? $options{'country'}
2638 'referer' => 'http://cleanwhisker.420.am/',
2640 'phone' => $self->daytime || $self->night,
2643 $transaction->submit();
2645 if ( $transaction->is_success() && $action2 ) {
2646 my $auth = $transaction->authorization;
2647 my $ordernum = $transaction->can('order_number')
2648 ? $transaction->order_number
2652 new Business::OnlinePayment( $processor, @bop_options );
2659 password => $password,
2660 order_number => $ordernum,
2662 authorization => $auth,
2663 description => $options{'description'},
2666 foreach my $field (qw( authorization_source_code returned_ACI
2667 transaction_identifier validation_code
2668 transaction_sequence_num local_transaction_date
2669 local_transaction_time AVS_result_code )) {
2670 $capture{$field} = $transaction->$field() if $transaction->can($field);
2673 $capture->content( %capture );
2677 unless ( $capture->is_success ) {
2678 my $e = "Authorization successful but capture failed, custnum #".
2679 $self->custnum. ': '. $capture->result_code.
2680 ": ". $capture->error_message;
2688 # remove paycvv after initial transaction
2691 #false laziness w/misc/process/payment.cgi - check both to make sure working
2693 if ( defined $self->dbdef_table->column('paycvv')
2694 && length($self->paycvv)
2695 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2697 my $error = $self->remove_cvv;
2699 warn "WARNING: error removing cvv: $error\n";
2707 if ( $transaction->is_success() ) {
2709 my %method2payby = (
2716 if ( $payment_gateway ) { # agent override
2717 $paybatch = $payment_gateway->gatewaynum. '-';
2720 $paybatch .= "$processor:". $transaction->authorization;
2722 $paybatch .= ':'. $transaction->order_number
2723 if $transaction->can('order_number')
2724 && length($transaction->order_number);
2726 my $cust_pay = new FS::cust_pay ( {
2727 'custnum' => $self->custnum,
2728 'invnum' => $options{'invnum'},
2731 'payby' => $method2payby{$method},
2732 'payinfo' => $payinfo,
2733 'paybatch' => $paybatch,
2735 my $error = $cust_pay->insert;
2737 $cust_pay->invnum(''); #try again with no specific invnum
2738 my $error2 = $cust_pay->insert;
2740 # gah, even with transactions.
2741 my $e = 'WARNING: Card/ACH debited but database not updated - '.
2742 "error inserting payment ($processor): $error2".
2743 " (previously tried insert with invnum #$options{'invnum'}" .
2749 return ''; #no error
2753 my $perror = "$processor error: ". $transaction->error_message;
2755 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2756 && $conf->exists('emaildecline')
2757 && grep { $_ ne 'POST' } $self->invoicing_list
2758 && ! grep { $transaction->error_message =~ /$_/ }
2759 $conf->config('emaildecline-exclude')
2761 my @templ = $conf->config('declinetemplate');
2762 my $template = new Text::Template (
2764 SOURCE => [ map "$_\n", @templ ],
2765 ) or return "($perror) can't create template: $Text::Template::ERROR";
2766 $template->compile()
2767 or return "($perror) can't compile template: $Text::Template::ERROR";
2769 my $templ_hash = { error => $transaction->error_message };
2771 my $error = send_email(
2772 'from' => $conf->config('invoice_from'),
2773 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2774 'subject' => 'Your payment could not be processed',
2775 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2778 $perror .= " (also received error sending decline notification: $error)"
2788 =item default_payment_gateway
2792 sub default_payment_gateway {
2793 my( $self, $method ) = @_;
2795 die "Real-time processing not enabled\n"
2796 unless $conf->exists('business-onlinepayment');
2799 my $bop_config = 'business-onlinepayment';
2800 $bop_config .= '-ach'
2801 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2802 my ( $processor, $login, $password, $action, @bop_options ) =
2803 $conf->config($bop_config);
2804 $action ||= 'normal authorization';
2805 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2806 die "No real-time processor is enabled - ".
2807 "did you set the business-onlinepayment configuration value?\n"
2810 ( $processor, $login, $password, $action, @bop_options )
2815 Removes the I<paycvv> field from the database directly.
2817 If there is an error, returns the error, otherwise returns false.
2823 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2824 or return dbh->errstr;
2825 $sth->execute($self->custnum)
2826 or return $sth->errstr;
2831 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2833 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2834 via a Business::OnlinePayment realtime gateway. See
2835 L<http://420.am/business-onlinepayment> for supported gateways.
2837 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2839 Available options are: I<amount>, I<reason>, I<paynum>
2841 Most gateways require a reference to an original payment transaction to refund,
2842 so you probably need to specify a I<paynum>.
2844 I<amount> defaults to the original amount of the payment if not specified.
2846 I<reason> specifies a reason for the refund.
2848 Implementation note: If I<amount> is unspecified or equal to the amount of the
2849 orignal payment, first an attempt is made to "void" the transaction via
2850 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2851 the normal attempt is made to "refund" ("credit") the transaction via the
2852 gateway is attempted.
2854 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2855 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2856 #if set, will override the value from the customer record.
2858 #If an I<invnum> is specified, this payment (if successful) is applied to the
2859 #specified invoice. If you don't specify an I<invnum> you might want to
2860 #call the B<apply_payments> method.
2864 #some false laziness w/realtime_bop, not enough to make it worth merging
2865 #but some useful small subs should be pulled out
2866 sub realtime_refund_bop {
2867 my( $self, $method, %options ) = @_;
2869 warn "$me realtime_refund_bop: $method refund\n";
2870 warn " $_ => $options{$_}\n" foreach keys %options;
2873 eval "use Business::OnlinePayment";
2877 # look up the original payment and optionally a gateway for that payment
2881 my $amount = $options{'amount'};
2883 my( $processor, $login, $password, @bop_options ) ;
2884 my( $auth, $order_number ) = ( '', '', '' );
2886 if ( $options{'paynum'} ) {
2888 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
2889 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2890 or return "Unknown paynum $options{'paynum'}";
2891 $amount ||= $cust_pay->paid;
2893 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-]*)(:([\w\-]+))?$/
2894 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2895 $cust_pay->paybatch;
2896 my $gatewaynum = '';
2897 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2899 if ( $gatewaynum ) { #gateway for the payment to be refunded
2901 my $payment_gateway =
2902 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2903 die "payment gateway $gatewaynum not found"
2904 unless $payment_gateway;
2906 $processor = $payment_gateway->gateway_module;
2907 $login = $payment_gateway->gateway_username;
2908 $password = $payment_gateway->gateway_password;
2909 @bop_options = $payment_gateway->options;
2911 } else { #try the default gateway
2913 my( $conf_processor, $unused_action );
2914 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2915 $self->default_payment_gateway($method);
2917 return "processor of payment $options{'paynum'} $processor does not".
2918 " match default processor $conf_processor"
2919 unless $processor eq $conf_processor;
2924 } else { # didn't specify a paynum, so look for agent gateway overrides
2925 # like a normal transaction
2928 if ( $method eq 'CC' ) {
2929 $cardtype = cardtype($self->payinfo);
2930 } elsif ( $method eq 'ECHECK' ) {
2933 $cardtype = $method;
2936 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2937 cardtype => $cardtype,
2939 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2941 taxclass => '', } );
2943 if ( $override ) { #use a payment gateway override
2945 my $payment_gateway = $override->payment_gateway;
2947 $processor = $payment_gateway->gateway_module;
2948 $login = $payment_gateway->gateway_username;
2949 $password = $payment_gateway->gateway_password;
2950 #$action = $payment_gateway->gateway_action;
2951 @bop_options = $payment_gateway->options;
2953 } else { #use the standard settings from the config
2956 ( $processor, $login, $password, $unused_action, @bop_options ) =
2957 $self->default_payment_gateway($method);
2962 return "neither amount nor paynum specified" unless $amount;
2967 'password' => $password,
2968 'order_number' => $order_number,
2969 'amount' => $amount,
2970 'referer' => 'http://cleanwhisker.420.am/',
2972 $content{authorization} = $auth
2973 if length($auth); #echeck/ACH transactions have an order # but no auth
2974 #(at least with authorize.net)
2976 #first try void if applicable
2977 if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
2978 warn " attempting void\n" if $DEBUG > 1;
2979 my $void = new Business::OnlinePayment( $processor, @bop_options );
2980 $void->content( 'action' => 'void', %content );
2982 if ( $void->is_success ) {
2983 my $error = $cust_pay->void($options{'reason'});
2985 # gah, even with transactions.
2986 my $e = 'WARNING: Card/ACH voided but database not updated - '.
2987 "error voiding payment: $error";
2991 warn " void successful\n" if $DEBUG > 1;
2996 warn " void unsuccessful, trying refund\n"
3000 my $address = $self->address1;
3001 $address .= ", ". $self->address2 if $self->address2;
3003 my($payname, $payfirst, $paylast);
3004 if ( $self->payname && $method ne 'ECHECK' ) {
3005 $payname = $self->payname;
3006 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3007 or return "Illegal payname $payname";
3008 ($payfirst, $paylast) = ($1, $2);
3010 $payfirst = $self->getfield('first');
3011 $paylast = $self->getfield('last');
3012 $payname = "$payfirst $paylast";
3015 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
3016 if ( $conf->exists('emailinvoiceauto')
3017 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3018 push @invoicing_list, $self->all_emails;
3021 my $email = ($conf->exists('business-onlinepayment-email-override'))
3022 ? $conf->config('business-onlinepayment-email-override')
3023 : $invoicing_list[0];
3025 my $payip = exists($options{'payip'})
3028 $content{customer_ip} = $payip
3032 if ( $method eq 'CC' ) {
3035 $content{card_number} = $payinfo = $cust_pay->payinfo;
3036 #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3037 #$content{expiration} = "$2/$1";
3039 $content{card_number} = $payinfo = $self->payinfo;
3040 $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3041 $content{expiration} = "$2/$1";
3044 } elsif ( $method eq 'ECHECK' ) {
3045 ( $content{account_number}, $content{routing_code} ) =
3046 split('@', $payinfo = $self->payinfo);
3047 $content{bank_name} = $self->payname;
3048 $content{account_type} = 'CHECKING';
3049 $content{account_name} = $payname;
3050 $content{customer_org} = $self->company ? 'B' : 'I';
3051 $content{customer_ssn} = $self->ss;
3052 } elsif ( $method eq 'LEC' ) {
3053 $content{phone} = $payinfo = $self->payinfo;
3057 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3058 my %sub_content = $refund->content(
3059 'action' => 'credit',
3060 'customer_id' => $self->custnum,
3061 'last_name' => $paylast,
3062 'first_name' => $payfirst,
3064 'address' => $address,
3065 'city' => $self->city,
3066 'state' => $self->state,
3067 'zip' => $self->zip,
3068 'country' => $self->country,
3070 'phone' => $self->daytime || $self->night,
3073 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3077 return "$processor error: ". $refund->error_message
3078 unless $refund->is_success();
3080 my %method2payby = (
3086 my $paybatch = "$processor:". $refund->authorization;
3087 $paybatch .= ':'. $refund->order_number
3088 if $refund->can('order_number') && $refund->order_number;
3090 while ( $cust_pay && $cust_pay->unappled < $amount ) {
3091 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3092 last unless @cust_bill_pay;
3093 my $cust_bill_pay = pop @cust_bill_pay;
3094 my $error = $cust_bill_pay->delete;
3098 my $cust_refund = new FS::cust_refund ( {
3099 'custnum' => $self->custnum,
3100 'paynum' => $options{'paynum'},
3101 'refund' => $amount,
3103 'payby' => $method2payby{$method},
3104 'payinfo' => $payinfo,
3105 'paybatch' => $paybatch,
3106 'reason' => $options{'reason'} || 'card or ACH refund',
3108 my $error = $cust_refund->insert;
3110 $cust_refund->paynum(''); #try again with no specific paynum
3111 my $error2 = $cust_refund->insert;
3113 # gah, even with transactions.
3114 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3115 "error inserting refund ($processor): $error2".
3116 " (previously tried insert with paynum #$options{'paynum'}" .
3129 Returns the total owed for this customer on all invoices
3130 (see L<FS::cust_bill/owed>).
3136 $self->total_owed_date(2145859200); #12/31/2037
3139 =item total_owed_date TIME
3141 Returns the total owed for this customer on all invoices with date earlier than
3142 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3143 see L<Time::Local> and L<Date::Parse> for conversion functions.
3147 sub total_owed_date {
3151 foreach my $cust_bill (
3152 grep { $_->_date <= $time }
3153 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3155 $total_bill += $cust_bill->owed;
3157 sprintf( "%.2f", $total_bill );
3160 =item apply_credits OPTION => VALUE ...
3162 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3163 to outstanding invoice balances in chronological order (or reverse
3164 chronological order if the I<order> option is set to B<newest>) and returns the
3165 value of any remaining unapplied credits available for refund (see
3166 L<FS::cust_refund>).
3174 return 0 unless $self->total_credited;
3176 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3177 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3179 my @invoices = $self->open_cust_bill;
3180 @invoices = sort { $b->_date <=> $a->_date } @invoices
3181 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3184 foreach my $cust_bill ( @invoices ) {
3187 if ( !defined($credit) || $credit->credited == 0) {
3188 $credit = pop @credits or last;
3191 if ($cust_bill->owed >= $credit->credited) {
3192 $amount=$credit->credited;
3194 $amount=$cust_bill->owed;
3197 my $cust_credit_bill = new FS::cust_credit_bill ( {
3198 'crednum' => $credit->crednum,
3199 'invnum' => $cust_bill->invnum,
3200 'amount' => $amount,
3202 my $error = $cust_credit_bill->insert;
3203 die $error if $error;
3205 redo if ($cust_bill->owed > 0);
3209 return $self->total_credited;
3212 =item apply_payments
3214 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3215 to outstanding invoice balances in chronological order.
3217 #and returns the value of any remaining unapplied payments.
3221 sub apply_payments {
3226 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3227 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3229 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3230 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3234 foreach my $cust_bill ( @invoices ) {
3237 if ( !defined($payment) || $payment->unapplied == 0 ) {
3238 $payment = pop @payments or last;
3241 if ( $cust_bill->owed >= $payment->unapplied ) {
3242 $amount = $payment->unapplied;
3244 $amount = $cust_bill->owed;
3247 my $cust_bill_pay = new FS::cust_bill_pay ( {
3248 'paynum' => $payment->paynum,
3249 'invnum' => $cust_bill->invnum,
3250 'amount' => $amount,
3252 my $error = $cust_bill_pay->insert;
3253 die $error if $error;
3255 redo if ( $cust_bill->owed > 0);
3259 return $self->total_unapplied_payments;
3262 =item total_credited
3264 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3265 customer. See L<FS::cust_credit/credited>.
3269 sub total_credited {
3271 my $total_credit = 0;
3272 foreach my $cust_credit ( qsearch('cust_credit', {
3273 'custnum' => $self->custnum,
3275 $total_credit += $cust_credit->credited;
3277 sprintf( "%.2f", $total_credit );
3280 =item total_unapplied_payments
3282 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3283 See L<FS::cust_pay/unapplied>.
3287 sub total_unapplied_payments {
3289 my $total_unapplied = 0;
3290 foreach my $cust_pay ( qsearch('cust_pay', {
3291 'custnum' => $self->custnum,
3293 $total_unapplied += $cust_pay->unapplied;
3295 sprintf( "%.2f", $total_unapplied );
3300 Returns the balance for this customer (total_owed minus total_credited
3301 minus total_unapplied_payments).
3308 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3312 =item balance_date TIME
3314 Returns the balance for this customer, only considering invoices with date
3315 earlier than TIME (total_owed_date minus total_credited minus
3316 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3317 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3326 $self->total_owed_date($time)
3327 - $self->total_credited
3328 - $self->total_unapplied_payments
3332 =item in_transit_payments
3334 Returns the total of requests for payments for this customer pending in
3335 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3339 sub in_transit_payments {
3341 my $in_transit_payments = 0;
3342 foreach my $pay_batch ( qsearch('pay_batch', {
3345 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3346 'batchnum' => $pay_batch->batchnum,
3347 'custnum' => $self->custnum,
3349 $in_transit_payments += $cust_pay_batch->amount;
3352 sprintf( "%.2f", $in_transit_payments );
3355 =item paydate_monthyear
3357 Returns a two-element list consisting of the month and year of this customer's
3358 paydate (credit card expiration date for CARD customers)
3362 sub paydate_monthyear {
3364 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3366 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3373 =item invoicing_list [ ARRAYREF ]
3375 If an arguement is given, sets these email addresses as invoice recipients
3376 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3377 (except as warnings), so use check_invoicing_list first.
3379 Returns a list of email addresses (with svcnum entries expanded).
3381 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3382 check it without disturbing anything by passing nothing.
3384 This interface may change in the future.
3388 sub invoicing_list {
3389 my( $self, $arrayref ) = @_;
3392 my @cust_main_invoice;
3393 if ( $self->custnum ) {
3394 @cust_main_invoice =
3395 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3397 @cust_main_invoice = ();
3399 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3400 #warn $cust_main_invoice->destnum;
3401 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3402 #warn $cust_main_invoice->destnum;
3403 my $error = $cust_main_invoice->delete;
3404 warn $error if $error;
3407 if ( $self->custnum ) {
3408 @cust_main_invoice =
3409 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3411 @cust_main_invoice = ();
3413 my %seen = map { $_->address => 1 } @cust_main_invoice;
3414 foreach my $address ( @{$arrayref} ) {
3415 next if exists $seen{$address} && $seen{$address};
3416 $seen{$address} = 1;
3417 my $cust_main_invoice = new FS::cust_main_invoice ( {
3418 'custnum' => $self->custnum,
3421 my $error = $cust_main_invoice->insert;
3422 warn $error if $error;
3426 if ( $self->custnum ) {
3428 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3435 =item check_invoicing_list ARRAYREF
3437 Checks these arguements as valid input for the invoicing_list method. If there
3438 is an error, returns the error, otherwise returns false.
3442 sub check_invoicing_list {
3443 my( $self, $arrayref ) = @_;
3444 foreach my $address ( @{$arrayref} ) {
3446 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3447 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3450 my $cust_main_invoice = new FS::cust_main_invoice ( {
3451 'custnum' => $self->custnum,
3454 my $error = $self->custnum
3455 ? $cust_main_invoice->check
3456 : $cust_main_invoice->checkdest
3458 return $error if $error;
3463 =item set_default_invoicing_list
3465 Sets the invoicing list to all accounts associated with this customer,
3466 overwriting any previous invoicing list.
3470 sub set_default_invoicing_list {
3472 $self->invoicing_list($self->all_emails);
3477 Returns the email addresses of all accounts provisioned for this customer.
3484 foreach my $cust_pkg ( $self->all_pkgs ) {
3485 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3487 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3488 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3490 $list{$_}=1 foreach map { $_->email } @svc_acct;
3495 =item invoicing_list_addpost
3497 Adds postal invoicing to this customer. If this customer is already configured
3498 to receive postal invoices, does nothing.
3502 sub invoicing_list_addpost {
3504 return if grep { $_ eq 'POST' } $self->invoicing_list;
3505 my @invoicing_list = $self->invoicing_list;
3506 push @invoicing_list, 'POST';
3507 $self->invoicing_list(\@invoicing_list);
3510 =item invoicing_list_emailonly
3512 Returns the list of email invoice recipients (invoicing_list without non-email
3513 destinations such as POST and FAX).
3517 sub invoicing_list_emailonly {
3519 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3522 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3524 Returns an array of customers referred by this customer (referral_custnum set
3525 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3526 customers referred by customers referred by this customer and so on, inclusive.
3527 The default behavior is DEPTH 1 (no recursion).
3531 sub referral_cust_main {
3533 my $depth = @_ ? shift : 1;
3534 my $exclude = @_ ? shift : {};
3537 map { $exclude->{$_->custnum}++; $_; }
3538 grep { ! $exclude->{ $_->custnum } }
3539 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3543 map { $_->referral_cust_main($depth-1, $exclude) }
3550 =item referral_cust_main_ncancelled
3552 Same as referral_cust_main, except only returns customers with uncancelled
3557 sub referral_cust_main_ncancelled {
3559 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3562 =item referral_cust_pkg [ DEPTH ]
3564 Like referral_cust_main, except returns a flat list of all unsuspended (and
3565 uncancelled) packages for each customer. The number of items in this list may
3566 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3570 sub referral_cust_pkg {
3572 my $depth = @_ ? shift : 1;
3574 map { $_->unsuspended_pkgs }
3575 grep { $_->unsuspended_pkgs }
3576 $self->referral_cust_main($depth);
3579 =item referring_cust_main
3581 Returns the single cust_main record for the customer who referred this customer
3582 (referral_custnum), or false.
3586 sub referring_cust_main {
3588 return '' unless $self->referral_custnum;
3589 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3592 =item credit AMOUNT, REASON
3594 Applies a credit to this customer. If there is an error, returns the error,
3595 otherwise returns false.
3600 my( $self, $amount, $reason ) = @_;
3601 my $cust_credit = new FS::cust_credit {
3602 'custnum' => $self->custnum,
3603 'amount' => $amount,
3604 'reason' => $reason,
3606 $cust_credit->insert;
3609 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3611 Creates a one-time charge for this customer. If there is an error, returns
3612 the error, otherwise returns false.
3617 my ( $self, $amount ) = ( shift, shift );
3618 my $pkg = @_ ? shift : 'One-time charge';
3619 my $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3620 my $taxclass = @_ ? shift : '';
3622 local $SIG{HUP} = 'IGNORE';
3623 local $SIG{INT} = 'IGNORE';
3624 local $SIG{QUIT} = 'IGNORE';
3625 local $SIG{TERM} = 'IGNORE';
3626 local $SIG{TSTP} = 'IGNORE';
3627 local $SIG{PIPE} = 'IGNORE';
3629 my $oldAutoCommit = $FS::UID::AutoCommit;
3630 local $FS::UID::AutoCommit = 0;
3633 my $part_pkg = new FS::part_pkg ( {
3635 'comment' => $comment,
3636 #'setup' => $amount,
3639 'plandata' => "setup_fee=$amount",
3642 'taxclass' => $taxclass,
3645 my $error = $part_pkg->insert;
3647 $dbh->rollback if $oldAutoCommit;
3651 my $pkgpart = $part_pkg->pkgpart;
3652 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3653 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3654 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3655 $error = $type_pkgs->insert;
3657 $dbh->rollback if $oldAutoCommit;
3662 my $cust_pkg = new FS::cust_pkg ( {
3663 'custnum' => $self->custnum,
3664 'pkgpart' => $pkgpart,
3667 $error = $cust_pkg->insert;
3669 $dbh->rollback if $oldAutoCommit;
3673 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3680 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3686 sort { $a->_date <=> $b->_date }
3687 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3690 =item open_cust_bill
3692 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3697 sub open_cust_bill {
3699 grep { $_->owed > 0 } $self->cust_bill;
3704 Returns all the credits (see L<FS::cust_credit>) for this customer.
3710 sort { $a->_date <=> $b->_date }
3711 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3716 Returns all the payments (see L<FS::cust_pay>) for this customer.
3722 sort { $a->_date <=> $b->_date }
3723 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3728 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3734 sort { $a->_date <=> $b->_date }
3735 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3741 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3747 sort { $a->_date <=> $b->_date }
3748 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3751 =item select_for_update
3753 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
3758 sub select_for_update {
3760 qsearch('cust_main', { 'custnum' => $self->custnum }, '*', 'FOR UPDATE' );
3765 Returns a name string for this customer, either "Company (Last, First)" or
3772 my $name = $self->contact;
3773 $name = $self->company. " ($name)" if $self->company;
3779 Returns a name string for this (service/shipping) contact, either
3780 "Company (Last, First)" or "Last, First".
3786 if ( $self->get('ship_last') ) {
3787 my $name = $self->ship_contact;
3788 $name = $self->ship_company. " ($name)" if $self->ship_company;
3797 Returns this customer's full (billing) contact name only, "Last, First"
3803 $self->get('last'). ', '. $self->first;
3808 Returns this customer's full (shipping) contact name only, "Last, First"
3814 $self->get('ship_last')
3815 ? $self->get('ship_last'). ', '. $self->ship_first
3821 Returns this customer's full country name
3827 code2country($self->country);
3832 Returns a status string for this customer, currently:
3836 =item prospect - No packages have ever been ordered
3838 =item active - One or more recurring packages is active
3840 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3842 =item suspended - All non-cancelled recurring packages are suspended
3844 =item cancelled - All recurring packages are cancelled
3852 for my $status (qw( prospect active inactive suspended cancelled )) {
3853 my $method = $status.'_sql';
3854 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3855 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3856 $sth->execute( ($self->custnum) x $numnum ) or die $sth->errstr;
3857 return $status if $sth->fetchrow_arrayref->[0];
3863 Returns a hex triplet color string for this customer's status.
3867 use vars qw(%statuscolor);
3869 'prospect' => '7e0079', #'000000', #black? naw, purple
3870 'active' => '00CC00', #green
3871 'inactive' => '0000CC', #blue
3872 'suspended' => 'FF9900', #yellow
3873 'cancelled' => 'FF0000', #red
3878 $statuscolor{$self->status};
3883 =head1 CLASS METHODS
3889 Returns an SQL expression identifying prospective cust_main records (customers
3890 with no packages ever ordered)
3894 use vars qw($select_count_pkgs);
3895 $select_count_pkgs =
3896 "SELECT COUNT(*) FROM cust_pkg
3897 WHERE cust_pkg.custnum = cust_main.custnum";
3899 sub select_count_pkgs_sql {
3903 sub prospect_sql { "
3904 0 = ( $select_count_pkgs )
3909 Returns an SQL expression identifying active cust_main records (customers with
3910 no active recurring packages, but otherwise unsuspended/uncancelled).
3915 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
3921 Returns an SQL expression identifying inactive cust_main records (customers with
3922 active recurring packages).
3926 sub inactive_sql { "
3927 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3929 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
3935 Returns an SQL expression identifying suspended cust_main records.
3940 sub suspended_sql { susp_sql(@_); }
3942 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
3944 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3950 Returns an SQL expression identifying cancelled cust_main records.
3954 sub cancelled_sql { cancel_sql(@_); }
3957 my $recurring_sql = FS::cust_pkg->recurring_sql;
3958 #my $recurring_sql = "
3959 # '0' != ( select freq from part_pkg
3960 # where cust_pkg.pkgpart = part_pkg.pkgpart )
3964 0 < ( $select_count_pkgs )
3965 AND 0 = ( $select_count_pkgs AND $recurring_sql
3966 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3972 =item uncancelled_sql
3974 Returns an SQL expression identifying un-cancelled cust_main records.
3978 sub uncancelled_sql { uncancel_sql(@_); }
3979 sub uncancel_sql { "
3980 ( 0 < ( $select_count_pkgs
3981 AND ( cust_pkg.cancel IS NULL
3982 OR cust_pkg.cancel = 0
3985 OR 0 = ( $select_count_pkgs )
3989 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
3991 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
3992 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
3993 appropriate ship_ field is also searched).
3995 Additional options are the same as FS::Record::qsearch
4000 my( $self, $fuzzy, $hash, @opt) = @_;
4005 check_and_rebuild_fuzzyfiles();
4006 foreach my $field ( keys %$fuzzy ) {
4008 my $all = $self->all_X($field);
4009 next unless scalar(@$all);
4012 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4015 foreach ( keys %match ) {
4016 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4017 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4020 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4023 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4025 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4037 =item smart_search OPTION => VALUE ...
4039 Accepts the following options: I<search>, the string to search for. The string
4040 will be searched for as a customer number, phone number, name or company name,
4041 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4042 for the exact heuristics used).
4044 Any additional options are treated as an additional qualifier on the search
4047 Returns a (possibly empty) array of FS::cust_main objects.
4054 #here is the agent virtualization
4055 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4059 my $search = delete $options{'search'};
4060 ( my $alphanum_search = $search ) =~ s/\W//g;
4062 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4064 #false laziness w/Record::ut_phone
4065 my $phonen = "$1-$2-$3";
4066 $phonen .= " x$4" if $4;
4068 push @cust_main, qsearch( {
4069 'table' => 'cust_main',
4070 'hashref' => { %options },
4071 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4073 join(' OR ', map "$_ = '$phonen'",
4074 qw( daytime night fax
4075 ship_daytime ship_night ship_fax )
4078 " AND $agentnums_sql", #agent virtualization
4081 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4082 #try looking for matches with extensions unless one was specified
4084 push @cust_main, qsearch( {
4085 'table' => 'cust_main',
4086 'hashref' => { %options },
4087 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4089 join(' OR ', map "$_ LIKE '$phonen\%'",
4091 ship_daytime ship_night )
4094 " AND $agentnums_sql", #agent virtualization
4099 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4101 push @cust_main, qsearch( {
4102 'table' => 'cust_main',
4103 'hashref' => { 'custnum' => $1, %options },
4104 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4107 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4109 my($company, $last, $first) = ( $1, $2, $3 );
4111 # "Company (Last, First)"
4112 #this is probably something a browser remembered,
4113 #so just do an exact search
4115 foreach my $prefix ( '', 'ship_' ) {
4116 push @cust_main, qsearch( {
4117 'table' => 'cust_main',
4118 'hashref' => { $prefix.'first' => $first,
4119 $prefix.'last' => $last,
4120 $prefix.'company' => $company,
4123 'extra_sql' => " AND $agentnums_sql",
4127 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4128 # try (ship_){last,company}
4132 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4133 # # full strings the browser remembers won't work
4134 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4136 use Lingua::EN::NameParse;
4137 my $NameParse = new Lingua::EN::NameParse(
4139 allow_reversed => 1,
4142 my($last, $first) = ( '', '' );
4143 #maybe disable this too and just rely on NameParse?
4144 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4146 ($last, $first) = ( $1, $2 );
4148 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
4149 } elsif ( ! $NameParse->parse($value) ) {
4151 my %name = $NameParse->components;
4152 $first = $name{'given_name_1'};
4153 $last = $name{'surname_1'};
4157 if ( $first && $last ) {
4159 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4162 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4164 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4165 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4168 push @cust_main, qsearch( {
4169 'table' => 'cust_main',
4170 'hashref' => \%options,
4171 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4174 # or it just be something that was typed in... (try that in a sec)
4178 my $q_value = dbh->quote($value);
4181 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4182 $sql .= " ( LOWER(last) = $q_value
4183 OR LOWER(company) = $q_value
4184 OR LOWER(ship_last) = $q_value
4185 OR LOWER(ship_company) = $q_value
4188 push @cust_main, qsearch( {
4189 'table' => 'cust_main',
4190 'hashref' => \%options,
4191 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4194 #always do substring & fuzzy,
4195 #getting complains searches are not returning enough
4196 #unless ( @cust_main ) { #no exact match, trying substring/fuzzy
4198 #still some false laziness w/ search/cust_main.cgi
4203 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
4204 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4207 if ( $first && $last ) {
4210 { 'first' => { op=>'ILIKE', value=>"%$first%" },
4211 'last' => { op=>'ILIKE', value=>"%$last%" },
4213 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
4214 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
4221 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
4222 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
4226 foreach my $hashref ( @hashrefs ) {
4228 push @cust_main, qsearch( {
4229 'table' => 'cust_main',
4230 'hashref' => { %$hashref,
4233 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4242 " AND $agentnums_sql", #extra_sql #agent virtualization
4245 if ( $first && $last ) {
4246 push @cust_main, FS::cust_main->fuzzy_search(
4247 { 'last' => $last, #fuzzy hashref
4248 'first' => $first }, #
4252 foreach my $field ( 'last', 'company' ) {
4254 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4259 #eliminate duplicates
4261 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4269 =item check_and_rebuild_fuzzyfiles
4273 use vars qw(@fuzzyfields);
4274 @fuzzyfields = ( 'last', 'first', 'company' );
4276 sub check_and_rebuild_fuzzyfiles {
4277 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4278 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4281 =item rebuild_fuzzyfiles
4285 sub rebuild_fuzzyfiles {
4287 use Fcntl qw(:flock);
4289 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4290 mkdir $dir, 0700 unless -d $dir;
4292 foreach my $fuzzy ( @fuzzyfields ) {
4294 open(LOCK,">>$dir/cust_main.$fuzzy")
4295 or die "can't open $dir/cust_main.$fuzzy: $!";
4297 or die "can't lock $dir/cust_main.$fuzzy: $!";
4299 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4300 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4302 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4303 my $sth = dbh->prepare("SELECT $field FROM cust_main".
4304 " WHERE $field != '' AND $field IS NOT NULL");
4305 $sth->execute or die $sth->errstr;
4307 while ( my $row = $sth->fetchrow_arrayref ) {
4308 print CACHE $row->[0]. "\n";
4313 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4315 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4326 my( $self, $field ) = @_;
4327 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4328 open(CACHE,"<$dir/cust_main.$field")
4329 or die "can't open $dir/cust_main.$field: $!";
4330 my @array = map { chomp; $_; } <CACHE>;
4335 =item append_fuzzyfiles LASTNAME COMPANY
4339 sub append_fuzzyfiles {
4340 #my( $first, $last, $company ) = @_;
4342 &check_and_rebuild_fuzzyfiles;
4344 use Fcntl qw(:flock);
4346 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4348 foreach my $field (qw( first last company )) {
4353 open(CACHE,">>$dir/cust_main.$field")
4354 or die "can't open $dir/cust_main.$field: $!";
4355 flock(CACHE,LOCK_EX)
4356 or die "can't lock $dir/cust_main.$field: $!";
4358 print CACHE "$value\n";
4360 flock(CACHE,LOCK_UN)
4361 or die "can't unlock $dir/cust_main.$field: $!";
4376 #warn join('-',keys %$param);
4377 my $fh = $param->{filehandle};
4378 my $agentnum = $param->{agentnum};
4380 my $refnum = $param->{refnum};
4381 my $pkgpart = $param->{pkgpart};
4383 #my @fields = @{$param->{fields}};
4384 my $format = $param->{'format'};
4387 if ( $format eq 'simple' ) {
4388 @fields = qw( cust_pkg.setup dayphone first last
4389 address1 address2 city state zip comments );
4391 } elsif ( $format eq 'extended' ) {
4392 @fields = qw( agent_custid refnum
4393 last first address1 address2 city state zip country
4395 ship_last ship_first ship_address1 ship_address2
4396 ship_city ship_state ship_zip ship_country
4397 payinfo paycvv paydate
4400 svc_acct.username svc_acct._password
4404 die "unknown format $format";
4407 eval "use Text::CSV_XS;";
4410 my $csv = new Text::CSV_XS;
4417 local $SIG{HUP} = 'IGNORE';
4418 local $SIG{INT} = 'IGNORE';
4419 local $SIG{QUIT} = 'IGNORE';
4420 local $SIG{TERM} = 'IGNORE';
4421 local $SIG{TSTP} = 'IGNORE';
4422 local $SIG{PIPE} = 'IGNORE';
4424 my $oldAutoCommit = $FS::UID::AutoCommit;
4425 local $FS::UID::AutoCommit = 0;
4428 #while ( $columns = $csv->getline($fh) ) {
4430 while ( defined($line=<$fh>) ) {
4432 $csv->parse($line) or do {
4433 $dbh->rollback if $oldAutoCommit;
4434 return "can't parse: ". $csv->error_input();
4437 my @columns = $csv->fields();
4438 #warn join('-',@columns);
4441 agentnum => $agentnum,
4443 country => $conf->config('countrydefault') || 'US',
4444 payby => $payby, #default
4445 paydate => '12/2037', #default
4447 my $billtime = time;
4448 my %cust_pkg = ( pkgpart => $pkgpart );
4450 foreach my $field ( @fields ) {
4452 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4454 #$cust_pkg{$1} = str2time( shift @$columns );
4455 if ( $1 eq 'pkgpart' ) {
4456 $cust_pkg{$1} = shift @columns;
4457 } elsif ( $1 eq 'setup' ) {
4458 $billtime = str2time(shift @columns);
4460 $cust_pkg{$1} = str2time( shift @columns );
4463 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4465 $svc_acct{$1} = shift @columns;
4469 #refnum interception
4470 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4472 my $referral = $columns[0];
4473 my %hash = ( 'referral' => $referral,
4474 'agentnum' => $agentnum,
4478 my $part_referral = qsearchs('part_referral', \%hash )
4479 || new FS::part_referral \%hash;
4481 unless ( $part_referral->refnum ) {
4482 my $error = $part_referral->insert;
4484 $dbh->rollback if $oldAutoCommit;
4485 return "can't auto-insert advertising source: $referral: $error";
4489 $columns[0] = $part_referral->refnum;
4492 #$cust_main{$field} = shift @$columns;
4493 $cust_main{$field} = shift @columns;
4497 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4499 my $invoicing_list = $cust_main{'invoicing_list'}
4500 ? [ delete $cust_main{'invoicing_list'} ]
4503 my $cust_main = new FS::cust_main ( \%cust_main );
4506 tie my %hash, 'Tie::RefHash'; #this part is important
4508 if ( $cust_pkg{'pkgpart'} ) {
4509 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4512 if ( $svc_acct{'username'} ) {
4513 my $part_pkg = $cust_pkg->part_pkg;
4514 unless ( $part_pkg ) {
4515 $dbh->rollback if $oldAutoCommit;
4516 return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4518 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4519 push @svc_acct, new FS::svc_acct ( \%svc_acct )
4522 $hash{$cust_pkg} = \@svc_acct;
4525 my $error = $cust_main->insert( \%hash, $invoicing_list );
4528 $dbh->rollback if $oldAutoCommit;
4529 return "can't insert customer for $line: $error";
4532 if ( $format eq 'simple' ) {
4534 #false laziness w/bill.cgi
4535 $error = $cust_main->bill( 'time' => $billtime );
4537 $dbh->rollback if $oldAutoCommit;
4538 return "can't bill customer for $line: $error";
4541 $cust_main->apply_payments;
4542 $cust_main->apply_credits;
4544 $error = $cust_main->collect();
4546 $dbh->rollback if $oldAutoCommit;
4547 return "can't collect customer for $line: $error";
4555 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4557 return "Empty file!" unless $imported;
4569 #warn join('-',keys %$param);
4570 my $fh = $param->{filehandle};
4571 my @fields = @{$param->{fields}};
4573 eval "use Text::CSV_XS;";
4576 my $csv = new Text::CSV_XS;
4583 local $SIG{HUP} = 'IGNORE';
4584 local $SIG{INT} = 'IGNORE';
4585 local $SIG{QUIT} = 'IGNORE';
4586 local $SIG{TERM} = 'IGNORE';
4587 local $SIG{TSTP} = 'IGNORE';
4588 local $SIG{PIPE} = 'IGNORE';
4590 my $oldAutoCommit = $FS::UID::AutoCommit;
4591 local $FS::UID::AutoCommit = 0;
4594 #while ( $columns = $csv->getline($fh) ) {
4596 while ( defined($line=<$fh>) ) {
4598 $csv->parse($line) or do {
4599 $dbh->rollback if $oldAutoCommit;
4600 return "can't parse: ". $csv->error_input();
4603 my @columns = $csv->fields();
4604 #warn join('-',@columns);
4607 foreach my $field ( @fields ) {
4608 $row{$field} = shift @columns;
4611 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4612 unless ( $cust_main ) {
4613 $dbh->rollback if $oldAutoCommit;
4614 return "unknown custnum $row{'custnum'}";
4617 if ( $row{'amount'} > 0 ) {
4618 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4620 $dbh->rollback if $oldAutoCommit;
4624 } elsif ( $row{'amount'} < 0 ) {
4625 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4628 $dbh->rollback if $oldAutoCommit;
4638 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4640 return "Empty file!" unless $imported;
4652 The delete method should possibly take an FS::cust_main object reference
4653 instead of a scalar customer number.
4655 Bill and collect options should probably be passed as references instead of a
4658 There should probably be a configuration file with a list of allowed credit
4661 No multiple currency support (probably a larger project than just this module).
4663 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4665 Birthdates rely on negative epoch values.
4669 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4670 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4671 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.