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
17 $skip_fuzzyfiles @fuzzyfields
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;
86 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
88 @encrypted_fields = ('payinfo', 'paycvv');
89 sub nohistory_fields { ('payinfo', 'paycvv'); }
91 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
93 #ask FS::UID to run this stuff for us later
94 #$FS::UID::callback{'FS::cust_main'} = sub {
95 install_callback FS::UID sub {
97 #yes, need it for stuff below (prolly should be cached)
102 my ( $hashref, $cache ) = @_;
103 if ( exists $hashref->{'pkgnum'} ) {
104 #@{ $self->{'_pkgnum'} } = ();
105 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
106 $self->{'_pkgnum'} = $subcache;
107 #push @{ $self->{'_pkgnum'} },
108 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
114 FS::cust_main - Object methods for cust_main records
120 $record = new FS::cust_main \%hash;
121 $record = new FS::cust_main { 'column' => 'value' };
123 $error = $record->insert;
125 $error = $new_record->replace($old_record);
127 $error = $record->delete;
129 $error = $record->check;
131 @cust_pkg = $record->all_pkgs;
133 @cust_pkg = $record->ncancelled_pkgs;
135 @cust_pkg = $record->suspended_pkgs;
137 $error = $record->bill;
138 $error = $record->bill %options;
139 $error = $record->bill 'time' => $time;
141 $error = $record->collect;
142 $error = $record->collect %options;
143 $error = $record->collect 'invoice_time' => $time,
148 An FS::cust_main object represents a customer. FS::cust_main inherits from
149 FS::Record. The following fields are currently supported:
155 Primary key (assigned automatically for new customers)
159 Agent (see L<FS::agent>)
163 Advertising source (see L<FS::part_referral>)
175 Cocial security number (optional)
191 (optional, see L<FS::cust_main_county>)
195 (see L<FS::cust_main_county>)
201 (see L<FS::cust_main_county>)
241 (optional, see L<FS::cust_main_county>)
245 (see L<FS::cust_main_county>)
251 (see L<FS::cust_main_county>)
271 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
275 Payment Information (See L<FS::payinfo_Mixin> for data format)
279 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
283 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
287 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
291 Start date month (maestro/solo cards only)
295 Start date year (maestro/solo cards only)
299 Issue number (maestro/solo cards only)
303 Name on card or billing name
307 IP address from which payment information was received
311 Tax exempt, empty or `Y'
315 Order taker (see L<FS::access_user>)
321 =item referral_custnum
323 Referring customer number
327 Enable individual CDR spooling, empty or `Y'
331 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
335 Discourage individual CDR printing, empty or `Y'
339 Allow self-service editing of ticket subjects, empty or 'Y'
341 =item calling_list_exempt
343 Do not call, empty or 'Y'
353 Creates a new customer. To add the customer to the database, see L<"insert">.
355 Note that this stores the hash reference, not a distinct copy of the hash it
356 points to. You can ask the object for a copy with the I<hash> method.
360 sub table { 'cust_main'; }
362 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
364 Adds this customer to the database. If there is an error, returns the error,
365 otherwise returns false.
367 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
368 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
369 are inserted atomicly, or the transaction is rolled back. Passing an empty
370 hash reference is equivalent to not supplying this parameter. There should be
371 a better explanation of this, but until then, here's an example:
374 tie %hash, 'Tie::RefHash'; #this part is important
376 $cust_pkg => [ $svc_acct ],
379 $cust_main->insert( \%hash );
381 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
382 be set as the invoicing list (see L<"invoicing_list">). Errors return as
383 expected and rollback the entire transaction; it is not necessary to call
384 check_invoicing_list first. The invoicing_list is set after the records in the
385 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
386 invoicing_list destination to the newly-created svc_acct. Here's an example:
388 $cust_main->insert( {}, [ $email, 'POST' ] );
390 Currently available options are: I<depend_jobnum>, I<noexport>,
391 I<tax_exemption> and I<prospectnum>.
393 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
394 on the supplied jobnum (they will not run until the specific job completes).
395 This can be used to defer provisioning until some action completes (such
396 as running the customer's credit card successfully).
398 The I<noexport> option is deprecated. If I<noexport> is set true, no
399 provisioning jobs (exports) are scheduled. (You can schedule them later with
400 the B<reexport> method.)
402 The I<tax_exemption> option can be set to an arrayref of tax names.
403 FS::cust_main_exemption records will be created and inserted.
405 If I<prospectnum> is set, moves contacts and locations from that prospect.
411 my $cust_pkgs = @_ ? shift : {};
412 my $invoicing_list = @_ ? shift : '';
414 warn "$me insert called with options ".
415 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
418 local $SIG{HUP} = 'IGNORE';
419 local $SIG{INT} = 'IGNORE';
420 local $SIG{QUIT} = 'IGNORE';
421 local $SIG{TERM} = 'IGNORE';
422 local $SIG{TSTP} = 'IGNORE';
423 local $SIG{PIPE} = 'IGNORE';
425 my $oldAutoCommit = $FS::UID::AutoCommit;
426 local $FS::UID::AutoCommit = 0;
429 my $prepay_identifier = '';
430 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
432 if ( $self->payby eq 'PREPAY' ) {
434 $self->payby('BILL');
435 $prepay_identifier = $self->payinfo;
438 warn " looking up prepaid card $prepay_identifier\n"
441 my $error = $self->get_prepay( $prepay_identifier,
442 'amount_ref' => \$amount,
443 'seconds_ref' => \$seconds,
444 'upbytes_ref' => \$upbytes,
445 'downbytes_ref' => \$downbytes,
446 'totalbytes_ref' => \$totalbytes,
449 $dbh->rollback if $oldAutoCommit;
450 #return "error applying prepaid card (transaction rolled back): $error";
454 $payby = 'PREP' if $amount;
456 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
459 $self->payby('BILL');
460 $amount = $self->paid;
464 warn " inserting $self\n"
467 $self->signupdate(time) unless $self->signupdate;
469 $self->auto_agent_custid()
470 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
472 my $error = $self->SUPER::insert;
474 $dbh->rollback if $oldAutoCommit;
475 #return "inserting cust_main record (transaction rolled back): $error";
479 warn " setting invoicing list\n"
482 if ( $invoicing_list ) {
483 $error = $self->check_invoicing_list( $invoicing_list );
485 $dbh->rollback if $oldAutoCommit;
486 #return "checking invoicing_list (transaction rolled back): $error";
489 $self->invoicing_list( $invoicing_list );
492 warn " setting customer tags\n"
495 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
496 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
497 'custnum' => $self->custnum };
498 my $error = $cust_tag->insert;
500 $dbh->rollback if $oldAutoCommit;
505 my $prospectnum = delete $options{'prospectnum'};
506 if ( $prospectnum ) {
508 warn " moving contacts and locations from prospect $prospectnum\n"
512 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
513 unless ( $prospect_main ) {
514 $dbh->rollback if $oldAutoCommit;
515 return "Unknown prospectnum $prospectnum";
517 $prospect_main->custnum($self->custnum);
518 $prospect_main->disabled('Y');
519 my $error = $prospect_main->replace;
521 $dbh->rollback if $oldAutoCommit;
525 my @contact = $prospect_main->contact;
526 my @cust_location = $prospect_main->cust_location;
527 my @qual = $prospect_main->qual;
529 foreach my $r ( @contact, @cust_location, @qual ) {
531 $r->custnum($self->custnum);
532 my $error = $r->replace;
534 $dbh->rollback if $oldAutoCommit;
541 warn " setting cust_main_exemption\n"
544 my $tax_exemption = delete $options{'tax_exemption'};
545 if ( $tax_exemption ) {
546 foreach my $taxname ( @$tax_exemption ) {
547 my $cust_main_exemption = new FS::cust_main_exemption {
548 'custnum' => $self->custnum,
549 'taxname' => $taxname,
551 my $error = $cust_main_exemption->insert;
553 $dbh->rollback if $oldAutoCommit;
554 return "inserting cust_main_exemption (transaction rolled back): $error";
559 if ( $self->can('start_copy_skel') ) {
560 my $error = $self->start_copy_skel;
562 $dbh->rollback if $oldAutoCommit;
567 warn " ordering packages\n"
570 $error = $self->order_pkgs( $cust_pkgs,
572 'seconds_ref' => \$seconds,
573 'upbytes_ref' => \$upbytes,
574 'downbytes_ref' => \$downbytes,
575 'totalbytes_ref' => \$totalbytes,
578 $dbh->rollback if $oldAutoCommit;
583 $dbh->rollback if $oldAutoCommit;
584 return "No svc_acct record to apply pre-paid time";
586 if ( $upbytes || $downbytes || $totalbytes ) {
587 $dbh->rollback if $oldAutoCommit;
588 return "No svc_acct record to apply pre-paid data";
592 warn " inserting initial $payby payment of $amount\n"
594 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
596 $dbh->rollback if $oldAutoCommit;
597 return "inserting payment (transaction rolled back): $error";
601 unless ( $import || $skip_fuzzyfiles ) {
602 warn " queueing fuzzyfiles update\n"
604 $error = $self->queue_fuzzyfiles_update;
606 $dbh->rollback if $oldAutoCommit;
607 return "updating fuzzy search cache: $error";
612 warn " exporting\n" if $DEBUG > 1;
614 my $export_args = $options{'export_args'} || [];
617 map qsearch( 'part_export', {exportnum=>$_} ),
618 $conf->config('cust_main-exports'); #, $agentnum
620 foreach my $part_export ( @part_export ) {
621 my $error = $part_export->export_insert($self, @$export_args);
623 $dbh->rollback if $oldAutoCommit;
624 return "exporting to ". $part_export->exporttype.
625 " (transaction rolled back): $error";
629 #foreach my $depend_jobnum ( @$depend_jobnums ) {
630 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
632 # foreach my $jobnum ( @jobnums ) {
633 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
634 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
636 # my $error = $queue->depend_insert($depend_jobnum);
638 # $dbh->rollback if $oldAutoCommit;
639 # return "error queuing job dependancy: $error";
646 #if ( exists $options{'jobnums'} ) {
647 # push @{ $options{'jobnums'} }, @jobnums;
650 warn " insert complete; committing transaction\n"
653 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
658 use File::CounterFile;
659 sub auto_agent_custid {
662 my $format = $conf->config('cust_main-auto_agent_custid');
664 if ( $format eq '1YMMXXXXXXXX' ) {
666 my $counter = new File::CounterFile 'cust_main.agent_custid';
669 my $ym = 100000000000 + time2str('%y%m00000000', time);
670 if ( $ym > $counter->value ) {
671 $counter->{'value'} = $agent_custid = $ym;
672 $counter->{'updated'} = 1;
674 $agent_custid = $counter->inc;
680 die "Unknown cust_main-auto_agent_custid format: $format";
683 $self->agent_custid($agent_custid);
687 =item PACKAGE METHODS
689 Documentation on customer package methods has been moved to
690 L<FS::cust_main::Packages>.
692 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
694 Recharges this (existing) customer with the specified prepaid card (see
695 L<FS::prepay_credit>), specified either by I<identifier> or as an
696 FS::prepay_credit object. If there is an error, returns the error, otherwise
699 Optionally, five scalar references can be passed as well. They will have their
700 values filled in with the amount, number of seconds, and number of upload,
701 download, and total bytes applied by this prepaid card.
705 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
706 #the only place that uses these args
707 sub recharge_prepay {
708 my( $self, $prepay_credit, $amountref, $secondsref,
709 $upbytesref, $downbytesref, $totalbytesref ) = @_;
711 local $SIG{HUP} = 'IGNORE';
712 local $SIG{INT} = 'IGNORE';
713 local $SIG{QUIT} = 'IGNORE';
714 local $SIG{TERM} = 'IGNORE';
715 local $SIG{TSTP} = 'IGNORE';
716 local $SIG{PIPE} = 'IGNORE';
718 my $oldAutoCommit = $FS::UID::AutoCommit;
719 local $FS::UID::AutoCommit = 0;
722 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
724 my $error = $self->get_prepay( $prepay_credit,
725 'amount_ref' => \$amount,
726 'seconds_ref' => \$seconds,
727 'upbytes_ref' => \$upbytes,
728 'downbytes_ref' => \$downbytes,
729 'totalbytes_ref' => \$totalbytes,
731 || $self->increment_seconds($seconds)
732 || $self->increment_upbytes($upbytes)
733 || $self->increment_downbytes($downbytes)
734 || $self->increment_totalbytes($totalbytes)
735 || $self->insert_cust_pay_prepay( $amount,
737 ? $prepay_credit->identifier
742 $dbh->rollback if $oldAutoCommit;
746 if ( defined($amountref) ) { $$amountref = $amount; }
747 if ( defined($secondsref) ) { $$secondsref = $seconds; }
748 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
749 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
750 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
752 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
757 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
759 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
760 specified either by I<identifier> or as an FS::prepay_credit object.
762 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
763 incremented by the values of the prepaid card.
765 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
766 check or set this customer's I<agentnum>.
768 If there is an error, returns the error, otherwise returns false.
774 my( $self, $prepay_credit, %opt ) = @_;
776 local $SIG{HUP} = 'IGNORE';
777 local $SIG{INT} = 'IGNORE';
778 local $SIG{QUIT} = 'IGNORE';
779 local $SIG{TERM} = 'IGNORE';
780 local $SIG{TSTP} = 'IGNORE';
781 local $SIG{PIPE} = 'IGNORE';
783 my $oldAutoCommit = $FS::UID::AutoCommit;
784 local $FS::UID::AutoCommit = 0;
787 unless ( ref($prepay_credit) ) {
789 my $identifier = $prepay_credit;
791 $prepay_credit = qsearchs(
793 { 'identifier' => $identifier },
798 unless ( $prepay_credit ) {
799 $dbh->rollback if $oldAutoCommit;
800 return "Invalid prepaid card: ". $identifier;
805 if ( $prepay_credit->agentnum ) {
806 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
807 $dbh->rollback if $oldAutoCommit;
808 return "prepaid card not valid for agent ". $self->agentnum;
810 $self->agentnum($prepay_credit->agentnum);
813 my $error = $prepay_credit->delete;
815 $dbh->rollback if $oldAutoCommit;
816 return "removing prepay_credit (transaction rolled back): $error";
819 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
820 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
822 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
827 =item increment_upbytes SECONDS
829 Updates this customer's single or primary account (see L<FS::svc_acct>) by
830 the specified number of upbytes. If there is an error, returns the error,
831 otherwise returns false.
835 sub increment_upbytes {
836 _increment_column( shift, 'upbytes', @_);
839 =item increment_downbytes SECONDS
841 Updates this customer's single or primary account (see L<FS::svc_acct>) by
842 the specified number of downbytes. If there is an error, returns the error,
843 otherwise returns false.
847 sub increment_downbytes {
848 _increment_column( shift, 'downbytes', @_);
851 =item increment_totalbytes SECONDS
853 Updates this customer's single or primary account (see L<FS::svc_acct>) by
854 the specified number of totalbytes. If there is an error, returns the error,
855 otherwise returns false.
859 sub increment_totalbytes {
860 _increment_column( shift, 'totalbytes', @_);
863 =item increment_seconds SECONDS
865 Updates this customer's single or primary account (see L<FS::svc_acct>) by
866 the specified number of seconds. If there is an error, returns the error,
867 otherwise returns false.
871 sub increment_seconds {
872 _increment_column( shift, 'seconds', @_);
875 =item _increment_column AMOUNT
877 Updates this customer's single or primary account (see L<FS::svc_acct>) by
878 the specified number of seconds or bytes. If there is an error, returns
879 the error, otherwise returns false.
883 sub _increment_column {
884 my( $self, $column, $amount ) = @_;
885 warn "$me increment_column called: $column, $amount\n"
888 return '' unless $amount;
890 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
891 $self->ncancelled_pkgs;
894 return 'No packages with primary or single services found'.
895 ' to apply pre-paid time';
896 } elsif ( scalar(@cust_pkg) > 1 ) {
897 #maybe have a way to specify the package/account?
898 return 'Multiple packages found to apply pre-paid time';
901 my $cust_pkg = $cust_pkg[0];
902 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
906 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
909 return 'No account found to apply pre-paid time';
910 } elsif ( scalar(@cust_svc) > 1 ) {
911 return 'Multiple accounts found to apply pre-paid time';
914 my $svc_acct = $cust_svc[0]->svc_x;
915 warn " found service svcnum ". $svc_acct->pkgnum.
916 ' ('. $svc_acct->email. ")\n"
919 $column = "increment_$column";
920 $svc_acct->$column($amount);
924 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
926 Inserts a prepayment in the specified amount for this customer. An optional
927 second argument can specify the prepayment identifier for tracking purposes.
928 If there is an error, returns the error, otherwise returns false.
932 sub insert_cust_pay_prepay {
933 shift->insert_cust_pay('PREP', @_);
936 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
938 Inserts a cash payment in the specified amount for this customer. An optional
939 second argument can specify the payment identifier for tracking purposes.
940 If there is an error, returns the error, otherwise returns false.
944 sub insert_cust_pay_cash {
945 shift->insert_cust_pay('CASH', @_);
948 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
950 Inserts a Western Union payment in the specified amount for this customer. An
951 optional second argument can specify the prepayment identifier for tracking
952 purposes. If there is an error, returns the error, otherwise returns false.
956 sub insert_cust_pay_west {
957 shift->insert_cust_pay('WEST', @_);
960 sub insert_cust_pay {
961 my( $self, $payby, $amount ) = splice(@_, 0, 3);
962 my $payinfo = scalar(@_) ? shift : '';
964 my $cust_pay = new FS::cust_pay {
965 'custnum' => $self->custnum,
966 'paid' => sprintf('%.2f', $amount),
967 #'_date' => #date the prepaid card was purchased???
969 'payinfo' => $payinfo,
977 This method is deprecated. See the I<depend_jobnum> option to the insert and
978 order_pkgs methods for a better way to defer provisioning.
980 Re-schedules all exports by calling the B<reexport> method of all associated
981 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
982 otherwise returns false.
989 carp "WARNING: FS::cust_main::reexport is deprectated; ".
990 "use the depend_jobnum option to insert or order_pkgs to delay export";
992 local $SIG{HUP} = 'IGNORE';
993 local $SIG{INT} = 'IGNORE';
994 local $SIG{QUIT} = 'IGNORE';
995 local $SIG{TERM} = 'IGNORE';
996 local $SIG{TSTP} = 'IGNORE';
997 local $SIG{PIPE} = 'IGNORE';
999 my $oldAutoCommit = $FS::UID::AutoCommit;
1000 local $FS::UID::AutoCommit = 0;
1003 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1004 my $error = $cust_pkg->reexport;
1006 $dbh->rollback if $oldAutoCommit;
1011 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1016 =item delete [ OPTION => VALUE ... ]
1018 This deletes the customer. If there is an error, returns the error, otherwise
1021 This will completely remove all traces of the customer record. This is not
1022 what you want when a customer cancels service; for that, cancel all of the
1023 customer's packages (see L</cancel>).
1025 If the customer has any uncancelled packages, you need to pass a new (valid)
1026 customer number for those packages to be transferred to, as the "new_customer"
1027 option. Cancelled packages will be deleted. Did I mention that this is NOT
1028 what you want when a customer cancels service and that you really should be
1029 looking at L<FS::cust_pkg/cancel>?
1031 You can't delete a customer with invoices (see L<FS::cust_bill>),
1032 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1033 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1034 set the "delete_financials" option to a true value.
1039 my( $self, %opt ) = @_;
1041 local $SIG{HUP} = 'IGNORE';
1042 local $SIG{INT} = 'IGNORE';
1043 local $SIG{QUIT} = 'IGNORE';
1044 local $SIG{TERM} = 'IGNORE';
1045 local $SIG{TSTP} = 'IGNORE';
1046 local $SIG{PIPE} = 'IGNORE';
1048 my $oldAutoCommit = $FS::UID::AutoCommit;
1049 local $FS::UID::AutoCommit = 0;
1052 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1053 $dbh->rollback if $oldAutoCommit;
1054 return "Can't delete a master agent customer";
1057 #use FS::access_user
1058 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1059 $dbh->rollback if $oldAutoCommit;
1060 return "Can't delete a master employee customer";
1063 tie my %financial_tables, 'Tie::IxHash',
1064 'cust_bill' => 'invoices',
1065 'cust_statement' => 'statements',
1066 'cust_credit' => 'credits',
1067 'cust_pay' => 'payments',
1068 'cust_refund' => 'refunds',
1071 foreach my $table ( keys %financial_tables ) {
1073 my @records = $self->$table();
1075 if ( @records && ! $opt{'delete_financials'} ) {
1076 $dbh->rollback if $oldAutoCommit;
1077 return "Can't delete a customer with ". $financial_tables{$table};
1080 foreach my $record ( @records ) {
1081 my $error = $record->delete;
1083 $dbh->rollback if $oldAutoCommit;
1084 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1090 my @cust_pkg = $self->ncancelled_pkgs;
1092 my $new_custnum = $opt{'new_custnum'};
1093 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1094 $dbh->rollback if $oldAutoCommit;
1095 return "Invalid new customer number: $new_custnum";
1097 foreach my $cust_pkg ( @cust_pkg ) {
1098 my %hash = $cust_pkg->hash;
1099 $hash{'custnum'} = $new_custnum;
1100 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1101 my $error = $new_cust_pkg->replace($cust_pkg,
1102 options => { $cust_pkg->options },
1105 $dbh->rollback if $oldAutoCommit;
1110 my @cancelled_cust_pkg = $self->all_pkgs;
1111 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1112 my $error = $cust_pkg->delete;
1114 $dbh->rollback if $oldAutoCommit;
1119 #cust_tax_adjustment in financials?
1120 #cust_pay_pending? ouch
1122 foreach my $table (qw(
1123 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1124 cust_location cust_main_note cust_tax_adjustment
1125 cust_pay_void cust_pay_batch queue cust_tax_exempt
1127 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1128 my $error = $record->delete;
1130 $dbh->rollback if $oldAutoCommit;
1136 my $sth = $dbh->prepare(
1137 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1139 my $errstr = $dbh->errstr;
1140 $dbh->rollback if $oldAutoCommit;
1143 $sth->execute($self->custnum) or do {
1144 my $errstr = $sth->errstr;
1145 $dbh->rollback if $oldAutoCommit;
1151 my $ticket_dbh = '';
1152 if ($conf->config('ticket_system') eq 'RT_Internal') {
1154 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1155 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1156 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1157 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1160 if ( $ticket_dbh ) {
1162 my $ticket_sth = $ticket_dbh->prepare(
1163 'DELETE FROM Links WHERE Target = ?'
1165 my $errstr = $ticket_dbh->errstr;
1166 $dbh->rollback if $oldAutoCommit;
1169 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1171 my $errstr = $ticket_sth->errstr;
1172 $dbh->rollback if $oldAutoCommit;
1176 #check and see if the customer is the only link on the ticket, and
1177 #if so, set the ticket to deleted status in RT?
1178 #maybe someday, for now this will at least fix tickets not displaying
1182 #delete the customer record
1184 my $error = $self->SUPER::delete;
1186 $dbh->rollback if $oldAutoCommit;
1190 # cust_main exports!
1192 #my $export_args = $options{'export_args'} || [];
1195 map qsearch( 'part_export', {exportnum=>$_} ),
1196 $conf->config('cust_main-exports'); #, $agentnum
1198 foreach my $part_export ( @part_export ) {
1199 my $error = $part_export->export_delete( $self ); #, @$export_args);
1201 $dbh->rollback if $oldAutoCommit;
1202 return "exporting to ". $part_export->exporttype.
1203 " (transaction rolled back): $error";
1207 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1212 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1214 This merges this customer into the provided new custnum, and then deletes the
1215 customer. If there is an error, returns the error, otherwise returns false.
1217 The source customer's name, company name, phone numbers, agent,
1218 referring customer, customer class, advertising source, order taker, and
1219 billing information (except balance) are discarded.
1221 All packages are moved to the target customer. Packages with package locations
1222 are preserved. Packages without package locations are moved to a new package
1223 location with the source customer's service/shipping address.
1225 All invoices, statements, payments, credits and refunds are moved to the target
1226 customer. The source customer's balance is added to the target customer.
1228 All notes, attachments, tickets and customer tags are moved to the target
1231 Change history is not currently moved.
1236 my( $self, $new_custnum, %opt ) = @_;
1238 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1240 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1241 return "Invalid new customer number: $new_custnum";
1244 local $SIG{HUP} = 'IGNORE';
1245 local $SIG{INT} = 'IGNORE';
1246 local $SIG{QUIT} = 'IGNORE';
1247 local $SIG{TERM} = 'IGNORE';
1248 local $SIG{TSTP} = 'IGNORE';
1249 local $SIG{PIPE} = 'IGNORE';
1251 my $oldAutoCommit = $FS::UID::AutoCommit;
1252 local $FS::UID::AutoCommit = 0;
1255 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1256 $dbh->rollback if $oldAutoCommit;
1257 return "Can't merge a master agent customer";
1260 #use FS::access_user
1261 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1262 $dbh->rollback if $oldAutoCommit;
1263 return "Can't merge a master employee customer";
1266 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1267 'status' => { op=>'!=', value=>'done' },
1271 $dbh->rollback if $oldAutoCommit;
1272 return "Can't merge a customer with pending payments";
1275 tie my %financial_tables, 'Tie::IxHash',
1276 'cust_bill' => 'invoices',
1277 'cust_statement' => 'statements',
1278 'cust_credit' => 'credits',
1279 'cust_pay' => 'payments',
1280 'cust_pay_void' => 'voided payments',
1281 'cust_refund' => 'refunds',
1284 foreach my $table ( keys %financial_tables ) {
1286 my @records = $self->$table();
1288 foreach my $record ( @records ) {
1289 $record->custnum($new_custnum);
1290 my $error = $record->replace;
1292 $dbh->rollback if $oldAutoCommit;
1293 return "Error merging ". $financial_tables{$table}. ": $error\n";
1299 my $name = $self->ship_name;
1301 my $locationnum = '';
1302 foreach my $cust_pkg ( $self->all_pkgs ) {
1303 $cust_pkg->custnum($new_custnum);
1305 unless ( $cust_pkg->locationnum ) {
1306 unless ( $locationnum ) {
1307 my $cust_location = new FS::cust_location {
1308 $self->location_hash,
1309 'custnum' => $new_custnum,
1311 my $error = $cust_location->insert;
1313 $dbh->rollback if $oldAutoCommit;
1316 $locationnum = $cust_location->locationnum;
1318 $cust_pkg->locationnum($locationnum);
1321 my $error = $cust_pkg->replace;
1323 $dbh->rollback if $oldAutoCommit;
1327 # add customer (ship) name to svc_phone.phone_name if blank
1328 my @cust_svc = $cust_pkg->cust_svc;
1329 foreach my $cust_svc (@cust_svc) {
1330 my($label, $value, $svcdb) = $cust_svc->label;
1331 next unless $svcdb eq 'svc_phone';
1332 my $svc_phone = $cust_svc->svc_x;
1333 next if $svc_phone->phone_name;
1334 $svc_phone->phone_name($name);
1335 my $error = $svc_phone->replace;
1337 $dbh->rollback if $oldAutoCommit;
1345 # cust_tax_exempt (texas tax exemptions)
1346 # cust_recon (some sort of not-well understood thing for OnPac)
1348 #these are moved over
1349 foreach my $table (qw(
1350 cust_tag cust_location contact cust_attachment cust_main_note
1351 cust_tax_adjustment cust_pay_batch queue
1353 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1354 $record->custnum($new_custnum);
1355 my $error = $record->replace;
1357 $dbh->rollback if $oldAutoCommit;
1363 #these aren't preserved
1364 foreach my $table (qw(
1365 cust_main_exemption cust_main_invoice
1367 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1368 my $error = $record->delete;
1370 $dbh->rollback if $oldAutoCommit;
1377 my $sth = $dbh->prepare(
1378 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1380 my $errstr = $dbh->errstr;
1381 $dbh->rollback if $oldAutoCommit;
1384 $sth->execute($new_custnum, $self->custnum) or do {
1385 my $errstr = $sth->errstr;
1386 $dbh->rollback if $oldAutoCommit;
1392 my $ticket_dbh = '';
1393 if ($conf->config('ticket_system') eq 'RT_Internal') {
1395 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1396 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1397 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1398 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1401 if ( $ticket_dbh ) {
1403 my $ticket_sth = $ticket_dbh->prepare(
1404 'UPDATE Links SET Target = ? WHERE Target = ?'
1406 my $errstr = $ticket_dbh->errstr;
1407 $dbh->rollback if $oldAutoCommit;
1410 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1411 'freeside://freeside/cust_main/'.$self->custnum)
1413 my $errstr = $ticket_sth->errstr;
1414 $dbh->rollback if $oldAutoCommit;
1420 #delete the customer record
1422 my $error = $self->delete;
1424 $dbh->rollback if $oldAutoCommit;
1428 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1433 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1436 Replaces the OLD_RECORD with this one in the database. If there is an error,
1437 returns the error, otherwise returns false.
1439 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1440 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1441 expected and rollback the entire transaction; it is not necessary to call
1442 check_invoicing_list first. Here's an example:
1444 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1446 Currently available options are: I<tax_exemption>.
1448 The I<tax_exemption> option can be set to an arrayref of tax names.
1449 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1456 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1458 : $self->replace_old;
1462 warn "$me replace called\n"
1465 my $curuser = $FS::CurrentUser::CurrentUser;
1466 if ( $self->payby eq 'COMP'
1467 && $self->payby ne $old->payby
1468 && ! $curuser->access_right('Complimentary customer')
1471 return "You are not permitted to create complimentary accounts.";
1474 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1475 && $conf->exists('enable_taxproducts')
1478 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1480 $self->set('geocode', '')
1481 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1482 && length($self->get($pre.'zip')) >= 10;
1485 local($ignore_expired_card) = 1
1486 if $old->payby =~ /^(CARD|DCRD)$/
1487 && $self->payby =~ /^(CARD|DCRD)$/
1488 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1490 local($ignore_banned_card) = 1
1491 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1492 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1493 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1495 local $SIG{HUP} = 'IGNORE';
1496 local $SIG{INT} = 'IGNORE';
1497 local $SIG{QUIT} = 'IGNORE';
1498 local $SIG{TERM} = 'IGNORE';
1499 local $SIG{TSTP} = 'IGNORE';
1500 local $SIG{PIPE} = 'IGNORE';
1502 my $oldAutoCommit = $FS::UID::AutoCommit;
1503 local $FS::UID::AutoCommit = 0;
1506 my $error = $self->SUPER::replace($old);
1509 $dbh->rollback if $oldAutoCommit;
1513 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1514 my $invoicing_list = shift @param;
1515 $error = $self->check_invoicing_list( $invoicing_list );
1517 $dbh->rollback if $oldAutoCommit;
1520 $self->invoicing_list( $invoicing_list );
1523 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1525 #this could be more efficient than deleting and re-inserting, if it matters
1526 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1527 my $error = $cust_tag->delete;
1529 $dbh->rollback if $oldAutoCommit;
1533 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1534 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1535 'custnum' => $self->custnum };
1536 my $error = $cust_tag->insert;
1538 $dbh->rollback if $oldAutoCommit;
1545 my %options = @param;
1547 my $tax_exemption = delete $options{'tax_exemption'};
1548 if ( $tax_exemption ) {
1550 my %cust_main_exemption =
1551 map { $_->taxname => $_ }
1552 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1554 foreach my $taxname ( @$tax_exemption ) {
1556 next if delete $cust_main_exemption{$taxname};
1558 my $cust_main_exemption = new FS::cust_main_exemption {
1559 'custnum' => $self->custnum,
1560 'taxname' => $taxname,
1562 my $error = $cust_main_exemption->insert;
1564 $dbh->rollback if $oldAutoCommit;
1565 return "inserting cust_main_exemption (transaction rolled back): $error";
1569 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1570 my $error = $cust_main_exemption->delete;
1572 $dbh->rollback if $oldAutoCommit;
1573 return "deleting cust_main_exemption (transaction rolled back): $error";
1579 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1580 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1581 && $self->get('payinfo') !~ /^99\d{14}$/
1583 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1588 # card/check/lec info has changed, want to retry realtime_ invoice events
1589 my $error = $self->retry_realtime;
1591 $dbh->rollback if $oldAutoCommit;
1596 unless ( $import || $skip_fuzzyfiles ) {
1597 $error = $self->queue_fuzzyfiles_update;
1599 $dbh->rollback if $oldAutoCommit;
1600 return "updating fuzzy search cache: $error";
1604 # cust_main exports!
1606 my $export_args = $options{'export_args'} || [];
1609 map qsearch( 'part_export', {exportnum=>$_} ),
1610 $conf->config('cust_main-exports'); #, $agentnum
1612 foreach my $part_export ( @part_export ) {
1613 my $error = $part_export->export_replace( $self, $old, @$export_args);
1615 $dbh->rollback if $oldAutoCommit;
1616 return "exporting to ". $part_export->exporttype.
1617 " (transaction rolled back): $error";
1621 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1626 =item queue_fuzzyfiles_update
1628 Used by insert & replace to update the fuzzy search cache
1632 sub queue_fuzzyfiles_update {
1635 local $SIG{HUP} = 'IGNORE';
1636 local $SIG{INT} = 'IGNORE';
1637 local $SIG{QUIT} = 'IGNORE';
1638 local $SIG{TERM} = 'IGNORE';
1639 local $SIG{TSTP} = 'IGNORE';
1640 local $SIG{PIPE} = 'IGNORE';
1642 my $oldAutoCommit = $FS::UID::AutoCommit;
1643 local $FS::UID::AutoCommit = 0;
1646 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1647 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1649 $dbh->rollback if $oldAutoCommit;
1650 return "queueing job (transaction rolled back): $error";
1653 if ( $self->ship_last ) {
1654 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1655 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1657 $dbh->rollback if $oldAutoCommit;
1658 return "queueing job (transaction rolled back): $error";
1662 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1669 Checks all fields to make sure this is a valid customer record. If there is
1670 an error, returns the error, otherwise returns false. Called by the insert
1671 and replace methods.
1678 warn "$me check BEFORE: \n". $self->_dump
1682 $self->ut_numbern('custnum')
1683 || $self->ut_number('agentnum')
1684 || $self->ut_textn('agent_custid')
1685 || $self->ut_number('refnum')
1686 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1687 || $self->ut_textn('custbatch')
1688 || $self->ut_name('last')
1689 || $self->ut_name('first')
1690 || $self->ut_snumbern('birthdate')
1691 || $self->ut_snumbern('signupdate')
1692 || $self->ut_textn('company')
1693 || $self->ut_text('address1')
1694 || $self->ut_textn('address2')
1695 || $self->ut_text('city')
1696 || $self->ut_textn('county')
1697 || $self->ut_textn('state')
1698 || $self->ut_country('country')
1699 || $self->ut_anything('comments')
1700 || $self->ut_numbern('referral_custnum')
1701 || $self->ut_textn('stateid')
1702 || $self->ut_textn('stateid_state')
1703 || $self->ut_textn('invoice_terms')
1704 || $self->ut_alphan('geocode')
1705 || $self->ut_floatn('cdr_termination_percentage')
1706 || $self->ut_floatn('credit_limit')
1707 || $self->ut_numbern('billday')
1708 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1709 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1710 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1713 #barf. need message catalogs. i18n. etc.
1714 $error .= "Please select an advertising source."
1715 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1716 return $error if $error;
1718 return "Unknown agent"
1719 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1721 return "Unknown refnum"
1722 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1724 return "Unknown referring custnum: ". $self->referral_custnum
1725 unless ! $self->referral_custnum
1726 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1728 if ( $self->censustract ne '' ) {
1729 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1730 or return "Illegal census tract: ". $self->censustract;
1732 $self->censustract("$1.$2");
1735 if ( $self->ss eq '' ) {
1740 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1741 or return "Illegal social security number: ". $self->ss;
1742 $self->ss("$1-$2-$3");
1746 # bad idea to disable, causes billing to fail because of no tax rates later
1747 # except we don't fail any more
1748 unless ( $import ) {
1749 unless ( qsearch('cust_main_county', {
1750 'country' => $self->country,
1753 return "Unknown state/county/country: ".
1754 $self->state. "/". $self->county. "/". $self->country
1755 unless qsearch('cust_main_county',{
1756 'state' => $self->state,
1757 'county' => $self->county,
1758 'country' => $self->country,
1764 $self->ut_phonen('daytime', $self->country)
1765 || $self->ut_phonen('night', $self->country)
1766 || $self->ut_phonen('fax', $self->country)
1767 || $self->ut_phonen('mobile', $self->country)
1769 return $error if $error;
1771 unless ( $ignore_illegal_zip ) {
1772 $error = $self->ut_zip('zip', $self->country);
1773 return $error if $error;
1776 if ( $conf->exists('cust_main-require_phone')
1777 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1780 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1782 : FS::Msgcat::_gettext('daytime');
1783 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1785 : FS::Msgcat::_gettext('night');
1787 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1789 : FS::Msgcat::_gettext('mobile');
1791 return "$daytime_label, $night_label or $mobile_label is required"
1795 if ( $self->has_ship_address
1796 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1797 $self->addr_fields )
1801 $self->ut_name('ship_last')
1802 || $self->ut_name('ship_first')
1803 || $self->ut_textn('ship_company')
1804 || $self->ut_text('ship_address1')
1805 || $self->ut_textn('ship_address2')
1806 || $self->ut_text('ship_city')
1807 || $self->ut_textn('ship_county')
1808 || $self->ut_textn('ship_state')
1809 || $self->ut_country('ship_country')
1811 return $error if $error;
1813 #false laziness with above
1814 unless ( qsearchs('cust_main_county', {
1815 'country' => $self->ship_country,
1818 return "Unknown ship_state/ship_county/ship_country: ".
1819 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1820 unless qsearch('cust_main_county',{
1821 'state' => $self->ship_state,
1822 'county' => $self->ship_county,
1823 'country' => $self->ship_country,
1829 $self->ut_phonen('ship_daytime', $self->ship_country)
1830 || $self->ut_phonen('ship_night', $self->ship_country)
1831 || $self->ut_phonen('ship_fax', $self->ship_country)
1832 || $self->ut_phonen('ship_mobile', $self->ship_country)
1834 return $error if $error;
1836 unless ( $ignore_illegal_zip ) {
1837 $error = $self->ut_zip('ship_zip', $self->ship_country);
1838 return $error if $error;
1840 return "Unit # is required."
1841 if $self->ship_address2 =~ /^\s*$/
1842 && $conf->exists('cust_main-require_address2');
1844 } else { # ship_ info eq billing info, so don't store dup info in database
1846 $self->setfield("ship_$_", '')
1847 foreach $self->addr_fields;
1849 return "Unit # is required."
1850 if $self->address2 =~ /^\s*$/
1851 && $conf->exists('cust_main-require_address2');
1855 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1856 # or return "Illegal payby: ". $self->payby;
1858 FS::payby->can_payby($self->table, $self->payby)
1859 or return "Illegal payby: ". $self->payby;
1861 $error = $self->ut_numbern('paystart_month')
1862 || $self->ut_numbern('paystart_year')
1863 || $self->ut_numbern('payissue')
1864 || $self->ut_textn('paytype')
1866 return $error if $error;
1868 if ( $self->payip eq '' ) {
1871 $error = $self->ut_ip('payip');
1872 return $error if $error;
1875 # If it is encrypted and the private key is not availaible then we can't
1876 # check the credit card.
1877 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1879 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1881 my $payinfo = $self->payinfo;
1882 $payinfo =~ s/\D//g;
1883 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1884 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1886 $self->payinfo($payinfo);
1888 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1890 return gettext('unknown_card_type')
1891 if $self->payinfo !~ /^99\d{14}$/ #token
1892 && cardtype($self->payinfo) eq "Unknown";
1894 unless ( $ignore_banned_card ) {
1895 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1897 if ( $ban->bantype eq 'warn' ) {
1898 #or others depending on value of $ban->reason ?
1899 return '_duplicate_card'.
1900 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1901 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1902 ' (ban# '. $ban->bannum. ')'
1903 unless $self->override_ban_warn;
1905 return 'Banned credit card: banned on '.
1906 time2str('%a %h %o at %r', $ban->_date).
1907 ' by '. $ban->otaker.
1908 ' (ban# '. $ban->bannum. ')';
1913 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1914 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1915 $self->paycvv =~ /^(\d{4})$/
1916 or return "CVV2 (CID) for American Express cards is four digits.";
1919 $self->paycvv =~ /^(\d{3})$/
1920 or return "CVV2 (CVC2/CID) is three digits.";
1927 my $cardtype = cardtype($payinfo);
1928 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1930 return "Start date or issue number is required for $cardtype cards"
1931 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1933 return "Start month must be between 1 and 12"
1934 if $self->paystart_month
1935 and $self->paystart_month < 1 || $self->paystart_month > 12;
1937 return "Start year must be 1990 or later"
1938 if $self->paystart_year
1939 and $self->paystart_year < 1990;
1941 return "Issue number must be beween 1 and 99"
1943 and $self->payissue < 1 || $self->payissue > 99;
1946 $self->paystart_month('');
1947 $self->paystart_year('');
1948 $self->payissue('');
1951 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1953 my $payinfo = $self->payinfo;
1954 $payinfo =~ s/[^\d\@\.]//g;
1955 if ( $conf->exists('cust_main-require-bank-branch') ) {
1956 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
1957 $payinfo = "$1\@$2.$3";
1958 } elsif ( $conf->exists('echeck-nonus') ) {
1959 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1960 $payinfo = "$1\@$2";
1962 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1963 $payinfo = "$1\@$2";
1965 $self->payinfo($payinfo);
1968 unless ( $ignore_banned_card ) {
1969 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1971 if ( $ban->bantype eq 'warn' ) {
1972 #or others depending on value of $ban->reason ?
1973 return '_duplicate_ach' unless $self->override_ban_warn;
1975 return 'Banned ACH account: banned on '.
1976 time2str('%a %h %o at %r', $ban->_date).
1977 ' by '. $ban->otaker.
1978 ' (ban# '. $ban->bannum. ')';
1983 } elsif ( $self->payby eq 'LECB' ) {
1985 my $payinfo = $self->payinfo;
1986 $payinfo =~ s/\D//g;
1987 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1989 $self->payinfo($payinfo);
1992 } elsif ( $self->payby eq 'BILL' ) {
1994 $error = $self->ut_textn('payinfo');
1995 return "Illegal P.O. number: ". $self->payinfo if $error;
1998 } elsif ( $self->payby eq 'COMP' ) {
2000 my $curuser = $FS::CurrentUser::CurrentUser;
2001 if ( ! $self->custnum
2002 && ! $curuser->access_right('Complimentary customer')
2005 return "You are not permitted to create complimentary accounts."
2008 $error = $self->ut_textn('payinfo');
2009 return "Illegal comp account issuer: ". $self->payinfo if $error;
2012 } elsif ( $self->payby eq 'PREPAY' ) {
2014 my $payinfo = $self->payinfo;
2015 $payinfo =~ s/\W//g; #anything else would just confuse things
2016 $self->payinfo($payinfo);
2017 $error = $self->ut_alpha('payinfo');
2018 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2019 return "Unknown prepayment identifier"
2020 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2025 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2026 return "Expiration date required"
2027 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2031 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2032 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2033 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2034 ( $m, $y ) = ( $2, "19$1" );
2035 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2036 ( $m, $y ) = ( $3, "20$2" );
2038 return "Illegal expiration date: ". $self->paydate;
2040 $m = sprintf('%02d',$m);
2041 $self->paydate("$y-$m-01");
2042 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2043 return gettext('expired_card')
2045 && !$ignore_expired_card
2046 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2049 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2050 ( ! $conf->exists('require_cardname')
2051 || $self->payby !~ /^(CARD|DCRD)$/ )
2053 $self->payname( $self->first. " ". $self->getfield('last') );
2055 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2056 or return gettext('illegal_name'). " payname: ". $self->payname;
2060 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2061 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2065 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2067 warn "$me check AFTER: \n". $self->_dump
2070 $self->SUPER::check;
2075 Returns a list of fields which have ship_ duplicates.
2080 qw( last first company
2081 address1 address2 city county state zip country
2082 daytime night fax mobile
2086 =item has_ship_address
2088 Returns true if this customer record has a separate shipping address.
2092 sub has_ship_address {
2094 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2099 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2100 city, county, state, zip, country, and geocode. The shipping address is used if present.
2106 Returns all locations (see L<FS::cust_location>) for this customer.
2112 qsearch('cust_location', { 'custnum' => $self->custnum } );
2117 Returns all contacts (see L<FS::contact>) for this customer.
2121 #already used :/ sub contact {
2124 qsearch('contact', { 'custnum' => $self->custnum } );
2129 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2130 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2131 on success or a list of errors.
2137 grep { $_->unsuspend } $self->suspended_pkgs;
2142 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2144 Returns a list: an empty list on success or a list of errors.
2150 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2153 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2155 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2156 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2157 of a list of pkgparts; the hashref has the following keys:
2161 =item pkgparts - listref of pkgparts
2163 =item (other options are passed to the suspend method)
2168 Returns a list: an empty list on success or a list of errors.
2172 sub suspend_if_pkgpart {
2174 my (@pkgparts, %opt);
2175 if (ref($_[0]) eq 'HASH'){
2176 @pkgparts = @{$_[0]{pkgparts}};
2181 grep { $_->suspend(%opt) }
2182 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2183 $self->unsuspended_pkgs;
2186 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2188 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2189 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2190 instead of a list of pkgparts; the hashref has the following keys:
2194 =item pkgparts - listref of pkgparts
2196 =item (other options are passed to the suspend method)
2200 Returns a list: an empty list on success or a list of errors.
2204 sub suspend_unless_pkgpart {
2206 my (@pkgparts, %opt);
2207 if (ref($_[0]) eq 'HASH'){
2208 @pkgparts = @{$_[0]{pkgparts}};
2213 grep { $_->suspend(%opt) }
2214 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2215 $self->unsuspended_pkgs;
2218 =item cancel [ OPTION => VALUE ... ]
2220 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2222 Available options are:
2226 =item quiet - can be set true to supress email cancellation notices.
2228 =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.
2230 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2232 =item nobill - can be set true to skip billing if it might otherwise be done.
2236 Always returns a list: an empty list on success or a list of errors.
2240 # nb that dates are not specified as valid options to this method
2243 my( $self, %opt ) = @_;
2245 warn "$me cancel called on customer ". $self->custnum. " with options ".
2246 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2249 return ( 'access denied' )
2250 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2252 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2254 #should try decryption (we might have the private key)
2255 # and if not maybe queue a job for the server that does?
2256 return ( "Can't (yet) ban encrypted credit cards" )
2257 if $self->is_encrypted($self->payinfo);
2259 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2260 my $error = $ban->insert;
2261 return ( $error ) if $error;
2265 my @pkgs = $self->ncancelled_pkgs;
2267 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2269 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2270 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2274 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2275 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2278 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2281 sub _banned_pay_hashref {
2292 'payby' => $payby2ban{$self->payby},
2293 'payinfo' => $self->payinfo,
2294 #don't ever *search* on reason! #'reason' =>
2298 sub _new_banned_pay_hashref {
2300 my $hr = $self->_banned_pay_hashref;
2301 $hr->{payinfo} = md5_base64($hr->{payinfo});
2307 Returns all notes (see L<FS::cust_main_note>) for this customer.
2312 my($self,$orderby_classnum) = (shift,shift);
2313 my $orderby = "_DATE DESC";
2314 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2315 qsearch( 'cust_main_note',
2316 { 'custnum' => $self->custnum },
2318 "ORDER BY $orderby",
2324 Returns the agent (see L<FS::agent>) for this customer.
2330 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2335 Returns the agent name (see L<FS::agent>) for this customer.
2341 $self->agent->agent;
2346 Returns any tags associated with this customer, as FS::cust_tag objects,
2347 or an empty list if there are no tags.
2353 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2358 Returns any tags associated with this customer, as FS::part_tag objects,
2359 or an empty list if there are no tags.
2365 map $_->part_tag, $self->cust_tag;
2371 Returns the customer class, as an FS::cust_class object, or the empty string
2372 if there is no customer class.
2378 if ( $self->classnum ) {
2379 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2387 Returns the customer category name, or the empty string if there is no customer
2394 my $cust_class = $self->cust_class;
2396 ? $cust_class->categoryname
2402 Returns the customer class name, or the empty string if there is no customer
2409 my $cust_class = $self->cust_class;
2411 ? $cust_class->classname
2415 =item BILLING METHODS
2417 Documentation on billing methods has been moved to
2418 L<FS::cust_main::Billing>.
2420 =item REALTIME BILLING METHODS
2422 Documentation on realtime billing methods has been moved to
2423 L<FS::cust_main::Billing_Realtime>.
2427 Removes the I<paycvv> field from the database directly.
2429 If there is an error, returns the error, otherwise returns false.
2435 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2436 or return dbh->errstr;
2437 $sth->execute($self->custnum)
2438 or return $sth->errstr;
2443 =item batch_card OPTION => VALUE...
2445 Adds a payment for this invoice to the pending credit card batch (see
2446 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2447 runs the payment using a realtime gateway.
2452 my ($self, %options) = @_;
2455 if (exists($options{amount})) {
2456 $amount = $options{amount};
2458 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2460 return '' unless $amount > 0;
2462 my $invnum = delete $options{invnum};
2463 my $payby = $options{payby} || $self->payby; #still dubious
2465 if ($options{'realtime'}) {
2466 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2472 my $oldAutoCommit = $FS::UID::AutoCommit;
2473 local $FS::UID::AutoCommit = 0;
2476 #this needs to handle mysql as well as Pg, like svc_acct.pm
2477 #(make it into a common function if folks need to do batching with mysql)
2478 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2479 or return "Cannot lock pay_batch: " . $dbh->errstr;
2483 'payby' => FS::payby->payby2payment($payby),
2485 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2487 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2489 unless ( $pay_batch ) {
2490 $pay_batch = new FS::pay_batch \%pay_batch;
2491 my $error = $pay_batch->insert;
2493 $dbh->rollback if $oldAutoCommit;
2494 die "error creating new batch: $error\n";
2498 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2499 'batchnum' => $pay_batch->batchnum,
2500 'custnum' => $self->custnum,
2503 foreach (qw( address1 address2 city state zip country payby payinfo paydate
2505 $options{$_} = '' unless exists($options{$_});
2508 my $cust_pay_batch = new FS::cust_pay_batch ( {
2509 'batchnum' => $pay_batch->batchnum,
2510 'invnum' => $invnum || 0, # is there a better value?
2511 # this field should be
2513 # cust_bill_pay_batch now
2514 'custnum' => $self->custnum,
2515 'last' => $self->getfield('last'),
2516 'first' => $self->getfield('first'),
2517 'address1' => $options{address1} || $self->address1,
2518 'address2' => $options{address2} || $self->address2,
2519 'city' => $options{city} || $self->city,
2520 'state' => $options{state} || $self->state,
2521 'zip' => $options{zip} || $self->zip,
2522 'country' => $options{country} || $self->country,
2523 'payby' => $options{payby} || $self->payby,
2524 'payinfo' => $options{payinfo} || $self->payinfo,
2525 'exp' => $options{paydate} || $self->paydate,
2526 'payname' => $options{payname} || $self->payname,
2527 'amount' => $amount, # consolidating
2530 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2531 if $old_cust_pay_batch;
2534 if ($old_cust_pay_batch) {
2535 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2537 $error = $cust_pay_batch->insert;
2541 $dbh->rollback if $oldAutoCommit;
2545 my $unapplied = $self->total_unapplied_credits
2546 + $self->total_unapplied_payments
2547 + $self->in_transit_payments;
2548 foreach my $cust_bill ($self->open_cust_bill) {
2549 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2550 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2551 'invnum' => $cust_bill->invnum,
2552 'paybatchnum' => $cust_pay_batch->paybatchnum,
2553 'amount' => $cust_bill->owed,
2556 if ($unapplied >= $cust_bill_pay_batch->amount){
2557 $unapplied -= $cust_bill_pay_batch->amount;
2560 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2561 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2563 $error = $cust_bill_pay_batch->insert;
2565 $dbh->rollback if $oldAutoCommit;
2570 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2576 Returns the total owed for this customer on all invoices
2577 (see L<FS::cust_bill/owed>).
2583 $self->total_owed_date(2145859200); #12/31/2037
2586 =item total_owed_date TIME
2588 Returns the total owed for this customer on all invoices with date earlier than
2589 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2590 see L<Time::Local> and L<Date::Parse> for conversion functions.
2594 sub total_owed_date {
2598 my $custnum = $self->custnum;
2600 my $owed_sql = FS::cust_bill->owed_sql;
2603 SELECT SUM($owed_sql) FROM cust_bill
2604 WHERE custnum = $custnum
2608 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2612 =item total_owed_pkgnum PKGNUM
2614 Returns the total owed on all invoices for this customer's specific package
2615 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2619 sub total_owed_pkgnum {
2620 my( $self, $pkgnum ) = @_;
2621 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2624 =item total_owed_date_pkgnum TIME PKGNUM
2626 Returns the total owed for this customer's specific package when using
2627 experimental package balances on all invoices with date earlier than
2628 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2629 see L<Time::Local> and L<Date::Parse> for conversion functions.
2633 sub total_owed_date_pkgnum {
2634 my( $self, $time, $pkgnum ) = @_;
2637 foreach my $cust_bill (
2638 grep { $_->_date <= $time }
2639 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2641 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2643 sprintf( "%.2f", $total_bill );
2649 Returns the total amount of all payments.
2656 $total += $_->paid foreach $self->cust_pay;
2657 sprintf( "%.2f", $total );
2660 =item total_unapplied_credits
2662 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2663 customer. See L<FS::cust_credit/credited>.
2665 =item total_credited
2667 Old name for total_unapplied_credits. Don't use.
2671 sub total_credited {
2672 #carp "total_credited deprecated, use total_unapplied_credits";
2673 shift->total_unapplied_credits(@_);
2676 sub total_unapplied_credits {
2679 my $custnum = $self->custnum;
2681 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2684 SELECT SUM($unapplied_sql) FROM cust_credit
2685 WHERE custnum = $custnum
2688 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2692 =item total_unapplied_credits_pkgnum PKGNUM
2694 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2695 customer. See L<FS::cust_credit/credited>.
2699 sub total_unapplied_credits_pkgnum {
2700 my( $self, $pkgnum ) = @_;
2701 my $total_credit = 0;
2702 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2703 sprintf( "%.2f", $total_credit );
2707 =item total_unapplied_payments
2709 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2710 See L<FS::cust_pay/unapplied>.
2714 sub total_unapplied_payments {
2717 my $custnum = $self->custnum;
2719 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2722 SELECT SUM($unapplied_sql) FROM cust_pay
2723 WHERE custnum = $custnum
2726 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2730 =item total_unapplied_payments_pkgnum PKGNUM
2732 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2733 specific package when using experimental package balances. See
2734 L<FS::cust_pay/unapplied>.
2738 sub total_unapplied_payments_pkgnum {
2739 my( $self, $pkgnum ) = @_;
2740 my $total_unapplied = 0;
2741 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2742 sprintf( "%.2f", $total_unapplied );
2746 =item total_unapplied_refunds
2748 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2749 customer. See L<FS::cust_refund/unapplied>.
2753 sub total_unapplied_refunds {
2755 my $custnum = $self->custnum;
2757 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2760 SELECT SUM($unapplied_sql) FROM cust_refund
2761 WHERE custnum = $custnum
2764 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2770 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2771 total_unapplied_credits minus total_unapplied_payments).
2777 $self->balance_date_range;
2780 =item balance_date TIME
2782 Returns the balance for this customer, only considering invoices with date
2783 earlier than TIME (total_owed_date minus total_credited minus
2784 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2785 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2792 $self->balance_date_range(shift);
2795 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2797 Returns the balance for this customer, optionally considering invoices with
2798 date earlier than START_TIME, and not later than END_TIME
2799 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2801 Times are specified as SQL fragments or numeric
2802 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2803 L<Date::Parse> for conversion functions. The empty string can be passed
2804 to disable that time constraint completely.
2806 Available options are:
2810 =item unapplied_date
2812 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)
2818 sub balance_date_range {
2820 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2821 ') FROM cust_main WHERE custnum='. $self->custnum;
2822 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2825 =item balance_pkgnum PKGNUM
2827 Returns the balance for this customer's specific package when using
2828 experimental package balances (total_owed plus total_unrefunded, minus
2829 total_unapplied_credits minus total_unapplied_payments)
2833 sub balance_pkgnum {
2834 my( $self, $pkgnum ) = @_;
2837 $self->total_owed_pkgnum($pkgnum)
2838 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2839 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2840 - $self->total_unapplied_credits_pkgnum($pkgnum)
2841 - $self->total_unapplied_payments_pkgnum($pkgnum)
2845 =item in_transit_payments
2847 Returns the total of requests for payments for this customer pending in
2848 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2852 sub in_transit_payments {
2854 my $in_transit_payments = 0;
2855 foreach my $pay_batch ( qsearch('pay_batch', {
2858 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2859 'batchnum' => $pay_batch->batchnum,
2860 'custnum' => $self->custnum,
2862 $in_transit_payments += $cust_pay_batch->amount;
2865 sprintf( "%.2f", $in_transit_payments );
2870 Returns a hash of useful information for making a payment.
2880 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2881 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2882 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2886 For credit card transactions:
2898 For electronic check transactions:
2913 $return{balance} = $self->balance;
2915 $return{payname} = $self->payname
2916 || ( $self->first. ' '. $self->get('last') );
2918 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2920 $return{payby} = $self->payby;
2921 $return{stateid_state} = $self->stateid_state;
2923 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2924 $return{card_type} = cardtype($self->payinfo);
2925 $return{payinfo} = $self->paymask;
2927 @return{'month', 'year'} = $self->paydate_monthyear;
2931 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2932 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2933 $return{payinfo1} = $payinfo1;
2934 $return{payinfo2} = $payinfo2;
2935 $return{paytype} = $self->paytype;
2936 $return{paystate} = $self->paystate;
2940 #doubleclick protection
2942 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2948 =item paydate_monthyear
2950 Returns a two-element list consisting of the month and year of this customer's
2951 paydate (credit card expiration date for CARD customers)
2955 sub paydate_monthyear {
2957 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2959 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2968 Returns the exact time in seconds corresponding to the payment method
2969 expiration date. For CARD/DCRD customers this is the end of the month;
2970 for others (COMP is the only other payby that uses paydate) it's the start.
2971 Returns 0 if the paydate is empty or set to the far future.
2977 my ($month, $year) = $self->paydate_monthyear;
2978 return 0 if !$year or $year >= 2037;
2979 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
2981 if ( $month == 13 ) {
2985 return timelocal(0,0,0,1,$month-1,$year) - 1;
2988 return timelocal(0,0,0,1,$month-1,$year);
2992 =item paydate_epoch_sql
2994 Class method. Returns an SQL expression to obtain the payment expiration date
2995 as a number of seconds.
2999 # Special expiration date behavior for non-CARD/DCRD customers has been
3000 # carefully preserved. Do we really use that?
3001 sub paydate_epoch_sql {
3003 my $table = shift || 'cust_main';
3004 my ($case1, $case2);
3005 if ( driver_name eq 'Pg' ) {
3006 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3007 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3009 elsif ( lc(driver_name) eq 'mysql' ) {
3010 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3011 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3014 return "CASE WHEN $table.payby IN('CARD','DCRD')
3020 =item tax_exemption TAXNAME
3025 my( $self, $taxname ) = @_;
3027 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3028 'taxname' => $taxname,
3033 =item cust_main_exemption
3037 sub cust_main_exemption {
3039 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3042 =item invoicing_list [ ARRAYREF ]
3044 If an arguement is given, sets these email addresses as invoice recipients
3045 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3046 (except as warnings), so use check_invoicing_list first.
3048 Returns a list of email addresses (with svcnum entries expanded).
3050 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3051 check it without disturbing anything by passing nothing.
3053 This interface may change in the future.
3057 sub invoicing_list {
3058 my( $self, $arrayref ) = @_;
3061 my @cust_main_invoice;
3062 if ( $self->custnum ) {
3063 @cust_main_invoice =
3064 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3066 @cust_main_invoice = ();
3068 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3069 #warn $cust_main_invoice->destnum;
3070 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3071 #warn $cust_main_invoice->destnum;
3072 my $error = $cust_main_invoice->delete;
3073 warn $error if $error;
3076 if ( $self->custnum ) {
3077 @cust_main_invoice =
3078 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3080 @cust_main_invoice = ();
3082 my %seen = map { $_->address => 1 } @cust_main_invoice;
3083 foreach my $address ( @{$arrayref} ) {
3084 next if exists $seen{$address} && $seen{$address};
3085 $seen{$address} = 1;
3086 my $cust_main_invoice = new FS::cust_main_invoice ( {
3087 'custnum' => $self->custnum,
3090 my $error = $cust_main_invoice->insert;
3091 warn $error if $error;
3095 if ( $self->custnum ) {
3097 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3104 =item check_invoicing_list ARRAYREF
3106 Checks these arguements as valid input for the invoicing_list method. If there
3107 is an error, returns the error, otherwise returns false.
3111 sub check_invoicing_list {
3112 my( $self, $arrayref ) = @_;
3114 foreach my $address ( @$arrayref ) {
3116 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3117 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3120 my $cust_main_invoice = new FS::cust_main_invoice ( {
3121 'custnum' => $self->custnum,
3124 my $error = $self->custnum
3125 ? $cust_main_invoice->check
3126 : $cust_main_invoice->checkdest
3128 return $error if $error;
3132 return "Email address required"
3133 if $conf->exists('cust_main-require_invoicing_list_email')
3134 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3139 =item set_default_invoicing_list
3141 Sets the invoicing list to all accounts associated with this customer,
3142 overwriting any previous invoicing list.
3146 sub set_default_invoicing_list {
3148 $self->invoicing_list($self->all_emails);
3153 Returns the email addresses of all accounts provisioned for this customer.
3160 foreach my $cust_pkg ( $self->all_pkgs ) {
3161 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3163 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3164 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3166 $list{$_}=1 foreach map { $_->email } @svc_acct;
3171 =item invoicing_list_addpost
3173 Adds postal invoicing to this customer. If this customer is already configured
3174 to receive postal invoices, does nothing.
3178 sub invoicing_list_addpost {
3180 return if grep { $_ eq 'POST' } $self->invoicing_list;
3181 my @invoicing_list = $self->invoicing_list;
3182 push @invoicing_list, 'POST';
3183 $self->invoicing_list(\@invoicing_list);
3186 =item invoicing_list_emailonly
3188 Returns the list of email invoice recipients (invoicing_list without non-email
3189 destinations such as POST and FAX).
3193 sub invoicing_list_emailonly {
3195 warn "$me invoicing_list_emailonly called"
3197 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3200 =item invoicing_list_emailonly_scalar
3202 Returns the list of email invoice recipients (invoicing_list without non-email
3203 destinations such as POST and FAX) as a comma-separated scalar.
3207 sub invoicing_list_emailonly_scalar {
3209 warn "$me invoicing_list_emailonly_scalar called"
3211 join(', ', $self->invoicing_list_emailonly);
3214 =item referral_custnum_cust_main
3216 Returns the customer who referred this customer (or the empty string, if
3217 this customer was not referred).
3219 Note the difference with referral_cust_main method: This method,
3220 referral_custnum_cust_main returns the single customer (if any) who referred
3221 this customer, while referral_cust_main returns an array of customers referred
3226 sub referral_custnum_cust_main {
3228 return '' unless $self->referral_custnum;
3229 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3232 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3234 Returns an array of customers referred by this customer (referral_custnum set
3235 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3236 customers referred by customers referred by this customer and so on, inclusive.
3237 The default behavior is DEPTH 1 (no recursion).
3239 Note the difference with referral_custnum_cust_main method: This method,
3240 referral_cust_main, returns an array of customers referred BY this customer,
3241 while referral_custnum_cust_main returns the single customer (if any) who
3242 referred this customer.
3246 sub referral_cust_main {
3248 my $depth = @_ ? shift : 1;
3249 my $exclude = @_ ? shift : {};
3252 map { $exclude->{$_->custnum}++; $_; }
3253 grep { ! $exclude->{ $_->custnum } }
3254 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3258 map { $_->referral_cust_main($depth-1, $exclude) }
3265 =item referral_cust_main_ncancelled
3267 Same as referral_cust_main, except only returns customers with uncancelled
3272 sub referral_cust_main_ncancelled {
3274 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3277 =item referral_cust_pkg [ DEPTH ]
3279 Like referral_cust_main, except returns a flat list of all unsuspended (and
3280 uncancelled) packages for each customer. The number of items in this list may
3281 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3285 sub referral_cust_pkg {
3287 my $depth = @_ ? shift : 1;
3289 map { $_->unsuspended_pkgs }
3290 grep { $_->unsuspended_pkgs }
3291 $self->referral_cust_main($depth);
3294 =item referring_cust_main
3296 Returns the single cust_main record for the customer who referred this customer
3297 (referral_custnum), or false.
3301 sub referring_cust_main {
3303 return '' unless $self->referral_custnum;
3304 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3307 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3309 Applies a credit to this customer. If there is an error, returns the error,
3310 otherwise returns false.
3312 REASON can be a text string, an FS::reason object, or a scalar reference to
3313 a reasonnum. If a text string, it will be automatically inserted as a new
3314 reason, and a 'reason_type' option must be passed to indicate the
3315 FS::reason_type for the new reason.
3317 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3319 Any other options are passed to FS::cust_credit::insert.
3324 my( $self, $amount, $reason, %options ) = @_;
3326 my $cust_credit = new FS::cust_credit {
3327 'custnum' => $self->custnum,
3328 'amount' => $amount,
3331 if ( ref($reason) ) {
3333 if ( ref($reason) eq 'SCALAR' ) {
3334 $cust_credit->reasonnum( $$reason );
3336 $cust_credit->reasonnum( $reason->reasonnum );
3340 $cust_credit->set('reason', $reason)
3343 for (qw( addlinfo eventnum )) {
3344 $cust_credit->$_( delete $options{$_} )
3345 if exists($options{$_});
3348 $cust_credit->insert(%options);
3352 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3354 Creates a one-time charge for this customer. If there is an error, returns
3355 the error, otherwise returns false.
3357 New-style, with a hashref of options:
3359 my $error = $cust_main->charge(
3363 'start_date' => str2time('7/4/2009'),
3364 'pkg' => 'Description',
3365 'comment' => 'Comment',
3366 'additional' => [], #extra invoice detail
3367 'classnum' => 1, #pkg_class
3369 'setuptax' => '', # or 'Y' for tax exempt
3372 'taxclass' => 'Tax class',
3375 'taxproduct' => 2, #part_pkg_taxproduct
3376 'override' => {}, #XXX describe
3378 #will be filled in with the new object
3379 'cust_pkg_ref' => \$cust_pkg,
3381 #generate an invoice immediately
3383 'invoice_terms' => '', #with these terms
3389 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3395 my ( $amount, $quantity, $start_date, $classnum );
3396 my ( $pkg, $comment, $additional );
3397 my ( $setuptax, $taxclass ); #internal taxes
3398 my ( $taxproduct, $override ); #vendor (CCH) taxes
3400 my $cust_pkg_ref = '';
3401 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3402 if ( ref( $_[0] ) ) {
3403 $amount = $_[0]->{amount};
3404 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3405 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3406 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3407 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3408 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3409 : '$'. sprintf("%.2f",$amount);
3410 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3411 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3412 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3413 $additional = $_[0]->{additional} || [];
3414 $taxproduct = $_[0]->{taxproductnum};
3415 $override = { '' => $_[0]->{tax_override} };
3416 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3417 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3418 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3423 $pkg = @_ ? shift : 'One-time charge';
3424 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3426 $taxclass = @_ ? shift : '';
3430 local $SIG{HUP} = 'IGNORE';
3431 local $SIG{INT} = 'IGNORE';
3432 local $SIG{QUIT} = 'IGNORE';
3433 local $SIG{TERM} = 'IGNORE';
3434 local $SIG{TSTP} = 'IGNORE';
3435 local $SIG{PIPE} = 'IGNORE';
3437 my $oldAutoCommit = $FS::UID::AutoCommit;
3438 local $FS::UID::AutoCommit = 0;
3441 my $part_pkg = new FS::part_pkg ( {
3443 'comment' => $comment,
3447 'classnum' => ( $classnum ? $classnum : '' ),
3448 'setuptax' => $setuptax,
3449 'taxclass' => $taxclass,
3450 'taxproductnum' => $taxproduct,
3453 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3454 ( 0 .. @$additional - 1 )
3456 'additional_count' => scalar(@$additional),
3457 'setup_fee' => $amount,
3460 my $error = $part_pkg->insert( options => \%options,
3461 tax_overrides => $override,
3464 $dbh->rollback if $oldAutoCommit;
3468 my $pkgpart = $part_pkg->pkgpart;
3469 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3470 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3471 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3472 $error = $type_pkgs->insert;
3474 $dbh->rollback if $oldAutoCommit;
3479 my $cust_pkg = new FS::cust_pkg ( {
3480 'custnum' => $self->custnum,
3481 'pkgpart' => $pkgpart,
3482 'quantity' => $quantity,
3483 'start_date' => $start_date,
3484 'no_auto' => $no_auto,
3487 $error = $cust_pkg->insert;
3489 $dbh->rollback if $oldAutoCommit;
3491 } elsif ( $cust_pkg_ref ) {
3492 ${$cust_pkg_ref} = $cust_pkg;
3496 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3497 'pkg_list' => [ $cust_pkg ],
3500 $dbh->rollback if $oldAutoCommit;
3505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3510 #=item charge_postal_fee
3512 #Applies a one time charge this customer. If there is an error,
3513 #returns the error, returns the cust_pkg charge object or false
3514 #if there was no charge.
3518 # This should be a customer event. For that to work requires that bill
3519 # also be a customer event.
3521 sub charge_postal_fee {
3524 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3525 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3527 my $cust_pkg = new FS::cust_pkg ( {
3528 'custnum' => $self->custnum,
3529 'pkgpart' => $pkgpart,
3533 my $error = $cust_pkg->insert;
3534 $error ? $error : $cust_pkg;
3537 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3539 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3541 Optionally, a list or hashref of additional arguments to the qsearch call can
3548 my $opt = ref($_[0]) ? shift : { @_ };
3550 #return $self->num_cust_bill unless wantarray || keys %$opt;
3552 $opt->{'table'} = 'cust_bill';
3553 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3554 $opt->{'hashref'}{'custnum'} = $self->custnum;
3555 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3557 map { $_ } #behavior of sort undefined in scalar context
3558 sort { $a->_date <=> $b->_date }
3562 =item open_cust_bill
3564 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3569 sub open_cust_bill {
3573 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3579 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3581 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3585 sub legacy_cust_bill {
3588 #return $self->num_legacy_cust_bill unless wantarray;
3590 map { $_ } #behavior of sort undefined in scalar context
3591 sort { $a->_date <=> $b->_date }
3592 qsearch({ 'table' => 'legacy_cust_bill',
3593 'hashref' => { 'custnum' => $self->custnum, },
3594 'order_by' => 'ORDER BY _date ASC',
3598 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3600 Returns all the statements (see L<FS::cust_statement>) for this customer.
3602 Optionally, a list or hashref of additional arguments to the qsearch call can
3607 sub cust_statement {
3609 my $opt = ref($_[0]) ? shift : { @_ };
3611 #return $self->num_cust_statement unless wantarray || keys %$opt;
3613 $opt->{'table'} = 'cust_statement';
3614 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3615 $opt->{'hashref'}{'custnum'} = $self->custnum;
3616 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3618 map { $_ } #behavior of sort undefined in scalar context
3619 sort { $a->_date <=> $b->_date }
3623 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3625 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3627 Optionally, a list or hashref of additional arguments to the qsearch call can
3628 be passed following the SVCDB.
3635 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3636 warn "$me svc_x requires a svcdb";
3639 my $opt = ref($_[0]) ? shift : { @_ };
3641 $opt->{'table'} = $svcdb;
3642 $opt->{'addl_from'} =
3643 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3644 ($opt->{'addl_from'} || '');
3646 my $custnum = $self->custnum;
3647 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3648 my $where = "cust_pkg.custnum = $custnum";
3650 my $extra_sql = $opt->{'extra_sql'} || '';
3651 if ( keys %{ $opt->{'hashref'} } ) {
3652 $extra_sql = " AND $where $extra_sql";
3655 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3656 $extra_sql = "WHERE $where AND $1";
3659 $extra_sql = "WHERE $where $extra_sql";
3662 $opt->{'extra_sql'} = $extra_sql;
3667 # required for use as an eventtable;
3670 $self->svc_x('svc_acct', @_);
3675 Returns all the credits (see L<FS::cust_credit>) for this customer.
3681 map { $_ } #return $self->num_cust_credit unless wantarray;
3682 sort { $a->_date <=> $b->_date }
3683 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3686 =item cust_credit_pkgnum
3688 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3689 package when using experimental package balances.
3693 sub cust_credit_pkgnum {
3694 my( $self, $pkgnum ) = @_;
3695 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3696 sort { $a->_date <=> $b->_date }
3697 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3698 'pkgnum' => $pkgnum,
3705 Returns all the payments (see L<FS::cust_pay>) for this customer.
3711 return $self->num_cust_pay unless wantarray;
3712 sort { $a->_date <=> $b->_date }
3713 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3718 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3719 called automatically when the cust_pay method is used in a scalar context.
3725 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3726 my $sth = dbh->prepare($sql) or die dbh->errstr;
3727 $sth->execute($self->custnum) or die $sth->errstr;
3728 $sth->fetchrow_arrayref->[0];
3731 =item cust_pay_pkgnum
3733 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3734 package when using experimental package balances.
3738 sub cust_pay_pkgnum {
3739 my( $self, $pkgnum ) = @_;
3740 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3741 sort { $a->_date <=> $b->_date }
3742 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3743 'pkgnum' => $pkgnum,
3750 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3756 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3757 sort { $a->_date <=> $b->_date }
3758 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3761 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3763 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3765 Optionally, a list or hashref of additional arguments to the qsearch call can
3770 sub cust_pay_batch {
3772 my $opt = ref($_[0]) ? shift : { @_ };
3774 #return $self->num_cust_statement unless wantarray || keys %$opt;
3776 $opt->{'table'} = 'cust_pay_batch';
3777 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3778 $opt->{'hashref'}{'custnum'} = $self->custnum;
3779 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3781 map { $_ } #behavior of sort undefined in scalar context
3782 sort { $a->paybatchnum <=> $b->paybatchnum }
3786 =item cust_pay_pending
3788 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3789 (without status "done").
3793 sub cust_pay_pending {
3795 return $self->num_cust_pay_pending unless wantarray;
3796 sort { $a->_date <=> $b->_date }
3797 qsearch( 'cust_pay_pending', {
3798 'custnum' => $self->custnum,
3799 'status' => { op=>'!=', value=>'done' },
3804 =item cust_pay_pending_attempt
3806 Returns all payment attempts / declined payments for this customer, as pending
3807 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3808 a corresponding payment (see L<FS::cust_pay>).
3812 sub cust_pay_pending_attempt {
3814 return $self->num_cust_pay_pending_attempt unless wantarray;
3815 sort { $a->_date <=> $b->_date }
3816 qsearch( 'cust_pay_pending', {
3817 'custnum' => $self->custnum,
3824 =item num_cust_pay_pending
3826 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3827 customer (without status "done"). Also called automatically when the
3828 cust_pay_pending method is used in a scalar context.
3832 sub num_cust_pay_pending {
3835 " SELECT COUNT(*) FROM cust_pay_pending ".
3836 " WHERE custnum = ? AND status != 'done' ",
3841 =item num_cust_pay_pending_attempt
3843 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3844 customer, with status "done" but without a corresp. Also called automatically when the
3845 cust_pay_pending method is used in a scalar context.
3849 sub num_cust_pay_pending_attempt {
3852 " SELECT COUNT(*) FROM cust_pay_pending ".
3853 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3860 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3866 map { $_ } #return $self->num_cust_refund unless wantarray;
3867 sort { $a->_date <=> $b->_date }
3868 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3871 =item display_custnum
3873 Returns the displayed customer number for this customer: agent_custid if
3874 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3878 sub display_custnum {
3880 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3881 return $self->agent_custid;
3883 return $self->custnum;
3889 Returns a name string for this customer, either "Company (Last, First)" or
3896 my $name = $self->contact;
3897 $name = $self->company. " ($name)" if $self->company;
3903 Returns a name string for this (service/shipping) contact, either
3904 "Company (Last, First)" or "Last, First".
3910 if ( $self->get('ship_last') ) {
3911 my $name = $self->ship_contact;
3912 $name = $self->ship_company. " ($name)" if $self->ship_company;
3921 Returns a name string for this customer, either "Company" or "First Last".
3927 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3930 =item ship_name_short
3932 Returns a name string for this (service/shipping) contact, either "Company"
3937 sub ship_name_short {
3939 if ( $self->get('ship_last') ) {
3940 $self->ship_company !~ /^\s*$/
3941 ? $self->ship_company
3942 : $self->ship_contact_firstlast;
3944 $self->name_company_or_firstlast;
3950 Returns this customer's full (billing) contact name only, "Last, First"
3956 $self->get('last'). ', '. $self->first;
3961 Returns this customer's full (shipping) contact name only, "Last, First"
3967 $self->get('ship_last')
3968 ? $self->get('ship_last'). ', '. $self->ship_first
3972 =item contact_firstlast
3974 Returns this customers full (billing) contact name only, "First Last".
3978 sub contact_firstlast {
3980 $self->first. ' '. $self->get('last');
3983 =item ship_contact_firstlast
3985 Returns this customer's full (shipping) contact name only, "First Last".
3989 sub ship_contact_firstlast {
3991 $self->get('ship_last')
3992 ? $self->first. ' '. $self->get('ship_last')
3993 : $self->contact_firstlast;
3998 Returns this customer's full country name
4004 code2country($self->country);
4007 =item geocode DATA_VENDOR
4009 Returns a value for the customer location as encoded by DATA_VENDOR.
4010 Currently this only makes sense for "CCH" as DATA_VENDOR.
4018 Returns a status string for this customer, currently:
4022 =item prospect - No packages have ever been ordered
4024 =item ordered - Recurring packages all are new (not yet billed).
4026 =item active - One or more recurring packages is active
4028 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4030 =item suspended - All non-cancelled recurring packages are suspended
4032 =item cancelled - All recurring packages are cancelled
4036 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4037 cust_main-status_module configuration option.
4041 sub status { shift->cust_status(@_); }
4045 for my $status ( FS::cust_main->statuses() ) {
4046 my $method = $status.'_sql';
4047 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4048 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4049 $sth->execute( ($self->custnum) x $numnum )
4050 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4051 return $status if $sth->fetchrow_arrayref->[0];
4055 =item ucfirst_cust_status
4057 =item ucfirst_status
4059 Returns the status with the first character capitalized.
4063 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4065 sub ucfirst_cust_status {
4067 ucfirst($self->cust_status);
4072 Returns a hex triplet color string for this customer's status.
4076 sub statuscolor { shift->cust_statuscolor(@_); }
4078 sub cust_statuscolor {
4080 __PACKAGE__->statuscolors->{$self->cust_status};
4085 Returns an array of hashes representing the customer's RT tickets.
4092 my $num = $conf->config('cust_main-max_tickets') || 10;
4095 if ( $conf->config('ticket_system') ) {
4096 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4098 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4102 foreach my $priority (
4103 $conf->config('ticket_system-custom_priority_field-values'), ''
4105 last if scalar(@tickets) >= $num;
4107 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4108 $num - scalar(@tickets),
4118 # Return services representing svc_accts in customer support packages
4119 sub support_services {
4121 my %packages = map { $_ => 1 } $conf->config('support_packages');
4123 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4124 grep { $_->part_svc->svcdb eq 'svc_acct' }
4125 map { $_->cust_svc }
4126 grep { exists $packages{ $_->pkgpart } }
4127 $self->ncancelled_pkgs;
4131 # Return a list of latitude/longitude for one of the services (if any)
4132 sub service_coordinates {
4136 grep { $_->latitude && $_->longitude }
4138 map { $_->cust_svc }
4139 $self->ncancelled_pkgs;
4141 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4146 Returns a masked version of the named field
4151 my ($self,$field) = @_;
4155 'x'x(length($self->getfield($field))-4).
4156 substr($self->getfield($field), (length($self->getfield($field))-4));
4162 =head1 CLASS METHODS
4168 Class method that returns the list of possible status strings for customers
4169 (see L<the status method|/status>). For example:
4171 @statuses = FS::cust_main->statuses();
4177 keys %{ $self->statuscolors };
4180 =item cust_status_sql
4182 Returns an SQL fragment to determine the status of a cust_main record, as a
4187 sub cust_status_sql {
4189 for my $status ( FS::cust_main->statuses() ) {
4190 my $method = $status.'_sql';
4191 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4200 Returns an SQL expression identifying prospective cust_main records (customers
4201 with no packages ever ordered)
4205 use vars qw($select_count_pkgs);
4206 $select_count_pkgs =
4207 "SELECT COUNT(*) FROM cust_pkg
4208 WHERE cust_pkg.custnum = cust_main.custnum";
4210 sub select_count_pkgs_sql {
4215 " 0 = ( $select_count_pkgs ) ";
4220 Returns an SQL expression identifying ordered cust_main records (customers with
4221 no active packages, but recurring packages not yet setup or one time charges
4227 FS::cust_main->none_active_sql.
4228 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4233 Returns an SQL expression identifying active cust_main records (customers with
4234 active recurring packages).
4239 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4242 =item none_active_sql
4244 Returns an SQL expression identifying cust_main records with no active
4245 recurring packages. This includes customers of status prospect, ordered,
4246 inactive, and suspended.
4250 sub none_active_sql {
4251 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4256 Returns an SQL expression identifying inactive cust_main records (customers with
4257 no active recurring packages, but otherwise unsuspended/uncancelled).
4262 FS::cust_main->none_active_sql.
4263 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4269 Returns an SQL expression identifying suspended cust_main records.
4274 sub suspended_sql { susp_sql(@_); }
4276 FS::cust_main->none_active_sql.
4277 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4283 Returns an SQL expression identifying cancelled cust_main records.
4287 sub cancel_sql { shift->cancelled_sql(@_); }
4290 =item uncancelled_sql
4292 Returns an SQL expression identifying un-cancelled cust_main records.
4296 sub uncancelled_sql { uncancel_sql(@_); }
4297 sub uncancel_sql { "
4298 ( 0 < ( $select_count_pkgs
4299 AND ( cust_pkg.cancel IS NULL
4300 OR cust_pkg.cancel = 0
4303 OR 0 = ( $select_count_pkgs )
4309 Returns an SQL fragment to retreive the balance.
4314 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4315 WHERE cust_bill.custnum = cust_main.custnum )
4316 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4317 WHERE cust_pay.custnum = cust_main.custnum )
4318 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4319 WHERE cust_credit.custnum = cust_main.custnum )
4320 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4321 WHERE cust_refund.custnum = cust_main.custnum )
4324 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4326 Returns an SQL fragment to retreive the balance for this customer, optionally
4327 considering invoices with date earlier than START_TIME, and not
4328 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4329 total_unapplied_payments).
4331 Times are specified as SQL fragments or numeric
4332 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4333 L<Date::Parse> for conversion functions. The empty string can be passed
4334 to disable that time constraint completely.
4336 Available options are:
4340 =item unapplied_date
4342 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)
4347 set to true to remove all customer comparison clauses, for totals
4352 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4357 JOIN clause (typically used with the total option)
4361 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4362 time will be ignored. Note that START_TIME and END_TIME only limit the date
4363 range for invoices and I<unapplied> payments, credits, and refunds.
4369 sub balance_date_sql {
4370 my( $class, $start, $end, %opt ) = @_;
4372 my $cutoff = $opt{'cutoff'};
4374 my $owed = FS::cust_bill->owed_sql($cutoff);
4375 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4376 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4377 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4379 my $j = $opt{'join'} || '';
4381 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4382 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4383 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4384 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4386 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4387 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4388 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4389 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4394 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4396 Returns an SQL fragment to retreive the total unapplied payments for this
4397 customer, only considering payments with date earlier than START_TIME, and
4398 optionally not later than END_TIME.
4400 Times are specified as SQL fragments or numeric
4401 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4402 L<Date::Parse> for conversion functions. The empty string can be passed
4403 to disable that time constraint completely.
4405 Available options are:
4409 sub unapplied_payments_date_sql {
4410 my( $class, $start, $end, %opt ) = @_;
4412 my $cutoff = $opt{'cutoff'};
4414 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4416 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4417 'unapplied_date'=>1 );
4419 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4422 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4424 Helper method for balance_date_sql; name (and usage) subject to change
4425 (suggestions welcome).
4427 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4428 cust_refund, cust_credit or cust_pay).
4430 If TABLE is "cust_bill" or the unapplied_date option is true, only
4431 considers records with date earlier than START_TIME, and optionally not
4432 later than END_TIME .
4436 sub _money_table_where {
4437 my( $class, $table, $start, $end, %opt ) = @_;
4440 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4441 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4442 push @where, "$table._date <= $start" if defined($start) && length($start);
4443 push @where, "$table._date > $end" if defined($end) && length($end);
4445 push @where, @{$opt{'where'}} if $opt{'where'};
4446 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4452 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4453 use FS::cust_main::Search;
4456 FS::cust_main::Search->search(@_);
4465 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
4469 use FS::cust_main::Search;
4470 sub append_fuzzyfiles {
4471 #my( $first, $last, $company ) = @_;
4473 FS::cust_main::Search::check_and_rebuild_fuzzyfiles();
4475 use Fcntl qw(:flock);
4477 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
4479 foreach my $field (@fuzzyfields) {
4484 open(CACHE,">>$dir/cust_main.$field")
4485 or die "can't open $dir/cust_main.$field: $!";
4486 flock(CACHE,LOCK_EX)
4487 or die "can't lock $dir/cust_main.$field: $!";
4489 print CACHE "$value\n";
4491 flock(CACHE,LOCK_UN)
4492 or die "can't unlock $dir/cust_main.$field: $!";
4507 #warn join('-',keys %$param);
4508 my $fh = $param->{filehandle};
4509 my $agentnum = $param->{agentnum};
4510 my $format = $param->{format};
4512 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4515 if ( $format eq 'simple' ) {
4516 @fields = qw( custnum agent_custid amount pkg );
4518 die "unknown format $format";
4521 eval "use Text::CSV_XS;";
4524 my $csv = new Text::CSV_XS;
4531 local $SIG{HUP} = 'IGNORE';
4532 local $SIG{INT} = 'IGNORE';
4533 local $SIG{QUIT} = 'IGNORE';
4534 local $SIG{TERM} = 'IGNORE';
4535 local $SIG{TSTP} = 'IGNORE';
4536 local $SIG{PIPE} = 'IGNORE';
4538 my $oldAutoCommit = $FS::UID::AutoCommit;
4539 local $FS::UID::AutoCommit = 0;
4542 #while ( $columns = $csv->getline($fh) ) {
4544 while ( defined($line=<$fh>) ) {
4546 $csv->parse($line) or do {
4547 $dbh->rollback if $oldAutoCommit;
4548 return "can't parse: ". $csv->error_input();
4551 my @columns = $csv->fields();
4552 #warn join('-',@columns);
4555 foreach my $field ( @fields ) {
4556 $row{$field} = shift @columns;
4559 if ( $row{custnum} && $row{agent_custid} ) {
4560 dbh->rollback if $oldAutoCommit;
4561 return "can't specify custnum with agent_custid $row{agent_custid}";
4565 if ( $row{agent_custid} && $agentnum ) {
4566 %hash = ( 'agent_custid' => $row{agent_custid},
4567 'agentnum' => $agentnum,
4571 if ( $row{custnum} ) {
4572 %hash = ( 'custnum' => $row{custnum} );
4575 unless ( scalar(keys %hash) ) {
4576 $dbh->rollback if $oldAutoCommit;
4577 return "can't find customer without custnum or agent_custid and agentnum";
4580 my $cust_main = qsearchs('cust_main', { %hash } );
4581 unless ( $cust_main ) {
4582 $dbh->rollback if $oldAutoCommit;
4583 my $custnum = $row{custnum} || $row{agent_custid};
4584 return "unknown custnum $custnum";
4587 if ( $row{'amount'} > 0 ) {
4588 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4590 $dbh->rollback if $oldAutoCommit;
4594 } elsif ( $row{'amount'} < 0 ) {
4595 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4598 $dbh->rollback if $oldAutoCommit;
4608 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4610 return "Empty file!" unless $imported;
4616 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4618 Deprecated. Use event notification and message templates
4619 (L<FS::msg_template>) instead.
4621 Sends a templated email notification to the customer (see L<Text::Template>).
4623 OPTIONS is a hash and may include
4625 I<from> - the email sender (default is invoice_from)
4627 I<to> - comma-separated scalar or arrayref of recipients
4628 (default is invoicing_list)
4630 I<subject> - The subject line of the sent email notification
4631 (default is "Notice from company_name")
4633 I<extra_fields> - a hashref of name/value pairs which will be substituted
4636 The following variables are vavailable in the template.
4638 I<$first> - the customer first name
4639 I<$last> - the customer last name
4640 I<$company> - the customer company
4641 I<$payby> - a description of the method of payment for the customer
4642 # would be nice to use FS::payby::shortname
4643 I<$payinfo> - the account information used to collect for this customer
4644 I<$expdate> - the expiration of the customer payment in seconds from epoch
4649 my ($self, $template, %options) = @_;
4651 return unless $conf->exists($template);
4653 my $from = $conf->config('invoice_from', $self->agentnum)
4654 if $conf->exists('invoice_from', $self->agentnum);
4655 $from = $options{from} if exists($options{from});
4657 my $to = join(',', $self->invoicing_list_emailonly);
4658 $to = $options{to} if exists($options{to});
4660 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4661 if $conf->exists('company_name', $self->agentnum);
4662 $subject = $options{subject} if exists($options{subject});
4664 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4665 SOURCE => [ map "$_\n",
4666 $conf->config($template)]
4668 or die "can't create new Text::Template object: Text::Template::ERROR";
4669 $notify_template->compile()
4670 or die "can't compile template: Text::Template::ERROR";
4672 $FS::notify_template::_template::company_name =
4673 $conf->config('company_name', $self->agentnum);
4674 $FS::notify_template::_template::company_address =
4675 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4677 my $paydate = $self->paydate || '2037-12-31';
4678 $FS::notify_template::_template::first = $self->first;
4679 $FS::notify_template::_template::last = $self->last;
4680 $FS::notify_template::_template::company = $self->company;
4681 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4682 my $payby = $self->payby;
4683 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4684 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4686 #credit cards expire at the end of the month/year of their exp date
4687 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4688 $FS::notify_template::_template::payby = 'credit card';
4689 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4690 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4692 }elsif ($payby eq 'COMP') {
4693 $FS::notify_template::_template::payby = 'complimentary account';
4695 $FS::notify_template::_template::payby = 'current method';
4697 $FS::notify_template::_template::expdate = $expire_time;
4699 for (keys %{$options{extra_fields}}){
4701 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4704 send_email(from => $from,
4706 subject => $subject,
4707 body => $notify_template->fill_in( PACKAGE =>
4708 'FS::notify_template::_template' ),
4713 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4715 Generates a templated notification to the customer (see L<Text::Template>).
4717 OPTIONS is a hash and may include
4719 I<extra_fields> - a hashref of name/value pairs which will be substituted
4720 into the template. These values may override values mentioned below
4721 and those from the customer record.
4723 The following variables are available in the template instead of or in addition
4724 to the fields of the customer record.
4726 I<$payby> - a description of the method of payment for the customer
4727 # would be nice to use FS::payby::shortname
4728 I<$payinfo> - the masked account information used to collect for this customer
4729 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4730 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4734 # a lot like cust_bill::print_latex
4735 sub generate_letter {
4736 my ($self, $template, %options) = @_;
4738 return unless $conf->exists($template);
4740 my $letter_template = new Text::Template
4742 SOURCE => [ map "$_\n", $conf->config($template)],
4743 DELIMITERS => [ '[@--', '--@]' ],
4745 or die "can't create new Text::Template object: Text::Template::ERROR";
4747 $letter_template->compile()
4748 or die "can't compile template: Text::Template::ERROR";
4750 my %letter_data = map { $_ => $self->$_ } $self->fields;
4751 $letter_data{payinfo} = $self->mask_payinfo;
4753 #my $paydate = $self->paydate || '2037-12-31';
4754 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4756 my $payby = $self->payby;
4757 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4758 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4760 #credit cards expire at the end of the month/year of their exp date
4761 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4762 $letter_data{payby} = 'credit card';
4763 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4764 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4766 }elsif ($payby eq 'COMP') {
4767 $letter_data{payby} = 'complimentary account';
4769 $letter_data{payby} = 'current method';
4771 $letter_data{expdate} = $expire_time;
4773 for (keys %{$options{extra_fields}}){
4774 $letter_data{$_} = $options{extra_fields}->{$_};
4777 unless(exists($letter_data{returnaddress})){
4778 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4779 $self->agent_template)
4781 if ( length($retadd) ) {
4782 $letter_data{returnaddress} = $retadd;
4783 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4784 $letter_data{returnaddress} =
4785 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4789 ( $conf->config('company_name', $self->agentnum),
4790 $conf->config('company_address', $self->agentnum),
4794 $letter_data{returnaddress} = '~';
4798 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4800 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4802 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4804 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4808 ) or die "can't open temp file: $!\n";
4809 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4810 or die "can't write temp file: $!\n";
4812 $letter_data{'logo_file'} = $lh->filename;
4814 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4818 ) or die "can't open temp file: $!\n";
4820 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4822 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4823 return ($1, $letter_data{'logo_file'});
4827 =item print_ps TEMPLATE
4829 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4835 my($file, $lfile) = $self->generate_letter(@_);
4836 my $ps = FS::Misc::generate_ps($file);
4837 unlink($file.'.tex');
4843 =item print TEMPLATE
4845 Prints the filled in template.
4847 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4851 sub queueable_print {
4854 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4855 or die "invalid customer number: " . $opt{custvnum};
4857 my $error = $self->print( $opt{template} );
4858 die $error if $error;
4862 my ($self, $template) = (shift, shift);
4863 do_print [ $self->print_ps($template) ];
4866 #these three subs should just go away once agent stuff is all config overrides
4868 sub agent_template {
4870 $self->_agent_plandata('agent_templatename');
4873 sub agent_invoice_from {
4875 $self->_agent_plandata('agent_invoice_from');
4878 sub _agent_plandata {
4879 my( $self, $option ) = @_;
4881 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4882 #agent-specific Conf
4884 use FS::part_event::Condition;
4886 my $agentnum = $self->agentnum;
4888 my $regexp = regexp_sql();
4890 my $part_event_option =
4892 'select' => 'part_event_option.*',
4893 'table' => 'part_event_option',
4895 LEFT JOIN part_event USING ( eventpart )
4896 LEFT JOIN part_event_option AS peo_agentnum
4897 ON ( part_event.eventpart = peo_agentnum.eventpart
4898 AND peo_agentnum.optionname = 'agentnum'
4899 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4901 LEFT JOIN part_event_condition
4902 ON ( part_event.eventpart = part_event_condition.eventpart
4903 AND part_event_condition.conditionname = 'cust_bill_age'
4905 LEFT JOIN part_event_condition_option
4906 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4907 AND part_event_condition_option.optionname = 'age'
4910 #'hashref' => { 'optionname' => $option },
4911 #'hashref' => { 'part_event_option.optionname' => $option },
4913 " WHERE part_event_option.optionname = ". dbh->quote($option).
4914 " AND action = 'cust_bill_send_agent' ".
4915 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4916 " AND peo_agentnum.optionname = 'agentnum' ".
4917 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4919 CASE WHEN part_event_condition_option.optionname IS NULL
4921 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4923 , part_event.weight".
4927 unless ( $part_event_option ) {
4928 return $self->agent->invoice_template || ''
4929 if $option eq 'agent_templatename';
4933 $part_event_option->optionvalue;
4937 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4939 Subroutine (not a method), designed to be called from the queue.
4941 Takes a list of options and values.
4943 Pulls up the customer record via the custnum option and calls bill_and_collect.
4948 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4950 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4951 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4953 $cust_main->bill_and_collect( %args );
4956 sub process_bill_and_collect {
4958 my $param = thaw(decode_base64(shift));
4959 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4960 or die "custnum '$param->{custnum}' not found!\n";
4961 $param->{'job'} = $job;
4962 $param->{'fatal'} = 1; # runs from job queue, will be caught
4963 $param->{'retry'} = 1;
4965 $cust_main->bill_and_collect( %$param );
4968 sub _upgrade_data { #class method
4969 my ($class, %opts) = @_;
4972 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4973 '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',
4975 # fix yyyy-m-dd formatted paydates
4976 if ( driver_name =~ /^mysql$/i ) {
4978 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4980 else { # the SQL standard
4982 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4985 foreach my $sql ( @statements ) {
4986 my $sth = dbh->prepare($sql) or die dbh->errstr;
4987 $sth->execute or die $sth->errstr;
4990 local($ignore_expired_card) = 1;
4991 local($ignore_illegal_zip) = 1;
4992 local($ignore_banned_card) = 1;
4993 local($skip_fuzzyfiles) = 1;
4994 $class->_upgrade_otaker(%opts);
5004 The delete method should possibly take an FS::cust_main object reference
5005 instead of a scalar customer number.
5007 Bill and collect options should probably be passed as references instead of a
5010 There should probably be a configuration file with a list of allowed credit
5013 No multiple currency support (probably a larger project than just this module).
5015 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5017 Birthdates rely on negative epoch values.
5019 The payby for card/check batches is broken. With mixed batching, bad
5022 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5026 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5027 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5028 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.