5 #FS::cust_main:_Marketgear when they're ready to move to 2.1
6 use base qw( FS::cust_main::Packages FS::cust_main::Status
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 use vars qw( $DEBUG $me $conf
16 $ignore_expired_card $ignore_illegal_zip $ignore_banned_card
21 use Scalar::Util qw( blessed );
22 use Time::Local qw(timelocal);
23 use Storable qw(thaw);
27 use Digest::MD5 qw(md5_base64);
30 use File::Temp; #qw( tempfile );
31 use Business::CreditCard 0.28;
33 use FS::UID qw( getotaker dbh driver_name );
34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_email send_email generate_ps do_print );
36 use FS::Msgcat qw(gettext);
43 use FS::legacy_cust_bill;
45 use FS::cust_pay_pending;
46 use FS::cust_pay_void;
47 use FS::cust_pay_batch;
50 use FS::part_referral;
51 use FS::cust_main_county;
52 use FS::cust_location;
54 use FS::cust_main_exemption;
55 use FS::cust_tax_adjustment;
56 use FS::cust_tax_location;
58 use FS::cust_main_invoice;
60 use FS::prepay_credit;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::cust_main_note;
70 use FS::cust_attachment;
74 # 1 is mostly method/subroutine entry and options
75 # 2 traces progress of some operations
76 # 3 is even more information including possibly sensitive data
78 $me = '[FS::cust_main]';
81 $ignore_expired_card = 0;
82 $ignore_illegal_zip = 0;
83 $ignore_banned_card = 0;
87 @encrypted_fields = ('payinfo', 'paycvv');
88 sub nohistory_fields { ('payinfo', 'paycvv'); }
90 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
92 #ask FS::UID to run this stuff for us later
93 #$FS::UID::callback{'FS::cust_main'} = sub {
94 install_callback FS::UID sub {
96 #yes, need it for stuff below (prolly should be cached)
101 my ( $hashref, $cache ) = @_;
102 if ( exists $hashref->{'pkgnum'} ) {
103 #@{ $self->{'_pkgnum'} } = ();
104 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
105 $self->{'_pkgnum'} = $subcache;
106 #push @{ $self->{'_pkgnum'} },
107 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
113 FS::cust_main - Object methods for cust_main records
119 $record = new FS::cust_main \%hash;
120 $record = new FS::cust_main { 'column' => 'value' };
122 $error = $record->insert;
124 $error = $new_record->replace($old_record);
126 $error = $record->delete;
128 $error = $record->check;
130 @cust_pkg = $record->all_pkgs;
132 @cust_pkg = $record->ncancelled_pkgs;
134 @cust_pkg = $record->suspended_pkgs;
136 $error = $record->bill;
137 $error = $record->bill %options;
138 $error = $record->bill 'time' => $time;
140 $error = $record->collect;
141 $error = $record->collect %options;
142 $error = $record->collect 'invoice_time' => $time,
147 An FS::cust_main object represents a customer. FS::cust_main inherits from
148 FS::Record. The following fields are currently supported:
154 Primary key (assigned automatically for new customers)
158 Agent (see L<FS::agent>)
162 Advertising source (see L<FS::part_referral>)
174 Cocial security number (optional)
190 (optional, see L<FS::cust_main_county>)
194 (see L<FS::cust_main_county>)
200 (see L<FS::cust_main_county>)
240 (optional, see L<FS::cust_main_county>)
244 (see L<FS::cust_main_county>)
250 (see L<FS::cust_main_county>)
270 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
274 Payment Information (See L<FS::payinfo_Mixin> for data format)
278 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
282 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
286 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
290 Start date month (maestro/solo cards only)
294 Start date year (maestro/solo cards only)
298 Issue number (maestro/solo cards only)
302 Name on card or billing name
306 IP address from which payment information was received
310 Tax exempt, empty or `Y'
314 Order taker (see L<FS::access_user>)
320 =item referral_custnum
322 Referring customer number
326 Enable individual CDR spooling, empty or `Y'
330 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
334 Discourage individual CDR printing, empty or `Y'
338 Allow self-service editing of ticket subjects, empty or 'Y'
340 =item calling_list_exempt
342 Do not call, empty or 'Y'
352 Creates a new customer. To add the customer to the database, see L<"insert">.
354 Note that this stores the hash reference, not a distinct copy of the hash it
355 points to. You can ask the object for a copy with the I<hash> method.
359 sub table { 'cust_main'; }
361 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
363 Adds this customer to the database. If there is an error, returns the error,
364 otherwise returns false.
366 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
367 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
368 are inserted atomicly, or the transaction is rolled back. Passing an empty
369 hash reference is equivalent to not supplying this parameter. There should be
370 a better explanation of this, but until then, here's an example:
373 tie %hash, 'Tie::RefHash'; #this part is important
375 $cust_pkg => [ $svc_acct ],
378 $cust_main->insert( \%hash );
380 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
381 be set as the invoicing list (see L<"invoicing_list">). Errors return as
382 expected and rollback the entire transaction; it is not necessary to call
383 check_invoicing_list first. The invoicing_list is set after the records in the
384 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
385 invoicing_list destination to the newly-created svc_acct. Here's an example:
387 $cust_main->insert( {}, [ $email, 'POST' ] );
389 Currently available options are: I<depend_jobnum>, I<noexport>,
390 I<tax_exemption> and I<prospectnum>.
392 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
393 on the supplied jobnum (they will not run until the specific job completes).
394 This can be used to defer provisioning until some action completes (such
395 as running the customer's credit card successfully).
397 The I<noexport> option is deprecated. If I<noexport> is set true, no
398 provisioning jobs (exports) are scheduled. (You can schedule them later with
399 the B<reexport> method.)
401 The I<tax_exemption> option can be set to an arrayref of tax names.
402 FS::cust_main_exemption records will be created and inserted.
404 If I<prospectnum> is set, moves contacts and locations from that prospect.
410 my $cust_pkgs = @_ ? shift : {};
411 my $invoicing_list = @_ ? shift : '';
413 warn "$me insert called with options ".
414 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
417 local $SIG{HUP} = 'IGNORE';
418 local $SIG{INT} = 'IGNORE';
419 local $SIG{QUIT} = 'IGNORE';
420 local $SIG{TERM} = 'IGNORE';
421 local $SIG{TSTP} = 'IGNORE';
422 local $SIG{PIPE} = 'IGNORE';
424 my $oldAutoCommit = $FS::UID::AutoCommit;
425 local $FS::UID::AutoCommit = 0;
428 my $prepay_identifier = '';
429 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
431 if ( $self->payby eq 'PREPAY' ) {
433 $self->payby('BILL');
434 $prepay_identifier = $self->payinfo;
437 warn " looking up prepaid card $prepay_identifier\n"
440 my $error = $self->get_prepay( $prepay_identifier,
441 'amount_ref' => \$amount,
442 'seconds_ref' => \$seconds,
443 'upbytes_ref' => \$upbytes,
444 'downbytes_ref' => \$downbytes,
445 'totalbytes_ref' => \$totalbytes,
448 $dbh->rollback if $oldAutoCommit;
449 #return "error applying prepaid card (transaction rolled back): $error";
453 $payby = 'PREP' if $amount;
455 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
458 $self->payby('BILL');
459 $amount = $self->paid;
463 warn " inserting $self\n"
466 $self->signupdate(time) unless $self->signupdate;
468 $self->censusyear($conf->config('census_year')) if $self->censustract;
470 $self->auto_agent_custid()
471 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
473 my $error = $self->SUPER::insert;
475 $dbh->rollback if $oldAutoCommit;
476 #return "inserting cust_main record (transaction rolled back): $error";
480 warn " setting invoicing list\n"
483 if ( $invoicing_list ) {
484 $error = $self->check_invoicing_list( $invoicing_list );
486 $dbh->rollback if $oldAutoCommit;
487 #return "checking invoicing_list (transaction rolled back): $error";
490 $self->invoicing_list( $invoicing_list );
493 warn " setting customer tags\n"
496 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
497 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
498 'custnum' => $self->custnum };
499 my $error = $cust_tag->insert;
501 $dbh->rollback if $oldAutoCommit;
506 my $prospectnum = delete $options{'prospectnum'};
507 if ( $prospectnum ) {
509 warn " moving contacts and locations from prospect $prospectnum\n"
513 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
514 unless ( $prospect_main ) {
515 $dbh->rollback if $oldAutoCommit;
516 return "Unknown prospectnum $prospectnum";
518 $prospect_main->custnum($self->custnum);
519 $prospect_main->disabled('Y');
520 my $error = $prospect_main->replace;
522 $dbh->rollback if $oldAutoCommit;
526 my @contact = $prospect_main->contact;
527 my @cust_location = $prospect_main->cust_location;
528 my @qual = $prospect_main->qual;
530 foreach my $r ( @contact, @cust_location, @qual ) {
532 $r->custnum($self->custnum);
533 my $error = $r->replace;
535 $dbh->rollback if $oldAutoCommit;
542 warn " setting cust_main_exemption\n"
545 my $tax_exemption = delete $options{'tax_exemption'};
546 if ( $tax_exemption ) {
547 foreach my $taxname ( @$tax_exemption ) {
548 my $cust_main_exemption = new FS::cust_main_exemption {
549 'custnum' => $self->custnum,
550 'taxname' => $taxname,
552 my $error = $cust_main_exemption->insert;
554 $dbh->rollback if $oldAutoCommit;
555 return "inserting cust_main_exemption (transaction rolled back): $error";
560 if ( $self->can('start_copy_skel') ) {
561 my $error = $self->start_copy_skel;
563 $dbh->rollback if $oldAutoCommit;
568 warn " ordering packages\n"
571 $error = $self->order_pkgs( $cust_pkgs,
573 'seconds_ref' => \$seconds,
574 'upbytes_ref' => \$upbytes,
575 'downbytes_ref' => \$downbytes,
576 'totalbytes_ref' => \$totalbytes,
579 $dbh->rollback if $oldAutoCommit;
584 $dbh->rollback if $oldAutoCommit;
585 return "No svc_acct record to apply pre-paid time";
587 if ( $upbytes || $downbytes || $totalbytes ) {
588 $dbh->rollback if $oldAutoCommit;
589 return "No svc_acct record to apply pre-paid data";
593 warn " inserting initial $payby payment of $amount\n"
595 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
597 $dbh->rollback if $oldAutoCommit;
598 return "inserting payment (transaction rolled back): $error";
602 unless ( $import || $skip_fuzzyfiles ) {
603 warn " queueing fuzzyfiles update\n"
605 $error = $self->queue_fuzzyfiles_update;
607 $dbh->rollback if $oldAutoCommit;
608 return "updating fuzzy search cache: $error";
613 warn " exporting\n" if $DEBUG > 1;
615 my $export_args = $options{'export_args'} || [];
618 map qsearch( 'part_export', {exportnum=>$_} ),
619 $conf->config('cust_main-exports'); #, $agentnum
621 foreach my $part_export ( @part_export ) {
622 my $error = $part_export->export_insert($self, @$export_args);
624 $dbh->rollback if $oldAutoCommit;
625 return "exporting to ". $part_export->exporttype.
626 " (transaction rolled back): $error";
630 #foreach my $depend_jobnum ( @$depend_jobnums ) {
631 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
633 # foreach my $jobnum ( @jobnums ) {
634 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
635 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
637 # my $error = $queue->depend_insert($depend_jobnum);
639 # $dbh->rollback if $oldAutoCommit;
640 # return "error queuing job dependancy: $error";
647 #if ( exists $options{'jobnums'} ) {
648 # push @{ $options{'jobnums'} }, @jobnums;
651 warn " insert complete; committing transaction\n"
654 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
659 use File::CounterFile;
660 sub auto_agent_custid {
663 my $format = $conf->config('cust_main-auto_agent_custid');
665 if ( $format eq '1YMMXXXXXXXX' ) {
667 my $counter = new File::CounterFile 'cust_main.agent_custid';
670 my $ym = 100000000000 + time2str('%y%m00000000', time);
671 if ( $ym > $counter->value ) {
672 $counter->{'value'} = $agent_custid = $ym;
673 $counter->{'updated'} = 1;
675 $agent_custid = $counter->inc;
681 die "Unknown cust_main-auto_agent_custid format: $format";
684 $self->agent_custid($agent_custid);
688 =item PACKAGE METHODS
690 Documentation on customer package methods has been moved to
691 L<FS::cust_main::Packages>.
693 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
695 Recharges this (existing) customer with the specified prepaid card (see
696 L<FS::prepay_credit>), specified either by I<identifier> or as an
697 FS::prepay_credit object. If there is an error, returns the error, otherwise
700 Optionally, five scalar references can be passed as well. They will have their
701 values filled in with the amount, number of seconds, and number of upload,
702 download, and total bytes applied by this prepaid card.
706 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
707 #the only place that uses these args
708 sub recharge_prepay {
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upbytesref, $downbytesref, $totalbytesref ) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
725 my $error = $self->get_prepay( $prepay_credit,
726 'amount_ref' => \$amount,
727 'seconds_ref' => \$seconds,
728 'upbytes_ref' => \$upbytes,
729 'downbytes_ref' => \$downbytes,
730 'totalbytes_ref' => \$totalbytes,
732 || $self->increment_seconds($seconds)
733 || $self->increment_upbytes($upbytes)
734 || $self->increment_downbytes($downbytes)
735 || $self->increment_totalbytes($totalbytes)
736 || $self->insert_cust_pay_prepay( $amount,
738 ? $prepay_credit->identifier
743 $dbh->rollback if $oldAutoCommit;
747 if ( defined($amountref) ) { $$amountref = $amount; }
748 if ( defined($secondsref) ) { $$secondsref = $seconds; }
749 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
750 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
751 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
753 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
758 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
760 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
761 specified either by I<identifier> or as an FS::prepay_credit object.
763 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
764 incremented by the values of the prepaid card.
766 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
767 check or set this customer's I<agentnum>.
769 If there is an error, returns the error, otherwise returns false.
775 my( $self, $prepay_credit, %opt ) = @_;
777 local $SIG{HUP} = 'IGNORE';
778 local $SIG{INT} = 'IGNORE';
779 local $SIG{QUIT} = 'IGNORE';
780 local $SIG{TERM} = 'IGNORE';
781 local $SIG{TSTP} = 'IGNORE';
782 local $SIG{PIPE} = 'IGNORE';
784 my $oldAutoCommit = $FS::UID::AutoCommit;
785 local $FS::UID::AutoCommit = 0;
788 unless ( ref($prepay_credit) ) {
790 my $identifier = $prepay_credit;
792 $prepay_credit = qsearchs(
794 { 'identifier' => $identifier },
799 unless ( $prepay_credit ) {
800 $dbh->rollback if $oldAutoCommit;
801 return "Invalid prepaid card: ". $identifier;
806 if ( $prepay_credit->agentnum ) {
807 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
808 $dbh->rollback if $oldAutoCommit;
809 return "prepaid card not valid for agent ". $self->agentnum;
811 $self->agentnum($prepay_credit->agentnum);
814 my $error = $prepay_credit->delete;
816 $dbh->rollback if $oldAutoCommit;
817 return "removing prepay_credit (transaction rolled back): $error";
820 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
821 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
823 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
828 =item increment_upbytes SECONDS
830 Updates this customer's single or primary account (see L<FS::svc_acct>) by
831 the specified number of upbytes. If there is an error, returns the error,
832 otherwise returns false.
836 sub increment_upbytes {
837 _increment_column( shift, 'upbytes', @_);
840 =item increment_downbytes SECONDS
842 Updates this customer's single or primary account (see L<FS::svc_acct>) by
843 the specified number of downbytes. If there is an error, returns the error,
844 otherwise returns false.
848 sub increment_downbytes {
849 _increment_column( shift, 'downbytes', @_);
852 =item increment_totalbytes SECONDS
854 Updates this customer's single or primary account (see L<FS::svc_acct>) by
855 the specified number of totalbytes. If there is an error, returns the error,
856 otherwise returns false.
860 sub increment_totalbytes {
861 _increment_column( shift, 'totalbytes', @_);
864 =item increment_seconds SECONDS
866 Updates this customer's single or primary account (see L<FS::svc_acct>) by
867 the specified number of seconds. If there is an error, returns the error,
868 otherwise returns false.
872 sub increment_seconds {
873 _increment_column( shift, 'seconds', @_);
876 =item _increment_column AMOUNT
878 Updates this customer's single or primary account (see L<FS::svc_acct>) by
879 the specified number of seconds or bytes. If there is an error, returns
880 the error, otherwise returns false.
884 sub _increment_column {
885 my( $self, $column, $amount ) = @_;
886 warn "$me increment_column called: $column, $amount\n"
889 return '' unless $amount;
891 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
892 $self->ncancelled_pkgs;
895 return 'No packages with primary or single services found'.
896 ' to apply pre-paid time';
897 } elsif ( scalar(@cust_pkg) > 1 ) {
898 #maybe have a way to specify the package/account?
899 return 'Multiple packages found to apply pre-paid time';
902 my $cust_pkg = $cust_pkg[0];
903 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
907 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
910 return 'No account found to apply pre-paid time';
911 } elsif ( scalar(@cust_svc) > 1 ) {
912 return 'Multiple accounts found to apply pre-paid time';
915 my $svc_acct = $cust_svc[0]->svc_x;
916 warn " found service svcnum ". $svc_acct->pkgnum.
917 ' ('. $svc_acct->email. ")\n"
920 $column = "increment_$column";
921 $svc_acct->$column($amount);
925 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
927 Inserts a prepayment in the specified amount for this customer. An optional
928 second argument can specify the prepayment identifier for tracking purposes.
929 If there is an error, returns the error, otherwise returns false.
933 sub insert_cust_pay_prepay {
934 shift->insert_cust_pay('PREP', @_);
937 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
939 Inserts a cash payment in the specified amount for this customer. An optional
940 second argument can specify the payment identifier for tracking purposes.
941 If there is an error, returns the error, otherwise returns false.
945 sub insert_cust_pay_cash {
946 shift->insert_cust_pay('CASH', @_);
949 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
951 Inserts a Western Union payment in the specified amount for this customer. An
952 optional second argument can specify the prepayment identifier for tracking
953 purposes. If there is an error, returns the error, otherwise returns false.
957 sub insert_cust_pay_west {
958 shift->insert_cust_pay('WEST', @_);
961 sub insert_cust_pay {
962 my( $self, $payby, $amount ) = splice(@_, 0, 3);
963 my $payinfo = scalar(@_) ? shift : '';
965 my $cust_pay = new FS::cust_pay {
966 'custnum' => $self->custnum,
967 'paid' => sprintf('%.2f', $amount),
968 #'_date' => #date the prepaid card was purchased???
970 'payinfo' => $payinfo,
978 This method is deprecated. See the I<depend_jobnum> option to the insert and
979 order_pkgs methods for a better way to defer provisioning.
981 Re-schedules all exports by calling the B<reexport> method of all associated
982 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
983 otherwise returns false.
990 carp "WARNING: FS::cust_main::reexport is deprectated; ".
991 "use the depend_jobnum option to insert or order_pkgs to delay export";
993 local $SIG{HUP} = 'IGNORE';
994 local $SIG{INT} = 'IGNORE';
995 local $SIG{QUIT} = 'IGNORE';
996 local $SIG{TERM} = 'IGNORE';
997 local $SIG{TSTP} = 'IGNORE';
998 local $SIG{PIPE} = 'IGNORE';
1000 my $oldAutoCommit = $FS::UID::AutoCommit;
1001 local $FS::UID::AutoCommit = 0;
1004 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1005 my $error = $cust_pkg->reexport;
1007 $dbh->rollback if $oldAutoCommit;
1012 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1017 =item delete [ OPTION => VALUE ... ]
1019 This deletes the customer. If there is an error, returns the error, otherwise
1022 This will completely remove all traces of the customer record. This is not
1023 what you want when a customer cancels service; for that, cancel all of the
1024 customer's packages (see L</cancel>).
1026 If the customer has any uncancelled packages, you need to pass a new (valid)
1027 customer number for those packages to be transferred to, as the "new_customer"
1028 option. Cancelled packages will be deleted. Did I mention that this is NOT
1029 what you want when a customer cancels service and that you really should be
1030 looking at L<FS::cust_pkg/cancel>?
1032 You can't delete a customer with invoices (see L<FS::cust_bill>),
1033 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1034 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1035 set the "delete_financials" option to a true value.
1040 my( $self, %opt ) = @_;
1042 local $SIG{HUP} = 'IGNORE';
1043 local $SIG{INT} = 'IGNORE';
1044 local $SIG{QUIT} = 'IGNORE';
1045 local $SIG{TERM} = 'IGNORE';
1046 local $SIG{TSTP} = 'IGNORE';
1047 local $SIG{PIPE} = 'IGNORE';
1049 my $oldAutoCommit = $FS::UID::AutoCommit;
1050 local $FS::UID::AutoCommit = 0;
1053 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1054 $dbh->rollback if $oldAutoCommit;
1055 return "Can't delete a master agent customer";
1058 #use FS::access_user
1059 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1060 $dbh->rollback if $oldAutoCommit;
1061 return "Can't delete a master employee customer";
1064 tie my %financial_tables, 'Tie::IxHash',
1065 'cust_bill' => 'invoices',
1066 'cust_statement' => 'statements',
1067 'cust_credit' => 'credits',
1068 'cust_pay' => 'payments',
1069 'cust_refund' => 'refunds',
1072 foreach my $table ( keys %financial_tables ) {
1074 my @records = $self->$table();
1076 if ( @records && ! $opt{'delete_financials'} ) {
1077 $dbh->rollback if $oldAutoCommit;
1078 return "Can't delete a customer with ". $financial_tables{$table};
1081 foreach my $record ( @records ) {
1082 my $error = $record->delete;
1084 $dbh->rollback if $oldAutoCommit;
1085 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1091 my @cust_pkg = $self->ncancelled_pkgs;
1093 my $new_custnum = $opt{'new_custnum'};
1094 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1095 $dbh->rollback if $oldAutoCommit;
1096 return "Invalid new customer number: $new_custnum";
1098 foreach my $cust_pkg ( @cust_pkg ) {
1099 my %hash = $cust_pkg->hash;
1100 $hash{'custnum'} = $new_custnum;
1101 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1102 my $error = $new_cust_pkg->replace($cust_pkg,
1103 options => { $cust_pkg->options },
1106 $dbh->rollback if $oldAutoCommit;
1111 my @cancelled_cust_pkg = $self->all_pkgs;
1112 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1113 my $error = $cust_pkg->delete;
1115 $dbh->rollback if $oldAutoCommit;
1120 #cust_tax_adjustment in financials?
1121 #cust_pay_pending? ouch
1123 foreach my $table (qw(
1124 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1125 cust_location cust_main_note cust_tax_adjustment
1126 cust_pay_void cust_pay_batch queue cust_tax_exempt
1128 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1129 my $error = $record->delete;
1131 $dbh->rollback if $oldAutoCommit;
1137 my $sth = $dbh->prepare(
1138 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1140 my $errstr = $dbh->errstr;
1141 $dbh->rollback if $oldAutoCommit;
1144 $sth->execute($self->custnum) or do {
1145 my $errstr = $sth->errstr;
1146 $dbh->rollback if $oldAutoCommit;
1152 my $ticket_dbh = '';
1153 if ($conf->config('ticket_system') eq 'RT_Internal') {
1155 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1156 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1157 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1158 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1161 if ( $ticket_dbh ) {
1163 my $ticket_sth = $ticket_dbh->prepare(
1164 'DELETE FROM Links WHERE Target = ?'
1166 my $errstr = $ticket_dbh->errstr;
1167 $dbh->rollback if $oldAutoCommit;
1170 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1172 my $errstr = $ticket_sth->errstr;
1173 $dbh->rollback if $oldAutoCommit;
1177 #check and see if the customer is the only link on the ticket, and
1178 #if so, set the ticket to deleted status in RT?
1179 #maybe someday, for now this will at least fix tickets not displaying
1183 #delete the customer record
1185 my $error = $self->SUPER::delete;
1187 $dbh->rollback if $oldAutoCommit;
1191 # cust_main exports!
1193 #my $export_args = $options{'export_args'} || [];
1196 map qsearch( 'part_export', {exportnum=>$_} ),
1197 $conf->config('cust_main-exports'); #, $agentnum
1199 foreach my $part_export ( @part_export ) {
1200 my $error = $part_export->export_delete( $self ); #, @$export_args);
1202 $dbh->rollback if $oldAutoCommit;
1203 return "exporting to ". $part_export->exporttype.
1204 " (transaction rolled back): $error";
1208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1213 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1215 This merges this customer into the provided new custnum, and then deletes the
1216 customer. If there is an error, returns the error, otherwise returns false.
1218 The source customer's name, company name, phone numbers, agent,
1219 referring customer, customer class, advertising source, order taker, and
1220 billing information (except balance) are discarded.
1222 All packages are moved to the target customer. Packages with package locations
1223 are preserved. Packages without package locations are moved to a new package
1224 location with the source customer's service/shipping address.
1226 All invoices, statements, payments, credits and refunds are moved to the target
1227 customer. The source customer's balance is added to the target customer.
1229 All notes, attachments, tickets and customer tags are moved to the target
1232 Change history is not currently moved.
1237 my( $self, $new_custnum, %opt ) = @_;
1239 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1241 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1242 return "Invalid new customer number: $new_custnum";
1245 local $SIG{HUP} = 'IGNORE';
1246 local $SIG{INT} = 'IGNORE';
1247 local $SIG{QUIT} = 'IGNORE';
1248 local $SIG{TERM} = 'IGNORE';
1249 local $SIG{TSTP} = 'IGNORE';
1250 local $SIG{PIPE} = 'IGNORE';
1252 my $oldAutoCommit = $FS::UID::AutoCommit;
1253 local $FS::UID::AutoCommit = 0;
1256 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1257 $dbh->rollback if $oldAutoCommit;
1258 return "Can't merge a master agent customer";
1261 #use FS::access_user
1262 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1263 $dbh->rollback if $oldAutoCommit;
1264 return "Can't merge a master employee customer";
1267 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1268 'status' => { op=>'!=', value=>'done' },
1272 $dbh->rollback if $oldAutoCommit;
1273 return "Can't merge a customer with pending payments";
1276 tie my %financial_tables, 'Tie::IxHash',
1277 'cust_bill' => 'invoices',
1278 'cust_statement' => 'statements',
1279 'cust_credit' => 'credits',
1280 'cust_pay' => 'payments',
1281 'cust_pay_void' => 'voided payments',
1282 'cust_refund' => 'refunds',
1285 foreach my $table ( keys %financial_tables ) {
1287 my @records = $self->$table();
1289 foreach my $record ( @records ) {
1290 $record->custnum($new_custnum);
1291 my $error = $record->replace;
1293 $dbh->rollback if $oldAutoCommit;
1294 return "Error merging ". $financial_tables{$table}. ": $error\n";
1300 my $name = $self->ship_name;
1302 my $locationnum = '';
1303 foreach my $cust_pkg ( $self->all_pkgs ) {
1304 $cust_pkg->custnum($new_custnum);
1306 unless ( $cust_pkg->locationnum ) {
1307 unless ( $locationnum ) {
1308 my $cust_location = new FS::cust_location {
1309 $self->location_hash,
1310 'custnum' => $new_custnum,
1312 my $error = $cust_location->insert;
1314 $dbh->rollback if $oldAutoCommit;
1317 $locationnum = $cust_location->locationnum;
1319 $cust_pkg->locationnum($locationnum);
1322 my $error = $cust_pkg->replace;
1324 $dbh->rollback if $oldAutoCommit;
1328 # add customer (ship) name to svc_phone.phone_name if blank
1329 my @cust_svc = $cust_pkg->cust_svc;
1330 foreach my $cust_svc (@cust_svc) {
1331 my($label, $value, $svcdb) = $cust_svc->label;
1332 next unless $svcdb eq 'svc_phone';
1333 my $svc_phone = $cust_svc->svc_x;
1334 next if $svc_phone->phone_name;
1335 $svc_phone->phone_name($name);
1336 my $error = $svc_phone->replace;
1338 $dbh->rollback if $oldAutoCommit;
1346 # cust_tax_exempt (texas tax exemptions)
1347 # cust_recon (some sort of not-well understood thing for OnPac)
1349 #these are moved over
1350 foreach my $table (qw(
1351 cust_tag cust_location contact cust_attachment cust_main_note
1352 cust_tax_adjustment cust_pay_batch queue
1354 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1355 $record->custnum($new_custnum);
1356 my $error = $record->replace;
1358 $dbh->rollback if $oldAutoCommit;
1364 #these aren't preserved
1365 foreach my $table (qw(
1366 cust_main_exemption cust_main_invoice
1368 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1369 my $error = $record->delete;
1371 $dbh->rollback if $oldAutoCommit;
1378 my $sth = $dbh->prepare(
1379 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1381 my $errstr = $dbh->errstr;
1382 $dbh->rollback if $oldAutoCommit;
1385 $sth->execute($new_custnum, $self->custnum) or do {
1386 my $errstr = $sth->errstr;
1387 $dbh->rollback if $oldAutoCommit;
1393 my $ticket_dbh = '';
1394 if ($conf->config('ticket_system') eq 'RT_Internal') {
1396 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1397 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1398 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1399 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1402 if ( $ticket_dbh ) {
1404 my $ticket_sth = $ticket_dbh->prepare(
1405 'UPDATE Links SET Target = ? WHERE Target = ?'
1407 my $errstr = $ticket_dbh->errstr;
1408 $dbh->rollback if $oldAutoCommit;
1411 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1412 'freeside://freeside/cust_main/'.$self->custnum)
1414 my $errstr = $ticket_sth->errstr;
1415 $dbh->rollback if $oldAutoCommit;
1421 #delete the customer record
1423 my $error = $self->delete;
1425 $dbh->rollback if $oldAutoCommit;
1429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1434 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1437 Replaces the OLD_RECORD with this one in the database. If there is an error,
1438 returns the error, otherwise returns false.
1440 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1441 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1442 expected and rollback the entire transaction; it is not necessary to call
1443 check_invoicing_list first. Here's an example:
1445 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1447 Currently available options are: I<tax_exemption>.
1449 The I<tax_exemption> option can be set to an arrayref of tax names.
1450 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1457 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1459 : $self->replace_old;
1463 warn "$me replace called\n"
1466 my $curuser = $FS::CurrentUser::CurrentUser;
1467 if ( $self->payby eq 'COMP'
1468 && $self->payby ne $old->payby
1469 && ! $curuser->access_right('Complimentary customer')
1472 return "You are not permitted to create complimentary accounts.";
1475 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1476 && $conf->exists('enable_taxproducts')
1479 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1481 $self->set('geocode', '')
1482 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1483 && length($self->get($pre.'zip')) >= 10;
1486 for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1488 $self->set($pre.'coord_auto', '') && next
1489 if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1490 && ( $self->get($pre.'latitude') != $old->get($pre.'latitude')
1491 || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1494 $self->set_coord($pre)
1495 if $old->get($pre.'address1') ne $self->get($pre.'address1')
1496 || $old->get($pre.'city') ne $self->get($pre.'city')
1497 || $old->get($pre.'state') ne $self->get($pre.'state')
1498 || $old->get($pre.'country') ne $self->get($pre.'country');
1503 if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1505 $self->set_coord('ship_')
1506 if $self->has_ship_address && ! $self->ship_coord_auto
1507 && ! $self->ship_latitude && ! $self->ship_longitude;
1509 local($ignore_expired_card) = 1
1510 if $old->payby =~ /^(CARD|DCRD)$/
1511 && $self->payby =~ /^(CARD|DCRD)$/
1512 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1514 local($ignore_banned_card) = 1
1515 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1516 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1517 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1519 if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1520 # update censusyear whenever tract code changes
1521 $self->censusyear($conf->config('census_year'));
1525 local $SIG{HUP} = 'IGNORE';
1526 local $SIG{INT} = 'IGNORE';
1527 local $SIG{QUIT} = 'IGNORE';
1528 local $SIG{TERM} = 'IGNORE';
1529 local $SIG{TSTP} = 'IGNORE';
1530 local $SIG{PIPE} = 'IGNORE';
1532 my $oldAutoCommit = $FS::UID::AutoCommit;
1533 local $FS::UID::AutoCommit = 0;
1536 my $error = $self->SUPER::replace($old);
1539 $dbh->rollback if $oldAutoCommit;
1543 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1544 my $invoicing_list = shift @param;
1545 $error = $self->check_invoicing_list( $invoicing_list );
1547 $dbh->rollback if $oldAutoCommit;
1550 $self->invoicing_list( $invoicing_list );
1553 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1555 #this could be more efficient than deleting and re-inserting, if it matters
1556 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1557 my $error = $cust_tag->delete;
1559 $dbh->rollback if $oldAutoCommit;
1563 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1564 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1565 'custnum' => $self->custnum };
1566 my $error = $cust_tag->insert;
1568 $dbh->rollback if $oldAutoCommit;
1575 my %options = @param;
1577 my $tax_exemption = delete $options{'tax_exemption'};
1578 if ( $tax_exemption ) {
1580 my %cust_main_exemption =
1581 map { $_->taxname => $_ }
1582 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1584 foreach my $taxname ( @$tax_exemption ) {
1586 next if delete $cust_main_exemption{$taxname};
1588 my $cust_main_exemption = new FS::cust_main_exemption {
1589 'custnum' => $self->custnum,
1590 'taxname' => $taxname,
1592 my $error = $cust_main_exemption->insert;
1594 $dbh->rollback if $oldAutoCommit;
1595 return "inserting cust_main_exemption (transaction rolled back): $error";
1599 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1600 my $error = $cust_main_exemption->delete;
1602 $dbh->rollback if $oldAutoCommit;
1603 return "deleting cust_main_exemption (transaction rolled back): $error";
1609 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1610 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1611 && $self->get('payinfo') !~ /^99\d{14}$/
1613 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1618 # card/check/lec info has changed, want to retry realtime_ invoice events
1619 my $error = $self->retry_realtime;
1621 $dbh->rollback if $oldAutoCommit;
1626 unless ( $import || $skip_fuzzyfiles ) {
1627 $error = $self->queue_fuzzyfiles_update;
1629 $dbh->rollback if $oldAutoCommit;
1630 return "updating fuzzy search cache: $error";
1634 # cust_main exports!
1636 my $export_args = $options{'export_args'} || [];
1639 map qsearch( 'part_export', {exportnum=>$_} ),
1640 $conf->config('cust_main-exports'); #, $agentnum
1642 foreach my $part_export ( @part_export ) {
1643 my $error = $part_export->export_replace( $self, $old, @$export_args);
1645 $dbh->rollback if $oldAutoCommit;
1646 return "exporting to ". $part_export->exporttype.
1647 " (transaction rolled back): $error";
1651 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1656 =item queue_fuzzyfiles_update
1658 Used by insert & replace to update the fuzzy search cache
1662 use FS::cust_main::Search;
1663 sub queue_fuzzyfiles_update {
1666 local $SIG{HUP} = 'IGNORE';
1667 local $SIG{INT} = 'IGNORE';
1668 local $SIG{QUIT} = 'IGNORE';
1669 local $SIG{TERM} = 'IGNORE';
1670 local $SIG{TSTP} = 'IGNORE';
1671 local $SIG{PIPE} = 'IGNORE';
1673 my $oldAutoCommit = $FS::UID::AutoCommit;
1674 local $FS::UID::AutoCommit = 0;
1677 my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1678 my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1680 $dbh->rollback if $oldAutoCommit;
1681 return "queueing job (transaction rolled back): $error";
1684 if ( $self->ship_last ) {
1685 $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1686 $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1688 $dbh->rollback if $oldAutoCommit;
1689 return "queueing job (transaction rolled back): $error";
1693 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1700 Checks all fields to make sure this is a valid customer record. If there is
1701 an error, returns the error, otherwise returns false. Called by the insert
1702 and replace methods.
1709 warn "$me check BEFORE: \n". $self->_dump
1713 $self->ut_numbern('custnum')
1714 || $self->ut_number('agentnum')
1715 || $self->ut_textn('agent_custid')
1716 || $self->ut_number('refnum')
1717 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1718 || $self->ut_textn('custbatch')
1719 || $self->ut_name('last')
1720 || $self->ut_name('first')
1721 || $self->ut_snumbern('birthdate')
1722 || $self->ut_snumbern('signupdate')
1723 || $self->ut_textn('company')
1724 || $self->ut_text('address1')
1725 || $self->ut_textn('address2')
1726 || $self->ut_text('city')
1727 || $self->ut_textn('county')
1728 || $self->ut_textn('state')
1729 || $self->ut_country('country')
1730 || $self->ut_coordn('latitude')
1731 || $self->ut_coordn('longitude')
1732 || $self->ut_enum('coord_auto', [ '', 'Y' ])
1733 || $self->ut_numbern('censusyear')
1734 || $self->ut_anything('comments')
1735 || $self->ut_numbern('referral_custnum')
1736 || $self->ut_textn('stateid')
1737 || $self->ut_textn('stateid_state')
1738 || $self->ut_textn('invoice_terms')
1739 || $self->ut_alphan('geocode')
1740 || $self->ut_floatn('cdr_termination_percentage')
1741 || $self->ut_floatn('credit_limit')
1742 || $self->ut_numbern('billday')
1743 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1744 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1745 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1749 unless $import || ($self->latitude && $self->longitude);
1751 #barf. need message catalogs. i18n. etc.
1752 $error .= "Please select an advertising source."
1753 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1754 return $error if $error;
1756 return "Unknown agent"
1757 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1759 return "Unknown refnum"
1760 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1762 return "Unknown referring custnum: ". $self->referral_custnum
1763 unless ! $self->referral_custnum
1764 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1766 if ( $self->censustract ne '' ) {
1767 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1768 or return "Illegal census tract: ". $self->censustract;
1770 $self->censustract("$1.$2");
1773 if ( $self->ss eq '' ) {
1778 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1779 or return "Illegal social security number: ". $self->ss;
1780 $self->ss("$1-$2-$3");
1784 # bad idea to disable, causes billing to fail because of no tax rates later
1785 # except we don't fail any more
1786 unless ( $import ) {
1787 unless ( qsearch('cust_main_county', {
1788 'country' => $self->country,
1791 return "Unknown state/county/country: ".
1792 $self->state. "/". $self->county. "/". $self->country
1793 unless qsearch('cust_main_county',{
1794 'state' => $self->state,
1795 'county' => $self->county,
1796 'country' => $self->country,
1802 $self->ut_phonen('daytime', $self->country)
1803 || $self->ut_phonen('night', $self->country)
1804 || $self->ut_phonen('fax', $self->country)
1805 || $self->ut_phonen('mobile', $self->country)
1807 return $error if $error;
1809 unless ( $ignore_illegal_zip ) {
1810 $error = $self->ut_zip('zip', $self->country);
1811 return $error if $error;
1814 if ( $conf->exists('cust_main-require_phone')
1815 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1818 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1820 : FS::Msgcat::_gettext('daytime');
1821 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1823 : FS::Msgcat::_gettext('night');
1825 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1827 : FS::Msgcat::_gettext('mobile');
1829 return "$daytime_label, $night_label or $mobile_label is required"
1833 if ( $self->has_ship_address
1834 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1835 $self->addr_fields )
1839 $self->ut_name('ship_last')
1840 || $self->ut_name('ship_first')
1841 || $self->ut_textn('ship_company')
1842 || $self->ut_text('ship_address1')
1843 || $self->ut_textn('ship_address2')
1844 || $self->ut_text('ship_city')
1845 || $self->ut_textn('ship_county')
1846 || $self->ut_textn('ship_state')
1847 || $self->ut_country('ship_country')
1848 || $self->ut_coordn('ship_latitude')
1849 || $self->ut_coordn('ship_longitude')
1850 || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1852 return $error if $error;
1854 $self->set_coord('ship_')
1855 unless $import || ($self->ship_latitude && $self->ship_longitude);
1857 #false laziness with above
1858 unless ( qsearchs('cust_main_county', {
1859 'country' => $self->ship_country,
1862 return "Unknown ship_state/ship_county/ship_country: ".
1863 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1864 unless qsearch('cust_main_county',{
1865 'state' => $self->ship_state,
1866 'county' => $self->ship_county,
1867 'country' => $self->ship_country,
1873 $self->ut_phonen('ship_daytime', $self->ship_country)
1874 || $self->ut_phonen('ship_night', $self->ship_country)
1875 || $self->ut_phonen('ship_fax', $self->ship_country)
1876 || $self->ut_phonen('ship_mobile', $self->ship_country)
1878 return $error if $error;
1880 unless ( $ignore_illegal_zip ) {
1881 $error = $self->ut_zip('ship_zip', $self->ship_country);
1882 return $error if $error;
1884 return "Unit # is required."
1885 if $self->ship_address2 =~ /^\s*$/
1886 && $conf->exists('cust_main-require_address2');
1888 } else { # ship_ info eq billing info, so don't store dup info in database
1890 $self->setfield("ship_$_", '')
1891 foreach $self->addr_fields;
1893 return "Unit # is required."
1894 if $self->address2 =~ /^\s*$/
1895 && $conf->exists('cust_main-require_address2');
1899 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1900 # or return "Illegal payby: ". $self->payby;
1902 FS::payby->can_payby($self->table, $self->payby)
1903 or return "Illegal payby: ". $self->payby;
1905 $error = $self->ut_numbern('paystart_month')
1906 || $self->ut_numbern('paystart_year')
1907 || $self->ut_numbern('payissue')
1908 || $self->ut_textn('paytype')
1910 return $error if $error;
1912 if ( $self->payip eq '' ) {
1915 $error = $self->ut_ip('payip');
1916 return $error if $error;
1919 # If it is encrypted and the private key is not availaible then we can't
1920 # check the credit card.
1921 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1923 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1925 my $payinfo = $self->payinfo;
1926 $payinfo =~ s/\D//g;
1927 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1928 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1930 $self->payinfo($payinfo);
1932 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1934 return gettext('unknown_card_type')
1935 if $self->payinfo !~ /^99\d{14}$/ #token
1936 && cardtype($self->payinfo) eq "Unknown";
1938 unless ( $ignore_banned_card ) {
1939 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1941 if ( $ban->bantype eq 'warn' ) {
1942 #or others depending on value of $ban->reason ?
1943 return '_duplicate_card'.
1944 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1945 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1946 ' (ban# '. $ban->bannum. ')'
1947 unless $self->override_ban_warn;
1949 return 'Banned credit card: banned on '.
1950 time2str('%a %h %o at %r', $ban->_date).
1951 ' by '. $ban->otaker.
1952 ' (ban# '. $ban->bannum. ')';
1957 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1958 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1959 $self->paycvv =~ /^(\d{4})$/
1960 or return "CVV2 (CID) for American Express cards is four digits.";
1963 $self->paycvv =~ /^(\d{3})$/
1964 or return "CVV2 (CVC2/CID) is three digits.";
1971 my $cardtype = cardtype($payinfo);
1972 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1974 return "Start date or issue number is required for $cardtype cards"
1975 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1977 return "Start month must be between 1 and 12"
1978 if $self->paystart_month
1979 and $self->paystart_month < 1 || $self->paystart_month > 12;
1981 return "Start year must be 1990 or later"
1982 if $self->paystart_year
1983 and $self->paystart_year < 1990;
1985 return "Issue number must be beween 1 and 99"
1987 and $self->payissue < 1 || $self->payissue > 99;
1990 $self->paystart_month('');
1991 $self->paystart_year('');
1992 $self->payissue('');
1995 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1997 my $payinfo = $self->payinfo;
1998 $payinfo =~ s/[^\d\@\.]//g;
1999 if ( $conf->exists('cust_main-require-bank-branch') ) {
2000 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
2001 $payinfo = "$1\@$2.$3";
2002 } elsif ( $conf->exists('echeck-nonus') ) {
2003 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
2004 $payinfo = "$1\@$2";
2006 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2007 $payinfo = "$1\@$2";
2009 $self->payinfo($payinfo);
2012 unless ( $ignore_banned_card ) {
2013 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2015 if ( $ban->bantype eq 'warn' ) {
2016 #or others depending on value of $ban->reason ?
2017 return '_duplicate_ach' unless $self->override_ban_warn;
2019 return 'Banned ACH account: banned on '.
2020 time2str('%a %h %o at %r', $ban->_date).
2021 ' by '. $ban->otaker.
2022 ' (ban# '. $ban->bannum. ')';
2027 } elsif ( $self->payby eq 'LECB' ) {
2029 my $payinfo = $self->payinfo;
2030 $payinfo =~ s/\D//g;
2031 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2033 $self->payinfo($payinfo);
2036 } elsif ( $self->payby eq 'BILL' ) {
2038 $error = $self->ut_textn('payinfo');
2039 return "Illegal P.O. number: ". $self->payinfo if $error;
2042 } elsif ( $self->payby eq 'COMP' ) {
2044 my $curuser = $FS::CurrentUser::CurrentUser;
2045 if ( ! $self->custnum
2046 && ! $curuser->access_right('Complimentary customer')
2049 return "You are not permitted to create complimentary accounts."
2052 $error = $self->ut_textn('payinfo');
2053 return "Illegal comp account issuer: ". $self->payinfo if $error;
2056 } elsif ( $self->payby eq 'PREPAY' ) {
2058 my $payinfo = $self->payinfo;
2059 $payinfo =~ s/\W//g; #anything else would just confuse things
2060 $self->payinfo($payinfo);
2061 $error = $self->ut_alpha('payinfo');
2062 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2063 return "Unknown prepayment identifier"
2064 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2069 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2070 return "Expiration date required"
2071 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2075 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2076 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2077 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2078 ( $m, $y ) = ( $2, "19$1" );
2079 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2080 ( $m, $y ) = ( $3, "20$2" );
2082 return "Illegal expiration date: ". $self->paydate;
2084 $m = sprintf('%02d',$m);
2085 $self->paydate("$y-$m-01");
2086 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2087 return gettext('expired_card')
2089 && !$ignore_expired_card
2090 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2093 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2094 ( ! $conf->exists('require_cardname')
2095 || $self->payby !~ /^(CARD|DCRD)$/ )
2097 $self->payname( $self->first. " ". $self->getfield('last') );
2099 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2100 or return gettext('illegal_name'). " payname: ". $self->payname;
2104 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2105 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2109 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2111 warn "$me check AFTER: \n". $self->_dump
2114 $self->SUPER::check;
2119 Returns a list of fields which have ship_ duplicates.
2124 qw( last first company
2125 address1 address2 city county state zip country
2127 daytime night fax mobile
2131 =item has_ship_address
2133 Returns true if this customer record has a separate shipping address.
2137 sub has_ship_address {
2139 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2144 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2145 city, county, state, zip, country, and geocode. The shipping address is used if present.
2151 Returns all locations (see L<FS::cust_location>) for this customer.
2157 qsearch('cust_location', { 'custnum' => $self->custnum } );
2162 Returns all contacts (see L<FS::contact>) for this customer.
2166 #already used :/ sub contact {
2169 qsearch('contact', { 'custnum' => $self->custnum } );
2174 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2175 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2176 on success or a list of errors.
2182 grep { $_->unsuspend } $self->suspended_pkgs;
2187 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2189 Returns a list: an empty list on success or a list of errors.
2195 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2198 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2200 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2201 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2202 of a list of pkgparts; the hashref has the following keys:
2206 =item pkgparts - listref of pkgparts
2208 =item (other options are passed to the suspend method)
2213 Returns a list: an empty list on success or a list of errors.
2217 sub suspend_if_pkgpart {
2219 my (@pkgparts, %opt);
2220 if (ref($_[0]) eq 'HASH'){
2221 @pkgparts = @{$_[0]{pkgparts}};
2226 grep { $_->suspend(%opt) }
2227 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2228 $self->unsuspended_pkgs;
2231 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2233 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2234 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2235 instead of a list of pkgparts; the hashref has the following keys:
2239 =item pkgparts - listref of pkgparts
2241 =item (other options are passed to the suspend method)
2245 Returns a list: an empty list on success or a list of errors.
2249 sub suspend_unless_pkgpart {
2251 my (@pkgparts, %opt);
2252 if (ref($_[0]) eq 'HASH'){
2253 @pkgparts = @{$_[0]{pkgparts}};
2258 grep { $_->suspend(%opt) }
2259 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2260 $self->unsuspended_pkgs;
2263 =item cancel [ OPTION => VALUE ... ]
2265 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2267 Available options are:
2271 =item quiet - can be set true to supress email cancellation notices.
2273 =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.
2275 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2277 =item nobill - can be set true to skip billing if it might otherwise be done.
2281 Always returns a list: an empty list on success or a list of errors.
2285 # nb that dates are not specified as valid options to this method
2288 my( $self, %opt ) = @_;
2290 warn "$me cancel called on customer ". $self->custnum. " with options ".
2291 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2294 return ( 'access denied' )
2295 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2297 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2299 #should try decryption (we might have the private key)
2300 # and if not maybe queue a job for the server that does?
2301 return ( "Can't (yet) ban encrypted credit cards" )
2302 if $self->is_encrypted($self->payinfo);
2304 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2305 my $error = $ban->insert;
2306 return ( $error ) if $error;
2310 my @pkgs = $self->ncancelled_pkgs;
2312 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2314 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2315 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2319 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2320 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2323 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2326 sub _banned_pay_hashref {
2337 'payby' => $payby2ban{$self->payby},
2338 'payinfo' => $self->payinfo,
2339 #don't ever *search* on reason! #'reason' =>
2343 sub _new_banned_pay_hashref {
2345 my $hr = $self->_banned_pay_hashref;
2346 $hr->{payinfo} = md5_base64($hr->{payinfo});
2352 Returns all notes (see L<FS::cust_main_note>) for this customer.
2357 my($self,$orderby_classnum) = (shift,shift);
2358 my $orderby = "_DATE DESC";
2359 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2360 qsearch( 'cust_main_note',
2361 { 'custnum' => $self->custnum },
2363 "ORDER BY $orderby",
2369 Returns the agent (see L<FS::agent>) for this customer.
2375 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2380 Returns the agent name (see L<FS::agent>) for this customer.
2386 $self->agent->agent;
2391 Returns any tags associated with this customer, as FS::cust_tag objects,
2392 or an empty list if there are no tags.
2398 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2403 Returns any tags associated with this customer, as FS::part_tag objects,
2404 or an empty list if there are no tags.
2410 map $_->part_tag, $self->cust_tag;
2416 Returns the customer class, as an FS::cust_class object, or the empty string
2417 if there is no customer class.
2423 if ( $self->classnum ) {
2424 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2432 Returns the customer category name, or the empty string if there is no customer
2439 my $cust_class = $self->cust_class;
2441 ? $cust_class->categoryname
2447 Returns the customer class name, or the empty string if there is no customer
2454 my $cust_class = $self->cust_class;
2456 ? $cust_class->classname
2460 =item BILLING METHODS
2462 Documentation on billing methods has been moved to
2463 L<FS::cust_main::Billing>.
2465 =item REALTIME BILLING METHODS
2467 Documentation on realtime billing methods has been moved to
2468 L<FS::cust_main::Billing_Realtime>.
2472 Removes the I<paycvv> field from the database directly.
2474 If there is an error, returns the error, otherwise returns false.
2480 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2481 or return dbh->errstr;
2482 $sth->execute($self->custnum)
2483 or return $sth->errstr;
2488 =item batch_card OPTION => VALUE...
2490 Adds a payment for this invoice to the pending credit card batch (see
2491 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2492 runs the payment using a realtime gateway.
2497 my ($self, %options) = @_;
2500 if (exists($options{amount})) {
2501 $amount = $options{amount};
2503 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2505 return '' unless $amount > 0;
2507 my $invnum = delete $options{invnum};
2508 my $payby = $options{payby} || $self->payby; #still dubious
2510 if ($options{'realtime'}) {
2511 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2517 my $oldAutoCommit = $FS::UID::AutoCommit;
2518 local $FS::UID::AutoCommit = 0;
2521 #this needs to handle mysql as well as Pg, like svc_acct.pm
2522 #(make it into a common function if folks need to do batching with mysql)
2523 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2524 or return "Cannot lock pay_batch: " . $dbh->errstr;
2528 'payby' => FS::payby->payby2payment($payby),
2530 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2532 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2534 unless ( $pay_batch ) {
2535 $pay_batch = new FS::pay_batch \%pay_batch;
2536 my $error = $pay_batch->insert;
2538 $dbh->rollback if $oldAutoCommit;
2539 die "error creating new batch: $error\n";
2543 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2544 'batchnum' => $pay_batch->batchnum,
2545 'custnum' => $self->custnum,
2548 foreach (qw( address1 address2 city state zip country latitude longitude
2549 payby payinfo paydate payname ))
2551 $options{$_} = '' unless exists($options{$_});
2554 my $cust_pay_batch = new FS::cust_pay_batch ( {
2555 'batchnum' => $pay_batch->batchnum,
2556 'invnum' => $invnum || 0, # is there a better value?
2557 # this field should be
2559 # cust_bill_pay_batch now
2560 'custnum' => $self->custnum,
2561 'last' => $self->getfield('last'),
2562 'first' => $self->getfield('first'),
2563 'address1' => $options{address1} || $self->address1,
2564 'address2' => $options{address2} || $self->address2,
2565 'city' => $options{city} || $self->city,
2566 'state' => $options{state} || $self->state,
2567 'zip' => $options{zip} || $self->zip,
2568 'country' => $options{country} || $self->country,
2569 'payby' => $options{payby} || $self->payby,
2570 'payinfo' => $options{payinfo} || $self->payinfo,
2571 'exp' => $options{paydate} || $self->paydate,
2572 'payname' => $options{payname} || $self->payname,
2573 'amount' => $amount, # consolidating
2576 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2577 if $old_cust_pay_batch;
2580 if ($old_cust_pay_batch) {
2581 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2583 $error = $cust_pay_batch->insert;
2587 $dbh->rollback if $oldAutoCommit;
2591 my $unapplied = $self->total_unapplied_credits
2592 + $self->total_unapplied_payments
2593 + $self->in_transit_payments;
2594 foreach my $cust_bill ($self->open_cust_bill) {
2595 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2596 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2597 'invnum' => $cust_bill->invnum,
2598 'paybatchnum' => $cust_pay_batch->paybatchnum,
2599 'amount' => $cust_bill->owed,
2602 if ($unapplied >= $cust_bill_pay_batch->amount){
2603 $unapplied -= $cust_bill_pay_batch->amount;
2606 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2607 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2609 $error = $cust_bill_pay_batch->insert;
2611 $dbh->rollback if $oldAutoCommit;
2616 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2622 Returns the total owed for this customer on all invoices
2623 (see L<FS::cust_bill/owed>).
2629 $self->total_owed_date(2145859200); #12/31/2037
2632 =item total_owed_date TIME
2634 Returns the total owed for this customer on all invoices with date earlier than
2635 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2636 see L<Time::Local> and L<Date::Parse> for conversion functions.
2640 sub total_owed_date {
2644 my $custnum = $self->custnum;
2646 my $owed_sql = FS::cust_bill->owed_sql;
2649 SELECT SUM($owed_sql) FROM cust_bill
2650 WHERE custnum = $custnum
2654 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2658 =item total_owed_pkgnum PKGNUM
2660 Returns the total owed on all invoices for this customer's specific package
2661 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2665 sub total_owed_pkgnum {
2666 my( $self, $pkgnum ) = @_;
2667 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2670 =item total_owed_date_pkgnum TIME PKGNUM
2672 Returns the total owed for this customer's specific package when using
2673 experimental package balances on all invoices with date earlier than
2674 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2675 see L<Time::Local> and L<Date::Parse> for conversion functions.
2679 sub total_owed_date_pkgnum {
2680 my( $self, $time, $pkgnum ) = @_;
2683 foreach my $cust_bill (
2684 grep { $_->_date <= $time }
2685 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2687 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2689 sprintf( "%.2f", $total_bill );
2695 Returns the total amount of all payments.
2702 $total += $_->paid foreach $self->cust_pay;
2703 sprintf( "%.2f", $total );
2706 =item total_unapplied_credits
2708 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2709 customer. See L<FS::cust_credit/credited>.
2711 =item total_credited
2713 Old name for total_unapplied_credits. Don't use.
2717 sub total_credited {
2718 #carp "total_credited deprecated, use total_unapplied_credits";
2719 shift->total_unapplied_credits(@_);
2722 sub total_unapplied_credits {
2725 my $custnum = $self->custnum;
2727 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2730 SELECT SUM($unapplied_sql) FROM cust_credit
2731 WHERE custnum = $custnum
2734 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2738 =item total_unapplied_credits_pkgnum PKGNUM
2740 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2741 customer. See L<FS::cust_credit/credited>.
2745 sub total_unapplied_credits_pkgnum {
2746 my( $self, $pkgnum ) = @_;
2747 my $total_credit = 0;
2748 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2749 sprintf( "%.2f", $total_credit );
2753 =item total_unapplied_payments
2755 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2756 See L<FS::cust_pay/unapplied>.
2760 sub total_unapplied_payments {
2763 my $custnum = $self->custnum;
2765 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2768 SELECT SUM($unapplied_sql) FROM cust_pay
2769 WHERE custnum = $custnum
2772 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2776 =item total_unapplied_payments_pkgnum PKGNUM
2778 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2779 specific package when using experimental package balances. See
2780 L<FS::cust_pay/unapplied>.
2784 sub total_unapplied_payments_pkgnum {
2785 my( $self, $pkgnum ) = @_;
2786 my $total_unapplied = 0;
2787 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2788 sprintf( "%.2f", $total_unapplied );
2792 =item total_unapplied_refunds
2794 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2795 customer. See L<FS::cust_refund/unapplied>.
2799 sub total_unapplied_refunds {
2801 my $custnum = $self->custnum;
2803 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2806 SELECT SUM($unapplied_sql) FROM cust_refund
2807 WHERE custnum = $custnum
2810 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2816 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2817 total_unapplied_credits minus total_unapplied_payments).
2823 $self->balance_date_range;
2826 =item balance_date TIME
2828 Returns the balance for this customer, only considering invoices with date
2829 earlier than TIME (total_owed_date minus total_credited minus
2830 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2831 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2838 $self->balance_date_range(shift);
2841 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2843 Returns the balance for this customer, optionally considering invoices with
2844 date earlier than START_TIME, and not later than END_TIME
2845 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2847 Times are specified as SQL fragments or numeric
2848 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2849 L<Date::Parse> for conversion functions. The empty string can be passed
2850 to disable that time constraint completely.
2852 Available options are:
2856 =item unapplied_date
2858 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)
2864 sub balance_date_range {
2866 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2867 ') FROM cust_main WHERE custnum='. $self->custnum;
2868 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2871 =item balance_pkgnum PKGNUM
2873 Returns the balance for this customer's specific package when using
2874 experimental package balances (total_owed plus total_unrefunded, minus
2875 total_unapplied_credits minus total_unapplied_payments)
2879 sub balance_pkgnum {
2880 my( $self, $pkgnum ) = @_;
2883 $self->total_owed_pkgnum($pkgnum)
2884 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2885 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2886 - $self->total_unapplied_credits_pkgnum($pkgnum)
2887 - $self->total_unapplied_payments_pkgnum($pkgnum)
2891 =item in_transit_payments
2893 Returns the total of requests for payments for this customer pending in
2894 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2898 sub in_transit_payments {
2900 my $in_transit_payments = 0;
2901 foreach my $pay_batch ( qsearch('pay_batch', {
2904 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2905 'batchnum' => $pay_batch->batchnum,
2906 'custnum' => $self->custnum,
2908 $in_transit_payments += $cust_pay_batch->amount;
2911 sprintf( "%.2f", $in_transit_payments );
2916 Returns a hash of useful information for making a payment.
2926 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2927 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2928 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2932 For credit card transactions:
2944 For electronic check transactions:
2959 $return{balance} = $self->balance;
2961 $return{payname} = $self->payname
2962 || ( $self->first. ' '. $self->get('last') );
2964 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2966 $return{payby} = $self->payby;
2967 $return{stateid_state} = $self->stateid_state;
2969 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2970 $return{card_type} = cardtype($self->payinfo);
2971 $return{payinfo} = $self->paymask;
2973 @return{'month', 'year'} = $self->paydate_monthyear;
2977 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2978 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2979 $return{payinfo1} = $payinfo1;
2980 $return{payinfo2} = $payinfo2;
2981 $return{paytype} = $self->paytype;
2982 $return{paystate} = $self->paystate;
2986 #doubleclick protection
2988 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2994 =item paydate_monthyear
2996 Returns a two-element list consisting of the month and year of this customer's
2997 paydate (credit card expiration date for CARD customers)
3001 sub paydate_monthyear {
3003 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3005 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3014 Returns the exact time in seconds corresponding to the payment method
3015 expiration date. For CARD/DCRD customers this is the end of the month;
3016 for others (COMP is the only other payby that uses paydate) it's the start.
3017 Returns 0 if the paydate is empty or set to the far future.
3023 my ($month, $year) = $self->paydate_monthyear;
3024 return 0 if !$year or $year >= 2037;
3025 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3027 if ( $month == 13 ) {
3031 return timelocal(0,0,0,1,$month-1,$year) - 1;
3034 return timelocal(0,0,0,1,$month-1,$year);
3038 =item paydate_epoch_sql
3040 Class method. Returns an SQL expression to obtain the payment expiration date
3041 as a number of seconds.
3045 # Special expiration date behavior for non-CARD/DCRD customers has been
3046 # carefully preserved. Do we really use that?
3047 sub paydate_epoch_sql {
3049 my $table = shift || 'cust_main';
3050 my ($case1, $case2);
3051 if ( driver_name eq 'Pg' ) {
3052 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3053 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3055 elsif ( lc(driver_name) eq 'mysql' ) {
3056 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3057 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3060 return "CASE WHEN $table.payby IN('CARD','DCRD')
3066 =item tax_exemption TAXNAME
3071 my( $self, $taxname ) = @_;
3073 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3074 'taxname' => $taxname,
3079 =item cust_main_exemption
3083 sub cust_main_exemption {
3085 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3088 =item invoicing_list [ ARRAYREF ]
3090 If an arguement is given, sets these email addresses as invoice recipients
3091 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3092 (except as warnings), so use check_invoicing_list first.
3094 Returns a list of email addresses (with svcnum entries expanded).
3096 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3097 check it without disturbing anything by passing nothing.
3099 This interface may change in the future.
3103 sub invoicing_list {
3104 my( $self, $arrayref ) = @_;
3107 my @cust_main_invoice;
3108 if ( $self->custnum ) {
3109 @cust_main_invoice =
3110 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3112 @cust_main_invoice = ();
3114 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3115 #warn $cust_main_invoice->destnum;
3116 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3117 #warn $cust_main_invoice->destnum;
3118 my $error = $cust_main_invoice->delete;
3119 warn $error if $error;
3122 if ( $self->custnum ) {
3123 @cust_main_invoice =
3124 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3126 @cust_main_invoice = ();
3128 my %seen = map { $_->address => 1 } @cust_main_invoice;
3129 foreach my $address ( @{$arrayref} ) {
3130 next if exists $seen{$address} && $seen{$address};
3131 $seen{$address} = 1;
3132 my $cust_main_invoice = new FS::cust_main_invoice ( {
3133 'custnum' => $self->custnum,
3136 my $error = $cust_main_invoice->insert;
3137 warn $error if $error;
3141 if ( $self->custnum ) {
3143 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3150 =item check_invoicing_list ARRAYREF
3152 Checks these arguements as valid input for the invoicing_list method. If there
3153 is an error, returns the error, otherwise returns false.
3157 sub check_invoicing_list {
3158 my( $self, $arrayref ) = @_;
3160 foreach my $address ( @$arrayref ) {
3162 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3163 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3166 my $cust_main_invoice = new FS::cust_main_invoice ( {
3167 'custnum' => $self->custnum,
3170 my $error = $self->custnum
3171 ? $cust_main_invoice->check
3172 : $cust_main_invoice->checkdest
3174 return $error if $error;
3178 return "Email address required"
3179 if $conf->exists('cust_main-require_invoicing_list_email')
3180 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3185 =item set_default_invoicing_list
3187 Sets the invoicing list to all accounts associated with this customer,
3188 overwriting any previous invoicing list.
3192 sub set_default_invoicing_list {
3194 $self->invoicing_list($self->all_emails);
3199 Returns the email addresses of all accounts provisioned for this customer.
3206 foreach my $cust_pkg ( $self->all_pkgs ) {
3207 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3209 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3210 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3212 $list{$_}=1 foreach map { $_->email } @svc_acct;
3217 =item invoicing_list_addpost
3219 Adds postal invoicing to this customer. If this customer is already configured
3220 to receive postal invoices, does nothing.
3224 sub invoicing_list_addpost {
3226 return if grep { $_ eq 'POST' } $self->invoicing_list;
3227 my @invoicing_list = $self->invoicing_list;
3228 push @invoicing_list, 'POST';
3229 $self->invoicing_list(\@invoicing_list);
3232 =item invoicing_list_emailonly
3234 Returns the list of email invoice recipients (invoicing_list without non-email
3235 destinations such as POST and FAX).
3239 sub invoicing_list_emailonly {
3241 warn "$me invoicing_list_emailonly called"
3243 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3246 =item invoicing_list_emailonly_scalar
3248 Returns the list of email invoice recipients (invoicing_list without non-email
3249 destinations such as POST and FAX) as a comma-separated scalar.
3253 sub invoicing_list_emailonly_scalar {
3255 warn "$me invoicing_list_emailonly_scalar called"
3257 join(', ', $self->invoicing_list_emailonly);
3260 =item referral_custnum_cust_main
3262 Returns the customer who referred this customer (or the empty string, if
3263 this customer was not referred).
3265 Note the difference with referral_cust_main method: This method,
3266 referral_custnum_cust_main returns the single customer (if any) who referred
3267 this customer, while referral_cust_main returns an array of customers referred
3272 sub referral_custnum_cust_main {
3274 return '' unless $self->referral_custnum;
3275 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3278 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3280 Returns an array of customers referred by this customer (referral_custnum set
3281 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3282 customers referred by customers referred by this customer and so on, inclusive.
3283 The default behavior is DEPTH 1 (no recursion).
3285 Note the difference with referral_custnum_cust_main method: This method,
3286 referral_cust_main, returns an array of customers referred BY this customer,
3287 while referral_custnum_cust_main returns the single customer (if any) who
3288 referred this customer.
3292 sub referral_cust_main {
3294 my $depth = @_ ? shift : 1;
3295 my $exclude = @_ ? shift : {};
3298 map { $exclude->{$_->custnum}++; $_; }
3299 grep { ! $exclude->{ $_->custnum } }
3300 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3304 map { $_->referral_cust_main($depth-1, $exclude) }
3311 =item referral_cust_main_ncancelled
3313 Same as referral_cust_main, except only returns customers with uncancelled
3318 sub referral_cust_main_ncancelled {
3320 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3323 =item referral_cust_pkg [ DEPTH ]
3325 Like referral_cust_main, except returns a flat list of all unsuspended (and
3326 uncancelled) packages for each customer. The number of items in this list may
3327 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3331 sub referral_cust_pkg {
3333 my $depth = @_ ? shift : 1;
3335 map { $_->unsuspended_pkgs }
3336 grep { $_->unsuspended_pkgs }
3337 $self->referral_cust_main($depth);
3340 =item referring_cust_main
3342 Returns the single cust_main record for the customer who referred this customer
3343 (referral_custnum), or false.
3347 sub referring_cust_main {
3349 return '' unless $self->referral_custnum;
3350 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3353 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3355 Applies a credit to this customer. If there is an error, returns the error,
3356 otherwise returns false.
3358 REASON can be a text string, an FS::reason object, or a scalar reference to
3359 a reasonnum. If a text string, it will be automatically inserted as a new
3360 reason, and a 'reason_type' option must be passed to indicate the
3361 FS::reason_type for the new reason.
3363 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3365 Any other options are passed to FS::cust_credit::insert.
3370 my( $self, $amount, $reason, %options ) = @_;
3372 my $cust_credit = new FS::cust_credit {
3373 'custnum' => $self->custnum,
3374 'amount' => $amount,
3377 if ( ref($reason) ) {
3379 if ( ref($reason) eq 'SCALAR' ) {
3380 $cust_credit->reasonnum( $$reason );
3382 $cust_credit->reasonnum( $reason->reasonnum );
3386 $cust_credit->set('reason', $reason)
3389 for (qw( addlinfo eventnum )) {
3390 $cust_credit->$_( delete $options{$_} )
3391 if exists($options{$_});
3394 $cust_credit->insert(%options);
3398 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3400 Creates a one-time charge for this customer. If there is an error, returns
3401 the error, otherwise returns false.
3403 New-style, with a hashref of options:
3405 my $error = $cust_main->charge(
3409 'start_date' => str2time('7/4/2009'),
3410 'pkg' => 'Description',
3411 'comment' => 'Comment',
3412 'additional' => [], #extra invoice detail
3413 'classnum' => 1, #pkg_class
3415 'setuptax' => '', # or 'Y' for tax exempt
3418 'taxclass' => 'Tax class',
3421 'taxproduct' => 2, #part_pkg_taxproduct
3422 'override' => {}, #XXX describe
3424 #will be filled in with the new object
3425 'cust_pkg_ref' => \$cust_pkg,
3427 #generate an invoice immediately
3429 'invoice_terms' => '', #with these terms
3435 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3441 my ( $amount, $quantity, $start_date, $classnum );
3442 my ( $pkg, $comment, $additional );
3443 my ( $setuptax, $taxclass ); #internal taxes
3444 my ( $taxproduct, $override ); #vendor (CCH) taxes
3446 my $cust_pkg_ref = '';
3447 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3448 if ( ref( $_[0] ) ) {
3449 $amount = $_[0]->{amount};
3450 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3451 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3452 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3453 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3454 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3455 : '$'. sprintf("%.2f",$amount);
3456 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3457 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3458 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3459 $additional = $_[0]->{additional} || [];
3460 $taxproduct = $_[0]->{taxproductnum};
3461 $override = { '' => $_[0]->{tax_override} };
3462 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3463 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3464 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3469 $pkg = @_ ? shift : 'One-time charge';
3470 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3472 $taxclass = @_ ? shift : '';
3476 local $SIG{HUP} = 'IGNORE';
3477 local $SIG{INT} = 'IGNORE';
3478 local $SIG{QUIT} = 'IGNORE';
3479 local $SIG{TERM} = 'IGNORE';
3480 local $SIG{TSTP} = 'IGNORE';
3481 local $SIG{PIPE} = 'IGNORE';
3483 my $oldAutoCommit = $FS::UID::AutoCommit;
3484 local $FS::UID::AutoCommit = 0;
3487 my $part_pkg = new FS::part_pkg ( {
3489 'comment' => $comment,
3493 'classnum' => ( $classnum ? $classnum : '' ),
3494 'setuptax' => $setuptax,
3495 'taxclass' => $taxclass,
3496 'taxproductnum' => $taxproduct,
3499 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3500 ( 0 .. @$additional - 1 )
3502 'additional_count' => scalar(@$additional),
3503 'setup_fee' => $amount,
3506 my $error = $part_pkg->insert( options => \%options,
3507 tax_overrides => $override,
3510 $dbh->rollback if $oldAutoCommit;
3514 my $pkgpart = $part_pkg->pkgpart;
3515 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3516 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3517 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3518 $error = $type_pkgs->insert;
3520 $dbh->rollback if $oldAutoCommit;
3525 my $cust_pkg = new FS::cust_pkg ( {
3526 'custnum' => $self->custnum,
3527 'pkgpart' => $pkgpart,
3528 'quantity' => $quantity,
3529 'start_date' => $start_date,
3530 'no_auto' => $no_auto,
3533 $error = $cust_pkg->insert;
3535 $dbh->rollback if $oldAutoCommit;
3537 } elsif ( $cust_pkg_ref ) {
3538 ${$cust_pkg_ref} = $cust_pkg;
3542 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3543 'pkg_list' => [ $cust_pkg ],
3546 $dbh->rollback if $oldAutoCommit;
3551 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3556 #=item charge_postal_fee
3558 #Applies a one time charge this customer. If there is an error,
3559 #returns the error, returns the cust_pkg charge object or false
3560 #if there was no charge.
3564 # This should be a customer event. For that to work requires that bill
3565 # also be a customer event.
3567 sub charge_postal_fee {
3570 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3571 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3573 my $cust_pkg = new FS::cust_pkg ( {
3574 'custnum' => $self->custnum,
3575 'pkgpart' => $pkgpart,
3579 my $error = $cust_pkg->insert;
3580 $error ? $error : $cust_pkg;
3583 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3585 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3587 Optionally, a list or hashref of additional arguments to the qsearch call can
3594 my $opt = ref($_[0]) ? shift : { @_ };
3596 #return $self->num_cust_bill unless wantarray || keys %$opt;
3598 $opt->{'table'} = 'cust_bill';
3599 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3600 $opt->{'hashref'}{'custnum'} = $self->custnum;
3601 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3603 map { $_ } #behavior of sort undefined in scalar context
3604 sort { $a->_date <=> $b->_date }
3608 =item open_cust_bill
3610 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3615 sub open_cust_bill {
3619 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3625 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3627 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3631 sub legacy_cust_bill {
3634 #return $self->num_legacy_cust_bill unless wantarray;
3636 map { $_ } #behavior of sort undefined in scalar context
3637 sort { $a->_date <=> $b->_date }
3638 qsearch({ 'table' => 'legacy_cust_bill',
3639 'hashref' => { 'custnum' => $self->custnum, },
3640 'order_by' => 'ORDER BY _date ASC',
3644 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3646 Returns all the statements (see L<FS::cust_statement>) for this customer.
3648 Optionally, a list or hashref of additional arguments to the qsearch call can
3653 sub cust_statement {
3655 my $opt = ref($_[0]) ? shift : { @_ };
3657 #return $self->num_cust_statement unless wantarray || keys %$opt;
3659 $opt->{'table'} = 'cust_statement';
3660 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3661 $opt->{'hashref'}{'custnum'} = $self->custnum;
3662 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3664 map { $_ } #behavior of sort undefined in scalar context
3665 sort { $a->_date <=> $b->_date }
3669 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3671 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3673 Optionally, a list or hashref of additional arguments to the qsearch call can
3674 be passed following the SVCDB.
3681 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3682 warn "$me svc_x requires a svcdb";
3685 my $opt = ref($_[0]) ? shift : { @_ };
3687 $opt->{'table'} = $svcdb;
3688 $opt->{'addl_from'} =
3689 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3690 ($opt->{'addl_from'} || '');
3692 my $custnum = $self->custnum;
3693 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3694 my $where = "cust_pkg.custnum = $custnum";
3696 my $extra_sql = $opt->{'extra_sql'} || '';
3697 if ( keys %{ $opt->{'hashref'} } ) {
3698 $extra_sql = " AND $where $extra_sql";
3701 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3702 $extra_sql = "WHERE $where AND $1";
3705 $extra_sql = "WHERE $where $extra_sql";
3708 $opt->{'extra_sql'} = $extra_sql;
3713 # required for use as an eventtable;
3716 $self->svc_x('svc_acct', @_);
3721 Returns all the credits (see L<FS::cust_credit>) for this customer.
3727 map { $_ } #return $self->num_cust_credit unless wantarray;
3728 sort { $a->_date <=> $b->_date }
3729 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3732 =item cust_credit_pkgnum
3734 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3735 package when using experimental package balances.
3739 sub cust_credit_pkgnum {
3740 my( $self, $pkgnum ) = @_;
3741 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3742 sort { $a->_date <=> $b->_date }
3743 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3744 'pkgnum' => $pkgnum,
3751 Returns all the payments (see L<FS::cust_pay>) for this customer.
3757 return $self->num_cust_pay unless wantarray;
3758 sort { $a->_date <=> $b->_date }
3759 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3764 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3765 called automatically when the cust_pay method is used in a scalar context.
3771 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3772 my $sth = dbh->prepare($sql) or die dbh->errstr;
3773 $sth->execute($self->custnum) or die $sth->errstr;
3774 $sth->fetchrow_arrayref->[0];
3777 =item cust_pay_pkgnum
3779 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3780 package when using experimental package balances.
3784 sub cust_pay_pkgnum {
3785 my( $self, $pkgnum ) = @_;
3786 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3787 sort { $a->_date <=> $b->_date }
3788 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3789 'pkgnum' => $pkgnum,
3796 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3802 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3803 sort { $a->_date <=> $b->_date }
3804 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3807 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3809 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3811 Optionally, a list or hashref of additional arguments to the qsearch call can
3816 sub cust_pay_batch {
3818 my $opt = ref($_[0]) ? shift : { @_ };
3820 #return $self->num_cust_statement unless wantarray || keys %$opt;
3822 $opt->{'table'} = 'cust_pay_batch';
3823 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3824 $opt->{'hashref'}{'custnum'} = $self->custnum;
3825 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3827 map { $_ } #behavior of sort undefined in scalar context
3828 sort { $a->paybatchnum <=> $b->paybatchnum }
3832 =item cust_pay_pending
3834 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3835 (without status "done").
3839 sub cust_pay_pending {
3841 return $self->num_cust_pay_pending unless wantarray;
3842 sort { $a->_date <=> $b->_date }
3843 qsearch( 'cust_pay_pending', {
3844 'custnum' => $self->custnum,
3845 'status' => { op=>'!=', value=>'done' },
3850 =item cust_pay_pending_attempt
3852 Returns all payment attempts / declined payments for this customer, as pending
3853 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3854 a corresponding payment (see L<FS::cust_pay>).
3858 sub cust_pay_pending_attempt {
3860 return $self->num_cust_pay_pending_attempt unless wantarray;
3861 sort { $a->_date <=> $b->_date }
3862 qsearch( 'cust_pay_pending', {
3863 'custnum' => $self->custnum,
3870 =item num_cust_pay_pending
3872 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3873 customer (without status "done"). Also called automatically when the
3874 cust_pay_pending method is used in a scalar context.
3878 sub num_cust_pay_pending {
3881 " SELECT COUNT(*) FROM cust_pay_pending ".
3882 " WHERE custnum = ? AND status != 'done' ",
3887 =item num_cust_pay_pending_attempt
3889 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3890 customer, with status "done" but without a corresp. Also called automatically when the
3891 cust_pay_pending method is used in a scalar context.
3895 sub num_cust_pay_pending_attempt {
3898 " SELECT COUNT(*) FROM cust_pay_pending ".
3899 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3906 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3912 map { $_ } #return $self->num_cust_refund unless wantarray;
3913 sort { $a->_date <=> $b->_date }
3914 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3917 =item display_custnum
3919 Returns the displayed customer number for this customer: agent_custid if
3920 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3924 sub display_custnum {
3926 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3927 return $self->agent_custid;
3928 } elsif ( $conf->config('cust_main-custnum-display_prefix') ) {
3929 return $conf->config('cust_main-custnum-display_prefix').
3930 sprintf('%08d', $self->custnum)
3932 return $self->custnum;
3938 Returns a name string for this customer, either "Company (Last, First)" or
3945 my $name = $self->contact;
3946 $name = $self->company. " ($name)" if $self->company;
3952 Returns a name string for this (service/shipping) contact, either
3953 "Company (Last, First)" or "Last, First".
3959 if ( $self->get('ship_last') ) {
3960 my $name = $self->ship_contact;
3961 $name = $self->ship_company. " ($name)" if $self->ship_company;
3970 Returns a name string for this customer, either "Company" or "First Last".
3976 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3979 =item ship_name_short
3981 Returns a name string for this (service/shipping) contact, either "Company"
3986 sub ship_name_short {
3988 if ( $self->get('ship_last') ) {
3989 $self->ship_company !~ /^\s*$/
3990 ? $self->ship_company
3991 : $self->ship_contact_firstlast;
3993 $self->name_company_or_firstlast;
3999 Returns this customer's full (billing) contact name only, "Last, First"
4005 $self->get('last'). ', '. $self->first;
4010 Returns this customer's full (shipping) contact name only, "Last, First"
4016 $self->get('ship_last')
4017 ? $self->get('ship_last'). ', '. $self->ship_first
4021 =item contact_firstlast
4023 Returns this customers full (billing) contact name only, "First Last".
4027 sub contact_firstlast {
4029 $self->first. ' '. $self->get('last');
4032 =item ship_contact_firstlast
4034 Returns this customer's full (shipping) contact name only, "First Last".
4038 sub ship_contact_firstlast {
4040 $self->get('ship_last')
4041 ? $self->first. ' '. $self->get('ship_last')
4042 : $self->contact_firstlast;
4047 Returns this customer's full country name
4053 code2country($self->country);
4056 =item geocode DATA_VENDOR
4058 Returns a value for the customer location as encoded by DATA_VENDOR.
4059 Currently this only makes sense for "CCH" as DATA_VENDOR.
4067 Returns a status string for this customer, currently:
4071 =item prospect - No packages have ever been ordered
4073 =item ordered - Recurring packages all are new (not yet billed).
4075 =item active - One or more recurring packages is active
4077 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4079 =item suspended - All non-cancelled recurring packages are suspended
4081 =item cancelled - All recurring packages are cancelled
4085 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4086 cust_main-status_module configuration option.
4090 sub status { shift->cust_status(@_); }
4094 for my $status ( FS::cust_main->statuses() ) {
4095 my $method = $status.'_sql';
4096 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4097 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4098 $sth->execute( ($self->custnum) x $numnum )
4099 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4100 return $status if $sth->fetchrow_arrayref->[0];
4104 =item ucfirst_cust_status
4106 =item ucfirst_status
4108 Returns the status with the first character capitalized.
4112 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4114 sub ucfirst_cust_status {
4116 ucfirst($self->cust_status);
4121 Returns a hex triplet color string for this customer's status.
4125 sub statuscolor { shift->cust_statuscolor(@_); }
4127 sub cust_statuscolor {
4129 __PACKAGE__->statuscolors->{$self->cust_status};
4134 Returns an array of hashes representing the customer's RT tickets.
4141 my $num = $conf->config('cust_main-max_tickets') || 10;
4144 if ( $conf->config('ticket_system') ) {
4145 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4147 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4151 foreach my $priority (
4152 $conf->config('ticket_system-custom_priority_field-values'), ''
4154 last if scalar(@tickets) >= $num;
4156 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4157 $num - scalar(@tickets),
4167 # Return services representing svc_accts in customer support packages
4168 sub support_services {
4170 my %packages = map { $_ => 1 } $conf->config('support_packages');
4172 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4173 grep { $_->part_svc->svcdb eq 'svc_acct' }
4174 map { $_->cust_svc }
4175 grep { exists $packages{ $_->pkgpart } }
4176 $self->ncancelled_pkgs;
4180 # Return a list of latitude/longitude for one of the services (if any)
4181 sub service_coordinates {
4185 grep { $_->latitude && $_->longitude }
4187 map { $_->cust_svc }
4188 $self->ncancelled_pkgs;
4190 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4195 Returns a masked version of the named field
4200 my ($self,$field) = @_;
4204 'x'x(length($self->getfield($field))-4).
4205 substr($self->getfield($field), (length($self->getfield($field))-4));
4211 =head1 CLASS METHODS
4217 Class method that returns the list of possible status strings for customers
4218 (see L<the status method|/status>). For example:
4220 @statuses = FS::cust_main->statuses();
4226 keys %{ $self->statuscolors };
4229 =item cust_status_sql
4231 Returns an SQL fragment to determine the status of a cust_main record, as a
4236 sub cust_status_sql {
4238 for my $status ( FS::cust_main->statuses() ) {
4239 my $method = $status.'_sql';
4240 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4249 Returns an SQL expression identifying prospective cust_main records (customers
4250 with no packages ever ordered)
4254 use vars qw($select_count_pkgs);
4255 $select_count_pkgs =
4256 "SELECT COUNT(*) FROM cust_pkg
4257 WHERE cust_pkg.custnum = cust_main.custnum";
4259 sub select_count_pkgs_sql {
4264 " 0 = ( $select_count_pkgs ) ";
4269 Returns an SQL expression identifying ordered cust_main records (customers with
4270 no active packages, but recurring packages not yet setup or one time charges
4276 FS::cust_main->none_active_sql.
4277 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4282 Returns an SQL expression identifying active cust_main records (customers with
4283 active recurring packages).
4288 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4291 =item none_active_sql
4293 Returns an SQL expression identifying cust_main records with no active
4294 recurring packages. This includes customers of status prospect, ordered,
4295 inactive, and suspended.
4299 sub none_active_sql {
4300 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4305 Returns an SQL expression identifying inactive cust_main records (customers with
4306 no active recurring packages, but otherwise unsuspended/uncancelled).
4311 FS::cust_main->none_active_sql.
4312 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4318 Returns an SQL expression identifying suspended cust_main records.
4323 sub suspended_sql { susp_sql(@_); }
4325 FS::cust_main->none_active_sql.
4326 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4332 Returns an SQL expression identifying cancelled cust_main records.
4336 sub cancel_sql { shift->cancelled_sql(@_); }
4339 =item uncancelled_sql
4341 Returns an SQL expression identifying un-cancelled cust_main records.
4345 sub uncancelled_sql { uncancel_sql(@_); }
4346 sub uncancel_sql { "
4347 ( 0 < ( $select_count_pkgs
4348 AND ( cust_pkg.cancel IS NULL
4349 OR cust_pkg.cancel = 0
4352 OR 0 = ( $select_count_pkgs )
4358 Returns an SQL fragment to retreive the balance.
4363 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4364 WHERE cust_bill.custnum = cust_main.custnum )
4365 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4366 WHERE cust_pay.custnum = cust_main.custnum )
4367 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4368 WHERE cust_credit.custnum = cust_main.custnum )
4369 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4370 WHERE cust_refund.custnum = cust_main.custnum )
4373 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4375 Returns an SQL fragment to retreive the balance for this customer, optionally
4376 considering invoices with date earlier than START_TIME, and not
4377 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4378 total_unapplied_payments).
4380 Times are specified as SQL fragments or numeric
4381 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4382 L<Date::Parse> for conversion functions. The empty string can be passed
4383 to disable that time constraint completely.
4385 Available options are:
4389 =item unapplied_date
4391 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)
4396 set to true to remove all customer comparison clauses, for totals
4401 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4406 JOIN clause (typically used with the total option)
4410 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4411 time will be ignored. Note that START_TIME and END_TIME only limit the date
4412 range for invoices and I<unapplied> payments, credits, and refunds.
4418 sub balance_date_sql {
4419 my( $class, $start, $end, %opt ) = @_;
4421 my $cutoff = $opt{'cutoff'};
4423 my $owed = FS::cust_bill->owed_sql($cutoff);
4424 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4425 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4426 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4428 my $j = $opt{'join'} || '';
4430 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4431 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4432 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4433 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4435 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4436 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4437 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4438 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4443 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4445 Returns an SQL fragment to retreive the total unapplied payments for this
4446 customer, only considering payments with date earlier than START_TIME, and
4447 optionally not later than END_TIME.
4449 Times are specified as SQL fragments or numeric
4450 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4451 L<Date::Parse> for conversion functions. The empty string can be passed
4452 to disable that time constraint completely.
4454 Available options are:
4458 sub unapplied_payments_date_sql {
4459 my( $class, $start, $end, %opt ) = @_;
4461 my $cutoff = $opt{'cutoff'};
4463 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4465 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4466 'unapplied_date'=>1 );
4468 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4471 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4473 Helper method for balance_date_sql; name (and usage) subject to change
4474 (suggestions welcome).
4476 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4477 cust_refund, cust_credit or cust_pay).
4479 If TABLE is "cust_bill" or the unapplied_date option is true, only
4480 considers records with date earlier than START_TIME, and optionally not
4481 later than END_TIME .
4485 sub _money_table_where {
4486 my( $class, $table, $start, $end, %opt ) = @_;
4489 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4490 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4491 push @where, "$table._date <= $start" if defined($start) && length($start);
4492 push @where, "$table._date > $end" if defined($end) && length($end);
4494 push @where, @{$opt{'where'}} if $opt{'where'};
4495 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4501 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4502 use FS::cust_main::Search;
4505 FS::cust_main::Search->search(@_);
4520 #warn join('-',keys %$param);
4521 my $fh = $param->{filehandle};
4522 my $agentnum = $param->{agentnum};
4523 my $format = $param->{format};
4525 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4528 if ( $format eq 'simple' ) {
4529 @fields = qw( custnum agent_custid amount pkg );
4531 die "unknown format $format";
4534 eval "use Text::CSV_XS;";
4537 my $csv = new Text::CSV_XS;
4544 local $SIG{HUP} = 'IGNORE';
4545 local $SIG{INT} = 'IGNORE';
4546 local $SIG{QUIT} = 'IGNORE';
4547 local $SIG{TERM} = 'IGNORE';
4548 local $SIG{TSTP} = 'IGNORE';
4549 local $SIG{PIPE} = 'IGNORE';
4551 my $oldAutoCommit = $FS::UID::AutoCommit;
4552 local $FS::UID::AutoCommit = 0;
4555 #while ( $columns = $csv->getline($fh) ) {
4557 while ( defined($line=<$fh>) ) {
4559 $csv->parse($line) or do {
4560 $dbh->rollback if $oldAutoCommit;
4561 return "can't parse: ". $csv->error_input();
4564 my @columns = $csv->fields();
4565 #warn join('-',@columns);
4568 foreach my $field ( @fields ) {
4569 $row{$field} = shift @columns;
4572 if ( $row{custnum} && $row{agent_custid} ) {
4573 dbh->rollback if $oldAutoCommit;
4574 return "can't specify custnum with agent_custid $row{agent_custid}";
4578 if ( $row{agent_custid} && $agentnum ) {
4579 %hash = ( 'agent_custid' => $row{agent_custid},
4580 'agentnum' => $agentnum,
4584 if ( $row{custnum} ) {
4585 %hash = ( 'custnum' => $row{custnum} );
4588 unless ( scalar(keys %hash) ) {
4589 $dbh->rollback if $oldAutoCommit;
4590 return "can't find customer without custnum or agent_custid and agentnum";
4593 my $cust_main = qsearchs('cust_main', { %hash } );
4594 unless ( $cust_main ) {
4595 $dbh->rollback if $oldAutoCommit;
4596 my $custnum = $row{custnum} || $row{agent_custid};
4597 return "unknown custnum $custnum";
4600 if ( $row{'amount'} > 0 ) {
4601 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4603 $dbh->rollback if $oldAutoCommit;
4607 } elsif ( $row{'amount'} < 0 ) {
4608 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4611 $dbh->rollback if $oldAutoCommit;
4621 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4623 return "Empty file!" unless $imported;
4629 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4631 Deprecated. Use event notification and message templates
4632 (L<FS::msg_template>) instead.
4634 Sends a templated email notification to the customer (see L<Text::Template>).
4636 OPTIONS is a hash and may include
4638 I<from> - the email sender (default is invoice_from)
4640 I<to> - comma-separated scalar or arrayref of recipients
4641 (default is invoicing_list)
4643 I<subject> - The subject line of the sent email notification
4644 (default is "Notice from company_name")
4646 I<extra_fields> - a hashref of name/value pairs which will be substituted
4649 The following variables are vavailable in the template.
4651 I<$first> - the customer first name
4652 I<$last> - the customer last name
4653 I<$company> - the customer company
4654 I<$payby> - a description of the method of payment for the customer
4655 # would be nice to use FS::payby::shortname
4656 I<$payinfo> - the account information used to collect for this customer
4657 I<$expdate> - the expiration of the customer payment in seconds from epoch
4662 my ($self, $template, %options) = @_;
4664 return unless $conf->exists($template);
4666 my $from = $conf->config('invoice_from', $self->agentnum)
4667 if $conf->exists('invoice_from', $self->agentnum);
4668 $from = $options{from} if exists($options{from});
4670 my $to = join(',', $self->invoicing_list_emailonly);
4671 $to = $options{to} if exists($options{to});
4673 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4674 if $conf->exists('company_name', $self->agentnum);
4675 $subject = $options{subject} if exists($options{subject});
4677 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4678 SOURCE => [ map "$_\n",
4679 $conf->config($template)]
4681 or die "can't create new Text::Template object: Text::Template::ERROR";
4682 $notify_template->compile()
4683 or die "can't compile template: Text::Template::ERROR";
4685 $FS::notify_template::_template::company_name =
4686 $conf->config('company_name', $self->agentnum);
4687 $FS::notify_template::_template::company_address =
4688 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4690 my $paydate = $self->paydate || '2037-12-31';
4691 $FS::notify_template::_template::first = $self->first;
4692 $FS::notify_template::_template::last = $self->last;
4693 $FS::notify_template::_template::company = $self->company;
4694 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4695 my $payby = $self->payby;
4696 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4697 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4699 #credit cards expire at the end of the month/year of their exp date
4700 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4701 $FS::notify_template::_template::payby = 'credit card';
4702 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4703 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4705 }elsif ($payby eq 'COMP') {
4706 $FS::notify_template::_template::payby = 'complimentary account';
4708 $FS::notify_template::_template::payby = 'current method';
4710 $FS::notify_template::_template::expdate = $expire_time;
4712 for (keys %{$options{extra_fields}}){
4714 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4717 send_email(from => $from,
4719 subject => $subject,
4720 body => $notify_template->fill_in( PACKAGE =>
4721 'FS::notify_template::_template' ),
4726 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4728 Generates a templated notification to the customer (see L<Text::Template>).
4730 OPTIONS is a hash and may include
4732 I<extra_fields> - a hashref of name/value pairs which will be substituted
4733 into the template. These values may override values mentioned below
4734 and those from the customer record.
4736 The following variables are available in the template instead of or in addition
4737 to the fields of the customer record.
4739 I<$payby> - a description of the method of payment for the customer
4740 # would be nice to use FS::payby::shortname
4741 I<$payinfo> - the masked account information used to collect for this customer
4742 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4743 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4747 # a lot like cust_bill::print_latex
4748 sub generate_letter {
4749 my ($self, $template, %options) = @_;
4751 return unless $conf->exists($template);
4753 my $letter_template = new Text::Template
4755 SOURCE => [ map "$_\n", $conf->config($template)],
4756 DELIMITERS => [ '[@--', '--@]' ],
4758 or die "can't create new Text::Template object: Text::Template::ERROR";
4760 $letter_template->compile()
4761 or die "can't compile template: Text::Template::ERROR";
4763 my %letter_data = map { $_ => $self->$_ } $self->fields;
4764 $letter_data{payinfo} = $self->mask_payinfo;
4766 #my $paydate = $self->paydate || '2037-12-31';
4767 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4769 my $payby = $self->payby;
4770 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4771 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4773 #credit cards expire at the end of the month/year of their exp date
4774 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4775 $letter_data{payby} = 'credit card';
4776 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4777 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4779 }elsif ($payby eq 'COMP') {
4780 $letter_data{payby} = 'complimentary account';
4782 $letter_data{payby} = 'current method';
4784 $letter_data{expdate} = $expire_time;
4786 for (keys %{$options{extra_fields}}){
4787 $letter_data{$_} = $options{extra_fields}->{$_};
4790 unless(exists($letter_data{returnaddress})){
4791 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4792 $self->agent_template)
4794 if ( length($retadd) ) {
4795 $letter_data{returnaddress} = $retadd;
4796 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4797 $letter_data{returnaddress} =
4798 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4802 ( $conf->config('company_name', $self->agentnum),
4803 $conf->config('company_address', $self->agentnum),
4807 $letter_data{returnaddress} = '~';
4811 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4813 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4815 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4817 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4821 ) or die "can't open temp file: $!\n";
4822 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4823 or die "can't write temp file: $!\n";
4825 $letter_data{'logo_file'} = $lh->filename;
4827 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4831 ) or die "can't open temp file: $!\n";
4833 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4835 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4836 return ($1, $letter_data{'logo_file'});
4840 =item print_ps TEMPLATE
4842 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4848 my($file, $lfile) = $self->generate_letter(@_);
4849 my $ps = FS::Misc::generate_ps($file);
4850 unlink($file.'.tex');
4856 =item print TEMPLATE
4858 Prints the filled in template.
4860 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4864 sub queueable_print {
4867 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4868 or die "invalid customer number: " . $opt{custvnum};
4870 my $error = $self->print( $opt{template} );
4871 die $error if $error;
4875 my ($self, $template) = (shift, shift);
4876 do_print [ $self->print_ps($template) ];
4879 #these three subs should just go away once agent stuff is all config overrides
4881 sub agent_template {
4883 $self->_agent_plandata('agent_templatename');
4886 sub agent_invoice_from {
4888 $self->_agent_plandata('agent_invoice_from');
4891 sub _agent_plandata {
4892 my( $self, $option ) = @_;
4894 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4895 #agent-specific Conf
4897 use FS::part_event::Condition;
4899 my $agentnum = $self->agentnum;
4901 my $regexp = regexp_sql();
4903 my $part_event_option =
4905 'select' => 'part_event_option.*',
4906 'table' => 'part_event_option',
4908 LEFT JOIN part_event USING ( eventpart )
4909 LEFT JOIN part_event_option AS peo_agentnum
4910 ON ( part_event.eventpart = peo_agentnum.eventpart
4911 AND peo_agentnum.optionname = 'agentnum'
4912 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4914 LEFT JOIN part_event_condition
4915 ON ( part_event.eventpart = part_event_condition.eventpart
4916 AND part_event_condition.conditionname = 'cust_bill_age'
4918 LEFT JOIN part_event_condition_option
4919 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4920 AND part_event_condition_option.optionname = 'age'
4923 #'hashref' => { 'optionname' => $option },
4924 #'hashref' => { 'part_event_option.optionname' => $option },
4926 " WHERE part_event_option.optionname = ". dbh->quote($option).
4927 " AND action = 'cust_bill_send_agent' ".
4928 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4929 " AND peo_agentnum.optionname = 'agentnum' ".
4930 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4932 CASE WHEN part_event_condition_option.optionname IS NULL
4934 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4936 , part_event.weight".
4940 unless ( $part_event_option ) {
4941 return $self->agent->invoice_template || ''
4942 if $option eq 'agent_templatename';
4946 $part_event_option->optionvalue;
4950 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4952 Subroutine (not a method), designed to be called from the queue.
4954 Takes a list of options and values.
4956 Pulls up the customer record via the custnum option and calls bill_and_collect.
4961 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4963 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4964 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4966 $cust_main->bill_and_collect( %args );
4969 sub process_bill_and_collect {
4971 my $param = thaw(decode_base64(shift));
4972 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4973 or die "custnum '$param->{custnum}' not found!\n";
4974 $param->{'job'} = $job;
4975 $param->{'fatal'} = 1; # runs from job queue, will be caught
4976 $param->{'retry'} = 1;
4978 $cust_main->bill_and_collect( %$param );
4981 =item process_censustract_update CUSTNUM
4983 Queueable function to update the census tract to the current year (as set in
4984 the 'census_year' configuration variable) and retrieve the new tract code.
4988 sub process_censustract_update {
4989 eval "use FS::Misc::Geo qw(get_censustract)";
4991 my $custnum = shift;
4992 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
4993 or die "custnum '$custnum' not found!\n";
4995 my $new_year = $conf->config('census_year') or return;
4996 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
4997 if ( $new_tract =~ /^\d/ ) {
4998 # then it's a tract code
4999 $cust_main->set('censustract', $new_tract);
5000 $cust_main->set('censusyear', $new_year);
5001 my $error = $cust_main->replace;
5002 die $error if $error;
5005 # it's an error message
5011 sub _upgrade_data { #class method
5012 my ($class, %opts) = @_;
5015 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5016 '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',
5018 # fix yyyy-m-dd formatted paydates
5019 if ( driver_name =~ /^mysql$/i ) {
5021 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5023 else { # the SQL standard
5025 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5028 foreach my $sql ( @statements ) {
5029 my $sth = dbh->prepare($sql) or die dbh->errstr;
5030 $sth->execute or die $sth->errstr;
5033 local($ignore_expired_card) = 1;
5034 local($ignore_illegal_zip) = 1;
5035 local($ignore_banned_card) = 1;
5036 local($skip_fuzzyfiles) = 1;
5037 $class->_upgrade_otaker(%opts);
5047 The delete method should possibly take an FS::cust_main object reference
5048 instead of a scalar customer number.
5050 Bill and collect options should probably be passed as references instead of a
5053 There should probably be a configuration file with a list of allowed credit
5056 No multiple currency support (probably a larger project than just this module).
5058 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5060 Birthdates rely on negative epoch values.
5062 The payby for card/check batches is broken. With mixed batching, bad
5065 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5069 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5070 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5071 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.