5 #FS::cust_main:_Marketgear when they're ready to move to 2.1
6 use base qw( FS::cust_main::Packages FS::cust_main::Status
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 use vars qw( $DEBUG $me $conf
16 $ignore_expired_card $ignore_illegal_zip $ignore_banned_card
21 use Scalar::Util qw( blessed );
22 use Time::Local qw(timelocal);
23 use Storable qw(thaw);
27 use Digest::MD5 qw(md5_base64);
30 use File::Temp; #qw( tempfile );
31 use Business::CreditCard 0.28;
33 use FS::UID qw( getotaker dbh driver_name );
34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_email send_email generate_ps do_print );
36 use FS::Msgcat qw(gettext);
43 use FS::legacy_cust_bill;
45 use FS::cust_pay_pending;
46 use FS::cust_pay_void;
47 use FS::cust_pay_batch;
50 use FS::part_referral;
51 use FS::cust_main_county;
52 use FS::cust_location;
54 use FS::cust_main_exemption;
55 use FS::cust_tax_adjustment;
56 use FS::cust_tax_location;
58 use FS::cust_main_invoice;
60 use FS::prepay_credit;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::cust_main_note;
70 use FS::cust_attachment;
74 # 1 is mostly method/subroutine entry and options
75 # 2 traces progress of some operations
76 # 3 is even more information including possibly sensitive data
78 $me = '[FS::cust_main]';
81 $ignore_expired_card = 0;
82 $ignore_illegal_zip = 0;
83 $ignore_banned_card = 0;
87 @encrypted_fields = ('payinfo', 'paycvv');
88 sub nohistory_fields { ('payinfo', 'paycvv'); }
90 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
92 #ask FS::UID to run this stuff for us later
93 #$FS::UID::callback{'FS::cust_main'} = sub {
94 install_callback FS::UID sub {
96 #yes, need it for stuff below (prolly should be cached)
101 my ( $hashref, $cache ) = @_;
102 if ( exists $hashref->{'pkgnum'} ) {
103 #@{ $self->{'_pkgnum'} } = ();
104 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
105 $self->{'_pkgnum'} = $subcache;
106 #push @{ $self->{'_pkgnum'} },
107 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
113 FS::cust_main - Object methods for cust_main records
119 $record = new FS::cust_main \%hash;
120 $record = new FS::cust_main { 'column' => 'value' };
122 $error = $record->insert;
124 $error = $new_record->replace($old_record);
126 $error = $record->delete;
128 $error = $record->check;
130 @cust_pkg = $record->all_pkgs;
132 @cust_pkg = $record->ncancelled_pkgs;
134 @cust_pkg = $record->suspended_pkgs;
136 $error = $record->bill;
137 $error = $record->bill %options;
138 $error = $record->bill 'time' => $time;
140 $error = $record->collect;
141 $error = $record->collect %options;
142 $error = $record->collect 'invoice_time' => $time,
147 An FS::cust_main object represents a customer. FS::cust_main inherits from
148 FS::Record. The following fields are currently supported:
154 Primary key (assigned automatically for new customers)
158 Agent (see L<FS::agent>)
162 Advertising source (see L<FS::part_referral>)
174 Cocial security number (optional)
190 (optional, see L<FS::cust_main_county>)
194 (see L<FS::cust_main_county>)
200 (see L<FS::cust_main_county>)
240 (optional, see L<FS::cust_main_county>)
244 (see L<FS::cust_main_county>)
250 (see L<FS::cust_main_county>)
270 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
274 Payment Information (See L<FS::payinfo_Mixin> for data format)
278 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
282 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
286 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
290 Start date month (maestro/solo cards only)
294 Start date year (maestro/solo cards only)
298 Issue number (maestro/solo cards only)
302 Name on card or billing name
306 IP address from which payment information was received
310 Tax exempt, empty or `Y'
314 Order taker (see L<FS::access_user>)
320 =item referral_custnum
322 Referring customer number
326 Enable individual CDR spooling, empty or `Y'
330 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
334 Discourage individual CDR printing, empty or `Y'
338 Allow self-service editing of ticket subjects, empty or 'Y'
340 =item calling_list_exempt
342 Do not call, empty or 'Y'
352 Creates a new customer. To add the customer to the database, see L<"insert">.
354 Note that this stores the hash reference, not a distinct copy of the hash it
355 points to. You can ask the object for a copy with the I<hash> method.
359 sub table { 'cust_main'; }
361 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
363 Adds this customer to the database. If there is an error, returns the error,
364 otherwise returns false.
366 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
367 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
368 are inserted atomicly, or the transaction is rolled back. Passing an empty
369 hash reference is equivalent to not supplying this parameter. There should be
370 a better explanation of this, but until then, here's an example:
373 tie %hash, 'Tie::RefHash'; #this part is important
375 $cust_pkg => [ $svc_acct ],
378 $cust_main->insert( \%hash );
380 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
381 be set as the invoicing list (see L<"invoicing_list">). Errors return as
382 expected and rollback the entire transaction; it is not necessary to call
383 check_invoicing_list first. The invoicing_list is set after the records in the
384 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
385 invoicing_list destination to the newly-created svc_acct. Here's an example:
387 $cust_main->insert( {}, [ $email, 'POST' ] );
389 Currently available options are: I<depend_jobnum>, I<noexport>,
390 I<tax_exemption> and I<prospectnum>.
392 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
393 on the supplied jobnum (they will not run until the specific job completes).
394 This can be used to defer provisioning until some action completes (such
395 as running the customer's credit card successfully).
397 The I<noexport> option is deprecated. If I<noexport> is set true, no
398 provisioning jobs (exports) are scheduled. (You can schedule them later with
399 the B<reexport> method.)
401 The I<tax_exemption> option can be set to an arrayref of tax names.
402 FS::cust_main_exemption records will be created and inserted.
404 If I<prospectnum> is set, moves contacts and locations from that prospect.
410 my $cust_pkgs = @_ ? shift : {};
411 my $invoicing_list = @_ ? shift : '';
413 warn "$me insert called with options ".
414 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
417 local $SIG{HUP} = 'IGNORE';
418 local $SIG{INT} = 'IGNORE';
419 local $SIG{QUIT} = 'IGNORE';
420 local $SIG{TERM} = 'IGNORE';
421 local $SIG{TSTP} = 'IGNORE';
422 local $SIG{PIPE} = 'IGNORE';
424 my $oldAutoCommit = $FS::UID::AutoCommit;
425 local $FS::UID::AutoCommit = 0;
428 my $prepay_identifier = '';
429 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
431 if ( $self->payby eq 'PREPAY' ) {
433 $self->payby('BILL');
434 $prepay_identifier = $self->payinfo;
437 warn " looking up prepaid card $prepay_identifier\n"
440 my $error = $self->get_prepay( $prepay_identifier,
441 'amount_ref' => \$amount,
442 'seconds_ref' => \$seconds,
443 'upbytes_ref' => \$upbytes,
444 'downbytes_ref' => \$downbytes,
445 'totalbytes_ref' => \$totalbytes,
448 $dbh->rollback if $oldAutoCommit;
449 #return "error applying prepaid card (transaction rolled back): $error";
453 $payby = 'PREP' if $amount;
455 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
458 $self->payby('BILL');
459 $amount = $self->paid;
463 warn " inserting $self\n"
466 $self->signupdate(time) unless $self->signupdate;
468 $self->censusyear($conf->config('census_year')) if $self->censustract;
470 $self->auto_agent_custid()
471 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
473 my $error = $self->SUPER::insert;
475 $dbh->rollback if $oldAutoCommit;
476 #return "inserting cust_main record (transaction rolled back): $error";
480 warn " setting invoicing list\n"
483 if ( $invoicing_list ) {
484 $error = $self->check_invoicing_list( $invoicing_list );
486 $dbh->rollback if $oldAutoCommit;
487 #return "checking invoicing_list (transaction rolled back): $error";
490 $self->invoicing_list( $invoicing_list );
493 warn " setting customer tags\n"
496 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
497 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
498 'custnum' => $self->custnum };
499 my $error = $cust_tag->insert;
501 $dbh->rollback if $oldAutoCommit;
506 my $prospectnum = delete $options{'prospectnum'};
507 if ( $prospectnum ) {
509 warn " moving contacts and locations from prospect $prospectnum\n"
513 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
514 unless ( $prospect_main ) {
515 $dbh->rollback if $oldAutoCommit;
516 return "Unknown prospectnum $prospectnum";
518 $prospect_main->custnum($self->custnum);
519 $prospect_main->disabled('Y');
520 my $error = $prospect_main->replace;
522 $dbh->rollback if $oldAutoCommit;
526 my @contact = $prospect_main->contact;
527 my @cust_location = $prospect_main->cust_location;
528 my @qual = $prospect_main->qual;
530 foreach my $r ( @contact, @cust_location, @qual ) {
532 $r->custnum($self->custnum);
533 my $error = $r->replace;
535 $dbh->rollback if $oldAutoCommit;
542 warn " setting cust_main_exemption\n"
545 my $tax_exemption = delete $options{'tax_exemption'};
546 if ( $tax_exemption ) {
547 foreach my $taxname ( @$tax_exemption ) {
548 my $cust_main_exemption = new FS::cust_main_exemption {
549 'custnum' => $self->custnum,
550 'taxname' => $taxname,
552 my $error = $cust_main_exemption->insert;
554 $dbh->rollback if $oldAutoCommit;
555 return "inserting cust_main_exemption (transaction rolled back): $error";
560 if ( $self->can('start_copy_skel') ) {
561 my $error = $self->start_copy_skel;
563 $dbh->rollback if $oldAutoCommit;
568 warn " ordering packages\n"
571 $error = $self->order_pkgs( $cust_pkgs,
573 'seconds_ref' => \$seconds,
574 'upbytes_ref' => \$upbytes,
575 'downbytes_ref' => \$downbytes,
576 'totalbytes_ref' => \$totalbytes,
579 $dbh->rollback if $oldAutoCommit;
584 $dbh->rollback if $oldAutoCommit;
585 return "No svc_acct record to apply pre-paid time";
587 if ( $upbytes || $downbytes || $totalbytes ) {
588 $dbh->rollback if $oldAutoCommit;
589 return "No svc_acct record to apply pre-paid data";
593 warn " inserting initial $payby payment of $amount\n"
595 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
597 $dbh->rollback if $oldAutoCommit;
598 return "inserting payment (transaction rolled back): $error";
602 unless ( $import || $skip_fuzzyfiles ) {
603 warn " queueing fuzzyfiles update\n"
605 $error = $self->queue_fuzzyfiles_update;
607 $dbh->rollback if $oldAutoCommit;
608 return "updating fuzzy search cache: $error";
612 # FS::geocode_Mixin::after_insert or something?
613 if ( $conf->config('tax_district_method') and !$import ) {
614 # if anything non-empty, try to look it up
615 my $queue = new FS::queue {
616 'job' => 'FS::geocode_Mixin::process_district_update',
617 'custnum' => $self->custnum,
619 my $error = $queue->insert( ref($self), $self->custnum );
621 $dbh->rollback if $oldAutoCommit;
622 return "queueing tax district update: $error";
627 warn " exporting\n" if $DEBUG > 1;
629 my $export_args = $options{'export_args'} || [];
632 map qsearch( 'part_export', {exportnum=>$_} ),
633 $conf->config('cust_main-exports'); #, $agentnum
635 foreach my $part_export ( @part_export ) {
636 my $error = $part_export->export_insert($self, @$export_args);
638 $dbh->rollback if $oldAutoCommit;
639 return "exporting to ". $part_export->exporttype.
640 " (transaction rolled back): $error";
644 #foreach my $depend_jobnum ( @$depend_jobnums ) {
645 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
647 # foreach my $jobnum ( @jobnums ) {
648 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
649 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
651 # my $error = $queue->depend_insert($depend_jobnum);
653 # $dbh->rollback if $oldAutoCommit;
654 # return "error queuing job dependancy: $error";
661 #if ( exists $options{'jobnums'} ) {
662 # push @{ $options{'jobnums'} }, @jobnums;
665 warn " insert complete; committing transaction\n"
668 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
673 use File::CounterFile;
674 sub auto_agent_custid {
677 my $format = $conf->config('cust_main-auto_agent_custid');
679 if ( $format eq '1YMMXXXXXXXX' ) {
681 my $counter = new File::CounterFile 'cust_main.agent_custid';
684 my $ym = 100000000000 + time2str('%y%m00000000', time);
685 if ( $ym > $counter->value ) {
686 $counter->{'value'} = $agent_custid = $ym;
687 $counter->{'updated'} = 1;
689 $agent_custid = $counter->inc;
695 die "Unknown cust_main-auto_agent_custid format: $format";
698 $self->agent_custid($agent_custid);
702 =item PACKAGE METHODS
704 Documentation on customer package methods has been moved to
705 L<FS::cust_main::Packages>.
707 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
709 Recharges this (existing) customer with the specified prepaid card (see
710 L<FS::prepay_credit>), specified either by I<identifier> or as an
711 FS::prepay_credit object. If there is an error, returns the error, otherwise
714 Optionally, five scalar references can be passed as well. They will have their
715 values filled in with the amount, number of seconds, and number of upload,
716 download, and total bytes applied by this prepaid card.
720 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
721 #the only place that uses these args
722 sub recharge_prepay {
723 my( $self, $prepay_credit, $amountref, $secondsref,
724 $upbytesref, $downbytesref, $totalbytesref ) = @_;
726 local $SIG{HUP} = 'IGNORE';
727 local $SIG{INT} = 'IGNORE';
728 local $SIG{QUIT} = 'IGNORE';
729 local $SIG{TERM} = 'IGNORE';
730 local $SIG{TSTP} = 'IGNORE';
731 local $SIG{PIPE} = 'IGNORE';
733 my $oldAutoCommit = $FS::UID::AutoCommit;
734 local $FS::UID::AutoCommit = 0;
737 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
739 my $error = $self->get_prepay( $prepay_credit,
740 'amount_ref' => \$amount,
741 'seconds_ref' => \$seconds,
742 'upbytes_ref' => \$upbytes,
743 'downbytes_ref' => \$downbytes,
744 'totalbytes_ref' => \$totalbytes,
746 || $self->increment_seconds($seconds)
747 || $self->increment_upbytes($upbytes)
748 || $self->increment_downbytes($downbytes)
749 || $self->increment_totalbytes($totalbytes)
750 || $self->insert_cust_pay_prepay( $amount,
752 ? $prepay_credit->identifier
757 $dbh->rollback if $oldAutoCommit;
761 if ( defined($amountref) ) { $$amountref = $amount; }
762 if ( defined($secondsref) ) { $$secondsref = $seconds; }
763 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
764 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
765 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
767 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
772 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
774 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
775 specified either by I<identifier> or as an FS::prepay_credit object.
777 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
778 incremented by the values of the prepaid card.
780 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
781 check or set this customer's I<agentnum>.
783 If there is an error, returns the error, otherwise returns false.
789 my( $self, $prepay_credit, %opt ) = @_;
791 local $SIG{HUP} = 'IGNORE';
792 local $SIG{INT} = 'IGNORE';
793 local $SIG{QUIT} = 'IGNORE';
794 local $SIG{TERM} = 'IGNORE';
795 local $SIG{TSTP} = 'IGNORE';
796 local $SIG{PIPE} = 'IGNORE';
798 my $oldAutoCommit = $FS::UID::AutoCommit;
799 local $FS::UID::AutoCommit = 0;
802 unless ( ref($prepay_credit) ) {
804 my $identifier = $prepay_credit;
806 $prepay_credit = qsearchs(
808 { 'identifier' => $identifier },
813 unless ( $prepay_credit ) {
814 $dbh->rollback if $oldAutoCommit;
815 return "Invalid prepaid card: ". $identifier;
820 if ( $prepay_credit->agentnum ) {
821 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
822 $dbh->rollback if $oldAutoCommit;
823 return "prepaid card not valid for agent ". $self->agentnum;
825 $self->agentnum($prepay_credit->agentnum);
828 my $error = $prepay_credit->delete;
830 $dbh->rollback if $oldAutoCommit;
831 return "removing prepay_credit (transaction rolled back): $error";
834 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
835 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
837 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
842 =item increment_upbytes SECONDS
844 Updates this customer's single or primary account (see L<FS::svc_acct>) by
845 the specified number of upbytes. If there is an error, returns the error,
846 otherwise returns false.
850 sub increment_upbytes {
851 _increment_column( shift, 'upbytes', @_);
854 =item increment_downbytes SECONDS
856 Updates this customer's single or primary account (see L<FS::svc_acct>) by
857 the specified number of downbytes. If there is an error, returns the error,
858 otherwise returns false.
862 sub increment_downbytes {
863 _increment_column( shift, 'downbytes', @_);
866 =item increment_totalbytes SECONDS
868 Updates this customer's single or primary account (see L<FS::svc_acct>) by
869 the specified number of totalbytes. If there is an error, returns the error,
870 otherwise returns false.
874 sub increment_totalbytes {
875 _increment_column( shift, 'totalbytes', @_);
878 =item increment_seconds SECONDS
880 Updates this customer's single or primary account (see L<FS::svc_acct>) by
881 the specified number of seconds. If there is an error, returns the error,
882 otherwise returns false.
886 sub increment_seconds {
887 _increment_column( shift, 'seconds', @_);
890 =item _increment_column AMOUNT
892 Updates this customer's single or primary account (see L<FS::svc_acct>) by
893 the specified number of seconds or bytes. If there is an error, returns
894 the error, otherwise returns false.
898 sub _increment_column {
899 my( $self, $column, $amount ) = @_;
900 warn "$me increment_column called: $column, $amount\n"
903 return '' unless $amount;
905 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
906 $self->ncancelled_pkgs;
909 return 'No packages with primary or single services found'.
910 ' to apply pre-paid time';
911 } elsif ( scalar(@cust_pkg) > 1 ) {
912 #maybe have a way to specify the package/account?
913 return 'Multiple packages found to apply pre-paid time';
916 my $cust_pkg = $cust_pkg[0];
917 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
921 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
924 return 'No account found to apply pre-paid time';
925 } elsif ( scalar(@cust_svc) > 1 ) {
926 return 'Multiple accounts found to apply pre-paid time';
929 my $svc_acct = $cust_svc[0]->svc_x;
930 warn " found service svcnum ". $svc_acct->pkgnum.
931 ' ('. $svc_acct->email. ")\n"
934 $column = "increment_$column";
935 $svc_acct->$column($amount);
939 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
941 Inserts a prepayment in the specified amount for this customer. An optional
942 second argument can specify the prepayment identifier for tracking purposes.
943 If there is an error, returns the error, otherwise returns false.
947 sub insert_cust_pay_prepay {
948 shift->insert_cust_pay('PREP', @_);
951 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
953 Inserts a cash payment in the specified amount for this customer. An optional
954 second argument can specify the payment identifier for tracking purposes.
955 If there is an error, returns the error, otherwise returns false.
959 sub insert_cust_pay_cash {
960 shift->insert_cust_pay('CASH', @_);
963 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
965 Inserts a Western Union payment in the specified amount for this customer. An
966 optional second argument can specify the prepayment identifier for tracking
967 purposes. If there is an error, returns the error, otherwise returns false.
971 sub insert_cust_pay_west {
972 shift->insert_cust_pay('WEST', @_);
975 sub insert_cust_pay {
976 my( $self, $payby, $amount ) = splice(@_, 0, 3);
977 my $payinfo = scalar(@_) ? shift : '';
979 my $cust_pay = new FS::cust_pay {
980 'custnum' => $self->custnum,
981 'paid' => sprintf('%.2f', $amount),
982 #'_date' => #date the prepaid card was purchased???
984 'payinfo' => $payinfo,
992 This method is deprecated. See the I<depend_jobnum> option to the insert and
993 order_pkgs methods for a better way to defer provisioning.
995 Re-schedules all exports by calling the B<reexport> method of all associated
996 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
997 otherwise returns false.
1004 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1005 "use the depend_jobnum option to insert or order_pkgs to delay export";
1007 local $SIG{HUP} = 'IGNORE';
1008 local $SIG{INT} = 'IGNORE';
1009 local $SIG{QUIT} = 'IGNORE';
1010 local $SIG{TERM} = 'IGNORE';
1011 local $SIG{TSTP} = 'IGNORE';
1012 local $SIG{PIPE} = 'IGNORE';
1014 my $oldAutoCommit = $FS::UID::AutoCommit;
1015 local $FS::UID::AutoCommit = 0;
1018 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1019 my $error = $cust_pkg->reexport;
1021 $dbh->rollback if $oldAutoCommit;
1026 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1031 =item delete [ OPTION => VALUE ... ]
1033 This deletes the customer. If there is an error, returns the error, otherwise
1036 This will completely remove all traces of the customer record. This is not
1037 what you want when a customer cancels service; for that, cancel all of the
1038 customer's packages (see L</cancel>).
1040 If the customer has any uncancelled packages, you need to pass a new (valid)
1041 customer number for those packages to be transferred to, as the "new_customer"
1042 option. Cancelled packages will be deleted. Did I mention that this is NOT
1043 what you want when a customer cancels service and that you really should be
1044 looking at L<FS::cust_pkg/cancel>?
1046 You can't delete a customer with invoices (see L<FS::cust_bill>),
1047 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1048 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1049 set the "delete_financials" option to a true value.
1054 my( $self, %opt ) = @_;
1056 local $SIG{HUP} = 'IGNORE';
1057 local $SIG{INT} = 'IGNORE';
1058 local $SIG{QUIT} = 'IGNORE';
1059 local $SIG{TERM} = 'IGNORE';
1060 local $SIG{TSTP} = 'IGNORE';
1061 local $SIG{PIPE} = 'IGNORE';
1063 my $oldAutoCommit = $FS::UID::AutoCommit;
1064 local $FS::UID::AutoCommit = 0;
1067 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1068 $dbh->rollback if $oldAutoCommit;
1069 return "Can't delete a master agent customer";
1072 #use FS::access_user
1073 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1074 $dbh->rollback if $oldAutoCommit;
1075 return "Can't delete a master employee customer";
1078 tie my %financial_tables, 'Tie::IxHash',
1079 'cust_bill' => 'invoices',
1080 'cust_statement' => 'statements',
1081 'cust_credit' => 'credits',
1082 'cust_pay' => 'payments',
1083 'cust_refund' => 'refunds',
1086 foreach my $table ( keys %financial_tables ) {
1088 my @records = $self->$table();
1090 if ( @records && ! $opt{'delete_financials'} ) {
1091 $dbh->rollback if $oldAutoCommit;
1092 return "Can't delete a customer with ". $financial_tables{$table};
1095 foreach my $record ( @records ) {
1096 my $error = $record->delete;
1098 $dbh->rollback if $oldAutoCommit;
1099 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1105 my @cust_pkg = $self->ncancelled_pkgs;
1107 my $new_custnum = $opt{'new_custnum'};
1108 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1109 $dbh->rollback if $oldAutoCommit;
1110 return "Invalid new customer number: $new_custnum";
1112 foreach my $cust_pkg ( @cust_pkg ) {
1113 my %hash = $cust_pkg->hash;
1114 $hash{'custnum'} = $new_custnum;
1115 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1116 my $error = $new_cust_pkg->replace($cust_pkg,
1117 options => { $cust_pkg->options },
1120 $dbh->rollback if $oldAutoCommit;
1125 my @cancelled_cust_pkg = $self->all_pkgs;
1126 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1127 my $error = $cust_pkg->delete;
1129 $dbh->rollback if $oldAutoCommit;
1134 #cust_tax_adjustment in financials?
1135 #cust_pay_pending? ouch
1137 foreach my $table (qw(
1138 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1139 cust_location cust_main_note cust_tax_adjustment
1140 cust_pay_void cust_pay_batch queue cust_tax_exempt
1142 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1143 my $error = $record->delete;
1145 $dbh->rollback if $oldAutoCommit;
1151 my $sth = $dbh->prepare(
1152 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1154 my $errstr = $dbh->errstr;
1155 $dbh->rollback if $oldAutoCommit;
1158 $sth->execute($self->custnum) or do {
1159 my $errstr = $sth->errstr;
1160 $dbh->rollback if $oldAutoCommit;
1166 my $ticket_dbh = '';
1167 if ($conf->config('ticket_system') eq 'RT_Internal') {
1169 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1170 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1171 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1172 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1175 if ( $ticket_dbh ) {
1177 my $ticket_sth = $ticket_dbh->prepare(
1178 'DELETE FROM Links WHERE Target = ?'
1180 my $errstr = $ticket_dbh->errstr;
1181 $dbh->rollback if $oldAutoCommit;
1184 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1186 my $errstr = $ticket_sth->errstr;
1187 $dbh->rollback if $oldAutoCommit;
1191 #check and see if the customer is the only link on the ticket, and
1192 #if so, set the ticket to deleted status in RT?
1193 #maybe someday, for now this will at least fix tickets not displaying
1197 #delete the customer record
1199 my $error = $self->SUPER::delete;
1201 $dbh->rollback if $oldAutoCommit;
1205 # cust_main exports!
1207 #my $export_args = $options{'export_args'} || [];
1210 map qsearch( 'part_export', {exportnum=>$_} ),
1211 $conf->config('cust_main-exports'); #, $agentnum
1213 foreach my $part_export ( @part_export ) {
1214 my $error = $part_export->export_delete( $self ); #, @$export_args);
1216 $dbh->rollback if $oldAutoCommit;
1217 return "exporting to ". $part_export->exporttype.
1218 " (transaction rolled back): $error";
1222 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1227 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1229 This merges this customer into the provided new custnum, and then deletes the
1230 customer. If there is an error, returns the error, otherwise returns false.
1232 The source customer's name, company name, phone numbers, agent,
1233 referring customer, customer class, advertising source, order taker, and
1234 billing information (except balance) are discarded.
1236 All packages are moved to the target customer. Packages with package locations
1237 are preserved. Packages without package locations are moved to a new package
1238 location with the source customer's service/shipping address.
1240 All invoices, statements, payments, credits and refunds are moved to the target
1241 customer. The source customer's balance is added to the target customer.
1243 All notes, attachments, tickets and customer tags are moved to the target
1246 Change history is not currently moved.
1251 my( $self, $new_custnum, %opt ) = @_;
1253 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1255 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1256 return "Invalid new customer number: $new_custnum";
1259 local $SIG{HUP} = 'IGNORE';
1260 local $SIG{INT} = 'IGNORE';
1261 local $SIG{QUIT} = 'IGNORE';
1262 local $SIG{TERM} = 'IGNORE';
1263 local $SIG{TSTP} = 'IGNORE';
1264 local $SIG{PIPE} = 'IGNORE';
1266 my $oldAutoCommit = $FS::UID::AutoCommit;
1267 local $FS::UID::AutoCommit = 0;
1270 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1271 $dbh->rollback if $oldAutoCommit;
1272 return "Can't merge a master agent customer";
1275 #use FS::access_user
1276 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1277 $dbh->rollback if $oldAutoCommit;
1278 return "Can't merge a master employee customer";
1281 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1282 'status' => { op=>'!=', value=>'done' },
1286 $dbh->rollback if $oldAutoCommit;
1287 return "Can't merge a customer with pending payments";
1290 tie my %financial_tables, 'Tie::IxHash',
1291 'cust_bill' => 'invoices',
1292 'cust_statement' => 'statements',
1293 'cust_credit' => 'credits',
1294 'cust_pay' => 'payments',
1295 'cust_pay_void' => 'voided payments',
1296 'cust_refund' => 'refunds',
1299 foreach my $table ( keys %financial_tables ) {
1301 my @records = $self->$table();
1303 foreach my $record ( @records ) {
1304 $record->custnum($new_custnum);
1305 my $error = $record->replace;
1307 $dbh->rollback if $oldAutoCommit;
1308 return "Error merging ". $financial_tables{$table}. ": $error\n";
1314 my $name = $self->ship_name;
1316 my $locationnum = '';
1317 foreach my $cust_pkg ( $self->all_pkgs ) {
1318 $cust_pkg->custnum($new_custnum);
1320 unless ( $cust_pkg->locationnum ) {
1321 unless ( $locationnum ) {
1322 my $cust_location = new FS::cust_location {
1323 $self->location_hash,
1324 'custnum' => $new_custnum,
1326 my $error = $cust_location->insert;
1328 $dbh->rollback if $oldAutoCommit;
1331 $locationnum = $cust_location->locationnum;
1333 $cust_pkg->locationnum($locationnum);
1336 my $error = $cust_pkg->replace;
1338 $dbh->rollback if $oldAutoCommit;
1342 # add customer (ship) name to svc_phone.phone_name if blank
1343 my @cust_svc = $cust_pkg->cust_svc;
1344 foreach my $cust_svc (@cust_svc) {
1345 my($label, $value, $svcdb) = $cust_svc->label;
1346 next unless $svcdb eq 'svc_phone';
1347 my $svc_phone = $cust_svc->svc_x;
1348 next if $svc_phone->phone_name;
1349 $svc_phone->phone_name($name);
1350 my $error = $svc_phone->replace;
1352 $dbh->rollback if $oldAutoCommit;
1360 # cust_tax_exempt (texas tax exemptions)
1361 # cust_recon (some sort of not-well understood thing for OnPac)
1363 #these are moved over
1364 foreach my $table (qw(
1365 cust_tag cust_location contact cust_attachment cust_main_note
1366 cust_tax_adjustment cust_pay_batch queue
1368 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1369 $record->custnum($new_custnum);
1370 my $error = $record->replace;
1372 $dbh->rollback if $oldAutoCommit;
1378 #these aren't preserved
1379 foreach my $table (qw(
1380 cust_main_exemption cust_main_invoice
1382 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1383 my $error = $record->delete;
1385 $dbh->rollback if $oldAutoCommit;
1392 my $sth = $dbh->prepare(
1393 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1395 my $errstr = $dbh->errstr;
1396 $dbh->rollback if $oldAutoCommit;
1399 $sth->execute($new_custnum, $self->custnum) or do {
1400 my $errstr = $sth->errstr;
1401 $dbh->rollback if $oldAutoCommit;
1407 my $ticket_dbh = '';
1408 if ($conf->config('ticket_system') eq 'RT_Internal') {
1410 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1411 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1412 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1413 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1416 if ( $ticket_dbh ) {
1418 my $ticket_sth = $ticket_dbh->prepare(
1419 'UPDATE Links SET Target = ? WHERE Target = ?'
1421 my $errstr = $ticket_dbh->errstr;
1422 $dbh->rollback if $oldAutoCommit;
1425 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1426 'freeside://freeside/cust_main/'.$self->custnum)
1428 my $errstr = $ticket_sth->errstr;
1429 $dbh->rollback if $oldAutoCommit;
1435 #delete the customer record
1437 my $error = $self->delete;
1439 $dbh->rollback if $oldAutoCommit;
1443 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1448 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1451 Replaces the OLD_RECORD with this one in the database. If there is an error,
1452 returns the error, otherwise returns false.
1454 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1455 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1456 expected and rollback the entire transaction; it is not necessary to call
1457 check_invoicing_list first. Here's an example:
1459 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1461 Currently available options are: I<tax_exemption>.
1463 The I<tax_exemption> option can be set to an arrayref of tax names.
1464 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1471 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1473 : $self->replace_old;
1477 warn "$me replace called\n"
1480 my $curuser = $FS::CurrentUser::CurrentUser;
1481 if ( $self->payby eq 'COMP'
1482 && $self->payby ne $old->payby
1483 && ! $curuser->access_right('Complimentary customer')
1486 return "You are not permitted to create complimentary accounts.";
1489 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1490 && $conf->exists('enable_taxproducts')
1493 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1495 $self->set('geocode', '')
1496 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1497 && length($self->get($pre.'zip')) >= 10;
1500 for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1502 $self->set($pre.'coord_auto', '') && next
1503 if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1504 && ( $self->get($pre.'latitude') != $old->get($pre.'latitude')
1505 || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1508 $self->set_coord($pre)
1509 if $old->get($pre.'address1') ne $self->get($pre.'address1')
1510 || $old->get($pre.'city') ne $self->get($pre.'city')
1511 || $old->get($pre.'state') ne $self->get($pre.'state')
1512 || $old->get($pre.'country') ne $self->get($pre.'country');
1516 unless ( $import ) {
1518 if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1520 $self->set_coord('ship_')
1521 if $self->has_ship_address && ! $self->ship_coord_auto
1522 && ! $self->ship_latitude && ! $self->ship_longitude;
1525 local($ignore_expired_card) = 1
1526 if $old->payby =~ /^(CARD|DCRD)$/
1527 && $self->payby =~ /^(CARD|DCRD)$/
1528 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1530 local($ignore_banned_card) = 1
1531 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1532 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1533 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1535 if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1536 # update censusyear whenever tract code changes
1537 $self->censusyear($conf->config('census_year'));
1541 local $SIG{HUP} = 'IGNORE';
1542 local $SIG{INT} = 'IGNORE';
1543 local $SIG{QUIT} = 'IGNORE';
1544 local $SIG{TERM} = 'IGNORE';
1545 local $SIG{TSTP} = 'IGNORE';
1546 local $SIG{PIPE} = 'IGNORE';
1548 my $oldAutoCommit = $FS::UID::AutoCommit;
1549 local $FS::UID::AutoCommit = 0;
1552 my $error = $self->SUPER::replace($old);
1555 $dbh->rollback if $oldAutoCommit;
1559 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1560 my $invoicing_list = shift @param;
1561 $error = $self->check_invoicing_list( $invoicing_list );
1563 $dbh->rollback if $oldAutoCommit;
1566 $self->invoicing_list( $invoicing_list );
1569 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1571 #this could be more efficient than deleting and re-inserting, if it matters
1572 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1573 my $error = $cust_tag->delete;
1575 $dbh->rollback if $oldAutoCommit;
1579 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1580 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1581 'custnum' => $self->custnum };
1582 my $error = $cust_tag->insert;
1584 $dbh->rollback if $oldAutoCommit;
1591 my %options = @param;
1593 my $tax_exemption = delete $options{'tax_exemption'};
1594 if ( $tax_exemption ) {
1596 my %cust_main_exemption =
1597 map { $_->taxname => $_ }
1598 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1600 foreach my $taxname ( @$tax_exemption ) {
1602 next if delete $cust_main_exemption{$taxname};
1604 my $cust_main_exemption = new FS::cust_main_exemption {
1605 'custnum' => $self->custnum,
1606 'taxname' => $taxname,
1608 my $error = $cust_main_exemption->insert;
1610 $dbh->rollback if $oldAutoCommit;
1611 return "inserting cust_main_exemption (transaction rolled back): $error";
1615 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1616 my $error = $cust_main_exemption->delete;
1618 $dbh->rollback if $oldAutoCommit;
1619 return "deleting cust_main_exemption (transaction rolled back): $error";
1625 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1626 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1627 && $self->get('payinfo') !~ /^99\d{14}$/
1629 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1634 # card/check/lec info has changed, want to retry realtime_ invoice events
1635 my $error = $self->retry_realtime;
1637 $dbh->rollback if $oldAutoCommit;
1642 unless ( $import || $skip_fuzzyfiles ) {
1643 $error = $self->queue_fuzzyfiles_update;
1645 $dbh->rollback if $oldAutoCommit;
1646 return "updating fuzzy search cache: $error";
1650 # FS::geocode_Mixin::after_replace ?
1651 # though this will go away anyway once we move customer bill/service
1652 # locations into cust_location
1653 # We can trigger this on any address change--just have to make sure
1654 # not to trigger it on itself.
1655 if ( $conf->config('tax_district_method') and !$import
1656 and ( $self->get('ship_address1') ne $old->get('ship_address1')
1657 or $self->get('address1') ne $old->get('address1') ) ) {
1658 my $queue = new FS::queue {
1659 'job' => 'FS::geocode_Mixin::process_district_update',
1660 'custnum' => $self->custnum,
1662 my $error = $queue->insert( ref($self), $self->custnum );
1664 $dbh->rollback if $oldAutoCommit;
1665 return "queueing tax district update: $error";
1669 # cust_main exports!
1671 my $export_args = $options{'export_args'} || [];
1674 map qsearch( 'part_export', {exportnum=>$_} ),
1675 $conf->config('cust_main-exports'); #, $agentnum
1677 foreach my $part_export ( @part_export ) {
1678 my $error = $part_export->export_replace( $self, $old, @$export_args);
1680 $dbh->rollback if $oldAutoCommit;
1681 return "exporting to ". $part_export->exporttype.
1682 " (transaction rolled back): $error";
1686 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1691 =item queue_fuzzyfiles_update
1693 Used by insert & replace to update the fuzzy search cache
1697 use FS::cust_main::Search;
1698 sub queue_fuzzyfiles_update {
1701 local $SIG{HUP} = 'IGNORE';
1702 local $SIG{INT} = 'IGNORE';
1703 local $SIG{QUIT} = 'IGNORE';
1704 local $SIG{TERM} = 'IGNORE';
1705 local $SIG{TSTP} = 'IGNORE';
1706 local $SIG{PIPE} = 'IGNORE';
1708 my $oldAutoCommit = $FS::UID::AutoCommit;
1709 local $FS::UID::AutoCommit = 0;
1712 my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1713 my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1715 $dbh->rollback if $oldAutoCommit;
1716 return "queueing job (transaction rolled back): $error";
1719 if ( $self->ship_last ) {
1720 $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1721 $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1723 $dbh->rollback if $oldAutoCommit;
1724 return "queueing job (transaction rolled back): $error";
1728 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1735 Checks all fields to make sure this is a valid customer record. If there is
1736 an error, returns the error, otherwise returns false. Called by the insert
1737 and replace methods.
1744 warn "$me check BEFORE: \n". $self->_dump
1748 $self->ut_numbern('custnum')
1749 || $self->ut_number('agentnum')
1750 || $self->ut_textn('agent_custid')
1751 || $self->ut_number('refnum')
1752 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1753 || $self->ut_textn('custbatch')
1754 || $self->ut_name('last')
1755 || $self->ut_name('first')
1756 || $self->ut_snumbern('birthdate')
1757 || $self->ut_snumbern('signupdate')
1758 || $self->ut_textn('company')
1759 || $self->ut_text('address1')
1760 || $self->ut_textn('address2')
1761 || $self->ut_text('city')
1762 || $self->ut_textn('county')
1763 || $self->ut_textn('state')
1764 || $self->ut_country('country')
1765 || $self->ut_coordn('latitude')
1766 || $self->ut_coordn('longitude')
1767 || $self->ut_enum('coord_auto', [ '', 'Y' ])
1768 || $self->ut_numbern('censusyear')
1769 || $self->ut_anything('comments')
1770 || $self->ut_numbern('referral_custnum')
1771 || $self->ut_textn('stateid')
1772 || $self->ut_textn('stateid_state')
1773 || $self->ut_textn('invoice_terms')
1774 || $self->ut_alphan('geocode')
1775 || $self->ut_alphan('district')
1776 || $self->ut_floatn('cdr_termination_percentage')
1777 || $self->ut_floatn('credit_limit')
1778 || $self->ut_numbern('billday')
1779 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1780 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1781 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1785 unless $import || ($self->latitude && $self->longitude);
1787 #barf. need message catalogs. i18n. etc.
1788 $error .= "Please select an advertising source."
1789 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1790 return $error if $error;
1792 return "Unknown agent"
1793 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1795 return "Unknown refnum"
1796 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1798 return "Unknown referring custnum: ". $self->referral_custnum
1799 unless ! $self->referral_custnum
1800 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1802 if ( $self->censustract ne '' ) {
1803 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1804 or return "Illegal census tract: ". $self->censustract;
1806 $self->censustract("$1.$2");
1809 if ( $self->ss eq '' ) {
1814 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1815 or return "Illegal social security number: ". $self->ss;
1816 $self->ss("$1-$2-$3");
1820 # bad idea to disable, causes billing to fail because of no tax rates later
1821 # except we don't fail any more
1822 unless ( $import ) {
1823 unless ( qsearch('cust_main_county', {
1824 'country' => $self->country,
1827 return "Unknown state/county/country: ".
1828 $self->state. "/". $self->county. "/". $self->country
1829 unless qsearch('cust_main_county',{
1830 'state' => $self->state,
1831 'county' => $self->county,
1832 'country' => $self->country,
1838 $self->ut_phonen('daytime', $self->country)
1839 || $self->ut_phonen('night', $self->country)
1840 || $self->ut_phonen('fax', $self->country)
1841 || $self->ut_phonen('mobile', $self->country)
1843 return $error if $error;
1845 unless ( $ignore_illegal_zip ) {
1846 $error = $self->ut_zip('zip', $self->country);
1847 return $error if $error;
1850 if ( $conf->exists('cust_main-require_phone')
1851 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1854 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1856 : FS::Msgcat::_gettext('daytime');
1857 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1859 : FS::Msgcat::_gettext('night');
1861 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1863 : FS::Msgcat::_gettext('mobile');
1865 return "$daytime_label, $night_label or $mobile_label is required"
1869 if ( $self->has_ship_address
1870 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1871 $self->addr_fields )
1875 $self->ut_name('ship_last')
1876 || $self->ut_name('ship_first')
1877 || $self->ut_textn('ship_company')
1878 || $self->ut_text('ship_address1')
1879 || $self->ut_textn('ship_address2')
1880 || $self->ut_text('ship_city')
1881 || $self->ut_textn('ship_county')
1882 || $self->ut_textn('ship_state')
1883 || $self->ut_country('ship_country')
1884 || $self->ut_coordn('ship_latitude')
1885 || $self->ut_coordn('ship_longitude')
1886 || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1888 return $error if $error;
1890 $self->set_coord('ship_')
1891 unless $import || ($self->ship_latitude && $self->ship_longitude);
1893 #false laziness with above
1894 unless ( qsearchs('cust_main_county', {
1895 'country' => $self->ship_country,
1898 return "Unknown ship_state/ship_county/ship_country: ".
1899 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1900 unless qsearch('cust_main_county',{
1901 'state' => $self->ship_state,
1902 'county' => $self->ship_county,
1903 'country' => $self->ship_country,
1909 $self->ut_phonen('ship_daytime', $self->ship_country)
1910 || $self->ut_phonen('ship_night', $self->ship_country)
1911 || $self->ut_phonen('ship_fax', $self->ship_country)
1912 || $self->ut_phonen('ship_mobile', $self->ship_country)
1914 return $error if $error;
1916 unless ( $ignore_illegal_zip ) {
1917 $error = $self->ut_zip('ship_zip', $self->ship_country);
1918 return $error if $error;
1920 return "Unit # is required."
1921 if $self->ship_address2 =~ /^\s*$/
1922 && $conf->exists('cust_main-require_address2');
1924 } else { # ship_ info eq billing info, so don't store dup info in database
1926 $self->setfield("ship_$_", '')
1927 foreach $self->addr_fields;
1929 return "Unit # is required."
1930 if $self->address2 =~ /^\s*$/
1931 && $conf->exists('cust_main-require_address2');
1935 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1936 # or return "Illegal payby: ". $self->payby;
1938 FS::payby->can_payby($self->table, $self->payby)
1939 or return "Illegal payby: ". $self->payby;
1941 $error = $self->ut_numbern('paystart_month')
1942 || $self->ut_numbern('paystart_year')
1943 || $self->ut_numbern('payissue')
1944 || $self->ut_textn('paytype')
1946 return $error if $error;
1948 if ( $self->payip eq '' ) {
1951 $error = $self->ut_ip('payip');
1952 return $error if $error;
1955 # If it is encrypted and the private key is not availaible then we can't
1956 # check the credit card.
1957 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1959 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1961 my $payinfo = $self->payinfo;
1962 $payinfo =~ s/\D//g;
1963 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1964 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1966 $self->payinfo($payinfo);
1968 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1970 return gettext('unknown_card_type')
1971 if $self->payinfo !~ /^99\d{14}$/ #token
1972 && cardtype($self->payinfo) eq "Unknown";
1974 unless ( $ignore_banned_card ) {
1975 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1977 if ( $ban->bantype eq 'warn' ) {
1978 #or others depending on value of $ban->reason ?
1979 return '_duplicate_card'.
1980 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1981 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1982 ' (ban# '. $ban->bannum. ')'
1983 unless $self->override_ban_warn;
1985 return 'Banned credit card: banned on '.
1986 time2str('%a %h %o at %r', $ban->_date).
1987 ' by '. $ban->otaker.
1988 ' (ban# '. $ban->bannum. ')';
1993 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1994 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1995 $self->paycvv =~ /^(\d{4})$/
1996 or return "CVV2 (CID) for American Express cards is four digits.";
1999 $self->paycvv =~ /^(\d{3})$/
2000 or return "CVV2 (CVC2/CID) is three digits.";
2007 my $cardtype = cardtype($payinfo);
2008 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
2010 return "Start date or issue number is required for $cardtype cards"
2011 unless $self->paystart_month && $self->paystart_year or $self->payissue;
2013 return "Start month must be between 1 and 12"
2014 if $self->paystart_month
2015 and $self->paystart_month < 1 || $self->paystart_month > 12;
2017 return "Start year must be 1990 or later"
2018 if $self->paystart_year
2019 and $self->paystart_year < 1990;
2021 return "Issue number must be beween 1 and 99"
2023 and $self->payissue < 1 || $self->payissue > 99;
2026 $self->paystart_month('');
2027 $self->paystart_year('');
2028 $self->payissue('');
2031 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
2033 my $payinfo = $self->payinfo;
2034 $payinfo =~ s/[^\d\@\.]//g;
2035 if ( $conf->exists('cust_main-require-bank-branch') ) {
2036 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
2037 $payinfo = "$1\@$2.$3";
2038 } elsif ( $conf->exists('echeck-nonus') ) {
2039 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
2040 $payinfo = "$1\@$2";
2042 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2043 $payinfo = "$1\@$2";
2045 $self->payinfo($payinfo);
2048 unless ( $ignore_banned_card ) {
2049 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2051 if ( $ban->bantype eq 'warn' ) {
2052 #or others depending on value of $ban->reason ?
2053 return '_duplicate_ach' unless $self->override_ban_warn;
2055 return 'Banned ACH account: banned on '.
2056 time2str('%a %h %o at %r', $ban->_date).
2057 ' by '. $ban->otaker.
2058 ' (ban# '. $ban->bannum. ')';
2063 } elsif ( $self->payby eq 'LECB' ) {
2065 my $payinfo = $self->payinfo;
2066 $payinfo =~ s/\D//g;
2067 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2069 $self->payinfo($payinfo);
2072 } elsif ( $self->payby eq 'BILL' ) {
2074 $error = $self->ut_textn('payinfo');
2075 return "Illegal P.O. number: ". $self->payinfo if $error;
2078 } elsif ( $self->payby eq 'COMP' ) {
2080 my $curuser = $FS::CurrentUser::CurrentUser;
2081 if ( ! $self->custnum
2082 && ! $curuser->access_right('Complimentary customer')
2085 return "You are not permitted to create complimentary accounts."
2088 $error = $self->ut_textn('payinfo');
2089 return "Illegal comp account issuer: ". $self->payinfo if $error;
2092 } elsif ( $self->payby eq 'PREPAY' ) {
2094 my $payinfo = $self->payinfo;
2095 $payinfo =~ s/\W//g; #anything else would just confuse things
2096 $self->payinfo($payinfo);
2097 $error = $self->ut_alpha('payinfo');
2098 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2099 return "Unknown prepayment identifier"
2100 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2105 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2106 return "Expiration date required"
2107 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2111 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2112 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2113 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2114 ( $m, $y ) = ( $2, "19$1" );
2115 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2116 ( $m, $y ) = ( $3, "20$2" );
2118 return "Illegal expiration date: ". $self->paydate;
2120 $m = sprintf('%02d',$m);
2121 $self->paydate("$y-$m-01");
2122 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2123 return gettext('expired_card')
2125 && !$ignore_expired_card
2126 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2129 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2130 ( ! $conf->exists('require_cardname')
2131 || $self->payby !~ /^(CARD|DCRD)$/ )
2133 $self->payname( $self->first. " ". $self->getfield('last') );
2135 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2136 or return gettext('illegal_name'). " payname: ". $self->payname;
2140 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2141 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2145 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2147 warn "$me check AFTER: \n". $self->_dump
2150 $self->SUPER::check;
2155 Returns a list of fields which have ship_ duplicates.
2160 qw( last first company
2161 address1 address2 city county state zip country
2163 daytime night fax mobile
2167 =item has_ship_address
2169 Returns true if this customer record has a separate shipping address.
2173 sub has_ship_address {
2175 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2180 Returns a list of key/value pairs, with the following keys: address1,
2181 adddress2, city, county, state, zip, country, district, and geocode. The
2182 shipping address is used if present.
2188 Returns all locations (see L<FS::cust_location>) for this customer.
2194 qsearch('cust_location', { 'custnum' => $self->custnum } );
2199 Returns all contacts (see L<FS::contact>) for this customer.
2203 #already used :/ sub contact {
2206 qsearch('contact', { 'custnum' => $self->custnum } );
2211 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2212 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2213 on success or a list of errors.
2219 grep { $_->unsuspend } $self->suspended_pkgs;
2224 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2226 Returns a list: an empty list on success or a list of errors.
2232 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2235 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2237 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2238 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2239 of a list of pkgparts; the hashref has the following keys:
2243 =item pkgparts - listref of pkgparts
2245 =item (other options are passed to the suspend method)
2250 Returns a list: an empty list on success or a list of errors.
2254 sub suspend_if_pkgpart {
2256 my (@pkgparts, %opt);
2257 if (ref($_[0]) eq 'HASH'){
2258 @pkgparts = @{$_[0]{pkgparts}};
2263 grep { $_->suspend(%opt) }
2264 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2265 $self->unsuspended_pkgs;
2268 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2270 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2271 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2272 instead of a list of pkgparts; the hashref has the following keys:
2276 =item pkgparts - listref of pkgparts
2278 =item (other options are passed to the suspend method)
2282 Returns a list: an empty list on success or a list of errors.
2286 sub suspend_unless_pkgpart {
2288 my (@pkgparts, %opt);
2289 if (ref($_[0]) eq 'HASH'){
2290 @pkgparts = @{$_[0]{pkgparts}};
2295 grep { $_->suspend(%opt) }
2296 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2297 $self->unsuspended_pkgs;
2300 =item cancel [ OPTION => VALUE ... ]
2302 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2304 Available options are:
2308 =item quiet - can be set true to supress email cancellation notices.
2310 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2312 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2314 =item nobill - can be set true to skip billing if it might otherwise be done.
2318 Always returns a list: an empty list on success or a list of errors.
2322 # nb that dates are not specified as valid options to this method
2325 my( $self, %opt ) = @_;
2327 warn "$me cancel called on customer ". $self->custnum. " with options ".
2328 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2331 return ( 'access denied' )
2332 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2334 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2336 #should try decryption (we might have the private key)
2337 # and if not maybe queue a job for the server that does?
2338 return ( "Can't (yet) ban encrypted credit cards" )
2339 if $self->is_encrypted($self->payinfo);
2341 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2342 my $error = $ban->insert;
2343 return ( $error ) if $error;
2347 my @pkgs = $self->ncancelled_pkgs;
2349 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2351 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2352 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2356 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2357 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2360 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2363 sub _banned_pay_hashref {
2374 'payby' => $payby2ban{$self->payby},
2375 'payinfo' => $self->payinfo,
2376 #don't ever *search* on reason! #'reason' =>
2380 sub _new_banned_pay_hashref {
2382 my $hr = $self->_banned_pay_hashref;
2383 $hr->{payinfo} = md5_base64($hr->{payinfo});
2389 Returns all notes (see L<FS::cust_main_note>) for this customer.
2394 my($self,$orderby_classnum) = (shift,shift);
2395 my $orderby = "_DATE DESC";
2396 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2397 qsearch( 'cust_main_note',
2398 { 'custnum' => $self->custnum },
2400 "ORDER BY $orderby",
2406 Returns the agent (see L<FS::agent>) for this customer.
2412 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2417 Returns the agent name (see L<FS::agent>) for this customer.
2423 $self->agent->agent;
2428 Returns any tags associated with this customer, as FS::cust_tag objects,
2429 or an empty list if there are no tags.
2435 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2440 Returns any tags associated with this customer, as FS::part_tag objects,
2441 or an empty list if there are no tags.
2447 map $_->part_tag, $self->cust_tag;
2453 Returns the customer class, as an FS::cust_class object, or the empty string
2454 if there is no customer class.
2460 if ( $self->classnum ) {
2461 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2469 Returns the customer category name, or the empty string if there is no customer
2476 my $cust_class = $self->cust_class;
2478 ? $cust_class->categoryname
2484 Returns the customer class name, or the empty string if there is no customer
2491 my $cust_class = $self->cust_class;
2493 ? $cust_class->classname
2497 =item BILLING METHODS
2499 Documentation on billing methods has been moved to
2500 L<FS::cust_main::Billing>.
2502 =item REALTIME BILLING METHODS
2504 Documentation on realtime billing methods has been moved to
2505 L<FS::cust_main::Billing_Realtime>.
2509 Removes the I<paycvv> field from the database directly.
2511 If there is an error, returns the error, otherwise returns false.
2517 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2518 or return dbh->errstr;
2519 $sth->execute($self->custnum)
2520 or return $sth->errstr;
2525 =item batch_card OPTION => VALUE...
2527 Adds a payment for this invoice to the pending credit card batch (see
2528 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2529 runs the payment using a realtime gateway.
2534 my ($self, %options) = @_;
2537 if (exists($options{amount})) {
2538 $amount = $options{amount};
2540 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2542 return '' unless $amount > 0;
2544 my $invnum = delete $options{invnum};
2545 my $payby = $options{payby} || $self->payby; #still dubious
2547 if ($options{'realtime'}) {
2548 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2554 my $oldAutoCommit = $FS::UID::AutoCommit;
2555 local $FS::UID::AutoCommit = 0;
2558 #this needs to handle mysql as well as Pg, like svc_acct.pm
2559 #(make it into a common function if folks need to do batching with mysql)
2560 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2561 or return "Cannot lock pay_batch: " . $dbh->errstr;
2565 'payby' => FS::payby->payby2payment($payby),
2567 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2569 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2571 unless ( $pay_batch ) {
2572 $pay_batch = new FS::pay_batch \%pay_batch;
2573 my $error = $pay_batch->insert;
2575 $dbh->rollback if $oldAutoCommit;
2576 die "error creating new batch: $error\n";
2580 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2581 'batchnum' => $pay_batch->batchnum,
2582 'custnum' => $self->custnum,
2585 foreach (qw( address1 address2 city state zip country latitude longitude
2586 payby payinfo paydate payname ))
2588 $options{$_} = '' unless exists($options{$_});
2591 my $cust_pay_batch = new FS::cust_pay_batch ( {
2592 'batchnum' => $pay_batch->batchnum,
2593 'invnum' => $invnum || 0, # is there a better value?
2594 # this field should be
2596 # cust_bill_pay_batch now
2597 'custnum' => $self->custnum,
2598 'last' => $self->getfield('last'),
2599 'first' => $self->getfield('first'),
2600 'address1' => $options{address1} || $self->address1,
2601 'address2' => $options{address2} || $self->address2,
2602 'city' => $options{city} || $self->city,
2603 'state' => $options{state} || $self->state,
2604 'zip' => $options{zip} || $self->zip,
2605 'country' => $options{country} || $self->country,
2606 'payby' => $options{payby} || $self->payby,
2607 'payinfo' => $options{payinfo} || $self->payinfo,
2608 'exp' => $options{paydate} || $self->paydate,
2609 'payname' => $options{payname} || $self->payname,
2610 'amount' => $amount, # consolidating
2613 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2614 if $old_cust_pay_batch;
2617 if ($old_cust_pay_batch) {
2618 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2620 $error = $cust_pay_batch->insert;
2624 $dbh->rollback if $oldAutoCommit;
2628 my $unapplied = $self->total_unapplied_credits
2629 + $self->total_unapplied_payments
2630 + $self->in_transit_payments;
2631 foreach my $cust_bill ($self->open_cust_bill) {
2632 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2633 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2634 'invnum' => $cust_bill->invnum,
2635 'paybatchnum' => $cust_pay_batch->paybatchnum,
2636 'amount' => $cust_bill->owed,
2639 if ($unapplied >= $cust_bill_pay_batch->amount){
2640 $unapplied -= $cust_bill_pay_batch->amount;
2643 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2644 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2646 $error = $cust_bill_pay_batch->insert;
2648 $dbh->rollback if $oldAutoCommit;
2653 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2659 Returns the total owed for this customer on all invoices
2660 (see L<FS::cust_bill/owed>).
2666 $self->total_owed_date(2145859200); #12/31/2037
2669 =item total_owed_date TIME
2671 Returns the total owed for this customer on all invoices with date earlier than
2672 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2673 see L<Time::Local> and L<Date::Parse> for conversion functions.
2677 sub total_owed_date {
2681 my $custnum = $self->custnum;
2683 my $owed_sql = FS::cust_bill->owed_sql;
2686 SELECT SUM($owed_sql) FROM cust_bill
2687 WHERE custnum = $custnum
2691 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2695 =item total_owed_pkgnum PKGNUM
2697 Returns the total owed on all invoices for this customer's specific package
2698 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2702 sub total_owed_pkgnum {
2703 my( $self, $pkgnum ) = @_;
2704 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2707 =item total_owed_date_pkgnum TIME PKGNUM
2709 Returns the total owed for this customer's specific package when using
2710 experimental package balances on all invoices with date earlier than
2711 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2712 see L<Time::Local> and L<Date::Parse> for conversion functions.
2716 sub total_owed_date_pkgnum {
2717 my( $self, $time, $pkgnum ) = @_;
2720 foreach my $cust_bill (
2721 grep { $_->_date <= $time }
2722 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2724 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2726 sprintf( "%.2f", $total_bill );
2732 Returns the total amount of all payments.
2739 $total += $_->paid foreach $self->cust_pay;
2740 sprintf( "%.2f", $total );
2743 =item total_unapplied_credits
2745 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2746 customer. See L<FS::cust_credit/credited>.
2748 =item total_credited
2750 Old name for total_unapplied_credits. Don't use.
2754 sub total_credited {
2755 #carp "total_credited deprecated, use total_unapplied_credits";
2756 shift->total_unapplied_credits(@_);
2759 sub total_unapplied_credits {
2762 my $custnum = $self->custnum;
2764 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2767 SELECT SUM($unapplied_sql) FROM cust_credit
2768 WHERE custnum = $custnum
2771 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2775 =item total_unapplied_credits_pkgnum PKGNUM
2777 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2778 customer. See L<FS::cust_credit/credited>.
2782 sub total_unapplied_credits_pkgnum {
2783 my( $self, $pkgnum ) = @_;
2784 my $total_credit = 0;
2785 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2786 sprintf( "%.2f", $total_credit );
2790 =item total_unapplied_payments
2792 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2793 See L<FS::cust_pay/unapplied>.
2797 sub total_unapplied_payments {
2800 my $custnum = $self->custnum;
2802 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2805 SELECT SUM($unapplied_sql) FROM cust_pay
2806 WHERE custnum = $custnum
2809 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2813 =item total_unapplied_payments_pkgnum PKGNUM
2815 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2816 specific package when using experimental package balances. See
2817 L<FS::cust_pay/unapplied>.
2821 sub total_unapplied_payments_pkgnum {
2822 my( $self, $pkgnum ) = @_;
2823 my $total_unapplied = 0;
2824 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2825 sprintf( "%.2f", $total_unapplied );
2829 =item total_unapplied_refunds
2831 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2832 customer. See L<FS::cust_refund/unapplied>.
2836 sub total_unapplied_refunds {
2838 my $custnum = $self->custnum;
2840 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2843 SELECT SUM($unapplied_sql) FROM cust_refund
2844 WHERE custnum = $custnum
2847 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2853 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2854 total_unapplied_credits minus total_unapplied_payments).
2860 $self->balance_date_range;
2863 =item balance_date TIME
2865 Returns the balance for this customer, only considering invoices with date
2866 earlier than TIME (total_owed_date minus total_credited minus
2867 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2868 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2875 $self->balance_date_range(shift);
2878 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2880 Returns the balance for this customer, optionally considering invoices with
2881 date earlier than START_TIME, and not later than END_TIME
2882 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2884 Times are specified as SQL fragments or numeric
2885 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2886 L<Date::Parse> for conversion functions. The empty string can be passed
2887 to disable that time constraint completely.
2889 Available options are:
2893 =item unapplied_date
2895 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
2901 sub balance_date_range {
2903 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2904 ') FROM cust_main WHERE custnum='. $self->custnum;
2905 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2908 =item balance_pkgnum PKGNUM
2910 Returns the balance for this customer's specific package when using
2911 experimental package balances (total_owed plus total_unrefunded, minus
2912 total_unapplied_credits minus total_unapplied_payments)
2916 sub balance_pkgnum {
2917 my( $self, $pkgnum ) = @_;
2920 $self->total_owed_pkgnum($pkgnum)
2921 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2922 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2923 - $self->total_unapplied_credits_pkgnum($pkgnum)
2924 - $self->total_unapplied_payments_pkgnum($pkgnum)
2928 =item in_transit_payments
2930 Returns the total of requests for payments for this customer pending in
2931 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2935 sub in_transit_payments {
2937 my $in_transit_payments = 0;
2938 foreach my $pay_batch ( qsearch('pay_batch', {
2941 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2942 'batchnum' => $pay_batch->batchnum,
2943 'custnum' => $self->custnum,
2945 $in_transit_payments += $cust_pay_batch->amount;
2948 sprintf( "%.2f", $in_transit_payments );
2953 Returns a hash of useful information for making a payment.
2963 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2964 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2965 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2969 For credit card transactions:
2981 For electronic check transactions:
2996 $return{balance} = $self->balance;
2998 $return{payname} = $self->payname
2999 || ( $self->first. ' '. $self->get('last') );
3001 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
3003 $return{payby} = $self->payby;
3004 $return{stateid_state} = $self->stateid_state;
3006 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3007 $return{card_type} = cardtype($self->payinfo);
3008 $return{payinfo} = $self->paymask;
3010 @return{'month', 'year'} = $self->paydate_monthyear;
3014 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3015 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3016 $return{payinfo1} = $payinfo1;
3017 $return{payinfo2} = $payinfo2;
3018 $return{paytype} = $self->paytype;
3019 $return{paystate} = $self->paystate;
3023 #doubleclick protection
3025 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3031 =item paydate_monthyear
3033 Returns a two-element list consisting of the month and year of this customer's
3034 paydate (credit card expiration date for CARD customers)
3038 sub paydate_monthyear {
3040 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3042 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3051 Returns the exact time in seconds corresponding to the payment method
3052 expiration date. For CARD/DCRD customers this is the end of the month;
3053 for others (COMP is the only other payby that uses paydate) it's the start.
3054 Returns 0 if the paydate is empty or set to the far future.
3060 my ($month, $year) = $self->paydate_monthyear;
3061 return 0 if !$year or $year >= 2037;
3062 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3064 if ( $month == 13 ) {
3068 return timelocal(0,0,0,1,$month-1,$year) - 1;
3071 return timelocal(0,0,0,1,$month-1,$year);
3075 =item paydate_epoch_sql
3077 Class method. Returns an SQL expression to obtain the payment expiration date
3078 as a number of seconds.
3082 # Special expiration date behavior for non-CARD/DCRD customers has been
3083 # carefully preserved. Do we really use that?
3084 sub paydate_epoch_sql {
3086 my $table = shift || 'cust_main';
3087 my ($case1, $case2);
3088 if ( driver_name eq 'Pg' ) {
3089 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3090 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3092 elsif ( lc(driver_name) eq 'mysql' ) {
3093 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3094 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3097 return "CASE WHEN $table.payby IN('CARD','DCRD')
3103 =item tax_exemption TAXNAME
3108 my( $self, $taxname ) = @_;
3110 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3111 'taxname' => $taxname,
3116 =item cust_main_exemption
3120 sub cust_main_exemption {
3122 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3125 =item invoicing_list [ ARRAYREF ]
3127 If an arguement is given, sets these email addresses as invoice recipients
3128 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3129 (except as warnings), so use check_invoicing_list first.
3131 Returns a list of email addresses (with svcnum entries expanded).
3133 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3134 check it without disturbing anything by passing nothing.
3136 This interface may change in the future.
3140 sub invoicing_list {
3141 my( $self, $arrayref ) = @_;
3144 my @cust_main_invoice;
3145 if ( $self->custnum ) {
3146 @cust_main_invoice =
3147 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3149 @cust_main_invoice = ();
3151 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3152 #warn $cust_main_invoice->destnum;
3153 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3154 #warn $cust_main_invoice->destnum;
3155 my $error = $cust_main_invoice->delete;
3156 warn $error if $error;
3159 if ( $self->custnum ) {
3160 @cust_main_invoice =
3161 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3163 @cust_main_invoice = ();
3165 my %seen = map { $_->address => 1 } @cust_main_invoice;
3166 foreach my $address ( @{$arrayref} ) {
3167 next if exists $seen{$address} && $seen{$address};
3168 $seen{$address} = 1;
3169 my $cust_main_invoice = new FS::cust_main_invoice ( {
3170 'custnum' => $self->custnum,
3173 my $error = $cust_main_invoice->insert;
3174 warn $error if $error;
3178 if ( $self->custnum ) {
3180 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3187 =item check_invoicing_list ARRAYREF
3189 Checks these arguements as valid input for the invoicing_list method. If there
3190 is an error, returns the error, otherwise returns false.
3194 sub check_invoicing_list {
3195 my( $self, $arrayref ) = @_;
3197 foreach my $address ( @$arrayref ) {
3199 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3200 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3203 my $cust_main_invoice = new FS::cust_main_invoice ( {
3204 'custnum' => $self->custnum,
3207 my $error = $self->custnum
3208 ? $cust_main_invoice->check
3209 : $cust_main_invoice->checkdest
3211 return $error if $error;
3215 return "Email address required"
3216 if $conf->exists('cust_main-require_invoicing_list_email')
3217 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3222 =item set_default_invoicing_list
3224 Sets the invoicing list to all accounts associated with this customer,
3225 overwriting any previous invoicing list.
3229 sub set_default_invoicing_list {
3231 $self->invoicing_list($self->all_emails);
3236 Returns the email addresses of all accounts provisioned for this customer.
3243 foreach my $cust_pkg ( $self->all_pkgs ) {
3244 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3246 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3247 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3249 $list{$_}=1 foreach map { $_->email } @svc_acct;
3254 =item invoicing_list_addpost
3256 Adds postal invoicing to this customer. If this customer is already configured
3257 to receive postal invoices, does nothing.
3261 sub invoicing_list_addpost {
3263 return if grep { $_ eq 'POST' } $self->invoicing_list;
3264 my @invoicing_list = $self->invoicing_list;
3265 push @invoicing_list, 'POST';
3266 $self->invoicing_list(\@invoicing_list);
3269 =item invoicing_list_emailonly
3271 Returns the list of email invoice recipients (invoicing_list without non-email
3272 destinations such as POST and FAX).
3276 sub invoicing_list_emailonly {
3278 warn "$me invoicing_list_emailonly called"
3280 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3283 =item invoicing_list_emailonly_scalar
3285 Returns the list of email invoice recipients (invoicing_list without non-email
3286 destinations such as POST and FAX) as a comma-separated scalar.
3290 sub invoicing_list_emailonly_scalar {
3292 warn "$me invoicing_list_emailonly_scalar called"
3294 join(', ', $self->invoicing_list_emailonly);
3297 =item referral_custnum_cust_main
3299 Returns the customer who referred this customer (or the empty string, if
3300 this customer was not referred).
3302 Note the difference with referral_cust_main method: This method,
3303 referral_custnum_cust_main returns the single customer (if any) who referred
3304 this customer, while referral_cust_main returns an array of customers referred
3309 sub referral_custnum_cust_main {
3311 return '' unless $self->referral_custnum;
3312 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3315 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3317 Returns an array of customers referred by this customer (referral_custnum set
3318 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3319 customers referred by customers referred by this customer and so on, inclusive.
3320 The default behavior is DEPTH 1 (no recursion).
3322 Note the difference with referral_custnum_cust_main method: This method,
3323 referral_cust_main, returns an array of customers referred BY this customer,
3324 while referral_custnum_cust_main returns the single customer (if any) who
3325 referred this customer.
3329 sub referral_cust_main {
3331 my $depth = @_ ? shift : 1;
3332 my $exclude = @_ ? shift : {};
3335 map { $exclude->{$_->custnum}++; $_; }
3336 grep { ! $exclude->{ $_->custnum } }
3337 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3341 map { $_->referral_cust_main($depth-1, $exclude) }
3348 =item referral_cust_main_ncancelled
3350 Same as referral_cust_main, except only returns customers with uncancelled
3355 sub referral_cust_main_ncancelled {
3357 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3360 =item referral_cust_pkg [ DEPTH ]
3362 Like referral_cust_main, except returns a flat list of all unsuspended (and
3363 uncancelled) packages for each customer. The number of items in this list may
3364 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3368 sub referral_cust_pkg {
3370 my $depth = @_ ? shift : 1;
3372 map { $_->unsuspended_pkgs }
3373 grep { $_->unsuspended_pkgs }
3374 $self->referral_cust_main($depth);
3377 =item referring_cust_main
3379 Returns the single cust_main record for the customer who referred this customer
3380 (referral_custnum), or false.
3384 sub referring_cust_main {
3386 return '' unless $self->referral_custnum;
3387 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3390 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3392 Applies a credit to this customer. If there is an error, returns the error,
3393 otherwise returns false.
3395 REASON can be a text string, an FS::reason object, or a scalar reference to
3396 a reasonnum. If a text string, it will be automatically inserted as a new
3397 reason, and a 'reason_type' option must be passed to indicate the
3398 FS::reason_type for the new reason.
3400 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3402 Any other options are passed to FS::cust_credit::insert.
3407 my( $self, $amount, $reason, %options ) = @_;
3409 my $cust_credit = new FS::cust_credit {
3410 'custnum' => $self->custnum,
3411 'amount' => $amount,
3414 if ( ref($reason) ) {
3416 if ( ref($reason) eq 'SCALAR' ) {
3417 $cust_credit->reasonnum( $$reason );
3419 $cust_credit->reasonnum( $reason->reasonnum );
3423 $cust_credit->set('reason', $reason)
3426 for (qw( addlinfo eventnum )) {
3427 $cust_credit->$_( delete $options{$_} )
3428 if exists($options{$_});
3431 $cust_credit->insert(%options);
3435 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3437 Creates a one-time charge for this customer. If there is an error, returns
3438 the error, otherwise returns false.
3440 New-style, with a hashref of options:
3442 my $error = $cust_main->charge(
3446 'start_date' => str2time('7/4/2009'),
3447 'pkg' => 'Description',
3448 'comment' => 'Comment',
3449 'additional' => [], #extra invoice detail
3450 'classnum' => 1, #pkg_class
3452 'setuptax' => '', # or 'Y' for tax exempt
3455 'taxclass' => 'Tax class',
3458 'taxproduct' => 2, #part_pkg_taxproduct
3459 'override' => {}, #XXX describe
3461 #will be filled in with the new object
3462 'cust_pkg_ref' => \$cust_pkg,
3464 #generate an invoice immediately
3466 'invoice_terms' => '', #with these terms
3472 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3478 my ( $amount, $quantity, $start_date, $classnum );
3479 my ( $pkg, $comment, $additional );
3480 my ( $setuptax, $taxclass ); #internal taxes
3481 my ( $taxproduct, $override ); #vendor (CCH) taxes
3483 my $cust_pkg_ref = '';
3484 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3485 if ( ref( $_[0] ) ) {
3486 $amount = $_[0]->{amount};
3487 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3488 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3489 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3490 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3491 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3492 : '$'. sprintf("%.2f",$amount);
3493 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3494 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3495 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3496 $additional = $_[0]->{additional} || [];
3497 $taxproduct = $_[0]->{taxproductnum};
3498 $override = { '' => $_[0]->{tax_override} };
3499 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3500 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3501 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3506 $pkg = @_ ? shift : 'One-time charge';
3507 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3509 $taxclass = @_ ? shift : '';
3513 local $SIG{HUP} = 'IGNORE';
3514 local $SIG{INT} = 'IGNORE';
3515 local $SIG{QUIT} = 'IGNORE';
3516 local $SIG{TERM} = 'IGNORE';
3517 local $SIG{TSTP} = 'IGNORE';
3518 local $SIG{PIPE} = 'IGNORE';
3520 my $oldAutoCommit = $FS::UID::AutoCommit;
3521 local $FS::UID::AutoCommit = 0;
3524 my $part_pkg = new FS::part_pkg ( {
3526 'comment' => $comment,
3530 'classnum' => ( $classnum ? $classnum : '' ),
3531 'setuptax' => $setuptax,
3532 'taxclass' => $taxclass,
3533 'taxproductnum' => $taxproduct,
3536 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3537 ( 0 .. @$additional - 1 )
3539 'additional_count' => scalar(@$additional),
3540 'setup_fee' => $amount,
3543 my $error = $part_pkg->insert( options => \%options,
3544 tax_overrides => $override,
3547 $dbh->rollback if $oldAutoCommit;
3551 my $pkgpart = $part_pkg->pkgpart;
3552 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3553 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3554 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3555 $error = $type_pkgs->insert;
3557 $dbh->rollback if $oldAutoCommit;
3562 my $cust_pkg = new FS::cust_pkg ( {
3563 'custnum' => $self->custnum,
3564 'pkgpart' => $pkgpart,
3565 'quantity' => $quantity,
3566 'start_date' => $start_date,
3567 'no_auto' => $no_auto,
3570 $error = $cust_pkg->insert;
3572 $dbh->rollback if $oldAutoCommit;
3574 } elsif ( $cust_pkg_ref ) {
3575 ${$cust_pkg_ref} = $cust_pkg;
3579 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3580 'pkg_list' => [ $cust_pkg ],
3583 $dbh->rollback if $oldAutoCommit;
3588 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3593 #=item charge_postal_fee
3595 #Applies a one time charge this customer. If there is an error,
3596 #returns the error, returns the cust_pkg charge object or false
3597 #if there was no charge.
3601 # This should be a customer event. For that to work requires that bill
3602 # also be a customer event.
3604 sub charge_postal_fee {
3607 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3608 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3610 my $cust_pkg = new FS::cust_pkg ( {
3611 'custnum' => $self->custnum,
3612 'pkgpart' => $pkgpart,
3616 my $error = $cust_pkg->insert;
3617 $error ? $error : $cust_pkg;
3620 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3622 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3624 Optionally, a list or hashref of additional arguments to the qsearch call can
3631 my $opt = ref($_[0]) ? shift : { @_ };
3633 #return $self->num_cust_bill unless wantarray || keys %$opt;
3635 $opt->{'table'} = 'cust_bill';
3636 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3637 $opt->{'hashref'}{'custnum'} = $self->custnum;
3638 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3640 map { $_ } #behavior of sort undefined in scalar context
3641 sort { $a->_date <=> $b->_date }
3645 =item open_cust_bill
3647 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3652 sub open_cust_bill {
3656 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3662 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3664 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3668 sub legacy_cust_bill {
3671 #return $self->num_legacy_cust_bill unless wantarray;
3673 map { $_ } #behavior of sort undefined in scalar context
3674 sort { $a->_date <=> $b->_date }
3675 qsearch({ 'table' => 'legacy_cust_bill',
3676 'hashref' => { 'custnum' => $self->custnum, },
3677 'order_by' => 'ORDER BY _date ASC',
3681 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3683 Returns all the statements (see L<FS::cust_statement>) for this customer.
3685 Optionally, a list or hashref of additional arguments to the qsearch call can
3690 sub cust_statement {
3692 my $opt = ref($_[0]) ? shift : { @_ };
3694 #return $self->num_cust_statement unless wantarray || keys %$opt;
3696 $opt->{'table'} = 'cust_statement';
3697 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3698 $opt->{'hashref'}{'custnum'} = $self->custnum;
3699 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3701 map { $_ } #behavior of sort undefined in scalar context
3702 sort { $a->_date <=> $b->_date }
3706 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3708 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3710 Optionally, a list or hashref of additional arguments to the qsearch call can
3711 be passed following the SVCDB.
3718 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3719 warn "$me svc_x requires a svcdb";
3722 my $opt = ref($_[0]) ? shift : { @_ };
3724 $opt->{'table'} = $svcdb;
3725 $opt->{'addl_from'} =
3726 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3727 ($opt->{'addl_from'} || '');
3729 my $custnum = $self->custnum;
3730 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3731 my $where = "cust_pkg.custnum = $custnum";
3733 my $extra_sql = $opt->{'extra_sql'} || '';
3734 if ( keys %{ $opt->{'hashref'} } ) {
3735 $extra_sql = " AND $where $extra_sql";
3738 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3739 $extra_sql = "WHERE $where AND $1";
3742 $extra_sql = "WHERE $where $extra_sql";
3745 $opt->{'extra_sql'} = $extra_sql;
3750 # required for use as an eventtable;
3753 $self->svc_x('svc_acct', @_);
3758 Returns all the credits (see L<FS::cust_credit>) for this customer.
3764 map { $_ } #return $self->num_cust_credit unless wantarray;
3765 sort { $a->_date <=> $b->_date }
3766 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3769 =item cust_credit_pkgnum
3771 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3772 package when using experimental package balances.
3776 sub cust_credit_pkgnum {
3777 my( $self, $pkgnum ) = @_;
3778 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3779 sort { $a->_date <=> $b->_date }
3780 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3781 'pkgnum' => $pkgnum,
3788 Returns all the payments (see L<FS::cust_pay>) for this customer.
3794 return $self->num_cust_pay unless wantarray;
3795 sort { $a->_date <=> $b->_date }
3796 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3801 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3802 called automatically when the cust_pay method is used in a scalar context.
3808 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3809 my $sth = dbh->prepare($sql) or die dbh->errstr;
3810 $sth->execute($self->custnum) or die $sth->errstr;
3811 $sth->fetchrow_arrayref->[0];
3814 =item cust_pay_pkgnum
3816 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3817 package when using experimental package balances.
3821 sub cust_pay_pkgnum {
3822 my( $self, $pkgnum ) = @_;
3823 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3824 sort { $a->_date <=> $b->_date }
3825 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3826 'pkgnum' => $pkgnum,
3833 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3839 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3840 sort { $a->_date <=> $b->_date }
3841 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3844 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3846 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3848 Optionally, a list or hashref of additional arguments to the qsearch call can
3853 sub cust_pay_batch {
3855 my $opt = ref($_[0]) ? shift : { @_ };
3857 #return $self->num_cust_statement unless wantarray || keys %$opt;
3859 $opt->{'table'} = 'cust_pay_batch';
3860 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3861 $opt->{'hashref'}{'custnum'} = $self->custnum;
3862 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3864 map { $_ } #behavior of sort undefined in scalar context
3865 sort { $a->paybatchnum <=> $b->paybatchnum }
3869 =item cust_pay_pending
3871 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3872 (without status "done").
3876 sub cust_pay_pending {
3878 return $self->num_cust_pay_pending unless wantarray;
3879 sort { $a->_date <=> $b->_date }
3880 qsearch( 'cust_pay_pending', {
3881 'custnum' => $self->custnum,
3882 'status' => { op=>'!=', value=>'done' },
3887 =item cust_pay_pending_attempt
3889 Returns all payment attempts / declined payments for this customer, as pending
3890 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3891 a corresponding payment (see L<FS::cust_pay>).
3895 sub cust_pay_pending_attempt {
3897 return $self->num_cust_pay_pending_attempt unless wantarray;
3898 sort { $a->_date <=> $b->_date }
3899 qsearch( 'cust_pay_pending', {
3900 'custnum' => $self->custnum,
3907 =item num_cust_pay_pending
3909 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3910 customer (without status "done"). Also called automatically when the
3911 cust_pay_pending method is used in a scalar context.
3915 sub num_cust_pay_pending {
3918 " SELECT COUNT(*) FROM cust_pay_pending ".
3919 " WHERE custnum = ? AND status != 'done' ",
3924 =item num_cust_pay_pending_attempt
3926 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3927 customer, with status "done" but without a corresp. Also called automatically when the
3928 cust_pay_pending method is used in a scalar context.
3932 sub num_cust_pay_pending_attempt {
3935 " SELECT COUNT(*) FROM cust_pay_pending ".
3936 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3943 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3949 map { $_ } #return $self->num_cust_refund unless wantarray;
3950 sort { $a->_date <=> $b->_date }
3951 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3954 =item display_custnum
3956 Returns the displayed customer number for this customer: agent_custid if
3957 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3961 sub display_custnum {
3963 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3964 return $self->agent_custid;
3965 } elsif ( $conf->config('cust_main-custnum-display_prefix') ) {
3966 return $conf->config('cust_main-custnum-display_prefix').
3967 sprintf('%08d', $self->custnum)
3969 return $self->custnum;
3975 Returns a name string for this customer, either "Company (Last, First)" or
3982 my $name = $self->contact;
3983 $name = $self->company. " ($name)" if $self->company;
3989 Returns a name string for this (service/shipping) contact, either
3990 "Company (Last, First)" or "Last, First".
3996 if ( $self->get('ship_last') ) {
3997 my $name = $self->ship_contact;
3998 $name = $self->ship_company. " ($name)" if $self->ship_company;
4007 Returns a name string for this customer, either "Company" or "First Last".
4013 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4016 =item ship_name_short
4018 Returns a name string for this (service/shipping) contact, either "Company"
4023 sub ship_name_short {
4025 if ( $self->get('ship_last') ) {
4026 $self->ship_company !~ /^\s*$/
4027 ? $self->ship_company
4028 : $self->ship_contact_firstlast;
4030 $self->name_company_or_firstlast;
4036 Returns this customer's full (billing) contact name only, "Last, First"
4042 $self->get('last'). ', '. $self->first;
4047 Returns this customer's full (shipping) contact name only, "Last, First"
4053 $self->get('ship_last')
4054 ? $self->get('ship_last'). ', '. $self->ship_first
4058 =item contact_firstlast
4060 Returns this customers full (billing) contact name only, "First Last".
4064 sub contact_firstlast {
4066 $self->first. ' '. $self->get('last');
4069 =item ship_contact_firstlast
4071 Returns this customer's full (shipping) contact name only, "First Last".
4075 sub ship_contact_firstlast {
4077 $self->get('ship_last')
4078 ? $self->first. ' '. $self->get('ship_last')
4079 : $self->contact_firstlast;
4084 Returns this customer's full country name
4090 code2country($self->country);
4093 =item geocode DATA_VENDOR
4095 Returns a value for the customer location as encoded by DATA_VENDOR.
4096 Currently this only makes sense for "CCH" as DATA_VENDOR.
4104 Returns a status string for this customer, currently:
4108 =item prospect - No packages have ever been ordered
4110 =item ordered - Recurring packages all are new (not yet billed).
4112 =item active - One or more recurring packages is active
4114 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4116 =item suspended - All non-cancelled recurring packages are suspended
4118 =item cancelled - All recurring packages are cancelled
4122 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4123 cust_main-status_module configuration option.
4127 sub status { shift->cust_status(@_); }
4131 for my $status ( FS::cust_main->statuses() ) {
4132 my $method = $status.'_sql';
4133 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4134 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4135 $sth->execute( ($self->custnum) x $numnum )
4136 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4137 return $status if $sth->fetchrow_arrayref->[0];
4141 =item ucfirst_cust_status
4143 =item ucfirst_status
4145 Returns the status with the first character capitalized.
4149 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4151 sub ucfirst_cust_status {
4153 ucfirst($self->cust_status);
4158 Returns a hex triplet color string for this customer's status.
4162 sub statuscolor { shift->cust_statuscolor(@_); }
4164 sub cust_statuscolor {
4166 __PACKAGE__->statuscolors->{$self->cust_status};
4171 Returns an array of hashes representing the customer's RT tickets.
4178 my $num = $conf->config('cust_main-max_tickets') || 10;
4181 if ( $conf->config('ticket_system') ) {
4182 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4184 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4188 foreach my $priority (
4189 $conf->config('ticket_system-custom_priority_field-values'), ''
4191 last if scalar(@tickets) >= $num;
4193 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4194 $num - scalar(@tickets),
4204 # Return services representing svc_accts in customer support packages
4205 sub support_services {
4207 my %packages = map { $_ => 1 } $conf->config('support_packages');
4209 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4210 grep { $_->part_svc->svcdb eq 'svc_acct' }
4211 map { $_->cust_svc }
4212 grep { exists $packages{ $_->pkgpart } }
4213 $self->ncancelled_pkgs;
4217 # Return a list of latitude/longitude for one of the services (if any)
4218 sub service_coordinates {
4222 grep { $_->latitude && $_->longitude }
4224 map { $_->cust_svc }
4225 $self->ncancelled_pkgs;
4227 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4232 Returns a masked version of the named field
4237 my ($self,$field) = @_;
4241 'x'x(length($self->getfield($field))-4).
4242 substr($self->getfield($field), (length($self->getfield($field))-4));
4248 =head1 CLASS METHODS
4254 Class method that returns the list of possible status strings for customers
4255 (see L<the status method|/status>). For example:
4257 @statuses = FS::cust_main->statuses();
4263 keys %{ $self->statuscolors };
4266 =item cust_status_sql
4268 Returns an SQL fragment to determine the status of a cust_main record, as a
4273 sub cust_status_sql {
4275 for my $status ( FS::cust_main->statuses() ) {
4276 my $method = $status.'_sql';
4277 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4286 Returns an SQL expression identifying prospective cust_main records (customers
4287 with no packages ever ordered)
4291 use vars qw($select_count_pkgs);
4292 $select_count_pkgs =
4293 "SELECT COUNT(*) FROM cust_pkg
4294 WHERE cust_pkg.custnum = cust_main.custnum";
4296 sub select_count_pkgs_sql {
4301 " 0 = ( $select_count_pkgs ) ";
4306 Returns an SQL expression identifying ordered cust_main records (customers with
4307 no active packages, but recurring packages not yet setup or one time charges
4313 FS::cust_main->none_active_sql.
4314 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4319 Returns an SQL expression identifying active cust_main records (customers with
4320 active recurring packages).
4325 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4328 =item none_active_sql
4330 Returns an SQL expression identifying cust_main records with no active
4331 recurring packages. This includes customers of status prospect, ordered,
4332 inactive, and suspended.
4336 sub none_active_sql {
4337 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4342 Returns an SQL expression identifying inactive cust_main records (customers with
4343 no active recurring packages, but otherwise unsuspended/uncancelled).
4348 FS::cust_main->none_active_sql.
4349 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4355 Returns an SQL expression identifying suspended cust_main records.
4360 sub suspended_sql { susp_sql(@_); }
4362 FS::cust_main->none_active_sql.
4363 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4369 Returns an SQL expression identifying cancelled cust_main records.
4373 sub cancel_sql { shift->cancelled_sql(@_); }
4376 =item uncancelled_sql
4378 Returns an SQL expression identifying un-cancelled cust_main records.
4382 sub uncancelled_sql { uncancel_sql(@_); }
4383 sub uncancel_sql { "
4384 ( 0 < ( $select_count_pkgs
4385 AND ( cust_pkg.cancel IS NULL
4386 OR cust_pkg.cancel = 0
4389 OR 0 = ( $select_count_pkgs )
4395 Returns an SQL fragment to retreive the balance.
4400 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4401 WHERE cust_bill.custnum = cust_main.custnum )
4402 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4403 WHERE cust_pay.custnum = cust_main.custnum )
4404 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4405 WHERE cust_credit.custnum = cust_main.custnum )
4406 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4407 WHERE cust_refund.custnum = cust_main.custnum )
4410 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4412 Returns an SQL fragment to retreive the balance for this customer, optionally
4413 considering invoices with date earlier than START_TIME, and not
4414 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4415 total_unapplied_payments).
4417 Times are specified as SQL fragments or numeric
4418 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4419 L<Date::Parse> for conversion functions. The empty string can be passed
4420 to disable that time constraint completely.
4422 Available options are:
4426 =item unapplied_date
4428 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
4433 set to true to remove all customer comparison clauses, for totals
4438 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4443 JOIN clause (typically used with the total option)
4447 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4448 time will be ignored. Note that START_TIME and END_TIME only limit the date
4449 range for invoices and I<unapplied> payments, credits, and refunds.
4455 sub balance_date_sql {
4456 my( $class, $start, $end, %opt ) = @_;
4458 my $cutoff = $opt{'cutoff'};
4460 my $owed = FS::cust_bill->owed_sql($cutoff);
4461 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4462 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4463 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4465 my $j = $opt{'join'} || '';
4467 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4468 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4469 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4470 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4472 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4473 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4474 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4475 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4480 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4482 Returns an SQL fragment to retreive the total unapplied payments for this
4483 customer, only considering payments with date earlier than START_TIME, and
4484 optionally not later than END_TIME.
4486 Times are specified as SQL fragments or numeric
4487 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4488 L<Date::Parse> for conversion functions. The empty string can be passed
4489 to disable that time constraint completely.
4491 Available options are:
4495 sub unapplied_payments_date_sql {
4496 my( $class, $start, $end, %opt ) = @_;
4498 my $cutoff = $opt{'cutoff'};
4500 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4502 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4503 'unapplied_date'=>1 );
4505 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4508 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4510 Helper method for balance_date_sql; name (and usage) subject to change
4511 (suggestions welcome).
4513 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4514 cust_refund, cust_credit or cust_pay).
4516 If TABLE is "cust_bill" or the unapplied_date option is true, only
4517 considers records with date earlier than START_TIME, and optionally not
4518 later than END_TIME .
4522 sub _money_table_where {
4523 my( $class, $table, $start, $end, %opt ) = @_;
4526 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4527 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4528 push @where, "$table._date <= $start" if defined($start) && length($start);
4529 push @where, "$table._date > $end" if defined($end) && length($end);
4531 push @where, @{$opt{'where'}} if $opt{'where'};
4532 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4538 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4539 use FS::cust_main::Search;
4542 FS::cust_main::Search->search(@_);
4557 #warn join('-',keys %$param);
4558 my $fh = $param->{filehandle};
4559 my $agentnum = $param->{agentnum};
4560 my $format = $param->{format};
4562 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4565 if ( $format eq 'simple' ) {
4566 @fields = qw( custnum agent_custid amount pkg );
4568 die "unknown format $format";
4571 eval "use Text::CSV_XS;";
4574 my $csv = new Text::CSV_XS;
4581 local $SIG{HUP} = 'IGNORE';
4582 local $SIG{INT} = 'IGNORE';
4583 local $SIG{QUIT} = 'IGNORE';
4584 local $SIG{TERM} = 'IGNORE';
4585 local $SIG{TSTP} = 'IGNORE';
4586 local $SIG{PIPE} = 'IGNORE';
4588 my $oldAutoCommit = $FS::UID::AutoCommit;
4589 local $FS::UID::AutoCommit = 0;
4592 #while ( $columns = $csv->getline($fh) ) {
4594 while ( defined($line=<$fh>) ) {
4596 $csv->parse($line) or do {
4597 $dbh->rollback if $oldAutoCommit;
4598 return "can't parse: ". $csv->error_input();
4601 my @columns = $csv->fields();
4602 #warn join('-',@columns);
4605 foreach my $field ( @fields ) {
4606 $row{$field} = shift @columns;
4609 if ( $row{custnum} && $row{agent_custid} ) {
4610 dbh->rollback if $oldAutoCommit;
4611 return "can't specify custnum with agent_custid $row{agent_custid}";
4615 if ( $row{agent_custid} && $agentnum ) {
4616 %hash = ( 'agent_custid' => $row{agent_custid},
4617 'agentnum' => $agentnum,
4621 if ( $row{custnum} ) {
4622 %hash = ( 'custnum' => $row{custnum} );
4625 unless ( scalar(keys %hash) ) {
4626 $dbh->rollback if $oldAutoCommit;
4627 return "can't find customer without custnum or agent_custid and agentnum";
4630 my $cust_main = qsearchs('cust_main', { %hash } );
4631 unless ( $cust_main ) {
4632 $dbh->rollback if $oldAutoCommit;
4633 my $custnum = $row{custnum} || $row{agent_custid};
4634 return "unknown custnum $custnum";
4637 if ( $row{'amount'} > 0 ) {
4638 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4640 $dbh->rollback if $oldAutoCommit;
4644 } elsif ( $row{'amount'} < 0 ) {
4645 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4648 $dbh->rollback if $oldAutoCommit;
4658 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4660 return "Empty file!" unless $imported;
4666 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4668 Deprecated. Use event notification and message templates
4669 (L<FS::msg_template>) instead.
4671 Sends a templated email notification to the customer (see L<Text::Template>).
4673 OPTIONS is a hash and may include
4675 I<from> - the email sender (default is invoice_from)
4677 I<to> - comma-separated scalar or arrayref of recipients
4678 (default is invoicing_list)
4680 I<subject> - The subject line of the sent email notification
4681 (default is "Notice from company_name")
4683 I<extra_fields> - a hashref of name/value pairs which will be substituted
4686 The following variables are vavailable in the template.
4688 I<$first> - the customer first name
4689 I<$last> - the customer last name
4690 I<$company> - the customer company
4691 I<$payby> - a description of the method of payment for the customer
4692 # would be nice to use FS::payby::shortname
4693 I<$payinfo> - the account information used to collect for this customer
4694 I<$expdate> - the expiration of the customer payment in seconds from epoch
4699 my ($self, $template, %options) = @_;
4701 return unless $conf->exists($template);
4703 my $from = $conf->config('invoice_from', $self->agentnum)
4704 if $conf->exists('invoice_from', $self->agentnum);
4705 $from = $options{from} if exists($options{from});
4707 my $to = join(',', $self->invoicing_list_emailonly);
4708 $to = $options{to} if exists($options{to});
4710 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4711 if $conf->exists('company_name', $self->agentnum);
4712 $subject = $options{subject} if exists($options{subject});
4714 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4715 SOURCE => [ map "$_\n",
4716 $conf->config($template)]
4718 or die "can't create new Text::Template object: Text::Template::ERROR";
4719 $notify_template->compile()
4720 or die "can't compile template: Text::Template::ERROR";
4722 $FS::notify_template::_template::company_name =
4723 $conf->config('company_name', $self->agentnum);
4724 $FS::notify_template::_template::company_address =
4725 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4727 my $paydate = $self->paydate || '2037-12-31';
4728 $FS::notify_template::_template::first = $self->first;
4729 $FS::notify_template::_template::last = $self->last;
4730 $FS::notify_template::_template::company = $self->company;
4731 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4732 my $payby = $self->payby;
4733 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4734 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4736 #credit cards expire at the end of the month/year of their exp date
4737 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4738 $FS::notify_template::_template::payby = 'credit card';
4739 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4740 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4742 }elsif ($payby eq 'COMP') {
4743 $FS::notify_template::_template::payby = 'complimentary account';
4745 $FS::notify_template::_template::payby = 'current method';
4747 $FS::notify_template::_template::expdate = $expire_time;
4749 for (keys %{$options{extra_fields}}){
4751 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4754 send_email(from => $from,
4756 subject => $subject,
4757 body => $notify_template->fill_in( PACKAGE =>
4758 'FS::notify_template::_template' ),
4763 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4765 Generates a templated notification to the customer (see L<Text::Template>).
4767 OPTIONS is a hash and may include
4769 I<extra_fields> - a hashref of name/value pairs which will be substituted
4770 into the template. These values may override values mentioned below
4771 and those from the customer record.
4773 The following variables are available in the template instead of or in addition
4774 to the fields of the customer record.
4776 I<$payby> - a description of the method of payment for the customer
4777 # would be nice to use FS::payby::shortname
4778 I<$payinfo> - the masked account information used to collect for this customer
4779 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4780 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4784 # a lot like cust_bill::print_latex
4785 sub generate_letter {
4786 my ($self, $template, %options) = @_;
4788 return unless $conf->exists($template);
4790 my $letter_template = new Text::Template
4792 SOURCE => [ map "$_\n", $conf->config($template)],
4793 DELIMITERS => [ '[@--', '--@]' ],
4795 or die "can't create new Text::Template object: Text::Template::ERROR";
4797 $letter_template->compile()
4798 or die "can't compile template: Text::Template::ERROR";
4800 my %letter_data = map { $_ => $self->$_ } $self->fields;
4801 $letter_data{payinfo} = $self->mask_payinfo;
4803 #my $paydate = $self->paydate || '2037-12-31';
4804 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4806 my $payby = $self->payby;
4807 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4808 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4810 #credit cards expire at the end of the month/year of their exp date
4811 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4812 $letter_data{payby} = 'credit card';
4813 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4814 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4816 }elsif ($payby eq 'COMP') {
4817 $letter_data{payby} = 'complimentary account';
4819 $letter_data{payby} = 'current method';
4821 $letter_data{expdate} = $expire_time;
4823 for (keys %{$options{extra_fields}}){
4824 $letter_data{$_} = $options{extra_fields}->{$_};
4827 unless(exists($letter_data{returnaddress})){
4828 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4829 $self->agent_template)
4831 if ( length($retadd) ) {
4832 $letter_data{returnaddress} = $retadd;
4833 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4834 $letter_data{returnaddress} =
4835 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4839 ( $conf->config('company_name', $self->agentnum),
4840 $conf->config('company_address', $self->agentnum),
4844 $letter_data{returnaddress} = '~';
4848 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4850 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4852 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4854 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4858 ) or die "can't open temp file: $!\n";
4859 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4860 or die "can't write temp file: $!\n";
4862 $letter_data{'logo_file'} = $lh->filename;
4864 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4868 ) or die "can't open temp file: $!\n";
4870 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4872 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4873 return ($1, $letter_data{'logo_file'});
4877 =item print_ps TEMPLATE
4879 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4885 my($file, $lfile) = $self->generate_letter(@_);
4886 my $ps = FS::Misc::generate_ps($file);
4887 unlink($file.'.tex');
4893 =item print TEMPLATE
4895 Prints the filled in template.
4897 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4901 sub queueable_print {
4904 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4905 or die "invalid customer number: " . $opt{custvnum};
4907 my $error = $self->print( $opt{template} );
4908 die $error if $error;
4912 my ($self, $template) = (shift, shift);
4913 do_print [ $self->print_ps($template) ];
4916 #these three subs should just go away once agent stuff is all config overrides
4918 sub agent_template {
4920 $self->_agent_plandata('agent_templatename');
4923 sub agent_invoice_from {
4925 $self->_agent_plandata('agent_invoice_from');
4928 sub _agent_plandata {
4929 my( $self, $option ) = @_;
4931 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4932 #agent-specific Conf
4934 use FS::part_event::Condition;
4936 my $agentnum = $self->agentnum;
4938 my $regexp = regexp_sql();
4940 my $part_event_option =
4942 'select' => 'part_event_option.*',
4943 'table' => 'part_event_option',
4945 LEFT JOIN part_event USING ( eventpart )
4946 LEFT JOIN part_event_option AS peo_agentnum
4947 ON ( part_event.eventpart = peo_agentnum.eventpart
4948 AND peo_agentnum.optionname = 'agentnum'
4949 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4951 LEFT JOIN part_event_condition
4952 ON ( part_event.eventpart = part_event_condition.eventpart
4953 AND part_event_condition.conditionname = 'cust_bill_age'
4955 LEFT JOIN part_event_condition_option
4956 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4957 AND part_event_condition_option.optionname = 'age'
4960 #'hashref' => { 'optionname' => $option },
4961 #'hashref' => { 'part_event_option.optionname' => $option },
4963 " WHERE part_event_option.optionname = ". dbh->quote($option).
4964 " AND action = 'cust_bill_send_agent' ".
4965 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4966 " AND peo_agentnum.optionname = 'agentnum' ".
4967 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4969 CASE WHEN part_event_condition_option.optionname IS NULL
4971 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4973 , part_event.weight".
4977 unless ( $part_event_option ) {
4978 return $self->agent->invoice_template || ''
4979 if $option eq 'agent_templatename';
4983 $part_event_option->optionvalue;
4987 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4989 Subroutine (not a method), designed to be called from the queue.
4991 Takes a list of options and values.
4993 Pulls up the customer record via the custnum option and calls bill_and_collect.
4998 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5000 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5001 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5003 $cust_main->bill_and_collect( %args );
5006 sub process_bill_and_collect {
5008 my $param = thaw(decode_base64(shift));
5009 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5010 or die "custnum '$param->{custnum}' not found!\n";
5011 $param->{'job'} = $job;
5012 $param->{'fatal'} = 1; # runs from job queue, will be caught
5013 $param->{'retry'} = 1;
5015 $cust_main->bill_and_collect( %$param );
5018 =item process_censustract_update CUSTNUM
5020 Queueable function to update the census tract to the current year (as set in
5021 the 'census_year' configuration variable) and retrieve the new tract code.
5025 sub process_censustract_update {
5026 eval "use FS::Misc::Geo qw(get_censustract)";
5028 my $custnum = shift;
5029 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
5030 or die "custnum '$custnum' not found!\n";
5032 my $new_year = $conf->config('census_year') or return;
5033 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
5034 if ( $new_tract =~ /^\d/ ) {
5035 # then it's a tract code
5036 $cust_main->set('censustract', $new_tract);
5037 $cust_main->set('censusyear', $new_year);
5038 my $error = $cust_main->replace;
5039 die $error if $error;
5042 # it's an error message
5048 sub _upgrade_data { #class method
5049 my ($class, %opts) = @_;
5052 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5053 'UPDATE cust_main SET signupdate = (SELECT signupdate FROM h_cust_main WHERE signupdate IS NOT NULL AND h_cust_main.custnum = cust_main.custnum ORDER BY historynum DESC LIMIT 1) WHERE signupdate IS NULL',
5055 # fix yyyy-m-dd formatted paydates
5056 if ( driver_name =~ /^mysql$/i ) {
5058 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5060 else { # the SQL standard
5062 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5065 foreach my $sql ( @statements ) {
5066 my $sth = dbh->prepare($sql) or die dbh->errstr;
5067 $sth->execute or die $sth->errstr;
5070 local($ignore_expired_card) = 1;
5071 local($ignore_illegal_zip) = 1;
5072 local($ignore_banned_card) = 1;
5073 local($skip_fuzzyfiles) = 1;
5074 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5075 $class->_upgrade_otaker(%opts);
5085 The delete method should possibly take an FS::cust_main object reference
5086 instead of a scalar customer number.
5088 Bill and collect options should probably be passed as references instead of a
5091 There should probably be a configuration file with a list of allowed credit
5094 No multiple currency support (probably a larger project than just this module).
5096 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5098 Birthdates rely on negative epoch values.
5100 The payby for card/check batches is broken. With mixed batching, bad
5103 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5107 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5108 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5109 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.