5 #FS::cust_main:_Marketgear when they're ready to move to 2.1
6 use base qw( FS::cust_main::Packages FS::cust_main::Status
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 use vars qw( $DEBUG $me $conf
16 $ignore_expired_card $ignore_illegal_zip $ignore_banned_card
21 use Scalar::Util qw( blessed );
22 use Time::Local qw(timelocal);
23 use Storable qw(thaw);
27 use Digest::MD5 qw(md5_base64);
30 use File::Temp; #qw( tempfile );
31 use Business::CreditCard 0.28;
33 use FS::UID qw( getotaker dbh driver_name );
34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_email send_email generate_ps do_print );
36 use FS::Msgcat qw(gettext);
43 use FS::legacy_cust_bill;
45 use FS::cust_pay_pending;
46 use FS::cust_pay_void;
47 use FS::cust_pay_batch;
50 use FS::part_referral;
51 use FS::cust_main_county;
52 use FS::cust_location;
54 use FS::cust_main_exemption;
55 use FS::cust_tax_adjustment;
56 use FS::cust_tax_location;
58 use FS::cust_main_invoice;
60 use FS::prepay_credit;
66 use FS::payment_gateway;
67 use FS::agent_payment_gateway;
69 use FS::cust_main_note;
70 use FS::cust_attachment;
74 # 1 is mostly method/subroutine entry and options
75 # 2 traces progress of some operations
76 # 3 is even more information including possibly sensitive data
78 $me = '[FS::cust_main]';
81 $ignore_expired_card = 0;
82 $ignore_illegal_zip = 0;
83 $ignore_banned_card = 0;
87 @encrypted_fields = ('payinfo', 'paycvv');
88 sub nohistory_fields { ('payinfo', 'paycvv'); }
90 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
92 #ask FS::UID to run this stuff for us later
93 #$FS::UID::callback{'FS::cust_main'} = sub {
94 install_callback FS::UID sub {
96 #yes, need it for stuff below (prolly should be cached)
101 my ( $hashref, $cache ) = @_;
102 if ( exists $hashref->{'pkgnum'} ) {
103 #@{ $self->{'_pkgnum'} } = ();
104 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
105 $self->{'_pkgnum'} = $subcache;
106 #push @{ $self->{'_pkgnum'} },
107 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
113 FS::cust_main - Object methods for cust_main records
119 $record = new FS::cust_main \%hash;
120 $record = new FS::cust_main { 'column' => 'value' };
122 $error = $record->insert;
124 $error = $new_record->replace($old_record);
126 $error = $record->delete;
128 $error = $record->check;
130 @cust_pkg = $record->all_pkgs;
132 @cust_pkg = $record->ncancelled_pkgs;
134 @cust_pkg = $record->suspended_pkgs;
136 $error = $record->bill;
137 $error = $record->bill %options;
138 $error = $record->bill 'time' => $time;
140 $error = $record->collect;
141 $error = $record->collect %options;
142 $error = $record->collect 'invoice_time' => $time,
147 An FS::cust_main object represents a customer. FS::cust_main inherits from
148 FS::Record. The following fields are currently supported:
154 Primary key (assigned automatically for new customers)
158 Agent (see L<FS::agent>)
162 Advertising source (see L<FS::part_referral>)
174 Cocial security number (optional)
190 (optional, see L<FS::cust_main_county>)
194 (see L<FS::cust_main_county>)
200 (see L<FS::cust_main_county>)
240 (optional, see L<FS::cust_main_county>)
244 (see L<FS::cust_main_county>)
250 (see L<FS::cust_main_county>)
270 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
274 Payment Information (See L<FS::payinfo_Mixin> for data format)
278 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
282 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
286 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
290 Start date month (maestro/solo cards only)
294 Start date year (maestro/solo cards only)
298 Issue number (maestro/solo cards only)
302 Name on card or billing name
306 IP address from which payment information was received
310 Tax exempt, empty or `Y'
314 Order taker (see L<FS::access_user>)
320 =item referral_custnum
322 Referring customer number
326 Enable individual CDR spooling, empty or `Y'
330 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
334 Discourage individual CDR printing, empty or `Y'
338 Allow self-service editing of ticket subjects, empty or 'Y'
340 =item calling_list_exempt
342 Do not call, empty or 'Y'
352 Creates a new customer. To add the customer to the database, see L<"insert">.
354 Note that this stores the hash reference, not a distinct copy of the hash it
355 points to. You can ask the object for a copy with the I<hash> method.
359 sub table { 'cust_main'; }
361 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
363 Adds this customer to the database. If there is an error, returns the error,
364 otherwise returns false.
366 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
367 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
368 are inserted atomicly, or the transaction is rolled back. Passing an empty
369 hash reference is equivalent to not supplying this parameter. There should be
370 a better explanation of this, but until then, here's an example:
373 tie %hash, 'Tie::RefHash'; #this part is important
375 $cust_pkg => [ $svc_acct ],
378 $cust_main->insert( \%hash );
380 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
381 be set as the invoicing list (see L<"invoicing_list">). Errors return as
382 expected and rollback the entire transaction; it is not necessary to call
383 check_invoicing_list first. The invoicing_list is set after the records in the
384 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
385 invoicing_list destination to the newly-created svc_acct. Here's an example:
387 $cust_main->insert( {}, [ $email, 'POST' ] );
389 Currently available options are: I<depend_jobnum>, I<noexport>,
390 I<tax_exemption> and I<prospectnum>.
392 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
393 on the supplied jobnum (they will not run until the specific job completes).
394 This can be used to defer provisioning until some action completes (such
395 as running the customer's credit card successfully).
397 The I<noexport> option is deprecated. If I<noexport> is set true, no
398 provisioning jobs (exports) are scheduled. (You can schedule them later with
399 the B<reexport> method.)
401 The I<tax_exemption> option can be set to an arrayref of tax names.
402 FS::cust_main_exemption records will be created and inserted.
404 If I<prospectnum> is set, moves contacts and locations from that prospect.
410 my $cust_pkgs = @_ ? shift : {};
411 my $invoicing_list = @_ ? shift : '';
413 warn "$me insert called with options ".
414 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
417 local $SIG{HUP} = 'IGNORE';
418 local $SIG{INT} = 'IGNORE';
419 local $SIG{QUIT} = 'IGNORE';
420 local $SIG{TERM} = 'IGNORE';
421 local $SIG{TSTP} = 'IGNORE';
422 local $SIG{PIPE} = 'IGNORE';
424 my $oldAutoCommit = $FS::UID::AutoCommit;
425 local $FS::UID::AutoCommit = 0;
428 my $prepay_identifier = '';
429 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
431 if ( $self->payby eq 'PREPAY' ) {
433 $self->payby('BILL');
434 $prepay_identifier = $self->payinfo;
437 warn " looking up prepaid card $prepay_identifier\n"
440 my $error = $self->get_prepay( $prepay_identifier,
441 'amount_ref' => \$amount,
442 'seconds_ref' => \$seconds,
443 'upbytes_ref' => \$upbytes,
444 'downbytes_ref' => \$downbytes,
445 'totalbytes_ref' => \$totalbytes,
448 $dbh->rollback if $oldAutoCommit;
449 #return "error applying prepaid card (transaction rolled back): $error";
453 $payby = 'PREP' if $amount;
455 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
458 $self->payby('BILL');
459 $amount = $self->paid;
463 warn " inserting $self\n"
466 $self->signupdate(time) unless $self->signupdate;
468 $self->censusyear($conf->config('census_year')) if $self->censustract;
470 $self->auto_agent_custid()
471 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
473 my $error = $self->SUPER::insert;
475 $dbh->rollback if $oldAutoCommit;
476 #return "inserting cust_main record (transaction rolled back): $error";
480 warn " setting invoicing list\n"
483 if ( $invoicing_list ) {
484 $error = $self->check_invoicing_list( $invoicing_list );
486 $dbh->rollback if $oldAutoCommit;
487 #return "checking invoicing_list (transaction rolled back): $error";
490 $self->invoicing_list( $invoicing_list );
493 warn " setting customer tags\n"
496 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
497 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
498 'custnum' => $self->custnum };
499 my $error = $cust_tag->insert;
501 $dbh->rollback if $oldAutoCommit;
506 my $prospectnum = delete $options{'prospectnum'};
507 if ( $prospectnum ) {
509 warn " moving contacts and locations from prospect $prospectnum\n"
513 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
514 unless ( $prospect_main ) {
515 $dbh->rollback if $oldAutoCommit;
516 return "Unknown prospectnum $prospectnum";
518 $prospect_main->custnum($self->custnum);
519 $prospect_main->disabled('Y');
520 my $error = $prospect_main->replace;
522 $dbh->rollback if $oldAutoCommit;
526 my @contact = $prospect_main->contact;
527 my @cust_location = $prospect_main->cust_location;
528 my @qual = $prospect_main->qual;
530 foreach my $r ( @contact, @cust_location, @qual ) {
532 $r->custnum($self->custnum);
533 my $error = $r->replace;
535 $dbh->rollback if $oldAutoCommit;
542 warn " setting cust_main_exemption\n"
545 my $tax_exemption = delete $options{'tax_exemption'};
546 if ( $tax_exemption ) {
547 foreach my $taxname ( @$tax_exemption ) {
548 my $cust_main_exemption = new FS::cust_main_exemption {
549 'custnum' => $self->custnum,
550 'taxname' => $taxname,
552 my $error = $cust_main_exemption->insert;
554 $dbh->rollback if $oldAutoCommit;
555 return "inserting cust_main_exemption (transaction rolled back): $error";
560 if ( $self->can('start_copy_skel') ) {
561 my $error = $self->start_copy_skel;
563 $dbh->rollback if $oldAutoCommit;
568 warn " ordering packages\n"
571 $error = $self->order_pkgs( $cust_pkgs,
573 'seconds_ref' => \$seconds,
574 'upbytes_ref' => \$upbytes,
575 'downbytes_ref' => \$downbytes,
576 'totalbytes_ref' => \$totalbytes,
579 $dbh->rollback if $oldAutoCommit;
584 $dbh->rollback if $oldAutoCommit;
585 return "No svc_acct record to apply pre-paid time";
587 if ( $upbytes || $downbytes || $totalbytes ) {
588 $dbh->rollback if $oldAutoCommit;
589 return "No svc_acct record to apply pre-paid data";
593 warn " inserting initial $payby payment of $amount\n"
595 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
597 $dbh->rollback if $oldAutoCommit;
598 return "inserting payment (transaction rolled back): $error";
602 unless ( $import || $skip_fuzzyfiles ) {
603 warn " queueing fuzzyfiles update\n"
605 $error = $self->queue_fuzzyfiles_update;
607 $dbh->rollback if $oldAutoCommit;
608 return "updating fuzzy search cache: $error";
613 warn " exporting\n" if $DEBUG > 1;
615 my $export_args = $options{'export_args'} || [];
618 map qsearch( 'part_export', {exportnum=>$_} ),
619 $conf->config('cust_main-exports'); #, $agentnum
621 foreach my $part_export ( @part_export ) {
622 my $error = $part_export->export_insert($self, @$export_args);
624 $dbh->rollback if $oldAutoCommit;
625 return "exporting to ". $part_export->exporttype.
626 " (transaction rolled back): $error";
630 #foreach my $depend_jobnum ( @$depend_jobnums ) {
631 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
633 # foreach my $jobnum ( @jobnums ) {
634 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
635 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
637 # my $error = $queue->depend_insert($depend_jobnum);
639 # $dbh->rollback if $oldAutoCommit;
640 # return "error queuing job dependancy: $error";
647 #if ( exists $options{'jobnums'} ) {
648 # push @{ $options{'jobnums'} }, @jobnums;
651 warn " insert complete; committing transaction\n"
654 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
659 use File::CounterFile;
660 sub auto_agent_custid {
663 my $format = $conf->config('cust_main-auto_agent_custid');
665 if ( $format eq '1YMMXXXXXXXX' ) {
667 my $counter = new File::CounterFile 'cust_main.agent_custid';
670 my $ym = 100000000000 + time2str('%y%m00000000', time);
671 if ( $ym > $counter->value ) {
672 $counter->{'value'} = $agent_custid = $ym;
673 $counter->{'updated'} = 1;
675 $agent_custid = $counter->inc;
681 die "Unknown cust_main-auto_agent_custid format: $format";
684 $self->agent_custid($agent_custid);
688 =item PACKAGE METHODS
690 Documentation on customer package methods has been moved to
691 L<FS::cust_main::Packages>.
693 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
695 Recharges this (existing) customer with the specified prepaid card (see
696 L<FS::prepay_credit>), specified either by I<identifier> or as an
697 FS::prepay_credit object. If there is an error, returns the error, otherwise
700 Optionally, five scalar references can be passed as well. They will have their
701 values filled in with the amount, number of seconds, and number of upload,
702 download, and total bytes applied by this prepaid card.
706 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
707 #the only place that uses these args
708 sub recharge_prepay {
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upbytesref, $downbytesref, $totalbytesref ) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
725 my $error = $self->get_prepay( $prepay_credit,
726 'amount_ref' => \$amount,
727 'seconds_ref' => \$seconds,
728 'upbytes_ref' => \$upbytes,
729 'downbytes_ref' => \$downbytes,
730 'totalbytes_ref' => \$totalbytes,
732 || $self->increment_seconds($seconds)
733 || $self->increment_upbytes($upbytes)
734 || $self->increment_downbytes($downbytes)
735 || $self->increment_totalbytes($totalbytes)
736 || $self->insert_cust_pay_prepay( $amount,
738 ? $prepay_credit->identifier
743 $dbh->rollback if $oldAutoCommit;
747 if ( defined($amountref) ) { $$amountref = $amount; }
748 if ( defined($secondsref) ) { $$secondsref = $seconds; }
749 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
750 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
751 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
753 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
758 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
760 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
761 specified either by I<identifier> or as an FS::prepay_credit object.
763 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
764 incremented by the values of the prepaid card.
766 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
767 check or set this customer's I<agentnum>.
769 If there is an error, returns the error, otherwise returns false.
775 my( $self, $prepay_credit, %opt ) = @_;
777 local $SIG{HUP} = 'IGNORE';
778 local $SIG{INT} = 'IGNORE';
779 local $SIG{QUIT} = 'IGNORE';
780 local $SIG{TERM} = 'IGNORE';
781 local $SIG{TSTP} = 'IGNORE';
782 local $SIG{PIPE} = 'IGNORE';
784 my $oldAutoCommit = $FS::UID::AutoCommit;
785 local $FS::UID::AutoCommit = 0;
788 unless ( ref($prepay_credit) ) {
790 my $identifier = $prepay_credit;
792 $prepay_credit = qsearchs(
794 { 'identifier' => $identifier },
799 unless ( $prepay_credit ) {
800 $dbh->rollback if $oldAutoCommit;
801 return "Invalid prepaid card: ". $identifier;
806 if ( $prepay_credit->agentnum ) {
807 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
808 $dbh->rollback if $oldAutoCommit;
809 return "prepaid card not valid for agent ". $self->agentnum;
811 $self->agentnum($prepay_credit->agentnum);
814 my $error = $prepay_credit->delete;
816 $dbh->rollback if $oldAutoCommit;
817 return "removing prepay_credit (transaction rolled back): $error";
820 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
821 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
823 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
828 =item increment_upbytes SECONDS
830 Updates this customer's single or primary account (see L<FS::svc_acct>) by
831 the specified number of upbytes. If there is an error, returns the error,
832 otherwise returns false.
836 sub increment_upbytes {
837 _increment_column( shift, 'upbytes', @_);
840 =item increment_downbytes SECONDS
842 Updates this customer's single or primary account (see L<FS::svc_acct>) by
843 the specified number of downbytes. If there is an error, returns the error,
844 otherwise returns false.
848 sub increment_downbytes {
849 _increment_column( shift, 'downbytes', @_);
852 =item increment_totalbytes SECONDS
854 Updates this customer's single or primary account (see L<FS::svc_acct>) by
855 the specified number of totalbytes. If there is an error, returns the error,
856 otherwise returns false.
860 sub increment_totalbytes {
861 _increment_column( shift, 'totalbytes', @_);
864 =item increment_seconds SECONDS
866 Updates this customer's single or primary account (see L<FS::svc_acct>) by
867 the specified number of seconds. If there is an error, returns the error,
868 otherwise returns false.
872 sub increment_seconds {
873 _increment_column( shift, 'seconds', @_);
876 =item _increment_column AMOUNT
878 Updates this customer's single or primary account (see L<FS::svc_acct>) by
879 the specified number of seconds or bytes. If there is an error, returns
880 the error, otherwise returns false.
884 sub _increment_column {
885 my( $self, $column, $amount ) = @_;
886 warn "$me increment_column called: $column, $amount\n"
889 return '' unless $amount;
891 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
892 $self->ncancelled_pkgs;
895 return 'No packages with primary or single services found'.
896 ' to apply pre-paid time';
897 } elsif ( scalar(@cust_pkg) > 1 ) {
898 #maybe have a way to specify the package/account?
899 return 'Multiple packages found to apply pre-paid time';
902 my $cust_pkg = $cust_pkg[0];
903 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
907 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
910 return 'No account found to apply pre-paid time';
911 } elsif ( scalar(@cust_svc) > 1 ) {
912 return 'Multiple accounts found to apply pre-paid time';
915 my $svc_acct = $cust_svc[0]->svc_x;
916 warn " found service svcnum ". $svc_acct->pkgnum.
917 ' ('. $svc_acct->email. ")\n"
920 $column = "increment_$column";
921 $svc_acct->$column($amount);
925 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
927 Inserts a prepayment in the specified amount for this customer. An optional
928 second argument can specify the prepayment identifier for tracking purposes.
929 If there is an error, returns the error, otherwise returns false.
933 sub insert_cust_pay_prepay {
934 shift->insert_cust_pay('PREP', @_);
937 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
939 Inserts a cash payment in the specified amount for this customer. An optional
940 second argument can specify the payment identifier for tracking purposes.
941 If there is an error, returns the error, otherwise returns false.
945 sub insert_cust_pay_cash {
946 shift->insert_cust_pay('CASH', @_);
949 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
951 Inserts a Western Union payment in the specified amount for this customer. An
952 optional second argument can specify the prepayment identifier for tracking
953 purposes. If there is an error, returns the error, otherwise returns false.
957 sub insert_cust_pay_west {
958 shift->insert_cust_pay('WEST', @_);
961 sub insert_cust_pay {
962 my( $self, $payby, $amount ) = splice(@_, 0, 3);
963 my $payinfo = scalar(@_) ? shift : '';
965 my $cust_pay = new FS::cust_pay {
966 'custnum' => $self->custnum,
967 'paid' => sprintf('%.2f', $amount),
968 #'_date' => #date the prepaid card was purchased???
970 'payinfo' => $payinfo,
978 This method is deprecated. See the I<depend_jobnum> option to the insert and
979 order_pkgs methods for a better way to defer provisioning.
981 Re-schedules all exports by calling the B<reexport> method of all associated
982 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
983 otherwise returns false.
990 carp "WARNING: FS::cust_main::reexport is deprectated; ".
991 "use the depend_jobnum option to insert or order_pkgs to delay export";
993 local $SIG{HUP} = 'IGNORE';
994 local $SIG{INT} = 'IGNORE';
995 local $SIG{QUIT} = 'IGNORE';
996 local $SIG{TERM} = 'IGNORE';
997 local $SIG{TSTP} = 'IGNORE';
998 local $SIG{PIPE} = 'IGNORE';
1000 my $oldAutoCommit = $FS::UID::AutoCommit;
1001 local $FS::UID::AutoCommit = 0;
1004 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1005 my $error = $cust_pkg->reexport;
1007 $dbh->rollback if $oldAutoCommit;
1012 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1017 =item delete [ OPTION => VALUE ... ]
1019 This deletes the customer. If there is an error, returns the error, otherwise
1022 This will completely remove all traces of the customer record. This is not
1023 what you want when a customer cancels service; for that, cancel all of the
1024 customer's packages (see L</cancel>).
1026 If the customer has any uncancelled packages, you need to pass a new (valid)
1027 customer number for those packages to be transferred to, as the "new_customer"
1028 option. Cancelled packages will be deleted. Did I mention that this is NOT
1029 what you want when a customer cancels service and that you really should be
1030 looking at L<FS::cust_pkg/cancel>?
1032 You can't delete a customer with invoices (see L<FS::cust_bill>),
1033 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1034 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1035 set the "delete_financials" option to a true value.
1040 my( $self, %opt ) = @_;
1042 local $SIG{HUP} = 'IGNORE';
1043 local $SIG{INT} = 'IGNORE';
1044 local $SIG{QUIT} = 'IGNORE';
1045 local $SIG{TERM} = 'IGNORE';
1046 local $SIG{TSTP} = 'IGNORE';
1047 local $SIG{PIPE} = 'IGNORE';
1049 my $oldAutoCommit = $FS::UID::AutoCommit;
1050 local $FS::UID::AutoCommit = 0;
1053 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1054 $dbh->rollback if $oldAutoCommit;
1055 return "Can't delete a master agent customer";
1058 #use FS::access_user
1059 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1060 $dbh->rollback if $oldAutoCommit;
1061 return "Can't delete a master employee customer";
1064 tie my %financial_tables, 'Tie::IxHash',
1065 'cust_bill' => 'invoices',
1066 'cust_statement' => 'statements',
1067 'cust_credit' => 'credits',
1068 'cust_pay' => 'payments',
1069 'cust_refund' => 'refunds',
1072 foreach my $table ( keys %financial_tables ) {
1074 my @records = $self->$table();
1076 if ( @records && ! $opt{'delete_financials'} ) {
1077 $dbh->rollback if $oldAutoCommit;
1078 return "Can't delete a customer with ". $financial_tables{$table};
1081 foreach my $record ( @records ) {
1082 my $error = $record->delete;
1084 $dbh->rollback if $oldAutoCommit;
1085 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1091 my @cust_pkg = $self->ncancelled_pkgs;
1093 my $new_custnum = $opt{'new_custnum'};
1094 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1095 $dbh->rollback if $oldAutoCommit;
1096 return "Invalid new customer number: $new_custnum";
1098 foreach my $cust_pkg ( @cust_pkg ) {
1099 my %hash = $cust_pkg->hash;
1100 $hash{'custnum'} = $new_custnum;
1101 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1102 my $error = $new_cust_pkg->replace($cust_pkg,
1103 options => { $cust_pkg->options },
1106 $dbh->rollback if $oldAutoCommit;
1111 my @cancelled_cust_pkg = $self->all_pkgs;
1112 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1113 my $error = $cust_pkg->delete;
1115 $dbh->rollback if $oldAutoCommit;
1120 #cust_tax_adjustment in financials?
1121 #cust_pay_pending? ouch
1123 foreach my $table (qw(
1124 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1125 cust_location cust_main_note cust_tax_adjustment
1126 cust_pay_void cust_pay_batch queue cust_tax_exempt
1128 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1129 my $error = $record->delete;
1131 $dbh->rollback if $oldAutoCommit;
1137 my $sth = $dbh->prepare(
1138 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1140 my $errstr = $dbh->errstr;
1141 $dbh->rollback if $oldAutoCommit;
1144 $sth->execute($self->custnum) or do {
1145 my $errstr = $sth->errstr;
1146 $dbh->rollback if $oldAutoCommit;
1152 my $ticket_dbh = '';
1153 if ($conf->config('ticket_system') eq 'RT_Internal') {
1155 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1156 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1157 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1158 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1161 if ( $ticket_dbh ) {
1163 my $ticket_sth = $ticket_dbh->prepare(
1164 'DELETE FROM Links WHERE Target = ?'
1166 my $errstr = $ticket_dbh->errstr;
1167 $dbh->rollback if $oldAutoCommit;
1170 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1172 my $errstr = $ticket_sth->errstr;
1173 $dbh->rollback if $oldAutoCommit;
1177 #check and see if the customer is the only link on the ticket, and
1178 #if so, set the ticket to deleted status in RT?
1179 #maybe someday, for now this will at least fix tickets not displaying
1183 #delete the customer record
1185 my $error = $self->SUPER::delete;
1187 $dbh->rollback if $oldAutoCommit;
1191 # cust_main exports!
1193 #my $export_args = $options{'export_args'} || [];
1196 map qsearch( 'part_export', {exportnum=>$_} ),
1197 $conf->config('cust_main-exports'); #, $agentnum
1199 foreach my $part_export ( @part_export ) {
1200 my $error = $part_export->export_delete( $self ); #, @$export_args);
1202 $dbh->rollback if $oldAutoCommit;
1203 return "exporting to ". $part_export->exporttype.
1204 " (transaction rolled back): $error";
1208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1213 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1215 This merges this customer into the provided new custnum, and then deletes the
1216 customer. If there is an error, returns the error, otherwise returns false.
1218 The source customer's name, company name, phone numbers, agent,
1219 referring customer, customer class, advertising source, order taker, and
1220 billing information (except balance) are discarded.
1222 All packages are moved to the target customer. Packages with package locations
1223 are preserved. Packages without package locations are moved to a new package
1224 location with the source customer's service/shipping address.
1226 All invoices, statements, payments, credits and refunds are moved to the target
1227 customer. The source customer's balance is added to the target customer.
1229 All notes, attachments, tickets and customer tags are moved to the target
1232 Change history is not currently moved.
1237 my( $self, $new_custnum, %opt ) = @_;
1239 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1241 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1242 return "Invalid new customer number: $new_custnum";
1245 local $SIG{HUP} = 'IGNORE';
1246 local $SIG{INT} = 'IGNORE';
1247 local $SIG{QUIT} = 'IGNORE';
1248 local $SIG{TERM} = 'IGNORE';
1249 local $SIG{TSTP} = 'IGNORE';
1250 local $SIG{PIPE} = 'IGNORE';
1252 my $oldAutoCommit = $FS::UID::AutoCommit;
1253 local $FS::UID::AutoCommit = 0;
1256 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1257 $dbh->rollback if $oldAutoCommit;
1258 return "Can't merge a master agent customer";
1261 #use FS::access_user
1262 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1263 $dbh->rollback if $oldAutoCommit;
1264 return "Can't merge a master employee customer";
1267 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1268 'status' => { op=>'!=', value=>'done' },
1272 $dbh->rollback if $oldAutoCommit;
1273 return "Can't merge a customer with pending payments";
1276 tie my %financial_tables, 'Tie::IxHash',
1277 'cust_bill' => 'invoices',
1278 'cust_statement' => 'statements',
1279 'cust_credit' => 'credits',
1280 'cust_pay' => 'payments',
1281 'cust_pay_void' => 'voided payments',
1282 'cust_refund' => 'refunds',
1285 foreach my $table ( keys %financial_tables ) {
1287 my @records = $self->$table();
1289 foreach my $record ( @records ) {
1290 $record->custnum($new_custnum);
1291 my $error = $record->replace;
1293 $dbh->rollback if $oldAutoCommit;
1294 return "Error merging ". $financial_tables{$table}. ": $error\n";
1300 my $name = $self->ship_name;
1302 my $locationnum = '';
1303 foreach my $cust_pkg ( $self->all_pkgs ) {
1304 $cust_pkg->custnum($new_custnum);
1306 unless ( $cust_pkg->locationnum ) {
1307 unless ( $locationnum ) {
1308 my $cust_location = new FS::cust_location {
1309 $self->location_hash,
1310 'custnum' => $new_custnum,
1312 my $error = $cust_location->insert;
1314 $dbh->rollback if $oldAutoCommit;
1317 $locationnum = $cust_location->locationnum;
1319 $cust_pkg->locationnum($locationnum);
1322 my $error = $cust_pkg->replace;
1324 $dbh->rollback if $oldAutoCommit;
1328 # add customer (ship) name to svc_phone.phone_name if blank
1329 my @cust_svc = $cust_pkg->cust_svc;
1330 foreach my $cust_svc (@cust_svc) {
1331 my($label, $value, $svcdb) = $cust_svc->label;
1332 next unless $svcdb eq 'svc_phone';
1333 my $svc_phone = $cust_svc->svc_x;
1334 next if $svc_phone->phone_name;
1335 $svc_phone->phone_name($name);
1336 my $error = $svc_phone->replace;
1338 $dbh->rollback if $oldAutoCommit;
1346 # cust_tax_exempt (texas tax exemptions)
1347 # cust_recon (some sort of not-well understood thing for OnPac)
1349 #these are moved over
1350 foreach my $table (qw(
1351 cust_tag cust_location contact cust_attachment cust_main_note
1352 cust_tax_adjustment cust_pay_batch queue
1354 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1355 $record->custnum($new_custnum);
1356 my $error = $record->replace;
1358 $dbh->rollback if $oldAutoCommit;
1364 #these aren't preserved
1365 foreach my $table (qw(
1366 cust_main_exemption cust_main_invoice
1368 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1369 my $error = $record->delete;
1371 $dbh->rollback if $oldAutoCommit;
1378 my $sth = $dbh->prepare(
1379 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1381 my $errstr = $dbh->errstr;
1382 $dbh->rollback if $oldAutoCommit;
1385 $sth->execute($new_custnum, $self->custnum) or do {
1386 my $errstr = $sth->errstr;
1387 $dbh->rollback if $oldAutoCommit;
1393 my $ticket_dbh = '';
1394 if ($conf->config('ticket_system') eq 'RT_Internal') {
1396 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1397 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1398 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1399 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1402 if ( $ticket_dbh ) {
1404 my $ticket_sth = $ticket_dbh->prepare(
1405 'UPDATE Links SET Target = ? WHERE Target = ?'
1407 my $errstr = $ticket_dbh->errstr;
1408 $dbh->rollback if $oldAutoCommit;
1411 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1412 'freeside://freeside/cust_main/'.$self->custnum)
1414 my $errstr = $ticket_sth->errstr;
1415 $dbh->rollback if $oldAutoCommit;
1421 #delete the customer record
1423 my $error = $self->delete;
1425 $dbh->rollback if $oldAutoCommit;
1429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1434 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1437 Replaces the OLD_RECORD with this one in the database. If there is an error,
1438 returns the error, otherwise returns false.
1440 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1441 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1442 expected and rollback the entire transaction; it is not necessary to call
1443 check_invoicing_list first. Here's an example:
1445 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1447 Currently available options are: I<tax_exemption>.
1449 The I<tax_exemption> option can be set to an arrayref of tax names.
1450 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1457 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1459 : $self->replace_old;
1463 warn "$me replace called\n"
1466 my $curuser = $FS::CurrentUser::CurrentUser;
1467 if ( $self->payby eq 'COMP'
1468 && $self->payby ne $old->payby
1469 && ! $curuser->access_right('Complimentary customer')
1472 return "You are not permitted to create complimentary accounts.";
1475 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1476 && $conf->exists('enable_taxproducts')
1479 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1481 $self->set('geocode', '')
1482 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1483 && length($self->get($pre.'zip')) >= 10;
1486 for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1488 $self->set($pre.'coord_auto', '') && next
1489 if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1490 && ( $self->get($pre.'latitude') != $old->get($pre.'latitude')
1491 || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1494 $self->set_coord($pre)
1495 if $old->get($pre.'address1') ne $self->get($pre.'address1')
1496 || $old->get($pre.'city') ne $self->get($pre.'city')
1497 || $old->get($pre.'state') ne $self->get($pre.'state')
1498 || $old->get($pre.'country') ne $self->get($pre.'country');
1502 unless ( $import ) {
1504 if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1506 $self->set_coord('ship_')
1507 if $self->has_ship_address && ! $self->ship_coord_auto
1508 && ! $self->ship_latitude && ! $self->ship_longitude;
1511 local($ignore_expired_card) = 1
1512 if $old->payby =~ /^(CARD|DCRD)$/
1513 && $self->payby =~ /^(CARD|DCRD)$/
1514 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1516 local($ignore_banned_card) = 1
1517 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1518 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1519 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1521 if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1522 # update censusyear whenever tract code changes
1523 $self->censusyear($conf->config('census_year'));
1527 local $SIG{HUP} = 'IGNORE';
1528 local $SIG{INT} = 'IGNORE';
1529 local $SIG{QUIT} = 'IGNORE';
1530 local $SIG{TERM} = 'IGNORE';
1531 local $SIG{TSTP} = 'IGNORE';
1532 local $SIG{PIPE} = 'IGNORE';
1534 my $oldAutoCommit = $FS::UID::AutoCommit;
1535 local $FS::UID::AutoCommit = 0;
1538 my $error = $self->SUPER::replace($old);
1541 $dbh->rollback if $oldAutoCommit;
1545 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1546 my $invoicing_list = shift @param;
1547 $error = $self->check_invoicing_list( $invoicing_list );
1549 $dbh->rollback if $oldAutoCommit;
1552 $self->invoicing_list( $invoicing_list );
1555 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1557 #this could be more efficient than deleting and re-inserting, if it matters
1558 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1559 my $error = $cust_tag->delete;
1561 $dbh->rollback if $oldAutoCommit;
1565 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1566 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1567 'custnum' => $self->custnum };
1568 my $error = $cust_tag->insert;
1570 $dbh->rollback if $oldAutoCommit;
1577 my %options = @param;
1579 my $tax_exemption = delete $options{'tax_exemption'};
1580 if ( $tax_exemption ) {
1582 my %cust_main_exemption =
1583 map { $_->taxname => $_ }
1584 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1586 foreach my $taxname ( @$tax_exemption ) {
1588 next if delete $cust_main_exemption{$taxname};
1590 my $cust_main_exemption = new FS::cust_main_exemption {
1591 'custnum' => $self->custnum,
1592 'taxname' => $taxname,
1594 my $error = $cust_main_exemption->insert;
1596 $dbh->rollback if $oldAutoCommit;
1597 return "inserting cust_main_exemption (transaction rolled back): $error";
1601 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1602 my $error = $cust_main_exemption->delete;
1604 $dbh->rollback if $oldAutoCommit;
1605 return "deleting cust_main_exemption (transaction rolled back): $error";
1611 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1612 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1613 && $self->get('payinfo') !~ /^99\d{14}$/
1615 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1620 # card/check/lec info has changed, want to retry realtime_ invoice events
1621 my $error = $self->retry_realtime;
1623 $dbh->rollback if $oldAutoCommit;
1628 unless ( $import || $skip_fuzzyfiles ) {
1629 $error = $self->queue_fuzzyfiles_update;
1631 $dbh->rollback if $oldAutoCommit;
1632 return "updating fuzzy search cache: $error";
1636 # cust_main exports!
1638 my $export_args = $options{'export_args'} || [];
1641 map qsearch( 'part_export', {exportnum=>$_} ),
1642 $conf->config('cust_main-exports'); #, $agentnum
1644 foreach my $part_export ( @part_export ) {
1645 my $error = $part_export->export_replace( $self, $old, @$export_args);
1647 $dbh->rollback if $oldAutoCommit;
1648 return "exporting to ". $part_export->exporttype.
1649 " (transaction rolled back): $error";
1653 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1658 =item queue_fuzzyfiles_update
1660 Used by insert & replace to update the fuzzy search cache
1664 use FS::cust_main::Search;
1665 sub queue_fuzzyfiles_update {
1668 local $SIG{HUP} = 'IGNORE';
1669 local $SIG{INT} = 'IGNORE';
1670 local $SIG{QUIT} = 'IGNORE';
1671 local $SIG{TERM} = 'IGNORE';
1672 local $SIG{TSTP} = 'IGNORE';
1673 local $SIG{PIPE} = 'IGNORE';
1675 my $oldAutoCommit = $FS::UID::AutoCommit;
1676 local $FS::UID::AutoCommit = 0;
1679 my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1680 my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1682 $dbh->rollback if $oldAutoCommit;
1683 return "queueing job (transaction rolled back): $error";
1686 if ( $self->ship_last ) {
1687 $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1688 $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1690 $dbh->rollback if $oldAutoCommit;
1691 return "queueing job (transaction rolled back): $error";
1695 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1702 Checks all fields to make sure this is a valid customer record. If there is
1703 an error, returns the error, otherwise returns false. Called by the insert
1704 and replace methods.
1711 warn "$me check BEFORE: \n". $self->_dump
1715 $self->ut_numbern('custnum')
1716 || $self->ut_number('agentnum')
1717 || $self->ut_textn('agent_custid')
1718 || $self->ut_number('refnum')
1719 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1720 || $self->ut_textn('custbatch')
1721 || $self->ut_name('last')
1722 || $self->ut_name('first')
1723 || $self->ut_snumbern('birthdate')
1724 || $self->ut_snumbern('signupdate')
1725 || $self->ut_textn('company')
1726 || $self->ut_text('address1')
1727 || $self->ut_textn('address2')
1728 || $self->ut_text('city')
1729 || $self->ut_textn('county')
1730 || $self->ut_textn('state')
1731 || $self->ut_country('country')
1732 || $self->ut_coordn('latitude')
1733 || $self->ut_coordn('longitude')
1734 || $self->ut_enum('coord_auto', [ '', 'Y' ])
1735 || $self->ut_numbern('censusyear')
1736 || $self->ut_anything('comments')
1737 || $self->ut_numbern('referral_custnum')
1738 || $self->ut_textn('stateid')
1739 || $self->ut_textn('stateid_state')
1740 || $self->ut_textn('invoice_terms')
1741 || $self->ut_alphan('geocode')
1742 || $self->ut_floatn('cdr_termination_percentage')
1743 || $self->ut_floatn('credit_limit')
1744 || $self->ut_numbern('billday')
1745 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1746 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1747 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1751 unless $import || ($self->latitude && $self->longitude);
1753 #barf. need message catalogs. i18n. etc.
1754 $error .= "Please select an advertising source."
1755 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1756 return $error if $error;
1758 return "Unknown agent"
1759 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1761 return "Unknown refnum"
1762 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1764 return "Unknown referring custnum: ". $self->referral_custnum
1765 unless ! $self->referral_custnum
1766 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1768 if ( $self->censustract ne '' ) {
1769 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1770 or return "Illegal census tract: ". $self->censustract;
1772 $self->censustract("$1.$2");
1775 if ( $self->ss eq '' ) {
1780 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1781 or return "Illegal social security number: ". $self->ss;
1782 $self->ss("$1-$2-$3");
1786 # bad idea to disable, causes billing to fail because of no tax rates later
1787 # except we don't fail any more
1788 unless ( $import ) {
1789 unless ( qsearch('cust_main_county', {
1790 'country' => $self->country,
1793 return "Unknown state/county/country: ".
1794 $self->state. "/". $self->county. "/". $self->country
1795 unless qsearch('cust_main_county',{
1796 'state' => $self->state,
1797 'county' => $self->county,
1798 'country' => $self->country,
1804 $self->ut_phonen('daytime', $self->country)
1805 || $self->ut_phonen('night', $self->country)
1806 || $self->ut_phonen('fax', $self->country)
1807 || $self->ut_phonen('mobile', $self->country)
1809 return $error if $error;
1811 unless ( $ignore_illegal_zip ) {
1812 $error = $self->ut_zip('zip', $self->country);
1813 return $error if $error;
1816 if ( $conf->exists('cust_main-require_phone')
1817 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1820 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1822 : FS::Msgcat::_gettext('daytime');
1823 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1825 : FS::Msgcat::_gettext('night');
1827 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1829 : FS::Msgcat::_gettext('mobile');
1831 return "$daytime_label, $night_label or $mobile_label is required"
1835 if ( $self->has_ship_address
1836 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1837 $self->addr_fields )
1841 $self->ut_name('ship_last')
1842 || $self->ut_name('ship_first')
1843 || $self->ut_textn('ship_company')
1844 || $self->ut_text('ship_address1')
1845 || $self->ut_textn('ship_address2')
1846 || $self->ut_text('ship_city')
1847 || $self->ut_textn('ship_county')
1848 || $self->ut_textn('ship_state')
1849 || $self->ut_country('ship_country')
1850 || $self->ut_coordn('ship_latitude')
1851 || $self->ut_coordn('ship_longitude')
1852 || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1854 return $error if $error;
1856 $self->set_coord('ship_')
1857 unless $import || ($self->ship_latitude && $self->ship_longitude);
1859 #false laziness with above
1860 unless ( qsearchs('cust_main_county', {
1861 'country' => $self->ship_country,
1864 return "Unknown ship_state/ship_county/ship_country: ".
1865 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1866 unless qsearch('cust_main_county',{
1867 'state' => $self->ship_state,
1868 'county' => $self->ship_county,
1869 'country' => $self->ship_country,
1875 $self->ut_phonen('ship_daytime', $self->ship_country)
1876 || $self->ut_phonen('ship_night', $self->ship_country)
1877 || $self->ut_phonen('ship_fax', $self->ship_country)
1878 || $self->ut_phonen('ship_mobile', $self->ship_country)
1880 return $error if $error;
1882 unless ( $ignore_illegal_zip ) {
1883 $error = $self->ut_zip('ship_zip', $self->ship_country);
1884 return $error if $error;
1886 return "Unit # is required."
1887 if $self->ship_address2 =~ /^\s*$/
1888 && $conf->exists('cust_main-require_address2');
1890 } else { # ship_ info eq billing info, so don't store dup info in database
1892 $self->setfield("ship_$_", '')
1893 foreach $self->addr_fields;
1895 return "Unit # is required."
1896 if $self->address2 =~ /^\s*$/
1897 && $conf->exists('cust_main-require_address2');
1901 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1902 # or return "Illegal payby: ". $self->payby;
1904 FS::payby->can_payby($self->table, $self->payby)
1905 or return "Illegal payby: ". $self->payby;
1907 $error = $self->ut_numbern('paystart_month')
1908 || $self->ut_numbern('paystart_year')
1909 || $self->ut_numbern('payissue')
1910 || $self->ut_textn('paytype')
1912 return $error if $error;
1914 if ( $self->payip eq '' ) {
1917 $error = $self->ut_ip('payip');
1918 return $error if $error;
1921 # If it is encrypted and the private key is not availaible then we can't
1922 # check the credit card.
1923 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1925 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1927 my $payinfo = $self->payinfo;
1928 $payinfo =~ s/\D//g;
1929 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1930 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1932 $self->payinfo($payinfo);
1934 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1936 return gettext('unknown_card_type')
1937 if $self->payinfo !~ /^99\d{14}$/ #token
1938 && cardtype($self->payinfo) eq "Unknown";
1940 unless ( $ignore_banned_card ) {
1941 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1943 if ( $ban->bantype eq 'warn' ) {
1944 #or others depending on value of $ban->reason ?
1945 return '_duplicate_card'.
1946 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1947 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1948 ' (ban# '. $ban->bannum. ')'
1949 unless $self->override_ban_warn;
1951 return 'Banned credit card: banned on '.
1952 time2str('%a %h %o at %r', $ban->_date).
1953 ' by '. $ban->otaker.
1954 ' (ban# '. $ban->bannum. ')';
1959 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1960 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1961 $self->paycvv =~ /^(\d{4})$/
1962 or return "CVV2 (CID) for American Express cards is four digits.";
1965 $self->paycvv =~ /^(\d{3})$/
1966 or return "CVV2 (CVC2/CID) is three digits.";
1973 my $cardtype = cardtype($payinfo);
1974 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1976 return "Start date or issue number is required for $cardtype cards"
1977 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1979 return "Start month must be between 1 and 12"
1980 if $self->paystart_month
1981 and $self->paystart_month < 1 || $self->paystart_month > 12;
1983 return "Start year must be 1990 or later"
1984 if $self->paystart_year
1985 and $self->paystart_year < 1990;
1987 return "Issue number must be beween 1 and 99"
1989 and $self->payissue < 1 || $self->payissue > 99;
1992 $self->paystart_month('');
1993 $self->paystart_year('');
1994 $self->payissue('');
1997 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1999 my $payinfo = $self->payinfo;
2000 $payinfo =~ s/[^\d\@\.]//g;
2001 if ( $conf->exists('cust_main-require-bank-branch') ) {
2002 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
2003 $payinfo = "$1\@$2.$3";
2004 } elsif ( $conf->exists('echeck-nonus') ) {
2005 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
2006 $payinfo = "$1\@$2";
2008 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2009 $payinfo = "$1\@$2";
2011 $self->payinfo($payinfo);
2014 unless ( $ignore_banned_card ) {
2015 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2017 if ( $ban->bantype eq 'warn' ) {
2018 #or others depending on value of $ban->reason ?
2019 return '_duplicate_ach' unless $self->override_ban_warn;
2021 return 'Banned ACH account: banned on '.
2022 time2str('%a %h %o at %r', $ban->_date).
2023 ' by '. $ban->otaker.
2024 ' (ban# '. $ban->bannum. ')';
2029 } elsif ( $self->payby eq 'LECB' ) {
2031 my $payinfo = $self->payinfo;
2032 $payinfo =~ s/\D//g;
2033 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2035 $self->payinfo($payinfo);
2038 } elsif ( $self->payby eq 'BILL' ) {
2040 $error = $self->ut_textn('payinfo');
2041 return "Illegal P.O. number: ". $self->payinfo if $error;
2044 } elsif ( $self->payby eq 'COMP' ) {
2046 my $curuser = $FS::CurrentUser::CurrentUser;
2047 if ( ! $self->custnum
2048 && ! $curuser->access_right('Complimentary customer')
2051 return "You are not permitted to create complimentary accounts."
2054 $error = $self->ut_textn('payinfo');
2055 return "Illegal comp account issuer: ". $self->payinfo if $error;
2058 } elsif ( $self->payby eq 'PREPAY' ) {
2060 my $payinfo = $self->payinfo;
2061 $payinfo =~ s/\W//g; #anything else would just confuse things
2062 $self->payinfo($payinfo);
2063 $error = $self->ut_alpha('payinfo');
2064 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2065 return "Unknown prepayment identifier"
2066 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2071 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2072 return "Expiration date required"
2073 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2077 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2078 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2079 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2080 ( $m, $y ) = ( $2, "19$1" );
2081 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2082 ( $m, $y ) = ( $3, "20$2" );
2084 return "Illegal expiration date: ". $self->paydate;
2086 $m = sprintf('%02d',$m);
2087 $self->paydate("$y-$m-01");
2088 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2089 return gettext('expired_card')
2091 && !$ignore_expired_card
2092 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2095 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2096 ( ! $conf->exists('require_cardname')
2097 || $self->payby !~ /^(CARD|DCRD)$/ )
2099 $self->payname( $self->first. " ". $self->getfield('last') );
2101 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2102 or return gettext('illegal_name'). " payname: ". $self->payname;
2106 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2107 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2111 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2113 warn "$me check AFTER: \n". $self->_dump
2116 $self->SUPER::check;
2121 Returns a list of fields which have ship_ duplicates.
2126 qw( last first company
2127 address1 address2 city county state zip country
2129 daytime night fax mobile
2133 =item has_ship_address
2135 Returns true if this customer record has a separate shipping address.
2139 sub has_ship_address {
2141 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2146 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2147 city, county, state, zip, country, and geocode. The shipping address is used if present.
2153 Returns all locations (see L<FS::cust_location>) for this customer.
2159 qsearch('cust_location', { 'custnum' => $self->custnum } );
2164 Returns all contacts (see L<FS::contact>) for this customer.
2168 #already used :/ sub contact {
2171 qsearch('contact', { 'custnum' => $self->custnum } );
2176 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2177 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2178 on success or a list of errors.
2184 grep { $_->unsuspend } $self->suspended_pkgs;
2189 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2191 Returns a list: an empty list on success or a list of errors.
2197 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2200 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2202 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2203 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2204 of a list of pkgparts; the hashref has the following keys:
2208 =item pkgparts - listref of pkgparts
2210 =item (other options are passed to the suspend method)
2215 Returns a list: an empty list on success or a list of errors.
2219 sub suspend_if_pkgpart {
2221 my (@pkgparts, %opt);
2222 if (ref($_[0]) eq 'HASH'){
2223 @pkgparts = @{$_[0]{pkgparts}};
2228 grep { $_->suspend(%opt) }
2229 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2230 $self->unsuspended_pkgs;
2233 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2235 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2236 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2237 instead of a list of pkgparts; the hashref has the following keys:
2241 =item pkgparts - listref of pkgparts
2243 =item (other options are passed to the suspend method)
2247 Returns a list: an empty list on success or a list of errors.
2251 sub suspend_unless_pkgpart {
2253 my (@pkgparts, %opt);
2254 if (ref($_[0]) eq 'HASH'){
2255 @pkgparts = @{$_[0]{pkgparts}};
2260 grep { $_->suspend(%opt) }
2261 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2262 $self->unsuspended_pkgs;
2265 =item cancel [ OPTION => VALUE ... ]
2267 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2269 Available options are:
2273 =item quiet - can be set true to supress email cancellation notices.
2275 =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.
2277 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2279 =item nobill - can be set true to skip billing if it might otherwise be done.
2283 Always returns a list: an empty list on success or a list of errors.
2287 # nb that dates are not specified as valid options to this method
2290 my( $self, %opt ) = @_;
2292 warn "$me cancel called on customer ". $self->custnum. " with options ".
2293 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2296 return ( 'access denied' )
2297 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2299 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2301 #should try decryption (we might have the private key)
2302 # and if not maybe queue a job for the server that does?
2303 return ( "Can't (yet) ban encrypted credit cards" )
2304 if $self->is_encrypted($self->payinfo);
2306 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2307 my $error = $ban->insert;
2308 return ( $error ) if $error;
2312 my @pkgs = $self->ncancelled_pkgs;
2314 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2316 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2317 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2321 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2322 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2325 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2328 sub _banned_pay_hashref {
2339 'payby' => $payby2ban{$self->payby},
2340 'payinfo' => $self->payinfo,
2341 #don't ever *search* on reason! #'reason' =>
2345 sub _new_banned_pay_hashref {
2347 my $hr = $self->_banned_pay_hashref;
2348 $hr->{payinfo} = md5_base64($hr->{payinfo});
2354 Returns all notes (see L<FS::cust_main_note>) for this customer.
2359 my($self,$orderby_classnum) = (shift,shift);
2360 my $orderby = "_DATE DESC";
2361 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2362 qsearch( 'cust_main_note',
2363 { 'custnum' => $self->custnum },
2365 "ORDER BY $orderby",
2371 Returns the agent (see L<FS::agent>) for this customer.
2377 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2382 Returns the agent name (see L<FS::agent>) for this customer.
2388 $self->agent->agent;
2393 Returns any tags associated with this customer, as FS::cust_tag objects,
2394 or an empty list if there are no tags.
2400 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2405 Returns any tags associated with this customer, as FS::part_tag objects,
2406 or an empty list if there are no tags.
2412 map $_->part_tag, $self->cust_tag;
2418 Returns the customer class, as an FS::cust_class object, or the empty string
2419 if there is no customer class.
2425 if ( $self->classnum ) {
2426 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2434 Returns the customer category name, or the empty string if there is no customer
2441 my $cust_class = $self->cust_class;
2443 ? $cust_class->categoryname
2449 Returns the customer class name, or the empty string if there is no customer
2456 my $cust_class = $self->cust_class;
2458 ? $cust_class->classname
2462 =item BILLING METHODS
2464 Documentation on billing methods has been moved to
2465 L<FS::cust_main::Billing>.
2467 =item REALTIME BILLING METHODS
2469 Documentation on realtime billing methods has been moved to
2470 L<FS::cust_main::Billing_Realtime>.
2474 Removes the I<paycvv> field from the database directly.
2476 If there is an error, returns the error, otherwise returns false.
2482 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2483 or return dbh->errstr;
2484 $sth->execute($self->custnum)
2485 or return $sth->errstr;
2490 =item batch_card OPTION => VALUE...
2492 Adds a payment for this invoice to the pending credit card batch (see
2493 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2494 runs the payment using a realtime gateway.
2499 my ($self, %options) = @_;
2502 if (exists($options{amount})) {
2503 $amount = $options{amount};
2505 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2507 return '' unless $amount > 0;
2509 my $invnum = delete $options{invnum};
2510 my $payby = $options{payby} || $self->payby; #still dubious
2512 if ($options{'realtime'}) {
2513 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2519 my $oldAutoCommit = $FS::UID::AutoCommit;
2520 local $FS::UID::AutoCommit = 0;
2523 #this needs to handle mysql as well as Pg, like svc_acct.pm
2524 #(make it into a common function if folks need to do batching with mysql)
2525 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2526 or return "Cannot lock pay_batch: " . $dbh->errstr;
2530 'payby' => FS::payby->payby2payment($payby),
2532 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2534 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2536 unless ( $pay_batch ) {
2537 $pay_batch = new FS::pay_batch \%pay_batch;
2538 my $error = $pay_batch->insert;
2540 $dbh->rollback if $oldAutoCommit;
2541 die "error creating new batch: $error\n";
2545 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2546 'batchnum' => $pay_batch->batchnum,
2547 'custnum' => $self->custnum,
2550 foreach (qw( address1 address2 city state zip country latitude longitude
2551 payby payinfo paydate payname ))
2553 $options{$_} = '' unless exists($options{$_});
2556 my $cust_pay_batch = new FS::cust_pay_batch ( {
2557 'batchnum' => $pay_batch->batchnum,
2558 'invnum' => $invnum || 0, # is there a better value?
2559 # this field should be
2561 # cust_bill_pay_batch now
2562 'custnum' => $self->custnum,
2563 'last' => $self->getfield('last'),
2564 'first' => $self->getfield('first'),
2565 'address1' => $options{address1} || $self->address1,
2566 'address2' => $options{address2} || $self->address2,
2567 'city' => $options{city} || $self->city,
2568 'state' => $options{state} || $self->state,
2569 'zip' => $options{zip} || $self->zip,
2570 'country' => $options{country} || $self->country,
2571 'payby' => $options{payby} || $self->payby,
2572 'payinfo' => $options{payinfo} || $self->payinfo,
2573 'exp' => $options{paydate} || $self->paydate,
2574 'payname' => $options{payname} || $self->payname,
2575 'amount' => $amount, # consolidating
2578 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2579 if $old_cust_pay_batch;
2582 if ($old_cust_pay_batch) {
2583 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2585 $error = $cust_pay_batch->insert;
2589 $dbh->rollback if $oldAutoCommit;
2593 my $unapplied = $self->total_unapplied_credits
2594 + $self->total_unapplied_payments
2595 + $self->in_transit_payments;
2596 foreach my $cust_bill ($self->open_cust_bill) {
2597 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2598 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2599 'invnum' => $cust_bill->invnum,
2600 'paybatchnum' => $cust_pay_batch->paybatchnum,
2601 'amount' => $cust_bill->owed,
2604 if ($unapplied >= $cust_bill_pay_batch->amount){
2605 $unapplied -= $cust_bill_pay_batch->amount;
2608 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2609 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2611 $error = $cust_bill_pay_batch->insert;
2613 $dbh->rollback if $oldAutoCommit;
2618 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2624 Returns the total owed for this customer on all invoices
2625 (see L<FS::cust_bill/owed>).
2631 $self->total_owed_date(2145859200); #12/31/2037
2634 =item total_owed_date TIME
2636 Returns the total owed for this customer on all invoices with date earlier than
2637 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2638 see L<Time::Local> and L<Date::Parse> for conversion functions.
2642 sub total_owed_date {
2646 my $custnum = $self->custnum;
2648 my $owed_sql = FS::cust_bill->owed_sql;
2651 SELECT SUM($owed_sql) FROM cust_bill
2652 WHERE custnum = $custnum
2656 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2660 =item total_owed_pkgnum PKGNUM
2662 Returns the total owed on all invoices for this customer's specific package
2663 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2667 sub total_owed_pkgnum {
2668 my( $self, $pkgnum ) = @_;
2669 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2672 =item total_owed_date_pkgnum TIME PKGNUM
2674 Returns the total owed for this customer's specific package when using
2675 experimental package balances on all invoices with date earlier than
2676 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2677 see L<Time::Local> and L<Date::Parse> for conversion functions.
2681 sub total_owed_date_pkgnum {
2682 my( $self, $time, $pkgnum ) = @_;
2685 foreach my $cust_bill (
2686 grep { $_->_date <= $time }
2687 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2689 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2691 sprintf( "%.2f", $total_bill );
2697 Returns the total amount of all payments.
2704 $total += $_->paid foreach $self->cust_pay;
2705 sprintf( "%.2f", $total );
2708 =item total_unapplied_credits
2710 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2711 customer. See L<FS::cust_credit/credited>.
2713 =item total_credited
2715 Old name for total_unapplied_credits. Don't use.
2719 sub total_credited {
2720 #carp "total_credited deprecated, use total_unapplied_credits";
2721 shift->total_unapplied_credits(@_);
2724 sub total_unapplied_credits {
2727 my $custnum = $self->custnum;
2729 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2732 SELECT SUM($unapplied_sql) FROM cust_credit
2733 WHERE custnum = $custnum
2736 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2740 =item total_unapplied_credits_pkgnum PKGNUM
2742 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2743 customer. See L<FS::cust_credit/credited>.
2747 sub total_unapplied_credits_pkgnum {
2748 my( $self, $pkgnum ) = @_;
2749 my $total_credit = 0;
2750 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2751 sprintf( "%.2f", $total_credit );
2755 =item total_unapplied_payments
2757 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2758 See L<FS::cust_pay/unapplied>.
2762 sub total_unapplied_payments {
2765 my $custnum = $self->custnum;
2767 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2770 SELECT SUM($unapplied_sql) FROM cust_pay
2771 WHERE custnum = $custnum
2774 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2778 =item total_unapplied_payments_pkgnum PKGNUM
2780 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2781 specific package when using experimental package balances. See
2782 L<FS::cust_pay/unapplied>.
2786 sub total_unapplied_payments_pkgnum {
2787 my( $self, $pkgnum ) = @_;
2788 my $total_unapplied = 0;
2789 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2790 sprintf( "%.2f", $total_unapplied );
2794 =item total_unapplied_refunds
2796 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2797 customer. See L<FS::cust_refund/unapplied>.
2801 sub total_unapplied_refunds {
2803 my $custnum = $self->custnum;
2805 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2808 SELECT SUM($unapplied_sql) FROM cust_refund
2809 WHERE custnum = $custnum
2812 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2818 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2819 total_unapplied_credits minus total_unapplied_payments).
2825 $self->balance_date_range;
2828 =item balance_date TIME
2830 Returns the balance for this customer, only considering invoices with date
2831 earlier than TIME (total_owed_date minus total_credited minus
2832 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2833 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2840 $self->balance_date_range(shift);
2843 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2845 Returns the balance for this customer, optionally considering invoices with
2846 date earlier than START_TIME, and not later than END_TIME
2847 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2849 Times are specified as SQL fragments or numeric
2850 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2851 L<Date::Parse> for conversion functions. The empty string can be passed
2852 to disable that time constraint completely.
2854 Available options are:
2858 =item unapplied_date
2860 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)
2866 sub balance_date_range {
2868 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2869 ') FROM cust_main WHERE custnum='. $self->custnum;
2870 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2873 =item balance_pkgnum PKGNUM
2875 Returns the balance for this customer's specific package when using
2876 experimental package balances (total_owed plus total_unrefunded, minus
2877 total_unapplied_credits minus total_unapplied_payments)
2881 sub balance_pkgnum {
2882 my( $self, $pkgnum ) = @_;
2885 $self->total_owed_pkgnum($pkgnum)
2886 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2887 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2888 - $self->total_unapplied_credits_pkgnum($pkgnum)
2889 - $self->total_unapplied_payments_pkgnum($pkgnum)
2893 =item in_transit_payments
2895 Returns the total of requests for payments for this customer pending in
2896 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2900 sub in_transit_payments {
2902 my $in_transit_payments = 0;
2903 foreach my $pay_batch ( qsearch('pay_batch', {
2906 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2907 'batchnum' => $pay_batch->batchnum,
2908 'custnum' => $self->custnum,
2910 $in_transit_payments += $cust_pay_batch->amount;
2913 sprintf( "%.2f", $in_transit_payments );
2918 Returns a hash of useful information for making a payment.
2928 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2929 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2930 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2934 For credit card transactions:
2946 For electronic check transactions:
2961 $return{balance} = $self->balance;
2963 $return{payname} = $self->payname
2964 || ( $self->first. ' '. $self->get('last') );
2966 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2968 $return{payby} = $self->payby;
2969 $return{stateid_state} = $self->stateid_state;
2971 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2972 $return{card_type} = cardtype($self->payinfo);
2973 $return{payinfo} = $self->paymask;
2975 @return{'month', 'year'} = $self->paydate_monthyear;
2979 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2980 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2981 $return{payinfo1} = $payinfo1;
2982 $return{payinfo2} = $payinfo2;
2983 $return{paytype} = $self->paytype;
2984 $return{paystate} = $self->paystate;
2988 #doubleclick protection
2990 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2996 =item paydate_monthyear
2998 Returns a two-element list consisting of the month and year of this customer's
2999 paydate (credit card expiration date for CARD customers)
3003 sub paydate_monthyear {
3005 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3007 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3016 Returns the exact time in seconds corresponding to the payment method
3017 expiration date. For CARD/DCRD customers this is the end of the month;
3018 for others (COMP is the only other payby that uses paydate) it's the start.
3019 Returns 0 if the paydate is empty or set to the far future.
3025 my ($month, $year) = $self->paydate_monthyear;
3026 return 0 if !$year or $year >= 2037;
3027 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3029 if ( $month == 13 ) {
3033 return timelocal(0,0,0,1,$month-1,$year) - 1;
3036 return timelocal(0,0,0,1,$month-1,$year);
3040 =item paydate_epoch_sql
3042 Class method. Returns an SQL expression to obtain the payment expiration date
3043 as a number of seconds.
3047 # Special expiration date behavior for non-CARD/DCRD customers has been
3048 # carefully preserved. Do we really use that?
3049 sub paydate_epoch_sql {
3051 my $table = shift || 'cust_main';
3052 my ($case1, $case2);
3053 if ( driver_name eq 'Pg' ) {
3054 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3055 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3057 elsif ( lc(driver_name) eq 'mysql' ) {
3058 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3059 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3062 return "CASE WHEN $table.payby IN('CARD','DCRD')
3068 =item tax_exemption TAXNAME
3073 my( $self, $taxname ) = @_;
3075 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3076 'taxname' => $taxname,
3081 =item cust_main_exemption
3085 sub cust_main_exemption {
3087 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3090 =item invoicing_list [ ARRAYREF ]
3092 If an arguement is given, sets these email addresses as invoice recipients
3093 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3094 (except as warnings), so use check_invoicing_list first.
3096 Returns a list of email addresses (with svcnum entries expanded).
3098 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3099 check it without disturbing anything by passing nothing.
3101 This interface may change in the future.
3105 sub invoicing_list {
3106 my( $self, $arrayref ) = @_;
3109 my @cust_main_invoice;
3110 if ( $self->custnum ) {
3111 @cust_main_invoice =
3112 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3114 @cust_main_invoice = ();
3116 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3117 #warn $cust_main_invoice->destnum;
3118 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3119 #warn $cust_main_invoice->destnum;
3120 my $error = $cust_main_invoice->delete;
3121 warn $error if $error;
3124 if ( $self->custnum ) {
3125 @cust_main_invoice =
3126 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3128 @cust_main_invoice = ();
3130 my %seen = map { $_->address => 1 } @cust_main_invoice;
3131 foreach my $address ( @{$arrayref} ) {
3132 next if exists $seen{$address} && $seen{$address};
3133 $seen{$address} = 1;
3134 my $cust_main_invoice = new FS::cust_main_invoice ( {
3135 'custnum' => $self->custnum,
3138 my $error = $cust_main_invoice->insert;
3139 warn $error if $error;
3143 if ( $self->custnum ) {
3145 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3152 =item check_invoicing_list ARRAYREF
3154 Checks these arguements as valid input for the invoicing_list method. If there
3155 is an error, returns the error, otherwise returns false.
3159 sub check_invoicing_list {
3160 my( $self, $arrayref ) = @_;
3162 foreach my $address ( @$arrayref ) {
3164 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3165 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3168 my $cust_main_invoice = new FS::cust_main_invoice ( {
3169 'custnum' => $self->custnum,
3172 my $error = $self->custnum
3173 ? $cust_main_invoice->check
3174 : $cust_main_invoice->checkdest
3176 return $error if $error;
3180 return "Email address required"
3181 if $conf->exists('cust_main-require_invoicing_list_email')
3182 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3187 =item set_default_invoicing_list
3189 Sets the invoicing list to all accounts associated with this customer,
3190 overwriting any previous invoicing list.
3194 sub set_default_invoicing_list {
3196 $self->invoicing_list($self->all_emails);
3201 Returns the email addresses of all accounts provisioned for this customer.
3208 foreach my $cust_pkg ( $self->all_pkgs ) {
3209 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3211 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3212 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3214 $list{$_}=1 foreach map { $_->email } @svc_acct;
3219 =item invoicing_list_addpost
3221 Adds postal invoicing to this customer. If this customer is already configured
3222 to receive postal invoices, does nothing.
3226 sub invoicing_list_addpost {
3228 return if grep { $_ eq 'POST' } $self->invoicing_list;
3229 my @invoicing_list = $self->invoicing_list;
3230 push @invoicing_list, 'POST';
3231 $self->invoicing_list(\@invoicing_list);
3234 =item invoicing_list_emailonly
3236 Returns the list of email invoice recipients (invoicing_list without non-email
3237 destinations such as POST and FAX).
3241 sub invoicing_list_emailonly {
3243 warn "$me invoicing_list_emailonly called"
3245 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3248 =item invoicing_list_emailonly_scalar
3250 Returns the list of email invoice recipients (invoicing_list without non-email
3251 destinations such as POST and FAX) as a comma-separated scalar.
3255 sub invoicing_list_emailonly_scalar {
3257 warn "$me invoicing_list_emailonly_scalar called"
3259 join(', ', $self->invoicing_list_emailonly);
3262 =item referral_custnum_cust_main
3264 Returns the customer who referred this customer (or the empty string, if
3265 this customer was not referred).
3267 Note the difference with referral_cust_main method: This method,
3268 referral_custnum_cust_main returns the single customer (if any) who referred
3269 this customer, while referral_cust_main returns an array of customers referred
3274 sub referral_custnum_cust_main {
3276 return '' unless $self->referral_custnum;
3277 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3280 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3282 Returns an array of customers referred by this customer (referral_custnum set
3283 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3284 customers referred by customers referred by this customer and so on, inclusive.
3285 The default behavior is DEPTH 1 (no recursion).
3287 Note the difference with referral_custnum_cust_main method: This method,
3288 referral_cust_main, returns an array of customers referred BY this customer,
3289 while referral_custnum_cust_main returns the single customer (if any) who
3290 referred this customer.
3294 sub referral_cust_main {
3296 my $depth = @_ ? shift : 1;
3297 my $exclude = @_ ? shift : {};
3300 map { $exclude->{$_->custnum}++; $_; }
3301 grep { ! $exclude->{ $_->custnum } }
3302 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3306 map { $_->referral_cust_main($depth-1, $exclude) }
3313 =item referral_cust_main_ncancelled
3315 Same as referral_cust_main, except only returns customers with uncancelled
3320 sub referral_cust_main_ncancelled {
3322 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3325 =item referral_cust_pkg [ DEPTH ]
3327 Like referral_cust_main, except returns a flat list of all unsuspended (and
3328 uncancelled) packages for each customer. The number of items in this list may
3329 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3333 sub referral_cust_pkg {
3335 my $depth = @_ ? shift : 1;
3337 map { $_->unsuspended_pkgs }
3338 grep { $_->unsuspended_pkgs }
3339 $self->referral_cust_main($depth);
3342 =item referring_cust_main
3344 Returns the single cust_main record for the customer who referred this customer
3345 (referral_custnum), or false.
3349 sub referring_cust_main {
3351 return '' unless $self->referral_custnum;
3352 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3355 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3357 Applies a credit to this customer. If there is an error, returns the error,
3358 otherwise returns false.
3360 REASON can be a text string, an FS::reason object, or a scalar reference to
3361 a reasonnum. If a text string, it will be automatically inserted as a new
3362 reason, and a 'reason_type' option must be passed to indicate the
3363 FS::reason_type for the new reason.
3365 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3367 Any other options are passed to FS::cust_credit::insert.
3372 my( $self, $amount, $reason, %options ) = @_;
3374 my $cust_credit = new FS::cust_credit {
3375 'custnum' => $self->custnum,
3376 'amount' => $amount,
3379 if ( ref($reason) ) {
3381 if ( ref($reason) eq 'SCALAR' ) {
3382 $cust_credit->reasonnum( $$reason );
3384 $cust_credit->reasonnum( $reason->reasonnum );
3388 $cust_credit->set('reason', $reason)
3391 for (qw( addlinfo eventnum )) {
3392 $cust_credit->$_( delete $options{$_} )
3393 if exists($options{$_});
3396 $cust_credit->insert(%options);
3400 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3402 Creates a one-time charge for this customer. If there is an error, returns
3403 the error, otherwise returns false.
3405 New-style, with a hashref of options:
3407 my $error = $cust_main->charge(
3411 'start_date' => str2time('7/4/2009'),
3412 'pkg' => 'Description',
3413 'comment' => 'Comment',
3414 'additional' => [], #extra invoice detail
3415 'classnum' => 1, #pkg_class
3417 'setuptax' => '', # or 'Y' for tax exempt
3420 'taxclass' => 'Tax class',
3423 'taxproduct' => 2, #part_pkg_taxproduct
3424 'override' => {}, #XXX describe
3426 #will be filled in with the new object
3427 'cust_pkg_ref' => \$cust_pkg,
3429 #generate an invoice immediately
3431 'invoice_terms' => '', #with these terms
3437 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3443 my ( $amount, $quantity, $start_date, $classnum );
3444 my ( $pkg, $comment, $additional );
3445 my ( $setuptax, $taxclass ); #internal taxes
3446 my ( $taxproduct, $override ); #vendor (CCH) taxes
3448 my $cust_pkg_ref = '';
3449 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3450 if ( ref( $_[0] ) ) {
3451 $amount = $_[0]->{amount};
3452 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3453 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3454 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3455 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3456 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3457 : '$'. sprintf("%.2f",$amount);
3458 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3459 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3460 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3461 $additional = $_[0]->{additional} || [];
3462 $taxproduct = $_[0]->{taxproductnum};
3463 $override = { '' => $_[0]->{tax_override} };
3464 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3465 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3466 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3471 $pkg = @_ ? shift : 'One-time charge';
3472 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3474 $taxclass = @_ ? shift : '';
3478 local $SIG{HUP} = 'IGNORE';
3479 local $SIG{INT} = 'IGNORE';
3480 local $SIG{QUIT} = 'IGNORE';
3481 local $SIG{TERM} = 'IGNORE';
3482 local $SIG{TSTP} = 'IGNORE';
3483 local $SIG{PIPE} = 'IGNORE';
3485 my $oldAutoCommit = $FS::UID::AutoCommit;
3486 local $FS::UID::AutoCommit = 0;
3489 my $part_pkg = new FS::part_pkg ( {
3491 'comment' => $comment,
3495 'classnum' => ( $classnum ? $classnum : '' ),
3496 'setuptax' => $setuptax,
3497 'taxclass' => $taxclass,
3498 'taxproductnum' => $taxproduct,
3501 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3502 ( 0 .. @$additional - 1 )
3504 'additional_count' => scalar(@$additional),
3505 'setup_fee' => $amount,
3508 my $error = $part_pkg->insert( options => \%options,
3509 tax_overrides => $override,
3512 $dbh->rollback if $oldAutoCommit;
3516 my $pkgpart = $part_pkg->pkgpart;
3517 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3518 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3519 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3520 $error = $type_pkgs->insert;
3522 $dbh->rollback if $oldAutoCommit;
3527 my $cust_pkg = new FS::cust_pkg ( {
3528 'custnum' => $self->custnum,
3529 'pkgpart' => $pkgpart,
3530 'quantity' => $quantity,
3531 'start_date' => $start_date,
3532 'no_auto' => $no_auto,
3535 $error = $cust_pkg->insert;
3537 $dbh->rollback if $oldAutoCommit;
3539 } elsif ( $cust_pkg_ref ) {
3540 ${$cust_pkg_ref} = $cust_pkg;
3544 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3545 'pkg_list' => [ $cust_pkg ],
3548 $dbh->rollback if $oldAutoCommit;
3553 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3558 #=item charge_postal_fee
3560 #Applies a one time charge this customer. If there is an error,
3561 #returns the error, returns the cust_pkg charge object or false
3562 #if there was no charge.
3566 # This should be a customer event. For that to work requires that bill
3567 # also be a customer event.
3569 sub charge_postal_fee {
3572 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3573 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3575 my $cust_pkg = new FS::cust_pkg ( {
3576 'custnum' => $self->custnum,
3577 'pkgpart' => $pkgpart,
3581 my $error = $cust_pkg->insert;
3582 $error ? $error : $cust_pkg;
3585 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3587 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3589 Optionally, a list or hashref of additional arguments to the qsearch call can
3596 my $opt = ref($_[0]) ? shift : { @_ };
3598 #return $self->num_cust_bill unless wantarray || keys %$opt;
3600 $opt->{'table'} = 'cust_bill';
3601 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3602 $opt->{'hashref'}{'custnum'} = $self->custnum;
3603 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3605 map { $_ } #behavior of sort undefined in scalar context
3606 sort { $a->_date <=> $b->_date }
3610 =item open_cust_bill
3612 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3617 sub open_cust_bill {
3621 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3627 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3629 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3633 sub legacy_cust_bill {
3636 #return $self->num_legacy_cust_bill unless wantarray;
3638 map { $_ } #behavior of sort undefined in scalar context
3639 sort { $a->_date <=> $b->_date }
3640 qsearch({ 'table' => 'legacy_cust_bill',
3641 'hashref' => { 'custnum' => $self->custnum, },
3642 'order_by' => 'ORDER BY _date ASC',
3646 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3648 Returns all the statements (see L<FS::cust_statement>) for this customer.
3650 Optionally, a list or hashref of additional arguments to the qsearch call can
3655 sub cust_statement {
3657 my $opt = ref($_[0]) ? shift : { @_ };
3659 #return $self->num_cust_statement unless wantarray || keys %$opt;
3661 $opt->{'table'} = 'cust_statement';
3662 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3663 $opt->{'hashref'}{'custnum'} = $self->custnum;
3664 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3666 map { $_ } #behavior of sort undefined in scalar context
3667 sort { $a->_date <=> $b->_date }
3671 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3673 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3675 Optionally, a list or hashref of additional arguments to the qsearch call can
3676 be passed following the SVCDB.
3683 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3684 warn "$me svc_x requires a svcdb";
3687 my $opt = ref($_[0]) ? shift : { @_ };
3689 $opt->{'table'} = $svcdb;
3690 $opt->{'addl_from'} =
3691 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3692 ($opt->{'addl_from'} || '');
3694 my $custnum = $self->custnum;
3695 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3696 my $where = "cust_pkg.custnum = $custnum";
3698 my $extra_sql = $opt->{'extra_sql'} || '';
3699 if ( keys %{ $opt->{'hashref'} } ) {
3700 $extra_sql = " AND $where $extra_sql";
3703 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3704 $extra_sql = "WHERE $where AND $1";
3707 $extra_sql = "WHERE $where $extra_sql";
3710 $opt->{'extra_sql'} = $extra_sql;
3715 # required for use as an eventtable;
3718 $self->svc_x('svc_acct', @_);
3723 Returns all the credits (see L<FS::cust_credit>) for this customer.
3729 map { $_ } #return $self->num_cust_credit unless wantarray;
3730 sort { $a->_date <=> $b->_date }
3731 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3734 =item cust_credit_pkgnum
3736 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3737 package when using experimental package balances.
3741 sub cust_credit_pkgnum {
3742 my( $self, $pkgnum ) = @_;
3743 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3744 sort { $a->_date <=> $b->_date }
3745 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3746 'pkgnum' => $pkgnum,
3753 Returns all the payments (see L<FS::cust_pay>) for this customer.
3759 return $self->num_cust_pay unless wantarray;
3760 sort { $a->_date <=> $b->_date }
3761 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3766 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3767 called automatically when the cust_pay method is used in a scalar context.
3773 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3774 my $sth = dbh->prepare($sql) or die dbh->errstr;
3775 $sth->execute($self->custnum) or die $sth->errstr;
3776 $sth->fetchrow_arrayref->[0];
3779 =item cust_pay_pkgnum
3781 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3782 package when using experimental package balances.
3786 sub cust_pay_pkgnum {
3787 my( $self, $pkgnum ) = @_;
3788 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3789 sort { $a->_date <=> $b->_date }
3790 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3791 'pkgnum' => $pkgnum,
3798 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3804 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3805 sort { $a->_date <=> $b->_date }
3806 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3809 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3811 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3813 Optionally, a list or hashref of additional arguments to the qsearch call can
3818 sub cust_pay_batch {
3820 my $opt = ref($_[0]) ? shift : { @_ };
3822 #return $self->num_cust_statement unless wantarray || keys %$opt;
3824 $opt->{'table'} = 'cust_pay_batch';
3825 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3826 $opt->{'hashref'}{'custnum'} = $self->custnum;
3827 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3829 map { $_ } #behavior of sort undefined in scalar context
3830 sort { $a->paybatchnum <=> $b->paybatchnum }
3834 =item cust_pay_pending
3836 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3837 (without status "done").
3841 sub cust_pay_pending {
3843 return $self->num_cust_pay_pending unless wantarray;
3844 sort { $a->_date <=> $b->_date }
3845 qsearch( 'cust_pay_pending', {
3846 'custnum' => $self->custnum,
3847 'status' => { op=>'!=', value=>'done' },
3852 =item cust_pay_pending_attempt
3854 Returns all payment attempts / declined payments for this customer, as pending
3855 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3856 a corresponding payment (see L<FS::cust_pay>).
3860 sub cust_pay_pending_attempt {
3862 return $self->num_cust_pay_pending_attempt unless wantarray;
3863 sort { $a->_date <=> $b->_date }
3864 qsearch( 'cust_pay_pending', {
3865 'custnum' => $self->custnum,
3872 =item num_cust_pay_pending
3874 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3875 customer (without status "done"). Also called automatically when the
3876 cust_pay_pending method is used in a scalar context.
3880 sub num_cust_pay_pending {
3883 " SELECT COUNT(*) FROM cust_pay_pending ".
3884 " WHERE custnum = ? AND status != 'done' ",
3889 =item num_cust_pay_pending_attempt
3891 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3892 customer, with status "done" but without a corresp. Also called automatically when the
3893 cust_pay_pending method is used in a scalar context.
3897 sub num_cust_pay_pending_attempt {
3900 " SELECT COUNT(*) FROM cust_pay_pending ".
3901 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3908 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3914 map { $_ } #return $self->num_cust_refund unless wantarray;
3915 sort { $a->_date <=> $b->_date }
3916 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3919 =item display_custnum
3921 Returns the displayed customer number for this customer: agent_custid if
3922 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3926 sub display_custnum {
3928 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3929 return $self->agent_custid;
3930 } elsif ( $conf->config('cust_main-custnum-display_prefix') ) {
3931 return $conf->config('cust_main-custnum-display_prefix').
3932 sprintf('%08d', $self->custnum)
3934 return $self->custnum;
3940 Returns a name string for this customer, either "Company (Last, First)" or
3947 my $name = $self->contact;
3948 $name = $self->company. " ($name)" if $self->company;
3954 Returns a name string for this (service/shipping) contact, either
3955 "Company (Last, First)" or "Last, First".
3961 if ( $self->get('ship_last') ) {
3962 my $name = $self->ship_contact;
3963 $name = $self->ship_company. " ($name)" if $self->ship_company;
3972 Returns a name string for this customer, either "Company" or "First Last".
3978 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3981 =item ship_name_short
3983 Returns a name string for this (service/shipping) contact, either "Company"
3988 sub ship_name_short {
3990 if ( $self->get('ship_last') ) {
3991 $self->ship_company !~ /^\s*$/
3992 ? $self->ship_company
3993 : $self->ship_contact_firstlast;
3995 $self->name_company_or_firstlast;
4001 Returns this customer's full (billing) contact name only, "Last, First"
4007 $self->get('last'). ', '. $self->first;
4012 Returns this customer's full (shipping) contact name only, "Last, First"
4018 $self->get('ship_last')
4019 ? $self->get('ship_last'). ', '. $self->ship_first
4023 =item contact_firstlast
4025 Returns this customers full (billing) contact name only, "First Last".
4029 sub contact_firstlast {
4031 $self->first. ' '. $self->get('last');
4034 =item ship_contact_firstlast
4036 Returns this customer's full (shipping) contact name only, "First Last".
4040 sub ship_contact_firstlast {
4042 $self->get('ship_last')
4043 ? $self->first. ' '. $self->get('ship_last')
4044 : $self->contact_firstlast;
4049 Returns this customer's full country name
4055 code2country($self->country);
4058 =item geocode DATA_VENDOR
4060 Returns a value for the customer location as encoded by DATA_VENDOR.
4061 Currently this only makes sense for "CCH" as DATA_VENDOR.
4069 Returns a status string for this customer, currently:
4073 =item prospect - No packages have ever been ordered
4075 =item ordered - Recurring packages all are new (not yet billed).
4077 =item active - One or more recurring packages is active
4079 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4081 =item suspended - All non-cancelled recurring packages are suspended
4083 =item cancelled - All recurring packages are cancelled
4087 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4088 cust_main-status_module configuration option.
4092 sub status { shift->cust_status(@_); }
4096 for my $status ( FS::cust_main->statuses() ) {
4097 my $method = $status.'_sql';
4098 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4099 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4100 $sth->execute( ($self->custnum) x $numnum )
4101 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4102 return $status if $sth->fetchrow_arrayref->[0];
4106 =item ucfirst_cust_status
4108 =item ucfirst_status
4110 Returns the status with the first character capitalized.
4114 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4116 sub ucfirst_cust_status {
4118 ucfirst($self->cust_status);
4123 Returns a hex triplet color string for this customer's status.
4127 sub statuscolor { shift->cust_statuscolor(@_); }
4129 sub cust_statuscolor {
4131 __PACKAGE__->statuscolors->{$self->cust_status};
4136 Returns an array of hashes representing the customer's RT tickets.
4143 my $num = $conf->config('cust_main-max_tickets') || 10;
4146 if ( $conf->config('ticket_system') ) {
4147 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4149 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4153 foreach my $priority (
4154 $conf->config('ticket_system-custom_priority_field-values'), ''
4156 last if scalar(@tickets) >= $num;
4158 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4159 $num - scalar(@tickets),
4169 # Return services representing svc_accts in customer support packages
4170 sub support_services {
4172 my %packages = map { $_ => 1 } $conf->config('support_packages');
4174 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4175 grep { $_->part_svc->svcdb eq 'svc_acct' }
4176 map { $_->cust_svc }
4177 grep { exists $packages{ $_->pkgpart } }
4178 $self->ncancelled_pkgs;
4182 # Return a list of latitude/longitude for one of the services (if any)
4183 sub service_coordinates {
4187 grep { $_->latitude && $_->longitude }
4189 map { $_->cust_svc }
4190 $self->ncancelled_pkgs;
4192 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4197 Returns a masked version of the named field
4202 my ($self,$field) = @_;
4206 'x'x(length($self->getfield($field))-4).
4207 substr($self->getfield($field), (length($self->getfield($field))-4));
4213 =head1 CLASS METHODS
4219 Class method that returns the list of possible status strings for customers
4220 (see L<the status method|/status>). For example:
4222 @statuses = FS::cust_main->statuses();
4228 keys %{ $self->statuscolors };
4231 =item cust_status_sql
4233 Returns an SQL fragment to determine the status of a cust_main record, as a
4238 sub cust_status_sql {
4240 for my $status ( FS::cust_main->statuses() ) {
4241 my $method = $status.'_sql';
4242 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4251 Returns an SQL expression identifying prospective cust_main records (customers
4252 with no packages ever ordered)
4256 use vars qw($select_count_pkgs);
4257 $select_count_pkgs =
4258 "SELECT COUNT(*) FROM cust_pkg
4259 WHERE cust_pkg.custnum = cust_main.custnum";
4261 sub select_count_pkgs_sql {
4266 " 0 = ( $select_count_pkgs ) ";
4271 Returns an SQL expression identifying ordered cust_main records (customers with
4272 no active packages, but recurring packages not yet setup or one time charges
4278 FS::cust_main->none_active_sql.
4279 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4284 Returns an SQL expression identifying active cust_main records (customers with
4285 active recurring packages).
4290 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4293 =item none_active_sql
4295 Returns an SQL expression identifying cust_main records with no active
4296 recurring packages. This includes customers of status prospect, ordered,
4297 inactive, and suspended.
4301 sub none_active_sql {
4302 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4307 Returns an SQL expression identifying inactive cust_main records (customers with
4308 no active recurring packages, but otherwise unsuspended/uncancelled).
4313 FS::cust_main->none_active_sql.
4314 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4320 Returns an SQL expression identifying suspended cust_main records.
4325 sub suspended_sql { susp_sql(@_); }
4327 FS::cust_main->none_active_sql.
4328 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4334 Returns an SQL expression identifying cancelled cust_main records.
4338 sub cancel_sql { shift->cancelled_sql(@_); }
4341 =item uncancelled_sql
4343 Returns an SQL expression identifying un-cancelled cust_main records.
4347 sub uncancelled_sql { uncancel_sql(@_); }
4348 sub uncancel_sql { "
4349 ( 0 < ( $select_count_pkgs
4350 AND ( cust_pkg.cancel IS NULL
4351 OR cust_pkg.cancel = 0
4354 OR 0 = ( $select_count_pkgs )
4360 Returns an SQL fragment to retreive the balance.
4365 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4366 WHERE cust_bill.custnum = cust_main.custnum )
4367 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4368 WHERE cust_pay.custnum = cust_main.custnum )
4369 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4370 WHERE cust_credit.custnum = cust_main.custnum )
4371 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4372 WHERE cust_refund.custnum = cust_main.custnum )
4375 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4377 Returns an SQL fragment to retreive the balance for this customer, optionally
4378 considering invoices with date earlier than START_TIME, and not
4379 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4380 total_unapplied_payments).
4382 Times are specified as SQL fragments or numeric
4383 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4384 L<Date::Parse> for conversion functions. The empty string can be passed
4385 to disable that time constraint completely.
4387 Available options are:
4391 =item unapplied_date
4393 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)
4398 set to true to remove all customer comparison clauses, for totals
4403 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4408 JOIN clause (typically used with the total option)
4412 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4413 time will be ignored. Note that START_TIME and END_TIME only limit the date
4414 range for invoices and I<unapplied> payments, credits, and refunds.
4420 sub balance_date_sql {
4421 my( $class, $start, $end, %opt ) = @_;
4423 my $cutoff = $opt{'cutoff'};
4425 my $owed = FS::cust_bill->owed_sql($cutoff);
4426 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4427 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4428 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4430 my $j = $opt{'join'} || '';
4432 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4433 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4434 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4435 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4437 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4438 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4439 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4440 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4445 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4447 Returns an SQL fragment to retreive the total unapplied payments for this
4448 customer, only considering payments with date earlier than START_TIME, and
4449 optionally not later than END_TIME.
4451 Times are specified as SQL fragments or numeric
4452 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4453 L<Date::Parse> for conversion functions. The empty string can be passed
4454 to disable that time constraint completely.
4456 Available options are:
4460 sub unapplied_payments_date_sql {
4461 my( $class, $start, $end, %opt ) = @_;
4463 my $cutoff = $opt{'cutoff'};
4465 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4467 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4468 'unapplied_date'=>1 );
4470 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4473 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4475 Helper method for balance_date_sql; name (and usage) subject to change
4476 (suggestions welcome).
4478 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4479 cust_refund, cust_credit or cust_pay).
4481 If TABLE is "cust_bill" or the unapplied_date option is true, only
4482 considers records with date earlier than START_TIME, and optionally not
4483 later than END_TIME .
4487 sub _money_table_where {
4488 my( $class, $table, $start, $end, %opt ) = @_;
4491 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4492 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4493 push @where, "$table._date <= $start" if defined($start) && length($start);
4494 push @where, "$table._date > $end" if defined($end) && length($end);
4496 push @where, @{$opt{'where'}} if $opt{'where'};
4497 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4503 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4504 use FS::cust_main::Search;
4507 FS::cust_main::Search->search(@_);
4522 #warn join('-',keys %$param);
4523 my $fh = $param->{filehandle};
4524 my $agentnum = $param->{agentnum};
4525 my $format = $param->{format};
4527 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4530 if ( $format eq 'simple' ) {
4531 @fields = qw( custnum agent_custid amount pkg );
4533 die "unknown format $format";
4536 eval "use Text::CSV_XS;";
4539 my $csv = new Text::CSV_XS;
4546 local $SIG{HUP} = 'IGNORE';
4547 local $SIG{INT} = 'IGNORE';
4548 local $SIG{QUIT} = 'IGNORE';
4549 local $SIG{TERM} = 'IGNORE';
4550 local $SIG{TSTP} = 'IGNORE';
4551 local $SIG{PIPE} = 'IGNORE';
4553 my $oldAutoCommit = $FS::UID::AutoCommit;
4554 local $FS::UID::AutoCommit = 0;
4557 #while ( $columns = $csv->getline($fh) ) {
4559 while ( defined($line=<$fh>) ) {
4561 $csv->parse($line) or do {
4562 $dbh->rollback if $oldAutoCommit;
4563 return "can't parse: ". $csv->error_input();
4566 my @columns = $csv->fields();
4567 #warn join('-',@columns);
4570 foreach my $field ( @fields ) {
4571 $row{$field} = shift @columns;
4574 if ( $row{custnum} && $row{agent_custid} ) {
4575 dbh->rollback if $oldAutoCommit;
4576 return "can't specify custnum with agent_custid $row{agent_custid}";
4580 if ( $row{agent_custid} && $agentnum ) {
4581 %hash = ( 'agent_custid' => $row{agent_custid},
4582 'agentnum' => $agentnum,
4586 if ( $row{custnum} ) {
4587 %hash = ( 'custnum' => $row{custnum} );
4590 unless ( scalar(keys %hash) ) {
4591 $dbh->rollback if $oldAutoCommit;
4592 return "can't find customer without custnum or agent_custid and agentnum";
4595 my $cust_main = qsearchs('cust_main', { %hash } );
4596 unless ( $cust_main ) {
4597 $dbh->rollback if $oldAutoCommit;
4598 my $custnum = $row{custnum} || $row{agent_custid};
4599 return "unknown custnum $custnum";
4602 if ( $row{'amount'} > 0 ) {
4603 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4605 $dbh->rollback if $oldAutoCommit;
4609 } elsif ( $row{'amount'} < 0 ) {
4610 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4613 $dbh->rollback if $oldAutoCommit;
4623 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4625 return "Empty file!" unless $imported;
4631 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4633 Deprecated. Use event notification and message templates
4634 (L<FS::msg_template>) instead.
4636 Sends a templated email notification to the customer (see L<Text::Template>).
4638 OPTIONS is a hash and may include
4640 I<from> - the email sender (default is invoice_from)
4642 I<to> - comma-separated scalar or arrayref of recipients
4643 (default is invoicing_list)
4645 I<subject> - The subject line of the sent email notification
4646 (default is "Notice from company_name")
4648 I<extra_fields> - a hashref of name/value pairs which will be substituted
4651 The following variables are vavailable in the template.
4653 I<$first> - the customer first name
4654 I<$last> - the customer last name
4655 I<$company> - the customer company
4656 I<$payby> - a description of the method of payment for the customer
4657 # would be nice to use FS::payby::shortname
4658 I<$payinfo> - the account information used to collect for this customer
4659 I<$expdate> - the expiration of the customer payment in seconds from epoch
4664 my ($self, $template, %options) = @_;
4666 return unless $conf->exists($template);
4668 my $from = $conf->config('invoice_from', $self->agentnum)
4669 if $conf->exists('invoice_from', $self->agentnum);
4670 $from = $options{from} if exists($options{from});
4672 my $to = join(',', $self->invoicing_list_emailonly);
4673 $to = $options{to} if exists($options{to});
4675 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4676 if $conf->exists('company_name', $self->agentnum);
4677 $subject = $options{subject} if exists($options{subject});
4679 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4680 SOURCE => [ map "$_\n",
4681 $conf->config($template)]
4683 or die "can't create new Text::Template object: Text::Template::ERROR";
4684 $notify_template->compile()
4685 or die "can't compile template: Text::Template::ERROR";
4687 $FS::notify_template::_template::company_name =
4688 $conf->config('company_name', $self->agentnum);
4689 $FS::notify_template::_template::company_address =
4690 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4692 my $paydate = $self->paydate || '2037-12-31';
4693 $FS::notify_template::_template::first = $self->first;
4694 $FS::notify_template::_template::last = $self->last;
4695 $FS::notify_template::_template::company = $self->company;
4696 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4697 my $payby = $self->payby;
4698 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4699 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4701 #credit cards expire at the end of the month/year of their exp date
4702 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4703 $FS::notify_template::_template::payby = 'credit card';
4704 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4705 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4707 }elsif ($payby eq 'COMP') {
4708 $FS::notify_template::_template::payby = 'complimentary account';
4710 $FS::notify_template::_template::payby = 'current method';
4712 $FS::notify_template::_template::expdate = $expire_time;
4714 for (keys %{$options{extra_fields}}){
4716 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4719 send_email(from => $from,
4721 subject => $subject,
4722 body => $notify_template->fill_in( PACKAGE =>
4723 'FS::notify_template::_template' ),
4728 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4730 Generates a templated notification to the customer (see L<Text::Template>).
4732 OPTIONS is a hash and may include
4734 I<extra_fields> - a hashref of name/value pairs which will be substituted
4735 into the template. These values may override values mentioned below
4736 and those from the customer record.
4738 The following variables are available in the template instead of or in addition
4739 to the fields of the customer record.
4741 I<$payby> - a description of the method of payment for the customer
4742 # would be nice to use FS::payby::shortname
4743 I<$payinfo> - the masked account information used to collect for this customer
4744 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4745 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4749 # a lot like cust_bill::print_latex
4750 sub generate_letter {
4751 my ($self, $template, %options) = @_;
4753 return unless $conf->exists($template);
4755 my $letter_template = new Text::Template
4757 SOURCE => [ map "$_\n", $conf->config($template)],
4758 DELIMITERS => [ '[@--', '--@]' ],
4760 or die "can't create new Text::Template object: Text::Template::ERROR";
4762 $letter_template->compile()
4763 or die "can't compile template: Text::Template::ERROR";
4765 my %letter_data = map { $_ => $self->$_ } $self->fields;
4766 $letter_data{payinfo} = $self->mask_payinfo;
4768 #my $paydate = $self->paydate || '2037-12-31';
4769 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4771 my $payby = $self->payby;
4772 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4773 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4775 #credit cards expire at the end of the month/year of their exp date
4776 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4777 $letter_data{payby} = 'credit card';
4778 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4779 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4781 }elsif ($payby eq 'COMP') {
4782 $letter_data{payby} = 'complimentary account';
4784 $letter_data{payby} = 'current method';
4786 $letter_data{expdate} = $expire_time;
4788 for (keys %{$options{extra_fields}}){
4789 $letter_data{$_} = $options{extra_fields}->{$_};
4792 unless(exists($letter_data{returnaddress})){
4793 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4794 $self->agent_template)
4796 if ( length($retadd) ) {
4797 $letter_data{returnaddress} = $retadd;
4798 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4799 $letter_data{returnaddress} =
4800 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4804 ( $conf->config('company_name', $self->agentnum),
4805 $conf->config('company_address', $self->agentnum),
4809 $letter_data{returnaddress} = '~';
4813 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4815 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4817 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4819 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4823 ) or die "can't open temp file: $!\n";
4824 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4825 or die "can't write temp file: $!\n";
4827 $letter_data{'logo_file'} = $lh->filename;
4829 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4833 ) or die "can't open temp file: $!\n";
4835 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4837 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4838 return ($1, $letter_data{'logo_file'});
4842 =item print_ps TEMPLATE
4844 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4850 my($file, $lfile) = $self->generate_letter(@_);
4851 my $ps = FS::Misc::generate_ps($file);
4852 unlink($file.'.tex');
4858 =item print TEMPLATE
4860 Prints the filled in template.
4862 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4866 sub queueable_print {
4869 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4870 or die "invalid customer number: " . $opt{custvnum};
4872 my $error = $self->print( $opt{template} );
4873 die $error if $error;
4877 my ($self, $template) = (shift, shift);
4878 do_print [ $self->print_ps($template) ];
4881 #these three subs should just go away once agent stuff is all config overrides
4883 sub agent_template {
4885 $self->_agent_plandata('agent_templatename');
4888 sub agent_invoice_from {
4890 $self->_agent_plandata('agent_invoice_from');
4893 sub _agent_plandata {
4894 my( $self, $option ) = @_;
4896 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4897 #agent-specific Conf
4899 use FS::part_event::Condition;
4901 my $agentnum = $self->agentnum;
4903 my $regexp = regexp_sql();
4905 my $part_event_option =
4907 'select' => 'part_event_option.*',
4908 'table' => 'part_event_option',
4910 LEFT JOIN part_event USING ( eventpart )
4911 LEFT JOIN part_event_option AS peo_agentnum
4912 ON ( part_event.eventpart = peo_agentnum.eventpart
4913 AND peo_agentnum.optionname = 'agentnum'
4914 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4916 LEFT JOIN part_event_condition
4917 ON ( part_event.eventpart = part_event_condition.eventpart
4918 AND part_event_condition.conditionname = 'cust_bill_age'
4920 LEFT JOIN part_event_condition_option
4921 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4922 AND part_event_condition_option.optionname = 'age'
4925 #'hashref' => { 'optionname' => $option },
4926 #'hashref' => { 'part_event_option.optionname' => $option },
4928 " WHERE part_event_option.optionname = ". dbh->quote($option).
4929 " AND action = 'cust_bill_send_agent' ".
4930 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4931 " AND peo_agentnum.optionname = 'agentnum' ".
4932 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4934 CASE WHEN part_event_condition_option.optionname IS NULL
4936 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4938 , part_event.weight".
4942 unless ( $part_event_option ) {
4943 return $self->agent->invoice_template || ''
4944 if $option eq 'agent_templatename';
4948 $part_event_option->optionvalue;
4952 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4954 Subroutine (not a method), designed to be called from the queue.
4956 Takes a list of options and values.
4958 Pulls up the customer record via the custnum option and calls bill_and_collect.
4963 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4965 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4966 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4968 $cust_main->bill_and_collect( %args );
4971 sub process_bill_and_collect {
4973 my $param = thaw(decode_base64(shift));
4974 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4975 or die "custnum '$param->{custnum}' not found!\n";
4976 $param->{'job'} = $job;
4977 $param->{'fatal'} = 1; # runs from job queue, will be caught
4978 $param->{'retry'} = 1;
4980 $cust_main->bill_and_collect( %$param );
4983 =item process_censustract_update CUSTNUM
4985 Queueable function to update the census tract to the current year (as set in
4986 the 'census_year' configuration variable) and retrieve the new tract code.
4990 sub process_censustract_update {
4991 eval "use FS::Misc::Geo qw(get_censustract)";
4993 my $custnum = shift;
4994 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
4995 or die "custnum '$custnum' not found!\n";
4997 my $new_year = $conf->config('census_year') or return;
4998 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
4999 if ( $new_tract =~ /^\d/ ) {
5000 # then it's a tract code
5001 $cust_main->set('censustract', $new_tract);
5002 $cust_main->set('censusyear', $new_year);
5003 my $error = $cust_main->replace;
5004 die $error if $error;
5007 # it's an error message
5013 sub _upgrade_data { #class method
5014 my ($class, %opts) = @_;
5017 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5018 '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',
5020 # fix yyyy-m-dd formatted paydates
5021 if ( driver_name =~ /^mysql$/i ) {
5023 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5025 else { # the SQL standard
5027 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5030 foreach my $sql ( @statements ) {
5031 my $sth = dbh->prepare($sql) or die dbh->errstr;
5032 $sth->execute or die $sth->errstr;
5035 local($ignore_expired_card) = 1;
5036 local($ignore_illegal_zip) = 1;
5037 local($ignore_banned_card) = 1;
5038 local($skip_fuzzyfiles) = 1;
5039 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5040 $class->_upgrade_otaker(%opts);
5050 The delete method should possibly take an FS::cust_main object reference
5051 instead of a scalar customer number.
5053 Bill and collect options should probably be passed as references instead of a
5056 There should probably be a configuration file with a list of allowed credit
5059 No multiple currency support (probably a larger project than just this module).
5061 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5063 Birthdates rely on negative epoch values.
5065 The payby for card/check batches is broken. With mixed batching, bad
5068 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5072 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5073 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5074 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.