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->auto_agent_custid()
469 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
471 my $error = $self->SUPER::insert;
473 $dbh->rollback if $oldAutoCommit;
474 #return "inserting cust_main record (transaction rolled back): $error";
478 warn " setting invoicing list\n"
481 if ( $invoicing_list ) {
482 $error = $self->check_invoicing_list( $invoicing_list );
484 $dbh->rollback if $oldAutoCommit;
485 #return "checking invoicing_list (transaction rolled back): $error";
488 $self->invoicing_list( $invoicing_list );
491 warn " setting customer tags\n"
494 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
495 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
496 'custnum' => $self->custnum };
497 my $error = $cust_tag->insert;
499 $dbh->rollback if $oldAutoCommit;
504 my $prospectnum = delete $options{'prospectnum'};
505 if ( $prospectnum ) {
507 warn " moving contacts and locations from prospect $prospectnum\n"
511 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
512 unless ( $prospect_main ) {
513 $dbh->rollback if $oldAutoCommit;
514 return "Unknown prospectnum $prospectnum";
516 $prospect_main->custnum($self->custnum);
517 $prospect_main->disabled('Y');
518 my $error = $prospect_main->replace;
520 $dbh->rollback if $oldAutoCommit;
524 my @contact = $prospect_main->contact;
525 my @cust_location = $prospect_main->cust_location;
526 my @qual = $prospect_main->qual;
528 foreach my $r ( @contact, @cust_location, @qual ) {
530 $r->custnum($self->custnum);
531 my $error = $r->replace;
533 $dbh->rollback if $oldAutoCommit;
540 warn " setting cust_main_exemption\n"
543 my $tax_exemption = delete $options{'tax_exemption'};
544 if ( $tax_exemption ) {
545 foreach my $taxname ( @$tax_exemption ) {
546 my $cust_main_exemption = new FS::cust_main_exemption {
547 'custnum' => $self->custnum,
548 'taxname' => $taxname,
550 my $error = $cust_main_exemption->insert;
552 $dbh->rollback if $oldAutoCommit;
553 return "inserting cust_main_exemption (transaction rolled back): $error";
558 if ( $self->can('start_copy_skel') ) {
559 my $error = $self->start_copy_skel;
561 $dbh->rollback if $oldAutoCommit;
566 warn " ordering packages\n"
569 $error = $self->order_pkgs( $cust_pkgs,
571 'seconds_ref' => \$seconds,
572 'upbytes_ref' => \$upbytes,
573 'downbytes_ref' => \$downbytes,
574 'totalbytes_ref' => \$totalbytes,
577 $dbh->rollback if $oldAutoCommit;
582 $dbh->rollback if $oldAutoCommit;
583 return "No svc_acct record to apply pre-paid time";
585 if ( $upbytes || $downbytes || $totalbytes ) {
586 $dbh->rollback if $oldAutoCommit;
587 return "No svc_acct record to apply pre-paid data";
591 warn " inserting initial $payby payment of $amount\n"
593 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
595 $dbh->rollback if $oldAutoCommit;
596 return "inserting payment (transaction rolled back): $error";
600 unless ( $import || $skip_fuzzyfiles ) {
601 warn " queueing fuzzyfiles update\n"
603 $error = $self->queue_fuzzyfiles_update;
605 $dbh->rollback if $oldAutoCommit;
606 return "updating fuzzy search cache: $error";
611 warn " exporting\n" if $DEBUG > 1;
613 my $export_args = $options{'export_args'} || [];
616 map qsearch( 'part_export', {exportnum=>$_} ),
617 $conf->config('cust_main-exports'); #, $agentnum
619 foreach my $part_export ( @part_export ) {
620 my $error = $part_export->export_insert($self, @$export_args);
622 $dbh->rollback if $oldAutoCommit;
623 return "exporting to ". $part_export->exporttype.
624 " (transaction rolled back): $error";
628 #foreach my $depend_jobnum ( @$depend_jobnums ) {
629 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
631 # foreach my $jobnum ( @jobnums ) {
632 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
633 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
635 # my $error = $queue->depend_insert($depend_jobnum);
637 # $dbh->rollback if $oldAutoCommit;
638 # return "error queuing job dependancy: $error";
645 #if ( exists $options{'jobnums'} ) {
646 # push @{ $options{'jobnums'} }, @jobnums;
649 warn " insert complete; committing transaction\n"
652 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
657 use File::CounterFile;
658 sub auto_agent_custid {
661 my $format = $conf->config('cust_main-auto_agent_custid');
663 if ( $format eq '1YMMXXXXXXXX' ) {
665 my $counter = new File::CounterFile 'cust_main.agent_custid';
668 my $ym = 100000000000 + time2str('%y%m00000000', time);
669 if ( $ym > $counter->value ) {
670 $counter->{'value'} = $agent_custid = $ym;
671 $counter->{'updated'} = 1;
673 $agent_custid = $counter->inc;
679 die "Unknown cust_main-auto_agent_custid format: $format";
682 $self->agent_custid($agent_custid);
686 =item PACKAGE METHODS
688 Documentation on customer package methods has been moved to
689 L<FS::cust_main::Packages>.
691 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
693 Recharges this (existing) customer with the specified prepaid card (see
694 L<FS::prepay_credit>), specified either by I<identifier> or as an
695 FS::prepay_credit object. If there is an error, returns the error, otherwise
698 Optionally, five scalar references can be passed as well. They will have their
699 values filled in with the amount, number of seconds, and number of upload,
700 download, and total bytes applied by this prepaid card.
704 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
705 #the only place that uses these args
706 sub recharge_prepay {
707 my( $self, $prepay_credit, $amountref, $secondsref,
708 $upbytesref, $downbytesref, $totalbytesref ) = @_;
710 local $SIG{HUP} = 'IGNORE';
711 local $SIG{INT} = 'IGNORE';
712 local $SIG{QUIT} = 'IGNORE';
713 local $SIG{TERM} = 'IGNORE';
714 local $SIG{TSTP} = 'IGNORE';
715 local $SIG{PIPE} = 'IGNORE';
717 my $oldAutoCommit = $FS::UID::AutoCommit;
718 local $FS::UID::AutoCommit = 0;
721 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
723 my $error = $self->get_prepay( $prepay_credit,
724 'amount_ref' => \$amount,
725 'seconds_ref' => \$seconds,
726 'upbytes_ref' => \$upbytes,
727 'downbytes_ref' => \$downbytes,
728 'totalbytes_ref' => \$totalbytes,
730 || $self->increment_seconds($seconds)
731 || $self->increment_upbytes($upbytes)
732 || $self->increment_downbytes($downbytes)
733 || $self->increment_totalbytes($totalbytes)
734 || $self->insert_cust_pay_prepay( $amount,
736 ? $prepay_credit->identifier
741 $dbh->rollback if $oldAutoCommit;
745 if ( defined($amountref) ) { $$amountref = $amount; }
746 if ( defined($secondsref) ) { $$secondsref = $seconds; }
747 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
748 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
749 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
751 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
756 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
758 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
759 specified either by I<identifier> or as an FS::prepay_credit object.
761 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
762 incremented by the values of the prepaid card.
764 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
765 check or set this customer's I<agentnum>.
767 If there is an error, returns the error, otherwise returns false.
773 my( $self, $prepay_credit, %opt ) = @_;
775 local $SIG{HUP} = 'IGNORE';
776 local $SIG{INT} = 'IGNORE';
777 local $SIG{QUIT} = 'IGNORE';
778 local $SIG{TERM} = 'IGNORE';
779 local $SIG{TSTP} = 'IGNORE';
780 local $SIG{PIPE} = 'IGNORE';
782 my $oldAutoCommit = $FS::UID::AutoCommit;
783 local $FS::UID::AutoCommit = 0;
786 unless ( ref($prepay_credit) ) {
788 my $identifier = $prepay_credit;
790 $prepay_credit = qsearchs(
792 { 'identifier' => $identifier },
797 unless ( $prepay_credit ) {
798 $dbh->rollback if $oldAutoCommit;
799 return "Invalid prepaid card: ". $identifier;
804 if ( $prepay_credit->agentnum ) {
805 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
806 $dbh->rollback if $oldAutoCommit;
807 return "prepaid card not valid for agent ". $self->agentnum;
809 $self->agentnum($prepay_credit->agentnum);
812 my $error = $prepay_credit->delete;
814 $dbh->rollback if $oldAutoCommit;
815 return "removing prepay_credit (transaction rolled back): $error";
818 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
819 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
821 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
826 =item increment_upbytes SECONDS
828 Updates this customer's single or primary account (see L<FS::svc_acct>) by
829 the specified number of upbytes. If there is an error, returns the error,
830 otherwise returns false.
834 sub increment_upbytes {
835 _increment_column( shift, 'upbytes', @_);
838 =item increment_downbytes SECONDS
840 Updates this customer's single or primary account (see L<FS::svc_acct>) by
841 the specified number of downbytes. If there is an error, returns the error,
842 otherwise returns false.
846 sub increment_downbytes {
847 _increment_column( shift, 'downbytes', @_);
850 =item increment_totalbytes SECONDS
852 Updates this customer's single or primary account (see L<FS::svc_acct>) by
853 the specified number of totalbytes. If there is an error, returns the error,
854 otherwise returns false.
858 sub increment_totalbytes {
859 _increment_column( shift, 'totalbytes', @_);
862 =item increment_seconds SECONDS
864 Updates this customer's single or primary account (see L<FS::svc_acct>) by
865 the specified number of seconds. If there is an error, returns the error,
866 otherwise returns false.
870 sub increment_seconds {
871 _increment_column( shift, 'seconds', @_);
874 =item _increment_column AMOUNT
876 Updates this customer's single or primary account (see L<FS::svc_acct>) by
877 the specified number of seconds or bytes. If there is an error, returns
878 the error, otherwise returns false.
882 sub _increment_column {
883 my( $self, $column, $amount ) = @_;
884 warn "$me increment_column called: $column, $amount\n"
887 return '' unless $amount;
889 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
890 $self->ncancelled_pkgs;
893 return 'No packages with primary or single services found'.
894 ' to apply pre-paid time';
895 } elsif ( scalar(@cust_pkg) > 1 ) {
896 #maybe have a way to specify the package/account?
897 return 'Multiple packages found to apply pre-paid time';
900 my $cust_pkg = $cust_pkg[0];
901 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
905 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
908 return 'No account found to apply pre-paid time';
909 } elsif ( scalar(@cust_svc) > 1 ) {
910 return 'Multiple accounts found to apply pre-paid time';
913 my $svc_acct = $cust_svc[0]->svc_x;
914 warn " found service svcnum ". $svc_acct->pkgnum.
915 ' ('. $svc_acct->email. ")\n"
918 $column = "increment_$column";
919 $svc_acct->$column($amount);
923 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
925 Inserts a prepayment in the specified amount for this customer. An optional
926 second argument can specify the prepayment identifier for tracking purposes.
927 If there is an error, returns the error, otherwise returns false.
931 sub insert_cust_pay_prepay {
932 shift->insert_cust_pay('PREP', @_);
935 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
937 Inserts a cash payment in the specified amount for this customer. An optional
938 second argument can specify the payment identifier for tracking purposes.
939 If there is an error, returns the error, otherwise returns false.
943 sub insert_cust_pay_cash {
944 shift->insert_cust_pay('CASH', @_);
947 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
949 Inserts a Western Union payment in the specified amount for this customer. An
950 optional second argument can specify the prepayment identifier for tracking
951 purposes. If there is an error, returns the error, otherwise returns false.
955 sub insert_cust_pay_west {
956 shift->insert_cust_pay('WEST', @_);
959 sub insert_cust_pay {
960 my( $self, $payby, $amount ) = splice(@_, 0, 3);
961 my $payinfo = scalar(@_) ? shift : '';
963 my $cust_pay = new FS::cust_pay {
964 'custnum' => $self->custnum,
965 'paid' => sprintf('%.2f', $amount),
966 #'_date' => #date the prepaid card was purchased???
968 'payinfo' => $payinfo,
976 This method is deprecated. See the I<depend_jobnum> option to the insert and
977 order_pkgs methods for a better way to defer provisioning.
979 Re-schedules all exports by calling the B<reexport> method of all associated
980 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
981 otherwise returns false.
988 carp "WARNING: FS::cust_main::reexport is deprectated; ".
989 "use the depend_jobnum option to insert or order_pkgs to delay export";
991 local $SIG{HUP} = 'IGNORE';
992 local $SIG{INT} = 'IGNORE';
993 local $SIG{QUIT} = 'IGNORE';
994 local $SIG{TERM} = 'IGNORE';
995 local $SIG{TSTP} = 'IGNORE';
996 local $SIG{PIPE} = 'IGNORE';
998 my $oldAutoCommit = $FS::UID::AutoCommit;
999 local $FS::UID::AutoCommit = 0;
1002 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1003 my $error = $cust_pkg->reexport;
1005 $dbh->rollback if $oldAutoCommit;
1010 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1015 =item delete [ OPTION => VALUE ... ]
1017 This deletes the customer. If there is an error, returns the error, otherwise
1020 This will completely remove all traces of the customer record. This is not
1021 what you want when a customer cancels service; for that, cancel all of the
1022 customer's packages (see L</cancel>).
1024 If the customer has any uncancelled packages, you need to pass a new (valid)
1025 customer number for those packages to be transferred to, as the "new_customer"
1026 option. Cancelled packages will be deleted. Did I mention that this is NOT
1027 what you want when a customer cancels service and that you really should be
1028 looking at L<FS::cust_pkg/cancel>?
1030 You can't delete a customer with invoices (see L<FS::cust_bill>),
1031 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1032 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1033 set the "delete_financials" option to a true value.
1038 my( $self, %opt ) = @_;
1040 local $SIG{HUP} = 'IGNORE';
1041 local $SIG{INT} = 'IGNORE';
1042 local $SIG{QUIT} = 'IGNORE';
1043 local $SIG{TERM} = 'IGNORE';
1044 local $SIG{TSTP} = 'IGNORE';
1045 local $SIG{PIPE} = 'IGNORE';
1047 my $oldAutoCommit = $FS::UID::AutoCommit;
1048 local $FS::UID::AutoCommit = 0;
1051 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1052 $dbh->rollback if $oldAutoCommit;
1053 return "Can't delete a master agent customer";
1056 #use FS::access_user
1057 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1058 $dbh->rollback if $oldAutoCommit;
1059 return "Can't delete a master employee customer";
1062 tie my %financial_tables, 'Tie::IxHash',
1063 'cust_bill' => 'invoices',
1064 'cust_statement' => 'statements',
1065 'cust_credit' => 'credits',
1066 'cust_pay' => 'payments',
1067 'cust_refund' => 'refunds',
1070 foreach my $table ( keys %financial_tables ) {
1072 my @records = $self->$table();
1074 if ( @records && ! $opt{'delete_financials'} ) {
1075 $dbh->rollback if $oldAutoCommit;
1076 return "Can't delete a customer with ". $financial_tables{$table};
1079 foreach my $record ( @records ) {
1080 my $error = $record->delete;
1082 $dbh->rollback if $oldAutoCommit;
1083 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1089 my @cust_pkg = $self->ncancelled_pkgs;
1091 my $new_custnum = $opt{'new_custnum'};
1092 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1093 $dbh->rollback if $oldAutoCommit;
1094 return "Invalid new customer number: $new_custnum";
1096 foreach my $cust_pkg ( @cust_pkg ) {
1097 my %hash = $cust_pkg->hash;
1098 $hash{'custnum'} = $new_custnum;
1099 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1100 my $error = $new_cust_pkg->replace($cust_pkg,
1101 options => { $cust_pkg->options },
1104 $dbh->rollback if $oldAutoCommit;
1109 my @cancelled_cust_pkg = $self->all_pkgs;
1110 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1111 my $error = $cust_pkg->delete;
1113 $dbh->rollback if $oldAutoCommit;
1118 #cust_tax_adjustment in financials?
1119 #cust_pay_pending? ouch
1121 foreach my $table (qw(
1122 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1123 cust_location cust_main_note cust_tax_adjustment
1124 cust_pay_void cust_pay_batch queue cust_tax_exempt
1126 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1127 my $error = $record->delete;
1129 $dbh->rollback if $oldAutoCommit;
1135 my $sth = $dbh->prepare(
1136 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1138 my $errstr = $dbh->errstr;
1139 $dbh->rollback if $oldAutoCommit;
1142 $sth->execute($self->custnum) or do {
1143 my $errstr = $sth->errstr;
1144 $dbh->rollback if $oldAutoCommit;
1150 my $ticket_dbh = '';
1151 if ($conf->config('ticket_system') eq 'RT_Internal') {
1153 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1154 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1155 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1156 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1159 if ( $ticket_dbh ) {
1161 my $ticket_sth = $ticket_dbh->prepare(
1162 'DELETE FROM Links WHERE Target = ?'
1164 my $errstr = $ticket_dbh->errstr;
1165 $dbh->rollback if $oldAutoCommit;
1168 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1170 my $errstr = $ticket_sth->errstr;
1171 $dbh->rollback if $oldAutoCommit;
1175 #check and see if the customer is the only link on the ticket, and
1176 #if so, set the ticket to deleted status in RT?
1177 #maybe someday, for now this will at least fix tickets not displaying
1181 #delete the customer record
1183 my $error = $self->SUPER::delete;
1185 $dbh->rollback if $oldAutoCommit;
1189 # cust_main exports!
1191 #my $export_args = $options{'export_args'} || [];
1194 map qsearch( 'part_export', {exportnum=>$_} ),
1195 $conf->config('cust_main-exports'); #, $agentnum
1197 foreach my $part_export ( @part_export ) {
1198 my $error = $part_export->export_delete( $self ); #, @$export_args);
1200 $dbh->rollback if $oldAutoCommit;
1201 return "exporting to ". $part_export->exporttype.
1202 " (transaction rolled back): $error";
1206 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1211 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1213 This merges this customer into the provided new custnum, and then deletes the
1214 customer. If there is an error, returns the error, otherwise returns false.
1216 The source customer's name, company name, phone numbers, agent,
1217 referring customer, customer class, advertising source, order taker, and
1218 billing information (except balance) are discarded.
1220 All packages are moved to the target customer. Packages with package locations
1221 are preserved. Packages without package locations are moved to a new package
1222 location with the source customer's service/shipping address.
1224 All invoices, statements, payments, credits and refunds are moved to the target
1225 customer. The source customer's balance is added to the target customer.
1227 All notes, attachments, tickets and customer tags are moved to the target
1230 Change history is not currently moved.
1235 my( $self, $new_custnum, %opt ) = @_;
1237 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1239 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1240 return "Invalid new customer number: $new_custnum";
1243 local $SIG{HUP} = 'IGNORE';
1244 local $SIG{INT} = 'IGNORE';
1245 local $SIG{QUIT} = 'IGNORE';
1246 local $SIG{TERM} = 'IGNORE';
1247 local $SIG{TSTP} = 'IGNORE';
1248 local $SIG{PIPE} = 'IGNORE';
1250 my $oldAutoCommit = $FS::UID::AutoCommit;
1251 local $FS::UID::AutoCommit = 0;
1254 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1255 $dbh->rollback if $oldAutoCommit;
1256 return "Can't merge a master agent customer";
1259 #use FS::access_user
1260 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1261 $dbh->rollback if $oldAutoCommit;
1262 return "Can't merge a master employee customer";
1265 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1266 'status' => { op=>'!=', value=>'done' },
1270 $dbh->rollback if $oldAutoCommit;
1271 return "Can't merge a customer with pending payments";
1274 tie my %financial_tables, 'Tie::IxHash',
1275 'cust_bill' => 'invoices',
1276 'cust_statement' => 'statements',
1277 'cust_credit' => 'credits',
1278 'cust_pay' => 'payments',
1279 'cust_pay_void' => 'voided payments',
1280 'cust_refund' => 'refunds',
1283 foreach my $table ( keys %financial_tables ) {
1285 my @records = $self->$table();
1287 foreach my $record ( @records ) {
1288 $record->custnum($new_custnum);
1289 my $error = $record->replace;
1291 $dbh->rollback if $oldAutoCommit;
1292 return "Error merging ". $financial_tables{$table}. ": $error\n";
1298 my $name = $self->ship_name;
1300 my $locationnum = '';
1301 foreach my $cust_pkg ( $self->all_pkgs ) {
1302 $cust_pkg->custnum($new_custnum);
1304 unless ( $cust_pkg->locationnum ) {
1305 unless ( $locationnum ) {
1306 my $cust_location = new FS::cust_location {
1307 $self->location_hash,
1308 'custnum' => $new_custnum,
1310 my $error = $cust_location->insert;
1312 $dbh->rollback if $oldAutoCommit;
1315 $locationnum = $cust_location->locationnum;
1317 $cust_pkg->locationnum($locationnum);
1320 my $error = $cust_pkg->replace;
1322 $dbh->rollback if $oldAutoCommit;
1326 # add customer (ship) name to svc_phone.phone_name if blank
1327 my @cust_svc = $cust_pkg->cust_svc;
1328 foreach my $cust_svc (@cust_svc) {
1329 my($label, $value, $svcdb) = $cust_svc->label;
1330 next unless $svcdb eq 'svc_phone';
1331 my $svc_phone = $cust_svc->svc_x;
1332 next if $svc_phone->phone_name;
1333 $svc_phone->phone_name($name);
1334 my $error = $svc_phone->replace;
1336 $dbh->rollback if $oldAutoCommit;
1344 # cust_tax_exempt (texas tax exemptions)
1345 # cust_recon (some sort of not-well understood thing for OnPac)
1347 #these are moved over
1348 foreach my $table (qw(
1349 cust_tag cust_location contact cust_attachment cust_main_note
1350 cust_tax_adjustment cust_pay_batch queue
1352 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1353 $record->custnum($new_custnum);
1354 my $error = $record->replace;
1356 $dbh->rollback if $oldAutoCommit;
1362 #these aren't preserved
1363 foreach my $table (qw(
1364 cust_main_exemption cust_main_invoice
1366 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1367 my $error = $record->delete;
1369 $dbh->rollback if $oldAutoCommit;
1376 my $sth = $dbh->prepare(
1377 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1379 my $errstr = $dbh->errstr;
1380 $dbh->rollback if $oldAutoCommit;
1383 $sth->execute($new_custnum, $self->custnum) or do {
1384 my $errstr = $sth->errstr;
1385 $dbh->rollback if $oldAutoCommit;
1391 my $ticket_dbh = '';
1392 if ($conf->config('ticket_system') eq 'RT_Internal') {
1394 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1395 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1396 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1397 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1400 if ( $ticket_dbh ) {
1402 my $ticket_sth = $ticket_dbh->prepare(
1403 'UPDATE Links SET Target = ? WHERE Target = ?'
1405 my $errstr = $ticket_dbh->errstr;
1406 $dbh->rollback if $oldAutoCommit;
1409 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1410 'freeside://freeside/cust_main/'.$self->custnum)
1412 my $errstr = $ticket_sth->errstr;
1413 $dbh->rollback if $oldAutoCommit;
1419 #delete the customer record
1421 my $error = $self->delete;
1423 $dbh->rollback if $oldAutoCommit;
1427 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1432 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1435 Replaces the OLD_RECORD with this one in the database. If there is an error,
1436 returns the error, otherwise returns false.
1438 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1439 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1440 expected and rollback the entire transaction; it is not necessary to call
1441 check_invoicing_list first. Here's an example:
1443 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1445 Currently available options are: I<tax_exemption>.
1447 The I<tax_exemption> option can be set to an arrayref of tax names.
1448 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1455 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1457 : $self->replace_old;
1461 warn "$me replace called\n"
1464 my $curuser = $FS::CurrentUser::CurrentUser;
1465 if ( $self->payby eq 'COMP'
1466 && $self->payby ne $old->payby
1467 && ! $curuser->access_right('Complimentary customer')
1470 return "You are not permitted to create complimentary accounts.";
1473 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1474 && $conf->exists('enable_taxproducts')
1477 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1479 $self->set('geocode', '')
1480 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1481 && length($self->get($pre.'zip')) >= 10;
1484 for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1486 $self->set($pre.'coord_auto', '') && next
1487 if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1488 && ( $self->get($pre.'latitude') != $old->get($pre.'latitude')
1489 || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1492 $self->set_coord($pre)
1493 if $old->get($pre.'address1') ne $self->get($pre.'address1')
1494 || $old->get($pre.'city') ne $self->get($pre.'city')
1495 || $old->get($pre.'state') ne $self->get($pre.'state')
1496 || $old->get($pre.'country') ne $self->get($pre.'country');
1501 if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1503 $self->set_coord('ship_')
1504 if $self->has_ship_address && ! $self->ship_coord_auto
1505 && ! $self->ship_latitude && ! $self->ship_longitude;
1507 local($ignore_expired_card) = 1
1508 if $old->payby =~ /^(CARD|DCRD)$/
1509 && $self->payby =~ /^(CARD|DCRD)$/
1510 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1512 local($ignore_banned_card) = 1
1513 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1514 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1515 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1517 local $SIG{HUP} = 'IGNORE';
1518 local $SIG{INT} = 'IGNORE';
1519 local $SIG{QUIT} = 'IGNORE';
1520 local $SIG{TERM} = 'IGNORE';
1521 local $SIG{TSTP} = 'IGNORE';
1522 local $SIG{PIPE} = 'IGNORE';
1524 my $oldAutoCommit = $FS::UID::AutoCommit;
1525 local $FS::UID::AutoCommit = 0;
1528 my $error = $self->SUPER::replace($old);
1531 $dbh->rollback if $oldAutoCommit;
1535 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1536 my $invoicing_list = shift @param;
1537 $error = $self->check_invoicing_list( $invoicing_list );
1539 $dbh->rollback if $oldAutoCommit;
1542 $self->invoicing_list( $invoicing_list );
1545 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1547 #this could be more efficient than deleting and re-inserting, if it matters
1548 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1549 my $error = $cust_tag->delete;
1551 $dbh->rollback if $oldAutoCommit;
1555 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1556 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1557 'custnum' => $self->custnum };
1558 my $error = $cust_tag->insert;
1560 $dbh->rollback if $oldAutoCommit;
1567 my %options = @param;
1569 my $tax_exemption = delete $options{'tax_exemption'};
1570 if ( $tax_exemption ) {
1572 my %cust_main_exemption =
1573 map { $_->taxname => $_ }
1574 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1576 foreach my $taxname ( @$tax_exemption ) {
1578 next if delete $cust_main_exemption{$taxname};
1580 my $cust_main_exemption = new FS::cust_main_exemption {
1581 'custnum' => $self->custnum,
1582 'taxname' => $taxname,
1584 my $error = $cust_main_exemption->insert;
1586 $dbh->rollback if $oldAutoCommit;
1587 return "inserting cust_main_exemption (transaction rolled back): $error";
1591 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1592 my $error = $cust_main_exemption->delete;
1594 $dbh->rollback if $oldAutoCommit;
1595 return "deleting cust_main_exemption (transaction rolled back): $error";
1601 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1602 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1603 && $self->get('payinfo') !~ /^99\d{14}$/
1605 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1610 # card/check/lec info has changed, want to retry realtime_ invoice events
1611 my $error = $self->retry_realtime;
1613 $dbh->rollback if $oldAutoCommit;
1618 unless ( $import || $skip_fuzzyfiles ) {
1619 $error = $self->queue_fuzzyfiles_update;
1621 $dbh->rollback if $oldAutoCommit;
1622 return "updating fuzzy search cache: $error";
1626 # cust_main exports!
1628 my $export_args = $options{'export_args'} || [];
1631 map qsearch( 'part_export', {exportnum=>$_} ),
1632 $conf->config('cust_main-exports'); #, $agentnum
1634 foreach my $part_export ( @part_export ) {
1635 my $error = $part_export->export_replace( $self, $old, @$export_args);
1637 $dbh->rollback if $oldAutoCommit;
1638 return "exporting to ". $part_export->exporttype.
1639 " (transaction rolled back): $error";
1643 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1648 =item queue_fuzzyfiles_update
1650 Used by insert & replace to update the fuzzy search cache
1654 use FS::cust_main::Search;
1655 sub queue_fuzzyfiles_update {
1658 local $SIG{HUP} = 'IGNORE';
1659 local $SIG{INT} = 'IGNORE';
1660 local $SIG{QUIT} = 'IGNORE';
1661 local $SIG{TERM} = 'IGNORE';
1662 local $SIG{TSTP} = 'IGNORE';
1663 local $SIG{PIPE} = 'IGNORE';
1665 my $oldAutoCommit = $FS::UID::AutoCommit;
1666 local $FS::UID::AutoCommit = 0;
1669 my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1670 my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1672 $dbh->rollback if $oldAutoCommit;
1673 return "queueing job (transaction rolled back): $error";
1676 if ( $self->ship_last ) {
1677 $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1678 $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1680 $dbh->rollback if $oldAutoCommit;
1681 return "queueing job (transaction rolled back): $error";
1685 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1692 Checks all fields to make sure this is a valid customer record. If there is
1693 an error, returns the error, otherwise returns false. Called by the insert
1694 and replace methods.
1701 warn "$me check BEFORE: \n". $self->_dump
1705 $self->ut_numbern('custnum')
1706 || $self->ut_number('agentnum')
1707 || $self->ut_textn('agent_custid')
1708 || $self->ut_number('refnum')
1709 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1710 || $self->ut_textn('custbatch')
1711 || $self->ut_name('last')
1712 || $self->ut_name('first')
1713 || $self->ut_snumbern('birthdate')
1714 || $self->ut_snumbern('signupdate')
1715 || $self->ut_textn('company')
1716 || $self->ut_text('address1')
1717 || $self->ut_textn('address2')
1718 || $self->ut_text('city')
1719 || $self->ut_textn('county')
1720 || $self->ut_textn('state')
1721 || $self->ut_country('country')
1722 || $self->ut_coordn('latitude')
1723 || $self->ut_coordn('longitude')
1724 || $self->ut_enum('coord_auto', [ '', 'Y' ])
1725 || $self->ut_anything('comments')
1726 || $self->ut_numbern('referral_custnum')
1727 || $self->ut_textn('stateid')
1728 || $self->ut_textn('stateid_state')
1729 || $self->ut_textn('invoice_terms')
1730 || $self->ut_alphan('geocode')
1731 || $self->ut_floatn('cdr_termination_percentage')
1732 || $self->ut_floatn('credit_limit')
1733 || $self->ut_numbern('billday')
1734 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1735 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1736 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1740 unless $import || ($self->latitude && $self->longitude);
1742 #barf. need message catalogs. i18n. etc.
1743 $error .= "Please select an advertising source."
1744 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1745 return $error if $error;
1747 return "Unknown agent"
1748 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1750 return "Unknown refnum"
1751 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1753 return "Unknown referring custnum: ". $self->referral_custnum
1754 unless ! $self->referral_custnum
1755 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1757 if ( $self->censustract ne '' ) {
1758 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1759 or return "Illegal census tract: ". $self->censustract;
1761 $self->censustract("$1.$2");
1764 if ( $self->ss eq '' ) {
1769 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1770 or return "Illegal social security number: ". $self->ss;
1771 $self->ss("$1-$2-$3");
1775 # bad idea to disable, causes billing to fail because of no tax rates later
1776 # except we don't fail any more
1777 unless ( $import ) {
1778 unless ( qsearch('cust_main_county', {
1779 'country' => $self->country,
1782 return "Unknown state/county/country: ".
1783 $self->state. "/". $self->county. "/". $self->country
1784 unless qsearch('cust_main_county',{
1785 'state' => $self->state,
1786 'county' => $self->county,
1787 'country' => $self->country,
1793 $self->ut_phonen('daytime', $self->country)
1794 || $self->ut_phonen('night', $self->country)
1795 || $self->ut_phonen('fax', $self->country)
1796 || $self->ut_phonen('mobile', $self->country)
1798 return $error if $error;
1800 unless ( $ignore_illegal_zip ) {
1801 $error = $self->ut_zip('zip', $self->country);
1802 return $error if $error;
1805 if ( $conf->exists('cust_main-require_phone')
1806 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1809 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1811 : FS::Msgcat::_gettext('daytime');
1812 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1814 : FS::Msgcat::_gettext('night');
1816 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1818 : FS::Msgcat::_gettext('mobile');
1820 return "$daytime_label, $night_label or $mobile_label is required"
1824 if ( $self->has_ship_address
1825 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1826 $self->addr_fields )
1830 $self->ut_name('ship_last')
1831 || $self->ut_name('ship_first')
1832 || $self->ut_textn('ship_company')
1833 || $self->ut_text('ship_address1')
1834 || $self->ut_textn('ship_address2')
1835 || $self->ut_text('ship_city')
1836 || $self->ut_textn('ship_county')
1837 || $self->ut_textn('ship_state')
1838 || $self->ut_country('ship_country')
1839 || $self->ut_coordn('ship_latitude')
1840 || $self->ut_coordn('ship_longitude')
1841 || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1843 return $error if $error;
1845 $self->set_coord('ship_')
1846 unless $import || ($self->ship_latitude && $self->ship_longitude);
1848 #false laziness with above
1849 unless ( qsearchs('cust_main_county', {
1850 'country' => $self->ship_country,
1853 return "Unknown ship_state/ship_county/ship_country: ".
1854 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1855 unless qsearch('cust_main_county',{
1856 'state' => $self->ship_state,
1857 'county' => $self->ship_county,
1858 'country' => $self->ship_country,
1864 $self->ut_phonen('ship_daytime', $self->ship_country)
1865 || $self->ut_phonen('ship_night', $self->ship_country)
1866 || $self->ut_phonen('ship_fax', $self->ship_country)
1867 || $self->ut_phonen('ship_mobile', $self->ship_country)
1869 return $error if $error;
1871 unless ( $ignore_illegal_zip ) {
1872 $error = $self->ut_zip('ship_zip', $self->ship_country);
1873 return $error if $error;
1875 return "Unit # is required."
1876 if $self->ship_address2 =~ /^\s*$/
1877 && $conf->exists('cust_main-require_address2');
1879 } else { # ship_ info eq billing info, so don't store dup info in database
1881 $self->setfield("ship_$_", '')
1882 foreach $self->addr_fields;
1884 return "Unit # is required."
1885 if $self->address2 =~ /^\s*$/
1886 && $conf->exists('cust_main-require_address2');
1890 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1891 # or return "Illegal payby: ". $self->payby;
1893 FS::payby->can_payby($self->table, $self->payby)
1894 or return "Illegal payby: ". $self->payby;
1896 $error = $self->ut_numbern('paystart_month')
1897 || $self->ut_numbern('paystart_year')
1898 || $self->ut_numbern('payissue')
1899 || $self->ut_textn('paytype')
1901 return $error if $error;
1903 if ( $self->payip eq '' ) {
1906 $error = $self->ut_ip('payip');
1907 return $error if $error;
1910 # If it is encrypted and the private key is not availaible then we can't
1911 # check the credit card.
1912 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1914 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1916 my $payinfo = $self->payinfo;
1917 $payinfo =~ s/\D//g;
1918 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1919 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1921 $self->payinfo($payinfo);
1923 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1925 return gettext('unknown_card_type')
1926 if $self->payinfo !~ /^99\d{14}$/ #token
1927 && cardtype($self->payinfo) eq "Unknown";
1929 unless ( $ignore_banned_card ) {
1930 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1932 if ( $ban->bantype eq 'warn' ) {
1933 #or others depending on value of $ban->reason ?
1934 return '_duplicate_card'.
1935 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1936 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1937 ' (ban# '. $ban->bannum. ')'
1938 unless $self->override_ban_warn;
1940 return 'Banned credit card: banned on '.
1941 time2str('%a %h %o at %r', $ban->_date).
1942 ' by '. $ban->otaker.
1943 ' (ban# '. $ban->bannum. ')';
1948 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1949 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1950 $self->paycvv =~ /^(\d{4})$/
1951 or return "CVV2 (CID) for American Express cards is four digits.";
1954 $self->paycvv =~ /^(\d{3})$/
1955 or return "CVV2 (CVC2/CID) is three digits.";
1962 my $cardtype = cardtype($payinfo);
1963 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1965 return "Start date or issue number is required for $cardtype cards"
1966 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1968 return "Start month must be between 1 and 12"
1969 if $self->paystart_month
1970 and $self->paystart_month < 1 || $self->paystart_month > 12;
1972 return "Start year must be 1990 or later"
1973 if $self->paystart_year
1974 and $self->paystart_year < 1990;
1976 return "Issue number must be beween 1 and 99"
1978 and $self->payissue < 1 || $self->payissue > 99;
1981 $self->paystart_month('');
1982 $self->paystart_year('');
1983 $self->payissue('');
1986 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1988 my $payinfo = $self->payinfo;
1989 $payinfo =~ s/[^\d\@\.]//g;
1990 if ( $conf->exists('cust_main-require-bank-branch') ) {
1991 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
1992 $payinfo = "$1\@$2.$3";
1993 } elsif ( $conf->exists('echeck-nonus') ) {
1994 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1995 $payinfo = "$1\@$2";
1997 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1998 $payinfo = "$1\@$2";
2000 $self->payinfo($payinfo);
2003 unless ( $ignore_banned_card ) {
2004 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2006 if ( $ban->bantype eq 'warn' ) {
2007 #or others depending on value of $ban->reason ?
2008 return '_duplicate_ach' unless $self->override_ban_warn;
2010 return 'Banned ACH account: banned on '.
2011 time2str('%a %h %o at %r', $ban->_date).
2012 ' by '. $ban->otaker.
2013 ' (ban# '. $ban->bannum. ')';
2018 } elsif ( $self->payby eq 'LECB' ) {
2020 my $payinfo = $self->payinfo;
2021 $payinfo =~ s/\D//g;
2022 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2024 $self->payinfo($payinfo);
2027 } elsif ( $self->payby eq 'BILL' ) {
2029 $error = $self->ut_textn('payinfo');
2030 return "Illegal P.O. number: ". $self->payinfo if $error;
2033 } elsif ( $self->payby eq 'COMP' ) {
2035 my $curuser = $FS::CurrentUser::CurrentUser;
2036 if ( ! $self->custnum
2037 && ! $curuser->access_right('Complimentary customer')
2040 return "You are not permitted to create complimentary accounts."
2043 $error = $self->ut_textn('payinfo');
2044 return "Illegal comp account issuer: ". $self->payinfo if $error;
2047 } elsif ( $self->payby eq 'PREPAY' ) {
2049 my $payinfo = $self->payinfo;
2050 $payinfo =~ s/\W//g; #anything else would just confuse things
2051 $self->payinfo($payinfo);
2052 $error = $self->ut_alpha('payinfo');
2053 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2054 return "Unknown prepayment identifier"
2055 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2060 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2061 return "Expiration date required"
2062 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2066 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2067 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2068 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2069 ( $m, $y ) = ( $2, "19$1" );
2070 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2071 ( $m, $y ) = ( $3, "20$2" );
2073 return "Illegal expiration date: ". $self->paydate;
2075 $m = sprintf('%02d',$m);
2076 $self->paydate("$y-$m-01");
2077 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2078 return gettext('expired_card')
2080 && !$ignore_expired_card
2081 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2084 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2085 ( ! $conf->exists('require_cardname')
2086 || $self->payby !~ /^(CARD|DCRD)$/ )
2088 $self->payname( $self->first. " ". $self->getfield('last') );
2090 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2091 or return gettext('illegal_name'). " payname: ". $self->payname;
2095 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2096 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2100 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2102 warn "$me check AFTER: \n". $self->_dump
2105 $self->SUPER::check;
2110 Returns a list of fields which have ship_ duplicates.
2115 qw( last first company
2116 address1 address2 city county state zip country
2118 daytime night fax mobile
2122 =item has_ship_address
2124 Returns true if this customer record has a separate shipping address.
2128 sub has_ship_address {
2130 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2135 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2136 city, county, state, zip, country, and geocode. The shipping address is used if present.
2142 Returns all locations (see L<FS::cust_location>) for this customer.
2148 qsearch('cust_location', { 'custnum' => $self->custnum } );
2153 Returns all contacts (see L<FS::contact>) for this customer.
2157 #already used :/ sub contact {
2160 qsearch('contact', { 'custnum' => $self->custnum } );
2165 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2166 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2167 on success or a list of errors.
2173 grep { $_->unsuspend } $self->suspended_pkgs;
2178 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2180 Returns a list: an empty list on success or a list of errors.
2186 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2189 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2191 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2192 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2193 of a list of pkgparts; the hashref has the following keys:
2197 =item pkgparts - listref of pkgparts
2199 =item (other options are passed to the suspend method)
2204 Returns a list: an empty list on success or a list of errors.
2208 sub suspend_if_pkgpart {
2210 my (@pkgparts, %opt);
2211 if (ref($_[0]) eq 'HASH'){
2212 @pkgparts = @{$_[0]{pkgparts}};
2217 grep { $_->suspend(%opt) }
2218 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2219 $self->unsuspended_pkgs;
2222 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2224 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2225 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2226 instead of a list of pkgparts; the hashref has the following keys:
2230 =item pkgparts - listref of pkgparts
2232 =item (other options are passed to the suspend method)
2236 Returns a list: an empty list on success or a list of errors.
2240 sub suspend_unless_pkgpart {
2242 my (@pkgparts, %opt);
2243 if (ref($_[0]) eq 'HASH'){
2244 @pkgparts = @{$_[0]{pkgparts}};
2249 grep { $_->suspend(%opt) }
2250 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2251 $self->unsuspended_pkgs;
2254 =item cancel [ OPTION => VALUE ... ]
2256 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2258 Available options are:
2262 =item quiet - can be set true to supress email cancellation notices.
2264 =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.
2266 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2268 =item nobill - can be set true to skip billing if it might otherwise be done.
2272 Always returns a list: an empty list on success or a list of errors.
2276 # nb that dates are not specified as valid options to this method
2279 my( $self, %opt ) = @_;
2281 warn "$me cancel called on customer ". $self->custnum. " with options ".
2282 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2285 return ( 'access denied' )
2286 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2288 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2290 #should try decryption (we might have the private key)
2291 # and if not maybe queue a job for the server that does?
2292 return ( "Can't (yet) ban encrypted credit cards" )
2293 if $self->is_encrypted($self->payinfo);
2295 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2296 my $error = $ban->insert;
2297 return ( $error ) if $error;
2301 my @pkgs = $self->ncancelled_pkgs;
2303 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2305 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2306 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2310 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2311 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2314 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2317 sub _banned_pay_hashref {
2328 'payby' => $payby2ban{$self->payby},
2329 'payinfo' => $self->payinfo,
2330 #don't ever *search* on reason! #'reason' =>
2334 sub _new_banned_pay_hashref {
2336 my $hr = $self->_banned_pay_hashref;
2337 $hr->{payinfo} = md5_base64($hr->{payinfo});
2343 Returns all notes (see L<FS::cust_main_note>) for this customer.
2348 my($self,$orderby_classnum) = (shift,shift);
2349 my $orderby = "_DATE DESC";
2350 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2351 qsearch( 'cust_main_note',
2352 { 'custnum' => $self->custnum },
2354 "ORDER BY $orderby",
2360 Returns the agent (see L<FS::agent>) for this customer.
2366 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2371 Returns the agent name (see L<FS::agent>) for this customer.
2377 $self->agent->agent;
2382 Returns any tags associated with this customer, as FS::cust_tag objects,
2383 or an empty list if there are no tags.
2389 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2394 Returns any tags associated with this customer, as FS::part_tag objects,
2395 or an empty list if there are no tags.
2401 map $_->part_tag, $self->cust_tag;
2407 Returns the customer class, as an FS::cust_class object, or the empty string
2408 if there is no customer class.
2414 if ( $self->classnum ) {
2415 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2423 Returns the customer category name, or the empty string if there is no customer
2430 my $cust_class = $self->cust_class;
2432 ? $cust_class->categoryname
2438 Returns the customer class name, or the empty string if there is no customer
2445 my $cust_class = $self->cust_class;
2447 ? $cust_class->classname
2451 =item BILLING METHODS
2453 Documentation on billing methods has been moved to
2454 L<FS::cust_main::Billing>.
2456 =item REALTIME BILLING METHODS
2458 Documentation on realtime billing methods has been moved to
2459 L<FS::cust_main::Billing_Realtime>.
2463 Removes the I<paycvv> field from the database directly.
2465 If there is an error, returns the error, otherwise returns false.
2471 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2472 or return dbh->errstr;
2473 $sth->execute($self->custnum)
2474 or return $sth->errstr;
2479 =item batch_card OPTION => VALUE...
2481 Adds a payment for this invoice to the pending credit card batch (see
2482 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2483 runs the payment using a realtime gateway.
2488 my ($self, %options) = @_;
2491 if (exists($options{amount})) {
2492 $amount = $options{amount};
2494 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2496 return '' unless $amount > 0;
2498 my $invnum = delete $options{invnum};
2499 my $payby = $options{payby} || $self->payby; #still dubious
2501 if ($options{'realtime'}) {
2502 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2508 my $oldAutoCommit = $FS::UID::AutoCommit;
2509 local $FS::UID::AutoCommit = 0;
2512 #this needs to handle mysql as well as Pg, like svc_acct.pm
2513 #(make it into a common function if folks need to do batching with mysql)
2514 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2515 or return "Cannot lock pay_batch: " . $dbh->errstr;
2519 'payby' => FS::payby->payby2payment($payby),
2521 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2523 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2525 unless ( $pay_batch ) {
2526 $pay_batch = new FS::pay_batch \%pay_batch;
2527 my $error = $pay_batch->insert;
2529 $dbh->rollback if $oldAutoCommit;
2530 die "error creating new batch: $error\n";
2534 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2535 'batchnum' => $pay_batch->batchnum,
2536 'custnum' => $self->custnum,
2539 foreach (qw( address1 address2 city state zip country latitude longitude
2540 payby payinfo paydate payname ))
2542 $options{$_} = '' unless exists($options{$_});
2545 my $cust_pay_batch = new FS::cust_pay_batch ( {
2546 'batchnum' => $pay_batch->batchnum,
2547 'invnum' => $invnum || 0, # is there a better value?
2548 # this field should be
2550 # cust_bill_pay_batch now
2551 'custnum' => $self->custnum,
2552 'last' => $self->getfield('last'),
2553 'first' => $self->getfield('first'),
2554 'address1' => $options{address1} || $self->address1,
2555 'address2' => $options{address2} || $self->address2,
2556 'city' => $options{city} || $self->city,
2557 'state' => $options{state} || $self->state,
2558 'zip' => $options{zip} || $self->zip,
2559 'country' => $options{country} || $self->country,
2560 'payby' => $options{payby} || $self->payby,
2561 'payinfo' => $options{payinfo} || $self->payinfo,
2562 'exp' => $options{paydate} || $self->paydate,
2563 'payname' => $options{payname} || $self->payname,
2564 'amount' => $amount, # consolidating
2567 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2568 if $old_cust_pay_batch;
2571 if ($old_cust_pay_batch) {
2572 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2574 $error = $cust_pay_batch->insert;
2578 $dbh->rollback if $oldAutoCommit;
2582 my $unapplied = $self->total_unapplied_credits
2583 + $self->total_unapplied_payments
2584 + $self->in_transit_payments;
2585 foreach my $cust_bill ($self->open_cust_bill) {
2586 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2587 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2588 'invnum' => $cust_bill->invnum,
2589 'paybatchnum' => $cust_pay_batch->paybatchnum,
2590 'amount' => $cust_bill->owed,
2593 if ($unapplied >= $cust_bill_pay_batch->amount){
2594 $unapplied -= $cust_bill_pay_batch->amount;
2597 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2598 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2600 $error = $cust_bill_pay_batch->insert;
2602 $dbh->rollback if $oldAutoCommit;
2607 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2613 Returns the total owed for this customer on all invoices
2614 (see L<FS::cust_bill/owed>).
2620 $self->total_owed_date(2145859200); #12/31/2037
2623 =item total_owed_date TIME
2625 Returns the total owed for this customer on all invoices with date earlier than
2626 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2627 see L<Time::Local> and L<Date::Parse> for conversion functions.
2631 sub total_owed_date {
2635 my $custnum = $self->custnum;
2637 my $owed_sql = FS::cust_bill->owed_sql;
2640 SELECT SUM($owed_sql) FROM cust_bill
2641 WHERE custnum = $custnum
2645 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2649 =item total_owed_pkgnum PKGNUM
2651 Returns the total owed on all invoices for this customer's specific package
2652 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2656 sub total_owed_pkgnum {
2657 my( $self, $pkgnum ) = @_;
2658 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2661 =item total_owed_date_pkgnum TIME PKGNUM
2663 Returns the total owed for this customer's specific package when using
2664 experimental package balances on all invoices with date earlier than
2665 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2666 see L<Time::Local> and L<Date::Parse> for conversion functions.
2670 sub total_owed_date_pkgnum {
2671 my( $self, $time, $pkgnum ) = @_;
2674 foreach my $cust_bill (
2675 grep { $_->_date <= $time }
2676 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2678 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2680 sprintf( "%.2f", $total_bill );
2686 Returns the total amount of all payments.
2693 $total += $_->paid foreach $self->cust_pay;
2694 sprintf( "%.2f", $total );
2697 =item total_unapplied_credits
2699 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2700 customer. See L<FS::cust_credit/credited>.
2702 =item total_credited
2704 Old name for total_unapplied_credits. Don't use.
2708 sub total_credited {
2709 #carp "total_credited deprecated, use total_unapplied_credits";
2710 shift->total_unapplied_credits(@_);
2713 sub total_unapplied_credits {
2716 my $custnum = $self->custnum;
2718 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2721 SELECT SUM($unapplied_sql) FROM cust_credit
2722 WHERE custnum = $custnum
2725 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2729 =item total_unapplied_credits_pkgnum PKGNUM
2731 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2732 customer. See L<FS::cust_credit/credited>.
2736 sub total_unapplied_credits_pkgnum {
2737 my( $self, $pkgnum ) = @_;
2738 my $total_credit = 0;
2739 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2740 sprintf( "%.2f", $total_credit );
2744 =item total_unapplied_payments
2746 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2747 See L<FS::cust_pay/unapplied>.
2751 sub total_unapplied_payments {
2754 my $custnum = $self->custnum;
2756 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2759 SELECT SUM($unapplied_sql) FROM cust_pay
2760 WHERE custnum = $custnum
2763 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2767 =item total_unapplied_payments_pkgnum PKGNUM
2769 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2770 specific package when using experimental package balances. See
2771 L<FS::cust_pay/unapplied>.
2775 sub total_unapplied_payments_pkgnum {
2776 my( $self, $pkgnum ) = @_;
2777 my $total_unapplied = 0;
2778 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2779 sprintf( "%.2f", $total_unapplied );
2783 =item total_unapplied_refunds
2785 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2786 customer. See L<FS::cust_refund/unapplied>.
2790 sub total_unapplied_refunds {
2792 my $custnum = $self->custnum;
2794 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2797 SELECT SUM($unapplied_sql) FROM cust_refund
2798 WHERE custnum = $custnum
2801 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2807 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2808 total_unapplied_credits minus total_unapplied_payments).
2814 $self->balance_date_range;
2817 =item balance_date TIME
2819 Returns the balance for this customer, only considering invoices with date
2820 earlier than TIME (total_owed_date minus total_credited minus
2821 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2822 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2829 $self->balance_date_range(shift);
2832 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2834 Returns the balance for this customer, optionally considering invoices with
2835 date earlier than START_TIME, and not later than END_TIME
2836 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2838 Times are specified as SQL fragments or numeric
2839 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2840 L<Date::Parse> for conversion functions. The empty string can be passed
2841 to disable that time constraint completely.
2843 Available options are:
2847 =item unapplied_date
2849 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)
2855 sub balance_date_range {
2857 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2858 ') FROM cust_main WHERE custnum='. $self->custnum;
2859 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2862 =item balance_pkgnum PKGNUM
2864 Returns the balance for this customer's specific package when using
2865 experimental package balances (total_owed plus total_unrefunded, minus
2866 total_unapplied_credits minus total_unapplied_payments)
2870 sub balance_pkgnum {
2871 my( $self, $pkgnum ) = @_;
2874 $self->total_owed_pkgnum($pkgnum)
2875 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2876 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2877 - $self->total_unapplied_credits_pkgnum($pkgnum)
2878 - $self->total_unapplied_payments_pkgnum($pkgnum)
2882 =item in_transit_payments
2884 Returns the total of requests for payments for this customer pending in
2885 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2889 sub in_transit_payments {
2891 my $in_transit_payments = 0;
2892 foreach my $pay_batch ( qsearch('pay_batch', {
2895 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2896 'batchnum' => $pay_batch->batchnum,
2897 'custnum' => $self->custnum,
2899 $in_transit_payments += $cust_pay_batch->amount;
2902 sprintf( "%.2f", $in_transit_payments );
2907 Returns a hash of useful information for making a payment.
2917 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2918 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2919 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2923 For credit card transactions:
2935 For electronic check transactions:
2950 $return{balance} = $self->balance;
2952 $return{payname} = $self->payname
2953 || ( $self->first. ' '. $self->get('last') );
2955 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2957 $return{payby} = $self->payby;
2958 $return{stateid_state} = $self->stateid_state;
2960 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2961 $return{card_type} = cardtype($self->payinfo);
2962 $return{payinfo} = $self->paymask;
2964 @return{'month', 'year'} = $self->paydate_monthyear;
2968 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2969 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2970 $return{payinfo1} = $payinfo1;
2971 $return{payinfo2} = $payinfo2;
2972 $return{paytype} = $self->paytype;
2973 $return{paystate} = $self->paystate;
2977 #doubleclick protection
2979 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2985 =item paydate_monthyear
2987 Returns a two-element list consisting of the month and year of this customer's
2988 paydate (credit card expiration date for CARD customers)
2992 sub paydate_monthyear {
2994 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2996 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3005 Returns the exact time in seconds corresponding to the payment method
3006 expiration date. For CARD/DCRD customers this is the end of the month;
3007 for others (COMP is the only other payby that uses paydate) it's the start.
3008 Returns 0 if the paydate is empty or set to the far future.
3014 my ($month, $year) = $self->paydate_monthyear;
3015 return 0 if !$year or $year >= 2037;
3016 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3018 if ( $month == 13 ) {
3022 return timelocal(0,0,0,1,$month-1,$year) - 1;
3025 return timelocal(0,0,0,1,$month-1,$year);
3029 =item paydate_epoch_sql
3031 Class method. Returns an SQL expression to obtain the payment expiration date
3032 as a number of seconds.
3036 # Special expiration date behavior for non-CARD/DCRD customers has been
3037 # carefully preserved. Do we really use that?
3038 sub paydate_epoch_sql {
3040 my $table = shift || 'cust_main';
3041 my ($case1, $case2);
3042 if ( driver_name eq 'Pg' ) {
3043 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3044 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3046 elsif ( lc(driver_name) eq 'mysql' ) {
3047 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3048 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3051 return "CASE WHEN $table.payby IN('CARD','DCRD')
3057 =item tax_exemption TAXNAME
3062 my( $self, $taxname ) = @_;
3064 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3065 'taxname' => $taxname,
3070 =item cust_main_exemption
3074 sub cust_main_exemption {
3076 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3079 =item invoicing_list [ ARRAYREF ]
3081 If an arguement is given, sets these email addresses as invoice recipients
3082 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3083 (except as warnings), so use check_invoicing_list first.
3085 Returns a list of email addresses (with svcnum entries expanded).
3087 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3088 check it without disturbing anything by passing nothing.
3090 This interface may change in the future.
3094 sub invoicing_list {
3095 my( $self, $arrayref ) = @_;
3098 my @cust_main_invoice;
3099 if ( $self->custnum ) {
3100 @cust_main_invoice =
3101 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3103 @cust_main_invoice = ();
3105 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3106 #warn $cust_main_invoice->destnum;
3107 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3108 #warn $cust_main_invoice->destnum;
3109 my $error = $cust_main_invoice->delete;
3110 warn $error if $error;
3113 if ( $self->custnum ) {
3114 @cust_main_invoice =
3115 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3117 @cust_main_invoice = ();
3119 my %seen = map { $_->address => 1 } @cust_main_invoice;
3120 foreach my $address ( @{$arrayref} ) {
3121 next if exists $seen{$address} && $seen{$address};
3122 $seen{$address} = 1;
3123 my $cust_main_invoice = new FS::cust_main_invoice ( {
3124 'custnum' => $self->custnum,
3127 my $error = $cust_main_invoice->insert;
3128 warn $error if $error;
3132 if ( $self->custnum ) {
3134 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3141 =item check_invoicing_list ARRAYREF
3143 Checks these arguements as valid input for the invoicing_list method. If there
3144 is an error, returns the error, otherwise returns false.
3148 sub check_invoicing_list {
3149 my( $self, $arrayref ) = @_;
3151 foreach my $address ( @$arrayref ) {
3153 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3154 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3157 my $cust_main_invoice = new FS::cust_main_invoice ( {
3158 'custnum' => $self->custnum,
3161 my $error = $self->custnum
3162 ? $cust_main_invoice->check
3163 : $cust_main_invoice->checkdest
3165 return $error if $error;
3169 return "Email address required"
3170 if $conf->exists('cust_main-require_invoicing_list_email')
3171 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3176 =item set_default_invoicing_list
3178 Sets the invoicing list to all accounts associated with this customer,
3179 overwriting any previous invoicing list.
3183 sub set_default_invoicing_list {
3185 $self->invoicing_list($self->all_emails);
3190 Returns the email addresses of all accounts provisioned for this customer.
3197 foreach my $cust_pkg ( $self->all_pkgs ) {
3198 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3200 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3201 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3203 $list{$_}=1 foreach map { $_->email } @svc_acct;
3208 =item invoicing_list_addpost
3210 Adds postal invoicing to this customer. If this customer is already configured
3211 to receive postal invoices, does nothing.
3215 sub invoicing_list_addpost {
3217 return if grep { $_ eq 'POST' } $self->invoicing_list;
3218 my @invoicing_list = $self->invoicing_list;
3219 push @invoicing_list, 'POST';
3220 $self->invoicing_list(\@invoicing_list);
3223 =item invoicing_list_emailonly
3225 Returns the list of email invoice recipients (invoicing_list without non-email
3226 destinations such as POST and FAX).
3230 sub invoicing_list_emailonly {
3232 warn "$me invoicing_list_emailonly called"
3234 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3237 =item invoicing_list_emailonly_scalar
3239 Returns the list of email invoice recipients (invoicing_list without non-email
3240 destinations such as POST and FAX) as a comma-separated scalar.
3244 sub invoicing_list_emailonly_scalar {
3246 warn "$me invoicing_list_emailonly_scalar called"
3248 join(', ', $self->invoicing_list_emailonly);
3251 =item referral_custnum_cust_main
3253 Returns the customer who referred this customer (or the empty string, if
3254 this customer was not referred).
3256 Note the difference with referral_cust_main method: This method,
3257 referral_custnum_cust_main returns the single customer (if any) who referred
3258 this customer, while referral_cust_main returns an array of customers referred
3263 sub referral_custnum_cust_main {
3265 return '' unless $self->referral_custnum;
3266 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3269 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3271 Returns an array of customers referred by this customer (referral_custnum set
3272 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3273 customers referred by customers referred by this customer and so on, inclusive.
3274 The default behavior is DEPTH 1 (no recursion).
3276 Note the difference with referral_custnum_cust_main method: This method,
3277 referral_cust_main, returns an array of customers referred BY this customer,
3278 while referral_custnum_cust_main returns the single customer (if any) who
3279 referred this customer.
3283 sub referral_cust_main {
3285 my $depth = @_ ? shift : 1;
3286 my $exclude = @_ ? shift : {};
3289 map { $exclude->{$_->custnum}++; $_; }
3290 grep { ! $exclude->{ $_->custnum } }
3291 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3295 map { $_->referral_cust_main($depth-1, $exclude) }
3302 =item referral_cust_main_ncancelled
3304 Same as referral_cust_main, except only returns customers with uncancelled
3309 sub referral_cust_main_ncancelled {
3311 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3314 =item referral_cust_pkg [ DEPTH ]
3316 Like referral_cust_main, except returns a flat list of all unsuspended (and
3317 uncancelled) packages for each customer. The number of items in this list may
3318 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3322 sub referral_cust_pkg {
3324 my $depth = @_ ? shift : 1;
3326 map { $_->unsuspended_pkgs }
3327 grep { $_->unsuspended_pkgs }
3328 $self->referral_cust_main($depth);
3331 =item referring_cust_main
3333 Returns the single cust_main record for the customer who referred this customer
3334 (referral_custnum), or false.
3338 sub referring_cust_main {
3340 return '' unless $self->referral_custnum;
3341 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3344 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3346 Applies a credit to this customer. If there is an error, returns the error,
3347 otherwise returns false.
3349 REASON can be a text string, an FS::reason object, or a scalar reference to
3350 a reasonnum. If a text string, it will be automatically inserted as a new
3351 reason, and a 'reason_type' option must be passed to indicate the
3352 FS::reason_type for the new reason.
3354 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3356 Any other options are passed to FS::cust_credit::insert.
3361 my( $self, $amount, $reason, %options ) = @_;
3363 my $cust_credit = new FS::cust_credit {
3364 'custnum' => $self->custnum,
3365 'amount' => $amount,
3368 if ( ref($reason) ) {
3370 if ( ref($reason) eq 'SCALAR' ) {
3371 $cust_credit->reasonnum( $$reason );
3373 $cust_credit->reasonnum( $reason->reasonnum );
3377 $cust_credit->set('reason', $reason)
3380 for (qw( addlinfo eventnum )) {
3381 $cust_credit->$_( delete $options{$_} )
3382 if exists($options{$_});
3385 $cust_credit->insert(%options);
3389 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3391 Creates a one-time charge for this customer. If there is an error, returns
3392 the error, otherwise returns false.
3394 New-style, with a hashref of options:
3396 my $error = $cust_main->charge(
3400 'start_date' => str2time('7/4/2009'),
3401 'pkg' => 'Description',
3402 'comment' => 'Comment',
3403 'additional' => [], #extra invoice detail
3404 'classnum' => 1, #pkg_class
3406 'setuptax' => '', # or 'Y' for tax exempt
3409 'taxclass' => 'Tax class',
3412 'taxproduct' => 2, #part_pkg_taxproduct
3413 'override' => {}, #XXX describe
3415 #will be filled in with the new object
3416 'cust_pkg_ref' => \$cust_pkg,
3418 #generate an invoice immediately
3420 'invoice_terms' => '', #with these terms
3426 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3432 my ( $amount, $quantity, $start_date, $classnum );
3433 my ( $pkg, $comment, $additional );
3434 my ( $setuptax, $taxclass ); #internal taxes
3435 my ( $taxproduct, $override ); #vendor (CCH) taxes
3437 my $cust_pkg_ref = '';
3438 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3439 if ( ref( $_[0] ) ) {
3440 $amount = $_[0]->{amount};
3441 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3442 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3443 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3444 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3445 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3446 : '$'. sprintf("%.2f",$amount);
3447 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3448 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3449 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3450 $additional = $_[0]->{additional} || [];
3451 $taxproduct = $_[0]->{taxproductnum};
3452 $override = { '' => $_[0]->{tax_override} };
3453 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3454 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3455 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3460 $pkg = @_ ? shift : 'One-time charge';
3461 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3463 $taxclass = @_ ? shift : '';
3467 local $SIG{HUP} = 'IGNORE';
3468 local $SIG{INT} = 'IGNORE';
3469 local $SIG{QUIT} = 'IGNORE';
3470 local $SIG{TERM} = 'IGNORE';
3471 local $SIG{TSTP} = 'IGNORE';
3472 local $SIG{PIPE} = 'IGNORE';
3474 my $oldAutoCommit = $FS::UID::AutoCommit;
3475 local $FS::UID::AutoCommit = 0;
3478 my $part_pkg = new FS::part_pkg ( {
3480 'comment' => $comment,
3484 'classnum' => ( $classnum ? $classnum : '' ),
3485 'setuptax' => $setuptax,
3486 'taxclass' => $taxclass,
3487 'taxproductnum' => $taxproduct,
3490 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3491 ( 0 .. @$additional - 1 )
3493 'additional_count' => scalar(@$additional),
3494 'setup_fee' => $amount,
3497 my $error = $part_pkg->insert( options => \%options,
3498 tax_overrides => $override,
3501 $dbh->rollback if $oldAutoCommit;
3505 my $pkgpart = $part_pkg->pkgpart;
3506 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3507 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3508 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3509 $error = $type_pkgs->insert;
3511 $dbh->rollback if $oldAutoCommit;
3516 my $cust_pkg = new FS::cust_pkg ( {
3517 'custnum' => $self->custnum,
3518 'pkgpart' => $pkgpart,
3519 'quantity' => $quantity,
3520 'start_date' => $start_date,
3521 'no_auto' => $no_auto,
3524 $error = $cust_pkg->insert;
3526 $dbh->rollback if $oldAutoCommit;
3528 } elsif ( $cust_pkg_ref ) {
3529 ${$cust_pkg_ref} = $cust_pkg;
3533 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3534 'pkg_list' => [ $cust_pkg ],
3537 $dbh->rollback if $oldAutoCommit;
3542 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3547 #=item charge_postal_fee
3549 #Applies a one time charge this customer. If there is an error,
3550 #returns the error, returns the cust_pkg charge object or false
3551 #if there was no charge.
3555 # This should be a customer event. For that to work requires that bill
3556 # also be a customer event.
3558 sub charge_postal_fee {
3561 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3562 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3564 my $cust_pkg = new FS::cust_pkg ( {
3565 'custnum' => $self->custnum,
3566 'pkgpart' => $pkgpart,
3570 my $error = $cust_pkg->insert;
3571 $error ? $error : $cust_pkg;
3574 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3576 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3578 Optionally, a list or hashref of additional arguments to the qsearch call can
3585 my $opt = ref($_[0]) ? shift : { @_ };
3587 #return $self->num_cust_bill unless wantarray || keys %$opt;
3589 $opt->{'table'} = 'cust_bill';
3590 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3591 $opt->{'hashref'}{'custnum'} = $self->custnum;
3592 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3594 map { $_ } #behavior of sort undefined in scalar context
3595 sort { $a->_date <=> $b->_date }
3599 =item open_cust_bill
3601 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3606 sub open_cust_bill {
3610 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3616 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3618 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3622 sub legacy_cust_bill {
3625 #return $self->num_legacy_cust_bill unless wantarray;
3627 map { $_ } #behavior of sort undefined in scalar context
3628 sort { $a->_date <=> $b->_date }
3629 qsearch({ 'table' => 'legacy_cust_bill',
3630 'hashref' => { 'custnum' => $self->custnum, },
3631 'order_by' => 'ORDER BY _date ASC',
3635 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3637 Returns all the statements (see L<FS::cust_statement>) for this customer.
3639 Optionally, a list or hashref of additional arguments to the qsearch call can
3644 sub cust_statement {
3646 my $opt = ref($_[0]) ? shift : { @_ };
3648 #return $self->num_cust_statement unless wantarray || keys %$opt;
3650 $opt->{'table'} = 'cust_statement';
3651 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3652 $opt->{'hashref'}{'custnum'} = $self->custnum;
3653 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3655 map { $_ } #behavior of sort undefined in scalar context
3656 sort { $a->_date <=> $b->_date }
3662 Returns all the credits (see L<FS::cust_credit>) for this customer.
3668 map { $_ } #return $self->num_cust_credit unless wantarray;
3669 sort { $a->_date <=> $b->_date }
3670 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3673 =item cust_credit_pkgnum
3675 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3676 package when using experimental package balances.
3680 sub cust_credit_pkgnum {
3681 my( $self, $pkgnum ) = @_;
3682 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3683 sort { $a->_date <=> $b->_date }
3684 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3685 'pkgnum' => $pkgnum,
3692 Returns all the payments (see L<FS::cust_pay>) for this customer.
3698 return $self->num_cust_pay unless wantarray;
3699 sort { $a->_date <=> $b->_date }
3700 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3705 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3706 called automatically when the cust_pay method is used in a scalar context.
3712 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3713 my $sth = dbh->prepare($sql) or die dbh->errstr;
3714 $sth->execute($self->custnum) or die $sth->errstr;
3715 $sth->fetchrow_arrayref->[0];
3718 =item cust_pay_pkgnum
3720 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3721 package when using experimental package balances.
3725 sub cust_pay_pkgnum {
3726 my( $self, $pkgnum ) = @_;
3727 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3728 sort { $a->_date <=> $b->_date }
3729 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3730 'pkgnum' => $pkgnum,
3737 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3743 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3744 sort { $a->_date <=> $b->_date }
3745 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3748 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3750 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3752 Optionally, a list or hashref of additional arguments to the qsearch call can
3757 sub cust_pay_batch {
3759 my $opt = ref($_[0]) ? shift : { @_ };
3761 #return $self->num_cust_statement unless wantarray || keys %$opt;
3763 $opt->{'table'} = 'cust_pay_batch';
3764 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3765 $opt->{'hashref'}{'custnum'} = $self->custnum;
3766 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3768 map { $_ } #behavior of sort undefined in scalar context
3769 sort { $a->paybatchnum <=> $b->paybatchnum }
3773 =item cust_pay_pending
3775 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3776 (without status "done").
3780 sub cust_pay_pending {
3782 return $self->num_cust_pay_pending unless wantarray;
3783 sort { $a->_date <=> $b->_date }
3784 qsearch( 'cust_pay_pending', {
3785 'custnum' => $self->custnum,
3786 'status' => { op=>'!=', value=>'done' },
3791 =item cust_pay_pending_attempt
3793 Returns all payment attempts / declined payments for this customer, as pending
3794 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3795 a corresponding payment (see L<FS::cust_pay>).
3799 sub cust_pay_pending_attempt {
3801 return $self->num_cust_pay_pending_attempt unless wantarray;
3802 sort { $a->_date <=> $b->_date }
3803 qsearch( 'cust_pay_pending', {
3804 'custnum' => $self->custnum,
3811 =item num_cust_pay_pending
3813 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3814 customer (without status "done"). Also called automatically when the
3815 cust_pay_pending method is used in a scalar context.
3819 sub num_cust_pay_pending {
3822 " SELECT COUNT(*) FROM cust_pay_pending ".
3823 " WHERE custnum = ? AND status != 'done' ",
3828 =item num_cust_pay_pending_attempt
3830 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3831 customer, with status "done" but without a corresp. Also called automatically when the
3832 cust_pay_pending method is used in a scalar context.
3836 sub num_cust_pay_pending_attempt {
3839 " SELECT COUNT(*) FROM cust_pay_pending ".
3840 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3847 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3853 map { $_ } #return $self->num_cust_refund unless wantarray;
3854 sort { $a->_date <=> $b->_date }
3855 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3858 =item display_custnum
3860 Returns the displayed customer number for this customer: agent_custid if
3861 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3865 sub display_custnum {
3867 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3868 return $self->agent_custid;
3869 } elsif ( $conf->config('cust_main-custnum-display_prefix') ) {
3870 return $conf->config('cust_main-custnum-display_prefix').
3871 sprintf('%08d', $self->custnum)
3873 return $self->custnum;
3879 Returns a name string for this customer, either "Company (Last, First)" or
3886 my $name = $self->contact;
3887 $name = $self->company. " ($name)" if $self->company;
3893 Returns a name string for this (service/shipping) contact, either
3894 "Company (Last, First)" or "Last, First".
3900 if ( $self->get('ship_last') ) {
3901 my $name = $self->ship_contact;
3902 $name = $self->ship_company. " ($name)" if $self->ship_company;
3911 Returns a name string for this customer, either "Company" or "First Last".
3917 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3920 =item ship_name_short
3922 Returns a name string for this (service/shipping) contact, either "Company"
3927 sub ship_name_short {
3929 if ( $self->get('ship_last') ) {
3930 $self->ship_company !~ /^\s*$/
3931 ? $self->ship_company
3932 : $self->ship_contact_firstlast;
3934 $self->name_company_or_firstlast;
3940 Returns this customer's full (billing) contact name only, "Last, First"
3946 $self->get('last'). ', '. $self->first;
3951 Returns this customer's full (shipping) contact name only, "Last, First"
3957 $self->get('ship_last')
3958 ? $self->get('ship_last'). ', '. $self->ship_first
3962 =item contact_firstlast
3964 Returns this customers full (billing) contact name only, "First Last".
3968 sub contact_firstlast {
3970 $self->first. ' '. $self->get('last');
3973 =item ship_contact_firstlast
3975 Returns this customer's full (shipping) contact name only, "First Last".
3979 sub ship_contact_firstlast {
3981 $self->get('ship_last')
3982 ? $self->first. ' '. $self->get('ship_last')
3983 : $self->contact_firstlast;
3988 Returns this customer's full country name
3994 code2country($self->country);
3997 =item geocode DATA_VENDOR
3999 Returns a value for the customer location as encoded by DATA_VENDOR.
4000 Currently this only makes sense for "CCH" as DATA_VENDOR.
4008 Returns a status string for this customer, currently:
4012 =item prospect - No packages have ever been ordered
4014 =item ordered - Recurring packages all are new (not yet billed).
4016 =item active - One or more recurring packages is active
4018 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4020 =item suspended - All non-cancelled recurring packages are suspended
4022 =item cancelled - All recurring packages are cancelled
4026 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4027 cust_main-status_module configuration option.
4031 sub status { shift->cust_status(@_); }
4035 for my $status ( FS::cust_main->statuses() ) {
4036 my $method = $status.'_sql';
4037 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4038 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4039 $sth->execute( ($self->custnum) x $numnum )
4040 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4041 return $status if $sth->fetchrow_arrayref->[0];
4045 =item ucfirst_cust_status
4047 =item ucfirst_status
4049 Returns the status with the first character capitalized.
4053 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4055 sub ucfirst_cust_status {
4057 ucfirst($self->cust_status);
4062 Returns a hex triplet color string for this customer's status.
4066 sub statuscolor { shift->cust_statuscolor(@_); }
4068 sub cust_statuscolor {
4070 __PACKAGE__->statuscolors->{$self->cust_status};
4075 Returns an array of hashes representing the customer's RT tickets.
4082 my $num = $conf->config('cust_main-max_tickets') || 10;
4085 if ( $conf->config('ticket_system') ) {
4086 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4088 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4092 foreach my $priority (
4093 $conf->config('ticket_system-custom_priority_field-values'), ''
4095 last if scalar(@tickets) >= $num;
4097 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4098 $num - scalar(@tickets),
4108 # Return services representing svc_accts in customer support packages
4109 sub support_services {
4111 my %packages = map { $_ => 1 } $conf->config('support_packages');
4113 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4114 grep { $_->part_svc->svcdb eq 'svc_acct' }
4115 map { $_->cust_svc }
4116 grep { exists $packages{ $_->pkgpart } }
4117 $self->ncancelled_pkgs;
4121 # Return a list of latitude/longitude for one of the services (if any)
4122 sub service_coordinates {
4126 grep { $_->latitude && $_->longitude }
4128 map { $_->cust_svc }
4129 $self->ncancelled_pkgs;
4131 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4136 Returns a masked version of the named field
4141 my ($self,$field) = @_;
4145 'x'x(length($self->getfield($field))-4).
4146 substr($self->getfield($field), (length($self->getfield($field))-4));
4152 =head1 CLASS METHODS
4158 Class method that returns the list of possible status strings for customers
4159 (see L<the status method|/status>). For example:
4161 @statuses = FS::cust_main->statuses();
4167 keys %{ $self->statuscolors };
4170 =item cust_status_sql
4172 Returns an SQL fragment to determine the status of a cust_main record, as a
4177 sub cust_status_sql {
4179 for my $status ( FS::cust_main->statuses() ) {
4180 my $method = $status.'_sql';
4181 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4190 Returns an SQL expression identifying prospective cust_main records (customers
4191 with no packages ever ordered)
4195 use vars qw($select_count_pkgs);
4196 $select_count_pkgs =
4197 "SELECT COUNT(*) FROM cust_pkg
4198 WHERE cust_pkg.custnum = cust_main.custnum";
4200 sub select_count_pkgs_sql {
4205 " 0 = ( $select_count_pkgs ) ";
4210 Returns an SQL expression identifying ordered cust_main records (customers with
4211 no active packages, but recurring packages not yet setup or one time charges
4217 FS::cust_main->none_active_sql.
4218 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4223 Returns an SQL expression identifying active cust_main records (customers with
4224 active recurring packages).
4229 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4232 =item none_active_sql
4234 Returns an SQL expression identifying cust_main records with no active
4235 recurring packages. This includes customers of status prospect, ordered,
4236 inactive, and suspended.
4240 sub none_active_sql {
4241 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4246 Returns an SQL expression identifying inactive cust_main records (customers with
4247 no active recurring packages, but otherwise unsuspended/uncancelled).
4252 FS::cust_main->none_active_sql.
4253 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4259 Returns an SQL expression identifying suspended cust_main records.
4264 sub suspended_sql { susp_sql(@_); }
4266 FS::cust_main->none_active_sql.
4267 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4273 Returns an SQL expression identifying cancelled cust_main records.
4277 sub cancel_sql { shift->cancelled_sql(@_); }
4280 =item uncancelled_sql
4282 Returns an SQL expression identifying un-cancelled cust_main records.
4286 sub uncancelled_sql { uncancel_sql(@_); }
4287 sub uncancel_sql { "
4288 ( 0 < ( $select_count_pkgs
4289 AND ( cust_pkg.cancel IS NULL
4290 OR cust_pkg.cancel = 0
4293 OR 0 = ( $select_count_pkgs )
4299 Returns an SQL fragment to retreive the balance.
4304 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4305 WHERE cust_bill.custnum = cust_main.custnum )
4306 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4307 WHERE cust_pay.custnum = cust_main.custnum )
4308 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4309 WHERE cust_credit.custnum = cust_main.custnum )
4310 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4311 WHERE cust_refund.custnum = cust_main.custnum )
4314 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4316 Returns an SQL fragment to retreive the balance for this customer, optionally
4317 considering invoices with date earlier than START_TIME, and not
4318 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4319 total_unapplied_payments).
4321 Times are specified as SQL fragments or numeric
4322 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4323 L<Date::Parse> for conversion functions. The empty string can be passed
4324 to disable that time constraint completely.
4326 Available options are:
4330 =item unapplied_date
4332 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)
4337 set to true to remove all customer comparison clauses, for totals
4342 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4347 JOIN clause (typically used with the total option)
4351 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4352 time will be ignored. Note that START_TIME and END_TIME only limit the date
4353 range for invoices and I<unapplied> payments, credits, and refunds.
4359 sub balance_date_sql {
4360 my( $class, $start, $end, %opt ) = @_;
4362 my $cutoff = $opt{'cutoff'};
4364 my $owed = FS::cust_bill->owed_sql($cutoff);
4365 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4366 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4367 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4369 my $j = $opt{'join'} || '';
4371 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4372 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4373 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4374 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4376 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4377 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4378 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4379 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4384 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4386 Returns an SQL fragment to retreive the total unapplied payments for this
4387 customer, only considering payments with date earlier than START_TIME, and
4388 optionally not later than END_TIME.
4390 Times are specified as SQL fragments or numeric
4391 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4392 L<Date::Parse> for conversion functions. The empty string can be passed
4393 to disable that time constraint completely.
4395 Available options are:
4399 sub unapplied_payments_date_sql {
4400 my( $class, $start, $end, %opt ) = @_;
4402 my $cutoff = $opt{'cutoff'};
4404 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4406 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4407 'unapplied_date'=>1 );
4409 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4412 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4414 Helper method for balance_date_sql; name (and usage) subject to change
4415 (suggestions welcome).
4417 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4418 cust_refund, cust_credit or cust_pay).
4420 If TABLE is "cust_bill" or the unapplied_date option is true, only
4421 considers records with date earlier than START_TIME, and optionally not
4422 later than END_TIME .
4426 sub _money_table_where {
4427 my( $class, $table, $start, $end, %opt ) = @_;
4430 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4431 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4432 push @where, "$table._date <= $start" if defined($start) && length($start);
4433 push @where, "$table._date > $end" if defined($end) && length($end);
4435 push @where, @{$opt{'where'}} if $opt{'where'};
4436 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4442 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4443 use FS::cust_main::Search;
4446 FS::cust_main::Search->search(@_);
4461 #warn join('-',keys %$param);
4462 my $fh = $param->{filehandle};
4463 my $agentnum = $param->{agentnum};
4464 my $format = $param->{format};
4466 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4469 if ( $format eq 'simple' ) {
4470 @fields = qw( custnum agent_custid amount pkg );
4472 die "unknown format $format";
4475 eval "use Text::CSV_XS;";
4478 my $csv = new Text::CSV_XS;
4485 local $SIG{HUP} = 'IGNORE';
4486 local $SIG{INT} = 'IGNORE';
4487 local $SIG{QUIT} = 'IGNORE';
4488 local $SIG{TERM} = 'IGNORE';
4489 local $SIG{TSTP} = 'IGNORE';
4490 local $SIG{PIPE} = 'IGNORE';
4492 my $oldAutoCommit = $FS::UID::AutoCommit;
4493 local $FS::UID::AutoCommit = 0;
4496 #while ( $columns = $csv->getline($fh) ) {
4498 while ( defined($line=<$fh>) ) {
4500 $csv->parse($line) or do {
4501 $dbh->rollback if $oldAutoCommit;
4502 return "can't parse: ". $csv->error_input();
4505 my @columns = $csv->fields();
4506 #warn join('-',@columns);
4509 foreach my $field ( @fields ) {
4510 $row{$field} = shift @columns;
4513 if ( $row{custnum} && $row{agent_custid} ) {
4514 dbh->rollback if $oldAutoCommit;
4515 return "can't specify custnum with agent_custid $row{agent_custid}";
4519 if ( $row{agent_custid} && $agentnum ) {
4520 %hash = ( 'agent_custid' => $row{agent_custid},
4521 'agentnum' => $agentnum,
4525 if ( $row{custnum} ) {
4526 %hash = ( 'custnum' => $row{custnum} );
4529 unless ( scalar(keys %hash) ) {
4530 $dbh->rollback if $oldAutoCommit;
4531 return "can't find customer without custnum or agent_custid and agentnum";
4534 my $cust_main = qsearchs('cust_main', { %hash } );
4535 unless ( $cust_main ) {
4536 $dbh->rollback if $oldAutoCommit;
4537 my $custnum = $row{custnum} || $row{agent_custid};
4538 return "unknown custnum $custnum";
4541 if ( $row{'amount'} > 0 ) {
4542 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4544 $dbh->rollback if $oldAutoCommit;
4548 } elsif ( $row{'amount'} < 0 ) {
4549 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4552 $dbh->rollback if $oldAutoCommit;
4562 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4564 return "Empty file!" unless $imported;
4570 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4572 Deprecated. Use event notification and message templates
4573 (L<FS::msg_template>) instead.
4575 Sends a templated email notification to the customer (see L<Text::Template>).
4577 OPTIONS is a hash and may include
4579 I<from> - the email sender (default is invoice_from)
4581 I<to> - comma-separated scalar or arrayref of recipients
4582 (default is invoicing_list)
4584 I<subject> - The subject line of the sent email notification
4585 (default is "Notice from company_name")
4587 I<extra_fields> - a hashref of name/value pairs which will be substituted
4590 The following variables are vavailable in the template.
4592 I<$first> - the customer first name
4593 I<$last> - the customer last name
4594 I<$company> - the customer company
4595 I<$payby> - a description of the method of payment for the customer
4596 # would be nice to use FS::payby::shortname
4597 I<$payinfo> - the account information used to collect for this customer
4598 I<$expdate> - the expiration of the customer payment in seconds from epoch
4603 my ($self, $template, %options) = @_;
4605 return unless $conf->exists($template);
4607 my $from = $conf->config('invoice_from', $self->agentnum)
4608 if $conf->exists('invoice_from', $self->agentnum);
4609 $from = $options{from} if exists($options{from});
4611 my $to = join(',', $self->invoicing_list_emailonly);
4612 $to = $options{to} if exists($options{to});
4614 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4615 if $conf->exists('company_name', $self->agentnum);
4616 $subject = $options{subject} if exists($options{subject});
4618 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4619 SOURCE => [ map "$_\n",
4620 $conf->config($template)]
4622 or die "can't create new Text::Template object: Text::Template::ERROR";
4623 $notify_template->compile()
4624 or die "can't compile template: Text::Template::ERROR";
4626 $FS::notify_template::_template::company_name =
4627 $conf->config('company_name', $self->agentnum);
4628 $FS::notify_template::_template::company_address =
4629 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4631 my $paydate = $self->paydate || '2037-12-31';
4632 $FS::notify_template::_template::first = $self->first;
4633 $FS::notify_template::_template::last = $self->last;
4634 $FS::notify_template::_template::company = $self->company;
4635 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4636 my $payby = $self->payby;
4637 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4638 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4640 #credit cards expire at the end of the month/year of their exp date
4641 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4642 $FS::notify_template::_template::payby = 'credit card';
4643 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4644 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4646 }elsif ($payby eq 'COMP') {
4647 $FS::notify_template::_template::payby = 'complimentary account';
4649 $FS::notify_template::_template::payby = 'current method';
4651 $FS::notify_template::_template::expdate = $expire_time;
4653 for (keys %{$options{extra_fields}}){
4655 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4658 send_email(from => $from,
4660 subject => $subject,
4661 body => $notify_template->fill_in( PACKAGE =>
4662 'FS::notify_template::_template' ),
4667 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4669 Generates a templated notification to the customer (see L<Text::Template>).
4671 OPTIONS is a hash and may include
4673 I<extra_fields> - a hashref of name/value pairs which will be substituted
4674 into the template. These values may override values mentioned below
4675 and those from the customer record.
4677 The following variables are available in the template instead of or in addition
4678 to the fields of the customer record.
4680 I<$payby> - a description of the method of payment for the customer
4681 # would be nice to use FS::payby::shortname
4682 I<$payinfo> - the masked account information used to collect for this customer
4683 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4684 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4688 # a lot like cust_bill::print_latex
4689 sub generate_letter {
4690 my ($self, $template, %options) = @_;
4692 return unless $conf->exists($template);
4694 my $letter_template = new Text::Template
4696 SOURCE => [ map "$_\n", $conf->config($template)],
4697 DELIMITERS => [ '[@--', '--@]' ],
4699 or die "can't create new Text::Template object: Text::Template::ERROR";
4701 $letter_template->compile()
4702 or die "can't compile template: Text::Template::ERROR";
4704 my %letter_data = map { $_ => $self->$_ } $self->fields;
4705 $letter_data{payinfo} = $self->mask_payinfo;
4707 #my $paydate = $self->paydate || '2037-12-31';
4708 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4710 my $payby = $self->payby;
4711 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4712 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4714 #credit cards expire at the end of the month/year of their exp date
4715 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4716 $letter_data{payby} = 'credit card';
4717 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4718 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4720 }elsif ($payby eq 'COMP') {
4721 $letter_data{payby} = 'complimentary account';
4723 $letter_data{payby} = 'current method';
4725 $letter_data{expdate} = $expire_time;
4727 for (keys %{$options{extra_fields}}){
4728 $letter_data{$_} = $options{extra_fields}->{$_};
4731 unless(exists($letter_data{returnaddress})){
4732 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4733 $self->agent_template)
4735 if ( length($retadd) ) {
4736 $letter_data{returnaddress} = $retadd;
4737 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4738 $letter_data{returnaddress} =
4739 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4743 ( $conf->config('company_name', $self->agentnum),
4744 $conf->config('company_address', $self->agentnum),
4748 $letter_data{returnaddress} = '~';
4752 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4754 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4756 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4758 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4762 ) or die "can't open temp file: $!\n";
4763 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4764 or die "can't write temp file: $!\n";
4766 $letter_data{'logo_file'} = $lh->filename;
4768 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4772 ) or die "can't open temp file: $!\n";
4774 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4776 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4777 return ($1, $letter_data{'logo_file'});
4781 =item print_ps TEMPLATE
4783 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4789 my($file, $lfile) = $self->generate_letter(@_);
4790 my $ps = FS::Misc::generate_ps($file);
4791 unlink($file.'.tex');
4797 =item print TEMPLATE
4799 Prints the filled in template.
4801 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4805 sub queueable_print {
4808 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4809 or die "invalid customer number: " . $opt{custvnum};
4811 my $error = $self->print( $opt{template} );
4812 die $error if $error;
4816 my ($self, $template) = (shift, shift);
4817 do_print [ $self->print_ps($template) ];
4820 #these three subs should just go away once agent stuff is all config overrides
4822 sub agent_template {
4824 $self->_agent_plandata('agent_templatename');
4827 sub agent_invoice_from {
4829 $self->_agent_plandata('agent_invoice_from');
4832 sub _agent_plandata {
4833 my( $self, $option ) = @_;
4835 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4836 #agent-specific Conf
4838 use FS::part_event::Condition;
4840 my $agentnum = $self->agentnum;
4842 my $regexp = regexp_sql();
4844 my $part_event_option =
4846 'select' => 'part_event_option.*',
4847 'table' => 'part_event_option',
4849 LEFT JOIN part_event USING ( eventpart )
4850 LEFT JOIN part_event_option AS peo_agentnum
4851 ON ( part_event.eventpart = peo_agentnum.eventpart
4852 AND peo_agentnum.optionname = 'agentnum'
4853 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4855 LEFT JOIN part_event_condition
4856 ON ( part_event.eventpart = part_event_condition.eventpart
4857 AND part_event_condition.conditionname = 'cust_bill_age'
4859 LEFT JOIN part_event_condition_option
4860 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4861 AND part_event_condition_option.optionname = 'age'
4864 #'hashref' => { 'optionname' => $option },
4865 #'hashref' => { 'part_event_option.optionname' => $option },
4867 " WHERE part_event_option.optionname = ". dbh->quote($option).
4868 " AND action = 'cust_bill_send_agent' ".
4869 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4870 " AND peo_agentnum.optionname = 'agentnum' ".
4871 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4873 CASE WHEN part_event_condition_option.optionname IS NULL
4875 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4877 , part_event.weight".
4881 unless ( $part_event_option ) {
4882 return $self->agent->invoice_template || ''
4883 if $option eq 'agent_templatename';
4887 $part_event_option->optionvalue;
4891 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4893 Subroutine (not a method), designed to be called from the queue.
4895 Takes a list of options and values.
4897 Pulls up the customer record via the custnum option and calls bill_and_collect.
4902 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4904 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4905 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4907 $cust_main->bill_and_collect( %args );
4910 sub process_bill_and_collect {
4912 my $param = thaw(decode_base64(shift));
4913 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4914 or die "custnum '$param->{custnum}' not found!\n";
4915 $param->{'job'} = $job;
4916 $param->{'fatal'} = 1; # runs from job queue, will be caught
4917 $param->{'retry'} = 1;
4919 $cust_main->bill_and_collect( %$param );
4922 sub _upgrade_data { #class method
4923 my ($class, %opts) = @_;
4926 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4927 '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',
4929 # fix yyyy-m-dd formatted paydates
4930 if ( driver_name =~ /^mysql$/i ) {
4932 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4934 else { # the SQL standard
4936 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4939 foreach my $sql ( @statements ) {
4940 my $sth = dbh->prepare($sql) or die dbh->errstr;
4941 $sth->execute or die $sth->errstr;
4944 local($ignore_expired_card) = 1;
4945 local($ignore_illegal_zip) = 1;
4946 local($ignore_banned_card) = 1;
4947 local($skip_fuzzyfiles) = 1;
4948 $class->_upgrade_otaker(%opts);
4958 The delete method should possibly take an FS::cust_main object reference
4959 instead of a scalar customer number.
4961 Bill and collect options should probably be passed as references instead of a
4964 There should probably be a configuration file with a list of allowed credit
4967 No multiple currency support (probably a larger project than just this module).
4969 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4971 Birthdates rely on negative epoch values.
4973 The payby for card/check batches is broken. With mixed batching, bad
4976 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
4980 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4981 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4982 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.