2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
6 FS::cust_main::Billing_Realtime
7 FS::cust_main::Billing_Discount
8 FS::cust_main::Billing_ThirdParty
9 FS::cust_main::Location
10 FS::cust_main::Credit_Limit
12 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
20 use vars qw( $DEBUG $me $conf
23 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
29 use Scalar::Util qw( blessed );
30 use Time::Local qw(timelocal);
31 use Storable qw(thaw);
35 use Digest::MD5 qw(md5_base64);
38 use File::Temp; #qw( tempfile );
39 use Business::CreditCard 0.28;
41 use FS::UID qw( dbh driver_name );
42 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
44 use FS::Misc qw( generate_email send_email generate_ps do_print );
45 use FS::Msgcat qw(gettext);
52 use FS::cust_bill_void;
53 use FS::legacy_cust_bill;
55 use FS::cust_pay_pending;
56 use FS::cust_pay_void;
57 use FS::cust_pay_batch;
60 use FS::part_referral;
61 use FS::cust_main_county;
62 use FS::cust_location;
64 use FS::cust_main_exemption;
65 use FS::cust_tax_adjustment;
66 use FS::cust_tax_location;
67 use FS::agent_currency;
68 use FS::cust_main_invoice;
70 use FS::prepay_credit;
76 use FS::payment_gateway;
77 use FS::agent_payment_gateway;
79 use FS::cust_main_note;
80 use FS::cust_attachment;
83 use FS::upgrade_journal;
87 # 1 is mostly method/subroutine entry and options
88 # 2 traces progress of some operations
89 # 3 is even more information including possibly sensitive data
91 $me = '[FS::cust_main]';
94 $ignore_expired_card = 0;
95 $ignore_banned_card = 0;
96 $ignore_invalid_card = 0;
100 @encrypted_fields = ('payinfo', 'paycvv');
101 sub nohistory_fields { ('payinfo', 'paycvv'); }
103 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
105 #ask FS::UID to run this stuff for us later
106 #$FS::UID::callback{'FS::cust_main'} = sub {
107 install_callback FS::UID sub {
108 $conf = new FS::Conf;
109 #yes, need it for stuff below (prolly should be cached)
110 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
115 my ( $hashref, $cache ) = @_;
116 if ( exists $hashref->{'pkgnum'} ) {
117 #@{ $self->{'_pkgnum'} } = ();
118 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
119 $self->{'_pkgnum'} = $subcache;
120 #push @{ $self->{'_pkgnum'} },
121 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
127 FS::cust_main - Object methods for cust_main records
133 $record = new FS::cust_main \%hash;
134 $record = new FS::cust_main { 'column' => 'value' };
136 $error = $record->insert;
138 $error = $new_record->replace($old_record);
140 $error = $record->delete;
142 $error = $record->check;
144 @cust_pkg = $record->all_pkgs;
146 @cust_pkg = $record->ncancelled_pkgs;
148 @cust_pkg = $record->suspended_pkgs;
150 $error = $record->bill;
151 $error = $record->bill %options;
152 $error = $record->bill 'time' => $time;
154 $error = $record->collect;
155 $error = $record->collect %options;
156 $error = $record->collect 'invoice_time' => $time,
161 An FS::cust_main object represents a customer. FS::cust_main inherits from
162 FS::Record. The following fields are currently supported:
168 Primary key (assigned automatically for new customers)
172 Agent (see L<FS::agent>)
176 Advertising source (see L<FS::part_referral>)
188 Cocial security number (optional)
212 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
216 Payment Information (See L<FS::payinfo_Mixin> for data format)
220 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
224 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
228 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
232 Start date month (maestro/solo cards only)
236 Start date year (maestro/solo cards only)
240 Issue number (maestro/solo cards only)
244 Name on card or billing name
248 IP address from which payment information was received
252 Tax exempt, empty or `Y'
256 Order taker (see L<FS::access_user>)
262 =item referral_custnum
264 Referring customer number
268 Enable individual CDR spooling, empty or `Y'
272 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
276 Discourage individual CDR printing, empty or `Y'
280 Allow self-service editing of ticket subjects, empty or 'Y'
282 =item calling_list_exempt
284 Do not call, empty or 'Y'
294 Creates a new customer. To add the customer to the database, see L<"insert">.
296 Note that this stores the hash reference, not a distinct copy of the hash it
297 points to. You can ask the object for a copy with the I<hash> method.
301 sub table { 'cust_main'; }
303 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
305 Adds this customer to the database. If there is an error, returns the error,
306 otherwise returns false.
308 Usually the customer's location will not yet exist in the database, and
309 the C<bill_location> and C<ship_location> pseudo-fields must be set to
310 uninserted L<FS::cust_location> objects. These will be inserted and linked
311 (in both directions) to the new customer record. If they're references
312 to the same object, they will become the same location.
314 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
315 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
316 are inserted atomicly, or the transaction is rolled back. Passing an empty
317 hash reference is equivalent to not supplying this parameter. There should be
318 a better explanation of this, but until then, here's an example:
321 tie %hash, 'Tie::RefHash'; #this part is important
323 $cust_pkg => [ $svc_acct ],
326 $cust_main->insert( \%hash );
328 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
329 be set as the invoicing list (see L<"invoicing_list">). Errors return as
330 expected and rollback the entire transaction; it is not necessary to call
331 check_invoicing_list first. The invoicing_list is set after the records in the
332 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
333 invoicing_list destination to the newly-created svc_acct. Here's an example:
335 $cust_main->insert( {}, [ $email, 'POST' ] );
337 Currently available options are: I<depend_jobnum>, I<noexport>,
338 I<tax_exemption> and I<prospectnum>.
340 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
341 on the supplied jobnum (they will not run until the specific job completes).
342 This can be used to defer provisioning until some action completes (such
343 as running the customer's credit card successfully).
345 The I<noexport> option is deprecated. If I<noexport> is set true, no
346 provisioning jobs (exports) are scheduled. (You can schedule them later with
347 the B<reexport> method.)
349 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
350 of tax names and exemption numbers. FS::cust_main_exemption records will be
351 created and inserted.
353 If I<prospectnum> is set, moves contacts and locations from that prospect.
355 If I<contact> is set to an arrayref of FS::contact objects, inserts those
356 new contacts with this new customer.
362 my $cust_pkgs = @_ ? shift : {};
363 my $invoicing_list = @_ ? shift : '';
365 warn "$me insert called with options ".
366 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
369 local $SIG{HUP} = 'IGNORE';
370 local $SIG{INT} = 'IGNORE';
371 local $SIG{QUIT} = 'IGNORE';
372 local $SIG{TERM} = 'IGNORE';
373 local $SIG{TSTP} = 'IGNORE';
374 local $SIG{PIPE} = 'IGNORE';
376 my $oldAutoCommit = $FS::UID::AutoCommit;
377 local $FS::UID::AutoCommit = 0;
380 my $prepay_identifier = '';
381 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
383 if ( $self->payby eq 'PREPAY' ) {
385 $self->payby('BILL');
386 $prepay_identifier = $self->payinfo;
389 warn " looking up prepaid card $prepay_identifier\n"
392 my $error = $self->get_prepay( $prepay_identifier,
393 'amount_ref' => \$amount,
394 'seconds_ref' => \$seconds,
395 'upbytes_ref' => \$upbytes,
396 'downbytes_ref' => \$downbytes,
397 'totalbytes_ref' => \$totalbytes,
400 $dbh->rollback if $oldAutoCommit;
401 #return "error applying prepaid card (transaction rolled back): $error";
405 $payby = 'PREP' if $amount;
407 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
410 $self->payby('BILL');
411 $amount = $self->paid;
416 foreach my $l (qw(bill_location ship_location)) {
418 my $loc = delete $self->hashref->{$l} or next;
420 if ( !$loc->locationnum ) {
421 # warn the location that we're going to insert it with no custnum
422 $loc->set(custnum_pending => 1);
423 warn " inserting $l\n"
425 my $error = $loc->insert;
427 $dbh->rollback if $oldAutoCommit;
428 my $label = $l eq 'ship_location' ? 'service' : 'billing';
429 return "$error (in $label location)";
432 } elsif ( $loc->prospectnum ) {
434 $loc->prospectnum('');
435 $loc->set(custnum_pending => 1);
436 my $error = $loc->replace;
438 $dbh->rollback if $oldAutoCommit;
439 my $label = $l eq 'ship_location' ? 'service' : 'billing';
440 return "$error (moving $label location)";
443 } elsif ( ($loc->custnum || 0) > 0 ) {
444 # then it somehow belongs to another customer--shouldn't happen
445 $dbh->rollback if $oldAutoCommit;
446 return "$l belongs to customer ".$loc->custnum;
448 # else it already belongs to this customer
449 # (happens when ship_location is identical to bill_location)
451 $self->set($l.'num', $loc->locationnum);
453 if ( $self->get($l.'num') eq '' ) {
454 $dbh->rollback if $oldAutoCommit;
459 warn " inserting $self\n"
462 $self->signupdate(time) unless $self->signupdate;
464 $self->auto_agent_custid()
465 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
467 my $error = $self->SUPER::insert;
469 $dbh->rollback if $oldAutoCommit;
470 #return "inserting cust_main record (transaction rolled back): $error";
474 # now set cust_location.custnum
475 foreach my $l (qw(bill_location ship_location)) {
476 warn " setting $l.custnum\n"
478 my $loc = $self->$l or next;
479 unless ( $loc->custnum ) {
480 $loc->set(custnum => $self->custnum);
481 $error ||= $loc->replace;
485 $dbh->rollback if $oldAutoCommit;
486 return "error setting $l custnum: $error";
490 warn " setting invoicing list\n"
493 if ( $invoicing_list ) {
494 $error = $self->check_invoicing_list( $invoicing_list );
496 $dbh->rollback if $oldAutoCommit;
497 #return "checking invoicing_list (transaction rolled back): $error";
500 $self->invoicing_list( $invoicing_list );
503 warn " setting customer tags\n"
506 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
507 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
508 'custnum' => $self->custnum };
509 my $error = $cust_tag->insert;
511 $dbh->rollback if $oldAutoCommit;
516 my $prospectnum = delete $options{'prospectnum'};
517 if ( $prospectnum ) {
519 warn " moving contacts and locations from prospect $prospectnum\n"
523 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
524 unless ( $prospect_main ) {
525 $dbh->rollback if $oldAutoCommit;
526 return "Unknown prospectnum $prospectnum";
528 $prospect_main->custnum($self->custnum);
529 $prospect_main->disabled('Y');
530 my $error = $prospect_main->replace;
532 $dbh->rollback if $oldAutoCommit;
536 my @contact = $prospect_main->contact;
537 my @cust_location = $prospect_main->cust_location;
538 my @qual = $prospect_main->qual;
540 foreach my $r ( @contact, @cust_location, @qual ) {
542 $r->custnum($self->custnum);
543 my $error = $r->replace;
545 $dbh->rollback if $oldAutoCommit;
552 my $contact = delete $options{'contact'};
555 foreach my $c ( @$contact ) {
556 $c->custnum($self->custnum);
557 my $error = $c->insert;
559 $dbh->rollback if $oldAutoCommit;
567 warn " setting cust_main_exemption\n"
570 my $tax_exemption = delete $options{'tax_exemption'};
571 if ( $tax_exemption ) {
573 $tax_exemption = { map { $_ => '' } @$tax_exemption }
574 if ref($tax_exemption) eq 'ARRAY';
576 foreach my $taxname ( keys %$tax_exemption ) {
577 my $cust_main_exemption = new FS::cust_main_exemption {
578 'custnum' => $self->custnum,
579 'taxname' => $taxname,
580 'exempt_number' => $tax_exemption->{$taxname},
582 my $error = $cust_main_exemption->insert;
584 $dbh->rollback if $oldAutoCommit;
585 return "inserting cust_main_exemption (transaction rolled back): $error";
590 warn " ordering packages\n"
593 $error = $self->order_pkgs( $cust_pkgs,
595 'seconds_ref' => \$seconds,
596 'upbytes_ref' => \$upbytes,
597 'downbytes_ref' => \$downbytes,
598 'totalbytes_ref' => \$totalbytes,
601 $dbh->rollback if $oldAutoCommit;
606 $dbh->rollback if $oldAutoCommit;
607 return "No svc_acct record to apply pre-paid time";
609 if ( $upbytes || $downbytes || $totalbytes ) {
610 $dbh->rollback if $oldAutoCommit;
611 return "No svc_acct record to apply pre-paid data";
615 warn " inserting initial $payby payment of $amount\n"
617 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
619 $dbh->rollback if $oldAutoCommit;
620 return "inserting payment (transaction rolled back): $error";
624 unless ( $import || $skip_fuzzyfiles ) {
625 warn " queueing fuzzyfiles update\n"
627 $error = $self->queue_fuzzyfiles_update;
629 $dbh->rollback if $oldAutoCommit;
630 return "updating fuzzy search cache: $error";
634 # FS::geocode_Mixin::after_insert or something?
635 if ( $conf->config('tax_district_method') and !$import ) {
636 # if anything non-empty, try to look it up
637 my $queue = new FS::queue {
638 'job' => 'FS::geocode_Mixin::process_district_update',
639 'custnum' => $self->custnum,
641 my $error = $queue->insert( ref($self), $self->custnum );
643 $dbh->rollback if $oldAutoCommit;
644 return "queueing tax district update: $error";
649 warn " exporting\n" if $DEBUG > 1;
651 my $export_args = $options{'export_args'} || [];
654 map qsearch( 'part_export', {exportnum=>$_} ),
655 $conf->config('cust_main-exports'); #, $agentnum
657 foreach my $part_export ( @part_export ) {
658 my $error = $part_export->export_insert($self, @$export_args);
660 $dbh->rollback if $oldAutoCommit;
661 return "exporting to ". $part_export->exporttype.
662 " (transaction rolled back): $error";
666 #foreach my $depend_jobnum ( @$depend_jobnums ) {
667 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
669 # foreach my $jobnum ( @jobnums ) {
670 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
671 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
673 # my $error = $queue->depend_insert($depend_jobnum);
675 # $dbh->rollback if $oldAutoCommit;
676 # return "error queuing job dependancy: $error";
683 #if ( exists $options{'jobnums'} ) {
684 # push @{ $options{'jobnums'} }, @jobnums;
687 warn " insert complete; committing transaction\n"
690 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
695 use File::CounterFile;
696 sub auto_agent_custid {
699 my $format = $conf->config('cust_main-auto_agent_custid');
701 if ( $format eq '1YMMXXXXXXXX' ) {
703 my $counter = new File::CounterFile 'cust_main.agent_custid';
706 my $ym = 100000000000 + time2str('%y%m00000000', time);
707 if ( $ym > $counter->value ) {
708 $counter->{'value'} = $agent_custid = $ym;
709 $counter->{'updated'} = 1;
711 $agent_custid = $counter->inc;
717 die "Unknown cust_main-auto_agent_custid format: $format";
720 $self->agent_custid($agent_custid);
724 =item PACKAGE METHODS
726 Documentation on customer package methods has been moved to
727 L<FS::cust_main::Packages>.
729 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
731 Recharges this (existing) customer with the specified prepaid card (see
732 L<FS::prepay_credit>), specified either by I<identifier> or as an
733 FS::prepay_credit object. If there is an error, returns the error, otherwise
736 Optionally, five scalar references can be passed as well. They will have their
737 values filled in with the amount, number of seconds, and number of upload,
738 download, and total bytes applied by this prepaid card.
742 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
743 #the only place that uses these args
744 sub recharge_prepay {
745 my( $self, $prepay_credit, $amountref, $secondsref,
746 $upbytesref, $downbytesref, $totalbytesref ) = @_;
748 local $SIG{HUP} = 'IGNORE';
749 local $SIG{INT} = 'IGNORE';
750 local $SIG{QUIT} = 'IGNORE';
751 local $SIG{TERM} = 'IGNORE';
752 local $SIG{TSTP} = 'IGNORE';
753 local $SIG{PIPE} = 'IGNORE';
755 my $oldAutoCommit = $FS::UID::AutoCommit;
756 local $FS::UID::AutoCommit = 0;
759 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
761 my $error = $self->get_prepay( $prepay_credit,
762 'amount_ref' => \$amount,
763 'seconds_ref' => \$seconds,
764 'upbytes_ref' => \$upbytes,
765 'downbytes_ref' => \$downbytes,
766 'totalbytes_ref' => \$totalbytes,
768 || $self->increment_seconds($seconds)
769 || $self->increment_upbytes($upbytes)
770 || $self->increment_downbytes($downbytes)
771 || $self->increment_totalbytes($totalbytes)
772 || $self->insert_cust_pay_prepay( $amount,
774 ? $prepay_credit->identifier
779 $dbh->rollback if $oldAutoCommit;
783 if ( defined($amountref) ) { $$amountref = $amount; }
784 if ( defined($secondsref) ) { $$secondsref = $seconds; }
785 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
786 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
787 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
789 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
794 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
796 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
797 specified either by I<identifier> or as an FS::prepay_credit object.
799 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
800 incremented by the values of the prepaid card.
802 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
803 check or set this customer's I<agentnum>.
805 If there is an error, returns the error, otherwise returns false.
811 my( $self, $prepay_credit, %opt ) = @_;
813 local $SIG{HUP} = 'IGNORE';
814 local $SIG{INT} = 'IGNORE';
815 local $SIG{QUIT} = 'IGNORE';
816 local $SIG{TERM} = 'IGNORE';
817 local $SIG{TSTP} = 'IGNORE';
818 local $SIG{PIPE} = 'IGNORE';
820 my $oldAutoCommit = $FS::UID::AutoCommit;
821 local $FS::UID::AutoCommit = 0;
824 unless ( ref($prepay_credit) ) {
826 my $identifier = $prepay_credit;
828 $prepay_credit = qsearchs(
830 { 'identifier' => $identifier },
835 unless ( $prepay_credit ) {
836 $dbh->rollback if $oldAutoCommit;
837 return "Invalid prepaid card: ". $identifier;
842 if ( $prepay_credit->agentnum ) {
843 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
844 $dbh->rollback if $oldAutoCommit;
845 return "prepaid card not valid for agent ". $self->agentnum;
847 $self->agentnum($prepay_credit->agentnum);
850 my $error = $prepay_credit->delete;
852 $dbh->rollback if $oldAutoCommit;
853 return "removing prepay_credit (transaction rolled back): $error";
856 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
857 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
859 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
864 =item increment_upbytes SECONDS
866 Updates this customer's single or primary account (see L<FS::svc_acct>) by
867 the specified number of upbytes. If there is an error, returns the error,
868 otherwise returns false.
872 sub increment_upbytes {
873 _increment_column( shift, 'upbytes', @_);
876 =item increment_downbytes SECONDS
878 Updates this customer's single or primary account (see L<FS::svc_acct>) by
879 the specified number of downbytes. If there is an error, returns the error,
880 otherwise returns false.
884 sub increment_downbytes {
885 _increment_column( shift, 'downbytes', @_);
888 =item increment_totalbytes SECONDS
890 Updates this customer's single or primary account (see L<FS::svc_acct>) by
891 the specified number of totalbytes. If there is an error, returns the error,
892 otherwise returns false.
896 sub increment_totalbytes {
897 _increment_column( shift, 'totalbytes', @_);
900 =item increment_seconds SECONDS
902 Updates this customer's single or primary account (see L<FS::svc_acct>) by
903 the specified number of seconds. If there is an error, returns the error,
904 otherwise returns false.
908 sub increment_seconds {
909 _increment_column( shift, 'seconds', @_);
912 =item _increment_column AMOUNT
914 Updates this customer's single or primary account (see L<FS::svc_acct>) by
915 the specified number of seconds or bytes. If there is an error, returns
916 the error, otherwise returns false.
920 sub _increment_column {
921 my( $self, $column, $amount ) = @_;
922 warn "$me increment_column called: $column, $amount\n"
925 return '' unless $amount;
927 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
928 $self->ncancelled_pkgs;
931 return 'No packages with primary or single services found'.
932 ' to apply pre-paid time';
933 } elsif ( scalar(@cust_pkg) > 1 ) {
934 #maybe have a way to specify the package/account?
935 return 'Multiple packages found to apply pre-paid time';
938 my $cust_pkg = $cust_pkg[0];
939 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
943 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
946 return 'No account found to apply pre-paid time';
947 } elsif ( scalar(@cust_svc) > 1 ) {
948 return 'Multiple accounts found to apply pre-paid time';
951 my $svc_acct = $cust_svc[0]->svc_x;
952 warn " found service svcnum ". $svc_acct->pkgnum.
953 ' ('. $svc_acct->email. ")\n"
956 $column = "increment_$column";
957 $svc_acct->$column($amount);
961 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
963 Inserts a prepayment in the specified amount for this customer. An optional
964 second argument can specify the prepayment identifier for tracking purposes.
965 If there is an error, returns the error, otherwise returns false.
969 sub insert_cust_pay_prepay {
970 shift->insert_cust_pay('PREP', @_);
973 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
975 Inserts a cash payment in the specified amount for this customer. An optional
976 second argument can specify the payment identifier for tracking purposes.
977 If there is an error, returns the error, otherwise returns false.
981 sub insert_cust_pay_cash {
982 shift->insert_cust_pay('CASH', @_);
985 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
987 Inserts a Western Union payment in the specified amount for this customer. An
988 optional second argument can specify the prepayment identifier for tracking
989 purposes. If there is an error, returns the error, otherwise returns false.
993 sub insert_cust_pay_west {
994 shift->insert_cust_pay('WEST', @_);
997 sub insert_cust_pay {
998 my( $self, $payby, $amount ) = splice(@_, 0, 3);
999 my $payinfo = scalar(@_) ? shift : '';
1001 my $cust_pay = new FS::cust_pay {
1002 'custnum' => $self->custnum,
1003 'paid' => sprintf('%.2f', $amount),
1004 #'_date' => #date the prepaid card was purchased???
1006 'payinfo' => $payinfo,
1012 =item delete [ OPTION => VALUE ... ]
1014 This deletes the customer. If there is an error, returns the error, otherwise
1017 This will completely remove all traces of the customer record. This is not
1018 what you want when a customer cancels service; for that, cancel all of the
1019 customer's packages (see L</cancel>).
1021 If the customer has any uncancelled packages, you need to pass a new (valid)
1022 customer number for those packages to be transferred to, as the "new_customer"
1023 option. Cancelled packages will be deleted. Did I mention that this is NOT
1024 what you want when a customer cancels service and that you really should be
1025 looking at L<FS::cust_pkg/cancel>?
1027 You can't delete a customer with invoices (see L<FS::cust_bill>),
1028 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1029 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1030 set the "delete_financials" option to a true value.
1035 my( $self, %opt ) = @_;
1037 local $SIG{HUP} = 'IGNORE';
1038 local $SIG{INT} = 'IGNORE';
1039 local $SIG{QUIT} = 'IGNORE';
1040 local $SIG{TERM} = 'IGNORE';
1041 local $SIG{TSTP} = 'IGNORE';
1042 local $SIG{PIPE} = 'IGNORE';
1044 my $oldAutoCommit = $FS::UID::AutoCommit;
1045 local $FS::UID::AutoCommit = 0;
1048 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1049 $dbh->rollback if $oldAutoCommit;
1050 return "Can't delete a master agent customer";
1053 #use FS::access_user
1054 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1055 $dbh->rollback if $oldAutoCommit;
1056 return "Can't delete a master employee customer";
1059 tie my %financial_tables, 'Tie::IxHash',
1060 'cust_bill' => 'invoices',
1061 'cust_statement' => 'statements',
1062 'cust_credit' => 'credits',
1063 'cust_pay' => 'payments',
1064 'cust_refund' => 'refunds',
1067 foreach my $table ( keys %financial_tables ) {
1069 my @records = $self->$table();
1071 if ( @records && ! $opt{'delete_financials'} ) {
1072 $dbh->rollback if $oldAutoCommit;
1073 return "Can't delete a customer with ". $financial_tables{$table};
1076 foreach my $record ( @records ) {
1077 my $error = $record->delete;
1079 $dbh->rollback if $oldAutoCommit;
1080 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1086 my @cust_pkg = $self->ncancelled_pkgs;
1088 my $new_custnum = $opt{'new_custnum'};
1089 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1090 $dbh->rollback if $oldAutoCommit;
1091 return "Invalid new customer number: $new_custnum";
1093 foreach my $cust_pkg ( @cust_pkg ) {
1094 my %hash = $cust_pkg->hash;
1095 $hash{'custnum'} = $new_custnum;
1096 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1097 my $error = $new_cust_pkg->replace($cust_pkg,
1098 options => { $cust_pkg->options },
1101 $dbh->rollback if $oldAutoCommit;
1106 my @cancelled_cust_pkg = $self->all_pkgs;
1107 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1108 my $error = $cust_pkg->delete;
1110 $dbh->rollback if $oldAutoCommit;
1115 #cust_tax_adjustment in financials?
1116 #cust_pay_pending? ouch
1118 foreach my $table (qw(
1119 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1120 cust_location cust_main_note cust_tax_adjustment
1121 cust_pay_void cust_pay_batch queue cust_tax_exempt
1123 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1124 my $error = $record->delete;
1126 $dbh->rollback if $oldAutoCommit;
1132 my $sth = $dbh->prepare(
1133 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1135 my $errstr = $dbh->errstr;
1136 $dbh->rollback if $oldAutoCommit;
1139 $sth->execute($self->custnum) or do {
1140 my $errstr = $sth->errstr;
1141 $dbh->rollback if $oldAutoCommit;
1147 my $ticket_dbh = '';
1148 if ($conf->config('ticket_system') eq 'RT_Internal') {
1150 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1151 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1152 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1153 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1156 if ( $ticket_dbh ) {
1158 my $ticket_sth = $ticket_dbh->prepare(
1159 'DELETE FROM Links WHERE Target = ?'
1161 my $errstr = $ticket_dbh->errstr;
1162 $dbh->rollback if $oldAutoCommit;
1165 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1167 my $errstr = $ticket_sth->errstr;
1168 $dbh->rollback if $oldAutoCommit;
1172 #check and see if the customer is the only link on the ticket, and
1173 #if so, set the ticket to deleted status in RT?
1174 #maybe someday, for now this will at least fix tickets not displaying
1178 #delete the customer record
1180 my $error = $self->SUPER::delete;
1182 $dbh->rollback if $oldAutoCommit;
1186 # cust_main exports!
1188 #my $export_args = $options{'export_args'} || [];
1191 map qsearch( 'part_export', {exportnum=>$_} ),
1192 $conf->config('cust_main-exports'); #, $agentnum
1194 foreach my $part_export ( @part_export ) {
1195 my $error = $part_export->export_delete( $self ); #, @$export_args);
1197 $dbh->rollback if $oldAutoCommit;
1198 return "exporting to ". $part_export->exporttype.
1199 " (transaction rolled back): $error";
1203 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1208 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1210 This merges this customer into the provided new custnum, and then deletes the
1211 customer. If there is an error, returns the error, otherwise returns false.
1213 The source customer's name, company name, phone numbers, agent,
1214 referring customer, customer class, advertising source, order taker, and
1215 billing information (except balance) are discarded.
1217 All packages are moved to the target customer. Packages with package locations
1218 are preserved. Packages without package locations are moved to a new package
1219 location with the source customer's service/shipping address.
1221 All invoices, statements, payments, credits and refunds are moved to the target
1222 customer. The source customer's balance is added to the target customer.
1224 All notes, attachments, tickets and customer tags are moved to the target
1227 Change history is not currently moved.
1232 my( $self, $new_custnum, %opt ) = @_;
1234 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1236 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1237 or return "Invalid new customer number: $new_custnum";
1239 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1240 if $self->agentnum != $new_cust_main->agentnum
1241 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
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_bill_void' => 'voided invoices',
1277 'cust_statement' => 'statements',
1278 'cust_credit' => 'credits',
1279 'cust_credit_void' => 'voided credits',
1280 'cust_pay' => 'payments',
1281 'cust_pay_void' => 'voided payments',
1282 'cust_refund' => 'refunds',
1285 foreach my $table ( keys %financial_tables ) {
1287 my @records = $self->$table();
1289 foreach my $record ( @records ) {
1290 $record->custnum($new_custnum);
1291 my $error = $record->replace;
1293 $dbh->rollback if $oldAutoCommit;
1294 return "Error merging ". $financial_tables{$table}. ": $error\n";
1300 my $name = $self->ship_name; #?
1302 my $locationnum = '';
1303 foreach my $cust_pkg ( $self->all_pkgs ) {
1304 $cust_pkg->custnum($new_custnum);
1306 unless ( $cust_pkg->locationnum ) {
1307 unless ( $locationnum ) {
1308 my $cust_location = new FS::cust_location {
1309 $self->location_hash,
1310 'custnum' => $new_custnum,
1312 my $error = $cust_location->insert;
1314 $dbh->rollback if $oldAutoCommit;
1317 $locationnum = $cust_location->locationnum;
1319 $cust_pkg->locationnum($locationnum);
1322 my $error = $cust_pkg->replace;
1324 $dbh->rollback if $oldAutoCommit;
1328 # add customer (ship) name to svc_phone.phone_name if blank
1329 my @cust_svc = $cust_pkg->cust_svc;
1330 foreach my $cust_svc (@cust_svc) {
1331 my($label, $value, $svcdb) = $cust_svc->label;
1332 next unless $svcdb eq 'svc_phone';
1333 my $svc_phone = $cust_svc->svc_x;
1334 next if $svc_phone->phone_name;
1335 $svc_phone->phone_name($name);
1336 my $error = $svc_phone->replace;
1338 $dbh->rollback if $oldAutoCommit;
1346 # cust_tax_exempt (texas tax exemptions)
1347 # cust_recon (some sort of not-well understood thing for OnPac)
1349 #these are moved over
1350 foreach my $table (qw(
1351 cust_tag cust_location contact cust_attachment cust_main_note
1352 cust_tax_adjustment cust_pay_batch queue
1354 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1355 $record->custnum($new_custnum);
1356 my $error = $record->replace;
1358 $dbh->rollback if $oldAutoCommit;
1364 #these aren't preserved
1365 foreach my $table (qw(
1366 cust_main_exemption cust_main_invoice
1368 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1369 my $error = $record->delete;
1371 $dbh->rollback if $oldAutoCommit;
1378 my $sth = $dbh->prepare(
1379 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1381 my $errstr = $dbh->errstr;
1382 $dbh->rollback if $oldAutoCommit;
1385 $sth->execute($new_custnum, $self->custnum) or do {
1386 my $errstr = $sth->errstr;
1387 $dbh->rollback if $oldAutoCommit;
1393 my $ticket_dbh = '';
1394 if ($conf->config('ticket_system') eq 'RT_Internal') {
1396 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1397 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1398 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1399 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1402 if ( $ticket_dbh ) {
1404 my $ticket_sth = $ticket_dbh->prepare(
1405 'UPDATE Links SET Target = ? WHERE Target = ?'
1407 my $errstr = $ticket_dbh->errstr;
1408 $dbh->rollback if $oldAutoCommit;
1411 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1412 'freeside://freeside/cust_main/'.$self->custnum)
1414 my $errstr = $ticket_sth->errstr;
1415 $dbh->rollback if $oldAutoCommit;
1421 #delete the customer record
1423 my $error = $self->delete;
1425 $dbh->rollback if $oldAutoCommit;
1429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1434 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1436 Replaces the OLD_RECORD with this one in the database. If there is an error,
1437 returns the error, otherwise returns false.
1439 To change the customer's address, set the pseudo-fields C<bill_location> and
1440 C<ship_location>. The address will still only change if at least one of the
1441 address fields differs from the existing values.
1443 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1444 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1445 expected and rollback the entire transaction; it is not necessary to call
1446 check_invoicing_list first. Here's an example:
1448 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1450 Currently available options are: I<tax_exemption>.
1452 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1453 of tax names and exemption numbers. FS::cust_main_exemption records will be
1454 deleted and inserted as appropriate.
1461 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1463 : $self->replace_old;
1467 warn "$me replace called\n"
1470 my $curuser = $FS::CurrentUser::CurrentUser;
1471 if ( $self->payby eq 'COMP'
1472 && $self->payby ne $old->payby
1473 && ! $curuser->access_right('Complimentary customer')
1476 return "You are not permitted to create complimentary accounts.";
1479 local($ignore_expired_card) = 1
1480 if $old->payby =~ /^(CARD|DCRD)$/
1481 && $self->payby =~ /^(CARD|DCRD)$/
1482 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1484 local($ignore_banned_card) = 1
1485 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1486 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1487 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1489 return "Invoicing locale is required"
1492 && $conf->exists('cust_main-require_locale');
1494 local $SIG{HUP} = 'IGNORE';
1495 local $SIG{INT} = 'IGNORE';
1496 local $SIG{QUIT} = 'IGNORE';
1497 local $SIG{TERM} = 'IGNORE';
1498 local $SIG{TSTP} = 'IGNORE';
1499 local $SIG{PIPE} = 'IGNORE';
1501 my $oldAutoCommit = $FS::UID::AutoCommit;
1502 local $FS::UID::AutoCommit = 0;
1505 for my $l (qw(bill_location ship_location)) {
1506 my $old_loc = $old->$l;
1507 my $new_loc = $self->$l;
1509 # find the existing location if there is one
1510 $new_loc->set('custnum' => $self->custnum);
1511 my $error = $new_loc->find_or_insert;
1513 $dbh->rollback if $oldAutoCommit;
1516 $self->set($l.'num', $new_loc->locationnum);
1519 # replace the customer record
1520 my $error = $self->SUPER::replace($old);
1523 $dbh->rollback if $oldAutoCommit;
1527 # now move packages to the new service location
1528 $self->set('ship_location', ''); #flush cache
1529 if ( $old->ship_locationnum and # should only be null during upgrade...
1530 $old->ship_locationnum != $self->ship_locationnum ) {
1531 $error = $old->ship_location->move_to($self->ship_location);
1533 $dbh->rollback if $oldAutoCommit;
1537 # don't move packages based on the billing location, but
1538 # disable it if it's no longer in use
1539 if ( $old->bill_locationnum and
1540 $old->bill_locationnum != $self->bill_locationnum ) {
1541 $error = $old->bill_location->disable_if_unused;
1543 $dbh->rollback if $oldAutoCommit;
1548 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1549 my $invoicing_list = shift @param;
1550 $error = $self->check_invoicing_list( $invoicing_list );
1552 $dbh->rollback if $oldAutoCommit;
1555 $self->invoicing_list( $invoicing_list );
1558 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1560 #this could be more efficient than deleting and re-inserting, if it matters
1561 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1562 my $error = $cust_tag->delete;
1564 $dbh->rollback if $oldAutoCommit;
1568 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1569 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1570 'custnum' => $self->custnum };
1571 my $error = $cust_tag->insert;
1573 $dbh->rollback if $oldAutoCommit;
1580 my %options = @param;
1582 my $tax_exemption = delete $options{'tax_exemption'};
1583 if ( $tax_exemption ) {
1585 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1586 if ref($tax_exemption) eq 'ARRAY';
1588 my %cust_main_exemption =
1589 map { $_->taxname => $_ }
1590 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1592 foreach my $taxname ( keys %$tax_exemption ) {
1594 if ( $cust_main_exemption{$taxname} &&
1595 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1598 delete $cust_main_exemption{$taxname};
1602 my $cust_main_exemption = new FS::cust_main_exemption {
1603 'custnum' => $self->custnum,
1604 'taxname' => $taxname,
1605 'exempt_number' => $tax_exemption->{$taxname},
1607 my $error = $cust_main_exemption->insert;
1609 $dbh->rollback if $oldAutoCommit;
1610 return "inserting cust_main_exemption (transaction rolled back): $error";
1614 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1615 my $error = $cust_main_exemption->delete;
1617 $dbh->rollback if $oldAutoCommit;
1618 return "deleting cust_main_exemption (transaction rolled back): $error";
1624 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1625 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1626 && $self->get('payinfo') !~ /^99\d{14}$/
1628 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1633 # card/check/lec info has changed, want to retry realtime_ invoice events
1634 my $error = $self->retry_realtime;
1636 $dbh->rollback if $oldAutoCommit;
1641 unless ( $import || $skip_fuzzyfiles ) {
1642 $error = $self->queue_fuzzyfiles_update;
1644 $dbh->rollback if $oldAutoCommit;
1645 return "updating fuzzy search cache: $error";
1649 # tax district update in cust_location
1651 # cust_main exports!
1653 my $export_args = $options{'export_args'} || [];
1656 map qsearch( 'part_export', {exportnum=>$_} ),
1657 $conf->config('cust_main-exports'); #, $agentnum
1659 foreach my $part_export ( @part_export ) {
1660 my $error = $part_export->export_replace( $self, $old, @$export_args);
1662 $dbh->rollback if $oldAutoCommit;
1663 return "exporting to ". $part_export->exporttype.
1664 " (transaction rolled back): $error";
1668 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1673 =item queue_fuzzyfiles_update
1675 Used by insert & replace to update the fuzzy search cache
1679 use FS::cust_main::Search;
1680 sub queue_fuzzyfiles_update {
1683 local $SIG{HUP} = 'IGNORE';
1684 local $SIG{INT} = 'IGNORE';
1685 local $SIG{QUIT} = 'IGNORE';
1686 local $SIG{TERM} = 'IGNORE';
1687 local $SIG{TSTP} = 'IGNORE';
1688 local $SIG{PIPE} = 'IGNORE';
1690 my $oldAutoCommit = $FS::UID::AutoCommit;
1691 local $FS::UID::AutoCommit = 0;
1694 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1695 my $queue = new FS::queue {
1696 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1698 my @args = "cust_main.$field", $self->get($field);
1699 my $error = $queue->insert( @args );
1701 $dbh->rollback if $oldAutoCommit;
1702 return "queueing job (transaction rolled back): $error";
1707 push @locations, $self->bill_location if $self->bill_locationnum;
1708 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1709 foreach my $location (@locations) {
1710 my $queue = new FS::queue {
1711 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1713 my @args = 'cust_location.address1', $location->address1;
1714 my $error = $queue->insert( @args );
1716 $dbh->rollback if $oldAutoCommit;
1717 return "queueing job (transaction rolled back): $error";
1721 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1728 Checks all fields to make sure this is a valid customer record. If there is
1729 an error, returns the error, otherwise returns false. Called by the insert
1730 and replace methods.
1737 warn "$me check BEFORE: \n". $self->_dump
1741 $self->ut_numbern('custnum')
1742 || $self->ut_number('agentnum')
1743 || $self->ut_textn('agent_custid')
1744 || $self->ut_number('refnum')
1745 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1746 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1747 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1748 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1749 || $self->ut_textn('custbatch')
1750 || $self->ut_name('last')
1751 || $self->ut_name('first')
1752 || $self->ut_snumbern('signupdate')
1753 || $self->ut_snumbern('birthdate')
1754 || $self->ut_namen('spouse_last')
1755 || $self->ut_namen('spouse_first')
1756 || $self->ut_snumbern('spouse_birthdate')
1757 || $self->ut_snumbern('anniversary_date')
1758 || $self->ut_textn('company')
1759 || $self->ut_textn('ship_company')
1760 || $self->ut_anything('comments')
1761 || $self->ut_numbern('referral_custnum')
1762 || $self->ut_textn('stateid')
1763 || $self->ut_textn('stateid_state')
1764 || $self->ut_textn('invoice_terms')
1765 || $self->ut_floatn('cdr_termination_percentage')
1766 || $self->ut_floatn('credit_limit')
1767 || $self->ut_numbern('billday')
1768 || $self->ut_numbern('prorate_day')
1769 || $self->ut_flag('edit_subject')
1770 || $self->ut_flag('calling_list_exempt')
1771 || $self->ut_flag('invoice_noemail')
1772 || $self->ut_flag('message_noemail')
1773 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1774 || $self->ut_currencyn('currency')
1777 foreach (qw(company ship_company)) {
1778 my $company = $self->get($_);
1779 $company =~ s/^\s+//;
1780 $company =~ s/\s+$//;
1781 $company =~ s/\s+/ /g;
1782 $self->set($_, $company);
1785 #barf. need message catalogs. i18n. etc.
1786 $error .= "Please select an advertising source."
1787 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1788 return $error if $error;
1790 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1791 or return "Unknown agent";
1793 if ( $self->currency ) {
1794 my $agent_currency = qsearchs( 'agent_currency', {
1795 'agentnum' => $agent->agentnum,
1796 'currency' => $self->currency,
1798 or return "Agent ". $agent->agent.
1799 " not permitted to offer ". $self->currency. " invoicing";
1802 return "Unknown refnum"
1803 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1805 return "Unknown referring custnum: ". $self->referral_custnum
1806 unless ! $self->referral_custnum
1807 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1809 if ( $self->ss eq '' ) {
1814 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1815 or return "Illegal social security number: ". $self->ss;
1816 $self->ss("$1-$2-$3");
1819 # cust_main_county verification now handled by cust_location check
1822 $self->ut_phonen('daytime', $self->country)
1823 || $self->ut_phonen('night', $self->country)
1824 || $self->ut_phonen('fax', $self->country)
1825 || $self->ut_phonen('mobile', $self->country)
1827 return $error if $error;
1829 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1831 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1834 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1836 : FS::Msgcat::_gettext('daytime');
1837 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1839 : FS::Msgcat::_gettext('night');
1841 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1843 : FS::Msgcat::_gettext('mobile');
1845 return "$daytime_label, $night_label or $mobile_label is required"
1849 ### start of stuff moved to cust_payby
1850 # then mostly kept here to support upgrades (can remove in 5.x)
1851 # but modified to allow everything to be empty
1853 if ( $self->payby ) {
1854 FS::payby->can_payby($self->table, $self->payby)
1855 or return "Illegal payby: ". $self->payby;
1860 $error = $self->ut_numbern('paystart_month')
1861 || $self->ut_numbern('paystart_year')
1862 || $self->ut_numbern('payissue')
1863 || $self->ut_textn('paytype')
1865 return $error if $error;
1867 if ( $self->payip eq '' ) {
1870 $error = $self->ut_ip('payip');
1871 return $error if $error;
1874 # If it is encrypted and the private key is not availaible then we can't
1875 # check the credit card.
1876 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1878 # Need some kind of global flag to accept invalid cards, for testing
1880 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1881 $self->payby =~ /^(CARD|DCRD)$/ ) {
1883 my $payinfo = $self->payinfo;
1884 $payinfo =~ s/\D//g;
1885 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1886 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1888 $self->payinfo($payinfo);
1890 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1892 return gettext('unknown_card_type')
1893 if $self->payinfo !~ /^99\d{14}$/ #token
1894 && cardtype($self->payinfo) eq "Unknown";
1896 unless ( $ignore_banned_card ) {
1897 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1899 if ( $ban->bantype eq 'warn' ) {
1900 #or others depending on value of $ban->reason ?
1901 return '_duplicate_card'.
1902 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1903 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1904 ' (ban# '. $ban->bannum. ')'
1905 unless $self->override_ban_warn;
1907 return 'Banned credit card: banned on '.
1908 time2str('%a %h %o at %r', $ban->_date).
1909 ' by '. $ban->otaker.
1910 ' (ban# '. $ban->bannum. ')';
1915 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1916 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1917 $self->paycvv =~ /^(\d{4})$/
1918 or return "CVV2 (CID) for American Express cards is four digits.";
1921 $self->paycvv =~ /^(\d{3})$/
1922 or return "CVV2 (CVC2/CID) is three digits.";
1929 my $cardtype = cardtype($payinfo);
1930 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1932 return "Start date or issue number is required for $cardtype cards"
1933 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1935 return "Start month must be between 1 and 12"
1936 if $self->paystart_month
1937 and $self->paystart_month < 1 || $self->paystart_month > 12;
1939 return "Start year must be 1990 or later"
1940 if $self->paystart_year
1941 and $self->paystart_year < 1990;
1943 return "Issue number must be beween 1 and 99"
1945 and $self->payissue < 1 || $self->payissue > 99;
1948 $self->paystart_month('');
1949 $self->paystart_year('');
1950 $self->payissue('');
1953 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1954 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1956 my $payinfo = $self->payinfo;
1957 $payinfo =~ s/[^\d\@\.]//g;
1958 if ( $conf->config('echeck-country') eq 'CA' ) {
1959 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1960 or return 'invalid echeck account@branch.bank';
1961 $payinfo = "$1\@$2.$3";
1962 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1963 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1964 $payinfo = "$1\@$2";
1966 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1967 $payinfo = "$1\@$2";
1969 $self->payinfo($payinfo);
1972 unless ( $ignore_banned_card ) {
1973 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1975 if ( $ban->bantype eq 'warn' ) {
1976 #or others depending on value of $ban->reason ?
1977 return '_duplicate_ach' unless $self->override_ban_warn;
1979 return 'Banned ACH account: banned on '.
1980 time2str('%a %h %o at %r', $ban->_date).
1981 ' by '. $ban->otaker.
1982 ' (ban# '. $ban->bannum. ')';
1987 } elsif ( $self->payby eq 'LECB' ) {
1989 my $payinfo = $self->payinfo;
1990 $payinfo =~ s/\D//g;
1991 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1993 $self->payinfo($payinfo);
1996 } elsif ( $self->payby eq 'BILL' ) {
1998 $error = $self->ut_textn('payinfo');
1999 return "Illegal P.O. number: ". $self->payinfo if $error;
2002 } elsif ( $self->payby eq 'COMP' ) {
2004 my $curuser = $FS::CurrentUser::CurrentUser;
2005 if ( ! $self->custnum
2006 && ! $curuser->access_right('Complimentary customer')
2009 return "You are not permitted to create complimentary accounts."
2012 $error = $self->ut_textn('payinfo');
2013 return "Illegal comp account issuer: ". $self->payinfo if $error;
2016 } elsif ( $self->payby eq 'PREPAY' ) {
2018 my $payinfo = $self->payinfo;
2019 $payinfo =~ s/\W//g; #anything else would just confuse things
2020 $self->payinfo($payinfo);
2021 $error = $self->ut_alpha('payinfo');
2022 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2023 return "Unknown prepayment identifier"
2024 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2029 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2030 return "Expiration date required"
2031 # shouldn't payinfo_check do this?
2032 unless ! $self->payby
2033 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2037 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2038 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2039 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2040 ( $m, $y ) = ( $2, "19$1" );
2041 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2042 ( $m, $y ) = ( $3, "20$2" );
2044 return "Illegal expiration date: ". $self->paydate;
2046 $m = sprintf('%02d',$m);
2047 $self->paydate("$y-$m-01");
2048 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2049 return gettext('expired_card')
2051 && !$ignore_expired_card
2052 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2055 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2056 ( ! $conf->exists('require_cardname')
2057 || $self->payby !~ /^(CARD|DCRD)$/ )
2059 $self->payname( $self->first. " ". $self->getfield('last') );
2062 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2063 $self->payname =~ /^([\w \,\.\-\']*)$/
2064 or return gettext('illegal_name'). " payname: ". $self->payname;
2067 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2068 or return gettext('illegal_name'). " payname: ". $self->payname;
2074 ### end of stuff moved to cust_payby
2076 return "Please select an invoicing locale"
2079 && $conf->exists('cust_main-require_locale');
2081 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2082 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2086 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2088 warn "$me check AFTER: \n". $self->_dump
2091 $self->SUPER::check;
2096 Returns a list of fields which have ship_ duplicates.
2101 qw( last first company
2103 address1 address2 city county state zip country
2105 daytime night fax mobile
2109 =item has_ship_address
2111 Returns true if this customer record has a separate shipping address.
2115 sub has_ship_address {
2117 $self->bill_locationnum != $self->ship_locationnum;
2122 Returns a list of key/value pairs, with the following keys: address1,
2123 adddress2, city, county, state, zip, country, district, and geocode. The
2124 shipping address is used if present.
2130 $self->ship_location->location_hash;
2135 Returns all locations (see L<FS::cust_location>) for this customer.
2141 qsearch('cust_location', { 'custnum' => $self->custnum,
2142 'prospectnum' => '' } );
2147 Returns all contacts (see L<FS::contact>) for this customer.
2151 #already used :/ sub contact {
2154 qsearch('contact', { 'custnum' => $self->custnum } );
2159 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2166 'table' => 'cust_payby',
2167 'hashref' => { 'custnum' => $self->custnum },
2168 'order_by' => 'ORDER BY weight ASC',
2174 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2175 and L<FS::cust_pkg>) for this customer, except those on hold.
2177 Returns a list: an empty list on success or a list of errors.
2183 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2188 Unsuspends all suspended packages in the on-hold state (those without setup
2189 dates) for this customer.
2195 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2200 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2202 Returns a list: an empty list on success or a list of errors.
2208 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2211 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2213 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2214 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2215 of a list of pkgparts; the hashref has the following keys:
2219 =item pkgparts - listref of pkgparts
2221 =item (other options are passed to the suspend method)
2226 Returns a list: an empty list on success or a list of errors.
2230 sub suspend_if_pkgpart {
2232 my (@pkgparts, %opt);
2233 if (ref($_[0]) eq 'HASH'){
2234 @pkgparts = @{$_[0]{pkgparts}};
2239 grep { $_->suspend(%opt) }
2240 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2241 $self->unsuspended_pkgs;
2244 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2246 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2247 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2248 instead of a list of pkgparts; the hashref has the following keys:
2252 =item pkgparts - listref of pkgparts
2254 =item (other options are passed to the suspend method)
2258 Returns a list: an empty list on success or a list of errors.
2262 sub suspend_unless_pkgpart {
2264 my (@pkgparts, %opt);
2265 if (ref($_[0]) eq 'HASH'){
2266 @pkgparts = @{$_[0]{pkgparts}};
2271 grep { $_->suspend(%opt) }
2272 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2273 $self->unsuspended_pkgs;
2276 =item cancel [ OPTION => VALUE ... ]
2278 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2280 Available options are:
2284 =item quiet - can be set true to supress email cancellation notices.
2286 =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.
2288 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2290 =item nobill - can be set true to skip billing if it might otherwise be done.
2294 Always returns a list: an empty list on success or a list of errors.
2298 # nb that dates are not specified as valid options to this method
2301 my( $self, %opt ) = @_;
2303 warn "$me cancel called on customer ". $self->custnum. " with options ".
2304 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2307 return ( 'access denied' )
2308 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2310 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2312 #should try decryption (we might have the private key)
2313 # and if not maybe queue a job for the server that does?
2314 return ( "Can't (yet) ban encrypted credit cards" )
2315 if $self->is_encrypted($self->payinfo);
2317 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2318 my $error = $ban->insert;
2319 return ( $error ) if $error;
2323 my @pkgs = $self->ncancelled_pkgs;
2325 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2327 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2328 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2332 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2333 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2336 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2339 sub _banned_pay_hashref {
2350 'payby' => $payby2ban{$self->payby},
2351 'payinfo' => $self->payinfo,
2352 #don't ever *search* on reason! #'reason' =>
2356 sub _new_banned_pay_hashref {
2358 my $hr = $self->_banned_pay_hashref;
2359 $hr->{payinfo} = md5_base64($hr->{payinfo});
2365 Returns all notes (see L<FS::cust_main_note>) for this customer.
2370 my($self,$orderby_classnum) = (shift,shift);
2371 my $orderby = "_DATE DESC";
2372 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2373 qsearch( 'cust_main_note',
2374 { 'custnum' => $self->custnum },
2376 "ORDER BY $orderby",
2382 Returns the agent (see L<FS::agent>) for this customer.
2386 Returns the agent name (see L<FS::agent>) for this customer.
2392 $self->agent->agent;
2397 Returns any tags associated with this customer, as FS::cust_tag objects,
2398 or an empty list if there are no tags.
2402 Returns any tags associated with this customer, as FS::part_tag objects,
2403 or an empty list if there are no tags.
2409 map $_->part_tag, $self->cust_tag;
2415 Returns the customer class, as an FS::cust_class object, or the empty string
2416 if there is no customer class.
2420 Returns the customer category name, or the empty string if there is no customer
2427 my $cust_class = $self->cust_class;
2429 ? $cust_class->categoryname
2435 Returns the customer class name, or the empty string if there is no customer
2442 my $cust_class = $self->cust_class;
2444 ? $cust_class->classname
2448 =item BILLING METHODS
2450 Documentation on billing methods has been moved to
2451 L<FS::cust_main::Billing>.
2453 =item REALTIME BILLING METHODS
2455 Documentation on realtime billing methods has been moved to
2456 L<FS::cust_main::Billing_Realtime>.
2460 Removes the I<paycvv> field from the database directly.
2462 If there is an error, returns the error, otherwise returns false.
2468 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2469 or return dbh->errstr;
2470 $sth->execute($self->custnum)
2471 or return $sth->errstr;
2476 =item batch_card OPTION => VALUE...
2478 Adds a payment for this invoice to the pending credit card batch (see
2479 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2480 runs the payment using a realtime gateway.
2482 Options may include:
2484 B<amount>: the amount to be paid; defaults to the customer's balance minus
2485 any payments in transit.
2487 B<payby>: the payment method; defaults to cust_main.payby
2489 B<realtime>: runs this as a realtime payment instead of adding it to a
2492 B<invnum>: sets cust_pay_batch.invnum.
2494 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2495 the billing address for the payment; defaults to the customer's billing
2498 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2499 date, and name; defaults to those fields in cust_main.
2504 my ($self, %options) = @_;
2507 if (exists($options{amount})) {
2508 $amount = $options{amount};
2510 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2512 return '' unless $amount > 0;
2514 my $invnum = delete $options{invnum};
2515 my $payby = $options{payby} || $self->payby; #still dubious
2517 if ($options{'realtime'}) {
2518 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2524 my $oldAutoCommit = $FS::UID::AutoCommit;
2525 local $FS::UID::AutoCommit = 0;
2528 #this needs to handle mysql as well as Pg, like svc_acct.pm
2529 #(make it into a common function if folks need to do batching with mysql)
2530 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2531 or return "Cannot lock pay_batch: " . $dbh->errstr;
2535 'payby' => FS::payby->payby2payment($payby),
2537 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2539 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2541 unless ( $pay_batch ) {
2542 $pay_batch = new FS::pay_batch \%pay_batch;
2543 my $error = $pay_batch->insert;
2545 $dbh->rollback if $oldAutoCommit;
2546 die "error creating new batch: $error\n";
2550 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2551 'batchnum' => $pay_batch->batchnum,
2552 'custnum' => $self->custnum,
2555 foreach (qw( address1 address2 city state zip country latitude longitude
2556 payby payinfo paydate payname ))
2558 $options{$_} = '' unless exists($options{$_});
2561 my $loc = $self->bill_location;
2563 my $cust_pay_batch = new FS::cust_pay_batch ( {
2564 'batchnum' => $pay_batch->batchnum,
2565 'invnum' => $invnum || 0, # is there a better value?
2566 # this field should be
2568 # cust_bill_pay_batch now
2569 'custnum' => $self->custnum,
2570 'last' => $self->getfield('last'),
2571 'first' => $self->getfield('first'),
2572 'address1' => $options{address1} || $loc->address1,
2573 'address2' => $options{address2} || $loc->address2,
2574 'city' => $options{city} || $loc->city,
2575 'state' => $options{state} || $loc->state,
2576 'zip' => $options{zip} || $loc->zip,
2577 'country' => $options{country} || $loc->country,
2578 'payby' => $options{payby} || $self->payby,
2579 'payinfo' => $options{payinfo} || $self->payinfo,
2580 'exp' => $options{paydate} || $self->paydate,
2581 'payname' => $options{payname} || $self->payname,
2582 'amount' => $amount, # consolidating
2585 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2586 if $old_cust_pay_batch;
2589 if ($old_cust_pay_batch) {
2590 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2592 $error = $cust_pay_batch->insert;
2596 $dbh->rollback if $oldAutoCommit;
2600 my $unapplied = $self->total_unapplied_credits
2601 + $self->total_unapplied_payments
2602 + $self->in_transit_payments;
2603 foreach my $cust_bill ($self->open_cust_bill) {
2604 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2605 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2606 'invnum' => $cust_bill->invnum,
2607 'paybatchnum' => $cust_pay_batch->paybatchnum,
2608 'amount' => $cust_bill->owed,
2611 if ($unapplied >= $cust_bill_pay_batch->amount){
2612 $unapplied -= $cust_bill_pay_batch->amount;
2615 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2616 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2618 $error = $cust_bill_pay_batch->insert;
2620 $dbh->rollback if $oldAutoCommit;
2625 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2631 Returns the total owed for this customer on all invoices
2632 (see L<FS::cust_bill/owed>).
2638 $self->total_owed_date(2145859200); #12/31/2037
2641 =item total_owed_date TIME
2643 Returns the total owed for this customer on all invoices with date earlier than
2644 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2645 see L<Time::Local> and L<Date::Parse> for conversion functions.
2649 sub total_owed_date {
2653 my $custnum = $self->custnum;
2655 my $owed_sql = FS::cust_bill->owed_sql;
2658 SELECT SUM($owed_sql) FROM cust_bill
2659 WHERE custnum = $custnum
2663 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2667 =item total_owed_pkgnum PKGNUM
2669 Returns the total owed on all invoices for this customer's specific package
2670 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2674 sub total_owed_pkgnum {
2675 my( $self, $pkgnum ) = @_;
2676 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2679 =item total_owed_date_pkgnum TIME PKGNUM
2681 Returns the total owed for this customer's specific package when using
2682 experimental package balances on all invoices with date earlier than
2683 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2684 see L<Time::Local> and L<Date::Parse> for conversion functions.
2688 sub total_owed_date_pkgnum {
2689 my( $self, $time, $pkgnum ) = @_;
2692 foreach my $cust_bill (
2693 grep { $_->_date <= $time }
2694 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2696 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2698 sprintf( "%.2f", $total_bill );
2704 Returns the total amount of all payments.
2711 $total += $_->paid foreach $self->cust_pay;
2712 sprintf( "%.2f", $total );
2715 =item total_unapplied_credits
2717 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2718 customer. See L<FS::cust_credit/credited>.
2720 =item total_credited
2722 Old name for total_unapplied_credits. Don't use.
2726 sub total_credited {
2727 #carp "total_credited deprecated, use total_unapplied_credits";
2728 shift->total_unapplied_credits(@_);
2731 sub total_unapplied_credits {
2734 my $custnum = $self->custnum;
2736 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2739 SELECT SUM($unapplied_sql) FROM cust_credit
2740 WHERE custnum = $custnum
2743 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2747 =item total_unapplied_credits_pkgnum PKGNUM
2749 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2750 customer. See L<FS::cust_credit/credited>.
2754 sub total_unapplied_credits_pkgnum {
2755 my( $self, $pkgnum ) = @_;
2756 my $total_credit = 0;
2757 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2758 sprintf( "%.2f", $total_credit );
2762 =item total_unapplied_payments
2764 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2765 See L<FS::cust_pay/unapplied>.
2769 sub total_unapplied_payments {
2772 my $custnum = $self->custnum;
2774 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2777 SELECT SUM($unapplied_sql) FROM cust_pay
2778 WHERE custnum = $custnum
2781 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2785 =item total_unapplied_payments_pkgnum PKGNUM
2787 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2788 specific package when using experimental package balances. See
2789 L<FS::cust_pay/unapplied>.
2793 sub total_unapplied_payments_pkgnum {
2794 my( $self, $pkgnum ) = @_;
2795 my $total_unapplied = 0;
2796 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2797 sprintf( "%.2f", $total_unapplied );
2801 =item total_unapplied_refunds
2803 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2804 customer. See L<FS::cust_refund/unapplied>.
2808 sub total_unapplied_refunds {
2810 my $custnum = $self->custnum;
2812 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2815 SELECT SUM($unapplied_sql) FROM cust_refund
2816 WHERE custnum = $custnum
2819 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2825 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2826 total_unapplied_credits minus total_unapplied_payments).
2832 $self->balance_date_range;
2835 =item balance_date TIME
2837 Returns the balance for this customer, only considering invoices with date
2838 earlier than TIME (total_owed_date minus total_credited minus
2839 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2840 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2847 $self->balance_date_range(shift);
2850 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2852 Returns the balance for this customer, optionally considering invoices with
2853 date earlier than START_TIME, and not later than END_TIME
2854 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2856 Times are specified as SQL fragments or numeric
2857 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2858 L<Date::Parse> for conversion functions. The empty string can be passed
2859 to disable that time constraint completely.
2861 Accepts the same options as L<balance_date_sql>:
2865 =item unapplied_date
2867 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)
2871 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2872 time will be ignored. Note that START_TIME and END_TIME only limit the date
2873 range for invoices and I<unapplied> payments, credits, and refunds.
2879 sub balance_date_range {
2881 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2882 ') FROM cust_main WHERE custnum='. $self->custnum;
2883 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2886 =item balance_pkgnum PKGNUM
2888 Returns the balance for this customer's specific package when using
2889 experimental package balances (total_owed plus total_unrefunded, minus
2890 total_unapplied_credits minus total_unapplied_payments)
2894 sub balance_pkgnum {
2895 my( $self, $pkgnum ) = @_;
2898 $self->total_owed_pkgnum($pkgnum)
2899 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2900 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2901 - $self->total_unapplied_credits_pkgnum($pkgnum)
2902 - $self->total_unapplied_payments_pkgnum($pkgnum)
2906 =item in_transit_payments
2908 Returns the total of requests for payments for this customer pending in
2909 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2913 sub in_transit_payments {
2915 my $in_transit_payments = 0;
2916 foreach my $pay_batch ( qsearch('pay_batch', {
2919 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2920 'batchnum' => $pay_batch->batchnum,
2921 'custnum' => $self->custnum,
2923 $in_transit_payments += $cust_pay_batch->amount;
2926 sprintf( "%.2f", $in_transit_payments );
2931 Returns a hash of useful information for making a payment.
2941 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2942 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2943 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2947 For credit card transactions:
2959 For electronic check transactions:
2974 $return{balance} = $self->balance;
2976 $return{payname} = $self->payname
2977 || ( $self->first. ' '. $self->get('last') );
2979 $return{$_} = $self->bill_location->$_
2980 for qw(address1 address2 city state zip);
2982 $return{payby} = $self->payby;
2983 $return{stateid_state} = $self->stateid_state;
2985 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2986 $return{card_type} = cardtype($self->payinfo);
2987 $return{payinfo} = $self->paymask;
2989 @return{'month', 'year'} = $self->paydate_monthyear;
2993 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2994 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2995 $return{payinfo1} = $payinfo1;
2996 $return{payinfo2} = $payinfo2;
2997 $return{paytype} = $self->paytype;
2998 $return{paystate} = $self->paystate;
3002 #doubleclick protection
3004 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3010 =item paydate_monthyear
3012 Returns a two-element list consisting of the month and year of this customer's
3013 paydate (credit card expiration date for CARD customers)
3017 sub paydate_monthyear {
3019 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3021 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3030 Returns the exact time in seconds corresponding to the payment method
3031 expiration date. For CARD/DCRD customers this is the end of the month;
3032 for others (COMP is the only other payby that uses paydate) it's the start.
3033 Returns 0 if the paydate is empty or set to the far future.
3039 my ($month, $year) = $self->paydate_monthyear;
3040 return 0 if !$year or $year >= 2037;
3041 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3043 if ( $month == 13 ) {
3047 return timelocal(0,0,0,1,$month-1,$year) - 1;
3050 return timelocal(0,0,0,1,$month-1,$year);
3054 =item paydate_epoch_sql
3056 Class method. Returns an SQL expression to obtain the payment expiration date
3057 as a number of seconds.
3061 # Special expiration date behavior for non-CARD/DCRD customers has been
3062 # carefully preserved. Do we really use that?
3063 sub paydate_epoch_sql {
3065 my $table = shift || 'cust_main';
3066 my ($case1, $case2);
3067 if ( driver_name eq 'Pg' ) {
3068 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3069 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3071 elsif ( lc(driver_name) eq 'mysql' ) {
3072 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3073 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3076 return "CASE WHEN $table.payby IN('CARD','DCRD')
3082 =item tax_exemption TAXNAME
3087 my( $self, $taxname ) = @_;
3089 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3090 'taxname' => $taxname,
3095 =item cust_main_exemption
3097 =item invoicing_list [ ARRAYREF ]
3099 If an arguement is given, sets these email addresses as invoice recipients
3100 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3101 (except as warnings), so use check_invoicing_list first.
3103 Returns a list of email addresses (with svcnum entries expanded).
3105 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3106 check it without disturbing anything by passing nothing.
3108 This interface may change in the future.
3112 sub invoicing_list {
3113 my( $self, $arrayref ) = @_;
3116 my @cust_main_invoice;
3117 if ( $self->custnum ) {
3118 @cust_main_invoice =
3119 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3121 @cust_main_invoice = ();
3123 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3124 #warn $cust_main_invoice->destnum;
3125 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3126 #warn $cust_main_invoice->destnum;
3127 my $error = $cust_main_invoice->delete;
3128 warn $error if $error;
3131 if ( $self->custnum ) {
3132 @cust_main_invoice =
3133 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3135 @cust_main_invoice = ();
3137 my %seen = map { $_->address => 1 } @cust_main_invoice;
3138 foreach my $address ( @{$arrayref} ) {
3139 next if exists $seen{$address} && $seen{$address};
3140 $seen{$address} = 1;
3141 my $cust_main_invoice = new FS::cust_main_invoice ( {
3142 'custnum' => $self->custnum,
3145 my $error = $cust_main_invoice->insert;
3146 warn $error if $error;
3150 if ( $self->custnum ) {
3152 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3159 =item check_invoicing_list ARRAYREF
3161 Checks these arguements as valid input for the invoicing_list method. If there
3162 is an error, returns the error, otherwise returns false.
3166 sub check_invoicing_list {
3167 my( $self, $arrayref ) = @_;
3169 foreach my $address ( @$arrayref ) {
3171 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3172 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3175 my $cust_main_invoice = new FS::cust_main_invoice ( {
3176 'custnum' => $self->custnum,
3179 my $error = $self->custnum
3180 ? $cust_main_invoice->check
3181 : $cust_main_invoice->checkdest
3183 return $error if $error;
3187 return "Email address required"
3188 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3189 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3194 =item set_default_invoicing_list
3196 Sets the invoicing list to all accounts associated with this customer,
3197 overwriting any previous invoicing list.
3201 sub set_default_invoicing_list {
3203 $self->invoicing_list($self->all_emails);
3208 Returns the email addresses of all accounts provisioned for this customer.
3215 foreach my $cust_pkg ( $self->all_pkgs ) {
3216 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3218 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3219 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3221 $list{$_}=1 foreach map { $_->email } @svc_acct;
3226 =item invoicing_list_addpost
3228 Adds postal invoicing to this customer. If this customer is already configured
3229 to receive postal invoices, does nothing.
3233 sub invoicing_list_addpost {
3235 return if grep { $_ eq 'POST' } $self->invoicing_list;
3236 my @invoicing_list = $self->invoicing_list;
3237 push @invoicing_list, 'POST';
3238 $self->invoicing_list(\@invoicing_list);
3241 =item invoicing_list_emailonly
3243 Returns the list of email invoice recipients (invoicing_list without non-email
3244 destinations such as POST and FAX).
3248 sub invoicing_list_emailonly {
3250 warn "$me invoicing_list_emailonly called"
3252 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3255 =item invoicing_list_emailonly_scalar
3257 Returns the list of email invoice recipients (invoicing_list without non-email
3258 destinations such as POST and FAX) as a comma-separated scalar.
3262 sub invoicing_list_emailonly_scalar {
3264 warn "$me invoicing_list_emailonly_scalar called"
3266 join(', ', $self->invoicing_list_emailonly);
3269 =item referral_custnum_cust_main
3271 Returns the customer who referred this customer (or the empty string, if
3272 this customer was not referred).
3274 Note the difference with referral_cust_main method: This method,
3275 referral_custnum_cust_main returns the single customer (if any) who referred
3276 this customer, while referral_cust_main returns an array of customers referred
3281 sub referral_custnum_cust_main {
3283 return '' unless $self->referral_custnum;
3284 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3287 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3289 Returns an array of customers referred by this customer (referral_custnum set
3290 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3291 customers referred by customers referred by this customer and so on, inclusive.
3292 The default behavior is DEPTH 1 (no recursion).
3294 Note the difference with referral_custnum_cust_main method: This method,
3295 referral_cust_main, returns an array of customers referred BY this customer,
3296 while referral_custnum_cust_main returns the single customer (if any) who
3297 referred this customer.
3301 sub referral_cust_main {
3303 my $depth = @_ ? shift : 1;
3304 my $exclude = @_ ? shift : {};
3307 map { $exclude->{$_->custnum}++; $_; }
3308 grep { ! $exclude->{ $_->custnum } }
3309 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3313 map { $_->referral_cust_main($depth-1, $exclude) }
3320 =item referral_cust_main_ncancelled
3322 Same as referral_cust_main, except only returns customers with uncancelled
3327 sub referral_cust_main_ncancelled {
3329 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3332 =item referral_cust_pkg [ DEPTH ]
3334 Like referral_cust_main, except returns a flat list of all unsuspended (and
3335 uncancelled) packages for each customer. The number of items in this list may
3336 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3340 sub referral_cust_pkg {
3342 my $depth = @_ ? shift : 1;
3344 map { $_->unsuspended_pkgs }
3345 grep { $_->unsuspended_pkgs }
3346 $self->referral_cust_main($depth);
3349 =item referring_cust_main
3351 Returns the single cust_main record for the customer who referred this customer
3352 (referral_custnum), or false.
3356 sub referring_cust_main {
3358 return '' unless $self->referral_custnum;
3359 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3362 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3364 Applies a credit to this customer. If there is an error, returns the error,
3365 otherwise returns false.
3367 REASON can be a text string, an FS::reason object, or a scalar reference to
3368 a reasonnum. If a text string, it will be automatically inserted as a new
3369 reason, and a 'reason_type' option must be passed to indicate the
3370 FS::reason_type for the new reason.
3372 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3373 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3374 I<commission_pkgnum>.
3376 Any other options are passed to FS::cust_credit::insert.
3381 my( $self, $amount, $reason, %options ) = @_;
3383 my $cust_credit = new FS::cust_credit {
3384 'custnum' => $self->custnum,
3385 'amount' => $amount,
3388 if ( ref($reason) ) {
3390 if ( ref($reason) eq 'SCALAR' ) {
3391 $cust_credit->reasonnum( $$reason );
3393 $cust_credit->reasonnum( $reason->reasonnum );
3397 $cust_credit->set('reason', $reason)
3400 $cust_credit->$_( delete $options{$_} )
3401 foreach grep exists($options{$_}),
3402 qw( addlinfo eventnum ),
3403 map "commission_$_", qw( agentnum salesnum pkgnum );
3405 $cust_credit->insert(%options);
3409 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3411 Creates a one-time charge for this customer. If there is an error, returns
3412 the error, otherwise returns false.
3414 New-style, with a hashref of options:
3416 my $error = $cust_main->charge(
3420 'start_date' => str2time('7/4/2009'),
3421 'pkg' => 'Description',
3422 'comment' => 'Comment',
3423 'additional' => [], #extra invoice detail
3424 'classnum' => 1, #pkg_class
3426 'setuptax' => '', # or 'Y' for tax exempt
3428 'locationnum'=> 1234, # optional
3431 'taxclass' => 'Tax class',
3434 'taxproduct' => 2, #part_pkg_taxproduct
3435 'override' => {}, #XXX describe
3437 #will be filled in with the new object
3438 'cust_pkg_ref' => \$cust_pkg,
3440 #generate an invoice immediately
3442 'invoice_terms' => '', #with these terms
3448 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3454 my ( $amount, $quantity, $start_date, $classnum );
3455 my ( $pkg, $comment, $additional );
3456 my ( $setuptax, $taxclass ); #internal taxes
3457 my ( $taxproduct, $override ); #vendor (CCH) taxes
3459 my $cust_pkg_ref = '';
3460 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3462 if ( ref( $_[0] ) ) {
3463 $amount = $_[0]->{amount};
3464 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3465 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3466 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3467 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3468 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3469 : '$'. sprintf("%.2f",$amount);
3470 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3471 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3472 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3473 $additional = $_[0]->{additional} || [];
3474 $taxproduct = $_[0]->{taxproductnum};
3475 $override = { '' => $_[0]->{tax_override} };
3476 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3477 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3478 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3479 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3484 $pkg = @_ ? shift : 'One-time charge';
3485 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3487 $taxclass = @_ ? shift : '';
3491 local $SIG{HUP} = 'IGNORE';
3492 local $SIG{INT} = 'IGNORE';
3493 local $SIG{QUIT} = 'IGNORE';
3494 local $SIG{TERM} = 'IGNORE';
3495 local $SIG{TSTP} = 'IGNORE';
3496 local $SIG{PIPE} = 'IGNORE';
3498 my $oldAutoCommit = $FS::UID::AutoCommit;
3499 local $FS::UID::AutoCommit = 0;
3502 my $part_pkg = new FS::part_pkg ( {
3504 'comment' => $comment,
3508 'classnum' => ( $classnum ? $classnum : '' ),
3509 'setuptax' => $setuptax,
3510 'taxclass' => $taxclass,
3511 'taxproductnum' => $taxproduct,
3514 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3515 ( 0 .. @$additional - 1 )
3517 'additional_count' => scalar(@$additional),
3518 'setup_fee' => $amount,
3521 my $error = $part_pkg->insert( options => \%options,
3522 tax_overrides => $override,
3525 $dbh->rollback if $oldAutoCommit;
3529 my $pkgpart = $part_pkg->pkgpart;
3530 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3531 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3532 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3533 $error = $type_pkgs->insert;
3535 $dbh->rollback if $oldAutoCommit;
3540 my $cust_pkg = new FS::cust_pkg ( {
3541 'custnum' => $self->custnum,
3542 'pkgpart' => $pkgpart,
3543 'quantity' => $quantity,
3544 'start_date' => $start_date,
3545 'no_auto' => $no_auto,
3546 'locationnum'=> $locationnum,
3549 $error = $cust_pkg->insert;
3551 $dbh->rollback if $oldAutoCommit;
3553 } elsif ( $cust_pkg_ref ) {
3554 ${$cust_pkg_ref} = $cust_pkg;
3558 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3559 'pkg_list' => [ $cust_pkg ],
3562 $dbh->rollback if $oldAutoCommit;
3567 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3572 #=item charge_postal_fee
3574 #Applies a one time charge this customer. If there is an error,
3575 #returns the error, returns the cust_pkg charge object or false
3576 #if there was no charge.
3580 # This should be a customer event. For that to work requires that bill
3581 # also be a customer event.
3583 sub charge_postal_fee {
3586 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3587 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3589 my $cust_pkg = new FS::cust_pkg ( {
3590 'custnum' => $self->custnum,
3591 'pkgpart' => $pkgpart,
3595 my $error = $cust_pkg->insert;
3596 $error ? $error : $cust_pkg;
3599 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3601 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3603 Optionally, a list or hashref of additional arguments to the qsearch call can
3610 my $opt = ref($_[0]) ? shift : { @_ };
3612 #return $self->num_cust_bill unless wantarray || keys %$opt;
3614 $opt->{'table'} = 'cust_bill';
3615 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3616 $opt->{'hashref'}{'custnum'} = $self->custnum;
3617 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3619 map { $_ } #behavior of sort undefined in scalar context
3620 sort { $a->_date <=> $b->_date }
3624 =item open_cust_bill
3626 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3631 sub open_cust_bill {
3635 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3641 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3643 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3647 sub legacy_cust_bill {
3650 #return $self->num_legacy_cust_bill unless wantarray;
3652 map { $_ } #behavior of sort undefined in scalar context
3653 sort { $a->_date <=> $b->_date }
3654 qsearch({ 'table' => 'legacy_cust_bill',
3655 'hashref' => { 'custnum' => $self->custnum, },
3656 'order_by' => 'ORDER BY _date ASC',
3660 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3662 Returns all the statements (see L<FS::cust_statement>) for this customer.
3664 Optionally, a list or hashref of additional arguments to the qsearch call can
3669 =item cust_bill_void
3671 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3675 sub cust_bill_void {
3678 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3679 sort { $a->_date <=> $b->_date }
3680 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3683 sub cust_statement {
3685 my $opt = ref($_[0]) ? shift : { @_ };
3687 #return $self->num_cust_statement unless wantarray || keys %$opt;
3689 $opt->{'table'} = 'cust_statement';
3690 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3691 $opt->{'hashref'}{'custnum'} = $self->custnum;
3692 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3694 map { $_ } #behavior of sort undefined in scalar context
3695 sort { $a->_date <=> $b->_date }
3699 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3701 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3703 Optionally, a list or hashref of additional arguments to the qsearch call can
3704 be passed following the SVCDB.
3711 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3712 warn "$me svc_x requires a svcdb";
3715 my $opt = ref($_[0]) ? shift : { @_ };
3717 $opt->{'table'} = $svcdb;
3718 $opt->{'addl_from'} =
3719 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3720 ($opt->{'addl_from'} || '');
3722 my $custnum = $self->custnum;
3723 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3724 my $where = "cust_pkg.custnum = $custnum";
3726 my $extra_sql = $opt->{'extra_sql'} || '';
3727 if ( keys %{ $opt->{'hashref'} } ) {
3728 $extra_sql = " AND $where $extra_sql";
3731 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3732 $extra_sql = "WHERE $where AND $1";
3735 $extra_sql = "WHERE $where $extra_sql";
3738 $opt->{'extra_sql'} = $extra_sql;
3743 # required for use as an eventtable;
3746 $self->svc_x('svc_acct', @_);
3751 Returns all the credits (see L<FS::cust_credit>) for this customer.
3757 map { $_ } #return $self->num_cust_credit unless wantarray;
3758 sort { $a->_date <=> $b->_date }
3759 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3762 =item cust_credit_pkgnum
3764 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3765 package when using experimental package balances.
3769 sub cust_credit_pkgnum {
3770 my( $self, $pkgnum ) = @_;
3771 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3772 sort { $a->_date <=> $b->_date }
3773 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3774 'pkgnum' => $pkgnum,
3779 =item cust_credit_void
3781 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3785 sub cust_credit_void {
3788 sort { $a->_date <=> $b->_date }
3789 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3794 Returns all the payments (see L<FS::cust_pay>) for this customer.
3800 my $opt = ref($_[0]) ? shift : { @_ };
3802 return $self->num_cust_pay unless wantarray || keys %$opt;
3804 $opt->{'table'} = 'cust_pay';
3805 $opt->{'hashref'}{'custnum'} = $self->custnum;
3807 map { $_ } #behavior of sort undefined in scalar context
3808 sort { $a->_date <=> $b->_date }
3815 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3816 called automatically when the cust_pay method is used in a scalar context.
3822 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3823 my $sth = dbh->prepare($sql) or die dbh->errstr;
3824 $sth->execute($self->custnum) or die $sth->errstr;
3825 $sth->fetchrow_arrayref->[0];
3828 =item unapplied_cust_pay
3830 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3834 sub unapplied_cust_pay {
3838 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3844 =item cust_pay_pkgnum
3846 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3847 package when using experimental package balances.
3851 sub cust_pay_pkgnum {
3852 my( $self, $pkgnum ) = @_;
3853 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3854 sort { $a->_date <=> $b->_date }
3855 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3856 'pkgnum' => $pkgnum,
3863 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3869 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3870 sort { $a->_date <=> $b->_date }
3871 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3874 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3876 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3878 Optionally, a list or hashref of additional arguments to the qsearch call can
3883 sub cust_pay_batch {
3885 my $opt = ref($_[0]) ? shift : { @_ };
3887 #return $self->num_cust_statement unless wantarray || keys %$opt;
3889 $opt->{'table'} = 'cust_pay_batch';
3890 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3891 $opt->{'hashref'}{'custnum'} = $self->custnum;
3892 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3894 map { $_ } #behavior of sort undefined in scalar context
3895 sort { $a->paybatchnum <=> $b->paybatchnum }
3899 =item cust_pay_pending
3901 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3902 (without status "done").
3906 sub cust_pay_pending {
3908 return $self->num_cust_pay_pending unless wantarray;
3909 sort { $a->_date <=> $b->_date }
3910 qsearch( 'cust_pay_pending', {
3911 'custnum' => $self->custnum,
3912 'status' => { op=>'!=', value=>'done' },
3917 =item cust_pay_pending_attempt
3919 Returns all payment attempts / declined payments for this customer, as pending
3920 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3921 a corresponding payment (see L<FS::cust_pay>).
3925 sub cust_pay_pending_attempt {
3927 return $self->num_cust_pay_pending_attempt unless wantarray;
3928 sort { $a->_date <=> $b->_date }
3929 qsearch( 'cust_pay_pending', {
3930 'custnum' => $self->custnum,
3937 =item num_cust_pay_pending
3939 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3940 customer (without status "done"). Also called automatically when the
3941 cust_pay_pending method is used in a scalar context.
3945 sub num_cust_pay_pending {
3948 " SELECT COUNT(*) FROM cust_pay_pending ".
3949 " WHERE custnum = ? AND status != 'done' ",
3954 =item num_cust_pay_pending_attempt
3956 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3957 customer, with status "done" but without a corresp. Also called automatically when the
3958 cust_pay_pending method is used in a scalar context.
3962 sub num_cust_pay_pending_attempt {
3965 " SELECT COUNT(*) FROM cust_pay_pending ".
3966 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3973 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3979 map { $_ } #return $self->num_cust_refund unless wantarray;
3980 sort { $a->_date <=> $b->_date }
3981 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3984 =item display_custnum
3986 Returns the displayed customer number for this customer: agent_custid if
3987 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3991 sub display_custnum {
3994 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3995 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3996 if ( $special eq 'CoStAg' ) {
3997 $prefix = uc( join('',
3999 ($self->state =~ /^(..)/),
4000 $prefix || ($self->agent->agent =~ /^(..)/)
4003 elsif ( $special eq 'CoStCl' ) {
4004 $prefix = uc( join('',
4006 ($self->state =~ /^(..)/),
4007 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
4010 # add any others here if needed
4013 my $length = $conf->config('cust_main-custnum-display_length');
4014 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
4015 return $self->agent_custid;
4016 } elsif ( $prefix ) {
4017 $length = 8 if !defined($length);
4019 sprintf('%0'.$length.'d', $self->custnum)
4020 } elsif ( $length ) {
4021 return sprintf('%0'.$length.'d', $self->custnum);
4023 return $self->custnum;
4029 Returns a name string for this customer, either "Company (Last, First)" or
4036 my $name = $self->contact;
4037 $name = $self->company. " ($name)" if $self->company;
4041 =item service_contact
4043 Returns the L<FS::contact> object for this customer that has the 'Service'
4044 contact class, or undef if there is no such contact. Deprecated; don't use
4049 sub service_contact {
4051 if ( !exists($self->{service_contact}) ) {
4052 my $classnum = $self->scalar_sql(
4053 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4054 ) || 0; #if it's zero, qsearchs will return nothing
4055 $self->{service_contact} = qsearchs('contact', {
4056 'classnum' => $classnum, 'custnum' => $self->custnum
4059 $self->{service_contact};
4064 Returns a name string for this (service/shipping) contact, either
4065 "Company (Last, First)" or "Last, First".
4072 my $name = $self->ship_contact;
4073 $name = $self->company. " ($name)" if $self->company;
4079 Returns a name string for this customer, either "Company" or "First Last".
4085 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4088 =item ship_name_short
4090 Returns a name string for this (service/shipping) contact, either "Company"
4095 sub ship_name_short {
4097 $self->service_contact
4098 ? $self->ship_contact_firstlast
4104 Returns this customer's full (billing) contact name only, "Last, First"
4110 $self->get('last'). ', '. $self->first;
4115 Returns this customer's full (shipping) contact name only, "Last, First"
4121 my $contact = $self->service_contact || $self;
4122 $contact->get('last') . ', ' . $contact->get('first');
4125 =item contact_firstlast
4127 Returns this customers full (billing) contact name only, "First Last".
4131 sub contact_firstlast {
4133 $self->first. ' '. $self->get('last');
4136 =item ship_contact_firstlast
4138 Returns this customer's full (shipping) contact name only, "First Last".
4142 sub ship_contact_firstlast {
4144 my $contact = $self->service_contact || $self;
4145 $contact->get('first') . ' '. $contact->get('last');
4148 #XXX this doesn't work in 3.x+
4151 #Returns this customer's full country name
4157 # code2country($self->country);
4160 sub bill_country_full {
4162 code2country($self->bill_location->country);
4165 sub ship_country_full {
4167 code2country($self->ship_location->country);
4170 =item county_state_county [ PREFIX ]
4172 Returns a string consisting of just the county, state and country.
4176 sub county_state_country {
4179 if ( @_ && $_[0] && $self->has_ship_address ) {
4180 $locationnum = $self->ship_locationnum;
4182 $locationnum = $self->bill_locationnum;
4184 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4185 $cust_location->county_state_country;
4188 =item geocode DATA_VENDOR
4190 Returns a value for the customer location as encoded by DATA_VENDOR.
4191 Currently this only makes sense for "CCH" as DATA_VENDOR.
4199 Returns a status string for this customer, currently:
4203 =item prospect - No packages have ever been ordered
4205 =item ordered - Recurring packages all are new (not yet billed).
4207 =item active - One or more recurring packages is active
4209 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4211 =item suspended - All non-cancelled recurring packages are suspended
4213 =item cancelled - All recurring packages are cancelled
4217 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4218 cust_main-status_module configuration option.
4222 sub status { shift->cust_status(@_); }
4226 for my $status ( FS::cust_main->statuses() ) {
4227 my $method = $status.'_sql';
4228 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4229 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4230 $sth->execute( ($self->custnum) x $numnum )
4231 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4232 return $status if $sth->fetchrow_arrayref->[0];
4236 =item ucfirst_cust_status
4238 =item ucfirst_status
4240 Returns the status with the first character capitalized.
4244 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4246 sub ucfirst_cust_status {
4248 ucfirst($self->cust_status);
4253 Returns a hex triplet color string for this customer's status.
4257 sub statuscolor { shift->cust_statuscolor(@_); }
4259 sub cust_statuscolor {
4261 __PACKAGE__->statuscolors->{$self->cust_status};
4264 =item tickets [ STATUS ]
4266 Returns an array of hashes representing the customer's RT tickets.
4268 An optional status (or arrayref or hashref of statuses) may be specified.
4274 my $status = ( @_ && $_[0] ) ? shift : '';
4276 my $num = $conf->config('cust_main-max_tickets') || 10;
4279 if ( $conf->config('ticket_system') ) {
4280 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4282 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4291 foreach my $priority (
4292 $conf->config('ticket_system-custom_priority_field-values'), ''
4294 last if scalar(@tickets) >= $num;
4296 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4297 $num - scalar(@tickets),
4308 # Return services representing svc_accts in customer support packages
4309 sub support_services {
4311 my %packages = map { $_ => 1 } $conf->config('support_packages');
4313 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4314 grep { $_->part_svc->svcdb eq 'svc_acct' }
4315 map { $_->cust_svc }
4316 grep { exists $packages{ $_->pkgpart } }
4317 $self->ncancelled_pkgs;
4321 # Return a list of latitude/longitude for one of the services (if any)
4322 sub service_coordinates {
4326 grep { $_->latitude && $_->longitude }
4328 map { $_->cust_svc }
4329 $self->ncancelled_pkgs;
4331 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4336 Returns a masked version of the named field
4341 my ($self,$field) = @_;
4345 'x'x(length($self->getfield($field))-4).
4346 substr($self->getfield($field), (length($self->getfield($field))-4));
4352 =head1 CLASS METHODS
4358 Class method that returns the list of possible status strings for customers
4359 (see L<the status method|/status>). For example:
4361 @statuses = FS::cust_main->statuses();
4367 keys %{ $self->statuscolors };
4370 =item cust_status_sql
4372 Returns an SQL fragment to determine the status of a cust_main record, as a
4377 sub cust_status_sql {
4379 for my $status ( FS::cust_main->statuses() ) {
4380 my $method = $status.'_sql';
4381 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4390 Returns an SQL expression identifying prospective cust_main records (customers
4391 with no packages ever ordered)
4395 use vars qw($select_count_pkgs);
4396 $select_count_pkgs =
4397 "SELECT COUNT(*) FROM cust_pkg
4398 WHERE cust_pkg.custnum = cust_main.custnum";
4400 sub select_count_pkgs_sql {
4405 " 0 = ( $select_count_pkgs ) ";
4410 Returns an SQL expression identifying ordered cust_main records (customers with
4411 no active packages, but recurring packages not yet setup or one time charges
4417 FS::cust_main->none_active_sql.
4418 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4423 Returns an SQL expression identifying active cust_main records (customers with
4424 active recurring packages).
4429 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4432 =item none_active_sql
4434 Returns an SQL expression identifying cust_main records with no active
4435 recurring packages. This includes customers of status prospect, ordered,
4436 inactive, and suspended.
4440 sub none_active_sql {
4441 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4446 Returns an SQL expression identifying inactive cust_main records (customers with
4447 no active recurring packages, but otherwise unsuspended/uncancelled).
4452 FS::cust_main->none_active_sql.
4453 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4459 Returns an SQL expression identifying suspended cust_main records.
4464 sub suspended_sql { susp_sql(@_); }
4466 FS::cust_main->none_active_sql.
4467 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4473 Returns an SQL expression identifying cancelled cust_main records.
4477 sub cancel_sql { shift->cancelled_sql(@_); }
4480 =item uncancelled_sql
4482 Returns an SQL expression identifying un-cancelled cust_main records.
4486 sub uncancelled_sql { uncancel_sql(@_); }
4487 sub uncancel_sql { "
4488 ( 0 < ( $select_count_pkgs
4489 AND ( cust_pkg.cancel IS NULL
4490 OR cust_pkg.cancel = 0
4493 OR 0 = ( $select_count_pkgs )
4499 Returns an SQL fragment to retreive the balance.
4504 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4505 WHERE cust_bill.custnum = cust_main.custnum )
4506 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4507 WHERE cust_pay.custnum = cust_main.custnum )
4508 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4509 WHERE cust_credit.custnum = cust_main.custnum )
4510 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4511 WHERE cust_refund.custnum = cust_main.custnum )
4514 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4516 Returns an SQL fragment to retreive the balance for this customer, optionally
4517 considering invoices with date earlier than START_TIME, and not
4518 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4519 total_unapplied_payments).
4521 Times are specified as SQL fragments or numeric
4522 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4523 L<Date::Parse> for conversion functions. The empty string can be passed
4524 to disable that time constraint completely.
4526 Available options are:
4530 =item unapplied_date
4532 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)
4537 set to true to remove all customer comparison clauses, for totals
4542 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4547 JOIN clause (typically used with the total option)
4551 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4552 time will be ignored. Note that START_TIME and END_TIME only limit the date
4553 range for invoices and I<unapplied> payments, credits, and refunds.
4559 sub balance_date_sql {
4560 my( $class, $start, $end, %opt ) = @_;
4562 my $cutoff = $opt{'cutoff'};
4564 my $owed = FS::cust_bill->owed_sql($cutoff);
4565 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4566 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4567 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4569 my $j = $opt{'join'} || '';
4571 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4572 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4573 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4574 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4576 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4577 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4578 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4579 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4584 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4586 Returns an SQL fragment to retreive the total unapplied payments for this
4587 customer, only considering payments with date earlier than START_TIME, and
4588 optionally not later than END_TIME.
4590 Times are specified as SQL fragments or numeric
4591 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4592 L<Date::Parse> for conversion functions. The empty string can be passed
4593 to disable that time constraint completely.
4595 Available options are:
4599 sub unapplied_payments_date_sql {
4600 my( $class, $start, $end, %opt ) = @_;
4602 my $cutoff = $opt{'cutoff'};
4604 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4606 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4607 'unapplied_date'=>1 );
4609 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4612 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4614 Helper method for balance_date_sql; name (and usage) subject to change
4615 (suggestions welcome).
4617 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4618 cust_refund, cust_credit or cust_pay).
4620 If TABLE is "cust_bill" or the unapplied_date option is true, only
4621 considers records with date earlier than START_TIME, and optionally not
4622 later than END_TIME .
4626 sub _money_table_where {
4627 my( $class, $table, $start, $end, %opt ) = @_;
4630 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4631 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4632 push @where, "$table._date <= $start" if defined($start) && length($start);
4633 push @where, "$table._date > $end" if defined($end) && length($end);
4635 push @where, @{$opt{'where'}} if $opt{'where'};
4636 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4642 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4643 use FS::cust_main::Search;
4646 FS::cust_main::Search->search(@_);
4655 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4657 Deprecated. Use event notification and message templates
4658 (L<FS::msg_template>) instead.
4660 Sends a templated email notification to the customer (see L<Text::Template>).
4662 OPTIONS is a hash and may include
4664 I<from> - the email sender (default is invoice_from)
4666 I<to> - comma-separated scalar or arrayref of recipients
4667 (default is invoicing_list)
4669 I<subject> - The subject line of the sent email notification
4670 (default is "Notice from company_name")
4672 I<extra_fields> - a hashref of name/value pairs which will be substituted
4675 The following variables are vavailable in the template.
4677 I<$first> - the customer first name
4678 I<$last> - the customer last name
4679 I<$company> - the customer company
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 account information used to collect for this customer
4683 I<$expdate> - the expiration of the customer payment in seconds from epoch
4688 my ($self, $template, %options) = @_;
4690 return unless $conf->exists($template);
4692 my $from = $conf->config('invoice_from', $self->agentnum)
4693 if $conf->exists('invoice_from', $self->agentnum);
4694 $from = $options{from} if exists($options{from});
4696 my $to = join(',', $self->invoicing_list_emailonly);
4697 $to = $options{to} if exists($options{to});
4699 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4700 if $conf->exists('company_name', $self->agentnum);
4701 $subject = $options{subject} if exists($options{subject});
4703 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4704 SOURCE => [ map "$_\n",
4705 $conf->config($template)]
4707 or die "can't create new Text::Template object: Text::Template::ERROR";
4708 $notify_template->compile()
4709 or die "can't compile template: Text::Template::ERROR";
4711 $FS::notify_template::_template::company_name =
4712 $conf->config('company_name', $self->agentnum);
4713 $FS::notify_template::_template::company_address =
4714 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4716 my $paydate = $self->paydate || '2037-12-31';
4717 $FS::notify_template::_template::first = $self->first;
4718 $FS::notify_template::_template::last = $self->last;
4719 $FS::notify_template::_template::company = $self->company;
4720 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4721 my $payby = $self->payby;
4722 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4723 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4725 #credit cards expire at the end of the month/year of their exp date
4726 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4727 $FS::notify_template::_template::payby = 'credit card';
4728 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4729 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4731 }elsif ($payby eq 'COMP') {
4732 $FS::notify_template::_template::payby = 'complimentary account';
4734 $FS::notify_template::_template::payby = 'current method';
4736 $FS::notify_template::_template::expdate = $expire_time;
4738 for (keys %{$options{extra_fields}}){
4740 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4743 send_email(from => $from,
4745 subject => $subject,
4746 body => $notify_template->fill_in( PACKAGE =>
4747 'FS::notify_template::_template' ),
4752 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4754 Generates a templated notification to the customer (see L<Text::Template>).
4756 OPTIONS is a hash and may include
4758 I<extra_fields> - a hashref of name/value pairs which will be substituted
4759 into the template. These values may override values mentioned below
4760 and those from the customer record.
4762 The following variables are available in the template instead of or in addition
4763 to the fields of the customer record.
4765 I<$payby> - a description of the method of payment for the customer
4766 # would be nice to use FS::payby::shortname
4767 I<$payinfo> - the masked account information used to collect for this customer
4768 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4769 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4773 # a lot like cust_bill::print_latex
4774 sub generate_letter {
4775 my ($self, $template, %options) = @_;
4777 return unless $conf->exists($template);
4779 my $letter_template = new Text::Template
4781 SOURCE => [ map "$_\n", $conf->config($template)],
4782 DELIMITERS => [ '[@--', '--@]' ],
4784 or die "can't create new Text::Template object: Text::Template::ERROR";
4786 $letter_template->compile()
4787 or die "can't compile template: Text::Template::ERROR";
4789 my %letter_data = map { $_ => $self->$_ } $self->fields;
4790 $letter_data{payinfo} = $self->mask_payinfo;
4792 #my $paydate = $self->paydate || '2037-12-31';
4793 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4795 my $payby = $self->payby;
4796 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4797 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4799 #credit cards expire at the end of the month/year of their exp date
4800 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4801 $letter_data{payby} = 'credit card';
4802 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4803 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4805 }elsif ($payby eq 'COMP') {
4806 $letter_data{payby} = 'complimentary account';
4808 $letter_data{payby} = 'current method';
4810 $letter_data{expdate} = $expire_time;
4812 for (keys %{$options{extra_fields}}){
4813 $letter_data{$_} = $options{extra_fields}->{$_};
4816 unless(exists($letter_data{returnaddress})){
4817 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4818 $self->agent_template)
4820 if ( length($retadd) ) {
4821 $letter_data{returnaddress} = $retadd;
4822 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4823 $letter_data{returnaddress} =
4824 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4828 ( $conf->config('company_name', $self->agentnum),
4829 $conf->config('company_address', $self->agentnum),
4833 $letter_data{returnaddress} = '~';
4837 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4839 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4841 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4843 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4847 ) or die "can't open temp file: $!\n";
4848 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4849 or die "can't write temp file: $!\n";
4851 $letter_data{'logo_file'} = $lh->filename;
4853 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4857 ) or die "can't open temp file: $!\n";
4859 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4861 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4862 return ($1, $letter_data{'logo_file'});
4866 =item print_ps TEMPLATE
4868 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4874 my($file, $lfile) = $self->generate_letter(@_);
4875 my $ps = FS::Misc::generate_ps($file);
4876 unlink($file.'.tex');
4882 =item print TEMPLATE
4884 Prints the filled in template.
4886 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4890 sub queueable_print {
4893 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4894 or die "invalid customer number: " . $opt{custnum};
4896 my $error = $self->print( { 'template' => $opt{template} } );
4897 die $error if $error;
4901 my ($self, $template) = (shift, shift);
4903 [ $self->print_ps($template) ],
4904 'agentnum' => $self->agentnum,
4908 #these three subs should just go away once agent stuff is all config overrides
4910 sub agent_template {
4912 $self->_agent_plandata('agent_templatename');
4915 sub agent_invoice_from {
4917 $self->_agent_plandata('agent_invoice_from');
4920 sub _agent_plandata {
4921 my( $self, $option ) = @_;
4923 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4924 #agent-specific Conf
4926 use FS::part_event::Condition;
4928 my $agentnum = $self->agentnum;
4930 my $regexp = regexp_sql();
4932 my $part_event_option =
4934 'select' => 'part_event_option.*',
4935 'table' => 'part_event_option',
4937 LEFT JOIN part_event USING ( eventpart )
4938 LEFT JOIN part_event_option AS peo_agentnum
4939 ON ( part_event.eventpart = peo_agentnum.eventpart
4940 AND peo_agentnum.optionname = 'agentnum'
4941 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4943 LEFT JOIN part_event_condition
4944 ON ( part_event.eventpart = part_event_condition.eventpart
4945 AND part_event_condition.conditionname = 'cust_bill_age'
4947 LEFT JOIN part_event_condition_option
4948 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4949 AND part_event_condition_option.optionname = 'age'
4952 #'hashref' => { 'optionname' => $option },
4953 #'hashref' => { 'part_event_option.optionname' => $option },
4955 " WHERE part_event_option.optionname = ". dbh->quote($option).
4956 " AND action = 'cust_bill_send_agent' ".
4957 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4958 " AND peo_agentnum.optionname = 'agentnum' ".
4959 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4961 CASE WHEN part_event_condition_option.optionname IS NULL
4963 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4965 , part_event.weight".
4969 unless ( $part_event_option ) {
4970 return $self->agent->invoice_template || ''
4971 if $option eq 'agent_templatename';
4975 $part_event_option->optionvalue;
4979 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4981 Subroutine (not a method), designed to be called from the queue.
4983 Takes a list of options and values.
4985 Pulls up the customer record via the custnum option and calls bill_and_collect.
4990 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4992 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4993 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4995 #without this errors don't get rolled back
4996 $args{'fatal'} = 1; # runs from job queue, will be caught
4998 $cust_main->bill_and_collect( %args );
5001 sub process_bill_and_collect {
5003 my $param = thaw(decode_base64(shift));
5004 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5005 or die "custnum '$param->{custnum}' not found!\n";
5006 $param->{'job'} = $job;
5007 $param->{'fatal'} = 1; # runs from job queue, will be caught
5008 $param->{'retry'} = 1;
5010 $cust_main->bill_and_collect( %$param );
5013 #starting to take quite a while for big dbs
5014 # (JRNL: journaled so it only happens once per database)
5015 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5016 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5017 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5018 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5019 # JRNL leading/trailing spaces in first, last, company
5020 # JRNL migrate to cust_payby
5021 # - otaker upgrade? journal and call it good? (double check to make sure
5022 # we're not still setting otaker here)
5024 #only going to get worse with new location stuff...
5026 sub _upgrade_data { #class method
5027 my ($class, %opts) = @_;
5030 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5033 #this seems to be the only expensive one.. why does it take so long?
5034 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5036 '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';
5037 FS::upgrade_journal->set_done('cust_main__signupdate');
5040 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5042 # fix yyyy-m-dd formatted paydates
5043 if ( driver_name =~ /^mysql/i ) {
5045 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5046 } else { # the SQL standard
5048 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5050 FS::upgrade_journal->set_done('cust_main__paydate');
5053 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5055 push @statements, #fix the weird BILL with a cc# in payinfo problem
5057 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5059 FS::upgrade_journal->set_done('cust_main__payinfo');
5064 foreach my $sql ( @statements ) {
5065 my $sth = dbh->prepare($sql) or die dbh->errstr;
5066 $sth->execute or die $sth->errstr;
5067 #warn ( (time - $t). " seconds\n" );
5071 local($ignore_expired_card) = 1;
5072 local($ignore_banned_card) = 1;
5073 local($skip_fuzzyfiles) = 1;
5074 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5076 FS::cust_main::Location->_upgrade_data(%opts);
5078 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5080 foreach my $cust_main ( qsearch({
5081 'table' => 'cust_main',
5083 'extra_sql' => 'WHERE '.
5085 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5086 qw( first last company )
5089 my $error = $cust_main->replace;
5090 die $error if $error;
5093 FS::upgrade_journal->set_done('cust_main__trimspaces');
5097 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5099 #we don't want to decrypt them, just stuff them as-is into cust_payby
5100 local(@encrypted_fields) = ();
5102 local($FS::cust_payby::ignore_expired_card) = 1;
5103 local($FS::cust_payby::ignore_banned_card) = 1;
5105 my @payfields = qw( payby payinfo paycvv paymask
5106 paydate paystart_month paystart_year payissue
5107 payname paystate paytype payip
5110 my $search = new FS::Cursor {
5111 'table' => 'cust_main',
5112 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5115 while (my $cust_main = $search->fetch) {
5117 my $cust_payby = new FS::cust_payby {
5118 'custnum' => $cust_main->custnum,
5120 map { $_ => $cust_main->$_(); } @payfields
5123 my $error = $cust_payby->insert;
5124 die $error if $error;
5126 $cust_main->setfield($_, '') foreach @payfields;
5127 $error = $cust_main->replace;
5128 die $error if $error;
5132 FS::upgrade_journal->set_done('cust_main__cust_payby');
5135 $class->_upgrade_otaker(%opts);
5145 The delete method should possibly take an FS::cust_main object reference
5146 instead of a scalar customer number.
5148 Bill and collect options should probably be passed as references instead of a
5151 There should probably be a configuration file with a list of allowed credit
5154 No multiple currency support (probably a larger project than just this module).
5156 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5158 Birthdates rely on negative epoch values.
5160 The payby for card/check batches is broken. With mixed batching, bad
5163 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5167 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5168 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5169 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.