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;
73 use FS::upgrade_journal;
75 # 1 is mostly method/subroutine entry and options
76 # 2 traces progress of some operations
77 # 3 is even more information including possibly sensitive data
79 $me = '[FS::cust_main]';
82 $ignore_expired_card = 0;
83 $ignore_illegal_zip = 0;
84 $ignore_banned_card = 0;
88 @encrypted_fields = ('payinfo', 'paycvv');
89 sub nohistory_fields { ('payinfo', 'paycvv'); }
91 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
93 #ask FS::UID to run this stuff for us later
94 #$FS::UID::callback{'FS::cust_main'} = sub {
95 install_callback FS::UID sub {
97 #yes, need it for stuff below (prolly should be cached)
102 my ( $hashref, $cache ) = @_;
103 if ( exists $hashref->{'pkgnum'} ) {
104 #@{ $self->{'_pkgnum'} } = ();
105 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
106 $self->{'_pkgnum'} = $subcache;
107 #push @{ $self->{'_pkgnum'} },
108 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
114 FS::cust_main - Object methods for cust_main records
120 $record = new FS::cust_main \%hash;
121 $record = new FS::cust_main { 'column' => 'value' };
123 $error = $record->insert;
125 $error = $new_record->replace($old_record);
127 $error = $record->delete;
129 $error = $record->check;
131 @cust_pkg = $record->all_pkgs;
133 @cust_pkg = $record->ncancelled_pkgs;
135 @cust_pkg = $record->suspended_pkgs;
137 $error = $record->bill;
138 $error = $record->bill %options;
139 $error = $record->bill 'time' => $time;
141 $error = $record->collect;
142 $error = $record->collect %options;
143 $error = $record->collect 'invoice_time' => $time,
148 An FS::cust_main object represents a customer. FS::cust_main inherits from
149 FS::Record. The following fields are currently supported:
155 Primary key (assigned automatically for new customers)
159 Agent (see L<FS::agent>)
163 Advertising source (see L<FS::part_referral>)
175 Cocial security number (optional)
191 (optional, see L<FS::cust_main_county>)
195 (see L<FS::cust_main_county>)
201 (see L<FS::cust_main_county>)
241 (optional, see L<FS::cust_main_county>)
245 (see L<FS::cust_main_county>)
251 (see L<FS::cust_main_county>)
271 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
275 Payment Information (See L<FS::payinfo_Mixin> for data format)
279 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
283 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
287 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
291 Start date month (maestro/solo cards only)
295 Start date year (maestro/solo cards only)
299 Issue number (maestro/solo cards only)
303 Name on card or billing name
307 IP address from which payment information was received
311 Tax exempt, empty or `Y'
315 Order taker (see L<FS::access_user>)
321 =item referral_custnum
323 Referring customer number
327 Enable individual CDR spooling, empty or `Y'
331 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
335 Discourage individual CDR printing, empty or `Y'
339 Allow self-service editing of ticket subjects, empty or 'Y'
341 =item calling_list_exempt
343 Do not call, empty or 'Y'
353 Creates a new customer. To add the customer to the database, see L<"insert">.
355 Note that this stores the hash reference, not a distinct copy of the hash it
356 points to. You can ask the object for a copy with the I<hash> method.
360 sub table { 'cust_main'; }
362 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
364 Adds this customer to the database. If there is an error, returns the error,
365 otherwise returns false.
367 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
368 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
369 are inserted atomicly, or the transaction is rolled back. Passing an empty
370 hash reference is equivalent to not supplying this parameter. There should be
371 a better explanation of this, but until then, here's an example:
374 tie %hash, 'Tie::RefHash'; #this part is important
376 $cust_pkg => [ $svc_acct ],
379 $cust_main->insert( \%hash );
381 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
382 be set as the invoicing list (see L<"invoicing_list">). Errors return as
383 expected and rollback the entire transaction; it is not necessary to call
384 check_invoicing_list first. The invoicing_list is set after the records in the
385 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
386 invoicing_list destination to the newly-created svc_acct. Here's an example:
388 $cust_main->insert( {}, [ $email, 'POST' ] );
390 Currently available options are: I<depend_jobnum>, I<noexport>,
391 I<tax_exemption> and I<prospectnum>.
393 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
394 on the supplied jobnum (they will not run until the specific job completes).
395 This can be used to defer provisioning until some action completes (such
396 as running the customer's credit card successfully).
398 The I<noexport> option is deprecated. If I<noexport> is set true, no
399 provisioning jobs (exports) are scheduled. (You can schedule them later with
400 the B<reexport> method.)
402 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
403 of tax names and exemption numbers. FS::cust_main_exemption records will be
404 created and inserted.
406 If I<prospectnum> is set, moves contacts and locations from that prospect.
412 my $cust_pkgs = @_ ? shift : {};
413 my $invoicing_list = @_ ? shift : '';
415 warn "$me insert called with options ".
416 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
419 local $SIG{HUP} = 'IGNORE';
420 local $SIG{INT} = 'IGNORE';
421 local $SIG{QUIT} = 'IGNORE';
422 local $SIG{TERM} = 'IGNORE';
423 local $SIG{TSTP} = 'IGNORE';
424 local $SIG{PIPE} = 'IGNORE';
426 my $oldAutoCommit = $FS::UID::AutoCommit;
427 local $FS::UID::AutoCommit = 0;
430 my $prepay_identifier = '';
431 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
433 if ( $self->payby eq 'PREPAY' ) {
435 $self->payby('BILL');
436 $prepay_identifier = $self->payinfo;
439 warn " looking up prepaid card $prepay_identifier\n"
442 my $error = $self->get_prepay( $prepay_identifier,
443 'amount_ref' => \$amount,
444 'seconds_ref' => \$seconds,
445 'upbytes_ref' => \$upbytes,
446 'downbytes_ref' => \$downbytes,
447 'totalbytes_ref' => \$totalbytes,
450 $dbh->rollback if $oldAutoCommit;
451 #return "error applying prepaid card (transaction rolled back): $error";
455 $payby = 'PREP' if $amount;
457 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
460 $self->payby('BILL');
461 $amount = $self->paid;
465 warn " inserting $self\n"
468 $self->signupdate(time) unless $self->signupdate;
470 $self->censusyear($conf->config('census_year')||'2012') if $self->censustract;
472 $self->auto_agent_custid()
473 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
475 my $error = $self->SUPER::insert;
477 $dbh->rollback if $oldAutoCommit;
478 #return "inserting cust_main record (transaction rolled back): $error";
482 warn " setting invoicing list\n"
485 if ( $invoicing_list ) {
486 $error = $self->check_invoicing_list( $invoicing_list );
488 $dbh->rollback if $oldAutoCommit;
489 #return "checking invoicing_list (transaction rolled back): $error";
492 $self->invoicing_list( $invoicing_list );
495 warn " setting customer tags\n"
498 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
499 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
500 'custnum' => $self->custnum };
501 my $error = $cust_tag->insert;
503 $dbh->rollback if $oldAutoCommit;
508 my $prospectnum = delete $options{'prospectnum'};
509 if ( $prospectnum ) {
511 warn " moving contacts and locations from prospect $prospectnum\n"
515 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
516 unless ( $prospect_main ) {
517 $dbh->rollback if $oldAutoCommit;
518 return "Unknown prospectnum $prospectnum";
520 $prospect_main->custnum($self->custnum);
521 $prospect_main->disabled('Y');
522 my $error = $prospect_main->replace;
524 $dbh->rollback if $oldAutoCommit;
528 my @contact = $prospect_main->contact;
529 my @cust_location = $prospect_main->cust_location;
530 my @qual = $prospect_main->qual;
532 foreach my $r ( @contact, @cust_location, @qual ) {
534 $r->custnum($self->custnum);
535 my $error = $r->replace;
537 $dbh->rollback if $oldAutoCommit;
544 warn " setting cust_main_exemption\n"
547 my $tax_exemption = delete $options{'tax_exemption'};
548 if ( $tax_exemption ) {
550 $tax_exemption = { map { $_ => '' } @$tax_exemption }
551 if ref($tax_exemption) eq 'ARRAY';
553 foreach my $taxname ( keys %$tax_exemption ) {
554 my $cust_main_exemption = new FS::cust_main_exemption {
555 'custnum' => $self->custnum,
556 'taxname' => $taxname,
557 'exempt_number' => $tax_exemption->{$taxname},
559 my $error = $cust_main_exemption->insert;
561 $dbh->rollback if $oldAutoCommit;
562 return "inserting cust_main_exemption (transaction rolled back): $error";
567 if ( $self->can('start_copy_skel') ) {
568 my $error = $self->start_copy_skel;
570 $dbh->rollback if $oldAutoCommit;
575 warn " ordering packages\n"
578 $error = $self->order_pkgs( $cust_pkgs,
580 'seconds_ref' => \$seconds,
581 'upbytes_ref' => \$upbytes,
582 'downbytes_ref' => \$downbytes,
583 'totalbytes_ref' => \$totalbytes,
586 $dbh->rollback if $oldAutoCommit;
591 $dbh->rollback if $oldAutoCommit;
592 return "No svc_acct record to apply pre-paid time";
594 if ( $upbytes || $downbytes || $totalbytes ) {
595 $dbh->rollback if $oldAutoCommit;
596 return "No svc_acct record to apply pre-paid data";
600 warn " inserting initial $payby payment of $amount\n"
602 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
604 $dbh->rollback if $oldAutoCommit;
605 return "inserting payment (transaction rolled back): $error";
609 unless ( $import || $skip_fuzzyfiles ) {
610 warn " queueing fuzzyfiles update\n"
612 $error = $self->queue_fuzzyfiles_update;
614 $dbh->rollback if $oldAutoCommit;
615 return "updating fuzzy search cache: $error";
619 # FS::geocode_Mixin::after_insert or something?
620 if ( $conf->config('tax_district_method') and !$import ) {
621 # if anything non-empty, try to look it up
622 my $queue = new FS::queue {
623 'job' => 'FS::geocode_Mixin::process_district_update',
624 'custnum' => $self->custnum,
626 my $error = $queue->insert( ref($self), $self->custnum );
628 $dbh->rollback if $oldAutoCommit;
629 return "queueing tax district update: $error";
634 warn " exporting\n" if $DEBUG > 1;
636 my $export_args = $options{'export_args'} || [];
639 map qsearch( 'part_export', {exportnum=>$_} ),
640 $conf->config('cust_main-exports'); #, $agentnum
642 foreach my $part_export ( @part_export ) {
643 my $error = $part_export->export_insert($self, @$export_args);
645 $dbh->rollback if $oldAutoCommit;
646 return "exporting to ". $part_export->exporttype.
647 " (transaction rolled back): $error";
651 #foreach my $depend_jobnum ( @$depend_jobnums ) {
652 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
654 # foreach my $jobnum ( @jobnums ) {
655 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
656 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
658 # my $error = $queue->depend_insert($depend_jobnum);
660 # $dbh->rollback if $oldAutoCommit;
661 # return "error queuing job dependancy: $error";
668 #if ( exists $options{'jobnums'} ) {
669 # push @{ $options{'jobnums'} }, @jobnums;
672 warn " insert complete; committing transaction\n"
675 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
680 use File::CounterFile;
681 sub auto_agent_custid {
684 my $format = $conf->config('cust_main-auto_agent_custid');
686 if ( $format eq '1YMMXXXXXXXX' ) {
688 my $counter = new File::CounterFile 'cust_main.agent_custid';
691 my $ym = 100000000000 + time2str('%y%m00000000', time);
692 if ( $ym > $counter->value ) {
693 $counter->{'value'} = $agent_custid = $ym;
694 $counter->{'updated'} = 1;
696 $agent_custid = $counter->inc;
702 die "Unknown cust_main-auto_agent_custid format: $format";
705 $self->agent_custid($agent_custid);
709 =item PACKAGE METHODS
711 Documentation on customer package methods has been moved to
712 L<FS::cust_main::Packages>.
714 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
716 Recharges this (existing) customer with the specified prepaid card (see
717 L<FS::prepay_credit>), specified either by I<identifier> or as an
718 FS::prepay_credit object. If there is an error, returns the error, otherwise
721 Optionally, five scalar references can be passed as well. They will have their
722 values filled in with the amount, number of seconds, and number of upload,
723 download, and total bytes applied by this prepaid card.
727 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
728 #the only place that uses these args
729 sub recharge_prepay {
730 my( $self, $prepay_credit, $amountref, $secondsref,
731 $upbytesref, $downbytesref, $totalbytesref ) = @_;
733 local $SIG{HUP} = 'IGNORE';
734 local $SIG{INT} = 'IGNORE';
735 local $SIG{QUIT} = 'IGNORE';
736 local $SIG{TERM} = 'IGNORE';
737 local $SIG{TSTP} = 'IGNORE';
738 local $SIG{PIPE} = 'IGNORE';
740 my $oldAutoCommit = $FS::UID::AutoCommit;
741 local $FS::UID::AutoCommit = 0;
744 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
746 my $error = $self->get_prepay( $prepay_credit,
747 'amount_ref' => \$amount,
748 'seconds_ref' => \$seconds,
749 'upbytes_ref' => \$upbytes,
750 'downbytes_ref' => \$downbytes,
751 'totalbytes_ref' => \$totalbytes,
753 || $self->increment_seconds($seconds)
754 || $self->increment_upbytes($upbytes)
755 || $self->increment_downbytes($downbytes)
756 || $self->increment_totalbytes($totalbytes)
757 || $self->insert_cust_pay_prepay( $amount,
759 ? $prepay_credit->identifier
764 $dbh->rollback if $oldAutoCommit;
768 if ( defined($amountref) ) { $$amountref = $amount; }
769 if ( defined($secondsref) ) { $$secondsref = $seconds; }
770 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
771 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
772 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
774 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
779 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
781 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
782 specified either by I<identifier> or as an FS::prepay_credit object.
784 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
785 incremented by the values of the prepaid card.
787 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
788 check or set this customer's I<agentnum>.
790 If there is an error, returns the error, otherwise returns false.
796 my( $self, $prepay_credit, %opt ) = @_;
798 local $SIG{HUP} = 'IGNORE';
799 local $SIG{INT} = 'IGNORE';
800 local $SIG{QUIT} = 'IGNORE';
801 local $SIG{TERM} = 'IGNORE';
802 local $SIG{TSTP} = 'IGNORE';
803 local $SIG{PIPE} = 'IGNORE';
805 my $oldAutoCommit = $FS::UID::AutoCommit;
806 local $FS::UID::AutoCommit = 0;
809 unless ( ref($prepay_credit) ) {
811 my $identifier = $prepay_credit;
813 $prepay_credit = qsearchs(
815 { 'identifier' => $identifier },
820 unless ( $prepay_credit ) {
821 $dbh->rollback if $oldAutoCommit;
822 return "Invalid prepaid card: ". $identifier;
827 if ( $prepay_credit->agentnum ) {
828 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
829 $dbh->rollback if $oldAutoCommit;
830 return "prepaid card not valid for agent ". $self->agentnum;
832 $self->agentnum($prepay_credit->agentnum);
835 my $error = $prepay_credit->delete;
837 $dbh->rollback if $oldAutoCommit;
838 return "removing prepay_credit (transaction rolled back): $error";
841 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
842 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
844 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
849 =item increment_upbytes SECONDS
851 Updates this customer's single or primary account (see L<FS::svc_acct>) by
852 the specified number of upbytes. If there is an error, returns the error,
853 otherwise returns false.
857 sub increment_upbytes {
858 _increment_column( shift, 'upbytes', @_);
861 =item increment_downbytes SECONDS
863 Updates this customer's single or primary account (see L<FS::svc_acct>) by
864 the specified number of downbytes. If there is an error, returns the error,
865 otherwise returns false.
869 sub increment_downbytes {
870 _increment_column( shift, 'downbytes', @_);
873 =item increment_totalbytes SECONDS
875 Updates this customer's single or primary account (see L<FS::svc_acct>) by
876 the specified number of totalbytes. If there is an error, returns the error,
877 otherwise returns false.
881 sub increment_totalbytes {
882 _increment_column( shift, 'totalbytes', @_);
885 =item increment_seconds SECONDS
887 Updates this customer's single or primary account (see L<FS::svc_acct>) by
888 the specified number of seconds. If there is an error, returns the error,
889 otherwise returns false.
893 sub increment_seconds {
894 _increment_column( shift, 'seconds', @_);
897 =item _increment_column AMOUNT
899 Updates this customer's single or primary account (see L<FS::svc_acct>) by
900 the specified number of seconds or bytes. If there is an error, returns
901 the error, otherwise returns false.
905 sub _increment_column {
906 my( $self, $column, $amount ) = @_;
907 warn "$me increment_column called: $column, $amount\n"
910 return '' unless $amount;
912 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
913 $self->ncancelled_pkgs;
916 return 'No packages with primary or single services found'.
917 ' to apply pre-paid time';
918 } elsif ( scalar(@cust_pkg) > 1 ) {
919 #maybe have a way to specify the package/account?
920 return 'Multiple packages found to apply pre-paid time';
923 my $cust_pkg = $cust_pkg[0];
924 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
928 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
931 return 'No account found to apply pre-paid time';
932 } elsif ( scalar(@cust_svc) > 1 ) {
933 return 'Multiple accounts found to apply pre-paid time';
936 my $svc_acct = $cust_svc[0]->svc_x;
937 warn " found service svcnum ". $svc_acct->pkgnum.
938 ' ('. $svc_acct->email. ")\n"
941 $column = "increment_$column";
942 $svc_acct->$column($amount);
946 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
948 Inserts a prepayment in the specified amount for this customer. An optional
949 second argument can specify the prepayment identifier for tracking purposes.
950 If there is an error, returns the error, otherwise returns false.
954 sub insert_cust_pay_prepay {
955 shift->insert_cust_pay('PREP', @_);
958 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
960 Inserts a cash payment in the specified amount for this customer. An optional
961 second argument can specify the payment identifier for tracking purposes.
962 If there is an error, returns the error, otherwise returns false.
966 sub insert_cust_pay_cash {
967 shift->insert_cust_pay('CASH', @_);
970 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
972 Inserts a Western Union payment in the specified amount for this customer. An
973 optional second argument can specify the prepayment identifier for tracking
974 purposes. If there is an error, returns the error, otherwise returns false.
978 sub insert_cust_pay_west {
979 shift->insert_cust_pay('WEST', @_);
982 sub insert_cust_pay {
983 my( $self, $payby, $amount ) = splice(@_, 0, 3);
984 my $payinfo = scalar(@_) ? shift : '';
986 my $cust_pay = new FS::cust_pay {
987 'custnum' => $self->custnum,
988 'paid' => sprintf('%.2f', $amount),
989 #'_date' => #date the prepaid card was purchased???
991 'payinfo' => $payinfo,
999 This method is deprecated. See the I<depend_jobnum> option to the insert and
1000 order_pkgs methods for a better way to defer provisioning.
1002 Re-schedules all exports by calling the B<reexport> method of all associated
1003 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1004 otherwise returns false.
1011 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1012 "use the depend_jobnum option to insert or order_pkgs to delay export";
1014 local $SIG{HUP} = 'IGNORE';
1015 local $SIG{INT} = 'IGNORE';
1016 local $SIG{QUIT} = 'IGNORE';
1017 local $SIG{TERM} = 'IGNORE';
1018 local $SIG{TSTP} = 'IGNORE';
1019 local $SIG{PIPE} = 'IGNORE';
1021 my $oldAutoCommit = $FS::UID::AutoCommit;
1022 local $FS::UID::AutoCommit = 0;
1025 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1026 my $error = $cust_pkg->reexport;
1028 $dbh->rollback if $oldAutoCommit;
1033 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1038 =item delete [ OPTION => VALUE ... ]
1040 This deletes the customer. If there is an error, returns the error, otherwise
1043 This will completely remove all traces of the customer record. This is not
1044 what you want when a customer cancels service; for that, cancel all of the
1045 customer's packages (see L</cancel>).
1047 If the customer has any uncancelled packages, you need to pass a new (valid)
1048 customer number for those packages to be transferred to, as the "new_customer"
1049 option. Cancelled packages will be deleted. Did I mention that this is NOT
1050 what you want when a customer cancels service and that you really should be
1051 looking at L<FS::cust_pkg/cancel>?
1053 You can't delete a customer with invoices (see L<FS::cust_bill>),
1054 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1055 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1056 set the "delete_financials" option to a true value.
1061 my( $self, %opt ) = @_;
1063 local $SIG{HUP} = 'IGNORE';
1064 local $SIG{INT} = 'IGNORE';
1065 local $SIG{QUIT} = 'IGNORE';
1066 local $SIG{TERM} = 'IGNORE';
1067 local $SIG{TSTP} = 'IGNORE';
1068 local $SIG{PIPE} = 'IGNORE';
1070 my $oldAutoCommit = $FS::UID::AutoCommit;
1071 local $FS::UID::AutoCommit = 0;
1074 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1075 $dbh->rollback if $oldAutoCommit;
1076 return "Can't delete a master agent customer";
1079 #use FS::access_user
1080 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1081 $dbh->rollback if $oldAutoCommit;
1082 return "Can't delete a master employee customer";
1085 tie my %financial_tables, 'Tie::IxHash',
1086 'cust_bill' => 'invoices',
1087 'cust_statement' => 'statements',
1088 'cust_credit' => 'credits',
1089 'cust_pay' => 'payments',
1090 'cust_refund' => 'refunds',
1093 foreach my $table ( keys %financial_tables ) {
1095 my @records = $self->$table();
1097 if ( @records && ! $opt{'delete_financials'} ) {
1098 $dbh->rollback if $oldAutoCommit;
1099 return "Can't delete a customer with ". $financial_tables{$table};
1102 foreach my $record ( @records ) {
1103 my $error = $record->delete;
1105 $dbh->rollback if $oldAutoCommit;
1106 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1112 my @cust_pkg = $self->ncancelled_pkgs;
1114 my $new_custnum = $opt{'new_custnum'};
1115 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1116 $dbh->rollback if $oldAutoCommit;
1117 return "Invalid new customer number: $new_custnum";
1119 foreach my $cust_pkg ( @cust_pkg ) {
1120 my %hash = $cust_pkg->hash;
1121 $hash{'custnum'} = $new_custnum;
1122 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1123 my $error = $new_cust_pkg->replace($cust_pkg,
1124 options => { $cust_pkg->options },
1127 $dbh->rollback if $oldAutoCommit;
1132 my @cancelled_cust_pkg = $self->all_pkgs;
1133 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1134 my $error = $cust_pkg->delete;
1136 $dbh->rollback if $oldAutoCommit;
1141 #cust_tax_adjustment in financials?
1142 #cust_pay_pending? ouch
1144 foreach my $table (qw(
1145 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1146 cust_location cust_main_note cust_tax_adjustment
1147 cust_pay_void cust_pay_batch queue cust_tax_exempt
1149 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1150 my $error = $record->delete;
1152 $dbh->rollback if $oldAutoCommit;
1158 my $sth = $dbh->prepare(
1159 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1161 my $errstr = $dbh->errstr;
1162 $dbh->rollback if $oldAutoCommit;
1165 $sth->execute($self->custnum) or do {
1166 my $errstr = $sth->errstr;
1167 $dbh->rollback if $oldAutoCommit;
1173 my $ticket_dbh = '';
1174 if ($conf->config('ticket_system') eq 'RT_Internal') {
1176 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1177 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1178 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1179 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1182 if ( $ticket_dbh ) {
1184 my $ticket_sth = $ticket_dbh->prepare(
1185 'DELETE FROM Links WHERE Target = ?'
1187 my $errstr = $ticket_dbh->errstr;
1188 $dbh->rollback if $oldAutoCommit;
1191 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1193 my $errstr = $ticket_sth->errstr;
1194 $dbh->rollback if $oldAutoCommit;
1198 #check and see if the customer is the only link on the ticket, and
1199 #if so, set the ticket to deleted status in RT?
1200 #maybe someday, for now this will at least fix tickets not displaying
1204 #delete the customer record
1206 my $error = $self->SUPER::delete;
1208 $dbh->rollback if $oldAutoCommit;
1212 # cust_main exports!
1214 #my $export_args = $options{'export_args'} || [];
1217 map qsearch( 'part_export', {exportnum=>$_} ),
1218 $conf->config('cust_main-exports'); #, $agentnum
1220 foreach my $part_export ( @part_export ) {
1221 my $error = $part_export->export_delete( $self ); #, @$export_args);
1223 $dbh->rollback if $oldAutoCommit;
1224 return "exporting to ". $part_export->exporttype.
1225 " (transaction rolled back): $error";
1229 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1234 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1236 This merges this customer into the provided new custnum, and then deletes the
1237 customer. If there is an error, returns the error, otherwise returns false.
1239 The source customer's name, company name, phone numbers, agent,
1240 referring customer, customer class, advertising source, order taker, and
1241 billing information (except balance) are discarded.
1243 All packages are moved to the target customer. Packages with package locations
1244 are preserved. Packages without package locations are moved to a new package
1245 location with the source customer's service/shipping address.
1247 All invoices, statements, payments, credits and refunds are moved to the target
1248 customer. The source customer's balance is added to the target customer.
1250 All notes, attachments, tickets and customer tags are moved to the target
1253 Change history is not currently moved.
1258 my( $self, $new_custnum, %opt ) = @_;
1260 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1262 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1263 return "Invalid new customer number: $new_custnum";
1266 local $SIG{HUP} = 'IGNORE';
1267 local $SIG{INT} = 'IGNORE';
1268 local $SIG{QUIT} = 'IGNORE';
1269 local $SIG{TERM} = 'IGNORE';
1270 local $SIG{TSTP} = 'IGNORE';
1271 local $SIG{PIPE} = 'IGNORE';
1273 my $oldAutoCommit = $FS::UID::AutoCommit;
1274 local $FS::UID::AutoCommit = 0;
1277 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1278 $dbh->rollback if $oldAutoCommit;
1279 return "Can't merge a master agent customer";
1282 #use FS::access_user
1283 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1284 $dbh->rollback if $oldAutoCommit;
1285 return "Can't merge a master employee customer";
1288 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1289 'status' => { op=>'!=', value=>'done' },
1293 $dbh->rollback if $oldAutoCommit;
1294 return "Can't merge a customer with pending payments";
1297 tie my %financial_tables, 'Tie::IxHash',
1298 'cust_bill' => 'invoices',
1299 'cust_statement' => 'statements',
1300 'cust_credit' => 'credits',
1301 'cust_pay' => 'payments',
1302 'cust_pay_void' => 'voided payments',
1303 'cust_refund' => 'refunds',
1306 foreach my $table ( keys %financial_tables ) {
1308 my @records = $self->$table();
1310 foreach my $record ( @records ) {
1311 $record->custnum($new_custnum);
1312 my $error = $record->replace;
1314 $dbh->rollback if $oldAutoCommit;
1315 return "Error merging ". $financial_tables{$table}. ": $error\n";
1321 my $name = $self->ship_name;
1323 my $locationnum = '';
1324 foreach my $cust_pkg ( $self->all_pkgs ) {
1325 $cust_pkg->custnum($new_custnum);
1327 unless ( $cust_pkg->locationnum ) {
1328 unless ( $locationnum ) {
1329 my $cust_location = new FS::cust_location {
1330 $self->location_hash,
1331 'custnum' => $new_custnum,
1333 my $error = $cust_location->insert;
1335 $dbh->rollback if $oldAutoCommit;
1338 $locationnum = $cust_location->locationnum;
1340 $cust_pkg->locationnum($locationnum);
1343 my $error = $cust_pkg->replace;
1345 $dbh->rollback if $oldAutoCommit;
1349 # add customer (ship) name to svc_phone.phone_name if blank
1350 my @cust_svc = $cust_pkg->cust_svc;
1351 foreach my $cust_svc (@cust_svc) {
1352 my($label, $value, $svcdb) = $cust_svc->label;
1353 next unless $svcdb eq 'svc_phone';
1354 my $svc_phone = $cust_svc->svc_x;
1355 next if $svc_phone->phone_name;
1356 $svc_phone->phone_name($name);
1357 my $error = $svc_phone->replace;
1359 $dbh->rollback if $oldAutoCommit;
1367 # cust_tax_exempt (texas tax exemptions)
1368 # cust_recon (some sort of not-well understood thing for OnPac)
1370 #these are moved over
1371 foreach my $table (qw(
1372 cust_tag cust_location contact cust_attachment cust_main_note
1373 cust_tax_adjustment cust_pay_batch queue
1375 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1376 $record->custnum($new_custnum);
1377 my $error = $record->replace;
1379 $dbh->rollback if $oldAutoCommit;
1385 #these aren't preserved
1386 foreach my $table (qw(
1387 cust_main_exemption cust_main_invoice
1389 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1390 my $error = $record->delete;
1392 $dbh->rollback if $oldAutoCommit;
1399 my $sth = $dbh->prepare(
1400 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1402 my $errstr = $dbh->errstr;
1403 $dbh->rollback if $oldAutoCommit;
1406 $sth->execute($new_custnum, $self->custnum) or do {
1407 my $errstr = $sth->errstr;
1408 $dbh->rollback if $oldAutoCommit;
1414 my $ticket_dbh = '';
1415 if ($conf->config('ticket_system') eq 'RT_Internal') {
1417 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1418 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1419 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1420 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1423 if ( $ticket_dbh ) {
1425 my $ticket_sth = $ticket_dbh->prepare(
1426 'UPDATE Links SET Target = ? WHERE Target = ?'
1428 my $errstr = $ticket_dbh->errstr;
1429 $dbh->rollback if $oldAutoCommit;
1432 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1433 'freeside://freeside/cust_main/'.$self->custnum)
1435 my $errstr = $ticket_sth->errstr;
1436 $dbh->rollback if $oldAutoCommit;
1442 #delete the customer record
1444 my $error = $self->delete;
1446 $dbh->rollback if $oldAutoCommit;
1450 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1455 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1458 Replaces the OLD_RECORD with this one in the database. If there is an error,
1459 returns the error, otherwise returns false.
1461 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1462 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1463 expected and rollback the entire transaction; it is not necessary to call
1464 check_invoicing_list first. Here's an example:
1466 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1468 Currently available options are: I<tax_exemption>.
1470 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1471 of tax names and exemption numbers. FS::cust_main_exemption records will be
1472 deleted and inserted as appropriate.
1479 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1481 : $self->replace_old;
1485 warn "$me replace called\n"
1488 my $curuser = $FS::CurrentUser::CurrentUser;
1489 if ( $self->payby eq 'COMP'
1490 && $self->payby ne $old->payby
1491 && ! $curuser->access_right('Complimentary customer')
1494 return "You are not permitted to create complimentary accounts.";
1497 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1498 && $conf->exists('enable_taxproducts')
1501 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1503 $self->set('geocode', '')
1504 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1505 && length($self->get($pre.'zip')) >= 10;
1508 for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1510 $self->set($pre.'coord_auto', '') && next
1511 if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1512 && ( $self->get($pre.'latitude') != $old->get($pre.'latitude')
1513 || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1516 $self->set_coord($pre)
1517 if $old->get($pre.'address1') ne $self->get($pre.'address1')
1518 || $old->get($pre.'city') ne $self->get($pre.'city')
1519 || $old->get($pre.'state') ne $self->get($pre.'state')
1520 || $old->get($pre.'country') ne $self->get($pre.'country');
1524 unless ( $import ) {
1526 if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1528 $self->set_coord('ship_')
1529 if $self->has_ship_address && ! $self->ship_coord_auto
1530 && ! $self->ship_latitude && ! $self->ship_longitude;
1533 local($ignore_expired_card) = 1
1534 if $old->payby =~ /^(CARD|DCRD)$/
1535 && $self->payby =~ /^(CARD|DCRD)$/
1536 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1538 local($ignore_banned_card) = 1
1539 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1540 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1541 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1543 if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1544 # update censusyear whenever tract code changes
1545 $self->censusyear($conf->config('census_year')||'2012');
1548 return "Invoicing locale is required"
1551 && $conf->exists('cust_main-require_locale');
1553 local $SIG{HUP} = 'IGNORE';
1554 local $SIG{INT} = 'IGNORE';
1555 local $SIG{QUIT} = 'IGNORE';
1556 local $SIG{TERM} = 'IGNORE';
1557 local $SIG{TSTP} = 'IGNORE';
1558 local $SIG{PIPE} = 'IGNORE';
1560 my $oldAutoCommit = $FS::UID::AutoCommit;
1561 local $FS::UID::AutoCommit = 0;
1564 my $error = $self->SUPER::replace($old);
1567 $dbh->rollback if $oldAutoCommit;
1571 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1572 my $invoicing_list = shift @param;
1573 $error = $self->check_invoicing_list( $invoicing_list );
1575 $dbh->rollback if $oldAutoCommit;
1578 $self->invoicing_list( $invoicing_list );
1581 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1583 #this could be more efficient than deleting and re-inserting, if it matters
1584 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1585 my $error = $cust_tag->delete;
1587 $dbh->rollback if $oldAutoCommit;
1591 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1592 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1593 'custnum' => $self->custnum };
1594 my $error = $cust_tag->insert;
1596 $dbh->rollback if $oldAutoCommit;
1603 my %options = @param;
1605 my $tax_exemption = delete $options{'tax_exemption'};
1606 if ( $tax_exemption ) {
1608 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1609 if ref($tax_exemption) eq 'ARRAY';
1611 my %cust_main_exemption =
1612 map { $_->taxname => $_ }
1613 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1615 foreach my $taxname ( keys %$tax_exemption ) {
1617 if ( $cust_main_exemption{$taxname} &&
1618 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1621 delete $cust_main_exemption{$taxname};
1625 my $cust_main_exemption = new FS::cust_main_exemption {
1626 'custnum' => $self->custnum,
1627 'taxname' => $taxname,
1628 'exempt_number' => $tax_exemption->{$taxname},
1630 my $error = $cust_main_exemption->insert;
1632 $dbh->rollback if $oldAutoCommit;
1633 return "inserting cust_main_exemption (transaction rolled back): $error";
1637 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1638 my $error = $cust_main_exemption->delete;
1640 $dbh->rollback if $oldAutoCommit;
1641 return "deleting cust_main_exemption (transaction rolled back): $error";
1647 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1648 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1649 && $self->get('payinfo') !~ /^99\d{14}$/
1651 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1656 # card/check/lec info has changed, want to retry realtime_ invoice events
1657 my $error = $self->retry_realtime;
1659 $dbh->rollback if $oldAutoCommit;
1664 unless ( $import || $skip_fuzzyfiles ) {
1665 $error = $self->queue_fuzzyfiles_update;
1667 $dbh->rollback if $oldAutoCommit;
1668 return "updating fuzzy search cache: $error";
1672 # FS::geocode_Mixin::after_replace ?
1673 # though this will go away anyway once we move customer bill/service
1674 # locations into cust_location
1675 # We can trigger this on any address change--just have to make sure
1676 # not to trigger it on itself.
1677 if ( $conf->config('tax_district_method') and !$import
1678 and ( $self->get('ship_address1') ne $old->get('ship_address1')
1679 or $self->get('address1') ne $old->get('address1') ) ) {
1680 my $queue = new FS::queue {
1681 'job' => 'FS::geocode_Mixin::process_district_update',
1682 'custnum' => $self->custnum,
1684 my $error = $queue->insert( ref($self), $self->custnum );
1686 $dbh->rollback if $oldAutoCommit;
1687 return "queueing tax district update: $error";
1691 # cust_main exports!
1693 my $export_args = $options{'export_args'} || [];
1696 map qsearch( 'part_export', {exportnum=>$_} ),
1697 $conf->config('cust_main-exports'); #, $agentnum
1699 foreach my $part_export ( @part_export ) {
1700 my $error = $part_export->export_replace( $self, $old, @$export_args);
1702 $dbh->rollback if $oldAutoCommit;
1703 return "exporting to ". $part_export->exporttype.
1704 " (transaction rolled back): $error";
1708 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1713 =item queue_fuzzyfiles_update
1715 Used by insert & replace to update the fuzzy search cache
1719 use FS::cust_main::Search;
1720 sub queue_fuzzyfiles_update {
1723 local $SIG{HUP} = 'IGNORE';
1724 local $SIG{INT} = 'IGNORE';
1725 local $SIG{QUIT} = 'IGNORE';
1726 local $SIG{TERM} = 'IGNORE';
1727 local $SIG{TSTP} = 'IGNORE';
1728 local $SIG{PIPE} = 'IGNORE';
1730 my $oldAutoCommit = $FS::UID::AutoCommit;
1731 local $FS::UID::AutoCommit = 0;
1734 my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1735 my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1737 $dbh->rollback if $oldAutoCommit;
1738 return "queueing job (transaction rolled back): $error";
1741 if ( $self->ship_last ) {
1742 $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1743 $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1745 $dbh->rollback if $oldAutoCommit;
1746 return "queueing job (transaction rolled back): $error";
1750 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1757 Checks all fields to make sure this is a valid customer record. If there is
1758 an error, returns the error, otherwise returns false. Called by the insert
1759 and replace methods.
1766 warn "$me check BEFORE: \n". $self->_dump
1770 $self->ut_numbern('custnum')
1771 || $self->ut_number('agentnum')
1772 || $self->ut_textn('agent_custid')
1773 || $self->ut_number('refnum')
1774 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1775 || $self->ut_textn('custbatch')
1776 || $self->ut_name('last')
1777 || $self->ut_name('first')
1778 || $self->ut_snumbern('birthdate')
1779 || $self->ut_snumbern('signupdate')
1780 || $self->ut_textn('company')
1781 || $self->ut_text('address1')
1782 || $self->ut_textn('address2')
1783 || $self->ut_text('city')
1784 || $self->ut_textn('county')
1785 || $self->ut_textn('state')
1786 || $self->ut_country('country')
1787 || $self->ut_coordn('latitude')
1788 || $self->ut_coordn('longitude')
1789 || $self->ut_enum('coord_auto', [ '', 'Y' ])
1790 || $self->ut_numbern('censusyear')
1791 || $self->ut_anything('comments')
1792 || $self->ut_numbern('referral_custnum')
1793 || $self->ut_textn('stateid')
1794 || $self->ut_textn('stateid_state')
1795 || $self->ut_textn('invoice_terms')
1796 || $self->ut_alphan('geocode')
1797 || $self->ut_alphan('district')
1798 || $self->ut_floatn('cdr_termination_percentage')
1799 || $self->ut_floatn('credit_limit')
1800 || $self->ut_numbern('billday')
1801 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1802 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1803 || $self->ut_enum('invoice_noemail', [ '', 'Y' ] )
1804 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1808 unless $import || ($self->latitude && $self->longitude);
1810 #barf. need message catalogs. i18n. etc.
1811 $error .= "Please select an advertising source."
1812 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1813 return $error if $error;
1815 return "Unknown agent"
1816 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1818 return "Unknown refnum"
1819 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1821 return "Unknown referring custnum: ". $self->referral_custnum
1822 unless ! $self->referral_custnum
1823 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1825 if ( $self->censustract ne '' ) {
1826 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1827 or return "Illegal census tract: ". $self->censustract;
1829 $self->censustract("$1.$2");
1832 if ( $self->ss eq '' ) {
1837 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1838 or return "Illegal social security number: ". $self->ss;
1839 $self->ss("$1-$2-$3");
1843 # bad idea to disable, causes billing to fail because of no tax rates later
1844 # except we don't fail any more
1845 unless ( $import ) {
1846 unless ( qsearch('cust_main_county', {
1847 'country' => $self->country,
1850 return "Unknown state/county/country: ".
1851 $self->state. "/". $self->county. "/". $self->country
1852 unless qsearch('cust_main_county',{
1853 'state' => $self->state,
1854 'county' => $self->county,
1855 'country' => $self->country,
1861 $self->ut_phonen('daytime', $self->country)
1862 || $self->ut_phonen('night', $self->country)
1863 || $self->ut_phonen('fax', $self->country)
1864 || $self->ut_phonen('mobile', $self->country)
1866 return $error if $error;
1868 unless ( $ignore_illegal_zip ) {
1869 $error = $self->ut_zip('zip', $self->country);
1870 return $error if $error;
1873 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1874 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1877 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1879 : FS::Msgcat::_gettext('daytime');
1880 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1882 : FS::Msgcat::_gettext('night');
1884 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1886 : FS::Msgcat::_gettext('mobile');
1888 return "$daytime_label, $night_label or $mobile_label is required"
1892 if ( $self->has_ship_address
1893 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1894 $self->addr_fields )
1898 $self->ut_name('ship_last')
1899 || $self->ut_name('ship_first')
1900 || $self->ut_textn('ship_company')
1901 || $self->ut_text('ship_address1')
1902 || $self->ut_textn('ship_address2')
1903 || $self->ut_text('ship_city')
1904 || $self->ut_textn('ship_county')
1905 || $self->ut_textn('ship_state')
1906 || $self->ut_country('ship_country')
1907 || $self->ut_coordn('ship_latitude')
1908 || $self->ut_coordn('ship_longitude')
1909 || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1911 return $error if $error;
1913 $self->set_coord('ship_')
1914 unless $import || ($self->ship_latitude && $self->ship_longitude);
1916 #false laziness with above
1917 unless ( qsearchs('cust_main_county', {
1918 'country' => $self->ship_country,
1921 return "Unknown ship_state/ship_county/ship_country: ".
1922 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1923 unless qsearch('cust_main_county',{
1924 'state' => $self->ship_state,
1925 'county' => $self->ship_county,
1926 'country' => $self->ship_country,
1932 $self->ut_phonen('ship_daytime', $self->ship_country)
1933 || $self->ut_phonen('ship_night', $self->ship_country)
1934 || $self->ut_phonen('ship_fax', $self->ship_country)
1935 || $self->ut_phonen('ship_mobile', $self->ship_country)
1937 return $error if $error;
1939 unless ( $ignore_illegal_zip ) {
1940 $error = $self->ut_zip('ship_zip', $self->ship_country);
1941 return $error if $error;
1943 return "Unit # is required."
1944 if $self->ship_address2 =~ /^\s*$/
1945 && $conf->exists('cust_main-require_address2');
1947 } else { # ship_ info eq billing info, so don't store dup info in database
1949 $self->setfield("ship_$_", '')
1950 foreach $self->addr_fields;
1952 return "Unit # is required."
1953 if $self->address2 =~ /^\s*$/
1954 && $conf->exists('cust_main-require_address2');
1958 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1959 # or return "Illegal payby: ". $self->payby;
1961 FS::payby->can_payby($self->table, $self->payby)
1962 or return "Illegal payby: ". $self->payby;
1964 $error = $self->ut_numbern('paystart_month')
1965 || $self->ut_numbern('paystart_year')
1966 || $self->ut_numbern('payissue')
1967 || $self->ut_textn('paytype')
1969 return $error if $error;
1971 if ( $self->payip eq '' ) {
1974 $error = $self->ut_ip('payip');
1975 return $error if $error;
1978 # If it is encrypted and the private key is not availaible then we can't
1979 # check the credit card.
1980 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1982 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1984 my $payinfo = $self->payinfo;
1985 $payinfo =~ s/\D//g;
1986 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1987 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1989 $self->payinfo($payinfo);
1991 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1993 return gettext('unknown_card_type')
1994 if $self->payinfo !~ /^99\d{14}$/ #token
1995 && cardtype($self->payinfo) eq "Unknown";
1997 unless ( $ignore_banned_card ) {
1998 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2000 if ( $ban->bantype eq 'warn' ) {
2001 #or others depending on value of $ban->reason ?
2002 return '_duplicate_card'.
2003 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
2004 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
2005 ' (ban# '. $ban->bannum. ')'
2006 unless $self->override_ban_warn;
2008 return 'Banned credit card: banned on '.
2009 time2str('%a %h %o at %r', $ban->_date).
2010 ' by '. $ban->otaker.
2011 ' (ban# '. $ban->bannum. ')';
2016 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
2017 if ( cardtype($self->payinfo) eq 'American Express card' ) {
2018 $self->paycvv =~ /^(\d{4})$/
2019 or return "CVV2 (CID) for American Express cards is four digits.";
2022 $self->paycvv =~ /^(\d{3})$/
2023 or return "CVV2 (CVC2/CID) is three digits.";
2030 my $cardtype = cardtype($payinfo);
2031 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
2033 return "Start date or issue number is required for $cardtype cards"
2034 unless $self->paystart_month && $self->paystart_year or $self->payissue;
2036 return "Start month must be between 1 and 12"
2037 if $self->paystart_month
2038 and $self->paystart_month < 1 || $self->paystart_month > 12;
2040 return "Start year must be 1990 or later"
2041 if $self->paystart_year
2042 and $self->paystart_year < 1990;
2044 return "Issue number must be beween 1 and 99"
2046 and $self->payissue < 1 || $self->payissue > 99;
2049 $self->paystart_month('');
2050 $self->paystart_year('');
2051 $self->payissue('');
2054 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
2056 my $payinfo = $self->payinfo;
2057 $payinfo =~ s/[^\d\@\.]//g;
2058 if ( $conf->config('echeck-country') eq 'CA' ) {
2059 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
2060 or return 'invalid echeck account@branch.bank';
2061 $payinfo = "$1\@$2.$3";
2062 } elsif ( $conf->config('echeck-country') eq 'US' ) {
2063 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2064 $payinfo = "$1\@$2";
2066 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
2067 $payinfo = "$1\@$2";
2069 $self->payinfo($payinfo);
2072 unless ( $ignore_banned_card ) {
2073 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2075 if ( $ban->bantype eq 'warn' ) {
2076 #or others depending on value of $ban->reason ?
2077 return '_duplicate_ach' unless $self->override_ban_warn;
2079 return 'Banned ACH account: banned on '.
2080 time2str('%a %h %o at %r', $ban->_date).
2081 ' by '. $ban->otaker.
2082 ' (ban# '. $ban->bannum. ')';
2087 } elsif ( $self->payby eq 'LECB' ) {
2089 my $payinfo = $self->payinfo;
2090 $payinfo =~ s/\D//g;
2091 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2093 $self->payinfo($payinfo);
2096 } elsif ( $self->payby eq 'BILL' ) {
2098 $error = $self->ut_textn('payinfo');
2099 return "Illegal P.O. number: ". $self->payinfo if $error;
2102 } elsif ( $self->payby eq 'COMP' ) {
2104 my $curuser = $FS::CurrentUser::CurrentUser;
2105 if ( ! $self->custnum
2106 && ! $curuser->access_right('Complimentary customer')
2109 return "You are not permitted to create complimentary accounts."
2112 $error = $self->ut_textn('payinfo');
2113 return "Illegal comp account issuer: ". $self->payinfo if $error;
2116 } elsif ( $self->payby eq 'PREPAY' ) {
2118 my $payinfo = $self->payinfo;
2119 $payinfo =~ s/\W//g; #anything else would just confuse things
2120 $self->payinfo($payinfo);
2121 $error = $self->ut_alpha('payinfo');
2122 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2123 return "Unknown prepayment identifier"
2124 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2129 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2130 return "Expiration date required"
2131 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2135 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2136 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2137 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2138 ( $m, $y ) = ( $2, "19$1" );
2139 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2140 ( $m, $y ) = ( $3, "20$2" );
2142 return "Illegal expiration date: ". $self->paydate;
2144 $m = sprintf('%02d',$m);
2145 $self->paydate("$y-$m-01");
2146 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2147 return gettext('expired_card')
2149 && !$ignore_expired_card
2150 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2153 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2154 ( ! $conf->exists('require_cardname')
2155 || $self->payby !~ /^(CARD|DCRD)$/ )
2157 $self->payname( $self->first. " ". $self->getfield('last') );
2159 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2160 or return gettext('illegal_name'). " payname: ". $self->payname;
2164 return "Please select an invoicing locale"
2167 && $conf->exists('cust_main-require_locale');
2169 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2170 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2174 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2176 warn "$me check AFTER: \n". $self->_dump
2179 $self->SUPER::check;
2184 Returns a list of fields which have ship_ duplicates.
2189 qw( last first company
2190 address1 address2 city county state zip country
2192 daytime night fax mobile
2196 =item has_ship_address
2198 Returns true if this customer record has a separate shipping address.
2202 sub has_ship_address {
2204 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2209 Returns a list of key/value pairs, with the following keys: address1,
2210 adddress2, city, county, state, zip, country, district, and geocode. The
2211 shipping address is used if present.
2217 Returns all locations (see L<FS::cust_location>) for this customer.
2223 qsearch('cust_location', { 'custnum' => $self->custnum } );
2228 Returns all contacts (see L<FS::contact>) for this customer.
2232 #already used :/ sub contact {
2235 qsearch('contact', { 'custnum' => $self->custnum } );
2240 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2241 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2242 on success or a list of errors.
2248 grep { $_->unsuspend } $self->suspended_pkgs;
2253 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2255 Returns a list: an empty list on success or a list of errors.
2261 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2264 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2266 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2267 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2268 of a list of pkgparts; the hashref has the following keys:
2272 =item pkgparts - listref of pkgparts
2274 =item (other options are passed to the suspend method)
2279 Returns a list: an empty list on success or a list of errors.
2283 sub suspend_if_pkgpart {
2285 my (@pkgparts, %opt);
2286 if (ref($_[0]) eq 'HASH'){
2287 @pkgparts = @{$_[0]{pkgparts}};
2292 grep { $_->suspend(%opt) }
2293 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2294 $self->unsuspended_pkgs;
2297 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2299 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2300 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2301 instead of a list of pkgparts; the hashref has the following keys:
2305 =item pkgparts - listref of pkgparts
2307 =item (other options are passed to the suspend method)
2311 Returns a list: an empty list on success or a list of errors.
2315 sub suspend_unless_pkgpart {
2317 my (@pkgparts, %opt);
2318 if (ref($_[0]) eq 'HASH'){
2319 @pkgparts = @{$_[0]{pkgparts}};
2324 grep { $_->suspend(%opt) }
2325 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2326 $self->unsuspended_pkgs;
2329 =item cancel [ OPTION => VALUE ... ]
2331 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2333 Available options are:
2337 =item quiet - can be set true to supress email cancellation notices.
2339 =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.
2341 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2343 =item nobill - can be set true to skip billing if it might otherwise be done.
2347 Always returns a list: an empty list on success or a list of errors.
2351 # nb that dates are not specified as valid options to this method
2354 my( $self, %opt ) = @_;
2356 warn "$me cancel called on customer ". $self->custnum. " with options ".
2357 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2360 return ( 'access denied' )
2361 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2363 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2365 #should try decryption (we might have the private key)
2366 # and if not maybe queue a job for the server that does?
2367 return ( "Can't (yet) ban encrypted credit cards" )
2368 if $self->is_encrypted($self->payinfo);
2370 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2371 my $error = $ban->insert;
2372 return ( $error ) if $error;
2376 my @pkgs = $self->ncancelled_pkgs;
2378 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2380 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2381 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2385 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2386 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2389 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2392 sub _banned_pay_hashref {
2403 'payby' => $payby2ban{$self->payby},
2404 'payinfo' => $self->payinfo,
2405 #don't ever *search* on reason! #'reason' =>
2409 sub _new_banned_pay_hashref {
2411 my $hr = $self->_banned_pay_hashref;
2412 $hr->{payinfo} = md5_base64($hr->{payinfo});
2418 Returns all notes (see L<FS::cust_main_note>) for this customer.
2423 my($self,$orderby_classnum) = (shift,shift);
2424 my $orderby = "_DATE DESC";
2425 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2426 qsearch( 'cust_main_note',
2427 { 'custnum' => $self->custnum },
2429 "ORDER BY $orderby",
2435 Returns the agent (see L<FS::agent>) for this customer.
2441 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2446 Returns the agent name (see L<FS::agent>) for this customer.
2452 $self->agent->agent;
2457 Returns any tags associated with this customer, as FS::cust_tag objects,
2458 or an empty list if there are no tags.
2464 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2469 Returns any tags associated with this customer, as FS::part_tag objects,
2470 or an empty list if there are no tags.
2476 map $_->part_tag, $self->cust_tag;
2482 Returns the customer class, as an FS::cust_class object, or the empty string
2483 if there is no customer class.
2489 if ( $self->classnum ) {
2490 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2498 Returns the customer category name, or the empty string if there is no customer
2505 my $cust_class = $self->cust_class;
2507 ? $cust_class->categoryname
2513 Returns the customer class name, or the empty string if there is no customer
2520 my $cust_class = $self->cust_class;
2522 ? $cust_class->classname
2526 =item BILLING METHODS
2528 Documentation on billing methods has been moved to
2529 L<FS::cust_main::Billing>.
2531 =item REALTIME BILLING METHODS
2533 Documentation on realtime billing methods has been moved to
2534 L<FS::cust_main::Billing_Realtime>.
2538 Removes the I<paycvv> field from the database directly.
2540 If there is an error, returns the error, otherwise returns false.
2546 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2547 or return dbh->errstr;
2548 $sth->execute($self->custnum)
2549 or return $sth->errstr;
2554 =item batch_card OPTION => VALUE...
2556 Adds a payment for this invoice to the pending credit card batch (see
2557 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2558 runs the payment using a realtime gateway.
2563 my ($self, %options) = @_;
2566 if (exists($options{amount})) {
2567 $amount = $options{amount};
2569 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2571 return '' unless $amount > 0;
2573 my $invnum = delete $options{invnum};
2574 my $payby = $options{payby} || $self->payby; #still dubious
2576 if ($options{'realtime'}) {
2577 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2583 my $oldAutoCommit = $FS::UID::AutoCommit;
2584 local $FS::UID::AutoCommit = 0;
2587 #this needs to handle mysql as well as Pg, like svc_acct.pm
2588 #(make it into a common function if folks need to do batching with mysql)
2589 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2590 or return "Cannot lock pay_batch: " . $dbh->errstr;
2594 'payby' => FS::payby->payby2payment($payby),
2596 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2598 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2600 unless ( $pay_batch ) {
2601 $pay_batch = new FS::pay_batch \%pay_batch;
2602 my $error = $pay_batch->insert;
2604 $dbh->rollback if $oldAutoCommit;
2605 die "error creating new batch: $error\n";
2609 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2610 'batchnum' => $pay_batch->batchnum,
2611 'custnum' => $self->custnum,
2614 foreach (qw( address1 address2 city state zip country latitude longitude
2615 payby payinfo paydate payname ))
2617 $options{$_} = '' unless exists($options{$_});
2620 my $cust_pay_batch = new FS::cust_pay_batch ( {
2621 'batchnum' => $pay_batch->batchnum,
2622 'invnum' => $invnum || 0, # is there a better value?
2623 # this field should be
2625 # cust_bill_pay_batch now
2626 'custnum' => $self->custnum,
2627 'last' => $self->getfield('last'),
2628 'first' => $self->getfield('first'),
2629 'address1' => $options{address1} || $self->address1,
2630 'address2' => $options{address2} || $self->address2,
2631 'city' => $options{city} || $self->city,
2632 'state' => $options{state} || $self->state,
2633 'zip' => $options{zip} || $self->zip,
2634 'country' => $options{country} || $self->country,
2635 'payby' => $options{payby} || $self->payby,
2636 'payinfo' => $options{payinfo} || $self->payinfo,
2637 'exp' => $options{paydate} || $self->paydate,
2638 'payname' => $options{payname} || $self->payname,
2639 'amount' => $amount, # consolidating
2642 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2643 if $old_cust_pay_batch;
2646 if ($old_cust_pay_batch) {
2647 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2649 $error = $cust_pay_batch->insert;
2653 $dbh->rollback if $oldAutoCommit;
2657 my $unapplied = $self->total_unapplied_credits
2658 + $self->total_unapplied_payments
2659 + $self->in_transit_payments;
2660 foreach my $cust_bill ($self->open_cust_bill) {
2661 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2662 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2663 'invnum' => $cust_bill->invnum,
2664 'paybatchnum' => $cust_pay_batch->paybatchnum,
2665 'amount' => $cust_bill->owed,
2668 if ($unapplied >= $cust_bill_pay_batch->amount){
2669 $unapplied -= $cust_bill_pay_batch->amount;
2672 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2673 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2675 $error = $cust_bill_pay_batch->insert;
2677 $dbh->rollback if $oldAutoCommit;
2682 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2688 Returns the total owed for this customer on all invoices
2689 (see L<FS::cust_bill/owed>).
2695 $self->total_owed_date(2145859200); #12/31/2037
2698 =item total_owed_date TIME
2700 Returns the total owed for this customer on all invoices with date earlier than
2701 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2702 see L<Time::Local> and L<Date::Parse> for conversion functions.
2706 sub total_owed_date {
2710 my $custnum = $self->custnum;
2712 my $owed_sql = FS::cust_bill->owed_sql;
2715 SELECT SUM($owed_sql) FROM cust_bill
2716 WHERE custnum = $custnum
2720 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2724 =item total_owed_pkgnum PKGNUM
2726 Returns the total owed on all invoices for this customer's specific package
2727 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2731 sub total_owed_pkgnum {
2732 my( $self, $pkgnum ) = @_;
2733 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2736 =item total_owed_date_pkgnum TIME PKGNUM
2738 Returns the total owed for this customer's specific package when using
2739 experimental package balances on all invoices with date earlier than
2740 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2741 see L<Time::Local> and L<Date::Parse> for conversion functions.
2745 sub total_owed_date_pkgnum {
2746 my( $self, $time, $pkgnum ) = @_;
2749 foreach my $cust_bill (
2750 grep { $_->_date <= $time }
2751 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2753 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2755 sprintf( "%.2f", $total_bill );
2761 Returns the total amount of all payments.
2768 $total += $_->paid foreach $self->cust_pay;
2769 sprintf( "%.2f", $total );
2772 =item total_unapplied_credits
2774 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2775 customer. See L<FS::cust_credit/credited>.
2777 =item total_credited
2779 Old name for total_unapplied_credits. Don't use.
2783 sub total_credited {
2784 #carp "total_credited deprecated, use total_unapplied_credits";
2785 shift->total_unapplied_credits(@_);
2788 sub total_unapplied_credits {
2791 my $custnum = $self->custnum;
2793 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2796 SELECT SUM($unapplied_sql) FROM cust_credit
2797 WHERE custnum = $custnum
2800 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2804 =item total_unapplied_credits_pkgnum PKGNUM
2806 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2807 customer. See L<FS::cust_credit/credited>.
2811 sub total_unapplied_credits_pkgnum {
2812 my( $self, $pkgnum ) = @_;
2813 my $total_credit = 0;
2814 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2815 sprintf( "%.2f", $total_credit );
2819 =item total_unapplied_payments
2821 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2822 See L<FS::cust_pay/unapplied>.
2826 sub total_unapplied_payments {
2829 my $custnum = $self->custnum;
2831 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2834 SELECT SUM($unapplied_sql) FROM cust_pay
2835 WHERE custnum = $custnum
2838 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2842 =item total_unapplied_payments_pkgnum PKGNUM
2844 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2845 specific package when using experimental package balances. See
2846 L<FS::cust_pay/unapplied>.
2850 sub total_unapplied_payments_pkgnum {
2851 my( $self, $pkgnum ) = @_;
2852 my $total_unapplied = 0;
2853 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2854 sprintf( "%.2f", $total_unapplied );
2858 =item total_unapplied_refunds
2860 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2861 customer. See L<FS::cust_refund/unapplied>.
2865 sub total_unapplied_refunds {
2867 my $custnum = $self->custnum;
2869 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2872 SELECT SUM($unapplied_sql) FROM cust_refund
2873 WHERE custnum = $custnum
2876 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2882 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2883 total_unapplied_credits minus total_unapplied_payments).
2889 $self->balance_date_range;
2892 =item balance_date TIME
2894 Returns the balance for this customer, only considering invoices with date
2895 earlier than TIME (total_owed_date minus total_credited minus
2896 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2897 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2904 $self->balance_date_range(shift);
2907 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2909 Returns the balance for this customer, optionally considering invoices with
2910 date earlier than START_TIME, and not later than END_TIME
2911 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2913 Times are specified as SQL fragments or numeric
2914 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2915 L<Date::Parse> for conversion functions. The empty string can be passed
2916 to disable that time constraint completely.
2918 Available options are:
2922 =item unapplied_date
2924 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)
2930 sub balance_date_range {
2932 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2933 ') FROM cust_main WHERE custnum='. $self->custnum;
2934 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2937 =item balance_pkgnum PKGNUM
2939 Returns the balance for this customer's specific package when using
2940 experimental package balances (total_owed plus total_unrefunded, minus
2941 total_unapplied_credits minus total_unapplied_payments)
2945 sub balance_pkgnum {
2946 my( $self, $pkgnum ) = @_;
2949 $self->total_owed_pkgnum($pkgnum)
2950 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2951 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2952 - $self->total_unapplied_credits_pkgnum($pkgnum)
2953 - $self->total_unapplied_payments_pkgnum($pkgnum)
2957 =item in_transit_payments
2959 Returns the total of requests for payments for this customer pending in
2960 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2964 sub in_transit_payments {
2966 my $in_transit_payments = 0;
2967 foreach my $pay_batch ( qsearch('pay_batch', {
2970 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2971 'batchnum' => $pay_batch->batchnum,
2972 'custnum' => $self->custnum,
2974 $in_transit_payments += $cust_pay_batch->amount;
2977 sprintf( "%.2f", $in_transit_payments );
2982 Returns a hash of useful information for making a payment.
2992 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2993 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2994 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2998 For credit card transactions:
3010 For electronic check transactions:
3025 $return{balance} = $self->balance;
3027 $return{payname} = $self->payname
3028 || ( $self->first. ' '. $self->get('last') );
3030 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
3032 $return{payby} = $self->payby;
3033 $return{stateid_state} = $self->stateid_state;
3035 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3036 $return{card_type} = cardtype($self->payinfo);
3037 $return{payinfo} = $self->paymask;
3039 @return{'month', 'year'} = $self->paydate_monthyear;
3043 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3044 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3045 $return{payinfo1} = $payinfo1;
3046 $return{payinfo2} = $payinfo2;
3047 $return{paytype} = $self->paytype;
3048 $return{paystate} = $self->paystate;
3052 #doubleclick protection
3054 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3060 =item paydate_monthyear
3062 Returns a two-element list consisting of the month and year of this customer's
3063 paydate (credit card expiration date for CARD customers)
3067 sub paydate_monthyear {
3069 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3071 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3080 Returns the exact time in seconds corresponding to the payment method
3081 expiration date. For CARD/DCRD customers this is the end of the month;
3082 for others (COMP is the only other payby that uses paydate) it's the start.
3083 Returns 0 if the paydate is empty or set to the far future.
3089 my ($month, $year) = $self->paydate_monthyear;
3090 return 0 if !$year or $year >= 2037;
3091 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3093 if ( $month == 13 ) {
3097 return timelocal(0,0,0,1,$month-1,$year) - 1;
3100 return timelocal(0,0,0,1,$month-1,$year);
3104 =item paydate_epoch_sql
3106 Class method. Returns an SQL expression to obtain the payment expiration date
3107 as a number of seconds.
3111 # Special expiration date behavior for non-CARD/DCRD customers has been
3112 # carefully preserved. Do we really use that?
3113 sub paydate_epoch_sql {
3115 my $table = shift || 'cust_main';
3116 my ($case1, $case2);
3117 if ( driver_name eq 'Pg' ) {
3118 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3119 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3121 elsif ( lc(driver_name) eq 'mysql' ) {
3122 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3123 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3126 return "CASE WHEN $table.payby IN('CARD','DCRD')
3132 =item tax_exemption TAXNAME
3137 my( $self, $taxname ) = @_;
3139 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3140 'taxname' => $taxname,
3145 =item cust_main_exemption
3149 sub cust_main_exemption {
3151 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3154 =item invoicing_list [ ARRAYREF ]
3156 If an arguement is given, sets these email addresses as invoice recipients
3157 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3158 (except as warnings), so use check_invoicing_list first.
3160 Returns a list of email addresses (with svcnum entries expanded).
3162 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3163 check it without disturbing anything by passing nothing.
3165 This interface may change in the future.
3169 sub invoicing_list {
3170 my( $self, $arrayref ) = @_;
3173 my @cust_main_invoice;
3174 if ( $self->custnum ) {
3175 @cust_main_invoice =
3176 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3178 @cust_main_invoice = ();
3180 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3181 #warn $cust_main_invoice->destnum;
3182 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3183 #warn $cust_main_invoice->destnum;
3184 my $error = $cust_main_invoice->delete;
3185 warn $error if $error;
3188 if ( $self->custnum ) {
3189 @cust_main_invoice =
3190 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3192 @cust_main_invoice = ();
3194 my %seen = map { $_->address => 1 } @cust_main_invoice;
3195 foreach my $address ( @{$arrayref} ) {
3196 next if exists $seen{$address} && $seen{$address};
3197 $seen{$address} = 1;
3198 my $cust_main_invoice = new FS::cust_main_invoice ( {
3199 'custnum' => $self->custnum,
3202 my $error = $cust_main_invoice->insert;
3203 warn $error if $error;
3207 if ( $self->custnum ) {
3209 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3216 =item check_invoicing_list ARRAYREF
3218 Checks these arguements as valid input for the invoicing_list method. If there
3219 is an error, returns the error, otherwise returns false.
3223 sub check_invoicing_list {
3224 my( $self, $arrayref ) = @_;
3226 foreach my $address ( @$arrayref ) {
3228 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3229 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3232 my $cust_main_invoice = new FS::cust_main_invoice ( {
3233 'custnum' => $self->custnum,
3236 my $error = $self->custnum
3237 ? $cust_main_invoice->check
3238 : $cust_main_invoice->checkdest
3240 return $error if $error;
3244 return "Email address required"
3245 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3246 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3251 =item set_default_invoicing_list
3253 Sets the invoicing list to all accounts associated with this customer,
3254 overwriting any previous invoicing list.
3258 sub set_default_invoicing_list {
3260 $self->invoicing_list($self->all_emails);
3265 Returns the email addresses of all accounts provisioned for this customer.
3272 foreach my $cust_pkg ( $self->all_pkgs ) {
3273 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3275 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3276 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3278 $list{$_}=1 foreach map { $_->email } @svc_acct;
3283 =item invoicing_list_addpost
3285 Adds postal invoicing to this customer. If this customer is already configured
3286 to receive postal invoices, does nothing.
3290 sub invoicing_list_addpost {
3292 return if grep { $_ eq 'POST' } $self->invoicing_list;
3293 my @invoicing_list = $self->invoicing_list;
3294 push @invoicing_list, 'POST';
3295 $self->invoicing_list(\@invoicing_list);
3298 =item invoicing_list_emailonly
3300 Returns the list of email invoice recipients (invoicing_list without non-email
3301 destinations such as POST and FAX).
3305 sub invoicing_list_emailonly {
3307 warn "$me invoicing_list_emailonly called"
3309 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3312 =item invoicing_list_emailonly_scalar
3314 Returns the list of email invoice recipients (invoicing_list without non-email
3315 destinations such as POST and FAX) as a comma-separated scalar.
3319 sub invoicing_list_emailonly_scalar {
3321 warn "$me invoicing_list_emailonly_scalar called"
3323 join(', ', $self->invoicing_list_emailonly);
3326 =item referral_custnum_cust_main
3328 Returns the customer who referred this customer (or the empty string, if
3329 this customer was not referred).
3331 Note the difference with referral_cust_main method: This method,
3332 referral_custnum_cust_main returns the single customer (if any) who referred
3333 this customer, while referral_cust_main returns an array of customers referred
3338 sub referral_custnum_cust_main {
3340 return '' unless $self->referral_custnum;
3341 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3344 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3346 Returns an array of customers referred by this customer (referral_custnum set
3347 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3348 customers referred by customers referred by this customer and so on, inclusive.
3349 The default behavior is DEPTH 1 (no recursion).
3351 Note the difference with referral_custnum_cust_main method: This method,
3352 referral_cust_main, returns an array of customers referred BY this customer,
3353 while referral_custnum_cust_main returns the single customer (if any) who
3354 referred this customer.
3358 sub referral_cust_main {
3360 my $depth = @_ ? shift : 1;
3361 my $exclude = @_ ? shift : {};
3364 map { $exclude->{$_->custnum}++; $_; }
3365 grep { ! $exclude->{ $_->custnum } }
3366 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3370 map { $_->referral_cust_main($depth-1, $exclude) }
3377 =item referral_cust_main_ncancelled
3379 Same as referral_cust_main, except only returns customers with uncancelled
3384 sub referral_cust_main_ncancelled {
3386 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3389 =item referral_cust_pkg [ DEPTH ]
3391 Like referral_cust_main, except returns a flat list of all unsuspended (and
3392 uncancelled) packages for each customer. The number of items in this list may
3393 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3397 sub referral_cust_pkg {
3399 my $depth = @_ ? shift : 1;
3401 map { $_->unsuspended_pkgs }
3402 grep { $_->unsuspended_pkgs }
3403 $self->referral_cust_main($depth);
3406 =item referring_cust_main
3408 Returns the single cust_main record for the customer who referred this customer
3409 (referral_custnum), or false.
3413 sub referring_cust_main {
3415 return '' unless $self->referral_custnum;
3416 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3419 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3421 Applies a credit to this customer. If there is an error, returns the error,
3422 otherwise returns false.
3424 REASON can be a text string, an FS::reason object, or a scalar reference to
3425 a reasonnum. If a text string, it will be automatically inserted as a new
3426 reason, and a 'reason_type' option must be passed to indicate the
3427 FS::reason_type for the new reason.
3429 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3431 Any other options are passed to FS::cust_credit::insert.
3436 my( $self, $amount, $reason, %options ) = @_;
3438 my $cust_credit = new FS::cust_credit {
3439 'custnum' => $self->custnum,
3440 'amount' => $amount,
3443 if ( ref($reason) ) {
3445 if ( ref($reason) eq 'SCALAR' ) {
3446 $cust_credit->reasonnum( $$reason );
3448 $cust_credit->reasonnum( $reason->reasonnum );
3452 $cust_credit->set('reason', $reason)
3455 for (qw( addlinfo eventnum )) {
3456 $cust_credit->$_( delete $options{$_} )
3457 if exists($options{$_});
3460 $cust_credit->insert(%options);
3464 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3466 Creates a one-time charge for this customer. If there is an error, returns
3467 the error, otherwise returns false.
3469 New-style, with a hashref of options:
3471 my $error = $cust_main->charge(
3475 'start_date' => str2time('7/4/2009'),
3476 'pkg' => 'Description',
3477 'comment' => 'Comment',
3478 'additional' => [], #extra invoice detail
3479 'classnum' => 1, #pkg_class
3481 'setuptax' => '', # or 'Y' for tax exempt
3484 'taxclass' => 'Tax class',
3487 'taxproduct' => 2, #part_pkg_taxproduct
3488 'override' => {}, #XXX describe
3490 #will be filled in with the new object
3491 'cust_pkg_ref' => \$cust_pkg,
3493 #generate an invoice immediately
3495 'invoice_terms' => '', #with these terms
3501 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3507 my ( $amount, $quantity, $start_date, $classnum );
3508 my ( $pkg, $comment, $additional );
3509 my ( $setuptax, $taxclass ); #internal taxes
3510 my ( $taxproduct, $override ); #vendor (CCH) taxes
3512 my $cust_pkg_ref = '';
3513 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3514 if ( ref( $_[0] ) ) {
3515 $amount = $_[0]->{amount};
3516 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3517 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3518 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3519 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3520 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3521 : '$'. sprintf("%.2f",$amount);
3522 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3523 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3524 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3525 $additional = $_[0]->{additional} || [];
3526 $taxproduct = $_[0]->{taxproductnum};
3527 $override = { '' => $_[0]->{tax_override} };
3528 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3529 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3530 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3535 $pkg = @_ ? shift : 'One-time charge';
3536 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3538 $taxclass = @_ ? shift : '';
3542 local $SIG{HUP} = 'IGNORE';
3543 local $SIG{INT} = 'IGNORE';
3544 local $SIG{QUIT} = 'IGNORE';
3545 local $SIG{TERM} = 'IGNORE';
3546 local $SIG{TSTP} = 'IGNORE';
3547 local $SIG{PIPE} = 'IGNORE';
3549 my $oldAutoCommit = $FS::UID::AutoCommit;
3550 local $FS::UID::AutoCommit = 0;
3553 my $part_pkg = new FS::part_pkg ( {
3555 'comment' => $comment,
3559 'classnum' => ( $classnum ? $classnum : '' ),
3560 'setuptax' => $setuptax,
3561 'taxclass' => $taxclass,
3562 'taxproductnum' => $taxproduct,
3565 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3566 ( 0 .. @$additional - 1 )
3568 'additional_count' => scalar(@$additional),
3569 'setup_fee' => $amount,
3572 my $error = $part_pkg->insert( options => \%options,
3573 tax_overrides => $override,
3576 $dbh->rollback if $oldAutoCommit;
3580 my $pkgpart = $part_pkg->pkgpart;
3581 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3582 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3583 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3584 $error = $type_pkgs->insert;
3586 $dbh->rollback if $oldAutoCommit;
3591 my $cust_pkg = new FS::cust_pkg ( {
3592 'custnum' => $self->custnum,
3593 'pkgpart' => $pkgpart,
3594 'quantity' => $quantity,
3595 'start_date' => $start_date,
3596 'no_auto' => $no_auto,
3599 $error = $cust_pkg->insert;
3601 $dbh->rollback if $oldAutoCommit;
3603 } elsif ( $cust_pkg_ref ) {
3604 ${$cust_pkg_ref} = $cust_pkg;
3608 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3609 'pkg_list' => [ $cust_pkg ],
3612 $dbh->rollback if $oldAutoCommit;
3617 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3622 #=item charge_postal_fee
3624 #Applies a one time charge this customer. If there is an error,
3625 #returns the error, returns the cust_pkg charge object or false
3626 #if there was no charge.
3630 # This should be a customer event. For that to work requires that bill
3631 # also be a customer event.
3633 sub charge_postal_fee {
3636 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3637 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3639 my $cust_pkg = new FS::cust_pkg ( {
3640 'custnum' => $self->custnum,
3641 'pkgpart' => $pkgpart,
3645 my $error = $cust_pkg->insert;
3646 $error ? $error : $cust_pkg;
3649 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3651 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3653 Optionally, a list or hashref of additional arguments to the qsearch call can
3660 my $opt = ref($_[0]) ? shift : { @_ };
3662 #return $self->num_cust_bill unless wantarray || keys %$opt;
3664 $opt->{'table'} = 'cust_bill';
3665 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3666 $opt->{'hashref'}{'custnum'} = $self->custnum;
3667 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3669 map { $_ } #behavior of sort undefined in scalar context
3670 sort { $a->_date <=> $b->_date }
3674 =item open_cust_bill
3676 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3681 sub open_cust_bill {
3685 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3691 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3693 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3697 sub legacy_cust_bill {
3700 #return $self->num_legacy_cust_bill unless wantarray;
3702 map { $_ } #behavior of sort undefined in scalar context
3703 sort { $a->_date <=> $b->_date }
3704 qsearch({ 'table' => 'legacy_cust_bill',
3705 'hashref' => { 'custnum' => $self->custnum, },
3706 'order_by' => 'ORDER BY _date ASC',
3710 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3712 Returns all the statements (see L<FS::cust_statement>) for this customer.
3714 Optionally, a list or hashref of additional arguments to the qsearch call can
3719 sub cust_statement {
3721 my $opt = ref($_[0]) ? shift : { @_ };
3723 #return $self->num_cust_statement unless wantarray || keys %$opt;
3725 $opt->{'table'} = 'cust_statement';
3726 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3727 $opt->{'hashref'}{'custnum'} = $self->custnum;
3728 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3730 map { $_ } #behavior of sort undefined in scalar context
3731 sort { $a->_date <=> $b->_date }
3737 Returns all the credits (see L<FS::cust_credit>) for this customer.
3743 map { $_ } #return $self->num_cust_credit unless wantarray;
3744 sort { $a->_date <=> $b->_date }
3745 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3748 =item cust_credit_pkgnum
3750 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3751 package when using experimental package balances.
3755 sub cust_credit_pkgnum {
3756 my( $self, $pkgnum ) = @_;
3757 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3758 sort { $a->_date <=> $b->_date }
3759 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3760 'pkgnum' => $pkgnum,
3767 Returns all the payments (see L<FS::cust_pay>) for this customer.
3773 return $self->num_cust_pay unless wantarray;
3774 sort { $a->_date <=> $b->_date }
3775 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3780 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3781 called automatically when the cust_pay method is used in a scalar context.
3787 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3788 my $sth = dbh->prepare($sql) or die dbh->errstr;
3789 $sth->execute($self->custnum) or die $sth->errstr;
3790 $sth->fetchrow_arrayref->[0];
3793 =item cust_pay_pkgnum
3795 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3796 package when using experimental package balances.
3800 sub cust_pay_pkgnum {
3801 my( $self, $pkgnum ) = @_;
3802 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3803 sort { $a->_date <=> $b->_date }
3804 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3805 'pkgnum' => $pkgnum,
3812 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3818 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3819 sort { $a->_date <=> $b->_date }
3820 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3823 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3825 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3827 Optionally, a list or hashref of additional arguments to the qsearch call can
3832 sub cust_pay_batch {
3834 my $opt = ref($_[0]) ? shift : { @_ };
3836 #return $self->num_cust_statement unless wantarray || keys %$opt;
3838 $opt->{'table'} = 'cust_pay_batch';
3839 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3840 $opt->{'hashref'}{'custnum'} = $self->custnum;
3841 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3843 map { $_ } #behavior of sort undefined in scalar context
3844 sort { $a->paybatchnum <=> $b->paybatchnum }
3848 =item cust_pay_pending
3850 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3851 (without status "done").
3855 sub cust_pay_pending {
3857 return $self->num_cust_pay_pending unless wantarray;
3858 sort { $a->_date <=> $b->_date }
3859 qsearch( 'cust_pay_pending', {
3860 'custnum' => $self->custnum,
3861 'status' => { op=>'!=', value=>'done' },
3866 =item cust_pay_pending_attempt
3868 Returns all payment attempts / declined payments for this customer, as pending
3869 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3870 a corresponding payment (see L<FS::cust_pay>).
3874 sub cust_pay_pending_attempt {
3876 return $self->num_cust_pay_pending_attempt unless wantarray;
3877 sort { $a->_date <=> $b->_date }
3878 qsearch( 'cust_pay_pending', {
3879 'custnum' => $self->custnum,
3886 =item num_cust_pay_pending
3888 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3889 customer (without status "done"). Also called automatically when the
3890 cust_pay_pending method is used in a scalar context.
3894 sub num_cust_pay_pending {
3897 " SELECT COUNT(*) FROM cust_pay_pending ".
3898 " WHERE custnum = ? AND status != 'done' ",
3903 =item num_cust_pay_pending_attempt
3905 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3906 customer, with status "done" but without a corresp. Also called automatically when the
3907 cust_pay_pending method is used in a scalar context.
3911 sub num_cust_pay_pending_attempt {
3914 " SELECT COUNT(*) FROM cust_pay_pending ".
3915 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3922 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3928 map { $_ } #return $self->num_cust_refund unless wantarray;
3929 sort { $a->_date <=> $b->_date }
3930 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3933 =item display_custnum
3935 Returns the displayed customer number for this customer: agent_custid if
3936 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3940 sub display_custnum {
3943 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3944 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3945 if ( $special eq 'CoStAg' ) {
3946 $prefix = uc( join('',
3948 ($self->state =~ /^(..)/),
3949 $prefix || ($self->agent->agent =~ /^(..)/)
3952 elsif ( $special eq 'CoStCl' ) {
3953 $prefix = uc( join('',
3955 ($self->state =~ /^(..)/),
3956 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3959 # add any others here if needed
3962 my $length = $conf->config('cust_main-custnum-display_length');
3963 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3964 return $self->agent_custid;
3965 } elsif ( $prefix ) {
3966 $length = 8 if !defined($length);
3968 sprintf('%0'.$length.'d', $self->custnum)
3969 } elsif ( $length ) {
3970 return sprintf('%0'.$length.'d', $self->custnum);
3972 return $self->custnum;
3978 Returns a name string for this customer, either "Company (Last, First)" or
3985 my $name = $self->contact;
3986 $name = $self->company. " ($name)" if $self->company;
3992 Returns a name string for this (service/shipping) contact, either
3993 "Company (Last, First)" or "Last, First".
3999 if ( $self->get('ship_last') ) {
4000 my $name = $self->ship_contact;
4001 $name = $self->ship_company. " ($name)" if $self->ship_company;
4010 Returns a name string for this customer, either "Company" or "First Last".
4016 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4019 =item ship_name_short
4021 Returns a name string for this (service/shipping) contact, either "Company"
4026 sub ship_name_short {
4028 if ( $self->get('ship_last') ) {
4029 $self->ship_company !~ /^\s*$/
4030 ? $self->ship_company
4031 : $self->ship_contact_firstlast;
4033 $self->name_company_or_firstlast;
4039 Returns this customer's full (billing) contact name only, "Last, First"
4045 $self->get('last'). ', '. $self->first;
4050 Returns this customer's full (shipping) contact name only, "Last, First"
4056 $self->get('ship_last')
4057 ? $self->get('ship_last'). ', '. $self->ship_first
4061 =item contact_firstlast
4063 Returns this customers full (billing) contact name only, "First Last".
4067 sub contact_firstlast {
4069 $self->first. ' '. $self->get('last');
4072 =item ship_contact_firstlast
4074 Returns this customer's full (shipping) contact name only, "First Last".
4078 sub ship_contact_firstlast {
4080 $self->get('ship_last')
4081 ? $self->first. ' '. $self->get('ship_last')
4082 : $self->contact_firstlast;
4087 Returns this customer's full country name
4093 code2country($self->country);
4096 =item geocode DATA_VENDOR
4098 Returns a value for the customer location as encoded by DATA_VENDOR.
4099 Currently this only makes sense for "CCH" as DATA_VENDOR.
4107 Returns a status string for this customer, currently:
4111 =item prospect - No packages have ever been ordered
4113 =item ordered - Recurring packages all are new (not yet billed).
4115 =item active - One or more recurring packages is active
4117 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4119 =item suspended - All non-cancelled recurring packages are suspended
4121 =item cancelled - All recurring packages are cancelled
4125 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4126 cust_main-status_module configuration option.
4130 sub status { shift->cust_status(@_); }
4134 for my $status ( FS::cust_main->statuses() ) {
4135 my $method = $status.'_sql';
4136 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4137 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4138 $sth->execute( ($self->custnum) x $numnum )
4139 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4140 return $status if $sth->fetchrow_arrayref->[0];
4144 =item ucfirst_cust_status
4146 =item ucfirst_status
4148 Returns the status with the first character capitalized.
4152 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4154 sub ucfirst_cust_status {
4156 ucfirst($self->cust_status);
4161 Returns a hex triplet color string for this customer's status.
4165 sub statuscolor { shift->cust_statuscolor(@_); }
4167 sub cust_statuscolor {
4169 __PACKAGE__->statuscolors->{$self->cust_status};
4174 Returns an array of hashes representing the customer's RT tickets.
4181 my $num = $conf->config('cust_main-max_tickets') || 10;
4184 if ( $conf->config('ticket_system') ) {
4185 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4187 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4191 foreach my $priority (
4192 $conf->config('ticket_system-custom_priority_field-values'), ''
4194 last if scalar(@tickets) >= $num;
4196 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4197 $num - scalar(@tickets),
4207 # Return services representing svc_accts in customer support packages
4208 sub support_services {
4210 my %packages = map { $_ => 1 } $conf->config('support_packages');
4212 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4213 grep { $_->part_svc->svcdb eq 'svc_acct' }
4214 map { $_->cust_svc }
4215 grep { exists $packages{ $_->pkgpart } }
4216 $self->ncancelled_pkgs;
4220 # Return a list of latitude/longitude for one of the services (if any)
4221 sub service_coordinates {
4225 grep { $_->latitude && $_->longitude }
4227 map { $_->cust_svc }
4228 $self->ncancelled_pkgs;
4230 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4235 Returns a masked version of the named field
4240 my ($self,$field) = @_;
4244 'x'x(length($self->getfield($field))-4).
4245 substr($self->getfield($field), (length($self->getfield($field))-4));
4251 =head1 CLASS METHODS
4257 Class method that returns the list of possible status strings for customers
4258 (see L<the status method|/status>). For example:
4260 @statuses = FS::cust_main->statuses();
4266 keys %{ $self->statuscolors };
4269 =item cust_status_sql
4271 Returns an SQL fragment to determine the status of a cust_main record, as a
4276 sub cust_status_sql {
4278 for my $status ( FS::cust_main->statuses() ) {
4279 my $method = $status.'_sql';
4280 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4289 Returns an SQL expression identifying prospective cust_main records (customers
4290 with no packages ever ordered)
4294 use vars qw($select_count_pkgs);
4295 $select_count_pkgs =
4296 "SELECT COUNT(*) FROM cust_pkg
4297 WHERE cust_pkg.custnum = cust_main.custnum";
4299 sub select_count_pkgs_sql {
4304 " 0 = ( $select_count_pkgs ) ";
4309 Returns an SQL expression identifying ordered cust_main records (customers with
4310 no active packages, but recurring packages not yet setup or one time charges
4316 FS::cust_main->none_active_sql.
4317 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4322 Returns an SQL expression identifying active cust_main records (customers with
4323 active recurring packages).
4328 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4331 =item none_active_sql
4333 Returns an SQL expression identifying cust_main records with no active
4334 recurring packages. This includes customers of status prospect, ordered,
4335 inactive, and suspended.
4339 sub none_active_sql {
4340 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4345 Returns an SQL expression identifying inactive cust_main records (customers with
4346 no active recurring packages, but otherwise unsuspended/uncancelled).
4351 FS::cust_main->none_active_sql.
4352 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4358 Returns an SQL expression identifying suspended cust_main records.
4363 sub suspended_sql { susp_sql(@_); }
4365 FS::cust_main->none_active_sql.
4366 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4372 Returns an SQL expression identifying cancelled cust_main records.
4376 sub cancel_sql { shift->cancelled_sql(@_); }
4379 =item uncancelled_sql
4381 Returns an SQL expression identifying un-cancelled cust_main records.
4385 sub uncancelled_sql { uncancel_sql(@_); }
4386 sub uncancel_sql { "
4387 ( 0 < ( $select_count_pkgs
4388 AND ( cust_pkg.cancel IS NULL
4389 OR cust_pkg.cancel = 0
4392 OR 0 = ( $select_count_pkgs )
4398 Returns an SQL fragment to retreive the balance.
4403 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4404 WHERE cust_bill.custnum = cust_main.custnum )
4405 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4406 WHERE cust_pay.custnum = cust_main.custnum )
4407 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4408 WHERE cust_credit.custnum = cust_main.custnum )
4409 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4410 WHERE cust_refund.custnum = cust_main.custnum )
4413 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4415 Returns an SQL fragment to retreive the balance for this customer, optionally
4416 considering invoices with date earlier than START_TIME, and not
4417 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4418 total_unapplied_payments).
4420 Times are specified as SQL fragments or numeric
4421 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4422 L<Date::Parse> for conversion functions. The empty string can be passed
4423 to disable that time constraint completely.
4425 Available options are:
4429 =item unapplied_date
4431 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)
4436 set to true to remove all customer comparison clauses, for totals
4441 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4446 JOIN clause (typically used with the total option)
4450 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4451 time will be ignored. Note that START_TIME and END_TIME only limit the date
4452 range for invoices and I<unapplied> payments, credits, and refunds.
4458 sub balance_date_sql {
4459 my( $class, $start, $end, %opt ) = @_;
4461 my $cutoff = $opt{'cutoff'};
4463 my $owed = FS::cust_bill->owed_sql($cutoff);
4464 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4465 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4466 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4468 my $j = $opt{'join'} || '';
4470 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4471 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4472 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4473 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4475 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4476 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4477 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4478 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4483 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4485 Returns an SQL fragment to retreive the total unapplied payments for this
4486 customer, only considering payments with date earlier than START_TIME, and
4487 optionally not later than END_TIME.
4489 Times are specified as SQL fragments or numeric
4490 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4491 L<Date::Parse> for conversion functions. The empty string can be passed
4492 to disable that time constraint completely.
4494 Available options are:
4498 sub unapplied_payments_date_sql {
4499 my( $class, $start, $end, %opt ) = @_;
4501 my $cutoff = $opt{'cutoff'};
4503 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4505 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4506 'unapplied_date'=>1 );
4508 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4511 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4513 Helper method for balance_date_sql; name (and usage) subject to change
4514 (suggestions welcome).
4516 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4517 cust_refund, cust_credit or cust_pay).
4519 If TABLE is "cust_bill" or the unapplied_date option is true, only
4520 considers records with date earlier than START_TIME, and optionally not
4521 later than END_TIME .
4525 sub _money_table_where {
4526 my( $class, $table, $start, $end, %opt ) = @_;
4529 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4530 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4531 push @where, "$table._date <= $start" if defined($start) && length($start);
4532 push @where, "$table._date > $end" if defined($end) && length($end);
4534 push @where, @{$opt{'where'}} if $opt{'where'};
4535 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4541 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4542 use FS::cust_main::Search;
4545 FS::cust_main::Search->search(@_);
4560 #warn join('-',keys %$param);
4561 my $fh = $param->{filehandle};
4562 my $agentnum = $param->{agentnum};
4563 my $format = $param->{format};
4565 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4568 if ( $format eq 'simple' ) {
4569 @fields = qw( custnum agent_custid amount pkg );
4571 die "unknown format $format";
4574 eval "use Text::CSV_XS;";
4577 my $csv = new Text::CSV_XS;
4584 local $SIG{HUP} = 'IGNORE';
4585 local $SIG{INT} = 'IGNORE';
4586 local $SIG{QUIT} = 'IGNORE';
4587 local $SIG{TERM} = 'IGNORE';
4588 local $SIG{TSTP} = 'IGNORE';
4589 local $SIG{PIPE} = 'IGNORE';
4591 my $oldAutoCommit = $FS::UID::AutoCommit;
4592 local $FS::UID::AutoCommit = 0;
4595 #while ( $columns = $csv->getline($fh) ) {
4597 while ( defined($line=<$fh>) ) {
4599 $csv->parse($line) or do {
4600 $dbh->rollback if $oldAutoCommit;
4601 return "can't parse: ". $csv->error_input();
4604 my @columns = $csv->fields();
4605 #warn join('-',@columns);
4608 foreach my $field ( @fields ) {
4609 $row{$field} = shift @columns;
4612 if ( $row{custnum} && $row{agent_custid} ) {
4613 dbh->rollback if $oldAutoCommit;
4614 return "can't specify custnum with agent_custid $row{agent_custid}";
4618 if ( $row{agent_custid} && $agentnum ) {
4619 %hash = ( 'agent_custid' => $row{agent_custid},
4620 'agentnum' => $agentnum,
4624 if ( $row{custnum} ) {
4625 %hash = ( 'custnum' => $row{custnum} );
4628 unless ( scalar(keys %hash) ) {
4629 $dbh->rollback if $oldAutoCommit;
4630 return "can't find customer without custnum or agent_custid and agentnum";
4633 my $cust_main = qsearchs('cust_main', { %hash } );
4634 unless ( $cust_main ) {
4635 $dbh->rollback if $oldAutoCommit;
4636 my $custnum = $row{custnum} || $row{agent_custid};
4637 return "unknown custnum $custnum";
4640 if ( $row{'amount'} > 0 ) {
4641 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4643 $dbh->rollback if $oldAutoCommit;
4647 } elsif ( $row{'amount'} < 0 ) {
4648 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4651 $dbh->rollback if $oldAutoCommit;
4661 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4663 return "Empty file!" unless $imported;
4669 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4671 Deprecated. Use event notification and message templates
4672 (L<FS::msg_template>) instead.
4674 Sends a templated email notification to the customer (see L<Text::Template>).
4676 OPTIONS is a hash and may include
4678 I<from> - the email sender (default is invoice_from)
4680 I<to> - comma-separated scalar or arrayref of recipients
4681 (default is invoicing_list)
4683 I<subject> - The subject line of the sent email notification
4684 (default is "Notice from company_name")
4686 I<extra_fields> - a hashref of name/value pairs which will be substituted
4689 The following variables are vavailable in the template.
4691 I<$first> - the customer first name
4692 I<$last> - the customer last name
4693 I<$company> - the customer company
4694 I<$payby> - a description of the method of payment for the customer
4695 # would be nice to use FS::payby::shortname
4696 I<$payinfo> - the account information used to collect for this customer
4697 I<$expdate> - the expiration of the customer payment in seconds from epoch
4702 my ($self, $template, %options) = @_;
4704 return unless $conf->exists($template);
4706 my $from = $conf->config('invoice_from', $self->agentnum)
4707 if $conf->exists('invoice_from', $self->agentnum);
4708 $from = $options{from} if exists($options{from});
4710 my $to = join(',', $self->invoicing_list_emailonly);
4711 $to = $options{to} if exists($options{to});
4713 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4714 if $conf->exists('company_name', $self->agentnum);
4715 $subject = $options{subject} if exists($options{subject});
4717 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4718 SOURCE => [ map "$_\n",
4719 $conf->config($template)]
4721 or die "can't create new Text::Template object: Text::Template::ERROR";
4722 $notify_template->compile()
4723 or die "can't compile template: Text::Template::ERROR";
4725 $FS::notify_template::_template::company_name =
4726 $conf->config('company_name', $self->agentnum);
4727 $FS::notify_template::_template::company_address =
4728 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4730 my $paydate = $self->paydate || '2037-12-31';
4731 $FS::notify_template::_template::first = $self->first;
4732 $FS::notify_template::_template::last = $self->last;
4733 $FS::notify_template::_template::company = $self->company;
4734 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4735 my $payby = $self->payby;
4736 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4737 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4739 #credit cards expire at the end of the month/year of their exp date
4740 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4741 $FS::notify_template::_template::payby = 'credit card';
4742 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4743 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4745 }elsif ($payby eq 'COMP') {
4746 $FS::notify_template::_template::payby = 'complimentary account';
4748 $FS::notify_template::_template::payby = 'current method';
4750 $FS::notify_template::_template::expdate = $expire_time;
4752 for (keys %{$options{extra_fields}}){
4754 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4757 send_email(from => $from,
4759 subject => $subject,
4760 body => $notify_template->fill_in( PACKAGE =>
4761 'FS::notify_template::_template' ),
4766 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4768 Generates a templated notification to the customer (see L<Text::Template>).
4770 OPTIONS is a hash and may include
4772 I<extra_fields> - a hashref of name/value pairs which will be substituted
4773 into the template. These values may override values mentioned below
4774 and those from the customer record.
4776 The following variables are available in the template instead of or in addition
4777 to the fields of the customer record.
4779 I<$payby> - a description of the method of payment for the customer
4780 # would be nice to use FS::payby::shortname
4781 I<$payinfo> - the masked account information used to collect for this customer
4782 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4783 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4787 # a lot like cust_bill::print_latex
4788 sub generate_letter {
4789 my ($self, $template, %options) = @_;
4791 return unless $conf->exists($template);
4793 my $letter_template = new Text::Template
4795 SOURCE => [ map "$_\n", $conf->config($template)],
4796 DELIMITERS => [ '[@--', '--@]' ],
4798 or die "can't create new Text::Template object: Text::Template::ERROR";
4800 $letter_template->compile()
4801 or die "can't compile template: Text::Template::ERROR";
4803 my %letter_data = map { $_ => $self->$_ } $self->fields;
4804 $letter_data{payinfo} = $self->mask_payinfo;
4806 #my $paydate = $self->paydate || '2037-12-31';
4807 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4809 my $payby = $self->payby;
4810 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4811 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4813 #credit cards expire at the end of the month/year of their exp date
4814 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4815 $letter_data{payby} = 'credit card';
4816 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4817 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4819 }elsif ($payby eq 'COMP') {
4820 $letter_data{payby} = 'complimentary account';
4822 $letter_data{payby} = 'current method';
4824 $letter_data{expdate} = $expire_time;
4826 for (keys %{$options{extra_fields}}){
4827 $letter_data{$_} = $options{extra_fields}->{$_};
4830 unless(exists($letter_data{returnaddress})){
4831 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4832 $self->agent_template)
4834 if ( length($retadd) ) {
4835 $letter_data{returnaddress} = $retadd;
4836 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4837 $letter_data{returnaddress} =
4838 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4842 ( $conf->config('company_name', $self->agentnum),
4843 $conf->config('company_address', $self->agentnum),
4847 $letter_data{returnaddress} = '~';
4851 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4853 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4855 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4857 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4861 ) or die "can't open temp file: $!\n";
4862 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4863 or die "can't write temp file: $!\n";
4865 $letter_data{'logo_file'} = $lh->filename;
4867 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4871 ) or die "can't open temp file: $!\n";
4873 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4875 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4876 return ($1, $letter_data{'logo_file'});
4880 =item print_ps TEMPLATE
4882 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4888 my($file, $lfile) = $self->generate_letter(@_);
4889 my $ps = FS::Misc::generate_ps($file);
4890 unlink($file.'.tex');
4896 =item print TEMPLATE
4898 Prints the filled in template.
4900 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4904 sub queueable_print {
4907 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4908 or die "invalid customer number: " . $opt{custvnum};
4910 my $error = $self->print( $opt{template} );
4911 die $error if $error;
4915 my ($self, $template) = (shift, shift);
4916 do_print [ $self->print_ps($template) ];
4919 #these three subs should just go away once agent stuff is all config overrides
4921 sub agent_template {
4923 $self->_agent_plandata('agent_templatename');
4926 sub agent_invoice_from {
4928 $self->_agent_plandata('agent_invoice_from');
4931 sub _agent_plandata {
4932 my( $self, $option ) = @_;
4934 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4935 #agent-specific Conf
4937 use FS::part_event::Condition;
4939 my $agentnum = $self->agentnum;
4941 my $regexp = regexp_sql();
4943 my $part_event_option =
4945 'select' => 'part_event_option.*',
4946 'table' => 'part_event_option',
4948 LEFT JOIN part_event USING ( eventpart )
4949 LEFT JOIN part_event_option AS peo_agentnum
4950 ON ( part_event.eventpart = peo_agentnum.eventpart
4951 AND peo_agentnum.optionname = 'agentnum'
4952 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4954 LEFT JOIN part_event_condition
4955 ON ( part_event.eventpart = part_event_condition.eventpart
4956 AND part_event_condition.conditionname = 'cust_bill_age'
4958 LEFT JOIN part_event_condition_option
4959 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4960 AND part_event_condition_option.optionname = 'age'
4963 #'hashref' => { 'optionname' => $option },
4964 #'hashref' => { 'part_event_option.optionname' => $option },
4966 " WHERE part_event_option.optionname = ". dbh->quote($option).
4967 " AND action = 'cust_bill_send_agent' ".
4968 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4969 " AND peo_agentnum.optionname = 'agentnum' ".
4970 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4972 CASE WHEN part_event_condition_option.optionname IS NULL
4974 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4976 , part_event.weight".
4980 unless ( $part_event_option ) {
4981 return $self->agent->invoice_template || ''
4982 if $option eq 'agent_templatename';
4986 $part_event_option->optionvalue;
4990 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4992 Subroutine (not a method), designed to be called from the queue.
4994 Takes a list of options and values.
4996 Pulls up the customer record via the custnum option and calls bill_and_collect.
5001 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5003 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5004 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5006 $cust_main->bill_and_collect( %args );
5009 sub process_bill_and_collect {
5011 my $param = thaw(decode_base64(shift));
5012 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5013 or die "custnum '$param->{custnum}' not found!\n";
5014 $param->{'job'} = $job;
5015 $param->{'fatal'} = 1; # runs from job queue, will be caught
5016 $param->{'retry'} = 1;
5018 $cust_main->bill_and_collect( %$param );
5021 =item process_censustract_update CUSTNUM
5023 Queueable function to update the census tract to the current year (as set in
5024 the 'census_year' configuration variable) and retrieve the new tract code.
5028 sub process_censustract_update {
5029 eval "use FS::Misc::Geo qw(get_censustract)";
5031 my $custnum = shift;
5032 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
5033 or die "custnum '$custnum' not found!\n";
5035 my $new_year = $conf->config('census_year') or return;
5036 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
5037 if ( $new_tract =~ /^\d/ ) {
5038 # then it's a tract code
5039 $cust_main->set('censustract', $new_tract);
5040 $cust_main->set('censusyear', $new_year);
5042 local($ignore_expired_card) = 1;
5043 local($ignore_illegal_zip) = 1;
5044 local($ignore_banned_card) = 1;
5045 local($skip_fuzzyfiles) = 1;
5046 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5047 my $error = $cust_main->replace;
5048 die $error if $error;
5051 # it's an error message
5057 sub _upgrade_data { #class method
5058 my ($class, %opts) = @_;
5061 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5064 #this seems to be the only expensive one.. why does it take so long?
5065 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5067 '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';
5068 FS::upgrade_journal->set_done('cust_main__signupdate');
5071 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5073 # fix yyyy-m-dd formatted paydates
5074 if ( driver_name =~ /^mysql/i ) {
5076 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5077 } else { # the SQL standard
5079 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5081 FS::upgrade_journal->set_done('cust_main__paydate');
5084 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5086 push @statements, #fix the weird BILL with a cc# in payinfo problem
5088 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5090 FS::upgrade_journal->set_done('cust_main__payinfo');
5095 foreach my $sql ( @statements ) {
5096 my $sth = dbh->prepare($sql) or die dbh->errstr;
5097 $sth->execute or die $sth->errstr;
5098 #warn ( (time - $t). " seconds\n" );
5102 local($ignore_expired_card) = 1;
5103 local($ignore_illegal_zip) = 1;
5104 local($ignore_banned_card) = 1;
5105 local($skip_fuzzyfiles) = 1;
5106 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5107 $class->_upgrade_otaker(%opts);
5117 The delete method should possibly take an FS::cust_main object reference
5118 instead of a scalar customer number.
5120 Bill and collect options should probably be passed as references instead of a
5123 There should probably be a configuration file with a list of allowed credit
5126 No multiple currency support (probably a larger project than just this module).
5128 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5130 Birthdates rely on negative epoch values.
5132 The payby for card/check batches is broken. With mixed batching, bad
5135 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5139 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5140 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5141 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.